@decaf-ts/ui-decorators 0.20.9 → 0.21.1

package/lib/types/graph/nodes/utility/merge.d.mts

@@ -1,12 +0,0 @@
-/**
- * @module ui-decorators/graph/nodes/utility/merge
- * @summary Merge utility node declaration (DECAF-32 §22.2.2).
- * @description Merge — normalises branch/parallel outputs into a single
- * output.
- */
-import { Model } from "@decaf-ts/decorator-validation";
-import "../category-styles";
-export declare class MergeFlowNode extends Model {
-    values: unknown[];
-    merged: unknown;
-}

package/lib/types/graph/nodes/utility/return.d.cts

@@ -1,11 +0,0 @@
-/**
- * @module ui-decorators/graph/nodes/utility/return
- * @summary Return utility node declaration (DECAF-32 §22.2.2).
- * @description Return — defines and normalises the final workflow output.
- */
-import { Model } from "@decaf-ts/decorator-validation";
-import "../category-styles";
-export declare class ReturnFlowNode extends Model {
-    value: unknown;
-    result: unknown;
-}

package/lib/types/graph/nodes/utility/return.d.mts

@@ -1,11 +0,0 @@
-/**
- * @module ui-decorators/graph/nodes/utility/return
- * @summary Return utility node declaration (DECAF-32 §22.2.2).
- * @description Return — defines and normalises the final workflow output.
- */
-import { Model } from "@decaf-ts/decorator-validation";
-import "../category-styles";
-export declare class ReturnFlowNode extends Model {
-    value: unknown;
-    result: unknown;
-}

package/lib/types/graph/nodes/utility/utility-log.d.cts

@@ -1,15 +0,0 @@
-/**
- * @module ui-decorators/graph/nodes/utility/utility-log
- * @summary Utility Log node declaration (DECAF-48 §4.3).
- * @description Utility Log — logs the input value through the run's
- * `ctx.logger` at a configurable level and forwards it unchanged on the
- * `logged` output port.
- */
-import { Model } from "@decaf-ts/decorator-validation";
-import type { LogNodeLevel } from "../../types.d.cts";
-import "../category-styles";
-export declare class UtilityLogNode extends Model {
-    value: unknown;
-    level: LogNodeLevel;
-    logged: unknown;
-}

package/lib/types/graph/nodes/utility/utility-log.d.mts

@@ -1,15 +0,0 @@
-/**
- * @module ui-decorators/graph/nodes/utility/utility-log
- * @summary Utility Log node declaration (DECAF-48 §4.3).
- * @description Utility Log — logs the input value through the run's
- * `ctx.logger` at a configurable level and forwards it unchanged on the
- * `logged` output port.
- */
-import { Model } from "@decaf-ts/decorator-validation";
-import type { LogNodeLevel } from "../../types.d.mts";
-import "../category-styles";
-export declare class UtilityLogNode extends Model {
-    value: unknown;
-    level: LogNodeLevel;
-    logged: unknown;
-}

package/lib/types/graph/overrides/Metadata.d.cts

