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

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/command/CommandStream.js

@@ -1,66 +0,0 @@
-import { RocosCommandMessage, SubscriberStatusEnum, } from '../../../models';
-import { Observable } from 'rxjs';
-import { CommandClient } from '../../../grpc/rambo.v1_pb.client';
-import { CommandStreamAbstract } from './CommandStreamAbstract';
-import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
-import { RocosLogger } from '../../../logger/RocosLogger';
-export class CommandStream extends CommandStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`CommandStream(${this.identifier})`);
-        const protocol = config.insecure ? 'http' : 'https';
-        const transport = new GrpcWebFetchTransport({
-            baseUrl: `${protocol}://${this.url}`,
-        });
-        this.client = new CommandClient(transport);
-    }
-    callStream(request, params) {
-        const metadata = this.getMetadata(params.projectId, params.callsign);
-        const abortController = new AbortController();
-        return new Observable((emitter) => {
-            const call = this.client.callCommand(request, { meta: metadata, abort: abortController.signal });
-            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-            this.statusStream$.next(this.subscriberStatus);
-            call.responses.onMessage((update) => {
-                const message = RocosCommandMessage.fromModel(update);
-                emitter.next(message);
-                this.logger.debug('invokeRequest - on(data)', {
-                    message,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    commandId: params.commandId,
-                });
-            });
-            call.responses.onError((error) => {
-                this.logger.debug('invokeRequest - on(error)', {
-                    error,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    commandId: params.commandId,
-                });
-                emitter.error(error);
-            });
-            call.responses.onComplete(() => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug('invokeRequest - on(end)', {
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    commandId: params.commandId,
-                });
-                emitter.complete();
-            });
-            return () => {
-                this.logger.debug('unsubscribing commandStream');
-                abortController.abort();
-            };
-        });
-    }
-    getMetadata(projectId, callsign) {
-        return {
-            'authorization': this.token,
-            'r-p': projectId,
-            'r-cs': callsign,
-        };
-    }
-}

package/api/streams/control/ControlStream.js

@@ -1,75 +0,0 @@
-import { RocosControlMessage, SubscriberStatusEnum, } from '../../../models';
-import { Observable } from 'rxjs';
-import { ControlStreamAbstract } from './ControlStreamAbstract';
-import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
-import { RobotControlClient } from '../../../grpc/conker_pb.client';
-import { RocosLogger } from '../../../logger/RocosLogger';
-import { stringToUint8Array } from '../../../helpers/stringToUint8Array';
-export class ControlStream extends ControlStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`ControlStream(${this.identifier})`);
-        const protocol = config.insecure ? 'http' : 'https';
-        const transport = new GrpcWebFetchTransport({
-            baseUrl: `${protocol}://${this.url}`,
-        });
-        this.client = new RobotControlClient(transport);
-    }
-    async controlRobotCall(request, params) {
-        const metadata = this.getMetadata(params.projectId, params.callsign);
-        await this.client.controlRobotCall(request, { meta: metadata });
-    }
-    controlRobotCallWithAckStream(request, params) {
-        const metadata = this.getMetadata(params.projectId, params.callsign);
-        const abortController = new AbortController();
-        return new Observable((emitter) => {
-            // Send the message to back-end.
-            const call = this.client.controlRobotCallWithAckStream(request, { meta: metadata, abort: abortController.signal });
-            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-            this.statusStream$.next(this.subscriberStatus);
-            call.responses.onMessage((update) => {
-                const message = RocosControlMessage.fromMessage(update);
-                emitter.next(message);
-                this.logger.debug('controlRobotCallWithAckStream - on(data)', {
-                    message,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    destination: params.destination,
-                });
-            });
-            call.responses.onComplete(() => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug('controlRobotCallWithAckStream - on(end)', {
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    destination: params.destination,
-                });
-                emitter.complete();
-            });
-            call.responses.onError((error) => {
-                this.logger.debug('controlRobotCallWithAckStream- on(error)', {
-                    error,
-                    projectId: params.projectId,
-                    callsign: params.callsign,
-                    destination: params.destination,
-                });
-                emitter.error(error);
-            });
-            return () => {
-                this.logger.debug('unsubscribing controlRobotCallWithAckStream');
-                abortController.abort();
-            };
-        });
-    }
-    getPayload(payload) {
-        return stringToUint8Array(payload);
-    }
-    getMetadata(projectId, callsign) {
-        return {
-            'authorization': this.token,
-            'r-p': projectId,
-            'r-cs': callsign,
-        };
-    }
-}

package/api/streams/fileAccessor/FileAccessorStream.js

