@dronedeploy/rocos-js-sdk 0.0.1 → 2.6.1

package/services/FunctionService.d.ts

@@ -0,0 +1,68 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IExportDataQuery } from '../models/IExportDataQuery';
+import { IFunctionConfig } from '../models/IFunctionConfig';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class FunctionService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Export data
+     *
+     * @param projectId - Project Id
+     * @param query - Payload {@link IExportDataQuery}
+     */
+    exportJobs(projectId: string, query: IExportDataQuery): Promise<any>;
+    /**
+     * Create a function
+     *
+     * @param projectId - Project Id
+     * @param model - Payload {@link IFunctionConfig}
+     */
+    create(projectId: string, model: IFunctionConfig): Promise<any>;
+    /**
+     * Get a functions
+     *
+     * @param projectId - Project Id
+     */
+    list(projectId: string): Promise<any>;
+    /**
+     * Update a function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     * @param model - Payload {@link IFunctionConfig}
+     */
+    update(projectId: string, functionId: string, model: IFunctionConfig): Promise<any>;
+    /**
+     * Get function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    info(projectId: string, functionId: string): Promise<any>;
+    /**
+     * Delete function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    delete(projectId: string, functionId: string): Promise<any>;
+    /**
+     * Run a function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     * @param body - Payload
+     */
+    run(projectId: string, functionId: string, body?: any): Promise<any>;
+    /**
+     * Get function pods
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    pods(projectId: string, functionId: string): Promise<any>;
+}

package/services/FunctionService.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionService = void 0;
+const api_1 = require("../constants/api");
+const RocosError_1 = require("../models/RocosError");
+const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
+const ExportDataQuery_1 = require("../models/ExportDataQuery");
+const RocosLogger_1 = require("../logger/RocosLogger");
+const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
+class FunctionService extends BaseServiceAbstract_1.BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger_1.RocosLogger.getInstance(`FunctionService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError_1.RocosError(e, RocosError_1.errorCodes.FUNCTION_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Export data
+     *
+     * @param projectId - Project Id
+     * @param query - Payload {@link IExportDataQuery}
+     */
+    // TODO: map the response object
+    async exportJobs(projectId, query) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_EXPORT_URL, { url: this.config.url, projectId }, this.config.insecure), new ExportDataQuery_1.ExportDataQuery(query).toJSON(), `Failed to export data for ${projectId}.`);
+    }
+    /**
+     * Create a function
+     *
+     * @param projectId - Project Id
+     * @param model - Payload {@link IFunctionConfig}
+     */
+    // TODO: map the response object
+    async create(projectId, model) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create function for ${projectId}.`);
+    }
+    /**
+     * Get a functions
+     *
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async list(projectId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get functions for ${projectId}.`);
+    }
+    /**
+     * Update a function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     * @param model - Payload {@link IFunctionConfig}
+     */
+    // TODO: map the response object
+    async update(projectId, functionId, model) {
+        return this.callPut(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), model, `Failed to update function for ${projectId}, functionId ${functionId}.`);
+    }
+    /**
+     * Get function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    // TODO: map the response object
+    async info(projectId, functionId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to get function for ${projectId}, functionId ${functionId}.`);
+    }
+    /**
+     * Delete function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    // TODO: map the response object
+    async delete(projectId, functionId) {
+        return this.callDelete(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to delete function for ${projectId}, functionId ${functionId}.`);
+    }
+    /**
+     * Run a function
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     * @param body - Payload
+     */
+    // TODO: map the response object
+    async run(projectId, functionId, body = null) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_RUN_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), body, `Failed to run function for ${projectId}, functionId ${functionId}.`);
+    }
+    /**
+     * Get function pods
+     *
+     * @param projectId - Project Id
+     * @param functionId - Function Id
+     */
+    // TODO: map the response object
+    async pods(projectId, functionId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FUNCTION_POD_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to ged function pods for ${projectId}, functionId ${functionId}.`);
+    }
+}
+exports.FunctionService = FunctionService;

package/services/IntegrationService.d.ts

@@ -0,0 +1,48 @@
+import { IBaseService, IRocosSDKConfig, Overlay, Plan, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+/**
+ * Integrations to retrieve data from the linked project in DroneDeploy
+ */
+export declare class IntegrationService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    /**
+     * Gets latest plans from the project linked to the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    getPlans(projectId: string): Promise<Plan[]>;
+    /**
+     * Gets the plans from the project linked to the provided project ID
+     * @param projectId Project ID
+     * @param pageStart Page start
+     * @returns Plans list (limited to 50) with cursor to next page when available
+     */
+    getPlansPaged(projectId: string, pageStart?: string): Promise<{
+        plans: Plan[];
+        pageNext?: string;
+    }>;
+    /**
+     * Gets a plan for a given project (using its linked project)
+     * @param projectId Project ID
+     * @param planId Requested plan
+     * @returns A single plan
+     */
+    getPlanById(projectId: string, planId: string): Promise<Plan>;
+    /**
+     * Returns raster overlays such as drawings to be used for mission planning
+     * @param projectId Project ID
+     * @returns A list of overlays in the project
+     */
+    getOverlays(projectId: string): Promise<Overlay[]>;
+    /**
+     * Creates a blank issue in the latest ortho plan available
+     * @param projectId Project ID
+     * @param location Location of the issue
+     */
+    createIssue(projectId: string, location: {
+        lat: number;
+        lng: number;
+    }): Promise<void>;
+}

package/services/IntegrationService.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntegrationService = void 0;
+const api_1 = require("../constants/api");
+const models_1 = require("../models");
+const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
+const RocosLogger_1 = require("../logger/RocosLogger");
+const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
+/**
+ * Integrations to retrieve data from the linked project in DroneDeploy
+ */
+class IntegrationService extends BaseServiceAbstract_1.BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger_1.RocosLogger.getInstance(`IntegrationService(${this.config.url})`);
+    }
+    getStatus() {
+        return true;
+    }
+    getError(e) {
+        return new models_1.RocosError(e, models_1.errorCodes.INTEGRATIONS_SERVICE_ERROR);
+    }
+    /**
+     * Gets latest plans from the project linked to the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    async getPlans(projectId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_DD_INTEGRATION_PLANS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get plans.');
+    }
+    /**
+     * Gets the plans from the project linked to the provided project ID
+     * @param projectId Project ID
+     * @param pageStart Page start
+     * @returns Plans list (limited to 50) with cursor to next page when available
+     */
+    async getPlansPaged(projectId, pageStart) {
+        var _a;
+        const params = pageStart ? { page_start: pageStart } : undefined;
+        const response = await this.callGet(formatServiceUrl_1.formatServiceUrl(`${api_1.API_DD_INTEGRATION_PLANS_URL}`, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get plans.', params, { responseType: 'raw' });
+        const pageNext = (_a = response.headers.get('x-dd-page-next')) !== null && _a !== void 0 ? _a : undefined;
+        const plans = await response.json();
+        return {
+            plans,
+            pageNext,
+        };
+    }
+    /**
+     * Gets a plan for a given project (using its linked project)
+     * @param projectId Project ID
+     * @param planId Requested plan
+     * @returns A single plan
+     */
+    async getPlanById(projectId, planId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_DD_INTEGRATION_PLAN_BY_ID_URL, { url: this.config.url, projectId, planId }, this.config.insecure), 'Failed to get plan.');
+    }
+    /**
+     * Returns raster overlays such as drawings to be used for mission planning
+     * @param projectId Project ID
+     * @returns A list of overlays in the project
+     */
+    async getOverlays(projectId) {
+        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_DD_INTEGRATION_OVERLAYS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get overlays.');
+    }
+    /**
+     * Creates a blank issue in the latest ortho plan available
+     * @param projectId Project ID
+     * @param location Location of the issue
+     */
+    async createIssue(projectId, location) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_DD_INTEGRATION_ISSUES_URL, { url: this.config.url, projectId }, this.config.insecure), {
+            lat: location.lat,
+            lng: location.lng,
+        }, 'Failed to create issue.');
+    }
+}
+exports.IntegrationService = IntegrationService;

package/services/MapService.d.ts

@@ -0,0 +1,96 @@
+import { IBaseService, IRocosSDKConfig, Map, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+/**
+ * Integrations to retrieve data from the linked project in DroneDeploy
+ */
+export declare class MapService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    /**
+     * List maps from the cloud
+     *
+     * @param projectId Project ID
+     * @returns All maps in the cloud
+     */
+    list(projectId: string): Promise<Map[]>;
+    /**
+     * List maps from the robot and the cloud
+     *
+     * if onlyRobot is true, only the maps from the robot will be returned
+     *
+     * @param projectId Project ID
+     * @param callsign Robot callsign
+     * @param options Options to filter the maps
+     * @returns All maps in the cloud
+     */
+    list(projectId: string, callsign: string, options?: {
+        onlyRobot: boolean;
+    }): Promise<Map[]>;
+    /**
+     * Creates a new DB for the project if it's missing
+     *
+     * has no effect if the DB already exists
+     *
+     * @param projectId Project ID
+     */
+    initDB(projectId: string): Promise<void>;
+    /**
+     * 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
+     */
+    merge(projectId: string, maps: [string, string], options: {
+        name: string;
+        description?: string;
+        callsign: string;
+    }): Promise<void>;
+    /**
+     * Updates a maps metadata
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options New metadata
+     */
+    update(projectId: string, mapId: string, options: {
+        name: string;
+        description?: string;
+        callsign?: string;
+    }): Promise<void>;
+    /**
+     * Copies a map from a robot to the cloud
+     *
+     * @see copyFromCloud
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param callsign Robot callsign
+     */
+    copyFromRobot(projectId: string, mapId: string, callsign: string): Promise<void>;
+    /**
+     * Deletes a map from the cloud
+     * @param projectId
+     * @param mapId
+     */
+    delete(projectId: string, mapId: string): Promise<void>;
+    /**
+     * Deletes a map from the cloud and attempts to delete it from the robot
+     * @param projectId
+     * @param mapId
+     * @param callsign
+     */
+    delete(projectId: string, mapId: string, callsign: string): Promise<void>;
+    /**
+     * Makes a copy of a map stored in the cloud
+     *
+     * @see copyFromRobot
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options Options to create the new map
+     */
+    copyFromCloud(projectId: string, mapId: string, options: {
+        name: string;
+        description?: string;
+    }): Promise<void>;
+}

package/services/MapService.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapService = void 0;
+const api_1 = require("../constants/api");
+const models_1 = require("../models");
+const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
+const RocosLogger_1 = require("../logger/RocosLogger");
+const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
+/**
+ * Integrations to retrieve data from the linked project in DroneDeploy
+ */
+class MapService extends BaseServiceAbstract_1.BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger_1.RocosLogger.getInstance(`MapService(${this.config.url})`);
+    }
+    getStatus() {
+        return true;
+    }
+    getError(e) {
+        return new models_1.RocosError(e, models_1.errorCodes.MAPS_SERVICE_ERROR);
+    }
+    async list(projectId, callsign, options) {
+        var _a;
+        const resp = await this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_MAPS_URL, {
+            url: this.config.url,
+            projectId,
+        }, this.config.insecure), 'Failed to get maps.', callsign ? { callsign, onlyRobot: (_a = options === null || options === void 0 ? void 0 : options.onlyRobot) !== null && _a !== void 0 ? _a : false } : undefined);
+        return resp.maps;
+    }
+    /**
+     * Creates a new DB for the project if it's missing
+     *
+     * has no effect if the DB already exists
+     *
+     * @param projectId Project ID
+     */
+    async initDB(projectId) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_MAPS_INIT_DB_URL, {
+            url: this.config.url,
+            projectId,
+        }, this.config.insecure), undefined, 'Failed to init DB.');
+    }
+    /**
+     * 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_1.formatServiceUrl(api_1.API_MAPS_MERGE_URL, {
+            url: this.config.url,
+            projectId,
+        }, this.config.insecure), payload, 'Failed to merge maps.');
+    }
+    /**
+     * 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_1.formatServiceUrl(api_1.API_MAP_ID_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), options, 'Failed to update map.');
+    }
+    /**
+     * Copies a map from a robot to the cloud
+     *
+     * @see copyFromCloud
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param callsign Robot callsign
+     */
+    async copyFromRobot(projectId, mapId, callsign) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_MAP_ID_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), { callsign }, 'Failed to copy map from robot.');
+    }
+    async delete(projectId, mapId, callsign) {
+        return this.callDelete(formatServiceUrl_1.formatServiceUrl(api_1.API_MAP_ID_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), 'Failed to delete map.', callsign ? { callsign } : {});
+    }
+    /**
+     * Makes a copy of a map stored in the cloud
+     *
+     * @see copyFromRobot
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options Options to create the new map
+     */
+    async copyFromCloud(projectId, mapId, options) {
+        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_MAPS_COPY_URL, {
+            url: this.config.url,
+            projectId,
+            mapId,
+        }, this.config.insecure), options, 'Failed to copy map.');
+    }
+}
+exports.MapService = MapService;

package/services/PlatformTimeService.d.ts

@@ -0,0 +1,35 @@
+import { Logger } from 'loglevel';
+import { TimeSyncerService } from './TimeSyncerService';
+export interface IPlatformTime {
+    now: number;
+    duration: number;
+}
+export interface IPlatformTimeMeasurement {
+    clientTimeStampEnd: number;
+    clientTimeStampStart: number;
+    serverTime: IPlatformTime;
+}
+export declare class PlatFormTimeService {
+    protected static instance: PlatFormTimeService;
+    protected backoffTimeouts: number[];
+    protected isSyncing: boolean;
+    protected backoffFailCount: number;
+    protected serverTimeOffset: number;
+    protected lastPlatformTimeSyncedAt: number;
+    protected timeSyncerService: TimeSyncerService;
+    protected logger: Logger;
+    protected constructor(timeSyncerService: TimeSyncerService);
+    static getInstance(timeSyncerService?: TimeSyncerService): PlatFormTimeService;
+    get platformTimeOffset(): number;
+    get platformTime(): number;
+    private getClockOffsetBetweenClientAndServer;
+    private getPlatformTime;
+    protected handleServerTimeNotReliable(): void;
+    private backoff;
+    protected isReliableServerTime(platformTimeMeasurements: IPlatformTimeMeasurement[]): boolean;
+    private handleGetServerTimeError;
+    protected calculateOffset(platformTimeMeasurements: IPlatformTimeMeasurement[]): number;
+    private saveOffset;
+    protected removeLongestAndShortest(serverTimeMeasurements: IPlatformTimeMeasurement[]): IPlatformTimeMeasurement[];
+    private getServerTime;
+}