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

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/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/asset-storage/AssetModelItem.d.ts

@@ -1,29 +0,0 @@
-export interface AssetItemModel {
-    metadata?: {
-        [key: string]: string;
-    };
-    path?: string;
-    contentType?: string;
-    signedURL?: string;
-    name?: string;
-    modifiedTime?: number;
-    size?: number;
-}
-export interface AssetSyncDefinitionModel {
-    path: string;
-    enabled: boolean;
-    deleteFromRobotAfterSync?: boolean;
-    integration?: {
-        forward?: {
-            provider: string;
-            configs: any;
-        }[];
-    };
-}
-export interface AssetSyncDefinitionOverrideModel extends AssetSyncDefinitionModel {
-    _isOverridden: boolean;
-}
-export interface AssetSyncDefinitionsModel {
-    items: AssetSyncDefinitionModel[];
-    profileOverriddenItems?: AssetSyncDefinitionOverrideModel[];
-}

package/models/caller/IRocosCallerMessageChunk.d.ts

@@ -1,10 +0,0 @@
-import { IRocosCallerMessageResponseAck } from './IRocosCallerMessageResponseAck';
-import { IRocosCallerMessageResponseResult } from './IRocosCallerMessageResponseResult';
-import { IRocosCallerMessageResponseUid } from './IRocosCallerMessageResponseUid';
-export interface IRocosCallerMessageChunk {
-    chunkIndex: number;
-    chunkCount: number;
-    uid?: IRocosCallerMessageResponseUid;
-    ack?: IRocosCallerMessageResponseAck;
-    result?: IRocosCallerMessageResponseResult;
-}

package/models/caller/index.d.ts

@@ -1,10 +0,0 @@
-export * from './IRocosCallerMessageChunk';
-export * from './IRocosCallerMessageChunks';
-export * from './IRocosCallerMessageHeartbeat';
-export * from './IRocosCallerMessageResponse';
-export * from './IRocosCallerMessageResponseAck';
-export * from './IRocosCallerMessageResponseResult';
-export * from './IRocosCallerMessageResponses';
-export * from './IRocosCallerMessageResponseUid';
-export * from './RocosCallerResultStatus';
-export * from './RocosResponseLevel';

package/models/caller/index.js

@@ -1,10 +0,0 @@
-export * from './IRocosCallerMessageChunk';
-export * from './IRocosCallerMessageChunks';
-export * from './IRocosCallerMessageHeartbeat';
-export * from './IRocosCallerMessageResponse';
-export * from './IRocosCallerMessageResponseAck';
-export * from './IRocosCallerMessageResponseResult';
-export * from './IRocosCallerMessageResponses';
-export * from './IRocosCallerMessageResponseUid';
-export * from './RocosCallerResultStatus';
-export * from './RocosResponseLevel';

package/models/index.d.ts

@@ -1,75 +0,0 @@
-export * from './asset-storage/AssetModelItem';
-export * from './schedule/IScheduleInfo';
-export * from './schedule/IScheduleAction';
-export * from './schedule/IScheduleJob';
-export * from './caller';
-export * from './callsigns/CallsignsEnums';
-export * from './callsigns/CallsignsLookup';
-export * from './callsigns/CallsignsQuery';
-export * from './callsigns/CallsignsQueryPredicate';
-export * from './command';
-export * from './file/FileEnums';
-export * from './message';
-export * from './params/ICallerParams';
-export * from './params/ICommandParams';
-export * from './params/IControlParams';
-export * from './params/IFileAccessorParams';
-export * from './params/ISearchParams';
-export * from './params/ITelemetryParams';
-export * from './params/IWebRTCSignallingParams';
-export * from './search/SearchQueryFilter';
-export * from './search/SearchStreamQuery';
-export * from './stream/IBaseStream';
-export * from './stream/ICallerStream';
-export * from './stream/ICommandStream';
-export * from './stream/IControlStream';
-export * from './stream/IFileAccessorStream';
-export * from './stream/ISearchStream';
-export * from './stream/ITelemetryStream';
-export * from './stream/IWebRTCSignallingStream';
-export * from './integrations/Overlay';
-export * from './integrations/Plan';
-export * from './maps/Map';
-export * from './projects/ProjectUser';
-export * from './CallsignStatus';
-export * from './ExportDataQuery';
-export * from './IBaseService';
-export * from './IConfigGroup';
-export * from './IDebugLevel';
-export * from './IExportDataQuery';
-export * from './IFunctionConfig';
-export * from './IInvitation';
-export * from './IInvitationExists';
-export * from './IOperation';
-export * from './IPersonalAccessToken';
-export * from './IProject';
-export * from './IProjectApplication';
-export * from './IRobot';
-export * from './IRobotConfig';
-export * from './IRobotPlugin';
-export * from './IRobotSettings';
-export * from './IRobotTemplate';
-export * from './IRocosSDKConfig';
-export * from './ISource';
-export * from './IStream';
-export * from './IStreamConfig';
-export * from './IStreamOptions';
-export * from './IStreamSource';
-export * from './ITelemetryStreamConfig';
-export * from './IToken';
-export * from './IWidget';
-export * from './IWidgetLineGroup';
-export * from './Robot';
-export * from './RobotConfig';
-export * from './RobotPlugin';
-export * from './RobotTemplate';
-export * from './RocosError';
-export * from './ServiceEnum';
-export * from './Stream';
-export * from './StreamOptions';
-export * from './StreamSource';
-export * from './SubscriberStatusEnum';
-export * from './Token';
-export * from './types';
-export * from './Widget';
-export * from './WidgetLineGroup';

