@atomic-solutions/woocommerce-react 0.6.2 → 0.7.0

package/dist/{index-Dmlapl9c.d.ts → index-BmWcF7aq.d.ts}

@@ -1,8 +1,8 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, UseInfiniteQueryOptions, InfiniteData, UseMutationOptions } from '@tanstack/react-query';
 import * as _atomic_solutions_woocommerce_api_client from '@atomic-solutions/woocommerce-api-client';
-import { WooCommerceClient, ProductCategory, ProductParams, PaginatedResponse, Product, Cart, Checkout, GetOrderInput, StoreApiOrder, ProductImage, CartItemImage, CartItem } from '@atomic-solutions/woocommerce-api-client';
-import { Q as QueryKeys, k as StoreContextValue, l as StoreFeatures, S as StoreLocale, n as StoreTheme } from './types-Dnq60zh-.js';
+import { WooCommerceClient, ProductCategory, ProductParams, PaginatedResponse, Product, ProductTagsParams, ProductTag, Cart, Checkout, GetOrderInput, StoreApiOrder, ProductImage, CartItemImage, CartItem } from '@atomic-solutions/woocommerce-api-client';
+import { Q as QueryKeys, k as StoreContextValue, l as StoreFeatures, S as StoreLocale, n as StoreTheme } from './types-4MW3Y__g.js';
 
 type QueryOptions<TData, TError = Error> = Omit<UseQueryOptions<TData, TError>, 'queryKey' | 'queryFn'>;
 type MutationOptions<TData, TError = Error, TVariables = unknown> = Omit<UseMutationOptions<TData, TError, TVariables>, 'mutationFn'>;
@@ -2933,6 +2933,11 @@ declare const useProductCategories: (options?: QueryOptions<ProductCategory[]>)
     count: number;
     menu_order?: number | undefined;
 }[], Error>;
