@dronedeploy/rocos-js-sdk 0.0.1 → 1.0.0-alpha-2

package/helpers/standardDeviation.spec.js

@@ -0,0 +1,11 @@
+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/stringToUint8Array.d.ts

@@ -0,0 +1 @@
+export declare const stringToUint8Array: (input: string) => Uint8Array;

package/helpers/stringToUint8Array.js

@@ -0,0 +1,10 @@
+import { Buffer } from 'buffer';
+export const stringToUint8Array = (input) => {
+    input = input ? input : '';
+    const buf = new Buffer(input);
+    const result = new Uint8Array(buf.length);
+    for (let i = 0; i < buf.length; i++) {
+        result[i] = buf[i];
+    }
+    return result;
+};

package/helpers/uint8ArrayToString.d.ts

@@ -0,0 +1 @@
+export declare const uint8ArrayToString: (arr: Uint8Array | any) => string;

package/helpers/uint8ArrayToString.js

@@ -0,0 +1,10 @@
+export const uint8ArrayToString = (arr) => {
+    if (!arr) {
+        return '';
+    }
+    const strArr = [];
+    arr?.forEach((element) => {
+        strArr.push(String.fromCharCode(element));
+    });
+    return strArr.join('');
+};

package/index.d.ts

@@ -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/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/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/logger/RocosLogger.js

@@ -0,0 +1,37 @@
+import * as prefix from 'loglevel-plugin-prefix';
+import log from 'loglevel';
+log.setDefaultLevel('silent');
+prefix.reg(log);
+prefix.apply(log, {
+    format(level, name, timestamp) {
+        return `[${timestamp}] ${level.toUpperCase()} ${name}:`;
+    },
+});
+export class RocosLogger {
+    static getInstance(name) {
+        if (name) {
+            const logger = log.getLogger(name);
+            logger.setLevel(log.getLevel());
+            return logger;
+        }
+        return log;
+    }
+    static enableAll() {
+        log.enableAll();
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).enableAll();
+        }
+    }
+    static disableAll() {
+        log.disableAll();
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).disableAll();
+        }
+    }
+    static setLevel(level) {
+        log.setLevel(level);
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).setLevel(log.getLevel());
+        }
+    }
+}

package/models/CallsignStatus.d.ts

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

package/models/CallsignStatus.js

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

package/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/models/ExportDataQuery.js

@@ -0,0 +1,13 @@
+export 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,
+        };
+    }
+}

package/models/ExternalProject.d.ts

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

package/models/ExternalProject.js

@@ -0,0 +1,2 @@
+export class ExternalProject {
+}

package/models/IBaseService.d.ts

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

package/models/IBaseService.js

@@ -0,0 +1 @@
+export {};

package/models/IConfigGroup.d.ts

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

package/models/IConfigGroup.js

@@ -0,0 +1 @@
+export {};

package/models/IDebugLevel.d.ts

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

package/models/IDebugLevel.js

@@ -0,0 +1 @@
+export {};

package/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/models/IExportDataQuery.js

@@ -0,0 +1 @@
+export {};

package/models/IFunctionConfig.d.ts

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

package/models/IFunctionConfig.js

@@ -0,0 +1 @@
+export {};

package/models/IInvitation.d.ts

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

package/models/IInvitation.js

@@ -0,0 +1 @@
+export {};

package/models/IInvitationExists.d.ts

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

package/models/IInvitationExists.js

@@ -0,0 +1 @@
+export {};

package/models/IOperation.d.ts

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

package/models/IOperation.js

@@ -0,0 +1 @@
+export {};

package/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/models/IPersonalAccessToken.js

@@ -0,0 +1 @@
+export {};

package/models/IProject.d.ts

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

package/models/IProject.js

@@ -0,0 +1 @@
+export {};

package/models/IProjectApplication.d.ts

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

package/models/IProjectApplication.js

@@ -0,0 +1 @@
+export {};

package/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/models/IRobot.js

@@ -0,0 +1 @@
+export {};

package/models/IRobotConfig.d.ts

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

package/models/IRobotConfig.js

@@ -0,0 +1 @@
+export {};

package/models/IRobotPlugin.d.ts

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

package/models/IRobotPlugin.js

@@ -0,0 +1 @@
+export {};

package/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/models/IRobotSettings.js

@@ -0,0 +1 @@
+export {};

package/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[];
+}

package/models/IRobotTemplate.js

@@ -0,0 +1 @@
+export {};

package/models/IRocosSDKConfig.d.ts

@@ -0,0 +1,19 @@
+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/IRocosSDKConfig.js

@@ -0,0 +1 @@
+export {};

package/models/ISource.d.ts

@@ -0,0 +1,8 @@
+export interface ISourceData {
+    id: string;
+}
+export interface ISource {
+    id: string;
+    name: string;
+    data?: ISourceData[];
+}

package/models/ISource.js

@@ -0,0 +1 @@
+export {};

package/models/IStream.d.ts

@@ -0,0 +1,9 @@
+import { IStreamSource } from './IStreamSource';
+export interface IStream {
+    id?: string;
+    name: string;
+    description?: string;
+    data: IStreamSource[];
+    callsigns?: string[];
+    robotDefinitionIds?: any;
+}

package/models/IStream.js

@@ -0,0 +1 @@
+export {};

package/models/IStreamConfig.d.ts

