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

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

@@ -0,0 +1,67 @@
+// this token (__WORKER_SOURCE__) is replaced by webpack with the source of the worker
+const WORKER_SOURCE = '__WORKER_SOURCE__';
+export default class Manager {
+    constructor() {
+        this.messageListeners = new Map();
+        this.worker = this.createWorker();
+    }
+    async execute(task) {
+        const workerTask = {
+            ...task,
+            contextVariable: task.contextVariable ?? 'ctx',
+        };
+        const result = this.runTask(workerTask);
+        const timeout = new Promise((_, reject) => {
+            const signal = AbortSignal.timeout(task.timeout);
+            signal.addEventListener('abort', () => {
+                reject(signal.reason);
+            });
+        });
+        return Promise.race([result, timeout])
+            .catch((e) => {
+            if (e.name === 'TimeoutError') {
+                this.terminate();
+            }
+            throw e;
+        })
+            .finally(() => {
+            this.removeMessageListener(task.id);
+        });
+    }
+    terminate() {
+        for (const listener of this.messageListeners.values()) {
+            this.worker.removeEventListener('message', listener);
+        }
+        this.worker.terminate();
+        this.worker = this.createWorker();
+    }
+    runTask(task) {
+        return new Promise((resolve, reject) => {
+            const listener = (event) => {
+                const { data } = event;
+                if (data.id === task.id) {
+                    if (data.success) {
+                        resolve(data.result);
+                    }
+                    else {
+                        reject(data.result);
+                    }
+                }
+            };
+            this.messageListeners.set(task.id, listener);
+            this.worker.addEventListener('message', listener);
+            this.worker.postMessage(task);
+        });
+    }
+    createWorker() {
+        const blob = URL.createObjectURL(new Blob([WORKER_SOURCE], { type: 'application/javascript' }));
+        return new Worker(blob);
+    }
+    removeMessageListener(id) {
+        const listener = this.messageListeners.get(id);
+        if (!listener) {
+            return;
+        }
+        this.worker.removeEventListener('message', listener);
+    }
+}

package/esm/helpers/websandbox/frame/worker/manager.spec.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @jest-environment jsdom
+ */
+export {};

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

