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

package/cjs/models/message/RocosSearchRowMessage.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosSearchRowMessage = void 0;
+class RocosSearchRowMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromMessage(row) {
+        const msg = new RocosSearchRowMessage();
+        msg.key = row.key;
+        msg.count = Number(row.count);
+        msg.avgSize = row.avgSize;
+        msg.totalSize = row.totalSize;
+        msg.payload = row.payload;
+        msg.transPerSecond = row.transPerSecond;
+        msg.bytesPerSecond = row.bytesPerSecond;
+        return msg;
+    }
+}
+exports.RocosSearchRowMessage = RocosSearchRowMessage;

package/cjs/models/message/RocosTelemetryMessage.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosTelemetryMessage = void 0;
+const grpc_1 = require("../../constants/grpc");
+const nanosecondToMillisecond_1 = require("../../helpers/nanosecondToMillisecond");
+class RocosTelemetryMessage {
+    static fromTelemetryMessage(msg, data, type) {
+        return {
+            isackable: false,
+            hasHeartbeat: msg.source === grpc_1.GRPC_SOURCE_HEARTBEAT,
+            isStreamMessage: false,
+            callsign: msg.callsign,
+            source: msg.source,
+            payload: RocosTelemetryMessage.getPayload(msg.payload, type),
+            createdAt: new Date((0, nanosecondToMillisecond_1.nanosecondToMillisecond)(msg.created)),
+            uid: msg.uid,
+            seq: Number(msg.seq),
+            receivedAt: new Date(),
+            subId: data.subId,
+            projectId: data.projectId,
+            subscriberId: data.subscriberId,
+            type,
+        };
+    }
+    static fromTelemetryStreamMessage(msg, data, type) {
+        if (msg.content.oneofKind !== 'message') {
+            throw new Error(`Invalid message type. Expected message, received ${msg.content.oneofKind}`);
+        }
+        const telemetry = msg.content.message;
+        return {
+            isStreamMessage: true,
+            isackable: msg.isAckable,
+            hasHeartbeat: false,
+            callsign: telemetry.callsign,
+            source: telemetry.source,
+            payload: RocosTelemetryMessage.getPayload(telemetry.payload, type),
+            createdAt: new Date((0, nanosecondToMillisecond_1.nanosecondToMillisecond)(telemetry.created)),
+            uid: telemetry.uid,
+            seq: Number(telemetry.seq),
+            receivedAt: new Date(),
+            subId: data.subId,
+            projectId: data.projectId,
+            subscriberId: data.subscriberId,
+            type,
+        };
+    }
+    static getPayloadAsString(payload) {
+        return new TextDecoder().decode(payload);
+    }
+    static getPayloadAsJSON(payload) {
+        return JSON.parse(RocosTelemetryMessage.getPayloadAsString(payload));
+    }
+    static getPayload(payload, type) {
+        switch (type) {
+            case 'string':
+                return RocosTelemetryMessage.getPayloadAsString(payload);
+            case 'json':
+                return this.getPayloadAsJSON(payload);
+            case 'none':
+                return null;
+            case 'raw':
+            default:
+                return payload;
+        }
+    }
+}
+exports.RocosTelemetryMessage = RocosTelemetryMessage;

package/cjs/models/message/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./IRocosCallerMessage"), exports);
+__exportStar(require("./IRocosChangeMessage"), exports);
+__exportStar(require("./IRocosCommandMessage"), exports);
+__exportStar(require("./IRocosControlMessage"), exports);
+__exportStar(require("./IRocosOpResultMessage"), exports);
+__exportStar(require("./IRocosSearchMessage"), exports);
+__exportStar(require("./IRocosSearchRowMessage"), exports);
+__exportStar(require("./IRocosSearchStatusMessage"), exports);
+__exportStar(require("./IRocosTelemetryMessage"), exports);
+__exportStar(require("./IStreamStatusMessage"), exports);
+__exportStar(require("./RocosCallerMessage"), exports);
+__exportStar(require("./RocosCommandMessage"), exports);
+__exportStar(require("./RocosControlMessage"), exports);
+__exportStar(require("./RocosOpResultMessage"), exports);
+__exportStar(require("./RocosSearchMessage"), exports);
+__exportStar(require("./RocosSearchRowMessage"), exports);
+__exportStar(require("./RocosTelemetryMessage"), exports);

