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

package/cjs/store/RocosStore.d.ts

@@ -0,0 +1,30 @@
+import { IRocosChangeMessage, IRocosSDKConfig } from '../models';
+import { IRocosSDK } from '../IRocosSDK';
+import { Subject } from 'rxjs';
+export declare class RocosStore {
+    private static changeSubject$?;
+    protected static instances: Record<string, IRocosSDK>;
+    /**
+     * A static method to get the change subject.
+     */
+    static getChangeSubject(): Subject<IRocosChangeMessage>;
+    /**
+     * A static method to get the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static getSDKInstance(config: IRocosSDKConfig): IRocosSDK;
+    /**
+     * A static method to put the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     * @param instance - SDK instance {@link IRocosSDK}
+     */
+    static putSDKInstance(config: IRocosSDKConfig, instance: IRocosSDK): void;
+    /**
+     * A static method to remove the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static removeSDKInstance(config: IRocosSDKConfig): void;
+}

package/cjs/store/RocosStore.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosStore = void 0;
+const rxjs_1 = require("rxjs");
+const getUniqueConfigKey_1 = require("../helpers/getUniqueConfigKey");
+class RocosStore {
+    /**
+     * A static method to get the change subject.
+     */
+    static getChangeSubject() {
+        if (!RocosStore.changeSubject$) {
+            RocosStore.changeSubject$ = new rxjs_1.Subject();
+        }
+        return RocosStore.changeSubject$;
+    }
+    /**
+     * A static method to get the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static getSDKInstance(config) {
+        const uniqueConfigKey = (0, getUniqueConfigKey_1.getUniqueConfigKey)(config);
+        return RocosStore.instances[uniqueConfigKey];
+    }
+    /**
+     * A static method to put the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     * @param instance - SDK instance {@link IRocosSDK}
+     */
+    static putSDKInstance(config, instance) {
+        const uniqueConfigKey = (0, getUniqueConfigKey_1.getUniqueConfigKey)(config);
+        if (!RocosStore.instances?.[uniqueConfigKey]) {
+            RocosStore.instances[uniqueConfigKey] = instance;
+        }
+    }
+    /**
+     * A static method to remove the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static removeSDKInstance(config) {
+        const uniqueConfigKey = (0, getUniqueConfigKey_1.getUniqueConfigKey)(config);
+        if (RocosStore.instances?.[uniqueConfigKey]) {
+            delete RocosStore.instances[uniqueConfigKey];
+        }
+    }
+}
+exports.RocosStore = RocosStore;
+// TODO(matej): migrate to non static instance registry
+RocosStore.instances = {};

package/esm/IRocosSDK.d.ts

@@ -0,0 +1,34 @@
+import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, DeviceCredentialsService, EvaluatorService, EventService, FileAccessorService, IntegrationService, MapService, ProfileService, ProjectService, RTPWebRTCService, RobotService, SearchService, SpotProvisioningService, SpotProvisioningServiceNode, StreamService, TargetService, TelemetryService, TimeSyncerService, UserService, WebRTCSignallingService, WorkflowService } from './services';
+import { IBaseService, IDebugLevel, ServiceEnum } from './models';
+export declare abstract class IRocosSDK {
+    abstract getService<T extends IBaseService>(name: ServiceEnum): T;
+    abstract getAuthService(): AuthService;
+    abstract getRobotService(): RobotService;
+    abstract getEventService(): EventService;
+    abstract getProjectService(): ProjectService;
+    abstract getTelemetryService(): TelemetryService;
+    abstract getCallerService(): CallerService;
+    abstract getControlService(): ControlService;
+    abstract getCommandService(): CommandService;
+    abstract getSearchService(): SearchService;
+    abstract getConfigGroupService(): ConfigGroupService;
+    abstract getDashboardService(): DashboardService;
+    abstract getStreamService(): StreamService;
+    abstract getUserService(): UserService;
+    abstract getMapService(): MapService;
+    abstract getTimeSyncerService(): TimeSyncerService;
+    abstract getWorkflowService(): WorkflowService;
+    abstract getAssetStorageService(): AssetStorageService;
+    abstract getProfileService(): ProfileService;
+    abstract getRTPWebRTCService(): RTPWebRTCService;
+    abstract getWebRTCSignallingService(): WebRTCSignallingService;
+    abstract getFileAccessorService(): FileAccessorService;
+    abstract getSpotProvisionerService(): SpotProvisioningService | SpotProvisioningServiceNode;
+    abstract getIntegrationService(): IntegrationService;
+    abstract getEvaluatorService(): EvaluatorService;
+    abstract getDeviceCredentialsService(): DeviceCredentialsService;
+    abstract getTargetService(): TargetService;
+    abstract cleanup(): Promise<boolean>;
+    abstract enableDebugMode(on: boolean): void;
+    abstract setDebugLevel(level: IDebugLevel): void;
+}

package/esm/RocosSDK.d.ts

@@ -0,0 +1,157 @@
+import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, DeviceCredentialsService, EvaluatorService, EventService, FileAccessorService, IntegrationService, MapService, ProfileService, ProjectService, RTPWebRTCService, RobotService, ScheduleService, SearchService, SpotProvisioningService, StreamService, TargetService, TelemetryService, TimeSyncerService, UserService, WebRTCSignallingService, WorkflowService } from './services';
+import { AuthorisedConfig, IBaseService, IDebugLevel, IRocosSDKConfig, ServiceEnum } from './models';
+import { IRocosSDK } from './IRocosSDK';
+import { Logger } from 'loglevel';
+export declare class RocosSDK implements IRocosSDK {
+    protected config: IRocosSDKConfig;
+    protected logger: Logger;
+    protected services: Record<string, IBaseService>;
+    /**
+     * Create a new SDK instance using a config object.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    constructor(config: IRocosSDKConfig);
+    /**
+     * Gets the service by service name.
+     *
+     * @param name - Service name {@link ServiceEnum}
+     */
+    getService<T extends IBaseService>(name: ServiceEnum): T;
+    /**
+     * Gets the authentication service.
+     */
+    getAuthService(): AuthService;
+    /**
+     * Gets the robot service.
+     */
+    getRobotService(): RobotService;
+    /**
+     * Gets the event service.
+     */
+    getEventService(): EventService;
+    /**
+     * Gets the project service.
+     */
+    getProjectService(): ProjectService;
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService(): TelemetryService;
+    /**
+     * Gets the service call service.
+     */
+    getCallerService(): CallerService;
+    /**
+     * Gets the command service.
+     */
+    getCommandService(): CommandService;
+    /**
+     * Gets the robot control service.
+     */
+    getControlService(): ControlService;
+    /**
+     * Gets the search service.
+     */
+    getSearchService(): SearchService;
+    /**
+     * Gets the config group service
+     */
+    getConfigGroupService(): ConfigGroupService;
+    /**
+     * Gets the dashboard service
+     */
+    getDashboardService(): DashboardService;
+    /**
+     * Gets the stream service
+     */
+    getStreamService(): StreamService;
+    /**
+     * Gets the user service
+     */
+    getUserService(): UserService;
+    /**
+     * Gets time syncer service
+     */
+    getTimeSyncerService(): TimeSyncerService;
+    /**
+     * Gets the workflow service
+     */
+    getWorkflowService(): WorkflowService;
+    /**
+     * Gets the asset storage service
+     */
+    getAssetStorageService(): AssetStorageService;
+    /**
+     * Gets the robot profile service
+     */
+    getProfileService(): ProfileService;
+    /**
+     * Gets the WebRTC signalling service
+     * @returns WebRTCSignallingService
+     */
+    getWebRTCSignallingService(): WebRTCSignallingService;
+    /**
+     * Gets the WebRTC service
+     * @returns RTPWebRTCService
+     */
+    getRTPWebRTCService(): RTPWebRTCService;
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorService
+     */
+    getFileAccessorService(): FileAccessorService;
+    /**
+     * Gets the scheduler service
+     * @returns FileAccessorService
+     */
+    getSchedulerService(): ScheduleService;
+    /**
+     * Gets the spot provisioner service
+     * @returns SpotProvisioningService
+     */
+    getSpotProvisionerService(): SpotProvisioningService;
+    /**
+     * Gets the integration service
+     * @returns IntegrationService
+     */
+    getIntegrationService(): IntegrationService;
+    /**
+     * Gets the map service
+     * @returns MapService
+     */
+    getMapService(): MapService;
+    /**
+     * Gets the evaluator service
+     * @returns EvaluatorService
+     */
+    getEvaluatorService(): EvaluatorService;
+    /**
+     * Gets the device credentials service.
+     * @returns DeviceCredentialsService
+     */
+    getDeviceCredentialsService(): DeviceCredentialsService;
+    /**
+     * Gets the asset service.
+     * @returns AssetService
+     */
+    getTargetService(): TargetService;
+    get platformTimeOffset(): number;
+    get platformTime(): number;
+    /**
+     * Cleanup function to release all the stream resources.
+     * All streams get destroyed by default once all the observers unsubscribe.
+     * This should be called as a precaution in case there are some subscriptions still hanging.
+     */
+    cleanup(): Promise<boolean>;
+    /**
+     * Enable or disable debug log
+     *
+     * @param on
+     */
+    enableDebugMode(on: boolean): void;
+    setDebugLevel(level: IDebugLevel): void;
+    protected overrideConfig(service: ServiceEnum): AuthorisedConfig & {
+        _parentConfig?: IRocosSDKConfig;
+    };
+}