@@ -1,43 +0,0 @@
-/**
- * @module ui-decorators/graph/overrides/Metadata
- * @summary Metadata namespace augmentation for graph nodes and workflows.
- * @description Extends the `Metadata` class from `@decaf-ts/decoration` with
- * `Metadata.nodes()` and `Metadata.workflows()` accessors that return all
- * `@node`-decorated and `@graph`-decorated constructors respectively.
- *
- * This follows the existing override pattern used by `core` (`core/src/overrides/`)
- * and `decorator-validation` (`decorator-validation/src/overrides/`):
- * 1. This file declares the new static methods on the `Metadata` namespace via
- *    `declare module` (TypeScript declaration merging).
- * 2. The companion `overrides.ts` attaches the implementations to the
- *    `Metadata` class at runtime via `(Metadata as any).fn = ...`.
- * 3. The `index.ts` of this folder side-effect-imports `overrides.ts` so the
- *    attachments run whenever the graph module is loaded.
- * 4. The package's `sideEffects` array in `package.json` includes the compiled
- *    overrides entry points so bundlers preserve the side-effect imports.
- */
-import "@decaf-ts/decoration";
-import type { Constructor } from "@decaf-ts/decoration";
-declare module "@decaf-ts/decoration" {
-    namespace Metadata {
-        /**
-         * Returns all `@node`-decorated constructors.
-         *
-         * The list is populated as a side-effect of the `@node` decorator — every
-         * class decorated with `@node(...)` is appended to the node registry at
-         * decoration time. Consumers (e.g. the for-angular graph palette, CRUD form
-         * builders, executor registries) call this to discover all available node
-         * kinds without a hand-maintained array.
-         * @returns A fresh array of `@node`-decorated constructors.
-         */
-        function nodes(): Constructor[];
-        /**
-         * Returns all `@graph`-decorated constructors (workflow roots).
-         *
-         * Analogous to {@link nodes} but for `@graph`-decorated workflow-root
-         * classes. Populated as a side-effect of the `@graph` decorator.
-         * @returns A fresh array of `@graph`-decorated constructors.
-         */
-        function workflows(): Constructor[];
-    }
-}

package/lib/types/graph/overrides/Metadata.d.mts

@@ -1,43 +0,0 @@
-/**
- * @module ui-decorators/graph/overrides/Metadata
- * @summary Metadata namespace augmentation for graph nodes and workflows.
- * @description Extends the `Metadata` class from `@decaf-ts/decoration` with
- * `Metadata.nodes()` and `Metadata.workflows()` accessors that return all
- * `@node`-decorated and `@graph`-decorated constructors respectively.
- *
- * This follows the existing override pattern used by `core` (`core/src/overrides/`)
- * and `decorator-validation` (`decorator-validation/src/overrides/`):
- * 1. This file declares the new static methods on the `Metadata` namespace via
- *    `declare module` (TypeScript declaration merging).
- * 2. The companion `overrides.ts` attaches the implementations to the
- *    `Metadata` class at runtime via `(Metadata as any).fn = ...`.
- * 3. The `index.ts` of this folder side-effect-imports `overrides.ts` so the
- *    attachments run whenever the graph module is loaded.
- * 4. The package's `sideEffects` array in `package.json` includes the compiled
- *    overrides entry points so bundlers preserve the side-effect imports.
- */
-import "@decaf-ts/decoration";
-import type { Constructor } from "@decaf-ts/decoration";
-declare module "@decaf-ts/decoration" {
-    namespace Metadata {
-        /**
-         * Returns all `@node`-decorated constructors.
-         *
-         * The list is populated as a side-effect of the `@node` decorator — every
-         * class decorated with `@node(...)` is appended to the node registry at
-         * decoration time. Consumers (e.g. the for-angular graph palette, CRUD form
-         * builders, executor registries) call this to discover all available node
-         * kinds without a hand-maintained array.
-         * @returns A fresh array of `@node`-decorated constructors.
-         */
-        function nodes(): Constructor[];
-        /**
-         * Returns all `@graph`-decorated constructors (workflow roots).
-         *
-         * Analogous to {@link nodes} but for `@graph`-decorated workflow-root
-         * classes. Populated as a side-effect of the `@graph` decorator.
-         * @returns A fresh array of `@graph`-decorated constructors.
-         */
-        function workflows(): Constructor[];
-    }
-}

package/lib/types/graph/overrides/Rendering.d.cts

@@ -1,5 +0,0 @@
-import type { FieldDefinition } from "../../ui/types.d.cts";
-import type { Model } from "@decaf-ts/decorator-validation";
-export interface RenderingEngine<T = void, R = FieldDefinition<T>> {
-    renderAsNode<M extends Model>(model: M, globalProps: Record<string, unknown>, ...args: any[]): R;
-}

package/lib/types/graph/overrides/Rendering.d.mts

@@ -1,5 +0,0 @@
-import type { FieldDefinition } from "../../ui/types.d.mts";
-import type { Model } from "@decaf-ts/decorator-validation";
-export interface RenderingEngine<T = void, R = FieldDefinition<T>> {
-    renderAsNode<M extends Model>(model: M, globalProps: Record<string, unknown>, ...args: any[]): R;
-}

