Options
All
  • Public
  • Public/Protected
  • All
Menu

Module core

Index

Action Types Enumerations

Authorization Enumerations

Other Enumerations

Awayto Classes

Cognito Classes

Other Classes

Awayto Interfaces

Cognito Interfaces

Other Interfaces

API Type aliases

Action Types Type aliases

Awayto Type aliases

Awayto Redux Type aliases

Cognito Type aliases

File Type aliases

Login Type aliases

Logout Type aliases

Manage Type aliases

Manage Groups Type aliases

Manage Roles Type aliases

Manage Users Type aliases

Other Type aliases

User Profile Type aliases

Util Type aliases

Uuid Files Type aliases

Uuid Groups Type aliases

Uuid Notes Type aliases

Uuid Roles Type aliases

Variables

Build Functions

Cognito Functions

Other Functions

Util Functions

API Type aliases

ApiEvent

ApiEvent: { body: Record<string, unknown> | Record<string, unknown>[]; httpMethod: string; pathParameters: Record<string, string>; query: Record<string, string>; queryStringParameters: Record<string, string>; resource: string; script: string; userAdmin: string; userSub: string }

Type declaration

  • [name: string]: unknown
  • body: Record<string, unknown> | Record<string, unknown>[]
  • httpMethod: string
  • pathParameters: Record<string, string>
  • query: Record<string, string>
  • queryStringParameters: Record<string, string>
  • resource: string
  • script: string
  • userAdmin: string
  • userSub: string

ApiModule

ApiModule: {}

Type declaration

ApiModulet

ApiModulet: { inclusive?: boolean; path: string; roles?: string; cmnd: any }

Type declaration

ApiProps

ApiProps: { client: PoolClient; context: Context; event: ApiEvent }

Type declaration

  • client: PoolClient
  • context: Context
  • event: ApiEvent

ApiRequestAuthorizer

ApiRequestAuthorizer: { inclusive: boolean; roles: string; userToken: string }

Type declaration

  • inclusive: boolean
  • roles: string
  • userToken: string

Action Types Type aliases

IActionTypes

IActionTypes: ISharedActionTypes[keyof ISharedActionTypes]

Awayto Type aliases

IGroup

IGroup: { id: string; name: string; roles: IRole[]; users: number }

Type declaration

  • id: string
  • name: string
  • roles: IRole[]
  • users: number

ILogin

ILogin: { challengeName: string; error: Error | string; isLoggedIn: boolean; session: string; username: string }

Type declaration

  • challengeName: string
  • error: Error | string
  • isLoggedIn: boolean
  • session: string
  • username: string

IManage

IManage: { manageGroups: IManageGroupsState; manageRoles: IManageRolesState; manageUsers: IManageUsersState }

Type declaration

IManageGroups

IManageGroups: { checkedName: string; checkingName: boolean; error: Error | string; groups: IGroup[]; isValid: boolean; needCheckName: boolean }

Type declaration

  • checkedName: string
  • checkingName: boolean
  • error: Error | string
  • groups: IGroup[]
  • isValid: boolean
  • needCheckName: boolean

IManageRoles

IManageRoles: { error?: Error | string; roles: IRole[] }

Type declaration

  • Optional error?: Error | string
  • roles: IRole[]

IManageUsers

IManageUsers: { error: Error | string; users: IUserProfile[] }

Type declaration

IManageUuidRoles

IManageUuidRoles: { roleIds?: string[]; roles?: IUuidRoles[] }

Type declaration

  • Optional roleIds?: string[]
  • Optional roles?: IUuidRoles[]

IRole

IRole: { id: string; name: string }

Type declaration

  • id: string
  • name: string

IUserProfile

IUserProfile: { createdOn: string; email: string; file: File; firstName: string; groups: IGroup[]; hasSignUpCode: boolean; id: string; image: string; info: AdminGetUserResponse; lastName: string; locked: boolean; signedUp: boolean; status: string; sub: string; updatedOn: string; username: string }

