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

package/node/RocosSDKNode.js

@@ -0,0 +1,143 @@
+import { MapService, ScheduleService, SpotProvisioningServiceNode } from '../services';
+import { AssetStorageService } from '../services/AssetStorageService';
+import { AuthService } from '../services/AuthService';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ConfigGroupService } from '../services/ConfigGroupService';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { DashboardService } from '../services/DashboardService';
+import { EventService } from '../services/EventService';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { FunctionService } from '../services/FunctionService';
+import { IntegrationService } from '../services/IntegrationService';
+import { ProfileService } from '../services/ProfileService';
+import { ProjectService } from '../services/ProjectService';
+import { RobotService } from '../services/RobotService';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+import { ServiceEnum } from '../models/ServiceEnum';
+import { StreamService } from '../services/StreamService';
+import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
+import { UserService } from '../services/UserService';
+import { WorkflowService } from '../services/WorkflowService';
+export class RocosSDKNode extends RocosSDK {
+    // 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 TelemetryServiceNode(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 CallerServiceNode(this.config);
+                    break;
+                case ServiceEnum.COMMAND:
+                    this.services[name] = new CommandServiceNode(this.config);
+                    break;
+                case ServiceEnum.CONTROL:
+                    this.services[name] = new ControlServiceNode(this.config);
+                    break;
+                case ServiceEnum.SEARCH:
+                    this.services[name] = new SearchServiceNode(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.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.FILE_ACCESSOR:
+                    this.services[name] = new FileAccessorServiceNode(this.config);
+                    break;
+                case ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new SpotProvisioningServiceNode(this.config);
+                    break;
+                case ServiceEnum.SCHEDULE:
+                    this.services[name] = new ScheduleService(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;
+            }
+        }
+        this.logger.debug(`Found service ${name}.`);
+        return this.services[name];
+    }
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService() {
+        return this.getService(ServiceEnum.TELEMETRY);
+    }
+    /**
+     * Gets the scheduler service.
+     */
+    getSchedulerService() {
+        return this.getService(ServiceEnum.SCHEDULE);
+    }
+    /**
+     * 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 file accessor service
+     * @returns FileAccessorServiceNode
+     */
+    getFileAccessorService() {
+        return this.getService(ServiceEnum.FILE_ACCESSOR);
+    }
+}

package/node/index.d.ts

@@ -0,0 +1,7 @@
+export * from './RocosSDKNode';
+export * from '../services/CallerServiceNode';
+export * from '../services/CommandServiceNode';
+export * from '../services/ControlServiceNode';
+export * from '../services/FileAccessorServiceNode';
+export * from '../services/SearchServiceNode';
+export * from '../services/TelemetryServiceNode';

package/node/index.js

@@ -0,0 +1,7 @@
+export * from './RocosSDKNode';
+export * from '../services/CallerServiceNode';
+export * from '../services/CommandServiceNode';
+export * from '../services/ControlServiceNode';
+export * from '../services/FileAccessorServiceNode';
+export * from '../services/SearchServiceNode';
+export * from '../services/TelemetryServiceNode';

package/package.json

@@ -1,11 +1,27 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "0.0.1",
-  "description": "placeholder package for now",
+  "version": "1.0.0-alpha-2",
+  "description": "Javascript SDK for rocos",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "types": "index.d.ts",
+  "author": "Rocos",
+  "scripts": {},
+  "license": "MIT",
+  "devDependencies": {},
+  "dependencies": {
+    "@grpc/grpc-js": "^1.7.1",
+    "@improbable-eng/grpc-web": "^0.14.0",
+    "@protobuf-ts/grpcweb-transport": "^2.9.1",
+    "@protobuf-ts/plugin": "^2.9.1",
+    "@protobuf-ts/runtime": "^2.9.1",
+    "buffer": "^6.0.3",
+    "loglevel": "^1.7.1",
+    "loglevel-plugin-prefix": "^0.8.4",
+    "uuid": "^9.0.0"
   },
-  "author": "",
-  "license": "ISC"
+  "peerDependencies": {
+    "rxjs": "^6.6.6 || ^7.0.0"
+  },
+  "repository": {},
+  "private": false
 }

package/services/AssetStorageService.d.ts

