@modainteract/moda-interact-shared 5.5.0 → 5.7.0

package/dist/commerce/presentation/index.d.ts

@@ -0,0 +1,420 @@
+import * as zod from 'zod';
+import { z } from 'zod';
+import { ModaSupportedLanguageTag, IcuMessageCatalogue, InternationalizationRuntime } from '../../internationalization.js';
+import { Y as CommerceShippingInformation, d as CommerceFinalResponse } from '../../response-DFDEw4K0.js';
+import 'intl-messageformat';
+
+declare const CommerceVerifiedPresentationSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    brandName: z.ZodNullable<z.ZodString>;
+    locale: z.ZodEnum<{
+        tr: "tr";
+        "zh-Hans": "zh-Hans";
+        "zh-Hant": "zh-Hant";
+        cs: "cs";
+        da: "da";
+        nl: "nl";
+        en: "en";
+        fi: "fi";
+        fr: "fr";
+        de: "de";
+        it: "it";
+        ja: "ja";
+        ko: "ko";
+        nb: "nb";
+        pl: "pl";
+        "pt-BR": "pt-BR";
+        "pt-PT": "pt-PT";
+        es: "es";
+        sv: "sv";
+        th: "th";
+    }>;
+    disposition: z.ZodEnum<{
+        STANDARD: "STANDARD";
+        OUT_OF_SCOPE_REDIRECT: "OUT_OF_SCOPE_REDIRECT";
+        SHIPPING_INFORMATION_UNVERIFIED: "SHIPPING_INFORMATION_UNVERIFIED";
+        PRODUCT_OPTIONS: "PRODUCT_OPTIONS";
+        PRODUCT_DETAILS: "PRODUCT_DETAILS";
+    }>;
+    storeUrl: z.ZodString;
+    products: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        url: z.ZodString;
+        quantity: z.ZodNumber;
+        scope: z.ZodEnum<{
+            PRODUCT_ONLY: "PRODUCT_ONLY";
+            ADD_TO_BASKET: "ADD_TO_BASKET";
+            REPLACE_BASKET_LINE: "REPLACE_BASKET_LINE";
+        }>;
+        currentPrice: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<z.ZodString>;
+        regularPrice: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        offerTerms: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            kind: z.ZodEnum<{
+                percent: "percent";
+                amount: "amount";
+                "free-shipping": "free-shipping";
+            }>;
+            value: z.ZodOptional<z.ZodString>;
+            currency: z.ZodOptional<z.ZodString>;
+            code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            automatic: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>;
+    productFacts: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        variantId: z.ZodNullable<z.ZodString>;
+        title: z.ZodString;
+        description: z.ZodObject<{
+            status: z.ZodEnum<{
+                AVAILABLE: "AVAILABLE";
+                NOT_PROVIDED: "NOT_PROVIDED";
+                PARTIAL: "PARTIAL";
+            }>;
+            text: z.ZodString;
+        }, z.core.$strict>;
+        attributes: z.ZodObject<{
+            status: z.ZodEnum<{
+                AVAILABLE: "AVAILABLE";
+                NOT_PROVIDED: "NOT_PROVIDED";
+                PARTIAL: "PARTIAL";
+            }>;
+            items: z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                values: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>;
+        options: z.ZodPreprocess<z.ZodObject<{
+            status: z.ZodEnum<{
+                AVAILABLE: "AVAILABLE";
+                NOT_PROVIDED: "NOT_PROVIDED";
+                PARTIAL: "PARTIAL";
+            }>;
+            items: z.ZodArray<z.ZodObject<{
+                name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+                values: z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>>;
+                usedForVariants: z.ZodNullable<z.ZodBoolean>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        selectedOptions: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+            name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+            value: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>>;
+    optionFacts: z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        variantId: z.ZodNullable<z.ZodString>;
+        title: z.ZodString;
+        options: z.ZodPreprocess<z.ZodObject<{
+            status: z.ZodEnum<{
+                AVAILABLE: "AVAILABLE";
+                NOT_PROVIDED: "NOT_PROVIDED";
+                PARTIAL: "PARTIAL";
+            }>;
+            items: z.ZodArray<z.ZodObject<{
+                name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+                values: z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>>;
+                usedForVariants: z.ZodNullable<z.ZodBoolean>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        selectedOptions: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+            name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+            value: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>;
+    requiresShipping: z.ZodNullable<z.ZodBoolean>;
+    policyUrl: z.ZodNullable<z.ZodString>;
+    includeNoVerifiedOffer: z.ZodBoolean;
+}, z.core.$strict>;
+type CommerceVerifiedPresentation = z.input<typeof CommerceVerifiedPresentationSchema>;
+
+declare const CommerceOptionFactSchema: z.ZodObject<{
+    productId: z.ZodString;
+    variantId: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    options: z.ZodPreprocess<z.ZodObject<{
+        status: z.ZodEnum<{
+            AVAILABLE: "AVAILABLE";
+            NOT_PROVIDED: "NOT_PROVIDED";
+            PARTIAL: "PARTIAL";
+        }>;
+        items: z.ZodArray<z.ZodObject<{
+            name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+            values: z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>>;
+            usedForVariants: z.ZodNullable<z.ZodBoolean>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    selectedOptions: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+        name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+        value: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+type CommerceOptionFact = z.infer<typeof CommerceOptionFactSchema>;
+declare function verifyCommerceOptionFacts(selection: readonly {
+    productId: string;
+    variantId: string | null;
+}[], currentProducts: readonly unknown[]): {
+    kind: "verified";
+    optionFacts: CommerceOptionFact[];
+} | {
+    kind: "limitation";
+    reason: "INVALID_SELECTION" | "PRODUCT_NOT_FOUND" | "PRODUCT_INVALID";
+};
+declare function renderProductOptionFacts(facts: readonly CommerceOptionFact[], locale: ModaSupportedLanguageTag): string;
+
+declare const productOptionMessages: Readonly<Record<"tr" | "zh-Hans" | "zh-Hant" | "cs" | "da" | "nl" | "en" | "fi" | "fr" | "de" | "it" | "ja" | "ko" | "nb" | "pl" | "pt-BR" | "pt-PT" | "es" | "sv" | "th", readonly [string, string, string]>>;
+
+/** Plain text only. Unbalanced markers and non-HTTPS links remain literal. */
+declare function normalizeCommerceReplyText(value: string): string;
+
+type RenderRecommendationProduct = Readonly<{
+    title: string;
+    url: string;
+    quantity: number;
+    scope: "PRODUCT_ONLY" | "ADD_TO_BASKET" | "REPLACE_BASKET_LINE";
+    currentPrice: string | null;
+    currency: string | null;
+    regularPrice?: string | null;
+    offerTerms?: readonly Readonly<{
+        kind: "percent" | "amount" | "free-shipping";
+        value?: string;
+        currency?: string;
+        code?: string | null;
+        automatic?: boolean;
+    }>[];
+}>;
+declare function renderRecommendationReply(input: {
+    locale: ModaSupportedLanguageTag;
+    disposition: "STANDARD" | "OUT_OF_SCOPE_REDIRECT" | "SHIPPING_INFORMATION_UNVERIFIED";
+    storeUrl: string;
+    policyUrl?: string | null;
+    requiresShipping?: boolean | null;
+    products?: readonly RenderRecommendationProduct[];
+    includeNoVerifiedOffer?: boolean;
+}): string;
+
+declare const recommendationMessageKeys: readonly ["scopeLimit", "shippingUnverified", "shippingRequired", "shippingNotRequired", "policyLink", "storeLink", "productOption", "proposedQuantity", "addProposal", "replaceProposal", "currentPrice", "regularPrice", "percentTerms", "amountTerms", "freeShippingTerms", "code", "automatic", "checkoutQualification", "productLink", "noVerifiedOffer", "optionsUnavailable", "optionsPartial", "optionsSelected"];
+type MessageKey = typeof recommendationMessageKeys[number];
+declare const recommendationMessages: Readonly<Record<ModaSupportedLanguageTag, IcuMessageCatalogue>>;
+declare function recommendationMessage(locale: ModaSupportedLanguageTag, key: MessageKey, values?: Record<string, string | number>): string;
+
+declare function isValidDecimal(value: string): boolean;
+declare function currencyExponent(currency: string): number | null;
+declare function minorUnitsToDecimal(value: bigint, currency: string): string | null;
+declare function decimalToMinorUnits(value: string, currency: string): bigint | null;
+declare function sumPurchaseSubtotal(lines: readonly Readonly<{
+    amountDecimal: string;
+    quantity: number;
+}>[], currency: string): bigint | null;
+declare function formatObservedMoney(value: string, currency: string, runtime: InternationalizationRuntime): string | null;
+
+declare function buildReplyCandidates(input: {
+    fullBody: string;
+    firstProductBody?: string | null;
+    minimalBody: string;
+}): readonly string[];
+
+type ShippingPresentation = Readonly<{
+    requiresShipping: boolean | null;
+    policyUrl: string | null;
+    limitation: boolean;
+}>;
+declare function selectShippingPresentation(input: {
+    selection: Readonly<{
+        productId: string | null;
+        variantId: string | null;
+    }>;
+    observation: CommerceShippingInformation | null;
+    refreshed: CommerceShippingInformation | null;
+}): ShippingPresentation;
+
+/** Pure immutable wrapper projections. Host-owned persistence and sending stay outside Shared. */
+type WrapperSource = "AI" | "HUMAN";
+type WrapperAudience = "SHARED" | WrapperSource;
+type WrapperVariable = "customer.firstName" | "shop.name" | "checkout.url" | "shopBrand.brandName" | "shopBrand.logoUrl" | "shopBrand.logoAltText" | "shopBrand.logoWidth" | "shopBrand.logoHeight" | "shopBrand.squareLogoUrl" | "shopBrand.squareLogoAltText" | "shopBrand.coverImageUrl";
+type PreparedToken = Readonly<{
+    kind: "text";
+    value: string;
+}> | Readonly<{
+    kind: "variable";
+    name: WrapperVariable;
+}> | Readonly<{
+    kind: "responseSlot";
+    name: "response.body";
+}>;
+/** Admin emits this immutable projection in WhatsAppTemplateLocale.localeAst.prepared. */
+type PreparedWrapper = Readonly<{
+    schemaVersion: 1;
+    family: "MODA_CONVERSATION_WRAPPER";
+    responseSlot: "response.body";
+    header: readonly PreparedToken[];
+    body: readonly PreparedToken[];
+    footer: readonly PreparedToken[];
+    conditionals: readonly Readonly<{
+        when: "checkout.available";
+        tokens: readonly PreparedToken[];
+    }>[];
+}>;
+type VerifiedWrapperContext = Readonly<{
+    conversationId: string;
+    shopId: string;
+    conversationLanguageTag: string | null;
+    merchantLanguageTag: string | null;
+    variables: Partial<Record<WrapperVariable, string>>;
+    checkoutAvailable: boolean;
+}>;
+type WrapperDefinition = Readonly<{
+    id: string;
+    kind: string;
+    audience: string | null;
+    status: string;
+    sourceLanguageTag: string;
+    astSchemaVersion: number;
+    sourceHash: string;
+    publishedAt: Date | null;
+    retiredAt: Date | null;
+    createdByAdminId: string;
+    locales: readonly Readonly<{
+        id: string;
+        languageTag: string;
+        status: string;
+        providerLanguageCode: string | null;
+        localeAst: unknown;
+        contentHash: string | null;
+        reviewedAt: Date | null;
+        reviewedByAdminId: string | null;
+    }>[];
+}>;
+type WrapperSlot = Readonly<{
+    audience: string;
+    definitionId: string;
+    editVersion: number;
+    definition: WrapperDefinition;
+}>;
+type WrapperRefusal = "INVALID_INPUT" | "INVALID_LANGUAGE" | "CONVERSATION_UNAVAILABLE" | "TENANT_MISMATCH" | "NOT_CONFIGURED" | "DEFINITION_UNAVAILABLE" | "LOCALE_UNAVAILABLE" | "PREPARED_MISSING" | "PREPARED_INVALID" | "VARIABLE_UNAVAILABLE" | "ALREADY_WRAPPED" | "OUTPUT_TOO_LONG" | "REPLAY_MISMATCH";
+
+/** Admin's documented stable JSON hashing protocol, without importing its AST/compiler. */
+declare function stableJson(value: unknown): string;
+type PresentationDigest = (value: string) => string;
+declare function digest(value: string, sha256: PresentationDigest): string;
+/** Never parse localeAst.authoring. Fail closed if the compiled runtime projection is absent. */
+declare function readPreparedWrapper(localeAst: unknown, contentHash: string | null, sha256: PresentationDigest): {
+    kind: "ok";
+    prepared: PreparedWrapper;
+} | {
+    kind: "missing" | "invalid";
+};
+
+/** WhatsApp plain-text message maximum; reject before moderation and provider calls. */
+declare const MAX_WHATSAPP_TEXT_LENGTH = 4096;
+/** No AST reads, external dependencies, side effects, network, billing or sending. */
+declare function renderPreparedWrapper(input: {
+    prepared: PreparedWrapper;
+    context: VerifiedWrapperContext;
+    responseBody: string;
+}): {
+    kind: "rendered";
+    body: string;
+} | {
+    kind: "rejected";
+    reason: WrapperRefusal;
+};
+
+declare function canonicalTag(value: string | null | undefined): string | null;
+/** Explicit precedence. Invalid override never silently falls back to SHARED. */
+declare function chooseSlot(slots: readonly WrapperSlot[], source: "AI" | "HUMAN"): WrapperSlot | "invalid" | null;
+declare function validDefinition(def: WrapperDefinition, slot: WrapperSlot): boolean;
+declare function languageChoices(input: {
+    conversationTag: string | null;
+    merchantTag: string | null;
+    preferredTag: string | null | undefined;
+    platformFallbackTag: string | null;
+}, onInvalid?: (error: unknown) => void): string[] | "invalid";
+
+type CommerceWhatsAppPreviewInput = {
+    envelope: CommerceFinalResponse;
+    presentation: zod.input<typeof CommerceVerifiedPresentationSchema>;
+    /** Must agree with the host-verified projection. */
+    locale?: string;
+    brandName?: string | null;
+    wrapper?: {
+        slots: readonly WrapperSlot[];
+        context: VerifiedWrapperContext;
+        digest: PresentationDigest;
+        platformFallbackLanguageTag?: string | null;
+        languageTag?: string | null;
+    } | null;
+};
+type CommerceWhatsAppPreviewResult = {
+    kind: "ready";
+    body: string;
+    candidates: readonly string[];
+    wrapper: {
+        definitionId: string;
+        localeId: string;
+        contentHash: string;
+        slotEditVersion: number;
+    } | null;
+} | {
+    kind: "refused";
+    reason: string;
+};
+/** Pure formatting/projection only; never moderation, billing or send admission. */
+declare function composeCommerceWhatsAppPreview(input: CommerceWhatsAppPreviewInput): CommerceWhatsAppPreviewResult;
+
+declare const CommerceProductFactSchema: z.ZodObject<{
+    productId: z.ZodString;
+    variantId: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    description: z.ZodObject<{
+        status: z.ZodEnum<{
+            AVAILABLE: "AVAILABLE";
+            NOT_PROVIDED: "NOT_PROVIDED";
+            PARTIAL: "PARTIAL";
+        }>;
+        text: z.ZodString;
+    }, z.core.$strict>;
+    attributes: z.ZodObject<{
+        status: z.ZodEnum<{
+            AVAILABLE: "AVAILABLE";
+            NOT_PROVIDED: "NOT_PROVIDED";
+            PARTIAL: "PARTIAL";
+        }>;
+        items: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            values: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    options: z.ZodPreprocess<z.ZodObject<{
+        status: z.ZodEnum<{
+            AVAILABLE: "AVAILABLE";
+            NOT_PROVIDED: "NOT_PROVIDED";
+            PARTIAL: "PARTIAL";
+        }>;
+        items: z.ZodArray<z.ZodObject<{
+            name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+            values: z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>>;
+            usedForVariants: z.ZodNullable<z.ZodBoolean>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    selectedOptions: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+        name: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+        value: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodString>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+type CommerceProductFact = z.infer<typeof CommerceProductFactSchema>;
+declare function verifyCommerceProductFacts(selection: readonly {
+    productId: string;
+    variantId: string | null;
+}[], currentProducts: readonly unknown[]): {
+    kind: "verified";
+    productFacts: CommerceProductFact[];
+} | {
+    kind: "limitation";
+    reason: "INVALID_SELECTION" | "PRODUCT_NOT_FOUND" | "PRODUCT_INVALID";
+};
+declare function renderCommerceProductFacts(facts: readonly CommerceProductFact[], locale: ModaSupportedLanguageTag): string;
+
+declare const productFactMessages: Readonly<Record<"tr" | "zh-Hans" | "zh-Hant" | "cs" | "da" | "nl" | "en" | "fi" | "fr" | "de" | "it" | "ja" | "ko" | "nb" | "pl" | "pt-BR" | "pt-PT" | "es" | "sv" | "th", readonly [string, string, string]>>;
+
+export { type CommerceOptionFact, CommerceOptionFactSchema, type CommerceProductFact, CommerceProductFactSchema, type CommerceVerifiedPresentation, CommerceVerifiedPresentationSchema, type CommerceWhatsAppPreviewInput, type CommerceWhatsAppPreviewResult, MAX_WHATSAPP_TEXT_LENGTH, type PreparedToken, type PreparedWrapper, type PresentationDigest, type RenderRecommendationProduct, type ShippingPresentation, type VerifiedWrapperContext, type WrapperAudience, type WrapperDefinition, type WrapperRefusal, type WrapperSlot, type WrapperSource, type WrapperVariable, buildReplyCandidates, canonicalTag, chooseSlot, composeCommerceWhatsAppPreview, currencyExponent, decimalToMinorUnits, digest, formatObservedMoney, isValidDecimal, languageChoices, minorUnitsToDecimal, normalizeCommerceReplyText, productFactMessages, productOptionMessages, readPreparedWrapper, recommendationMessage, recommendationMessageKeys, recommendationMessages, renderCommerceProductFacts, renderPreparedWrapper, renderProductOptionFacts, renderRecommendationReply, selectShippingPresentation, stableJson, sumPurchaseSubtotal, validDefinition, verifyCommerceOptionFacts, verifyCommerceProductFacts };