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

package/helpers/websandbox/frame/worker/manager.spec.js

@@ -1,121 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-import WorkerManager from './manager';
-const WorkerMocks = {
-    postMessage: jest.fn(),
-    terminate: jest.fn(),
-    addEventListener: jest.fn(),
-    removeEventListener: jest.fn(),
-    onerror: jest.fn(),
-    onmessage: jest.fn(),
-    onmessageerror: jest.fn(),
-    dispatchEvent: jest.fn(),
-    clearAllMocks() {
-        this.postMessage.mockClear();
-        this.terminate.mockClear();
-        this.addEventListener.mockClear();
-        this.removeEventListener.mockClear();
-        this.onerror.mockClear();
-        this.onmessage.mockClear();
-        this.onmessageerror.mockClear();
-        this.dispatchEvent.mockClear();
-    },
-};
-class MockWorkerClass {
-    constructor() {
-        this.postMessage = WorkerMocks.postMessage;
-        this.terminate = WorkerMocks.terminate;
-        this.addEventListener = WorkerMocks.addEventListener;
-        this.removeEventListener = WorkerMocks.removeEventListener;
-        this.onerror = WorkerMocks.onerror;
-        this.onmessage = WorkerMocks.onmessage;
-        this.onmessageerror = WorkerMocks.onmessageerror;
-        this.dispatchEvent = WorkerMocks.dispatchEvent;
-    }
-}
-Object.defineProperty(window, 'Worker', {
-    value: MockWorkerClass,
-    writable: true,
-});
-Object.defineProperty(window, 'URL', {
-    value: {
-        createObjectURL: jest.fn(),
-    },
-});
-const task = {
-    id: 'test',
-    code: '1',
-    timeout: 1000,
-};
-const response = {
-    data: {
-        id: 'test',
-        success: true,
-        result: 'test',
-    },
-};
-describe('WorkerManager', () => {
-    beforeEach(() => {
-        WorkerMocks.clearAllMocks();
-    });
-    it('should send a task to the worker', async () => {
-        const listeners = [];
-        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
-            listeners.push(listener);
-        });
-        WorkerMocks.postMessage.mockImplementation((msg) => {
-            listeners.forEach((listener) => {
-                listener(response);
-            });
-        });
-        const manager = new WorkerManager();
-        const result = await manager.execute(task);
-        expect(result).toEqual('test');
-    });
-    it('should handle listener for a single task', async () => {
-        const listeners = [];
-        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
-            listeners.push(listener);
-        });
-        WorkerMocks.removeEventListener.mockImplementation((_, listener) => {
-            const index = listeners.indexOf(listener);
-            listeners.splice(index, 1);
-        });
-        const manager = new WorkerManager();
-        expect(listeners.length).toEqual(0);
-        const result = manager.execute(task);
-        expect(listeners.length).toEqual(1);
-        listeners[0](response);
-        await result;
-        expect(listeners.length).toEqual(0);
-    });
-    it('should handle listener for multiple simultaneous task', async () => {
-        const listeners = [];
-        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
-            listeners.push(listener);
-        });
-        WorkerMocks.removeEventListener.mockImplementation((_, listener) => {
-            const index = listeners.indexOf(listener);
-            listeners.splice(index, 1);
-        });
-        const manager = new WorkerManager();
-        expect(listeners.length).toEqual(0);
-        const result1 = manager.execute(task);
-        const result2 = manager.execute(task);
-        expect(listeners.length).toEqual(2);
-        const result3 = manager.execute(task);
-        expect(listeners.length).toEqual(3);
-        const [listener1, listener2, listener3] = listeners;
-        listener1(response);
-        await result1;
-        expect(listeners.length).toEqual(2);
-        listener3(response);
-        await result3;
-        expect(listeners.length).toEqual(1);
-        listener2(response);
-        await result2;
-        expect(listeners.length).toEqual(0);
-        expect(WorkerMocks.removeEventListener).toHaveBeenCalledTimes(3);
-    });
-});

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