Type declaration

  • createdOn: string
  • email: string
  • file: File
  • firstName: string
  • groups: IGroup[]
  • hasSignUpCode: boolean
  • id: string
  • image: string
  • info: AdminGetUserResponse
  • lastName: string
  • locked: boolean
  • signedUp: boolean
  • status: string
  • sub: string
  • updatedOn: string
  • username: string

IUtil

IUtil: { error: Error | string; hasSignUpCode: boolean; isConfirming: boolean; isLoading: boolean; loadingMessage: string; message: string; perPage: number; snackOn: string; snackType: "success" | "info" | "warning" | "error"; test: { objectUrl: string }; theme: string; action: any }

Type declaration

  • error: Error | string
  • hasSignUpCode: boolean
  • isConfirming: boolean
  • isLoading: boolean
  • loadingMessage: string
  • message: string
  • perPage: number
  • snackOn: string
  • snackType: "success" | "info" | "warning" | "error"
  • test: { objectUrl: string }
    • objectUrl: string
  • theme: string
  • action: function
    • action(): Promise<void>

IUuidFiles

IUuidFiles: { fileId: string; id: string; parentUuid: string }

Type declaration

  • fileId: string
  • id: string
  • parentUuid: string

IUuidGroups

IUuidGroups: { groupId: string; id?: string; parentUuid: string }

Type declaration

  • groupId: string
  • Optional id?: string
  • parentUuid: string

IUuidNotes

IUuidNotes: { id: string; note: string; parentUuid: string }

Type declaration

  • id: string
  • note: string
  • parentUuid: string

IUuidRoles

IUuidRoles: { id?: string; parentUuid: string; roleId: string }

Type declaration

  • Optional id?: string
  • parentUuid: string
  • roleId: string

Awayto Redux Type aliases

ILoadedState

ILoadedState: ISharedState[keyof ISharedState]

MetaAction

MetaAction<Type, Meta>: Action<Type> & { meta?: Meta }

Type parameters

  • Type

  • Meta

PayloadAction

PayloadAction<Type, Payload, Meta>: MetaAction<Type, Meta> & { payload: Payload }

Type parameters

  • Type

  • Payload

  • Meta = void

Cognito Type aliases

ClientMetadata

ClientMetadata: {} | undefined

CognitoAuthResponse

CognitoAuthResponse: RespondToAuthChallengeCommandOutput & { requiredAttributes: string[]; userAttributes: AttributeType[] }

File Type aliases

IFile

IFile: { fileTypeId: string; id: string; location: string; name: string }

Type declaration

  • fileTypeId: string
  • id: string
  • location: string
  • name: string

IFileActions

IFileActions: ILogoutUserAction | IPostFileAction | IPutFileAction | IGetFileAction | IGetFileByIdAction | IDeleteFileAction | IDisableFileAction

IFileState

IFileState: Partial<IFile>

IPostFileAction

IPostFileAction: PayloadAction<POST_FILES, IFileState>

Login Type aliases

IAuthDenialAction

IAuthDenialAction: PayloadAction<AUTH_DENIAL, ILoginState>

IAuthUserAction

IAuthUserAction: PayloadAction<AUTH_USER, ILoginState>

IAuthUserSuccessAction

IAuthUserSuccessAction: PayloadAction<AUTH_SUCCESS, ILoginState>

IForcePassChangeAction

IForcePassChangeAction: PayloadAction<FORCE_PASS_CHANGE_SUCCESS, ILoginState>

ILoginActions

ILoginActions: LogoutAction | ILoginUserAction | ILogoutUserAction | IAuthUserAction | IAuthUserSuccessAction | IAuthDenialAction | IResetPasswordAction | IForcePassChangeAction

ILoginState

ILoginState: Partial<ILogin>

ILoginUserAction

ILoginUserAction: PayloadAction<LOGIN_USER, ILoginState>

ILogoutUserAction

