common
Enumerations
Classes
Type Aliases
CustomRouteUrl
Ƭ CustomRouteUrl: Object
Type declaration
| Name | Type |
|---|---|
_prefix? | string |
backChannelLogout? | string |
callback? | string |
loginListener? | string |
loginPage? | string |
loginPost? | string |
logoutCallback? | string |
logoutPage? | string |
logoutPost? | string |
publicDir? | string |
publicKeys? | string |
userStatus? | string |
Defined in
packages/common/src/types.ts:65
Deferred
Ƭ Deferred<T>: Object
Type parameters
| Name |
|---|
T |
Type declaration
| Name | Type |
|---|---|
promise | Promise<T> |
reject | (reason?: unknown) => void |
resolve | (value: T | PromiseLike<T>) => void |
Defined in
packages/common/src/utils.ts:12
EventListenerFunction
Ƭ EventListenerFunction<Event>: (event: Event, payload?: unknown) => void
Type parameters
| Name |
|---|
Event |
Type declaration
▸ (event, payload?): void
Parameters
| Name | Type |
|---|---|
event | Event |
payload? | unknown |
Returns
void
Defined in
packages/common/src/event-listener.ts:2
GeneralResponse
Ƭ GeneralResponse: SuccessResponse | ErrorResponse
Defined in
packages/common/src/types.ts:105
SilentLoginMessage
Ƭ SilentLoginMessage: Object
Type declaration
| Name | Type |
|---|---|
data? | UserStatusWrapped |
event | SilentLoginEvent |
token? | string |
Defined in
packages/common/src/types.ts:59
UserStatus
Ƭ UserStatus<Data>: UserStatusBase<Data> & { userInfo: UserInfoResponse | undefined }
Type parameters
| Name | Type |
|---|---|
Data | extends Record<string, any> = Record<string, any> |
Defined in
packages/common/src/types.ts:10
UserStatusImmerSafe
Ƭ UserStatusImmerSafe<Data>: UserStatusBase<Data> & { userInfo: { [claim: string]: JsonPrimitive; sub: string } | undefined }
Type parameters
| Name | Type |
|---|---|
Data | extends Record<string, any> = Record<string, any> |
Defined in
packages/common/src/types.ts:14
UserStatusWrapped
Ƭ UserStatusWrapped: Object
Type declaration
| Name | Type |
|---|---|
md5 | string |
payload | UserStatus |
timestamp | number |
Defined in
packages/common/src/types.ts:53
Variables
ConnectorCookieNames
• Const ConnectorCookieNames: Readonly<string[]>
Defined in
packages/common/src/connector-cookies.ts:17
ConnectorCookies
• Const ConnectorCookies: Readonly<{ ACCESS_TOKEN: `${string}access` ; CODE_VERIFIER: `${string}cv` ; ID_TOKEN: `${string}id` ; LOGOUT_REDIRECT_URI_B64: `${string}logout-redirect-uri` ; REDIRECT_URI_B64: `${string}redirect-uri` ; REFRESH_TOKEN: `${string}refresh` ; REFRESH_TOKEN_EXPIRATION: `${string}refresh-expiration` }>
Defined in
packages/common/src/connector-cookies.ts:7
ConnectorCookiesToKeep
• Const ConnectorCookiesToKeep: Readonly<string[]>
Array of cookies to keep after login process is complete *
Defined in
packages/common/src/connector-cookies.ts:20
RouteUrlDefaults
• Const RouteUrlDefaults: Required<CustomRouteUrl>
Defined in
packages/common/src/defaults.ts:3
STORAGE_PREFIX_COMBINED
• Const STORAGE_PREFIX_COMBINED: string
Defined in
packages/common/src/connector-cookies.ts:5
Functions
decodePayloadFromBase64
▸ decodePayloadFromBase64(base64): Record<string, any>
Parameters
| Name | Type |
|---|---|
base64 | string |
Returns
Record<string, any>
Defined in
packages/common/src/utils.ts:52
deferredFactory
▸ deferredFactory<T>(): Deferred<T>
Type parameters
| Name | Type |
|---|---|
T | unknown |
Returns
Deferred<T>
Defined in
packages/common/src/utils.ts:17
epoch
▸ epoch(date?): number
Parameters
| Name | Type |
|---|---|
date | Date |
Returns
number
Defined in
packages/common/src/utils.ts:3
getRoutePath
▸ getRoutePath(route, routePaths?): string
Parameters
| Name | Type |
|---|---|
route | RouteEnum |
routePaths? | CustomRouteUrl |
Returns
string
Defined in
packages/common/src/routes.ts:4
isDev
▸ isDev(): boolean
Returns
boolean
Defined in
packages/common/src/utils.ts:6
isObject
▸ isObject(obj): obj is Record<never, never>
Parameters
| Name | Type |
|---|---|
obj | unknown |
Returns
obj is Record<never, never>