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

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;
-}

package/services/TelemetryService.js

@@ -1,142 +0,0 @@
-import { BehaviorSubject, catchError, combineLatest, distinctUntilChanged, from, interval, map, mergeAll, of, startWith, } from 'rxjs';
-import { CallsignsLookup, CallsignsLookupType, CallsignStatus, errorCodes, RocosError, SubscriberStatusEnum, } from '../models';
-import { filter, finalize } from 'rxjs/operators';
-import { BaseStreamService } from './BaseStreamService';
-import { IDENTIFIER_NAME_TELEMETRY } from '../constants/identifier';
-import { RocosStore } from '../store/RocosStore';
-import { TelemetryStream } from '../api/streams/telemetry/TelemetryStream';
-import { arrayUnique } from '../helpers/arrayUnique';
-import { getUniqueId } from '../helpers/getUniqueId';
-const HEARTBEAT_SOURCE = '/rocos/agent/telemetry/heartbeat';
-const HEARTBEAT_TIMEOUT = 5000; // if no heartbeat within 5 seconds then the robot is considered dead
-export class TelemetryService extends BaseStreamService {
-    constructor(config) {
-        super('TelemetryService', config);
-        this.changeStream$ = new BehaviorSubject(new Map());
-        RocosStore.getChangeSubject()
-            .pipe(filter((message) => {
-            return message.type === 'telemetry-subscription' && message.url === this.config.url;
-        }))
-            .subscribe((msg) => {
-            this.changeStream$.next(msg.data);
-        });
-        this.streamStatusSubject$ = new BehaviorSubject({
-            scope: 'default',
-            status: SubscriberStatusEnum.STOPPED,
-        });
-    }
-    /**
-     * The main method for subscribing to telemetry messages
-     *
-     * @param params - Subscription params
-     *
-     * @returns An Observable that outputs telemetry messages
-     */
-    subscribe(params) {
-        const sources = arrayUnique(params.sources).map((item) => item.trim()) ?? [];
-        if (!params?.callsigns && params?.query) {
-            this.logger.error('Error: params need to contain either callsigns or query', params);
-            throw new RocosError('Params need to contain either callsigns or query.', errorCodes.TELEMETRY_SERVICE_ERROR);
-        }
-        let callsignsLookup = new CallsignsLookup([]);
-        if (params?.callsigns) {
-            this.logger.info('subscribe with callsigns', params);
-            callsignsLookup = new CallsignsLookup(params.callsigns);
-        }
-        else if (params?.query) {
-            this.logger.info('subscribe with query', params);
-            callsignsLookup = new CallsignsLookup(params.query);
-        }
-        const scope = params.scope ?? 'default';
-        const callsigns = callsignsLookup.lookupValue;
-        const subscriptionParams = {
-            uniqueId: getUniqueId(params.projectId, callsignsLookup, sources, scope),
-            callsigns: callsignsLookup?.lookupType === CallsignsLookupType.List ? callsignsLookup.lookupValue : [],
-            sources,
-        };
-        const stream = this.createStream(params.projectId, callsignsLookup, sources, scope).then((stream) => {
-            stream.addSubscription(subscriptionParams);
-            if (!this.statusSubscription) {
-                this.statusSubscription = stream.statusStream$.subscribe((msg) => {
-                    this.status = msg === SubscriberStatusEnum.STOPPED || msg === SubscriberStatusEnum.ALIVE;
-                    this.status$.next(msg);
-                });
-            }
-            return from(stream.messageStream$).pipe(finalize(() => stream?.removeSubscription(subscriptionParams, params.terminateReceiverGroupOnUnsubscribe)));
-        });
-        return from(stream).pipe(mergeAll(), filter((message) => {
-            return callsigns.includes(message.callsign) && sources.includes(message.source);
-        }));
-    }
-    /**
-     * A method to keep track of the current subscriptions
-     *
-     * @returns An Observable that outputs subscription changes
-     */
-    getSubscriptionChanges() {
-        return this.changeStream$.asObservable();
-    }
-    /**
-     * A method to keep track of the stream status
-     *
-     * @returns An Observable that outputs stream status
-     */
-    getStatusChanges() {
-        return this.streamStatusSubject$.asObservable();
-    }
-    /**
-     * 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, callsign, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
-        const startedAt = Date.now();
-        const heartbeatTime$ = this.subscribe({
-            projectId,
-            sources: [HEARTBEAT_SOURCE],
-            callsigns: [callsign],
-        }).pipe(map(() => Date.now()));
-        return combineLatest([heartbeatTime$.pipe(startWith(startedAt)), interval(intervalMs)]).pipe(map(([lastHeartbeat, _]) => {
-            const now = Date.now();
-            // If we haven't received a heartbeat, but we've only just started
-            if (lastHeartbeat === startedAt && now - startedAt <= heartbeatTimeoutMs) {
-                return CallsignStatus.UNKNOWN;
-            }
-            if (now - lastHeartbeat > heartbeatTimeoutMs) {
-                return CallsignStatus.OFFLINE;
-            }
-            return CallsignStatus.ONLINE;
-        }), startWith(CallsignStatus.UNKNOWN), distinctUntilChanged(), catchError(() => of(CallsignStatus.ERROR)));
-    }
-    async initStream(stream) {
-        await super.initStream(stream);
-        stream.init();
-    }
-    async createStream(projectId, callsignsLookup, sources, scope) {
-        const newStream = await this.createStreamFromConfig(IDENTIFIER_NAME_TELEMETRY, {
-            url: this.config.url,
-            projectId,
-            callsignsLookup,
-            sources,
-            token: this.config.token,
-            scope: scope ?? 'default',
-            options: this.config.options,
-            port: this.config.port,
-            insecure: this.config.insecure,
-        });
-        if (!newStream.isNew) {
-            newStream.stream.statusStream$.subscribe((msg) => {
-                this.streamStatusSubject$.next({
-                    scope,
-                    status: msg,
-                });
-            });
-        }
-        return newStream.stream;
-    }
-    getStream(config) {
-        return new TelemetryStream(config);
-    }
-}

package/services/index.d.ts

@@ -1,27 +0,0 @@
-export * from './AssetStorageService';
-export * from './AuthService';
-export * from './CallerService';
-export * from './CommandService';
-export * from './ConfigGroupService';
-export * from './ControlService';
-export * from './DashboardService';
-export * from './EventService';
-export * from './FileAccessorService';
-export * from './FunctionService';
-export * from './IntegrationService';
-export * from './ProfileService';
-export * from './ProjectService';
-export * from './RobotService';
-export * from './SearchService';
-export * from './StreamService';
-export * from './TelemetryService';
-export * from './UserService';
-export * from './WebRTCSignallingService';
-export * from './WorkflowService';
-export * from './ScheduleService';
-export * from './TimeSyncerService';
-export * from './PlatformTimeService';
-export * from './SpotProvisioningService';
-export * from './SpotProvisioningServiceNode';
-export * from './MapService';
-export * from './EvaluatorService';

package/services/index.js

@@ -1,27 +0,0 @@
-export * from './AssetStorageService';
-export * from './AuthService';
-export * from './CallerService';
-export * from './CommandService';
-export * from './ConfigGroupService';
-export * from './ControlService';
-export * from './DashboardService';
-export * from './EventService';
-export * from './FileAccessorService';
-export * from './FunctionService';
-export * from './IntegrationService';
-export * from './ProfileService';
-export * from './ProjectService';
-export * from './RobotService';
-export * from './SearchService';
-export * from './StreamService';
-export * from './TelemetryService';
-export * from './UserService';
-export * from './WebRTCSignallingService';
-export * from './WorkflowService';
-export * from './ScheduleService';
-export * from './TimeSyncerService';
-export * from './PlatformTimeService';
-export * from './SpotProvisioningService';
-export * from './SpotProvisioningServiceNode';
-export * from './MapService';
-export * from './EvaluatorService';