@salesforce/commerce-sdk-react 1.0.0-preview.0

package/hooks/ShopperProducts/query.js

@@ -0,0 +1,178 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useProducts = exports.useProduct = exports.useCategory = exports.useCategories = void 0;
+var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
+var _useQuery = require("../useQuery");
+var _utils = require("../utils");
+var queryKeyHelpers = _interopRequireWildcard(require("./queryKeyHelpers"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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.
+                                                                                                                                                                                                                                                                                                                                                                                                       * 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
+ * @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 Products `getProducts` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-products?meta=getProducts| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperproducts.shopperproducts-1.html#getproducts | `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 useProducts = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperProducts: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getProducts';
+  const requiredParameters = ['organizationId', 'ids', '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 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)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. Along with product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products will be included, as appropriate.
+ * @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 Products `getProduct` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-products?meta=getProduct| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperproducts.shopperproducts-1.html#getproduct | `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.
+ */
+exports.useProducts = useProducts;
+const useProduct = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperProducts: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getProduct';
+  const requiredParameters = ['organizationId', 'id', '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 queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x2) {
+      return _ref2.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, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify up to 50 multiple IDs. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character. The server only returns online categories.
+ * @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 Products `getCategories` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-products?meta=getCategories| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperproducts.shopperproducts-1.html#getcategories | `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.
+ */
+exports.useProduct = useProduct;
+const useCategories = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperProducts: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCategories';
+  const requiredParameters = ['organizationId', 'ids', '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 queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x3) {
+      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, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * When you use the URL template below, the server returns a category identified by its ID; by default, the server
+also returns the first level of subcategories, but you can specify another level by setting the levels
+parameter. The server only returns online categories.
+ * @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 Products `getCategory` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-products?meta=getCategory| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperproducts.shopperproducts-1.html#getcategory | `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.
+ */
+exports.useCategories = useCategories;
+const useCategory = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperProducts: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getCategory';
+  const requiredParameters = ['organizationId', 'id', '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 queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref4 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x4) {
+      return _ref4.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, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+exports.useCategory = useCategory;

package/hooks/ShopperProducts/queryKeyHelpers.d.ts

@@ -0,0 +1,55 @@
+import type { ShopperProducts } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+declare type Client = ShopperProducts<{
+    shortCode: string;
+}>;
+declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export declare type QueryKeys = {
+    getProducts: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/products',
+        Params<'getProducts'>
+    ];
+    getProduct: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/products/',
+        string | undefined,
+        Params<'getProduct'>
+    ];
+    getCategories: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/categories',
+        Params<'getCategories'>
+    ];
+    getCategory: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/categories/',
+        string | undefined,
+        Params<'getCategory'>
+    ];
+};
+declare 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 getProducts: QueryKeyHelper<'getProducts'>;
+export declare const getProduct: QueryKeyHelper<'getProduct'>;
+export declare const getCategories: QueryKeyHelper<'getCategories'>;
+export declare const getCategory: QueryKeyHelper<'getCategory'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map

package/hooks/ShopperProducts/queryKeyHelpers.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getProducts = exports.getProduct = exports.getCategory = exports.getCategories = void 0;
+var _utils = require("../utils");
+/*
+ * 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
+ */
+
+// 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 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)]
+};
+exports.getProducts = getProducts;
+const 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)]
+};
+exports.getProduct = getProduct;
+const 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)]
+};
+exports.getCategories = getCategories;
+const 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)]
+};
+exports.getCategory = getCategory;

package/hooks/ShopperPromotions/index.d.ts

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

package/hooks/ShopperPromotions/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/ShopperPromotions/query.d.ts

