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

package/hooks/ShopperOrders/mutation.js

@@ -17,14 +17,16 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-/** Mutations available for Shopper Orders. */
+/**
+ * Mutations available for Shopper Orders
+ * @group ShopperOrders
+ * @category Mutation
+ * @enum
+ */
 const ShopperOrdersMutations = {
   /**
    * Submits an order based on a prepared basket. The only considered value from the request body is basketId.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `createOrder` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=createOrder| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#createorder | `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.
    */
   CreateOrder: 'createOrder',
   /**
@@ -33,35 +35,31 @@ const ShopperOrdersMutations = {
   The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
   /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
   * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `createPaymentInstrumentForOrder` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=createPaymentInstrumentForOrder| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#createpaymentinstrumentfororder | `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.
   */
   CreatePaymentInstrumentForOrder: 'createPaymentInstrumentForOrder',
   /**
    * Removes a payment instrument of an order.
    * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `removePaymentInstrumentFromOrder` endpoint.
-   * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=removePaymentInstrumentFromOrder| Salesforce Developer Center} for more information about the API endpoint.
-   * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#removepaymentinstrumentfromorder | `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.
    */
   RemovePaymentInstrumentFromOrder: 'removePaymentInstrumentFromOrder',
   /**
-  * Updates a payment instrument of an order.
-  Details:
-  The payment instrument is updated with the provided details. The payment method must be applicable for the
-  order see GET /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a
-  paymentCard must be specified in the request.
-  * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `updatePaymentInstrumentForOrder` endpoint.
-  * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-orders?meta=updatePaymentInstrumentForOrder| Salesforce Developer Center} for more information about the API endpoint.
-  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperorders.shopperorders-1.html#updatepaymentinstrumentfororder | `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.
-  */
+   * Updates a payment instrument of an order.
+   * @returns A TanStack Query mutation hook for interacting with the Shopper Orders `updatePaymentInstrumentForOrder` endpoint.
+   */
   UpdatePaymentInstrumentForOrder: 'updatePaymentInstrumentForOrder'
 };
 
-/** Mutation for Shopper Orders. */
+/**
+ * Mutation for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 exports.ShopperOrdersMutations = ShopperOrdersMutations;
+/**
+ * Mutation hook for Shopper Orders.
+ * @group ShopperOrders
+ * @category Mutation
+ */
 function useShopperOrdersMutation(mutation) {
   const getCacheUpdates = _cache.cacheUpdateMatrix[mutation];
   // TODO: Remove this check when all mutations are implemented.

package/hooks/ShopperOrders/query.d.ts

@@ -3,6 +3,8 @@ import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } f
 declare type Client = ApiClients['shopperOrders'];
 /**
  * Gets information for an order.
+ * @group ShopperOrders
+ * @category Query
  * @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 Orders `getOrder` endpoint.
@@ -13,6 +15,8 @@ declare type Client = ApiClients['shopperOrders'];
 export declare const useOrder: (apiOptions: NullableParameters<Argument<Client['getOrder']>>, queryOptions?: ApiQueryOptions<Client['getOrder']>) => UseQueryResult<DataType<Client['getOrder']>>;
 /**
  * Gets the applicable payment methods for an existing order considering the open payment amount only.
+ * @group ShopperOrders
+ * @category Query
  * @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 Orders `getPaymentMethodsForOrder` endpoint.
@@ -25,6 +29,8 @@ export declare const usePaymentMethodsForOrder: (apiOptions: NullableParameters<
  * This method gives you the external taxation data of the order transferred from the basket during
 order creation. This endpoint can be called only if external taxation was used. See POST /baskets
 for more information.
+ * @group ShopperOrders
+ * @category Query
  * @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 Orders `getTaxesFromOrder` endpoint.

package/hooks/ShopperOrders/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * Gets information for an order.
+ * @group ShopperOrders
+ * @category Query
  * @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 Orders `getOrder` endpoint.
@@ -58,6 +60,8 @@ const useOrder = (apiOptions, queryOptions = {}) => {
 };
 /**
  * Gets the applicable payment methods for an existing order considering the open payment amount only.
+ * @group ShopperOrders
+ * @category Query
  * @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 Orders `getPaymentMethodsForOrder` endpoint.
@@ -98,7 +102,9 @@ const usePaymentMethodsForOrder = (apiOptions, queryOptions = {}) => {
 /**
  * This method gives you the external taxation data of the order transferred from the basket during 
 order creation. This endpoint can be called only if external taxation was used. See POST /baskets 
-for more information.         
+for more information.     
+ * @group ShopperOrders
+ * @category Query    
  * @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 Orders `getTaxesFromOrder` endpoint.

package/hooks/ShopperProducts/query.d.ts

@@ -3,6 +3,8 @@ import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } f
 declare type Client = ApiClients['shopperProducts'];
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -13,6 +15,8 @@ declare type Client = ApiClients['shopperProducts'];
 export declare const useProducts: (apiOptions: NullableParameters<Argument<Client['getProducts']>>, queryOptions?: ApiQueryOptions<Client['getProducts']>) => UseQueryResult<DataType<Client['getProducts']>>;
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -23,6 +27,8 @@ export declare const useProducts: (apiOptions: NullableParameters<Argument<Clien
 export declare const useProduct: (apiOptions: NullableParameters<Argument<Client['getProduct']>>, queryOptions?: ApiQueryOptions<Client['getProduct']>) => UseQueryResult<DataType<Client['getProduct']>>;
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -35,6 +41,8 @@ export declare const useCategories: (apiOptions: NullableParameters<Argument<Cli
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.

package/hooks/ShopperProducts/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -58,6 +60,8 @@ const useProducts = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -97,6 +101,8 @@ const useProduct = (apiOptions, queryOptions = {}) => {
 };
 /**
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.
@@ -138,6 +144,8 @@ const useCategories = (apiOptions, queryOptions = {}) => {
  * 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.
+ * @group ShopperProducts
+ * @category Query
  * @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.

package/hooks/ShopperPromotions/query.d.ts

@@ -3,6 +3,8 @@ import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } f
 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.
+ * @group ShopperPromotions
+ * @category Query
  * @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.
@@ -17,6 +19,8 @@ criteria. In the request URL, you must provide a campaign_id parameter, and you
 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.
+ * @group ShopperPromotions
+ * @category Query
  * @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.

package/hooks/ShopperPromotions/query.js

@@ -20,6 +20,8 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
  * 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.
+ * @group ShopperPromotions
+ * @category Query
  * @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.
@@ -62,6 +64,8 @@ criteria. In the request URL, you must provide a campaign_id parameter, and you
 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.
+ * @group ShopperPromotions
+ * @category Query
  * @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.

package/hooks/ShopperSearch/query.d.ts

@@ -2,8 +2,12 @@ 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.
+ * 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.
+ * @group ShopperSearch
+ * @category Query
  * @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.
@@ -13,7 +17,11 @@ the product search hit. The search result contains only products that are online
  */
 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.
