@salesforce/commerce-sdk-react 3.3.0-dev → 3.3.0-extensibility-preview.4

package/CHANGELOG.md

@@ -1,6 +1,10 @@
+## v3.3.0-extensibility-preview.4 (Feb 12, 2025)
+- Add `ServerContext` type for `useServerContext` hook [#2239](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2239)
+
 ## v3.3.0-dev (Feb 18, 2025)
 - Invalidate cache instead of removing cache when triggering logout [#2323](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2323)
 - Fix dependencies vulnerabilities [#2338](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2338)
+- Allow custom parameters/body to be passed to SLAS authorize/authenticate calls via commerce-sdk-react auth helpers [#2358](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2358)
 
 ## v3.2.1 (Mar 05, 2025)
 - Update PWA-Kit SDKs to v3.9.1 [#2301](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2301)

package/auth/index.d.ts

@@ -24,6 +24,16 @@ type LoginIDPUserParams = Parameters<Helpers['loginIDPUser']>[2];
 type AuthorizePasswordlessParams = Parameters<Helpers['authorizePasswordless']>[2];
 type LoginPasswordlessParams = Parameters<Helpers['getPasswordLessAccessToken']>[2];
 type LoginRegisteredUserB2CCredentials = Parameters<Helpers['loginRegisteredUserB2C']>[1];
+/**
+ * This is a temporary type until we can make a breaking change and modify the signature for
+ * loginRegisteredUserB2C so that it takes in a body rather than just credentials
+ *
+ */
+type LoginRegisteredUserCredentialsWithCustomParams = LoginRegisteredUserB2CCredentials & {
+    options?: {
+        body: helpers.CustomRequestBody;
+    };
+};
 /**
  * The extended field is not from api response, we manually store the auth type,
  * so we don't need to make another API call when we already have the data.
@@ -199,7 +209,7 @@ declare class Auth {
      * A wrapper method for commerce-sdk-isomorphic helper: loginGuestUser.
      *
      */
-    loginGuestUser(): Promise<ShopperLoginTypes.TokenResponse>;
+    loginGuestUser(parameters?: helpers.CustomQueryParameters): Promise<ShopperLoginTypes.TokenResponse>;
     /**
      * This is a wrapper method for ShopperCustomer API registerCustomer endpoint.
      *
@@ -302,8 +312,14 @@ declare class Auth {
     /**
      * A wrapper method for commerce-sdk-isomorphic helper: loginRegisteredUserB2C.
      *
+     * Note: This uses the type LoginRegisteredUserCredentialsWithCustomParams rather than LoginRegisteredUserB2CCredentials
+     * as a workaround to allow custom parameters through because the login.mutateAsync hook will only pass through a single
+     * 'body' argument into this function.
+     *
+     * In the next major version release, we should modify this method so that it's input is a body containing credentials,
+     * similar to the input for the register function.
      */
-    loginRegisteredUserB2C(credentials: LoginRegisteredUserB2CCredentials): Promise<helpers.TokenResponse>;
+    loginRegisteredUserB2C(credentials: LoginRegisteredUserCredentialsWithCustomParams): Promise<helpers.TokenResponse>;
     /**
      * Trusted agent authorization
      *

package/auth/index.js

@@ -9,6 +9,9 @@ var _jwtDecode = require("jwt-decode");
 var _storage = require("./storage");
 var _utils = require("../utils");
 var _constant = require("../constant");
+const _excluded = ["customer", "password"];
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
 function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -21,6 +24,12 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+/**
+ * This is a temporary type until we can make a breaking change and modify the signature for
+ * loginRegisteredUserB2C so that it takes in a body rather than just credentials
+ *
+ */
+
 /**
  * The extended field is not from api response, we manually store the auth type,
  * so we don't need to make another API call when we already have the data.
@@ -692,7 +701,7 @@ class Auth {
    * A wrapper method for commerce-sdk-isomorphic helper: loginGuestUser.
    *
    */
-  loginGuestUser() {
+  loginGuestUser(parameters) {
     var _this6 = this;
     return _asyncToGenerator(function* () {
       if (_this6.clientSecret && (0, _utils.onClient)() && _this6.clientSecret !== _constant.SLAS_SECRET_PLACEHOLDER) {
@@ -710,12 +719,12 @@ class Auth {
       }), {
         clientSecret: _this6.clientSecret
       }];
-      const guestPublicArgs = [_this6.client, _objectSpread({
+      const guestPublicArgs = [_this6.client, _objectSpread(_objectSpread({
         redirectURI: _this6.redirectURI,
         dnt: dntPref
       }, usid && {
         usid
-      })];
+      }), parameters)];
       const callback = _this6.clientSecret ? () => _commerceSdkIsomorphic.helpers.loginGuestUserPrivate(...guestPrivateArgs) : () => _commerceSdkIsomorphic.helpers.loginGuestUser(...guestPublicArgs);
       try {
         return yield _this6.queueRequest(callback, isGuest);
@@ -740,11 +749,14 @@ class Auth {
     var _this7 = this;
     return _asyncToGenerator(function* () {
       const {
-        customer: {
-          login
-        },
-        password
-      } = body;
+          customer,
+          password
+        } = body,
+        parameters = _objectWithoutProperties(body, _excluded);
+      const {
+        login
+      } = customer;
+      const customParameters = (0, _utils.extractCustomParameters)(parameters);
 
       // login is optional field from isomorphic library
       // type CustomerRegistration
@@ -752,15 +764,24 @@ class Auth {
       if (!login) {
         throw new Error('Customer registration is missing login field.');
       }
+
+      // The registerCustomer endpoint currently does not support custom parameters
+      // so we make sure not to send any custom params here
       const res = yield _this7.shopperCustomersClient.registerCustomer({
         headers: {
           authorization: `Bearer ${_this7.get('access_token')}`
         },
-        body
+        body: {
+          customer,
+          password
+        }
       });
       yield _this7.loginRegisteredUserB2C({
         username: login,
-        password
+        password,
+        options: {
+          body: customParameters
+        }
       });
       return res;
     })();
@@ -769,6 +790,12 @@ class Auth {
   /**
    * A wrapper method for commerce-sdk-isomorphic helper: loginRegisteredUserB2C.
    *
+   * Note: This uses the type LoginRegisteredUserCredentialsWithCustomParams rather than LoginRegisteredUserB2CCredentials
+   * as a workaround to allow custom parameters through because the login.mutateAsync hook will only pass through a single
+   * 'body' argument into this function.
+   *
+   * In the next major version release, we should modify this method so that it's input is a body containing credentials,
+   * similar to the input for the register function.
    */
   loginRegisteredUserB2C(credentials) {
     var _this8 = this;
@@ -782,14 +809,16 @@ class Auth {
         includeDefaults: true
       });
       const isGuest = false;
-      const token = yield _commerceSdkIsomorphic.helpers.loginRegisteredUserB2C(_this8.client, _objectSpread(_objectSpread({}, credentials), {}, {
+      const token = yield _commerceSdkIsomorphic.helpers.loginRegisteredUserB2C(_this8.client, {
+        username: credentials.username,
+        password: credentials.password,
         clientSecret: _this8.clientSecret
-      }), _objectSpread({
+      }, _objectSpread({
         redirectURI,
         dnt: dntPref
       }, usid && {
         usid
-      }));
+      }), credentials.options);
       _this8.handleTokenResponse(token, isGuest);
       if ((0, _utils.onClient)()) {
         void _this8.clearECOMSession();
@@ -956,15 +985,16 @@ class Auth {
     return _asyncToGenerator(function* () {
       const redirectURI = parameters.redirectURI || _this14.redirectURI;
       const usid = _this14.get('usid');
+      const customParameters = (0, _utils.extractCustomParameters)(parameters);
       const {
         url,
         codeVerifier
-      } = yield _commerceSdkIsomorphic.helpers.authorizeIDP(_this14.client, _objectSpread({
+      } = yield _commerceSdkIsomorphic.helpers.authorizeIDP(_this14.client, _objectSpread(_objectSpread({
         redirectURI,
         hint: parameters.hint
       }, usid && {
         usid
-      }), _this14.isPrivate);
+      }), customParameters), _this14.isPrivate);
       if ((0, _utils.onClient)()) {
         window.location.assign(url);
       } else {

package/hooks/types.d.ts

@@ -144,5 +144,10 @@ export type TMutationVariables = {
         [key: string]: string;
     };
 } | void;
+export type ServerContext = {
+    req: {
+        originalUrl?: string;
+    };
+};
 export {};
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/commerce-sdk-react",
-  "version": "3.3.0-dev",
+  "version": "3.3.0-extensibility-preview.4",
   "description": "A library that provides react hooks for fetching data from Commerce Cloud",
   "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/ecom-react-hooks#readme",
   "bugs": {
@@ -40,12 +40,12 @@
     "version": "node ./scripts/version.js"
   },
   "dependencies": {
-    "commerce-sdk-isomorphic": "^3.2.0",
+    "commerce-sdk-isomorphic": "^3.3.0",
     "js-cookie": "^3.0.1",
     "jwt-decode": "^4.0.0"
   },
   "devDependencies": {
-    "@salesforce/pwa-kit-dev": "3.10.0-dev",
+    "@salesforce/pwa-kit-dev": "4.0.0-extensibility-preview.4",
     "@tanstack/react-query": "^4.28.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
@@ -60,7 +60,7 @@
     "@types/react-helmet": "~6.1.6",
     "@types/react-router-dom": "~5.3.3",
     "cross-env": "^5.2.1",
-    "internal-lib-build": "3.10.0-dev",
+    "internal-lib-build": "4.0.0-extensibility-preview.4",
     "jsonwebtoken": "^9.0.0",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
@@ -90,5 +90,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "d86dc7bea3fe03a0f475ecf1a0ab878374f07026"
+  "gitHead": "5ad3b1f0e598cfe0fbdec5b1212b4dabc0a8733c"
 }

package/provider.d.ts

@@ -20,6 +20,7 @@ export interface CommerceApiProviderProps extends ApiClientConfigParams {
     passwordlessLoginCallbackURI?: string;
     refreshTokenRegisteredCookieTTL?: number;
     refreshTokenGuestCookieTTL?: number;
+    OCAPISessionsURL?: string;
 }
 /**
  * @internal

package/utils.d.ts

@@ -1,4 +1,5 @@
 import { CookieAttributes } from 'js-cookie';
+import { helpers } from 'commerce-sdk-isomorphic';
 /** Utility to determine if you are on the browser (client) or not. */
 export declare const onClient: () => boolean;
 /** Detects whether the storefront is running in an iframe. */
@@ -58,4 +59,15 @@ export declare function isAbsoluteUrl(url: string): boolean;
  *   that uses `Buffer` to perform the Base64 encoding.
  */
 export declare const stringToBase64: typeof btoa;
+/**
+ * Extracts custom parameters from a set of SCAPI parameters
+ *
+ * Custom parameters are identified by the 'c_' prefix before their key
+ *
+ * @param parameters object containing all parameters for a SCAPI / SLAS call
+ * @returns new object containing only custom parameters
+ */
+export declare const extractCustomParameters: (parameters: {
+    [key: string]: string | number | boolean | string[] | number[];
+} | null) => helpers.CustomQueryParameters | helpers.CustomRequestBody;
 //# sourceMappingURL=utils.d.ts.map

package/utils.js

@@ -7,7 +7,7 @@ exports.DEVELOPMENT_ORIGIN = void 0;
 exports.detectCookiesAvailable = detectCookiesAvailable;
 exports.detectInIframe = void 0;
 exports.detectLocalStorageAvailable = detectLocalStorageAvailable;
-exports.getParentOrigin = exports.getDefaultCookieAttributes = exports.getCookieSameSiteAttribute = void 0;
+exports.getParentOrigin = exports.getDefaultCookieAttributes = exports.getCookieSameSiteAttribute = exports.extractCustomParameters = void 0;
 exports.isAbsoluteUrl = isAbsoluteUrl;
 exports.stringToBase64 = exports.onClient = exports.isOriginTrusted = void 0;
 var _jsCookie = _interopRequireDefault(require("js-cookie"));
@@ -154,4 +154,20 @@ function isAbsoluteUrl(url) {
  * - In a non-browser environment (like Node.js), a fallback is provided
  *   that uses `Buffer` to perform the Base64 encoding.
  */
-const stringToBase64 = exports.stringToBase64 = typeof window === 'object' && typeof window.document === 'object' ? btoa : unencoded => Buffer.from(unencoded).toString('base64');
+const stringToBase64 = exports.stringToBase64 = typeof window === 'object' && typeof window.document === 'object' ? btoa : unencoded => Buffer.from(unencoded).toString('base64');
+
+/**
+ * Extracts custom parameters from a set of SCAPI parameters
+ *
+ * Custom parameters are identified by the 'c_' prefix before their key
+ *
+ * @param parameters object containing all parameters for a SCAPI / SLAS call
+ * @returns new object containing only custom parameters
+ */
+const extractCustomParameters = parameters => {
+  if (typeof parameters !== 'object' || parameters === null) {
+    throw new Error('Invalid input. Expecting an object as an input.');
+  }
+  return Object.fromEntries(Object.entries(parameters).filter(([key]) => key.startsWith('c_')));
+};
+exports.extractCustomParameters = extractCustomParameters;