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

package/esm/services/ConfigGroupService.d.ts

@@ -0,0 +1,89 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IConfigGroup } from '../models/IConfigGroup';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class ConfigGroupService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Create a config group
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param model - Payload {@link IConfigGroup}
+     */
+    create(projectId: string, type: string, model: IConfigGroup): Promise<any>;
+    /**
+     * Get a config group list
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     */
+    list(projectId: string, type: string): Promise<any>;
+    /**
+     * Update a config group
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param model - Payload {@link IConfigGroup}
+     */
+    update(projectId: string, type: string, configGroupId: string, model: IConfigGroup): Promise<any>;
+    /**
+     * Get a config group
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     */
+    info(projectId: string, type: string, configGroupId: string): Promise<any>;
+    /**
+     * Publish a config group
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param model - Payload {@link IConfigGroup}
+     */
+    publish(projectId: string, type: string, configGroupId: string, model: IConfigGroup): Promise<any>;
+    /**
+     * Update a config
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param configId - Config Id
+     * @param content - Payload
+     */
+    updateConfig(projectId: string, type: string, configGroupId: string, configId: string, content: any): Promise<any>;
+    /**
+     * Get a config group by version
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param version - Version
+     */
+    getByVersion(projectId: string, type: string, configGroupId: string, version: string): Promise<any>;
+    /**
+     * Override a config for owner
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param ownerId - Override Id
+     * @param content - Payload
+     */
+    overrideByOwnerId(projectId: string, type: string, configGroupId: string, ownerId: string, content: any): Promise<any>;
+    /**
+     * Get an override config for owner
+     *
+     * @param projectId - Project Id
+     * @param type - Config group type
+     * @param configGroupId - Config group Id
+     * @param ownerId - Override Id
+     */
+    getOverrideConfig(projectId: string, type: string, configGroupId: string, ownerId: string): Promise<any>;
+}

package/esm/services/ControlService.d.ts

@@ -0,0 +1,11 @@
+import { ControlActionType, IControlParams, IControlStream, IRocosControlMessage, IRocosSDKConfig, IStreamConfig } from '../models';
+import { Observable } from 'rxjs';
+import { BaseStreamService } from './BaseStreamService';
+export declare class ControlService extends BaseStreamService<IControlStream> {
+    constructor(config: IRocosSDKConfig);
+    takeActionWithAck(action: ControlActionType, params: IControlParams, ackTimeoutInSeconds?: number): Observable<string>;
+    sendCommand(params: IControlParams): Promise<void>;
+    sendCommandWithAck(params: IControlParams): Observable<IRocosControlMessage>;
+    protected createStream(): Promise<IControlStream>;
+    protected getStream(config: IStreamConfig): IControlStream;
+}

package/esm/services/ControlServiceNode.d.ts

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

package/esm/services/DashboardService.d.ts

@@ -0,0 +1,97 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { IWidget } from '../models/IWidget';
+export declare class DashboardService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get dashboard info.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     */
+    info(projectId: string, dashboardId: string): Promise<any>;
+    /**
+     * Create a dashboard widget.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     * @param widget - Widget payload {@link IWidget}
+     */
+    createWidget(projectId: string, dashboardId: string, widget: IWidget): Promise<any>;
+    /**
+     * Delete dashboard widgets.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     * @param widgetIds - List of widget Id's
+     */
+    deleteWidgets(projectId: string, dashboardId: string, widgetIds: string[]): Promise<any>;
+    /**
+     * Get collection documents.
+     *
+     * @param projectId - Project Id
+     * @param collectionId - Collection Id
+     */
+    getDocs(projectId: string, collectionId: string): Promise<any>;
+    /**
+     * Create a document.
+     *
+     * @param projectId - Project Id
+     * @param collectionId - Collection Id
+     * @param doc - Document payload
+     */
+    createDoc(projectId: string, collectionId: string, doc: any): Promise<any>;
+    /**
+     * Delete documents.
+     *
+     * @param projectId - Project Id
+     * @param collectionId - Collection Id
+     * @param docIds - List of document Id's
+     */
+    deleteDocs(projectId: string, collectionId: string, docIds: string[]): Promise<any>;
+    /**
+     * Create a dashboard
+     *
+     * @param projectId - Project Id
+     */
+    createProjectDashboard(projectId: string): Promise<any>;
+    /**
+     * Update the dashboard with widgets.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     * @param widgets - Array of Widgets as payload {@link IWidget}
+     */
+    updateProjectDashboard(projectId: string, dashboardId: string, widgets: IWidget[]): Promise<any>;
+    /**
+     * Delete a dashboard.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     */
+    deleteProjectDashboard(projectId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get the dashboard
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     */
+    getProjectDashboard(projectId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get all dashboards fora project.
+     *
+     * @param projectId - Project Id
+     */
+    getProjectDashboardList(projectId: string): Promise<any>;
+    /**
+     * Get all custom widgets for a dashboard.
+     *
+     * @param projectId - Project Id
+     * @param dashboardId - Dashboard Id
+     */
+    getProjectDashboardCustomWidget(projectId: string, dashboardId: string): Promise<any>;
+}

package/esm/services/DeviceCredentialsService.d.ts

@@ -0,0 +1,15 @@
+import { DeviceCredentialAuth, DeviceCredentialAuthResult, DeviceCredentialCreate, DeviceCredentials } from '../models/device-credentials/DeviceCredentials';
+import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+/**
+ * Manage external devices authenticating with the platform
+ */
+export declare class DeviceCredentialsService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    list(projectId: string, callsign: string): Promise<DeviceCredentials>;
+    create(projectId: string, callsign: string, credentials: DeviceCredentialCreate): Promise<DeviceCredentialCreate>;
+    delete(projectId: string, callsign: string, component: string, system: string): Promise<void>;
+    auth(credentials: DeviceCredentialAuth): Promise<DeviceCredentialAuthResult>;
+}

