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

package/hooks/ShopperCustomers/queryKeyHelpers.js

@@ -0,0 +1,91 @@
+"use strict";
+
+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;
+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 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)]
+};
+exports.getExternalProfile = getExternalProfile;
+const 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)]
+};
+exports.getCustomer = getCustomer;
+const 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)]
+};
+exports.getCustomerAddress = getCustomerAddress;
+const 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)]
+};
+exports.getCustomerBaskets = getCustomerBaskets;
+const 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)]
+};
+exports.getCustomerOrders = getCustomerOrders;
+const 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)]
+};
+exports.getCustomerPaymentInstrument = getCustomerPaymentInstrument;
+const 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)]
+};
+exports.getCustomerProductLists = getCustomerProductLists;
+const 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)]
+};
+exports.getCustomerProductList = getCustomerProductList;
+const 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)]
+};
+exports.getCustomerProductListItem = getCustomerProductListItem;
+const 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)]
+};
+exports.getPublicProductListsBySearchTerm = getPublicProductListsBySearchTerm;
+const 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)]
+};
+exports.getPublicProductList = getPublicProductList;
+const 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)]
+};
+exports.getProductListItem = getProductListItem;

package/hooks/ShopperExperience/index.d.ts

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

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

@@ -0,0 +1,31 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
+declare type Client = ApiClients['shopperExperience'];
+/**
+ * Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+
+Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
+
+**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @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 Experience `getPages` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-experience?meta=getPages| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperexperience.shopperexperience-1.html#getpages | `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 usePages: (apiOptions: NullableParameters<Argument<Client['getPages']>>, queryOptions?: ApiQueryOptions<Client['getPages']>) => UseQueryResult<DataType<Client['getPages']>>;
+/**
+ * Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+
+**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @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 Experience `getPage` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-experience?meta=getPage| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperexperience.shopperexperience-1.html#getpage | `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 usePage: (apiOptions: NullableParameters<Argument<Client['getPage']>>, queryOptions?: ApiQueryOptions<Client['getPage']>) => UseQueryResult<DataType<Client['getPage']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map

package/hooks/ShopperExperience/query.js

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePages = exports.usePage = 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+
+Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
+
+**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @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 Experience `getPages` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-experience?meta=getPages| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperexperience.shopperexperience-1.html#getpages | `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 usePages = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperExperience: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPages';
+  const requiredParameters = ['organizationId', 'aspectTypeId', '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
+  });
+};
+/**
+ * Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+
+**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
+ * @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 Experience `getPage` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-experience?meta=getPage| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperexperience.shopperexperience-1.html#getpage | `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.usePages = usePages;
+const usePage = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperExperience: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPage';
+  const requiredParameters = ['organizationId', 'pageId', '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.usePage = usePage;

package/hooks/ShopperExperience/queryKeyHelpers.d.ts

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

package/hooks/ShopperExperience/queryKeyHelpers.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPages = exports.getPage = 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 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)]
+};
+exports.getPages = getPages;
+const 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)]
+};
+exports.getPage = getPage;

package/hooks/ShopperGiftCertificates/index.d.ts

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

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

@@ -0,0 +1,15 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
+declare type Client = ApiClients['shopperGiftCertificates'];
+/**
+ * Action to retrieve an existing gift certificate.
+ * @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 Gift Certificates `getGiftCertificate` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-gift-certificates?meta=getGiftCertificate| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppergiftcertificates.shoppergiftcertificates-1.html#getgiftcertificate | `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 useGiftCertificate: (apiOptions: NullableParameters<Argument<Client['getGiftCertificate']>>, queryOptions?: ApiQueryOptions<Client['getGiftCertificate']>) => UseQueryResult<DataType<Client['getGiftCertificate']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map

package/hooks/ShopperGiftCertificates/query.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useGiftCertificate = 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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+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(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Action to retrieve an existing gift certificate.
+ * @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 Gift Certificates `getGiftCertificate` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-gift-certificates?meta=getGiftCertificate| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppergiftcertificates.shoppergiftcertificates-1.html#getgiftcertificate | `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 useGiftCertificate = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperGiftCertificates: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getGiftCertificate';
+  const requiredParameters = ['organizationId', 'siteId'];
+
+  // Parameters can be set in `apiOptions` or `client.clientConfig`;
+  // we must merge them in order to generate the correct query key.
+  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
+  const 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, _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
+    // the shared cache.
+    cacheTime: 0
+  }, queryOptions), {
+    method,
+    queryKey,
+    requiredParameters
+  });
+};
+exports.useGiftCertificate = useGiftCertificate;

package/hooks/ShopperGiftCertificates/queryKeyHelpers.d.ts

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

package/hooks/ShopperGiftCertificates/queryKeyHelpers.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getGiftCertificate = 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 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)]
+};
+exports.getGiftCertificate = getGiftCertificate;

package/hooks/ShopperLogin/cache.d.ts

@@ -0,0 +1,3 @@
+import { ApiClients, CacheUpdateMatrix } from '../types';
+export declare const cacheUpdateMatrix: CacheUpdateMatrix<ApiClients['shopperLogin']>;
+//# sourceMappingURL=cache.d.ts.map

package/hooks/ShopperLogin/cache.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cacheUpdateMatrix = 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 noop = () => ({});
+const cacheUpdateMatrix = {
+  authorizePasswordlessCustomer: noop,
+  logoutCustomer: () => {
+    return {
+      remove: [{
+        queryKey: ['/commerce-sdk-react']
+      }]
+    };
+  },
+  getAccessToken: noop,
+  getSessionBridgeAccessToken: noop,
+  getTrustedSystemAccessToken: noop,
+  getTrustedAgentAccessToken: noop,
+  resetPassword: noop,
+  getPasswordLessAccessToken: noop,
+  revokeToken: noop,
+  introspectToken: noop
+};
+exports.cacheUpdateMatrix = cacheUpdateMatrix;

package/hooks/ShopperLogin/index.d.ts

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

package/hooks/ShopperLogin/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _mutation = require("./mutation");
+Object.keys(_mutation).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _mutation[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _mutation[key];
+    }
+  });
+});
+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];
+    }
+  });
+});