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

package/cjs/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/cjs/IRocosSDK.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IRocosSDK = void 0;
+class IRocosSDK {
+}
+exports.IRocosSDK = IRocosSDK;

package/cjs/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/cjs/RocosSDK.js

@@ -0,0 +1,340 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RocosSDK = void 0;
+const services_1 = require("./services");
+const models_1 = require("./models");
+const RocosLogger_1 = require("./logger/RocosLogger");
+const RocosStore_1 = require("./store/RocosStore");
+const StreamRegister_1 = require("./api/StreamRegister");
+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_1.RocosLogger.getInstance(`RocosSDK(${this.config.url})`);
+        RocosStore_1.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 models_1.ServiceEnum.AUTH:
+                    this.services[name] = new services_1.AuthService(config);
+                    break;
+                case models_1.ServiceEnum.TELEMETRY:
+                    this.services[name] = new services_1.TelemetryService(config);
+                    break;
+                case models_1.ServiceEnum.ROBOT:
+                    this.services[name] = new services_1.RobotService(config);
+                    break;
+                case models_1.ServiceEnum.EVENT:
+                    this.services[name] = new services_1.EventService(config);
+                    break;
+                case models_1.ServiceEnum.PROJECT:
+                    this.services[name] = new services_1.ProjectService(config);
+                    break;
+                case models_1.ServiceEnum.CALLER:
+                    this.services[name] = new services_1.CallerService(config);
+                    break;
+                case models_1.ServiceEnum.COMMAND:
+                    this.services[name] = new services_1.CommandService(config);
+                    break;
+                case models_1.ServiceEnum.CONTROL:
+                    this.services[name] = new services_1.ControlService(config);
+                    break;
+                case models_1.ServiceEnum.SEARCH:
+                    this.services[name] = new services_1.SearchService(config);
+                    break;
+                case models_1.ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new services_1.ConfigGroupService(config);
+                    break;
+                case models_1.ServiceEnum.DASHBOARD:
+                    this.services[name] = new services_1.DashboardService(config);
+                    break;
+                case models_1.ServiceEnum.STREAM:
+                    this.services[name] = new services_1.StreamService(config);
+                    break;
+                case models_1.ServiceEnum.USER:
+                    this.services[name] = new services_1.UserService(config);
+                    break;
+                case models_1.ServiceEnum.TIME_SYNCER:
+                    this.services[name] = new services_1.TimeSyncerService(config);
+                    break;
+                case models_1.ServiceEnum.WORKFLOW:
+                    this.services[name] = new services_1.WorkflowService(config);
+                    break;
+                case models_1.ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new services_1.AssetStorageService(config);
+                    break;
+                case models_1.ServiceEnum.PROFILE:
+                    this.services[name] = new services_1.ProfileService(config);
+                    break;
+                case models_1.ServiceEnum.RTP_WEBRTC:
+                    this.services[name] = new services_1.RTPWebRTCService(config);
+                    break;
+                case models_1.ServiceEnum.WEBRTC_SIGNALLING:
+                    this.services[name] = new services_1.WebRTCSignallingService(config);
+                    break;
+                case models_1.ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new services_1.FileAccessorService(config);
+                    break;
+                case models_1.ServiceEnum.SCHEDULE:
+                    this.services[name] = new services_1.ScheduleService(config);
+                    break;
+                case models_1.ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new services_1.SpotProvisioningService(config);
+                    break;
+                case models_1.ServiceEnum.INTEGRATION:
+                    this.services[name] = new services_1.IntegrationService(config);
+                    break;
+                case models_1.ServiceEnum.MAP:
+                    this.services[name] = new services_1.MapService(config);
+                    break;
+                case models_1.ServiceEnum.EVALUATOR:
+                    this.services[name] = new services_1.EvaluatorService(config);
+                    break;
+                case models_1.ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new services_1.DeviceCredentialsService(config);
+                    break;
+                case models_1.ServiceEnum.TARGET:
+                    this.services[name] = new services_1.TargetService(config);
+                    break;
+            }
+        }
+        this.logger.debug(`Found service ${name}.`);
+        return this.services[name];
+    }
+    /**
+     * Gets the authentication service.
+     */
+    getAuthService() {
+        return this.getService(models_1.ServiceEnum.AUTH);
+    }
+    /**
+     * Gets the robot service.
+     */
+    getRobotService() {
+        return this.getService(models_1.ServiceEnum.ROBOT);
+    }
+    /**
+     * Gets the event service.
+     */
+    getEventService() {
+        return this.getService(models_1.ServiceEnum.EVENT);
+    }
+    /**
+     * Gets the project service.
+     */
+    getProjectService() {
+        return this.getService(models_1.ServiceEnum.PROJECT);
+    }
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService() {
+        return this.getService(models_1.ServiceEnum.TELEMETRY);
+    }
+    /**
+     * Gets the service call service.
+     */
+    getCallerService() {
+        return this.getService(models_1.ServiceEnum.CALLER);
+    }
+    /**
+     * Gets the command service.
+     */
+    getCommandService() {
+        return this.getService(models_1.ServiceEnum.COMMAND);
+    }
+    /**
+     * Gets the robot control service.
+     */
+    getControlService() {
+        return this.getService(models_1.ServiceEnum.CONTROL);
+    }
+    /**
+     * Gets the search service.
+     */
+    getSearchService() {
+        return this.getService(models_1.ServiceEnum.SEARCH);
+    }
+    /**
+     * Gets the config group service
+     */
+    getConfigGroupService() {
+        return this.getService(models_1.ServiceEnum.CONFIG_GROUP);
+    }
+    /**
+     * Gets the dashboard service
+     */
+    getDashboardService() {
+        return this.getService(models_1.ServiceEnum.DASHBOARD);
+    }
+    /**
+     * Gets the stream service
+     */
+    getStreamService() {
+        return this.getService(models_1.ServiceEnum.STREAM);
+    }
+    /**
+     * Gets the user service
+     */
+    getUserService() {
+        return this.getService(models_1.ServiceEnum.USER);
+    }
+    /**
+     * Gets time syncer service
+     */
+    getTimeSyncerService() {
+        return this.getService(models_1.ServiceEnum.TIME_SYNCER);
+    }
+    /**
+     * Gets the workflow service
+     */
+    getWorkflowService() {
+        return this.getService(models_1.ServiceEnum.WORKFLOW);
+    }
+    /**
+     * Gets the asset storage service
+     */
+    getAssetStorageService() {
+        return this.getService(models_1.ServiceEnum.ASSET_STORAGE);
+    }
+    /**
+     * Gets the robot profile service
+     */
+    getProfileService() {
+        return this.getService(models_1.ServiceEnum.PROFILE);
+    }
+    /**
+     * Gets the WebRTC signalling service
+     * @returns WebRTCSignallingService
+     */
+    getWebRTCSignallingService() {
+        return this.getService(models_1.ServiceEnum.WEBRTC_SIGNALLING);
+    }
+    /**
+     * Gets the WebRTC service
+     * @returns RTPWebRTCService
+     */
+    getRTPWebRTCService() {
+        return this.getService(models_1.ServiceEnum.RTP_WEBRTC);
+    }
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorService
+     */
+    getFileAccessorService() {
+        return this.getService(models_1.ServiceEnum.FILE_ACCESSOR);
+    }
+    /**
+     * Gets the scheduler service
+     * @returns FileAccessorService
+     */
+    getSchedulerService() {
+        return this.getService(models_1.ServiceEnum.SCHEDULE);
+    }
+    /**
+     * Gets the spot provisioner service
+     * @returns SpotProvisioningService
+     */
+    getSpotProvisionerService() {
+        return this.getService(models_1.ServiceEnum.SPOT_PROVISIONER);
+    }
+    /**
+     * Gets the integration service
+     * @returns IntegrationService
+     */
+    getIntegrationService() {
+        return this.getService(models_1.ServiceEnum.INTEGRATION);
+    }
+    /**
+     * Gets the map service
+     * @returns MapService
+     */
+    getMapService() {
+        return this.getService(models_1.ServiceEnum.MAP);
+    }
+    /**
+     * Gets the evaluator service
+     * @returns EvaluatorService
+     */
+    getEvaluatorService() {
+        return this.getService(models_1.ServiceEnum.EVALUATOR);
+    }
+    /**
+     * Gets the device credentials service.
+     * @returns DeviceCredentialsService
+     */
+    getDeviceCredentialsService() {
+        return this.getService(models_1.ServiceEnum.DEVICE_CREDENTIALS);
+    }
+    /**
+     * Gets the asset service.
+     * @returns AssetService
+     */
+    getTargetService() {
+        return this.getService(models_1.ServiceEnum.TARGET);
+    }
+    get platformTimeOffset() {
+        return services_1.PlatFormTimeService.getInstance(this.getTimeSyncerService())?.platformTimeOffset;
+    }
+    get platformTime() {
+        return services_1.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_1.RocosStore.removeSDKInstance(this.config);
+        return StreamRegister_1.StreamRegister.getInstance().removeAllStreams();
+    }
+    /**
+     * Enable or disable debug log
+     *
+     * @param on
+     */
+    enableDebugMode(on) {
+        if (on) {
+            RocosLogger_1.RocosLogger.enableAll();
+        }
+        else {
+            RocosLogger_1.RocosLogger.disableAll();
+        }
+    }
+    setDebugLevel(level) {
+        RocosLogger_1.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,
+        };
+    }
+}
+exports.RocosSDK = RocosSDK;

