@dronedeploy/rocos-js-sdk 1.0.0-alpha-2 → 3.0.0-alpha.19

package/services/EvaluatorService.d.ts

@@ -0,0 +1,11 @@
+import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RunCodeOptions } from '../helpers/websandbox/sandbox';
+export declare class EvaluatorService extends BaseServiceAbstract implements IBaseService {
+    private readonly sandbox;
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    teardown(): Promise<void>;
+    execute<T = unknown>(code: string | (() => T), context?: unknown, options?: RunCodeOptions): Promise<T>;
+}

package/services/EvaluatorService.js

@@ -0,0 +1,28 @@
+import { RocosError, errorCodes } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { WebSandbox } from '../helpers';
+export class EvaluatorService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`EvaluatorService(${this.config.url})`);
+        this.sandbox = WebSandbox.new().catch((e) => {
+            this.logger.error('Failed to create WebSandbox', e);
+            throw e;
+        });
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.EVALUATOR_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    async teardown() {
+        const sandbox = await this.sandbox;
+        sandbox.destroy();
+    }
+    async execute(code, context, options) {
+        const sandbox = await this.sandbox;
+        return sandbox.run(code, context, options);
+    }
+}

package/services/MapService.d.ts

@@ -1,5 +1,6 @@
 import { IBaseService, IRocosSDKConfig, Map, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { Observation } from '../models/maps/Panorama';
 /**
  * Integrations to retrieve data from the linked project in DroneDeploy
  */
@@ -52,7 +53,6 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      * @param options New metadata
      */
     update(projectId: string, mapId: string, options: {
-        name: string;
         description?: string;
         callsign?: string;
     }): Promise<void>;
@@ -90,7 +90,6 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      * @param options Options to create the new map
      */
     copy(projectId: string, mapId: string, options: {
-        name: string;
         description?: string;
     }): Promise<void>;
     /** Deploy a map from the cloud to a robot
@@ -104,6 +103,40 @@ export declare class MapService extends BaseServiceAbstract implements IBaseServ
      *
      * @param projectId Project ID
      * @param mapId Map ID
+     * @param frameId Frame ID (optional)
+     */
+    getGeoJSON(projectId: string, mapId: string, frameId?: string): Promise<unknown>;
+    /**
+     * Returns a Promise that resolves to an array of Observation objects for the given panorama ID.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to retrieve observations for.
+     * @returns A Promise that resolves to an array of Observation objects.
+     */
+    listObservations(projectId: string, panoramaId: string): Promise<Observation[]>;
+    /**
+     * Creates new observations on a panorama.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to create observations for.
+     * @param observations An array of Observation objects to create.
+     * @returns A Promise that resolves when the observations have been created.
+     */
+    createObservations(projectId: string, panoramaId: string, observations: Observation[]): Promise<void>;
+    /**
+     * Gets observations for a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @param key (optional) Filters on a key defined on the observation
+     * @param frameID (optional) Transforms on a seed frame
+     * @returns A list of observations
+     */
+    getObservations(projectId: string, key?: string, frameID?: string): Promise<Observation[]>;
+    /**
+     * Lists available keys for all observations in a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @returns A list of observations
      */
-    getGeoJSON(projectId: string, mapId: string): Promise<unknown>;
+    getObservationsKeys(projectId: string): Promise<string[]>;
 }

package/services/MapService.js

@@ -1,4 +1,4 @@
-import { API_MAPS_COPY_URL, API_MAPS_DEPLOYED_URL, API_MAPS_DEPLOY_URL, API_MAPS_GEOJSON_URL, API_MAPS_MERGE_URL, API_MAPS_URL, API_MAP_ID_URL, } from '../constants/api';
+import { API_MAPS_COPY_URL, API_MAPS_DEPLOYED_URL, API_MAPS_DEPLOY_URL, API_MAPS_GEOJSON_URL, API_MAPS_MERGE_URL, API_MAPS_PANORAMA_OBSERVATIONS_URL, API_MAPS_URL, API_MAP_ID_URL, API_OBSERVATIONS_URL, API_OBSERVATION_KEYS_URL, } from '../constants/api';
 import { RocosError, errorCodes } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
