@getrheo/contracts 1.0.0

package/dist/decisions.d.ts

@@ -0,0 +1,575 @@
+import { z } from 'zod';
+
+declare const DecisionNodeIdSchema: z.ZodString;
+type DecisionNodeId = z.infer<typeof DecisionNodeIdSchema>;
+/**
+ * Terminal jump target for an external surface branch: end the flow immediately
+ * after this outcome (no next screen). Distinct from omitting the outcome, which
+ * falls through to {@link ExternalSurfaceNode.fallback}.
+ */
+declare const EXTERNAL_SURFACE_NO_NEXT: "__onb_surface_no_next__";
+/**
+ * React Flow `Handle.id` / edge `sourceHandle` for a decision node's catch-all
+ * output (`elseNext`). Not a {@link FlowJumpTarget}.
+ */
+declare const DECISION_ELSE_SOURCE_HANDLE: "__dec_else__";
+/** Nullable jump target from a screen, decision, or external surface: another screen, a decision vertex, or an external surface. */
+declare const FlowJumpTargetSchema: z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>;
+type FlowJumpTarget = z.infer<typeof FlowJumpTargetSchema>;
+declare const DecisionBuiltinNameSchema: z.ZodEnum<["locale", "platform"]>;
+type DecisionBuiltinName = z.infer<typeof DecisionBuiltinNameSchema>;
+declare const DecisionVariableRefSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+    kind: z.ZodLiteral<"builtin">;
+    name: z.ZodEnum<["locale", "platform"]>;
+}, "strip", z.ZodTypeAny, {
+    name: "locale" | "platform";
+    kind: "builtin";
+}, {
+    name: "locale" | "platform";
+    kind: "builtin";
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"sdk">;
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    kind: "sdk";
+    key: string;
+}, {
+    kind: "sdk";
+    key: string;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"field">;
+    fieldKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    kind: "field";
+    fieldKey: string;
+}, {
+    kind: "field";
+    fieldKey: string;
+}>]>;
+type DecisionVariableRef = z.infer<typeof DecisionVariableRefSchema>;
+declare const DecisionStringPredicateSchema: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+    op: z.ZodLiteral<"eq">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    op: "eq";
+}, {
+    value: string;
+    op: "eq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"neq">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    op: "neq";
+}, {
+    value: string;
+    op: "neq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"contains">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    op: "contains";
+}, {
+    value: string;
+    op: "contains";
+}>]>;
+declare const DecisionNumberPredicateSchema: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+    op: z.ZodLiteral<"eq">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "eq";
+}, {
+    value: number;
+    op: "eq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"neq">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "neq";
+}, {
+    value: number;
+    op: "neq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"lt">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "lt";
+}, {
+    value: number;
+    op: "lt";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"lte">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "lte";
+}, {
+    value: number;
+    op: "lte";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"gt">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "gt";
+}, {
+    value: number;
+    op: "gt";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"gte">;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    op: "gte";
+}, {
+    value: number;
+    op: "gte";
+}>]>;
+declare const DecisionChoicePredicateSchema: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+    op: z.ZodLiteral<"eq">;
+    optionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    optionId: string;
+    op: "eq";
+}, {
+    optionId: string;
+    op: "eq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"one_of">;
+    optionIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    op: "one_of";
+    optionIds: string[];
+}, {
+    op: "one_of";
+    optionIds: string[];
+}>]>;
+declare const DecisionMultiPredicateSchema: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+    op: z.ZodLiteral<"intersects">;
+    optionIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    op: "intersects";
+    optionIds: string[];
+}, {
+    op: "intersects";
+    optionIds: string[];
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"contains_all">;
+    optionIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    op: "contains_all";
+    optionIds: string[];
+}, {
+    op: "contains_all";
+    optionIds: string[];
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"subset_of">;
+    optionIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    op: "subset_of";
+    optionIds: string[];
+}, {
+    op: "subset_of";
+    optionIds: string[];
+}>]>;
+declare const DecisionBooleanPredicateSchema: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+    op: z.ZodLiteral<"eq">;
+    value: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    value: boolean;
+    op: "eq";
+}, {
+    value: boolean;
+    op: "eq";
+}>, z.ZodObject<{
+    op: z.ZodLiteral<"neq">;
+    value: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    value: boolean;
+    op: "neq";
+}, {
+    value: boolean;
+    op: "neq";
+}>]>;
+declare const DecisionPredicatePayloadSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"string">;
+    pred: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+        op: z.ZodLiteral<"eq">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        op: "eq";
+    }, {
+        value: string;
+        op: "eq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"neq">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        op: "neq";
+    }, {
+        value: string;
+        op: "neq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"contains">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        op: "contains";
+    }, {
+        value: string;
+        op: "contains";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "string";
+    pred: {
+        value: string;
+        op: "eq";
+    } | {
+        value: string;
+        op: "neq";
+    } | {
+        value: string;
+        op: "contains";
+    };
+}, {
+    type: "string";
+    pred: {
+        value: string;
+        op: "eq";
+    } | {
+        value: string;
+        op: "neq";
+    } | {
+        value: string;
+        op: "contains";
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    pred: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+        op: z.ZodLiteral<"eq">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "eq";
+    }, {
+        value: number;
+        op: "eq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"neq">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "neq";
+    }, {
+        value: number;
+        op: "neq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"lt">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "lt";
+    }, {
+        value: number;
+        op: "lt";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"lte">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "lte";
+    }, {
+        value: number;
+        op: "lte";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"gt">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "gt";
+    }, {
+        value: number;
+        op: "gt";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"gte">;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        op: "gte";
+    }, {
+        value: number;
+        op: "gte";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "number";
+    pred: {
+        value: number;
+        op: "eq";
+    } | {
+        value: number;
+        op: "neq";
+    } | {
+        value: number;
+        op: "lt";
+    } | {
+        value: number;
+        op: "lte";
+    } | {
+        value: number;
+        op: "gt";
+    } | {
+        value: number;
+        op: "gte";
+    };
+}, {
+    type: "number";
+    pred: {
+        value: number;
+        op: "eq";
+    } | {
+        value: number;
+        op: "neq";
+    } | {
+        value: number;
+        op: "lt";
+    } | {
+        value: number;
+        op: "lte";
+    } | {
+        value: number;
+        op: "gt";
+    } | {
+        value: number;
+        op: "gte";
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    pred: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+        op: z.ZodLiteral<"eq">;
+        value: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        value: boolean;
+        op: "eq";
+    }, {
+        value: boolean;
+        op: "eq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"neq">;
+        value: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        value: boolean;
+        op: "neq";
+    }, {
+        value: boolean;
+        op: "neq";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    pred: {
+        value: boolean;
+        op: "eq";
+    } | {
+        value: boolean;
+        op: "neq";
+    };
+}, {
+    type: "boolean";
+    pred: {
+        value: boolean;
+        op: "eq";
+    } | {
+        value: boolean;
+        op: "neq";
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"choice">;
+    pred: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+        op: z.ZodLiteral<"eq">;
+        optionId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        optionId: string;
+        op: "eq";
+    }, {
+        optionId: string;
+        op: "eq";
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"one_of">;
+        optionIds: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        op: "one_of";
+        optionIds: string[];
+    }, {
+        op: "one_of";
+        optionIds: string[];
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "choice";
+    pred: {
+        optionId: string;
+        op: "eq";
+    } | {
+        op: "one_of";
+        optionIds: string[];
+    };
+}, {
+    type: "choice";
+    pred: {
+        optionId: string;
+        op: "eq";
+    } | {
+        op: "one_of";
+        optionIds: string[];
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"multi">;
+    pred: z.ZodDiscriminatedUnion<"op", [z.ZodObject<{
+        op: z.ZodLiteral<"intersects">;
+        optionIds: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        op: "intersects";
+        optionIds: string[];
+    }, {
+        op: "intersects";
+        optionIds: string[];
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"contains_all">;
+        optionIds: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        op: "contains_all";
+        optionIds: string[];
+    }, {
+        op: "contains_all";
+        optionIds: string[];
+    }>, z.ZodObject<{
+        op: z.ZodLiteral<"subset_of">;
+        optionIds: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        op: "subset_of";
+        optionIds: string[];
+    }, {
+        op: "subset_of";
+        optionIds: string[];
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "multi";
+    pred: {
+        op: "intersects";
+        optionIds: string[];
+    } | {
+        op: "contains_all";
+        optionIds: string[];
+    } | {
+        op: "subset_of";
+        optionIds: string[];
+    };
+}, {
+    type: "multi";
+    pred: {
+        op: "intersects";
+        optionIds: string[];
+    } | {
+        op: "contains_all";
+        optionIds: string[];
+    } | {
+        op: "subset_of";
+        optionIds: string[];
+    };
+}>]>;
+type DecisionPredicatePayload = z.infer<typeof DecisionPredicatePayloadSchema>;
+type DecisionExpr = {
+    kind: 'empty';
+} | {
+    kind: 'group';
+    op: 'and' | 'or';
+    children: DecisionExpr[];
+} | {
+    kind: 'predicate';
+    variable: DecisionVariableRef;
+    predicate: DecisionPredicatePayload;
+};
+declare const DecisionExprSchema: z.ZodType<DecisionExpr>;
+/** One ordered segment evaluated before {@link DecisionNode.elseNext}. */
+declare const DecisionCaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    /** Display label in the editor (e.g. “Engaged users”). */
+    name: z.ZodOptional<z.ZodString>;
+    expression: z.ZodType<DecisionExpr, z.ZodTypeDef, DecisionExpr>;
+    next: z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    next: string | null;
+    expression: DecisionExpr;
+    name?: string | undefined;
+}, {
+    id: string;
+    next: string | null;
+    expression: DecisionExpr;
+    name?: string | undefined;
+}>;
+type DecisionCase = z.infer<typeof DecisionCaseSchema>;
+/**
+ * Multi-branch decision: `cases` are evaluated in order; the first matching
+ * expression routes to that case’s `next`. If none match, `elseNext` is used
+ * (“everyone else”).
+ */
+declare const DecisionNodeSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    cases: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        /** Display label in the editor (e.g. “Engaged users”). */
+        name: z.ZodOptional<z.ZodString>;
+        expression: z.ZodType<DecisionExpr, z.ZodTypeDef, DecisionExpr>;
+        next: z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        next: string | null;
+        expression: DecisionExpr;
+        name?: string | undefined;
+    }, {
+        id: string;
+        next: string | null;
+        expression: DecisionExpr;
+        name?: string | undefined;
+    }>, "many">;
+    elseNext: z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    cases: {
+        id: string;
+        next: string | null;
+        expression: DecisionExpr;
+        name?: string | undefined;
+    }[];
+    elseNext: string | null;
+    name?: string | undefined;
+}, {
+    id: string;
+    cases: {
+        id: string;
+        next: string | null;
+        expression: DecisionExpr;
+        name?: string | undefined;
+    }[];
+    elseNext: string | null;
+    name?: string | undefined;
+}>;
+type DecisionNode = z.infer<typeof DecisionNodeSchema>;
+/**
+ * Migrate a persisted binary decision (`expression` + `onTrue` / `onFalse`) to
+ * the multi-segment shape in-place. No-op when already migrated.
+ */
+declare const migrateLegacyDecisionNodeInPlace: (node: Record<string, unknown>) => void;
+declare const collectDecisionSdkKeys: (expr: DecisionExpr) => string[];
+declare const collectDecisionFieldKeys: (expr: DecisionExpr) => string[];
+declare const collectDecisionSdkKeysFromNode: (node: DecisionNode) => string[];
+declare const collectDecisionFieldKeysFromNode: (node: DecisionNode) => string[];
+
+export { DECISION_ELSE_SOURCE_HANDLE, DecisionBooleanPredicateSchema, type DecisionBuiltinName, DecisionBuiltinNameSchema, type DecisionCase, DecisionCaseSchema, DecisionChoicePredicateSchema, type DecisionExpr, DecisionExprSchema, DecisionMultiPredicateSchema, type DecisionNode, type DecisionNodeId, DecisionNodeIdSchema, DecisionNodeSchema, DecisionNumberPredicateSchema, type DecisionPredicatePayload, DecisionPredicatePayloadSchema, DecisionStringPredicateSchema, type DecisionVariableRef, DecisionVariableRefSchema, EXTERNAL_SURFACE_NO_NEXT, type FlowJumpTarget, FlowJumpTargetSchema, collectDecisionFieldKeys, collectDecisionFieldKeysFromNode, collectDecisionSdkKeys, collectDecisionSdkKeysFromNode, migrateLegacyDecisionNodeInPlace };