@republicroad/seal-editor 1.15.0 → 1.17.0

package/dist/index.d.ts

@@ -43,6 +43,8 @@ export declare const anyNodeSchema: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 
+export declare const applySchemaTextToInputContract: (contract: InputContract, schemaText: string) => InputContract;
+
 declare type Arrayable<T> = T | T[];
 
 export declare const AUTO_SYNC_DEBOUNCE_MS = 700;
@@ -221,8 +223,35 @@ export declare const compareAndUnifyLists: <T extends BaseItem>(newList: T[], ol
 
 export declare const compareStringFields: (field1?: string | null, field2?: string | null) => boolean;
 
+export declare const computeExampleDrift: (data: Record<string, unknown>, definitions: Array<Pick<RequestDefinition, "name" | "path" | "type">>) => RequestExampleDrift;
+
 export declare const computeGraphDiff: (a: DecisionGraphType, b: DecisionGraphType) => GraphDiff;
 
+export declare type ContractDriftEvent = {
+    at: string;
+    nodeId: string;
+    nodeName?: string;
+    kind: ContractDriftEventKind;
+    exampleNames: string[];
+    counts?: {
+        missing: number;
+        extra: number;
+        conflicts: number;
+        constraints: number;
+    };
+};
+
+export declare type ContractDriftEventKind = 'drift-detected' | 'drift-migrated' | 'drift-confirmed';
+
+export declare const contractExamplesToSources: (contract: InputContract, options?: {
+    dataLabel?: string;
+}) => RequestExampleSource[];
+
+export declare type ContractFixture = {
+    name: string;
+    input: unknown;
+};
+
 declare type ControlToType<T> = T extends keyof InputTypeMap ? InputTypeMap[T] : never;
 
 declare type CreateDynamicType<T extends ReadonlyArray<unknown>, Result = {}> = T extends readonly [infer First, ...infer Rest] ? First extends {
@@ -342,6 +371,8 @@ declare type DecisionGraphEmptyType = {
     mode?: JdmUiMode;
     onChange?: DecisionGraphStoreType['listeners']['onChange'];
     onReactFlowInit?: DecisionGraphStoreType['listeners']['onReactFlowInit'];
+    fixturesRunner?: DecisionGraphStoreType['state']['fixturesRunner'];
+    onContractEvent?: DecisionGraphStoreType['listeners']['onContractEvent'];
     onCodeExtension?: DecisionGraphStoreType['listeners']['onCodeExtension'];
     onFunctionReady?: DecisionGraphStoreType['listeners']['onFunctionReady'];
 };
@@ -378,6 +409,13 @@ declare type DecisionGraphStoreType = {
         user: string;
         simulatorRequest?: string;
         simulatorExampleBinding?: SimulatorExampleBinding;
+        fixturesRunner?: FixturesRunner | null;
+        fixturesRun?: {
+            nodeId: string;
+            status: 'running' | 'done' | 'error';
+            report?: ExampleRunReport;
+            error?: string;
+        } | null;
         compactMode?: boolean;
         dictionaries?: DictionaryMap;
         mode?: JdmUiMode;
@@ -424,11 +462,15 @@ declare type DecisionGraphStoreType = {
         removeNodeType: (id: string, kind?: NodeTypeKind) => void;
         setSimulatorRequest: (req: string) => void;
         setSimulatorExampleBinding: (binding?: SimulatorExampleBinding) => void;
+        setFixturesRunner: (runner: FixturesRunner | null) => void;
+        runFixtures: () => Promise<void>;
+        emitContractEvent: (event: ContractDriftEvent) => void;
         triggerNodeSelect: (id: string, mode: 'toggle' | 'only') => void;
     };
     listeners: {
         onChange?: (val: DecisionGraphType) => void;
         onPanelsChange?: (val?: string) => void;
+        onContractEvent?: (event: ContractDriftEvent) => void;
         onReactFlowInit?: (instance: ReactFlowInstance) => void;
         onCodeExtension?: CodeEditorProps['extension'];
         onFunctionReady?: (monaco: Monaco) => void;
@@ -639,6 +681,17 @@ export declare const decisionModelSchema: z.ZodObject<{
             }, z.core.$strip>>>;
             inputField: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
             outputPath: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
+            inputContract: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                contractVersion: z.ZodDefault<z.ZodNumber>;
+                schema: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>>>, z.ZodTransform<Record<string, any>, string | Record<string, any> | null | undefined>>;
+                examples: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodDefault<z.ZodString>;
+                    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                    schemaFingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>>>;
         }, z.core.$strip>>;
         id: z.ZodDefault<z.ZodString>;
         name: z.ZodString;
@@ -1204,6 +1257,53 @@ declare const en: {
     readonly 'request.fieldNamePlaceholder': "Field name";
     readonly 'request.formatSchema': "Format schema";
     readonly 'request.noDataSources': "No data";
+    readonly 'request.driftSchemaChanged': "Schema changed since last validation";
+    readonly 'request.driftMissing': "missing";
+    readonly 'request.driftExtra': "extra";
+    readonly 'request.driftConflicts': "type conflicts";
+    readonly 'request.driftMigrate': "Migrate";
+    readonly 'request.driftMigrateTooltip': "Fill missing values from defaults and remove fields that no longer exist";
+    readonly 'request.driftMigrateAll': "Migrate all";
+    readonly 'request.driftMigrateAllTooltip': "Apply the safe migration to every example";
+    readonly 'request.driftConfirmValid': "Mark valid";
+    readonly 'request.driftConfirmTooltip': "The example already matches the current schema - record its fingerprint";
+    readonly 'request.driftConstraints': "constraint violations";
+    readonly 'request.importContract': "Import contract";
+    readonly 'request.importContractTooltip': "Adopt a shared contract envelope (contractVersion + schema + examples)";
+    readonly 'request.importContractSuccess': "Contract envelope imported";
+    readonly 'request.importContractInvalidJson': "The file is not valid JSON";
+    readonly 'request.importContractInvalidShape': "Not a contract envelope (contractVersion + schema + examples are required)";
+    readonly 'request.importContractUnsupportedVersion': "The envelope contractVersion is newer than this version supports";
+    readonly 'request.exportContract': "Export contract";
+    readonly 'request.exportContractTooltip': "Download the contract envelope for sharing (OpenAPI / mock / fixtures)";
+    readonly 'request.showRemainingSources': "Show remaining examples";
+    readonly 'request.runAll': "Run all";
+    readonly 'request.runAllTooltip': "Execute every example against the current graph (runs on the host engine)";
+    readonly 'request.runAllFailed': "Run failed";
+    readonly 'request.runAllMatrixTitle': "Run report";
+    readonly 'request.runAllMatrixLabel': "Run all result matrix";
+    readonly 'request.runAllPassed': "passed";
+    readonly 'request.runAllFailedCount': "failed";
+    readonly 'request.outcomePassed': "passed";
+    readonly 'request.outcomeAssertionFailed': "assertion failed";
+    readonly 'request.outcomeExecutionError': "error";
+    readonly 'request.modeDesign': "Design";
+    readonly 'request.modeCode': "Code";
+    readonly 'request.designModeTooltip': "Structured field editor";
+    readonly 'request.examplesSwitcherLabel': "Examples";
+    readonly 'request.selectFieldHint': "Select a field in the tree to edit it";
+    readonly 'request.objectChildrenHint': "Child fields";
+    readonly 'request.arrayCodeHint': "Array item editing lives in Code mode.";
+    readonly 'request.examplePreviewTitle': "Example";
+    readonly 'request.debugInSimulator': "Debug";
+    readonly 'request.fixturesNoInputNode': "No input node in this graph";
+    readonly 'request.fixturesNoExamples': "The input node has no examples yet";
+    readonly 'request.fixturesRunning': "Running…";
+    readonly 'cf.argsDriftTitle': "Function argument drift";
+    readonly 'cf.argsDriftRows': "row(s)";
+    readonly 'cf.argsDriftMissing': "missing";
+    readonly 'cf.argsDriftUnrecognized': "unrecognized";
+    readonly 'cf.argsFillMissing': "Fill missing defaults";
     readonly 'request.noDefinitions': "No field definitions";
     readonly 'request.schemaPriorityTooltip': "Schema has the highest priority. Definitions and example data sync into schema, but schema remains the source of truth.";
     readonly 'request.simulateTooltip': "Open simulator";
@@ -1241,6 +1341,24 @@ declare const en: {
 
 export declare const ensureWasmLoaded: () => Promise<void>;
 
+export declare type ExampleRunOutcome = 'passed' | 'assertion-failed' | 'execution-error';
+
+export declare type ExampleRunReport = {
+    passed: number;
+    failed: number;
+    results: ExampleRunResult[];
+};
+
+export declare type ExampleRunResult = {
+    name: string;
+    passed: boolean;
+    outcome: ExampleRunOutcome;
+    actual?: unknown;
+    error?: string;
+    durationMs?: number;
+    traceHits?: string[];
+};
+
 declare type ExposedStore<T> = UseBoundStore<StoreApi<T>> & {
     setState: (partial: Partial<T>) => void;
 };
@@ -1334,6 +1452,10 @@ declare type ExtensionParams = {
     type?: 'standard' | 'unary' | 'template';
 };
 
+export declare const FixturesPanel: default_2.FC;
+
+export declare type FixturesRunner = (graph: DecisionGraphType, fixtures: ContractFixture[]) => Promise<ExampleRunReport>;
+
 declare const Function_2: default_2.FC<FunctionProps>;
 export { Function_2 as Function }
 
@@ -1497,6 +1619,8 @@ declare type GraphTabsProps = {
     tabBarExtraContent?: TabsProps['tabBarExtraContent'];
 };
 
+export declare const hasExampleDrift: (drift: RequestExampleDrift) => boolean;
+
 declare type HitPolicy = 'first' | 'collect';
 
 export declare type I18nMessages = Record<string, string>;
@@ -1522,6 +1646,22 @@ declare type InferTypeData<T> = {
 
 declare type Input = unknown;
 
+export declare const INPUT_CONTRACT_VERSION = 1;
+
+export declare type InputContract = {
+    contractVersion: number;
+    schema: RequestJsonSchema;
+    examples: InputContractExample[];
+};
+
+export declare type InputContractExample = {
+    id: string;
+    name: string;
+    description?: string;
+    data: Record<string, unknown>;
+    schemaFingerprint?: string;
+};
+
 export declare const inputNodeSchema: z.ZodObject<{
     type: z.ZodLiteral<NodeKind.Input>;
     content: z.ZodDefault<z.ZodObject<{
@@ -1534,6 +1674,17 @@ export declare const inputNodeSchema: z.ZodObject<{
         }, z.core.$strip>>>;
         inputField: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
         outputPath: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
+        inputContract: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            contractVersion: z.ZodDefault<z.ZodNumber>;
+            schema: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>>>, z.ZodTransform<Record<string, any>, string | Record<string, any> | null | undefined>>;
+            examples: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodDefault<z.ZodString>;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                schemaFingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
     id: z.ZodDefault<z.ZodString>;
     name: z.ZodString;
@@ -1617,6 +1768,11 @@ declare interface MenuProps {
     onClick?: MenuItemType['onClick'];
 }
 
+export declare const migrateRequestExampleDataByDefinitions: (data: Record<string, unknown>, definitions: Array<Pick<RequestDefinition, "name" | "path" | "type" | "defaultValue">>) => {
+    data: Record<string, unknown>;
+    conflicts: RequestDefinitionSyncConflict[];
+};
+
 export declare type MinimalNodeProps = Pick<NodeProps, 'id' | 'selected'> & {
     data: any;
 };
@@ -1855,6 +2011,17 @@ export declare const nodeSchema: z.ZodUnion<[z.ZodDiscriminatedUnion<[z.ZodObjec
         }, z.core.$strip>>>;
         inputField: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
         outputPath: z.ZodPipe<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>, z.ZodTransform<string | null, string | null>>;
+        inputContract: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            contractVersion: z.ZodDefault<z.ZodNumber>;
+            schema: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>>>, z.ZodTransform<Record<string, any>, string | Record<string, any> | null | undefined>>;
+            examples: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodDefault<z.ZodString>;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                schemaFingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
     id: z.ZodDefault<z.ZodString>;
     name: z.ZodString;
@@ -2054,10 +2221,16 @@ declare interface RadioGroupProps {
     style?: React_2.CSSProperties;
 }
 
+export declare const readRequestInputContract: (content?: RequestContentLike | null) => {
+    contract: InputContract;
+    origin: RequestInputContractOrigin;
+};
+
 declare type RequestContentLike = {
     schema?: unknown;
     schemaUI?: unknown;
     inputs?: LegacyRequestInput[];
+    inputContract?: InputContract;
 };
 
 export declare type RequestDefinition = {
@@ -2074,8 +2247,20 @@ export declare type RequestDefinition = {
     defaultValue?: string;
 };
 
+declare type RequestDefinitionSyncConflict = {
+    path: string;
+    nextType: RequestDefinitionType;
+    value: unknown;
+};
+
 export declare type RequestDefinitionType = 'number' | 'string' | 'array' | 'object' | 'datetime' | 'boolean';
 
+export declare type RequestExampleDrift = {
+    missing: Array<Pick<RequestDefinition, 'name' | 'path' | 'type'>>;
+    extra: string[];
+    conflicts: RequestDefinitionSyncConflict[];
+};
+
 declare type RequestExampleMeta = {
     name?: string;
     description?: string;
@@ -2089,6 +2274,8 @@ export declare type RequestExampleSource = {
     source: 'schema.examples' | 'content.inputs';
 };
 
+declare type RequestInputContractOrigin = 'contract' | 'legacy';
+
 declare type RequestJsonSchema = {
     'type'?: string | string[];
     'description'?: string;
@@ -2101,6 +2288,8 @@ declare type RequestJsonSchema = {
     [key: string]: unknown;
 };
 
+export declare const requestSchemaFingerprint: (schema: unknown) => string;
+
 export declare const resolveRequestSchemaValue: (content?: RequestContentLike | null, options?: {
     includeExamples?: boolean;
 }) => RequestJsonSchema | null;
@@ -2508,19 +2697,21 @@ declare type ViewConfig = {
 
 declare type ViewConfigPermission = 'edit:values' | 'edit:rules' | 'edit:full';
 
+export declare const writeRequestInputContract: (content: RequestContentLike & Record<string, any>, contract: InputContract) => InputContract;
+
 export { }
 
 
-declare global {
-    interface Window {
-        monaco?: Monaco;
+declare module '@gorules/zen-engine-wasm' {
+    interface VariableType {
+        __hash: string;
     }
 }
 
 
-declare module '@gorules/zen-engine-wasm' {
-    interface VariableType {
-        __hash: string;
+declare global {
+    interface Window {
+        monaco?: Monaco;
     }
 }