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

Accessors

data

Constructors

constructor

Methods

clearStorage createOCAPISession get handleTokenResponse isTokenExpired loginGuestUser loginRegisteredUserB2C logout parseSlasJWT queueRequest ready register set whenReady

Properties

OCAPISessionsURL REFRESH_TOKEN_EXPIRATION_DAYS client fetchedToken pendingToken redirectURI shopperCustomersClient stores

Accessors

Private data

Constructors

constructor

Methods

Private clearStorage

createOCAPISession

  • Make a post request to the OCAPI /session endpoint to bridge the session.

    The HTTP response contains a set-cookie header which sets the dwsid session cookie. This cookie is used on SFRA, and it allows shoppers to navigate between SFRA and this PWA site seamlessly; this is often used to enable hybrid deployment.

    (Note: this method is client side only, b/c MRT doesn't support set-cookie header right now)

    Returns Promise<Response>

get

Private handleTokenResponse

  • This method stores the TokenResponse object retrived from SLAS, and store the data in storage.

    Parameters

    Returns void

Private isTokenExpired

  • Used to validate JWT token expiration.

    Parameters

    • token: string

    Returns boolean

loginGuestUser

loginRegisteredUserB2C

  • A wrapper method for commerce-sdk-isomorphic helper: loginRegisteredUserB2C.

    Parameters

    • credentials: {
          password: string;
          username: string;
      }
      • password: string
      • username: string

    Returns Promise<TokenResponse>

logout

parseSlasJWT

  • Decode SLAS JWT and extract information such as customer id, usid, etc.

    Parameters

    • jwt: string

    Returns {
        customerId: string;
        isGuest: boolean;
        usid: string;
    }

    • customerId: string
    • isGuest: boolean
    • usid: string

queueRequest

ready

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

    Returns Promise<TokenResponse>

register

Private set

whenReady

  • 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

Properties

Private OCAPISessionsURL

OCAPISessionsURL: string

Private REFRESH_TOKEN_EXPIRATION_DAYS

REFRESH_TOKEN_EXPIRATION_DAYS: number = 90

Private client

client: ShopperLogin<ApiClientConfigParams>

Private fetchedToken

fetchedToken: string

Private pendingToken

pendingToken: undefined | Promise<TokenResponse>

Private redirectURI

redirectURI: string

Private shopperCustomersClient

shopperCustomersClient: ShopperCustomers<ApiClientConfigParams>

Private stores

stores: Record<StorageType, BaseStorage>

Settings

Member Visibility

Theme

On This Page