platform-types 1.10.675 → 1.10.676

package/dist/storefrontDesign.d.ts

@@ -0,0 +1,331 @@
+export declare const STOREFRONT_DESIGN_LIMITS: {
+    readonly customPages: 20;
+    readonly sectionsPerPage: 10;
+    readonly productCountMin: 4;
+    readonly productCountMax: 24;
+    readonly productCountDefault: 8;
+    readonly navigationTopLevel: 12;
+    readonly navigationChildren: 8;
+    readonly navigationTotal: 40;
+    readonly footerGroups: 4;
+    readonly footerLinks: 8;
+    readonly faqs: 20;
+    readonly benefits: 8;
+    readonly historyEntries: 20;
+    readonly documentBytes: number;
+    readonly heading: 120;
+    readonly label: 80;
+    readonly body: 4000;
+    readonly slug: 80;
+    readonly seoTitle: 120;
+    readonly seoDescription: 320;
+    readonly imageAlt: 250;
+    readonly activeImages: 200;
+    readonly imageDecodedBytes: number;
+    readonly imagePixels: 32000000;
+    readonly imageDimension: 8000;
+    readonly previewSeconds: number;
+    readonly fieldErrors: 100;
+    readonly fieldErrorPath: 240;
+    readonly contactAddress: 500;
+    readonly contactNote: 200;
+    readonly contactHours: 14;
+    readonly contactSocials: 8;
+    readonly contactEmail: 254;
+};
+export declare const STOREFRONT_SECTION_TYPES: readonly ["banner", "imageText", "products", "categories", "brands", "text", "faq", "benefits", "contact", "paymentDelivery"];
+export declare const STOREFRONT_BUILTIN_DESTINATIONS: readonly ["home", "catalogue", "offers", "new", "search", "cart", "account", "privacy", "terms"];
+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"];
+export declare const STOREFRONT_BENEFIT_ICONS: readonly ["truck", "shield", "credit-card", "store", "heart", "check"];
+export declare const STOREFRONT_SOCIAL_HOSTS: {
+    readonly instagram: readonly ["instagram.com", "www.instagram.com"];
+    readonly facebook: readonly ["facebook.com", "www.facebook.com"];
+    readonly youtube: readonly ["youtube.com", "www.youtube.com", "youtu.be", "www.youtu.be"];
+    readonly tiktok: readonly ["tiktok.com", "www.tiktok.com"];
+    readonly linkedin: readonly ["linkedin.com", "www.linkedin.com"];
+    readonly x: readonly ["x.com", "www.x.com"];
+};
+export declare function createStorefrontDesignV1(): StorefrontDesignV1;
+declare global {
+    type StorefrontDesignSectionType = (typeof STOREFRONT_SECTION_TYPES)[number];
+    type StorefrontContactField = (typeof STOREFRONT_CONTACT_FIELDS)[number];
+    type StorefrontDesignProductSource = {
+        kind: 'offers' | 'new';
+    } | {
+        kind: 'category' | 'brand' | 'collection';
+        id: string;
+    };
+    type StorefrontDesignLinkTarget = {
+        kind: 'builtin';
+        id: (typeof STOREFRONT_BUILTIN_DESTINATIONS)[number];
+    } | {
+        kind: 'page' | 'category' | 'brand' | 'collection';
+        id: string;
+    } | {
+        kind: 'external';
+        url: string;
+    } | {
+        kind: 'contact';
+        field: StorefrontContactField;
+    };
+    interface StorefrontDesignImagePlacement {
+        assetId: string;
+        mobileAssetId?: string;
+        alt?: string;
+        decorative: boolean;
+        focalPoint?: {
+            x: number;
+            y: number;
+        };
+    }
+    interface StorefrontDesignAction {
+        label?: string;
+        target?: StorefrontDesignLinkTarget;
+    }
+    interface StorefrontDesignSectionContent {
+        banner: {
+            image?: StorefrontDesignImagePlacement;
+            heading?: string;
+            body?: string;
+            action?: StorefrontDesignAction;
+        };
+        imageText: {
+            image?: StorefrontDesignImagePlacement;
+            heading?: string;
+            body?: string;
+            imagePosition?: 'left' | 'right';
+            action?: StorefrontDesignAction;
+        };
+        products: {
+            source?: StorefrontDesignProductSource;
+            layout?: 'row' | 'grid';
+            count?: number;
+            heading?: string;
+        };
+        categories: {
+            source?: {
+                kind: 'roots';
+            } | {
+                kind: 'selected';
+                ids: string[];
+            };
+            heading?: string;
+        };
+        brands: {
+            source?: {
+                kind: 'all';
+            } | {
+                kind: 'selected';
+                ids: string[];
+            };
+            heading?: string;
+        };
+        text: {
+            heading?: string;
+            body?: string;
+        };
+        faq: {
+            heading?: string;
+            items?: {
+                question?: string;
+                answer?: string;
+            }[];
+        };
+        benefits: {
+            heading?: string;
+            items?: {
+                title?: string;
+                body?: string;
+                icon?: (typeof STOREFRONT_BENEFIT_ICONS)[number];
+            }[];
+        };
+        contact: {
+            heading?: string;
+            fields?: StorefrontContactField[];
+        };
+        paymentDelivery: {
+            heading?: string;
+            body?: string;
+            showPayments?: boolean;
+            showDelivery?: boolean;
+        };
+    }
+    type StorefrontDesignSection = {
+        [K in StorefrontDesignSectionType]: {
+            id: string;
+            type: K;
+            enabled: boolean;
+            content: StorefrontDesignSectionContent[K];
+        };
+    }[StorefrontDesignSectionType];
+    interface StorefrontDesignSeo {
+        title?: string;
+        description?: string;
+        image?: StorefrontDesignImagePlacement;
+    }
+    interface StorefrontDesignPage {
+        id: string;
+        slug: string;
+        title: string;
+        enabled: boolean;
+        seo?: StorefrontDesignSeo;
+        sections: StorefrontDesignSection[];
+    }
+    interface StorefrontDesignHome {
+        id: 'home';
+        title: string;
+        enabled: boolean;
+        sections: StorefrontDesignSection[];
+    }
+    interface StorefrontDesignMenuLink {
+        id: string;
+        label?: string;
+        target?: StorefrontDesignLinkTarget;
+    }
+    interface StorefrontDesignNavigationEntry extends StorefrontDesignMenuLink {
+        children?: StorefrontDesignMenuLink[];
+    }
+    interface StorefrontDesignFooterGroup {
+        id: string;
+        title?: string;
+        links: StorefrontDesignMenuLink[];
+    }
+    interface StorefrontContactHours {
+        rows: {
+            days: number[];
+            opens: string;
+            closes: string;
+        }[];
+        note?: string;
+    }
+    interface StorefrontContactSocial {
+        kind: keyof typeof STOREFRONT_SOCIAL_HOSTS;
+        url: string;
+    }
+    interface StorefrontDesignContactValues {
+        email: string;
+        phone: string;
+        whatsapp: string;
+        address: string;
+        hours: StorefrontContactHours;
+        socials: StorefrontContactSocial[];
+    }
+    type StorefrontDesignContact = {
+        [K in StorefrontContactField]?: {
+            visible: boolean;
+            value: StorefrontDesignContactValues[K];
+        };
+    };
+    interface StorefrontDesignV1 {
+        schemaVersion: 1;
+        templateId: 'standard';
+        settings: Partial<StorefrontDesignSettings>;
+        branding: {
+            logo?: StorefrontDesignImagePlacement;
+        };
+        home: StorefrontDesignHome;
+        pages: StorefrontDesignPage[];
+        navigation: StorefrontDesignNavigationEntry[];
+        footer: StorefrontDesignFooterGroup[];
+        contact: StorefrontDesignContact;
+        seo: StorefrontDesignSeo;
+        literalOverrides: Record<string, string>;
+    }
+    type StorefrontDesignFieldErrorCode = 'INVALID' | 'REQUIRED' | 'UNKNOWN_KEY' | 'DUPLICATE' | 'RESERVED_SLUG' | 'DANGLING_REFERENCE' | 'MAPPING_CONFLICT' | 'TOO_LARGE';
+    interface StorefrontDesignFieldError {
+        path: string;
+        code: StorefrontDesignFieldErrorCode;
+    }
+    type StorefrontDesignErrorCode = 'STOREFRONT_DESIGN_INVALID' | 'STOREFRONT_SCHEMA_UNSUPPORTED' | 'STOREFRONT_REVISION_CONFLICT' | 'STOREFRONT_REQUEST_EXPIRED' | '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 {
+        document: StorefrontDesignV1;
+        mappingConflicts: StorefrontDesignMappingConflict[];
+        legacySourceRevision: string;
+        legacyLogo?: {
+            source: 'store.photoURL';
+            key: string;
+        };
+    }
+    type StorefrontDesignParseResult = {
+        success: true;
+        document: StorefrontDesignV1;
+        fieldErrors: StorefrontDesignFieldError[];
+    } | {
+        success: false;
+        error: StorefrontDesignErrorCode;
+        fieldErrors: StorefrontDesignFieldError[];
+    };
+    interface StorefrontDesignRevisionInput {
+        requestId: string;
+        expectedDraftRevision: string | null;
+        expectedPublishedRevision: string | null;
+    }
+    type StorefrontDesignSaveInput = StorefrontDesignRevisionInput & {
+        document: StorefrontDesignV1;
+    };
+    type StorefrontDesignRestoreInput = StorefrontDesignRevisionInput & {
+        publicationId: string;
+    };
+    type StorefrontDesignPublishInput = StorefrontDesignRevisionInput;
+    type StorefrontDesignDiscardInput = StorefrontDesignRevisionInput;
+    interface StorefrontDesignPreviewInput {
+        draftRevision: string;
+    }
+    interface StorefrontDesignDraftResult {
+        draftRevision: string;
+        publishedRevision: string | null;
+        document: StorefrontDesignV1;
+        dirty: boolean;
+        mappingConflicts: StorefrontDesignMappingConflict[];
+    }
+    interface StorefrontDesignDeliveryTarget {
+        targetId: string;
+        state: 'pending' | 'retrying' | 'completed' | 'notProvisioned';
+        providerOperationId?: string;
+    }
+    interface StorefrontDesignPublishResult {
+        publicationId: string;
+        committedRevision: string;
+        draftRevision: string;
+        delivery: {
+            state: 'refreshPending' | 'retrying' | 'providerCompleted' | 'notProvisioned';
+            targets: StorefrontDesignDeliveryTarget[];
+        };
+    }
+    interface StorefrontDesignPreviewResult {
+        grant: string;
+        previewOrigin: string;
+        draftRevision: string;
+        expiresAt: string;
+        protocolVersion: 1;
+    }
+    type StorefrontDesignFailure = {
+        message: string;
+        error: 'STOREFRONT_REVISION_CONFLICT';
+        draftRevision: string | null;
+        publishedRevision: string | null;
+    } | {
+        message: string;
+        error: Exclude<StorefrontDesignErrorCode, 'STOREFRONT_REVISION_CONFLICT'>;
+        fieldErrors?: StorefrontDesignFieldError[];
+    };
+    type StorefrontDesignDraftResponse = {
+        message: string;
+        data: StorefrontDesignDraftResult;
+    } | StorefrontDesignFailure;
+    type StorefrontDesignPublishResponse = {
+        message: string;
+        data: StorefrontDesignPublishResult;
+    } | StorefrontDesignFailure;
+    type StorefrontDesignPreviewResponse = {
+        message: string;
+        data: StorefrontDesignPreviewResult;
+    } | StorefrontDesignFailure;
+}
+export {};

