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

package/RocosSDK.d.ts

@@ -1,143 +0,0 @@
-import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, EvaluatorService, EventService, FileAccessorService, FunctionService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, ScheduleService, SearchService, SpotProvisioningService, StreamService, TelemetryService, TimeSyncerService, UserService, WebRTCSignallingService, WorkflowService } from './services';
-import { 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 function service
-     */
-    getFunctionService(): FunctionService;
-    /**
-     * 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 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;
-    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;
-}

package/RocosSDK.js

@@ -1,302 +0,0 @@
-import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, EvaluatorService, EventService, FileAccessorService, FunctionService, IntegrationService, MapService, PlatFormTimeService, ProfileService, ProjectService, RobotService, ScheduleService, SearchService, SpotProvisioningService, StreamService, 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.`);
-            switch (name) {
-                case ServiceEnum.AUTH:
-                    this.services[name] = new AuthService(this.config);
-                    break;
-                case ServiceEnum.TELEMETRY:
-                    this.services[name] = new TelemetryService(this.config);
-                    break;
-                case ServiceEnum.ROBOT:
-                    this.services[name] = new RobotService(this.config);
-                    break;
-                case ServiceEnum.EVENT:
-                    this.services[name] = new EventService(this.config);
-                    break;
-                case ServiceEnum.PROJECT:
-                    this.services[name] = new ProjectService(this.config);
-                    break;
-                case ServiceEnum.CALLER:
-                    this.services[name] = new CallerService(this.config);
-                    break;
-                case ServiceEnum.COMMAND:
-                    this.services[name] = new CommandService(this.config);
-                    break;
-                case ServiceEnum.CONTROL:
-                    this.services[name] = new ControlService(this.config);
-                    break;
-                case ServiceEnum.SEARCH:
-                    this.services[name] = new SearchService(this.config);
-                    break;
-                case ServiceEnum.CONFIG_GROUP:
-                    this.services[name] = new ConfigGroupService(this.config);
-                    break;
-                case ServiceEnum.DASHBOARD:
-                    this.services[name] = new DashboardService(this.config);
-                    break;
-                case ServiceEnum.FUNCTION:
-                    this.services[name] = new FunctionService(this.config);
-                    break;
-                case ServiceEnum.STREAM:
-                    this.services[name] = new StreamService(this.config);
-                    break;
-                case ServiceEnum.USER:
-                    this.services[name] = new UserService(this.config);
-                    break;
-                case ServiceEnum.TIME_SYNCER:
-                    this.services[name] = new TimeSyncerService(this.config);
-                    break;
-                case ServiceEnum.WORKFLOW:
-                    this.services[name] = new WorkflowService(this.config);
-                    break;
-                case ServiceEnum.ASSET_STORAGE:
-                    this.services[name] = new AssetStorageService(this.config);
-                    break;
-                case ServiceEnum.PROFILE:
-                    this.services[name] = new ProfileService(this.config);
-                    break;
-                case ServiceEnum.WEBRTC_SIGNALLING:
-                    this.services[name] = new WebRTCSignallingService(this.config);
-                    break;
-                case ServiceEnum.FILE_ACCESSOR:
-                    this.services[name] = new FileAccessorService(this.config);
-                    break;
-                case ServiceEnum.SCHEDULE:
-                    this.services[name] = new ScheduleService(this.config);
-                    break;
-                case ServiceEnum.SPOT_PROVISIONER:
-                    this.services[name] = new SpotProvisioningService(this.config);
-                    break;
-                case ServiceEnum.INTEGRATION:
-                    this.services[name] = new IntegrationService(this.config);
-                    break;
-                case ServiceEnum.MAP:
-                    this.services[name] = new MapService(this.config);
-                    break;
-                case ServiceEnum.EVALUATOR:
-                    this.services[name] = new EvaluatorService(this.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 function service
-     */
-    getFunctionService() {
-        return this.getService(ServiceEnum.FUNCTION);
-    }
-    /**
-     * 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 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);
-    }
-    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);
-    }
-}

package/api/streams/caller/CallerStream.js

@@ -1,77 +0,0 @@
-import { RocosCallerMessage, SubscriberStatusEnum, } from '../../../models';
-import { Observable } from 'rxjs';
-import { CallerStreamAbstract } from './CallerStreamAbstract';
-import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
-import { RocosLogger } from '../../../logger/RocosLogger';
-import { WebServiceCallerClient } from '../../../grpc/serviette.v1_pb.client';
-import { stringToUint8Array } from '../../../helpers/stringToUint8Array';
-export class CallerStream extends CallerStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`CallerStream(${this.identifier})`);
-        const protocol = config.insecure ? 'http' : 'https';
-        const transport = new GrpcWebFetchTransport({
-            baseUrl: `${protocol}://${this.url}`,
-        });
-        this.client = new WebServiceCallerClient(transport);
-    }
-    callService(request, params) {
-        const meta = this.getMetadata(params.projectId, params.callsign, params.subSystem);
-        const stream = this.client.callService(request, { meta });
-        return this.handleStream(stream, params, 'invoke');
-    }
-    cancelService(request, params) {
-        const meta = this.getMetadata(params.projectId, params.callsign, params.subSystem);
-        const stream = this.client.cancelService(request, { meta });
-        return this.handleStream(stream, params, 'cancel');
-    }
-    handleStream(stream, params, requestType) {
-        return new Observable((emitter) => {
-            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-            this.statusStream$.next(this.subscriberStatus);
-            stream.responses.onMessage((message) => {
-                const msg = RocosCallerMessage.fromModel(message);
-                emitter.next(msg);
-                this.logger.debug(`${requestType}Request - on(data)`, {
-                    message,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    component: params.component,
-                    topic: params.topic,
-                });
-            });
-            stream.responses.onError((error) => {
-                this.logger.debug(`${requestType}Request - on(error)`, {
-                    error,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    component: params.component,
-                    topic: params.topic,
-                });
-                emitter.error(error);
-            });
-            stream.responses.onComplete(() => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug(`${requestType}Request - on(end)`, {
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    component: params.component,
-                    topic: params.topic,
-                });
-                emitter.complete();
-            });
-        });
-    }
-    getPayload(payload) {
-        return stringToUint8Array(payload);
-    }
-    getMetadata(projectId, callsign, subsystem) {
-        return {
-            'authorization': this.token,
-            'r-p': projectId,
-            'r-cs': callsign,
-            'r-s': subsystem ?? '',
-        };
-    }
-}

package/api/streams/caller/CallerStreamNode.js

@@ -1,115 +0,0 @@
-import * as grpc from '@grpc/grpc-js';
-import { RocosCallerMessage, SubscriberStatusEnum, } from '../../../models';
-import { Observable } from 'rxjs';
-import { RequestChannelMessage, } from '../../../grpc/serviette.v1_pb';
-import { CallerStreamAbstract } from './CallerStreamAbstract';
-import { RocosLogger } from '../../../logger/RocosLogger';
-import { ServiceCallerClient } from '../../../grpc/serviette.v1_pb.grpc-client';
-export class CallerStreamNode extends CallerStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`CallerStreamNode(${this.identifier})`);
-        const port = config.port ?? 443;
-        const credentials = config.insecure ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
-        this.client = new ServiceCallerClient(`${this.url}:${port}`, credentials);
-    }
-    cancelService(request, params) {
-        return this.callStream(RequestChannelMessage.create({
-            content: {
-                oneofKind: 'cancellations',
-                cancellations: {
-                    cancellations: [request],
-                },
-            },
-        }), params, 'cancel');
-    }
-    callService(request, params) {
-        return this.callStream(RequestChannelMessage.create({
-            content: {
-                oneofKind: 'requests',
-                requests: {
-                    requests: [request],
-                },
-            },
-        }), params, 'invoke');
-    }
-    callStream(request, params, requestType) {
-        const metadata = this.getMetadata(params.projectId, params.callsign, params.subSystem);
-        let call;
-        return new Observable((emitter) => {
-            call = this.client.callServices(metadata);
-            this.logger.info(`${requestType}Request - call`);
-            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-            this.statusStream$.next(this.subscriberStatus);
-            call.write(request, () => {
-                if (this.logger.getLevel().valueOf() <= 2) {
-                    this.logger.info(`${requestType}Request write completed for - ${JSON.stringify(request, (_, v) => {
-                        return typeof v === 'bigint' ? `${v.toString()}n` : v;
-                    })}`);
-                }
-            });
-            call.on('data', (update) => {
-                const message = RocosCallerMessage.fromModel(update);
-                emitter.next(message);
-                this.logger.debug(`${requestType}Request - on(data)`, {
-                    message,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    component: params.component,
-                    topic: params.topic,
-                });
-            });
-            call.on('finish', () => {
-                this.logger.info(`${requestType}Request - on(finish) all writes are now complete`);
-                call.end();
-            });
-            call.on('end', () => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug(`${requestType}Request - on(end)`, {
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    component: params.component,
-                    topic: params.topic,
-                });
-                call.pause();
-                call.destroy();
-                this.client.close();
-                emitter.complete();
-            });
-            call.on('close', () => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug(`${requestType}Request - on(close)`);
-            });
-            call.on('error', (error) => {
-                this.subscriberStatus = SubscriberStatusEnum.ERROR;
-                this.statusStream$.next(this.subscriberStatus);
-                if (/10 ABORTED: heartbeat watchdog strike/.exec(error.stack)) {
-                    this.logger.debug(`${requestType}Request grpc Error heartbeat error`, error);
-                    call.end();
-                    emitter.complete();
-                }
-                else {
-                    this.logger.error(`${requestType}Request - on(error)`, error);
-                    emitter.error(error);
-                }
-            });
-            return () => {
-                this.logger.debug('unsubscribing callStream');
-                call.cancel();
-            };
-        });
-    }
-    getPayload(payload) {
-        return Buffer.from(payload);
-    }
-    getMetadata(projectId, callsign, subsystem) {
-        const meta = new grpc.Metadata();
-        meta.add('r-p', projectId);
-        meta.add('r-cs', callsign);
-        meta.add('r-s', subsystem ?? '');
-        meta.add('authorization', this.token);
-        return meta;
-    }
-}