File

src/lib/utils/types.ts

Methods

getCurrentAccessToken
getCurrentAccessToken()
Returns: string
getCurrentIdToken
getCurrentIdToken()
Returns: string
isAuthenticated
isAuthenticated()
Returns: any
finalScope
finalScope(scope: string)
Returns: string
signInWithoutRedirect
signInWithoutRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
signInWithSSO
signInWithSSO(idpId: string, options: SsoSignOptsAttrs)
Returns: any
signInWithSSOGateway
signInWithSSOGateway(idpId: string | string[], options: SsoSignOptsAttrs)
Returns: any
signUpWithoutRedirect
signUpWithoutRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
inviteWithoutRedirect
inviteWithoutRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
signInWithRedirect
signInWithRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
signUpWithRedirect
signUpWithRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
inviteWithRedirect
inviteWithRedirect(scope: string, redirectUri: string, locale: string)
Returns: any
handleInvitationState
handleInvitationState(scope: string)
Returns: any
handleTokensErrors
handleTokensErrors(errors: TokenError[])
Returns: boolean
handleNewTokens
handleNewTokens(refreshStore: RefreshStore, tokens: any)
Returns: void
handleRedirectCallback
handleRedirectCallback()
Returns: any
canRefresh
canRefresh(refreshStore: RefreshStore)
Returns: boolean
getRefreshStore
getRefreshStore()
Returns: RefreshStore
handleRefreshTokens
handleRefreshTokens()
Returns: any
recurringRefreshToken
recurringRefreshToken(refreshTokenWrapper: RefreshStore)
Returns: void
getUser
getUser()
Returns: object
getClaimsFromAccess
getClaimsFromAccess(accessToken: string)
Returns: object
canHandleAuthentication
canHandleAuthentication(searchParams: string)
Returns: boolean
canHandleInvitation
canHandleInvitation(searchParams: string)
Returns: boolean
userAccountAccess
userAccountAccess()
Returns: any
import
import()
Returns: void

Properties

config
config: Config
Type : Config
export enum Sign {
  Invite = 'invite',
  In = 'signin',
  Up = 'signup',
  Refresh = 'refresh'
}

/** @ignore */
export interface Authorization {
  id: string;
  code: string;
}

/**
 * Result of tokens response
 */
export interface Tokens {
  /** is token response returns sucessfully */
  valid: boolean;
  /** access token value */
  accessToken?: string;
}

/**
 * Cryptr config interface
 */
export interface Config {
  /** Tenant domain */
  tenant_domain: string;
  /** Cryptr Client ID */
  client_id: string;
  /** Application audience URL */
  audience: string;
  /**
   * Default redirect URI for application
   * after Cryptr authentication process
   */
  default_redirect_uri: string;
  /** Default locale for Cryptr SDK in application */
  default_locale?: string;
  /** region used for Cryptr integration */
  region?: string;
  /** Cryptr Service URL for this application */
  cryptr_base_url?: string;
  /** Activate Cryptr telemetry reporting */
  telemetry?: boolean;
}

/** @ignore */
export interface AuthResponseError {
  field: string;
  message: string;
}

/**
 * Token error response interface
 */
export interface TokenError {
  /**
   * Response error body of token request
   */
  http_response: any;
  /**
   * Error message of token request failure
   */
  error: string;
  /**
   * Error description of token request failure
   */
  error_description: string;
}

/** @ignore */
export interface RefreshStore {
  refresh_token: string;
  access_token_expiration_date: number;
  refresh_expiration_date: number;
  refresh_leeway: number;
  refresh_retry: number;
}

export interface SignOptsAttrs {
  scope?: string;
  redirectUri?: string;
  locale?: string;
}
export interface SsoSignOptsAttrs extends SignOptsAttrs {
  clientId?: string;
  tenantDomain?: string;
}

/** @ignore */
export interface CryptrClient {
  config: Config;
  getCurrentAccessToken(): string | undefined;
  getCurrentIdToken(): string | undefined;
  isAuthenticated(): Promise<boolean>;
  finalScope(scope?: string): string;
  signInWithoutRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  signInWithSSO(idpId: string, options?: SsoSignOptsAttrs): Promise<void>;
  signInWithSSOGateway(idpId?: string | string[], options?: SsoSignOptsAttrs): Promise<void>;
  signUpWithoutRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  inviteWithoutRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  signInWithRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  signUpWithRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  inviteWithRedirect(scope?: string, redirectUri?: string, locale?: string): Promise<void>;
  handleInvitationState(scope?: string): Promise<void>;
  handleTokensErrors(errors: TokenError[]): boolean;
  handleNewTokens(refreshStore: RefreshStore, tokens?: any): void;
  handleRedirectCallback(): Promise<any>;
  canRefresh(refreshStore: RefreshStore): boolean;
  getRefreshStore(): RefreshStore;
  handleRefreshTokens(): Promise<boolean>;
  recurringRefreshToken(refreshTokenWrapper: RefreshStore): void;
  getUser(): object | undefined;
  getClaimsFromAccess(accessToken: string): object | null;
  canHandleAuthentication(searchParams?: string): boolean;
  canHandleInvitation(searchParams?: string): boolean;
  userAccountAccess(): Promise<import('axios').AxiosResponse<any> | undefined>;
  logOut(callback: any, location?: Location, targetUrl?: string): Promise<boolean>;
  decoratedRequest(axiosRequestConfig: any): any;
}

/**
 * Cryptr User simplest representation
 */
export interface User {
  /** email of end user */
  email: string;
}

results matching ""

    No results matching ""