@@ -0,0 +1,127 @@
+/**
+ * @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(),
+    },
+});
+// add mock to AbortSignal.timeout
+Object.defineProperty(AbortSignal, 'timeout', {
+    value: jest.fn().mockImplementation((timeout) => {
+        return new AbortController().signal;
+    }),
+});
+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/esm/helpers/websandbox/frame/worker/types.d.ts

@@ -0,0 +1,11 @@
+export interface WorkerResult {
+    id: string;
+    result: unknown;
+    success: boolean;
+}
+export interface WorkerTask {
+    id: string;
+    code: string;
+    contextVariable: string;
+    context?: unknown;
+}

package/esm/helpers/websandbox/frame/worker/worker.source.d.ts

@@ -0,0 +1,2 @@
+declare const source: string;
+export default source;

package/esm/helpers/websandbox/index.js

@@ -0,0 +1,2 @@
+import WebSandbox from './sandbox';
+export { WebSandbox };

package/esm/helpers/websandbox/sandbox.d.ts

@@ -0,0 +1,57 @@
+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;
+    };
+    abortSignal?: AbortSignal | null;
+}
+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;
+    private frameAbortController;
+    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 promisifyAbortSignal;
+    private createFrame;
+    private prepareFrameContent;
+}

package/esm/helpers/websandbox/sandbox.js

@@ -0,0 +1,175 @@
+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,
+    },
+    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.
+ */
+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();
+        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('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 = 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 = generateUUID();
+        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/esm/helpers/websandbox/types.d.ts

@@ -0,0 +1,13 @@
+type APIMethod = (...args: any[]) => unknown;
+export type API = Map<string, APIMethod>;
+export type APIDeclaration<T> = {
+    [K in keyof T]: T[K] extends APIMethod ? T[K] : never;
+};
+export interface Task {
+    id: string;
+    code: string;
+    context?: unknown;
+    timeout: number;
+    contextVariable?: string;
+}
+export {};

package/esm/index.js

@@ -0,0 +1,7 @@
+export * from './constants/grpc';
+export * from './constants/timezones';
+export * from './helpers';
+export * from './models';
+export * from './services';
+export * from './IRocosSDK';
+export * from './RocosSDK';

package/esm/logger/RocosLogger.d.ts

@@ -0,0 +1,7 @@
+import { LogLevelDesc, Logger } from 'loglevel';
+export declare class RocosLogger {
+    static getInstance(name?: string): Logger;
+    static enableAll(): void;
+    static disableAll(): void;
+    static setLevel(level: LogLevelDesc): void;
+}

package/esm/models/CallsignStatus.d.ts

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

package/esm/models/ExportDataQuery.d.ts

@@ -0,0 +1,8 @@
+import { IExportDataQuery, IExportDataQueryFilter } from './IExportDataQuery';
+export declare class ExportDataQuery implements IExportDataQuery {
+    startDate: Date;
+    endDate: Date;
+    filters: IExportDataQueryFilter[];
+    constructor(init?: Partial<IExportDataQuery>);
+    toJSON(): any;
+}

package/esm/models/ExternalProject.d.ts

@@ -0,0 +1,6 @@
+export declare class ExternalProject {
+    id?: string;
+    name?: string;
+    createdAt?: number;
+    isLinked?: boolean;
+}

package/esm/models/IBaseService.d.ts

@@ -0,0 +1,4 @@
+export interface IBaseService {
+    getStatus: () => boolean;
+    teardown?: (() => void) | (() => Promise<void>);
+}

package/esm/models/IConfigGroup.d.ts

@@ -0,0 +1,5 @@
+export interface IConfigGroup {
+    id: string;
+    name: string;
+    config: any[];
+}

package/esm/models/IDebugLevel.d.ts

@@ -0,0 +1,2 @@
+import { LogLevelDesc } from 'loglevel';
+export type IDebugLevel = LogLevelDesc;

package/esm/models/IExportDataQuery.d.ts

@@ -0,0 +1,9 @@
+export interface IExportDataQueryFilter {
+    keyword: string;
+    ids: string[];
+}
+export interface IExportDataQuery {
+    startDate: Date;
+    endDate: Date;
+    filters: IExportDataQueryFilter[];
+}

package/esm/models/IFunctionConfig.d.ts

@@ -0,0 +1,8 @@
+export interface IFunctionConfig {
+    id: string;
+    name: string;
+    handler: string;
+    runtime: string;
+    function: string;
+    deps: string[];
+}

package/esm/models/IInvitation.d.ts

@@ -0,0 +1,6 @@
+export type IInvitationType = 'PROJECT' | 'SIGNUP';
+export interface IInvitation {
+    email: string;
+    type: IInvitationType;
+    ids: string[];
+}

package/esm/models/IInvitationExists.d.ts

@@ -0,0 +1,4 @@
+export interface IInvitationExists {
+    accountExists: boolean;
+    accepted: boolean;
+}

package/esm/models/IOperation.d.ts

@@ -0,0 +1,6 @@
+export interface IOperation {
+    name: string;
+    pageType: string;
+    payload?: string;
+    description?: string;
+}

package/esm/models/IPersonalAccessToken.d.ts

@@ -0,0 +1,16 @@
+export interface IPersonalAccessToken {
+    name: string;
+    pat?: string;
+    ttlDays: number;
+    scope: string[];
+    projectId: string;
+    robotDefinitionId?: string;
+    metaData: IPersonalAccessTokenMetadata;
+    expiry?: Date;
+}
+interface IPersonalAccessTokenMetadata {
+    singleUse?: boolean;
+    defaultRobotDefinitionId?: string;
+    [key: string]: unknown;
+}
+export {};

package/esm/models/IProject.d.ts

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

package/esm/models/IProjectApplication.d.ts

@@ -0,0 +1,6 @@
+export interface IProjectApplication {
+    id?: string;
+    name: string;
+    secret?: string;
+    tokenExpiryInMinutes: number;
+}

package/esm/models/IRobot.d.ts

@@ -0,0 +1,18 @@
+import { RobotModeType } from './types';
+export interface IRobot {
+    tags?: string[];
+    name: string;
+    callsign: string;
+    disabled: boolean;
+    imageId: string;
+    mode: RobotModeType;
+    description?: string;
+    configParameters?: string;
+    robotDefinition?: string;
+    projectId?: string;
+    componentSettingsVersionLog?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+    robotDefinitionName?: string;
+    robotDefinitionTags?: string[];
+}

package/esm/models/IRobotConfig.d.ts

@@ -0,0 +1,8 @@
+export interface IRobotConfig {
+    id: string;
+    name: string;
+    description: string;
+    type: string;
+    defaultValue: any;
+    required: boolean;
+}

package/esm/models/IRobotPlugin.d.ts

@@ -0,0 +1,3 @@
+export interface IRobotPlugin {
+    name: string;
+}

package/esm/models/IRobotSettings.d.ts

@@ -0,0 +1,28 @@
+export interface IRobotSettings {
+    type: "settings";
+    items: {
+        id: string;
+        value: {
+            /**
+             * The actual settings object for this specific setting type
+             */
+            settings: Record<string, any>;
+            /**
+             * The ID of the setting type, usually one of: ops-global-settings, ops-local-settings, flight-app-settings
+             */
+            id: 'ops-global-settings' | 'ops-local-settings' | 'flight-app-settings' | string;
+            enabled: boolean;
+        };
+    }[];
+    version: number;
+    robotDefinitionId: string;
+    username: string;
+    /**
+     * Date in ISO format
+     */
+    createdAt: string;
+    /**
+     * Date in ISO format
+     */
+    updatedAt: string;
+}

package/esm/models/IRobotTemplate.d.ts

@@ -0,0 +1,10 @@
+import { IRobotConfig } from './IRobotConfig';
+import { IRobotPlugin } from './IRobotPlugin';
+export interface IRobotTemplate {
+    id: string;
+    name: string;
+    description?: string;
+    parameters: IRobotConfig[];
+    metaData: any;
+    plugins: IRobotPlugin[];
+}