Class Auth

This class is used to handle shopper authentication. It is responsible for initializing shopper session, manage access and refresh tokens on server/browser environments. As well as providing a mechanism to queue network calls before having a valid access token.

Internal

Hierarchy

Auth

Index

Accessors

`Private` data

get data(): AuthData
Every method in this class that returns a TokenResponse constructs it via this getter.

Returns AuthData
- Defined in src/auth/index.ts:476

Constructors

constructor

new Auth(config): Auth
Parameters
- config: AuthConfig
Returns Auth
- Defined in src/auth/index.ts:269

Methods

authorizeIDP

authorizeIDP(parameters): Promise<{
codeVerifier: string;
url: string;
}>
A wrapper method for commerce-sdk-isomorphic helper: authorizeIDP. Initiates OAuth2 authorization flow for Identity Provider (IDP) login.
Parameters
- parameters: AuthorizeIDPParams
Returns Promise<{
codeVerifier: string;
url: string;
}>
- Defined in src/auth/index.ts:1191

authorizePasswordless

authorizePasswordless(parameters): Promise<Response>
A wrapper method for commerce-sdk-isomorphic helper: authorizePasswordless.
Parameters
- parameters: AuthorizePasswordlessParams
Returns Promise<Response>
- Defined in src/auth/index.ts:1262

authorizeTrustedAgent

authorizeTrustedAgent(credentials): Promise<{
codeVerifier: string;
url: string;
}>
Trusted agent authorization
Parameters
- credentials: {
  loginId?: string;
  }
  - Optional loginId?: string
Returns Promise<{
codeVerifier: string;
url: string;
}>

Warning
This method is not supported on the server, it is a client-only method.
- Defined in src/auth/index.ts:1022

`Private` clearECOMSession

clearECOMSession(): void
For Hybrid storefronts ONLY!!! This method clears the dwsid cookie from the browser. In a hybrid setup, dwsid points to an ECOM session and is passed between PWA Kit and SFRA/SG sites via "dwsid" cookie.

Whenever a registered shopper logs in on PWA Kit, we must clear the dwsid cookie if one exists. When shopper navigates to SFRA as a logged-in shopper, ECOM notices a missing DWSID, generates a new DWSID and triggers the onSession hook which uses registered shopper refresh-token and restores session and basket on SFRA.

Returns void
- Defined in src/auth/index.ts:601

`Private` clearSFRAAuthToken

clearSFRAAuthToken(): void
For Hybrid storefronts ONLY!!! This method clears out SLAS access token generated in Plugin SLAS and passed in via "cc-at" cookie.

In a hybrid setup, whenever any SLAS flow executes in Plugin SLAS and an access token is generated, the access token is sent over to PWA Kit using cc-at cookie.

PWA Kit will check to see if cc-at cookie exists, if it does, the access token value in localStorage is updated with value from the cc-at cookie and is then used for all SCAPI requests made from PWA Kit. The cc-at cookie is then cleared.

Returns void
- Defined in src/auth/index.ts:586

`Private` clearStorage

clearStorage(): void
Returns void
- Defined in src/auth/index.ts:463

`Private` convertSecondsToDate

convertSecondsToDate(seconds): Date
Converts a duration in seconds to a Date object. This function takes a number representing seconds and returns a Date object for the current time plus the given duration.
Parameters
- seconds: number
  
  The number of seconds to add to the current time.
Returns Date
A Date object for the expiration time.
- Defined in src/auth/index.ts:623

`Private` delete

delete(name): void
Parameters
- name: AuthDataKeys
Returns void
- Defined in src/auth/index.ts:380

extractResponseError

extractResponseError(error): Promise<{
responseMessage: string;
status_code: string;
}>
This method extracts the status and message from a ResponseError that is returned by commerce-sdk-isomorphic.

commerce-sdk-isomorphic throws a ResponseError, but doesn't export the class. We can't use instanceof, so instead we just check for the response property and assume it is a ResponseError if a response is present

Once commerce-sdk-isomorphic exports ResponseError we can revisit if this method is still required.
Parameters
- error: Error
Returns Promise<{
responseMessage: string;
status_code: string;
}>
contained within the ResponseError

Throws
error if the error is not a ResponseError

Internal
- Defined in src/auth/index.ts:803

get

get(name): string
Parameters
- name: AuthDataKeys
Returns string
- Defined in src/auth/index.ts:367

