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

package/hooks/ShopperPromotions/queryKeyHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { ShopperPromotions } from 'commerce-sdk-isomorphic';
 import { Argument, ExcludeTail } from '../types';
-declare type Client = ShopperPromotions<{
+type Client = ShopperPromotions<{
     shortCode: string;
 }>;
-declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
-export declare type QueryKeys = {
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
     getPromotions: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -21,7 +21,7 @@ export declare type QueryKeys = {
         Params<'getPromotionsForCampaign'>
     ];
 };
-declare type QueryKeyHelper<T extends keyof QueryKeys> = {
+type QueryKeyHelper<T extends keyof QueryKeys> = {
     /**
      * Reduces the given parameters (which may have additional, unknown properties) to an object
      * containing *only* the properties required for an endpoint.

package/hooks/ShopperSearch/query.d.ts

@@ -1,9 +1,13 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
-declare type Client = ApiClients['shopperSearch'];
+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/ShopperSearch/queryKeyHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { ShopperSearch } from 'commerce-sdk-isomorphic';
 import { Argument, ExcludeTail } from '../types';
-declare type Client = ShopperSearch<{
+type Client = ShopperSearch<{
     shortCode: string;
 }>;
-declare type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
-export declare type QueryKeys = {
+type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
+export type QueryKeys = {
     productSearch: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -20,7 +20,7 @@ export declare type QueryKeys = {
         Params<'getSearchSuggestions'>
     ];
 };
-declare type QueryKeyHelper<T extends keyof QueryKeys> = {
+type QueryKeyHelper<T extends keyof QueryKeys> = {
     /**
      * Reduces the given parameters (which may have additional, unknown properties) to an object
      * containing *only* the properties required for an endpoint.

package/hooks/types.d.ts

@@ -1,39 +1,39 @@
 import { InvalidateQueryFilters, QueryFilters, Updater, UseQueryOptions } from '@tanstack/react-query';
 import { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch } from 'commerce-sdk-isomorphic';
 /** Makes a type easier to read. */
-export declare type Prettify<T extends object> = NonNullable<Pick<T, keyof T>>;
+export type Prettify<T extends object> = NonNullable<Pick<T, keyof T>>;
 /**
  * Marks the given keys as required.
  * WARNING: Does not work if T has an index signature.
  */
-export declare type RequireKeys<T, K extends keyof T> = Prettify<T & Required<Pick<T, K>>>;
+export type RequireKeys<T, K extends keyof T> = Prettify<T & Required<Pick<T, K>>>;
 /** Removes keys whose value is `never`. */
-declare type RemoveNeverValues<T> = {
+type RemoveNeverValues<T> = {
     [K in keyof T as T[K] extends never ? never : K]: T[K];
 };
 /** Change string index type to `never`. */
-declare type StringIndexToNever<T> = {
+type StringIndexToNever<T> = {
     [K in keyof T]: string extends K ? never : T[K];
 };
 /** Removes a string index type. */
-export declare type RemoveStringIndex<T> = RemoveNeverValues<StringIndexToNever<T>>;
+export type RemoveStringIndex<T> = RemoveNeverValues<StringIndexToNever<T>>;
 /** Gets the last element of an array. */
-export declare type Tail<T extends readonly unknown[]> = T extends [...head: unknown[], tail: infer Tail] ? Tail : T;
+export type Tail<T extends readonly unknown[]> = T extends [...head: unknown[], tail: infer Tail] ? Tail : T;
 /** Remove the last entry from a tuple type. */
-export declare type ExcludeTail<T extends readonly unknown[]> = T extends readonly [...infer Head, unknown] ? T extends unknown[] ? Head : Readonly<Head> : T;
+export type ExcludeTail<T extends readonly unknown[]> = T extends readonly [...infer Head, unknown] ? T extends unknown[] ? Head : Readonly<Head> : T;
 /** Adds `null` as an allowed value to all properties. */
-declare type AllowNull<T> = {
+type AllowNull<T> = {
     [K in keyof T]: T[K] | null;
 };
 /** Gets the keys of `T` which allow `null` as a possible value. */
-declare type NullKeys<T> = {
+type NullKeys<T> = {
     [K in keyof T]-?: null extends T[K] ? K : never;
 }[keyof T];
 /** Removes `null` values and marks those properties as optional. */
-export declare type NullToOptional<T> = Omit<T, NullKeys<T>> & {
+export type NullToOptional<T> = Omit<T, NullKeys<T>> & {
     [K in keyof T]?: NonNullable<T[K]>;
 };
-export declare type ApiClientConfigParams = {
+export type ApiClientConfigParams = {
     clientId: string;
     organizationId: string;
     siteId: string;
@@ -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>;
@@ -53,11 +56,11 @@ export interface ApiClients {
     shopperPromotions: ShopperPromotions<ApiClientConfigParams>;
     shopperSearch: ShopperSearch<ApiClientConfigParams>;
 }
-export declare type ApiClient = ApiClients[keyof ApiClients];
+export type ApiClient = ApiClients[keyof ApiClients];
 /**
  * Generic signature of the options objects used by commerce-sdk-isomorphic
  */
-export declare type ApiOptions<Parameters extends object = Record<string, unknown>, Body extends object | unknown[] | undefined = Record<string, unknown> | unknown[] | undefined, Headers extends Record<string, string> = Record<string, string>> = {
+export type ApiOptions<Parameters extends object = Record<string, unknown>, Body extends object | unknown[] | undefined = Record<string, unknown> | unknown[] | undefined, Headers extends Record<string, string> = Record<string, string>> = {
     parameters?: Parameters;
     headers?: Headers;
     body?: Body;
@@ -65,35 +68,35 @@ export declare type ApiOptions<Parameters extends object = Record<string, unknow
 /**
  * Generic signature of API methods exported by commerce-sdk-isomorphic
  */
-export declare type ApiMethod<Options extends ApiOptions, Data> = {
+export type ApiMethod<Options extends ApiOptions, Data> = {
     (options: Options): Promise<Data>;
 };
 /**
  * The first argument of a function.
  */
-export declare type Argument<T extends (arg: any) => unknown> = NonNullable<Parameters<T>[0]>;
+export type Argument<T extends (arg: any) => unknown> = NonNullable<Parameters<T>[0]>;
 /**
  * The data type returned by a commerce-sdk-isomorphic method when the raw response
  * flag is not set.
  */
-export declare type DataType<T> = T extends ApiMethod<any, Response | infer R> ? R : never;
+export type DataType<T> = T extends ApiMethod<any, Response | infer R> ? R : never;
 /**
  * Merged headers and parameters from client config and options, mimicking the behavior
  * of commerce-sdk-isomorphic.
  */
-export declare type MergedOptions<Client extends ApiClient, Options extends ApiOptions> = Required<ApiOptions<NonNullable<Client['clientConfig']['parameters'] & Options['parameters']>, unknown extends Options['body'] ? never : Options['body'], NonNullable<Client['clientConfig']['headers'] & Options['headers']>>>;
+export type MergedOptions<Client extends ApiClient, Options extends ApiOptions> = Required<ApiOptions<NonNullable<Client['clientConfig']['parameters'] & Options['parameters']>, unknown extends Options['body'] ? never : Options['body'], NonNullable<Client['clientConfig']['headers'] & Options['headers']>>>;
 /** Query key interface used by API query hooks. */
-export declare type ApiQueryKey<Params extends Record<string, unknown> = Record<string, unknown>> = readonly [...path: (string | undefined)[], parameters: Params];
+export type ApiQueryKey<Params extends Record<string, unknown> = Record<string, unknown>> = readonly [...path: (string | undefined)[], parameters: Params];
 /** Query options for endpoint hooks. */
-export declare type ApiQueryOptions<Method extends ApiMethod<any, unknown>> = Prettify<Omit<UseQueryOptions<DataType<Method>, unknown, DataType<Method>, ApiQueryKey>, 'queryFn' | 'queryKey'>>;
+export type ApiQueryOptions<Method extends ApiMethod<any, unknown>> = Prettify<Omit<UseQueryOptions<DataType<Method>, unknown, DataType<Method>, ApiQueryKey>, 'queryFn' | 'queryKey'>>;
 /** Adds `null` as an allowed value to all parameters. */
-export declare type NullableParameters<T extends {
+export type NullableParameters<T extends {
     parameters?: object;
 }> = {
     [K in keyof T]: K extends 'parameters' ? AllowNull<T[K]> : T[K];
 };
 /** Remove `null` and `undefined` values from all parameters. */
-export declare type OmitNullableParameters<T extends {
+export type OmitNullableParameters<T extends {
     parameters: object;
 }> = Omit<T, 'parameters'> & {
     parameters: NullToOptional<T['parameters']>;
@@ -103,25 +106,25 @@ export declare type OmitNullableParameters<T extends {
  * @property queryKey - The query key to update
  * @property updater - Either the new data or a function that accepts old data and returns new data
  */
-export declare type CacheUpdateUpdate<T> = {
+export type CacheUpdateUpdate<T> = {
     queryKey: ApiQueryKey;
     updater?: Updater<T | undefined, T | undefined>;
 };
 /** Query predicate for queries to invalidate */
-export declare type CacheUpdateInvalidate = InvalidateQueryFilters;
+export type CacheUpdateInvalidate = InvalidateQueryFilters;
 /** Query predicate for queries to remove */
-export declare type CacheUpdateRemove = QueryFilters;
+export type CacheUpdateRemove = QueryFilters;
 /** Collection of updates to make to the cache when a request completes. */
-export declare type CacheUpdate = {
+export type CacheUpdate = {
     update?: CacheUpdateUpdate<unknown>[];
     invalidate?: CacheUpdateInvalidate[];
     remove?: CacheUpdateRemove[];
     clear?: boolean;
 };
 /** Generates a collection of cache updates to make for a given request. */
-export declare type CacheUpdateGetter<Options, Data> = (customerId: string | null, options: Options, response: Data) => CacheUpdate;
+export type CacheUpdateGetter<Options, Data> = (customerId: string | null, options: Options, response: Data) => CacheUpdate;
 /** Collection of cache update getters for each method of an API client. */
-export declare type CacheUpdateMatrix<Client extends ApiClient> = {
+export type CacheUpdateMatrix<Client extends ApiClient> = {
     [Method in keyof Client]?: Client[Method] extends ApiMethod<any, Response | infer Data> ? CacheUpdateGetter<MergedOptions<Client, Argument<Client[Method]>>, Data> : never;
 };
 export {};

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";
 };
-export declare type AuthHelper = (typeof AuthHelpers)[keyof typeof AuthHelpers];
+/**
+ * @group Helpers
+ * @category Shopper Authentication
+ *
+ */
+export 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

@@ -1,5 +1,5 @@
-export declare type CustomerType = null | 'guest' | 'registered';
-declare type useCustomerType = {
+export type CustomerType = null | 'guest' | 'registered';
+type useCustomerType = {
     customerType: CustomerType;
     isGuest: boolean;
     isRegistered: boolean;
@@ -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/useLocalStorage.d.ts

@@ -1,4 +1,4 @@
-declare type Value = string | null;
+type Value = string | null;
 /**
  * @internal
  *

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.2",
   "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,23 +42,25 @@
   "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.2",
     "@tanstack/react-query": "^4.28.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
     "@types/js-cookie": "^3.0.3",
-    "@types/jsonwebtoken": "^8.5.9",
+    "@types/jsonwebtoken": "^9.0.0",
     "@types/jwt-decode": "^3.1.0",
     "@types/node": "^14.18.40",
     "@types/react": "^18.2.0",
     "@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",
-    "jsonwebtoken": "^8.5.1",
+    "internal-lib-build": "3.0.0-preview.2",
+    "jsonwebtoken": "^9.0.0",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
     "react": "^18.2.0",
@@ -66,13 +68,13 @@
     "react-helmet": "^6.1.0",
     "semver": "^7.3.8",
     "shelljs": "^0.8.5",
-    "typedoc": "^0.23.28",
-    "typescript": "4.8.3"
+    "typedoc": "^0.24.7",
+    "typescript": "^4.8.3"
   },
   "peerDependencies": {
-    "@tanstack/react-query": "^4",
-    "react": "^18",
-    "react-helmet": "6"
+    "@tanstack/react-query": "^4.28.0",
+    "react": "^18.2.0",
+    "react-helmet": "^6.1.0"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1"
@@ -84,5 +86,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "a9f820893b7714244a0af509a5aefecc1344153c"
+  "gitHead": "a2476c090ce48fd09e9116437aedc6cc45ae60bd"
 }

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;