diff --git a/classes/AWSHttpRequestBuilder.html b/classes/AWSHttpRequestBuilder.html index a77723a..6a79ba9 100644 --- a/classes/AWSHttpRequestBuilder.html +++ b/classes/AWSHttpRequestBuilder.html @@ -1,7 +1,7 @@ AWSHttpRequestBuilder | @lemoncloud/lemon-web-core

Class AWSHttpRequestBuilder

Class to build and execute HTTP requests with AWS signing

Example

const response: HttpResponse<OAuthResponse> = await new AWSHttpRequestBuilder({
    method: 'GET',
    baseURL: `https://api.lemoncloud.io/v1/oauth`,
 })
   .addHeaders({ Cookie: this.cookie })
   .setParams({ page: 0 })
   .execute();
-

Constructors

constructor +

Constructors

constructor

Properties

axiosInstance config logger @@ -21,60 +21,60 @@

Parameters

  • tokenStorage: AWSStorageService

    The AWS storage service for token management.

  • config: AxiosRequestConfig<any>

    The Axios request configuration.

Returns AWSHttpRequestBuilder

Throws

If tokenStorage, method, or baseURL are not defined.

-

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Private logger

logger: LoggerService

Private Readonly tokenStorage

tokenStorage: AWSStorageService

The AWS storage service for token management.

-

Methods

addAxiosRequestConfig

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Private logger

logger: LoggerService

Private Readonly tokenStorage

tokenStorage: AWSStorageService

The AWS storage service for token management.

+

Methods

addAxiosRequestConfig

addHeaders

addHeaders

Private addXLemonIdentityToHeader

Private addXLemonIdentityToHeader

  • addXLemonIdentityToHeader(header): Promise<AxiosHeaders>

  • Adds x-lemon-identity to the header.

    Parameters

    • header: any

      The header to be added

    Returns Promise<AxiosHeaders>

    The header with x-lemon-identity added

    -

execute

execute

Private extractHostname

Private extractHostname

  • extractHostname(url): any
  • Private

    Extracts the hostname from a URL.

    Parameters

    • url: string

      The URL to extract the hostname from.

    Returns any

    • The extracted hostname.
    -

Private getSignedClient

Private getSignedClient

  • getSignedClient(endpoint): Promise<any>
  • Private

    Gets the signed AWS client.

    Parameters

    • endpoint: string

      The endpoint for the client.

    Returns Promise<any>

    • The signed AWS client.

    Throws

    If endpoint is not provided or signed client is not available.

    -

Private getSignedHeader

Private getSignedHeader

  • getSignedHeader(signedClient, data): Promise<any>
  • Private

    Gets the signed headers for the request.

    Parameters

    • signedClient: any

      The signed AWS client.

    • data: HttpRequestData

      The request data.

    Returns Promise<any>

    • The signed headers.
    -

setBody

setBody

setHeaders

setHeaders

setMethod

setMethod

setParams

setParams

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigloggertokenStorageaddAxiosRequestConfigaddHeadersaddXLemonIdentityToHeaderexecuteextractHostnamegetSignedClientgetSignedHeadersetBodysetHeaderssetMethodsetParams
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigloggertokenStorageaddAxiosRequestConfigaddHeadersaddXLemonIdentityToHeaderexecuteextractHostnamegetSignedClientgetSignedHeadersetBodysetHeaderssetMethodsetParams
\ No newline at end of file diff --git a/classes/AWSStorageService.html b/classes/AWSStorageService.html index 52867ba..d1d29ce 100644 --- a/classes/AWSStorageService.html +++ b/classes/AWSStorageService.html @@ -1,7 +1,7 @@ AWSStorageService | @lemoncloud/lemon-web-core

Class AWSStorageService

Abstract class representing a token storage service. Provides methods to set and get items in storage, and abstract methods to check and manage cached tokens.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

config credentialKeys prefix @@ -18,30 +18,30 @@ setItem shouldRefreshToken updatePrefix -

Constructors

constructor

Properties

Readonly config

config: WebCoreConfig<"aws">

The configuration for the web core.

-

Private credentialKeys

credentialKeys: string[] = ...

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

clearOAuthToken

getAllItems

  • getAllItems(): Promise<{}>

  • Gets all items from the storage.

    +

Constructors

constructor

Properties

Readonly config

config: WebCoreConfig<"aws">

The configuration for the web core.

+

Private credentialKeys

credentialKeys: string[] = ...

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

clearOAuthToken

getAllItems

getCachedCredentials

getCachedOAuthToken

getItem

getCachedCredentials

getCachedOAuthToken

getItem

hasCachedToken

hasCachedToken

initLemonConfig

saveKMS

saveOAuthToken

setItem

initLemonConfig

saveKMS

saveOAuthToken

setItem

shouldRefreshToken

shouldRefreshToken

updatePrefix

updatePrefix

Settings

Member Visibility

Theme

On This Page

constructorconfigcredentialKeysprefixstorageclearOAuthTokengetAllItemsgetCachedCredentialsgetCachedOAuthTokengetItemhasCachedTokeninitLemonConfigsaveKMSsaveOAuthTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorconfigcredentialKeysprefixstorageclearOAuthTokengetAllItemsgetCachedCredentialsgetCachedOAuthTokengetItemhasCachedTokeninitLemonConfigsaveKMSsaveOAuthTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file diff --git a/classes/AWSWebCore.html b/classes/AWSWebCore.html index 9a34019..146d2b2 100644 --- a/classes/AWSWebCore.html +++ b/classes/AWSWebCore.html @@ -1,5 +1,5 @@ AWSWebCore | @lemoncloud/lemon-web-core

Class AWSWebCore

AWSWebCore class implements AWS-based operations for Lemoncloud authentication logic

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

config logger tokenStorage @@ -26,35 +26,35 @@ 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 AWSWebCore

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.

    +

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.

    +

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.

    +

buildCredentialsByToken

  • buildCredentialsByToken(token): Promise<Credentials>

  • Builds AWS credentials using an OAuth token.

    Parameters

    Returns Promise<Credentials>

    • The AWS credentials.
    -

buildRequest

buildRequest

buildSignedRequest

buildSignedRequest

changeUserSite

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

  • Changes the user site and returns new AWS credentials.

    +

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>

      @@ -63,31 +63,31 @@

      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.

    +

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

  • 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.

    +

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.

    +

getSavedToken

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

  • Retrieves the saved tokens from the storage.

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

    • The saved tokens.
    -

getTokenSignature

getTokenSignature

getTokenStorage

getTokenStorage

init

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>

      @@ -96,21 +96,21 @@

      Example

      const
      Throws
        
 
      • Throws an error if there is no cached token.
        • 
 
      
-

isAuthenticated

isAuthenticated

logout

logout

refreshCachedToken

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.
    -

request

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.

      @@ -119,14 +119,14 @@

      Example

      const

    Returns Promise<HttpResponse<T>>

    • The Axios response.
    -

saveKMS

  • saveKMS(kms): Promise<void>

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

    +

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

setUseXLemonIdentity

signedRequest

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

  • Executes a signed HTTP request.

    +

Returns Promise<void>

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.

      @@ -135,4 +135,4 @@

      Example

      const

    Returns Promise<HttpResponse<T>>

    • The Axios response.
    -

Settings

Member Visibility

Theme

On This Page

