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

package/hooks/ShopperBaskets/query.js

@@ -0,0 +1,215 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTaxesFromBasket = exports.useShippingMethodsForShipment = exports.usePriceBooksForBasket = exports.usePaymentMethodsForBasket = exports.useBasket = 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Gets a basket.
+ * @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 Baskets `getBasket` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-baskets?meta=getBasket| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperbaskets.shopperbaskets-1.html#getbasket | `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 useBasket = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperBaskets: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getBasket';
+  const requiredParameters = ['organizationId', 'basketId', '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
+  });
+};
+/**
+ * Gets applicable payment methods for an existing basket considering the open payment amount only.
+ * @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 Baskets `getPaymentMethodsForBasket` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-baskets?meta=getPaymentMethodsForBasket| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperbaskets.shopperbaskets-1.html#getpaymentmethodsforbasket | `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.useBasket = useBasket;
+const usePaymentMethodsForBasket = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperBaskets: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPaymentMethodsForBasket';
+  const requiredParameters = ['organizationId', 'basketId', '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
+  });
+};
+/**
+ * Gets applicable price books for an existing basket.
+ * @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 Baskets `getPriceBooksForBasket` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-baskets?meta=getPriceBooksForBasket| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperbaskets.shopperbaskets-1.html#getpricebooksforbasket | `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.usePaymentMethodsForBasket = usePaymentMethodsForBasket;
+const usePriceBooksForBasket = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperBaskets: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getPriceBooksForBasket';
+  const requiredParameters = ['organizationId', 'basketId', '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
+  });
+};
+/**
+ * Gets the applicable shipping methods for a certain shipment of a basket.
+ * @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 Baskets `getShippingMethodsForShipment` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-baskets?meta=getShippingMethodsForShipment| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperbaskets.shopperbaskets-1.html#getshippingmethodsforshipment | `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.usePriceBooksForBasket = usePriceBooksForBasket;
+const useShippingMethodsForShipment = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperBaskets: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getShippingMethodsForShipment';
+  const requiredParameters = ['organizationId', 'basketId', 'shipmentId', '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
+  });
+};
+/**
+ * This method gives you the external taxation data set by the PUT taxes API. This endpoint can be called only if external taxation mode was used for basket creation. See POST /baskets for more information.
+ * @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 Baskets `getTaxesFromBasket` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-baskets?meta=getTaxesFromBasket| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperbaskets.shopperbaskets-1.html#gettaxesfrombasket | `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.useShippingMethodsForShipment = useShippingMethodsForShipment;
+const useTaxesFromBasket = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperBaskets: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getTaxesFromBasket';
+  const requiredParameters = ['organizationId', 'basketId', '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 _ref5 = _asyncToGenerator(function* (options) {
+      return yield client[methodName](options);
+    });
+    return function method(_x5) {
+      return _ref5.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.useTaxesFromBasket = useTaxesFromBasket;

package/hooks/ShopperBaskets/queryKeyHelpers.d.ts

@@ -0,0 +1,72 @@
+import type { ShopperBaskets } from 'commerce-sdk-isomorphic';
+import { Argument, ExcludeTail } from '../types';
+declare type Client = ShopperBaskets<{
+    shortCode: string;
+}>;
+declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export declare type QueryKeys = {
+    getBasket: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/baskets/',
+        string | undefined,
+        Params<'getBasket'>
+    ];
+    getPaymentMethodsForBasket: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/baskets/',
+        string | undefined,
+        '/payment-methods',
+        Params<'getPaymentMethodsForBasket'>
+    ];
+    getPriceBooksForBasket: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/baskets/',
+        string | undefined,
+        '/price-books',
+        Params<'getPriceBooksForBasket'>
+    ];
+    getShippingMethodsForShipment: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/baskets/',
+        string | undefined,
+        '/shipments/',
+        string | undefined,
+        '/shipping-methods',
+        Params<'getShippingMethodsForShipment'>
+    ];
+    getTaxesFromBasket: [
+        '/commerce-sdk-react',
+        '/organizations/',
+        string | undefined,
+        '/baskets/',
+        string | undefined,
+        '/taxes',
+        Params<'getTaxesFromBasket'>
+    ];
+};
+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 getBasket: QueryKeyHelper<'getBasket'>;
+export declare const getPaymentMethodsForBasket: QueryKeyHelper<'getPaymentMethodsForBasket'>;
+export declare const getPriceBooksForBasket: QueryKeyHelper<'getPriceBooksForBasket'>;
+export declare const getShippingMethodsForShipment: QueryKeyHelper<'getShippingMethodsForShipment'>;
+export declare const getTaxesFromBasket: QueryKeyHelper<'getTaxesFromBasket'>;
+export {};
+//# sourceMappingURL=queryKeyHelpers.d.ts.map

package/hooks/ShopperBaskets/queryKeyHelpers.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTaxesFromBasket = exports.getShippingMethodsForShipment = exports.getPriceBooksForBasket = exports.getPaymentMethodsForBasket = exports.getBasket = 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 getBasket = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'basketId', 'siteId', 'locale']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/baskets/', params.basketId],
+  queryKey: params => [...getBasket.path(params), getBasket.parameters(params)]
+};
+exports.getBasket = getBasket;
+const getPaymentMethodsForBasket = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'basketId', 'siteId', 'locale']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/baskets/', params.basketId, '/payment-methods'],
+  queryKey: params => [...getPaymentMethodsForBasket.path(params), getPaymentMethodsForBasket.parameters(params)]
+};
+exports.getPaymentMethodsForBasket = getPaymentMethodsForBasket;
+const getPriceBooksForBasket = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'basketId', 'siteId']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/baskets/', params.basketId, '/price-books'],
+  queryKey: params => [...getPriceBooksForBasket.path(params), getPriceBooksForBasket.parameters(params)]
+};
+exports.getPriceBooksForBasket = getPriceBooksForBasket;
+const getShippingMethodsForShipment = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'basketId', 'shipmentId', 'siteId', 'locale']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/baskets/', params.basketId, '/shipments/', params.shipmentId, '/shipping-methods'],
+  queryKey: params => [...getShippingMethodsForShipment.path(params), getShippingMethodsForShipment.parameters(params)]
+};
+exports.getShippingMethodsForShipment = getShippingMethodsForShipment;
+const getTaxesFromBasket = {
+  parameters: params => (0, _utils.pick)(params, ['organizationId', 'basketId', 'siteId']),
+  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/baskets/', params.basketId, '/taxes'],
+  queryKey: params => [...getTaxesFromBasket.path(params), getTaxesFromBasket.parameters(params)]
+};
+exports.getTaxesFromBasket = getTaxesFromBasket;

package/hooks/ShopperContexts/cache.d.ts

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

package/hooks/ShopperContexts/cache.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cacheUpdateMatrix = void 0;
+var _queryKeyHelpers = require("./queryKeyHelpers");
+/*
+ * 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
+ */
+
+// TODO: Complete cache invalidation https://gus.lightning.force.com/lightning/_classic/%2Fa07EE00001NoYplYAF
+const cacheUpdateMatrix = {
+  createShopperContext(customerId, {
+    parameters
+  }) {
+    return {
+      invalidate: [{
+        queryKey: _queryKeyHelpers.getShopperContext.queryKey(parameters)
+      }]
+    };
+  },
+  updateShopperContext(_customerId, {
+    parameters
+  }) {
+    return {
+      update: [{
+        queryKey: _queryKeyHelpers.getShopperContext.queryKey(parameters)
+      }]
+    };
+  },
+  deleteShopperContext(_customerId, {
+    parameters
+  }) {
+    return {
+      remove: [{
+        queryKey: _queryKeyHelpers.getShopperContext.queryKey(parameters)
+      }]
+    };
+  }
+};
+exports.cacheUpdateMatrix = cacheUpdateMatrix;