ILogoutUserAction: PayloadAction<LOGOUT_USER, ILoginState>

IResetPasswordAction

IResetPasswordAction: PayloadAction<RESET_PASSWORD, ILoginState>

Logout Type aliases

ILogout

ILogout: Record<string, unknown>

LogoutAction

LogoutAction: PayloadAction<"LOGOUT", ILogout>

Manage Type aliases

IGetModulesAction

IGetModulesAction: PayloadAction<GET_MODULES, IManage>

IManageActions

IManageActions: IGetModulesAction

IManageState

IManageState: Partial<IManage>

Manage Groups Type aliases

ICheckGroupNameAction

ICheckGroupNameAction: PayloadAction<CHECK_GROUP_NAME, IManageGroupsState>

IDeleteManageGroupsAction

IDeleteManageGroupsAction: PayloadAction<DELETE_MANAGE_GROUPS, IGroupState>

IDisableManageGroupsAction

IDisableManageGroupsAction: PayloadAction<DISABLE_MANAGE_GROUPS, IGroupState[]>

IGetManageGroupsAction

IGetManageGroupsAction: PayloadAction<GET_MANAGE_GROUPS, IGroup[]>

IGroupState

IGroupState: Partial<IGroup>

IManageGroupsActions

IManageGroupsActions: LogoutAction | IGetManageGroupsAction | ICheckGroupNameAction | IPostManageGroupsAction | IPutManageGroupsAction | IDeleteManageGroupsAction | IDisableManageGroupsAction

IManageGroupsState

IManageGroupsState: Partial<IManageGroups>

IPostManageGroupsAction

IPostManageGroupsAction: PayloadAction<POST_MANAGE_GROUPS, IGroup>

IPutManageGroupsAction

IPutManageGroupsAction: PayloadAction<PUT_MANAGE_GROUPS, IGroupState>

Manage Roles Type aliases

IDeleteManageRolesAction

IDeleteManageRolesAction: PayloadAction<DELETE_MANAGE_ROLES, IRoleState>

IGetManageRolesAction

IGetManageRolesAction: PayloadAction<GET_MANAGE_ROLES, IRole[]>

IManageRolesActions

IManageRolesActions: LogoutAction | IGetManageRolesAction | IPostManageRolesAction | IPutManageRolesAction | IDeleteManageRolesAction

IManageRolesState

IManageRolesState: Partial<IManageRoles>

IPostManageRolesAction

IPostManageRolesAction: PayloadAction<POST_MANAGE_ROLES, IRole>

IPutManageRolesAction

IPutManageRolesAction: PayloadAction<PUT_MANAGE_ROLES, IRoleState>

IRoleState

IRoleState: Partial<IRole>

Manage Users Type aliases

IGetManageUsersAction

IGetManageUsersAction: PayloadAction<GET_MANAGE_USERS, IUserProfile[]>

IGetManageUsersByIdAction

IGetManageUsersByIdAction: PayloadAction<GET_MANAGE_USERS_BY_ID, IUserProfile>

IGetManageUsersBySubAction

IGetManageUsersBySubAction: PayloadAction<GET_MANAGE_USERS_BY_SUB, IUserProfile>

IGetManageUsersInfoAction

IGetManageUsersInfoAction: PayloadAction<GET_MANAGE_USERS_INFO, IUserProfile[]>

ILockManageUsersAction

ILockManageUsersAction: PayloadAction<LOCK_MANAGE_USERS, Partial<IUserProfile>[]>

IManageUsersActions

IManageUsersActions: LogoutAction | IGetManageUsersAction | IGetManageUsersBySubAction | IGetManageUsersByIdAction | IGetManageUsersInfoAction | IPostManageUsersAction | IPostManageUsersSubAction | IPostManageUsersAppAcctAction | IPutManageUsersAction | ILockManageUsersAction | IUnlockManageUsersAction

IManageUsersState

IManageUsersState: Partial<IManageUsers>

IPostManageUsersAction

