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

package/hooks/ShopperLogin/paramKeys.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    getUserInfo: readonly ["organizationId", "channel_id"];
+    getWellknownOpenidConfiguration: readonly ["organizationId"];
+    getJwksUri: readonly ["organizationId"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperLogin/paramKeys.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2023, 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 getUserInfo = ['organizationId', 'channel_id'];
+const getWellknownOpenidConfiguration = ['organizationId'];
+const getJwksUri = ['organizationId'];
+var _default = exports.default = {
+  getUserInfo,
+  getWellknownOpenidConfiguration,
+  getJwksUri
+};

package/hooks/ShopperLogin/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.
@@ -39,6 +45,9 @@ const useUserInfo = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -52,7 +61,9 @@ const useUserInfo = (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
@@ -80,6 +91,9 @@ const useWellknownOpenidConfiguration = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -93,7 +107,9 @@ const useWellknownOpenidConfiguration = (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
@@ -121,6 +137,9 @@ const useJwksUri = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -134,7 +153,9 @@ const useJwksUri = (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/ShopperLogin/queryKeyHelpers.d.ts

@@ -28,11 +28,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/ShopperLogin/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getWellknownOpenidConfiguration = exports.getUserInfo = exports.getJwksUri = 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,17 +20,23 @@ var _utils = require("../utils");
 // and making those generic would add too much complexity.
 
 const getUserInfo = exports.getUserInfo = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'channel_id']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/oauth2/userinfo'],
-  queryKey: params => [...getUserInfo.path(params), getUserInfo.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getUserInfo'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getUserInfo.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getWellknownOpenidConfiguration = exports.getWellknownOpenidConfiguration = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/oauth2/.well-known/openid-configuration'],
-  queryKey: params => [...getWellknownOpenidConfiguration.path(params), getWellknownOpenidConfiguration.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getWellknownOpenidConfiguration'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getWellknownOpenidConfiguration.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getJwksUri = exports.getJwksUri = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/oauth2/jwks'],
-  queryKey: params => [...getJwksUri.path(params), getJwksUri.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getJwksUri'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getJwksUri.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperOrders/paramKeys.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    getOrder: readonly ["organizationId", "orderNo", "siteId", "locale"];
+    getPaymentMethodsForOrder: readonly ["organizationId", "orderNo", "siteId", "locale"];
+    getTaxesFromOrder: readonly ["organizationId", "orderNo", "siteId"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperOrders/paramKeys.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2023, 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 getOrder = ['organizationId', 'orderNo', 'siteId', 'locale'];
+const getPaymentMethodsForOrder = ['organizationId', 'orderNo', 'siteId', 'locale'];
+const getTaxesFromOrder = ['organizationId', 'orderNo', 'siteId'];
+var _default = exports.default = {
+  getOrder,
+  getPaymentMethodsForOrder,
+  getTaxesFromOrder
+};

package/hooks/ShopperOrders/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.
@@ -39,6 +45,9 @@ const useOrder = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -52,7 +61,9 @@ const useOrder = (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
@@ -80,6 +91,9 @@ const usePaymentMethodsForOrder = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -93,7 +107,9 @@ const usePaymentMethodsForOrder = (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
@@ -123,6 +139,9 @@ const useTaxesFromOrder = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -136,7 +155,9 @@ const useTaxesFromOrder = (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/ShopperOrders/queryKeyHelpers.d.ts

@@ -33,11 +33,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/ShopperOrders/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getTaxesFromOrder = exports.getPaymentMethodsForOrder = exports.getOrder = 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,17 +20,23 @@ var _utils = require("../utils");
 // and making those generic would add too much complexity.
 
 const getOrder = exports.getOrder = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'orderNo', 'siteId', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/orders/', params.orderNo],
-  queryKey: params => [...getOrder.path(params), getOrder.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getOrder'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getOrder.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getPaymentMethodsForOrder = exports.getPaymentMethodsForOrder = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'orderNo', 'siteId', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/orders/', params.orderNo, '/payment-methods'],
-  queryKey: params => [...getPaymentMethodsForOrder.path(params), getPaymentMethodsForOrder.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPaymentMethodsForOrder'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPaymentMethodsForOrder.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getTaxesFromOrder = exports.getTaxesFromOrder = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'orderNo', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/orders/', params.orderNo, '/taxes'],
-  queryKey: params => [...getTaxesFromOrder.path(params), getTaxesFromOrder.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getTaxesFromOrder'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getTaxesFromOrder.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperProducts/paramKeys.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    getProducts: readonly ["organizationId", "ids", "inventoryIds", "select", "currency", "expand", "locale", "allImages", "perPricebook", "siteId"];
+    getProduct: readonly ["organizationId", "id", "inventoryIds", "currency", "expand", "locale", "allImages", "perPricebook", "siteId"];
+    getCategories: readonly ["organizationId", "ids", "levels", "locale", "siteId"];
+    getCategory: readonly ["organizationId", "id", "levels", "locale", "siteId"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperProducts/paramKeys.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2023, 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 getProducts = ['organizationId', 'ids', 'inventoryIds', 'select', 'currency', 'expand', 'locale', 'allImages', 'perPricebook', 'siteId'];
+const getProduct = ['organizationId', 'id', 'inventoryIds', 'currency', 'expand', 'locale', 'allImages', 'perPricebook', 'siteId'];
+const getCategories = ['organizationId', 'ids', 'levels', 'locale', 'siteId'];
+const getCategory = ['organizationId', 'id', 'levels', 'locale', 'siteId'];
+var _default = exports.default = {
+  getProducts,
+  getProduct,
+  getCategories,
+  getCategory
+};

package/hooks/ShopperProducts/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.
@@ -39,6 +45,9 @@ const useProducts = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -52,7 +61,9 @@ const useProducts = (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
@@ -80,6 +91,9 @@ const useProduct = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -93,7 +107,9 @@ const useProduct = (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
@@ -121,6 +137,9 @@ const useCategories = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -134,7 +153,9 @@ const useCategories = (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
@@ -164,6 +185,9 @@ const useCategory = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -177,7 +201,9 @@ const useCategory = (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/ShopperProducts/queryKeyHelpers.d.ts

@@ -37,11 +37,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/ShopperProducts/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getProducts = exports.getProduct = exports.getCategory = exports.getCategories = 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,22 +20,30 @@ var _utils = require("../utils");
 // and making those generic would add too much complexity.
 
 const getProducts = exports.getProducts = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'ids', 'inventoryIds', 'currency', 'expand', 'locale', 'allImages', 'perPricebook', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/products'],
-  queryKey: params => [...getProducts.path(params), getProducts.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getProducts'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getProducts.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getProduct = exports.getProduct = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'id', 'inventoryIds', 'currency', 'expand', 'locale', 'allImages', 'perPricebook', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/products/', params.id],
-  queryKey: params => [...getProduct.path(params), getProduct.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getProduct'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getProduct.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCategories = exports.getCategories = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'ids', 'levels', 'locale', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/categories'],
-  queryKey: params => [...getCategories.path(params), getCategories.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCategories'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCategories.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCategory = exports.getCategory = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'id', 'levels', 'locale', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/categories/', params.id],
-  queryKey: params => [...getCategory.path(params), getCategory.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCategory'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCategory.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperPromotions/paramKeys.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    getPromotionsForCampaign: readonly ["organizationId", "campaignId", "siteId", "startDate", "endDate", "currency"];
+    getPromotions: readonly ["organizationId", "siteId", "ids", "locale"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperPromotions/paramKeys.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2023, 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 getPromotionsForCampaign = ['organizationId', 'campaignId', 'siteId', 'startDate', 'endDate', 'currency'];
+const getPromotions = ['organizationId', 'siteId', 'ids', 'locale'];
+var _default = exports.default = {
+  getPromotionsForCampaign,
+  getPromotions
+};

package/hooks/ShopperPromotions/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.
@@ -39,6 +45,9 @@ const usePromotions = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -52,7 +61,9 @@ const usePromotions = (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
@@ -84,6 +95,9 @@ const usePromotionsForCampaign = (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));
+  // get param keys for the api from netOptions
+  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 () {
@@ -97,7 +111,9 @@ const usePromotionsForCampaign = (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/ShopperPromotions/queryKeyHelpers.d.ts

@@ -22,11 +22,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. */