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

package/services/MapService.js

@@ -1,151 +0,0 @@
-import { API_MAPS_COPY_URL, API_MAPS_DEPLOYED_URL, API_MAPS_DEPLOY_URL, API_MAPS_GEOJSON_URL, API_MAPS_MERGE_URL, API_MAPS_URL, API_MAP_ID_URL, } from '../constants/api';
-import { RocosError, errorCodes } from '../models';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { RocosLogger } from '../logger/RocosLogger';
-import { formatServiceUrl } from '../helpers/formatServiceUrl';
-/**
- * Integrations to retrieve data from the linked project in DroneDeploy
- */
-export class MapService extends BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`MapService(${this.config.url})`);
-    }
-    getStatus() {
-        return true;
-    }
-    getError(e) {
-        return new RocosError(e, errorCodes.MAPS_SERVICE_ERROR);
-    }
-    async list(projectId, callsign) {
-        const resp = await this.callGet(formatServiceUrl(API_MAPS_URL, {
-            url: this.config.url,
-            projectId,
-        }, this.config.insecure), 'Failed to get maps.', callsign ? { callsign } : undefined);
-        return resp.maps;
-    }
-    /** List maps to be deployed to a callsign
-     *
-     * @param projectId
-     * @param callsign
-     */
-    async listDeployedMaps(projectId, callsign) {
-        const safeCallsign = encodeURIComponent(callsign);
-        const resp = await this.callGet(formatServiceUrl(API_MAPS_DEPLOYED_URL, {
-            url: this.config.url,
-            projectId,
-            callsign: safeCallsign,
-        }, this.config.insecure), 'Failed to get deployed maps.');
-        return resp.maps;
-    }
-    /**
-     * Creates a new map by merging two existing maps
-     * @param projectId Project ID
-     * @param maps Array of two map IDs to merge
-     * @param options Options to create the new map
-     */
-    async merge(projectId, maps, options) {
-        if (maps.length !== 2)
-            throw new Error('You must provide two maps to merge.');
-        const payload = {
-            projectID: projectId,
-            mapIDLeft: maps[0],
-            mapIDRight: maps[1],
-            name: options.name,
-            description: options.description,
-            callsign: options.callsign,
-        };
-        return this.callPost(formatServiceUrl(API_MAPS_MERGE_URL, {
-            url: this.config.url,
-            projectId,
-        }, this.config.insecure), payload, 'Failed to merge maps.');
-    }
-    /** Returns a map in its canonical form
-     *
-     * @param projectId Project ID
-     * @param mapId Map ID
-     */
-    async get(projectId, mapId) {
-        return this.callGet(formatServiceUrl(API_MAP_ID_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), 'Failed to get map.');
-    }
-    /**
-     * Updates a maps metadata
-     * @param projectId Project ID
-     * @param mapId Map ID
-     * @param options New metadata
-     */
-    async update(projectId, mapId, options) {
-        return this.callPut(formatServiceUrl(API_MAP_ID_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), options, 'Failed to update map.');
-    }
-    /**
-     * Begins uploading a map from the agent
-     *
-     * @param projectId Project ID
-     * @param mapId Map ID
-     * @param callsign Robot callsign
-     * @param hash Map hash
-     */
-    async sendToCloud(projectId, mapId, callsign, hash) {
-        return this.callPost(formatServiceUrl(API_MAP_ID_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), { callsign, hash }, 'Failed to start map upload.');
-    }
-    async delete(projectId, mapId, callsign, hash) {
-        return this.callDelete(formatServiceUrl(API_MAP_ID_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), 'Failed to delete map.', callsign ? { callsign, hash } : {});
-    }
-    /**
-     * Makes a copy of an uploaded map
-     *
-     * @param projectId Project ID
-     * @param mapId Map ID
-     * @param options Options to create the new map
-     */
-    async copy(projectId, mapId, options) {
-        return this.callPost(formatServiceUrl(API_MAPS_COPY_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), options, 'Failed to copy map.');
-    }
-    /** Deploy a map from the cloud to a robot
-     *
-     * @param projectId Project ID
-     * @param mapId Map ID
-     * @param callsign Robot callsign
-     */
-    async deploy(projectId, mapId, callsign) {
-        return this.callPost(formatServiceUrl(API_MAPS_DEPLOY_URL, {
-            url: this.config.url,
-            projectId,
-            mapId,
-        }, this.config.insecure), { callsign }, 'Failed to deploy map.');
-    }
-    /** Get a GeoJSON representation of a map
-     *
-     * @param projectId Project ID
-     * @param mapId Map ID
-     * @param frameId Frame ID (optional)
-     */
-    async getGeoJSON(projectId, mapId, frameId) {
-        const params = {
-            url: this.config.url,
-            projectId,
-            mapId,
-        };
-        return this.callGet(formatServiceUrl(API_MAPS_GEOJSON_URL, params, this.config.insecure), 'Failed to get map GeoJSON.', frameId ? { frameID: frameId } : undefined);
-    }
-}

