platform-types 1.10.753 → 1.10.754

package/dist/cjs/storefrontDesign.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STOREFRONT_PREVIEW_PROTOCOL_ERRORS = exports.STOREFRONT_PREVIEW_READ_OPERATIONS = exports.STOREFRONT_BENEFIT_ICONS = exports.STOREFRONT_RESERVED_SLUGS = exports.STOREFRONT_CONTACT_FIELDS = exports.STOREFRONT_PROTECTED_BUILTIN_DESTINATIONS = exports.STOREFRONT_BUILTIN_DESTINATIONS = exports.STOREFRONT_REPEATABLE_SECTION_TYPES = exports.STOREFRONT_SECTION_TYPES = exports.isStorefrontPageSlug = exports.STOREFRONT_PAGE_SLUG_RE = exports.STOREFRONT_DESIGN_LIMITS = exports.STOREFRONT_SOCIAL_HOSTS = void 0;
+exports.STOREFRONT_PREVIEW_PROTOCOL_ERRORS = exports.STOREFRONT_PREVIEW_READ_OPERATIONS = exports.STOREFRONT_DESIGN_AUDIENCES = exports.STOREFRONT_BENEFIT_ICONS = exports.STOREFRONT_RESERVED_SLUGS = exports.STOREFRONT_CONTACT_FIELDS = exports.STOREFRONT_PROTECTED_BUILTIN_DESTINATIONS = exports.STOREFRONT_BUILTIN_DESTINATIONS = exports.STOREFRONT_REPEATABLE_SECTION_TYPES = exports.STOREFRONT_SECTION_TYPES = exports.isStorefrontPageSlug = exports.STOREFRONT_PAGE_SLUG_RE = exports.STOREFRONT_DESIGN_LIMITS = exports.STOREFRONT_SOCIAL_HOSTS = void 0;
 exports.createStorefrontDesignV1 = createStorefrontDesignV1;
 exports.parseStorefrontPreviewDocument = parseStorefrontPreviewDocument;
 exports.parseStorefrontPreviewMessage = parseStorefrontPreviewMessage;
@@ -37,6 +37,8 @@ exports.STOREFRONT_DESIGN_LIMITS = {
     benefits: 8,
     historyEntries: 20,
     selectedSourceIds: 50,
+    /** A `visibility` rule's `priceLists`: the store's own cap on price lists. */
+    visibilityPriceLists: 64,
     documentBytes: 256 * 1024,
     heading: 120,
     label: 80,
@@ -168,6 +170,12 @@ exports.STOREFRONT_RESERVED_SLUGS = [
     'mantenimiento',
 ];
 exports.STOREFRONT_BENEFIT_ICONS = ['truck', 'shield', 'credit-card', 'store', 'heart', 'check'];
+/**
+ * Who a `visibility` rule may name. `guest`: no approved customer resolved. `customer`: any
+ * approved customer. `retail` / `wholesale`: an approved customer whose list's `audienceClass`
+ * is that class, an absent class meaning `retail`.
+ */
+exports.STOREFRONT_DESIGN_AUDIENCES = ['guest', 'customer', 'retail', 'wholesale'];
 function createStorefrontDesignV1() {
     return {
         schemaVersion: 1,
@@ -232,6 +240,29 @@ function previewWithinBytes(value, maximum) {
         return false;
     }
 }
+/**
+ * A `visibility` rule kept on the transport only when well-formed: known audiences, and integer
+ * price lists within the store cap. Anything else is left off rather than failing the frame — the
+ * preview never filters by it, it only shows the rule the editor authored.
+ */
+function previewVisibility(input) {
+    if (!previewRecord(input) || !Array.isArray(input.audiences))
+        return {};
+    const { audiences, priceLists } = input;
+    if (!audiences.every((entry) => exports.STOREFRONT_DESIGN_AUDIENCES.includes(entry)))
+        return {};
+    if (priceLists !== undefined &&
+        (!Array.isArray(priceLists) ||
+            priceLists.length > exports.STOREFRONT_DESIGN_LIMITS.visibilityPriceLists ||
+            !priceLists.every((entry) => Number.isInteger(entry))))
+        return {};
+    return {
+        visibility: {
+            audiences: [...audiences],
+            ...(priceLists === undefined ? {} : { priceLists: [...priceLists] }),
+        },
+    };
+}
 function previewSections(input) {
     if (!Array.isArray(input) || input.length > exports.STOREFRONT_DESIGN_LIMITS.sectionsPerPage)
         return undefined;
@@ -248,6 +279,7 @@ function previewSections(input) {
             type: entry.type,
             enabled: entry.enabled,
             content: entry.content,
+            ...previewVisibility(entry.visibility),
         });
     }
     return sections;
@@ -270,6 +302,7 @@ function previewPage(input) {
         enabled: input.enabled,
         sections,
         ...(input.seo === undefined ? {} : { seo: input.seo }),
+        ...previewVisibility(input.visibility),
     };
 }
 /** Checks transport structure and UTF-8 size; unfamiliar section types are skipped, never rendered. */