package/cjs/models/params/ICallerParams.d.ts

@@ -0,0 +1,26 @@
+import { RocosResponseLevel } from '../caller';
+export interface ICallerParams {
+    uid: string;
+    projectId: string;
+    callsign: string;
+    subSystem: string;
+    component?: string;
+    topic?: string;
+}
+export interface ICallerInvokeParams extends ICallerParams {
+    component: string;
+    topic: string;
+    responseLevelNumber: RocosResponseLevel | number;
+    payload: string;
+    query?: Record<string, string[]>;
+}
+export interface ICallerCallParams {
+    projectId: string;
+    callsign: string;
+    source: string;
+    payload?: unknown;
+    options?: {
+        uid?: string;
+        query?: Record<string, string[]>;
+    };
+}

package/cjs/models/params/ICallerParams.js

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

package/cjs/models/params/ICommandParams.js

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

package/cjs/models/params/IControlParams.js

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

package/cjs/models/params/IFileAccessorParams.js

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

package/cjs/models/params/ISearchParams.js

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

package/cjs/models/params/ITelemetryParams.js

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

package/cjs/models/params/IWebRTCSignallingParams.js

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

package/cjs/models/projects/ProjectUser.js

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

package/cjs/models/schedule/IScheduleAction.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionType = void 0;
+var ActionType;
+(function (ActionType) {
+    ActionType["command"] = "command";
+    ActionType["service"] = "service";
+    ActionType["sendMessage"] = "control";
+})(ActionType || (exports.ActionType = ActionType = {}));

package/cjs/models/schedule/IScheduleInfo.js

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

package/cjs/models/schedule/IScheduleJob.js

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

package/cjs/models/search/SearchQueryFilter.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchQueryFilter = void 0;
+class SearchQueryFilter {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}
+exports.SearchQueryFilter = SearchQueryFilter;

package/cjs/models/search/SearchStreamQuery.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchStreamQuery = void 0;
+class SearchStreamQuery {
+    constructor(init) {
+        this.disableDateHistogram = false;
+        Object.assign(this, init);
+    }
+}
+exports.SearchStreamQuery = SearchStreamQuery;

package/cjs/models/stream/IBaseStream.js

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

package/cjs/models/stream/ICallerStream.js

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

package/cjs/models/stream/ICommandStream.js

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

package/cjs/models/stream/IControlStream.js

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

package/cjs/models/stream/IFileAccessorStream.js

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

package/cjs/models/stream/ISearchStream.js

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

package/cjs/models/stream/ITelemetryStream.js

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

package/cjs/models/stream/IWebRTCSignallingStream.js

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

package/cjs/models/target/Target.d.ts

@@ -0,0 +1,27 @@
+import { Quaternion } from '../graph/Quaternion';
+import { Vector3 } from '../graph/Vector3';
+/**
+ * Observation target model (such as an asset, a point of interest, a puddle, etc.)
+ */
+export interface Target {
+    /**
+     * Unique identifier of the target
+     */
+    id: string;
+    /**
+     * Name of the target
+     */
+    name: string;
+    /**
+     * Metadata associated with the target (key-value pairs) such as name, type, asset-id, etc.
+     */
+    data: Record<string, string>;
+    /**
+     * Position of the target in the 3D space
+     */
+    translation: Vector3;
+    /**
+     * Rotation of the target in the 3D space
+     */
+    rotation: Quaternion;
+}

package/cjs/models/target/Target.js

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

package/cjs/models/types.js

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

package/cjs/models/workflow/Workflow.d.ts