constructorconfigloggertokenStoragebuildAWSCredentialsByStoragebuildAWSCredentialsByTokenbuildCredentialsByStoragebuildCredentialsByTokenbuildRequestbuildSignedRequestchangeUserSitecreateAWSCredentialsgetCredentialsgetCurrentCredentialsgetSavedTokengetTokenSignaturegetTokenStorageinitisAuthenticatedlogoutrefreshCachedTokenrequestsaveKMSsetUseXLemonIdentitysignedRequest
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorconfigloggertokenStoragebuildAWSCredentialsByStoragebuildAWSCredentialsByTokenbuildCredentialsByStoragebuildCredentialsByTokenbuildRequestbuildSignedRequestchangeUserSitecreateAWSCredentialsgetCredentialsgetCurrentCredentialsgetSavedTokengetTokenSignaturegetTokenStorageinitisAuthenticatedlogoutrefreshCachedTokenrequestsaveKMSsetUseXLemonIdentitysignedRequest
\ No newline at end of file diff --git a/classes/AzureHttpRequestBuilder.html b/classes/AzureHttpRequestBuilder.html index 3ec6af6..90f671f 100644 --- a/classes/AzureHttpRequestBuilder.html +++ b/classes/AzureHttpRequestBuilder.html @@ -1,7 +1,7 @@ AzureHttpRequestBuilder | @lemoncloud/lemon-web-core

Class AzureHttpRequestBuilder

Class to build and execute HTTP requests with AWS signing

Example

const response: HttpResponse<OAuthResponse> = await new AzureHttpRequestBuilder({
    method: 'GET',
    baseURL: `https://api.lemoncloud.io/v1/oauth`,
 })
   .addHeaders({ Cookie: this.cookie })
   .setParams({ page: 0 })
   .execute();
-

Constructors

constructor +

Constructors

constructor

Properties

axiosInstance config tokenStorage @@ -19,56 +19,56 @@

Parameters

  • tokenStorage: AzureStorageService

    The AWS storage service for token management.

  • config: AxiosRequestConfig<any>

    The Axios request configuration.

Returns AzureHttpRequestBuilder

Throws

If tokenStorage, method, or baseURL are not defined.

-

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Private Readonly tokenStorage

tokenStorage: AzureStorageService

The AWS storage service for token management.

-

Methods

addAxiosRequestConfig

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Private Readonly tokenStorage

tokenStorage: AzureStorageService

The AWS storage service for token management.

+

Methods

addAxiosRequestConfig

Private addBearerTokenToHeader

Private addBearerTokenToHeader

  • addBearerTokenToHeader(): Promise<void>
  • Private

    Adds a Bearer token to the request headers. Retrieves the identityToken from the token storage and sets it as the Authorization header.

    Returns Promise<void>

    • A promise that resolves when the token is added.
    -

    Async

Private addCodeParams

Private addCodeParams

  • addCodeParams(): Promise<void>
  • Private

    Adds code parameters to the request configuration. Retrieves the hostKey and clientId from the token storage and sets them as request parameters.

    Returns Promise<void>

    • A promise that resolves when the parameters are added.
    -

    Async

addHeaders

addHeaders

Private addXLemonIdentityToHeader

Private addXLemonIdentityToHeader

  • addXLemonIdentityToHeader(): Promise<void>
  • Private

    Adds the x-lemon-identity token to the request headers if required. Checks if the USE_X_LEMON_IDENTITY_KEY is set in the token storage and, if true, retrieves the identityToken and sets it as the x-lemon-identity header.

    Returns Promise<void>

    • A promise that resolves when the token is added.
    -

    Async

execute

execute

setBody

setBody

setHeaders

setHeaders

setMethod

setMethod

setParams

setParams

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigtokenStorageaddAxiosRequestConfigaddBearerTokenToHeaderaddCodeParamsaddHeadersaddXLemonIdentityToHeaderexecutesetBodysetHeaderssetMethodsetParams
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigtokenStorageaddAxiosRequestConfigaddBearerTokenToHeaderaddCodeParamsaddHeadersaddXLemonIdentityToHeaderexecutesetBodysetHeaderssetMethodsetParams
\ No newline at end of file diff --git a/classes/AzureStorageService.html b/classes/AzureStorageService.html index 4d664d4..2c8a715 100644 --- a/classes/AzureStorageService.html +++ b/classes/AzureStorageService.html @@ -1,5 +1,5 @@ AzureStorageService | @lemoncloud/lemon-web-core

Class AzureStorageService

A service to manage Azure-specific storage operations.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

config credentialKeys prefix @@ -13,30 +13,30 @@ setItem shouldRefreshToken updatePrefix -

Constructors

constructor

Properties

Readonly config

config: WebCoreConfig<"azure">

The configuration for the web core.

-

Private credentialKeys

credentialKeys: string[] = ...

The list of keys used to store credentials in the storage.

-

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

clearOAuthToken

getAllItems

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

  • Retrieves all items from the storage.

    +

Constructors

constructor

Properties

Readonly config

config: WebCoreConfig<"azure">

The configuration for the web core.

+

Private credentialKeys

credentialKeys: string[] = ...

The list of keys used to store credentials in the storage.

+

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

clearOAuthToken

getAllItems

getCachedOAuthToken

getCachedOAuthToken

getItem

getItem

hasCachedToken

hasCachedToken

saveOAuthToken

saveOAuthToken

setItem

  • setItem(key, value): Promise<void>

  • Sets an item in the storage.

    +

Returns Promise<void>

setItem

shouldRefreshToken

shouldRefreshToken

updatePrefix

updatePrefix

Settings

Member Visibility

Theme

On This Page

constructorconfigcredentialKeysprefixstorageclearOAuthTokengetAllItemsgetCachedOAuthTokengetItemhasCachedTokensaveOAuthTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorconfigcredentialKeysprefixstorageclearOAuthTokengetAllItemsgetCachedOAuthTokengetItemhasCachedTokensaveOAuthTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file diff --git a/classes/AzureWebCore.html b/classes/AzureWebCore.html index 6f36cb3..c68ab22 100644 --- a/classes/AzureWebCore.html +++ b/classes/AzureWebCore.html @@ -1,6 +1,6 @@ AzureWebCore | @lemoncloud/lemon-web-core

Class AzureWebCore

Class to handle Azure-specific web core operations. Implements the WebCoreService interface.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

config logger tokenStorage @@ -17,38 +17,38 @@ signedRequest

Constructors

constructor

Properties

Private Readonly config

config: WebCoreConfig<"azure">

The configuration for the Azure web core.

-

Private Readonly logger

logger: LoggerService

Private Readonly tokenStorage

tokenStorage: AzureStorageService

Methods

buildRequest

  • buildRequest(config): HttpRequestBuilder

  • Builds a request using HttpRequestBuilder without Credentials.

    +

Returns AzureWebCore

Properties

Private Readonly config

config: WebCoreConfig<"azure">

The configuration for the Azure web core.

+

Private Readonly logger

logger: LoggerService

Private Readonly tokenStorage

tokenStorage: AzureStorageService

Methods

buildRequest

buildSignedRequest

buildSignedRequest

getSavedToken

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

  • Retrieves all saved tokens from the storage.

    +

getSavedToken

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

  • Retrieves all saved tokens from the storage.

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

    • An object containing all saved tokens.
    -

getTokenStorage

getTokenStorage

init

init

isAuthenticated

isAuthenticated

logout

logout

  • logout(): Promise<void>

  • Logs the user out by clearing the OAuth token from the storage.

    Returns Promise<void>

    • A promise that resolves when the user is logged out.
    -

request

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.

      @@ -57,17 +57,17 @@

    Returns Promise<HttpResponse<T>>

    • The Axios response.
    -

saveOAuthToken

saveOAuthToken

  • saveOAuthToken(token): Promise<void>

  • Saves an OAuth token to the storage.

    Parameters

    Returns Promise<void>

    • A promise that resolves when the token is saved.
    -

setUseXLemonIdentity

