platform-types 1.10.774 → 1.10.775

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.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_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,10 @@ exports.MAX_BASE_QUANTITY = 1_000_000;
  * order them inside one bounded request).
  */
 exports.DISCOVERY_SORTS = ['newest'];
+/** 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. */
+exports.RECENT_PURCHASES_MAX = 50;
 /**
  * The CSV header of `GET /products?mode=export`, in file order.
  *

package/dist/cjs/storefrontDesign.js

@@ -205,6 +205,8 @@ exports.STOREFRONT_PREVIEW_READ_OPERATIONS = [
     'product',
     'productBySlug',
     'productsByIds',
+    'bestSellers',
+    'recentlyBought',
     'products',
     'incomes',
     'group',

package/dist/customer.d.ts

@@ -1146,6 +1146,11 @@ declare global {
         invoiceId?: string;
         accountId?: string;
     }
+    /** One entry of `CustomerDataExport.recentPurchases`: a product id and when it was last ordered (epoch ms). */
+    interface CustomerRecentPurchaseExportEntry {
+        productId: string;
+        lastOrderedAt: number;
+    }
     /**
      * Supported customer, CRM, order, invoice, ledger and directly customer-linked
      * payment collections, assembled for the SUBJECT
@@ -1225,6 +1230,14 @@ declare global {
          * `customer` object above never carries that array.
          */
         favorites: CustomerFavoriteExportEntry[];
+        /**
+         * The subject's recent purchases (`PURCHASES#{storeId}` / `{customerId}`), newest first:
+         * the distinct products they ordered on the storefront or at the counter, at most
+         * `RECENT_PURCHASES_MAX` per id. A merge does not move the row, so the row of every folded
+         * id (up to the folded-id cap) is unioned in, one entry per product at its latest instant.
+         * On BOTH surfaces; `[]` when the subject has none.
+         */
+        recentPurchases: CustomerRecentPurchaseExportEntry[];
         /**
          * Per COLLECTION, and honest: `true` means the read stopped before the
          * end of a partition, folded financial IDs were omitted at the cap, or whole
@@ -1246,6 +1259,8 @@ declare global {
             /** Present exactly when `contacts` is. */
             contacts?: boolean;
             favorites: boolean;
+            /** `true` when folded ids past the cap were not read. */
+            recentPurchases: boolean;
         };
     }
     /**
@@ -1531,6 +1546,14 @@ declare global {
          * On BOTH wires — the subject's own data, like the addresses.
          */
         favoritesEraseComplete: boolean;
