@dronedeploy/rocos-js-sdk 3.0.1-alpha.1 → 3.0.1-alpha.14

package/cjs/models/index.js

@@ -0,0 +1,96 @@
+"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("./asset-storage/AssetItem"), exports);
+__exportStar(require("./asset-storage/SyncIntegrations"), exports);
+__exportStar(require("./schedule/IScheduleInfo"), exports);
+__exportStar(require("./schedule/IScheduleAction"), exports);
+__exportStar(require("./schedule/IScheduleJob"), exports);
+__exportStar(require("./caller"), exports);
+__exportStar(require("./callsigns/CallsignsEnums"), exports);
+__exportStar(require("./callsigns/CallsignsLookup"), exports);
+__exportStar(require("./callsigns/CallsignsQuery"), exports);
+__exportStar(require("./callsigns/CallsignsQueryPredicate"), exports);
+__exportStar(require("./command"), exports);
+__exportStar(require("./file/FileEnums"), exports);
+__exportStar(require("./message"), exports);
+__exportStar(require("./params/ICallerParams"), exports);
+__exportStar(require("./params/ICommandParams"), exports);
+__exportStar(require("./params/IControlParams"), exports);
+__exportStar(require("./params/IFileAccessorParams"), exports);
+__exportStar(require("./params/ISearchParams"), exports);
+__exportStar(require("./params/ITelemetryParams"), exports);
+__exportStar(require("./params/IWebRTCSignallingParams"), exports);
+__exportStar(require("./search/SearchQueryFilter"), exports);
+__exportStar(require("./search/SearchStreamQuery"), exports);
+__exportStar(require("./stream/IBaseStream"), exports);
+__exportStar(require("./stream/ICallerStream"), exports);
+__exportStar(require("./stream/ICommandStream"), exports);
+__exportStar(require("./stream/IControlStream"), exports);
+__exportStar(require("./stream/IFileAccessorStream"), exports);
+__exportStar(require("./stream/ISearchStream"), exports);
+__exportStar(require("./stream/ITelemetryStream"), exports);
+__exportStar(require("./stream/IWebRTCSignallingStream"), exports);
+__exportStar(require("./integrations/Overlay"), exports);
+__exportStar(require("./integrations/Plan"), exports);
+__exportStar(require("./maps/Map"), exports);
+__exportStar(require("./maps/Panorama"), exports);
+__exportStar(require("./projects/ProjectUser"), exports);
+__exportStar(require("./CallsignStatus"), exports);
+__exportStar(require("./ExportDataQuery"), exports);
+__exportStar(require("./HttpError"), exports);
+__exportStar(require("./IBaseService"), exports);
+__exportStar(require("./IConfigGroup"), exports);
+__exportStar(require("./IDebugLevel"), exports);
+__exportStar(require("./IExportDataQuery"), exports);
+__exportStar(require("./IFunctionConfig"), exports);
+__exportStar(require("./IInvitation"), exports);
+__exportStar(require("./IInvitationExists"), exports);
+__exportStar(require("./IOperation"), exports);
+__exportStar(require("./IPersonalAccessToken"), exports);
+__exportStar(require("./IProject"), exports);
+__exportStar(require("./IProjectApplication"), exports);
+__exportStar(require("./IProjectInfo"), exports);
+__exportStar(require("./IRobot"), exports);
+__exportStar(require("./IRobotConfig"), exports);
+__exportStar(require("./IRobotPlugin"), exports);
+__exportStar(require("./IRobotSettings"), exports);
+__exportStar(require("./IRobotTemplate"), exports);
+__exportStar(require("./IRocosSDKConfig"), exports);
+__exportStar(require("./ISource"), exports);
+__exportStar(require("./IStream"), exports);
+__exportStar(require("./IStreamConfig"), exports);
+__exportStar(require("./IStreamOptions"), exports);
+__exportStar(require("./IStreamSource"), exports);
+__exportStar(require("./ITelemetryStreamConfig"), exports);
+__exportStar(require("./IToken"), exports);
+__exportStar(require("./IWidget"), exports);
+__exportStar(require("./IWidgetLineGroup"), exports);
+__exportStar(require("./Robot"), exports);
+__exportStar(require("./RobotConfig"), exports);
+__exportStar(require("./RobotPlugin"), exports);
+__exportStar(require("./RobotTemplate"), exports);
+__exportStar(require("./RocosError"), exports);
+__exportStar(require("./ServiceEnum"), exports);
+__exportStar(require("./Stream"), exports);
+__exportStar(require("./StreamOptions"), exports);
+__exportStar(require("./StreamSource"), exports);
+__exportStar(require("./SubscriberStatusEnum"), exports);
+__exportStar(require("./Token"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./Widget"), exports);
+__exportStar(require("./WidgetLineGroup"), exports);
+__exportStar(require("./workflow/Workflow"), exports);

package/cjs/models/integrations/Overlay.js

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

package/cjs/models/integrations/Plan.js

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

package/cjs/models/maps/Map.js

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

package/cjs/models/maps/Panorama.d.ts

@@ -0,0 +1,36 @@
+export interface Position {
+    pitch: number;
+    yaw: number;
+    x?: number;
+    y?: number;
+}
+export interface Quaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+export interface Vector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface Observation {
+    panoramaID: string;
+    id?: string;
+    name?: string;
+    data?: Record<string, string>;
+    geometry?: Position[];
+    center?: Position;
+}
+export interface Panorama {
+    transform: {
+        parent: string;
+        id: string;
+        rot: Quaternion;
+        pos: Vector3;
+    };
+    data: {
+        path: string;
+    };
+}

package/cjs/models/maps/Panorama.js

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

package/cjs/models/message/IRocosCallerMessage.js

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

package/cjs/models/message/IRocosChangeMessage.js

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

package/cjs/models/message/IRocosCommandMessage.js

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

package/cjs/models/message/IRocosControlMessage.js

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

package/cjs/models/message/IRocosOpResultMessage.js

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

package/cjs/models/message/IRocosSearchMessage.js

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

package/cjs/models/message/IRocosSearchRowMessage.js

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

package/cjs/models/message/IRocosSearchStatusMessage.js

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

package/cjs/models/message/IRocosTelemetryMessage.d.ts

@@ -0,0 +1,23 @@
+import { RocosTelemetryMessageType } from '../types';
+export interface IRocosTelemetryMessage<T extends RocosTelemetryMessageType = 'json', R = unknown> {
+    subId: string;
+    uid: string;
+    seq: number;
+    subscriberId?: string;
+    createdAt: Date;
+    projectId: string;
+    callsign: string;
+    source: string;
+    payload: PayloadType<R>[T];
+    type: T;
+    hasHeartbeat: boolean;
+    isackable: boolean;
+    isStreamMessage: boolean;
+    receivedAt: Date;
+}
+export interface PayloadType<R = unknown> {
+    'json': R;
+    'string': string;
+    'none': null;
+    'raw': Uint8Array;
+}

package/cjs/models/message/IRocosTelemetryMessage.js

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

package/cjs/models/message/IStreamStatusMessage.js

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

package/cjs/models/message/RocosCallerMessage.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosCallerMessage = void 0;
+const flattenOneOf_1 = require("../../helpers/flattenOneOf");
+const nanosecondToMillisecond_1 = require("../../helpers/nanosecondToMillisecond");
+class RocosCallerMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromModel(model) {
+        const message = new RocosCallerMessage();
+        const obj = (0, flattenOneOf_1.flattenOneOf)(model, true);
+        const responses = obj.responses?.responses.map((response) => {
+            if (!response?.return?.header)
+                return response;
+            const { created } = response.return.header;
+            const newResponse = {
+                ...response,
+                return: {
+                    ...response.return,
+                    header: {
+                        createdNs: created.toString(),
+                        createdAt: new Date((0, nanosecondToMillisecond_1.nanosecondToMillisecond)(created)),
+                        meta: response.return.header.meta,
+                    },
+                },
+            };
+            return newResponse;
+        }) ?? [];
+        message.chunks = obj.chunks;
+        message.heartbeat = obj.heartbeat;
+        message.responses = { responses };
+        return message;
+    }
+}
+exports.RocosCallerMessage = RocosCallerMessage;

package/cjs/models/message/RocosCommandMessage.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosCommandMessage = void 0;
+const flattenOneOf_1 = require("../../helpers/flattenOneOf");
+class RocosCommandMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromModel(model) {
+        const message = new RocosCommandMessage();
+        const obj = (0, flattenOneOf_1.flattenOneOf)(model);
+        message.heartbeat = obj.heartbeat ? {} : undefined;
+        message.response = obj.commandResponse;
+        return message;
+    }
+}
+exports.RocosCommandMessage = RocosCommandMessage;