package/cjs/api/StreamRegister.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamRegister = void 0;
+const models_1 = require("../models");
+const RocosLogger_1 = require("../logger/RocosLogger");
+class StreamRegister {
+    constructor() {
+        this.teleStreams = new Map();
+        this.logger = RocosLogger_1.RocosLogger.getInstance('StreamRegister');
+    }
+    static getInstance() {
+        if (!StreamRegister.instance) {
+            StreamRegister.instance = new StreamRegister();
+        }
+        return StreamRegister.instance;
+    }
+    static getIdentifier($identifier, scope) {
+        return `${$identifier}-${scope ?? ''}`;
+    }
+    async addStream(stream) {
+        try {
+            if (this.teleStreams.has(stream.identifier)) {
+                await this.removeStream(stream);
+            }
+            this.teleStreams.set(stream.identifier, stream);
+        }
+        catch (e) {
+            this.logger.error(`Failed to add stream to list. identifier: ${stream.identifier}`, e);
+            if (e instanceof Error || typeof e === 'string') {
+                throw new models_1.RocosError(e, models_1.errorCodes.STREAM_LISTENER_ERROR);
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    getStream(identifier) {
+        return this.teleStreams.get(identifier);
+    }
+    async removeStream(stream) {
+        try {
+            await stream.stopStream();
+            this.teleStreams.delete(stream.identifier);
+        }
+        catch (e) {
+            this.logger.error(`Failed to remove stream from list. identifier: ${stream.identifier}`, e);
+            if (e instanceof Error || typeof e === 'string') {
+                throw new models_1.RocosError(e, models_1.errorCodes.STREAM_LISTENER_ERROR);
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    async removeAllStreams() {
+        try {
+            for (const [, stream] of this.teleStreams.entries()) {
+                await this.removeStream(stream);
+            }
+        }
+        catch (e) {
+            this.logger.error(`error removing stream, ${e}`);
+            if (e instanceof Error || typeof e === 'string') {
+                throw new models_1.RocosError(e, models_1.errorCodes.STREAM_LISTENER_ERROR);
+            }
+            else {
+                throw e;
+            }
+        }
+        return true;
+    }
+}
+exports.StreamRegister = StreamRegister;