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

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

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const WHITELIST = [
+    'TEMPORARY',
+    'PERSISTENT',
+    'console',
+    'self',
+    'onmessage',
+    'postMessage',
+    'global',
+    'allowed',
+    'Array',
+    'Boolean',
+    'Date',
+    'Function',
+    'Number',
+    'Object',
+    'RegExp',
+    'String',
+    'Error',
+    'EvalError',
+    'RangeError',
+    'ReferenceError',
+    'SyntaxError',
+    'TypeError',
+    'URIError',
+    'decodeURI',
+    'decodeURIComponent',
+    'encodeURI',
+    'encodeURIComponent',
+    'isFinite',
+    'isNaN',
+    'parseFloat',
+    'parseInt',
+    'Infinity',
+    'JSON',
+    'Math',
+    'NaN',
+    'undefined',
+];
+const windowProps = Object.getOwnPropertyNames(self);
+const protoProps = Object.getOwnPropertyNames(self.__proto__);
+const props = [...windowProps, ...protoProps];
+props.forEach((prop) => {
+    if (!WHITELIST.includes(prop)) {
+        Object.defineProperty(self, prop, {
+            get: () => {
+                throw new Error(`Security Exception: cannot access ${prop}`);
+            },
+            set: () => {
+                throw new Error(`Security Exception: cannot set ${prop}`);
+            },
+            configurable: false,
+        });
+    }
+});
+// Parses and calls function string with args
+onmessage = (event) => {
+    let result;
+    let success = true;
+    try {
+        const fn = Function(event.data.contextVariable, `"use strict";return (${event.data.code});`);
+        result = fn(event.data.context);
+    }
+    catch (e) {
+        result = e;
+        success = false;
+    }
+    const message = {
+        id: event.data.id,
+        result,
+        success,
+    };
+    postMessage(message);
+};

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

@@ -0,0 +1,6 @@
+"use strict";
+// Auto-generated file
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+const source = `(()=>{"use strict";(()=>{const e=["TEMPORARY","PERSISTENT","console","self","onmessage","postMessage","global","allowed","Array","Boolean","Date","Function","Number","Object","RegExp","String","Error","EvalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","isFinite","isNaN","parseFloat","parseInt","Infinity","JSON","Math","NaN","undefined"];[...Object.getOwnPropertyNames(self),...Object.getOwnPropertyNames(self.__proto__)].forEach((r=>{e.includes(r)||Object.defineProperty(self,r,{get:()=>{throw new Error(\`Security Exception: cannot access \${r}\`)},set:()=>{throw new Error(\`Security Exception: cannot set \${r}\`)},configurable:!1})})),onmessage=e=>{let r,t=!0;try{r=Function(e.data.contextVariable,\`"use strict";return (\${e.data.code});\`)(e.data.context)}catch(e){r=e,t=!1}const o={id:e.data.id,result:r,success:t};postMessage(o)}})()})();`;
+exports.default = source;

package/cjs/helpers/websandbox/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSandbox = void 0;
+const sandbox_1 = __importDefault(require("./sandbox"));
+exports.WebSandbox = sandbox_1.default;

package/cjs/helpers/websandbox/sandbox.js

