@salesforce/commerce-sdk-react 3.5.0-preview.1 → 4.0.0-dev

package/provider.d.ts

@@ -2,14 +2,14 @@ import React, { ReactElement } from 'react';
 import Auth from './auth';
 import { ApiClientConfigParams, ApiClients } from './hooks/types';
 import { Logger } from './types';
-import { ShopperBasketsTypes } from 'commerce-sdk-isomorphic';
+import { FetchOptions } from 'commerce-sdk-isomorphic';
 export interface CommerceApiProviderProps extends ApiClientConfigParams {
     children: React.ReactNode;
     proxy: string;
     locale: string;
     currency: string;
     redirectURI: string;
-    fetchOptions?: ShopperBasketsTypes.FetchOptions;
+    fetchOptions?: FetchOptions;
     headers?: Record<string, string>;
     fetchedToken?: string;
     enablePWAKitPrivateClient?: boolean;
@@ -23,6 +23,7 @@ export interface CommerceApiProviderProps extends ApiClientConfigParams {
     refreshTokenGuestCookieTTL?: number;
     apiClients?: ApiClients;
     disableAuthInit?: boolean;
+    hybridAuthEnabled?: boolean;
 }
 /**
  * @internal
@@ -76,6 +77,17 @@ export declare const AuthContext: React.Context<Auth>;
  * directly to the provider. However, be careful when doing this as you will have
  * to make sure the secret is not unexpectedly exposed to the client.
  *
+ *
+ * `hybridAuthEnabled` is an optional flag that indicates the current Site has Hybrid Auth enabled.
+ * This drives the behavior of the `clearECOMSession` method. If `hybridAuthEnabled` is true,
+ * the `clearECOMSession` method will not be called. This makes sure the session-bridged dwsid, received from `/oauth2/token` call
+ * on shopper login is NOT cleared and can be used to maintain the server affinity.
+ *
+ * `hybridAuthEnabled` flag can also be used to drive other Hybrid Auth specific behaviors in the future.
+ *
+ * Note: `hybridAuthEnabled` should NOT be set to true for hybrid storefronts using Plugin SLAS as we need the dwsid to be deleted
+ * to force session-bridging on SFRA as in this case, the `oauth2/token` call does not return a dwsid.
+ *
  * @returns Provider to wrap your app with
  */
 declare const CommerceApiProvider: (props: CommerceApiProviderProps) => ReactElement;

package/provider.js

@@ -79,6 +79,17 @@ const AuthContext = exports.AuthContext = /*#__PURE__*/_react.default.createCont
  * Non-PWA Kit users can enable private client mode by passing in a client secret
  * directly to the provider. However, be careful when doing this as you will have
  * to make sure the secret is not unexpectedly exposed to the client.
+ * 
+ * 
+ * `hybridAuthEnabled` is an optional flag that indicates the current Site has Hybrid Auth enabled.
+ * This drives the behavior of the `clearECOMSession` method. If `hybridAuthEnabled` is true,
+ * the `clearECOMSession` method will not be called. This makes sure the session-bridged dwsid, received from `/oauth2/token` call
+ * on shopper login is NOT cleared and can be used to maintain the server affinity.
+ * 
+ * `hybridAuthEnabled` flag can also be used to drive other Hybrid Auth specific behaviors in the future.
+ * 
+ * Note: `hybridAuthEnabled` should NOT be set to true for hybrid storefronts using Plugin SLAS as we need the dwsid to be deleted
+ * to force session-bridging on SFRA as in this case, the `oauth2/token` call does not return a dwsid.
  *
  * @returns Provider to wrap your app with
  */
@@ -106,7 +117,8 @@ const CommerceApiProvider = props => {
     refreshTokenRegisteredCookieTTL,
     refreshTokenGuestCookieTTL,
     apiClients,
-    disableAuthInit = false
+    disableAuthInit = false,
+    hybridAuthEnabled = false
   } = props;
 
   // Set the logger based on provided configuration, or default to the console object if no logger is provided
@@ -119,6 +131,7 @@ const CommerceApiProvider = props => {
       siteId,
       proxy,
       redirectURI,
+      headers,
       fetchOptions,
       fetchedToken,
       enablePWAKitPrivateClient,
@@ -129,9 +142,10 @@ const CommerceApiProvider = props => {
       defaultDnt,
       passwordlessLoginCallbackURI,
       refreshTokenRegisteredCookieTTL,
-      refreshTokenGuestCookieTTL
+      refreshTokenGuestCookieTTL,
+      hybridAuthEnabled
     });
-  }, [clientId, organizationId, shortCode, siteId, proxy, redirectURI, fetchOptions, fetchedToken, enablePWAKitPrivateClient, privateClientProxyEndpoint, clientSecret, silenceWarnings, configLogger, defaultDnt, passwordlessLoginCallbackURI, refreshTokenRegisteredCookieTTL, refreshTokenGuestCookieTTL, apiClients]);
+  }, [clientId, organizationId, shortCode, siteId, proxy, redirectURI, headers, fetchOptions, fetchedToken, enablePWAKitPrivateClient, privateClientProxyEndpoint, clientSecret, silenceWarnings, configLogger, defaultDnt, passwordlessLoginCallbackURI, refreshTokenRegisteredCookieTTL, refreshTokenGuestCookieTTL, apiClients, hybridAuthEnabled]);
   const dwsid = auth.get(_constant.DWSID_COOKIE_NAME);
   const serverAffinityHeader = {};
   if (dwsid) {
@@ -178,14 +192,6 @@ const CommerceApiProvider = props => {
       throwOnBadResponse: true,
       fetchOptions
     };
-
-    // Special proxy endpoint for injecting SLAS private client secret.
-    // This is only used by the ShopperLogin API as that is the only one that interacts with SLAS.
-    // We prioritize config.privateClientProxyEndpoint since that allows us to use the new envBasePath feature
-    // The preexisting hard coded privateClientEndpoint is kept here for now to prevent a breaking change.
-    // TODO: We should remove this in the next major release so we do not have a hard coded proxy path inside commerce-sdk-react
-    const baseUrl = config.proxy.split(_constant.MOBIFY_PATH)[0];
-    const privateClientEndpoint = `${baseUrl}${_constant.SLAS_PRIVATE_PROXY_PATH}`;
     return {
       shopperBaskets: new _commerceSdkIsomorphic.ShopperBaskets(config),
       shopperContexts: new _commerceSdkIsomorphic.ShopperContexts(config),
@@ -193,13 +199,13 @@ const CommerceApiProvider = props => {
       shopperExperience: new _commerceSdkIsomorphic.ShopperExperience(config),
       shopperGiftCertificates: new _commerceSdkIsomorphic.ShopperGiftCertificates(config),
       shopperLogin: new _commerceSdkIsomorphic.ShopperLogin(_objectSpread(_objectSpread({}, config), {}, {
-        proxy: enablePWAKitPrivateClient ? privateClientProxyEndpoint ? privateClientProxyEndpoint : privateClientEndpoint : config.proxy
+        proxy: enablePWAKitPrivateClient ? privateClientProxyEndpoint : config.proxy
       })),
       shopperOrders: new _commerceSdkIsomorphic.ShopperOrders(config),
       shopperProducts: new _commerceSdkIsomorphic.ShopperProducts(config),
       shopperPromotions: new _commerceSdkIsomorphic.ShopperPromotions(config),
       shopperSearch: new _commerceSdkIsomorphic.ShopperSearch(config),
-      shopperSeo: new _commerceSdkIsomorphic.ShopperSeo(config),
+      shopperSeo: new _commerceSdkIsomorphic.ShopperSEO(config),
       shopperStores: new _commerceSdkIsomorphic.ShopperStores(config)
     };
   }, [clientId, organizationId, shortCode, siteId, proxy, fetchOptions, locale, currency, headers === null || headers === void 0 ? void 0 : headers['correlation-id'], apiClients]);

package/utils.d.ts

@@ -25,7 +25,7 @@ export declare const isOriginTrusted: (origin: string | undefined) => boolean;
  * @returns `undefined` if running on the server, `"none"` if running as an iframe on a trusted site
  * (i.e. Storefront Preview), otherwise `"Lax"`
  */
-export declare const getCookieSameSiteAttribute: () => "Lax" | "none" | undefined;
+export declare const getCookieSameSiteAttribute: () => "none" | "Lax" | undefined;
 /**
  * Gets the default cookie attributes. Sets the secure flag unless running on localhost in Safari.
  * Sets the sameSite attribute to `"none"` when running in a trusted iframe.