@atomic-solutions/woocommerce-react 0.6.1 → 0.7.0

package/dist/hooks/index.d.cts

@@ -1,4 +1,4 @@
-export { A as AppliedCoupon, C as CartTotals, aj as InfiniteQueryOptions, ak as MutationOptions, a as PaymentMethod, b as ProcessedCartItem, c as ProcessedCategory, d as ProcessedOrderDetails, e as ProcessedOrderLineItem, f as ProcessedProduct, g as ProcessedProductDetails, h as ProductCartState, i as ProductCategoryTreeNode, al as QueryOptions, R as ReorderInputItem, j as ReorderItemView, k as ReorderUnavailableReason, S as ShippingRate, n as UseCartViewOptions, o as UseCartViewReturn, p as UseOrderViewOptions, q as UseOrderViewReturn, r as UseProductViewOptions, s as UseProductViewReturn, t as UseProductsFeedOptions, u as UseProductsFeedReturn, v as UseReorderViewOptions, w as UseReorderViewReturn, E as getOrderStatusLabel, Q as useAddManyToCart, T as useAddToCart, V as useApplyCoupon, W as useCart, X as useCartView, Y as useCheckout, Z as useInfiniteProducts, _ as useOrder, $ as useOrderView, a0 as useProcessCheckout, a1 as useProduct, a2 as useProductCategories, a3 as useProductCategoryTree, a4 as useProductView, a5 as useProducts, a6 as useProductsFeed, a7 as useRemoveCoupon, a8 as useRemoveFromCart, a9 as useReorderView, aa as useSelectShippingRate, ab as useStore, ac as useStoreFeatures, ad as useStoreLocale, ae as useStoreTheme, af as useUpdateCartItem, ag as useUpdateCustomer, ah as useWooCommerceClient, ai as useWooCommerceQueryKeys } from '../index-DEvJWFSF.cjs';
-export { Q as QueryKeys, p as createQueryKeys } from '../types-Dnq60zh-.cjs';
+export { A as AppliedCoupon, C as CartTotals, ak as InfiniteQueryOptions, al as MutationOptions, a as PaymentMethod, b as ProcessedCartItem, c as ProcessedCategory, d as ProcessedOrderDetails, e as ProcessedOrderLineItem, f as ProcessedProduct, g as ProcessedProductDetails, h as ProductCartState, i as ProductCategoryTreeNode, am as QueryOptions, R as ReorderInputItem, j as ReorderItemView, k as ReorderUnavailableReason, S as ShippingRate, n as UseCartViewOptions, o as UseCartViewReturn, p as UseOrderViewOptions, q as UseOrderViewReturn, r as UseProductViewOptions, s as UseProductViewReturn, t as UseProductsFeedOptions, u as UseProductsFeedReturn, v as UseReorderViewOptions, w as UseReorderViewReturn, E as getOrderStatusLabel, Q as useAddManyToCart, T as useAddToCart, V as useApplyCoupon, W as useCart, X as useCartView, Y as useCheckout, Z as useInfiniteProducts, _ as useOrder, $ as useOrderView, a0 as useProcessCheckout, a1 as useProduct, a2 as useProductCategories, a3 as useProductCategoryTree, a4 as useProductTags, a5 as useProductView, a6 as useProducts, a7 as useProductsFeed, a8 as useRemoveCoupon, a9 as useRemoveFromCart, aa as useReorderView, ab as useSelectShippingRate, ac as useStore, ad as useStoreFeatures, ae as useStoreLocale, af as useStoreTheme, ag as useUpdateCartItem, ah as useUpdateCustomer, ai as useWooCommerceClient, aj as useWooCommerceQueryKeys } from '../index-UkshfFwm.cjs';
+export { Q as QueryKeys, p as createQueryKeys } from '../types-4MW3Y__g.cjs';
 export { OrderStatus } from '@atomic-solutions/woocommerce-api-client';
 import '@tanstack/react-query';

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-export { A as AppliedCoupon, C as CartTotals, aj as InfiniteQueryOptions, ak as MutationOptions, a as PaymentMethod, b as ProcessedCartItem, c as ProcessedCategory, d as ProcessedOrderDetails, e as ProcessedOrderLineItem, f as ProcessedProduct, g as ProcessedProductDetails, h as ProductCartState, i as ProductCategoryTreeNode, al as QueryOptions, R as ReorderInputItem, j as ReorderItemView, k as ReorderUnavailableReason, S as ShippingRate, n as UseCartViewOptions, o as UseCartViewReturn, p as UseOrderViewOptions, q as UseOrderViewReturn, r as UseProductViewOptions, s as UseProductViewReturn, t as UseProductsFeedOptions, u as UseProductsFeedReturn, v as UseReorderViewOptions, w as UseReorderViewReturn, E as getOrderStatusLabel, Q as useAddManyToCart, T as useAddToCart, V as useApplyCoupon, W as useCart, X as useCartView, Y as useCheckout, Z as useInfiniteProducts, _ as useOrder, $ as useOrderView, a0 as useProcessCheckout, a1 as useProduct, a2 as useProductCategories, a3 as useProductCategoryTree, a4 as useProductView, a5 as useProducts, a6 as useProductsFeed, a7 as useRemoveCoupon, a8 as useRemoveFromCart, a9 as useReorderView, aa as useSelectShippingRate, ab as useStore, ac as useStoreFeatures, ad as useStoreLocale, ae as useStoreTheme, af as useUpdateCartItem, ag as useUpdateCustomer, ah as useWooCommerceClient, ai as useWooCommerceQueryKeys } from '../index-Dmlapl9c.js';
-export { Q as QueryKeys, p as createQueryKeys } from '../types-Dnq60zh-.js';
+export { A as AppliedCoupon, C as CartTotals, ak as InfiniteQueryOptions, al as MutationOptions, a as PaymentMethod, b as ProcessedCartItem, c as ProcessedCategory, d as ProcessedOrderDetails, e as ProcessedOrderLineItem, f as ProcessedProduct, g as ProcessedProductDetails, h as ProductCartState, i as ProductCategoryTreeNode, am as QueryOptions, R as ReorderInputItem, j as ReorderItemView, k as ReorderUnavailableReason, S as ShippingRate, n as UseCartViewOptions, o as UseCartViewReturn, p as UseOrderViewOptions, q as UseOrderViewReturn, r as UseProductViewOptions, s as UseProductViewReturn, t as UseProductsFeedOptions, u as UseProductsFeedReturn, v as UseReorderViewOptions, w as UseReorderViewReturn, E as getOrderStatusLabel, Q as useAddManyToCart, T as useAddToCart, V as useApplyCoupon, W as useCart, X as useCartView, Y as useCheckout, Z as useInfiniteProducts, _ as useOrder, $ as useOrderView, a0 as useProcessCheckout, a1 as useProduct, a2 as useProductCategories, a3 as useProductCategoryTree, a4 as useProductTags, a5 as useProductView, a6 as useProducts, a7 as useProductsFeed, a8 as useRemoveCoupon, a9 as useRemoveFromCart, aa as useReorderView, ab as useSelectShippingRate, ac as useStore, ad as useStoreFeatures, ae as useStoreLocale, af as useStoreTheme, ag as useUpdateCartItem, ah as useUpdateCustomer, ai as useWooCommerceClient, aj as useWooCommerceQueryKeys } from '../index-BmWcF7aq.js';
+export { Q as QueryKeys, p as createQueryKeys } from '../types-4MW3Y__g.js';
 export { OrderStatus } from '@atomic-solutions/woocommerce-api-client';
 import '@tanstack/react-query';

