@serverlessworkflow/sdk 1.0.0 → 1.0.1

package/lib/generated/classes/index.d.ts

@@ -158,6 +158,8 @@ export declare const Classes: {
     Workflow: import("./workflow").WorkflowConstructor & {
         deserialize(text: string): import("./workflow").WorkflowIntersection;
         serialize(workflow: Partial<import("./workflow").WorkflowIntersection>, format?: "yaml" | "json", normalize?: boolean): string;
+        toGraph(workflow: Partial<import("./workflow").WorkflowIntersection>): import("../../graph-builder").Graph;
+        toMermaidCode(workflow: Partial<import("./workflow").WorkflowIntersection>): string;
     };
     WorkflowMetadata: import("./workflow-metadata").WorkflowMetadataConstructor;
     WorkflowTags: import("./workflow-tags").WorkflowTagsConstructor;

package/lib/generated/classes/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/generated/classes/index.ts"],"names":[],"mappings":"AAiLA,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiKnB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/generated/classes/index.ts"],"names":[],"mappings":"AAiLA,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiKnB,CAAC"}

package/lib/generated/classes/workflow.d.ts

@@ -1,5 +1,6 @@
 import { ObjectHydrator } from '../../hydrator';
 import { Specification } from '../definitions';
+import { Graph } from '../../graph-builder';
 /**
  * Represents the intersection between the Workflow class and type
  */
@@ -36,6 +37,8 @@ export declare class Workflow extends ObjectHydrator<Specification.Workflow> {
     normalize(): Workflow & Specification.Workflow;
     static deserialize(text: string): WorkflowIntersection;
     static serialize(model: Partial<WorkflowIntersection>, format?: 'yaml' | 'json', normalize?: boolean): string;
+    static toGraph(model: Partial<WorkflowIntersection>): Graph;
+    static toMermaidCode(model: Partial<WorkflowIntersection>): string;
     /**
      * Serializes the workflow to YAML or JSON
      * @param format The format, 'yaml' or 'json', default is 'yaml'
@@ -43,6 +46,16 @@ export declare class Workflow extends ObjectHydrator<Specification.Workflow> {
      * @returns A string representation of the workflow
      */
     serialize(format?: 'yaml' | 'json', normalize?: boolean): string;
+    /**
+     * Creates a directed graph representation of the workflow
+     * @returns A directed graph of the workflow
+     */
+    toGraph(): Graph;
+    /**
+     * Generates the MermaidJS code corresponding to the workflow
+     * @returns The MermaidJS code
+     */
+    toMermaidCode(): string;
 }
 export declare const _Workflow: WorkflowConstructor & {
     /**
@@ -59,5 +72,17 @@ export declare const _Workflow: WorkflowConstructor & {
      * @returns A string representation of the workflow
      */
     serialize(workflow: Partial<WorkflowIntersection>, format?: "yaml" | "json", normalize?: boolean): string;
+    /**
+     * Creates a directed graph representation of the provided workflow
+     * @param workflow The workflow to convert
+     * @returns A directed graph of the provided workflow
+     */
+    toGraph(workflow: Partial<WorkflowIntersection>): Graph;
+    /**
+     * Generates the MermaidJS code corresponding to the provided workflow
+     * @param workflow The workflow to convert
+     * @returns The MermaidJS code
+     */
+    toMermaidCode(workflow: Partial<WorkflowIntersection>): string;
 };
 //# sourceMappingURL=workflow.d.ts.map

package/lib/generated/classes/workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../../../../src/lib/generated/classes/workflow.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAM/C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,KAAK,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC;CACrE;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC;IAClE;;;;;OAKG;gBACS,KAAK,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;IAenD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;IAKnD;;;;;OAKG;IACH,SAAS,IAAI,QAAQ,GAAG,aAAa,CAAC,QAAQ;IAK9C,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB;IAMtD,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,EACpC,MAAM,GAAE,MAAM,GAAG,MAAe,EAChC,SAAS,GAAE,OAAc,GACxB,MAAM;IAUT;;;;;OAKG;IACH,SAAS,CAAC,MAAM,GAAE,MAAM,GAAG,MAAe,EAAE,SAAS,GAAE,OAAc,GAAG,MAAM;CAG/E;AAED,eAAO,MAAM,SAAS,EAAe,mBAAmB,GAAG;IACzD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAEhD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3G,CAAC"}
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../../../../src/lib/generated/classes/workflow.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAK/C,OAAO,EAAc,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,KAAK,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC;CACrE;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC;IAClE;;;;;OAKG;gBACS,KAAK,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;IAenD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;IAKnD;;;;;OAKG;IACH,SAAS,IAAI,QAAQ,GAAG,aAAa,CAAC,QAAQ;IAK9C,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB;IAMtD,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,EACpC,MAAM,GAAE,MAAM,GAAG,MAAe,EAChC,SAAS,GAAE,OAAc,GACxB,MAAM;IAUT,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,KAAK;IAI3D,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,MAAM;IAIlE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,GAAE,MAAM,GAAG,MAAe,EAAE,SAAS,GAAE,OAAc,GAAG,MAAM;IAI9E;;;OAGG;IACH,OAAO,IAAI,KAAK;IAIhB;;;OAGG;IACH,aAAa,IAAI,MAAM;CAGxB;AAED,eAAO,MAAM,SAAS,EAAe,mBAAmB,GAAG;IACzD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAEhD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE1G;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC;IAExD;;;;OAIG;IACH,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;CAChE,CAAC"}

package/lib/graph-builder.d.ts

@@ -0,0 +1,74 @@
+import { Workflow } from './generated/definitions/specification';
+/**
+ * Represents a generic within a graph.
+ * This serves as a base type for nodes, edges, and graphs.
+ */
+export type GraphElement = {
+    /** A unique identifier for this graph element. */
+    id: string;
+    /** An optional label to provide additional context or naming. */
+    label?: string | null;
+};
+/**
+ * Enumeration of possible node types in a graph.
+ */
+export declare enum GraphNodeType {
+    Root = "root",
+    Start = "start",
+    End = "end",
+    Entry = "entry",
+    Exit = "exit",
+    Call = "call",
+    Catch = "catch",
+    Do = "do",
+    Emit = "emit",
+    For = "for",
+    Fork = "fork",
+    Listen = "listen",
+    Raise = "raise",
+    Run = "run",
+    Set = "set",
+    Switch = "switch",
+    Try = "try",
+    TryCatch = "try-catch",
+    Wait = "wait"
+}
+/**
+ * Represents a node within the graph.
+ */
+export type GraphNode = GraphElement & {
+    /** The type of the node. */
+    type: GraphNodeType;
+};
+/**
+ * Represents a directed edge connecting two nodes in the graph.
+ */
+export type GraphEdge = GraphElement & {
+    /** The unique identifier of the node where the edge originates. */
+    sourceId: string;
+    /** The unique identifier of the node where the edge terminates. */
+    destinationId: string;
+};
+/**
+ * Represents a graph or a subgraph
+ */
+export type Graph = GraphNode & {
+    /** The parent graph if this is a subgraph, otherwise null. */
+    parent?: Graph | null;
+    /** A collection of nodes that belong to this graph. */
+    nodes: GraphNode[];
+    /** A collection of edges that define relationships between nodes. */
+    edges: GraphEdge[];
+    /** The entry node of the graph. */
+    entryNode: GraphNode;
+    /** The exit node of the graph. */
+    exitNode: GraphNode;
+};
+/**
+ * Constructs a graph representation based on the given workflow.
+ *
+ * @param workflow The workflow to be converted into a graph structure.
+ * @returns A graph representation of the workflow.
+ */
+export declare function buildGraph(workflow: Workflow): Graph;
+//# sourceMappingURL=graph-builder.d.ts.map

package/lib/graph-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-builder.d.ts","sourceRoot":"","sources":["../../../src/lib/graph-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAeL,QAAQ,EACT,MAAM,uCAAuC,CAAC;AAa/C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa;IACvB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,EAAE,OAAO;IACT,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,QAAQ,cAAc;IACtB,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG;IACrC,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG;IACrC,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG;IAC9B,8DAA8D;IAC9D,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IACtB,uDAAuD;IACvD,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,qEAAqE;IACrE,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,mCAAmC;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,kCAAkC;IAClC,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAuFF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,KAAK,CASpD"}

package/lib/mermaid-converter.d.ts

@@ -0,0 +1,21 @@
+import { Workflow } from './generated/definitions/specification';
+/**
+ * Converts the provided workflow to Mermaid code
+ * @param workflow The workflow to convert
+ * @returns The Mermaid diagram
+ */
+export declare function convertToMermaidCode(workflow: Workflow): string;
+/**
+ * Represents a Mermaid diagram generator for a given workflow.
+ * This class takes a workflow definition and converts it into a Mermaid.js-compatible diagram.
+ */
+export declare class MermaidDiagram {
+    private workflow;
+    constructor(workflow: Workflow);
+    /**
+     * Generates the Mermaid code representation of the workflow.
+     * @returns The Mermaid diagram source code as a string.
+     */
+    sourceCode(): string;
+}
+//# sourceMappingURL=mermaid-converter.d.ts.map

package/lib/mermaid-converter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid-converter.d.ts","sourceRoot":"","sources":["../../../src/lib/mermaid-converter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAsEjE;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAQ/D;AAED;;;GAGG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,QAAQ;IAEtC;;;OAGG;IACH,UAAU,IAAI,MAAM;CAGrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serverlessworkflow/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "schemaVersion": "1.0.0",
   "description": "Typescript SDK for Serverless Workflow Specification",
   "main": "umd/index.umd.min.js",

package/serverless-workflow-sdk.d.ts

@@ -2,4 +2,6 @@ export * from './lib/generated/builders';
 export * from './lib/generated/classes';
 export * from './lib/generated/definitions';
 export * from './lib/validation';
+export * from './lib/graph-builder';
+export * from './lib/mermaid-converter';
 //# sourceMappingURL=serverless-workflow-sdk.d.ts.map

package/serverless-workflow-sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serverless-workflow-sdk.d.ts","sourceRoot":"","sources":["../../src/serverless-workflow-sdk.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"serverless-workflow-sdk.d.ts","sourceRoot":"","sources":["../../src/serverless-workflow-sdk.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC"}