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

package/helpers/standardDeviation.spec.js

@@ -1,11 +0,0 @@
-import { standardDeviation } from './standardDeviation';
-describe('standardDeviation', () => {
-    it('should calculate standard deviation correctly', () => {
-        let numbers = [10, 12, 23, 23, 16, 23, 21, 16];
-        let stdDev = standardDeviation(numbers);
-        expect(Math.abs(stdDev - 4.8989794855664)).toBeLessThan(0.000001);
-        numbers = [100, 12, 23, 23, 116, 23, 21, 162];
-        stdDev = standardDeviation(numbers);
-        expect(Math.abs(stdDev - 53.702886328394)).toBeLessThan(0.000001);
-    });
-});

package/helpers/websandbox/connection.d.ts

@@ -1,67 +0,0 @@
-import { APIDeclaration } from './types';
-export interface ConnectionOptions {
-    allowedSenderOrigin?: string;
-    debugMode: boolean;
-}
-type ListenerCallback = (e: MessageEvent<Message>) => void;
-declare enum MessageType {
-    RESPONSE = "response",
-    MESSAGE = "message"
-}
-interface BaseMessageData {
-    type: MessageType;
-    callId: string;
-}
-interface ResponseData extends BaseMessageData {
-    type: MessageType.RESPONSE;
-    success: boolean;
-    result: unknown;
-}
-interface MessageData extends BaseMessageData {
-    type: MessageType.MESSAGE;
-    methodName: string;
-    arguments: unknown[];
-}
-type Message = MessageData | ResponseData;
-export default class Connection<Local extends APIDeclaration<Local>, Remote extends APIDeclaration<Remote>> {
-    private readonly name;
-    private incrementalID;
-    private readonly options;
-    private readonly postMessageInternal;
-    private callbacks;
-    private serviceMethods;
-    constructor(name: string, postMessage: typeof window.postMessage, methods: Local, registerOnMessageListener: (listener: ListenerCallback) => void, options?: Partial<ConnectionOptions>);
-    /** Call a remote method
-     *
-     * returns a promise that resolves when the remote responds
-     *
-     * @param name - name of remote method to call
-     * @param args - arguments to pass to remote method
-     */
-    callRemoteMethod<Method extends keyof Remote>(name: Method, ...args: Parameters<Remote[Method]>): Promise<ReturnType<Remote[Method]>>;
-    private onMessageListener;
-    private callLocalMethod;
-    /** Respond to remote call
-     *
-     * @param id - remote call ID
-     * @param result - result to pass to calling function
-     * @param success - whether the call was successful
-     */
-    private responseOtherSide;
-    /** Store a callback to be called when the remote responds
-     *
-     * @param success - callback to be called on success
-     * @param failure - callback to be called on failure
-     */
-    private registerCallback;
-    /** Calls and deletes stored callback
-     *
-     * @param callId - ID of callback to call
-     * @param success - whether the call was successful
-     * @param result - result of remote call
-     */
-    private popCallback;
-    private postMessage;
-    private log;
-}
-export {};

package/helpers/websandbox/connection.js

