platform-types 1.10.685 → 1.10.686

package/dist/cjs/storefrontDesign.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STOREFRONT_SOCIAL_HOSTS = exports.STOREFRONT_BENEFIT_ICONS = exports.STOREFRONT_RESERVED_SLUGS = exports.STOREFRONT_CONTACT_FIELDS = exports.STOREFRONT_PROTECTED_BUILTIN_DESTINATIONS = exports.STOREFRONT_BUILTIN_DESTINATIONS = exports.STOREFRONT_SECTION_TYPES = exports.STOREFRONT_DESIGN_LIMITS = void 0;
+exports.STOREFRONT_PREVIEW_PROTOCOL_ERRORS = exports.STOREFRONT_PREVIEW_READ_OPERATIONS = exports.STOREFRONT_SOCIAL_HOSTS = exports.STOREFRONT_BENEFIT_ICONS = exports.STOREFRONT_RESERVED_SLUGS = exports.STOREFRONT_CONTACT_FIELDS = exports.STOREFRONT_PROTECTED_BUILTIN_DESTINATIONS = exports.STOREFRONT_BUILTIN_DESTINATIONS = exports.STOREFRONT_SECTION_TYPES = exports.STOREFRONT_DESIGN_LIMITS = void 0;
 exports.createStorefrontDesignV1 = createStorefrontDesignV1;