IPostManageUsersAction: PayloadAction<POST_MANAGE_USERS, IUserProfile>

IPostManageUsersAppAcctAction

IPostManageUsersAppAcctAction: PayloadAction<POST_MANAGE_USERS_APP_ACCT, IUserProfile>

IPostManageUsersSubAction

IPostManageUsersSubAction: PayloadAction<POST_MANAGE_USERS_SUB, IUserProfile>

IPutManageUsersAction

IPutManageUsersAction: PayloadAction<PUT_MANAGE_USERS, IUserProfile>

IUnlockManageUsersAction

IUnlockManageUsersAction: PayloadAction<UNLOCK_MANAGE_USERS, IUserProfile[]>

Other Type aliases

IDeleteFileAction

IDeleteFileAction: PayloadAction<DELETE_FILES, IFileState>

IDisableFileAction

IDisableFileAction: PayloadAction<DISABLE_FILES, IFileState>

IGetFileAction

IGetFileAction: PayloadAction<GET_FILES, IFileState>

IGetFileByIdAction

IGetFileByIdAction: PayloadAction<GET_FILES_BY_ID, IFileState>

ILogoutActions

ILogoutActions: LogoutAction

IPutFileAction

IPutFileAction: PayloadAction<PUT_FILES, IFileState>

User Profile Type aliases

IDisableUserProfileAction

IDisableUserProfileAction: PayloadAction<DISABLE_USER_PROFILE, IUserProfileState>

IGetUserProfileDetailsAction

IGetUserProfileDetailsAction: PayloadAction<GET_USER_PROFILE_DETAILS, IUserProfile>

IGetUserProfileDetailsByIdAction

IGetUserProfileDetailsByIdAction: PayloadAction<GET_USER_PROFILE_DETAILS_BY_ID, IUserProfile>

IGetUserProfileDetailsBySubAction

IGetUserProfileDetailsBySubAction: PayloadAction<GET_USER_PROFILE_DETAILS_BY_SUB, IUserProfile>

IHasCodeUserProfileAction

IHasCodeUserProfileAction: PayloadAction<HAS_CODE, IUserProfile>

IPostUserProfileAction

IPostUserProfileAction: PayloadAction<POST_USER_PROFILE, IUserProfile>

IPutUserProfileAction

IPutUserProfileAction: PayloadAction<PUT_USER_PROFILE, IUserProfile>

ISignUpUserAction

ISignUpUserAction: PayloadAction<SIGNUP_USER, IUserProfile>

IUserProfileActions

IUserProfileActions: LogoutAction | IHasCodeUserProfileAction | ISignUpUserAction | IPostUserProfileAction | IPutUserProfileAction | IGetUserProfileDetailsAction | IGetUserProfileDetailsBySubAction | IGetUserProfileDetailsByIdAction | IDisableUserProfileAction

IUserProfileState

IUserProfileState: Partial<IUserProfile>

Util Type aliases

IApiErrorAction

IApiErrorAction: PayloadAction<API_ERROR, IApiErrorActionPayload>

IApiErrorActionPayload

IApiErrorActionPayload: { error: string }

Type declaration

  • error: string

IApiSuccessAction

IApiSuccessAction: PayloadAction<API_SUCCESS, void>

IClearReduxAction

IClearReduxAction: PayloadAction<CLEAR_REDUX, null>

ICloseConfirmAction

ICloseConfirmAction: PayloadAction<CLOSE_CONFIRM, { isConfirming: boolean; message: string }>

IOpenConfirmAction

IOpenConfirmAction: PayloadAction<OPEN_CONFIRM, { action: Promise<void>; isConfirming: boolean; message: string }>

ISetSnackAction

ISetSnackAction: PayloadAction<SET_SNACK, { snackOn: string; snackType: string }>

ISetThemeAction

ISetThemeAction: PayloadAction<SET_THEME, ISetThemeActionPayload>

ISetThemeActionPayload

