platform-types 1.10.813 → 1.10.814

package/dist/cjs/product.js

@@ -14,8 +14,10 @@ exports.MAX_BASE_QUANTITY = 1_000_000;
 exports.DISCOVERY_SORTS = ['newest', 'price_asc', 'price_desc', 'name_asc', 'name_desc'];
 /**
  * The facets Web `GET /products?mode=discover` can count (`facets=brand,tag,category`).
- * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`
- * (the filter matches no descendants, so a rolled-up parent would select nothing).
+ * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`.
+ * The `categoryId` filter selects a category's enabled descendants too, so a filter on a
+ * parent yields counts for several descendant ids; a product has one primary category,
+ * so a client sums exact counts over a subtree without counting a product twice.
  */
 exports.DISCOVERY_FACETS = ['brand', 'tag', 'category'];
 /** Most products the store's best-seller ranking holds, and web `mode=best-sellers` returns. */

package/dist/product.d.ts

@@ -12,8 +12,10 @@ export declare const DISCOVERY_SORTS: readonly ["newest", "price_asc", "price_de
 export type DiscoverySort = (typeof DISCOVERY_SORTS)[number];
 /**
  * The facets Web `GET /products?mode=discover` can count (`facets=brand,tag,category`).
- * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`
- * (the filter matches no descendants, so a rolled-up parent would select nothing).
+ * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`.
+ * The `categoryId` filter selects a category's enabled descendants too, so a filter on a
+ * parent yields counts for several descendant ids; a product has one primary category,
+ * so a client sums exact counts over a subtree without counting a product twice.
  */
 export declare const DISCOVERY_FACETS: readonly ["brand", "tag", "category"];
 export type DiscoveryFacet = (typeof DISCOVERY_FACETS)[number];
@@ -272,7 +274,17 @@ declare global {
         mode: 'discover';
         /** Free text, ≤100 chars; every token must appear in the product's search term. */
         search?: string;
-        /** Exact primary category; descendants are not included. */
+        /**
+         * A primary category AND every enabled descendant: a product whose primary
+         * category is this one or any category below it. A disabled descendant
+         * excludes its whole branch. An id the store's enabled tree does not hold —
+         * unknown, or itself disabled — matches its own products only. A cursor is
+         * bound to the subtree it was minted over: once descendants count, or after
+         * the enabled subtree changes, a parent's cursor is 400 `INVALID_CURSOR`
+         * (a category with no enabled descendant keeps its cursors). A subtree too
+         * large for a price or name sort's whole-set read is refused like any such
+         * set (`DISCOVERY_SORT_UNSUPPORTED`).
+         */
         categoryId?: string;
         brandId?: string;
         /**

package/dist/product.js

@@ -11,8 +11,10 @@ export const MAX_BASE_QUANTITY = 1_000_000;
 export const DISCOVERY_SORTS = ['newest', 'price_asc', 'price_desc', 'name_asc', 'name_desc'];
 /**
  * The facets Web `GET /products?mode=discover` can count (`facets=brand,tag,category`).
- * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`
- * (the filter matches no descendants, so a rolled-up parent would select nothing).
+ * `brand` tallies `brandId`, `tag` each of `tagIds`, `category` the EXACT `categoryId`.
+ * The `categoryId` filter selects a category's enabled descendants too, so a filter on a
+ * parent yields counts for several descendant ids; a product has one primary category,
+ * so a client sums exact counts over a subtree without counting a product twice.
  */
 export const DISCOVERY_FACETS = ['brand', 'tag', 'category'];
 /** Most products the store's best-seller ranking holds, and web `mode=best-sellers` returns. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.813",
+	"version": "1.10.814",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",