`Private` getAccessToken

getAccessToken(): string
Returns the SLAS access token or an empty string if the access token is not found in local store or if SFRA wants PWA to trigger refresh token login.

On PWA-only sites, this returns the access token from local storage. On Hybrid sites, this checks whether SFRA has sent an auth token via cookies. Returns an access token from SFRA if it exist. If not, the access token from local store is returned.

This is only used within this Auth module since other modules consider the access token from this.get('access_token') to be the source of truth.

Returns string
access token
- Defined in src/auth/index.ts:516

getDnt

getDnt(options?): undefined | boolean
Return the value of the DNT cookie or undefined if it is not set. The DNT cookie being undefined means that there is a necessity to get the user's input for consent tracking, but not that there is no DNT value to apply to analytics layers. DNT value will default to a certain value and this is reflected by effectiveDnt.

If the cookie value is invalid, then it will be deleted in this function.

If includeDefaults is true, then even if the cookie is not defined, defaultDnt will be returned, if it exists. If defaultDnt is not defined, then the SDK Default will return (false)
Parameters
- Optional options: DntOptions
Returns undefined | boolean
- Defined in src/auth/index.ts:399

getPasswordLessAccessToken

getPasswordLessAccessToken(parameters): Promise<TokenResponse>
A wrapper method for commerce-sdk-isomorphic helper: getPasswordLessAccessToken.
Parameters
- parameters: GetPasswordLessAccessTokenParams
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:1289

getPasswordResetToken

getPasswordResetToken(parameters): Promise<void>
A wrapper method for the SLAS endpoint: getPasswordResetToken.
Parameters
- parameters: getPasswordResetTokenBodyType
Returns Promise<void>
- Defined in src/auth/index.ts:1314

`Private` getRefreshTokenCookieTTLValue

getRefreshTokenCookieTTLValue(refreshTokenExpiresInSLASValue, isGuest): number
Retrieves our refresh token cookie ttl value from the following sources in order:
1. Override value (if set)
2. SLAS response value (if set)
3. Default value (if no override or SLAS response value is set)
Parameters
- refreshTokenExpiresInSLASValue: undefined | number
- isGuest: boolean
Returns number
- Defined in src/auth/index.ts:636

`Private` handleTokenResponse

handleTokenResponse(res, isGuest): void
This method stores the TokenResponse object retrieved from SLAS, and store the data in storage.
Parameters
- res: TokenResponse
- isGuest: boolean
Returns void
- Defined in src/auth/index.ts:662

`Private` isTokenExpired

isTokenExpired(token): boolean
Used to validate JWT token expiration.
Parameters
- token: string
Returns boolean
- Defined in src/auth/index.ts:495

logWarning

logWarning(msg): void
Parameters
- msg: string
Returns void
- Defined in src/auth/index.ts:782

loginGuestUser

loginGuestUser(parameters?): Promise<TokenResponse>
A wrapper method for commerce-sdk-isomorphic helper: loginGuestUser.
Parameters
- Optional parameters: CustomQueryParameters
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:899

loginIDPUser

loginIDPUser(parameters): Promise<TokenResponse>
A wrapper method for commerce-sdk-isomorphic helper: loginIDPUser.
Parameters
- parameters: LoginIDPUserParams
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:1230

loginRegisteredUserB2C

loginRegisteredUserB2C(body): Promise<TokenResponse>
A wrapper method for commerce-sdk-isomorphic helper: loginRegisteredUserB2C.

This method uses a body-based API similar to the register function for consistency. Supports custom parameters through the customParameters field.
Parameters
- body: LoginRegisteredUserB2CBody
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:982

loginTrustedAgent

loginTrustedAgent(credentials): Promise<TokenResponse>
Trusted agent login
Parameters
- credentials: {
      clientSecret?: string;
      code: string;
      codeVerifier?: string;
      loginId?: string;
      state?: string;
      usid?: string;
  }
  - Optional clientSecret?: string
  - code: string
  - Optional codeVerifier?: string
  - Optional loginId?: string
  - Optional state?: string
  - Optional usid?: string
Returns Promise<TokenResponse>

Warning
This method is not supported on the server, it is a client-only method.
- Defined in src/auth/index.ts:1055

logout

logout(): Promise<TokenResponse>
A wrapper method for commerce-sdk-isomorphic helper: logout.

Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:1128

parseSlasJWT

