11/*
2- * Copyright (c) 2022 , Salesforce, Inc.
2+ * Copyright (c) 2023 , Salesforce, Inc.
33 * All rights reserved.
44 * SPDX-License-Identifier: BSD-3-Clause
55 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -12,11 +12,12 @@ import {
1212 ShopperCustomersTypes
1313} from 'commerce-sdk-isomorphic'
1414import jwtDecode from 'jwt-decode'
15- import { ApiClientConfigParams , Argument } from '../hooks/types'
15+ import { ApiClientConfigParams , Prettify , RemoveStringIndex } from '../hooks/types'
1616import { BaseStorage , LocalStorage , CookieStorage , MemoryStorage , StorageType } from './storage'
1717import { CustomerType } from '../hooks/useCustomerType'
1818import { onClient } from '../utils'
1919
20+ type TokenResponse = ShopperLoginTypes . TokenResponse
2021type Helpers = typeof helpers
2122interface AuthConfig extends ApiClientConfigParams {
2223 redirectURI : string
@@ -30,24 +31,25 @@ interface JWTHeaders {
3031 iat : number
3132}
3233
33- // this type is slightly different from ShopperLoginTypes.TokenResponse, reasons:
34- // 1. TokenResponse is too generic (with & {[key:string]: any}), we need a more
35- // restrictive type to make sure type safe
36- // 2. The refresh tokens are stored separately for guest and registered user. Instead
37- // of refresh_token, we have refresh_token_guest and refresh_token_registered
34+ /**
35+ * The extended field is not from api response, we manually store the auth type,
36+ * so we don't need to make another API call when we already have the data.
37+ * Plus, the getCustomer endpoint only works for registered user, it returns a 404 for a guest user,
38+ * and it's not easy to grab this info in user land, so we add it into the Auth object, and expose it via a hook
39+ */
40+ export type AuthData = Prettify <
41+ RemoveStringIndex < TokenResponse > & {
42+ customer_type : CustomerType
43+ idp_access_token : string
44+ }
45+ >
46+
47+ /** A shopper could be guest or registered, so we store the refresh tokens individually. */
3848type AuthDataKeys =
39- | 'access_token'
40- | 'customer_id'
41- | 'enc_user_id'
42- | 'expires_in'
43- | 'id_token'
44- | 'idp_access_token'
49+ | Exclude < keyof AuthData , 'refresh_token' >
4550 | 'refresh_token_guest'
4651 | 'refresh_token_registered'
47- | 'token_type'
48- | 'usid'
49- | 'site_id'
50- | 'customer_type'
52+
5153type AuthDataMap = Record <
5254 AuthDataKeys ,
5355 {
@@ -57,16 +59,6 @@ type AuthDataMap = Record<
5759 }
5860>
5961
60- /**
61- * The extended field is not from api response, we manually store the auth type,
62- * so we don't need to make another API call when we already have the data.
63- * Plus, the getCustomer endpoint only works for registered user, it returns a 404 for a guest user,
64- * and it's not easy to grab this info in user land, so we add it into the Auth object, and expose it via a hook
65- */
66- type AuthData = ShopperLoginTypes . TokenResponse & {
67- customer_type : CustomerType
68- }
69-
7062/**
7163 * A map of the data that this auth module stores. This maps the name of the property to
7264 * the storage type and the key when stored in that storage. You can also pass in a "callback"
@@ -119,10 +111,6 @@ const DATA_MAP: AuthDataMap = {
119111 store . delete ( 'cc-nx-g' )
120112 }
121113 } ,
122- site_id : {
123- storageType : 'cookie' ,
124- key : 'cc-site-id'
125- } ,
126114 customer_type : {
127115 storageType : 'local' ,
128116 key : 'customer_type'
@@ -141,7 +129,7 @@ class Auth {
141129 private client : ShopperLogin < ApiClientConfigParams >
142130 private shopperCustomersClient : ShopperCustomers < ApiClientConfigParams >
143131 private redirectURI : string
144- private pendingToken : Promise < ShopperLoginTypes . TokenResponse > | undefined
132+ private pendingToken : Promise < TokenResponse > | undefined
145133 private REFRESH_TOKEN_EXPIRATION_DAYS = 90
146134 private stores : Record < StorageType , BaseStorage >
147135 private fetchedToken : string
@@ -208,9 +196,10 @@ class Auth {
208196 }
209197
210198 private clearStorage ( ) {
211- Object . keys ( DATA_MAP ) . forEach ( ( keyName ) => {
212- type Key = keyof AuthDataMap
213- const { key, storageType} = DATA_MAP [ keyName as Key ]
199+ // Type assertion because Object.keys is silly and limited :(
200+ const keys = Object . keys ( DATA_MAP ) as AuthDataKeys [ ]
201+ keys . forEach ( ( keyName ) => {
202+ const { key, storageType} = DATA_MAP [ keyName ]
214203 const store = this . stores [ storageType ]
215204 store . delete ( key )
216205 } )
@@ -248,7 +237,7 @@ class Auth {
248237 * This method stores the TokenResponse object retrived from SLAS, and
249238 * store the data in storage.
250239 */
251- private handleTokenResponse ( res : ShopperLoginTypes . TokenResponse , isGuest : boolean ) {
240+ private handleTokenResponse ( res : TokenResponse , isGuest : boolean ) {
252241 this . set ( 'access_token' , res . access_token )
253242 this . set ( 'customer_id' , res . customer_id )
254243 this . set ( 'enc_user_id' , res . enc_user_id )
@@ -272,7 +261,7 @@ class Auth {
272261 *
273262 * @Internal
274263 */
275- async queueRequest ( fn : ( ) => Promise < ShopperLoginTypes . TokenResponse > , isGuest : boolean ) {
264+ async queueRequest ( fn : ( ) => Promise < TokenResponse > , isGuest : boolean ) {
276265 const queue = this . pendingToken ?? Promise . resolve ( )
277266 this . pendingToken = queue . then ( async ( ) => {
278267 const token = await fn ( )
@@ -331,6 +320,20 @@ class Auth {
331320 )
332321 }
333322
323+ /**
324+ * Creates a function that only executes after a session is initialized.
325+ * @param fn Function that needs to wait until the session is initialized.
326+ * @returns Wrapped function
327+ */
328+ whenReady < Args extends unknown [ ] , Data > (
329+ fn : ( ...args : Args ) => Promise < Data >
330+ ) : ( ...args : Args ) => Promise < Data > {
331+ return async ( ...args ) => {
332+ await this . ready ( )
333+ return await fn ( ...args )
334+ }
335+ }
336+
334337 /**
335338 * A wrapper method for commerce-sdk-isomorphic helper: loginGuestUser.
336339 *
0 commit comments