package/lib/types/graph/overrides/index.d.cts

@@ -1,3 +0,0 @@
-import "./Rendering";
-export * from "./overrides.d.cts";
-export * from "./Metadata.d.cts";

package/lib/types/graph/overrides/index.d.mts

@@ -1,3 +0,0 @@
-import "./Rendering";
-export * from "./overrides.d.mts";
-export * from "./Metadata.d.mts";

package/lib/types/graph/overrides/overrides.d.cts

@@ -1 +0,0 @@
-import "./Rendering";

package/lib/types/graph/overrides/overrides.d.mts

@@ -1 +0,0 @@
-import "./Rendering";

package/lib/types/graph/reader.d.cts

@@ -1,16 +0,0 @@
-import { Constructor } from "@decaf-ts/decoration";
-import { Model } from "@decaf-ts/decorator-validation";
-import type { GraphNodeDefinition, GraphNodeMetadata, GraphPortDefinition, GraphPortMetadata, GraphWorkflowDefinition, GraphWorkflowMetadata } from "./constants.d.cts";
-import "../model/overrides";
-type GraphModelLike<M extends Model = Model> = Constructor<M> | M;
-export declare function graphNodeMetadataOf<M extends Model>(model: GraphModelLike<M>): GraphNodeMetadata | undefined;
-export declare function graphWorkflowMetadataOf<M extends Model>(model: GraphModelLike<M>): GraphWorkflowMetadata | undefined;
-export declare function graphPortMetadataOf<M extends Model>(model: GraphModelLike<M>, property: keyof M | string): GraphPortMetadata | undefined;
-export declare function graphPortDefinitionOf<M extends Model>(model: GraphModelLike<M>, property: keyof M | string): GraphPortDefinition | undefined;
-export declare function graphPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphLeafPortsOf(ports: GraphPortDefinition[]): GraphPortDefinition[];
-export declare function graphWorkflowInputLeafPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphWorkflowOutputLeafPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphDefinitionOf<M extends Model>(model: GraphModelLike<M>): GraphNodeDefinition;
-export declare function graphWorkflowDefinitionOf<M extends Model>(model: GraphModelLike<M>): GraphWorkflowDefinition;
-export {};

package/lib/types/graph/reader.d.mts

@@ -1,16 +0,0 @@
-import { Constructor } from "@decaf-ts/decoration";
-import { Model } from "@decaf-ts/decorator-validation";
-import type { GraphNodeDefinition, GraphNodeMetadata, GraphPortDefinition, GraphPortMetadata, GraphWorkflowDefinition, GraphWorkflowMetadata } from "./constants.d.mts";
-import "../model/overrides";
-type GraphModelLike<M extends Model = Model> = Constructor<M> | M;
-export declare function graphNodeMetadataOf<M extends Model>(model: GraphModelLike<M>): GraphNodeMetadata | undefined;
-export declare function graphWorkflowMetadataOf<M extends Model>(model: GraphModelLike<M>): GraphWorkflowMetadata | undefined;
-export declare function graphPortMetadataOf<M extends Model>(model: GraphModelLike<M>, property: keyof M | string): GraphPortMetadata | undefined;
-export declare function graphPortDefinitionOf<M extends Model>(model: GraphModelLike<M>, property: keyof M | string): GraphPortDefinition | undefined;
-export declare function graphPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphLeafPortsOf(ports: GraphPortDefinition[]): GraphPortDefinition[];
-export declare function graphWorkflowInputLeafPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphWorkflowOutputLeafPortsOf<M extends Model>(model: GraphModelLike<M>): GraphPortDefinition[];
-export declare function graphDefinitionOf<M extends Model>(model: GraphModelLike<M>): GraphNodeDefinition;
-export declare function graphWorkflowDefinitionOf<M extends Model>(model: GraphModelLike<M>): GraphWorkflowDefinition;
-export {};

package/lib/types/graph/registry.d.cts

