@junejuly-lockstep/model 0.0.0-stage → 0.1.0

package/dist/journey.d.ts

@@ -0,0 +1,705 @@
+import { z } from 'zod';
+/**
+ * Journey model: an XState v5 compatible machine JSON plus Lockstep metadata.
+ * The client repo is the source of truth; the platform mirrors it.
+ */
+export declare const JourneyKey: z.ZodString;
+export type JourneyKey = z.infer<typeof JourneyKey>;
+export declare const StateKey: z.ZodString;
+export type StateKey = z.infer<typeof StateKey>;
+/** A single transition target in XState JSON form. */
+export declare const TransitionConfig: z.ZodObject<{
+    target: z.ZodString;
+    guard: z.ZodOptional<z.ZodString>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}>;
+export type TransitionConfig = z.infer<typeof TransitionConfig>;
+/** XState allows `on: { EVENT: 'target' | { target } | [{ target, guard }] }`. */
+export declare const TransitionValue: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    target: z.ZodString;
+    guard: z.ZodOptional<z.ZodString>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}>, z.ZodArray<z.ZodObject<{
+    target: z.ZodString;
+    guard: z.ZodOptional<z.ZodString>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}, {
+    target: string;
+    guard?: string | undefined;
+    actions?: string[] | undefined;
+    description?: string | undefined;
+}>, "many">]>;
+export type TransitionValue = z.infer<typeof TransitionValue>;
+export declare const MachineStateConfig: z.ZodObject<{
+    on: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodObject<{
+        target: z.ZodString;
+        guard: z.ZodOptional<z.ZodString>;
+        actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }, {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }>, z.ZodArray<z.ZodObject<{
+        target: z.ZodString;
+        guard: z.ZodOptional<z.ZodString>;
+        actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }, {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }>, "many">]>>>;
+    type: z.ZodOptional<z.ZodEnum<["atomic", "final", "compound", "parallel", "history"]>>;
+    description: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+    description?: string | undefined;
+    on?: Record<string, string | {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    } | {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }[]> | undefined;
+    tags?: string[] | undefined;
+    meta?: Record<string, unknown> | undefined;
+}, {
+    type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+    description?: string | undefined;
+    on?: Record<string, string | {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    } | {
+        target: string;
+        guard?: string | undefined;
+        actions?: string[] | undefined;
+        description?: string | undefined;
+    }[]> | undefined;
+    tags?: string[] | undefined;
+    meta?: Record<string, unknown> | undefined;
+}>;
+export type MachineStateConfig = z.infer<typeof MachineStateConfig>;
+/** The subset of XState v5 machine config Lockstep understands. Flat states only in v1. */
+export declare const MachineJson: z.ZodObject<{
+    id: z.ZodString;
+    initial: z.ZodString;
+    context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    states: z.ZodRecord<z.ZodString, z.ZodObject<{
+        on: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodObject<{
+            target: z.ZodString;
+            guard: z.ZodOptional<z.ZodString>;
+            actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }, {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }>, z.ZodArray<z.ZodObject<{
+            target: z.ZodString;
+            guard: z.ZodOptional<z.ZodString>;
+            actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }, {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }>, "many">]>>>;
+        type: z.ZodOptional<z.ZodEnum<["atomic", "final", "compound", "parallel", "history"]>>;
+        description: z.ZodOptional<z.ZodString>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+        description?: string | undefined;
+        on?: Record<string, string | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        } | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }[]> | undefined;
+        tags?: string[] | undefined;
+        meta?: Record<string, unknown> | undefined;
+    }, {
+        type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+        description?: string | undefined;
+        on?: Record<string, string | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        } | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }[]> | undefined;
+        tags?: string[] | undefined;
+        meta?: Record<string, unknown> | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    initial: string;
+    states: Record<string, {
+        type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+        description?: string | undefined;
+        on?: Record<string, string | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        } | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }[]> | undefined;
+        tags?: string[] | undefined;
+        meta?: Record<string, unknown> | undefined;
+    }>;
+    context?: Record<string, unknown> | undefined;
+}, {
+    id: string;
+    initial: string;
+    states: Record<string, {
+        type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+        description?: string | undefined;
+        on?: Record<string, string | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        } | {
+            target: string;
+            guard?: string | undefined;
+            actions?: string[] | undefined;
+            description?: string | undefined;
+        }[]> | undefined;
+        tags?: string[] | undefined;
+        meta?: Record<string, unknown> | undefined;
+    }>;
+    context?: Record<string, unknown> | undefined;
+}>;
+export type MachineJson = z.infer<typeof MachineJson>;
+/** Per-state Lockstep metadata: where it lives, how to find it, what it means. */
+export declare const StateMeta: z.ZodObject<{
+    route: z.ZodString;
+    testId: z.ZodString;
+    intent: z.ZodString;
+    rules: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    referenceAsset: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    route: string;
+    testId: string;
+    intent: string;
+    rules: string[];
+    referenceAsset?: string | undefined;
+}, {
+    route: string;
+    testId: string;
+    intent: string;
+    rules?: string[] | undefined;
+    referenceAsset?: string | undefined;
+}>;
+export type StateMeta = z.infer<typeof StateMeta>;
+/** Binding of a declared transition to the element that triggers it. */
+export declare const TriggerBinding: z.ZodObject<{
+    from: z.ZodString;
+    event: z.ZodString;
+    testId: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    testId: string;
+    from: string;
+    event: string;
+    label?: string | undefined;
+}, {
+    testId: string;
+    from: string;
+    event: string;
+    label?: string | undefined;
+}>;
+export type TriggerBinding = z.infer<typeof TriggerBinding>;
+export declare const JourneyMeta: z.ZodObject<{
+    narrative: z.ZodDefault<z.ZodString>;
+    states: z.ZodRecord<z.ZodString, z.ZodObject<{
+        route: z.ZodString;
+        testId: z.ZodString;
+        intent: z.ZodString;
+        rules: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        referenceAsset: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        route: string;
+        testId: string;
+        intent: string;
+        rules: string[];
+        referenceAsset?: string | undefined;
+    }, {
+        route: string;
+        testId: string;
+        intent: string;
+        rules?: string[] | undefined;
+        referenceAsset?: string | undefined;
+    }>>;
+    bindings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        from: z.ZodString;
+        event: z.ZodString;
+        testId: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        testId: string;
+        from: string;
+        event: string;
+        label?: string | undefined;
+    }, {
+        testId: string;
+        from: string;
+        event: string;
+        label?: string | undefined;
+    }>, "many">>;
+    assets: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        url: string;
+    }, {
+        name: string;
+        url: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    states: Record<string, {
+        route: string;
+        testId: string;
+        intent: string;
+        rules: string[];
+        referenceAsset?: string | undefined;
+    }>;
+    narrative: string;
+    bindings: {
+        testId: string;
+        from: string;
+        event: string;
+        label?: string | undefined;
+    }[];
+    assets: {
+        name: string;
+        url: string;
+    }[];
+}, {
+    states: Record<string, {
+        route: string;
+        testId: string;
+        intent: string;
+        rules?: string[] | undefined;
+        referenceAsset?: string | undefined;
+    }>;
+    narrative?: string | undefined;
+    bindings?: {
+        testId: string;
+        from: string;
+        event: string;
+        label?: string | undefined;
+    }[] | undefined;
+    assets?: {
+        name: string;
+        url: string;
+    }[] | undefined;
+}>;
+export type JourneyMeta = z.infer<typeof JourneyMeta>;
+export declare const JourneyModel: z.ZodObject<{
+    key: z.ZodString;
+    name: z.ZodString;
+    machine: z.ZodObject<{
+        id: z.ZodString;
+        initial: z.ZodString;
+        context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        states: z.ZodRecord<z.ZodString, z.ZodObject<{
+            on: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodObject<{
+                target: z.ZodString;
+                guard: z.ZodOptional<z.ZodString>;
+                actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                description: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }, {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }>, z.ZodArray<z.ZodObject<{
+                target: z.ZodString;
+                guard: z.ZodOptional<z.ZodString>;
+                actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                description: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }, {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }>, "many">]>>>;
+            type: z.ZodOptional<z.ZodEnum<["atomic", "final", "compound", "parallel", "history"]>>;
+            description: z.ZodOptional<z.ZodString>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, "strip", z.ZodTypeAny, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        initial: string;
+        states: Record<string, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }>;
+        context?: Record<string, unknown> | undefined;
+    }, {
+        id: string;
+        initial: string;
+        states: Record<string, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }>;
+        context?: Record<string, unknown> | undefined;
+    }>;
+    meta: z.ZodObject<{
+        narrative: z.ZodDefault<z.ZodString>;
+        states: z.ZodRecord<z.ZodString, z.ZodObject<{
+            route: z.ZodString;
+            testId: z.ZodString;
+            intent: z.ZodString;
+            rules: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            referenceAsset: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules: string[];
+            referenceAsset?: string | undefined;
+        }, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules?: string[] | undefined;
+            referenceAsset?: string | undefined;
+        }>>;
+        bindings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            from: z.ZodString;
+            event: z.ZodString;
+            testId: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }, {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }>, "many">>;
+        assets: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            url: string;
+        }, {
+            name: string;
+            url: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        states: Record<string, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules: string[];
+            referenceAsset?: string | undefined;
+        }>;
+        narrative: string;
+        bindings: {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }[];
+        assets: {
+            name: string;
+            url: string;
+        }[];
+    }, {
+        states: Record<string, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules?: string[] | undefined;
+            referenceAsset?: string | undefined;
+        }>;
+        narrative?: string | undefined;
+        bindings?: {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }[] | undefined;
+        assets?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    meta: {
+        states: Record<string, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules: string[];
+            referenceAsset?: string | undefined;
+        }>;
+        narrative: string;
+        bindings: {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }[];
+        assets: {
+            name: string;
+            url: string;
+        }[];
+    };
+    name: string;
+    key: string;
+    machine: {
+        id: string;
+        initial: string;
+        states: Record<string, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }>;
+        context?: Record<string, unknown> | undefined;
+    };
+}, {
+    meta: {
+        states: Record<string, {
+            route: string;
+            testId: string;
+            intent: string;
+            rules?: string[] | undefined;
+            referenceAsset?: string | undefined;
+        }>;
+        narrative?: string | undefined;
+        bindings?: {
+            testId: string;
+            from: string;
+            event: string;
+            label?: string | undefined;
+        }[] | undefined;
+        assets?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+    };
+    name: string;
+    key: string;
+    machine: {
+        id: string;
+        initial: string;
+        states: Record<string, {
+            type?: "atomic" | "final" | "compound" | "parallel" | "history" | undefined;
+            description?: string | undefined;
+            on?: Record<string, string | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            } | {
+                target: string;
+                guard?: string | undefined;
+                actions?: string[] | undefined;
+                description?: string | undefined;
+            }[]> | undefined;
+            tags?: string[] | undefined;
+            meta?: Record<string, unknown> | undefined;
+        }>;
+        context?: Record<string, unknown> | undefined;
+    };
+}>;
+export type JourneyModel = z.infer<typeof JourneyModel>;
+/** A named test persona: deterministic seed plus mock overrides. */
+export declare const Scenario: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    seed: z.ZodNumber;
+    overrides: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    seed: number;
+    overrides: Record<string, unknown>;
+    description?: string | undefined;
+}, {
+    name: string;
+    seed: number;
+    description?: string | undefined;
+    overrides?: Record<string, unknown> | undefined;
+}>;
+export type Scenario = z.infer<typeof Scenario>;
+/** Flatten any XState transition value into a list of concrete edges. */
+export declare function transitionsOf(machine: MachineJson): Array<{
+    from: string;
+    event: string;
+    to: string;
+    guard?: string;
+}>;
+/** Stable key for a transition element: `from --event--> to`. */
+export declare function transitionKey(t: {
+    from: string;
+    event: string;
+    to: string;
+}): string;
+/** Validate a journey model beyond the schema: every state has meta and targets resolve. */
+export declare function validateJourney(model: JourneyModel): string[];
+//# sourceMappingURL=journey.d.ts.map