package/cjs/models/message/RocosControlMessage.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosControlMessage = void 0;
+class RocosControlMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromMessage(ack) {
+        const msg = new RocosControlMessage();
+        msg.success = ack.success;
+        msg.stage = ack.stage;
+        msg.message = ack.message;
+        msg.txid = ack.txid;
+        msg.seq = ack.seq;
+        return msg;
+    }
+}
+exports.RocosControlMessage = RocosControlMessage;

package/cjs/models/message/RocosOpResultMessage.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosOpResultMessage = void 0;
+class RocosOpResultMessage {
+    static fromMessages(results) {
+        const list = results.results;
+        return list.map((item) => {
+            return RocosOpResultMessage.fromMessage(item);
+        });
+    }
+    static fromMessage(result) {
+        const message = new RocosOpResultMessage();
+        const opResult = result.result;
+        if (opResult) {
+            message.path = opResult.path;
+            message.data = opResult.data;
+            message.type = opResult.type.valueOf();
+        }
+        return message;
+    }
+}
+exports.RocosOpResultMessage = RocosOpResultMessage;

package/cjs/models/message/RocosSearchMessage.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosSearchMessage = void 0;
+const RocosSearchRowMessage_1 = require("./RocosSearchRowMessage");
+class RocosSearchMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromMessage(dataRow) {
+        const msg = new RocosSearchMessage();
+        const dateStr = dataRow.date;
+        const rows = dataRow.row;
+        // There are two date format: 1) unix timestamp (string); 2) custom: yyyy-MM-dd HH:mm:ss
+        if (+dateStr) {
+            // It's a unix timestamp. New version.
+            msg.date = new Date(+dateStr);
+        }
+        else {
+            // Old version.
+            msg.date = new Date(dateStr.replace(' ', 'T'));
+        }
+        msg.rows = rows.map((row) => {
+            return RocosSearchRowMessage_1.RocosSearchRowMessage.fromMessage(row);
+        });
+        return msg;
+    }
+}
+exports.RocosSearchMessage = RocosSearchMessage;

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/types.js

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