@behio/storefront-sdk 2.16.0 → 2.17.0

package/dist/react.mjs

@@ -171,6 +171,7 @@ var BehioStorefront = class {
     this.pages = new PagesModule(this);
     this.blog = new BlogModule(this);
     this.forms = new FormsModule(this);
+    this.collections = new CollectionsModule(this);
     this.wishlist = new WishlistModule(this);
     this.reviews = new ReviewsModule(this);
     this.returns = new ReturnsModule(this);
@@ -1799,6 +1800,34 @@ var BlogModule = class {
     });
   }
 };
+var CollectionsModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * One collection with its published items in the owner's order.
+   * `limit` 1 to 200 (default 100), `offset` for paging; `total` is the
+   * number of published items. 404 `be.collections.collectionNotFound` for an
+   * unknown or private slug.
+   */
+  async get(slug, query) {
+    return this.client.request(
+      "GET",
+      `/collections/${encodeURIComponent(slug)}`,
+      { query: { limit: query?.limit, offset: query?.offset } }
+    );
+  }
+  /**
+   * One published item by its slug or id (detail page). 404
+   * `be.collections.itemNotFound` for a draft or unknown item.
+   */
+  async item(slug, itemSlugOrId) {
+    return this.client.request(
+      "GET",
+      `/collections/${encodeURIComponent(slug)}/items/${encodeURIComponent(itemSlugOrId)}`
+    );
+  }
+};
 var FormsModule = class {
   constructor(client) {
     this.client = client;
@@ -3955,9 +3984,28 @@ function useBlogPost(handle, slug, locale, options) {
   });
 }
 
+// src/react/hooks/use-collection.ts
+import { useQuery as useQuery31 } from "@tanstack/react-query";
+function useCollection(slug, query, options) {
+  const { client } = useBehio();
+  return useQuery31({
+    queryKey: ["behio", "collection", slug, query?.limit, query?.offset],
+    queryFn: () => unwrap(client.collections.get(slug, query)),
+    enabled: options?.enabled !== false && !!slug
+  });
+}
+function useCollectionItem(slug, itemSlugOrId, options) {
+  const { client } = useBehio();
+  return useQuery31({
+    queryKey: ["behio", "collection", slug, "item", itemSlugOrId],
+    queryFn: () => unwrap(client.collections.item(slug, itemSlugOrId)),
+    enabled: options?.enabled !== false && !!slug && !!itemSlugOrId
+  });
+}
+
 // src/react/hooks/use-site-form.ts
 import { useCallback as useCallback15, useMemo as useMemo4 } from "react";