@@ -1,40 +0,0 @@
-/**
- * @module ui-decorators/graph/registry
- * @summary Node and workflow class registries.
- * @description Module-level registries that track every `@node`-decorated and
- * `@graph`-decorated constructor. The `@node` and `@graph` decorators call
- * {@link registerNode} / {@link registerWorkflow} as a side-effect; consumers
- * discover all decorated classes via {@link graphNodes} / {@link graphWorkflows}
- * or the `Metadata.nodes()` / `Metadata.workflows()` accessors.
- *
- * This follows the same pattern as `Injectables` (`injectable-decorators`)
- * which maintains its own `InjectablesRegistry` rather than using the private
- * `Metadata.innerGet`/`innerSet` helpers.
- */
-import type { Constructor } from "@decaf-ts/decoration";
-/**
- * Appends a constructor to the node registry. Called by the `@node` decorator.
- * Idempotent — re-decorating the same class does not duplicate the entry.
- * @param ctor The `@node`-decorated constructor.
- */
-export declare function registerNode(ctor: Constructor): void;
-/**
- * Appends a constructor to the workflow registry. Called by the `@graph`
- * decorator. Idempotent.
- * @param ctor The `@graph`-decorated constructor.
- */
-export declare function registerWorkflow(ctor: Constructor): void;
-/**
- * Returns all `@node`-decorated constructors.
- * @returns A fresh array of constructors (mutable; does not expose the internal set).
- */
-export declare function graphNodes(): Constructor[];
-/**
- * Returns all `@graph`-decorated constructors.
- * @returns A fresh array of constructors.
- */
-export declare function graphWorkflows(): Constructor[];
-/**
- * Clears both registries. Intended for tests only.
- */
-export declare function resetGraphRegistries(): void;

package/lib/types/graph/registry.d.mts

@@ -1,40 +0,0 @@
-/**
- * @module ui-decorators/graph/registry
- * @summary Node and workflow class registries.
- * @description Module-level registries that track every `@node`-decorated and
- * `@graph`-decorated constructor. The `@node` and `@graph` decorators call
- * {@link registerNode} / {@link registerWorkflow} as a side-effect; consumers
- * discover all decorated classes via {@link graphNodes} / {@link graphWorkflows}
- * or the `Metadata.nodes()` / `Metadata.workflows()` accessors.
- *
- * This follows the same pattern as `Injectables` (`injectable-decorators`)
- * which maintains its own `InjectablesRegistry` rather than using the private
- * `Metadata.innerGet`/`innerSet` helpers.
- */
-import type { Constructor } from "@decaf-ts/decoration";
-/**
- * Appends a constructor to the node registry. Called by the `@node` decorator.
- * Idempotent — re-decorating the same class does not duplicate the entry.
- * @param ctor The `@node`-decorated constructor.
- */
-export declare function registerNode(ctor: Constructor): void;
-/**
- * Appends a constructor to the workflow registry. Called by the `@graph`
- * decorator. Idempotent.
- * @param ctor The `@graph`-decorated constructor.
- */
-export declare function registerWorkflow(ctor: Constructor): void;
-/**
- * Returns all `@node`-decorated constructors.
- * @returns A fresh array of constructors (mutable; does not expose the internal set).
- */
-export declare function graphNodes(): Constructor[];
-/**
- * Returns all `@graph`-decorated constructors.
- * @returns A fresh array of constructors.
- */
-export declare function graphWorkflows(): Constructor[];
-/**
- * Clears both registries. Intended for tests only.
- */
-export declare function resetGraphRegistries(): void;

package/lib/types/graph/snapshot.d.cts