@@ -1,4 +0,0 @@
-// Auto-generated file
-/* eslint-disable */
-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)}})()})();`;
-export default source;

package/helpers/websandbox/sandbox.d.ts

@@ -1,54 +0,0 @@
-export interface SandboxOptions extends Required<RunCodeOptions> {
-    /** The selector or element to append the iframe to */
-    frameContainer: string | Element;
-    /** Whether to enable verbose logging */
-    debugMode: boolean;
-}
-export interface RunCodeOptions {
-    /** The name of the variable to use for the context object */
-    contextVariable?: string;
-    timeout?: {
-        /** The minimum time to wait for a task to complete
-         *
-         * The worker will attempt to kill the task after this time.
-         */
-        minimumMs: number;
-        /** The maximum time to wait for a task to complete
-         *
-         * The sandbox will be destroyed and rebuilt after this time.
-         */
-        maximumMs: number;
-    };
-}
-export declare const BaseOptions: SandboxOptions;
-export interface SandboxMethods {
-    iframeInitialised: () => void;
-}
-/** 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.
- */
-export default class WebSandbox {
-    private readonly options;
-    private frame;
-    private connection?;
-    private initialised;
-    static new(options?: Partial<SandboxOptions>): Promise<WebSandbox>;
-    private constructor();
-    /** Runs code in the sandbox. Can be either a string or a function */
-    run<T = unknown>(code: string | (() => T), context?: unknown, options?: RunCodeOptions): Promise<T>;
-    /** Destroys the sandbox.
-     *
-     * This will remove the iframe from the DOM and remove the message listener.
-     */
-    destroy(): void;
-    private initialise;
-    private validateOptions;
-    private destroyAndRebuild;
-    private removeMessageListener;
-    private runFunction;
-    private runCode;
-    private createFrame;
-    private prepareFrameContent;
-}

package/helpers/websandbox/sandbox.js

@@ -1,146 +0,0 @@
-import Connection from './connection';
-import frameSource from './frame';
-import { generateUUID } from '../generateUUID';
-export const BaseOptions = {
-    frameContainer: 'body',
-    debugMode: false,
-    contextVariable: 'ctx',
-    timeout: {
-        minimumMs: 1000,
-        maximumMs: 1500,
-    },
-};
-/** 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.
- */
-export default class WebSandbox {
-    static async new(options = {}) {
-        const sandbox = new WebSandbox(options);
-        await sandbox.initialised;
-        return sandbox;
-    }
-    constructor(options) {
-        this.options = { ...BaseOptions, ...options };
-        this.frame = this.createFrame();
-        this.validateOptions(this.options);
-        this.initialised = this.initialise();
-    }
-    /** 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.frame.remove();
-        this.removeMessageListener();
-    }
-    initialise() {
-        return new Promise((resolve) => {
-            this.connection = new Connection('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() {
-        this.destroy();
-        this.frame = this.createFrame();
-        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,
-        });
-        let timerId;
-        const timeout = new Promise((_, reject) => {
-            timerId = setTimeout(() => {
-                this.destroyAndRebuild().finally(() => reject(new Error('sandbox timed out')));
-            }, options?.timeout?.maximumMs ?? this.options.timeout.maximumMs);
-        });
-        const taskId = generateUUID();
-        const task = await this.connection.callRemoteMethod('startTask', {
-            id: taskId,
-            code,
-            context,
-            timeout: this.options.timeout.minimumMs,
-            contextVariable: options?.contextVariable ?? this.options.contextVariable,
-        });
-        return Promise.race([task, timeout]).finally(() => {
-            clearTimeout(timerId);
-        });
-    }
-    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';
-        container.appendChild(iframe);
-        return iframe;
-    }
-    prepareFrameContent() {
-        let script = frameSource;
-        if (this.options.debugMode) {
-            script = `window.debugMode=true;${script}`;
-        }
-        return `
-      <!DOCTYPE html>
-      <html>
-        <head>
-          <meta charset="UTF-8">
-          <script>
-            ${script}
-          </script>
-        </head>
-      </html>
-    `;
-    }
-}

package/models/CallsignStatus.d.ts

@@ -1,6 +0,0 @@
-export declare enum CallsignStatus {
-    UNKNOWN = "unknown",
-    ONLINE = "online",
-    OFFLINE = "offline",
-    ERROR = "error"
-}

package/models/CallsignStatus.js

@@ -1,7 +0,0 @@
-export var CallsignStatus;
-(function (CallsignStatus) {
-    CallsignStatus["UNKNOWN"] = "unknown";
-    CallsignStatus["ONLINE"] = "online";
-    CallsignStatus["OFFLINE"] = "offline";
-    CallsignStatus["ERROR"] = "error";
-})(CallsignStatus || (CallsignStatus = {}));

package/models/IProject.d.ts

@@ -1,4 +0,0 @@
-export interface IProject {
-    name: string;
-    description: string;
-}

package/models/IRocosSDKConfig.d.ts

@@ -1,19 +0,0 @@
-import { IStreamOptions } from './IStreamOptions';
-export type IRocosSDKConfig = IRocosSDKConfigApp | IRocosSDKConfigToken;
-interface IRocosSDKConfigBase {
-    url: string;
-    token?: string;
-    refreshToken?: string;
-    options?: IStreamOptions;
-    port?: number;
-    insecure?: boolean;
-}
-export interface IRocosSDKConfigApp extends IRocosSDKConfigBase {
-    appId: string;
-    appKey: string;
-}
-export interface IRocosSDKConfigToken extends IRocosSDKConfigBase {
-    token: string;
-    refreshToken?: string;
-}
-export {};

package/models/RocosError.d.ts

@@ -1,31 +0,0 @@
-export declare const errorCodes: {
-    SKD_ERROR: string;
-    AUTH_ERROR: string;
-    ROBOT_SERVICE_ERROR: string;
-    SPOT_SERVICE_ERROR: string;
-    STREAM_LISTENER_ERROR: string;
-    TELEMETRY_ERROR: string;
-    TELEMETRY_STREAM_ERROR: string;
-    TELEMETRY_SERVICE_ERROR: string;
-    EVENT_SERVICE_ERROR: string;
-    PROJECT_SERVICE_ERROR: string;
-    DASHBOARD_SERVICE_ERROR: string;
-    USER_SERVICE_ERROR: string;
-    ACCOUNT_SERVICE_ERROR: string;
-    TIME_SYNCER_SERVICE_ERROR: string;
-    CONFIG_GROUP_SERVICE_ERROR: string;
-    FUNCTION_SERVICE_ERROR: string;
-    STREAM_SERVICE_ERROR: string;
-    WORKFLOW_SERVICE_ERROR: string;
-    ASSET_STORAGE_SERVICE_ERROR: string;
-    PROFILE_SERVICE_ERROR: string;
-    SCHEDULE_SERVICE_ERROR: string;
-    INTEGRATIONS_SERVICE_ERROR: string;
-    MAPS_SERVICE_ERROR: string;
-    EVALUATOR_SERVICE_ERROR: string;
-};
-export declare class RocosError extends Error {
-    code?: string;
-    statusCode?: number;
-    constructor(err: string | Error, code?: string, statusCode?: number);
-}

package/models/RocosError.js

@@ -1,40 +0,0 @@
-export const errorCodes = {
-    SKD_ERROR: 'SKD_ERROR',
-    AUTH_ERROR: 'AUTH_ERROR',
-    ROBOT_SERVICE_ERROR: 'ROBOT_SERVICE_ERROR',
-    SPOT_SERVICE_ERROR: 'SPOT_SERVICE_ERROR',
-    STREAM_LISTENER_ERROR: 'STREAM_LISTENER_ERROR',
-    TELEMETRY_ERROR: 'TELEMETRY_ERROR',
-    TELEMETRY_STREAM_ERROR: 'TELEMETRY_STREAM_ERROR',
-    TELEMETRY_SERVICE_ERROR: 'TELEMETRY_SERVICE_ERROR',
-    EVENT_SERVICE_ERROR: 'EVENT_SERVICE_ERROR',
-    PROJECT_SERVICE_ERROR: 'PROJECT_SERVICE_ERROR',
-    DASHBOARD_SERVICE_ERROR: 'PROJECT_SERVICE_ERROR',
-    USER_SERVICE_ERROR: 'USER_SERVICE_ERROR',
-    ACCOUNT_SERVICE_ERROR: 'ACCOUNT_SERVICE_ERROR',
-    TIME_SYNCER_SERVICE_ERROR: 'TIME_SYNCER_SERVICE_ERROR',
-    CONFIG_GROUP_SERVICE_ERROR: 'CONFIG_GROUP_SERVICE_ERROR',
-    FUNCTION_SERVICE_ERROR: 'FUNCTION_SERVICE_ERROR',
-    STREAM_SERVICE_ERROR: 'STREAM_SERVICE_ERROR',
-    WORKFLOW_SERVICE_ERROR: 'WORKFLOW_SERVICE_ERROR',
-    ASSET_STORAGE_SERVICE_ERROR: 'ASSET_STORAGE_SERVICE_ERROR',
-    PROFILE_SERVICE_ERROR: 'PROFILE_SERVICE_ERROR',
-    SCHEDULE_SERVICE_ERROR: 'SCHEDULE_SERVICE_ERROR',
-    INTEGRATIONS_SERVICE_ERROR: 'INTEGRATIONS_SERVICE_ERROR',
-    MAPS_SERVICE_ERROR: 'MAPS_SERVICE_ERROR',
-    EVALUATOR_SERVICE_ERROR: 'EVALUATOR_SERVICE_ERROR',
-};
-export class RocosError extends Error {
-    constructor(err, code, statusCode) {
-        if (err instanceof Error) {
-            super(err.message);
-            this.name = err.name;
-            this.stack = err.stack;
-        }
-        else {
-            super(err);
-        }
-        this.code = code;
-        this.statusCode = statusCode;
-    }
-}

package/models/ServiceEnum.d.ts

@@ -1,27 +0,0 @@
-export declare enum ServiceEnum {
-    AUTH = "auth",
-    TELEMETRY = "telemetry",
-    ROBOT = "robot",
-    EVENT = "event",
-    PROJECT = "project",
-    CALLER = "caller",
-    COMMAND = "command",
-    CONTROL = "control",
-    SEARCH = "search",
-    CONFIG_GROUP = "config_group",
-    DASHBOARD = "dashboard",
-    FUNCTION = "function",
-    STREAM = "stream",
-    USER = "user",
-    TIME_SYNCER = "time_syncer",
-    WORKFLOW = "workflow",
-    ASSET_STORAGE = "asset_storage",
-    PROFILE = "profile",
-    WEBRTC_SIGNALLING = "webrtc_signalling",
-    FILE_ACCESSOR = "file_accessor",
-    SCHEDULE = "schedule",
-    SPOT_PROVISIONER = "spot_provisioner",
-    INTEGRATION = "integration",
-    MAP = "map",
-    EVALUATOR = "evaluator"
-}

package/models/ServiceEnum.js

@@ -1,28 +0,0 @@
-export var ServiceEnum;
-(function (ServiceEnum) {
-    ServiceEnum["AUTH"] = "auth";
-    ServiceEnum["TELEMETRY"] = "telemetry";
-    ServiceEnum["ROBOT"] = "robot";
-    ServiceEnum["EVENT"] = "event";
-    ServiceEnum["PROJECT"] = "project";
-    ServiceEnum["CALLER"] = "caller";
-    ServiceEnum["COMMAND"] = "command";
-    ServiceEnum["CONTROL"] = "control";
-    ServiceEnum["SEARCH"] = "search";
-    ServiceEnum["CONFIG_GROUP"] = "config_group";
-    ServiceEnum["DASHBOARD"] = "dashboard";
-    ServiceEnum["FUNCTION"] = "function";
-    ServiceEnum["STREAM"] = "stream";
-    ServiceEnum["USER"] = "user";
-    ServiceEnum["TIME_SYNCER"] = "time_syncer";
-    ServiceEnum["WORKFLOW"] = "workflow";
-    ServiceEnum["ASSET_STORAGE"] = "asset_storage";
-    ServiceEnum["PROFILE"] = "profile";
-    ServiceEnum["WEBRTC_SIGNALLING"] = "webrtc_signalling";
-    ServiceEnum["FILE_ACCESSOR"] = "file_accessor";
-    ServiceEnum["SCHEDULE"] = "schedule";
-    ServiceEnum["SPOT_PROVISIONER"] = "spot_provisioner";
-    ServiceEnum["INTEGRATION"] = "integration";
-    ServiceEnum["MAP"] = "map";
-    ServiceEnum["EVALUATOR"] = "evaluator";
-})(ServiceEnum || (ServiceEnum = {}));

package/models/Token.d.ts

@@ -1,40 +0,0 @@
-import { IToken } from './IToken';
-/** Represents a JWT token.
- *
- * @see https://jwt.io/
- * @see https://tools.ietf.org/html/rfc7519
- * */
-export declare class Token implements IToken {
-    /**
-     * The raw token value.
-     *
-     * @see bearer
-     */
-    readonly value: string;
-    readonly audience?: string;
-    readonly expires?: Date;
-    readonly issuedAt?: Date;
-    readonly issuer?: string;
-    readonly subject?: string;
-    readonly refreshToken?: string;
-    constructor(token: string, refreshToken?: string);
-    /** Convenience method to get the token in Bearer format. */
-    get bearer(): string;
-    /**
-     * Check if the token is expired
-     *
-     * You may optionally provide a threshold in minutes to check if the token will expire within that time.
-     * If no threshold is provided, the token will be considered expired if it has already expired.
-     *
-     * @returns true if the token is expired (or will expire within the threshold)
-     */
-    isExpiredIn(threshold?: number, unit?: 'minutes' | 'seconds' | 'hours'): boolean;
-    isExpired(): boolean;
-    private getJWTPayload;
-    /** Decode a base64 string.
-     *
-     * Supports both Node.js and browser environments.
-     * @private
-     */
-    private decodeBase64;
-}

package/models/Token.js

@@ -1,78 +0,0 @@
-import { isNode } from '../helpers/enviroment';
-/** Represents a JWT token.
- *
- * @see https://jwt.io/
- * @see https://tools.ietf.org/html/rfc7519
- * */
-export class Token {
-    constructor(token, refreshToken) {
-        this.value = token;
-        this.refreshToken = refreshToken;
-        const decoded = this.getJWTPayload(token);
-        this.audience = typeof decoded.aud === 'string' ? decoded.aud : undefined;
-        this.expires = decoded.exp ? new Date(Number(decoded.exp) * 1000) : undefined;
-        this.issuedAt = decoded.iat ? new Date(Number(decoded.iat) * 1000) : undefined;
-        this.issuer = typeof decoded.iss === 'string' ? decoded.iss : undefined;
-        this.subject = typeof decoded.sub === 'string' ? decoded.sub : undefined;
-    }
-    /** Convenience method to get the token in Bearer format. */
-    get bearer() {
-        return `Bearer ${this.value}`;
-    }
-    /**
-     * Check if the token is expired
-     *
-     * You may optionally provide a threshold in minutes to check if the token will expire within that time.
-     * If no threshold is provided, the token will be considered expired if it has already expired.
-     *
-     * @returns true if the token is expired (or will expire within the threshold)
-     */
-    isExpiredIn(threshold = 0, unit = 'minutes') {
-        if (!this.expires) {
-            return false;
-        }
-        const msTillExpire = this.expires.getTime() - Date.now();
-        const msInUnit = {
-            minutes: 60000,
-            seconds: 1000,
-            hours: 3600000,
-        }[unit];
-        return msTillExpire <= threshold * msInUnit;
-    }
-    isExpired() {
-        return this.isExpiredIn();
-    }
-    getJWTPayload(token) {
-        const parts = token.split('.');
-        if (parts.length < 2) {
-            throw new Error('Invalid token, missing payload');
-        }
-        else if (parts.length > 3) {
-            throw new Error('Invalid token, too many parts');
-        }
-        const [header, payload] = parts.slice(0, 2).map((part) => {
-            return JSON.parse(this.decodeBase64(part));
-        });
-        if (typeof payload !== 'object') {
-            throw new Error('Invalid token, payload must be an object');
-        }
-        if (typeof header !== 'object') {
-            throw new Error('Invalid token, header must be an object');
-        }
-        if (!('typ' in header) || header.typ !== 'JWT') {
-            throw new Error('Invalid token, must be a JWT');
-        }
-        return payload;
-    }
-    /** Decode a base64 string.
-     *
-     * Supports both Node.js and browser environments.
-     * @private
-     */
-    decodeBase64(base64String) {
-        if (isNode) {
-            return Buffer.from(base64String, 'base64').toString('utf-8');
-        }
-        return atob(base64String);
-    }
-}