@dronedeploy/rocos-js-sdk 2.6.1 → 3.0.0-alpha.20

package/models/stream/IWebRTCSignallingStream.d.ts

@@ -1,41 +1,76 @@
-import { GetDetailsResponse, Message, Outcome } from '../../grpc/video/pigeon_pb';
 import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest } from '../params/IWebRTCSignallingParams';
 import { IBaseStream } from './IBaseStream';
-import { grpc } from '@improbable-eng/grpc-web';
-export import IWebRTCSignallingMessage = Message;
-export import IWebRTCSignallingGetDetailsResponse = GetDetailsResponse;
-export import IWebRTCSignallingOutcome = Outcome;
+export interface IWebRTCSignallingMessage {
+    videoId: string;
+    messageType: string;
+    payload: string;
+}
+export interface IWebRTCSignallingGetDetailsResponse {
+    operators: number;
+}
+export interface IWebRTCSignallingOutcome {
+    outcome: string;
+    message: string;
+}
 export interface IStatus {
     details: string;
-    code: number;
-    metadata: grpc.Metadata;
+    /**
+     * For gRPC, it will be the string value of a StatusCode enum value
+     * https://github.com/grpc/grpc/blob/a19d8dcfb50caa81cddc25bc1a6afdd7a2f497b7/include/grpcpp/impl/codegen/status_code_enum.h#L24
+     */
+    code: string;
+    metadata: Record<string, string | string[]>;
 }
 export interface IServiceError {
     message: string;
     code: number;
-    metadata: grpc.Metadata;
+    metadata: Record<string, string>;
 }
 /**
- * Represent the gRPC stream for the estabilshed operation connection
+ * Represent the gRPC stream for the established operation connection
  */