package/services/PlatformTimeService.spec.js

@@ -1,180 +0,0 @@
-import { PlatFormTimeService } from "./PlatformTimeService";
-import { TimeSyncerService } from "./TimeSyncerService";
-import { standardDeviation } from "../helpers";
-// Subclass PlatformTimeService so that we can test the protected methods
-class PlatformtimeServicePublic extends PlatFormTimeService {
-    constructor(timeSyncerService) {
-        super(timeSyncerService);
-    }
-    isReliableServerTime(platformTimeMeasurement) {
-        return super.isReliableServerTime(platformTimeMeasurement);
-    }
-    calculateOffset(platformTimeMeasurement) {
-        return super.calculateOffset(platformTimeMeasurement);
-    }
-    removeLongestAndShortest(platformTimeMeasurement) {
-        return super.removeLongestAndShortest(platformTimeMeasurement);
-    }
-    static getInstance(timeSyncerService) {
-        const instance = super.getInstance(timeSyncerService);
-        return instance;
-    }
-}
-describe('platformTimeService', () => {
-    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);
-    });
-    it('should be able to tell reliable server time response', () => {
-        jest.useFakeTimers();
-        const p = PlatformtimeServicePublic.getInstance(new TimeSyncerService({}));
-        const mock = {
-            clientTimeStampEnd: 100,
-            clientTimeStampStart: 20,
-            serverTime: {
-                now: 0,
-                duration: 0,
-            },
-        };
-        const mocks = [];
-        mocks.push(mock);
-        let isReliableServerTime = p.isReliableServerTime(mocks);
-        expect(isReliableServerTime).toBeTruthy();
-        for (let i = 0; i < 4; i++) {
-            mocks.push({ ...mock });
-            isReliableServerTime = p.isReliableServerTime(mocks);
-            expect(isReliableServerTime).toBeTruthy();
-        }
-    });
-    it('should be able to tell unreliable server time response', () => {
-        jest.useFakeTimers();
-        const p = PlatformtimeServicePublic.getInstance(new TimeSyncerService({}));
-        const mock = {
-            clientTimeStampEnd: 100,
-            clientTimeStampStart: 0,
-            serverTime: {
-                now: 0,
-                duration: 0,
-            },
-        };
-        const mocks = [];
-        let isReliableServerTime = false;
-        for (let i = 0; i < 5; i++) {
-            const mockClone = { ...mock };
-            mockClone.clientTimeStampEnd += i * 60;
-            mocks.push(mockClone);
-        }
-        isReliableServerTime = p.isReliableServerTime(mocks);
-        expect(isReliableServerTime).toBeTruthy();
-        for (let i = 0; i < 5; i++) {
-            const mockClone = { ...mock };
-            mockClone.clientTimeStampEnd += i * 70;
-            mocks.push(mockClone);
-        }
-        isReliableServerTime = p.isReliableServerTime(mocks);
-        expect(isReliableServerTime).toBeTruthy();
-        for (let i = 0; i < 5; i++) {
-            const mockClone = { ...mock };
-            mockClone.clientTimeStampEnd += i * 80;
-            mocks.push(mockClone);
-        }
-        isReliableServerTime = p.isReliableServerTime(mocks);
-        // std dev = 113.13708498985
-        expect(isReliableServerTime).toBeFalsy();
-        for (let i = 0; i < 5; i++) {
-            const mockClone = { ...mock };
-            mockClone.clientTimeStampEnd += i * 100;
-            mocks.push(mockClone);
-        }
-        isReliableServerTime = p.isReliableServerTime(mocks);
-        expect(isReliableServerTime).toBeFalsy();
-    });
-    it('should be able to remove shortest and longest correctly', () => {
-        jest.useFakeTimers();
-        const p = PlatformtimeServicePublic.getInstance(new TimeSyncerService({}));
-        const mock = {
-            clientTimeStampEnd: 100,
-            clientTimeStampStart: 0,
-            serverTime: {
-                now: 0,
-                duration: 0,
-            },
-        };
-        const mocks = [];
-        let mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 100;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 200;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 500;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 400;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 300;
-        mocks.push(mockClone);
-        const platformTimeMeasurement = p.removeLongestAndShortest(mocks);
-        platformTimeMeasurement.forEach((p) => {
-            expect(p.clientTimeStampEnd).not.toEqual(100);
-            expect(p.clientTimeStampEnd).not.toEqual(500);
-        });
-    });
-    it('should be able to calculate the offset correctly', () => {
-        jest.useFakeTimers();
-        const p = PlatformtimeServicePublic.getInstance(new TimeSyncerService({}));
-        const mock = {
-            clientTimeStampEnd: 100,
-            clientTimeStampStart: 0,
-            serverTime: {
-                now: 0,
-                duration: 0,
-            },
-        };
-        const mocks = [];
-        let mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 200;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 500;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 400;
-        mocks.push(mockClone);
-        const offset = p.calculateOffset(mocks);
-        // (200-(200)/2 + 500 - (500)/2 + 400 - (400)/2)/3 = 183.333333333, round to 183
-        expect(offset).toEqual(183);
-    });
-    it('should be able to filter where service time is not provided', () => {
-        jest.useFakeTimers();
-        const p = PlatformtimeServicePublic.getInstance(new TimeSyncerService({}));
-        const mock = {
-            clientTimeStampEnd: 100,
-            clientTimeStampStart: 0,
-            serverTime: {
-                now: 0,
-                duration: 0,
-            },
-        };
-        const mocks = [];
-        let mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 200;
-        mockClone.serverTime = undefined;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 500;
-        mocks.push(mockClone);
-        mockClone = { ...mock };
-        mockClone.clientTimeStampEnd = 400;
-        mocks.push(mockClone);
-        const offset = p.calculateOffset(mocks);
-        // (500 - (500)/2 + 400 - (400)/2)/2 = 225
-        expect(offset).toEqual(225);
-    });
-});

