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

package/hooks/ShopperCustomers/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.
@@ -77,10 +83,10 @@ const useCustomer = (apiOptions, queryOptions = {}) => {
   } = (0, _useCommerceApi.default)();
   const methodName = 'getCustomer';
   const requiredParameters = ['organizationId', 'customerId', '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));
+  // 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 () {
@@ -94,7 +100,9 @@ const useCustomer = (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
@@ -122,6 +130,9 @@ const useCustomerAddress = (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 () {
@@ -135,7 +146,9 @@ const useCustomerAddress = (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
@@ -163,6 +176,9 @@ const useCustomerBaskets = (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 () {
@@ -173,10 +189,11 @@ const useCustomerBaskets = (apiOptions, queryOptions = {}) => {
       return _ref3.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)(netOptions, queryOptions, {
+  return (0, _useQuery.useQuery)(_objectSpread(_objectSpread({}, netOptions), {}, {
+    parameters
+  }), queryOptions, {
     method,
     queryKey,
     requiredParameters
@@ -206,8 +223,11 @@ const useCustomerOrders = (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`.
+  // We don't use `netOptions` here because we manipulate the option in `useQuery`.
   const method = /*#__PURE__*/function () {
     var _ref4 = _asyncToGenerator(function* (options) {
       return yield client[methodName](options);
@@ -219,7 +239,9 @@ const useCustomerOrders = (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
@@ -247,6 +269,9 @@ const useCustomerPaymentInstrument = (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 () {
@@ -260,7 +285,9 @@ const useCustomerPaymentInstrument = (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
@@ -288,6 +315,9 @@ const useCustomerProductLists = (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 () {
@@ -301,7 +331,9 @@ const useCustomerProductLists = (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
@@ -329,6 +361,9 @@ const useCustomerProductList = (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 () {
@@ -342,7 +377,9 @@ const useCustomerProductList = (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
@@ -370,6 +407,9 @@ const useCustomerProductListItem = (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 () {
@@ -383,7 +423,9 @@ const useCustomerProductListItem = (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
@@ -411,6 +453,9 @@ const usePublicProductListsBySearchTerm = (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 () {
@@ -424,7 +469,9 @@ const usePublicProductListsBySearchTerm = (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
@@ -452,6 +499,9 @@ const usePublicProductList = (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 () {
@@ -465,7 +515,9 @@ const usePublicProductList = (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
@@ -493,6 +545,9 @@ const useProductListItem = (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 () {
@@ -506,7 +561,9 @@ const useProductListItem = (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/ShopperCustomers/queryKeyHelpers.d.ts

@@ -116,17 +116,11 @@ 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. */
     queryKey: (params: Params<T>) => QueryKeys[T];
 };
-export declare const getExternalProfile: QueryKeyHelper<'getExternalProfile'>;
 export declare const getCustomer: QueryKeyHelper<'getCustomer'>;
 export declare const getCustomerAddress: QueryKeyHelper<'getCustomerAddress'>;
 export declare const getCustomerBaskets: QueryKeyHelper<'getCustomerBaskets'>;

package/hooks/ShopperCustomers/queryKeyHelpers.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getPublicProductListsBySearchTerm = exports.getPublicProductList = exports.getProductListItem = exports.getExternalProfile = exports.getCustomerProductLists = exports.getCustomerProductListItem = exports.getCustomerProductList = exports.getCustomerPaymentInstrument = exports.getCustomerOrders = exports.getCustomerBaskets = exports.getCustomerAddress = exports.getCustomer = void 0;
+exports.getPublicProductListsBySearchTerm = exports.getPublicProductList = exports.getProductListItem = exports.getCustomerProductLists = exports.getCustomerProductListItem = exports.getCustomerProductList = exports.getCustomerPaymentInstrument = exports.getCustomerOrders = exports.getCustomerBaskets = exports.getCustomerAddress = exports.getCustomer = 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.
@@ -17,63 +19,91 @@ var _utils = require("../utils");
 // 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 getExternalProfile = exports.getExternalProfile = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'externalId', 'authenticationProviderId', 'siteId']),
-  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/external-profile'],
-  queryKey: params => [...getExternalProfile.path(params), getExternalProfile.parameters(params)]
-};
+// TODO: Re-implement (and update description from RAML spec) when the endpoint exits closed beta.
+// export const getExternalProfile: QueryKeyHelper<'getExternalProfile'> = {
+//     queryKey: (params: Params<'getExternalProfile'>) => {
+//         const paramKeys = [
+//             ...paramKeysMap['getExternalProfile'],
+//             ...getCustomKeys(getCustomerBaskets)
+//         ]
+//         return [...getExternalProfile.path(params), pick(params, paramKeys)]
+//     }
+// }
+
 const getCustomer = exports.getCustomer = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId],
-  queryKey: params => [...getCustomer.path(params), getCustomer.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomer'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomer.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerAddress = exports.getCustomerAddress = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'addressName', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/addresses/', params.addressName],
-  queryKey: params => [...getCustomerAddress.path(params), getCustomerAddress.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerAddress'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerAddress.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerBaskets = exports.getCustomerBaskets = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/baskets'],
-  queryKey: params => [...getCustomerBaskets.path(params), getCustomerBaskets.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerBaskets'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerBaskets.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerOrders = exports.getCustomerOrders = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'crossSites', 'from', 'until', 'status', 'siteId', 'offset', 'limit']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/orders'],
-  queryKey: params => [...getCustomerOrders.path(params), getCustomerOrders.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerOrders'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerOrders.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerPaymentInstrument = exports.getCustomerPaymentInstrument = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'paymentInstrumentId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/payment-instruments/', params.paymentInstrumentId],
-  queryKey: params => [...getCustomerPaymentInstrument.path(params), getCustomerPaymentInstrument.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerPaymentInstrument'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerPaymentInstrument.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerProductLists = exports.getCustomerProductLists = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/product-lists'],
-  queryKey: params => [...getCustomerProductLists.path(params), getCustomerProductLists.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerProductLists'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerProductLists.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerProductList = exports.getCustomerProductList = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'listId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/product-lists/', params.listId],
-  queryKey: params => [...getCustomerProductList.path(params), getCustomerProductList.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerProductList'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerProductList.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getCustomerProductListItem = exports.getCustomerProductListItem = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'customerId', 'listId', 'itemId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/customers/', params.customerId, '/product-lists/', params.listId, '/items/', params.itemId],
-  queryKey: params => [...getCustomerProductListItem.path(params), getCustomerProductListItem.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getCustomerProductListItem'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getCustomerProductListItem.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getPublicProductListsBySearchTerm = exports.getPublicProductListsBySearchTerm = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'email', 'firstName', 'lastName', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/product-lists'],
-  queryKey: params => [...getPublicProductListsBySearchTerm.path(params), getPublicProductListsBySearchTerm.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPublicProductListsBySearchTerm'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPublicProductListsBySearchTerm.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getPublicProductList = exports.getPublicProductList = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'listId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/product-lists/', params.listId],
-  queryKey: params => [...getPublicProductList.path(params), getPublicProductList.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPublicProductList'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPublicProductList.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getProductListItem = exports.getProductListItem = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'listId', 'itemId', 'siteId']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/product-lists/', params.listId, '/items/', params.itemId],
-  queryKey: params => [...getProductListItem.path(params), getProductListItem.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getProductListItem'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getProductListItem.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperExperience/paramKeys.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    getPages: readonly ["organizationId", "categoryId", "productId", "aspectTypeId", "aspectAttributes", "parameters", "siteId", "locale"];
+    getPage: readonly ["organizationId", "pageId", "aspectAttributes", "parameters", "siteId", "locale"];
+};
+export default _default;
+//# sourceMappingURL=paramKeys.d.ts.map

package/hooks/ShopperExperience/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 getPages = ['organizationId', 'categoryId', 'productId', 'aspectTypeId', 'aspectAttributes', 'parameters', 'siteId', 'locale'];
+const getPage = ['organizationId', 'pageId', 'aspectAttributes', 'parameters', 'siteId', 'locale'];
+var _default = exports.default = {
+  getPages,
+  getPage
+};

package/hooks/ShopperExperience/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,9 @@ const usePages = (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 () {
@@ -55,7 +64,9 @@ const usePages = (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
@@ -86,6 +97,9 @@ const usePage = (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 () {
@@ -99,7 +113,9 @@ const usePage = (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/ShopperExperience/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. */

package/hooks/ShopperExperience/queryKeyHelpers.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getPages = exports.getPage = 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 getPages = exports.getPages = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'categoryId', 'productId', 'aspectTypeId', 'aspectAttributes', 'parameters', 'siteId', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/pages'],
-  queryKey: params => [...getPages.path(params), getPages.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPages'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPages.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };
 const getPage = exports.getPage = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'pageId', 'aspectAttributes', 'parameters', 'siteId', 'locale']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/pages/', params.pageId],
-  queryKey: params => [...getPage.path(params), getPage.parameters(params)]
+  queryKey: params => {
+    const paramKeys = [..._paramKeys.default['getPage'], ...(0, _utils.getCustomKeys)(params)];
+    return [...getPage.path(params), (0, _utils.pick)(params, paramKeys)];
+  }
 };

package/hooks/ShopperGiftCertificates/paramKeys.d.ts

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

package/hooks/ShopperGiftCertificates/paramKeys.js

@@ -0,0 +1,17 @@
+"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 getGiftCertificate = ['organizationId', 'siteId'];
+var _default = exports.default = {
+  getGiftCertificate
+};

package/hooks/ShopperGiftCertificates/query.js

@@ -8,6 +8,7 @@ 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 }; }
@@ -44,7 +45,11 @@ const useGiftCertificate = (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 () {
     var _ref = _asyncToGenerator(function* (options) {
@@ -57,7 +62,9 @@ const useGiftCertificate = (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, _objectSpread({
+  return (0, _useQuery.useQuery)(_objectSpread(_objectSpread({}, netOptions), {}, {
+    parameters
+  }), _objectSpread({
     // !!! This is a violation of our design goal of minimal logic in the indivudal endpoint
     // endpoint hooks. This is because this method is a post method, rather than GET,
     // and its body contains secrets. Setting cacheTime to 0 avoids exposing the secrets in

package/hooks/ShopperGiftCertificates/queryKeyHelpers.d.ts

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

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