platform-types 1.10.807 → 1.10.808

package/dist/cjs/product.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PRODUCT_MEDIA_INVALID_REASONS = exports.MAX_PRODUCT_PICTURE_ALT_CHARS = exports.PRODUCT_UPSERT_ERROR_CODES = exports.PRODUCT_UPSERT_ROW_ERROR_CODES = exports.PRODUCT_UPSERT_ROW_CAP = exports.PUBLIC_PRODUCT_SUGGEST_ERROR_CODES = exports.PUBLIC_PRODUCT_BY_SLUG_ERROR_CODES = exports.PRODUCT_PUBLISH_OVERDUE_AFTER_MS = exports.PRODUCT_PUBLISH_AT_MAX_AHEAD_MS = exports.PRODUCT_POST_ERROR_CODES = exports.PRODUCT_IDENTITY_ERROR_CODES = exports.PRODUCT_EXPORT_ERROR_CODES = exports.PRODUCT_CATALOG_EXPORT_COLUMNS = exports.RECENT_PURCHASES_MAX = exports.BEST_SELLERS_MAX = exports.DISCOVERY_SORTS = exports.MAX_BASE_QUANTITY = exports.BASE_QUANTITY_DECIMAL_PLACES = void 0;
+exports.PRODUCT_MEDIA_INVALID_REASONS = exports.MAX_PRODUCT_PICTURE_ALT_CHARS = exports.PRODUCT_UPSERT_ERROR_CODES = exports.PRODUCT_UPSERT_ROW_ERROR_CODES = exports.PRODUCT_UPSERT_ROW_CAP = exports.PUBLIC_PRODUCT_SUGGEST_ERROR_CODES = exports.PUBLIC_PRODUCT_BY_SLUG_ERROR_CODES = exports.PRODUCT_PUBLISH_OVERDUE_AFTER_MS = exports.PRODUCT_PUBLISH_AT_MAX_AHEAD_MS = exports.PRODUCT_POST_ERROR_CODES = exports.PRODUCT_IDENTITY_ERROR_CODES = exports.PRODUCT_EXPORT_ERROR_CODES = exports.PRODUCT_CATALOG_EXPORT_COLUMNS = exports.RECENT_PURCHASES_MAX = exports.BEST_SELLERS_MAX = exports.DISCOVERY_FACETS = exports.DISCOVERY_SORTS = exports.MAX_BASE_QUANTITY = exports.BASE_QUANTITY_DECIMAL_PLACES = void 0;
 /** Maximum decimal places in a canonical base quantity; inputs are exact, never rounded. */
 exports.BASE_QUANTITY_DECIMAL_PLACES = 6;
 /** Absolute base-quantity input bound; signed adjustments admit the negative of this value. */
@@ -11,6 +11,12 @@ exports.MAX_BASE_QUANTITY = 1_000_000;
  * order them inside one bounded request).
  */
 exports.DISCOVERY_SORTS = ['newest'];
+/**
+ * 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).
+ */
+exports.DISCOVERY_FACETS = ['brand', 'tag', 'category'];
 /** Most products the store's best-seller ranking holds, and web `mode=best-sellers` returns. */
 exports.BEST_SELLERS_MAX = 50;
 /** Most distinct products a buyer's recent-purchases row holds, and web `mode=recently-bought` returns. */

package/dist/product.d.ts

@@ -9,6 +9,13 @@ export declare const MAX_BASE_QUANTITY = 1000000;
  */
 export declare const DISCOVERY_SORTS: readonly ["newest"];
 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).
+ */
+export declare const DISCOVERY_FACETS: readonly ["brand", "tag", "category"];
+export type DiscoveryFacet = (typeof DISCOVERY_FACETS)[number];
 /** Most products the store's best-seller ranking holds, and web `mode=best-sellers` returns. */
 export declare const BEST_SELLERS_MAX = 50;
 /** Most distinct products a buyer's recent-purchases row holds, and web `mode=recently-bought` returns. */
@@ -281,6 +288,38 @@ declare global {
         sort?: string;
         /** The previous response's `LastEvaluatedKey`, under the SAME filters and sort; else 400 INVALID_CURSOR. */
         startKey?: string;
+        /**
+         * Comma-separated `DISCOVERY_FACETS` members to count. Unknown members are
+         * ignored; a value outside `^[\w,-]{1,128}$` is 400 `INVALID_DISCOVERY_QUERY`.
+         * Honoured only on a first page (no `startKey`), ignored after it. Never bound
+         * into the cursor.
+         */
+        facets?: string;
+    }
+    /**
+     * One facet value: applied as its filter with the other current filters, it returns at
+     * least `count` rows across the walk — exactly `count` unless the facets are `truncated`.
+     */
+    interface DiscoveryFacetValue {
+        id: string;
+        count: number;
+    }
+    /**
+     * The values each requested facet can take under the current query, count
+     * descending. Disjunctive: a facet is counted with every other filter applied
+     * but not its own, so the picked brand still lists its sibling brands. A
+     * facet absent from the request is absent here.
+     */
+    interface DiscoveryFacets {
+        brand?: DiscoveryFacetValue[];
+        tag?: DiscoveryFacetValue[];
+        category?: DiscoveryFacetValue[];
+        /**
+         * The count walk hit its read budget before the catalogue ended: every
+         * listed value still returns rows, but counts are lower bounds and a value
+         * may be missing — fall back to the store-wide list for anything unlisted.
+         */
+        truncated?: true;
     }
     /** One page of a discovery walk; `data` can be empty while `LastEvaluatedKey` is set. */
     interface PublicProductDiscoverResponse {
@@ -291,6 +330,12 @@ declare global {
         sort?: (typeof DISCOVERY_SORTS)[number];
         /** Present while rows remain; absent means the walk is complete. */
         LastEvaluatedKey?: string;
+        /**
+         * Only on a first page whose request named a known facet. Also absent when the
+         * count failed (the rows still answer) — read absence as "fall back to the
+         * store-wide lists", never as "no values".
+         */
+        facets?: DiscoveryFacets;
     }
     /**
      * Web `GET /products?mode=best-sellers` and `mode=recently-bought`: at most 50 rows, no cursor,

package/dist/product.js

@@ -8,6 +8,12 @@ export const MAX_BASE_QUANTITY = 1_000_000;
  * order them inside one bounded request).
  */
 export const DISCOVERY_SORTS = ['newest'];
+/**
+ * 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).
+ */
+export const DISCOVERY_FACETS = ['brand', 'tag', 'category'];
 /** Most products the store's best-seller ranking holds, and web `mode=best-sellers` returns. */
 export const BEST_SELLERS_MAX = 50;
 /** Most distinct products a buyer's recent-purchases row holds, and web `mode=recently-bought` returns. */

package/dist/storefrontDesign.d.ts

@@ -762,6 +762,8 @@ declare global {
         /** Web `mode=discover`'s `sort`; an unserved one answers 400 `DISCOVERY_SORT_UNSUPPORTED`. */
         sort?: DiscoverySort;
         startKey?: string;
+        /** Web `mode=discover`'s `facets`: counted on a first page only, answered as `facets`. */
+        facets?: string;
     }
     /**
      * Web `GET /products?updatedAt=`'s recency listing (the shop's «Ingresos» page), with the

package/package.json

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