@avaprotocol/sdk-js 1.4.0 → 1.5.0

package/dist/models/trigger/reason.js

@@ -0,0 +1,93 @@
+import * as avs_pb from "@/grpc_codegen/avs_pb";
+import { TriggerType } from "@avaprotocol/types";
+// Convert the number values of gRPC TriggerType to string values of TriggerType
+const convertTriggerType = (grpcType) => {
+    const conversionMap = {
+        [avs_pb.TriggerReason.TriggerType.FIXEDTIME]: TriggerType.FixedTime,
+        [avs_pb.TriggerReason.TriggerType.CRON]: TriggerType.Cron,
+        [avs_pb.TriggerReason.TriggerType.BLOCK]: TriggerType.Block,
+        [avs_pb.TriggerReason.TriggerType.EVENT]: TriggerType.Event,
+        [avs_pb.TriggerReason.TriggerType.MANUAL]: TriggerType.Manual,
+        [avs_pb.TriggerReason.TriggerType.UNSET]: TriggerType.Unset,
+    };
+    return conversionMap[grpcType];
+};
+class TriggerReason {
+    constructor(props) {
+        this.type = props.type;
+        // Configure reason based on trigger type
+        switch (props.type) {
+            case TriggerType.FixedTime:
+            case TriggerType.Cron:
+                this.epoch = props.epoch;
+                break;
+            case TriggerType.Block:
+                this.blockNumber = props.blockNumber;
+                break;
+            case TriggerType.Event:
+                this.blockNumber = props.blockNumber;
+                this.logIndex = props.logIndex;
+                this.txHash = props.txHash;
+                break;
+            default:
+                throw new Error("Unsupported trigger type");
+        }
+    }
+    static fromResponse(data) {
+        if (!data) {
+            return undefined;
+        }
+        return new TriggerReason({
+            type: convertTriggerType(data.getType()),
+            blockNumber: data.getBlockNumber(),
+            epoch: data.getEpoch(),
+            logIndex: data.getLogIndex(),
+            txHash: data.getTxHash(),
+        });
+    }
+    toRequest() {
+        const request = new avs_pb.TriggerReason();
+        switch (this.type) {
+            case TriggerType.FixedTime:
+                request.setType(avs_pb.TriggerReason.TriggerType.FIXEDTIME);
+                if (this.epoch) {
+                    request.setEpoch(this.epoch);
+                }
+                break;
+            case TriggerType.Cron:
+                request.setType(avs_pb.TriggerReason.TriggerType.CRON);
+                if (this.epoch) {
+                    request.setEpoch(this.epoch);
+                }
+                break;
+            case TriggerType.Block:
+                request.setType(avs_pb.TriggerReason.TriggerType.BLOCK);
+                if (this.blockNumber) {
+                    request.setBlockNumber(this.blockNumber);
+                }
+                break;
+            case TriggerType.Event:
+                request.setType(avs_pb.TriggerReason.TriggerType.EVENT);
+                if (this.blockNumber) {
+                    request.setBlockNumber(this.blockNumber);
+                }
+                if (this.logIndex) {
+                    request.setLogIndex(this.logIndex);
+                }
+                if (this.txHash) {
+                    request.setTxHash(this.txHash);
+                }
+                break;
+            case TriggerType.Manual:
+                request.setType(avs_pb.TriggerReason.TriggerType.MANUAL);
+                break;
+            case TriggerType.Unset:
+                request.setType(avs_pb.TriggerReason.TriggerType.UNSET);
+                break;
+            default:
+                throw new Error("Unsupported trigger type");
+        }
+        return request;
+    }
+}
+export default TriggerReason;

package/dist/models/workflow.d.ts

