@behio/storefront-sdk 2.20.0 → 2.21.0

package/dist/react.mjs

@@ -172,6 +172,7 @@ var BehioStorefront = class {
     this.blog = new BlogModule(this);
     this.forms = new FormsModule(this);
     this.collections = new CollectionsModule(this);
+    this.faq = new FaqModule(this);
     this.wishlist = new WishlistModule(this);
     this.reviews = new ReviewsModule(this);
     this.returns = new ReturnsModule(this);
@@ -1828,6 +1829,26 @@ var CollectionsModule = class {
     );
   }
 };
+var FaqModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** FAQ groups of the site in the admin order with the number of visible questions. */
+  async list(query) {
+    return this.client.request("GET", "/faq", {
+      query: { locale: query?.locale }
+    });
+  }
+  /**
+   * One group by its slug or id with its visible questions. 404
+   * `be.faq.groupNotFound` for an unknown group.
+   */
+  async get(group, query) {
+    return this.client.request("GET", `/faq/${encodeURIComponent(group)}`, {
+      query: { locale: query?.locale }
+    });
+  }
+};
 var FormsModule = class {
   constructor(client) {
     this.client = client;
@@ -4003,9 +4024,28 @@ function useCollectionItem(slug, itemSlugOrId, options) {
   });
 }
 
+// src/react/hooks/use-faq.ts
+import { useQuery as useQuery32 } from "@tanstack/react-query";
+function useFaqGroups(query, options) {
+  const { client } = useBehio();
+  return useQuery32({
+    queryKey: ["behio", "faq", query?.locale],
+    queryFn: () => unwrap(client.faq.list(query)),
+    enabled: options?.enabled !== false
+  });
+}
+function useFaqGroup(group, query, options) {
+  const { client } = useBehio();
+  return useQuery32({
+    queryKey: ["behio", "faq", group, query?.locale],
+    queryFn: () => unwrap(client.faq.get(group, query)),
+    enabled: options?.enabled !== false && !!group
+  });
+}
+
 // src/react/hooks/use-site-form.ts
 import { useCallback as useCallback15, useMemo as useMemo4 } from "react";
