@dronedeploy/rocos-js-sdk 3.0.1-alpha.2 → 3.0.1-alpha.3

package/constants/api.d.ts

@@ -98,10 +98,6 @@ export declare const API_PROJECT_ROBOT_DASHBOARD_URL = "https://{url}/projects/{
 export declare const API_PROJECT_ROBOT_DASHBOARD_ID_URL = "https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}";
 export declare const API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = "https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}/custom-widgets";
 export declare const API_PROJECT_CALLSIGN_STREAM_URL = "https://{url}/projects/{projectId}/callsigns/{callsign}/streams";
-export declare const API_PROJECT_CALLSIGN_WORKFLOW_URL = "https://{url}/projects/{projectId}/callsigns/{callsign}/workflows";
-export declare const API_PROJECT_WORKFLOW_URL = "https://{url}/projects/{projectId}/workflows";
-export declare const API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL = "https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments";
-export declare const API_PROJECT_WORKFLOW_ID_URL = "https://{url}/projects/{projectId}/workflows/{workflowId}";
 export declare const API_PROJECT_PROFILE_DASHBOARD_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards";
 export declare const API_PROJECT_PROFILE_DASHBOARD_ID_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}";
 export declare const API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = "https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}/custom-widgets";
@@ -125,3 +121,6 @@ export declare const API_MAP_ID_URL = "https://{url}/projects/{projectId}/maps/{
 export declare const API_MAPS_COPY_URL = "https://{url}/projects/{projectId}/maps/{mapId}/copy";
 export declare const API_MAPS_DEPLOY_URL = "https://{url}/projects/{projectId}/maps/{mapId}/deploy";
 export declare const API_MAPS_GEOJSON_URL = "https://{url}/projects/{projectId}/maps/{mapId}/geojson";
+export declare const API_PROJECT_WORKFLOW_URL = "https://{url}/projects/{projectId}/automate/flows";
+export declare const API_PROJECT_WORKFLOW_ID_URL = "https://{url}/projects/{projectId}/automate/flows/{workflowId}";
+export declare const API_PROJECT_DEPLOYED_WORKFLOW_URL = "https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments";

package/constants/api.js

@@ -98,10 +98,6 @@ export const API_PROJECT_ROBOT_DASHBOARD_URL = 'https://{url}/projects/{projectI
 export const API_PROJECT_ROBOT_DASHBOARD_ID_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}';
 export const API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/dashboards/{dashboardId}/custom-widgets';
 export const API_PROJECT_CALLSIGN_STREAM_URL = 'https://{url}/projects/{projectId}/callsigns/{callsign}/streams';
-export const API_PROJECT_CALLSIGN_WORKFLOW_URL = 'https://{url}/projects/{projectId}/callsigns/{callsign}/workflows';
-export const API_PROJECT_WORKFLOW_URL = 'https://{url}/projects/{projectId}/workflows';
-export const API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments';
-export const API_PROJECT_WORKFLOW_ID_URL = 'https://{url}/projects/{projectId}/workflows/{workflowId}';
 export const API_PROJECT_PROFILE_DASHBOARD_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards';
 export const API_PROJECT_PROFILE_DASHBOARD_ID_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}';
 export const API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = 'https://{url}/projects/{projectId}/profiles/{profileId}/dashboards/{dashboardId}/custom-widgets';
@@ -125,3 +121,6 @@ export const API_MAP_ID_URL = 'https://{url}/projects/{projectId}/maps/{mapId}';
 export const API_MAPS_COPY_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/copy';
 export const API_MAPS_DEPLOY_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/deploy';
 export const API_MAPS_GEOJSON_URL = 'https://{url}/projects/{projectId}/maps/{mapId}/geojson';
+export const API_PROJECT_WORKFLOW_URL = 'https://{url}/projects/{projectId}/automate/flows';
+export const API_PROJECT_WORKFLOW_ID_URL = 'https://{url}/projects/{projectId}/automate/flows/{workflowId}';
+export const API_PROJECT_DEPLOYED_WORKFLOW_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/automate/flows/deployments';

package/helpers/websandbox/frame/frame.source.js