ISetThemeActionPayload: { theme: string }

Type declaration

  • theme: string

IStartLoadingAction

IStartLoadingAction: PayloadAction<START_LOADING, IUtilLoadingActionPayload>

IStopLoadingAction

IStopLoadingAction: PayloadAction<STOP_LOADING, IUtilLoadingActionPayload>

ITestApiAction

ITestApiAction: PayloadAction<TEST_API, { test: { objectUrl?: Record<string, string> | string } }>

IUtilActions

IUtilActions: IClearReduxAction | IOpenConfirmAction | ICloseConfirmAction | IStartLoadingAction | IStopLoadingAction | ISetThemeAction | ISetSnackAction | ITestApiAction | IApiErrorAction

IUtilLoadingActionPayload

IUtilLoadingActionPayload: { isLoading: boolean }

Type declaration

  • isLoading: boolean

IUtilState

IUtilState: Partial<IUtil>

Uuid Files Type aliases

IDeleteUuidFilesAction

IDeleteUuidFilesAction: PayloadAction<DELETE_UUID_FILES, IUuidFilesState>

IDisableUuidFilesAction

IDisableUuidFilesAction: PayloadAction<DISABLE_UUID_FILES, IUuidFilesState>

IGetUuidFilesAction

IGetUuidFilesAction: PayloadAction<GET_UUID_FILES, IUuidFilesState>

IGetUuidFilesByIdAction

IGetUuidFilesByIdAction: PayloadAction<GET_UUID_FILES_BY_ID, IUuidFilesState>

IPostUuidFilesAction

IPostUuidFilesAction: PayloadAction<POST_UUID_FILES, IUuidFilesState>

IPutUuidFilesAction

IPutUuidFilesAction: PayloadAction<PUT_UUID_FILES, IUuidFilesState>

IUuidFilesActions

IUuidFilesActions: ILogoutUserAction | IPostUuidFilesAction | IPutUuidFilesAction | IGetUuidFilesAction | IGetUuidFilesByIdAction | IDeleteUuidFilesAction | IDisableUuidFilesAction

IUuidFilesState

IUuidFilesState: Partial<IUuidFiles>

Uuid Groups Type aliases

IPostUuidGroupsAction

IPostUuidGroupsAction: PayloadAction<UUID_GROUPS, IUuidGroups>

IUuidGroupsActions

IUuidGroupsActions: IPostUuidGroupsAction

IUuidGroupsState

IUuidGroupsState: Partial<IUuidGroups>

Uuid Notes Type aliases

IDeleteUuidNotesAction

IDeleteUuidNotesAction: PayloadAction<DELETE_UUID_NOTES, IUuidNotesState>

IDisableUuidNotesAction

IDisableUuidNotesAction: PayloadAction<DISABLE_UUID_NOTES, IUuidNotesState[]>

IGetUuidNotesAction

IGetUuidNotesAction: PayloadAction<GET_UUID_NOTES, IUuidNotesState>

IGetUuidNotesByIdAction

IGetUuidNotesByIdAction: PayloadAction<GET_UUID_NOTES_BY_ID, IUuidNotesState>

IPostUuidNotesAction

IPostUuidNotesAction: PayloadAction<POST_UUID_NOTES, IUuidNotesState>

IPutUuidNotesAction

IPutUuidNotesAction: PayloadAction<PUT_UUID_NOTES, IUuidNotesState>

IUuidNotesActions

IUuidNotesActions: ILogoutUserAction | IPostUuidNotesAction | IPutUuidNotesAction | IGetUuidNotesAction | IGetUuidNotesByIdAction | IDeleteUuidNotesAction | IDisableUuidNotesAction

IUuidNotesState

IUuidNotesState: Partial<IUuidNotes>

Uuid Roles Type aliases

IUuidRolesActions

IUuidRolesActions: IUuidRolesUserAction

IUuidRolesState

IUuidRolesState: Partial<IUuidRoles>

IUuidRolesUserAction

