otomato-sdk 1.2.1 → 1.3.0

package/test/automation.spec.ts

@@ -1,11 +1,11 @@
 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);
@@ -23,29 +23,29 @@ describe('Automation Class', () => {
     action2.setParams("message", "This is a test message");
     action2.setPosition(2, 0);
 
-    const automation = new Automation("Test Automation", [trigger, action1, action2]);
+    const workflow = new Workflow("Test Workflow", [trigger, action1, action2]);
 
-    const json = automation.toJSON();
+    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");
+    const workflow = new Workflow("Initial Name", [trigger]);
+    workflow.setName("Updated Name");
 
-    expect(automation.name).to.equal("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);
@@ -56,13 +56,13 @@ describe('Automation Class', () => {
     newTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
     newTrigger.setPosition(1, 0);
 
-    const automation = new Automation("Test Automation", [initialTrigger]);
-    automation.addNode(newTrigger);
+    const workflow = new Workflow("Test Workflow", [initialTrigger]);
+    workflow.addNode(newTrigger);
 
-    expect(automation.nodes).to.deep.equal([initialTrigger, 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);
@@ -80,10 +80,10 @@ describe('Automation Class', () => {
     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);
+    const workflow = new Workflow("Test Workflow", [trigger]);
+    workflow.addNode(action1);
+    workflow.addNode(action2);
 
-    expect(automation.nodes).to.deep.equal([trigger, action1, action2]);
+    expect(workflow.nodes).to.deep.equal([trigger, action1, action2]);
   });
-});
+});

package/test/node.spec.ts

@@ -10,11 +10,12 @@ 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;
@@ -22,12 +23,13 @@ describe('Node Class', () => {
 
   it('should create a node with coordinates', () => {
     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(node.position?.x).to.equal(100);
@@ -36,11 +38,12 @@ describe('Node Class', () => {
 
   it('should set and get coordinates correctly', () => {
     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);
@@ -50,11 +53,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);
@@ -67,11 +71,12 @@ 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);
@@ -79,7 +84,7 @@ describe('Node Class', () => {
 
     const json = node.toJSON();
     expect(json).to.deep.equal({
-      id: 5,
+      blockId: 5,
       ref: node.getRef(),
       type: 'testClass',
       parameters: {
@@ -91,12 +96,13 @@ 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);
@@ -105,7 +111,7 @@ describe('Node Class', () => {
     const json = node.toJSON();
     expect(json).to.deep.equal({
       type: 'testClass',
-      id: 6,
+      blockId: 6,
       ref: node.getRef(),
       parameters: {
         chainId: 1,
@@ -117,22 +123,24 @@ 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/test/trigger.spec.ts

@@ -39,7 +39,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/examples/create-automation.ts

@@ -1,35 +0,0 @@
-import { ACTIONS, Action, TRIGGERS, Trigger, Automation, CHAINS, getToken, Edge } from '../src/index.js';
-
-const main = async () => {
-    const usdcTransferTrigger = new Trigger({
-        id: TRIGGERS.TOKENS.ERC20.TRANSFER.id,
-        name: TRIGGERS.TOKENS.ERC20.TRANSFER.name,
-        description: TRIGGERS.TOKENS.ERC20.TRANSFER.description,
-        type: TRIGGERS.TOKENS.ERC20.TRANSFER.type,
-        parameters: TRIGGERS.TOKENS.ERC20.TRANSFER.parameters,
-        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 automation = new Automation("USDC Transfer Notification", [usdcTransferTrigger, slackAction]);
-
-    const edge = new Edge({
-        source: usdcTransferTrigger,
-        target: slackAction,
-    });
-
-    automation.addEdge(edge);
-
-    console.log(JSON.stringify(automation.toJSON(), null, 2));
-
-    //await automation.save();
-}
-
-main();

package/examples/sandbox.ts

@@ -1,12 +0,0 @@
-import { TRIGGERS, getToken, CHAINS, Trigger } from '../src/index.js';
-
-const trigger = new Trigger(TRIGGERS.PRICE_ACTION.ON_CHAIN_PRICE_MOVEMENT.PRICE_MOVEMENT_AGAINST_CURRENCY);
-
-trigger.setChainId(CHAINS.MODE);
-trigger.setComparisonValue(3200);
-trigger.setCondition("gte");
-trigger.setParams('currency', 'USD');
-trigger.setParams('contractAddress', getToken(CHAINS.MODE, 'MODE').contractAddress);
-trigger.setPosition(1, 0);
-
-console.log(JSON.stringify(trigger.toJSON(), null, 2));

package/src/models/Automation.ts

@@ -1,47 +0,0 @@
-import { Node } from './Node.js';
-import { Edge } from './Edge.js';
-import { apiServices } from '../services/ApiService.js';
-
-export class Automation {
-  name: string;
-  nodes: Node[];
-  edges: Edge[];
-
-  constructor(name: string, nodes: Node[] = [], edges: Edge[] = []) {
-    this.name = name;
-    this.nodes = nodes;
-    this.edges = edges;
-  }
-
-  setName(name: string): void {
-    this.name = name;
-  }
-
-  addNode(node: Node): void {
-    this.nodes.push(node);
-  }
-
-  addNodes(nodes: Node[]): void {
-    this.nodes.push(...nodes);
-  }
-
-  addEdge(edge: Edge): void {
-    this.edges.push(edge);
-  }
-
-  addEdges(edges: Edge[]): void {
-    this.edges.push(...edges);
-  }
-
-  toJSON() {
-    return {
-      name: this.name,
-      nodes: this.nodes.map(node => node.toJSON()),
-      edges: this.edges.map(edge => edge.toJSON()),
-    };
-  }
-
-  async save() {
-    return apiServices.post('/workflows', this.toJSON());
-  }
-}