@@ -0,0 +1,94 @@
+export type ResourceType = 'Manifest' | 'AgentGraph' | 'Javascript' | 'NodeDefinition' | 'Other';
+export interface Resource {
+    type: ResourceType;
+    data: string;
+    hash: string;
+    link: string;
+    contentLink?: string;
+    size?: number;
+    path?: string;
+}
+export interface Resources {
+    [key: string]: Resource;
+}
+export interface Author {
+    id: string;
+    name: string;
+    email: string;
+}
+interface ResponseBase {
+    id: string;
+    createdBy: string;
+    updatedBy: string;
+    dateCreated: number;
+    dateUpdated: number;
+}
+export interface WorkflowBase {
+    flowId: string;
+    name: string;
+    description?: string;
+    resources?: Resources;
+    type?: string;
+}
+export interface Workflow extends WorkflowBase, ResponseBase {
+    projectId: string;
+    author: Author;
+    latestVersion: string;
+    type: string;
+}
+export interface DeployedFlow {
+    flowId: string;
+    flow?: Workflow;
+    deployed?: boolean;
+}
+export interface WorkflowList extends Omit<WorkflowBase, 'resources'>, ResponseBase {
+    type?: 'cloud';
+    author: {
+        id: string;
+        name: string;
+        email: string;
+    } | Record<string, never>;
+}
+export interface WorkflowRevision {
+    id: string;
+    version: number;
+    authorName: string;
+    createdBy: string;
+    dateCreated: number;
+    description: string;
+    selected?: boolean;
+}
+export interface ManifestResource {
+    path: string;
+    provider: string;
+    runtime: string;
+    options: string[];
+}
+export interface ManifestArgument {
+    default?: string;
+    description?: string;
+    type: string;
+}
+export interface Manifest {
+    main: [string, string];
+    signals?: {
+        main: {
+            args: string[];
+            entry: [string, string];
+        };
+    };
+    arguments?: unknown | Record<string, ManifestArgument>;
+    resources: ManifestResource[];
+    mode?: 'cloud';
+}
+export interface CreateAssetResponse {
+    id: string;
+    name: string;
+    path: string;
+    dateCreated: number;
+    hash: string;
+    postContentLink: string;
+    type: 'file';
+    workflow: string;
+}
+export {};

package/cjs/models/workflow/Workflow.js

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

package/cjs/node/RocosSDKNode.d.ts

@@ -0,0 +1,47 @@
+import { EvaluatorService } from '../services';
+import { IBaseService, ServiceEnum } from '../models';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
+export declare class RocosSDKNode extends RocosSDK {
+    getService<T extends IBaseService>(name: ServiceEnum): T;
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService(): TelemetryServiceNode;
+    /**
+     * Gets the service call service.
+     */
+    getCallerService(): CallerServiceNode;
+    /**
+     * Gets the command service.
+     */
+    getCommandService(): CommandServiceNode;
+    /**
+     * Gets the robot control service.
+     */
+    getControlService(): ControlServiceNode;
+    /**
+     * Gets the search service.
+     */
+    getSearchService(): SearchServiceNode;
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorServiceNode
+     */
+    getFileAccessorService(): FileAccessorServiceNode;
+    /**
+     * Gets the evaluator service
+     * @deprecated Not supported in Node.js
+     */
+    getEvaluatorService(): EvaluatorService;
+    /**
+     * Gets the WebRTC service
+     * @deprecated Not supported in Node.js
+     */
+    getRTPWebRTCService(): never;
+}

