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

package/services/EventService.d.ts

@@ -0,0 +1,53 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class EventService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get event definitions for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param includeCounts - Counter
+     * @description - Renamed from getEventDefinitions
+     */
+    getDefinitions(projectId: string, callsign: string, includeCounts?: number): Promise<any>;
+    /**
+     * Add event definitions for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     * @description - Renamed from AddEventDefinitions
+     */
+    addDefinitions(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get history for an event
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param eventDefinitionId - Event Definition Id
+     * @description - Renamed from getEventHistory
+     */
+    getHistory(projectId: string, callsign: string, eventDefinitionId: string): Promise<any>;
+    /**
+     * Get events for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetEventDefinitions
+     */
+    getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update events for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefAddEventDefinitions
+     */
+    addDefinitionsForRobotDef(projectId: string, definitionId: string, model: any): Promise<any>;
+}

package/services/EventService.js

@@ -0,0 +1,85 @@
+import { API_PROJECT_DEFINITION_EVENT_URL, API_PROJECT_ROBOT_EVENT_HISTORY_URL, API_PROJECT_ROBOT_EVENT_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class EventService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`EventService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.EVENT_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Get event definitions for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param includeCounts - Counter
+     * @description - Renamed from getEventDefinitions
+     */
+    // TODO: map the response object
+    async getDefinitions(projectId, callsign, includeCounts = 0) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_EVENT_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get event definitions list for ${projectId}, callsign  ${callsign}.`, { includeCounts });
+    }
+    /**
+     * Add event definitions for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     * @description - Renamed from AddEventDefinitions
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async addDefinitions(projectId, callsign, model) {
+        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_EVENT_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to add event definitions for ${projectId}, callsign ${callsign}.`);
+    }
+    /**
+     * Get history for an event
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param eventDefinitionId - Event Definition Id
+     * @description - Renamed from getEventHistory
+     */
+    // TODO: map the response object
+    async getHistory(projectId, callsign, eventDefinitionId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_EVENT_HISTORY_URL, {
+            url: this.config.url,
+            projectId,
+            callsign,
+            eventDefinitionId,
+        }, this.config.insecure), `Failed to get event history for ${projectId}, callsign ${callsign}, eventDefinitionId ${eventDefinitionId}.`);
+    }
+    /**
+     * Get events for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetEventDefinitions
+     */
+    // TODO: map the response object
+    async getDefinitionsForRobotDef(projectId, definitionId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get event definitions list for ${projectId}, definitionId ${definitionId}.`);
+    }
+    /**
+     * Update events for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefAddEventDefinitions
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async addDefinitionsForRobotDef(projectId, definitionId, model) {
+        return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update event definitions for ${projectId}, definitionId ${definitionId}.`);
+    }
+}

package/services/FileAccessorService.d.ts

@@ -0,0 +1,11 @@
+import { IFileAccessorParams, IFileAccessorReqOpParams, IFileAccessorStream, IRocosOpResultMessage, IRocosSDKConfig, IStreamConfig } from '../models';
+import { BaseStreamService } from './BaseStreamService';
+export declare class FileAccessorService extends BaseStreamService<IFileAccessorStream> {
+    constructor(config: IRocosSDKConfig);
+    serverReqOp(params: IFileAccessorReqOpParams): Promise<IRocosOpResultMessage[]>;
+    listFolder(params: IFileAccessorParams): Promise<IRocosOpResultMessage[]>;
+    downloadFile(params: IFileAccessorParams): Promise<IRocosOpResultMessage[]>;
+    getDownloadFileLinkByUsingBlob(params: IFileAccessorParams): Promise<any>;
+    protected createStream(): Promise<IFileAccessorStream>;
+    protected getStream(config: IStreamConfig): IFileAccessorStream;
+}

package/services/FileAccessorService.js

@@ -0,0 +1,37 @@
+import { BaseStreamService } from './BaseStreamService';
+import { FileAccessorStream } from '../api/streams/fileAccessor/FileAccessorStream';
+import { IDENTIFIER_NAME_FILE_ACCESSOR } from '../constants/identifier';
+export class FileAccessorService extends BaseStreamService {
+    constructor(config) {
+        super('FileAccessorService', config);
+    }
+    async serverReqOp(params) {
+        const stream = await this.createStream();
+        return stream.serverReqOp(params);
+    }
+    async listFolder(params) {
+        const stream = await this.createStream();
+        return stream.listFolder(params);
+    }
+    async downloadFile(params) {
+        const stream = await this.createStream();
+        return stream.downloadFile(params);
+    }
+    async getDownloadFileLinkByUsingBlob(params) {
+        const stream = await this.createStream();
+        return stream.getDownloadFileLinkByUsingBlob(params);
+    }
+    async createStream() {
+        return (await this.createStreamFromConfig(IDENTIFIER_NAME_FILE_ACCESSOR, {
+            url: this.config.url,
+            token: this.config.token,
+            scope: 'default',
+            options: this.config.options,
+            port: this.config.port,
+            insecure: this.config.insecure,
+        })).stream;
+    }
+    getStream(config) {
+        return new FileAccessorStream(config);
+    }
+}

package/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/services/FileAccessorServiceNode.js

@@ -0,0 +1,7 @@
+import { FileAccessorService } from './FileAccessorService';
+import { FileAccessorStreamNode } from '../api/streams/fileAccessor/FileAccessorStreamNode';
+export class FileAccessorServiceNode extends FileAccessorService {
+    getStream(config) {
+        return new FileAccessorStreamNode(config);
+    }
+}

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,99 @@
+import { API_PROJECT_EXPORT_URL, API_PROJECT_FUNCTION_ID_URL, API_PROJECT_FUNCTION_POD_URL, API_PROJECT_FUNCTION_RUN_URL, API_PROJECT_FUNCTION_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { ExportDataQuery } from '../models/ExportDataQuery';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class FunctionService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`FunctionService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, 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(API_PROJECT_EXPORT_URL, { url: this.config.url, projectId }, this.config.insecure), new 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(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(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(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(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(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(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(API_PROJECT_FUNCTION_POD_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to ged function pods for ${projectId}, functionId ${functionId}.`);
+    }
+}

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,72 @@
+import { API_DD_INTEGRATION_ISSUES_URL, API_DD_INTEGRATION_OVERLAYS_URL, API_DD_INTEGRATION_PLANS_URL, API_DD_INTEGRATION_PLAN_BY_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 IntegrationService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`IntegrationService(${this.config.url})`);
+    }
+    getStatus() {
+        return true;
+    }
+    getError(e) {
+        return new RocosError(e, 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(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) {
+        const params = pageStart ? { page_start: pageStart } : undefined;
+        const response = await this.callGet(formatServiceUrl(`${API_DD_INTEGRATION_PLANS_URL}`, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get plans.', params, { responseType: 'raw' });
+        const pageNext = response.headers.get('x-dd-page-next') ?? 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(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(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(API_DD_INTEGRATION_ISSUES_URL, { url: this.config.url, projectId }, this.config.insecure), {
+            lat: location.lat,
+            lng: location.lng,
+        }, 'Failed to create issue.');
+    }
+}

package/services/MapService.d.ts

@@ -0,0 +1,109 @@
+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
+     *
+     * @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: {
+        name: string;
+        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: {
+        name: string;
+        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
+     */
+    getGeoJSON(projectId: string, mapId: string): Promise<unknown>;
+}