setUseXLemonIdentity

  • setUseXLemonIdentity(use): Promise<void>

  • Sets whether to use the x-lemon-identity header.

    Parameters

    • use: boolean

      True to use the x-lemon-identity header, otherwise false.

    Returns Promise<void>

    • A promise that resolves when the setting is updated.
    -

signedRequest

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 to use for the request.

    • url: string

      The URL for the request.

    • Optional params: Params = {}

      The URL parameters for the request.

      @@ -76,4 +76,4 @@

    Returns Promise<HttpResponse<T>>

    • The Axios response.
    -

Settings

Member Visibility

Theme

On This Page

constructorconfigloggertokenStoragebuildRequestbuildSignedRequestgetSavedTokengetTokenStorageinitisAuthenticatedlogoutrequestsaveOAuthTokensetUseXLemonIdentitysignedRequest
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorconfigloggertokenStoragebuildRequestbuildSignedRequestgetSavedTokengetTokenStorageinitisAuthenticatedlogoutrequestsaveOAuthTokensetUseXLemonIdentitysignedRequest
\ No newline at end of file diff --git a/classes/HttpRequestBuilder.html b/classes/HttpRequestBuilder.html index 33a16e5..b0047c9 100644 --- a/classes/HttpRequestBuilder.html +++ b/classes/HttpRequestBuilder.html @@ -1,7 +1,7 @@ HttpRequestBuilder | @lemoncloud/lemon-web-core

Class HttpRequestBuilder

Class to build and execute HTTP requests

Example

const response: HttpResponse<OAuthResponse> = await new HttpRequestBuilder({
    method: 'GET',
    baseURL: `https://api.lemoncloud.io/v1/oauth`,
 })
   .setHeaders({ Cookie: this.cookie })
   .setParams({ page: 0 })
   .execute();
-

Constructors

constructor +

Constructors

constructor

Properties

axiosInstance config

Methods

addAxiosRequestConfig @@ -14,39 +14,39 @@

Constructors

constructor

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Methods

addAxiosRequestConfig

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private config

config: AxiosRequestConfig<any> = ...

Methods

addAxiosRequestConfig

addHeaders

addHeaders

execute

execute

setBody

setBody

setHeaders

setHeaders

setMethod

setMethod

setParams

setParams

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigaddAxiosRequestConfigaddHeadersexecutesetBodysetHeaderssetMethodsetParams
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstanceconfigaddAxiosRequestConfigaddHeadersexecutesetBodysetHeaderssetMethodsetParams
\ No newline at end of file diff --git a/classes/LocalStorageService.html b/classes/LocalStorageService.html index 0e2e8b5..281f8d8 100644 --- a/classes/LocalStorageService.html +++ b/classes/LocalStorageService.html @@ -1,6 +1,6 @@ -LocalStorageService | @lemoncloud/lemon-web-core

Class LocalStorageService

Constructors

constructor +LocalStorageService | @lemoncloud/lemon-web-core

Class LocalStorageService

Constructors

constructor

Properties

storage

Methods

getItem removeItem setItem -

Constructors

constructor

Properties

Private storage

storage: any

Methods

getItem

removeItem

setItem

Settings

Member Visibility

Theme

On This Page

constructorstoragegetItemremoveItemsetItem
\ No newline at end of file +

Constructors

constructor

Properties

Private storage

storage: any

Methods

getItem

removeItem

setItem

Settings

Member Visibility

Theme

On This Page

constructorstoragegetItemremoveItemsetItem
\ No newline at end of file diff --git a/classes/LoggerHelperService.html b/classes/LoggerHelperService.html index 6ce332b..ca438e8 100644 --- a/classes/LoggerHelperService.html +++ b/classes/LoggerHelperService.html @@ -1,4 +1,4 @@ -LoggerHelperService | @lemoncloud/lemon-web-core

Class LoggerHelperService

Constructors

constructor +LoggerHelperService | @lemoncloud/lemon-web-core

Class LoggerHelperService

Constructors

constructor

Properties

colorSet logColors

Methods

checkErrorInstance @@ -8,4 +8,4 @@ getColorSet isBrowser isNode -

Constructors

constructor

Properties

Private colorSet

colorSet: any

Private logColors

logColors: any

Methods

Private checkErrorInstance

formatMessage

getColorAsType

getColorByName

Private getColorSet

  • getColorSet(): {
        Black: number;
        Blue: number;
        Cyan: number;
        Green: number;
        Grey: number;
        Magenta: number;
        Red: number;
        White: number;
        Yellow: number;
    } | {
        Black: string;
        Blue: string;
        Cyan: string;
        Green: string;
        Grey: string;
        Magenta: string;
        Red: string;
        White: string;
        Yellow: string;
    }

  • Returns {
        Black: number;
        Blue: number;
        Cyan: number;
        Green: number;
        Grey: number;
        Magenta: number;
        Red: number;
        White: number;
        Yellow: number;
    } | {
        Black: string;
        Blue: string;
        Cyan: string;
        Green: string;
        Grey: string;
        Magenta: string;
        Red: string;
        White: string;
        Yellow: string;
    }

isBrowser

isNode

Settings

Member Visibility

Theme

On This Page

constructorcolorSetlogColorscheckErrorInstanceformatMessagegetColorAsTypegetColorByNamegetColorSetisBrowserisNode
\ No newline at end of file +

Constructors

constructor

Properties

Private colorSet

colorSet: any

Private logColors

logColors: any

Methods

Private checkErrorInstance

formatMessage

getColorAsType

getColorByName

Private getColorSet

  • getColorSet(): {
        Black: number;
        Blue: number;
        Cyan: number;
        Green: number;
        Grey: number;
        Magenta: number;
        Red: number;
        White: number;
        Yellow: number;
    } | {
        Black: string;
        Blue: string;
        Cyan: string;
        Green: string;
        Grey: string;
        Magenta: string;
        Red: string;
        White: string;
        Yellow: string;
    }

  • Returns {
        Black: number;
        Blue: number;
        Cyan: number;
        Green: number;
        Grey: number;
        Magenta: number;
        Red: number;
        White: number;
        Yellow: number;
    } | {
        Black: string;
        Blue: string;
        Cyan: string;
        Green: string;
        Grey: string;
        Magenta: string;
        Red: string;
        White: string;
        Yellow: string;
    }

isBrowser

isNode

Settings

Member Visibility

Theme

On This Page

constructorcolorSetlogColorscheckErrorInstanceformatMessagegetColorAsTypegetColorByNamegetColorSetisBrowserisNode
\ No newline at end of file diff --git a/classes/LoggerService.html b/classes/LoggerService.html index b611efc..1baaf41 100644 --- a/classes/LoggerService.html +++ b/classes/LoggerService.html @@ -1,4 +1,4 @@ -LoggerService | @lemoncloud/lemon-web-core

Class LoggerService

Implements

Constructors

constructor +LoggerService | @lemoncloud/lemon-web-core

Class LoggerService

Implements

Constructors

constructor

Properties

isBrowser isNode namespace @@ -16,4 +16,4 @@ logOnBrowser warn writeLog -

Constructors

constructor

Properties

Private isBrowser

isBrowser: boolean

Private isNode

isNode: boolean

Private namespace

namespace: string

Private options

options: LoggerOption = ...

Private utils

utils: LoggerHelperService

Methods

Private createLogMessage

Private createTimestamp

debug

error

Private getBrowserFormat

Private getFormat

Private getNodeFormat

info