@@ -0,0 +1,99 @@
+import { AssetItemModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel } from '../models';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class AssetStorageService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Create a new project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     * @param file - File payload
+     */
+    create(projectId: string, filePath: string, file: File): Promise<any>;
+    /**
+     * Update a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     * @param file - File payload
+     */
+    update(projectId: string, filePath: string, file: File): Promise<any>;
+    /**
+     * Delete a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    delete(projectId: string, filePath: string): Promise<any>;
+    /**
+     * Lost assets for a project or project file path
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    list(projectId: string, filePath?: string): Promise<any>;
+    /**
+     * Get a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    getAsset(projectId: string, filePath: string): Promise<any>;
+    /**
+     * List assets for a robot
+     *
+     * @param projectId
+     * @param callsign
+     * @param parent
+     * @param signedURL
+     */
+    listRobotAssets(projectId: string, callsign: string, parent?: string, signedURL?: boolean): Promise<AssetItemModel[]>;
+    /**
+     * List assets for a flow
+     *
+     * @param projectId
+     * @param flowId
+     * @param flowInstance
+     * @param parent
+     * @param signedURL
+     */
+    listFlowAssets(projectId: string, flowId: string, flowInstance: string, parent?: string, signedURL?: boolean): Promise<AssetItemModel[]>;
+    /**
+     * List assets for a mission
+     *
+     * @param projectId
+     * @param dataUUID
+     */
+    getMissionAsset(projectId: string, dataUUID: string): Promise<AssetItemModel>;
+    /**
+     * Set Robot Sync Definitions
+     * @param projectId
+     * @param callsign
+     * @param definition
+     */
+    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionModel): Promise<AssetSyncDefinitionsModel>;
+    /**
+     * Get Robot Sync Definitions
+     * @param projectId
+     * @param callsign
+     */
+    getRobotSyncDefinitions(projectId: string, callsign: string): Promise<AssetSyncDefinitionsModel>;
+    /**
+     * Set Profile Sync Definitions
+     * @param projectId
+     * @param profileId
+     * @param definition
+     */
+    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionModel): Promise<any>;
+    /**
+     * Get Profile Sync Definitions
+     * @param projectId
+     * @param profileId
+     */
+    getProfileSyncDefinition(projectId: string, profileId: string): Promise<AssetSyncDefinitionsModel>;
+}

package/services/AssetStorageService.js

@@ -0,0 +1,158 @@
+import { API_PROJECT_ASSET_PATH_URL, API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_URL, API_PROJECT_FLOW_ASSET_PATH_URL, API_PROJECT_MISSION_ASSET_PATH_URL, API_PROJECT_ROBOT_ASSET_PATH_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class AssetStorageService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`AssetStorageService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.ASSET_STORAGE_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Create a new project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     * @param file - File payload
+     */
+    // TODO: map the response object
+    async create(projectId, filePath, file) {
+        const formData = new FormData();
+        formData.append('file', file);
+        return this.callPut(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to create asset for ${projectId}, filePath ${filePath}.`);
+    }
+    /**
+     * Update a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     * @param file - File payload
+     */
+    // TODO: map the response object
+    async update(projectId, filePath, file) {
+        const formData = new FormData();
+        formData.append('file', file);
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to update asset for ${projectId}, filePath ${filePath}.`);
+    }
+    /**
+     * Delete a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    // TODO: map the response object
+    async delete(projectId, filePath) {
+        return this.callDelete(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to delete asset for ${projectId}, filePath ${filePath}.`);
+    }
+    /**
+     * Lost assets for a project or project file path
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    // TODO: map the response object
+    async list(projectId, filePath) {
+        let url = '';
+        if (filePath) {
+            url = formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure);
+        }
+        else {
+            url = formatServiceUrl(API_PROJECT_ASSET_URL, { url: this.config.url, projectId }, this.config.insecure);
+        }
+        return this.callGet(url, `Failed to get asset list for ${projectId}, filePath ${filePath}.`);
+    }
+    /**
+     * Get a project asset
+     *
+     * @param projectId - Project Id
+     * @param filePath - Path to asset file
+     */
+    // TODO: map the response object
+    async getAsset(projectId, filePath) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
+            responseType: 'blob',
+        });
+    }
+    /**
+     * List assets for a robot
+     *
+     * @param projectId
+     * @param callsign
+     * @param parent
+     * @param signedURL
+     */
+    async listRobotAssets(projectId, callsign, parent = '/', signedURL = false) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_ASSET_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, { parent, signedURL });
+    }
+    /**
+     * List assets for a flow
+     *
+     * @param projectId
+     * @param flowId
+     * @param flowInstance
+     * @param parent
+     * @param signedURL
+     */
+    async listFlowAssets(projectId, flowId, flowInstance, parent = '/', signedURL = false) {
+        return this.callGet(formatServiceUrl(API_PROJECT_FLOW_ASSET_PATH_URL, { url: this.config.url, projectId, flowId, flowInstance }, this.config.insecure), `Failed to get asset for ${projectId}, flow ${flowId}, flow instance ${flowInstance}.`, { parent, signedURL });
+    }
+    /**
+     * List assets for a mission
+     *
+     * @param projectId
+     * @param dataUUID
+     */
+    async getMissionAsset(projectId, dataUUID) {
+        return this.callGet(formatServiceUrl(API_PROJECT_MISSION_ASSET_PATH_URL, { url: this.config.url, projectId, dataUUID }, this.config.insecure), `Failed to get asset for ${projectId}, dataUUID ${dataUUID}.`, undefined);
+    }
+    /**
+     * Set Robot Sync Definitions
+     * @param projectId
+     * @param callsign
+     * @param definition
+     */
+    setRobotSyncDefinitions(projectId, callsign, definition) {
+        const httpOptions = {
+            headers: {
+                'content-type': 'application/json',
+            },
+        };
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
+    }
+    /**
+     * Get Robot Sync Definitions
+     * @param projectId
+     * @param callsign
+     */
+    getRobotSyncDefinitions(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, undefined);
+    }
+    /**
+     * Set Profile Sync Definitions
+     * @param projectId
+     * @param profileId
+     * @param definition
+     */
+    setProfileSyncDefinitions(projectId, profileId, definition) {
+        const httpOptions = {
+            headers: {
+                'content-type': 'application/json',
+            },
+        };
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), definition, `Failed to update sync-definition for ${projectId}, callsign ${profileId}.`, httpOptions);
+    }
+    /**
+     * Get Profile Sync Definitions
+     * @param projectId
+     * @param profileId
+     */
+    getProfileSyncDefinition(projectId, profileId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), `Failed to get sync-definition for ${projectId}, callsign ${profileId}.`, undefined);
+    }
+}

