@dronedeploy/rocos-js-sdk 1.0.0-alpha-2 → 2.6.1

package/IRocosSDK.js

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

package/README.md

@@ -1,8 +1,6 @@
 # rocos-js-sdk
 Javascript SDK for interacting with the Rocos platform.
 
-## Using with Node
-In order to use the SDK with node, you must be using node version 18.13 or higher.
 
 ## Installation
 
@@ -25,22 +23,6 @@ yarn add @team-rocos/rocos-js-sdk rxjs@^7
 ```
 ## What's New?
 
-### 3.0.0
-
-*Breaking Changes*
-* `IToken` interface changes
-  * `created` is now `issuedAt` and is a `Date` object instead of a `string`
-  * `expiresIn` is now `expires` and is a `Date` object instead of a `number`
-* `Token` class is now only functional for JWT tokens
-* Logging in and signing up with email and password has been removed
-* Resetting password has been removed
-
-*New Features*
-* NodeJS requirement has been dropped, so that the SDK can be used in the browser regardless of node version. When using node SDK, you must be using node version 18.13 or higher.
-* `AuthService` now supports `refreshToken` method to refresh the access token
-* Auth Token will now be refreshed automatically when it expires
-
-
 ### 2.6.1
 
 * Modify map service response type

package/RocosSDK.js

@@ -1,9 +1,12 @@
-import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, 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 {
+"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.
      *
@@ -12,8 +15,8 @@ export class RocosSDK {
     constructor(config) {
         this.services = {};
         this.config = config;
-        this.logger = RocosLogger.getInstance(`RocosSDK(${this.config.url})`);
-        RocosStore.putSDKInstance(this.config, this);
+        this.logger = RocosLogger_1.RocosLogger.getInstance(`RocosSDK(${this.config.url})`);
+        RocosStore_1.RocosStore.putSDKInstance(this.config, this);
     }
     /**
      * Gets the service by service name.
@@ -22,80 +25,81 @@ export class RocosSDK {
      */
     // eslint-disable-next-line max-lines-per-function
     getService(name) {
-        if (!this.services?.[name]) {
+        var _a;
+        if (!((_a = this.services) === null || _a === void 0 ? void 0 : _a[name])) {
             this.logger.info(`Service ${name} does not exist, creating it now.`);
             switch (name) {
-                case ServiceEnum.AUTH:
-                    this.services[name] = new AuthService(this.config);
+                case models_1.ServiceEnum.AUTH:
+                    this.services[name] = new services_1.AuthService(this.config);
                     break;
-                case ServiceEnum.TELEMETRY:
-                    this.services[name] = new TelemetryService(this.config);
+                case models_1.ServiceEnum.TELEMETRY:
+                    this.services[name] = new services_1.TelemetryService(this.config);
                     break;
-                case ServiceEnum.ROBOT:
-                    this.services[name] = new RobotService(this.config);
+                case models_1.ServiceEnum.ROBOT:
+                    this.services[name] = new services_1.RobotService(this.config);
                     break;
-                case ServiceEnum.EVENT:
-                    this.services[name] = new EventService(this.config);
+                case models_1.ServiceEnum.EVENT:
+                    this.services[name] = new services_1.EventService(this.config);
                     break;
-                case ServiceEnum.PROJECT:
-                    this.services[name] = new ProjectService(this.config);
+                case models_1.ServiceEnum.PROJECT:
+                    this.services[name] = new services_1.ProjectService(this.config);
                     break;
-                case ServiceEnum.CALLER:
-                    this.services[name] = new CallerService(this.config);
+                case models_1.ServiceEnum.CALLER:
+                    this.services[name] = new services_1.CallerService(this.config);
                     break;
-                case ServiceEnum.COMMAND:
-                    this.services[name] = new CommandService(this.config);
+                case models_1.ServiceEnum.COMMAND:
+                    this.services[name] = new services_1.CommandService(this.config);
                     break;
-                case ServiceEnum.CONTROL:
-                    this.services[name] = new ControlService(this.config);
+                case models_1.ServiceEnum.CONTROL:
+                    this.services[name] = new services_1.ControlService(this.config);
                     break;
-                case ServiceEnum.SEARCH:
-                    this.services[name] = new SearchService(this.config);
+                case models_1.ServiceEnum.SEARCH:
+                    this.services[name] = new services_1.SearchService(this.config);
                     break;
-                case ServiceEnum.CONFIG_GROUP:
-                    this.services[name] = new ConfigGroupService(this.config);
+                case models_1.ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new services_1.ConfigGroupService(this.config);
                     break;
-                case ServiceEnum.DASHBOARD:
-                    this.services[name] = new DashboardService(this.config);
+                case models_1.ServiceEnum.DASHBOARD:
+                    this.services[name] = new services_1.DashboardService(this.config);
                     break;
-                case ServiceEnum.FUNCTION:
-                    this.services[name] = new FunctionService(this.config);
+                case models_1.ServiceEnum.FUNCTION:
+                    this.services[name] = new services_1.FunctionService(this.config);
                     break;
-                case ServiceEnum.STREAM:
-                    this.services[name] = new StreamService(this.config);
+                case models_1.ServiceEnum.STREAM:
+                    this.services[name] = new services_1.StreamService(this.config);
                     break;
-                case ServiceEnum.USER:
-                    this.services[name] = new UserService(this.config);
+                case models_1.ServiceEnum.USER:
+                    this.services[name] = new services_1.UserService(this.config);
                     break;
-                case ServiceEnum.TIME_SYNCER:
-                    this.services[name] = new TimeSyncerService(this.config);
+                case models_1.ServiceEnum.TIME_SYNCER:
+                    this.services[name] = new services_1.TimeSyncerService(this.config);
                     break;
-                case ServiceEnum.WORKFLOW:
-                    this.services[name] = new WorkflowService(this.config);
+                case models_1.ServiceEnum.WORKFLOW:
+                    this.services[name] = new services_1.WorkflowService(this.config);
                     break;
-                case ServiceEnum.ASSET_STORAGE:
-                    this.services[name] = new AssetStorageService(this.config);
+                case models_1.ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new services_1.AssetStorageService(this.config);
                     break;
-                case ServiceEnum.PROFILE:
-                    this.services[name] = new ProfileService(this.config);
+                case models_1.ServiceEnum.PROFILE:
+                    this.services[name] = new services_1.ProfileService(this.config);
                     break;
-                case ServiceEnum.WEBRTC_SIGNALLING:
-                    this.services[name] = new WebRTCSignallingService(this.config);
+                case models_1.ServiceEnum.WEBRTC_SIGNALLING:
+                    this.services[name] = new services_1.WebRTCSignallingService(this.config);
                     break;
-                case ServiceEnum.FILE_ACCESSOR:
-                    this.services[name] = new FileAccessorService(this.config);
+                case models_1.ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new services_1.FileAccessorService(this.config);
                     break;
-                case ServiceEnum.SCHEDULE:
-                    this.services[name] = new ScheduleService(this.config);
+                case models_1.ServiceEnum.SCHEDULE:
+                    this.services[name] = new services_1.ScheduleService(this.config);
                     break;
-                case ServiceEnum.SPOT_PROVISIONER:
-                    this.services[name] = new SpotProvisioningService(this.config);
+                case models_1.ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new services_1.SpotProvisioningService(this.config);
                     break;
-                case ServiceEnum.INTEGRATION:
-                    this.services[name] = new IntegrationService(this.config);
+                case models_1.ServiceEnum.INTEGRATION:
+                    this.services[name] = new services_1.IntegrationService(this.config);
                     break;
-                case ServiceEnum.MAP:
-                    this.services[name] = new MapService(this.config);
+                case models_1.ServiceEnum.MAP:
+                    this.services[name] = new services_1.MapService(this.config);
                     break;
             }
         }
@@ -106,157 +110,159 @@ export class RocosSDK {
      * GEts the authentication service.
      */
     getAuthService() {
-        return this.getService(ServiceEnum.AUTH);
+        return this.getService(models_1.ServiceEnum.AUTH);
     }
     /**
      * Gets the robot service.
      */
     getRobotService() {
-        return this.getService(ServiceEnum.ROBOT);
+        return this.getService(models_1.ServiceEnum.ROBOT);
     }
     /**
      * Gets the event service.
      */
     getEventService() {
-        return this.getService(ServiceEnum.EVENT);
+        return this.getService(models_1.ServiceEnum.EVENT);
     }
     /**
      * Gets the project service.
      */
     getProjectService() {
-        return this.getService(ServiceEnum.PROJECT);
+        return this.getService(models_1.ServiceEnum.PROJECT);
     }
     /**
      * Gets the telemetry service.
      */
     getTelemetryService() {
-        return this.getService(ServiceEnum.TELEMETRY);
+        return this.getService(models_1.ServiceEnum.TELEMETRY);
     }
     /**
      * Gets the service call service.
      */
     getCallerService() {
-        return this.getService(ServiceEnum.CALLER);
+        return this.getService(models_1.ServiceEnum.CALLER);
     }
     /**
      * Gets the command service.
      */
     getCommandService() {
-        return this.getService(ServiceEnum.COMMAND);
+        return this.getService(models_1.ServiceEnum.COMMAND);
     }
     /**
      * Gets the robot control service.
      */
     getControlService() {
-        return this.getService(ServiceEnum.CONTROL);
+        return this.getService(models_1.ServiceEnum.CONTROL);
     }
     /**
      * Gets the search service.
      */
     getSearchService() {
-        return this.getService(ServiceEnum.SEARCH);
+        return this.getService(models_1.ServiceEnum.SEARCH);
     }
     /**
      * Gets the config group service
      */
     getConfigGroupService() {
-        return this.getService(ServiceEnum.CONFIG_GROUP);
+        return this.getService(models_1.ServiceEnum.CONFIG_GROUP);
     }
     /**
      * Gets the dashboard service
      */
     getDashboardService() {
-        return this.getService(ServiceEnum.DASHBOARD);
+        return this.getService(models_1.ServiceEnum.DASHBOARD);
     }
     /**
      * Gets the function service
      */
     getFunctionService() {
-        return this.getService(ServiceEnum.FUNCTION);
+        return this.getService(models_1.ServiceEnum.FUNCTION);
     }
     /**
      * Gets the stream service
      */
     getStreamService() {
-        return this.getService(ServiceEnum.STREAM);
+        return this.getService(models_1.ServiceEnum.STREAM);
     }
     /**
      * Gets the user service
      */
     getUserService() {
-        return this.getService(ServiceEnum.USER);
+        return this.getService(models_1.ServiceEnum.USER);
     }
     /**
      * Gets time syncer service
      */
     getTimeSyncerService() {
-        return this.getService(ServiceEnum.TIME_SYNCER);
+        return this.getService(models_1.ServiceEnum.TIME_SYNCER);
     }
     /**
      * Gets the workflow service
      */
     getWorkflowService() {
-        return this.getService(ServiceEnum.WORKFLOW);
+        return this.getService(models_1.ServiceEnum.WORKFLOW);
     }
     /**
      * Gets the asset storage service
      */
     getAssetStorageService() {
-        return this.getService(ServiceEnum.ASSET_STORAGE);
+        return this.getService(models_1.ServiceEnum.ASSET_STORAGE);
     }
     /**
      * Gets the robot profile service
      */
     getProfileService() {
-        return this.getService(ServiceEnum.PROFILE);
+        return this.getService(models_1.ServiceEnum.PROFILE);
     }
     /**
      * Gets the WebRTC signalling service
      * @returns WebRTCSignallingService
      */
     getWebRTCSignallingService() {
-        return this.getService(ServiceEnum.WEBRTC_SIGNALLING);
+        return this.getService(models_1.ServiceEnum.WEBRTC_SIGNALLING);
     }
     /**
      * Gets the file accessor service
      * @returns FileAccessorService
      */
     getFileAccessorService() {
-        return this.getService(ServiceEnum.FILE_ACCESSOR);
+        return this.getService(models_1.ServiceEnum.FILE_ACCESSOR);
     }
     /**
      * Gets the scheduler service
      * @returns FileAccessorService
      */
     getSchedulerService() {
-        return this.getService(ServiceEnum.SCHEDULE);
+        return this.getService(models_1.ServiceEnum.SCHEDULE);
     }
     /**
      * Gets the spot provisioner service
      * @returns SpotProvisioningService
      */
     getSpotProvisionerService() {
-        return this.getService(ServiceEnum.SPOT_PROVISIONER);
+        return this.getService(models_1.ServiceEnum.SPOT_PROVISIONER);
     }
     /**
      * Gets the integration service
      * @returns IntegrationService
      */
     getIntegrationService() {
-        return this.getService(ServiceEnum.INTEGRATION);
+        return this.getService(models_1.ServiceEnum.INTEGRATION);
     }
     /**
      * Gets the map service
      * @returns MapService
      */
     getMapService() {
-        return this.getService(ServiceEnum.MAP);
+        return this.getService(models_1.ServiceEnum.MAP);
     }
     get platformTimeOffset() {
-        return PlatFormTimeService.getInstance(this.getTimeSyncerService())?.platformTimeOffset;
+        var _a;
+        return (_a = services_1.PlatFormTimeService.getInstance(this.getTimeSyncerService())) === null || _a === void 0 ? void 0 : _a.platformTimeOffset;
     }
     get platformTime() {
-        return PlatFormTimeService.getInstance(this.getTimeSyncerService())?.platformTime;
+        var _a;
+        return (_a = services_1.PlatFormTimeService.getInstance(this.getTimeSyncerService())) === null || _a === void 0 ? void 0 : _a.platformTime;
     }
     /**
      * Cleanup function to release all the stream resources.
@@ -264,14 +270,9 @@ export class RocosSDK {
      * 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();
+        RocosStore_1.RocosStore.removeSDKInstance(this.config);
+        return StreamRegister_1.StreamRegister.getInstance().removeAllStreams();
     }
     /**
      * Enable or disable debug log
@@ -280,13 +281,14 @@ export class RocosSDK {
      */
     enableDebugMode(on) {
         if (on) {
-            RocosLogger.enableAll();
+            RocosLogger_1.RocosLogger.enableAll();
         }
         else {
-            RocosLogger.disableAll();
+            RocosLogger_1.RocosLogger.disableAll();
         }
     }
     setDebugLevel(level) {
-        RocosLogger.setLevel(level);
+        RocosLogger_1.RocosLogger.setLevel(level);
     }
 }
+exports.RocosSDK = RocosSDK;

package/api/StreamRegister.d.ts

@@ -1,4 +1,4 @@
-import { IBaseStream } from '../models';
+import { IBaseStream } from '../models/stream/IBaseStream';
 export declare class StreamRegister {
     private teleStreams;
     private logger;

package/api/StreamRegister.js

@@ -1,9 +1,12 @@
-import { RocosError, errorCodes } from '../models';
-import { RocosLogger } from '../logger/RocosLogger';
-export class StreamRegister {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamRegister = void 0;
+const RocosError_1 = require("../models/RocosError");
+const RocosLogger_1 = require("../logger/RocosLogger");
+class StreamRegister {
     constructor() {
         this.teleStreams = new Map();
-        this.logger = RocosLogger.getInstance('StreamRegister');
+        this.logger = RocosLogger_1.RocosLogger.getInstance('StreamRegister');
     }
     static getInstance() {
         if (!StreamRegister.instance) {
@@ -12,7 +15,7 @@ export class StreamRegister {
         return StreamRegister.instance;
     }
     static getIdentifier($identifier, scope) {
-        return `${$identifier}-${scope ?? ''}`;
+        return `${$identifier}-${scope !== null && scope !== void 0 ? scope : ''}`;
     }
     async addStream(stream) {
         try {
@@ -23,12 +26,7 @@ export class StreamRegister {
         }
         catch (e) {
             this.logger.error(`Failed to add stream to list. identifier: ${stream.identifier}`, e);
-            if (e instanceof Error || typeof e === 'string') {
-                throw new RocosError(e, errorCodes.STREAM_LISTENER_ERROR);
-            }
-            else {
-                throw e;
-            }
+            throw new RocosError_1.RocosError(e, RocosError_1.errorCodes.STREAM_LISTENER_ERROR);
         }
     }
     getStream(identifier) {
@@ -41,12 +39,7 @@ export class StreamRegister {
         }
         catch (e) {
             this.logger.error(`Failed to remove stream from list. identifier: ${stream.identifier}`, e);
-            if (e instanceof Error || typeof e === 'string') {
-                throw new RocosError(e, errorCodes.STREAM_LISTENER_ERROR);
-            }
-            else {
-                throw e;
-            }
+            throw new RocosError_1.RocosError(e, RocosError_1.errorCodes.STREAM_LISTENER_ERROR);
         }
     }
     async removeAllStreams() {
@@ -57,13 +50,9 @@ export class StreamRegister {
         }
         catch (e) {
             this.logger.error(`error removing stream, ${e}`);
-            if (e instanceof Error || typeof e === 'string') {
-                throw new RocosError(e, errorCodes.STREAM_LISTENER_ERROR);
-            }
-            else {
-                throw e;
-            }
+            throw new RocosError_1.RocosError(e, RocosError_1.errorCodes.STREAM_LISTENER_ERROR);
         }
         return true;
     }
 }
+exports.StreamRegister = StreamRegister;

package/api/atoms/StreamHeartbeat.js

@@ -1,5 +1,8 @@
-import { RocosLogger } from '../../logger/RocosLogger';
-export class StreamHeartbeat {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamHeartbeat = void 0;
+const RocosLogger_1 = require("../../logger/RocosLogger");
+class StreamHeartbeat {
     constructor(identifier) {
         this.beats = 0;
         this.healthLastSeenDate = new Date();
@@ -8,7 +11,7 @@ export class StreamHeartbeat {
         this.healthMaxTimeout = 10;
         this.healthMaxMisses = 5;
         this.identifier = identifier;
-        this.logger = RocosLogger.getInstance(`StreamHeartbeat(${this.identifier})`);
+        this.logger = RocosLogger_1.RocosLogger.getInstance(`StreamHeartbeat(${this.identifier})`);
     }
     setHealthTimeout(healthTimeout) {
         this.healthTimeout = healthTimeout;
@@ -109,3 +112,4 @@ export class StreamHeartbeat {
         }
     }
 }
+exports.StreamHeartbeat = StreamHeartbeat;

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

@@ -1,13 +1,13 @@
-import { ICallerParams, IRocosCallerMessage, IStreamConfig } from '../../../models';
 import { Observable } from 'rxjs';
-import { RequestCancellation, ServiceRequest } from '../../../grpc/serviette.v1_pb';
+import { RequestCancellation, ServiceRequest } from '../../../grpc/serviette/serviette.v1_pb';
 import { CallerStreamAbstract } from './CallerStreamAbstract';
+import { ICallerParams } from '../../../models/params/ICallerParams';
+import { IRocosCallerMessage } from '../../../models/message/IRocosCallerMessage';
+import { IStreamConfig } from '../../../models/IStreamConfig';
 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;
+    protected callStream(request: ServiceRequest | RequestCancellation, params: ICallerParams): Observable<IRocosCallerMessage>;
+    protected setPayload(request: ServiceRequest, payload: string): void;
     private getMetadata;
 }