parseSlasJWT(jwt): {
    agentId: null | string;
    customerId: string;
    dnt: string;
    isAgent: boolean;
    isGuest: boolean;
    loginId: string;
    uido: string;
    usid: string;
}
Decode SLAS JWT and extract information such as customer id, usid, etc.
Parameters
- jwt: string
Returns {
    agentId: null | string;
    customerId: string;
    dnt: string;
    isAgent: boolean;
    isGuest: boolean;
    loginId: string;
    uido: string;
    usid: string;
}
- agentId: null | string
- customerId: string
- dnt: string
- isAgent: boolean
- isGuest: boolean
- loginId: string
- uido: string
- usid: string
- Defined in src/auth/index.ts:1382

queueRequest

queueRequest(fn, isGuest): Promise<TokenResponse>
This method queues the requests and handles the SLAS token response.

It returns the queue.
Parameters
- fn: (() => Promise<TokenResponse>)
  - - (): Promise<TokenResponse>
    - Returns Promise<TokenResponse>
- isGuest: boolean
Returns Promise<TokenResponse>

Internal
- Defined in src/auth/index.ts:765

ready

ready(): Promise<TokenResponse>
The ready function returns a promise that resolves with valid ShopperLogin token response.

When this method is called for the very first time, it initializes the session by following the public client auth flow to get access token for the user. The flow:
1. If we have valid access token - use it
2. If we have valid refresh token - refresh token flow
3. If we have valid TAOB access token - refresh TAOB token flow
4. PKCE flow
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:832

refreshAccessToken

refreshAccessToken(): Promise<TokenResponse>
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:694

refreshTrustedAgent

refreshTrustedAgent(loginId, usid): Promise<TokenResponse>
Parameters
- loginId: string
- usid: string
Returns Promise<TokenResponse>
- Defined in src/auth/index.ts:1115

register

register(body): Promise<Customer>
This is a wrapper method for ShopperCustomer API registerCustomer endpoint.
Parameters
- body: CustomerRegistration
Returns Promise<Customer>
- Defined in src/auth/index.ts:945

registerTrustedAgentRefreshHandler

registerTrustedAgentRefreshHandler(refreshTrustedAgentHandler): void
Trusted agent refresh handler
Parameters
- refreshTrustedAgentHandler: ((loginId?, usid?, refresh?) => Promise<TokenResponse>)
  - - (loginId?, usid?, refresh?): Promise<TokenResponse>
    - Parameters
      
      Optional loginId: string
      
      Optional usid: string
      
      Optional refresh: boolean
      
      Returns Promise<TokenResponse>
Returns void

Warning
This method is not supported on the server, it is a client-only method.
- Defined in src/auth/index.ts:1105

resetPassword

resetPassword(parameters): Promise<void>
A wrapper method for the SLAS endpoint: resetPassword.
Parameters
- parameters: resetPasswordBodyType
Returns Promise<void>
- Defined in src/auth/index.ts:1349

`Private` set

set(name, value, options?): void
Parameters
- name: AuthDataKeys
- value: string
- Optional options: unknown
Returns void
- Defined in src/auth/index.ts:373

setDnt

setDnt(preference): Promise<void>
Parameters
- preference: null | boolean
Returns Promise<void>
- Defined in src/auth/index.ts:433

updateCustomerPassword

updateCustomerPassword(body): Promise<void>
Handle updating customer password and re-log in after the access token is invalidated.
Parameters
- body: {
      currentPassword: string;
      customer: Customer;
      password: string;
      shouldReloginCurrentSession?: boolean;
  }
  - currentPassword: string
  - customer: Customer
  - password: string
  - Optional shouldReloginCurrentSession?: boolean
Returns Promise<void>
- Defined in src/auth/index.ts:1147

whenReady

whenReady<Args, Data>(fn): ((...args) => Promise<Data>)
Creates a function that only executes after a session is initialized.
Type Parameters
- Args extends unknown[]
- Data
Parameters
- fn: ((...args) => Promise<Data>)
  
  Function that needs to wait until the session is initialized.
  - - (...args): Promise<Data>
    - Parameters
      
      Rest ...args: Args
      
      Returns Promise<Data>
Returns ((...args) => Promise<Data>)
Wrapped function
- - (...args): Promise<Data>
  - Creates a function that only executes after a session is initialized.
    Parameters
    - Rest ...args: Args
    Returns Promise<Data>
    Wrapped function