@@ -1,59 +0,0 @@
-import { OpRequestTarget, RocosOpResultMessage, SubscriberStatusEnum, } from '../../../models';
-import { FilagreeClient } from '../../../grpc/filagree_pb.client';
-import { FileAccessorStreamAbstract } from './FileAccessorStreamAbstract';
-import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
-import { OpRequests } from '../../../grpc/filagree_pb';
-import { RocosLogger } from '../../../logger/RocosLogger';
-export class FileAccessorStream extends FileAccessorStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`FileAccessorStream(${this.identifier})`);
-        const protocol = config.insecure ? 'http' : 'https';
-        const transport = new GrpcWebFetchTransport({
-            baseUrl: `${protocol}://${this.url}`,
-        });
-        this.client = new FilagreeClient(transport);
-    }
-    async serverReqOpInternal(params) {
-        this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-        this.statusStream$.next(this.subscriberStatus);
-        this.logger.debug('serverReqOp - request', {
-            status: this.subscriberStatus,
-            projectId: params.projectId,
-            callsign: params.callsign,
-        });
-        const metadata = this.getMetadata(params.projectId, params.callsign);
-        const reqs = OpRequests.create({
-            requests: [
-                {
-                    opcode: params.opCode.valueOf(),
-                    path: params.path,
-                    target: params.target?.valueOf() ?? OpRequestTarget.AGENT,
-                    args: params.args,
-                },
-            ],
-        });
-        const response = await this.client.serverReqOp(reqs, { meta: metadata }).response;
-        this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-        this.statusStream$.next(this.subscriberStatus);
-        this.logger.debug('serverReqOp - response', {
-            status: this.subscriberStatus,
-            projectId: params.projectId,
-            callsign: params.callsign,
-        });
-        if (response) {
-            return RocosOpResultMessage.fromMessages(response);
-        }
-        throw new Error('Error in serverReqOp call');
-    }
-    getMetadata(projectId, callsign) {
-        const result = { authorization: this.token };
-        if (projectId) {
-            result['r-p'] = projectId;
-        }
-        if (callsign) {
-            result['r-cs'] = callsign;
-        }
-        return result;
-    }
-}

package/api/streams/search/SearchStream.js

@@ -1,96 +0,0 @@
-import { DeleteProjectMessage, Empty } from '../../../grpc/slowlane_pb';
-import { RocosSearchMessage, SubscriberStatusEnum, } from '../../../models';
-import { Observable } from 'rxjs';
-import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
-import { RocosLogger } from '../../../logger/RocosLogger';
-import { SearchStreamAbstract } from './SearchStreamAbstract';
-import { streamClient } from '../../../grpc/slowlane_pb.client';
-export class SearchStream extends SearchStreamAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`SearchStream(${this.identifier})`);
-        const protocol = config.insecure ? 'http' : 'https';
-        const transport = new GrpcWebFetchTransport({
-            baseUrl: `${protocol}://${this.url}`,
-        });
-        this.client = new streamClient(transport);
-    }
-    searchStreamInternal(request, params) {
-        const metadata = this.getMetadata(params.projectId);
-        const abortController = new AbortController();
-        return new Observable((emitter) => {
-            const call = this.client.searchStream(request, { meta: metadata, abort: abortController.signal });
-            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
-            this.statusStream$.next(this.subscriberStatus);
-            call.responses.onMessage((update) => {
-                const dataSetList = update.dataset;
-                const results = dataSetList.map((item) => {
-                    return RocosSearchMessage.fromMessage(item);
-                });
-                emitter.next(results);
-                this.logger.debug('searchStream - on(data)', {
-                    status: this.subscriberStatus,
-                    projectId: params.projectId,
-                    query: params.query,
-                });
-            });
-            call.responses.onComplete(() => {
-                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
-                this.statusStream$.next(this.subscriberStatus);
-                this.logger.debug('searchStream - on(end)', {
-                    status: this.subscriberStatus,
-                    projectId: params.projectId,
-                    query: params.query,
-                });
-                emitter.complete();
-            });
-            call.responses.onError((error) => {
-                this.logger.debug('searchStream - on(error)', {
-                    status: this.subscriberStatus,
-                    projectId: params.projectId,
-                    query: params.query,
-                    error,
-                });
-                emitter.error(error);
-            });
-            return () => {
-                this.logger.debug('unsubscribing searchStream');
-                abortController.abort();
-            };
-        });
-    }
-    async queryDataInternal(request, params) {
-        const metadata = this.getMetadata(params.projectId);
-        const response = await this.client.queryData(request, { meta: metadata }).response;
-        if (!response) {
-            throw new Error('Error with search query.');
-        }
-        return response.result;
-    }
-    async healthCheckInternal(params) {
-        const request = Empty.create();
-        const metadata = this.getMetadata(params.projectId);
-        const response = await this.client.healthCheck(request, { meta: metadata }).response;
-        if (!response) {
-            throw new Error('Error with health check.');
-        }
-        return response;
-    }
-    async deleteProjectDataInternal(params) {
-        const request = DeleteProjectMessage.create({
-            projectId: params.projectId,
-        });
-        const metadata = this.getMetadata(params.projectId);
-        const response = await this.client.deleteProjectData(request, { meta: metadata }).response;
-        if (!response) {
-            throw new Error('Error with deleting project data.');
-        }
-        return response;
-    }
-    getMetadata(projectId) {
-        return {
-            'authorization': this.token,
-            'r-p': projectId,
-        };
-    }
-}