+declare const useProductTags: (params?: ProductTagsParams, options?: QueryOptions<ProductTag[]>) => _tanstack_react_query.UseQueryResult<{
+    id: number;
+    name: string;
+    slug: string;
+}[], Error>;
 declare const useProductCategoryTree: () => {
     data: {
         id: number;
@@ -8333,7 +8338,7 @@ declare const useCheckout: (options?: QueryOptions<Checkout>) => _tanstack_react
         payment_status: string;
         payment_details: unknown[];
         redirect_url: string;
-    };
+    } | null;
 }, Error>;
 declare const useProcessCheckout: () => _tanstack_react_query.UseMutationResult<{
     status: string;
@@ -8371,7 +8376,7 @@ declare const useProcessCheckout: () => _tanstack_react_query.UseMutationResult<
         payment_status: string;
         payment_details: unknown[];
         redirect_url: string;
-    };
+    } | null;
 }, Error, {
     payment_method: string;
     extensions?: Record<string, unknown> | undefined;
@@ -8807,6 +8812,8 @@ interface ProcessedOrderDetails {
 }
 interface UseOrderViewOptions {
     localeTag?: string;
+    fallbackImageUrl?: string;
+    imageSize?: ImageSize;
 }
 interface UseOrderViewReturn {
     order: ProcessedOrderDetails | undefined;
@@ -8815,4 +8822,4 @@ interface UseOrderViewReturn {
 }
 declare function useOrderView(input: GetOrderInput, options?: UseOrderViewOptions): UseOrderViewReturn;
 
-export { useOrderView as $, type AppliedCoupon as A, getImageUrlOrPlaceholder as B, type CartTotals as C, getMaxAddToCartQuantity as D, getOrderStatusLabel as E, getPrimaryImage as F, getSizedImageUrl as G, getStockSeverity as H, type ImageSize as I, getStockStatusText as J, isLowStock as K, isPurchasable as L, preloadImage as M, preloadImages as N, unavailableReason as O, PLACEHOLDER_IMAGE_URL as P, useAddManyToCart as Q, type ReorderInputItem as R, type ShippingRate as S, useAddToCart as T, type UnavailableReason as U, useApplyCoupon as V, useCart as W, useCartView as X, useCheckout as Y, useInfiniteProducts as Z, useOrder as _, type PaymentMethod as a, useProcessCheckout as a0, useProduct as a1, useProductCategories as a2, useProductCategoryTree as a3, useProductView as a4, useProducts as a5, useProductsFeed as a6, useRemoveCoupon as a7, useRemoveFromCart as a8, useReorderView as a9, useSelectShippingRate as aa, useStore as ab, useStoreFeatures as ac, useStoreLocale as ad, useStoreTheme as ae, useUpdateCartItem as af, useUpdateCustomer as ag, useWooCommerceClient as ah, useWooCommerceQueryKeys as ai, type InfiniteQueryOptions as aj, type MutationOptions as ak, type QueryOptions as al, type ProcessedCartItem as b, type ProcessedCategory as c, type ProcessedOrderDetails as d, type ProcessedOrderLineItem as e, type ProcessedProduct as f, type ProcessedProductDetails as g, type ProductCartState as h, type ProductCategoryTreeNode as i, type ReorderItemView as j, type ReorderUnavailableReason as k, type StockDisplayConfig as l, type StockStatus as m, type UseCartViewOptions as n, type UseCartViewReturn as o, type UseOrderViewOptions as p, type UseOrderViewReturn as q, type UseProductViewOptions as r, type UseProductViewReturn as s, type UseProductsFeedOptions as t, type UseProductsFeedReturn as u, type UseReorderViewOptions as v, type UseReorderViewReturn as w, canAddToCart as x, getAllImageUrls as y, getImageUrl as z };
+export { useOrderView as $, type AppliedCoupon as A, getImageUrlOrPlaceholder as B, type CartTotals as C, getMaxAddToCartQuantity as D, getOrderStatusLabel as E, getPrimaryImage as F, getSizedImageUrl as G, getStockSeverity as H, type ImageSize as I, getStockStatusText as J, isLowStock as K, isPurchasable as L, preloadImage as M, preloadImages as N, unavailableReason as O, PLACEHOLDER_IMAGE_URL as P, useAddManyToCart as Q, type ReorderInputItem as R, type ShippingRate as S, useAddToCart as T, type UnavailableReason as U, useApplyCoupon as V, useCart as W, useCartView as X, useCheckout as Y, useInfiniteProducts as Z, useOrder as _, type PaymentMethod as a, useProcessCheckout as a0, useProduct as a1, useProductCategories as a2, useProductCategoryTree as a3, useProductTags as a4, useProductView as a5, useProducts as a6, useProductsFeed as a7, useRemoveCoupon as a8, useRemoveFromCart as a9, useReorderView as aa, useSelectShippingRate as ab, useStore as ac, useStoreFeatures as ad, useStoreLocale as ae, useStoreTheme as af, useUpdateCartItem as ag, useUpdateCustomer as ah, useWooCommerceClient as ai, useWooCommerceQueryKeys as aj, type InfiniteQueryOptions as ak, type MutationOptions as al, type QueryOptions as am, type ProcessedCartItem as b, type ProcessedCategory as c, type ProcessedOrderDetails as d, type ProcessedOrderLineItem as e, type ProcessedProduct as f, type ProcessedProductDetails as g, type ProductCartState as h, type ProductCategoryTreeNode as i, type ReorderItemView as j, type ReorderUnavailableReason as k, type StockDisplayConfig as l, type StockStatus as m, type UseCartViewOptions as n, type UseCartViewReturn as o, type UseOrderViewOptions as p, type UseOrderViewReturn as q, type UseProductViewOptions as r, type UseProductViewReturn as s, type UseProductsFeedOptions as t, type UseProductsFeedReturn as u, type UseReorderViewOptions as v, type UseReorderViewReturn as w, canAddToCart as x, getAllImageUrls as y, getImageUrl as z };

package/dist/{index-DEvJWFSF.d.cts → index-UkshfFwm.d.cts}

@@ -1,8 +1,8 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, UseInfiniteQueryOptions, InfiniteData, UseMutationOptions } from '@tanstack/react-query';
 import * as _atomic_solutions_woocommerce_api_client from '@atomic-solutions/woocommerce-api-client';
-import { WooCommerceClient, ProductCategory, ProductParams, PaginatedResponse, Product, Cart, Checkout, GetOrderInput, StoreApiOrder, ProductImage, CartItemImage, CartItem } from '@atomic-solutions/woocommerce-api-client';
-import { Q as QueryKeys, k as StoreContextValue, l as StoreFeatures, S as StoreLocale, n as StoreTheme } from './types-Dnq60zh-.cjs';
+import { WooCommerceClient, ProductCategory, ProductParams, PaginatedResponse, Product, ProductTagsParams, ProductTag, Cart, Checkout, GetOrderInput, StoreApiOrder, ProductImage, CartItemImage, CartItem } from '@atomic-solutions/woocommerce-api-client';
+import { Q as QueryKeys, k as StoreContextValue, l as StoreFeatures, S as StoreLocale, n as StoreTheme } from './types-4MW3Y__g.cjs';
 
 type QueryOptions<TData, TError = Error> = Omit<UseQueryOptions<TData, TError>, 'queryKey' | 'queryFn'>;
 type MutationOptions<TData, TError = Error, TVariables = unknown> = Omit<UseMutationOptions<TData, TError, TVariables>, 'mutationFn'>;
@@ -2933,6 +2933,11 @@ declare const useProductCategories: (options?: QueryOptions<ProductCategory[]>)
     count: number;
     menu_order?: number | undefined;
 }[], Error>;
