otomato-sdk 1.2.0 → 1.3.0

package/dist/test/typeValidator.spec.js

@@ -47,7 +47,8 @@ describe('Type Validator Utility Functions', () => {
             expect(validateType('paragraph', 12345)).to.be.false;
         });
         it('should validate logic operators', () => {
-            expect(validateType('logic_operator', '>')).to.be.true;
+            expect(validateType('logic_operator', 'gte')).to.be.true;
+            expect(validateType('logic_operator', '>')).to.be.false;
             expect(validateType('logic_operator', 'invalid_operator')).to.be.false;
         });
         it('should validate any type', () => {

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/examples/sandbox.d.ts

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

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

@@ -2,117 +2,189 @@ 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;
             };
         };
     };
-};
-export declare const ACTIONS: {
-    TOKENS: {
-        ERC20: {
-            CHAINS: number[];
-            TRANSFER: {
-                id: number;
+    PRICE_ACTION: {
+        ON_CHAIN_PRICE_MOVEMENT: {
+            description: string;
+            chains: number[];
+            image: string;
+            PRICE_MOVEMENT_AGAINST_CURRENCY: {
                 name: string;
                 description: string;
+                type: number;
                 parameters: Parameter[];
+                blockId: number;
+                image: string;
             };
         };
     };
+};
+export declare const ACTIONS: {
     NOTIFICATIONS: {
-        SMS: {
-            id: number;
-            name: string;
+        SLACK: {
             description: string;
-            parameters: Parameter[];
+            image: string;
+            SEND_MESSAGE: {
+                name: string;
+                type: number;
+                description: string;
+                parameters: Parameter[];
+                blockId: number;
+                image: string;
+            };
         };
-        SLACK: {
-            id: number;
-            name: string;
+        DISCORD: {
+            description: string;
+            image: string;
+            SEND_MESSAGE: {
+                name: string;
+                type: number;
+                description: string;
+                parameters: Parameter[];
+                blockId: number;
+                image: string;
+            };
+        };
+        TELEGRAM: {
+            description: string;
+            image: string;
+            SEND_MESSAGE: {
+                name: string;
+                type: number;
+                description: string;
+                parameters: Parameter[];
+                blockId: number;
+                image: string;
+            };
+        };
+    };
+    TOKENS: {
+        ERC20: {
             description: string;
-            parameters: Parameter[];
+            chains: number[];
+            image: string;
+            TRANSFER: {
+                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/Parameter.d.ts

@@ -2,5 +2,5 @@ export interface Parameter {
     key: string;
     type: string;
     description: string;
-    value: any;
+    value?: any;
 }

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

@@ -3,14 +3,16 @@ 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;
     });
+    private notAPollingTrigger;
     setCondition(value: string): void;
     setComparisonValue(value: number): void;
     setInterval(value: number): void;

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 cookie;
+    setCookie(cookie: string): void;
+    post(url: string, data: any): Promise<any>;
+    get(url: string): Promise<any>;
+}
+export declare const apiServices: ApiServices;
+export {};

package/examples/create-action.ts

@@ -11,14 +11,14 @@ const createAction = () => {
   console.log(transferAction.toJSON());
 
   // Create an SMS notification action
-  const smsAction = new Action(ACTIONS.NOTIFICATIONS.SMS);
+  const smsAction = new Action(ACTIONS.NOTIFICATIONS.DISCORD.SEND_MESSAGE);
   smsAction.setParams("phoneNumber", "+1234567890");
   smsAction.setParams("text", "This is a test message");
 
   console.log(smsAction.toJSON());
 
   // Create a Slack notification action
-  const slackAction = new Action(ACTIONS.NOTIFICATIONS.SLACK);
+  const slackAction = new Action(ACTIONS.NOTIFICATIONS.SLACK.SEND_MESSAGE);
   slackAction.setParams("webhook", "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX");
   slackAction.setParams("text", "This is a test message");
 

package/examples/create-trigger.ts

@@ -6,7 +6,7 @@ const transferTrigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
 
 transferTrigger.setChainId(CHAINS.ETHEREUM);
 // transferTrigger.setParams("value", 1000);
-// transferTrigger.setParams("to", "0xe1432599B51d9BE1b5A27E2A2FB8e5dF684749C6");
+transferTrigger.setParams("to", "0xe1432599B51d9BE1b5A27E2A2FB8e5dF684749C6");
 transferTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
 
-console.log(transferTrigger.toJSON());
+console.log(JSON.stringify(transferTrigger.toJSON(), null, 2));

package/examples/create-workflow.ts

@@ -0,0 +1,44 @@
+import { ACTIONS, Action, TRIGGERS, Trigger, Workflow, CHAINS, getToken, Edge, apiServices } from '../src/index.js';
+
+const main = async () => {
+
+    apiServices.setCookie("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);
+
+    // console.log(JSON.stringify(workflow.toJSON(), null, 2));
+return;
+    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.setCookie("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.0",
+  "version": "1.3.0",
   "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",