@decaf-ts/ui-decorators 0.19.0 → 0.20.0

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

@@ -1,6 +1,8 @@
 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 = {
@@ -83,7 +85,14 @@ export type GraphWorkflowSnapshotState = {
     ui: Record<string, unknown>;
     metadata: Record<string, unknown>;
 };
-export type GraphWorkflowSnapshot = {
+/**
+ * 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: typeof GRAPH_WORKFLOW_SNAPSHOT_VERSION;
     definition: GraphWorkflowSnapshotDefinition;
     state: GraphWorkflowSnapshotState;
@@ -98,10 +107,61 @@ export type GraphWorkflowSnapshotInput = {
     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): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotRestore<M extends Model>(snapshot: GraphWorkflowSnapshot | GraphWorkflowSnapshotInput, model?: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotToJSON(snapshot: GraphWorkflowSnapshot, space?: number): string;
-export declare function graphWorkflowSnapshotFromJSON(input: string | GraphWorkflowSnapshot, model?: GraphModelLike | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotInputValuesOf(snapshot: GraphWorkflowSnapshot): Record<string, unknown>;
-export declare function graphWorkflowSnapshotOutputValuesOf(snapshot: GraphWorkflowSnapshot): Record<string, unknown>;
+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 snapshot to the canonical {@link GraphWorkflowDocument}. */
+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,6 +1,8 @@
 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 = {
@@ -83,7 +85,14 @@ export type GraphWorkflowSnapshotState = {
     ui: Record<string, unknown>;
     metadata: Record<string, unknown>;
 };
-export type GraphWorkflowSnapshot = {
+/**
+ * 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: typeof GRAPH_WORKFLOW_SNAPSHOT_VERSION;
     definition: GraphWorkflowSnapshotDefinition;
     state: GraphWorkflowSnapshotState;
@@ -98,10 +107,61 @@ export type GraphWorkflowSnapshotInput = {
     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): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotRestore<M extends Model>(snapshot: GraphWorkflowSnapshot | GraphWorkflowSnapshotInput, model?: GraphModelLike<M> | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotToJSON(snapshot: GraphWorkflowSnapshot, space?: number): string;
-export declare function graphWorkflowSnapshotFromJSON(input: string | GraphWorkflowSnapshot, model?: GraphModelLike | GraphWorkflowDefinition | GraphWorkflowSnapshotDefinition): GraphWorkflowSnapshot;
-export declare function graphWorkflowSnapshotInputValuesOf(snapshot: GraphWorkflowSnapshot): Record<string, unknown>;
-export declare function graphWorkflowSnapshotOutputValuesOf(snapshot: GraphWorkflowSnapshot): Record<string, unknown>;
+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 snapshot to the canonical {@link GraphWorkflowDocument}. */
+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/types.d.cts

@@ -1,3 +1,3 @@
 export { PortDirection } from "./constants.d.cts";
 export type { GraphConnectionRule, GraphNodeDefinition, GraphNodeKind, GraphNodeMetadata, GraphPortDefinition, GraphPortMetadata, GraphWorkflowDefinition, GraphWorkflowMetadata, GraphWorkflowNodeMetadata, GraphWorkflowRelationMetadata, } from "./constants.d.cts";
-export type { GraphWorkflowSnapshot, GraphWorkflowSnapshotDefinition, GraphWorkflowSnapshotEdge, GraphWorkflowSnapshotInput, GraphWorkflowSnapshotNode, GraphWorkflowSnapshotPosition, GraphWorkflowSnapshotReference, GraphWorkflowSnapshotSize, GraphWorkflowSnapshotState, GraphWorkflowSnapshotValue, GraphWorkflowSnapshotPortState, } from "./snapshot.d.cts";
+export type { GraphWorkflowSnapshot, LegacyGraphWorkflowSnapshot, GraphWorkflowSnapshotDefinition, GraphWorkflowSnapshotEdge, GraphWorkflowSnapshotInput, GraphWorkflowSnapshotNode, GraphWorkflowSnapshotPosition, GraphWorkflowSnapshotReference, GraphWorkflowSnapshotSize, GraphWorkflowSnapshotState, GraphWorkflowSnapshotValue, GraphWorkflowSnapshotPortState, GraphWorkflowSnapshotLike, GraphSnapshotEditorState, } from "./snapshot.d.cts";

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

@@ -1,3 +1,3 @@
 export { PortDirection } from "./constants.d.mts";
 export type { GraphConnectionRule, GraphNodeDefinition, GraphNodeKind, GraphNodeMetadata, GraphPortDefinition, GraphPortMetadata, GraphWorkflowDefinition, GraphWorkflowMetadata, GraphWorkflowNodeMetadata, GraphWorkflowRelationMetadata, } from "./constants.d.mts";
-export type { GraphWorkflowSnapshot, GraphWorkflowSnapshotDefinition, GraphWorkflowSnapshotEdge, GraphWorkflowSnapshotInput, GraphWorkflowSnapshotNode, GraphWorkflowSnapshotPosition, GraphWorkflowSnapshotReference, GraphWorkflowSnapshotSize, GraphWorkflowSnapshotState, GraphWorkflowSnapshotValue, GraphWorkflowSnapshotPortState, } from "./snapshot.d.mts";
+export type { GraphWorkflowSnapshot, LegacyGraphWorkflowSnapshot, GraphWorkflowSnapshotDefinition, GraphWorkflowSnapshotEdge, GraphWorkflowSnapshotInput, GraphWorkflowSnapshotNode, GraphWorkflowSnapshotPosition, GraphWorkflowSnapshotReference, GraphWorkflowSnapshotSize, GraphWorkflowSnapshotState, GraphWorkflowSnapshotValue, GraphWorkflowSnapshotPortState, GraphWorkflowSnapshotLike, GraphSnapshotEditorState, } from "./snapshot.d.mts";

package/lib/types/index.d.cts

@@ -15,19 +15,19 @@ export * from "./ui/index.d.cts";
  * @const VERSION
  * @memberOf module:ui-decorators
  */
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.19.1";
 /**
  * @description Represents the current commit hash of the module build.
  * @summary Stores the current git commit hash for the package. The build replaces
  * the placeholder with the actual commit hash at publish time.
  * @const COMMIT
  */
-export declare const COMMIT = "23dcb33";
+export declare const COMMIT = "e9c549d";
 /**
  * @description Represents the full version string of the module.
  * @summary Stores the semver version and commit hash for the package.
  * The build replaces the placeholder with the actual `<version>-<commit>` value at publish time.
  * @const FULL_VERSION
  */
-export declare const FULL_VERSION = "0.18.0-23dcb33";
+export declare const FULL_VERSION = "0.19.1-e9c549d";
 export declare const PACKAGE_NAME = "@decaf-ts/ui-decorators";

package/lib/types/index.d.mts

@@ -15,19 +15,19 @@ export * from "./ui/index.d.mts";
  * @const VERSION
  * @memberOf module:ui-decorators
  */
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.19.1";
 /**
  * @description Represents the current commit hash of the module build.
  * @summary Stores the current git commit hash for the package. The build replaces
  * the placeholder with the actual commit hash at publish time.
  * @const COMMIT
  */
-export declare const COMMIT = "23dcb33";
+export declare const COMMIT = "e9c549d";
 /**
  * @description Represents the full version string of the module.
  * @summary Stores the semver version and commit hash for the package.
  * The build replaces the placeholder with the actual `<version>-<commit>` value at publish time.
  * @const FULL_VERSION
  */
-export declare const FULL_VERSION = "0.18.0-23dcb33";
+export declare const FULL_VERSION = "0.19.1-e9c549d";
 export declare const PACKAGE_NAME = "@decaf-ts/ui-decorators";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/ui-decorators",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Extension of decorator validation to ui elements to allow for web integration",
   "type": "module",
   "exports": {
@@ -122,9 +122,7 @@
     "@decaf-ts/core": "latest",
     "@decaf-ts/db-decorators": "latest",
     "@decaf-ts/decoration": "latest",
-    "@decaf-ts/decorator-validation": "latest",
-    "better-docs": "^2.7.3",
-    "taffydb": "^2.7.3"
+    "@decaf-ts/decorator-validation": "latest"
   },
   "main": "./lib/cjs/index.cjs",
   "module": "./lib/esm/index.js",
@@ -136,7 +134,9 @@
     "./lib/cjs/overrides/index.cjs",
     "./lib/cjs/graph/overrides/index.cjs",
     "./lib/cjs/graph/overrides/overrides.cjs",
-    "./lib/cjs/model/overrides.cjs"
+    "./lib/cjs/model/overrides.cjs",
+    "./lib/cjs/user-requests/index.cjs",
+    "./lib/cjs/user-requests/index.mjs"
   ],
   "overrides": {
     "test-exclude": "^7.0.2",