package/esm/services/DeviceCredentialsService.js

@@ -0,0 +1,46 @@
+import { API_DEVICE_CREDENTIALS_AUTH_URL, API_DEVICE_CREDENTIALS_URL } from '../constants/api';
+import { RocosError, errorCodes } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+/**
+ * Manage external devices authenticating with the platform
+ */
+export class DeviceCredentialsService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`DeviceCredentials(${this.config.url})`);
+    }
+    getStatus() {
+        return true;
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.DEVICE_CREDENTIALS_SERVICE_ERROR);
+    }
+    list(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_DEVICE_CREDENTIALS_URL, {
+            url: this.config.url,
+            projectId,
+            callsign,
+        }, this.config.insecure), 'Failed to get device credentials.');
+    }
+    create(projectId, callsign, credentials) {
+        return this.callPost(formatServiceUrl(API_DEVICE_CREDENTIALS_URL, {
+            url: this.config.url,
+            projectId,
+            callsign,
+        }, this.config.insecure), credentials, 'Failed to create device credentials.');
+    }
+    delete(projectId, callsign, component, system) {
+        return this.callDelete(formatServiceUrl(API_DEVICE_CREDENTIALS_URL, {
+            url: this.config.url,
+            projectId,
+            callsign,
+        }, this.config.insecure), 'Failed to delete device credentials.', { component, system });
+    }
+    auth(credentials) {
+        return this.callPost(formatServiceUrl(API_DEVICE_CREDENTIALS_AUTH_URL, {
+            url: this.config.url,
+        }, this.config.insecure), credentials, 'Failed to delete device credentials.');
+    }
+}

package/esm/services/EvaluatorService.d.ts

@@ -0,0 +1,11 @@
+import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RunCodeOptions } from '../helpers/websandbox/sandbox';
+export declare class EvaluatorService extends BaseServiceAbstract implements IBaseService {
+    private readonly sandbox;
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    teardown(): Promise<void>;
+    execute<T = unknown>(code: string | (() => T), context?: unknown, options?: RunCodeOptions): Promise<T>;
+}

package/esm/services/EvaluatorService.js

@@ -0,0 +1,28 @@
+import { RocosError, errorCodes } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { WebSandbox } from '../helpers';
+export class EvaluatorService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`EvaluatorService(${this.config.url})`);
+        this.sandbox = WebSandbox.new().catch((e) => {
+            this.logger.error('Failed to create WebSandbox', e);
+            throw e;
+        });
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.EVALUATOR_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    async teardown() {
+        const sandbox = await this.sandbox;
+        sandbox.destroy('evaluator service torn down');
+    }
+    async execute(code, context, options) {
+        const sandbox = await this.sandbox;
+        return sandbox.run(code, context, options);
+    }
+}

package/esm/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/esm/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/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/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';
+/**
+ * Maps service for managing robot maps in the cloud and on robots
+ */
+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[]>;
+}