@bacano/sdk 1.2.4 → 1.2.6

package/README.md

@@ -288,10 +288,12 @@ await client.init();
 
 ### 3. Browse Products (No Auth Required)
 
-`catalog.getProducts()` only returns products that are active, enabled for the
-website branch, have a valid `CLIENT` price and have available
-inventory in one of the inventory sources configured for the website. Websites
-without custom sources continue using the branch's default warehouse.
+`catalog.getProducts()` returns products that are active, published for the
+website, enabled for its branch and have a valid `CLIENT` price. By default it
+excludes sold-out products, but a website may show them globally or override
+that choice per published product. The SDK applies this rule; a visible
+sold-out product remains unavailable for purchase. Websites without custom
+inventory sources continue using the branch's default warehouse.
 
 ```typescript
 // List products
@@ -317,7 +319,7 @@ const affordable = await client.catalog.getProducts({
   maxPrice: 50,
 });
 
-// In-stock only. This is already the website default, kept for UI clarity.
+// Strictly in-stock, even if this website displays sold-out products.
 const available = await client.catalog.getProducts({ inStock: true });
 
 // Filter by color
@@ -353,7 +355,7 @@ const filtered = await client.catalog.getProducts({
 // Single product
 const product = await client.catalog.getProduct("product-uuid");
 
-// Static builds: fetch the complete sellable catalog and its first renderable
+// Static builds: fetch the complete visible catalog and its first renderable
 // catalog page. This is the canonical source for initial HTML, routes,
 // metadata, sitemap and product page data.
 const bootstrap = await client.catalog.getStaticCatalogBootstrap({
@@ -369,7 +371,8 @@ const productByRoute = new Map(
   bootstrap.products.map((item) => [item.slug || item.id, item]),
 );
 
-// Cards and filters use product.variants. Detail selectors use the official
+// Cards and filters use product.variants. These can include sold-out variants
+// if the website permits their display. Detail selectors use the official
 // helper so sold-out sizes remain visible and older snapshots stay compatible.
 const detailVariants = getProductDetailVariants(product!);
 

package/STOREFRONT_PERFORMANCE.md

@@ -49,9 +49,11 @@ if this contract fails; they must not silently publish an empty catalog.
 
 The static bootstrap deliberately exposes two projections on each product:
 
-- `product.variants` contains only variants that were saleable when Bacano
-  generated the catalog page. Cards, price ranges, filters and listing
-  visibility must use this projection.
+- `product.variants` contains variants eligible for this website's listings.
+  It can include sold-out variants when the website setting or this product's
+  per-website exception allows them to remain visible. Cards, price ranges,
+  filters and listing visibility must use this projection; visibility is not
+  permission to purchase.
 - `product.detailVariants` also contains enabled, published variants with a
   public price that are currently sold out. Product detail selectors must use
   this projection so a customer can see unavailable sizes instead of assuming
@@ -71,8 +73,13 @@ const liveState = await client.catalog.getProductLiveState(
 `getProduct()` and `getProductBySlug()` expose the complete detail projection
 through `variants` as well. A sold-out variant returns `inStock: false` and
 `maxPurchasableQuantity: 0` from live state. Never use `detailVariants` to
-calculate a card's minimum price or to make a completely sold-out product
-appear in listings.
+calculate a card's minimum price or independently decide whether a completely
+sold-out product belongs in listings. The SDK applies the website rule and the
+product's per-website exception to listings, static routes, search suggestions
+and recommendations. `getProducts({ inStock: true })` remains strictly
+in-stock. The public SDK reads these rules; their administration belongs in
+Bacano. Changing them requires rebuilding static routes and catalog HTML;
+live-state refresh cannot add a route missing from the build.
 
 ## Live price and availability
 

package/graphql.cjs

@@ -122,6 +122,12 @@ var GET_PRODUCTS = (
       id
       name
       description
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       long_description
       slug
       seo_title
@@ -357,6 +363,12 @@ var GET_PRODUCT_BY_PK = (
       limit: 1
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       product_option_group_members(limit: 1) {
         group {
           id
@@ -606,6 +618,12 @@ var GET_PRODUCT_SEO_ENTRIES = (
       id
       name
       slug
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       seo_title
       seo_description
       seo_image_file_id
@@ -2108,6 +2126,7 @@ var GET_PRODUCT_FILTERS = (
   query GetProductFilters(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $where: products_bool_exp = {}
     $attributeListKey: String!
   ) {
@@ -2115,6 +2134,12 @@ var GET_PRODUCT_FILTERS = (
       where: {
         _and: [
           { company_id: { _eq: $companyId } }
+          {
+            product_website_publications: {
+              website_id: { _eq: $websiteId }
+              is_visible: { _eq: true }
+            }
+          }
           {
             chain_products: {
               chain_id: { _eq: $chainId }
@@ -2127,6 +2152,12 @@ var GET_PRODUCT_FILTERS = (
       }
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       category
       subcategory
       color
@@ -2234,6 +2265,7 @@ var GET_SEARCH_SUGGESTIONS = (
   query GetSearchSuggestions(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $term: String!
     $productLimit: Int = 5
     $brandLimit: Int = 3
@@ -2241,6 +2273,10 @@ var GET_SEARCH_SUGGESTIONS = (
     products(
       where: {
         company_id: { _eq: $companyId }
+        product_website_publications: {
+          website_id: { _eq: $websiteId }
+          is_visible: { _eq: true }
+        }
         chain_products: {
           chain_id: { _eq: $chainId }
           is_enabled: { _eq: true }
@@ -2253,6 +2289,29 @@ var GET_SEARCH_SUGGESTIONS = (
     ) {
       id
       name
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
+      product_variants(where: { is_disabled: { _eq: false } }) {
+        id
+        product_variant_prices(
+          where: {
+            price_type: { _eq: CLIENT }
+            _or: [
+              { chain_id: { _eq: $chainId } }
+              { chain_id: { _is_null: true } }
+            ]
+          }
+        ) {
+          id
+          price
+          price_type
+          chain_id
+        }
+      }
     }
     brands(
       where: {

package/graphql.js

@@ -62,6 +62,12 @@ var GET_PRODUCTS = (
       id
       name
       description
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       long_description
       slug
       seo_title
@@ -297,6 +303,12 @@ var GET_PRODUCT_BY_PK = (
       limit: 1
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       product_option_group_members(limit: 1) {
         group {
           id
@@ -546,6 +558,12 @@ var GET_PRODUCT_SEO_ENTRIES = (
       id
       name
       slug
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       seo_title
       seo_description
       seo_image_file_id
@@ -2048,6 +2066,7 @@ var GET_PRODUCT_FILTERS = (
   query GetProductFilters(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $where: products_bool_exp = {}
     $attributeListKey: String!
   ) {
@@ -2055,6 +2074,12 @@ var GET_PRODUCT_FILTERS = (
       where: {
         _and: [
           { company_id: { _eq: $companyId } }
+          {
+            product_website_publications: {
+              website_id: { _eq: $websiteId }
+              is_visible: { _eq: true }
+            }
+          }
           {
             chain_products: {
               chain_id: { _eq: $chainId }
@@ -2067,6 +2092,12 @@ var GET_PRODUCT_FILTERS = (
       }
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       category
       subcategory
       color
@@ -2174,6 +2205,7 @@ var GET_SEARCH_SUGGESTIONS = (
   query GetSearchSuggestions(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $term: String!
     $productLimit: Int = 5
     $brandLimit: Int = 3
@@ -2181,6 +2213,10 @@ var GET_SEARCH_SUGGESTIONS = (
     products(
       where: {
         company_id: { _eq: $companyId }
+        product_website_publications: {
+          website_id: { _eq: $websiteId }
+          is_visible: { _eq: true }
+        }
         chain_products: {
           chain_id: { _eq: $chainId }
           is_enabled: { _eq: true }
@@ -2193,6 +2229,29 @@ var GET_SEARCH_SUGGESTIONS = (
     ) {
       id
       name
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
+      product_variants(where: { is_disabled: { _eq: false } }) {
+        id
+        product_variant_prices(
+          where: {
+            price_type: { _eq: CLIENT }
+            _or: [
+              { chain_id: { _eq: $chainId } }
+              { chain_id: { _is_null: true } }
+            ]
+          }
+        ) {
+          id
+          price
+          price_type
+          chain_id
+        }
+      }
     }
     brands(
       where: {

package/index.cjs

@@ -551,6 +551,12 @@ var GET_PRODUCTS = (
       id
       name
       description
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       long_description
       slug
       seo_title
@@ -786,6 +792,12 @@ var GET_PRODUCT_BY_PK = (
       limit: 1
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       product_option_group_members(limit: 1) {
         group {
           id
@@ -1035,6 +1047,12 @@ var GET_PRODUCT_SEO_ENTRIES = (
       id
       name
       slug
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       seo_title
       seo_description
       seo_image_file_id
@@ -2668,6 +2686,7 @@ var GET_PRODUCT_FILTERS = (
   query GetProductFilters(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $where: products_bool_exp = {}
     $attributeListKey: String!
   ) {
@@ -2675,6 +2694,12 @@ var GET_PRODUCT_FILTERS = (
       where: {
         _and: [
           { company_id: { _eq: $companyId } }
+          {
+            product_website_publications: {
+              website_id: { _eq: $websiteId }
+              is_visible: { _eq: true }
+            }
+          }
           {
             chain_products: {
               chain_id: { _eq: $chainId }
@@ -2687,6 +2712,12 @@ var GET_PRODUCT_FILTERS = (
       }
     ) {
       id
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
       category
       subcategory
       color
@@ -2794,6 +2825,7 @@ var GET_SEARCH_SUGGESTIONS = (
   query GetSearchSuggestions(
     $companyId: uuid!
     $chainId: uuid!
+    $websiteId: uuid!
     $term: String!
     $productLimit: Int = 5
     $brandLimit: Int = 3
@@ -2801,6 +2833,10 @@ var GET_SEARCH_SUGGESTIONS = (
     products(
       where: {
         company_id: { _eq: $companyId }
+        product_website_publications: {
+          website_id: { _eq: $websiteId }
+          is_visible: { _eq: true }
+        }
         chain_products: {
           chain_id: { _eq: $chainId }
           is_enabled: { _eq: true }
@@ -2813,6 +2849,29 @@ var GET_SEARCH_SUGGESTIONS = (
     ) {
       id
       name
+      product_website_publications(
+        where: { website_id: { _eq: $websiteId }, is_visible: { _eq: true } }
+        limit: 1
+      ) {
+        show_when_out_of_stock
+      }
+      product_variants(where: { is_disabled: { _eq: false } }) {
+        id
+        product_variant_prices(
+          where: {
+            price_type: { _eq: CLIENT }
+            _or: [
+              { chain_id: { _eq: $chainId } }
+              { chain_id: { _is_null: true } }
+            ]
+          }
+        ) {
+          id
+          price
+          price_type
+          chain_id
+        }
+      }
     }
     brands(
       where: {
@@ -3972,6 +4031,7 @@ function mapProduct(raw, storageUrl, labels, chainId) {
     createdAt: raw.created_at,
     updatedAt: raw.updated_at ?? raw.created_at,
     variants,
+    outOfStockVisibilityOverride: raw.product_website_publications?.[0]?.show_when_out_of_stock ?? null,
     detailVariants,
     media: raw.product_media.map((m) => mapMedia(m, storageUrl)),
     attributes: raw.product_attributes.map(
@@ -4333,7 +4393,7 @@ async function getWebsiteAvailabilityByVariantId(graphqlUrl, getHeaders, variant
   }
   return availabilityByVariantId;
 }
-async function filterProductsForWebsiteStock(graphqlUrl, getHeaders, products, chainId, websiteId) {
+async function filterProductsForWebsiteStock(graphqlUrl, getHeaders, products, chainId, websiteId, showOutOfStockByDefault = false, onlyInStock = false) {
   const variantIds = products.flatMap(
     (product) => product.variants.map((variant) => variant.id)
   );
@@ -4359,11 +4419,11 @@ async function filterProductsForWebsiteStock(graphqlUrl, getHeaders, products, c
         pricing: resolveProductPricing(prices)
       };
     }).filter(
-      (variant) => inStockVariantIds.has(variant.id) && variant.pricing.currentPrice != null
+      (variant) => (inStockVariantIds.has(variant.id) || !onlyInStock && (product.outOfStockVisibilityOverride ?? showOutOfStockByDefault)) && variant.pricing.currentPrice != null
     )
   })).filter((product) => product.variants.length > 0);
 }
-async function filterSeoProductsForWebsiteStock(graphqlUrl, getHeaders, products, chainId, websiteId) {
+async function filterSeoProductsForWebsiteStock(graphqlUrl, getHeaders, products, chainId, websiteId, showOutOfStockByDefault = false) {
   const variantIds = products.flatMap(
     (product) => product.product_variants.map((variant) => variant.id)
   );
@@ -4385,7 +4445,7 @@ async function filterSeoProductsForWebsiteStock(graphqlUrl, getHeaders, products
       const pricing = resolveProductPricing(
         selectPublicPrices(prices, chainId)
       );
-      return inStockVariantIds.has(variant.id) && pricing.currentPrice != null;
+      return (inStockVariantIds.has(variant.id) || (product.product_website_publications?.[0]?.show_when_out_of_stock ?? showOutOfStockByDefault)) && pricing.currentPrice != null;
     })
   );
 }
@@ -4456,7 +4516,8 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
       getHeaders,
       [mappedProduct],
       ctx.chainId,
-      ctx.websiteId
+      ctx.websiteId,
+      ctx.config?.show_out_of_stock_products === true
     );
     if (!filteredProducts[0]) return null;
     const specifications = await loadProductSpecifications([product.id]);
@@ -4689,7 +4750,8 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
         getHeaders,
         data.products ?? [],
         ctx.chainId,
-        ctx.websiteId
+        ctx.websiteId,
+        ctx.config?.show_out_of_stock_products === true
       );
       const entries = availableProducts.slice(0, limit).map((product) => mapProductSeoEntry(product, storageUrl)).filter((entry) => Boolean(entry));
       return {
@@ -4766,7 +4828,9 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
           (p) => mapProduct(p, storageUrl, publicAttributeLabels, chainId)
         ),
         chainId,
-        ctx.websiteId
+        ctx.websiteId,
+        ctx.config?.show_out_of_stock_products === true,
+        opts?.inStock === true
       );
       const specifications = await loadProductSpecifications(
         products.map((product) => product.id)
@@ -4873,6 +4937,7 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
           {
             companyId: ctx.companyId,
             chainId,
+            websiteId: ctx.websiteId,
             attributeListKey: DEFAULT_FILTER_ATTRIBUTE_LIST_KEY,
             where: buildProductWhere(opts.filters ?? {}, chainId)
           },
@@ -4896,7 +4961,7 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
               variant.product_variant_prices.map(mapPrice),
               chainId
             );
-            return prices.length > 0 && (availabilityByVariantId.get(variant.id)?.inStock ?? false);
+            return prices.length > 0 && ((availabilityByVariantId.get(variant.id)?.inStock ?? false) || (product.product_website_publications?.[0]?.show_when_out_of_stock ?? ctx.config?.show_out_of_stock_products === true));
           });
           if (!hasVisibleVariant) continue;
           applicableCategories.add(product.category);
@@ -4984,6 +5049,7 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
         {
           companyId: ctx.companyId,
           chainId,
+          websiteId: ctx.websiteId,
           attributeListKey: opts?.attributeListKey ?? DEFAULT_FILTER_ATTRIBUTE_LIST_KEY,
           where: {
             ...opts?.categoryName ? { category: { _eq: opts.categoryName } } : {},
@@ -5038,7 +5104,9 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
             chainId
           ),
           inStock: availabilityByVariantId.get(variant.id)?.inStock ?? false
-        })).filter((variant) => variant.inStock && variant.prices.length > 0);
+        })).filter(
+          (variant) => (variant.inStock || (product.product_website_publications?.[0]?.show_when_out_of_stock ?? ctx.config?.show_out_of_stock_products === true)) && variant.prices.length > 0
+        );
         if (visibleVariants.length === 0) continue;
         categoryCounts.set(
           product.category,
@@ -5123,6 +5191,7 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
           "NO_CHAIN"
         );
       }
+      const chainId = ctx.chainId;
       const term = `%${opts.query}%`;
       const limit = opts.limit ?? 8;
       const data = await executeGraphQL(
@@ -5130,7 +5199,8 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
         GET_SEARCH_SUGGESTIONS,
         {
           companyId: ctx.companyId,
-          chainId: ctx.chainId,
+          chainId,
+          websiteId: ctx.websiteId,
           term,
           productLimit: Math.min(limit, 5),
           brandLimit: Math.max(limit - 5, 3)
@@ -5138,8 +5208,29 @@ function createCatalogModule(graphqlUrl, getHeaders, getContext, storageUrl) {
         getHeaders
       );
       const suggestions = [];
+      const availability = await getWebsiteAvailabilityByVariantId(
+        graphqlUrl,
+        getHeaders,
+        (data.products ?? []).flatMap(
+          (product) => product.product_variants.map((variant) => variant.id)
+        ),
+        chainId,
+        ctx.websiteId
+      );
       for (const p of data.products ?? []) {
-        suggestions.push({ type: "product", text: p.name, id: p.id });
+        const showWithoutStock = p.product_website_publications?.[0]?.show_when_out_of_stock ?? ctx.config?.show_out_of_stock_products === true;
+        const isVisible = p.product_variants.some((variant) => {
+          const hasPrice = resolveProductPricing(
+            selectPublicPrices(
+              variant.product_variant_prices.map(mapPrice),
+              chainId
+            )
+          ).currentPrice != null;
+          return hasPrice && (showWithoutStock || availability.get(variant.id)?.inStock === true);
+        });
+        if (isVisible) {
+          suggestions.push({ type: "product", text: p.name, id: p.id });
+        }
       }
       for (const b of data.brands ?? []) {
         suggestions.push({ type: "brand", text: b.name, id: b.id });