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

package/services/RobotService.js

@@ -1,460 +0,0 @@
-import { API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_PROFILE_DASHBOARD_ID_URL, API_PROJECT_PROFILE_DASHBOARD_URL, API_PROJECT_ROBOT_AGENT_URL, API_PROJECT_ROBOT_ATTRIBUTES_URL, API_PROJECT_ROBOT_BUTTON_URL, API_PROJECT_ROBOT_COMMAND2_URL, API_PROJECT_ROBOT_COMMAND_URL, API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_ROBOT_DASHBOARD_ID_URL, API_PROJECT_ROBOT_DASHBOARD_URL, API_PROJECT_ROBOT_GAMEPAD_URL, API_PROJECT_ROBOT_ID_URL, API_PROJECT_ROBOT_REGISTER_URL, API_PROJECT_ROBOT_SETTING_URL, API_PROJECT_ROBOT_TRIGGER_URL, API_PROJECT_ROBOT_URL, API_PROJECT_VROBOT_DEPLOY_URL, API_PROJECT_VROBOT_DETAILS_URL, API_SOURCE_SCHEMA_URL, API_TEMPLATE_DEPLOY_URL, } from '../constants/api';
-import { errorCodes, Robot, RobotTemplate, RocosError, } from '../models';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { RocosLogger } from '../logger/RocosLogger';
-import { cleanObject } from '../helpers/cleanObject';
-import { formatServiceUrl } from '../helpers/formatServiceUrl';
-export class RobotService extends BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`RobotService(${this.config.url})`);
-    }
-    getError(e) {
-        return new RocosError(e, errorCodes.ROBOT_SERVICE_ERROR);
-    }
-    getStatus() {
-        return true;
-    }
-    /**
-     * Get a list of robots.
-     *
-     * @param projectId - Project Id
-     */
-    async getRobots(projectId) {
-        const data = await this.callGet(formatServiceUrl(API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get robots list for ${projectId}.`);
-        return data.map((item) => cleanObject(new Robot(item)));
-    }
-    /**
-     * Create a new robot.
-     *
-     * @param projectId
-     * @param robot - Robot payload {@link IRobot}
-     */
-    // TODO: map the response object
-    async create(projectId, robot) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), robot, 'Failed to create robot.');
-    }
-    /**
-     * Update robot information.
-     *
-     * @param projectId Project Id
-     * @param robot - Robot payload {@link IRobot}
-     */
-    // TODO: map the response object
-    async update(projectId, robot) {
-        return this.callPut(formatServiceUrl(API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), robot, 'Failed to update robot.');
-    }
-    /**
-     * Delete the robots by callsign list
-     *
-     * @param projectId - Project Id
-     * @param callsignIds - Callsign list
-     */
-    // TODO: map the response object
-    async delete(projectId, callsignIds) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to delete robots.', callsignIds);
-    }
-    /**
-     * Get robot information by project id and callsign of the robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Callsign of the robot
-     */
-    async info(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_ID_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get robot info.');
-    }
-    /**
-     * Get robot information by project id and callsign of the robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Callsign of the robot
-     */
-    async attributes(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_ATTRIBUTES_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get robot attributes.');
-    }
-    /**
-     * Register the specified callsign
-     *
-     * @param projectId - Project Id
-     * @param callsign - Callsign of the robot
-     */
-    // TODO: map the response object
-    async register(projectId, callsign) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_REGISTER_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), {}, 'Failed to register robot.');
-    }
-    /**
-     * Robot Templates
-     */
-    async templates() {
-        const data = await this.callGet(formatServiceUrl(API_TEMPLATE_DEPLOY_URL, { url: this.config.url }, this.config.insecure), 'Failed to get robot templates.');
-        return data.map((item) => cleanObject(new RobotTemplate(item)));
-    }
-    /**
-     * Get the deployment details of virtual robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Virtual Robot Callsign
-     */
-    // TODO: map the response object
-    async virtualRobotDeploymentDetails(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_VROBOT_DETAILS_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get virtual robot details.');
-    }
-    /**
-     * Deploy a virtual robot by project id and callsign
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot's Callsign
-     */
-    // TODO: map the response object
-    async deployVirtualRobot(projectId, callsign) {
-        return this.callPost(formatServiceUrl(API_PROJECT_VROBOT_DEPLOY_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), null, 'Failed to deploy a virtual robot.');
-    }
-    /**
-     * Get data sources tree components JSON schema
-     */
-    // TODO: map the response object
-    async dataSourcesSchema() {
-        return this.callGet(formatServiceUrl(API_SOURCE_SCHEMA_URL, { url: this.config.url }, this.config.insecure), 'Failed to get source schemas.');
-    }
-    /**
-     * Delete a robot dashboard.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async deleteRobotDashboardsV2(projectId, callsign, dashboardId) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            callsign,
-            dashboardId,
-        }, this.config.insecure), 'Failed to delete dashboard.');
-    }
-    /**
-     * Delete a profile dashboard.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async deleteDashboardsV2(projectId, profileId, dashboardId) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            profileId,
-            dashboardId,
-        }, this.config.insecure), 'Failed to delete dashboard.');
-    }
-    /**
-     * Get a list of robot dashboards.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     */
-    // TODO: map the response object
-    async listRobotDashboardsV2(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get robot dashboards.');
-    }
-    /**
-     * Get a list of profile dashboards.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     */
-    // TODO: map the response object
-    async listDashboardsV2(projectId, profileId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), 'Failed to get profile dashboards.');
-    }
-    /**
-     * Get a profile dashboard.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async robotDefDashboardsV2(projectId, profileId, dashboardId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            profileId,
-            dashboardId,
-        }, this.config.insecure), 'Failed to get profile dashboard.');
-    }
-    /**
-     * Get Dashboard data which stored in Azure Blob.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async robotDefDashboardBlobV2(projectId, profileId, dashboardId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL, {
-            url: this.config.url,
-            projectId,
-            profileId,
-            dashboardId,
-        }, this.config.insecure), 'Failed to get profile dashboard blob.');
-    }
-    /**
-     * Create dashboard for a robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async createRobotDashboardsV2(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, 'Failed to create robot dashboard.');
-    }
-    /**
-     * Create dashboard for a profile.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async createDashboardsV2(projectId, profileId, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), model, 'Failed to create profile dashboard.');
-    }
-    /**
-     * Update dashboard for a profile.
-     *
-     * @param projectId - Project Id
-     * @param profileId - Profile Id
-     * @param dashboardId - Dashboard Id
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    async robotDefUpdateDashboardsV2(projectId, profileId, dashboardId, 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            profileId,
-            dashboardId,
-        }, this.config.insecure), model, 'Failed to update profile dashboard.');
-    }
-    /**
-     * Get a list of dashboard for a robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async getDashboardsV2(projectId, callsign, dashboardId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            callsign,
-            dashboardId,
-        }, this.config.insecure), 'Failed to get robot dashboard.');
-    }
-    /**
-     * Get robot dashboard which stored in Azure Blob.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     * @param dashboardId - Dashboard Id
-     */
-    // TODO: map the response object
-    async getDashboardBlobV2(projectId, callsign, dashboardId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL, {
-            url: this.config.url,
-            projectId,
-            callsign,
-            dashboardId,
-        }, this.config.insecure), 'Failed to get robot dashboard blob.');
-    }
-    /**
-     * Update dashboard for a robot.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot Callsign
-     * @param dashboardId - Dashboard Id
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateDashboardsV2(projectId, callsign, dashboardId, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_ROBOT_DASHBOARD_ID_URL, {
-            url: this.config.url,
-            projectId,
-            callsign,
-            dashboardId,
-        }, this.config.insecure), model, 'Failed to update robot dashboard.');
-    }
-    /**
-     * Get robot settings
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    async getSettings(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_SETTING_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get robot settings.');
-    }
-    /**
-     * Update robot settings.
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateSettings(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_SETTING_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, 'Failed to update robot settings.');
-    }
-    /**
-     * Get agent settings for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getAgentSettings(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_AGENT_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get agent settings for robot.');
-    }
-    /**
-     * Update agent settings for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateAgentSettings(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_AGENT_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, 'Failed to update agent settings for robot.');
-    }
-    /**
-     * Get commands for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getCommands(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_COMMAND_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), 'Failed to get commands for a robot.');
-    }
-    /**
-     * Update commands for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateCommands(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_COMMAND_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, 'Failed to update commands for a robot.');
-    }
-    /**
-     * Get command V2 for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getCommandsV2(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get command list for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Update command V2 for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateCommandsV2(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update commands for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Get buttons for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getButtons(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_BUTTON_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get buttons for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Update buttons for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateButtons(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_BUTTON_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update buttons for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Get triggers for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getTriggers(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_TRIGGER_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get triggers for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Update triggers for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateTriggers(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_TRIGGER_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update triggers for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Get gamepads for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getGamepads(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get gamepads for ${projectId}, callsign  ${callsign}.`);
-    }
-    /**
-     * Update gamepads for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - \payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateGamepads(projectId, callsign, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update gamepads for ${projectId}, callsign  ${callsign}.`);
-    }
-}

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/TelemetryService.spec.js

@@ -1,37 +0,0 @@
-import { CallsignStatus } from '../models';
-import { NEVER, delay, from, lastValueFrom, take, throwError } from 'rxjs';
-import { TelemetryService } from './TelemetryService';
-describe('TelemetryService', () => {
-    describe('getRobotStatusChanges', () => {
-        it('should emit unknown to begin with', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(NEVER);
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign').pipe(take(1)));
-            expect(lastValue).toEqual(CallsignStatus.UNKNOWN);
-        });
-        it('should emit online if the robot emits a heartbeat', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest
-                .spyOn(service, 'subscribe')
-                .mockReturnValue(from([0, 1, 2, 3, 4]).pipe(delay(100)));
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 1000, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.ONLINE);
-        }, 10000);
-        it('should emit offline if the robot never emits', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(NEVER);
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 100, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.OFFLINE);
-        });
-        it('should emit an error if the telemetry errors', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(throwError(() => new Error('test')));
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 100, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.ERROR);
-        });
-    });
-});