package/hooks/ShopperContexts/index.d.ts

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

package/hooks/ShopperContexts/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];
+    }
+  });
+});

package/hooks/ShopperContexts/mutation.d.ts

@@ -0,0 +1,35 @@
+import { ApiClients, Argument, DataType } from '../types';
+import { UseMutationResult } from '@tanstack/react-query';
+declare type Client = ApiClients['shopperContexts'];
+/** Mutations available for Shopper Contexts. */
+export declare const ShopperContextsMutations: {
+    /**
+     * Creates the shopper's context based on shopperJWT.
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `createShopperContext` endpoint.
+     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=createShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#createshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+     */
+    readonly CreateShopperContext: "createShopperContext";
+    /**
+     * Gets the shopper's context based on the shopperJWT.
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `deleteShopperContext` endpoint.
+     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=deleteShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#deleteshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+     */
+    readonly DeleteShopperContext: "deleteShopperContext";
+    /**
+     * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a customer qualifier or an `effectiveDateTime` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a customer qualifers' value is set to `null` it's deleted from existing shopper context. If `effectiveDateTime` value is set to set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` value is set to `null` it's ignored. If an `effectiveDateTime` or customer qualifiiers' value is new, it's added to the existing Shopper context.
+     * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `updateShopperContext` endpoint.
+     * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=updateShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+     * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#updateshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+     * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+     */
+    readonly UpdateShopperContext: "updateShopperContext";
+};
+/** Mutation for Shopper Contexts. */
+export declare type ShopperContextsMutation = (typeof ShopperContextsMutations)[keyof typeof ShopperContextsMutations];
+export declare function useShopperContextsMutation<Mutation extends ShopperContextsMutation>(mutation: Mutation): UseMutationResult<DataType<Client[Mutation]>, unknown, Argument<Client[Mutation]>>;
+export {};
+//# sourceMappingURL=mutation.d.ts.map