-import { useMutation as useMutation15, useQuery as useQuery31 } from "@tanstack/react-query";
+import { useMutation as useMutation15, useQuery as useQuery32 } from "@tanstack/react-query";
 
 // src/errors.ts
 function bodyOf(err) {
@@ -4008,7 +4056,7 @@ function formFieldErrors(err) {
 // src/react/hooks/use-site-form.ts
 function useSiteForm(slug, options) {
   const { client } = useBehio();
-  return useQuery31({
+  return useQuery32({
     queryKey: ["behio", "form", slug],
     queryFn: () => unwrap(client.forms.get(slug)),
     enabled: options?.enabled !== false && !!slug
@@ -4052,10 +4100,10 @@ function useSiteFormSubmit(slug) {
 }
 
 // src/react/hooks/use-shop-info.ts
-import { useQuery as useQuery32 } from "@tanstack/react-query";
+import { useQuery as useQuery33 } from "@tanstack/react-query";
 function useShopInfo(options) {
   const { client } = useBehio();
-  return useQuery32({
+  return useQuery33({
     queryKey: ["behio", "shop-info"],
     queryFn: () => unwrap(client.getShopInfo()),
     enabled: options?.enabled !== false
@@ -4063,10 +4111,10 @@ function useShopInfo(options) {
 }
 
 // src/react/hooks/use-shop-scripts.ts
-import { useQuery as useQuery33 } from "@tanstack/react-query";
+import { useQuery as useQuery34 } from "@tanstack/react-query";
 function useShopScripts(options) {
   const { client } = useBehio();
-  return useQuery33({
+  return useQuery34({
     queryKey: ["behio", "shop-scripts"],
     queryFn: () => unwrap(client.getShopScripts()),
     enabled: options?.enabled !== false,
@@ -4075,11 +4123,11 @@ function useShopScripts(options) {
 }
 
 // src/react/hooks/use-shop-seo.ts
-import { useQuery as useQuery34 } from "@tanstack/react-query";
+import { useQuery as useQuery35 } from "@tanstack/react-query";
 function useShopSeo(options) {
   const { client } = useBehio();
   const { locale, initialData, enabled = true } = options ?? {};
-  return useQuery34({
+  return useQuery35({
     queryKey: ["behio", "shop-seo", locale ?? "_default"],
     queryFn: () => unwrap(client.getShopSeo(locale)),
     initialData,
@@ -4142,11 +4190,11 @@ function CurrencySwitcher({
 import { useEffect as useEffect7, useMemo as useMemo5, useRef as useRef4, useState as useState10 } from "react";
 
 // src/react/hooks/use-consent.ts
-import { useQuery as useQuery35, useMutation as useMutation16, useQueryClient as useQueryClient16 } from "@tanstack/react-query";
+import { useQuery as useQuery36, useMutation as useMutation16, useQueryClient as useQueryClient16 } from "@tanstack/react-query";
 function useCookieConsent(visitorId) {
   const { client } = useBehio();
   const qc = useQueryClient16();
-  const query = useQuery35({
+  const query = useQuery36({
     queryKey: ["behio", "consent", visitorId],
     queryFn: () => unwrap(client.consent.get(visitorId)),
     enabled: Boolean(visitorId)
@@ -4524,11 +4572,11 @@ function utmFromSearch(search) {
 }
 
 // src/react/hooks/use-bundles.ts
-import { useQuery as useQuery36 } from "@tanstack/react-query";
+import { useQuery as useQuery37 } from "@tanstack/react-query";
 function useBundles(options) {
   const { client, sessionRestored } = useBehio();
   const query = { locale: options?.locale ?? client.getLocale(), currency: options?.currency ?? client.getCurrency(), country: options?.country ?? client.getCountry() };
-  return useQuery36({
+  return useQuery37({
     queryKey: ["behio", "bundles", query],
     queryFn: () => unwrap(client.catalog.getBundles(query)),
     enabled: sessionRestored && (options?.enabled ?? true),
@@ -4538,7 +4586,7 @@ function useBundles(options) {
 function useBundle(slug, options) {
   const { client, sessionRestored } = useBehio();
   const query = { locale: options?.locale ?? client.getLocale(), currency: options?.currency ?? client.getCurrency(), country: options?.country ?? client.getCountry() };
-  return useQuery36({
+  return useQuery37({
     queryKey: ["behio", "bundle", slug, query],
     queryFn: () => unwrap(client.catalog.getBundle(slug, query)),
     enabled: sessionRestored && Boolean(slug) && (options?.enabled ?? true),
@@ -4547,10 +4595,10 @@ function useBundle(slug, options) {
 }
 
 // src/react/hooks/use-product-group.ts
-import { useQuery as useQuery37 } from "@tanstack/react-query";
+import { useQuery as useQuery38 } from "@tanstack/react-query";
 function useProductGroup(slug, options) {
   const { client } = useBehio();
-  return useQuery37({
+  return useQuery38({
     queryKey: ["behio", "product-group", slug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getProductGroup(slug, {
@@ -4564,10 +4612,10 @@ function useProductGroup(slug, options) {
 }
 
 // src/react/hooks/use-cross-sell.ts
-import { useQuery as useQuery38 } from "@tanstack/react-query";
+import { useQuery as useQuery39 } from "@tanstack/react-query";
 function useCrossSell(productSlug, options) {
   const { client } = useBehio();
-  return useQuery38({
+  return useQuery39({
     queryKey: ["behio", "cross-sell", productSlug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getCrossSell(productSlug, {
@@ -4581,10 +4629,10 @@ function useCrossSell(productSlug, options) {
 }
 
 // src/react/hooks/use-product-promotions.ts
-import { useQuery as useQuery39 } from "@tanstack/react-query";
+import { useQuery as useQuery40 } from "@tanstack/react-query";
 function useProductPromotions(productSlug, options) {
   const { client } = useBehio();
-  return useQuery39({
+  return useQuery40({
     queryKey: ["behio", "product-promotions", productSlug],
     queryFn: () => unwrap(client.catalog.getProductPromotions(productSlug)),
     enabled: Boolean(productSlug) && (options?.enabled ?? true),
@@ -4593,11 +4641,11 @@ function useProductPromotions(productSlug, options) {
 }
 
 // src/react/hooks/use-gift-card.ts
-import { useQuery as useQuery40 } from "@tanstack/react-query";
+import { useQuery as useQuery41 } from "@tanstack/react-query";
 function useGiftCardBalance(code, options) {
   const { client } = useBehio();
   const trimmed = code?.trim();
-  return useQuery40({
+  return useQuery41({
     queryKey: ["behio", "gift-card-balance", trimmed],
     queryFn: () => unwrap(client.catalog.checkGiftCard(trimmed)),
     enabled: Boolean(trimmed && trimmed.length >= 6) && (options?.enabled ?? true)
@@ -4605,11 +4653,11 @@ function useGiftCardBalance(code, options) {
 }
 
 // src/react/hooks/use-wishlist.ts
-import { useQuery as useQuery41, useMutation as useMutation17, useQueryClient as useQueryClient17 } from "@tanstack/react-query";
+import { useQuery as useQuery42, useMutation as useMutation17, useQueryClient as useQueryClient17 } from "@tanstack/react-query";
 function useWishlist(options) {
   const { client } = useBehio();
   const qc = useQueryClient17();
-  const query = useQuery41({
+  const query = useQuery42({
     queryKey: ["behio", "wishlist"],
     queryFn: () => unwrap(client.wishlist.get()),
     enabled: options?.enabled ?? true
@@ -4632,7 +4680,7 @@ function useWishlist(options) {
 }
 function useIsInWishlist(productId) {
   const { client } = useBehio();
-  return useQuery41({
+  return useQuery42({
     queryKey: ["behio", "wishlist-check", productId],
     queryFn: () => unwrap(client.wishlist.isInWishlist(productId)),
     enabled: Boolean(productId)
@@ -4640,10 +4688,10 @@ function useIsInWishlist(productId) {
 }
 
 // src/react/hooks/use-reviews.ts
-import { useQuery as useQuery42, useMutation as useMutation18, useQueryClient as useQueryClient18 } from "@tanstack/react-query";
+import { useQuery as useQuery43, useMutation as useMutation18, useQueryClient as useQueryClient18 } from "@tanstack/react-query";
 function useProductReviews(productId, options) {
   const { client } = useBehio();
-  return useQuery42({
+  return useQuery43({
     queryKey: ["behio", "reviews", productId, options?.page ?? 1, options?.limit ?? 20],
     queryFn: () => unwrap(client.reviews.getProductReviews(productId, options?.page, options?.limit)),
     initialData: options?.initialData,
@@ -4661,7 +4709,7 @@ function useSubmitReview() {
 }
 
 // src/react/hooks/use-returns.ts
-import { useQuery as useQuery43, useMutation as useMutation19 } from "@tanstack/react-query";
+import { useQuery as useQuery44, useMutation as useMutation19 } from "@tanstack/react-query";
 function useLookupReturnableOrder() {
   const { client } = useBehio();
   return useMutation19({
@@ -4676,7 +4724,7 @@ function useSubmitReturn() {
 }
 function useReturnStatus(returnId, email) {
   const { client } = useBehio();
-  return useQuery43({
+  return useQuery44({
     queryKey: ["behio", "return-status", returnId],
     queryFn: () => unwrap(client.returns.getStatus(returnId, email)),
     enabled: Boolean(returnId && email)
@@ -4684,7 +4732,7 @@ function useReturnStatus(returnId, email) {
 }
 
 // src/react/hooks/use-quotes.ts
-import { useMutation as useMutation20, useQuery as useQuery44 } from "@tanstack/react-query";
+import { useMutation as useMutation20, useQuery as useQuery45 } from "@tanstack/react-query";
 function useSubmitQuote() {
   const { client } = useBehio();
   return useMutation20({
@@ -4693,7 +4741,7 @@ function useSubmitQuote() {
 }
 function useQuoteStatus(quoteId, email) {
   const { client } = useBehio();
-  return useQuery44({
+  return useQuery45({
     queryKey: ["behio", "quote-status", quoteId],
     queryFn: () => unwrap(client.quotes.getStatus(quoteId, email)),
     enabled: Boolean(quoteId && email)
@@ -4860,6 +4908,8 @@ export {
   useCertificateVerification,
   useCheckout,
   useCheckoutPreview,
+  useCollection,
+  useCollectionItem,
   useCookieConsent,
   useCourse,
   useCourseCertificates,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@behio/storefront-sdk",
-  "version": "2.16.0",
+  "version": "2.17.0",
   "description": "TypeScript SDK for Behio headless e-commerce: core client + React hooks",
   "author": "Behio",
   "license": "MIT",