+ * Provides keyword search functionality for products, categories, and brands suggestions.
+ *
+ * Returns suggested products, suggested categories, and suggested brands for the given search phrase.
+ * @group ShopperSearch
+ * @category Query
  * @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.

package/hooks/ShopperSearch/query.js

@@ -19,8 +19,12 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
                                                                                                                                                                                                                                                                                                                                                                                                        */
 /**
- * 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.
+ * 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.
+ * @group ShopperSearch
+ * @category Query
  * @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.
@@ -58,7 +62,11 @@ const useProductSearch = (apiOptions, queryOptions = {}) => {
   });
 };
 /**
- * Provides keyword search functionality for products, categories, and brands suggestions. Returns suggested products, suggested categories, and suggested brands for the given search phrase.
+ * Provides keyword search functionality for products, categories, and brands suggestions.
+ *
+ * Returns suggested products, suggested categories, and suggested brands for the given search phrase.
+ * @group ShopperSearch
+ * @category Query
  * @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.

package/hooks/types.d.ts

@@ -41,6 +41,9 @@ export declare type ApiClientConfigParams = {
     locale?: string;
     currency?: string;
 };
+/**
+ * A map of commerce-sdk-isomorphic API client instances.
+ */
 export interface ApiClients {
     shopperBaskets: ShopperBaskets<ApiClientConfigParams>;
     shopperContexts: ShopperContexts<ApiClientConfigParams>;

package/hooks/useAccessToken.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @group Shopper Authentication helpers
+ */
 interface AccessToken {
     token: string | null;
     getTokenWhenReady: () => Promise<string>;
@@ -5,6 +8,9 @@ interface AccessToken {
 /**
  * Hook that returns the access token.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 declare const useAccessToken: () => AccessToken;
 export default useAccessToken;

package/hooks/useAccessToken.js

@@ -16,9 +16,17 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 const onClient = typeof window !== 'undefined';
+
+/**
+ * @group Shopper Authentication helpers
+ */
+
 /**
  * Hook that returns the access token.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 const useAccessToken = () => {
   const config = (0, _useConfig.default)();

package/hooks/useAuthHelper.d.ts

@@ -1,14 +1,25 @@
 import { UseMutationResult } from '@tanstack/react-query';
 import Auth from '../auth';
+/**
+ * @group Helpers
+ * @category Shopper Authentication
+ * @enum
+ */
 export declare const AuthHelpers: {
     readonly LoginGuestUser: "loginGuestUser";
     readonly LoginRegisteredUserB2C: "loginRegisteredUserB2C";
     readonly Logout: "logout";
     readonly Register: "register";
 };
+/**
+ * @group Helpers
+ * @category Shopper Authentication
+ *
+ */
 export declare type AuthHelper = (typeof AuthHelpers)[keyof typeof AuthHelpers];
 /**
  * A hook for Public Client OAuth helpers.
+ *
  * The hook calls the SLAS helpers imported from commerce-sdk-isomorphic.
  * For more, see https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/#public-client-shopper-login-helpers
  *
@@ -17,6 +28,9 @@ export declare type AuthHelper = (typeof AuthHelpers)[keyof typeof AuthHelpers];
  * - loginGuestUser
  * - logout
  * - register
+ *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 export declare function useAuthHelper<Mutation extends AuthHelper>(mutation: Mutation): UseMutationResult<ReturnType<Auth[Mutation]> extends Promise<infer Data> ? Data : never, unknown, [
 ] extends Parameters<Auth[Mutation]> ? void : Parameters<Auth[Mutation]>[0], unknown>;

package/hooks/useAuthHelper.js

@@ -16,16 +16,32 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+/**
+ * @group Helpers
+ * @category Shopper Authentication
+ * @enum
+ */
 const AuthHelpers = {
   LoginGuestUser: 'loginGuestUser',
   LoginRegisteredUserB2C: 'loginRegisteredUserB2C',
   Logout: 'logout',
   Register: 'register'
 };
+/**
+ * @group Helpers
+ * @category Shopper Authentication
+ *
+ */
 exports.AuthHelpers = AuthHelpers;
 const noop = () => ({});
+
+/**
+ * @internal
+ */
+
 /**
  * A hook for Public Client OAuth helpers.
+ *
  * The hook calls the SLAS helpers imported from commerce-sdk-isomorphic.
  * For more, see https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/#public-client-shopper-login-helpers
  *
@@ -34,6 +50,9 @@ const noop = () => ({});
  * - loginGuestUser
  * - logout
  * - register
+ *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 function useAuthHelper(mutation) {
   const auth = (0, _useAuthContext.default)();

package/hooks/useCommerceApi.d.ts

@@ -2,6 +2,8 @@ import { ApiClients } from './types';
 /**
  * Access a set of initialized Commerce API clients, which are initialized using the configurations passed to the CommerceApiProvider.
  *
+ * @group Helpers
+ *
  * @returns Commerce API clients
  */
 declare const useCommerceApi: () => ApiClients;

package/hooks/useCommerceApi.js

@@ -17,6 +17,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Access a set of initialized Commerce API clients, which are initialized using the configurations passed to the CommerceApiProvider.
  *
+ * @group Helpers
+ *
  * @returns Commerce API clients
  */
 const useCommerceApi = () => {

package/hooks/useCustomerId.d.ts

@@ -1,6 +1,8 @@
 /**
  * Hook that returns the customer ID.
  *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 declare const useCustomerId: () => string | null;
 export default useCustomerId;

package/hooks/useCustomerId.js

@@ -20,6 +20,8 @@ const onClient = typeof window !== 'undefined';
 /**
  * Hook that returns the customer ID.
  *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 const useCustomerId = () => {
   if (onClient) {

package/hooks/useCustomerType.d.ts

@@ -15,6 +15,9 @@ declare type useCustomerType = {
  * During initialization, type is null. And it is possible that
  * isGuest and isRegistered to both be false.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 declare const useCustomerType: () => useCustomerType;
 export default useCustomerType;

package/hooks/useCustomerType.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _useAuthContext = _interopRequireDefault(require("./useAuthContext"));
+var _useLocalStorage = _interopRequireDefault(require("./useLocalStorage"));
+var _useConfig = _interopRequireDefault(require("./useConfig"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /*
  * Copyright (c) 2023, salesforce.com, inc.
@@ -13,6 +15,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+const onClient = typeof window !== 'undefined';
 /**
  * A hook to return customer auth type.
  *
@@ -24,10 +27,18 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * During initialization, type is null. And it is possible that
  * isGuest and isRegistered to both be false.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 const useCustomerType = () => {
+  const config = (0, _useConfig.default)();
   const auth = (0, _useAuthContext.default)();
-  let customerType = auth.get('customer_type');
+  let customerType = onClient ?
+  // This conditional is a constant value based on the environment, so the same path will
+  // always be followed., and the "rule of hooks" is not violated.
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  (0, _useLocalStorage.default)(`customer_type_${config.siteId}`) : auth.get('customer_type');
   const isGuest = customerType === 'guest';
   const isRegistered = customerType === 'registered';
   if (customerType !== null && customerType !== 'guest' && customerType !== 'registered') {

package/hooks/useEncUserId.d.ts

@@ -3,6 +3,9 @@
  *
  * This is sometimes used as the user ID for Einstein.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 declare const useEncUserId: () => string | null;
 export default useEncUserId;

package/hooks/useEncUserId.js

@@ -22,6 +22,9 @@ const onClient = typeof window !== 'undefined';
  *
  * This is sometimes used as the user ID for Einstein.
  *
+ * @group Helpers
+ * @category Shopper Authentication
+ *
  */
 const useEncUserId = () => {
   const config = (0, _useConfig.default)();

package/hooks/useUsid.d.ts

@@ -1,6 +1,8 @@
 /**
  * Hook that returns the usid associated with the current access token.
  *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 declare const useUsid: () => string | null;
 export default useUsid;

package/hooks/useUsid.js

@@ -20,6 +20,8 @@ const onClient = typeof window !== 'undefined';
 /**
  * Hook that returns the usid associated with the current access token.
  *
+ * @group Helpers
+ * @category Shopper Authentication
  */
 const useUsid = () => {
   const config = (0, _useConfig.default)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/commerce-sdk-react",
-  "version": "1.0.0-preview.0",
+  "version": "1.0.0-preview.1",
   "description": "A library that provides react hooks for fetching data from Commerce Cloud",
   "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/ecom-react-hooks#readme",
   "bugs": {
@@ -26,7 +26,7 @@
   ],
   "scripts": {
     "build": "cross-env NODE_ENV=production internal-lib-build build && tsc --emitDeclarationOnly",
-    "build:docs": "typedoc",
+    "build:docs": "typedoc --plugin typedoc-plugin-missing-exports --hideGenerator",
     "build:watch": "nodemon --watch 'src/**' --ext 'tsx,ts' --exec  'npm run build'",
     "format": "internal-lib-build format \"**/*.{js,jsx,ts,tsx}\"",
     "lint": "npm run lint:js && tsc --noEmit",
@@ -42,10 +42,12 @@
   "dependencies": {
     "commerce-sdk-isomorphic": "^1.10.1",
     "js-cookie": "^3.0.1",
-    "jwt-decode": "^3.1.2"
+    "jwt-decode": "^3.1.2",
+    "typedoc": "^0.24.7",
+    "typedoc-plugin-missing-exports": "^2.0.0"
   },
   "devDependencies": {
-    "@salesforce/pwa-kit-dev": "3.0.0-preview.0",
+    "@salesforce/pwa-kit-dev": "3.0.0-preview.1",
     "@tanstack/react-query": "^4.28.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
@@ -57,7 +59,7 @@
     "@types/react-dom": "^18.2.1",
     "@types/react-helmet": "^6.1.6",
     "cross-env": "^5.2.1",
-    "internal-lib-build": "3.0.0-preview.0",
+    "internal-lib-build": "3.0.0-preview.1",
     "jsonwebtoken": "^8.5.1",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
@@ -84,5 +86,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "a9f820893b7714244a0af509a5aefecc1344153c"
+  "gitHead": "457b0179e4cf536e55bf9b21758302ff68ef3ea4"
 }

package/provider.d.ts

@@ -28,7 +28,33 @@ export declare const AuthContext: React.Context<Auth>;
 /**
  * Initialize a set of Commerce API clients and make it available to all of descendant components
  *
- * @param props
+ * @group Components
+ *
+ * @example
+ * ```js
+    import {CommerceApiProvider} from '@salesforce/commerce-sdk-react'
+
+
+    const App = ({children}) => {
+        return (
+                <CommerceApiProvider
+                    clientId="12345678-1234-1234-1234-123412341234"
+                    organizationId="f_ecom_aaaa_001"
+                    proxy="localhost:3000/mobify/proxy/api"
+                    redirectURI="localhost:3000/callback"
+                    siteId="RefArch"
+                    shortCode="12345678"
+                    locale="en-US"
+                    currency="USD"
+                >
+                    {children}
+                </CommerceApiProvider>
+        )
+    }
+
+    export default App
+ * ```
+ *
  * @returns Provider to wrap your app with
  */
 declare const CommerceApiProvider: (props: CommerceApiProviderProps) => ReactElement;