package/esm/RocosSDK.js

@@ -0,0 +1,336 @@
+import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, DeviceCredentialsService, EvaluatorService, EventService, FileAccessorService, IntegrationService, MapService, PlatFormTimeService, ProfileService, ProjectService, RTPWebRTCService, RobotService, ScheduleService, SearchService, SpotProvisioningService, StreamService, TargetService, TelemetryService, TimeSyncerService, UserService, WebRTCSignallingService, WorkflowService, } from './services';
+import { ServiceEnum } from './models';
+import { RocosLogger } from './logger/RocosLogger';
+import { RocosStore } from './store/RocosStore';
+import { StreamRegister } from './api/StreamRegister';
+export class RocosSDK {
+    /**
+     * Create a new SDK instance using a config object.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    constructor(config) {
+        this.services = {};
+        this.config = config;
+        this.logger = RocosLogger.getInstance(`RocosSDK(${this.config.url})`);
+        RocosStore.putSDKInstance(this.config, this);
+    }
+    /**
+     * Gets the service by service name.
+     *
+     * @param name - Service name {@link ServiceEnum}
+     */
+    // eslint-disable-next-line max-lines-per-function
+    getService(name) {
+        if (!this.services?.[name]) {
+            this.logger.info(`Service ${name} does not exist, creating it now.`);
+            const config = this.overrideConfig(name);
+            switch (name) {
+                case ServiceEnum.AUTH:
+                    this.services[name] = new AuthService(config);
+                    break;
+                case ServiceEnum.TELEMETRY:
+                    this.services[name] = new TelemetryService(config);
+                    break;
+                case ServiceEnum.ROBOT:
+                    this.services[name] = new RobotService(config);
+                    break;
+                case ServiceEnum.EVENT:
+                    this.services[name] = new EventService(config);
+                    break;
+                case ServiceEnum.PROJECT:
+                    this.services[name] = new ProjectService(config);
+                    break;
+                case ServiceEnum.CALLER:
+                    this.services[name] = new CallerService(config);
+                    break;
+                case ServiceEnum.COMMAND:
+                    this.services[name] = new CommandService(config);
+                    break;
+                case ServiceEnum.CONTROL:
+                    this.services[name] = new ControlService(config);
+                    break;
+                case ServiceEnum.SEARCH:
+                    this.services[name] = new SearchService(config);
+                    break;
+                case ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new ConfigGroupService(config);
+                    break;
+                case ServiceEnum.DASHBOARD:
+                    this.services[name] = new DashboardService(config);
+                    break;
+                case ServiceEnum.STREAM:
+                    this.services[name] = new StreamService(config);
+                    break;
+                case ServiceEnum.USER:
+                    this.services[name] = new UserService(config);
+                    break;
+                case ServiceEnum.TIME_SYNCER:
+                    this.services[name] = new TimeSyncerService(config);
+                    break;
+                case ServiceEnum.WORKFLOW:
+                    this.services[name] = new WorkflowService(config);
+                    break;
+                case ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new AssetStorageService(config);
+                    break;
+                case ServiceEnum.PROFILE:
+                    this.services[name] = new ProfileService(config);
+                    break;
+                case ServiceEnum.RTP_WEBRTC:
+                    this.services[name] = new RTPWebRTCService(config);
+                    break;
+                case ServiceEnum.WEBRTC_SIGNALLING:
+                    this.services[name] = new WebRTCSignallingService(config);
+                    break;
+                case ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new FileAccessorService(config);
+                    break;
+                case ServiceEnum.SCHEDULE:
+                    this.services[name] = new ScheduleService(config);
+                    break;
+                case ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new SpotProvisioningService(config);
+                    break;
+                case ServiceEnum.INTEGRATION:
+                    this.services[name] = new IntegrationService(config);
+                    break;
+                case ServiceEnum.MAP:
+                    this.services[name] = new MapService(config);
+                    break;
+                case ServiceEnum.EVALUATOR:
+                    this.services[name] = new EvaluatorService(config);
+                    break;
+                case ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new DeviceCredentialsService(config);
+                    break;
+                case ServiceEnum.TARGET:
+                    this.services[name] = new TargetService(config);
+                    break;
+            }
+        }
+        this.logger.debug(`Found service ${name}.`);
+        return this.services[name];
+    }
+    /**
+     * Gets the authentication service.
+     */
+    getAuthService() {
+        return this.getService(ServiceEnum.AUTH);
+    }
+    /**
+     * Gets the robot service.
+     */
+    getRobotService() {
+        return this.getService(ServiceEnum.ROBOT);
+    }
+    /**
+     * Gets the event service.
+     */
+    getEventService() {
+        return this.getService(ServiceEnum.EVENT);
+    }
+    /**
+     * Gets the project service.
+     */
+    getProjectService() {
+        return this.getService(ServiceEnum.PROJECT);
+    }
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService() {
+        return this.getService(ServiceEnum.TELEMETRY);
+    }
+    /**
+     * Gets the service call service.
+     */
+    getCallerService() {
+        return this.getService(ServiceEnum.CALLER);
+    }
+    /**
+     * Gets the command service.
+     */
+    getCommandService() {
+        return this.getService(ServiceEnum.COMMAND);
+    }
+    /**
+     * Gets the robot control service.
+     */
+    getControlService() {
+        return this.getService(ServiceEnum.CONTROL);
+    }
+    /**
+     * Gets the search service.
+     */
+    getSearchService() {
+        return this.getService(ServiceEnum.SEARCH);
+    }
+    /**
+     * Gets the config group service
+     */
+    getConfigGroupService() {
+        return this.getService(ServiceEnum.CONFIG_GROUP);
+    }
+    /**
+     * Gets the dashboard service
+     */
+    getDashboardService() {
+        return this.getService(ServiceEnum.DASHBOARD);
+    }
+    /**
+     * Gets the stream service
+     */
+    getStreamService() {
+        return this.getService(ServiceEnum.STREAM);
+    }
+    /**
+     * Gets the user service
+     */
+    getUserService() {
+        return this.getService(ServiceEnum.USER);
+    }
+    /**
+     * Gets time syncer service
+     */
+    getTimeSyncerService() {
+        return this.getService(ServiceEnum.TIME_SYNCER);
+    }
+    /**
+     * Gets the workflow service
+     */
+    getWorkflowService() {
+        return this.getService(ServiceEnum.WORKFLOW);
+    }
+    /**
+     * Gets the asset storage service
+     */
+    getAssetStorageService() {
+        return this.getService(ServiceEnum.ASSET_STORAGE);
+    }
+    /**
+     * Gets the robot profile service
+     */
+    getProfileService() {
+        return this.getService(ServiceEnum.PROFILE);
+    }
+    /**
+     * Gets the WebRTC signalling service
+     * @returns WebRTCSignallingService
+     */
+    getWebRTCSignallingService() {
+        return this.getService(ServiceEnum.WEBRTC_SIGNALLING);
+    }
+    /**
+     * Gets the WebRTC service
+     * @returns RTPWebRTCService
+     */
+    getRTPWebRTCService() {
+        return this.getService(ServiceEnum.RTP_WEBRTC);
+    }
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorService
+     */
+    getFileAccessorService() {
+        return this.getService(ServiceEnum.FILE_ACCESSOR);
+    }
+    /**
+     * Gets the scheduler service
+     * @returns FileAccessorService
+     */
+    getSchedulerService() {
+        return this.getService(ServiceEnum.SCHEDULE);
+    }
+    /**
+     * Gets the spot provisioner service
+     * @returns SpotProvisioningService
+     */
+    getSpotProvisionerService() {
+        return this.getService(ServiceEnum.SPOT_PROVISIONER);
+    }
+    /**
+     * Gets the integration service
+     * @returns IntegrationService
+     */
+    getIntegrationService() {
+        return this.getService(ServiceEnum.INTEGRATION);
+    }
+    /**
+     * Gets the map service
+     * @returns MapService
+     */
+    getMapService() {
+        return this.getService(ServiceEnum.MAP);
+    }
+    /**
+     * Gets the evaluator service
+     * @returns EvaluatorService
+     */
+    getEvaluatorService() {
+        return this.getService(ServiceEnum.EVALUATOR);
+    }
+    /**
+     * Gets the device credentials service.
+     * @returns DeviceCredentialsService
+     */
+    getDeviceCredentialsService() {
+        return this.getService(ServiceEnum.DEVICE_CREDENTIALS);
+    }
+    /**
+     * Gets the asset service.
+     * @returns AssetService
+     */
+    getTargetService() {
+        return this.getService(ServiceEnum.TARGET);
+    }
+    get platformTimeOffset() {
+        return PlatFormTimeService.getInstance(this.getTimeSyncerService())?.platformTimeOffset;
+    }
+    get platformTime() {
+        return PlatFormTimeService.getInstance(this.getTimeSyncerService())?.platformTime;
+    }
+    /**
+     * Cleanup function to release all the stream resources.
+     * All streams get destroyed by default once all the observers unsubscribe.
+     * This should be called as a precaution in case there are some subscriptions still hanging.
+     */
+    async cleanup() {
+        for (const service of Object.values(this.services)) {
+            if (service.teardown) {
+                await service.teardown();
+            }
+        }
+        this.services = {};
+        RocosStore.removeSDKInstance(this.config);
+        return StreamRegister.getInstance().removeAllStreams();
+    }
+    /**
+     * Enable or disable debug log
+     *
+     * @param on
+     */
+    enableDebugMode(on) {
+        if (on) {
+            RocosLogger.enableAll();
+        }
+        else {
+            RocosLogger.disableAll();
+        }
+    }
+    setDebugLevel(level) {
+        RocosLogger.setLevel(level);
+    }
+    overrideConfig(service) {
+        const override = this.config.overrides?.[service];
+        if (!override)
+            return this.config;
+        // strip out the overrides from the config
+        const { overrides: _, ...config } = this.config;
+        return {
+            ...config,
+            ...this.config.overrides?.[service],
+            _parentConfig: this.config,
+        };
+    }
+}