@@ -0,0 +1,54 @@
+import * as avs_pb from "@/grpc_codegen/avs_pb";
+import Node from "./node/interface";
+import Edge from "./edge";
+import Trigger from "./trigger/interface";
+export declare const DefaultExpiredAt = -1;
+import { WorkflowStatus } from "@avaprotocol/types";
+export declare function convertStatusToString(status: avs_pb.TaskStatus): WorkflowStatus;
+export type WorkflowProps = Omit<avs_pb.Task.AsObject, "id" | "owner" | "completedAt" | "status" | "name" | "trigger" | "nodesList" | "edgesList" | "lastRanAt" | "executionCount"> & {
+    id?: string;
+    owner?: string;
+    completedAt?: number;
+    status?: WorkflowStatus;
+    name?: string;
+    trigger: Trigger;
+    nodes: Node[];
+    edges: Edge[];
+    lastRanAt?: number;
+    executionCount?: number;
+};
+declare class Workflow implements WorkflowProps {
+    smartWalletAddress: string;
+    trigger: Trigger;
+    nodes: Node[];
+    edges: Edge[];
+    startAt: number;
+    expiredAt: number;
+    maxExecution: number;
+    id?: string;
+    owner?: string;
+    name?: string;
+    completedAt?: number;
+    status?: WorkflowStatus;
+    lastRanAt?: number;
+    executionCount?: number;
+    /**
+     * Create an instance of Workflow from user inputs
+     * @param props
+     */
+    constructor(props: WorkflowProps);
+    /**
+     * Create an instance of Workflow from AVS getWorkflow response
+     * @param res
+     * @returns
+     */
+    static fromResponse(obj: avs_pb.Task): Workflow;
+    /**
+     * Create an instance of Workflow with only selected fields
+     * @param obj
+     */
+    static fromListResponse(obj: avs_pb.ListTasksResp.Item): Workflow;
+    toRequest(): avs_pb.CreateTaskReq;
+}
+export default Workflow;
+//# sourceMappingURL=workflow.d.ts.map

package/dist/models/workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/models/workflow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAEhD,OAAO,IAAI,MAAM,kBAAkB,CAAC;AACpC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAG1C,eAAO,MAAM,gBAAgB,KAAK,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,UAAU,GACxB,cAAc,CAUhB;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,MAAM,CAAC,IAAI,CAAC,QAAQ,EAClB,IAAI,GACJ,OAAO,GACP,aAAa,GACb,QAAQ,GACR,MAAM,GACN,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,gBAAgB,CACnB,GAAG;IACF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,cAAM,QAAS,YAAW,aAAa;IACrC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IAGrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;gBACS,KAAK,EAAE,aAAa;IAuBhC;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,GAAG,QAAQ;IAkC/C;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,GAAG,QAAQ;IA2BjE,SAAS,IAAI,MAAM,CAAC,aAAa;CAsBlC;AAED,eAAe,QAAQ,CAAC"}

package/dist/models/workflow.js

@@ -0,0 +1,118 @@
+import _ from "lodash";
+import * as avs_pb from "@/grpc_codegen/avs_pb";
+import Edge from "./edge";
+import TriggerFactory from "./trigger/factory";
+import NodeFactory from "./node/factory";
+export const DefaultExpiredAt = -1; // TODO: explain the meaning of -1
+import { WorkflowStatus } from "@avaprotocol/types";
+// Function to convert TaskStatus to string
+export function convertStatusToString(status) {
+    const conversionMap = {
+        [avs_pb.TaskStatus.ACTIVE]: WorkflowStatus.Active,
+        [avs_pb.TaskStatus.COMPLETED]: WorkflowStatus.Completed,
+        [avs_pb.TaskStatus.FAILED]: WorkflowStatus.Failed,
+        [avs_pb.TaskStatus.CANCELED]: WorkflowStatus.Canceled,
+        [avs_pb.TaskStatus.EXECUTING]: WorkflowStatus.Executing,
+    };
+    return conversionMap[status];
+}
+class Workflow {
+    /**
+     * Create an instance of Workflow from user inputs
+     * @param props
+     */
+    constructor(props) {
+        if (!props.trigger) {
+            throw new Error("Trigger is undefined in new Workflow()");
+        }
+        this.smartWalletAddress = props.smartWalletAddress;
+        this.trigger = props.trigger;
+        this.nodes = props.nodes;
+        this.edges = props.edges;
+        this.startAt = props.startAt;
+        this.expiredAt = props.expiredAt;
+        this.maxExecution = props.maxExecution;
+        this.executionCount = props.executionCount;
+        // Optional fields
+        this.id = props.id;
+        this.owner = props.owner;
+        this.name = props.name;
+        this.status = props.status;
+        this.completedAt = props.completedAt;
+        this.lastRanAt = props.lastRanAt;
+    }
+    /**
+     * Create an instance of Workflow from AVS getWorkflow response
+     * @param res
+     * @returns
+     */
+    static fromResponse(obj) {
+        const trigger = TriggerFactory.fromResponse(obj.getTrigger());
+        if (!trigger) {
+            throw new Error("Trigger is undefined in fromResponse()");
+        }
+        const nodes = _.map(obj.getNodesList(), (node) => NodeFactory.fromResponse(node));
+        const edges = _.map(obj.getEdgesList(), (edge) => Edge.fromResponse(edge));
+        const workflow = new Workflow({
+            id: obj.getId(),
+            owner: obj.getOwner(),
+            smartWalletAddress: obj.getSmartWalletAddress(),
+            trigger,
+            nodes,
+            edges,
+            startAt: obj.getStartAt(),
+            expiredAt: obj.getExpiredAt(),
+            maxExecution: obj.getMaxExecution(),
+            executionCount: obj.getExecutionCount(),
+            name: obj.getName(),
+            status: convertStatusToString(obj.getStatus()),
+            completedAt: obj.getCompletedAt(),
+            lastRanAt: obj.getLastRanAt(),
+        });
+        return workflow;
+    }
+    /**
+     * Create an instance of Workflow with only selected fields
+     * @param obj
+     */
+    static fromListResponse(obj) {
+        const trigger = TriggerFactory.fromResponse(obj.getTrigger());
+        if (!trigger) {
+            throw new Error("Trigger is undefined in fromListResponse()");
+        }
+        const executionCount = obj.getExecutionCount ? obj.getExecutionCount() : obj.executionCount;
+        return new Workflow({
+            id: obj.getId(),
+            owner: obj.getOwner(),
+            smartWalletAddress: obj.getSmartWalletAddress(),
+            trigger: trigger,
+            startAt: obj.getStartAt(),
+            expiredAt: obj.getExpiredAt(),
+            maxExecution: obj.getMaxExecution(),
+            executionCount: executionCount,
+            nodes: [],
+            edges: [],
+            completedAt: obj.getCompletedAt(),
+            status: convertStatusToString(obj.getStatus()),
+            name: obj.getName(),
+            lastRanAt: obj.getLastRanAt(),
+        });
+    }
+    toRequest() {
+        const request = new avs_pb.CreateTaskReq();
+        // TODO: add client side validation for each field
+        request.setSmartWalletAddress(this.smartWalletAddress);
+        request.setTrigger(this.trigger.toRequest());
+        _.map(this.nodes, (node) => request.addNodes(node.toRequest()));
+        _.map(this.edges, (edge) => request.addEdges(edge.toRequest()));
+        request.setStartAt(this.startAt);
+        request.setExpiredAt(this.expiredAt);
+        request.setMaxExecution(this.maxExecution);
+        // Optional fields
+        if (this.name) {
+            request.setName(this.name);
+        }
+        return request;
+    }
+}
+export default Workflow;

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { Value as ProtobufValue } from "google-protobuf/google/protobuf/struct_pb";
+export declare function convertProtobufValueToJs(value?: ProtobufValue): any;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAGnF,wBAAgB,wBAAwB,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,GAAG,CAiCnE"}

