@dronedeploy/rocos-js-sdk 3.0.1-alpha.14 → 3.0.1-alpha.16

package/esm/services/TelemetryService.d.ts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { CallsignStatus, IRocosSDKConfig, IRocosTelemetryMessage, IStreamStatusMessage, ITelemetryStream, ITelemetryStreamConfig, ITelemetrySubscriptionParams, ITelemetrySubscriptions } from '../models';
+import { CallsignStatus, IRocosSDKConfig, IRocosTelemetryMessage, IStreamStatusMessage, ITelemetryStream, ITelemetryStreamConfig, ITelemetrySubscriptionParams, ITelemetrySubscriptions, TelemetryMonitorStatus } from '../models';
 import { BaseStreamService } from './BaseStreamService';
 export declare class TelemetryService extends BaseStreamService<ITelemetryStream, ITelemetryStreamConfig> {
     private statusSubscription;
@@ -34,6 +34,15 @@ export declare class TelemetryService extends BaseStreamService<ITelemetryStream
      * @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>;
+    /**
+     * Subscribes to the given telemetry and checks we receive one at least emission every `heartbeatTimeoutMs` (default 5s)
+     * @param projectId
+     * @param callsign
+     * @param source the telemetry source to monitor
+     * @param heartbeatTimeoutMs optionally override the deadline for telemetry emissions (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for telemetry emissions (in ms). Default 2000ms
+     */
+    monitorTelemetryWithTimeout(projectId: string, callsign: string, source: string, heartbeatTimeoutMs?: number, intervalMs?: number): Observable<TelemetryMonitorStatus>;
     protected initStream(stream: ITelemetryStream): Promise<void>;
     private buildScope;
     private createStream;

package/esm/services/TelemetryService.js

@@ -1,5 +1,5 @@
 import { BehaviorSubject, catchError, combineLatest, distinctUntilChanged, from, interval, map, mergeAll, of, startWith, } from 'rxjs';
-import { CallsignStatus, CallsignsLookup, CallsignsLookupType, RocosError, SubscriberStatusEnum, errorCodes, } from '../models';
+import { CallsignStatus, CallsignsLookup, CallsignsLookupType, RocosError, TelemetryMonitorStatus, SubscriberStatusEnum, errorCodes, } from '../models';
 import { filter, finalize } from 'rxjs/operators';
 import { BaseStreamService } from './BaseStreamService';
 import { IDENTIFIER_NAME_TELEMETRY } from '../constants/identifier';
@@ -95,23 +95,45 @@ export class TelemetryService extends BaseStreamService {
      * @param intervalMs optionally override the interval to check for heartbeats (in ms). Default 2000ms
      */
     getRobotStatusChanges(projectId, callsign, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
+        return this.monitorTelemetryWithTimeout(projectId, callsign, HEARTBEAT_SOURCE, heartbeatTimeoutMs, intervalMs).pipe(map((status) => {
+            switch (status) {
+                case TelemetryMonitorStatus.CONNECTED:
+                    return CallsignStatus.ONLINE;
+                case TelemetryMonitorStatus.DISCONNECTED:
+                    return CallsignStatus.OFFLINE;
+                case TelemetryMonitorStatus.ERROR:
+                    return CallsignStatus.ERROR;
+                default:
+                    return CallsignStatus.UNKNOWN;
+            }
+        }));
+    }
+    /**
+     * Subscribes to the given telemetry and checks we receive one at least emission every `heartbeatTimeoutMs` (default 5s)
+     * @param projectId
+     * @param callsign
+     * @param source the telemetry source to monitor
+     * @param heartbeatTimeoutMs optionally override the deadline for telemetry emissions (in ms). Default 5000ms
+     * @param intervalMs optionally override the interval to check for telemetry emissions (in ms). Default 2000ms
+     */
+    monitorTelemetryWithTimeout(projectId, callsign, source, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
         const startedAt = Date.now();
         const heartbeatTime$ = this.subscribe({
             projectId,
-            sources: [HEARTBEAT_SOURCE],
+            sources: [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;
+                return TelemetryMonitorStatus.UNKNOWN;
             }
             if (now - lastHeartbeat > heartbeatTimeoutMs) {
-                return CallsignStatus.OFFLINE;
+                return TelemetryMonitorStatus.DISCONNECTED;
             }
-            return CallsignStatus.ONLINE;
-        }), startWith(CallsignStatus.UNKNOWN), distinctUntilChanged(), catchError(() => of(CallsignStatus.ERROR)));
+            return TelemetryMonitorStatus.CONNECTED;
+        }), startWith(TelemetryMonitorStatus.UNKNOWN), distinctUntilChanged(), catchError(() => of(TelemetryMonitorStatus.ERROR)));
     }
     async initStream(stream) {
         await super.initStream(stream);

package/esm/services/index.d.ts

@@ -5,9 +5,9 @@ export * from './CommandService';
 export * from './ConfigGroupService';
 export * from './ControlService';
 export * from './DashboardService';
+export * from './DeviceCredentialsService';
 export * from './EventService';
 export * from './FileAccessorService';
-export * from './FunctionService';
 export * from './IntegrationService';
 export * from './ProfileService';
 export * from './ProjectService';

package/esm/services/index.js

@@ -5,9 +5,9 @@ export * from './CommandService';
 export * from './ConfigGroupService';
 export * from './ControlService';
 export * from './DashboardService';
+export * from './DeviceCredentialsService';
 export * from './EventService';
 export * from './FileAccessorService';
-export * from './FunctionService';
 export * from './IntegrationService';
 export * from './ProfileService';
 export * from './ProjectService';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.14",
+  "version": "3.0.1-alpha.16",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -23,7 +23,6 @@
   "devDependencies": {},
   "dependencies": {
     "@grpc/grpc-js": "^1.7.1",
-    "@improbable-eng/grpc-web": "^0.14.0",
     "@protobuf-ts/grpcweb-transport": "^2.9.1",
     "@protobuf-ts/plugin": "^2.9.1",
     "@protobuf-ts/runtime": "^2.9.1",

package/cjs/models/CallsignStatus.d.ts

@@ -1,6 +0,0 @@
-export declare enum CallsignStatus {
-    UNKNOWN = "unknown",
-    ONLINE = "online",
-    OFFLINE = "offline",
-    ERROR = "error"
-}

package/cjs/models/CallsignStatus.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallsignStatus = void 0;
-var CallsignStatus;
-(function (CallsignStatus) {
-    CallsignStatus["UNKNOWN"] = "unknown";
-    CallsignStatus["ONLINE"] = "online";
-    CallsignStatus["OFFLINE"] = "offline";
-    CallsignStatus["ERROR"] = "error";
-})(CallsignStatus || (exports.CallsignStatus = CallsignStatus = {}));

package/cjs/services/FunctionService.d.ts

@@ -1,68 +0,0 @@
-import { RocosError } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IExportDataQuery } from '../models/IExportDataQuery';
-import { IFunctionConfig } from '../models/IFunctionConfig';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-export declare class FunctionService extends BaseServiceAbstract implements IBaseService {
-    constructor(config: IRocosSDKConfig);
-    protected getError(e: Error): RocosError;
-    getStatus(): boolean;
-    /**
-     * Export data
-     *
-     * @param projectId - Project Id
-     * @param query - Payload {@link IExportDataQuery}
-     */
-    exportJobs(projectId: string, query: IExportDataQuery): Promise<any>;
-    /**
-     * Create a function
-     *
-     * @param projectId - Project Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    create(projectId: string, model: IFunctionConfig): Promise<any>;
-    /**
-     * Get a functions
-     *
-     * @param projectId - Project Id
-     */
-    list(projectId: string): Promise<any>;
-    /**
-     * Update a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    update(projectId: string, functionId: string, model: IFunctionConfig): Promise<any>;
-    /**
-     * Get function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    info(projectId: string, functionId: string): Promise<any>;
-    /**
-     * Delete function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    delete(projectId: string, functionId: string): Promise<any>;
-    /**
-     * Run a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param body - Payload
-     */
-    run(projectId: string, functionId: string, body?: any): Promise<any>;
-    /**
-     * Get function pods
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    pods(projectId: string, functionId: string): Promise<any>;
-}

package/cjs/services/FunctionService.js

@@ -1,103 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FunctionService = void 0;
-const api_1 = require("../constants/api");
-const RocosError_1 = require("../models/RocosError");
-const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
-const ExportDataQuery_1 = require("../models/ExportDataQuery");
-const RocosLogger_1 = require("../logger/RocosLogger");
-const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
-class FunctionService extends BaseServiceAbstract_1.BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger_1.RocosLogger.getInstance(`FunctionService(${this.config.url})`);
-    }
-    getError(e) {
-        return new RocosError_1.RocosError(e, RocosError_1.errorCodes.FUNCTION_SERVICE_ERROR);
-    }
-    getStatus() {
-        return true;
-    }
-    /**
-     * Export data
-     *
-     * @param projectId - Project Id
-     * @param query - Payload {@link IExportDataQuery}
-     */
-    // TODO: map the response object
-    async exportJobs(projectId, query) {
-        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_EXPORT_URL, { url: this.config.url, projectId }, this.config.insecure), new ExportDataQuery_1.ExportDataQuery(query).toJSON(), `Failed to export data for ${projectId}.`);
-    }
-    /**
-     * Create a function
-     *
-     * @param projectId - Project Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    // TODO: map the response object
-    async create(projectId, model) {
-        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create function for ${projectId}.`);
-    }
-    /**
-     * Get a functions
-     *
-     * @param projectId - Project Id
-     */
-    // TODO: map the response object
-    async list(projectId) {
-        return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get functions for ${projectId}.`);
-    }
-    /**
-     * Update a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    // TODO: map the response object
-    async update(projectId, functionId, model) {
-        return this.callPut((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), model, `Failed to update function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Get function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async info(projectId, functionId) {
-        return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to get function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Delete function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async delete(projectId, functionId) {
-        return this.callDelete((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to delete function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Run a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param body - Payload
-     */
-    // TODO: map the response object
-    async run(projectId, functionId, body = null) {
-        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_RUN_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), body, `Failed to run function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Get function pods
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async pods(projectId, functionId) {
-        return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_FUNCTION_POD_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to ged function pods for ${projectId}, functionId ${functionId}.`);
-    }
-}
-exports.FunctionService = FunctionService;

package/esm/models/CallsignStatus.d.ts

@@ -1,6 +0,0 @@
-export declare enum CallsignStatus {
-    UNKNOWN = "unknown",
-    ONLINE = "online",
-    OFFLINE = "offline",
-    ERROR = "error"
-}

package/esm/models/CallsignStatus.js

@@ -1,7 +0,0 @@
-export var CallsignStatus;
-(function (CallsignStatus) {
-    CallsignStatus["UNKNOWN"] = "unknown";
-    CallsignStatus["ONLINE"] = "online";
-    CallsignStatus["OFFLINE"] = "offline";
-    CallsignStatus["ERROR"] = "error";
-})(CallsignStatus || (CallsignStatus = {}));

package/esm/services/FunctionService.d.ts

@@ -1,68 +0,0 @@
-import { RocosError } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IExportDataQuery } from '../models/IExportDataQuery';
-import { IFunctionConfig } from '../models/IFunctionConfig';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-export declare class FunctionService extends BaseServiceAbstract implements IBaseService {
-    constructor(config: IRocosSDKConfig);
-    protected getError(e: Error): RocosError;
-    getStatus(): boolean;
-    /**
-     * Export data
-     *
-     * @param projectId - Project Id
-     * @param query - Payload {@link IExportDataQuery}
-     */
-    exportJobs(projectId: string, query: IExportDataQuery): Promise<any>;
-    /**
-     * Create a function
-     *
-     * @param projectId - Project Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    create(projectId: string, model: IFunctionConfig): Promise<any>;
-    /**
-     * Get a functions
-     *
-     * @param projectId - Project Id
-     */
-    list(projectId: string): Promise<any>;
-    /**
-     * Update a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    update(projectId: string, functionId: string, model: IFunctionConfig): Promise<any>;
-    /**
-     * Get function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    info(projectId: string, functionId: string): Promise<any>;
-    /**
-     * Delete function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    delete(projectId: string, functionId: string): Promise<any>;
-    /**
-     * Run a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param body - Payload
-     */
-    run(projectId: string, functionId: string, body?: any): Promise<any>;
-    /**
-     * Get function pods
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    pods(projectId: string, functionId: string): Promise<any>;
-}

package/esm/services/FunctionService.js

@@ -1,99 +0,0 @@
-import { API_PROJECT_EXPORT_URL, API_PROJECT_FUNCTION_ID_URL, API_PROJECT_FUNCTION_POD_URL, API_PROJECT_FUNCTION_RUN_URL, API_PROJECT_FUNCTION_URL, } from '../constants/api';
-import { RocosError, errorCodes } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { ExportDataQuery } from '../models/ExportDataQuery';
-import { RocosLogger } from '../logger/RocosLogger';
-import { formatServiceUrl } from '../helpers/formatServiceUrl';
-export class FunctionService extends BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`FunctionService(${this.config.url})`);
-    }
-    getError(e) {
-        return new RocosError(e, errorCodes.FUNCTION_SERVICE_ERROR);
-    }
-    getStatus() {
-        return true;
-    }
-    /**
-     * Export data
-     *
-     * @param projectId - Project Id
-     * @param query - Payload {@link IExportDataQuery}
-     */
-    // TODO: map the response object
-    async exportJobs(projectId, query) {
-        return this.callPost(formatServiceUrl(API_PROJECT_EXPORT_URL, { url: this.config.url, projectId }, this.config.insecure), new ExportDataQuery(query).toJSON(), `Failed to export data for ${projectId}.`);
-    }
-    /**
-     * Create a function
-     *
-     * @param projectId - Project Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    // TODO: map the response object
-    async create(projectId, model) {
-        return this.callPost(formatServiceUrl(API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create function for ${projectId}.`);
-    }
-    /**
-     * Get a functions
-     *
-     * @param projectId - Project Id
-     */
-    // TODO: map the response object
-    async list(projectId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_FUNCTION_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get functions for ${projectId}.`);
-    }
-    /**
-     * Update a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param model - Payload {@link IFunctionConfig}
-     */
-    // TODO: map the response object
-    async update(projectId, functionId, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), model, `Failed to update function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Get function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async info(projectId, functionId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to get function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Delete function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async delete(projectId, functionId) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_FUNCTION_ID_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to delete function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Run a function
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     * @param body - Payload
-     */
-    // TODO: map the response object
-    async run(projectId, functionId, body = null) {
-        return this.callPost(formatServiceUrl(API_PROJECT_FUNCTION_RUN_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), body, `Failed to run function for ${projectId}, functionId ${functionId}.`);
-    }
-    /**
-     * Get function pods
-     *
-     * @param projectId - Project Id
-     * @param functionId - Function Id
-     */
-    // TODO: map the response object
-    async pods(projectId, functionId) {
-        return this.callGet(formatServiceUrl(API_PROJECT_FUNCTION_POD_URL, { url: this.config.url, projectId, functionId }, this.config.insecure), `Failed to ged function pods for ${projectId}, functionId ${functionId}.`);
-    }
-}