package/models/index.js

@@ -1,75 +0,0 @@
-export * from './asset-storage/AssetModelItem';
-export * from './schedule/IScheduleInfo';
-export * from './schedule/IScheduleAction';
-export * from './schedule/IScheduleJob';
-export * from './caller';
-export * from './callsigns/CallsignsEnums';
-export * from './callsigns/CallsignsLookup';
-export * from './callsigns/CallsignsQuery';
-export * from './callsigns/CallsignsQueryPredicate';
-export * from './command';
-export * from './file/FileEnums';
-export * from './message';
-export * from './params/ICallerParams';
-export * from './params/ICommandParams';
-export * from './params/IControlParams';
-export * from './params/IFileAccessorParams';
-export * from './params/ISearchParams';
-export * from './params/ITelemetryParams';
-export * from './params/IWebRTCSignallingParams';
-export * from './search/SearchQueryFilter';
-export * from './search/SearchStreamQuery';
-export * from './stream/IBaseStream';
-export * from './stream/ICallerStream';
-export * from './stream/ICommandStream';
-export * from './stream/IControlStream';
-export * from './stream/IFileAccessorStream';
-export * from './stream/ISearchStream';
-export * from './stream/ITelemetryStream';
-export * from './stream/IWebRTCSignallingStream';
-export * from './integrations/Overlay';
-export * from './integrations/Plan';
-export * from './maps/Map';
-export * from './projects/ProjectUser';
-export * from './CallsignStatus';
-export * from './ExportDataQuery';
-export * from './IBaseService';
-export * from './IConfigGroup';
-export * from './IDebugLevel';
-export * from './IExportDataQuery';
-export * from './IFunctionConfig';
-export * from './IInvitation';
-export * from './IInvitationExists';
-export * from './IOperation';
-export * from './IPersonalAccessToken';
-export * from './IProject';
-export * from './IProjectApplication';
-export * from './IRobot';
-export * from './IRobotConfig';
-export * from './IRobotPlugin';
-export * from './IRobotSettings';
-export * from './IRobotTemplate';
-export * from './IRocosSDKConfig';
-export * from './ISource';
-export * from './IStream';
-export * from './IStreamConfig';
-export * from './IStreamOptions';
-export * from './IStreamSource';
-export * from './ITelemetryStreamConfig';
-export * from './IToken';
-export * from './IWidget';
-export * from './IWidgetLineGroup';
-export * from './Robot';
-export * from './RobotConfig';
-export * from './RobotPlugin';
-export * from './RobotTemplate';
-export * from './RocosError';
-export * from './ServiceEnum';
-export * from './Stream';
-export * from './StreamOptions';
-export * from './StreamSource';
-export * from './SubscriberStatusEnum';
-export * from './Token';
-export * from './types';
-export * from './Widget';
-export * from './WidgetLineGroup';

package/models/message/IRocosTelemetryMessage.d.ts

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

package/models/params/ICallerParams.d.ts

@@ -1,16 +0,0 @@
-import { RocosResponseLevel } from '../caller';
-export interface ICallerParams {
-    uid: string;
-    projectId: string;
-    callsign: string;
-    subSystem: string;
-    component?: string;
-    topic?: string;
-}
-export interface ICallerInvokeParams extends ICallerParams {
-    component: string;
-    topic: string;
-    responseLevelNumber: RocosResponseLevel | number;
-    payload: string;
-    query?: Record<string, string[]>;
-}

package/node/RocosSDKNode.d.ts

@@ -1,47 +0,0 @@
-import { EvaluatorService, ScheduleService } from '../services';
-import { CallerServiceNode } from '../services/CallerServiceNode';
-import { CommandServiceNode } from '../services/CommandServiceNode';
-import { ControlServiceNode } from '../services/ControlServiceNode';
-import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
-import { IBaseService } from '../models/IBaseService';
-import { RocosSDK } from '../RocosSDK';
-import { SearchServiceNode } from '../services/SearchServiceNode';
-import { ServiceEnum } from '../models/ServiceEnum';
-import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
-export declare class RocosSDKNode extends RocosSDK {
-    getService<T extends IBaseService>(name: ServiceEnum): T;
-    /**
-     * Gets the telemetry service.
-     */
-    getTelemetryService(): TelemetryServiceNode;
-    /**
-     * Gets the scheduler service.
-     */
-    getSchedulerService(): ScheduleService;
-    /**
-     * Gets the service call service.
-     */
-    getCallerService(): CallerServiceNode;
-    /**
-     * Gets the command service.
-     */
-    getCommandService(): CommandServiceNode;
-    /**
-     * Gets the robot control service.
-     */
-    getControlService(): ControlServiceNode;
-    /**
-     * Gets the search service.
-     */
-    getSearchService(): SearchServiceNode;
-    /**
-     * Gets the file accessor service
-     * @returns FileAccessorServiceNode
-     */
-    getFileAccessorService(): FileAccessorServiceNode;
-    /**
-     * Gets the evaluator service
-     * @returns EvaluatorServiceNode
-     */
-    getEvaluatorService(): EvaluatorService;
-}