@commercelayer/react-components 4.8.5-beta.0 → 4.8.5

package/lib/cjs/hooks/useCommerceLayer.d.ts

@@ -1,7 +1,12 @@
 import { type CommerceLayerClient } from '@commercelayer/sdk';
 interface ReturnProps {
+    /** This is the access token used to initialize the sdk client. It need to be set as prop in the main `<CommerceLayer>` component */
     accessToken?: string;
+    /** This method can be used to initialize an sdk client and perform list, retrieve, update or delete operations on any resource */
     sdkClient: () => CommerceLayerClient | undefined;
 }
+/**
+ * React Hook that provides access to the official Commerce Layer SDK JS Client.
+ **/
 export declare function useCommerceLayer(): ReturnProps;
 export default useCommerceLayer;

package/lib/cjs/hooks/useCustomerContainer.d.ts

@@ -1,5 +1,8 @@
 import { type CustomerState } from '../reducers/CustomerReducer';
 interface TReturnCustomer extends Omit<CustomerState, 'errors' | 'isGuest'> {
 }
+/**
+ * React Hook that provides access to the order context stored in the `<CustomerContainer>` component.
+ **/
 export declare function useCustomerContainer(): TReturnCustomer;
 export default useCustomerContainer;

package/lib/cjs/hooks/useOrderContainer.d.ts

@@ -2,9 +2,15 @@ import { type createOrder, type OrderState, type addToCart } from '../reducers/O
 type TAddToCartParams = Omit<Parameters<typeof addToCart>[number], 'buyNowMode' | 'state' | 'dispatch' | 'setLocalOrder' | 'errors' | 'checkoutUrl' | 'persistKey' | 'config'>;
 type TCreateCartParams = Pick<Parameters<typeof createOrder>[number], 'orderAttributes' | 'orderMetadata'>;
 interface TReturnOrder extends Omit<OrderState, 'loading' | 'include' | 'includeLoaded' | 'withoutIncludes' | 'orderId'> {
+    /** Refetch the current order and update the context */
     reloadOrder: () => Promise<OrderState['order']>;
+    /** Allow to add a SKU or a Bundle to the order stored in the context */
     addToCart: (params: TAddToCartParams) => ReturnType<typeof addToCart>;
+    /** Allow to create a new order and store it in the OrderContainer context */
     createOrder: (params: TCreateCartParams) => Promise<string | undefined>;
 }
+/**
+ * React Hook that provides access to the order context stored in the `<OrderContainer>` component.
+ **/
 export declare function useOrderContainer(): TReturnOrder;
 export default useOrderContainer;

package/lib/esm/hooks/useCommerceLayer.d.ts

@@ -1,7 +1,12 @@
 import { type CommerceLayerClient } from '@commercelayer/sdk';
 interface ReturnProps {
+    /** This is the access token used to initialize the sdk client. It need to be set as prop in the main `<CommerceLayer>` component */
     accessToken?: string;
+    /** This method can be used to initialize an sdk client and perform list, retrieve, update or delete operations on any resource */
     sdkClient: () => CommerceLayerClient | undefined;
 }
+/**
+ * React Hook that provides access to the official Commerce Layer SDK JS Client.
+ **/
 export declare function useCommerceLayer(): ReturnProps;
 export default useCommerceLayer;

package/lib/esm/hooks/useCustomerContainer.d.ts

@@ -1,5 +1,8 @@
 import { type CustomerState } from '../reducers/CustomerReducer';
 interface TReturnCustomer extends Omit<CustomerState, 'errors' | 'isGuest'> {
 }
+/**
+ * React Hook that provides access to the order context stored in the `<CustomerContainer>` component.
+ **/
 export declare function useCustomerContainer(): TReturnCustomer;
 export default useCustomerContainer;

package/lib/esm/hooks/useOrderContainer.d.ts

@@ -2,9 +2,15 @@ import { type createOrder, type OrderState, type addToCart } from '../reducers/O
 type TAddToCartParams = Omit<Parameters<typeof addToCart>[number], 'buyNowMode' | 'state' | 'dispatch' | 'setLocalOrder' | 'errors' | 'checkoutUrl' | 'persistKey' | 'config'>;
 type TCreateCartParams = Pick<Parameters<typeof createOrder>[number], 'orderAttributes' | 'orderMetadata'>;
 interface TReturnOrder extends Omit<OrderState, 'loading' | 'include' | 'includeLoaded' | 'withoutIncludes' | 'orderId'> {
+    /** Refetch the current order and update the context */
     reloadOrder: () => Promise<OrderState['order']>;
+    /** Allow to add a SKU or a Bundle to the order stored in the context */
     addToCart: (params: TAddToCartParams) => ReturnType<typeof addToCart>;
+    /** Allow to create a new order and store it in the OrderContainer context */
     createOrder: (params: TCreateCartParams) => Promise<string | undefined>;
 }
+/**
+ * React Hook that provides access to the order context stored in the `<OrderContainer>` component.
+ **/
 export declare function useOrderContainer(): TReturnOrder;
 export default useOrderContainer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercelayer/react-components",
-  "version": "4.8.5-beta.0",
+  "version": "4.8.5",
   "description": "The Official Commerce Layer React Components",
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",