package/dist/storefrontDesign.js

@@ -0,0 +1,114 @@
+export const STOREFRONT_DESIGN_LIMITS = {
+    customPages: 20,
+    sectionsPerPage: 10,
+    productCountMin: 4,
+    productCountMax: 24,
+    productCountDefault: 8,
+    navigationTopLevel: 12,
+    navigationChildren: 8,
+    navigationTotal: 40,
+    footerGroups: 4,
+    footerLinks: 8,
+    faqs: 20,
+    benefits: 8,
+    historyEntries: 20,
+    documentBytes: 256 * 1024,
+    heading: 120,
+    label: 80,
+    body: 4000,
+    slug: 80,
+    seoTitle: 120,
+    seoDescription: 320,
+    imageAlt: 250,
+    activeImages: 200,
+    imageDecodedBytes: 4 * 1024 * 1024,
+    imagePixels: 32_000_000,
+    imageDimension: 8000,
+    previewSeconds: 15 * 60,
+    fieldErrors: 100,
+    fieldErrorPath: 240,
+    contactAddress: 500,
+    contactNote: 200,
+    contactHours: 14,
+    contactSocials: 8,
+    contactEmail: 254,
+};
+export const STOREFRONT_SECTION_TYPES = [
+    'banner',
+    'imageText',
+    'products',
+    'categories',
+    'brands',
+    'text',
+    'faq',
+    'benefits',
+    'contact',
+    'paymentDelivery',
+];
+export const STOREFRONT_BUILTIN_DESTINATIONS = [
+    'home',
+    'catalogue',
+    'offers',
+    'new',
+    'search',
+    'cart',
+    'account',
+    'privacy',
+    'terms',
+];
+export const STOREFRONT_CONTACT_FIELDS = ['email', 'phone', 'whatsapp', 'address', 'hours', 'socials'];
+export const STOREFRONT_RESERVED_SLUGS = [
+    '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',
+];
+export const STOREFRONT_BENEFIT_ICONS = ['truck', 'shield', 'credit-card', 'store', 'heart', 'check'];
+export const STOREFRONT_SOCIAL_HOSTS = {
+    instagram: ['instagram.com', 'www.instagram.com'],
+    facebook: ['facebook.com', 'www.facebook.com'],
+    youtube: ['youtube.com', 'www.youtube.com', 'youtu.be', 'www.youtu.be'],
+    tiktok: ['tiktok.com', 'www.tiktok.com'],
+    linkedin: ['linkedin.com', 'www.linkedin.com'],
+    x: ['x.com', 'www.x.com'],
+};
+export function createStorefrontDesignV1() {
+    return {
+        schemaVersion: 1,
+        templateId: 'standard',
+        settings: {},
+        branding: {},
+        home: { id: 'home', title: 'Home', enabled: true, sections: [] },
+        pages: [],
+        navigation: [],
+        footer: [],
+        contact: {},
+        seo: {},
+        literalOverrides: {},
+    };
+}