@decaf-ts/ui-decorators 0.16.2 → 0.17.1

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

@@ -0,0 +1,106 @@
+import { Constructor } from "@decaf-ts/decoration";
+import { Model } from "@decaf-ts/decorator-validation";
+import { GraphPortDefinition, GraphWorkflowDefinition, GraphWorkflowMetadata, GraphWorkflowNodeMetadata, GraphWorkflowRelationMetadata } from "./constants.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;
+    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>;
+};
+export type GraphWorkflowSnapshot = {
+    version: typeof GRAPH_WORKFLOW_SNAPSHOT_VERSION;
+    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): 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 {};

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

@@ -1,2 +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";

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

@@ -1,2 +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";

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.16.1";
+export declare const VERSION = "0.17.0";
 /**
  * @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 = "4889499";
+export declare const COMMIT = "1c6464a";
 /**
  * @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.16.1-4889499";
+export declare const FULL_VERSION = "0.17.0-1c6464a";
 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.16.1";
+export declare const VERSION = "0.17.0";
 /**
  * @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 = "4889499";
+export declare const COMMIT = "1c6464a";
 /**
  * @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.16.1-4889499";
+export declare const FULL_VERSION = "0.17.0-1c6464a";
 export declare const PACKAGE_NAME = "@decaf-ts/ui-decorators";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/ui-decorators",
-  "version": "0.16.2",
+  "version": "0.17.1",
   "description": "Extension of decorator validation to ui elements to allow for web integration",
   "type": "module",
   "exports": {