@@ -0,0 +1,182 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseOptions = void 0;
+const connection_1 = __importDefault(require("./connection"));
+const frame_1 = __importDefault(require("./frame"));
+const generateUUID_1 = require("../generateUUID");
+exports.BaseOptions = {
+    frameContainer: 'body',
+    debugMode: false,
+    contextVariable: 'ctx',
+    timeout: {
+        minimumMs: 1000,
+        maximumMs: 1500,
+    },
+    abortSignal: null,
+};
+/** A sandbox for running untrusted code in an iframe & embedded web worker.
+ *
+ * This is a wrapper around the iframe and web worker that provides a simple API for running code in the sandbox.
+ * It also provides a context object that can be used to pass data into the sandbox.
+ */
+class WebSandbox {
+    static async new(options = {}) {
+        const sandbox = new WebSandbox(options);
+        await sandbox.initialised;
+        return sandbox;
+    }
+    constructor(options) {
+        this.options = { ...exports.BaseOptions, ...options };
+        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) {
+        if (typeof code === 'function') {
+            return this.runFunction(code, context);
+        }
+        return this.runCode(code, context, options);
+    }
+    /** Destroys the sandbox.
+     *
+     * This will remove the iframe from the DOM and remove the message listener.
+     */
+    destroy() {
+        this.frameAbortController.abort();
+        this.frame.remove();
+        this.removeMessageListener();
+    }
+    initialise() {
+        return new Promise((resolve) => {
+            this.connection = new connection_1.default('SANDBOX', this.frame.contentWindow.postMessage.bind(this.frame.contentWindow), {
+                iframeInitialised: () => resolve(),
+            }, (listener) => {
+                const sourceCheckListener = (event) => {
+                    if (event.source !== this.frame.contentWindow) {
+                        return;
+                    }
+                    return listener(event);
+                };
+                window.addEventListener('message', sourceCheckListener);
+                this.removeMessageListener = () => window.removeEventListener('message', sourceCheckListener);
+            }, { allowedSenderOrigin: 'null', debugMode: this.options.debugMode });
+        });
+    }
+    validateOptions(options) {
+        const minimumTimeout = options.timeout.minimumMs;
+        const maximumTimeout = options.timeout.maximumMs;
+        if (maximumTimeout < minimumTimeout) {
+            throw new Error(`maximum timeout (${maximumTimeout}ms) must be greater than or equal to minimum timeout (${minimumTimeout}ms)`);
+        }
+        if (minimumTimeout <= 0 || maximumTimeout <= 0) {
+            throw new Error('timeout values must be greater than 0');
+        }
+        if (maximumTimeout > 5000) {
+            throw new Error('maximum timeout must be less than or equal to 5000ms');
+        }
+    }
+    async destroyAndRebuild(frameId) {
+        if (this.frame.id !== frameId) {
+            return;
+        }
+        this.destroy();
+        this.frame = this.createFrame();
+        this.frameAbortController = new AbortController();
+        await this.initialise();
+    }
+    removeMessageListener() {
+        // replaced by constructor
+    }
+    async runFunction(fn, context, options) {
+        return this.runCode(`(${fn.toString()})()`, context, options);
+    }
+    async runCode(code, context, options) {
+        if (!this.connection) {
+            throw new Error('sandbox not initialised');
+        }
+        this.validateOptions({
+            ...this.options,
+            ...options,
+        });
+        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 = (0, generateUUID_1.generateUUID)();
+        const task = this.connection.callRemoteMethod('startTask', {
+            id: taskId,
+            code,
+            context,
+            timeout: this.options.timeout.minimumMs,
+            contextVariable: options?.contextVariable ?? this.options.contextVariable,
+        });
+        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() {
+        const containerSelector = this.options.frameContainer;
+        const container = typeof containerSelector === 'string' ? document.querySelector(containerSelector) : containerSelector;
+        if (!container) {
+            throw new Error('unable to find container for sandbox');
+        }
+        const iframe = document.createElement('iframe');
+        if (iframe.sandbox) {
+            iframe.sandbox.add('allow-scripts');
+        }
+        else {
+            iframe.setAttribute('sandbox', 'allow-scripts');
+        }
+        iframe.srcdoc = this.prepareFrameContent();
+        iframe.style.display = 'none';
+        iframe.id = (0, generateUUID_1.generateUUID)();
+        container.appendChild(iframe);
+        return iframe;
+    }
+    prepareFrameContent() {
+        let script = frame_1.default;
+        if (this.options.debugMode) {
+            script = `window.debugMode=true;${script}`;
+        }
+        return `
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta charset="UTF-8">
+          <script>
+            ${script}
+          </script>
+        </head>
+      </html>
+    `;
+    }
+}
+exports.default = WebSandbox;

package/cjs/helpers/websandbox/types.js

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

package/cjs/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("./constants/grpc"), exports);
+__exportStar(require("./constants/timezones"), exports);
+__exportStar(require("./helpers"), exports);
+__exportStar(require("./models"), exports);
+__exportStar(require("./services"), exports);
+__exportStar(require("./IRocosSDK"), exports);
+__exportStar(require("./RocosSDK"), exports);

package/cjs/logger/RocosLogger.js

@@ -0,0 +1,67 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosLogger = void 0;
+const prefix = __importStar(require("loglevel-plugin-prefix"));
+const loglevel_1 = __importDefault(require("loglevel"));
+loglevel_1.default.setDefaultLevel('silent');
+prefix.reg(loglevel_1.default);
+prefix.apply(loglevel_1.default, {
+    format(level, name, timestamp) {
+        return `[${timestamp}] ${level.toUpperCase()} ${name}:`;
+    },
+});
+class RocosLogger {
+    static getInstance(name) {
+        if (name) {
+            const logger = loglevel_1.default.getLogger(name);
+            logger.setLevel(loglevel_1.default.getLevel());
+            return logger;
+        }
+        return loglevel_1.default;
+    }
+    static enableAll() {
+        loglevel_1.default.enableAll();
+        for (const name in loglevel_1.default.getLoggers()) {
+            loglevel_1.default.getLogger(name).enableAll();
+        }
+    }
+    static disableAll() {
+        loglevel_1.default.disableAll();
+        for (const name in loglevel_1.default.getLoggers()) {
+            loglevel_1.default.getLogger(name).disableAll();
+        }
+    }
+    static setLevel(level) {
+        loglevel_1.default.setLevel(level);
+        for (const name in loglevel_1.default.getLoggers()) {
+            loglevel_1.default.getLogger(name).setLevel(loglevel_1.default.getLevel());
+        }
+    }
+}
+exports.RocosLogger = RocosLogger;

package/cjs/models/CallsignStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallsignStatus = void 0;
+var CallsignStatus;
+(function (CallsignStatus) {
+    CallsignStatus["UNKNOWN"] = "unknown";
+    CallsignStatus["ONLINE"] = "online";
+    CallsignStatus["OFFLINE"] = "offline";
+    CallsignStatus["ERROR"] = "error";
+})(CallsignStatus || (exports.CallsignStatus = CallsignStatus = {}));

