@salesforce/commerce-sdk-react 1.3.0 → 1.4.0-dev

package/hooks/ShopperPromotions/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getPromotionsForCampaign = exports.getPromotions = void 0;
 var _utils = require("../utils");
+var _paramKeys = _interopRequireDefault(require("./paramKeys"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /*
  * Copyright (c) 2023, Salesforce, Inc.
  * All rights reserved.
@@ -18,12 +20,16 @@ var _utils = require("../utils");
 // and making those generic would add too much complexity.
 
 const getPromotions = exports.getPromotions = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'siteId', 'ids', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/promotions'],
-  queryKey: params => [...getPromotions.path(params), getPromotions.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPromotions'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPromotions.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getPromotionsForCampaign = exports.getPromotionsForCampaign = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'campaignId', 'siteId', 'startDate', 'endDate', 'currency']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/promotions/campaigns/', params.campaignId],
-  queryKey: params => [...getPromotionsForCampaign.path(params), getPromotionsForCampaign.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPromotionsForCampaign'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPromotionsForCampaign.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperSearch/paramKeys.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    productSearch: readonly ["organizationId", "siteId", "q", "refine", "sort", "currency", "locale", "expand", "offset", "limit"];
+    getSearchSuggestions: readonly ["organizationId", "siteId", "q", "limit", "currency", "locale"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperSearch/paramKeys.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * 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
+ */
+const productSearch = ['organizationId', 'siteId', 'q', 'refine', 'sort', 'currency', 'locale', 'expand', 'offset', 'limit'];
+const getSearchSuggestions = ['organizationId', 'siteId', 'q', 'limit', 'currency', 'locale'];
+var _default = exports.default = {
+  productSearch,
+  getSearchSuggestions
+};

package/hooks/ShopperSearch/query.js

@@ -8,9 +8,15 @@ var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
 var _useQuery = require("../useQuery");
 var _utils = require("../utils");
 var queryKeyHelpers = _interopRequireWildcard(require("./queryKeyHelpers"));
+var _paramKeys = _interopRequireDefault(require("./paramKeys"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } /*
  * Copyright (c) 2023, Salesforce, Inc.
@@ -42,6 +48,8 @@ const useProductSearch = (apiOptions, queryOptions = {}) => {
   // Parameters can be set in `apiOptions` or `client.clientConfig`;
   // we must merge them in order to generate the correct query key.
   const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const paramKeys = [..._paramKeys.default[methodName], ...(0, _utils.getCustomKeys)(netOptions.parameters)];
+  const parameters = (0, _utils.pick)(netOptions.parameters, paramKeys);
   const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
   // We don't use `netOptions` here because we manipulate the options in `useQuery`.
   const method = /*#__PURE__*/function () {
@@ -55,7 +63,9 @@ const useProductSearch = (apiOptions, queryOptions = {}) => {
 
   // For some reason, if we don't explicitly set these generic parameters, the inferred type for
   // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
-  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+  return (0, _useQuery.useQuery)(_objectSpread(_objectSpread({}, netOptions), {}, {
+    parameters
+  }), queryOptions, {
     method,
     queryKey,
     requiredParameters
@@ -85,6 +95,8 @@ const useSearchSuggestions = (apiOptions, queryOptions = {}) => {
   // Parameters can be set in `apiOptions` or `client.clientConfig`;
   // we must merge them in order to generate the correct query key.
   const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const paramKeys = [..._paramKeys.default[methodName], ...(0, _utils.getCustomKeys)(netOptions.parameters)];
+  const parameters = (0, _utils.pick)(netOptions.parameters, paramKeys);
   const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
   // We don't use `netOptions` here because we manipulate the options in `useQuery`.
   const method = /*#__PURE__*/function () {
@@ -98,7 +110,9 @@ const useSearchSuggestions = (apiOptions, queryOptions = {}) => {
 
   // For some reason, if we don't explicitly set these generic parameters, the inferred type for
   // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
-  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
+  return (0, _useQuery.useQuery)(_objectSpread(_objectSpread({}, netOptions), {}, {
+    parameters
+  }), queryOptions, {
     method,
     queryKey,
     requiredParameters

package/hooks/ShopperSearch/queryKeyHelpers.d.ts

@@ -21,11 +21,6 @@ export type QueryKeys = {
     ];
 };
 type QueryKeyHelper<T extends keyof QueryKeys> = {
-    /**
-     * Reduces the given parameters (which may have additional, unknown properties) to an object
-     * containing *only* the properties required for an endpoint.
-     */
-    parameters: (params: Params<T>) => Params<T>;
     /** Generates the path component of the query key for an endpoint. */
     path: (params: Params<T>) => ExcludeTail<QueryKeys[T]>;
     /** Generates the full query key for an endpoint. */

package/hooks/ShopperSearch/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.productSearch = exports.getSearchSuggestions = void 0;
 var _utils = require("../utils");
+var _paramKeys = _interopRequireDefault(require("./paramKeys"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /*
  * Copyright (c) 2023, Salesforce, Inc.
  * All rights reserved.
@@ -18,12 +20,16 @@ var _utils = require("../utils");
 // and making those generic would add too much complexity.
 
 const productSearch = exports.productSearch = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'siteId', 'q', 'refine', 'sort', 'currency', 'locale', 'expand', 'offset', 'limit']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/product-search'],
-  queryKey: params => [...productSearch.path(params), productSearch.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['productSearch'], ...(0, _utils.getCustomKeys)(params)];
+    return [...productSearch.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getSearchSuggestions = exports.getSearchSuggestions = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'siteId', 'q', 'limit', 'currency', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/search-suggestions'],
-  queryKey: params => [...getSearchSuggestions.path(params), getSearchSuggestions.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getSearchSuggestions'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getSearchSuggestions.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperSeo/index.d.ts

@@ -0,0 +1,2 @@
+export * from './query';
+//# sourceMappingURL=index.d.ts.map

package/hooks/ShopperSeo/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _query = require("./query");
+Object.keys(_query).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _query[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _query[key];
+    }
+  });
+});

package/hooks/ShopperSeo/paramKeys.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    getUrlMapping: readonly ["organizationId", "urlSegment", "siteId", "locale"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperSeo/paramKeys.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * 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
+ */
+
+const getUrlMapping = ['organizationId', 'urlSegment', 'siteId', 'locale'];
+var _default = exports.default = {
+  getUrlMapping
+};

package/hooks/ShopperSeo/query.d.ts

@@ -0,0 +1,20 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
+type Client = ApiClients['shopperSeo'];
+/**
+ * Gets URL mapping information for a URL that a shopper clicked or typed in.
+ *
+ * The mapping information is based on URL rules and redirects set up in Business Manager.
+ * For more information about prerequisites and sample usage, see [URL Resolution](https://developer.salesforce.com/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks.
+ * @group ShopperSeo
+ * @category Query
+ * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
+ * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
+ * @returns A TanStack Query query hook with data from the Shopper Seo `getUrlMapping` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-seo?meta=getUrlMapping| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperseo.shopperseo-1.html#geturlmapping | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+export declare const useUrlMapping: (apiOptions: NullableParameters<Argument<Client['getUrlMapping']>>, queryOptions?: ApiQueryOptions<Client['getUrlMapping']>) => UseQueryResult<DataType<Client['getUrlMapping']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map

package/hooks/ShopperSeo/query.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUrlMapping = void 0;
+var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
+var _useQuery = require("../useQuery");
+var _utils = require("../utils");
+var queryKeyHelpers = _interopRequireWildcard(require("./queryKeyHelpers"));
+var _paramKeys = _interopRequireDefault(require("./paramKeys"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } /*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * 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
+ */
+/**
+ * Gets URL mapping information for a URL that a shopper clicked or typed in.
+ *
+ * The mapping information is based on URL rules and redirects set up in Business Manager.
+ * For more information about prerequisites and sample usage, see [URL Resolution](https://developer.salesforce.com/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks.
+ * @group ShopperSeo
+ * @category Query
+ * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
+ * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
+ * @returns A TanStack Query query hook with data from the Shopper Seo `getUrlMapping` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-seo?meta=getUrlMapping| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperseo.shopperseo-1.html#geturlmapping | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+ * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
+ */
+const useUrlMapping = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperSeo: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getUrlMapping';
+  const requiredParameters = ['organizationId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const paramKeys = [..._paramKeys.default[methodName], ...(0, _utils.getCustomKeys)(netOptions.parameters)];
+  const parameters = (0, _utils.pick)(netOptions.parameters, paramKeys);
+  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+
+  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
+  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
+  return (0, _useQuery.useQuery)(_objectSpread(_objectSpread({}, netOptions), {}, {
+    parameters
+  }), queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+exports.useUrlMapping = useUrlMapping;

package/hooks/ShopperSeo/queryKeyHelpers.d.ts

@@ -0,0 +1,24 @@
+import type { ShopperSeo } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+type Client = ShopperSeo<{
+    shortCode: string;
+}>;
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
+    getUrlMapping: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/url-mapping',
+        Params<'getUrlMapping'>
+    ];
+};
+type QueryKeyHelper<T extends keyof QueryKeys> = {
+    /** Generates the path component of the query key for an endpoint. */
+    path: (params: Params<T>) => ExcludeTail<QueryKeys[T]>;
+    /** Generates the full query key for an endpoint. */
+    queryKey: (params: Params<T>) => QueryKeys[T];
+};
+export declare const getUrlMapping: QueryKeyHelper<'getUrlMapping'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map

package/hooks/ShopperSeo/queryKeyHelpers.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getUrlMapping = void 0;
+var _utils = require("../utils");
+var _paramKeys = _interopRequireDefault(require("./paramKeys"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * 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
+ */
+
+// We must use a client with no parameters in order to have required/optional match the API spec
+
+// This is defined here, rather than `types.ts`, because it relies on `Client` and `QueryKeys`,
+// and making those generic would add too much complexity.
+
+const getUrlMapping = exports.getUrlMapping = {
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/url-mapping'],
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getUrlMapping'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getUrlMapping.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
+};

package/hooks/index.d.ts

@@ -8,6 +8,7 @@ export * from './ShopperOrders';
 export * from './ShopperProducts';
 export * from './ShopperPromotions';
 export * from './ShopperSearch';
+export * from './ShopperSeo';
 export * from './useAuthHelper';
 export { default as useAccessToken } from './useAccessToken';
 export { default as useCommerceApi } from './useCommerceApi';

package/hooks/index.js

@@ -167,6 +167,18 @@ Object.keys(_ShopperSearch).forEach(function (key) {
     }
   });
 });
+var _ShopperSeo = require("./ShopperSeo");
+Object.keys(_ShopperSeo).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _ShopperSeo[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _ShopperSeo[key];
+    }
+  });
+});
 var _useAuthHelper = require("./useAuthHelper");
 Object.keys(_useAuthHelper).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/hooks/types.d.ts

@@ -1,5 +1,5 @@
 import { InvalidateQueryFilters, QueryFilters, Updater, UseQueryOptions } from '@tanstack/react-query';
-import { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch } from 'commerce-sdk-isomorphic';
+import { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSeo } from 'commerce-sdk-isomorphic';
 /** Makes a type easier to read. */
 export type Prettify<T extends object> = NonNullable<Pick<T, keyof T>>;
 /**
@@ -55,6 +55,7 @@ export interface ApiClients {
     shopperProducts: ShopperProducts<ApiClientConfigParams>;
     shopperPromotions: ShopperPromotions<ApiClientConfigParams>;
     shopperSearch: ShopperSearch<ApiClientConfigParams>;
+    shopperSeo: ShopperSeo<ApiClientConfigParams>;
 }
 export type ApiClient = ApiClients[keyof ApiClients];
 /**

package/hooks/useLocalStorage.d.ts

@@ -1,7 +1,6 @@
 type Value = string | null;
 /**
  * @internal
- *
  */
 declare function useLocalStorage(key: string): Value;
 export default useLocalStorage;

package/hooks/useLocalStorage.js

@@ -14,27 +14,37 @@ var _react = require("react");
 
 /**
  * @internal
- *
+ */
+const readValue = key => {
+  // TODO: Use detectLocalStorageAvailable when app can better handle clients without storage
+  if (typeof window === 'undefined') {
+    return null;
+  }
+  return window.localStorage.getItem(key);
+};
+
+/**
+ * @internal
+ */
+const subscribeToLocalStorage = callback => {
+  window.addEventListener('storage', callback);
+  return () => window.removeEventListener('storage', callback);
+};
+
+/**
+ * @internal
+ */
+const getLocalStorageServerSnapshot = () => {
+  // local storage is not available on the server
+  return null;
+};
+
+/**
+ * @internal
  */
 function useLocalStorage(key) {
-  const readValue = () => {
-    // TODO: Use detectLocalStorageAvailable when app can better handle clients without storage
-    if (typeof window === 'undefined') {
-      return null;
-    }
-    return window.localStorage.getItem(key);
-  };
-  const [storedValue, setStoredValue] = (0, _react.useState)(readValue);
-  const handleStorageChange = event => {
-    if (event.key !== key) {
-      return;
-    }
-    setStoredValue(readValue());
-  };
-  (0, _react.useEffect)(() => {
-    window.addEventListener('storage', handleStorageChange);
-    return () => window.removeEventListener('storage', handleStorageChange);
-  }, []);
-  return storedValue;
+  const getLocalStorageSnapshot = () => readValue(key);
+  const store = (0, _react.useSyncExternalStore)(subscribeToLocalStorage, getLocalStorageSnapshot, getLocalStorageServerSnapshot);
+  return store;
 }
 var _default = exports.default = useLocalStorage;

package/hooks/utils.d.ts

@@ -29,4 +29,6 @@ export declare const omitNullableParameters: <T extends {
 }>(obj: T) => OmitNullableParameters<T>;
 /** Simple deep clone utility */
 export declare const clone: <T>(val: T) => T;
+/** get a list of custom key starting with c_**/
+export declare const getCustomKeys: <T extends object>(obj: T) => `c_${string}`[];
 //# sourceMappingURL=utils.d.ts.map

package/hooks/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateCache = exports.pick = exports.pathStartsWith = exports.omitNullableParameters = exports.omitNullable = exports.mergeOptions = exports.isObject = exports.hasAllKeys = exports.clone = exports.and = exports.NotImplementedError = void 0;
+exports.updateCache = exports.pick = exports.pathStartsWith = exports.omitNullableParameters = exports.omitNullable = exports.mergeOptions = exports.isObject = exports.hasAllKeys = exports.getCustomKeys = exports.clone = exports.and = exports.NotImplementedError = 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; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -122,4 +122,13 @@ const clone = val => {
   const entries = Object.entries(val).map(([k, v]) => [k, clone(v)]);
   return Object.fromEntries(entries);
 };
-exports.clone = clone;
+
+/** get a list of custom key starting with c_**/
+exports.clone = clone;
+const getCustomKeys = obj => {
+  if (typeof obj !== 'object' || obj === null) {
+    throw new Error('Invalid input. Expecting an object as an input.');
+  }
+  return Object.keys(obj).filter(key => key.startsWith('c_'));
+};
+exports.getCustomKeys = getCustomKeys;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/commerce-sdk-react",
-  "version": "1.3.0",
+  "version": "1.4.0-dev",
   "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": "^1.10.4",
+    "commerce-sdk-isomorphic": "^1.12.0",
     "js-cookie": "^3.0.1",
     "jwt-decode": "^4.0.0"
   },
   "devDependencies": {
-    "@salesforce/pwa-kit-dev": "3.4.0",
+    "@salesforce/pwa-kit-dev": "3.5.0-alpha.0",
     "@tanstack/react-query": "^4.28.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
@@ -59,7 +59,7 @@
     "@types/react-helmet": "~6.1.6",
     "@types/react-router-dom": "~5.3.3",
     "cross-env": "^5.2.1",
-    "internal-lib-build": "3.4.0",
+    "internal-lib-build": "3.5.0-alpha.0",
     "jsonwebtoken": "^9.0.0",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
@@ -89,5 +89,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "acb019e60609a5e5ef11ba40aedfa94beee4e515"
+  "gitHead": "0edd6b2ea26b9c23502755b6ccc7316a538a4c7a"
 }

package/provider.js

@@ -105,7 +105,8 @@ const CommerceApiProvider = props => {
       shopperOrders: new _commerceSdkIsomorphic.ShopperOrders(config),
       shopperProducts: new _commerceSdkIsomorphic.ShopperProducts(config),
       shopperPromotions: new _commerceSdkIsomorphic.ShopperPromotions(config),
-      shopperSearch: new _commerceSdkIsomorphic.ShopperSearch(config)
+      shopperSearch: new _commerceSdkIsomorphic.ShopperSearch(config),
+      shopperSeo: new _commerceSdkIsomorphic.ShopperSeo(config)
     };
   }, [clientId, organizationId, shortCode, siteId, proxy, fetchOptions, locale, currency, headers === null || headers === void 0 ? void 0 : headers['correlation-id']]);
   const auth = (0, _react.useMemo)(() => {