@@ -1,176 +0,0 @@
-import { Constructor } from "@decaf-ts/decoration";
-import { Model } from "@decaf-ts/decorator-validation";
-import { GraphPortDefinition, GraphWorkflowDefinition, GraphWorkflowMetadata, GraphWorkflowNodeMetadata, GraphWorkflowRelationMetadata } from "./constants.d.cts";
-import type { GraphWorkflowDocument } from "./document/GraphWorkflowDocument.d.cts";
-import type { GraphJsonValue } from "./document/GraphJsonValue.d.cts";
-type GraphModelLike<M extends Model = Model> = Constructor<M> | M;
-export declare const GRAPH_WORKFLOW_SNAPSHOT_VERSION: 1;
-export type GraphWorkflowSnapshotReference = {
-    id?: string;
-    kind?: string;
-    tag?: string;
-    path?: string;
-    property?: string;
-};
-export type GraphWorkflowSnapshotPosition = {
-    x: number;
-    y: number;
-};
-export type GraphWorkflowSnapshotSize = {
-    width?: number;
-    height?: number;
-};
-export type GraphWorkflowSnapshotPortState = {
-    expanded?: boolean;
-    value?: unknown;
-    mode?: "port" | "value";
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotValue = {
-    path: string;
-    value?: unknown;
-    label?: string;
-    type?: string;
-    required?: boolean;
-    model?: string;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotNode = {
-    id: string;
-    ref?: GraphWorkflowSnapshotReference;
-    label?: string;
-    kind?: string;
-    position?: GraphWorkflowSnapshotPosition;
-    size?: GraphWorkflowSnapshotSize;
-    expanded?: boolean;
-    ports?: Record<string, GraphWorkflowSnapshotPortState>;
-    data?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotEdge = {
-    id: string;
-    source: string;
-    sourceRef?: string;
-    sourcePort?: string;
-    target: string;
-    targetRef?: string;
-    targetPort?: string;
-    label?: string;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotDefinition = {
-    name: string;
-    tag: string;
-    kind: string;
-    category?: string;
-    color?: string;
-    group?: string;
-    height?: number;
-    icon?: string;
-    labels: string[];
-    maxChildren?: number;
-    minWidth?: number;
-    width?: number;
-    metadata?: GraphWorkflowMetadata;
-    inputs: GraphPortDefinition[];
-    outputs: GraphPortDefinition[];
-    nodes: GraphWorkflowNodeMetadata[];
-    relations: GraphWorkflowRelationMetadata[];
-};
-export type GraphWorkflowSnapshotState = {
-    inputs: GraphWorkflowSnapshotValue[];
-    outputs: GraphWorkflowSnapshotValue[];
-    nodes: GraphWorkflowSnapshotNode[];
-    edges: GraphWorkflowSnapshotEdge[];
-    ui: Record<string, unknown>;
-    metadata: Record<string, unknown>;
-};
-/** Snapshot schema version literal type ({@link GRAPH_WORKFLOW_SNAPSHOT_VERSION}). */
-export type GraphWorkflowSnapshotVersion = typeof GRAPH_WORKFLOW_SNAPSHOT_VERSION;
-/**
- * Legacy persisted snapshot (`{ version, definition, state }`). Kept only for
- * loading/compatibility of persisted data; the canonical snapshot is
- * {@link GraphWorkflowSnapshot} (`{ document, editor?, metadata? }`).
- * Convert with {@link graphWorkflowSnapshotFromLegacy} /
- * {@link graphWorkflowSnapshotToLegacy}.
- */
-export type LegacyGraphWorkflowSnapshot = {
-    version: GraphWorkflowSnapshotVersion;
-    definition: GraphWorkflowSnapshotDefinition;
-    state: GraphWorkflowSnapshotState;
-};
-export type GraphWorkflowSnapshotInput = {
-    definition?: Partial<GraphWorkflowSnapshotDefinition>;
-    inputs?: GraphWorkflowSnapshotValue[] | Record<string, unknown>;
-    outputs?: GraphWorkflowSnapshotValue[] | Record<string, unknown>;
-    nodes?: GraphWorkflowSnapshotNode[];
-    edges?: GraphWorkflowSnapshotEdge[];
-    ui?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-};
-export declare function graphWorkflowSnapshotDefinitionOf<M extends Model>(model: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshotDefinition;
-export declare function graphWorkflowSnapshotOf<M extends Model>(model: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition, input?: GraphWorkflowSnapshotInput): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotRestore<M extends Model>(snapshot: LegacyGraphWorkflowSnapshot | GraphWorkflowSnapshotInput, model?: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotToJSON(snapshot: LegacyGraphWorkflowSnapshot, space?: number): string;
-export declare function graphWorkflowSnapshotFromJSON(input: string | LegacyGraphWorkflowSnapshot, model?: GraphModelLike | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotInputValuesOf(snapshot: LegacyGraphWorkflowSnapshot): Record<string, unknown>;
-export declare function graphWorkflowSnapshotOutputValuesOf(snapshot: LegacyGraphWorkflowSnapshot): Record<string, unknown>;
-/**
- * Editor-only state that the canonical {@link GraphWorkflowDocument} cannot
- * express (layout beyond node positions, config-store values, per-port modes,
- * workflow boundary values, and duplicate counts). Stored as JSON-safe values
- * only; constructors and `modelClass`/`sourceClass` references are dropped.
- */
-export type GraphSnapshotEditorState = {
-    viewport?: {
-        x: number;
-        y: number;
-        scale: number;
-    };
-    duplicateCounts?: Record<string, number>;
-    boundaryInputValues?: Record<string, GraphJsonValue>;
-    boundaryOutputValues?: Record<string, GraphJsonValue>;
-    nodePorts?: Record<string, Record<string, GraphJsonValue>>;
-    nodeConfigs?: Record<string, GraphJsonValue>;
-    diagramMetadata?: Record<string, GraphJsonValue>;
-    definitionDisplay?: Record<string, GraphJsonValue>;
-    legacy?: GraphJsonValue;
-} & {
-    [key: string]: GraphJsonValue | undefined;
-};
-/**
- * Canonical document-first snapshot. `document` is the executable semantic
- * truth; `editor` preserves legacy editor-only state for lossless round trips.
- */
-export type GraphWorkflowSnapshot = {
-    document: GraphWorkflowDocument;
-    editor?: GraphSnapshotEditorState;
-    metadata?: Record<string, GraphJsonValue>;
-};
-export type GraphWorkflowSnapshotLike = LegacyGraphWorkflowSnapshot | GraphWorkflowSnapshot;
-/**
- * Maps a legacy (pre-P7) canvas snapshot to the canonical
- * {@link GraphWorkflowDocument} (DECAF-50 §4.4.6): legacy `node.data` becomes
- * instance `parameters`, legacy `node.metadata` becomes instance `metadata`,
- * workflow boundary badges (`input-{port}`) fold back onto their workflow
- * ports, and edge labels missing from cloned edge rows are restored from the
- * decorated definition's relation labels (§4.4.7).
- */
-export declare function graphWorkflowDocumentFromLegacySnapshot(snapshot: LegacyGraphWorkflowSnapshot): GraphWorkflowDocument;
-/**
- * Converts a legacy persisted snapshot into the canonical wrapper. The canonical
- * `document` carries executable semantics; `editor.legacy` keeps the sanitized
- * (constructor-free) legacy payload so a canonical→legacy round trip is lossless
- * for persisted data.
- */
-export declare function graphWorkflowSnapshotFromLegacy(snapshot: LegacyGraphWorkflowSnapshot): GraphWorkflowSnapshot;
-/**
- * Reconstructs a legacy snapshot from a canonical wrapper. Uses the
- * `editor.legacy` payload when present for exact round trips; otherwise it
- * rebuilds a best-effort legacy snapshot from the document + editor state
- * (constructors are never restored).
- */
-export declare function graphWorkflowSnapshotToLegacy(snapshot: GraphWorkflowSnapshot): LegacyGraphWorkflowSnapshot;
-/** Normalizes any accepted snapshot/document form to a canonical wrapper. */
-export declare function graphWorkflowSnapshotLikeToCanonical(value: GraphWorkflowSnapshotLike | GraphWorkflowDocument): GraphWorkflowSnapshot;
-export {};

package/lib/types/graph/snapshot.d.mts

@@ -1,176 +0,0 @@
-import { Constructor } from "@decaf-ts/decoration";
-import { Model } from "@decaf-ts/decorator-validation";
-import { GraphPortDefinition, GraphWorkflowDefinition, GraphWorkflowMetadata, GraphWorkflowNodeMetadata, GraphWorkflowRelationMetadata } from "./constants.d.mts";
-import type { GraphWorkflowDocument } from "./document/GraphWorkflowDocument.d.mts";
-import type { GraphJsonValue } from "./document/GraphJsonValue.d.mts";
-type GraphModelLike<M extends Model = Model> = Constructor<M> | M;
-export declare const GRAPH_WORKFLOW_SNAPSHOT_VERSION: 1;
-export type GraphWorkflowSnapshotReference = {
-    id?: string;
-    kind?: string;
-    tag?: string;
-    path?: string;
-    property?: string;
-};
-export type GraphWorkflowSnapshotPosition = {
-    x: number;
-    y: number;
-};
-export type GraphWorkflowSnapshotSize = {
-    width?: number;
-    height?: number;
-};
-export type GraphWorkflowSnapshotPortState = {
-    expanded?: boolean;
-    value?: unknown;
-    mode?: "port" | "value";
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotValue = {
-    path: string;
-    value?: unknown;
-    label?: string;
-    type?: string;
-    required?: boolean;
-    model?: string;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotNode = {
-    id: string;
-    ref?: GraphWorkflowSnapshotReference;
-    label?: string;
-    kind?: string;
-    position?: GraphWorkflowSnapshotPosition;
-    size?: GraphWorkflowSnapshotSize;
-    expanded?: boolean;
-    ports?: Record<string, GraphWorkflowSnapshotPortState>;
-    data?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotEdge = {
-    id: string;
-    source: string;
-    sourceRef?: string;
-    sourcePort?: string;
-    target: string;
-    targetRef?: string;
-    targetPort?: string;
-    label?: string;
-    metadata?: Record<string, unknown>;
-};
-export type GraphWorkflowSnapshotDefinition = {
-    name: string;
-    tag: string;
-    kind: string;
-    category?: string;
-    color?: string;
-    group?: string;
-    height?: number;
-    icon?: string;
-    labels: string[];
-    maxChildren?: number;
-    minWidth?: number;
-    width?: number;
-    metadata?: GraphWorkflowMetadata;
-    inputs: GraphPortDefinition[];
-    outputs: GraphPortDefinition[];
-    nodes: GraphWorkflowNodeMetadata[];
-    relations: GraphWorkflowRelationMetadata[];
-};
-export type GraphWorkflowSnapshotState = {
-    inputs: GraphWorkflowSnapshotValue[];
-    outputs: GraphWorkflowSnapshotValue[];
-    nodes: GraphWorkflowSnapshotNode[];
-    edges: GraphWorkflowSnapshotEdge[];
-    ui: Record<string, unknown>;
-    metadata: Record<string, unknown>;
-};
-/** Snapshot schema version literal type ({@link GRAPH_WORKFLOW_SNAPSHOT_VERSION}). */
-export type GraphWorkflowSnapshotVersion = typeof GRAPH_WORKFLOW_SNAPSHOT_VERSION;
-/**
- * Legacy persisted snapshot (`{ version, definition, state }`). Kept only for
- * loading/compatibility of persisted data; the canonical snapshot is
- * {@link GraphWorkflowSnapshot} (`{ document, editor?, metadata? }`).
- * Convert with {@link graphWorkflowSnapshotFromLegacy} /
- * {@link graphWorkflowSnapshotToLegacy}.
- */
-export type LegacyGraphWorkflowSnapshot = {
-    version: GraphWorkflowSnapshotVersion;
-    definition: GraphWorkflowSnapshotDefinition;
-    state: GraphWorkflowSnapshotState;
-};
-export type GraphWorkflowSnapshotInput = {
-    definition?: Partial<GraphWorkflowSnapshotDefinition>;
-    inputs?: GraphWorkflowSnapshotValue[] | Record<string, unknown>;
-    outputs?: GraphWorkflowSnapshotValue[] | Record<string, unknown>;
-    nodes?: GraphWorkflowSnapshotNode[];
-    edges?: GraphWorkflowSnapshotEdge[];
-    ui?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-};
-export declare function graphWorkflowSnapshotDefinitionOf<M extends Model>(model: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshotDefinition;
-export declare function graphWorkflowSnapshotOf<M extends Model>(model: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition, input?: GraphWorkflowSnapshotInput): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotRestore<M extends Model>(snapshot: LegacyGraphWorkflowSnapshot | GraphWorkflowSnapshotInput, model?: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotToJSON(snapshot: LegacyGraphWorkflowSnapshot, space?: number): string;
-export declare function graphWorkflowSnapshotFromJSON(input: string | LegacyGraphWorkflowSnapshot, model?: GraphModelLike | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): LegacyGraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotInputValuesOf(snapshot: LegacyGraphWorkflowSnapshot): Record<string, unknown>;
-export declare function graphWorkflowSnapshotOutputValuesOf(snapshot: LegacyGraphWorkflowSnapshot): Record<string, unknown>;
-/**
- * Editor-only state that the canonical {@link GraphWorkflowDocument} cannot
- * express (layout beyond node positions, config-store values, per-port modes,
- * workflow boundary values, and duplicate counts). Stored as JSON-safe values
- * only; constructors and `modelClass`/`sourceClass` references are dropped.
- */
-export type GraphSnapshotEditorState = {
-    viewport?: {
-        x: number;
-        y: number;
-        scale: number;
-    };
-    duplicateCounts?: Record<string, number>;
-    boundaryInputValues?: Record<string, GraphJsonValue>;
-    boundaryOutputValues?: Record<string, GraphJsonValue>;
-    nodePorts?: Record<string, Record<string, GraphJsonValue>>;
-    nodeConfigs?: Record<string, GraphJsonValue>;
-    diagramMetadata?: Record<string, GraphJsonValue>;
-    definitionDisplay?: Record<string, GraphJsonValue>;
-    legacy?: GraphJsonValue;
-} & {
-    [key: string]: GraphJsonValue | undefined;
-};
-/**
- * Canonical document-first snapshot. `document` is the executable semantic
- * truth; `editor` preserves legacy editor-only state for lossless round trips.
- */
-export type GraphWorkflowSnapshot = {
-    document: GraphWorkflowDocument;
-    editor?: GraphSnapshotEditorState;
-    metadata?: Record<string, GraphJsonValue>;
-};
-export type GraphWorkflowSnapshotLike = LegacyGraphWorkflowSnapshot | GraphWorkflowSnapshot;
-/**
- * Maps a legacy (pre-P7) canvas snapshot to the canonical
- * {@link GraphWorkflowDocument} (DECAF-50 §4.4.6): legacy `node.data` becomes
- * instance `parameters`, legacy `node.metadata` becomes instance `metadata`,
- * workflow boundary badges (`input-{port}`) fold back onto their workflow
- * ports, and edge labels missing from cloned edge rows are restored from the
- * decorated definition's relation labels (§4.4.7).
- */
-export declare function graphWorkflowDocumentFromLegacySnapshot(snapshot: LegacyGraphWorkflowSnapshot): GraphWorkflowDocument;
-/**
- * Converts a legacy persisted snapshot into the canonical wrapper. The canonical
- * `document` carries executable semantics; `editor.legacy` keeps the sanitized
- * (constructor-free) legacy payload so a canonical→legacy round trip is lossless
- * for persisted data.
- */
-export declare function graphWorkflowSnapshotFromLegacy(snapshot: LegacyGraphWorkflowSnapshot): GraphWorkflowSnapshot;
-/**
- * Reconstructs a legacy snapshot from a canonical wrapper. Uses the
- * `editor.legacy` payload when present for exact round trips; otherwise it
- * rebuilds a best-effort legacy snapshot from the document + editor state
- * (constructors are never restored).
- */
-export declare function graphWorkflowSnapshotToLegacy(snapshot: GraphWorkflowSnapshot): LegacyGraphWorkflowSnapshot;
-/** Normalizes any accepted snapshot/document form to a canonical wrapper. */
-export declare function graphWorkflowSnapshotLikeToCanonical(value: GraphWorkflowSnapshotLike | GraphWorkflowDocument): GraphWorkflowSnapshot;
-export {};