@eetech-commerce/cart-react 0.5.3 → 0.6.0

package/README.md

@@ -92,6 +92,7 @@ function Shop() {
 | `useCreateCheckoutSession()` | Create a checkout session |
 | `useShippingOptions(cartSessionId)` | Fetch available shipping options |
 | `useUpdateShippingSelections()` | Update selected shipping options |
+| `useShippingRegions()` | Fetch available shipping countries and states |
 
 ### Payment Hooks
 
@@ -334,6 +335,8 @@ import type {
   ShippingSelectionDto,
   CreateEmbeddedPaymentSessionDto,
   EmbeddedPaymentSessionResponseDto,
+  ShippingRegionsResponseDto,
+  ShippingRegionDto,
 } from '@eetech-commerce/cart-react';
 ```
 

package/dist/index.d.ts

@@ -394,6 +394,22 @@ type VerificationResultDto = {
      */
     verifiedAt: string;
 };
+type ShippingRegionDto = {
+    /**
+     * ISO country code
+     */
+    countryCode: string;
+    /**
+     * Available state/province codes. Empty array means all states are valid.
+     */
+    states: Array<string>;
+};
+type ShippingRegionsResponseDto = {
+    /**
+     * Available shipping regions grouped by country
+     */
+    shippingRegions: Array<ShippingRegionDto>;
+};
 type AddressDto = {
     /**
      * Name of the recipient
@@ -897,7 +913,332 @@ declare function useUpdateCheckoutSession(): {
     isPending: boolean;
     error: Error | null;
 };
-declare function useShippingOptions(cartSessionId: string | null): _tanstack_react_query.UseQueryResult<ShippingOptionsResponse, Error>;
+declare function useShippingOptions(cartSessionId: string | null): {
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+} | {
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+} | {
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingOptionsResponse, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingOptionsResponse>;
+    shippingOptions: ShippingOptionsResponse | undefined;
+};
+declare function useShippingRegions(): {
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+} | {
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+} | {
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+} | {
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<ShippingRegionsResponseDto, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<ShippingRegionsResponseDto>;
+    shippingRegions: ShippingRegionsResponseDto | undefined;
+};
 interface UpdateShippingSelectionsParams {
     selections: ShippingSelectionDto[];
 }
@@ -952,4 +1293,4 @@ interface CartProviderProps {
 }
 declare function CartProvider({ children, tenantSlug, cartApiUrl, storageAdapter, autoInitialize, queryClient, }: CartProviderProps): react_jsx_runtime.JSX.Element;
 
-export { type CartContextValue, CartProvider, type CartProviderProps, type CartResponseDto, type CreateCheckoutDto, type CreateEmbeddedPaymentSessionDto, type EmbeddedPaymentSessionResponseDto, type LineItemResponseDto, type LoadStripeFn, type MutationCallbacks, type ShippingOptionDto, type ShippingSelectionDto, type StorageAdapter, type UpdateCheckoutDto, type VerificationResultDto, cartKeys, localStorageAdapter, paymentKeys, shippingKeys, useAddToCart, useCart, useCartContext, useClearCart, useCreateCart, useCreateCheckoutSession, useCreateEmbeddedCheckoutSession, useInitializeCart, usePaymentSession, useRemoveItem, useShippingOptions, useStripePromise, useUpdateCheckoutSession, useUpdateItemQty, useUpdateShippingSelections, useVerifyCart };
+export { type CartContextValue, CartProvider, type CartProviderProps, type CartResponseDto, type CreateCheckoutDto, type CreateEmbeddedPaymentSessionDto, type EmbeddedPaymentSessionResponseDto, type LineItemResponseDto, type LoadStripeFn, type MutationCallbacks, type ShippingOptionDto, type ShippingRegionDto, type ShippingRegionsResponseDto, type ShippingSelectionDto, type StorageAdapter, type UpdateCheckoutDto, type VerificationResultDto, cartKeys, localStorageAdapter, paymentKeys, shippingKeys, useAddToCart, useCart, useCartContext, useClearCart, useCreateCart, useCreateCheckoutSession, useCreateEmbeddedCheckoutSession, useInitializeCart, usePaymentSession, useRemoveItem, useShippingOptions, useShippingRegions, useStripePromise, useUpdateCheckoutSession, useUpdateItemQty, useUpdateShippingSelections, useVerifyCart };

package/dist/index.js

@@ -917,6 +917,12 @@ var checkoutControllerVerifyCartV1 = (options) => {
     }
   });
 };
+var checkoutControllerGetShippingRegionsV1 = (options) => {
+  return (options.client ?? client).get({
+    url: "/v1/t/{tenantSlug}/checkout/shipping-regions",
+    ...options
+  });
+};
 var checkoutControllerUpdateCheckoutSessionV1 = (options) => {
   return (options.client ?? client).patch({
     url: "/v1/t/{tenantSlug}/checkout/{cartSessionId}",
@@ -1092,6 +1098,19 @@ var checkoutControllerVerifyCartV1Mutation = (options) => {
   };
   return mutationOptions;
 };
+var checkoutControllerGetShippingRegionsV1QueryKey = (options) => createQueryKey("checkoutControllerGetShippingRegionsV1", options);
+var checkoutControllerGetShippingRegionsV1Options = (options) => queryOptions({
+  queryFn: async ({ queryKey, signal }) => {
+    const { data } = await checkoutControllerGetShippingRegionsV1({
+      ...options,
+      ...queryKey[0],
+      signal,
+      throwOnError: true
+    });
+    return data;
+  },
+  queryKey: checkoutControllerGetShippingRegionsV1QueryKey(options)
+});
 var checkoutControllerUpdateCheckoutSessionV1Mutation = (options) => {
   const mutationOptions = {
     mutationFn: async (fnOptions) => {
@@ -1523,7 +1542,7 @@ function useUpdateCheckoutSession() {
 }
 function useShippingOptions(cartSessionId) {
   const { tenantSlug, cartApiUrl } = useCartContext();
-  return useQuery2({
+  const { data, ...rest } = useQuery2({
     ...checkoutControllerGetShippingOptionsV1Options({
       path: {
         tenantSlug,
@@ -1533,6 +1552,17 @@ function useShippingOptions(cartSessionId) {
     }),
     enabled: !!cartSessionId
   });
+  return { shippingOptions: data, ...rest };
+}
+function useShippingRegions() {
+  const { tenantSlug, cartApiUrl } = useCartContext();
+  const { data, ...rest } = useQuery2({
+    ...checkoutControllerGetShippingRegionsV1Options({
+      path: { tenantSlug },
+      baseUrl: cartApiUrl
+    })
+  });
+  return { shippingRegions: data, ...rest };
 }
 function useUpdateShippingSelections() {
   const { tenantSlug, cartApiUrl, cartSessionId } = useCartContext();
@@ -1733,6 +1763,7 @@ export {
   usePaymentSession,
   useRemoveItem,
   useShippingOptions,
+  useShippingRegions,
   useStripePromise,
   useUpdateCheckoutSession,
   useUpdateItemQty,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eetech-commerce/cart-react",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "type": "module",
   "publishConfig": {
     "access": "public"