@dronedeploy/rocos-js-sdk 3.0.1-alpha.3 → 3.0.1-alpha.6

package/services/AssetStorageService.js

@@ -1,169 +0,0 @@
-import { API_PROJECT_ASSET_PATH_URL, API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_URL, API_PROJECT_FLOW_ASSET_PATH_URL, API_PROJECT_MISSION_ASSETS_PATH_URL, API_PROJECT_MISSION_ASSET_PATH_URL, API_PROJECT_ROBOT_ASSET_PATH_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 AssetStorageService extends BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`AssetStorageService(${this.config.url})`);
-    }
-    getError(e) {
-        return new RocosError(e, errorCodes.ASSET_STORAGE_SERVICE_ERROR);
-    }
-    getStatus() {
-        return true;
-    }
-    /**
-     * Create a new project asset
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     * @param file - File payload
-     */
-    // TODO: map the response object
-    async create(projectId, filePath, file) {
-        const formData = new FormData();
-        formData.append('file', file);
-        return this.callPut(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to create asset for ${projectId}, filePath ${filePath}.`);
-    }
-    /**
-     * Update a project asset
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     * @param file - File payload
-     */
-    // TODO: map the response object
-    async update(projectId, filePath, file) {
-        const formData = new FormData();
-        formData.append('file', file);
-        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to update asset for ${projectId}, filePath ${filePath}.`);
-    }
-    /**
-     * Delete a project asset
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     */
-    // TODO: map the response object
-    async delete(projectId, filePath) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to delete asset for ${projectId}, filePath ${filePath}.`);
-    }
-    /**
-     * Lost assets for a project or project file path
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     */
-    // TODO: map the response object
-    async list(projectId, filePath) {
-        let url = '';
-        if (filePath) {
-            url = formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure);
-        }
-        else {
-            url = formatServiceUrl(API_PROJECT_ASSET_URL, { url: this.config.url, projectId }, this.config.insecure);
-        }
-        return this.callGet(url, `Failed to get asset list for ${projectId}, filePath ${filePath}.`);
-    }
-    /**
-     * Get a project asset
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     */
-    // TODO: map the response object
-    async getAsset(projectId, filePath) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
-            responseType: 'blob',
-        });
-    }
-    /**
-     * List assets for a robot
-     *
-     * @param projectId
-     * @param callsign
-     * @param parent
-     * @param signedURL
-     */
-    async listRobotAssets(projectId, callsign, parent = '/', signedURL = false) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_ASSET_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, { parent, signedURL });
-    }
-    /**
-     * List assets for a flow
-     *
-     * @param projectId
-     * @param flowId
-     * @param flowInstance
-     * @param parent
-     * @param signedURL
-     */
-    async listFlowAssets(projectId, flowId, flowInstance, parent = '/', signedURL = false) {
-        return this.callGet(formatServiceUrl(API_PROJECT_FLOW_ASSET_PATH_URL, { url: this.config.url, projectId, flowId, flowInstance }, this.config.insecure), `Failed to get asset for ${projectId}, flow ${flowId}, flow instance ${flowInstance}.`, { parent, signedURL });
-    }
-    /**
-     * List assets for a mission
-     *
-     * @param projectId
-     * @param assetIdList
-     */
-    async listMissionAssets(projectId, assetIdList) {
-        const searchParams = new URLSearchParams();
-        assetIdList.forEach((assetId) => searchParams.append('assetID', assetId));
-        return this.callGet(formatServiceUrl(API_PROJECT_MISSION_ASSETS_PATH_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get asset for ${projectId}, assetIdList ${assetIdList}.`, searchParams);
-    }
-    /**
-     * Get a single asset for a mission
-     *
-     * @param projectId
-     * @param assetId
-     */
-    async getMissionAsset(projectId, assetId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_MISSION_ASSET_PATH_URL, { url: this.config.url, projectId, assetId }, this.config.insecure), `Failed to get asset for ${projectId}, dataUUID ${assetId}.`, undefined);
-    }
-    /**
-     * Set Robot Sync Definitions
-     * @param projectId
-     * @param callsign
-     * @param definition
-     */
-    setRobotSyncDefinitions(projectId, callsign, definition) {
-        const httpOptions = {
-            headers: {
-                'content-type': 'application/json',
-            },
-        };
-        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
-    }
-    /**
-     * Get Robot Sync Definitions
-     * @param projectId
-     * @param callsign
-     */
-    getRobotSyncDefinitions(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, undefined);
-    }
-    /**
-     * Set Profile Sync Definitions
-     * @param projectId
-     * @param profileId
-     * @param definition
-     */
-    setProfileSyncDefinitions(projectId, profileId, definition) {
-        const httpOptions = {
-            headers: {
-                'content-type': 'application/json',
-            },
-        };
-        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), definition, `Failed to update sync-definition for ${projectId}, callsign ${profileId}.`, httpOptions);
-    }
-    /**
-     * Get Profile Sync Definitions
-     * @param projectId
-     * @param profileId
-     */
-    getProfileSyncDefinition(projectId, profileId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), `Failed to get sync-definition for ${projectId}, callsign ${profileId}.`, undefined);
-    }
-}

package/services/BaseStreamService.js