+        /**
+         * `false` when the subject's recent-purchases row (`PURCHASES#{storeId}` / `{customerId}`,
+         * one item per erased id) could not be deleted. The whole row goes: it is the subject's own
+         * data (it is in their art. 14 export). Re-issuing the erasure re-runs the delete; BOTH
+         * erasure handlers write a deduped `ERROR` row
+         * (`CUSTOMER_ANONYMIZE_RECENT_PURCHASES_INCOMPLETE`). On BOTH wires.
+         */
+        recentPurchasesEraseComplete: boolean;
         /**
          * `RMA#` rows of this customer whose free text (`requestReason`,
          * `rejectionReason`) this erasure REMOVEd. The RMA row itself is kept —

package/dist/product.d.ts

@@ -9,6 +9,10 @@ export declare const MAX_BASE_QUANTITY = 1000000;
  */
 export declare const DISCOVERY_SORTS: readonly ["newest"];
 export type DiscoverySort = (typeof DISCOVERY_SORTS)[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. */
+export declare const RECENT_PURCHASES_MAX = 50;
 declare global {
     type ProductUnitsErrorCode = 'UNIT_REVISION_STALE' | 'UNIT_FACTOR_INVALID' | 'UNIT_FACTOR_MISMATCH' | 'UNIT_INCOMPATIBLE_DIMENSION' | 'UNIT_QUANTITY_UNREPRESENTABLE' | 'UNIT_QUANTITY_NOT_WHOLE';
     type ProductUnit = 'each' | 'gram' | 'kilogram' | 'millilitre' | 'litre' | 'metre';
@@ -285,6 +289,21 @@ declare global {
         /** Present while rows remain; absent means the walk is complete. */
         LastEvaluatedKey?: string;
     }
+    /**
+     * Web `GET /products?mode=best-sellers` and `mode=recently-bought`: at most 50 rows, no cursor,
+     * each priced and stocked for the caller as `mode=by-ids` does, withheld products dropped.
+     *
+     * `best-sellers` is rank order: units sold over the store's ABC window (`windowDays`, default
+     * 90), net of customer returns, services and disabled products excluded, recomputed nightly;
+     * `[]` before the first ranking. `recently-bought` is the signed-in, approved buyer's own last
+     * distinct products, newest first, read for the bearer's own customer and never for a query
+     * parameter; a guest gets `[]`. Both answer `Cache-Control: private, no-store` when a customer is
+     * resolved, and `recently-bought` always does.
+     */
+    interface PublicProductSourceResponse {
+        message: string;
+        data: PublicProduct[];
+    }
     /** Anonymous Web GET /products typeahead; the tenant comes from the public store context. */
     interface PublicProductSuggestInput {
         mode: 'suggest';

package/dist/product.js

@@ -8,6 +8,10 @@ export const MAX_BASE_QUANTITY = 1_000_000;
  * order them inside one bounded request).
  */
 export const DISCOVERY_SORTS = ['newest'];
+/** 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. */
+export const RECENT_PURCHASES_MAX = 50;
 /**
  * The CSV header of `GET /products?mode=export`, in file order.
  *

package/dist/storefrontDesign.d.ts

@@ -1,4 +1,5 @@
 import type { StorefrontThemeWarning } from './storefrontTheme.ts';
+import type { DiscoverySort } from './product.ts';
 /** The social kinds a contact may link, each to its own hosts; a contact links at most one per kind. */
 export declare const STOREFRONT_SOCIAL_HOSTS: {
     readonly instagram: readonly ["instagram.com", "www.instagram.com"];
@@ -109,8 +110,14 @@ export declare function createStorefrontDesignV1(): StorefrontDesignV1;
 declare global {
     type StorefrontDesignSectionType = (typeof STOREFRONT_SECTION_TYPES)[number];
     type StorefrontContactField = (typeof STOREFRONT_CONTACT_FIELDS)[number];
+    /**
+     * Where a products section's rows come from. `bestSellers` is the shop's ranking (web
+     * `GET /products?mode=best-sellers`, rank order); `recentlyBought` is the signed-in buyer's own
+     * last distinct products (`mode=recently-bought`, newest first), empty for a guest. A storefront
+     * that does not know a kind must render nothing for it.
+     */
     type StorefrontDesignProductSource = {
-        kind: 'offers' | 'new';
+        kind: 'offers' | 'new' | 'bestSellers' | 'recentlyBought';
     } | {
         kind: 'category' | 'brand';
         id: string;
@@ -167,6 +174,13 @@ declare global {
             layout?: 'row' | 'grid';
             count?: number;
             heading?: string;
+            /**
+             * A `DISCOVERY_SORTS` member, for a discovery-backed source only (`offers`, `new`,
+             * `category`, `brand`); on `collection`, `bestSellers` or `recentlyBought` it is `INVALID`.
+             * Whether discovery serves it for the source's filters is discovery's own
+             * `DISCOVERY_SORT_UNSUPPORTED`. Absent means the source's own order.
+             */
+            sort?: DiscoverySort;
         };
         categories: {
             source?: {
@@ -662,6 +676,13 @@ declare global {
      | {
         operation: 'productsByIds';
         productIds: string;
+    }
+    /**
+     * `bestSellers` is web `GET /products?mode=best-sellers`'s read and answer, priced as a
+     * guest. `recentlyBought` answers `{ data: [] }`: a preview has no buyer to read for.
+     */
+     | {
+        operation: 'bestSellers' | 'recentlyBought';
     } | {
         operation: 'products';
         search?: string;
@@ -905,7 +926,7 @@ declare global {
         data: StorefrontDesignPreviewResult;
     } | StorefrontDesignFailure;
 }
-export declare const STOREFRONT_PREVIEW_READ_OPERATIONS: readonly ["design", "store", "product", "productBySlug", "productsByIds", "products", "incomes", "group", "related", "categories", "brands", "tags", "collection", "paymentMethods", "deliveryMethods", "asset"];
+export declare const STOREFRONT_PREVIEW_READ_OPERATIONS: readonly ["design", "store", "product", "productBySlug", "productsByIds", "bestSellers", "recentlyBought", "products", "incomes", "group", "related", "categories", "brands", "tags", "collection", "paymentMethods", "deliveryMethods", "asset"];
 /** Checks transport structure and UTF-8 size; unfamiliar section types are skipped, never rendered. */
 export declare function parseStorefrontPreviewDocument(input: unknown): StorefrontPreviewDocument | undefined;
 /** The codes a preview frame may report in an `error` message; the parser accepts exactly these. */

package/dist/storefrontDesign.js

@@ -197,6 +197,8 @@ export const STOREFRONT_PREVIEW_READ_OPERATIONS = [
     'product',
     'productBySlug',
     'productsByIds',
+    'bestSellers',
+    'recentlyBought',
     'products',
     'incomes',
     'group',

package/package.json

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