@misiki/gocommerce-connector 0.28.0 → 0.29.0

package/README.md

@@ -127,6 +127,7 @@ down stays best-effort: the storefront renders from its static record.
 | --- | --- |
 | product page, listings, search | `/api/products`, `/api/products/slug/{slug}` (an id or SKU also works) |
 | category pages and tree | `/api/categories`, `/api/categories/{slug}` — a category sells its descendants |
+| the filter rail's categories | the counts from `/api/products?facets=1`, each with its ancestors from `/api/categories?flat=1`, in tree order and with its `depth`. A parent counts its whole subtree |
 | collections | `/api/collections`, `/api/collections/{slug}` |
 | featured / trending shelves | the collection with slug `featured` / `trending`; newest products when there is none |
 | product page extras | on the product from `/api/products/slug/{slug}` (D134): `highlights` and `freeGift` from the product's own metadata, `soldAtLeast` when the shop shows sold counts (null otherwise, never zero), and the product's videos after its pictures in `images` (and alone in `videos`), so the gallery plays them |
@@ -241,6 +242,10 @@ Each of these is a real gap, listed so nobody has to find it in production.
   vendor, product type, category attributes, price) need an engine that counts
   them (`GET /api/products?facets=1`, D130). Against an older one the filter
   rail is empty and a category page's attribute filters are not applied.
+- **Category counts in a large shop.** The engine counts a listing's products
+  in at most 100 categories, the ones with the most products. The connector adds
+  those counts up to each parent, so in a shop with more categories a parent's
+  count misses the products of the categories the engine left out.
 - **Tax in the bag.** The engine's cart carries no tax or total; tax is computed
   when the order is placed. The bag shows subtotal − discount + delivery, and the
   order shows the real figures.

package/dist/{index-BaFtBtaA.d.cts → index-DOlNI60Y.d.cts}

@@ -2469,13 +2469,19 @@ declare class ProductService extends CatalogService {
 }
 declare const productService: ProductService;
 
+type RailCategory = {
+    name: string;
+    slug: string;
+    count: number;
+    depth: number;
+};
 /**
  * The engine's counts in the shape the storefront's filter rail reads. Each
  * `allFilters` key is also the URL parameter the rail writes when a value is
  * ticked, and `searchWithUrl` reads it back: `vendor`, `product_type` and
  * `attributes.<handle>`. Tags go to the rail's own tag group, written as `tags`.
  */
-declare function toStorefrontFacets(f?: ProductFacets | null): {
+declare function toStorefrontFacets(f?: ProductFacets | null, tree?: Category[]): {
     priceStat: {
         min: number;
         max: number;
@@ -2483,11 +2489,7 @@ declare function toStorefrontFacets(f?: ProductFacets | null): {
         min?: undefined;
         max?: undefined;
     };
-    categories: {
-        name: string;
-        slug: string;
-        count: number;
-    }[];
+    categories: RailCategory[];
     tags: {
         name: string;
         count: number;
@@ -2520,11 +2522,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2548,11 +2546,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2719,11 +2713,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;

package/dist/{index-BaFtBtaA.d.ts → index-DOlNI60Y.d.ts}

@@ -2469,13 +2469,19 @@ declare class ProductService extends CatalogService {
 }
 declare const productService: ProductService;
 
+type RailCategory = {
+    name: string;
+    slug: string;
+    count: number;
+    depth: number;
+};
 /**
  * The engine's counts in the shape the storefront's filter rail reads. Each
  * `allFilters` key is also the URL parameter the rail writes when a value is
  * ticked, and `searchWithUrl` reads it back: `vendor`, `product_type` and
  * `attributes.<handle>`. Tags go to the rail's own tag group, written as `tags`.
  */
-declare function toStorefrontFacets(f?: ProductFacets | null): {
+declare function toStorefrontFacets(f?: ProductFacets | null, tree?: Category[]): {
     priceStat: {
         min: number;
         max: number;
@@ -2483,11 +2489,7 @@ declare function toStorefrontFacets(f?: ProductFacets | null): {
         min?: undefined;
         max?: undefined;
     };
-    categories: {
-        name: string;
-        slug: string;
-        count: number;
-    }[];
+    categories: RailCategory[];
     tags: {
         name: string;
         count: number;
@@ -2520,11 +2522,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2548,11 +2546,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;
@@ -2719,11 +2713,7 @@ declare class SearchService extends CatalogService {
                 min?: undefined;
                 max?: undefined;
             };
-            categories: {
-                name: string;
-                slug: string;
-                count: number;
-            }[];
+            categories: RailCategory[];
             tags: {
                 name: string;
                 count: number;

package/dist/index.cjs

@@ -1593,7 +1593,23 @@ function attributesFrom(p) {
   return Object.keys(out).length ? out : void 0;
 }
 var counts = (values) => Object.fromEntries((values ?? []).map((v) => [v.value, v.count]));
-function toStorefrontFacets(f) {
+function categoryFacets(counted, tree) {
+  const byId = new Map(tree.map((c) => [c.id, c]));
+  const totals = /* @__PURE__ */ new Map();
+  for (const { id: id2, count } of counted) {
+    for (let c = byId.get(id2); c; c = c.parent_id === null ? void 0 : byId.get(c.parent_id)) {
+      totals.set(c.id, (totals.get(c.id) ?? 0) + count);
+    }
+  }
+  const kept = tree.filter((c) => totals.has(c.id)).sort((a, b) => a.position - b.position || a.id - b.id);
+  const parentOf = (c) => c.parent_id !== null && byId.has(c.parent_id) ? c.parent_id : null;
+  const under = (parent) => kept.filter((c) => parentOf(c) === parent).flatMap((c) => [{ name: c.title, slug: c.slug, count: totals.get(c.id), depth: c.depth }, ...under(c.id)]);
+  return [
+    ...under(null),
+    ...counted.filter((c) => !byId.has(c.id)).map((c) => ({ name: c.title, slug: c.slug, count: c.count, depth: 0 }))
+  ];
+}
+function toStorefrontFacets(f, tree = []) {
   if (!f) return { priceStat: {}, categories: [], tags: [], allFilters: {} };
   const allFilters = {};
   const group = (key, values) => {
@@ -1604,7 +1620,7 @@ function toStorefrontFacets(f) {
   for (const [handle, values] of Object.entries(f.attributes ?? {})) group(`attributes.${handle}`, values);
   return {
     priceStat: f.price ? { min: toMajor(f.price.min), max: toMajor(f.price.max) } : {},
-    categories: (f.categories ?? []).map((c) => ({ name: c.title, slug: c.slug, count: c.count })),
+    categories: categoryFacets(f.categories ?? [], tree),
     tags: (f.tags ?? []).map((t) => ({ name: t.value, count: t.count })),
     allFilters
   };
@@ -1637,13 +1653,14 @@ var SearchService = class extends CatalogService {
         productTypes: listParam(p, "product_type"),
         facets: true
       });
+      const tree = res.facets?.categories?.length ? await this.facts.categories().catch(() => []) : [];
       return {
         data: res.data,
         count: res.count,
         totalPages: res.noOfPage,
         page: res.page,
         categoryHierarchy: res.categoryHierarchy,
-        facets: toStorefrontFacets(res.facets)
+        facets: toStorefrontFacets(res.facets, tree)
       };
     } catch (err) {
       if (err?.status === 404) return this.emptyResult();