log

  • log(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

Private logOnBrowser

warn

Private writeLog

Settings

Member Visibility

Theme

On This Page

constructorisBrowserisNodenamespaceoptionsutilscreateLogMessagecreateTimestampdebugerrorgetBrowserFormatgetFormatgetNodeFormatinfologlogOnBrowserwarnwriteLog
\ No newline at end of file +

Constructors

constructor

Properties

Private isBrowser

isBrowser: boolean

Private isNode

isNode: boolean

Private namespace

namespace: string

Private options

options: LoggerOption = ...

Private utils

utils: LoggerHelperService

Methods

Private createLogMessage

Private createTimestamp

debug

error

Private getBrowserFormat

Private getFormat

Private getNodeFormat

info

log

  • log(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

Private logOnBrowser

warn

Private writeLog

Settings

Member Visibility

Theme

On This Page

constructorisBrowserisNodenamespaceoptionsutilscreateLogMessagecreateTimestampdebugerrorgetBrowserFormatgetFormatgetNodeFormatinfologlogOnBrowserwarnwriteLog
\ No newline at end of file diff --git a/classes/TokenStorageService.html b/classes/TokenStorageService.html index d06f7be..d703549 100644 --- a/classes/TokenStorageService.html +++ b/classes/TokenStorageService.html @@ -1,7 +1,7 @@ TokenStorageService | @lemoncloud/lemon-web-core

Class TokenStorageServiceAbstract

Abstract class representing a token storage service. Provides methods to set and get items in storage, and abstract methods to check and manage cached tokens.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

config prefix storage @@ -13,30 +13,30 @@ updatePrefix

Constructors

constructor

Properties

Protected Readonly config

config: WebCoreConfig<keyof WebCoreServiceMap>

The configuration for the web core.

-

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

Abstract getAllItems

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

  • Gets all items from the storage.

    +

Returns TokenStorageService

Properties

Protected Readonly config

config: WebCoreConfig<keyof WebCoreServiceMap>

The configuration for the web core.

+

Protected prefix

prefix: string = 'lemon'

Protected storage

storage: Storage = ...

Methods

Abstract getAllItems

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

  • Gets all items from the storage.

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

    • A promise that resolves to an object containing all items.
    -

getItem

getItem

  • getItem(key): Promise<string>

  • Gets an item from the storage.

    Parameters

    • key: string

      The key to get.

    Returns Promise<string>

    • A promise that resolves to the value of the item.
    -

Abstract hasCachedToken

Abstract hasCachedToken

  • hasCachedToken(): Promise<boolean>

  • Checks if there is a cached token in the storage.

    Returns Promise<boolean>

    • A promise that resolves to true if a cached token exists, false otherwise.
    -

setItem

setItem

  • setItem(key, value): Promise<void>

  • Sets an item in the storage.

    Parameters

    • key: string

      The key to set.

    • value: string

      The value to set.

    Returns Promise<void>

    • A promise that resolves when the item is set.
    -

Abstract shouldRefreshToken

Abstract shouldRefreshToken

  • shouldRefreshToken(): Promise<boolean>

  • Checks if the cached token should be refreshed.

    Returns Promise<boolean>

    • A promise that resolves to true if the token should be refreshed, false otherwise.
    -

updatePrefix

updatePrefix

Settings

Member Visibility

Theme

On This Page

constructorconfigprefixstoragegetAllItemsgetItemhasCachedTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorconfigprefixstoragegetAllItemsgetItemhasCachedTokensetItemshouldRefreshTokenupdatePrefix
\ No newline at end of file diff --git a/classes/WebCoreFactory.html b/classes/WebCoreFactory.html index 4069971..94d8fc8 100644 --- a/classes/WebCoreFactory.html +++ b/classes/WebCoreFactory.html @@ -1,8 +1,8 @@ WebCoreFactory | @lemoncloud/lemon-web-core

Class WebCoreFactory

A factory class to create instances of WebCoreService based on the cloud provider.

-

Constructors

constructor +

Constructors

constructor

Methods

create

Constructors

constructor

Methods

Static create

Settings

Member Visibility

Theme

On This Page

constructorcreate
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorcreate
\ No newline at end of file diff --git a/enums/LogType.html b/enums/LogType.html index 82c77cd..968a675 100644 --- a/enums/LogType.html +++ b/enums/LogType.html @@ -1,5 +1,5 @@ -LogType | @lemoncloud/lemon-web-core

Enumeration LogType

Enumeration Members

DEBUG +LogType | @lemoncloud/lemon-web-core

Enumeration LogType

Enumeration Members

DEBUG ERROR INFO WARN -

Enumeration Members

DEBUG

DEBUG: "DEBUG"

ERROR

ERROR: "ERROR"

INFO

INFO: "INFO"

WARN

WARN: "WARN"

Settings

Member Visibility

Theme

On This Page

DEBUGERRORINFOWARN
\ No newline at end of file +

Enumeration Members

DEBUG

DEBUG: "DEBUG"

ERROR

ERROR: "ERROR"

INFO

INFO: "INFO"

WARN

WARN: "WARN"

Settings

Member Visibility

Theme

On This Page

DEBUGERRORINFOWARN
\ No newline at end of file diff --git a/functions/calcSignature.html b/functions/calcSignature.html index 0b75b1f..c1714a9 100644 --- a/functions/calcSignature.html +++ b/functions/calcSignature.html @@ -1 +1 @@ -calcSignature | @lemoncloud/lemon-web-core

Function calcSignature

  • calcSignature(payload, current?, userAgent?): any

  • Parameters

    • payload: SignaturePayload
    • current: string = ...
    • userAgent: string = navigator.userAgent

    Returns any

Settings

Member Visibility

Theme

\ No newline at end of file +calcSignature | @lemoncloud/lemon-web-core

Function calcSignature

  • calcSignature(payload, current?, userAgent?): any

  • Parameters

    • payload: SignaturePayload
    • current: string = ...
    • userAgent: string = navigator.userAgent

    Returns any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createAsyncDelay.html b/functions/createAsyncDelay.html index 65403d7..d148711 100644 --- a/functions/createAsyncDelay.html +++ b/functions/createAsyncDelay.html @@ -2,4 +2,4 @@

Returns Promise<void>

Description

create delay using async/await

Example

await createAsyncDelay(2000) // wait 2 seconds
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/hmac.html b/functions/hmac.html index 39e44b8..0f014ac 100644 --- a/functions/hmac.html +++ b/functions/hmac.html @@ -1 +1 @@ -hmac | @lemoncloud/lemon-web-core

Function hmac

  • hmac(message, key): any

  • Parameters

    • message: string
    • key: string

    Returns any

Settings

Member Visibility

Theme

\ No newline at end of file +hmac | @lemoncloud/lemon-web-core

Function hmac

  • hmac(message, key): any

  • Parameters

    • message: string
    • key: string

    Returns any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/isEmptyObject.html b/functions/isEmptyObject.html index 8879339..bb70dff 100644 --- a/functions/isEmptyObject.html +++ b/functions/isEmptyObject.html @@ -1 +1 @@ -isEmptyObject | @lemoncloud/lemon-web-core

Function isEmptyObject

  • isEmptyObject(obj): boolean

  • Parameters

    • obj: any

    Returns boolean

Settings

Member Visibility

Theme

\ No newline at end of file +isEmptyObject | @lemoncloud/lemon-web-core

Function isEmptyObject

  • isEmptyObject(obj): boolean

  • Parameters

    • obj: any

    Returns boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/withRetries.html b/functions/withRetries.html index 6e02c68..af7946c 100644 --- a/functions/withRetries.html +++ b/functions/withRetries.html @@ -1 +1 @@ -withRetries | @lemoncloud/lemon-web-core

Function withRetries

  • withRetries(attempt, nthTry, delay): ((...args) => Promise<any>)

  • Parameters

    • attempt: any
    • nthTry: number
    • delay: number

    Returns ((...args) => Promise<any>)

      • (...args): Promise<any>

      • Parameters

        • Rest ...args: any[]

        Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file +withRetries | @lemoncloud/lemon-web-core

Function withRetries

  • withRetries(attempt, nthTry, delay): ((...args) => Promise<any>)

  • Parameters

    • attempt: any
    • nthTry: number
    • delay: number

    Returns ((...args) => Promise<any>)

      • (...args): Promise<any>

      • Parameters

        • Rest ...args: any[]

        Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/ChangeSiteBody.html b/interfaces/ChangeSiteBody.html index 23464c3..bc46358 100644 --- a/interfaces/ChangeSiteBody.html +++ b/interfaces/ChangeSiteBody.html @@ -1,6 +1,6 @@ ChangeSiteBody | @lemoncloud/lemon-web-core

Interface ChangeSiteBody

Represents the body of the request to change the user site.

-
interface ChangeSiteBody {
    siteId: string;
    userId: string;
}

Properties

siteId +
interface ChangeSiteBody {
    siteId: string;
    userId: string;
}

Properties

siteId userId

Properties

siteId

siteId: string

The ID of the site to switch to.

-

userId

userId: string

The ID of the user.

-

Settings

Member Visibility

Theme

On This Page

siteIduserId
\ No newline at end of file +

userId

userId: string

The ID of the user.

+

Settings

Member Visibility

Theme

On This Page

siteIduserId
\ No newline at end of file diff --git a/interfaces/FormatInterface.html b/interfaces/FormatInterface.html index d9dcb30..380ac89 100644 --- a/interfaces/FormatInterface.html +++ b/interfaces/FormatInterface.html @@ -1,5 +1,5 @@ -FormatInterface | @lemoncloud/lemon-web-core

Interface FormatInterface

interface FormatInterface {
    namespaceFormat: string;
    textFormat: string;
    timestampFormat: string;
    typeFormat: string;
}

Properties

namespaceFormat +FormatInterface | @lemoncloud/lemon-web-core

Interface FormatInterface

interface FormatInterface {
    namespaceFormat: string;
    textFormat: string;
    timestampFormat: string;
    typeFormat: string;
}

Properties

namespaceFormat textFormat timestampFormat typeFormat -

Properties

namespaceFormat

namespaceFormat: string

textFormat

textFormat: string

timestampFormat

timestampFormat: string

typeFormat

typeFormat: string

Settings

Member Visibility

Theme

On This Page

namespaceFormattextFormattimestampFormattypeFormat
\ No newline at end of file +

Properties

namespaceFormat

namespaceFormat: string

textFormat

textFormat: string

timestampFormat

timestampFormat: string

typeFormat

typeFormat: string

Settings

Member Visibility

Theme

On This Page

namespaceFormattextFormattimestampFormattypeFormat
\ No newline at end of file diff --git a/interfaces/HttpRequestData.html b/interfaces/HttpRequestData.html index 5a0938d..8f3321b 100644 --- a/interfaces/HttpRequestData.html +++ b/interfaces/HttpRequestData.html @@ -1,10 +1,10 @@ HttpRequestData | @lemoncloud/lemon-web-core

Interface HttpRequestData

Defines the structure of an HTTP request.

-
interface HttpRequestData {
    body?: Body;
    method: string;
    params?: Params;
    path?: string;
}

Properties

body? +
interface HttpRequestData {
    body?: Body;
    method: string;
    params?: Params;
    path?: string;
}

Properties

body? method params? path?

Properties

Optional body

body?: Body

The request body.

-

method

method: string

The HTTP method (e.g., GET, POST, PUT, etc.).

-

Optional params

params?: Params

The query parameters of the request.

-

Optional path

path?: string

The path of the request URL.

-

Settings

Member Visibility

Theme

On This Page

bodymethodparamspath
\ No newline at end of file +

method

method: string

The HTTP method (e.g., GET, POST, PUT, etc.).

+

Optional params

params?: Params

The query parameters of the request.

+

Optional path

path?: string

The path of the request URL.

+

Settings

Member Visibility

Theme

On This Page

bodymethodparamspath
\ No newline at end of file diff --git a/interfaces/HttpResponse.html b/interfaces/HttpResponse.html index 04ca61d..b8d7af5 100644 --- a/interfaces/HttpResponse.html +++ b/interfaces/HttpResponse.html @@ -1,7 +1,7 @@ -HttpResponse | @lemoncloud/lemon-web-core

Interface HttpResponse<T>

interface HttpResponse<T> {
    config?: any;
    data: T;
    headers?: any;
    request?: any;
    status: number;
    statusText: string;
}

Type Parameters

  • T = any

Properties

config? +HttpResponse | @lemoncloud/lemon-web-core

Interface HttpResponse<T>

interface HttpResponse<T> {
    config?: any;
    data: T;
    headers?: any;
    request?: any;
    status: number;
    statusText: string;
}

Type Parameters

  • T = any

Properties

config? data headers? request? status statusText -

Properties

Optional config

config?: any

data

data: T

Optional headers

headers?: any

Optional request

request?: any

status

status: number

statusText

statusText: string

Settings

Member Visibility

Theme

On This Page

configdataheadersrequeststatusstatusText
\ No newline at end of file +

Properties

Optional config

config?: any

data

data: T

Optional headers

headers?: any

Optional request

request?: any

status

status: number

statusText

statusText: string

Settings

Member Visibility

Theme

On This Page

configdataheadersrequeststatusstatusText
\ No newline at end of file diff --git a/interfaces/LemonCredentials.html b/interfaces/LemonCredentials.html index e126875..a08d7ed 100644 --- a/interfaces/LemonCredentials.html +++ b/interfaces/LemonCredentials.html @@ -1,14 +1,14 @@ LemonCredentials | @lemoncloud/lemon-web-core

Interface LemonCredentials

Represents the credentials associated with an OAuth token.

-
interface LemonCredentials {
    AccessKeyId: string;
    Expiration?: string;
    SecretKey: string;
    SessionToken?: string;
    clientId?: string;
    hostKey?: string;
}

Properties

AccessKeyId +
interface LemonCredentials {
    AccessKeyId: string;
    Expiration?: string;
    SecretKey: string;
    SessionToken?: string;
    clientId?: string;
    hostKey?: string;
}

Properties

AccessKeyId Expiration? SecretKey SessionToken? clientId? hostKey?

Properties

AccessKeyId

AccessKeyId: string

The Access Key ID.

-

Optional Expiration

Expiration?: string

The expiration time of the credentials (optional).

-

SecretKey

SecretKey: string

The Secret Key.

-

Optional SessionToken

SessionToken?: string

The session token associated with the credentials (optional).

-

Optional clientId

clientId?: string

The client id for Azure (optional).

-

Optional hostKey

hostKey?: string

The host key associated with the credentials for Azure (optional).

-

Settings

Member Visibility

Theme

On This Page

AccessKeyIdExpirationSecretKeySessionTokenclientIdhostKey
\ No newline at end of file +

Optional Expiration

Expiration?: string

The expiration time of the credentials (optional).

+

SecretKey

SecretKey: string

The Secret Key.

+

Optional SessionToken

SessionToken?: string

The session token associated with the credentials (optional).

+

Optional clientId

clientId?: string

The client id for Azure (optional).

+

Optional hostKey

hostKey?: string

The host key associated with the credentials for Azure (optional).

+

Settings

Member Visibility

Theme

On This Page

AccessKeyIdExpirationSecretKeySessionTokenclientIdhostKey
\ No newline at end of file diff --git a/interfaces/LemonKMS.html b/interfaces/LemonKMS.html index 363fb3a..684559c 100644 --- a/interfaces/LemonKMS.html +++ b/interfaces/LemonKMS.html @@ -1,3 +1,3 @@ LemonKMS | @lemoncloud/lemon-web-core

Interface LemonKMS

Represents the ARN of a KMS key in AWS.

-
interface LemonKMS {
    arn: string;
}

Properties

arn -

Properties

arn

arn: string

Settings

Member Visibility

Theme

On This Page

arn
\ No newline at end of file +
interface LemonKMS {
    arn: string;
}

Properties

arn +

Properties

arn

arn: string

Settings

Member Visibility

Theme

On This Page

arn
\ No newline at end of file diff --git a/interfaces/LemonOAuthToken.html b/interfaces/LemonOAuthToken.html index 8ba03bb..816a076 100644 --- a/interfaces/LemonOAuthToken.html +++ b/interfaces/LemonOAuthToken.html @@ -1,5 +1,5 @@ LemonOAuthToken | @lemoncloud/lemon-web-core

Interface LemonOAuthToken

Represents an OAuth token returned by Lemon.

-
interface LemonOAuthToken {
    accessToken?: string;
    accountId: string;
    authId: string;
    credential: LemonCredentials;
    error?: any;
    identityId: string;
    identityPoolId?: string;
    identityToken: string;
}

Properties

accessToken? +
interface LemonOAuthToken {
    accessToken?: string;
    accountId: string;
    authId: string;
    credential: LemonCredentials;
    error?: any;
    identityId: string;
    identityPoolId?: string;
    identityToken: string;
}

Properties

accessToken? accountId authId credential @@ -8,11 +8,11 @@ identityPoolId? identityToken

Properties

Optional accessToken

accessToken?: string

The access token associated with the token (optional).

-

accountId

accountId: string

The account ID associated with the token.

-

authId

authId: string

The authentication ID associated with the token.

-

credential

credential: LemonCredentials

The credentials associated with the token.

-

Optional error

error?: any

Any error information associated with the token (optional).

-

identityId

identityId: string

The identity ID associated with the token.

-

Optional identityPoolId

identityPoolId?: string

The identity pool ID associated with the token (optional).

-

identityToken

identityToken: string

The identity token associated with the token.

-

Settings

Member Visibility

Theme

On This Page

accessTokenaccountIdauthIdcredentialerroridentityIdidentityPoolIdidentityToken
\ No newline at end of file +

accountId

accountId: string

The account ID associated with the token.

+

authId

authId: string

The authentication ID associated with the token.

+

credential

credential: LemonCredentials

The credentials associated with the token.

+

Optional error

error?: any

Any error information associated with the token (optional).

+

identityId

identityId: string

The identity ID associated with the token.

+

Optional identityPoolId

identityPoolId?: string

The identity pool ID associated with the token (optional).

+

identityToken

identityToken: string

The identity token associated with the token.

+

Settings

Member Visibility

Theme

On This Page

accessTokenaccountIdauthIdcredentialerroridentityIdidentityPoolIdidentityToken
\ No newline at end of file diff --git a/interfaces/LemonRefreshToken.html b/interfaces/LemonRefreshToken.html index f810a8e..e343129 100644 --- a/interfaces/LemonRefreshToken.html +++ b/interfaces/LemonRefreshToken.html @@ -1,10 +1,10 @@ LemonRefreshToken | @lemoncloud/lemon-web-core

Interface LemonRefreshToken

Interface representing a Lemon refresh token.

-
interface LemonRefreshToken {
    accountId: string;
    authId: string;
    credential: LemonCredentials;
    identityId: string;
}

Properties

accountId +
interface LemonRefreshToken {
    accountId: string;
    authId: string;
    credential: LemonCredentials;
    identityId: string;
}

Properties

accountId authId credential identityId

Properties

accountId

accountId: string

The account ID associated with the refresh token.

-

authId

authId: string

The authentication ID associated with the refresh token.

-

credential

credential: LemonCredentials

The credentials associated with the refresh token.

-

identityId

identityId: string

The identity ID associated with the refresh token.

-

Settings

Member Visibility

Theme

On This Page

accountIdauthIdcredentialidentityId
\ No newline at end of file +

authId

authId: string

The authentication ID associated with the refresh token.

+

credential

credential: LemonCredentials

The credentials associated with the refresh token.

+

identityId

identityId: string

The identity ID associated with the refresh token.

+

Settings

Member Visibility

Theme

On This Page

accountIdauthIdcredentialidentityId
\ No newline at end of file diff --git a/interfaces/LogInterface.html b/interfaces/LogInterface.html index da0f8c4..7994dfc 100644 --- a/interfaces/LogInterface.html +++ b/interfaces/LogInterface.html @@ -1,5 +1,5 @@ -LogInterface | @lemoncloud/lemon-web-core

Interface LogInterface

interface LogInterface {
    debug(message, ...extraParams): void;
    error(message, ...extraParams): void;
    info(message, ...extraParams): void;
    warn(message, ...extraParams): void;
}

Implemented by

Methods

debug +LogInterface | @lemoncloud/lemon-web-core

Interface LogInterface

interface LogInterface {
    debug(message, ...extraParams): void;
    error(message, ...extraParams): void;
    info(message, ...extraParams): void;
    warn(message, ...extraParams): void;
}

Implemented by

Methods

debug error info warn -

Methods

debug

  • debug(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

error

  • error(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

info

  • info(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

warn

  • warn(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

debugerrorinfowarn
\ No newline at end of file +

Methods

debug

  • debug(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

error

  • error(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

info

  • info(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

warn

  • warn(message, ...extraParams): void

  • Parameters

    • message: string
    • Rest ...extraParams: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

debugerrorinfowarn
\ No newline at end of file diff --git a/interfaces/LoggerOption.html b/interfaces/LoggerOption.html index eb3ad64..aae2444 100644 --- a/interfaces/LoggerOption.html +++ b/interfaces/LoggerOption.html @@ -1,6 +1,6 @@ LoggerOption | @lemoncloud/lemon-web-core

Interface LoggerOption

Options for configuring the logger behavior.

-
interface LoggerOption {
    showLogType?: boolean;
    showTimestamp?: boolean;
}

Properties

showLogType? +
interface LoggerOption {
    showLogType?: boolean;
    showTimestamp?: boolean;
}

Properties

showLogType? showTimestamp?

Properties

Optional showLogType

showLogType?: boolean

Whether to show log types (e.g., info, error) in the log output.

-

Optional showTimestamp

showTimestamp?: boolean

Whether to show timestamps in the log output.

-

Settings

Member Visibility

Theme

On This Page

showLogTypeshowTimestamp
\ No newline at end of file +

Optional showTimestamp

showTimestamp?: boolean

Whether to show timestamps in the log output.

+

Settings

Member Visibility

Theme

On This Page

showLogTypeshowTimestamp
\ No newline at end of file diff --git a/interfaces/RefreshTokenBody.html b/interfaces/RefreshTokenBody.html index cfc1391..e5ee6e9 100644 --- a/interfaces/RefreshTokenBody.html +++ b/interfaces/RefreshTokenBody.html @@ -1,8 +1,8 @@ RefreshTokenBody | @lemoncloud/lemon-web-core

Interface RefreshTokenBody

Interface representing the body of a refresh token request.

-
interface RefreshTokenBody {
    current: string;
    domain?: string;
    signature: string;
}

Properties

current +
interface RefreshTokenBody {
    current: string;
    domain?: string;
    signature: string;
}

Properties

current domain? signature

Properties

current

current: string

The current token.

-

Optional domain

domain?: string

Optional. The domain of the token.

-

signature

signature: string

The signature of the token.

-

Settings

Member Visibility

Theme

On This Page

currentdomainsignature
\ No newline at end of file +

Optional domain

domain?: string

Optional. The domain of the token.

+

signature

signature: string

The signature of the token.

+

Settings

Member Visibility

Theme

On This Page

currentdomainsignature
\ No newline at end of file diff --git a/interfaces/SignaturePayload.html b/interfaces/SignaturePayload.html index b419035..6a34827 100644 --- a/interfaces/SignaturePayload.html +++ b/interfaces/SignaturePayload.html @@ -1,10 +1,10 @@ SignaturePayload | @lemoncloud/lemon-web-core

Interface SignaturePayload

The payload used for signature generation.

-
interface SignaturePayload {
    accountId?: string;
    authId?: string;
    identityId?: string;
    identityToken?: string;
}

Properties

accountId? +
interface SignaturePayload {
    accountId?: string;
    authId?: string;
    identityId?: string;
    identityToken?: string;
}

Properties

accountId? authId? identityId? identityToken?

Properties

Optional accountId

accountId?: string

The account ID.

-

Optional authId

authId?: string

The authentication ID.

-

Optional identityId

identityId?: string

The identity ID.

-

Optional identityToken

identityToken?: string

The identity token.

-

Settings

Member Visibility

Theme

On This Page

accountIdauthIdidentityIdidentityToken
\ No newline at end of file +

Optional authId

authId?: string

The authentication ID.

+

Optional identityId

identityId?: string

The identity ID.

+

Optional identityToken

identityToken?: string

The identity token.

+

Settings

Member Visibility

Theme

On This Page

accountIdauthIdidentityIdidentityToken
\ No newline at end of file diff --git a/interfaces/Storage.html b/interfaces/Storage.html index 3e17e6c..6e7f5ee 100644 --- a/interfaces/Storage.html +++ b/interfaces/Storage.html @@ -1,16 +1,16 @@ Storage | @lemoncloud/lemon-web-core

Interface Storage

Interface for storage operations.

-
interface Storage {
    getItem(key, ...params): any;
    removeItem(key, ...params): any;
    setItem(key, value, ...params): any;
}

Methods

getItem +
interface Storage {
    getItem(key, ...params): any;
    removeItem(key, ...params): any;
    setItem(key, value, ...params): any;
}

Methods

getItem removeItem setItem

Methods

getItem

  • getItem(key, ...params): any

  • Get the value associated with the given key.

    Parameters

    • key: string

      The key to retrieve the value for.

    • Rest ...params: any

      Additional parameters for the operation.

    Returns any

    The value associated with the given key.

    -

removeItem

  • removeItem(key, ...params): any

  • Remove the value associated with the given key.

    +

removeItem

  • removeItem(key, ...params): any

  • Remove the value associated with the given key.

    Parameters

    • key: string

      The key to remove the value for.

    • Rest ...params: any

      Additional parameters for the operation.

      -

    Returns any

setItem

  • setItem(key, value, ...params): any

  • Set the value for the given key.

    +

Returns any

setItem

  • setItem(key, value, ...params): any

  • Set the value for the given key.

    Parameters

    • key: string

      The key to set the value for.

    • value: string

      The value to be stored.

    • Rest ...params: any

      Additional parameters for the operation.

      -

    Returns any

Settings

Member Visibility

Theme

On This Page

getItemremoveItemsetItem
\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

On This Page

getItemremoveItemsetItem
\ No newline at end of file diff --git a/interfaces/TokenSignature.html b/interfaces/TokenSignature.html index be49ef8..c1bde7a 100644 --- a/interfaces/TokenSignature.html +++ b/interfaces/TokenSignature.html @@ -1,10 +1,10 @@ TokenSignature | @lemoncloud/lemon-web-core

Interface TokenSignature

The token signature object.

-
interface TokenSignature {
    authId: string;
    current: string;
    originToken: LemonOAuthToken;
    signature: string;
}

Properties

authId +
interface TokenSignature {
    authId: string;
    current: string;
    originToken: LemonOAuthToken;
    signature: string;
}

Properties

authId current originToken signature

Properties

authId

authId: string

The authentication ID.

-

current

current: string

The current token.

-

originToken

originToken: LemonOAuthToken

The original token.

-

signature

signature: string

The signature of the token.

-

Settings

Member Visibility

Theme

On This Page

authIdcurrentoriginTokensignature
\ No newline at end of file +

current

current: string

The current token.

+

originToken

originToken: LemonOAuthToken

The original token.

+

signature

signature: string

The signature of the token.

+

Settings

Member Visibility

Theme

On This Page

authIdcurrentoriginTokensignature
\ No newline at end of file diff --git a/interfaces/WebCoreService.html b/interfaces/WebCoreService.html index 7b8ab84..98a8e96 100644 --- a/interfaces/WebCoreService.html +++ b/interfaces/WebCoreService.html @@ -1,5 +1,5 @@ WebCoreService | @lemoncloud/lemon-web-core

Interface WebCoreService

Interface representing a web core service.

-
interface WebCoreService {
    getSavedToken(): Promise<{
        [key: string]: string;
    }>;
    isAuthenticated(): Promise<boolean>;
    logout(): Promise<void>;
    setUseXLemonIdentity(use): void;
}

Implemented by

Methods

getSavedToken +
interface WebCoreService {
    getSavedToken(): Promise<{
        [key: string]: string;
    }>;
    isAuthenticated(): Promise<boolean>;
    logout(): Promise<void>;
    setUseXLemonIdentity(use): void;
}

Implemented by

Methods

getSavedToken isAuthenticated logout setUseXLemonIdentity @@ -7,14 +7,14 @@

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

  • A promise that resolves to an object containing the saved token.
-

isAuthenticated

  • isAuthenticated(): Promise<boolean>

  • Checks if the user is authenticated.

    +

isAuthenticated

  • isAuthenticated(): Promise<boolean>

  • Checks if the user is authenticated.

    Returns Promise<boolean>

    • A promise that resolves to true if the user is authenticated, false otherwise.
    -

logout

logout

  • logout(): Promise<void>

  • Logs out the user.

    Returns Promise<void>

    • A promise that resolves when the user is logged out.
    -

setUseXLemonIdentity

  • setUseXLemonIdentity(use): void

  • Sets the use of X-Lemon-Identity.

    +

setUseXLemonIdentity

  • setUseXLemonIdentity(use): void

  • Sets the use of X-Lemon-Identity.

    Parameters

    • use: boolean

      Whether to use X-Lemon-Identity.

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

getSavedTokenisAuthenticatedlogoutsetUseXLemonIdentity
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

getSavedTokenisAuthenticatedlogoutsetUseXLemonIdentity
\ No newline at end of file diff --git a/types/AWSWebCoreState.html b/types/AWSWebCoreState.html index f57a592..3bae76f 100644 --- a/types/AWSWebCoreState.html +++ b/types/AWSWebCoreState.html @@ -1,2 +1,2 @@ AWSWebCoreState | @lemoncloud/lemon-web-core

Type alias AWSWebCoreState

AWSWebCoreState: "no-token" | "refreshed" | "build"

Represents the state of the AWS Web Core service.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/AzureWebCoreState.html b/types/AzureWebCoreState.html index b238f25..2d141b5 100644 --- a/types/AzureWebCoreState.html +++ b/types/AzureWebCoreState.html @@ -1,2 +1,2 @@ AzureWebCoreState | @lemoncloud/lemon-web-core

Type alias AzureWebCoreState

AzureWebCoreState: "no-token" | "has-token"

Represents the state of the Azure Web Core service.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Body.html b/types/Body.html index 304eb8e..4bbc18f 100644 --- a/types/Body.html +++ b/types/Body.html @@ -1,2 +1,2 @@ Body | @lemoncloud/lemon-web-core

Type alias Body

Body: {
    [key: string]: any;
}

Represents the body of an HTTP request, which can contain any key-value pairs.

-

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/CloudProvider.html b/types/CloudProvider.html index 15e0369..0d3bf4d 100644 --- a/types/CloudProvider.html +++ b/types/CloudProvider.html @@ -1,2 +1,2 @@ CloudProvider | @lemoncloud/lemon-web-core

Type alias CloudProvider

CloudProvider: keyof WebCoreServiceMap

Type representing a cloud provider.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Headers.html b/types/Headers.html index baaf201..06e27da 100644 --- a/types/Headers.html +++ b/types/Headers.html @@ -1,2 +1,2 @@ Headers | @lemoncloud/lemon-web-core

Type alias Headers

Headers: {
    [key: string]: any;
}

Represents the headers of an HTTP request, which can contain any key-value pairs.

-

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Params.html b/types/Params.html index 254ad1d..4204e81 100644 --- a/types/Params.html +++ b/types/Params.html @@ -1,2 +1,2 @@ Params | @lemoncloud/lemon-web-core

Type alias Params

Params: {
    [key: string]: any;
}

Represents the query parameters of an HTTP request, which can contain any key-value pairs.

-

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/WebCoreConfig.html b/types/WebCoreConfig.html index d673f38..fe45c63 100644 --- a/types/WebCoreConfig.html +++ b/types/WebCoreConfig.html @@ -1,3 +1,3 @@ WebCoreConfig | @lemoncloud/lemon-web-core

Type alias WebCoreConfig<T>

WebCoreConfig<T>: {
    cloud: T;
    oAuthEndpoint: string;
    project: string;
    region?: string;
    storage?: Storage;
}

Type representing the configuration for the web core.

Type Parameters

Type declaration

  • cloud: T
  • oAuthEndpoint: string
  • project: string
  • Optional region?: string
  • Optional storage?: Storage

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

  • cloud: T
  • oAuthEndpoint: string
  • project: string
  • Optional region?: string
  • Optional storage?: Storage

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/WebCoreConstructor.html b/types/WebCoreConstructor.html index 2b48115..5a6397e 100644 --- a/types/WebCoreConstructor.html +++ b/types/WebCoreConstructor.html @@ -1,3 +1,3 @@ WebCoreConstructor | @lemoncloud/lemon-web-core

Type alias WebCoreConstructor<T>

WebCoreConstructor<T>: (new (config) => T)

Type representing a constructor for a web core service.

Type Parameters

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/WebCoreServiceMap.html b/types/WebCoreServiceMap.html index 38c36a2..93dfb65 100644 --- a/types/WebCoreServiceMap.html +++ b/types/WebCoreServiceMap.html @@ -1,2 +1,2 @@ WebCoreServiceMap | @lemoncloud/lemon-web-core

Type alias WebCoreServiceMap

WebCoreServiceMap: {
    aws: AWSWebCore;
    azure: AzureWebCore;
}

Type representing a map of web core services.

-

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/BROWSER_COLORS.html b/variables/BROWSER_COLORS.html index d6d430d..cce119c 100644 --- a/variables/BROWSER_COLORS.html +++ b/variables/BROWSER_COLORS.html @@ -1 +1 @@ -BROWSER_COLORS | @lemoncloud/lemon-web-core

Variable BROWSER_COLORSConst

BROWSER_COLORS: {
    Black: string;
    Blue: string;
    Cyan: string;
    Green: string;
    Grey: string;
    Magenta: string;
    Red: string;
    White: string;
    Yellow: string;
} = ...

Type declaration

  • Black: string
  • Blue: string
  • Cyan: string
  • Green: string
  • Grey: string
  • Magenta: string
  • Red: string
  • White: string
  • Yellow: string

Settings

Member Visibility

Theme

\ No newline at end of file +BROWSER_COLORS | @lemoncloud/lemon-web-core

Variable BROWSER_COLORSConst

BROWSER_COLORS: {
    Black: string;
    Blue: string;
    Cyan: string;
    Green: string;
    Grey: string;
    Magenta: string;
    Red: string;
    White: string;
    Yellow: string;
} = ...

Type declaration

  • Black: string
  • Blue: string
  • Cyan: string
  • Green: string
  • Grey: string
  • Magenta: string
  • Red: string
  • White: string
  • Yellow: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/NODE_COLORS.html b/variables/NODE_COLORS.html index 4994af1..30e9d1c 100644 --- a/variables/NODE_COLORS.html +++ b/variables/NODE_COLORS.html @@ -1 +1 @@ -NODE_COLORS | @lemoncloud/lemon-web-core

Variable NODE_COLORSConst

NODE_COLORS: {
    Black: number;
    Blue: number;
    Cyan: number;
    Green: number;
    Grey: number;
    Magenta: number;
    Red: number;
    White: number;
    Yellow: number;
} = ...

Type declaration

  • Black: number
  • Blue: number
  • Cyan: number
  • Green: number
  • Grey: number
  • Magenta: number
  • Red: number
  • White: number
  • Yellow: number

Settings

Member Visibility

Theme

\ No newline at end of file +NODE_COLORS | @lemoncloud/lemon-web-core

Variable NODE_COLORSConst

NODE_COLORS: {
    Black: number;
    Blue: number;
    Cyan: number;
    Green: number;
    Grey: number;
    Magenta: number;
    Red: number;
    White: number;
    Yellow: number;
} = ...

Type declaration

  • Black: number
  • Blue: number
  • Cyan: number
  • Green: number
  • Grey: number
  • Magenta: number
  • Red: number
  • White: number
  • Yellow: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/REGION_KEY.html b/variables/REGION_KEY.html index d642c3d..1359970 100644 --- a/variables/REGION_KEY.html +++ b/variables/REGION_KEY.html @@ -1 +1 @@ -REGION_KEY | @lemoncloud/lemon-web-core

Variable REGION_KEYConst

REGION_KEY: "region" = 'region'

Settings

Member Visibility

Theme

\ No newline at end of file +REGION_KEY | @lemoncloud/lemon-web-core

Variable REGION_KEYConst

REGION_KEY: "region" = 'region'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/USE_X_LEMON_IDENTITY_KEY.html b/variables/USE_X_LEMON_IDENTITY_KEY.html index f995f6c..5027c7a 100644 --- a/variables/USE_X_LEMON_IDENTITY_KEY.html +++ b/variables/USE_X_LEMON_IDENTITY_KEY.html @@ -1 +1 @@ -USE_X_LEMON_IDENTITY_KEY | @lemoncloud/lemon-web-core

Variable USE_X_LEMON_IDENTITY_KEYConst

USE_X_LEMON_IDENTITY_KEY: "use_x_lemon_identity_key" = 'use_x_lemon_identity_key'

Settings

Member Visibility

Theme

\ No newline at end of file +USE_X_LEMON_IDENTITY_KEY | @lemoncloud/lemon-web-core

Variable USE_X_LEMON_IDENTITY_KEYConst

USE_X_LEMON_IDENTITY_KEY: "use_x_lemon_identity_key" = 'use_x_lemon_identity_key'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/sigV4Client.html b/variables/sigV4Client.html index f83e0f6..23308c2 100644 --- a/variables/sigV4Client.html +++ b/variables/sigV4Client.html @@ -1 +1 @@ -sigV4Client | @lemoncloud/lemon-web-core

Variable sigV4ClientConst

sigV4Client: {
    [key: string]: any;
} = {}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file +sigV4Client | @lemoncloud/lemon-web-core

Variable sigV4ClientConst

sigV4Client: {
    [key: string]: any;
} = {}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

\ No newline at end of file