graphai 0.0.1 → 0.0.2

package/README.md

@@ -1 +1,20 @@
-# dataflow
+# GraphAI
+
+GraphAI is a TypeScript library, which makes it easy to create AI applications that need to call asynchrouns AI API calls multiple times. You just need to describe dependencies among those API calls in a single JSON/YAML file, create a GraphAI object with it, and run it.
+
+Here is an example:
+
+```YAML
+nodes:
+  taskA:
+    params:
+      // app-specific parameters for taskA
+  taskB:
+    params:
+      // app-specific parameters for taskB
+  taskC:
+    params:
+      // app-specific parameters for taskC
+    inputs: [taskA, taskB]
+```
+

package/lib/flow.d.ts

@@ -30,13 +30,13 @@ declare class Node {
     retryCount: number;
     constructor(key: string, data: NodeData);
     asString(): string;
-    complete(result: Record<string, any>, nodes: Record<string, Node>, graph: Graph): void;
-    reportError(result: Record<string, any>, nodes: Record<string, Node>, graph: Graph): void;
-    removePending(key: string, graph: Graph): void;
-    payload(graph: Graph): Record<string, any>;
-    executeIfReady(graph: Graph): void;
+    complete(result: Record<string, any>, nodes: Record<string, Node>, graph: GraphAI): void;
+    reportError(result: Record<string, any>, nodes: Record<string, Node>, graph: GraphAI): void;
+    removePending(key: string, graph: GraphAI): void;
+    payload(graph: GraphAI): Record<string, any>;
+    executeIfReady(graph: GraphAI): void;
 }
-export declare class Graph {
+export declare class GraphAI {
     nodes: Record<string, Node>;
     callback: FlowCallback;
     private runningNodes;

package/lib/flow.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Graph = exports.FlowCommand = exports.NodeState = void 0;
+exports.GraphAI = exports.FlowCommand = exports.NodeState = void 0;
 var NodeState;
 (function (NodeState) {
     NodeState[NodeState["Waiting"] = 0] = "Waiting";
@@ -69,7 +69,7 @@ class Node {
         }
     }
 }
-class Graph {
+class GraphAI {
     constructor(data, callback) {
         this.callback = callback;
         this.runningNodes = new Set();
@@ -115,4 +115,4 @@ class Graph {
         }
     }
 }
-exports.Graph = Graph;
+exports.GraphAI = GraphAI;

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-import { Graph } from "./flow";
-export { Graph };
+import { GraphAI } from "./flow";
+export { GraphAI };

package/lib/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Graph = void 0;
+exports.GraphAI = void 0;
 const flow_1 = require("./flow");
-Object.defineProperty(exports, "Graph", { enumerable: true, get: function () { return flow_1.Graph; } });
+Object.defineProperty(exports, "GraphAI", { enumerable: true, get: function () { return flow_1.GraphAI; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphai",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Asynchronous data flow execution engine to make it simple to build LLM apps.",
   "main": "lib/index.js",
   "scripts": {
@@ -11,14 +11,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/snakajima/dataflow"
+    "url": "git+https://github.com/snakajima/graphai"
   },
   "author": "Satoshi Nakajima",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/snakajima/dataflow/issues"
+    "url": "https://github.com/snakajima/graphai/issues"
   },
-  "homepage": "https://github.com/snakajima/dataflow#readme",
+  "homepage": "https://github.com/snakajima/graphai#readme",
   "devDependencies": {
     "@types/node": "^20.8.7",
     "@typescript-eslint/eslint-plugin": "^6.8.0",

package/src/flow.ts

@@ -49,7 +49,7 @@ class Node {
     return `${this.key}: ${this.state} ${[...this.waitlist]}`    
   }
 
-  public complete(result: Record<string, any>, nodes: Record<string, Node>, graph: Graph) {
+  public complete(result: Record<string, any>, nodes: Record<string, Node>, graph: GraphAI) {
     this.state = NodeState.Completed;
     this.result = result;
     this.waitlist.forEach(key => {
@@ -59,7 +59,7 @@ class Node {
     graph.remove(this);
   }
 
-  public reportError(result: Record<string, any>, nodes: Record<string, Node>, graph: Graph) {
+  public reportError(result: Record<string, any>, nodes: Record<string, Node>, graph: GraphAI) {
     this.state = NodeState.Failed;
     this.result = result;
     if (this.retryCount < this.retryLimit) {
@@ -71,12 +71,12 @@ class Node {
     }
   }
 
-  public removePending(key: string, graph: Graph) {
+  public removePending(key: string, graph: GraphAI) {
     this.pendings.delete(key);
     this.executeIfReady(graph);
   }
 
-  public payload(graph: Graph) {
+  public payload(graph: GraphAI) {
     const foo: Record<string, any> = {};
     return this.inputs.reduce((payload, key) => {
       payload[key] = graph.nodes[key].result;       
@@ -84,7 +84,7 @@ class Node {
     }, foo);    
   }
 
-  public executeIfReady(graph: Graph) {
+  public executeIfReady(graph: GraphAI) {
     if (this.pendings.size == 0) {
       this.state = NodeState.Executing;
       graph.add(this);
@@ -93,7 +93,7 @@ class Node {
   }
 }
 
-export class Graph {
+export class GraphAI {
   public nodes: Record<string, Node>
   public callback: FlowCallback;
   private runningNodes: Set<string>;

package/src/index.ts

@@ -1,3 +1,3 @@
-import { Graph } from "./flow";
+import { GraphAI } from "./flow";
 
-export { Graph };
+export { GraphAI };

package/tests/sample_flow.ts

@@ -1,5 +1,5 @@
 import path from "path";
-import { Graph, FlowCommand } from "../src/flow";
+import { GraphAI, FlowCommand } from "../src/flow";
 
 import { readManifestData } from "../src/file_utils";
 
@@ -7,7 +7,7 @@ const test = async (file: string) => {
   const file_path = path.resolve(__dirname) + file;
   const graph_data = readManifestData(file_path);
   return new Promise((resolve, reject) => {
-    const graph = new Graph(graph_data, async (params) => {
+    const graph = new GraphAI(graph_data, async (params) => {
       if (params.cmd == FlowCommand.Execute) {
           const node = params.node;
           console.log("executing", node, params.params, params.payload)