@@ -138,12 +138,55 @@ export class MapService extends BaseServiceAbstract {
      *
      * @param projectId Project ID
      * @param mapId Map ID
+     * @param frameId Frame ID (optional)
      */
-    async getGeoJSON(projectId, mapId) {
-        return this.callGet(formatServiceUrl(API_MAPS_GEOJSON_URL, {
+    async getGeoJSON(projectId, mapId, frameId) {
+        const params = {
             url: this.config.url,
             projectId,
             mapId,
-        }, this.config.insecure), 'Failed to get map GeoJSON.');
+        };
+        return this.callGet(formatServiceUrl(API_MAPS_GEOJSON_URL, params, this.config.insecure), 'Failed to get map GeoJSON.', frameId ? { frameID: frameId } : undefined);
+    }
+    /**
+     * Returns a Promise that resolves to an array of Observation objects for the given panorama ID.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to retrieve observations for.
+     * @returns A Promise that resolves to an array of Observation objects.
+     */
+    listObservations(projectId, panoramaId) {
+        return this.callGet(formatServiceUrl(API_MAPS_PANORAMA_OBSERVATIONS_URL, { url: this.config.url, projectId, panoramaId }, this.config.insecure), 'Failed to list observations.');
+    }
+    /**
+     * Creates new observations on a panorama.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to create observations for.
+     * @param observations An array of Observation objects to create.
+     * @returns A Promise that resolves when the observations have been created.
+     */
+    createObservations(projectId, panoramaId, observations) {
+        return this.callPut(formatServiceUrl(API_MAPS_PANORAMA_OBSERVATIONS_URL, { url: this.config.url, projectId, panoramaId }, this.config.insecure), observations, 'Failed to update observations.');
+    }
+    /**
+     * Gets observations for a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @param key (optional) Filters on a key defined on the observation
+     * @param frameID (optional) Transforms on a seed frame
+     * @returns A list of observations
+     */
+    getObservations(projectId, key = '', frameID = '') {
+        return this.callGet(formatServiceUrl(API_OBSERVATIONS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get observations.', { key, frameID });
+    }
+    /**
+     * Lists available keys for all observations in a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @returns A list of observations
+     */
+    getObservationsKeys(projectId) {
+        return this.callGet(formatServiceUrl(API_OBSERVATION_KEYS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get observation keys.');
     }
 }

package/services/TelemetryService.d.ts

@@ -35,6 +35,7 @@ export declare class TelemetryService extends BaseStreamService<ITelemetryStream
      */
     getRobotStatusChanges(projectId: string, callsign: string, heartbeatTimeoutMs?: number, intervalMs?: number): Observable<CallsignStatus>;
     protected initStream(stream: ITelemetryStream): Promise<void>;
+    private buildScope;
     private createStream;
     protected getStream(config: ITelemetryStreamConfig): ITelemetryStream;
 }

package/services/TelemetryService.js

@@ -7,6 +7,7 @@ import { RocosStore } from '../store/RocosStore';
 import { TelemetryStream } from '../api/streams/telemetry/TelemetryStream';
 import { arrayUnique } from '../helpers/arrayUnique';
 import { getUniqueId } from '../helpers/getUniqueId';
+import { flattenCallsignsLookup } from '../helpers/flattenCallsignsLookup';
 const HEARTBEAT_SOURCE = '/rocos/agent/telemetry/heartbeat';
 const HEARTBEAT_TIMEOUT = 5000; // if no heartbeat within 5 seconds then the robot is considered dead
 export class TelemetryService extends BaseStreamService {
@@ -47,7 +48,9 @@ export class TelemetryService extends BaseStreamService {
             this.logger.info('subscribe with query', params);
             callsignsLookup = new CallsignsLookup(params.query);
         }
-        const scope = params.scope ?? 'default';
+        // scope is used as a key to generate unique streams
+        // ideally there should be just one concurrent stream opened
+        const scope = this.buildScope(params, callsignsLookup);
         const callsigns = callsignsLookup.lookupValue;
         const subscriptionParams = {
             uniqueId: getUniqueId(params.projectId, callsignsLookup, sources, scope),
@@ -114,6 +117,15 @@ export class TelemetryService extends BaseStreamService {
         await super.initStream(stream);
         stream.init();
     }
+    buildScope(params, callsignsLookup) {
+        // prefix with project id to avoid stream instance to be shared across projects
+        if (params.scope)
+            return `${params.projectId}-${params.scope}`;
+        this.logger.debug(`No scope is set, generating default`);
+        if (callsignsLookup)
+            return `${params.projectId}-default-${flattenCallsignsLookup(callsignsLookup).join()}`;
+        return `${params.projectId}-default`;
+    }
     async createStream(projectId, callsignsLookup, sources, scope) {
         const newStream = await this.createStreamFromConfig(IDENTIFIER_NAME_TELEMETRY, {
             url: this.config.url,

package/services/TelemetryService.spec.js

@@ -1,6 +1,6 @@
-import { TelemetryService } from './TelemetryService';
-import { delay, from, lastValueFrom, NEVER, take, throwError } from 'rxjs';
 import { CallsignStatus } from '../models';
+import { NEVER, delay, from, lastValueFrom, take, throwError } from 'rxjs';
+import { TelemetryService } from './TelemetryService';
 describe('TelemetryService', () => {
     describe('getRobotStatusChanges', () => {
         it('should emit unknown to begin with', async () => {

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}.`);
     }
 }

package/services/index.d.ts

@@ -24,3 +24,4 @@ export * from './PlatformTimeService';
 export * from './SpotProvisioningService';
 export * from './SpotProvisioningServiceNode';
 export * from './MapService';
+export * from './EvaluatorService';

package/services/index.js

@@ -24,3 +24,4 @@ export * from './PlatformTimeService';
 export * from './SpotProvisioningService';
 export * from './SpotProvisioningServiceNode';
 export * from './MapService';
+export * from './EvaluatorService';