package/hooks/ShopperContexts/mutation.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ShopperContextsMutations = void 0;
+exports.useShopperContextsMutation = useShopperContextsMutation;
+var _useMutation = require("../useMutation");
+var _utils = require("../utils");
+var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
+var _cache = require("./cache");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*
+ * 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
+ */
+
+/** Mutations available for Shopper Contexts. */
+const ShopperContextsMutations = {
+  /**
+   * Creates the shopper's context based on shopperJWT.
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `createShopperContext` endpoint.
+   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=createShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#createshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+   */
+  CreateShopperContext: 'createShopperContext',
+  /**
+   * Gets the shopper's context based on the shopperJWT.
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `deleteShopperContext` endpoint.
+   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=deleteShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#deleteshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+   */
+  DeleteShopperContext: 'deleteShopperContext',
+  /**
+   * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a customer qualifier or an `effectiveDateTime` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a customer qualifers' value is set to `null` it's deleted from existing shopper context. If `effectiveDateTime` value is set to set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` value is set to `null` it's ignored. If an `effectiveDateTime` or customer qualifiiers' value is new, it's added to the existing Shopper context.
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Contexts `updateShopperContext` endpoint.
+   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=updateShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#updateshoppercontext | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
+   * @see {@link https://tanstack.com/query/latest/docs/react/reference/useMutation | TanStack Query `useMutation` reference} for more information about the return value.
+   */
+  UpdateShopperContext: 'updateShopperContext'
+};
+
+/** Mutation for Shopper Contexts. */
+exports.ShopperContextsMutations = ShopperContextsMutations;
+function useShopperContextsMutation(mutation) {
+  const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
+  // TODO: Remove this check when all mutations are implemented.
+  if (!getCacheUpdates) throw new _utils.NotImplementedError(`The '${mutation}' mutation`);
+
+  // The `Options` and `Data` types for each mutation are similar, but distinct, and the union
+  // type generated from `Client[Mutation]` seems to be too complex for TypeScript to handle.
+  // I'm not sure if there's a way to avoid the type assertions in here for the methods that
+  // use them. However, I'm fairly confident that they are safe to do, as they seem to be simply
+  // re-asserting what we already have.
+  const {
+    shopperContexts: client
+  } = (0, _useCommerceApi.default)();
+  return (0, _useMutation.useMutation)({
+    client,
+    method: opts => client[mutation](opts),
+    getCacheUpdates: getCacheUpdates
+  });
+}

package/hooks/ShopperContexts/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['shopperContexts'];
+/**
+ * Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
+ * @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 Contexts `getShopperContext` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=getShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#getshoppercontext | `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 useShopperContext: (apiOptions: NullableParameters<Argument<Client['getShopperContext']>>, queryOptions?: ApiQueryOptions<Client['getShopperContext']>) => UseQueryResult<DataType<Client['getShopperContext']>>;
+export {};
+//# sourceMappingURL=query.d.ts.map

package/hooks/ShopperContexts/query.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useShopperContext = 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
+                                                                                                                                                                                                                                                                                                                                                                                                       */
+/**
+ * Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
+ * @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 Contexts `getShopperContext` endpoint.
+ * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-contexts?meta=getShopperContext| Salesforce Developer Center} for more information about the API endpoint.
+ * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shoppercontexts.shoppercontexts-1.html#getshoppercontext | `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 useShopperContext = (apiOptions, queryOptions = {}) => {
+  const {
+    shopperContexts: client
+  } = (0, _useCommerceApi.default)();
+  const methodName = 'getShopperContext';
+  const requiredParameters = ['organizationId', 'usid'];
+
+  // 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
+  });
+};
+exports.useShopperContext = useShopperContext;