IUuidRolesUserAction: PayloadAction<UUID_ROLES, IUuidRolesState>

Variables

Const AwaytoId

AwaytoId: string = ...

Const ClientId

ClientId: string = ...

Const IdentityPoolId

IdentityPoolId: string = ...

Const Region

Region: string = ...

Const UserPoolId

UserPoolId: string = ...

Build Functions

buildPathObject

  • buildPathObject(path: string): string

  • Parameters

    • path: string

    Returns string

    An object like { 'MyComponent': 'common/views/MyComponent' }

checkWriteBuildFile

  • checkWriteBuildFile(next: () => unknown): void

  • This function runs on build and when webpack dev server receives a request.

    Scan the file system for views and reducers and parse them into something we can use in the app.

    Check against a hash of existing file structure to see if we need to update the build file. The build file is used later in the app to load the views and reducers.

    // from config-overrides.js

function checkWriteBuildFile(next) {
  try {
    const files = JSON.stringify({
      views: parseResource('.' + REACT_APP_AWAYTO_WEBAPP_MODULES + '/**\/views/*.tsx'),
      reducers: parseResource('.' + REACT_APP_AWAYTO_WEBAPP_MODULES + '/**\/reducers/*.ts')
    });

    const newHash = crypto.createHash('sha1').update(Buffer.from(files)).digest('base64');

    if (oldHash != newHash) {
      oldHash = newHash;
      fs.writeFile(filePath, files, () => next && next())
    } else {
      next && next()
    }
  } catch (error) {
    console.log('error!', error)
  }
}

    Parameters

    • next: () => unknown

      The next function from express app

        • (): unknown

        • Returns unknown

    Returns void

parseResource

  • parseResource(path: string): Record<string, string>
  • example
    {
  "views": {
    "Home": "common/views/Home",
    "Login": "common/views/Login",
    "Secure": "common/views/Secure",
  },
  "reducers": {
    "login": "common/reducers/login",
    "util": "common/reducers/util",
  }
}

    Parameters

    • path: string

      A file path to a set of globbable files

    Returns Record<string, string>

    An object containing file names as keys and values as file paths.

Cognito Functions

Const cognitoPoolSignUp

  • cognitoPoolSignUp(username: string, password: string, email: string): Promise<void>

  • Parameters

    • username: string
    • password: string
    • email: string

    Returns Promise<void>

Const cognitoSSRPChallengeResponse

  • cognitoSSRPChallengeResponse(ChallengeName: string, Session: string, payload: Record<string, any>): Promise<{ error?: string }>

  • Parameters

    • ChallengeName: string
    • Session: string
    • payload: Record<string, any>

    Returns Promise<{ error?: string }>

Const cognitoSSRPLogin

  • cognitoSSRPLogin(Username: string, Password: string): Promise<Record<string, string>>

  • Parameters

    • Username: string
    • Password: string

    Returns Promise<Record<string, string>>

Const getUserPool

logoutUser

  • logoutUser(): void

Other Functions

Const passwordGen

  • passwordGen(): string

Util Functions

asyncForEach

  • asyncForEach<T>(array: T[], callback: (item: T, idx: number, arr: T[]) => Promise<void>): Promise<void>

  • Type parameters

    • T

    Parameters

    • array: T[]
    • callback: (item: T, idx: number, arr: T[]) => Promise<void>
        • (item: T, idx: number, arr: T[]): Promise<void>

        • Parameters

          • item: T
          • idx: number
          • arr: T[]

          Returns Promise<void>

    Returns Promise<void>

Const getAuthorization

  • getAuthorization(ug: string, rg: string): { hasGroup: boolean; hasRole: boolean }

  • Parameters

    • ug: string
    • rg: string

    Returns { hasGroup: boolean; hasRole: boolean }

    • hasGroup: boolean
    • hasRole: boolean

Const parseGroupString

  • parseGroupString(value: string): IGroup[]

Generated using TypeDoc