package/esm/api/StreamRegister.d.ts

@@ -0,0 +1,13 @@
+import { IBaseStream } from '../models';
+export declare class StreamRegister {
+    private teleStreams;
+    private logger;
+    private static instance;
+    private constructor();
+    static getInstance(): StreamRegister;
+    static getIdentifier($identifier: string, scope?: string): string;
+    addStream(stream: IBaseStream): Promise<void>;
+    getStream(identifier: string): IBaseStream | undefined;
+    removeStream(stream: IBaseStream): Promise<void>;
+    removeAllStreams(): Promise<boolean>;
+}

package/esm/api/atoms/StreamHeartbeat.d.ts

@@ -0,0 +1,27 @@
+export declare class StreamHeartbeat {
+    private identifier;
+    private callback?;
+    private timeout?;
+    private beats;
+    private interval?;
+    private healthInterval?;
+    private healthLastSeenDate;
+    private healthMisses;
+    private healthTimeout;
+    private healthMaxTimeout;
+    private healthMaxMisses;
+    private healthCheckStatusCallback?;
+    private healthCheckErrorCallback?;
+    private logger;
+    constructor(identifier: string);
+    setHealthTimeout(healthTimeout: number): StreamHeartbeat;
+    setHealthMaxTimeout(healthMaxTimeout: number): StreamHeartbeat;
+    setHealthMaxMisses(healthMaxMisses: number): StreamHeartbeat;
+    setHealthCheckStatusCallback(healthCheckStatusCallback: (status: boolean) => Promise<void>): StreamHeartbeat;
+    setHealthCheckErrorCallback(healthCheckErrorCallback: () => Promise<void>): StreamHeartbeat;
+    start(callback: () => void, timeout: number): void;
+    stop(): void;
+    pump(): number;
+    private checkHealth;
+    stopHealthCheck(): void;
+}

package/esm/api/streams/caller/CallerStream.d.ts

@@ -0,0 +1,13 @@
+import { ICallerParams, IRocosCallerMessage, IStreamConfig } from '../../../models';
+import { Observable } from 'rxjs';
+import { RequestCancellation, ServiceRequest } from '../../../grpc/serviette.v1_pb';
+import { CallerStreamAbstract } from './CallerStreamAbstract';
+export declare class CallerStream extends CallerStreamAbstract {
+    private client;
+    constructor(config: IStreamConfig);
+    protected callService(request: ServiceRequest, params: ICallerParams): Observable<IRocosCallerMessage>;
+    protected cancelService(request: RequestCancellation, params: ICallerParams): Observable<IRocosCallerMessage>;
+    private handleStream;
+    protected getPayload(payload: string): Uint8Array;
+    private getMetadata;
+}