+declare const useProductTags: (params?: ProductTagsParams, options?: QueryOptions<ProductTag[]>) => _tanstack_react_query.UseQueryResult<{
+    id: number;
+    name: string;
+    slug: string;
+}[], Error>;
 declare const useProductCategoryTree: () => {
     data: {
         id: number;
@@ -8333,7 +8338,7 @@ declare const useCheckout: (options?: QueryOptions<Checkout>) => _tanstack_react
         payment_status: string;
         payment_details: unknown[];
         redirect_url: string;
-    };
+    } | null;
 }, Error>;
 declare const useProcessCheckout: () => _tanstack_react_query.UseMutationResult<{
     status: string;
@@ -8371,7 +8376,7 @@ declare const useProcessCheckout: () => _tanstack_react_query.UseMutationResult<
         payment_status: string;
         payment_details: unknown[];
         redirect_url: string;
-    };
+    } | null;
 }, Error, {
     payment_method: string;
     extensions?: Record<string, unknown> | undefined;
@@ -8807,6 +8812,8 @@ interface ProcessedOrderDetails {
 }
 interface UseOrderViewOptions {
     localeTag?: string;
+    fallbackImageUrl?: string;
+    imageSize?: ImageSize;
 }
 interface UseOrderViewReturn {
     order: ProcessedOrderDetails | undefined;
@@ -8815,4 +8822,4 @@ interface UseOrderViewReturn {
 }
 declare function useOrderView(input: GetOrderInput, options?: UseOrderViewOptions): UseOrderViewReturn;
 
-export { useOrderView as $, type AppliedCoupon as A, getImageUrlOrPlaceholder as B, type CartTotals as C, getMaxAddToCartQuantity as D, getOrderStatusLabel as E, getPrimaryImage as F, getSizedImageUrl as G, getStockSeverity as H, type ImageSize as I, getStockStatusText as J, isLowStock as K, isPurchasable as L, preloadImage as M, preloadImages as N, unavailableReason as O, PLACEHOLDER_IMAGE_URL as P, useAddManyToCart as Q, type ReorderInputItem as R, type ShippingRate as S, useAddToCart as T, type UnavailableReason as U, useApplyCoupon as V, useCart as W, useCartView as X, useCheckout as Y, useInfiniteProducts as Z, useOrder as _, type PaymentMethod as a, useProcessCheckout as a0, useProduct as a1, useProductCategories as a2, useProductCategoryTree as a3, useProductView as a4, useProducts as a5, useProductsFeed as a6, useRemoveCoupon as a7, useRemoveFromCart as a8, useReorderView as a9, useSelectShippingRate as aa, useStore as ab, useStoreFeatures as ac, useStoreLocale as ad, useStoreTheme as ae, useUpdateCartItem as af, useUpdateCustomer as ag, useWooCommerceClient as ah, useWooCommerceQueryKeys as ai, type InfiniteQueryOptions as aj, type MutationOptions as ak, type QueryOptions as al, type ProcessedCartItem as b, type ProcessedCategory as c, type ProcessedOrderDetails as d, type ProcessedOrderLineItem as e, type ProcessedProduct as f, type ProcessedProductDetails as g, type ProductCartState as h, type ProductCategoryTreeNode as i, type ReorderItemView as j, type ReorderUnavailableReason as k, type StockDisplayConfig as l, type StockStatus as m, type UseCartViewOptions as n, type UseCartViewReturn as o, type UseOrderViewOptions as p, type UseOrderViewReturn as q, type UseProductViewOptions as r, type UseProductViewReturn as s, type UseProductsFeedOptions as t, type UseProductsFeedReturn as u, type UseReorderViewOptions as v, type UseReorderViewReturn as w, canAddToCart as x, getAllImageUrls as y, getImageUrl as z };
+export { useOrderView as $, type AppliedCoupon as A, getImageUrlOrPlaceholder as B, type CartTotals as C, getMaxAddToCartQuantity as D, getOrderStatusLabel as E, getPrimaryImage as F, getSizedImageUrl as G, getStockSeverity as H, type ImageSize as I, getStockStatusText as J, isLowStock as K, isPurchasable as L, preloadImage as M, preloadImages as N, unavailableReason as O, PLACEHOLDER_IMAGE_URL as P, useAddManyToCart as Q, type ReorderInputItem as R, type ShippingRate as S, useAddToCart as T, type UnavailableReason as U, useApplyCoupon as V, useCart as W, useCartView as X, useCheckout as Y, useInfiniteProducts as Z, useOrder as _, type PaymentMethod as a, useProcessCheckout as a0, useProduct as a1, useProductCategories as a2, useProductCategoryTree as a3, useProductTags as a4, useProductView as a5, useProducts as a6, useProductsFeed as a7, useRemoveCoupon as a8, useRemoveFromCart as a9, useReorderView as aa, useSelectShippingRate as ab, useStore as ac, useStoreFeatures as ad, useStoreLocale as ae, useStoreTheme as af, useUpdateCartItem as ag, useUpdateCustomer as ah, useWooCommerceClient as ai, useWooCommerceQueryKeys as aj, type InfiniteQueryOptions as ak, type MutationOptions as al, type QueryOptions as am, type ProcessedCartItem as b, type ProcessedCategory as c, type ProcessedOrderDetails as d, type ProcessedOrderLineItem as e, type ProcessedProduct as f, type ProcessedProductDetails as g, type ProductCartState as h, type ProductCategoryTreeNode as i, type ReorderItemView as j, type ReorderUnavailableReason as k, type StockDisplayConfig as l, type StockStatus as m, type UseCartViewOptions as n, type UseCartViewReturn as o, type UseOrderViewOptions as p, type UseOrderViewReturn as q, type UseProductViewOptions as r, type UseProductViewReturn as s, type UseProductsFeedOptions as t, type UseProductsFeedReturn as u, type UseReorderViewOptions as v, type UseReorderViewReturn as w, canAddToCart as x, getAllImageUrls as y, getImageUrl as z };

package/dist/index.cjs

@@ -478,6 +478,8 @@ var StaleTimes = {
   product: STALE_TIME_SHORT,
   /** Product categories - always fresh */
   categories: STALE_TIME_NONE,
+  /** Product tags - names rarely change, 1 hour */
+  tags: STALE_TIME_LONG,
   /** Orders - always fresh */
   orders: STALE_TIME_NONE,
   /** Default for infinite queries - 1 hour */
@@ -575,6 +577,16 @@ var processCategoriesToTree = (data) => {
   });
   return rootCategories?.map(processCategory) ?? [];
 };
+var useProductTags = (params, options) => {
+  const client = useWooCommerceClient();
+  const queryKeys = useWooCommerceQueryKeys();
+  return reactQuery.useQuery({
+    queryKey: queryKeys.products.tags(params),
+    queryFn: () => client.products.tags(params),
+    staleTime: StaleTimes.tags,
+    ...options
+  });
+};
 var useProductCategoryTree = () => {
   const query = useProductCategories();
   const flatData = query.data ?? [];
@@ -895,7 +907,9 @@ var createQueryKeys = (prefix = ["woocommerce"]) => ({
     list: (params) => [...prefix, "products", "list", params],
     details: () => [...prefix, "products", "detail"],
     detail: (id) => [...prefix, "products", "detail", id],
-    categories: () => [...prefix, "products", "categories"]
+    categories: () => [...prefix, "products", "categories"],
+    // Params are in the key, so each set of tag ids is cached apart.
+    tags: (params) => [...prefix, "products", "tags", params]
   },
   // Cart
   cart: {
@@ -1740,6 +1754,8 @@ function useOrderView(input, options = {}) {
   const storeContext = react.useContext(WooCommerceStoreContext);
   const storeConfig = storeContext?.config;
   const localeTag = options.localeTag ?? storeConfig?.locale?.localeTag ?? DEFAULT_STORE_CONFIG.locale.localeTag;
+  const { imageSize = "thumbnail" } = options;
+  const getProcessedImageUrl = useProcessedImageUrl(imageSize, options.fallbackImageUrl);
   const { data: rawOrder, isLoading, error } = useOrder(input);
   const order = react.useMemo(() => {
     if (!rawOrder) return void 0;
@@ -1750,7 +1766,7 @@ function useOrderView(input, options = {}) {
       quantity: item.quantity,
       price: formatStoreApiPriceIntl(item.prices.price, currencyCode, localeTag),
       total: formatStoreApiPriceIntl(item.totals.line_total, currencyCode, localeTag),
-      imageUrl: item.images?.[0]?.src
+      imageUrl: getProcessedImageUrl(item.images)
     }));
     const status = rawOrder.status;
     return {
@@ -1765,7 +1781,7 @@ function useOrderView(input, options = {}) {
       paymentMethod: rawOrder.payment_method ?? "",
       raw: rawOrder
     };
-  }, [rawOrder, localeTag]);
+  }, [rawOrder, localeTag, getProcessedImageUrl]);
   return {
     order,
     isLoading,
@@ -1908,6 +1924,7 @@ exports.useProcessCheckout = useProcessCheckout;
 exports.useProduct = useProduct;
 exports.useProductCategories = useProductCategories;
 exports.useProductCategoryTree = useProductCategoryTree;
+exports.useProductTags = useProductTags;
 exports.useProductView = useProductView;
 exports.useProducts = useProducts;
 exports.useProductsFeed = useProductsFeed;