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

package/esm/services/FileAccessorServiceNode.d.ts

@@ -0,0 +1,6 @@
+import { FileAccessorService } from './FileAccessorService';
+import { IFileAccessorStream } from '../models/stream/IFileAccessorStream';
+import { IStreamConfig } from '../models/IStreamConfig';
+export declare class FileAccessorServiceNode extends FileAccessorService {
+    protected getStream(config: IStreamConfig): IFileAccessorStream;
+}

package/esm/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/esm/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/esm/services/MapService.d.ts

@@ -0,0 +1,142 @@
+import { IBaseService, IRocosSDKConfig, Map, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { Observation } from '../models/maps/Panorama';
+/**
+ * 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
+     *
+     * @param projectId Project ID
+     * @param callsign Robot callsign
+     * @returns All maps in the cloud
+     */
+    list(projectId: string, callsign: string): Promise<Map[]>;
+    /** List maps to be deployed to a callsign
+     *
+     * @param projectId
+     * @param callsign
+     */
+    listDeployedMaps(projectId: string, callsign: string): Promise<Map[]>;
+    /**
+     * 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>;
+    /** Returns a map in its canonical form
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     */
+    get(projectId: string, mapId: string): Promise<Map>;
+    /**
+     * Updates a maps metadata
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options New metadata
+     */
+    update(projectId: string, mapId: string, options: {
+        description?: string;
+        callsign?: string;
+    }): Promise<void>;
+    /**
+     * Begins uploading a map from the agent
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param callsign Robot callsign
+     * @param hash Map hash
+     */
+    sendToCloud(projectId: string, mapId: string, callsign: string, hash: string): Promise<void>;
+    /**
+     * Deletes a map from the cloud and all agents
+     * @param projectId
+     * @param mapId
+     */
+    delete(projectId: string, mapId: string): Promise<void>;
+    /**
+     * Deletes a map from a single agent.
+     *
+     * If the callsign does not have the map deployed, any local copy of the map will be deleted.
+     *
+     * @param projectId
+     * @param mapId
+     * @param callsign
+     * @param hash
+     */
+    delete(projectId: string, mapId: string, callsign: string, hash: string): Promise<void>;
+    /**
+     * Makes a copy of an uploaded map
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param options Options to create the new map
+     */
+    copy(projectId: string, mapId: string, options: {
+        description?: string;
+    }): Promise<void>;
+    /** Deploy a map from the cloud to a robot
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param callsign Robot callsign
+     */
+    deploy(projectId: string, mapId: string, callsign: string): Promise<void>;
+    /** Get a GeoJSON representation of a map
+     *
+     * @param projectId Project ID
+     * @param mapId Map ID
+     * @param frameId Frame ID (optional)
+     */
+    getGeoJSON(projectId: string, mapId: string, frameId?: string): Promise<unknown>;
+    /**
+     * Returns a Promise that resolves to an array of Observation objects for the given panorama ID.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to retrieve observations for.
+     * @returns A Promise that resolves to an array of Observation objects.
+     */
+    listObservations(projectId: string, panoramaId: string): Promise<Observation[]>;
+    /**
+     * Creates new observations on a panorama.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to create observations for.
+     * @param observations An array of Observation objects to create.
+     * @returns A Promise that resolves when the observations have been created.
+     */
+    createObservations(projectId: string, panoramaId: string, observations: Observation[]): Promise<void>;
+    /**
+     * Gets observations for a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @param key (optional) Filters on a key defined on the observation
+     * @param frameID (optional) Transforms on a seed frame
+     * @returns A list of observations
+     */
+    getObservations(projectId: string, key?: string, frameID?: string): Promise<Observation[]>;
+    /**
+     * Lists available keys for all observations in a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @returns A list of observations
+     */
+    getObservationsKeys(projectId: string): Promise<string[]>;
+}

package/esm/services/MapService.js

@@ -0,0 +1,192 @@
+import { API_MAPS_COPY_URL, API_MAPS_DEPLOYED_URL, API_MAPS_DEPLOY_URL, API_MAPS_GEOJSON_URL, API_MAPS_MERGE_URL, API_MAPS_PANORAMA_OBSERVATIONS_URL, API_MAPS_URL, API_MAP_ID_URL, API_OBSERVATIONS_URL, API_OBSERVATION_KEYS_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);
+    }
+    /**
+     * Returns a Promise that resolves to an array of Observation objects for the given panorama ID.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to retrieve observations for.
+     * @returns A Promise that resolves to an array of Observation objects.
+     */
+    listObservations(projectId, panoramaId) {
+        return this.callGet(formatServiceUrl(API_MAPS_PANORAMA_OBSERVATIONS_URL, { url: this.config.url, projectId, panoramaId }, this.config.insecure), 'Failed to list observations.');
+    }
+    /**
+     * Creates new observations on a panorama.
+     *
+     * @param projectId The ID of the project the panorama belongs to.
+     * @param panoramaId The ID of the panorama to create observations for.
+     * @param observations An array of Observation objects to create.
+     * @returns A Promise that resolves when the observations have been created.
+     */
+    createObservations(projectId, panoramaId, observations) {
+        return this.callPut(formatServiceUrl(API_MAPS_PANORAMA_OBSERVATIONS_URL, { url: this.config.url, projectId, panoramaId }, this.config.insecure), observations, 'Failed to update observations.');
+    }
+    /**
+     * Gets observations for a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @param key (optional) Filters on a key defined on the observation
+     * @param frameID (optional) Transforms on a seed frame
+     * @returns A list of observations
+     */
+    getObservations(projectId, key = '', frameID = '') {
+        return this.callGet(formatServiceUrl(API_OBSERVATIONS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get observations.', { key, frameID });
+    }
+    /**
+     * Lists available keys for all observations in a project.
+     *
+     * @param projectId The ID of the project the observations belongs to.
+     * @returns A list of observations
+     */
+    getObservationsKeys(projectId) {
+        return this.callGet(formatServiceUrl(API_OBSERVATION_KEYS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get observation keys.');
+    }
+}

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