package/cjs/models/ExportDataQuery.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportDataQuery = void 0;
+class ExportDataQuery {
+    constructor(init) {
+        this.filters = [];
+        Object.assign(this, init);
+    }
+    toJSON() {
+        return {
+            startDate: this.startDate ? this.startDate.getTime() : null,
+            endDate: this.endDate ? this.endDate.getTime() : null,
+            filters: this.filters,
+        };
+    }
+}
+exports.ExportDataQuery = ExportDataQuery;

package/cjs/models/ExternalProject.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExternalProject = void 0;
+class ExternalProject {
+}
+exports.ExternalProject = ExternalProject;

package/cjs/models/IBaseService.js

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

package/cjs/models/IConfigGroup.js

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

package/cjs/models/IDebugLevel.js

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

package/cjs/models/IExportDataQuery.js

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

package/cjs/models/IFunctionConfig.js

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

package/cjs/models/IInvitation.js

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

package/cjs/models/IInvitationExists.js

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

package/cjs/models/IOperation.js

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

package/cjs/models/IPersonalAccessToken.js

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

package/cjs/models/IProject.js

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

package/cjs/models/IProjectApplication.js

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

package/cjs/models/IRobot.js

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

package/cjs/models/IRobotConfig.js

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

package/cjs/models/IRobotPlugin.js

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

package/cjs/models/IRobotSettings.js

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

package/cjs/models/IRobotTemplate.js

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

package/cjs/models/IRocosSDKConfig.d.ts

@@ -0,0 +1,23 @@
+import { IStreamOptions } from './IStreamOptions';
+import { ServiceEnum } from './ServiceEnum';
+export type IRocosSDKConfig = AuthorisedConfig & {
+    overrides?: Partial<Record<ServiceEnum, Partial<AuthorisedConfig>>>;
+};
+interface ConfigBase {
+    url: string;
+    token?: string;
+    refreshToken?: string;
+    options?: IStreamOptions;
+    port?: number;
+    insecure?: boolean;
+}
+export interface IRocosSDKConfigApp extends ConfigBase {
+    appId: string;
+    appKey: string;
+}
+export interface IRocosSDKConfigToken extends ConfigBase {
+    token: string;
+    refreshToken?: string;
+}
+export type AuthorisedConfig = IRocosSDKConfigApp | IRocosSDKConfigToken;
+export {};

package/cjs/models/IRocosSDKConfig.js

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

package/cjs/models/ISource.js

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

package/cjs/models/IStream.js

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

package/cjs/models/IStreamConfig.js

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

package/cjs/models/IStreamOptions.js

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

package/cjs/models/IStreamSource.js

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

package/cjs/models/ISubscriberStatus.js

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

package/cjs/models/ITelemetryStreamConfig.js

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

package/cjs/models/IToken.js

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

package/cjs/models/IWidget.js

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

package/cjs/models/IWidgetLineGroup.js

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

package/cjs/models/ResponseLevelEnum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseLevelEnum = void 0;
+var ResponseLevelEnum;
+(function (ResponseLevelEnum) {
+    /** ack, return, result **/
+    ResponseLevelEnum[ResponseLevelEnum["ALL"] = 0] = "ALL";
+    /** return, result **/
+    ResponseLevelEnum[ResponseLevelEnum["RETURN_AND_RESULT"] = 1] = "RETURN_AND_RESULT";
+    /** result **/
+    ResponseLevelEnum[ResponseLevelEnum["RESULT_ONLY"] = 2] = "RESULT_ONLY";
+    /** nothing **/
+    ResponseLevelEnum[ResponseLevelEnum["NONE"] = 3] = "NONE";
+})(ResponseLevelEnum || (exports.ResponseLevelEnum = ResponseLevelEnum = {}));

package/cjs/models/Robot.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Robot = void 0;
+class Robot {
+    constructor(init) {
+        this.disabled = false;
+        this.imageId = '';
+        this.mode = 'physical';
+        Object.assign(this, init);
+    }
+}
+exports.Robot = Robot;

package/cjs/models/RobotConfig.js

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

package/cjs/models/RobotPlugin.js

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

package/cjs/models/RobotTemplate.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RobotTemplate = void 0;
+const RobotConfig_1 = require("./RobotConfig");
+const RobotPlugin_1 = require("./RobotPlugin");
+class RobotTemplate {
+    constructor(init) {
+        this.parameters = [];
+        this.plugins = [];
+        Object.assign(this, init);
+        if (init?.parameters && init?.parameters?.length > 0) {
+            this.parameters = init.parameters.map((config) => {
+                return new RobotConfig_1.RobotConfig(config);
+            });
+        }
+        try {
+            this.metaData = JSON.parse(init?.metaData);
+            if (this?.metaData?.plugins?.length > 0) {
+                this.plugins = this.metaData.plugins.map((plugin) => {
+                    return new RobotPlugin_1.RobotPlugin(plugin);
+                });
+            }
+        }
+        catch {
+            this.metaData = {};
+        }
+    }
+}
+exports.RobotTemplate = RobotTemplate;