+exports.parseStorefrontPreviewDocument = parseStorefrontPreviewDocument;
+exports.parseStorefrontPreviewMessage = parseStorefrontPreviewMessage;
+exports.acceptStorefrontPreviewMessage = acceptStorefrontPreviewMessage;
 exports.STOREFRONT_DESIGN_LIMITS = {
     customPages: 20,
     sectionsPerPage: 10,
@@ -32,6 +35,7 @@ exports.STOREFRONT_DESIGN_LIMITS = {
     imagePixels: 32_000_000,
     imageDimension: 8000,
     previewSeconds: 15 * 60,
+    previewMessageBytes: 300 * 1024,
     fieldErrors: 100,
     fieldErrorPath: 240,
     contactAddress: 500,
@@ -141,3 +145,205 @@ function createStorefrontDesignV1() {
         literalOverrides: {},
     };
 }
+exports.STOREFRONT_PREVIEW_READ_OPERATIONS = [
+    'design',
+    'store',
+    'product',
+    'productBySlug',
+    'productsByIds',
+    'products',
+    'group',
+    'related',
+    'categories',
+    'brands',
+    'tags',
+    'collection',
+    'paymentMethods',
+    'deliveryMethods',
+    'asset',
+];
+const previewRecord = (value) => value !== null &&
+    typeof value === 'object' &&
+    !Array.isArray(value) &&
+    (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
+function previewWithinBytes(value, maximum) {
+    try {
+        const serialized = JSON.stringify(value);
+        return serialized !== undefined && new TextEncoder().encode(serialized).byteLength <= maximum;
+    }
+    catch {
+        return false;
+    }
+}
+function previewSections(input) {
+    if (!Array.isArray(input) || input.length > exports.STOREFRONT_DESIGN_LIMITS.sectionsPerPage)
+        return undefined;
+    const sections = [];
+    for (const entry of input) {
+        if (!previewRecord(entry) || typeof entry.type !== 'string')
+            return undefined;
+        if (!exports.STOREFRONT_SECTION_TYPES.includes(entry.type))
+            continue;
+        if (typeof entry.id !== 'string' || typeof entry.enabled !== 'boolean' || !previewRecord(entry.content))
+            return undefined;
+        sections.push({
+            id: entry.id,
+            type: entry.type,
+            enabled: entry.enabled,
+            content: entry.content,
+        });
+    }
+    return sections;
+}
+function previewPage(input) {
+    if (!previewRecord(input) ||
+        typeof input.id !== 'string' ||
+        typeof input.slug !== 'string' ||
+        typeof input.title !== 'string' ||
+        typeof input.enabled !== 'boolean' ||
+        (input.seo !== undefined && !previewRecord(input.seo)))
+        return undefined;
+    const sections = previewSections(input.sections);
+    if (!sections)
+        return undefined;
+    return {
+        id: input.id,
+        slug: input.slug,
+        title: input.title,
+        enabled: input.enabled,
+        sections,
+        ...(input.seo === undefined ? {} : { seo: input.seo }),
+    };
+}
+/** Checks transport structure and UTF-8 size; unfamiliar section types are skipped, never rendered. */
+function parseStorefrontPreviewDocument(input) {
+    if (!previewRecord(input) ||
+        input.schemaVersion !== 1 ||
+        input.templateId !== 'standard' ||
+        !previewWithinBytes(input, exports.STOREFRONT_DESIGN_LIMITS.documentBytes))
+        return undefined;
+    const { settings, branding, contact, seo, literalOverrides, home, pages, navigation, footer } = input;
+    if (![settings, branding, contact, seo, literalOverrides].every(previewRecord) ||
+        !previewRecord(home) ||
+        home.id !== 'home' ||
+        typeof home.title !== 'string' ||
+        typeof home.enabled !== 'boolean' ||
+        !Array.isArray(pages) ||
+        pages.length > exports.STOREFRONT_DESIGN_LIMITS.customPages ||
+        !Array.isArray(navigation) ||
+        !navigation.every(previewRecord) ||
+        !Array.isArray(footer) ||
+        !footer.every(previewRecord))
+        return undefined;
+    const sections = previewSections(home.sections);
+    const parsedPages = pages.map(previewPage);
+    if (!sections || parsedPages.some((page) => page === undefined))
+        return undefined;
+    return {
+        schemaVersion: 1,
+        templateId: 'standard',
+        settings: settings,
+        branding: branding,
+        contact: contact,
+        seo: seo,
+        literalOverrides: literalOverrides,
+        home: { id: 'home', title: home.title, enabled: home.enabled, sections },
+        pages: parsedPages,
+        navigation,
+        footer,
+    };
+}
+/** The codes a preview frame may report in an `error` message; the parser accepts exactly these. */
+exports.STOREFRONT_PREVIEW_PROTOCOL_ERRORS = [
+    'STOREFRONT_PREVIEW_EXPIRED',
+    'STOREFRONT_PREVIEW_REVOKED',
+    'STOREFRONT_PREVIEW_FORBIDDEN',
+    'STOREFRONT_PREVIEW_UNAVAILABLE',
+    'STOREFRONT_DESIGN_INVALID',
+    'STOREFRONT_SCHEMA_UNSUPPORTED',
+];
+const isPreviewProtocolError = (value) => exports.STOREFRONT_PREVIEW_PROTOCOL_ERRORS.includes(value);
+const previewNonempty = (value) => typeof value === 'string' && value.length > 0;
+const previewSequence = (value) => Number.isSafeInteger(value) && value >= 0;
+const previewKeys = (input, keys) => Object.keys(input).every((key) => keys.includes(key));
+function parsePreviewBind(input, base) {
+    if (!previewKeys(input, [
+        'v',
+        'type',
+        'nonce',
+        'sequence',
+        'grant',
+        'draftRevision',
+        'document',
+        'viewport',
+        'appearance',
+    ]) ||
+        !previewSequence(input.sequence) ||
+        !previewNonempty(input.grant) ||
+        !previewNonempty(input.draftRevision) ||
+        (input.viewport !== 'desktop' && input.viewport !== 'mobile') ||
+        (input.appearance !== 'light' && input.appearance !== 'dark' && input.appearance !== 'system'))
+        return undefined;
+    const document = input.document === undefined ? undefined : parseStorefrontPreviewDocument(input.document);
+    if (input.document !== undefined && !document)
+        return undefined;
+    return {
+        ...base,
+        type: 'bind',
+        sequence: input.sequence,
+        grant: input.grant,
+        draftRevision: input.draftRevision,
+        viewport: input.viewport,
+        appearance: input.appearance,
+        ...(document ? { document } : {}),
+    };
+}
+function parsePreviewSequenced(input, base) {
+    if (!previewSequence(input.sequence))
+        return undefined;
+    const sequence = input.sequence;
+    switch (input.type) {
+        case 'update': {
+            if (!previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'document']))
+                return undefined;
+            const document = parseStorefrontPreviewDocument(input.document);
+            return document ? { ...base, type: 'update', sequence, document } : undefined;
+        }
+        case 'ack':
+            return previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'draftRevision']) &&
+                previewNonempty(input.draftRevision)
+                ? { ...base, type: 'ack', sequence, draftRevision: input.draftRevision }
+                : undefined;
+        case 'error':
+            return previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'code']) && isPreviewProtocolError(input.code)
+                ? { ...base, type: 'error', sequence, code: input.code }
+                : undefined;
+        default:
+            return undefined;
+    }
+}
+/** Does not authenticate the grant. Keep it in memory and post only to the exact configured target origin. */
+function parseStorefrontPreviewMessage(input) {
+    if (!previewRecord(input) ||
+        input.v !== 1 ||
+        !previewNonempty(input.nonce) ||
+        !previewWithinBytes(input, exports.STOREFRONT_DESIGN_LIMITS.previewMessageBytes))
+        return undefined;
+    const base = { v: 1, nonce: input.nonce };
+    if (input.type === 'ready')
+        return previewKeys(input, ['v', 'type', 'nonce']) ? { ...base, type: 'ready' } : undefined;
+    if (input.type === 'bind')
+        return parsePreviewBind(input, base);
+    return parsePreviewSequenced(input, base);
+}
+/** Start at sequence -1; ready is accepted only before sequenced messages. Advance after accepting. */
+function acceptStorefrontPreviewMessage(event, binding) {
+    if (event.origin !== binding.origin || binding.source == null || event.source !== binding.source)
+        return undefined;
+    const message = parseStorefrontPreviewMessage(event.data);
+    if (!message || message.nonce !== binding.nonce)
+        return undefined;
+    if (message.type === 'ready')
+        return binding.sequence === -1 ? message : undefined;
+    return message.sequence > binding.sequence ? message : undefined;
+}