@@ -0,0 +1,29 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
+declare type Client = ApiClients['shopperPromotions'];
+/**
+ * Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
+ * @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 Promotions `getPromotions` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-promotions?meta=getPromotions| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperpromotions.shopperpromotions-1.html#getpromotions | `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 usePromotions: (apiOptions: NullableParameters<Argument<Client['getPromotions']>>, queryOptions?: ApiQueryOptions<Client['getPromotions']>) => UseQueryResult<DataType<Client['getPromotions']>>;
+/**
+ * Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter
+criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
+range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as
+omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
+promotions, since the server does not consider promotion qualifiers or schedules.
+ * @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 Promotions `getPromotionsForCampaign` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-promotions?meta=getPromotionsForCampaign| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperpromotions.shopperpromotions-1.html#getpromotionsforcampaign | `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 usePromotionsForCampaign: (apiOptions: NullableParameters<Argument<Client['getPromotionsForCampaign']>>, queryOptions?: ApiQueryOptions<Client['getPromotionsForCampaign']>) => UseQueryResult<DataType<Client['getPromotionsForCampaign']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map

package/hooks/ShopperPromotions/query.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePromotionsForCampaign = exports.usePromotions = void 0;
+var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
+var _useQuery = require("../useQuery");
+var _utils = require("../utils");
+var queryKeyHelpers = _interopRequireWildcard(require("./queryKeyHelpers"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+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.
+                                                                                                                                                                                                                                                                                                                                                                                                       * 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
+ * @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 Promotions `getPromotions` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-promotions?meta=getPromotions| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperpromotions.shopperpromotions-1.html#getpromotions | `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 usePromotions = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperPromotions: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPromotions';
+  const requiredParameters = ['organizationId', 'siteId', 'ids'];
+
+  // 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 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)(netOptions, queryOptions, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+/**
+ * Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter
+criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
+range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as 
+omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
+promotions, since the server does not consider promotion qualifiers or schedules.
+ * @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 Promotions `getPromotionsForCampaign` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-promotions?meta=getPromotionsForCampaign| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperpromotions.shopperpromotions-1.html#getpromotionsforcampaign | `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.
+ */
+exports.usePromotions = usePromotions;
+const usePromotionsForCampaign = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperPromotions: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPromotionsForCampaign';
+  const requiredParameters = ['organizationId', 'campaignId', '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 queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
+  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
+  const method = /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x2) {
+      return _ref2.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, {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+exports.usePromotionsForCampaign = usePromotionsForCampaign;

package/hooks/ShopperPromotions/queryKeyHelpers.d.ts

@@ -0,0 +1,38 @@
+import type { ShopperPromotions } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+declare type Client = ShopperPromotions<{
+    shortCode: string;
+}>;
+declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export declare type QueryKeys = {
+    getPromotions: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/promotions',
+        Params<'getPromotions'>
+    ];
+    getPromotionsForCampaign: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/promotions/campaigns/',
+        string | undefined,
+        Params<'getPromotionsForCampaign'>
+    ];
+};
+declare 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 getPromotions: QueryKeyHelper<'getPromotions'>;
+export declare const getPromotionsForCampaign: QueryKeyHelper<'getPromotionsForCampaign'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map

package/hooks/ShopperPromotions/queryKeyHelpers.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPromotionsForCampaign = exports.getPromotions = void 0;
+var _utils = require("../utils");
+/*
+ * 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
+ */
+
+// 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 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)]
+};
+exports.getPromotions = getPromotions;
+const 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)]
+};
+exports.getPromotionsForCampaign = getPromotionsForCampaign;

package/hooks/ShopperSearch/index.d.ts

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

package/hooks/ShopperSearch/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/ShopperSearch/query.d.ts

@@ -0,0 +1,26 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
+declare type Client = ApiClients['shopperSearch'];
+/**
+ * Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in
+the product search hit. The search result contains only products that are online and assigned to site catalog.
+ * @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 Search `productSearch` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-search?meta=productSearch| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppersearch.shoppersearch-1.html#productsearch | `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 useProductSearch: (apiOptions: NullableParameters<Argument<Client['productSearch']>>, queryOptions?: ApiQueryOptions<Client['productSearch']>) => UseQueryResult<DataType<Client['productSearch']>>;
+/**
+ * Provides keyword search functionality for products, categories, and brands suggestions. Returns suggested products, suggested categories, and suggested brands for the given search phrase.
+ * @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 Search `getSearchSuggestions` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-search?meta=getSearchSuggestions| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppersearch.shoppersearch-1.html#getsearchsuggestions | `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 useSearchSuggestions: (apiOptions: NullableParameters<Argument<Client['getSearchSuggestions']>>, queryOptions?: ApiQueryOptions<Client['getSearchSuggestions']>) => UseQueryResult<DataType<Client['getSearchSuggestions']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map