Class AWSWebCore

AWSWebCore class implements AWS-based operations for Lemoncloud authentication logic

Implements

Constructors

constructor

Properties

config logger tokenStorage

Methods

buildAWSCredentialsByStorage buildAWSCredentialsByToken buildCredentialsByStorage buildCredentialsByToken buildRequest buildSignedRequest changeUserSite createAWSCredentials getCredentials getCurrentCredentials getSavedToken getTokenSignature getTokenStorage init isAuthenticated logout refreshCachedToken refreshCachedTokenV2 request saveKMS setUseXLemonIdentity signedRequest

Constructors

constructor

Properties

Private Readonly config

config: WebCoreConfig<"aws">

The configuration for the AWS WebCore.

Private Readonly logger

logger: LoggerService

Private Readonly tokenStorage

tokenStorage: AWSStorageService

Methods

Private buildAWSCredentialsByStorage

  • buildAWSCredentialsByStorage(): Promise<void>

  • Builds AWS credentials using the cached credentials from storage.

    Returns Promise<void>

    • A promise that resolves when the credentials are built.

Private buildAWSCredentialsByToken

  • buildAWSCredentialsByToken(token): Promise<void>
  • Private

    Retrieves the current AWS credentials.

    Parameters

    Returns Promise<void>

    • The AWS credentials.

buildCredentialsByStorage

  • buildCredentialsByStorage(): Promise<Credentials>

  • Builds AWS credentials using the cached credentials from storage.

    Returns Promise<Credentials>

    • The AWS credentials.

buildCredentialsByToken

  • buildCredentialsByToken(token): Promise<Credentials>

  • Builds AWS credentials using an OAuth token.

    Parameters

    Returns Promise<Credentials>

    • The AWS credentials.

buildRequest

buildSignedRequest

changeUserSite

  • changeUserSite(changeSiteBody, url?): Promise<Credentials>

  • Changes the user site and returns new AWS credentials.

    Parameters

    • changeSiteBody: ChangeSiteBody

      The body containing site change details.

    • Optional url: string

      Optional URL for the OAuth endpoint.

    Returns Promise<Credentials>

    • A promise that resolves to AWS credentials.

    Throws

    Will throw an error if changeSiteBody, changeSiteBody.siteId, or changeSiteBody.userId are not provided.

    Example

    const changeSiteBody = { siteId: 'newSiteId', userId: 'userId123' };
    const credentials = await changeUserSite(changeSiteBody);

Private createAWSCredentials

  • createAWSCredentials(credentials): void
  • Private

    Builds AWS credentials using an OAuth token.

    Parameters

    Returns void

    • A promise that resolves when the credentials are built.

getCredentials

  • getCredentials(): Promise<Credentials>

  • Retrieves the AWS credentials.

    Returns Promise<Credentials>

    • The AWS credentials or null if no cached token exists.

Private getCurrentCredentials

  • getCurrentCredentials(): Promise<Credentials>
  • Private

    Retrieves the current AWS credentials.

    Returns Promise<Credentials>

    • The AWS credentials.

getSavedToken

  • getSavedToken(): Promise<{
        [key: string]: string;
    }>

  • Retrieves the saved tokens from the storage.

    Returns Promise<{
        [key: string]: string;
    }>

    • The saved tokens.

getTokenSignature

getTokenStorage

init

  • init(): Promise<AWSWebCoreState>

  • Checks if there is a cached token and refreshes it if needed. If the token should be refreshed, it refreshes the token and updates the AWS credentials. If the token is still valid, it uses the cached credentials to build AWS credentials.

    Returns Promise<AWSWebCoreState>

    • A promise that resolves to a string indicating the action taken.

    Throws

    • Throws an error if there is no cached token.

isAuthenticated

logout

refreshCachedToken

  • refreshCachedToken(domain?, url?): Promise<Credentials>

  • Refreshes the cached token.

    Parameters

    • Optional domain: string = ''

      The domain for the refresh request.

    • Optional url: string = ''

      The request url for refresh token

    Returns Promise<Credentials>

    • The AWS credentials or null if refresh fails.

refreshCachedTokenV2

  • refreshCachedTokenV2(domain?, url?): Promise<Credentials>

  • Refreshes the cached token new version

    Parameters

    • Optional domain: string = ''

      The domain for the refresh request.

    • Optional url: string = ''

      The request url for refresh token

    Returns Promise<Credentials>

    • The AWS credentials or null if refresh fails.

request

  • request<T>(method, url, params?, body?, config?): Promise<HttpResponse<T>>

  • Executes a HTTP request without Credentials.

    Type Parameters

    • T

    Parameters

    • method: string

      The HTTP method.

    • url: string

      The request URL.

    • Optional params: Params = {}

      The request parameters.

    • Optional body: Body

      The request body.

    • Optional config: AxiosRequestConfig<any>

      Additional Axios request configuration.

    Returns Promise<HttpResponse<T>>

    • The Axios response.

saveKMS

  • saveKMS(kms): Promise<void>

  • Saves the KMS (Key Management Service) details to storage.

    Parameters

    Returns Promise<void>

    • A promise that resolves when the KMS details are saved.

setUseXLemonIdentity

signedRequest

  • signedRequest<T>(method, url, params?, body?, config?): Promise<HttpResponse<T>>

  • Executes a signed HTTP request.

    Type Parameters

    • T

    Parameters

    • method: string

      The HTTP method.

    • url: string

      The request URL.

    • Optional params: Params = {}

      The request parameters.

    • Optional body: Body

      The request body.

    • Optional config: AxiosRequestConfig<any>

      Additional Axios request configuration.

    Returns Promise<HttpResponse<T>>

    • The Axios response.

Settings

Member Visibility

Theme

On This Page

constructorconfigloggertokenStoragebuildAWSCredentialsByStoragebuildAWSCredentialsByTokenbuildCredentialsByStoragebuildCredentialsByTokenbuildRequestbuildSignedRequestchangeUserSitecreateAWSCredentialsgetCredentialsgetCurrentCredentialsgetSavedTokengetTokenSignaturegetTokenStorageinitisAuthenticatedlogoutrefreshCachedTokenrefreshCachedTokenV2requestsaveKMSsetUseXLemonIdentitysignedRequest