platform-types 1.10.807 → 1.10.809

package/dist/cjs/product.js

@@ -1,16 +1,22 @@
 "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. */
 exports.MAX_BASE_QUANTITY = 1_000_000;
 /**
  * The `sort` values Web `GET /products?mode=discover` serves. `newest` is
- * descending product id; name and price sorts are not served (no index can
- * order them inside one bounded request).
+ * descending product id; `price_asc` / `price_desc` are the caller's own price
+ * (see `PublicProductDiscoverInput.sort`). Name sorts are not served.
  */
-exports.DISCOVERY_SORTS = ['newest'];
+exports.DISCOVERY_SORTS = ['newest', 'price_asc', 'price_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).
+ */
+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

@@ -4,11 +4,18 @@ export declare const BASE_QUANTITY_DECIMAL_PLACES = 6;
 export declare const MAX_BASE_QUANTITY = 1000000;
 /**
  * The `sort` values Web `GET /products?mode=discover` serves. `newest` is
- * descending product id; name and price sorts are not served (no index can
- * order them inside one bounded request).
+ * descending product id; `price_asc` / `price_desc` are the caller's own price
+ * (see `PublicProductDiscoverInput.sort`). Name sorts are not served.
  */
-export declare const DISCOVERY_SORTS: readonly ["newest"];
+export declare const DISCOVERY_SORTS: readonly ["newest", "price_asc", "price_desc"];
 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. */
@@ -273,14 +280,58 @@ declare global {
         isNew?: 'true';
         /**
          * A member of `DISCOVERY_SORTS`. `newest` = descending product id (mint
-         * order), on every filter combination. A well-formed value the api does not
-         * serve is 400 `DISCOVERY_SORT_UNSUPPORTED` ({@link DiscoverySortRefusal});
-         * one not matching `^[a-z_]{1,32}$` is 400 `INVALID_DISCOVERY_QUERY`. An
-         * empty value is absent. Bound into the cursor when present.
+         * order), on every filter combination. `price_asc` / `price_desc` = the
+         * caller's own price, as each row is priced for them: in the store's display
+         * currency, an open offer counting as the price, no quantity break. Rows the
+         * caller is shown no price for (a hidden slot, every row for a guest of a
+         * store that hides prices) come LAST in both directions; equal prices and
+         * that unpriced tail are newest first. A price sort reads the whole filtered
+         * set on every page, so a set too large for one read is 400
+         * `DISCOVERY_SORT_UNSUPPORTED` after the reads, with `supportedSorts`
+         * naming what that query can be served in, and a read the time budget cut
+         * short is 503 `PRODUCT_LOOKUP_INCOMPLETE` (retryable). A price cursor is
+         * also bound to the caller's price list: resumed under another (a sign-in,
+         * a list change) it is 400 `INVALID_CURSOR`. A well-formed value the api does
+         * not serve is 400 `DISCOVERY_SORT_UNSUPPORTED` ({@link DiscoverySortRefusal})
+         * before any read; one not matching `^[a-z_]{1,32}$` is 400
+         * `INVALID_DISCOVERY_QUERY`. An empty value is absent. Bound into the cursor
+         * when present.
          */
         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 +342,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,
@@ -335,8 +392,14 @@ declare global {
         truncated?: true;
     }
     /** Refusals of Web `GET /products?mode=discover`. */
-    type DiscoveryErrorCode = 'INVALID_DISCOVERY_QUERY' | 'INVALID_CURSOR' | 'DISCOVERY_SORT_UNSUPPORTED';
-    /** 400 body for a well-formed `sort` the api does not serve; `supportedSorts` lists what it does. */
+    type DiscoveryErrorCode = 'INVALID_DISCOVERY_QUERY' | 'INVALID_CURSOR' | 'DISCOVERY_SORT_UNSUPPORTED'
+    /** 503: a price-sorted walk the time budget cut short; retry. */
+     | 'PRODUCT_LOOKUP_INCOMPLETE';
+    /**
+     * 400 body for a `sort` the api does not serve for this request; `supportedSorts` lists what
+     * it does — every member for an unknown value, the non-price sorts when a price sort's
+     * filtered set was too large to read whole.
+     */
     interface DiscoverySortRefusal {
         message: string;
         error: 'DISCOVERY_SORT_UNSUPPORTED';

package/dist/product.js

@@ -4,10 +4,16 @@ export const BASE_QUANTITY_DECIMAL_PLACES = 6;
 export const MAX_BASE_QUANTITY = 1_000_000;
 /**
  * The `sort` values Web `GET /products?mode=discover` serves. `newest` is
- * descending product id; name and price sorts are not served (no index can
- * order them inside one bounded request).
+ * descending product id; `price_asc` / `price_desc` are the caller's own price
+ * (see `PublicProductDiscoverInput.sort`). Name sorts are not served.
  */
-export const DISCOVERY_SORTS = ['newest'];
+export const DISCOVERY_SORTS = ['newest', 'price_asc', 'price_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).
+ */
+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.809",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",