package/services/ProfileService.d.ts

@@ -1,244 +0,0 @@
-import { RocosError } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
-    constructor(config: IRocosSDKConfig);
-    protected getError(e: Error): RocosError;
-    getStatus(): boolean;
-    /**
-     *  Create a robot definition
-     *
-     * @param projectId - Project Id
-     * @param model - Payload
-     * @description - Renamed from robotDefsCreate
-     */
-    create(projectId: string, model: any): Promise<any>;
-    /**
-     * Get robot definitions
-     *
-     * @param projectId - Project Id
-     * @description - Renamed from robotDefsList
-     */
-    list(projectId: string): Promise<any>;
-    /**
-     * Delete robot definitions
-     *
-     * @param projectId - Project Id
-     * @param defIds - Definition Id's
-     * @description - Renamed from robotDefsRemove
-     */
-    remove(projectId: string, defIds: string[]): Promise<any>;
-    /**
-     * Get a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @description - Renamed from robotDefsGetOne
-     */
-    get(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Delete a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @description - Renamed from robotDefsDeleteOne
-     */
-    delete(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @param model - Definition payload
-     * @description - Renamed from robotDefsUpdateOne
-     */
-    update(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get definitions for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @description - Renamed from robotDefsForRobot
-     */
-    getForRobot(projectId: string, callsign: string): Promise<any>;
-    /**
-     * Update storage streams for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefsUpdateStorageStreams
-     */
-    updateStorageStreams(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Copy a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefCopyDef
-     */
-    copyDef(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get robot list got a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Definition Id
-     * @description - Renamed from robotListForDefs
-     */
-    robotList(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Get dashboards for a definition
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @description - Renamed from robotDefDashboards
-     */
-    dashboards(projectId: string, profileId: string): Promise<any>;
-    /**
-     * Get Dashboard data which stored in Azure Blob.
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot Profile Id
-     * @description - Renamed from robotDefDashboardBlob
-     */
-    dashboardBlob(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update dashboard for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot Profile Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateDashboards
-     */
-    updateDashboards(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get settings for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot Profile Id
-     * @description - Renamed from robotDefGetSettings
-     */
-    getSettings(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update settings for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot Profile Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateSettings
-     */
-    updateSettings(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get agent settings
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetAgentSettings
-     */
-    getAgentSettings(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update agent settings
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateAgentSettings
-     */
-    updateAgentSettings(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get commands fora robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetCommands
-     */
-    getCommands(projectId: string, definitionId: string): Promise<any>;
-    /**
-     *
-     * Update commands fora robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateCommands
-     */
-    updateCommands(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get command V2 for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetCommandsV2
-     */
-    getCommandsV2(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update command V2 for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateCommandsV2
-     */
-    updateCommandsV2(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get command actions for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetCommandActions
-     */
-    getCommandActions(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Get buttons for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetButtons
-     */
-    getButtons(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update buttons for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateButtons
-     */
-    updateButtons(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get triggers for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetTriggers
-     */
-    getTriggers(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update triggers for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - Payload
-     * @description - Renamed from robotDefUpdateTriggers
-     */
-    updateTriggers(projectId: string, definitionId: string, model: any): Promise<any>;
-    /**
-     * Get gamepads for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @description - Renamed from robotDefGetGamepads
-     */
-    getGamepads(projectId: string, definitionId: string): Promise<any>;
-    /**
-     * Update gamepads for a robot definition
-     *
-     * @param projectId - Project Id
-     * @param definitionId - Robot definition Id
-     * @param model - \payload
-     * @description - Renamed from robotDefUpdateGamepads
-     */
-    updateGamepads(projectId: string, definitionId: string, model: any): Promise<any>;
-}