platform-types 1.10.683 → 1.10.684

package/dist/cjs/storefrontDesignRegistry.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isStorefrontEditorLiteralKey = exports.STOREFRONT_EDITOR_LITERAL_DEFAULTS = exports.resolveStorefrontLiveSettings = exports.isStorefrontLiveSettingKey = exports.STOREFRONT_LIVE_SETTING_KEYS = exports.STOREFRONT_DESIGN_REGISTRY = exports.resolveStorefrontDesignSettings = exports.resolveStorefrontDesignSettingsLayers = exports.STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS = exports.validateStorefrontDesignSetting = exports.validateStorefrontSettingValue = exports.isStorefrontDesignSettingKey = exports.STOREFRONT_DESIGN_SETTINGS = void 0;
+exports.isStorefrontEditorLiteralKey = exports.STOREFRONT_EDITOR_LITERAL_DEFAULTS = exports.resolveStorefrontLiveSettings = exports.isStorefrontLiveSettingKey = exports.STOREFRONT_LIVE_SETTING_KEYS = exports.STOREFRONT_DESIGN_REGISTRY = exports.resolveStorefrontDesignSettings = exports.resolveStorefrontDesignSettingsLayers = exports.STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS = exports.validateStorefrontDesignSetting = exports.validateStorefrontSettingValue = exports.isStorefrontDesignSettingKey = exports.STOREFRONT_DESIGN_SETTINGS = exports.STOREFRONT_DEFAULTS_VERSION = void 0;
+exports.STOREFRONT_DEFAULTS_VERSION = '1';
 const DESIGN_METADATA = {
     scope: 'storefront',
     allowedLayers: ['GLOBAL', 'WEB', 'WEB#store'],

package/dist/store.d.ts

@@ -484,9 +484,8 @@ declare global {
          * Response-time join, not a persisted Store attribute — and TWO different
          * shapes depending on the endpoint: `GET /tenants` (SUPERVISOR) attaches the
          * compact `StoreRowSubscriptionSummary`; the tenant's own `GET /store`
-         * embeds a near-`SubscriptionSyncPayload` (today still missing `currency`
-         * and `freeUntil` — treat both as possibly absent until the api aligns the
-         * embed). Discriminate structurally (`'entitlements' in subscription`).
+         * embeds a near-`SubscriptionSyncPayload`, including `currency` and
+         * `freeUntil`. Discriminate structurally (`'entitlements' in subscription`).
          */
         subscription?: StoreRowSubscriptionSummary | SubscriptionSyncPayload;
         config: {
@@ -892,6 +891,13 @@ declare global {
          *   value refetches `GET /store` to see those.
          */
         publicStorefront?: PublicStorefront | null;
+        /**
+         * True once the shop has a published storefront design; legacy presentation fields are then
+         * owned by the design editor. Read-time, never stored: sent on app `GET /store` (both views)
+         * and `GET /tenants?storeId=`, never on the `GET /tenants` list, echoes or frames. Absent means
+         * "not read here", never "not adopted": keep the value from the last of those two reads.
+         */
+        storefrontAdopted?: boolean;
         /**
          * Server-built public contact on web GET /store and customer STORE frames.
          * Absent means an older API; an empty object means no validated public
@@ -901,6 +907,15 @@ declare global {
         publicContact?: StorefrontPublicContact;
         /** Read-only legacy editor seed, available only to the entitled tenant ADMIN. */
         storefrontEditorBaseline?: StorefrontEditorBaseline;
+        /** Public aggregate from the immutable publication and live platform layers. */
+        storefrontDesign?: PublicStorefrontDesignResult;
+        /**
+         * Customer STORE frame hint: re-read the public aggregate; carries no private identity. Set by
+         * an adopted shop's frame when the write reached `ecommerce` or `config`, by the frame a fresh
+         * publish sends, and by any frame whose publication contact could not be read (that frame
+         * carries no contact keys at all).
+         */
+        storefrontDesignInvalidated?: true;
         photoURL: string;
         /** @deprecated Request-only upload control, never persisted or returned — use `StoreUpdateInput.photoData`. */
         photoData?: string;
@@ -1000,6 +1015,16 @@ declare global {
          */
         requireEmailVerification?: boolean;
     }
+    /**
+     * `data` of a `stores` frame on a CUSTOMER socket — `dynamoUpdate`'s customer fan-out of a
+     * STORE write and the frame a fresh storefront publish sends. The public STORE allow-list,
+     * each value narrowed as web `GET /store` narrows it, plus the contact pair and `storeId`.
+     * Partial by design: a client merges it over its cached store and refetches `GET /store`, so
+     * an absent key means "unchanged", never "cleared".
+     */
+    type StoreCustomerFrameData = {
+        storeId: string;
+    } & Partial<Pick<Store, 'name' | 'photoURL' | 'brands' | 'deliveryMethods' | 'cuit' | 'config' | 'currencies' | 'address' | 'categories' | 'paymentMethods' | 'ecommerce' | 'email' | 'phone' | 'publicContact' | 'storefrontDesignInvalidated'>>;
     interface StoreIntegrations {
         afip?: Afip;
         mercadopago?: Mercadopago;

package/dist/storefrontDesign.d.ts

@@ -67,14 +67,20 @@ declare global {
     type StorefrontDesignProductSource = {
         kind: 'offers' | 'new';
     } | {
-        kind: 'category' | 'brand' | 'collection';
+        kind: 'category' | 'brand';
+        id: string;
+    } | {
+        kind: 'collection';
         id: string;
     };
     type StorefrontDesignLinkTarget = {
         kind: 'builtin';
         id: (typeof STOREFRONT_BUILTIN_DESTINATIONS)[number];
     } | {
-        kind: 'page' | 'category' | 'brand' | 'collection';
+        kind: 'page' | 'category' | 'brand';
+        id: string;
+    } | {
+        kind: 'collection';
         id: string;
     } | {
         kind: 'external';
@@ -255,6 +261,37 @@ declare global {
     type StorefrontDesignPublic = Omit<StorefrontDesignV1, 'contact'> & {
         contact: StorefrontPublicContact;
     };
+    /**
+     * Image placements gain `url`/`mobileUrl`: the variant-LESS base
+     * `/sf-media/{stage}/{storeId}/{publicationId}/{assetId}`, a path on the images host. Append
+     * `/${StorefrontAssetVariant}` (one of `STOREFRONT_ASSET_VARIANTS`) to request it; the base
+     * alone is not servable. Never route it through `/fit-in/`: the media path is refused there.
+     */
+    type PublicStorefrontDesignValue<T> = T extends StorefrontDesignImagePlacement ? T & {
+        url: string;
+        mobileUrl?: string;
+    } : T extends {
+        kind: 'collection';
+        id: string;
+    } ? T & {
+        slug: string;
+    } : T extends readonly (infer V)[] ? PublicStorefrontDesignValue<V>[] : T extends object ? {
+        [K in keyof T]: PublicStorefrontDesignValue<T[K]>;
+    } : T;
+    type PublicStorefrontDesign = PublicStorefrontDesignValue<Omit<StorefrontDesignPublic, 'literalOverrides'>>;
+    type PublicStorefrontDesignResult = {
+        mode: 'legacy';
+    } | {
+        mode: 'published';
+        publicationId: string;
+        document: PublicStorefrontDesign;
+        literalLayers: {
+            scope: LiteralScope;
+            literals: Record<string, string>;
+        }[];
+        effectiveSettings: StorefrontDesignSettings;
+        defaultsVersion: string;
+    };
     interface StorefrontDesignV1 {
         schemaVersion: 1;
         templateId: 'standard';
@@ -275,13 +312,16 @@ declare global {
         path: string;
         code: StorefrontDesignFieldErrorCode;
     }
-    type StorefrontDesignErrorCode = 'STOREFRONT_DESIGN_INVALID' | 'STOREFRONT_SCHEMA_UNSUPPORTED' | 'STOREFRONT_REVISION_CONFLICT' | 'STOREFRONT_DRAFT_NOT_INITIALIZED' | 'STOREFRONT_REQUEST_EXPIRED' | 'STOREFRONT_PUBLICATION_NOT_FOUND' | 'STOREFRONT_OPERATION_NOT_FOUND' | 'STOREFRONT_DRAFT_UNAVAILABLE' | 'IDEMPOTENCY_CONFLICT' | 'STOREFRONT_EDITOR_REQUIRED' | 'STOREFRONT_ASSET_NOT_READY' | 'STOREFRONT_PREVIEW_EXPIRED' | 'STOREFRONT_PREVIEW_REVOKED' | 'STOREFRONT_PREVIEW_FORBIDDEN';
+    type StorefrontDesignErrorCode = 'STOREFRONT_DESIGN_INVALID' | 'STOREFRONT_SCHEMA_UNSUPPORTED' | 'STOREFRONT_REVISION_CONFLICT' | 'STOREFRONT_DRAFT_NOT_INITIALIZED' | 'STOREFRONT_REQUEST_EXPIRED' | 'STOREFRONT_PUBLICATION_NOT_FOUND'
+    /** Web `GET /store` and `GET /literals` `503`: the stored publication cannot be served; retry later. */
+     | 'STOREFRONT_PUBLICATION_UNAVAILABLE' | 'STOREFRONT_OPERATION_NOT_FOUND' | 'STOREFRONT_DRAFT_UNAVAILABLE' | 'IDEMPOTENCY_CONFLICT' | 'STOREFRONT_EDITOR_REQUIRED' | 'STOREFRONT_ASSET_NOT_READY' | 'STOREFRONT_PREVIEW_EXPIRED' | 'STOREFRONT_PREVIEW_REVOKED' | 'STOREFRONT_PREVIEW_FORBIDDEN';
     interface StorefrontDesignMappingConflict {
         path: string;
         code: 'LEGACY_MULTIPLE_PRODUCT_FEEDS' | 'LEGACY_UNMAPPED_CONTENT';
         sources?: StorefrontDesignProductSource[];
     }
     interface StorefrontEditorBaseline {
+        legacyRevision?: number;
         document: StorefrontDesignV1;
         mappingConflicts: StorefrontDesignMappingConflict[];
         legacySourceRevision: string;

package/dist/storefrontDesignRegistry.d.ts

@@ -1,3 +1,4 @@
+export declare const STOREFRONT_DEFAULTS_VERSION = "1";
 export type StorefrontResolutionLayer = 'GLOBAL' | 'WEB' | 'WEB#store';
 export type StorefrontRegistryAudience = 'internal' | 'app' | 'public';
 export type StorefrontRegistryLifecycle = 'live' | 'release-owned';

package/dist/storefrontDesignRegistry.js

@@ -1,3 +1,4 @@
+export const STOREFRONT_DEFAULTS_VERSION = '1';
 const DESIGN_METADATA = {
     scope: 'storefront',
     allowedLayers: ['GLOBAL', 'WEB', 'WEB#store'],

package/package.json

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