package/cjs/node/RocosSDKNode.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosSDKNode = void 0;
+const services_1 = require("../services");
+const models_1 = require("../models");
+const CallerServiceNode_1 = require("../services/CallerServiceNode");
+const CommandServiceNode_1 = require("../services/CommandServiceNode");
+const ControlServiceNode_1 = require("../services/ControlServiceNode");
+const FileAccessorServiceNode_1 = require("../services/FileAccessorServiceNode");
+const RocosSDK_1 = require("../RocosSDK");
+const SearchServiceNode_1 = require("../services/SearchServiceNode");
+const TelemetryServiceNode_1 = require("../services/TelemetryServiceNode");
+const WorkflowServiceNode_1 = require("../services/WorkflowServiceNode");
+class RocosSDKNode extends RocosSDK_1.RocosSDK {
+    // eslint-disable-next-line max-lines-per-function
+    getService(name) {
+        if (!this.services?.[name]) {
+            this.logger.info(`Service ${name} does not exist, creating it now.`);
+            const config = this.overrideConfig(name);
+            switch (name) {
+                case models_1.ServiceEnum.AUTH:
+                    this.services[name] = new services_1.AuthService(config);
+                    break;
+                case models_1.ServiceEnum.TELEMETRY:
+                    this.services[name] = new TelemetryServiceNode_1.TelemetryServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.ROBOT:
+                    this.services[name] = new services_1.RobotService(config);
+                    break;
+                case models_1.ServiceEnum.EVENT:
+                    this.services[name] = new services_1.EventService(config);
+                    break;
+                case models_1.ServiceEnum.PROJECT:
+                    this.services[name] = new services_1.ProjectService(config);
+                    break;
+                case models_1.ServiceEnum.CALLER:
+                    this.services[name] = new CallerServiceNode_1.CallerServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.COMMAND:
+                    this.services[name] = new CommandServiceNode_1.CommandServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.CONTROL:
+                    this.services[name] = new ControlServiceNode_1.ControlServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.SEARCH:
+                    this.services[name] = new SearchServiceNode_1.SearchServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new services_1.ConfigGroupService(config);
+                    break;
+                case models_1.ServiceEnum.DASHBOARD:
+                    this.services[name] = new services_1.DashboardService(config);
+                    break;
+                case models_1.ServiceEnum.STREAM:
+                    this.services[name] = new services_1.StreamService(config);
+                    break;
+                case models_1.ServiceEnum.USER:
+                    this.services[name] = new services_1.UserService(config);
+                    break;
+                case models_1.ServiceEnum.WORKFLOW:
+                    this.services[name] = new WorkflowServiceNode_1.WorkflowServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new services_1.AssetStorageService(config);
+                    break;
+                case models_1.ServiceEnum.PROFILE:
+                    this.services[name] = new services_1.ProfileService(config);
+                    break;
+                case models_1.ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new FileAccessorServiceNode_1.FileAccessorServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new services_1.SpotProvisioningServiceNode(config);
+                    break;
+                case models_1.ServiceEnum.SCHEDULE:
+                    this.services[name] = new services_1.ScheduleService(config);
+                    break;
+                case models_1.ServiceEnum.INTEGRATION:
+                    this.services[name] = new services_1.IntegrationService(config);
+                    break;
+                case models_1.ServiceEnum.MAP:
+                    this.services[name] = new services_1.MapService(config);
+                    break;
+                case models_1.ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new services_1.DeviceCredentialsService(config);
+                    break;
+                case models_1.ServiceEnum.TARGET:
+                    this.services[name] = new services_1.TargetService(config);
+                    break;
+            }
+        }
+        this.logger.debug(`Found service ${name}.`);
+        return this.services[name];
+    }
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService() {
+        return this.getService(models_1.ServiceEnum.TELEMETRY);
+    }
+    /**
+     * Gets the service call service.
+     */
+    getCallerService() {
+        return this.getService(models_1.ServiceEnum.CALLER);
+    }
+    /**
+     * Gets the command service.
+     */
+    getCommandService() {
+        return this.getService(models_1.ServiceEnum.COMMAND);
+    }
+    /**
+     * Gets the robot control service.
+     */
+    getControlService() {
+        return this.getService(models_1.ServiceEnum.CONTROL);
+    }
+    /**
+     * Gets the search service.
+     */
+    getSearchService() {
+        return this.getService(models_1.ServiceEnum.SEARCH);
+    }
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorServiceNode
+     */
+    getFileAccessorService() {
+        return this.getService(models_1.ServiceEnum.FILE_ACCESSOR);
+    }
+    /**
+     * Gets the evaluator service
+     * @deprecated Not supported in Node.js
+     */
+    getEvaluatorService() {
+        throw new Error('Evaluator service is not supported in NodeJS');
+    }
+    /**
+     * Gets the WebRTC service
+     * @deprecated Not supported in Node.js
+     */
+    getRTPWebRTCService() {
+        throw new Error('WebRTC service is not supported in NodeJS');
+    }
+}
+exports.RocosSDKNode = RocosSDKNode;

package/cjs/node/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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);