package/dist/hooks/index.js

@@ -40,6 +40,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 */
@@ -137,6 +139,16 @@ var processCategoriesToTree = (data) => {
   });
   return rootCategories?.map(processCategory) ?? [];
 };
+var useProductTags = (params, options) => {
+  const client = useWooCommerceClient();
+  const queryKeys = useWooCommerceQueryKeys();
+  return useQuery({
+    queryKey: queryKeys.products.tags(params),
+    queryFn: () => client.products.tags(params),
+    staleTime: StaleTimes.tags,
+    ...options
+  });
+};
 var useProductCategoryTree = () => {
   const query = useProductCategories();
   const flatData = query.data ?? [];
@@ -461,7 +473,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: {
@@ -751,6 +765,18 @@ function getAllImageUrls(images, size = "full") {
   }
   return images.map((img) => getSizedImageUrl(img.src, size));
 }
+var useProcessedImageUrl = (imageSize, fallbackOverride) => {
+  const config = useContext(WooCommerceStoreContext)?.config;
+  const transformer = config?.imageUrlTransformer;
+  const fallbackImageUrl = fallbackOverride ?? config?.fallbackImageUrl;
+  return useCallback(
+    (images) => {
+      const baseUrl = getImageUrl(images, imageSize, fallbackImageUrl);
+      return baseUrl && transformer ? transformer(baseUrl, imageSize) : baseUrl;
+    },
+    [imageSize, fallbackImageUrl, transformer]
+  );
+};
 
 // src/hooks/useProductsFeed.ts
 function useProductsFeed(options = {}) {
@@ -758,8 +784,6 @@ function useProductsFeed(options = {}) {
   const storeContext = useContext(WooCommerceStoreContext);
   const storeConfig = storeContext?.config;
   const localeTag = options.localeTag ?? storeConfig?.locale?.localeTag ?? DEFAULT_STORE_CONFIG.locale.localeTag;
-  const fallbackImageUrl = options.fallbackImageUrl ?? storeConfig?.fallbackImageUrl;
-  const imageUrlTransformer = storeConfig?.imageUrlTransformer;
   const {
     data: productsData,
     isLoading,
@@ -771,16 +795,7 @@ function useProductsFeed(options = {}) {
     isRefetching
   } = useInfiniteProducts(params);
   const { treeData: categoryTree = [], findById } = useProductCategoryTree();
-  const getProcessedImageUrl = useCallback(
-    (images) => {
-      const baseUrl = getImageUrl(images, imageSize, fallbackImageUrl);
-      if (baseUrl && imageUrlTransformer) {
-        return imageUrlTransformer(baseUrl, imageSize);
-      }
-      return baseUrl;
-    },
-    [imageSize, fallbackImageUrl, imageUrlTransformer]
-  );
+  const getProcessedImageUrl = useProcessedImageUrl(imageSize, options.fallbackImageUrl);
   const products = useMemo(() => {
     if (!productsData) return [];
     const productList = Array.isArray(productsData) ? productsData : [];
@@ -832,7 +847,6 @@ function useProductView(options) {
   const storeContext = useContext(WooCommerceStoreContext);
   const storeConfig = storeContext?.config;
   const localeTag = options.localeTag ?? storeConfig?.locale?.localeTag ?? DEFAULT_STORE_CONFIG.locale.localeTag;
-  const fallbackImageUrl = options.fallbackImageUrl ?? storeConfig?.fallbackImageUrl;
   const imageUrlTransformer = storeConfig?.imageUrlTransformer;
   const [draftQuantity, setDraftQuantity] = useState(1);
   const { data: productData, isLoading, error, refetch } = useProduct(productId);
@@ -840,6 +854,7 @@ function useProductView(options) {
   const addToCartMutation = useAddToCart();
   const removeFromCartMutation = useRemoveFromCart();
   const updateCartMutation = useUpdateCartItem();
+  const getProcessedImageUrl = useProcessedImageUrl(imageSize, options.fallbackImageUrl);
   const processImageUrl = useCallback(
     (url) => {
       if (!url) return url;
@@ -855,7 +870,6 @@ function useProductView(options) {
     const currencyCode = productData.prices?.currency_code;
     const stockStatus = productData.is_on_backorder ? "onbackorder" : productData.is_in_stock ? "instock" : "outofstock";
     const lowStockRemaining = productData.low_stock_remaining;
-    const baseImageUrl = getImageUrl(productData.images, imageSize, fallbackImageUrl);
     const baseImageUrls = getAllImageUrls(productData.images, imageSize);
     return {
       id: productData.id,
@@ -865,7 +879,7 @@ function useProductView(options) {
       description: productData.description,
       shortDescription: productData.short_description,
       sku: productData.sku,
-      imageUrl: processImageUrl(baseImageUrl),
+      imageUrl: getProcessedImageUrl(productData.images),
       imageUrls: baseImageUrls.map((url) => processImageUrl(url) ?? url),
       price: formatStoreApiPriceIntl(productData.prices?.price, currencyCode, localeTag),
       regularPrice: formatStoreApiPriceIntl(
@@ -895,7 +909,7 @@ function useProductView(options) {
       minQuantity: productData.add_to_cart?.minimum ?? 1,
       raw: productData
     };
-  }, [productData, localeTag, fallbackImageUrl, imageSize, lowStockThreshold, processImageUrl]);
+  }, [productData, localeTag, imageSize, lowStockThreshold, getProcessedImageUrl, processImageUrl]);
   const cartItem = useMemo(() => {
     return cartData?.items.find((item) => item.id === productId);
   }, [cartData?.items, productId]);
@@ -978,24 +992,13 @@ function useCartView(options = {}) {
   const storeContext = useContext(WooCommerceStoreContext);
   const storeConfig = storeContext?.config;
   const localeTag = options.localeTag ?? storeConfig?.locale?.localeTag ?? DEFAULT_STORE_CONFIG.locale.localeTag;
-  const fallbackImageUrl = options.fallbackImageUrl ?? storeConfig?.fallbackImageUrl;
-  const imageUrlTransformer = storeConfig?.imageUrlTransformer;
   const { data: cartData, isLoading, error, refetch } = useCart();
   const updateItemMutation = useUpdateCartItem();
   const removeItemMutation = useRemoveFromCart();
   const applyCouponMutation = useApplyCoupon();
   const removeCouponMutation = useRemoveCoupon();
   const selectShippingMutation = useSelectShippingRate();
-  const getProcessedImageUrl = useCallback(
-    (images) => {
-      const baseUrl = getImageUrl(images, imageSize, fallbackImageUrl);
-      if (baseUrl && imageUrlTransformer) {
-        return imageUrlTransformer(baseUrl, imageSize);
-      }
-      return baseUrl;
-    },
-    [imageSize, fallbackImageUrl, imageUrlTransformer]
-  );
+  const getProcessedImageUrl = useProcessedImageUrl(imageSize, options.fallbackImageUrl);
   const items = useMemo(() => {
     if (!cartData?.items) return [];
     const currencyCode = cartData.totals.currency_code;
@@ -1141,8 +1144,6 @@ function useReorderView(items, options = {}) {
   const storeContext = useContext(WooCommerceStoreContext);
   const storeConfig = storeContext?.config;
   const localeTag = options.localeTag ?? storeConfig?.locale?.localeTag ?? DEFAULT_STORE_CONFIG.locale.localeTag;
-  const fallbackImageUrl = options.fallbackImageUrl ?? storeConfig?.fallbackImageUrl;
-  const imageUrlTransformer = storeConfig?.imageUrlTransformer;
   const productIds = useMemo(() => [...new Set(items.map((item) => item.productId))], [items]);
   const {
     data: productsPage,
@@ -1153,16 +1154,7 @@ function useReorderView(items, options = {}) {
     { enabled: productIds.length > 0 }
   );
   const { data: cart } = useCart();
-  const getProcessedImageUrl = useCallback(
-    (images) => {
-      const baseUrl = getImageUrl(images, imageSize, fallbackImageUrl);
-      if (baseUrl && imageUrlTransformer) {
-        return imageUrlTransformer(baseUrl, imageSize);
-      }
-      return baseUrl;
-    },
-    [imageSize, fallbackImageUrl, imageUrlTransformer]
-  );
+  const getProcessedImageUrl = useProcessedImageUrl(imageSize, options.fallbackImageUrl);
   const views = useMemo(() => {
     const products = new Map((productsPage?.data ?? []).map((product) => [product.id, product]));
     return items.map((item) => {
@@ -1244,6 +1236,8 @@ function useOrderView(input, options = {}) {
   const storeContext = 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 = useMemo(() => {
     if (!rawOrder) return void 0;
@@ -1254,7 +1248,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 {
@@ -1269,7 +1263,7 @@ function useOrderView(input, options = {}) {
       paymentMethod: rawOrder.payment_method ?? "",
       raw: rawOrder
     };
-  }, [rawOrder, localeTag]);
+  }, [rawOrder, localeTag, getProcessedImageUrl]);
   return {
     order,
     isLoading,
@@ -1277,6 +1271,6 @@ function useOrderView(input, options = {}) {
   };
 }
 
-export { createQueryKeys, getOrderStatusLabel, useAddManyToCart, useAddToCart, useApplyCoupon, useCart, useCartView, useCheckout, useInfiniteProducts, useOrder, useOrderView, useProcessCheckout, useProduct, useProductCategories, useProductCategoryTree, useProductView, useProducts, useProductsFeed, useRemoveCoupon, useRemoveFromCart, useReorderView, useSelectShippingRate, useStore, useStoreFeatures, useStoreLocale, useStoreTheme, useUpdateCartItem, useUpdateCustomer, useWooCommerceClient, useWooCommerceQueryKeys };
+export { createQueryKeys, getOrderStatusLabel, useAddManyToCart, useAddToCart, useApplyCoupon, useCart, useCartView, useCheckout, useInfiniteProducts, useOrder, useOrderView, useProcessCheckout, useProduct, useProductCategories, useProductCategoryTree, useProductTags, useProductView, useProducts, useProductsFeed, useRemoveCoupon, useRemoveFromCart, useReorderView, useSelectShippingRate, useStore, useStoreFeatures, useStoreLocale, useStoreTheme, useUpdateCartItem, useUpdateCustomer, useWooCommerceClient, useWooCommerceQueryKeys };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map