-export interface IWebRTCSignallingResponseStream<T> {
+export interface IWebRTCSignallingResponseStream<T> extends AsyncIterable<T> {
+    /**
+     * Add a callback for every new datum.
+     * If a new message arrived, the "message" argument is set.
+     * If an error occurred, the "error" argument is set.
+     * If the stream is complete, the "complete" argument is `true`.
+     * Only one of the arguments is used at a time.
+     */
+    onNext(callback: (message: T | undefined, error: Error | undefined, complete: boolean) => void): () => void;
+    /**
+     * Add a callback for every new message.
+     */
+    onMessage(callback: (message: T) => void): () => void;
+    /**
+     * Add a callback for stream completion.
+     * Called only when all messages have been read without error.
+     * The stream is closed when this callback is called.
+     */
+    onComplete(callback: () => void): () => void;
+    /**
+     * Add a callback for errors.
+     * The stream is closed when this callback is called.
+     */
+    onError(callback: (reason: Error) => void): () => void;
+    /**
+     * Cancel the stream
+     */
     cancel(): void;
-    on(type: 'data', handler: (message: T) => void): IWebRTCSignallingResponseStream<T>;
-    on(type: 'end', handler: (status?: IStatus) => void): IWebRTCSignallingResponseStream<T>;
-    on(type: 'status', handler: (status: IStatus) => void): IWebRTCSignallingResponseStream<T>;
+    status(): Promise<IStatus>;
 }
 export interface IWebRTCSignallingStream extends IBaseStream {
     connectOperator: (request: IOperatorConnectRequest) => IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>;
     /**
      * Get the peer details
      */
-    getDetails: (request: IGetDetailsRequest, callback: (err: IServiceError | null, response: IWebRTCSignallingGetDetailsResponse | null) => void) => void;
+    getDetails: (request: IGetDetailsRequest) => Promise<IWebRTCSignallingGetDetailsResponse>;
     /**
      * Offer the connection to the peer
      */
-    offerConnection: (request: IOfferRequest, callback: (err: IServiceError | null, response: IWebRTCSignallingOutcome | null) => void) => void;
+    offerConnection: (request: IOfferRequest) => Promise<IWebRTCSignallingOutcome>;
     /**
      * Add candidate about self
      */
-    addIceCandidate: (request: IAddIceCandidateRequest, callback: (err: IServiceError | null, response: IWebRTCSignallingOutcome | null) => void) => void;
+    addIceCandidate: (request: IAddIceCandidateRequest) => Promise<IWebRTCSignallingOutcome>;
 }

package/models/stream/IWebRTCSignallingStream.js

@@ -1,7 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IWebRTCSignallingOutcome = exports.IWebRTCSignallingGetDetailsResponse = exports.IWebRTCSignallingMessage = void 0;
-const pigeon_pb_1 = require("../../grpc/video/pigeon_pb");
-exports.IWebRTCSignallingMessage = pigeon_pb_1.Message;
-exports.IWebRTCSignallingGetDetailsResponse = pigeon_pb_1.GetDetailsResponse;
-exports.IWebRTCSignallingOutcome = pigeon_pb_1.Outcome;
+export {};

package/models/types.d.ts

@@ -1,5 +1,5 @@
-export declare type RocosChangeMessageType = 'token' | 'user-token' | 'telemetry-subscription' | 'http-error';
-export declare type RobotModeType = 'physical' | 'virtual';
-export declare type RocosTelemetryMessageType = 'json' | 'string' | 'none' | 'raw';
-export declare type SearchStreamQueryDateFieldType = 'dateCreated' | 'dateReceived';
-export declare type ScheduleActionType = 'service' | 'command' | 'control';
+export type RocosChangeMessageType = 'token' | 'user-token' | 'telemetry-subscription' | 'http-error';
+export type RobotModeType = 'physical' | 'virtual';
+export type RocosTelemetryMessageType = 'json' | 'string' | 'none' | 'raw';
+export type SearchStreamQueryDateFieldType = 'dateCreated' | 'dateReceived';
+export type ScheduleActionType = 'service' | 'command' | 'control';

package/models/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

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/node/RocosSDKNode.d.ts

@@ -1,4 +1,4 @@
-import { ScheduleService } from '../services';
+import { EvaluatorService, ScheduleService } from '../services';
 import { CallerServiceNode } from '../services/CallerServiceNode';
 import { CommandServiceNode } from '../services/CommandServiceNode';
 import { ControlServiceNode } from '../services/ControlServiceNode';
@@ -39,4 +39,9 @@ export declare class RocosSDKNode extends RocosSDK {
      * @returns FileAccessorServiceNode
      */
     getFileAccessorService(): FileAccessorServiceNode;
+    /**
+     * Gets the evaluator service
+     * @returns EvaluatorServiceNode
+     */
+    getEvaluatorService(): EvaluatorService;
 }

package/node/RocosSDKNode.js

@@ -1,100 +1,96 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RocosSDKNode = void 0;
-const services_1 = require("../services");
-const AssetStorageService_1 = require("../services/AssetStorageService");
-const AuthService_1 = require("../services/AuthService");
-const CallerServiceNode_1 = require("../services/CallerServiceNode");
-const CommandServiceNode_1 = require("../services/CommandServiceNode");
-const ConfigGroupService_1 = require("../services/ConfigGroupService");
-const ControlServiceNode_1 = require("../services/ControlServiceNode");
-const DashboardService_1 = require("../services/DashboardService");
-const EventService_1 = require("../services/EventService");
-const FileAccessorServiceNode_1 = require("../services/FileAccessorServiceNode");
-const FunctionService_1 = require("../services/FunctionService");
-const IntegrationService_1 = require("../services/IntegrationService");
-const ProfileService_1 = require("../services/ProfileService");
-const ProjectService_1 = require("../services/ProjectService");
-const RobotService_1 = require("../services/RobotService");
-const RocosSDK_1 = require("../RocosSDK");
-const SearchServiceNode_1 = require("../services/SearchServiceNode");
-const ServiceEnum_1 = require("../models/ServiceEnum");
-const StreamService_1 = require("../services/StreamService");
-const TelemetryServiceNode_1 = require("../services/TelemetryServiceNode");
-const UserService_1 = require("../services/UserService");
-const WorkflowService_1 = require("../services/WorkflowService");
-class RocosSDKNode extends RocosSDK_1.RocosSDK {
+import { MapService, ScheduleService, SpotProvisioningServiceNode } from '../services';
+import { AssetStorageService } from '../services/AssetStorageService';
+import { AuthService } from '../services/AuthService';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ConfigGroupService } from '../services/ConfigGroupService';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { DashboardService } from '../services/DashboardService';
+import { EventService } from '../services/EventService';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { FunctionService } from '../services/FunctionService';
+import { IntegrationService } from '../services/IntegrationService';
+import { ProfileService } from '../services/ProfileService';
+import { ProjectService } from '../services/ProjectService';
+import { RobotService } from '../services/RobotService';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+import { ServiceEnum } from '../models/ServiceEnum';
+import { StreamService } from '../services/StreamService';
+import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
+import { UserService } from '../services/UserService';
+import { WorkflowService } from '../services/WorkflowService';
+export class RocosSDKNode extends RocosSDK {
     // eslint-disable-next-line max-lines-per-function
     getService(name) {
-        var _a;
-        if (!((_a = this.services) === null || _a === void 0 ? void 0 : _a[name])) {
+        if (!this.services?.[name]) {
             this.logger.info(`Service ${name} does not exist, creating it now.`);
             switch (name) {
-                case ServiceEnum_1.ServiceEnum.AUTH:
-                    this.services[name] = new AuthService_1.AuthService(this.config);
+                case ServiceEnum.AUTH:
+                    this.services[name] = new AuthService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.TELEMETRY:
-                    this.services[name] = new TelemetryServiceNode_1.TelemetryServiceNode(this.config);
+                case ServiceEnum.TELEMETRY:
+                    this.services[name] = new TelemetryServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.ROBOT:
-                    this.services[name] = new RobotService_1.RobotService(this.config);
+                case ServiceEnum.ROBOT:
+                    this.services[name] = new RobotService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.EVENT:
-                    this.services[name] = new EventService_1.EventService(this.config);
+                case ServiceEnum.EVENT:
+                    this.services[name] = new EventService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.PROJECT:
-                    this.services[name] = new ProjectService_1.ProjectService(this.config);
+                case ServiceEnum.PROJECT:
+                    this.services[name] = new ProjectService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.CALLER:
-                    this.services[name] = new CallerServiceNode_1.CallerServiceNode(this.config);
+                case ServiceEnum.CALLER:
+                    this.services[name] = new CallerServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.COMMAND:
-                    this.services[name] = new CommandServiceNode_1.CommandServiceNode(this.config);
+                case ServiceEnum.COMMAND:
+                    this.services[name] = new CommandServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.CONTROL:
-                    this.services[name] = new ControlServiceNode_1.ControlServiceNode(this.config);
+                case ServiceEnum.CONTROL:
+                    this.services[name] = new ControlServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.SEARCH:
-                    this.services[name] = new SearchServiceNode_1.SearchServiceNode(this.config);
+                case ServiceEnum.SEARCH:
+                    this.services[name] = new SearchServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.CONFIG_GROUP:
-                    this.services[name] = new ConfigGroupService_1.ConfigGroupService(this.config);
+                case ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new ConfigGroupService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.DASHBOARD:
-                    this.services[name] = new DashboardService_1.DashboardService(this.config);
+                case ServiceEnum.DASHBOARD:
+                    this.services[name] = new DashboardService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.FUNCTION:
-                    this.services[name] = new FunctionService_1.FunctionService(this.config);
+                case ServiceEnum.FUNCTION:
+                    this.services[name] = new FunctionService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.STREAM:
-                    this.services[name] = new StreamService_1.StreamService(this.config);
+                case ServiceEnum.STREAM:
+                    this.services[name] = new StreamService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.USER:
-                    this.services[name] = new UserService_1.UserService(this.config);
+                case ServiceEnum.USER:
+                    this.services[name] = new UserService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.WORKFLOW:
-                    this.services[name] = new WorkflowService_1.WorkflowService(this.config);
+                case ServiceEnum.WORKFLOW:
+                    this.services[name] = new WorkflowService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.ASSET_STORAGE:
-                    this.services[name] = new AssetStorageService_1.AssetStorageService(this.config);
+                case ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new AssetStorageService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.PROFILE:
-                    this.services[name] = new ProfileService_1.ProfileService(this.config);
+                case ServiceEnum.PROFILE:
+                    this.services[name] = new ProfileService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.FILE_ACCESSOR:
-                    this.services[name] = new FileAccessorServiceNode_1.FileAccessorServiceNode(this.config);
+                case ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new FileAccessorServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.SPOT_PROVISIONER:
-                    this.services[name] = new services_1.SpotProvisioningServiceNode(this.config);
+                case ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new SpotProvisioningServiceNode(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.SCHEDULE:
-                    this.services[name] = new services_1.ScheduleService(this.config);
+                case ServiceEnum.SCHEDULE:
+                    this.services[name] = new ScheduleService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.INTEGRATION:
-                    this.services[name] = new IntegrationService_1.IntegrationService(this.config);
+                case ServiceEnum.INTEGRATION:
+                    this.services[name] = new IntegrationService(this.config);
                     break;
-                case ServiceEnum_1.ServiceEnum.MAP:
-                    this.services[name] = new services_1.MapService(this.config);
+                case ServiceEnum.MAP:
+                    this.services[name] = new MapService(this.config);
                     break;
             }
         }
@@ -105,44 +101,50 @@ class RocosSDKNode extends RocosSDK_1.RocosSDK {
      * Gets the telemetry service.
      */
     getTelemetryService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.TELEMETRY);
+        return this.getService(ServiceEnum.TELEMETRY);
     }
     /**
      * Gets the scheduler service.
      */
     getSchedulerService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.SCHEDULE);
+        return this.getService(ServiceEnum.SCHEDULE);
     }
     /**
      * Gets the service call service.
      */
     getCallerService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.CALLER);
+        return this.getService(ServiceEnum.CALLER);
     }
     /**
      * Gets the command service.
      */
     getCommandService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.COMMAND);