@@ -1,5 +1,5 @@
 // Auto-generated file
 /* eslint-disable */
 import __WORKER_SOURCE__ from './worker/worker.source';
-const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.messageListeners=new Map,this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t);let r;const i=new Promise(((t,s)=>{r=setTimeout((()=>{console.warn("sandbox level timeout exceeded, destroying and rebuilding"),this.terminate(),s(new Error("maximum execution time exceeded"))}),e.timeout)}));return Promise.race([s,i]).finally((()=>{this.removeMessageListener(e.id),clearTimeout(r)}))}terminate(){for(const e of this.messageListeners.values())this.worker.removeEventListener("message",e);this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(i.success?t(i.result):s(i.result))};this.messageListeners.set(e.id,r),this.worker.addEventListener("message",r),this.worker.postMessage(e)}))}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(e){const t=this.messageListeners.get(e);t&&this.worker.removeEventListener("message",t)}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
+const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.messageListeners=new Map,this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t),r=new Promise(((t,s)=>{const r=AbortSignal.timeout(e.timeout);r.addEventListener("abort",(()=>{s(r.reason)}))}));return Promise.race([s,r]).catch((e=>{throw"TimeoutError"===e.name&&this.terminate(),e})).finally((()=>{this.removeMessageListener(e.id)}))}terminate(){for(const e of this.messageListeners.values())this.worker.removeEventListener("message",e);this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(i.success?t(i.result):s(i.result))};this.messageListeners.set(e.id,r),this.worker.addEventListener("message",r),this.worker.postMessage(e)}))}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(e){const t=this.messageListeners.get(e);t&&this.worker.removeEventListener("message",t)}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
 export default source;

package/helpers/websandbox/frame/worker/manager.js

@@ -11,16 +11,21 @@ export default class Manager {
             contextVariable: task.contextVariable ?? 'ctx',
         };
         const result = this.runTask(workerTask);
-        let timerId;
         const timeout = new Promise((_, reject) => {
-            timerId = setTimeout(() => {
-                this.terminate();
-                reject(new Error('maximum execution time exceeded'));
-            }, task.timeout);
+            const signal = AbortSignal.timeout(task.timeout);
+            signal.addEventListener('abort', () => {
+                reject(signal.reason);
+            });
         });