package/dist/utils.js

@@ -0,0 +1,37 @@
+import { Value as ProtobufValue } from "google-protobuf/google/protobuf/struct_pb";
+// Helper function to convert google.protobuf.Value to native JavaScript types
+export function convertProtobufValueToJs(value) {
+    if (!value) {
+        return undefined;
+    }
+    switch (value.getKindCase()) {
+        case ProtobufValue.KindCase.NULL_VALUE:
+            return null;
+        case ProtobufValue.KindCase.NUMBER_VALUE:
+            return value.getNumberValue();
+        case ProtobufValue.KindCase.STRING_VALUE:
+            return value.getStringValue();
+        case ProtobufValue.KindCase.BOOL_VALUE:
+            return value.getBoolValue();
+        case ProtobufValue.KindCase.STRUCT_VALUE: {
+            const struct = value.getStructValue();
+            if (!struct)
+                return {};
+            const jsObj = {};
+            const fields = struct.getFieldsMap();
+            fields.forEach((val, key) => {
+                jsObj[key] = convertProtobufValueToJs(val);
+            });
+            return jsObj;
+        }
+        case ProtobufValue.KindCase.LIST_VALUE: {
+            const list = value.getListValue();
+            if (!list)
+                return [];
+            return list.getValuesList().map(item => convertProtobufValueToJs(item));
+        }
+        case ProtobufValue.KindCase.KIND_NOT_SET:
+        default:
+            return undefined;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avaprotocol/sdk-js",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "A JavaScript/TypeScript SDK designed to simplify integration with Ava Protocol's AVS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,16 +24,18 @@
     "yarn": ">=1.22.19"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build:declarations": "tsc -b tsconfig.json",
+    "build:js": "tsup src/index.ts --format cjs,esm",
+    "build": "yarn build:declarations && yarn build:js",
     "clean": "rm -rf node_modules dist tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@avaprotocol/types": "workspace:*",
+    "@avaprotocol/types": "1.0.0",
     "@grpc/grpc-js": "^1.11.3",
     "@grpc/proto-loader": "^0.7.13",
     "dotenv": "^16.4.5",
     "ethers": "^6.13.2",
-    "google-protobuf": "^3.21.4",
+    "google-protobuf": "3.19.4",
     "id128": "^1.6.6",
     "lodash": "^4.17.21"
   },