@@ -0,0 +1,9 @@
+import { IStreamOptions } from './IStreamOptions';
+export interface IStreamConfig {
+    url: string;
+    token: string;
+    scope: string;
+    options?: IStreamOptions;
+    port?: number;
+    insecure?: boolean;
+}

package/models/IStreamConfig.js

@@ -0,0 +1 @@
+export {};

package/models/IStreamOptions.d.ts

@@ -0,0 +1,7 @@
+export interface IStreamOptions {
+    autoResubscribeEnabled: boolean;
+    autoResubscribeMessageLimit: number;
+    autoResubscribeMinimumTime: number;
+    messageTimeoutInSec: number;
+    autoAcknowledgmentEnabled: boolean;
+}

package/models/IStreamOptions.js

@@ -0,0 +1 @@
+export {};

package/models/IStreamSource.d.ts

@@ -0,0 +1,8 @@
+export interface IStreamSource {
+    id?: string;
+    sourceId: string;
+    dataId: string;
+    type: string;
+    frequency: number;
+    robotDefinitionIds?: any;
+}

package/models/IStreamSource.js

@@ -0,0 +1 @@
+export {};

package/models/ISubscriberStatus.d.ts

@@ -0,0 +1,5 @@
+import { Observable } from 'rxjs';
+import { SubscriberStatusEnum } from './SubscriberStatusEnum';
+export interface ISubscriberStatus {
+    status$: Observable<SubscriberStatusEnum>;
+}

package/models/ISubscriberStatus.js

@@ -0,0 +1 @@
+export {};

package/models/ITelemetryStreamConfig.d.ts

@@ -0,0 +1,7 @@
+import { CallsignsLookup } from './callsigns/CallsignsLookup';
+import { IStreamConfig } from './IStreamConfig';
+export interface ITelemetryStreamConfig extends IStreamConfig {
+    projectId: string;
+    callsignsLookup: CallsignsLookup;
+    sources: string[];
+}

package/models/ITelemetryStreamConfig.js

@@ -0,0 +1 @@
+export {};

package/models/IToken.d.ts

@@ -0,0 +1,9 @@
+export interface IToken {
+    readonly value: string;
+    readonly expires?: Date;
+    readonly issuedAt?: Date;
+    readonly subject?: string;
+    readonly issuer?: string;
+    readonly audience?: string;
+    readonly refreshToken?: string;
+}

package/models/IToken.js

@@ -0,0 +1 @@
+export {};

package/models/IWidget.d.ts

@@ -0,0 +1,25 @@
+import { IWidgetLineGroup } from './IWidgetLineGroup';
+export interface IWidget {
+    connectionType: string;
+    widgetType: string;
+    widgetHeading: string;
+    dataURI: string;
+    source?: string;
+    units: string;
+    dataName: string;
+    key?: string;
+    valueExpression?: string;
+    decimalPlaces?: number;
+    widgetTimeout?: number;
+    minimumValue: number;
+    maximumValue: number;
+    lineGroups?: IWidgetLineGroup[];
+    rangeMin?: number;
+    rangeMax?: number;
+    tableFormat?: string;
+    videoServer?: string;
+    videoId?: string;
+    videoCommand?: string;
+    videoSourceType?: string;
+    html?: string;
+}

package/models/IWidget.js

@@ -0,0 +1 @@
+export {};

package/models/IWidgetLineGroup.d.ts

@@ -0,0 +1,8 @@
+export interface IWidgetLineGroup {
+    dataURI: string;
+    source?: string;
+    units: string;
+    dataLabel: string;
+    lineColor: string;
+    valueExpression?: string;
+}

package/models/IWidgetLineGroup.js

@@ -0,0 +1 @@
+export {};

package/models/ResponseLevelEnum.d.ts

@@ -0,0 +1,10 @@
+export declare enum ResponseLevelEnum {
+    /** ack, return, result **/
+    ALL = 0,
+    /** return, result **/
+    RETURN_AND_RESULT = 1,
+    /** result **/
+    RESULT_ONLY = 2,
+    /** nothing **/
+    NONE = 3
+}

package/models/ResponseLevelEnum.js

@@ -0,0 +1,11 @@
+export 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 || (ResponseLevelEnum = {}));

package/models/Robot.d.ts

@@ -0,0 +1,20 @@
+import { IRobot } from './IRobot';
+import { RobotModeType } from './types';
+export declare class Robot implements 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[];
+    constructor(init?: Partial<IRobot>);
+}

package/models/Robot.js

@@ -0,0 +1,8 @@
+export class Robot {
+    constructor(init) {
+        this.disabled = false;
+        this.imageId = '';
+        this.mode = 'physical';
+        Object.assign(this, init);
+    }
+}

package/models/RobotConfig.d.ts

@@ -0,0 +1,10 @@
+import { IRobotConfig } from './IRobotConfig';
+export declare class RobotConfig implements IRobotConfig {
+    id: string;
+    name: string;
+    description: string;
+    type: string;
+    defaultValue: any;
+    required: boolean;
+    constructor(init?: Partial<IRobotConfig>);
+}

package/models/RobotConfig.js

@@ -0,0 +1,5 @@
+export class RobotConfig {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}

package/models/RobotPlugin.d.ts

@@ -0,0 +1,5 @@
+import { IRobotPlugin } from './IRobotPlugin';
+export declare class RobotPlugin implements IRobotPlugin {
+    name: string;
+    constructor(init?: Partial<IRobotPlugin>);
+}

package/models/RobotPlugin.js

@@ -0,0 +1,5 @@
+export class RobotPlugin {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}