@@ -1,133 +0,0 @@
-var MessageType;
-(function (MessageType) {
-    MessageType["RESPONSE"] = "response";
-    MessageType["MESSAGE"] = "message";
-})(MessageType || (MessageType = {}));
-const defaultOptions = {
-    allowedSenderOrigin: undefined,
-    debugMode: false,
-};
-export default class Connection {
-    constructor(name, postMessage, methods, registerOnMessageListener, options = {}) {
-        this.callbacks = new Map();
-        this.serviceMethods = new Map();
-        this.name = name;
-        this.options = { ...defaultOptions, ...options };
-        this.log('Created connection w/ allowedOrigin:', this.options.allowedSenderOrigin);
-        this.serviceMethods = new Map(Object.entries(methods));
-        // Assign a random starting ID to this connection
-        const [id] = crypto.getRandomValues(new Uint32Array(1));
-        this.incrementalID = id;
-        this.postMessageInternal = postMessage;
-        registerOnMessageListener((e) => this.onMessageListener(e));
-    }
-    /** Call a remote method
-     *
-     * returns a promise that resolves when the remote responds
-     *
-     * @param name - name of remote method to call
-     * @param args - arguments to pass to remote method
-     */
-    callRemoteMethod(name, ...args) {
-        this.log('Calling Remote Method', {
-            name,
-            args,
-        });
-        return new Promise((resolve, reject) => {
-            const id = this.registerCallback(resolve, reject);
-            this.postMessage({
-                callId: id,
-                type: MessageType.MESSAGE,
-                methodName: name,
-                arguments: args,
-            });
-        });
-    }
-    onMessageListener(e) {
-        this.log('Received message', e);
-        const { data } = e;
-        const { allowedSenderOrigin } = this.options;
-        if (allowedSenderOrigin && e.origin !== allowedSenderOrigin) {
-            console.warn(`Received message from invalid origin: ${e.origin}`);
-        }
-        switch (data.type) {
-            case MessageType.RESPONSE:
-                this.popCallback(data.callId, data.success, data.result);
-                return;
-            case MessageType.MESSAGE:
-                this.callLocalMethod(data.methodName, data.arguments)
-                    .then((res) => this.responseOtherSide(data.callId, res))
-                    .catch((err) => this.responseOtherSide(data.callId, err, false));
-        }
-    }
-    async callLocalMethod(methodName, args) {
-        this.log('calling local method', methodName, args);
-        const method = this.serviceMethods.get(methodName);
-        if (!method) {
-            throw new Error(`service method ${methodName} not found`);
-        }
-        return method(...args);
-    }
-    /** Respond to remote call
-     *
-     * @param id - remote call ID
-     * @param result - result to pass to calling function
-     * @param success - whether the call was successful
-     */
-    responseOtherSide(id, result, success = true) {
-        this.log('responding to remote call', { id, result, success });
-        const doPost = (result) => {
-            this.postMessage({
-                callId: id,
-                type: MessageType.RESPONSE,
-                success,
-                result,
-            });
-        };
-        try {
-            doPost(result);
-        }
-        catch (err) {
-            if (err instanceof DOMException) {
-                doPost(JSON.parse(JSON.stringify(result)));
-            }
-        }
-    }
-    /** Store a callback to be called when the remote responds
-     *
-     * @param success - callback to be called on success
-     * @param failure - callback to be called on failure
-     */
-    registerCallback(success, failure) {
-        const id = (++this.incrementalID).toString();
-        this.log('registering callback for id', id);
-        this.callbacks.set(id, { success, failure });
-        return id;
-    }
-    /** Calls and deletes stored callback
-     *
-     * @param callId - ID of callback to call
-     * @param success - whether the call was successful
-     * @param result - result of remote call
-     */
-    popCallback(callId, success, result) {
-        this.log('calling callback for id', callId, { success, result });
-        const callbacks = this.callbacks.get(callId);
-        if (success) {
-            callbacks?.success(result);
-        }
-        else {
-            callbacks?.failure(result);
-        }
-        this.callbacks.delete(callId);
-    }
-    postMessage(data, targetOrigin = '*') {
-        this.log('sending message', { data, targetOrigin });
-        this.postMessageInternal(data, targetOrigin);
-    }
-    log(...args) {
-        if (this.options.debugMode) {
-            console.debug(`[${this.name}]`, ...args);
-        }
-    }
-}

package/helpers/websandbox/frame/frame.js

@@ -1,22 +0,0 @@
-// this file is bundled via webpack and included in the iframe source
-import Connection from '../connection';
-import WorkerManager from './worker';
-class Frame {
-    constructor() {
-        const isDebugMode = !!window?.debugMode;
-        this.connection = new Connection('FRAME', window.parent.postMessage.bind(window.parent), {
-            startTask: this.runCode.bind(this),
-        }, (listener) => {
-            window.addEventListener('message', listener);
-        }, {
-            debugMode: isDebugMode,
-        });
-        void this.connection.callRemoteMethod('iframeInitialised');
-        this.workerManager = new WorkerManager();
-    }
-    async runCode(task) {
-        return this.workerManager.execute(task);
-    }
-}
-const frame = new Frame();
-export default frame;

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

@@ -1,5 +0,0 @@
-// Auto-generated file
-/* eslint-disable */
-import __WORKER_SOURCE__ from './worker/worker.source';
-const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.messageListeners=new Map,this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t),r=new Promise(((t,s)=>{const r=AbortSignal.timeout(e.timeout);r.addEventListener("abort",(()=>{s(r.reason)}))}));return Promise.race([s,r]).catch((e=>{throw"TimeoutError"===e.name&&this.terminate(),e})).finally((()=>{this.removeMessageListener(e.id)}))}terminate(){for(const e of this.messageListeners.values())this.worker.removeEventListener("message",e);this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(i.success?t(i.result):s(i.result))};this.messageListeners.set(e.id,r),this.worker.addEventListener("message",r),this.worker.postMessage(e)}))}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(e){const t=this.messageListeners.get(e);t&&this.worker.removeEventListener("message",t)}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
-export default source;

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

@@ -1,11 +0,0 @@
-import { Task } from '../../types';
-export default class Manager {
-    private worker;
-    private messageListeners;
-    constructor();
-    execute(task: Task): Promise<unknown>;
-    terminate(): void;
-    private runTask;
-    private createWorker;
-    private removeMessageListener;
-}

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

@@ -1,67 +0,0 @@
-// 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/helpers/websandbox/frame/worker/manager.spec.d.ts

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

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

@@ -1,127 +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(),
-    },
-});
-// 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/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,57 +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;
-    };
-    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;
-}