+        return this.getService(ServiceEnum.COMMAND);
     }
     /**
      * Gets the robot control service.
      */
     getControlService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.CONTROL);
+        return this.getService(ServiceEnum.CONTROL);
     }
     /**
      * Gets the search service.
      */
     getSearchService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.SEARCH);
+        return this.getService(ServiceEnum.SEARCH);
     }
     /**
      * Gets the file accessor service
      * @returns FileAccessorServiceNode
      */
     getFileAccessorService() {
-        return this.getService(ServiceEnum_1.ServiceEnum.FILE_ACCESSOR);
+        return this.getService(ServiceEnum.FILE_ACCESSOR);
+    }
+    /**
+     * Gets the evaluator service
+     * @returns EvaluatorServiceNode
+     */
+    getEvaluatorService() {
+        throw new Error('Evaluator service is not supported in NodeJS');
     }
 }
-exports.RocosSDKNode = RocosSDKNode;

package/node/index.js

@@ -1,19 +1,7 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./RocosSDKNode"), exports);
-__exportStar(require("../services/CallerServiceNode"), exports);
-__exportStar(require("../services/CommandServiceNode"), exports);
-__exportStar(require("../services/ControlServiceNode"), exports);
-__exportStar(require("../services/FileAccessorServiceNode"), exports);
-__exportStar(require("../services/SearchServiceNode"), exports);
-__exportStar(require("../services/TelemetryServiceNode"), exports);
+export * from './RocosSDKNode';
+export * from '../services/CallerServiceNode';
+export * from '../services/CommandServiceNode';
+export * from '../services/ControlServiceNode';
+export * from '../services/FileAccessorServiceNode';
+export * from '../services/SearchServiceNode';
+export * from '../services/TelemetryServiceNode';