- Defined in src/auth/index.ts:886

Properties

`Private` client

client: ShopperLogin<ApiClientConfigParams>

`Private` clientSecret

clientSecret: string

`Private` defaultDnt

defaultDnt: undefined | boolean

`Private` fetchedToken

fetchedToken: string

`Private` hybridAuthEnabled

hybridAuthEnabled: boolean

`Private` isPrivate

isPrivate: boolean

`Private` logger

logger: Logger

`Private` passwordlessLoginCallbackURI

passwordlessLoginCallbackURI: string

`Private` pendingToken

pendingToken: undefined | Promise<TokenResponse>

`Private` redirectURI

redirectURI: string

`Private` refreshTokenGuestCookieTTL

refreshTokenGuestCookieTTL: undefined | number

`Private` refreshTokenRegisteredCookieTTL

refreshTokenRegisteredCookieTTL: undefined | number

`Private` refreshTrustedAgentHandler

refreshTrustedAgentHandler: undefined | ((loginId, usid, refresh) => Promise<TokenResponse>)

Type declaration

- (loginId, usid, refresh): Promise<TokenResponse>
- Parameters
  - loginId: string
  - usid: string
  - refresh: boolean
  Returns Promise<TokenResponse>

`Private` shopperCustomersClient

shopperCustomersClient: ShopperCustomers<ApiClientConfigParams>

`Private` silenceWarnings

silenceWarnings: boolean

`Private` stores

stores: Record<StorageType, BaseStorage>

Class Auth

Internal

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

Private data

Returns AuthData

Constructors

constructor

Parameters

config: AuthConfig

Returns Auth

Methods

authorizeIDP

Parameters

parameters: AuthorizeIDPParams

Returns Promise<{ codeVerifier: string; url: string; }>

authorizePasswordless

Parameters

parameters: AuthorizePasswordlessParams

Returns Promise<Response>

authorizeTrustedAgent

Parameters

credentials: { loginId?: string; }

Optional loginId?: string

Returns Promise<{ codeVerifier: string; url: string; }>

Warning

Private clearECOMSession

Returns void

Private clearSFRAAuthToken

Returns void

Private clearStorage

Returns void

Private convertSecondsToDate

Parameters

seconds: number

Returns Date

Private delete

Parameters

name: AuthDataKeys

Returns void

extractResponseError

Parameters

error: Error

Returns Promise<{ responseMessage: string; status_code: string; }>

Throws

Internal

get

Parameters

name: AuthDataKeys

Returns string

Private getAccessToken

Returns string

getDnt

Parameters

Optional options: DntOptions

Returns undefined | boolean

getPasswordLessAccessToken

Parameters

parameters: GetPasswordLessAccessTokenParams

Returns Promise<TokenResponse>

getPasswordResetToken

Parameters

parameters: getPasswordResetTokenBodyType

Returns Promise<void>

Private getRefreshTokenCookieTTLValue

Parameters

refreshTokenExpiresInSLASValue: undefined | number

isGuest: boolean

Returns number

Private handleTokenResponse

Parameters

res: TokenResponse

isGuest: boolean

Returns void

Private isTokenExpired

`Private` data

Returns Promise<{
codeVerifier: string;
url: string;
}>

credentials: {
loginId?: string;
}

`Optional` loginId?: string

Returns Promise<{
codeVerifier: string;
url: string;
}>

`Private` clearECOMSession

`Private` clearSFRAAuthToken

`Private` clearStorage

`Private` convertSecondsToDate

`Private` delete

Returns Promise<{
responseMessage: string;
status_code: string;
}>

`Private` getAccessToken

`Optional` options: DntOptions

`Private` getRefreshTokenCookieTTLValue

`Private` handleTokenResponse

`Private` isTokenExpired

`Optional` parameters: CustomQueryParameters

credentials: {
clientSecret?: string;
code: string;
codeVerifier?: string;
loginId?: string;
state?: string;
usid?: string;
}

`Optional` clientSecret?: string

`Optional` codeVerifier?: string

`Optional` loginId?: string

`Optional` state?: string

`Optional` usid?: string

Returns {
agentId: null | string;
customerId: string;
dnt: string;
isAgent: boolean;
isGuest: boolean;
loginId: string;
uido: string;
usid: string;
}

`Optional` loginId: string

`Optional` usid: string