-        return Promise.race([result, timeout]).finally(() => {
+        return Promise.race([result, timeout])
+            .catch((e) => {
+            if (e.name === 'TimeoutError') {
+                this.terminate();
+            }
+            throw e;
+        })
+            .finally(() => {
             this.removeMessageListener(task.id);
-            clearTimeout(timerId);
         });
     }
     terminate() {

package/helpers/websandbox/frame/worker/manager.spec.js

@@ -43,6 +43,12 @@ Object.defineProperty(window, 'URL', {
         createObjectURL: jest.fn(),
     },
 });
+// add mock to AbortSignal.timeout
+Object.defineProperty(AbortSignal, 'timeout', {
+    value: jest.fn().mockImplementation((timeout) => {
+        return new AbortController().signal;
+    }),
+});
 const task = {
     id: 'test',
     code: '1',

package/helpers/websandbox/sandbox.d.ts

@@ -19,6 +19,7 @@ export interface RunCodeOptions {
          */
         maximumMs: number;
     };
+    abortSignal?: AbortSignal | null;
 }
 export declare const BaseOptions: SandboxOptions;
 export interface SandboxMethods {
@@ -34,6 +35,7 @@ export default class WebSandbox {
     private frame;
     private connection?;
     private initialised;
+    private frameAbortController;
     static new(options?: Partial<SandboxOptions>): Promise<WebSandbox>;
     private constructor();
     /** Runs code in the sandbox. Can be either a string or a function */
@@ -49,6 +51,7 @@ export default class WebSandbox {
     private removeMessageListener;
     private runFunction;
     private runCode;
+    private promisifyAbortSignal;
     private createFrame;
     private prepareFrameContent;
 }

package/helpers/websandbox/sandbox.js

@@ -9,6 +9,7 @@ export const BaseOptions = {
         minimumMs: 1000,
         maximumMs: 1500,
     },
+    abortSignal: null,
 };
 /** A sandbox for running untrusted code in an iframe & embedded web worker.
  *
@@ -26,6 +27,12 @@ export default class WebSandbox {
         this.frame = this.createFrame();
         this.validateOptions(this.options);
         this.initialised = this.initialise();
+        this.frameAbortController = new AbortController();
+        if (options.abortSignal) {
+            this.promisifyAbortSignal(options.abortSignal).catch(() => {
+                void this.destroyAndRebuild(this.frame.id);
+            });
+        }
     }
     /** Runs code in the sandbox. Can be either a string or a function */
     async run(code, context, options) {
@@ -39,6 +46,7 @@ export default class WebSandbox {
      * This will remove the iframe from the DOM and remove the message listener.
      */
     destroy() {
+        this.frameAbortController.abort();
         this.frame.remove();
         this.removeMessageListener();
     }
@@ -71,9 +79,13 @@ export default class WebSandbox {
             throw new Error('maximum timeout must be less than or equal to 5000ms');
         }
     }
-    async destroyAndRebuild() {
+    async destroyAndRebuild(frameId) {
+        if (this.frame.id !== frameId) {
+            return;
+        }
         this.destroy();
         this.frame = this.createFrame();
+        this.frameAbortController = new AbortController();
         await this.initialise();
     }
     removeMessageListener() {
@@ -90,22 +102,38 @@ export default class WebSandbox {
             ...this.options,
             ...options,
         });
-        let timerId;
-        const timeout = new Promise((_, reject) => {
-            timerId = setTimeout(() => {
-                this.destroyAndRebuild().finally(() => reject(new Error('sandbox timed out')));
-            }, options?.timeout?.maximumMs ?? this.options.timeout.maximumMs);
-        });
+        const frameId = this.frame.id;
+        const timeout = this.promisifyAbortSignal(AbortSignal.timeout(options?.timeout?.maximumMs ?? this.options.timeout.maximumMs));
+        const frameAbortedSignal = this.promisifyAbortSignal(this.frameAbortController.signal);
+        const userAbortedSignal = options?.abortSignal ? this.promisifyAbortSignal(options.abortSignal) : null;
         const taskId = generateUUID();
-        const task = await this.connection.callRemoteMethod('startTask', {
+        const task = this.connection.callRemoteMethod('startTask', {
             id: taskId,
             code,
             context,
             timeout: this.options.timeout.minimumMs,
             contextVariable: options?.contextVariable ?? this.options.contextVariable,
         });
-        return Promise.race([task, timeout]).finally(() => {
-            clearTimeout(timerId);
+        const signals = [task, timeout, frameAbortedSignal, userAbortedSignal].filter((i) => i !== null);
+        return Promise.race(signals).catch(async (e) => {
+            if (e.name === 'TimeoutError') {
+                await this.destroyAndRebuild(frameId);
+            }
+            throw e;
+        });
+    }
+    promisifyAbortSignal(signal) {
+        return new Promise((_, reject) => {
+            // If the signal is already aborted, immediately throw in order to reject the promise.
+            if (signal.aborted) {
+                reject(signal.reason);
+            }
+            // Watch for 'abort' signals
+            signal.addEventListener('abort', () => {
+                // Stop the main operation
+                // Reject the promise with the abort reason.
+                reject(signal.reason);
+            });
         });
     }
     createFrame() {
@@ -123,6 +151,7 @@ export default class WebSandbox {
         }
         iframe.srcdoc = this.prepareFrameContent();
         iframe.style.display = 'none';
+        iframe.id = generateUUID();
         container.appendChild(iframe);
         return iframe;
     }

package/models/index.d.ts

@@ -73,3 +73,4 @@ export * from './Token';
 export * from './types';
 export * from './Widget';
 export * from './WidgetLineGroup';
+export * from './workflow/Workflow';

package/models/index.js

@@ -73,3 +73,4 @@ export * from './Token';
 export * from './types';
 export * from './Widget';
 export * from './WidgetLineGroup';
+export * from './workflow/Workflow';

package/models/workflow/Workflow.d.ts

@@ -0,0 +1,36 @@
+export type ResourceType = 'Manifest' | 'AgentGraph' | 'Javascript' | 'NodeDefinition';
+export interface Resource {
+    type: ResourceType;
+    data: string;
+    contentLink: string;
+    hash: string;
+    link: string;
+    path: string;
+    size: number;
+}
+export interface Resources {
+    [key: string]: Resource;
+}
+export interface Author {
+    id: string;
+    name: string;
+    email: string;
+}
+export interface WorkflowBase {
+    flowId: string;
+    name: string;
+    description: string;
+    resources?: Resources;
+    type?: string;
+}
+export interface Workflow extends WorkflowBase {
+    id: string;
+    projectId: string;
+    createdBy: string;
+    updatedBy: string;
+    author: Author;
+    dateCreated: number;
+    dateUpdated: number;
+    latestVersion: string;
+    type: string;
+}

package/models/workflow/Workflow.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.2",
+  "version": "3.0.1-alpha.3",
   "description": "Javascript SDK for rocos",
   "main": "index.js",
   "types": "index.d.ts",

package/services/WorkflowService.d.ts

@@ -1,4 +1,5 @@
 import { RocosError } from '../models/RocosError';
+import type { Workflow, WorkflowBase } from '../models/workflow/Workflow';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { IBaseService } from '../models/IBaseService';
 import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
@@ -7,65 +8,60 @@ export declare class WorkflowService extends BaseServiceAbstract implements IBas
     protected getError(e: Error): RocosError;
     getStatus(): boolean;
     /**
-     * Create workflow
+     * Get workflows for project
      *
      * @param projectId - Project Id
-     * @param model - Payload
      */
-    createOne(projectId: string, model: any): Promise<any>;
+    list(projectId: string): Promise<Workflow[]>;
     /**
-     * Get workflows for project
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use list instead.
+     */
+    getAll: (projectId: string) => Promise<Workflow[]>;
+    /**
+     * Create a workflow
      *
      * @param projectId - Project Id
-     * @param includeRocosGraph - Include Rocos graph
-     * @param includeStats - Include stats
-     * @param opsId - Ops Id
-     * @param workflowIds - Workflow Id's
+     * @param model - Workflow
      */
-    getAll(projectId: string, includeRocosGraph?: boolean, includeStats?: boolean, opsId?: string, workflowIds?: string[]): Promise<any>;
+    create(projectId: string, model: WorkflowBase): Promise<Workflow>;
     /**
      * Get a workflow
      *
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
-     * @param includeInstances - Include instances
      */
-    getOne(projectId: string, workflowId: string, includeInstances?: boolean): Promise<any>;
+    get(projectId: string, workflowId: string): Promise<Workflow>;
+    /**
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use get instead.
+     */
+    getOne: (projectId: string, workflowId: string) => Promise<Workflow>;
     /**
      * Update a workflow
      *
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
-     * @param model - Payload
+     * @param model - Workflow
      */
-    updateOne(projectId: string, workflowId: string, model: any): Promise<any>;
+    update(projectId: string, workflowId: string, model: Workflow): Promise<Workflow>;
     /**
      * Delete a workflow
      *
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
      */
-    deleteOne(projectId: string, workflowId: string): Promise<any>;
-    /**
-     * Get all workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    getAllOfRobot(projectId: string, callsign: string): Promise<any>;
+    delete(projectId: string, workflowId: string): Promise<void>;
     /**
-     * Update workflows for a robot
+     * Get deployed workflows on robot
      *
      * @param projectId - Project Id
      * @param callsign - Robot callsign
-     * @param model - Payload
      */
-    updateAllForRobot(projectId: string, callsign: string, model: any): Promise<any>;
+    getDeployedWorkflows(projectId: string, callsign: string): Promise<Workflow[]>;
     /**
-     * Get deployed workflows on robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use getDeployedWorkflow instead.
      */
-    getDeployedOnRobot(projectId: string, callsign: string): Promise<any>;
+    getDeployedOnRobot: (projectId: string, callsign: string) => Promise<Workflow[]>;
 }

package/services/WorkflowService.js

@@ -1,4 +1,4 @@
-import { API_PROJECT_CALLSIGN_WORKFLOW_URL, API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL, API_PROJECT_WORKFLOW_ID_URL, API_PROJECT_WORKFLOW_URL, } from '../constants/api';
+import { API_PROJECT_DEPLOYED_WORKFLOW_URL, API_PROJECT_WORKFLOW_ID_URL, API_PROJECT_WORKFLOW_URL, } from '../constants/api';
 import { RocosError, errorCodes } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
@@ -6,6 +6,21 @@ import { formatServiceUrl } from '../helpers/formatServiceUrl';
 export class WorkflowService extends BaseServiceAbstract {
     constructor(config) {
         super(config);
+        /**
+         * @deprecated This method is deprecated and will be removed in a future version.
+         * Use list instead.
+         */
+        this.getAll = this.list;
+        /**
+         * @deprecated This method is deprecated and will be removed in a future version.
+         * Use get instead.
+         */
+        this.getOne = this.get;
+        /**
+         * @deprecated This method is deprecated and will be removed in a future version.
+         * Use getDeployedWorkflow instead.
+         */
+        this.getDeployedOnRobot = this.getDeployedWorkflows;
         this.logger = RocosLogger.getInstance(`WorkflowService(${this.config.url})`);
     }
     getError(e) {
@@ -15,62 +30,39 @@ export class WorkflowService extends BaseServiceAbstract {
         return true;
     }
     /**
-     * Create workflow
+     * Get workflows for project
      *
      * @param projectId - Project Id
-     * @param model - Payload
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async createOne(projectId, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create workflow for ${projectId}.`);
+    async list(projectId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get workflows for ${projectId}.`);
     }
     /**
-     * Get workflows for project
+     * Create a workflow
      *
      * @param projectId - Project Id
-     * @param includeRocosGraph - Include Rocos graph
-     * @param includeStats - Include stats
-     * @param opsId - Ops Id
-     * @param workflowIds - Workflow Id's
+     * @param model - Workflow
      */
-    // TODO: map the response object
-    async getAll(projectId, includeRocosGraph = false, includeStats = false, opsId, workflowIds) {
-        const params = {
-            includeRocosGraph: includeRocosGraph ? 1 : 0,
-            includeStats: includeStats ? 1 : 0,
-        };
-        if (opsId) {
-            params.opsId = opsId;
-        }
-        if (workflowIds) {
-            params.workflowIds = workflowIds.join(',');
-        }
-        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get workflows for ${projectId}.`, params);
+    async create(projectId, model) {
+        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create workflow for ${projectId}.`);
     }
     /**
      * Get a workflow
      *
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
-     * @param includeInstances - Include instances
      */
-    // TODO: map the response object
-    async getOne(projectId, workflowId, includeInstances = false) {
-        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to get workflow for ${projectId}, workflowId ${workflowId}.`, { includeInstances: includeInstances ? 1 : 0 });
+    async get(projectId, workflowId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to get workflow for ${projectId}, workflowId ${workflowId}.`);
     }
     /**
      * Update a workflow
      *
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
-     * @param model - Payload
+     * @param model - Workflow
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateOne(projectId, workflowId, model) {
+    async update(projectId, workflowId, model) {
         return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), model, `Failed to update workflow for ${projectId}, workflowId ${workflowId}.`);
     }
     /**
@@ -79,40 +71,16 @@ export class WorkflowService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @param workflowId - Workflow Id
      */
-    // TODO: map the response object
-    async deleteOne(projectId, workflowId) {
+    async delete(projectId, workflowId) {
         return this.callDelete(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to delete workflow for ${projectId}, workflowId ${workflowId}.`);
     }
-    /**
-     * Get all workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getAllOfRobot(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get workflows for ${projectId}, callsign ${callsign}.`);
-    }
-    /**
-     * Update workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateAllForRobot(projectId, callsign, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
-    }
     /**
      * Get deployed workflows on robot
      *
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    async getDeployedOnRobot(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
+    async getDeployedWorkflows(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_PROJECT_DEPLOYED_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
     }
 }