package/dist/storefrontDesign.d.ts

@@ -29,6 +29,7 @@ export declare const STOREFRONT_DESIGN_LIMITS: {
     readonly imagePixels: 32000000;
     readonly imageDimension: 8000;
     readonly previewSeconds: number;
+    readonly previewMessageBytes: number;
     readonly fieldErrors: 100;
     readonly fieldErrorPath: 240;
     readonly contactAddress: 500;
@@ -266,6 +267,8 @@ declare global {
      * `/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.
+     * Private preview envelopes instead supply `/preview/read?operation=asset&assetId=...`; the
+     * preview transport adds a variant query and its in-memory grant, then renders returned bytes.
      */
     type PublicStorefrontDesignValue<T> = T extends StorefrontDesignImagePlacement ? T & {
         url: string;
@@ -314,7 +317,7 @@ declare global {
     }
     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';
+     | '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' | 'STOREFRONT_PREVIEW_UNAVAILABLE';
     interface StorefrontDesignMappingConflict {
         path: string;
         code: 'LEGACY_MULTIPLE_PRODUCT_FEEDS' | 'LEGACY_UNMAPPED_CONTENT';
@@ -414,8 +417,188 @@ declare global {
             targets: StorefrontDesignDeliveryTarget[];
         };
     }
+    interface StorefrontDesignPreviewRevokeInput {
+        grant: string;
+    }
+    interface StorefrontDesignPreviewRevokeResult {
+        revoked: true;
+    }
+    interface StorefrontPreviewGrantClaims {
+        aud: 'storefront-preview';
+        stage: 'dev' | 'prod';
+        storeId: string;
+        userId: string;
+        family: string;
+        draftRevision: string;
+        draftDocumentId: string;
+        grantId: string;
+        iat: number;
+        exp: number;
+    }
+    type StorefrontPreviewOperation = (typeof STOREFRONT_PREVIEW_READ_OPERATIONS)[number];
+    /** GET query fields use their serialized string representation. Store scope comes only from the grant. */
+    type StorefrontPreviewReadQuery = {
+        operation: 'design' | 'paymentMethods' | 'deliveryMethods';
+    }
+    /**
+     * The shop's public web `GET /store` frame — the same allow-listed STORE
+     * fields, method rows, currencies view, `config`, `ecommerce` and contact —
+     * with `storefrontDesign` from the pinned draft. Answered whether or not the
+     * shop is open: see {@link StorefrontPreviewStoreFrame}.
+     */
+     | {
+        operation: 'store';
+    } | {
+        operation: 'product' | 'related';
+        productId: string;
+    }
+    /** Web `GET /products?mode=by-slug`'s read and answer, in the grant's store. */
+     | {
+        operation: 'productBySlug';
+        slug: string;
+    }
+    /** Web `GET /products?mode=by-ids`'s read and answer: 1–100 comma-separated canonical ids. */
+     | {
+        operation: 'productsByIds';
+        productIds: string;
+    } | {
+        operation: 'products';
+        search?: string;
+        categoryId?: string;
+        brandId?: string;
+        tagId?: string;
+        inOffer?: 'true';
+        inStock?: 'true';
+        isNew?: 'true';
+        startKey?: string;
+    } | {
+        operation: 'group';
+        groupId: string;
+        limit?: string;
+        cursor?: string;
+    } | {
+        operation: 'categories' | 'brands';
+        Limit?: string;
+        offSet?: string;
+    } | {
+        operation: 'tags';
+        cursor?: string;
+    }
+    /**
+     * Web `GET /collections/{slug}`'s page: a collection that changes between the
+     * reads bracketing a page answers 409 `CURSOR_STALE`, as the public route does.
+     */
+     | {
+        operation: 'collection';
+        slug: string;
+        cursor?: string;
+    }
+    /**
+     * Answers the image bytes, not JSON. Send `Accept: image/*`: the App API
+     * returns binary only when the request's Accept matches its `image/*` binary
+     * media type, and any other Accept receives the bytes as base64 text.
+     */
+     | {
+        operation: 'asset';
+        assetId: string;
+        variant?: StorefrontAssetVariant;
+    };
+    interface StorefrontPreviewDesignResult {
+        mode: 'preview';
+        draftRevision: string;
+        document: PublicStorefrontDesign;
+        literalLayers: {
+            scope: LiteralScope;
+            literals: Record<string, string>;
+        }[];
+        effectiveSettings: StorefrontDesignSettings;
+        defaultsVersion: string;
+    }
+    /**
+     * `operation=store`'s `data`: the fields web `GET /store` builds from the STORE
+     * row, built by the same projector, and `storefrontDesign` from the pinned
+     * draft. The contact is the draft's (`publicContact`, plus `email`/`phone`
+     * derived from it), as an adopted shop's comes from its publication.
+     *
+     * Never carries what only an open shop's public route knows — `publicStorefront`,
+     * `maintenance` and `globals` — and never answers `STOREFRONT_UNAVAILABLE`: a
+     * shop whose storefront is switched off can still preview its draft.
+     */
+    type StorefrontPreviewStoreFrame = Omit<Partial<Store>, 'storefrontDesign' | 'publicStorefront' | 'maintenance' | 'globals'> & {
+        storefrontDesign: StorefrontPreviewDesignResult;
+    };
+    /** A transport shape only; renderers validate known content fields before rendering them. */
+    interface StorefrontPreviewSection {
+        id: string;
+        type: StorefrontDesignSectionType;
+        enabled: boolean;
+        content: Record<string, unknown>;
+    }
+    interface StorefrontPreviewDocument {
+        schemaVersion: 1;
+        templateId: 'standard';
+        settings: Record<string, unknown>;
+        branding: Record<string, unknown>;
+        home: {
+            id: 'home';
+            title: string;
+            enabled: boolean;
+            sections: StorefrontPreviewSection[];
+        };
+        pages: {
+            id: string;
+            slug: string;
+            title: string;
+            enabled: boolean;
+            sections: StorefrontPreviewSection[];
+            seo?: object;
+        }[];
+        navigation: object[];
+        footer: object[];
+        contact: Record<string, unknown>;
+        seo: object;
+        literalOverrides: Record<string, unknown>;
+    }
+    type StorefrontPreviewProtocolError = (typeof STOREFRONT_PREVIEW_PROTOCOL_ERRORS)[number];
+    type StorefrontPreviewViewport = 'desktop' | 'mobile';
+    type StorefrontPreviewAppearance = 'light' | 'dark' | 'system';
+    interface StorefrontPreviewMessageBase {
+        v: 1;
+        nonce: string;
+    }
+    type StorefrontPreviewMessage = StorefrontPreviewMessageBase & ({
+        type: 'ready';
+    } | {
+        type: 'bind';
+        sequence: number;
+        grant: string;
+        draftRevision: string;
+        document?: StorefrontPreviewDocument;
+        viewport: StorefrontPreviewViewport;
+        appearance: StorefrontPreviewAppearance;
+    } | {
+        type: 'update';
+        sequence: number;
+        document: StorefrontPreviewDocument;
+    } | {
+        type: 'ack';
+        sequence: number;
+        draftRevision: string;
+    } | {
+        type: 'error';
+        sequence: number;
+        code: StorefrontPreviewProtocolError;
+    });
+    interface StorefrontPreviewPeerBinding {
+        origin: string;
+        source: unknown;
+        nonce: string;
+        /** Last accepted sequence from this peer. Keep a separate binding in each direction. */
+        sequence: number;
+    }
     interface StorefrontDesignPreviewResult {
         grant: string;
+        /** Server-configured origin echo; the app must require equality with its configured preview origin. */
         previewOrigin: string;
         draftRevision: string;
         expiresAt: string;
@@ -468,9 +651,26 @@ declare global {
         message: string;
         data: StorefrontDesignPublishResult;
     } | StorefrontDesignFailure;
+    type StorefrontDesignPreviewRevokeResponse = {
+        message: string;
+        data: StorefrontDesignPreviewRevokeResult;
+    } | StorefrontDesignFailure;
     type StorefrontDesignPreviewResponse = {
         message: string;
         data: StorefrontDesignPreviewResult;
     } | StorefrontDesignFailure;
 }
+export declare const STOREFRONT_PREVIEW_READ_OPERATIONS: readonly ["design", "store", "product", "productBySlug", "productsByIds", "products", "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. */
+export declare const STOREFRONT_PREVIEW_PROTOCOL_ERRORS: readonly ["STOREFRONT_PREVIEW_EXPIRED", "STOREFRONT_PREVIEW_REVOKED", "STOREFRONT_PREVIEW_FORBIDDEN", "STOREFRONT_PREVIEW_UNAVAILABLE", "STOREFRONT_DESIGN_INVALID", "STOREFRONT_SCHEMA_UNSUPPORTED"];
+/** Does not authenticate the grant. Keep it in memory and post only to the exact configured target origin. */
+export declare function parseStorefrontPreviewMessage(input: unknown): StorefrontPreviewMessage | undefined;
+/** Start at sequence -1; ready is accepted only before sequenced messages. Advance after accepting. */
+export declare function acceptStorefrontPreviewMessage(event: {
+    origin: string;
+    source: unknown;
+    data: unknown;
+}, binding: StorefrontPreviewPeerBinding): StorefrontPreviewMessage | undefined;
 export {};

package/dist/storefrontDesign.js

@@ -28,6 +28,7 @@ export const STOREFRONT_DESIGN_LIMITS = {
     imagePixels: 32_000_000,
     imageDimension: 8000,
     previewSeconds: 15 * 60,
+    previewMessageBytes: 300 * 1024,
     fieldErrors: 100,
     fieldErrorPath: 240,
     contactAddress: 500,
@@ -137,3 +138,205 @@ export function createStorefrontDesignV1() {
         literalOverrides: {},
     };
 }
+export const STOREFRONT_PREVIEW_READ_OPERATIONS = [
+    'design',
+    'store',
+    'product',
+    'productBySlug',
+    'productsByIds',
+    'products',
+    'group',
+    'related',
+    'categories',
+    'brands',
+    'tags',
+    'collection',
+    'paymentMethods',
+    'deliveryMethods',
+    'asset',
+];
+const previewRecord = (value) => value !== null &&
+    typeof value === 'object' &&
+    !Array.isArray(value) &&
+    (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
+function previewWithinBytes(value, maximum) {
+    try {
+        const serialized = JSON.stringify(value);
+        return serialized !== undefined && new TextEncoder().encode(serialized).byteLength <= maximum;
+    }
+    catch {
+        return false;
+    }
+}
+function previewSections(input) {
+    if (!Array.isArray(input) || input.length > STOREFRONT_DESIGN_LIMITS.sectionsPerPage)
+        return undefined;
+    const sections = [];
+    for (const entry of input) {
+        if (!previewRecord(entry) || typeof entry.type !== 'string')
+            return undefined;
+        if (!STOREFRONT_SECTION_TYPES.includes(entry.type))
+            continue;
+        if (typeof entry.id !== 'string' || typeof entry.enabled !== 'boolean' || !previewRecord(entry.content))
+            return undefined;
+        sections.push({
+            id: entry.id,
+            type: entry.type,
+            enabled: entry.enabled,
+            content: entry.content,
+        });
+    }
+    return sections;
+}
+function previewPage(input) {
+    if (!previewRecord(input) ||
+        typeof input.id !== 'string' ||
+        typeof input.slug !== 'string' ||
+        typeof input.title !== 'string' ||
+        typeof input.enabled !== 'boolean' ||
+        (input.seo !== undefined && !previewRecord(input.seo)))
+        return undefined;
+    const sections = previewSections(input.sections);
+    if (!sections)
+        return undefined;
+    return {
+        id: input.id,
+        slug: input.slug,
+        title: input.title,
+        enabled: input.enabled,
+        sections,
+        ...(input.seo === undefined ? {} : { seo: input.seo }),
+    };
+}
+/** Checks transport structure and UTF-8 size; unfamiliar section types are skipped, never rendered. */
+export function parseStorefrontPreviewDocument(input) {
+    if (!previewRecord(input) ||
+        input.schemaVersion !== 1 ||
+        input.templateId !== 'standard' ||
+        !previewWithinBytes(input, STOREFRONT_DESIGN_LIMITS.documentBytes))
+        return undefined;
+    const { settings, branding, contact, seo, literalOverrides, home, pages, navigation, footer } = input;
+    if (![settings, branding, contact, seo, literalOverrides].every(previewRecord) ||
+        !previewRecord(home) ||
+        home.id !== 'home' ||
+        typeof home.title !== 'string' ||
+        typeof home.enabled !== 'boolean' ||
+        !Array.isArray(pages) ||
+        pages.length > STOREFRONT_DESIGN_LIMITS.customPages ||
+        !Array.isArray(navigation) ||
+        !navigation.every(previewRecord) ||
+        !Array.isArray(footer) ||
+        !footer.every(previewRecord))
+        return undefined;
+    const sections = previewSections(home.sections);
+    const parsedPages = pages.map(previewPage);
+    if (!sections || parsedPages.some((page) => page === undefined))
+        return undefined;
+    return {
+        schemaVersion: 1,
+        templateId: 'standard',
+        settings: settings,
+        branding: branding,
+        contact: contact,
+        seo: seo,
+        literalOverrides: literalOverrides,
+        home: { id: 'home', title: home.title, enabled: home.enabled, sections },
+        pages: parsedPages,
+        navigation,
+        footer,
+    };
+}
+/** The codes a preview frame may report in an `error` message; the parser accepts exactly these. */
+export const STOREFRONT_PREVIEW_PROTOCOL_ERRORS = [
+    'STOREFRONT_PREVIEW_EXPIRED',
+    'STOREFRONT_PREVIEW_REVOKED',
+    'STOREFRONT_PREVIEW_FORBIDDEN',
+    'STOREFRONT_PREVIEW_UNAVAILABLE',
+    'STOREFRONT_DESIGN_INVALID',
+    'STOREFRONT_SCHEMA_UNSUPPORTED',
+];
+const isPreviewProtocolError = (value) => STOREFRONT_PREVIEW_PROTOCOL_ERRORS.includes(value);
+const previewNonempty = (value) => typeof value === 'string' && value.length > 0;
+const previewSequence = (value) => Number.isSafeInteger(value) && value >= 0;
+const previewKeys = (input, keys) => Object.keys(input).every((key) => keys.includes(key));
+function parsePreviewBind(input, base) {
+    if (!previewKeys(input, [
+        'v',
+        'type',
+        'nonce',
+        'sequence',
+        'grant',
+        'draftRevision',
+        'document',
+        'viewport',
+        'appearance',
+    ]) ||
+        !previewSequence(input.sequence) ||
+        !previewNonempty(input.grant) ||
+        !previewNonempty(input.draftRevision) ||
+        (input.viewport !== 'desktop' && input.viewport !== 'mobile') ||
+        (input.appearance !== 'light' && input.appearance !== 'dark' && input.appearance !== 'system'))
+        return undefined;
+    const document = input.document === undefined ? undefined : parseStorefrontPreviewDocument(input.document);
+    if (input.document !== undefined && !document)
+        return undefined;
+    return {
+        ...base,
+        type: 'bind',
+        sequence: input.sequence,
+        grant: input.grant,
+        draftRevision: input.draftRevision,
+        viewport: input.viewport,
+        appearance: input.appearance,
+        ...(document ? { document } : {}),
+    };
+}
+function parsePreviewSequenced(input, base) {
+    if (!previewSequence(input.sequence))
+        return undefined;
+    const sequence = input.sequence;
+    switch (input.type) {
+        case 'update': {
+            if (!previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'document']))
+                return undefined;
+            const document = parseStorefrontPreviewDocument(input.document);
+            return document ? { ...base, type: 'update', sequence, document } : undefined;
+        }
+        case 'ack':
+            return previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'draftRevision']) &&
+                previewNonempty(input.draftRevision)
+                ? { ...base, type: 'ack', sequence, draftRevision: input.draftRevision }
+                : undefined;
+        case 'error':
+            return previewKeys(input, ['v', 'type', 'nonce', 'sequence', 'code']) && isPreviewProtocolError(input.code)
+                ? { ...base, type: 'error', sequence, code: input.code }
+                : undefined;
+        default:
+            return undefined;
+    }
+}
+/** Does not authenticate the grant. Keep it in memory and post only to the exact configured target origin. */
+export function parseStorefrontPreviewMessage(input) {
+    if (!previewRecord(input) ||
+        input.v !== 1 ||
+        !previewNonempty(input.nonce) ||
+        !previewWithinBytes(input, STOREFRONT_DESIGN_LIMITS.previewMessageBytes))
+        return undefined;
+    const base = { v: 1, nonce: input.nonce };
+    if (input.type === 'ready')
+        return previewKeys(input, ['v', 'type', 'nonce']) ? { ...base, type: 'ready' } : undefined;
+    if (input.type === 'bind')
+        return parsePreviewBind(input, base);
+    return parsePreviewSequenced(input, base);
+}
+/** Start at sequence -1; ready is accepted only before sequenced messages. Advance after accepting. */
+export function acceptStorefrontPreviewMessage(event, binding) {
+    if (event.origin !== binding.origin || binding.source == null || event.source !== binding.source)
+        return undefined;
+    const message = parseStorefrontPreviewMessage(event.data);
+    if (!message || message.nonce !== binding.nonce)
+        return undefined;
+    if (message.type === 'ready')
+        return binding.sequence === -1 ? message : undefined;
+    return message.sequence > binding.sequence ? message : undefined;
+}

package/package.json

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