-import { useMutation as useMutation15, useQuery as useQuery32 } from "@tanstack/react-query";
+import { useMutation as useMutation15, useQuery as useQuery33 } from "@tanstack/react-query";
 
 // src/errors.ts
 function bodyOf(err) {
@@ -4056,7 +4096,7 @@ function formFieldErrors(err) {
 // src/react/hooks/use-site-form.ts
 function useSiteForm(slug, options) {
   const { client } = useBehio();
-  return useQuery32({
+  return useQuery33({
     queryKey: ["behio", "form", slug],
     queryFn: () => unwrap(client.forms.get(slug)),
     enabled: options?.enabled !== false && !!slug
@@ -4100,10 +4140,10 @@ function useSiteFormSubmit(slug) {
 }
 
 // src/react/hooks/use-shop-info.ts
-import { useQuery as useQuery33 } from "@tanstack/react-query";
+import { useQuery as useQuery34 } from "@tanstack/react-query";
 function useShopInfo(options) {
   const { client } = useBehio();
-  return useQuery33({
+  return useQuery34({
     queryKey: ["behio", "shop-info"],
     queryFn: () => unwrap(client.getShopInfo()),
     enabled: options?.enabled !== false
@@ -4111,10 +4151,10 @@ function useShopInfo(options) {
 }
 
 // src/react/hooks/use-shop-scripts.ts
-import { useQuery as useQuery34 } from "@tanstack/react-query";
+import { useQuery as useQuery35 } from "@tanstack/react-query";
 function useShopScripts(options) {
   const { client } = useBehio();
-  return useQuery34({
+  return useQuery35({
     queryKey: ["behio", "shop-scripts"],
     queryFn: () => unwrap(client.getShopScripts()),
     enabled: options?.enabled !== false,
@@ -4123,11 +4163,11 @@ function useShopScripts(options) {
 }
 
 // src/react/hooks/use-shop-seo.ts
-import { useQuery as useQuery35 } from "@tanstack/react-query";
+import { useQuery as useQuery36 } from "@tanstack/react-query";
 function useShopSeo(options) {
   const { client } = useBehio();
   const { locale, initialData, enabled = true } = options ?? {};
-  return useQuery35({
+  return useQuery36({
     queryKey: ["behio", "shop-seo", locale ?? "_default"],
     queryFn: () => unwrap(client.getShopSeo(locale)),
     initialData,
@@ -4190,11 +4230,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 useQuery36, useMutation as useMutation16, useQueryClient as useQueryClient16 } from "@tanstack/react-query";
+import { useQuery as useQuery37, useMutation as useMutation16, useQueryClient as useQueryClient16 } from "@tanstack/react-query";
 function useCookieConsent(visitorId) {
   const { client } = useBehio();
   const qc = useQueryClient16();
-  const query = useQuery36({
+  const query = useQuery37({
     queryKey: ["behio", "consent", visitorId],
     queryFn: () => unwrap(client.consent.get(visitorId)),
     enabled: Boolean(visitorId)
@@ -4582,11 +4622,11 @@ function RichText({ html, className, as = "div" }) {
 }
 
 // src/react/hooks/use-bundles.ts
-import { useQuery as useQuery37 } from "@tanstack/react-query";
+import { useQuery as useQuery38 } 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 useQuery37({
+  return useQuery38({
     queryKey: ["behio", "bundles", query],
     queryFn: () => unwrap(client.catalog.getBundles(query)),
     enabled: sessionRestored && (options?.enabled ?? true),
@@ -4596,7 +4636,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 useQuery37({
+  return useQuery38({
     queryKey: ["behio", "bundle", slug, query],
     queryFn: () => unwrap(client.catalog.getBundle(slug, query)),
     enabled: sessionRestored && Boolean(slug) && (options?.enabled ?? true),
@@ -4605,10 +4645,10 @@ function useBundle(slug, options) {
 }
 
 // src/react/hooks/use-product-group.ts
-import { useQuery as useQuery38 } from "@tanstack/react-query";
+import { useQuery as useQuery39 } from "@tanstack/react-query";
 function useProductGroup(slug, options) {
   const { client } = useBehio();
-  return useQuery38({
+  return useQuery39({
     queryKey: ["behio", "product-group", slug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getProductGroup(slug, {
@@ -4622,10 +4662,10 @@ function useProductGroup(slug, options) {
 }
 
 // src/react/hooks/use-cross-sell.ts
-import { useQuery as useQuery39 } from "@tanstack/react-query";
+import { useQuery as useQuery40 } from "@tanstack/react-query";
 function useCrossSell(productSlug, options) {
   const { client } = useBehio();
-  return useQuery39({
+  return useQuery40({
     queryKey: ["behio", "cross-sell", productSlug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getCrossSell(productSlug, {
@@ -4639,10 +4679,10 @@ function useCrossSell(productSlug, options) {
 }
 
 // src/react/hooks/use-product-promotions.ts
-import { useQuery as useQuery40 } from "@tanstack/react-query";
+import { useQuery as useQuery41 } from "@tanstack/react-query";
 function useProductPromotions(productSlug, options) {
   const { client } = useBehio();
-  return useQuery40({
+  return useQuery41({
     queryKey: ["behio", "product-promotions", productSlug],
     queryFn: () => unwrap(client.catalog.getProductPromotions(productSlug)),
     enabled: Boolean(productSlug) && (options?.enabled ?? true),
@@ -4651,11 +4691,11 @@ function useProductPromotions(productSlug, options) {
 }
 
 // src/react/hooks/use-gift-card.ts
-import { useQuery as useQuery41 } from "@tanstack/react-query";
+import { useQuery as useQuery42 } from "@tanstack/react-query";
 function useGiftCardBalance(code, options) {
   const { client } = useBehio();
   const trimmed = code?.trim();
-  return useQuery41({
+  return useQuery42({
     queryKey: ["behio", "gift-card-balance", trimmed],
     queryFn: () => unwrap(client.catalog.checkGiftCard(trimmed)),
     enabled: Boolean(trimmed && trimmed.length >= 6) && (options?.enabled ?? true)
@@ -4663,11 +4703,11 @@ function useGiftCardBalance(code, options) {
 }
 
 // src/react/hooks/use-wishlist.ts
-import { useQuery as useQuery42, useMutation as useMutation17, useQueryClient as useQueryClient17 } from "@tanstack/react-query";
+import { useQuery as useQuery43, useMutation as useMutation17, useQueryClient as useQueryClient17 } from "@tanstack/react-query";
 function useWishlist(options) {
   const { client } = useBehio();
   const qc = useQueryClient17();
-  const query = useQuery42({
+  const query = useQuery43({
     queryKey: ["behio", "wishlist"],
     queryFn: () => unwrap(client.wishlist.get()),
     enabled: options?.enabled ?? true
@@ -4690,7 +4730,7 @@ function useWishlist(options) {
 }
 function useIsInWishlist(productId) {
   const { client } = useBehio();
-  return useQuery42({
+  return useQuery43({
     queryKey: ["behio", "wishlist-check", productId],
     queryFn: () => unwrap(client.wishlist.isInWishlist(productId)),
     enabled: Boolean(productId)
@@ -4698,10 +4738,10 @@ function useIsInWishlist(productId) {
 }
 
 // src/react/hooks/use-reviews.ts
-import { useQuery as useQuery43, useMutation as useMutation18, useQueryClient as useQueryClient18 } from "@tanstack/react-query";
+import { useQuery as useQuery44, useMutation as useMutation18, useQueryClient as useQueryClient18 } from "@tanstack/react-query";
 function useProductReviews(productId, options) {
   const { client } = useBehio();
-  return useQuery43({
+  return useQuery44({
     queryKey: ["behio", "reviews", productId, options?.page ?? 1, options?.limit ?? 20],
     queryFn: () => unwrap(client.reviews.getProductReviews(productId, options?.page, options?.limit)),
     initialData: options?.initialData,
@@ -4719,7 +4759,7 @@ function useSubmitReview() {
 }
 
 // src/react/hooks/use-returns.ts
-import { useQuery as useQuery44, useMutation as useMutation19 } from "@tanstack/react-query";
+import { useQuery as useQuery45, useMutation as useMutation19 } from "@tanstack/react-query";
 function useLookupReturnableOrder() {
   const { client } = useBehio();
   return useMutation19({
@@ -4734,7 +4774,7 @@ function useSubmitReturn() {
 }
 function useReturnStatus(returnId, email) {
   const { client } = useBehio();
-  return useQuery44({
+  return useQuery45({
     queryKey: ["behio", "return-status", returnId],
     queryFn: () => unwrap(client.returns.getStatus(returnId, email)),
     enabled: Boolean(returnId && email)
@@ -4742,7 +4782,7 @@ function useReturnStatus(returnId, email) {
 }
 
 // src/react/hooks/use-quotes.ts
-import { useMutation as useMutation20, useQuery as useQuery45 } from "@tanstack/react-query";
+import { useMutation as useMutation20, useQuery as useQuery46 } from "@tanstack/react-query";
 function useSubmitQuote() {
   const { client } = useBehio();
   return useMutation20({
@@ -4751,7 +4791,7 @@ function useSubmitQuote() {
 }
 function useQuoteStatus(quoteId, email) {
   const { client } = useBehio();
-  return useQuery45({
+  return useQuery46({
     queryKey: ["behio", "quote-status", quoteId],
     queryFn: () => unwrap(client.quotes.getStatus(quoteId, email)),
     enabled: Boolean(quoteId && email)
@@ -4929,6 +4969,8 @@ export {
   useCurrency,
   useCustomer,
   useFacets,
+  useFaqGroup,
+  useFaqGroups,
   useFeatured,
   useFilters,
   useGiftCardBalance,

package/package.json

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