package/dist/storefrontDesign.d.ts

@@ -31,6 +31,8 @@ export declare const STOREFRONT_DESIGN_LIMITS: {
     readonly benefits: 8;
     readonly historyEntries: 20;
     readonly selectedSourceIds: 50;
+    /** A `visibility` rule's `priceLists`: the store's own cap on price lists. */
+    readonly visibilityPriceLists: 64;
     readonly documentBytes: number;
     readonly heading: 120;
     readonly label: 80;
@@ -91,6 +93,12 @@ export declare const STOREFRONT_PROTECTED_BUILTIN_DESTINATIONS: readonly ["searc
 export declare const STOREFRONT_CONTACT_FIELDS: readonly ["email", "phone", "whatsapp", "address", "hours", "socials"];
 export declare const STOREFRONT_RESERVED_SLUGS: readonly ["home", "index", "api", "auth", "login", "logout", "account", "cart", "checkout", "orders", "search", "products", "product", "producto", "coleccion", "categories", "brands", "sale", "new", "privacy", "terms", "sitemap", "robots", "manifest", "assets", "preview", "admin", "storefront", "pagina", "basket", "profile", "favorites", "invoices", "payments", "payment-methods", "user", "mantenimiento"];
 export declare const STOREFRONT_BENEFIT_ICONS: readonly ["truck", "shield", "credit-card", "store", "heart", "check"];
+/**
+ * Who a `visibility` rule may name. `guest`: no approved customer resolved. `customer`: any
+ * approved customer. `retail` / `wholesale`: an approved customer whose list's `audienceClass`
+ * is that class, an absent class meaning `retail`.
+ */
+export declare const STOREFRONT_DESIGN_AUDIENCES: readonly ["guest", "customer", "retail", "wholesale"];
 export declare function createStorefrontDesignV1(): StorefrontDesignV1;
 declare global {
     type StorefrontDesignSectionType = (typeof STOREFRONT_SECTION_TYPES)[number];
@@ -202,12 +210,27 @@ declare global {
             showDelivery?: boolean;
         };
     }
+    type StorefrontDesignAudience = (typeof STOREFRONT_DESIGN_AUDIENCES)[number];
+    /**
+     * Who sees a section, page, navigation entry (top level or child) or footer link. Absent means
+     * everyone. A caller sees the item when any listed audience matches it, or when its price list
+     * is in `priceLists`. A list deleted after publish matches no one. Carries no `kind` or `id` key,
+     * so the reference and identity walkers pass over it.
+     *
+     * Web `GET /store` filters by it and strips it, marking each item visible through a rule
+     * `audienceScoped: true`. The private preview is not filtered and carries it as authored.
+     */
+    interface StorefrontDesignVisibility {
+        audiences: StorefrontDesignAudience[];
+        priceLists?: number[];
+    }
     type StorefrontDesignSection = {
         [K in StorefrontDesignSectionType]: {
             id: string;
             type: K;
             enabled: boolean;
             content: StorefrontDesignSectionContent[K];
+            visibility?: StorefrontDesignVisibility;
         };
     }[StorefrontDesignSectionType];
     interface StorefrontDesignPublicationMetadata {
@@ -227,6 +250,7 @@ declare global {
         enabled: boolean;
         seo?: StorefrontDesignSeo;
         sections: StorefrontDesignSection[];
+        visibility?: StorefrontDesignVisibility;
     }
     interface StorefrontDesignHome {
         id: 'home';
@@ -238,6 +262,7 @@ declare global {
         id: string;
         label?: string;
         target?: StorefrontDesignLinkTarget;
+        visibility?: StorefrontDesignVisibility;
     }
     interface StorefrontDesignNavigationEntry extends StorefrontDesignMenuLink {
         children?: StorefrontDesignMenuLink[];
@@ -305,6 +330,10 @@ declare global {
      * 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.
+     *
+     * An item that can carry `visibility` (section, page, navigation entry, footer link) may also
+     * carry `audienceScoped: true`: web `GET /store` sets it on an item it returned because the
+     * caller matched that item's rule, and strips every `visibility`. The preview never sets it.
      */
     type PublicStorefrontDesignValue<T> = T extends StorefrontDesignImagePlacement ? T & {
         url: string;
@@ -314,7 +343,11 @@ declare global {
         id: string;
     } ? T & {
         slug: string;
-    } : T extends readonly (infer V)[] ? PublicStorefrontDesignValue<V>[] : T extends object ? {
+    } : T extends readonly (infer V)[] ? PublicStorefrontDesignValue<V>[] : T extends object ? 'visibility' extends keyof T ? {
+        [K in keyof T]: PublicStorefrontDesignValue<T[K]>;
+    } & {
+        audienceScoped?: true;
+    } : {
         [K in keyof T]: PublicStorefrontDesignValue<T[K]>;
     } : T;
     type PublicStorefrontDesign = PublicStorefrontDesignValue<Omit<StorefrontDesignPublic, 'literalOverrides'>>;
@@ -351,7 +384,9 @@ declare global {
      * At `<page>.sections.<index>.type`, `DUPLICATE` is a second section of a once-per-page type and
      * `SECTION_TYPE_LIMIT` is a section past `repeatableSectionsPerType` of a repeatable type.
      */
-    type StorefrontDesignFieldErrorCode = 'INVALID' | 'REQUIRED' | 'UNKNOWN_KEY' | 'DUPLICATE' | 'SECTION_TYPE_LIMIT' | 'RESERVED_SLUG' | 'ALIAS_CONFLICT' | 'ALIAS_LIMIT' | 'DANGLING_REFERENCE' | 'MAPPING_CONFLICT' | 'TOO_LARGE';
+    type StorefrontDesignFieldErrorCode = 'INVALID' | 'REQUIRED' | 'UNKNOWN_KEY' | 'DUPLICATE' | 'SECTION_TYPE_LIMIT' | 'RESERVED_SLUG' | 'ALIAS_CONFLICT' | 'ALIAS_LIMIT' | 'DANGLING_REFERENCE' | 'MAPPING_CONFLICT' | 'TOO_LARGE'
+    /** A `visibility.priceLists` entry naming no list of the store's `priceLists`; refused on draft save. */
+     | 'UNKNOWN_PRICE_LIST';
     interface StorefrontDesignFieldError {
         path: string;
         code: StorefrontDesignFieldErrorCode;
@@ -667,6 +702,8 @@ declare global {
         type: StorefrontDesignSectionType;
         enabled: boolean;
         content: Record<string, unknown>;
+        /** Carried as authored when well-formed, as navigation and footer entries carry theirs; never applied. */
+        visibility?: StorefrontDesignVisibility;
     }
     interface StorefrontPreviewDocument {
         schemaVersion: 1;
@@ -686,6 +723,7 @@ declare global {
             enabled: boolean;
             sections: StorefrontPreviewSection[];
             seo?: object;
+            visibility?: StorefrontDesignVisibility;
         }[];
         navigation: object[];
         footer: object[];

package/dist/storefrontDesign.js

@@ -30,6 +30,8 @@ export const STOREFRONT_DESIGN_LIMITS = {
     benefits: 8,
     historyEntries: 20,
     selectedSourceIds: 50,
+    /** A `visibility` rule's `priceLists`: the store's own cap on price lists. */
+    visibilityPriceLists: 64,
     documentBytes: 256 * 1024,
     heading: 120,
     label: 80,
@@ -160,6 +162,12 @@ export const STOREFRONT_RESERVED_SLUGS = [
     'mantenimiento',
 ];
 export const STOREFRONT_BENEFIT_ICONS = ['truck', 'shield', 'credit-card', 'store', 'heart', 'check'];
+/**
+ * Who a `visibility` rule may name. `guest`: no approved customer resolved. `customer`: any
+ * approved customer. `retail` / `wholesale`: an approved customer whose list's `audienceClass`
+ * is that class, an absent class meaning `retail`.
+ */
+export const STOREFRONT_DESIGN_AUDIENCES = ['guest', 'customer', 'retail', 'wholesale'];
 export function createStorefrontDesignV1() {
     return {
         schemaVersion: 1,
@@ -224,6 +232,29 @@ function previewWithinBytes(value, maximum) {
         return false;
     }
 }
+/**
+ * A `visibility` rule kept on the transport only when well-formed: known audiences, and integer
+ * price lists within the store cap. Anything else is left off rather than failing the frame — the
+ * preview never filters by it, it only shows the rule the editor authored.
+ */
+function previewVisibility(input) {
+    if (!previewRecord(input) || !Array.isArray(input.audiences))
+        return {};
+    const { audiences, priceLists } = input;
+    if (!audiences.every((entry) => STOREFRONT_DESIGN_AUDIENCES.includes(entry)))
+        return {};
+    if (priceLists !== undefined &&
+        (!Array.isArray(priceLists) ||
+            priceLists.length > STOREFRONT_DESIGN_LIMITS.visibilityPriceLists ||
+            !priceLists.every((entry) => Number.isInteger(entry))))
+        return {};
+    return {
+        visibility: {
+            audiences: [...audiences],
+            ...(priceLists === undefined ? {} : { priceLists: [...priceLists] }),
+        },
+    };
+}
 function previewSections(input) {
     if (!Array.isArray(input) || input.length > STOREFRONT_DESIGN_LIMITS.sectionsPerPage)
         return undefined;
@@ -240,6 +271,7 @@ function previewSections(input) {
             type: entry.type,
             enabled: entry.enabled,
             content: entry.content,
+            ...previewVisibility(entry.visibility),
         });
     }
     return sections;
@@ -262,6 +294,7 @@ function previewPage(input) {
         enabled: input.enabled,
         sections,
         ...(input.seo === undefined ? {} : { seo: input.seo }),
+        ...previewVisibility(input.visibility),
     };
 }
 /** Checks transport structure and UTF-8 size; unfamiliar section types are skipped, never rendered. */

package/package.json

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