otomato-sdk 1.2.1 → 1.3.1

package/dist/test/automation.spec.js

@@ -1,10 +1,10 @@
 import { expect } from 'chai';
-import { Automation } from '../src/models/Automation.js';
+import { Workflow } from '../src/models/Workflow.js';
 import { Trigger } from '../src/models/Trigger.js';
 import { Action } from '../src/models/Action.js';
 import { TRIGGERS, ACTIONS, getToken, CHAINS } from '../src/index.js';
-describe('Automation Class', () => {
-    it('should create an automation with a trigger and actions', () => {
+describe('Workflow Class', () => {
+    it('should create a workflow with a trigger and actions', () => {
         const trigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
         trigger.setChainId(CHAINS.ETHEREUM);
         trigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
@@ -19,24 +19,24 @@ describe('Automation Class', () => {
         action2.setParams("webhook", "https://webhook.url");
         action2.setParams("message", "This is a test message");
         action2.setPosition(2, 0);
-        const automation = new Automation("Test Automation", [trigger, action1, action2]);
-        const json = automation.toJSON();
+        const workflow = new Workflow("Test Workflow", [trigger, action1, action2]);
+        const json = workflow.toJSON();
         expect(json).to.deep.equal({
-            name: "Test Automation",
+            name: "Test Workflow",
             nodes: [trigger.toJSON(), action1.toJSON(), action2.toJSON()],
             edges: []
         });
     });
-    it('should set the name of the automation', () => {
+    it('should set the name of the workflow', () => {
         const trigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
         trigger.setChainId(CHAINS.ETHEREUM);
         trigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
         trigger.setPosition(0, 0);
-        const automation = new Automation("Initial Name", [trigger]);
-        automation.setName("Updated Name");
-        expect(automation.name).to.equal("Updated Name");
+        const workflow = new Workflow("Initial Name", [trigger]);
+        workflow.setName("Updated Name");
+        expect(workflow.name).to.equal("Updated Name");
     });
-    it('should add a trigger to the automation', () => {
+    it('should add a trigger to the workflow', () => {
         const initialTrigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
         initialTrigger.setChainId(CHAINS.ETHEREUM);
         initialTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
@@ -45,11 +45,11 @@ describe('Automation Class', () => {
         newTrigger.setChainId(CHAINS.ETHEREUM);
         newTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
         newTrigger.setPosition(1, 0);
-        const automation = new Automation("Test Automation", [initialTrigger]);
-        automation.addNode(newTrigger);
-        expect(automation.nodes).to.deep.equal([initialTrigger, newTrigger]);
+        const workflow = new Workflow("Test Workflow", [initialTrigger]);
+        workflow.addNode(newTrigger);
+        expect(workflow.nodes).to.deep.equal([initialTrigger, newTrigger]);
     });
-    it('should add actions to the automation', () => {
+    it('should add actions to the workflow', () => {
         const trigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
         trigger.setChainId(CHAINS.ETHEREUM);
         trigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
@@ -64,9 +64,9 @@ describe('Automation Class', () => {
         action2.setParams("webhook", "https://webhook.url");
         action2.setParams("message", "This is a test message");
         action2.setPosition(2, 0);
-        const automation = new Automation("Test Automation", [trigger]);
-        automation.addNode(action1);
-        automation.addNode(action2);
-        expect(automation.nodes).to.deep.equal([trigger, action1, action2]);
+        const workflow = new Workflow("Test Workflow", [trigger]);
+        workflow.addNode(action1);
+        workflow.addNode(action2);
+        expect(workflow.nodes).to.deep.equal([trigger, action1, action2]);
     });
 });

package/dist/test/node.spec.js

@@ -7,23 +7,25 @@ const DEFAULT_PARAMETERS = [
 describe('Node Class', () => {
     it('should create a node without coordinates', () => {
         const node = new Node({
-            id: 1,
+            blockId: 1,
             name: 'Test Node',
             description: 'A node for testing',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         expect(node.position).to.be.undefined;
     });
     it('should create a node with coordinates', () => {
         var _a, _b;
         const node = new Node({
-            id: 2,
+            blockId: 2,
             name: 'Test Node with Coordinates',
             description: 'A node for testing with coordinates',
             parameters: DEFAULT_PARAMETERS,
             class: 'testClass',
-            position: { x: 100, y: 200 }
+            position: { x: 100, y: 200 },
+            image: 'a',
         });
         expect((_a = node.position) === null || _a === void 0 ? void 0 : _a.x).to.equal(100);
         expect((_b = node.position) === null || _b === void 0 ? void 0 : _b.y).to.equal(200);
@@ -31,11 +33,12 @@ describe('Node Class', () => {
     it('should set and get coordinates correctly', () => {
         var _a, _b;
         const node = new Node({
-            id: 3,
+            blockId: 3,
             name: 'Test Node for Coordinates',
             description: 'A node for testing coordinate setting',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         node.setPosition(300, 400);
         expect((_a = node.position) === null || _a === void 0 ? void 0 : _a.x).to.equal(300);
@@ -43,11 +46,12 @@ describe('Node Class', () => {
     });
     it('should create a node and set parameters correctly', () => {
         const node = new Node({
-            id: 4,
+            blockId: 4,
             name: 'Test Node for Parameters',
             description: 'A node for testing parameter setting',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         node.setChainId(1);
         node.setContractAddress("0x0000000000000000000000000000000000000000");
@@ -57,17 +61,18 @@ describe('Node Class', () => {
     });
     it('should be able to export a node as json without coordinates', () => {
         const node = new Node({
-            id: 5,
+            blockId: 5,
             name: 'Test Node for JSON',
             description: 'A node for testing JSON export',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         node.setChainId(1);
         node.setContractAddress("0x0000000000000000000000000000000000000000");
         const json = node.toJSON();
         expect(json).to.deep.equal({
-            id: 5,
+            blockId: 5,
             ref: node.getRef(),
             type: 'testClass',
             parameters: {
@@ -78,19 +83,20 @@ describe('Node Class', () => {
     });
     it('should be able to export a node as json with coordinates', () => {
         const node = new Node({
-            id: 6,
+            blockId: 6,
             name: 'Test Node for JSON with Coordinates',
             description: 'A node for testing JSON export with coordinates',
             parameters: DEFAULT_PARAMETERS,
             class: 'testClass',
-            position: { x: 1, y: 2 }
+            position: { x: 1, y: 2 },
+            image: 'a',
         });
         node.setChainId(1);
         node.setContractAddress("0x0000000000000000000000000000000000000000");
         const json = node.toJSON();
         expect(json).to.deep.equal({
             type: 'testClass',
-            id: 6,
+            blockId: 6,
             ref: node.getRef(),
             parameters: {
                 chainId: 1,
@@ -101,21 +107,23 @@ describe('Node Class', () => {
     });
     it('should throw an error for invalid parameter type', () => {
         const node = new Node({
-            id: 7,
+            blockId: 7,
             name: 'Test Node for Invalid Parameter Type',
             description: 'A node for testing invalid parameter type',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         expect(() => node.setParams("chainId", "invalid")).to.throw('Invalid type for parameter chainId. Expected integer.');
     });
     it('should throw an error for invalid address', () => {
         const node = new Node({
-            id: 8,
+            blockId: 8,
             name: 'Test Node for Invalid Address',
             description: 'A node for testing invalid address',
             parameters: DEFAULT_PARAMETERS,
-            class: 'testClass'
+            class: 'testClass',
+            image: 'a',
         });
         expect(() => node.setParams("contractAddress", "invalid_address")).to.throw('Invalid type for parameter contractAddress. Expected address.');
     });

package/dist/test/trigger.spec.js

@@ -31,7 +31,7 @@ describe('Trigger Class', () => {
         const json = transferTrigger.toJSON();
         console.log(json);
         expect(json).to.deep.equal({
-            id: TRIGGERS.TOKENS.ERC20.TRANSFER.id,
+            blockId: TRIGGERS.TOKENS.ERC20.TRANSFER.blockId,
             ref: transferTrigger.getRef(),
             type: 'trigger',
             parameters: {

package/dist/types/examples/create-workflow.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/examples/load-workflow.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/constants/Blocks.d.ts

@@ -2,110 +2,132 @@ import { Parameter } from '../models/Parameter.js';
 export declare const TRIGGERS: {
     TOKENS: {
         ERC20: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             TRANSFER: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
             BALANCE: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 method: string;
                 handler: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     YIELD: {
         SPLICE_FI: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             SWAP: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
             LIQUIDITY_REMOVED: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
             MARKET_CREATION: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
             INTEREST_RATE_UPDATE: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     LENDING: {
         ASTARIA: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             LEND_RECALLED: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     DEXES: {
         ODOS: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             SWAP: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     SOCIALS: {
         MODE_NAME_SERVICE: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             NAME_REGISTERED: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 contractAddress: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     PRICE_ACTION: {
         ON_CHAIN_PRICE_MOVEMENT: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             PRICE_MOVEMENT_AGAINST_CURRENCY: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
@@ -113,43 +135,55 @@ export declare const TRIGGERS: {
 export declare const ACTIONS: {
     NOTIFICATIONS: {
         SLACK: {
+            description: string;
+            image: string;
             SEND_MESSAGE: {
-                id: number;
                 name: string;
                 type: number;
                 description: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
         DISCORD: {
+            description: string;
+            image: string;
             SEND_MESSAGE: {
-                id: number;
                 name: string;
                 type: number;
                 description: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
         TELEGRAM: {
+            description: string;
+            image: string;
             SEND_MESSAGE: {
-                id: number;
                 name: string;
                 type: number;
                 description: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
     TOKENS: {
         ERC20: {
-            CHAINS: number[];
+            description: string;
+            chains: number[];
+            image: string;
             TRANSFER: {
-                id: number;
                 name: string;
                 description: string;
                 type: number;
                 method: string;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };

package/dist/types/src/index.d.ts

@@ -2,7 +2,7 @@ export * from './constants/Blocks.js';
 export * from './constants/chains.js';
 export * from './constants/tokens.js';
 export * from './models/Action.js';
-export * from './models/Automation.js';
+export * from './models/Workflow.js';
 export * from './models/Condition.js';
 export * from './models/Parameter.js';
 export * from './models/Trigger.js';

package/dist/types/src/models/Action.d.ts

@@ -2,10 +2,11 @@ import { Parameter } from './Parameter.js';
 import { Node, Position } from './Node.js';
 export declare class Action extends Node {
     constructor(action: {
-        id: number;
+        blockId: number;
         name: string;
         description: string;
         parameters: Parameter[];
+        image: string;
         ref?: string;
         position?: Position;
     });

package/dist/types/src/models/Edge.d.ts

@@ -11,4 +11,7 @@ export declare class Edge {
     toJSON(): {
         [key: string]: any;
     };
+    static fromJSON(json: {
+        [key: string]: any;
+    }): Edge;
 }

package/dist/types/src/models/Node.d.ts

@@ -4,7 +4,8 @@ export interface Position {
     y: number;
 }
 export declare class Node {
-    id: number;
+    id: string | null;
+    blockId: number;
     name: string;
     description: string;
     parameters: {
@@ -16,15 +17,18 @@ export declare class Node {
     position?: Position;
     ref: string;
     class: string;
+    image: string;
     constructor(node: {
-        id: number;
+        blockId: number;
         name: string;
         description: string;
         parameters: Parameter[];
         ref?: string;
         position?: Position;
         class: string;
+        image: string;
     });
+    setId(id: string): void;
     setChainId(value: number): void;
     setContractAddress(value: string): void;
     setParams(key: string, value: any): void;
@@ -39,4 +43,7 @@ export declare class Node {
         [key: string]: any;
     };
     private getSimplifiedKey;
+    static fromJSON(json: {
+        [key: string]: any;
+    }): Node;
 }

package/dist/types/src/models/Trigger.d.ts

@@ -3,11 +3,12 @@ import { Node, Position } from './Node.js';
 export declare class Trigger extends Node {
     type: number;
     constructor(trigger: {
-        id: number;
+        blockId: number;
         name: string;
         description: string;
         type: number;
         parameters: Parameter[];
+        image: string;
         ref?: string;
         position?: Position;
     });

package/dist/types/src/models/Workflow.d.ts

@@ -0,0 +1,26 @@
+import { Node } from './Node.js';
+import { Edge } from './Edge.js';
+export declare class Workflow {
+    id: string | null;
+    name: string;
+    nodes: Node[];
+    edges: Edge[];
+    constructor(name?: string, nodes?: Node[], edges?: Edge[]);
+    setName(name: string): void;
+    addNode(node: Node): void;
+    addNodes(nodes: Node[]): void;
+    addEdge(edge: Edge): void;
+    addEdges(edges: Edge[]): void;
+    toJSON(): {
+        id: string | null;
+        name: string;
+        nodes: {
+            [key: string]: any;
+        }[];
+        edges: {
+            [key: string]: any;
+        }[];
+    };
+    create(): Promise<any>;
+    load(workflowId: string): Promise<Workflow>;
+}

package/dist/types/src/services/ApiService.d.ts

@@ -1,3 +1,8 @@
-export declare const apiServices: {
-    post(endpoint: string, data: any): Promise<any>;
-};
+declare class ApiServices {
+    private auth;
+    setAuth(auth: string): void;
+    post(url: string, data: any): Promise<any>;
+    get(url: string): Promise<any>;
+}
+export declare const apiServices: ApiServices;
+export {};

package/examples/create-workflow.ts

@@ -0,0 +1,41 @@
+import { ACTIONS, Action, TRIGGERS, Trigger, Workflow, CHAINS, getToken, Edge, apiServices } from '../src/index.js';
+
+const main = async () => {
+
+    apiServices.setAuth("eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIweDdjRUI4ZDgxNDdBYWE5ZEI4MUFjQkRGRTVjMzA1MERGQ2ZGMTg1MzciLCJzdWIiOiIweDg3RkU4YjRmMkZlODM3MGY2Y0M5YTk2MzQ0MmYwN0IwMmY0OTA5QTciLCJhdWQiOiJvdG9tYXRvLXRlc3QubmV0bGlmeS5hcHAiLCJleHAiOjE3MjMzODMxOTksIm5iZiI6MTcyMDc4OTM5OSwiaWF0IjoxNzIwNzkxMTk5LCJqdGkiOiIweDY4ZDkxOWEyMGZiYjIyNDUwZDZmOTFjMzM2ZTBmYjBjMmYyYTc3MmU3Zjg4NWU1ZjRmNzg1NTM2ZGIyYTY5YTAiLCJjdHgiOnt9fQ.MHgyOTM1NTM3MWYwOWM1YzllNWE3YjI4MjVkZTNjMDljZTkwMTQ3OTQwZmU1ZWRlMjM5YTk0MmFjYTQ5YTcwZWI0MGJlNmJiZDk2MDA4ZTIxMzJmNGM3ZTVlZGIzZDZiZjYyMDE4Mzc1MzUwMTRmNTc0ODM0ZDk4YWU3NDQwNDQzOTFi");
+
+    const usdcTransferTrigger = new Trigger({
+        blockId: TRIGGERS.TOKENS.ERC20.TRANSFER.blockId,
+        name: TRIGGERS.TOKENS.ERC20.TRANSFER.name,
+        description: TRIGGERS.TOKENS.ERC20.TRANSFER.description,
+        type: TRIGGERS.TOKENS.ERC20.TRANSFER.type,
+        parameters: TRIGGERS.TOKENS.ERC20.TRANSFER.parameters,
+        image: TRIGGERS.TOKENS.ERC20.TRANSFER.image,
+        ref: 'n-1',
+    });
+    usdcTransferTrigger.setChainId(CHAINS.ETHEREUM);
+    usdcTransferTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
+    usdcTransferTrigger.setPosition(0, 0);
+
+    const slackAction = new Action(ACTIONS.NOTIFICATIONS.SLACK.SEND_MESSAGE);
+    slackAction.setParams("webhook", "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX");
+    slackAction.setParams("message", "USDC has been transferred!");
+    slackAction.setPosition(0, -10);
+
+    const workflow = new Workflow("USDC Transfer Notification", [usdcTransferTrigger, slackAction]);
+
+    const edge = new Edge({
+        source: usdcTransferTrigger,
+        target: slackAction,
+    });
+
+    workflow.addEdge(edge);
+    const res = await workflow.create();
+    console.log(res);
+    console.log(`Workflow ID: ${workflow.id}`);  // This will print the ID of the created workflow
+    workflow.nodes.forEach(node => {
+        console.log(`Node ${node.getRef()} ID: ${node.id}`);
+    });
+}
+
+main();

package/examples/load-workflow.ts

@@ -0,0 +1,10 @@
+import { ACTIONS, Action, TRIGGERS, Trigger, Workflow, CHAINS, getToken, Edge, apiServices } from '../src/index.js';
+
+const main = async () => {
+
+    apiServices.setAuth("eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIweDdjRUI4ZDgxNDdBYWE5ZEI4MUFjQkRGRTVjMzA1MERGQ2ZGMTg1MzciLCJzdWIiOiIweDg3RkU4YjRmMkZlODM3MGY2Y0M5YTk2MzQ0MmYwN0IwMmY0OTA5QTciLCJhdWQiOiJvdG9tYXRvLXRlc3QubmV0bGlmeS5hcHAiLCJleHAiOjE3MjMzODMxOTksIm5iZiI6MTcyMDc4OTM5OSwiaWF0IjoxNzIwNzkxMTk5LCJqdGkiOiIweDY4ZDkxOWEyMGZiYjIyNDUwZDZmOTFjMzM2ZTBmYjBjMmYyYTc3MmU3Zjg4NWU1ZjRmNzg1NTM2ZGIyYTY5YTAiLCJjdHgiOnt9fQ.MHgyOTM1NTM3MWYwOWM1YzllNWE3YjI4MjVkZTNjMDljZTkwMTQ3OTQwZmU1ZWRlMjM5YTk0MmFjYTQ5YTcwZWI0MGJlNmJiZDk2MDA4ZTIxMzJmNGM3ZTVlZGIzZDZiZjYyMDE4Mzc1MzUwMTRmNTc0ODM0ZDk4YWU3NDQwNDQzOTFi");
+    const workflow = await new Workflow().load("0b9bd533-339c-42b5-9ed3-a6a40fcfa8d3");
+    console.log(workflow)
+}
+
+main();

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "otomato-sdk",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "An SDK for building and managing automations on Otomato",
   "main": "dist/src/index.js",
   "types": "dist/types/src/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "npx tsc",
-    "test": "mocha --config .mocharc.json",
-    "publish": "npm publish"
+    "test": "mocha --config .mocharc.json"
   },
   "keywords": [
     "sdk",