package/package.json

@@ -1,30 +1,29 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "2.6.1",
+  "version": "3.0.0-alpha.20",
   "description": "Javascript SDK for rocos",
   "main": "index.js",
-  "types": "dist/index.d.ts",
+  "types": "index.d.ts",
   "author": "Rocos",
-  "engines": {
-    "npm": ">=8.0.0",
-    "node": ">=18.13.0"
-  },
   "scripts": {},
   "license": "MIT",
   "devDependencies": {},
   "dependencies": {
     "@grpc/grpc-js": "^1.7.1",
     "@improbable-eng/grpc-web": "^0.14.0",
+    "@protobuf-ts/grpcweb-transport": "^2.9.1",
+    "@protobuf-ts/plugin": "^2.9.1",
+    "@protobuf-ts/runtime": "^2.9.1",
     "buffer": "^6.0.3",
-    "google-protobuf": "^3.15.6",
     "loglevel": "^1.7.1",
     "loglevel-plugin-prefix": "^0.8.4",
-    "mathjs": "^9.3.0",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.0"
   },
   "peerDependencies": {
     "rxjs": "^6.6.6 || ^7.0.0"
   },
   "repository": {},
-  "private": false
-}
+  "private": false,
+  "type": "module",
+  "sideEffects": false
+}

package/services/AssetStorageService.d.ts

@@ -1,4 +1,4 @@
-import { AssetItemModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel } from '../models';
+import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel } from '../models';
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { IBaseService } from '../models/IBaseService';
@@ -63,6 +63,28 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param signedURL
      */
     listFlowAssets(projectId: string, flowId: string, flowInstance: string, parent?: string, signedURL?: boolean): Promise<AssetItemModel[]>;
+    /**
+     * List assets for a mission
+     *
+     * @param projectId
+     * @param assetIdList
+     */
+    listMissionAssets(projectId: string, assetIdList: string[]): Promise<AssetItemModel[]>;
+    /**
+     * Get a single asset for a mission
+     *
+     * @param projectId
+     * @param assetId
+     */
+    getMissionAsset(projectId: string, assetId: string): Promise<AssetItemModel>;
+    /**
+     * Lists mapped assets
+     *
+     * @param projectId
+     * @param start Start date for the query (optional)
+     * @param end End date for the query (optional)
+     */
+    listMappedAssets(projectId: string, start?: Date, end?: Date): Promise<AssetItemWithObservationsModel[]>;
     /**
      * Set Robot Sync Definitions
      * @param projectId