package/services/AuthService.d.ts

@@ -0,0 +1,93 @@
+import { IBaseService, IRocosSDKConfig, RocosError, Token } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+export declare class AuthService extends BaseServiceAbstract implements IBaseService {
+    protected config: IRocosSDKConfig;
+    private token?;
+    private tokenRefreshTimeoutId?;
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    teardown(): void;
+    protected getError(e: RocosError): RocosError;
+    /**
+     * Set the Auth token
+     * @param value - Token value
+     */
+    setToken(value: string | Token): void;
+    /**
+     * @deprecated `expiresIn` is now derived from the token. Use `setToken(value: string | Token)` instead
+     */
+    setToken(value: string | Token, expiresIn: number): void;
+    /**
+     * Clear token
+     */
+    clearToken(): void;
+    /**
+     * Get the authentication token for application Id and application Key.
+     */
+    getAppToken(): Promise<Token>;
+    /**
+     * Get new auth token for a user
+     * @desc This only works for user auth tokens, not appId auth tokens
+     */
+    getNewUserToken(): Promise<Token>;
+    /**
+     * Get new auth token for a user.
+     *
+     * Uses the OTP flow to exchange an external token for a user token.
+     *
+     * @desc This only works for user auth tokens, not appId auth tokens
+     */
+    private getNewUserTokenFromExternalToken;
+    /**
+     * Get the authentication token
+     *
+     * This will return the current token if it is not expired, otherwise it will get a new token based on your config.
+     */
+    getToken(): Promise<Token>;
+    /**
+     * Refresh the authentication token
+     *
+     * This only works for user auth tokens, not appId auth tokens.
+     *
+     * The new token is not automatically set as the current token. Use `setToken` to set the new token.
+     *
+     * @see setToken
+     * @param token the token to refresh. If not provided, the current token will be used.
+     */
+    refreshToken(token?: Token): Promise<Token>;
+    /** Refresh the token if it is expired or will expire in the next `minutes` minutes
+     *
+     * This only works for user auth tokens, not appId auth tokens.
+     *
+     * If you want to refresh the token regardless of the expiry time, use `refreshToken`.
+     *
+     * @param minutes the number of minutes before the token expires to refresh the token
+     * @see refreshToken
+     */
+    refreshTokenIfExpired(minutes: number): Promise<void>;
+    /** Start a 5-minute loop to check if the token needs to be refreshed
+     *
+     * This is useful when you are using GRPC services (i.e. telemetry) which does not automatically refresh the token.
+     * It is not required when using REST services as the token is refreshed automatically.
+     *
+     * The loop will stop when `stopTokenRefreshChecker` is called.
+     *
+     * @see stopTokenRefreshChecker
+     */
+    startTokenRefreshChecker(): void;
+    /**
+     * Stop the token refresh checker
+     * @see startTokenRefreshChecker
+     */
+    stopTokenRefreshChecker(): void;
+    /** Check if the token refresh checker is running
+     *
+     * @see startTokenRefreshChecker
+     * @see stopTokenRefreshChecker
+     * @returns true if the token refresh checker is running
+     */
+    isTokenRefreshCheckerRunning(): boolean;
+    /** Checks if the token is valid for use with the API */
+    isTokenValid(token: Token): boolean;
+    private isTokenIssuedByApp;
+}