@kubuild/schema 0.8.1 → 0.8.2

package/dist/tracking.d.cts

@@ -0,0 +1,348 @@
+import { z } from 'zod';
+/**
+ * Supported Tracking Providers
+ */
+export declare const TrackingProviderTypeSchema: z.ZodEnum<{
+    custom: "custom";
+    meta: "meta";
+    google: "google";
+    gtm: "gtm";
+    tiktok: "tiktok";
+}>;
+export type TrackingProviderType = z.infer<typeof TrackingProviderTypeSchema>;
+/**
+ * Metadata-only descriptor of a tracking credential saved by the host (account/workspace).
+ *
+ * This is what the editor receives to render a credential picker. It NEVER carries secret
+ * material (access tokens, API secrets, webhook URLs/headers) — those stay on the host and
+ * are resolved server-side from `id` (see `TrackingSecretResolver` in `@kubuild/core`).
+ */
+export interface PixelCredentialOption {
+    /** Opaque host id, stored in the document as `providers.<provider>.credentialId`. */
+    id: string;
+    /** Human-readable label shown in the picker. */
+    name: string;
+    provider: TrackingProviderType | (string & {});
+    /** Public Meta / TikTok pixel id, if the credential has one. */
+    pixelId?: string;
+    /** Public GA4 measurement id, if the credential has one. */
+    measurementId?: string;
+    /** Public GTM container id, if the credential has one. */
+    containerId?: string;
+    /** True when the host holds a server-side secret for this credential. */
+    hasSecret?: boolean;
+    isActive?: boolean;
+}
+/**
+ * Event Delivery Channels:
+ * - 'both': Fires client browser pixel and dispatches to the server relay (with deduplication event_id)
+ * - 'client_only': Only fires in the browser via client-side pixel scripts
+ * - 'server_only': Only sends to the host server relay (no browser pixel call)
+ */
+export declare const TrackingDeliverySchema: z.ZodEnum<{
+    both: "both";
+    client_only: "client_only";
+    server_only: "server_only";
+}>;
+export type TrackingDelivery = z.infer<typeof TrackingDeliverySchema>;
+/**
+ * Meta (Facebook) Pixel & Conversions API (CAPI) Configuration
+ */
+export declare const MetaTrackingProviderConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    credentialId: z.ZodOptional<z.ZodString>;
+    pixelId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    capiEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    testEventCode: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+export type MetaTrackingProviderConfig = z.infer<typeof MetaTrackingProviderConfigSchema>;
+/**
+ * Google Analytics 4 (GA4) & Measurement Protocol Configuration
+ */
+export declare const GoogleTrackingProviderConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    credentialId: z.ZodOptional<z.ZodString>;
+    measurementId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+export type GoogleTrackingProviderConfig = z.infer<typeof GoogleTrackingProviderConfigSchema>;
+/**
+ * Google Tag Manager (GTM) Configuration.
+ * Client-side only: `track_event` with provider 'gtm' (or 'all') pushes to `window.dataLayer`.
+ */
+export declare const GtmTrackingProviderConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    credentialId: z.ZodOptional<z.ZodString>;
+    containerId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+export type GtmTrackingProviderConfig = z.infer<typeof GtmTrackingProviderConfigSchema>;
+/**
+ * TikTok Pixel & Events API Configuration
+ */
+export declare const TikTokTrackingProviderConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    credentialId: z.ZodOptional<z.ZodString>;
+    pixelId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    eventsApiEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    testEventCode: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+export type TikTokTrackingProviderConfig = z.infer<typeof TikTokTrackingProviderConfigSchema>;
+/**
+ * Custom Webhook Configuration.
+ * The destination URL and any auth headers are host secrets resolved from `credentialId`.
+ */
+export declare const CustomTrackingProviderConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    credentialId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CustomTrackingProviderConfig = z.infer<typeof CustomTrackingProviderConfigSchema>;
+/**
+ * Provider keys that `<= 1.0.0` documents stored but that are now host-owned
+ * (secrets and server destinations). Used by migration and by import/export
+ * sanitization to strip them defensively.
+ */
+export declare const LEGACY_TRACKING_SECRET_KEYS: Readonly<Record<TrackingProviderType, readonly string[]>>;
+/**
+ * Global Tracking Configuration Schema
+ * Attached to Document / Project. Contains no secrets.
+ */
+export declare const TrackingConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    debugMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    autoPageView: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    defaultDelivery: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        both: "both";
+        client_only: "client_only";
+        server_only: "server_only";
+    }>>>;
+    providers: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        meta: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            credentialId: z.ZodOptional<z.ZodString>;
+            pixelId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            capiEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            testEventCode: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        google: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            credentialId: z.ZodOptional<z.ZodString>;
+            measurementId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        gtm: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            credentialId: z.ZodOptional<z.ZodString>;
+            containerId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        tiktok: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            credentialId: z.ZodOptional<z.ZodString>;
+            pixelId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            eventsApiEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            testEventCode: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        custom: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            credentialId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type TrackingConfig = z.infer<typeof TrackingConfigSchema>;
+/** Meta Conversions API secret material. */
+export declare const MetaTrackingSecretsSchema: z.ZodObject<{
+    capiAccessToken: z.ZodString;
+}, z.core.$strip>;
+export type MetaTrackingSecrets = z.infer<typeof MetaTrackingSecretsSchema>;
+/** GA4 Measurement Protocol secret material. */
+export declare const GoogleTrackingSecretsSchema: z.ZodObject<{
+    measurementProtocolSecret: z.ZodString;
+}, z.core.$strip>;
+export type GoogleTrackingSecrets = z.infer<typeof GoogleTrackingSecretsSchema>;
+/** TikTok Events API secret material. */
+export declare const TikTokTrackingSecretsSchema: z.ZodObject<{
+    accessToken: z.ZodString;
+}, z.core.$strip>;
+export type TikTokTrackingSecrets = z.infer<typeof TikTokTrackingSecretsSchema>;
+/** Custom webhook destination + auth headers (both are host secrets). */
+export declare const CustomTrackingSecretsSchema: z.ZodObject<{
+    endpointUrl: z.ZodString;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export type CustomTrackingSecrets = z.infer<typeof CustomTrackingSecretsSchema>;
+/** Secret material keyed by provider. GTM is client-only and has no secret. */
+export interface TrackingProviderSecretsMap {
+    meta: MetaTrackingSecrets;
+    google: GoogleTrackingSecrets;
+    tiktok: TikTokTrackingSecrets;
+    custom: CustomTrackingSecrets;
+}
+/** Providers that support server-side delivery (and therefore have secrets). */
+export type ServerTrackingProviderType = keyof TrackingProviderSecretsMap;
+/** Secret material for a single provider, as returned by a host secret resolver. */
+export type TrackingProviderSecrets = TrackingProviderSecretsMap[ServerTrackingProviderType];
+/**
+ * Standard Event Names commonly used across Meta, Google, and TikTok.
+ */
+export declare const StandardTrackingEventSchema: z.ZodEnum<{
+    PageView: "PageView";
+    ViewContent: "ViewContent";
+    AddToCart: "AddToCart";
+    InitiateCheckout: "InitiateCheckout";
+    Purchase: "Purchase";
+    Lead: "Lead";
+    Contact: "Contact";
+    CompleteRegistration: "CompleteRegistration";
+    Subscribe: "Subscribe";
+    Search: "Search";
+    SubmitApplication: "SubmitApplication";
+    Schedule: "Schedule";
+}>;
+export type StandardTrackingEvent = z.infer<typeof StandardTrackingEventSchema>;
+/**
+ * Target provider of a `track_event` step. 'gtm' pushes to `window.dataLayer` (client only).
+ */
+export declare const TrackEventProviderSchema: z.ZodEnum<{
+    all: "all";
+    custom: "custom";
+    meta: "meta";
+    google: "google";
+    gtm: "gtm";
+    tiktok: "tiktok";
+}>;
+export type TrackEventProvider = z.infer<typeof TrackEventProviderSchema>;
+/**
+ * Track Event Step Payload Schema (for Action Pipelines)
+ */
+export declare const TrackEventStepPayloadSchema: z.ZodObject<{
+    eventName: z.ZodString;
+    eventType: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        standard: "standard";
+        custom: "custom";
+    }>>>;
+    provider: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        all: "all";
+        custom: "custom";
+        meta: "meta";
+        google: "google";
+        gtm: "gtm";
+        tiktok: "tiktok";
+    }>>>;
+    delivery: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        both: "both";
+        client_only: "client_only";
+        server_only: "server_only";
+    }>>>;
+    eventId: z.ZodOptional<z.ZodString>;
+    params: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    userData: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type TrackEventStepPayload = z.infer<typeof TrackEventStepPayloadSchema>;
+export declare const TRACKING_RELAY_PROTOCOL_VERSION: 1;
+/** Normalized server tracking event, as sent from the browser to the host relay. */
+export declare const ServerTrackingEventSchema: z.ZodObject<{
+    eventName: z.ZodString;
+    eventType: z.ZodOptional<z.ZodEnum<{
+        standard: "standard";
+        custom: "custom";
+    }>>;
+    eventId: z.ZodOptional<z.ZodString>;
+    eventTime: z.ZodOptional<z.ZodNumber>;
+    eventSourceUrl: z.ZodOptional<z.ZodString>;
+    actionSource: z.ZodOptional<z.ZodEnum<{
+        website: "website";
+        app: "app";
+        system_generated: "system_generated";
+    }>>;
+    params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    userData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type ServerTrackingEventInput = z.infer<typeof ServerTrackingEventSchema>;
+/**
+ * Body the renderer POSTs to the host relay (`RenderContext.tracking.relayUrl`).
+ * The relay MUST load the tracking config itself (trusted) — never from this body.
+ */
+export declare const TrackingRelayRequestSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    event: z.ZodObject<{
+        eventName: z.ZodString;
+        eventType: z.ZodOptional<z.ZodEnum<{
+            standard: "standard";
+            custom: "custom";
+        }>>;
+        eventId: z.ZodOptional<z.ZodString>;
+        eventTime: z.ZodOptional<z.ZodNumber>;
+        eventSourceUrl: z.ZodOptional<z.ZodString>;
+        actionSource: z.ZodOptional<z.ZodEnum<{
+            website: "website";
+            app: "app";
+            system_generated: "system_generated";
+        }>>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        userData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+    provider: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        all: "all";
+        custom: "custom";
+        meta: "meta";
+        google: "google";
+        gtm: "gtm";
+        tiktok: "tiktok";
+    }>>>;
+    credentialId: z.ZodOptional<z.ZodString>;
+    documentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TrackingRelayRequest = z.infer<typeof TrackingRelayRequestSchema>;
+/** Per-provider outcome returned by the relay (provider response bodies are not echoed). */
+export declare const TrackingRelayProviderResultSchema: z.ZodObject<{
+    provider: z.ZodString;
+    success: z.ZodBoolean;
+    status: z.ZodOptional<z.ZodNumber>;
+    skipped: z.ZodOptional<z.ZodBoolean>;
+    reason: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TrackingRelayProviderResult = z.infer<typeof TrackingRelayProviderResultSchema>;
+export declare const TrackingRelayErrorCodeSchema: z.ZodEnum<{
+    INVALID_REQUEST: "INVALID_REQUEST";
+    UNSUPPORTED_VERSION: "UNSUPPORTED_VERSION";
+    FORBIDDEN_ORIGIN: "FORBIDDEN_ORIGIN";
+    METHOD_NOT_ALLOWED: "METHOD_NOT_ALLOWED";
+    CONFIG_NOT_FOUND: "CONFIG_NOT_FOUND";
+    INTERNAL_ERROR: "INTERNAL_ERROR";
+}>;
+export type TrackingRelayErrorCode = z.infer<typeof TrackingRelayErrorCodeSchema>;
+export declare const TrackingRelayResponseSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    success: z.ZodBoolean;
+    eventId: z.ZodOptional<z.ZodString>;
+    skipped: z.ZodOptional<z.ZodBoolean>;
+    reason: z.ZodOptional<z.ZodString>;
+    results: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        provider: z.ZodString;
+        success: z.ZodBoolean;
+        status: z.ZodOptional<z.ZodNumber>;
+        skipped: z.ZodOptional<z.ZodBoolean>;
+        reason: z.ZodOptional<z.ZodString>;
+        error: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodEnum<{
+            INVALID_REQUEST: "INVALID_REQUEST";
+            UNSUPPORTED_VERSION: "UNSUPPORTED_VERSION";
+            FORBIDDEN_ORIGIN: "FORBIDDEN_ORIGIN";
+            METHOD_NOT_ALLOWED: "METHOD_NOT_ALLOWED";
+            CONFIG_NOT_FOUND: "CONFIG_NOT_FOUND";
+            INTERNAL_ERROR: "INTERNAL_ERROR";
+        }>;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TrackingRelayResponse = z.infer<typeof TrackingRelayResponseSchema>;
+/**
+ * Type guards
+ */
+export declare function isTrackingConfig(value: unknown): value is TrackingConfig;
+export declare function isTrackEventStepPayload(value: unknown): value is TrackEventStepPayload;
+export declare function isTrackingRelayRequest(value: unknown): value is TrackingRelayRequest;
+//# sourceMappingURL=tracking.d.cts.map

package/dist/tracking.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking.d.cts","sourceRoot":"","sources":["../src/tracking.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;EAMrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAa9E;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,qFAAqF;IACrF,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,oBAAoB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAC/C,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yEAAyE;IACzE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;EAAiD,CAAC;AACrF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;iBAU3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;iBAM7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;iBAM1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;iBAU7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;iBAI7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,QAAQ,CAAC,MAAM,CAAC,oBAAoB,EAAE,SAAS,MAAM,EAAE,CAAC,CAO9F,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAOlE,4CAA4C;AAC5C,eAAO,MAAM,yBAAyB;;iBAGpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,gDAAgD;AAChD,eAAO,MAAM,2BAA2B;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,yCAAyC;AACzC,eAAO,MAAM,2BAA2B;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,yEAAyE;AACzE,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,+EAA+E;AAC/E,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,gFAAgF;AAChF,MAAM,MAAM,0BAA0B,GAAG,MAAM,0BAA0B,CAAC;AAE1E,oFAAoF;AACpF,MAAM,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,0BAA0B,CAAC,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;EAatC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;EAA+D,CAAC;AACrG,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;iBA8BtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAOhF,eAAO,MAAM,+BAA+B,EAAG,CAAU,CAAC;AAE1D,oFAAoF;AACpF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;iBAYpC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAEjF;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,4FAA4F;AAC5F,eAAO,MAAM,iCAAiC;;;;;;;iBAO5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F,eAAO,MAAM,4BAA4B;;;;;;;EAOvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;iBAatC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAExE;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB,CAEtF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAEpF"}

package/dist/types.d.cts

@@ -0,0 +1,331 @@
+/**
+ * `@kubuild/schema/types` — pure TypeScript interfaces for the portable document format
+ * (STORA-552).
+ *
+ * This module MUST NOT import zod (or any module that does). Its emitted `.d.ts` is what
+ * hosts on a different zod major (e.g. a zod v3 backend) import to type `PageDocument`,
+ * `Node`, etc. without pulling zod v4's core namespace into their compilation.
+ *
+ * Every type here mirrors the *parsed output* (`z.infer<...>`) of the matching schema in
+ * the main entry, i.e. fields with a schema default are required. The equality is
+ * enforced by `tests/types.test.ts` (`expectTypeOf(...).toEqualTypeOf(...)`), so a schema
+ * change that is not reflected here fails `pnpm run typecheck`.
+ */
+export interface AssetReference {
+    type: 'asset';
+    assetId: string;
+    filename?: string;
+    mimeType?: string;
+    fallbackUrl?: string;
+}
+export interface VariableBinding {
+    type: 'variable';
+    key: string;
+    fallback?: unknown;
+}
+export interface ActionBinding {
+    type: string;
+    payload?: Record<string, unknown>;
+}
+export type StyleValue = string | number | boolean | null | undefined;
+/**
+ * Standard CSS style definition supporting Flexbox, sizing constraints, effects,
+ * CSS Grid, and arbitrary CSS properties / design-token references.
+ */
+export interface StyleDefinition extends Record<string, StyleValue> {
+    display?: string;
+    flexDirection?: 'row' | 'row-reverse' | 'column' | 'column-reverse' | (string & {});
+    flexWrap?: 'nowrap' | 'wrap' | 'wrap-reverse' | (string & {});
+    justifyContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'space-evenly' | 'start' | 'end' | 'left' | 'right' | (string & {});
+    alignItems?: 'stretch' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'start' | 'end' | 'self-start' | 'self-end' | (string & {});
+    alignContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch' | 'start' | 'end' | (string & {});
+    gap?: string | number;
+    rowGap?: string | number;
+    columnGap?: string | number;
+    flexGrow?: number | string;
+    flexShrink?: number | string;
+    flexBasis?: string | number;
+    alignSelf?: 'auto' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch' | (string & {});
+    width?: string | number;
+    height?: string | number;
+    minWidth?: string | number;
+    maxWidth?: string | number;
+    minHeight?: string | number;
+    maxHeight?: string | number;
+    objectFit?: 'fill' | 'contain' | 'cover' | 'none' | 'scale-down' | (string & {});
+    objectPosition?: string;
+    borderRadius?: string | number;
+    borderTopLeftRadius?: string | number;
+    borderTopRightRadius?: string | number;
+    borderBottomRightRadius?: string | number;
+    borderBottomLeftRadius?: string | number;
+    backdropFilter?: string;
+    filter?: string;
+    boxShadow?: string;
+    backgroundColor?: string;
+    backgroundImage?: string;
+    backgroundSize?: 'cover' | 'contain' | 'auto' | (string & {});
+    backgroundPosition?: string;
+    backgroundRepeat?: 'no-repeat' | 'repeat' | 'repeat-x' | 'repeat-y' | (string & {});
+    backgroundAttachment?: 'scroll' | 'fixed' | 'local' | (string & {});
+    gridTemplateColumns?: string;
+    gridTemplateRows?: string;
+    gridAutoFlow?: string;
+    gridAutoColumns?: string;
+    gridAutoRows?: string;
+    gridColumn?: string | number;
+    gridRow?: string | number;
+    gridColumnStart?: string | number;
+    gridColumnEnd?: string | number;
+    gridRowStart?: string | number;
+    gridRowEnd?: string | number;
+    colSpan?: number | string;
+    rowSpan?: number | string;
+    justifySelf?: string;
+}
+export type PseudoStateStyles = Record<string, StyleDefinition>;
+/** Breakpoint style layers (`base` applies to every viewport) plus pseudo-state layers. */
+export interface ResponsiveStyles {
+    [key: string]: unknown;
+    base?: StyleDefinition;
+    desktop?: StyleDefinition;
+    tablet?: StyleDefinition;
+    mobile?: StyleDefinition;
+    states?: Record<string, StyleDefinition>;
+}
+export interface AnimationConfig {
+    type: string;
+    duration: number;
+    delay: number;
+    easing: string;
+    once: boolean;
+    hoverEffect: string;
+    loopEffect: string;
+}
+export type ThemeTokenValue = string | number;
+/** Design tokens; referenced from styles as `var(--kb-color-<key>)` etc. */
+export interface Theme {
+    colors?: Record<string, ThemeTokenValue>;
+    fonts?: Record<string, ThemeTokenValue>;
+    radii?: Record<string, ThemeTokenValue>;
+    spacing?: Record<string, ThemeTokenValue>;
+}
+export type ValidationRuleType = 'required' | 'email' | 'url' | 'min_length' | 'max_length' | 'numeric_min' | 'numeric_max' | 'pattern' | 'match_field' | 'custom_regex';
+export type ValidateOnEvent = 'blur' | 'change' | 'submit';
+export interface ValidationRule {
+    type: ValidationRuleType;
+    value?: unknown;
+    message: string;
+}
+export interface FormFieldBinding {
+    name: string;
+    label?: string;
+    defaultValue?: unknown;
+    rules: ValidationRule[];
+    validateOn: ValidateOnEvent;
+    transform?: 'trim' | 'lowercase' | 'uppercase' | 'number';
+    disabled?: boolean;
+    required?: boolean;
+}
+export interface FormConfig {
+    formId: string;
+    resetOnSubmit: boolean;
+    scrollToFirstError: boolean;
+    validateOn: ValidateOnEvent;
+    initialValues?: Record<string, unknown>;
+    rules?: ValidationRule[];
+}
+export type ActionTriggerType = 'click' | 'submit' | 'change' | 'blur' | 'focus' | 'load' | 'expire';
+export type ActionStepType = 'api_request' | 'navigate' | 'set_state' | 'reset_form' | 'show_toast' | 'open_modal' | 'close_modal' | 'toggle_modal' | 'copy_clipboard' | 'custom_event' | 'track_event';
+export type ConditionOperator = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'is_truthy' | 'is_falsy' | 'gt' | 'gte' | 'lt' | 'lte' | 'regex';
+export interface ActionStepCondition {
+    field: string;
+    operator: ConditionOperator;
+    value?: unknown;
+}
+export interface ActionStep {
+    id: string;
+    type: ActionStepType;
+    label?: string;
+    payload?: Record<string, unknown>;
+    condition?: ActionStepCondition;
+    timeout?: number;
+    continueOnError?: boolean;
+    onSuccess?: ActionStep[];
+    onError?: ActionStep[];
+}
+export interface ActionPipeline {
+    id: string;
+    trigger: ActionTriggerType;
+    label?: string;
+    debounceMs?: number;
+    preventDuplicate?: boolean;
+    enabled: boolean;
+    steps: ActionStep[];
+}
+export type TrackingProviderType = 'meta' | 'google' | 'gtm' | 'tiktok' | 'custom';
+export type TrackingDelivery = 'both' | 'client_only' | 'server_only';
+export interface MetaTrackingProviderConfig {
+    enabled: boolean;
+    credentialId?: string;
+    pixelId: string;
+    capiEnabled: boolean;
+    testEventCode: string;
+}
+export interface GoogleTrackingProviderConfig {
+    enabled: boolean;
+    credentialId?: string;
+    measurementId: string;
+}
+export interface GtmTrackingProviderConfig {
+    enabled: boolean;
+    credentialId?: string;
+    containerId: string;
+}
+export interface TikTokTrackingProviderConfig {
+    enabled: boolean;
+    credentialId?: string;
+    pixelId: string;
+    eventsApiEnabled: boolean;
+    testEventCode: string;
+}
+export interface CustomTrackingProviderConfig {
+    enabled: boolean;
+    credentialId?: string;
+}
+export interface TrackingConfig {
+    enabled: boolean;
+    debugMode: boolean;
+    autoPageView: boolean;
+    defaultDelivery: TrackingDelivery;
+    providers: {
+        meta?: MetaTrackingProviderConfig;
+        google?: GoogleTrackingProviderConfig;
+        gtm?: GtmTrackingProviderConfig;
+        tiktok?: TikTokTrackingProviderConfig;
+        custom?: CustomTrackingProviderConfig;
+    };
+}
+export interface Node {
+    id: string;
+    type: string;
+    props?: Record<string, unknown>;
+    styles?: ResponsiveStyles;
+    animation?: AnimationConfig;
+    actions?: ActionPipeline[];
+    formConfig?: FormConfig;
+    children?: Node[];
+}
+export type RootPageNode = Node & {
+    type: 'page';
+};
+export interface DocumentMetadata {
+    title: string;
+    description: string;
+    author: string;
+    createdAt?: string;
+    updatedAt?: string;
+    tags: string[];
+    category: string;
+    version: string;
+    custom?: Record<string, unknown>;
+    tracking?: TrackingConfig;
+}
+export interface PageDocument {
+    schema: 'stora.page';
+    version: string;
+    metadata?: DocumentMetadata;
+    tracking?: TrackingConfig;
+    theme?: Theme;
+    document: RootPageNode;
+}
+export type ArtboardType = 'page' | 'component';
+export interface Artboard {
+    id: string;
+    name: string;
+    artboardType: ArtboardType;
+    slug?: string;
+    triggerId?: string;
+    viewport?: 'desktop' | 'tablet' | 'mobile';
+    width?: number;
+    position?: {
+        x: number;
+        y: number;
+    };
+    document: PageDocument;
+}
+export interface ProjectDocument {
+    schema: 'stora.project';
+    version: string;
+    metadata?: DocumentMetadata;
+    tracking?: TrackingConfig;
+    artboards: Artboard[];
+    activeArtboardId?: string;
+}
+export interface ManifestAssetItem {
+    id: string;
+    path: string;
+    mimeType: string;
+    size: number;
+    checksum?: string;
+}
+export interface Manifest {
+    schema: 'stora.page';
+    schemaVersion: string;
+    packageVersion: string;
+    builderCompatibility: string;
+    requiredComponents: string[];
+    requiredCapabilities: string[];
+    assets: ManifestAssetItem[];
+    createdAt?: string;
+}
+export interface SafeThumbnailObject {
+    url: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+}
+export type SafeThumbnail = AssetReference | SafeThumbnailObject | string;
+export interface TemplatePackageRef {
+    path?: string;
+    url?: string;
+    checksum?: string;
+    format: 'stora' | 'json';
+}
+export interface TemplateRequirements {
+    requiredComponents: string[];
+    requiredCapabilities: string[];
+}
+export interface TemplateRecord {
+    id: string;
+    name: string;
+    description: string;
+    category: string;
+    tags: string[];
+    thumbnail?: SafeThumbnail;
+    author: string;
+    version: string;
+    document?: PageDocument;
+    packageReference?: TemplatePackageRef;
+    requirements: TemplateRequirements;
+    createdAt?: string;
+    updatedAt?: string;
+    custom?: Record<string, unknown>;
+}
+export interface SchemaValidationIssue {
+    /** Dotted path to the offending value, e.g. `document.children.0.id` (empty for root). */
+    path: string;
+    message: string;
+    /** Validator issue code (e.g. `invalid_type`, `custom`). */
+    code: string;
+}
+export type SchemaValidationResult<T> = {
+    success: true;
+    data: T;
+    issues: [];
+} | {
+    success: false;
+    data?: undefined;
+    issues: SchemaValidationIssue[];
+};
+//# sourceMappingURL=types.d.cts.map