@@ -1,47 +0,0 @@
-import { SubscriberStatusEnum, Token } from '../models';
-import { RocosLogger } from '../logger/RocosLogger';
-import { RocosStore } from '../store/RocosStore';
-import { StreamRegister } from '../api/StreamRegister';
-import { Subject } from 'rxjs';
-export class BaseStreamService {
-    constructor(name, config) {
-        this.status = false;
-        this.status$ = new Subject();
-        this.config = config;
-        this.logger = RocosLogger.getInstance(`${name}(${this.config.url})`);
-    }
-    getStatus() {
-        return this.status;
-    }
-    async initStream(stream) {
-        const authService = RocosStore.getSDKInstance(this.config).getAuthService();
-        if (!this.config.token || !authService.isTokenValid(new Token(this.config.token))) {
-            try {
-                const token = await authService.getToken();
-                stream.setToken(token.value);
-            }
-            catch (e) {
-                this.logger.error('Can not retrieve auth token', e);
-                throw new Error('Can not retrieve auth token');
-            }
-        }
-        authService.startTokenRefreshChecker();
-    }
-    async createStreamFromConfig(identifier, config) {
-        const identifierWithScope = StreamRegister.getIdentifier(identifier);
-        const streamRegister = StreamRegister.getInstance();
-        let stream = streamRegister.getStream(identifierWithScope);
-        let isNew = false;
-        if (!stream) {
-            isNew = true;
-            stream = this.getStream(config);
-            stream.statusStream$.subscribe((msg) => {
-                this.status = msg === SubscriberStatusEnum.STOPPED || msg === SubscriberStatusEnum.ALIVE;
-                this.status$.next(msg);
-            });
-            await streamRegister.addStream(stream);
-            await this.initStream(stream);
-        }
-        return { stream, isNew };
-    }
-}

package/services/CallerService.d.ts

@@ -1,10 +0,0 @@
-import { ICallerInvokeParams, ICallerParams, ICallerStream, IRocosCallerMessage, IRocosSDKConfig, IStreamConfig } from '../models';
-import { Observable } from 'rxjs';
-import { BaseStreamService } from './BaseStreamService';
-export declare class CallerService extends BaseStreamService<ICallerStream> {
-    constructor(config: IRocosSDKConfig);
-    invokeRequest(params: ICallerInvokeParams): Observable<IRocosCallerMessage>;
-    cancelRequest(params: ICallerParams): Observable<IRocosCallerMessage>;
-    protected createStream(): Promise<ICallerStream>;
-    protected getStream(config: IStreamConfig): ICallerStream;
-}

package/services/CallerService.js

@@ -1,53 +0,0 @@
-import { Subject } from 'rxjs';
-import { BaseStreamService } from './BaseStreamService';
-import { CallerStream } from '../api/streams/caller/CallerStream';
-import { IDENTIFIER_NAME_CALLER } from '../constants/identifier';
-import { finalize } from 'rxjs/operators';
-export class CallerService extends BaseStreamService {
-    constructor(config) {
-        super('CallerService', config);
-    }
-    invokeRequest(params) {
-        const subject = new Subject();
-        let subscription;
-        this.createStream()
-            .then((stream) => {
-            subscription = stream.invokeRequest(params).subscribe(subject);
-        })
-            .catch((e) => {
-            this.logger.info('invokeRequest error', e);
-            subject.error(e);
-        });
-        return subject.asObservable().pipe(finalize(() => {
-            subscription?.unsubscribe();
-        }));
-    }
-    cancelRequest(params) {
-        const subject = new Subject();
-        let subscription;
-        this.createStream()
-            .then((stream) => {
-            subscription = stream.cancelRequest(params).subscribe(subject);
-        })
-            .catch((e) => {
-            this.logger.info('invokeRequest error', e);
-            subject.error(e);
-        });
-        return subject.asObservable().pipe(finalize(() => {
-            subscription?.unsubscribe();
-        }));
-    }
-    async createStream() {
-        return (await this.createStreamFromConfig(IDENTIFIER_NAME_CALLER, {
-            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 CallerStream(config);
-    }
-}

package/services/MapService.d.ts

@@ -1,108 +0,0 @@
-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: {
-        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>;
-}

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/TelemetryService.d.ts

@@ -1,40 +0,0 @@
-import { Observable } from 'rxjs';
-import { CallsignStatus, IRocosSDKConfig, IRocosTelemetryMessage, IStreamStatusMessage, ITelemetryStream, ITelemetryStreamConfig, ITelemetrySubscriptionParams, ITelemetrySubscriptions } from '../models';
-import { BaseStreamService } from './BaseStreamService';
-export declare class TelemetryService extends BaseStreamService<ITelemetryStream, ITelemetryStreamConfig> {
-    private statusSubscription;
-    private changeStream$;
-    private streamStatusSubject$;
-    constructor(config: IRocosSDKConfig);
-    /**
-     * The main method for subscribing to telemetry messages
-     *
-     * @param params - Subscription params
-     *
-     * @returns An Observable that outputs telemetry messages
-     */
-    subscribe(params: ITelemetrySubscriptionParams): Observable<IRocosTelemetryMessage>;
-    /**
-     * A method to keep track of the current subscriptions
-     *
-     * @returns An Observable that outputs subscription changes
-     */
-    getSubscriptionChanges(): Observable<ITelemetrySubscriptions>;
-    /**
-     * A method to keep track of the stream status
-     *
-     * @returns An Observable that outputs stream status
-     */
-    getStatusChanges(): Observable<IStreamStatusMessage>;
-    /**
-     * Subscribes to the heartbeat telemetry and checks we receive one at least every 5s
-     * @param projectId
-     * @param callsign
-     * @param heartbeatTimeoutMs optionally override the deadline for heartbeats (in ms). Default 5000ms
-     * @param intervalMs optionally override the interval to check for heartbeats (in ms). Default 2000ms
-     */
-    getRobotStatusChanges(projectId: string, callsign: string, heartbeatTimeoutMs?: number, intervalMs?: number): Observable<CallsignStatus>;
-    protected initStream(stream: ITelemetryStream): Promise<void>;
-    private createStream;
-    protected getStream(config: ITelemetryStreamConfig): ITelemetryStream;
-}