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

package/esm/services/UserService.d.ts

@@ -0,0 +1,200 @@
+import { IInvitation, IInvitationType } from '../models/IInvitation';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IInvitationExists } from '../models/IInvitationExists';
+import { IPersonalAccessToken } from '../models/IPersonalAccessToken';
+import { IProjectApplication } from '../models/IProjectApplication';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class UserService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get the information of current user
+     */
+    info(): Promise<any>;
+    /**
+     * Get a new valid token
+     * @deprecated Please use {@link AuthService.getNewUserToken}
+     */
+    getToken(): Promise<any>;
+    /**
+     * Create a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    createInvitation(invitation: IInvitation): Promise<any>;
+    /**
+     * List invitations
+     */
+    listInvitations(): Promise<any>;
+    /**
+     * Delete invitations by email and invite type.
+     *
+     * @param email - Email
+     * @param type
+     */
+    deleteInvitations(email: string, type: IInvitationType): Promise<any>;
+    /**
+     * Accept invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    acceptInvitation(invitationId: string): Promise<any>;
+    /**
+     * Check invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    checkInvitation(invitationId: string): Promise<IInvitationExists>;
+    /**
+     * Activate account by id
+     *
+     * @param accountId - Account Id
+     */
+    activateAccount(accountId: string): Promise<any>;
+    /**
+     * Resend verification email
+     *
+     * @param email - Email
+     */
+    resendVerificationEmail(email: string): Promise<any>;
+    /**
+     * Send forgotten password email.
+     *
+     * @param email - Email
+     */
+    sendForgottenPasswordEmail(email: string): Promise<any>;
+    /**
+     * Revoke user's project access.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param userId - User Id
+     */
+    removeProjectAccess(accountId: string, projectId: string, userId: string): Promise<any>;
+    /**
+     * Revoke user's account access.
+     *
+     * @param accountId - Account Id
+     * @param userId - User Id
+     */
+    removeAccountAccess(accountId: string, userId: string): Promise<any>;
+    /**
+     * List account users
+     *
+     * @param accountId - Account Id
+     */
+    listAccountUsers(accountId: string): Promise<any>;
+    /**
+     * List project users
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    listProjectUsers(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Create a users personal access token.
+     *
+     * @param personalAccessToken - Payload {@link IPersonalAccessToken}
+     */
+    createPAT(personalAccessToken: IPersonalAccessToken): Promise<IPersonalAccessToken>;
+    /**
+     * Get all personal access tokens
+     *
+     * @param projectId - Project Id
+     * @param robotDefinitionId - Robot definition Id
+     */
+    getAllPATs(projectId: string, robotDefinitionId: string): Promise<any>;
+    /**
+     * Get a personal access token
+     *
+     * @param tokenString - Token string
+     */
+    getOnePAT(tokenString: string): Promise<any>;
+    /**
+     * REmove personal access token
+     *
+     * @param id - Token Id
+     */
+    removePATById(id: string): Promise<any>;
+    /**
+     * Get account details
+     *
+     * @param accountId - Account Id
+     */
+    accountDetails(accountId: string): Promise<any>;
+    /**
+     * Create an account
+     *
+     * @param name - Account name
+     */
+    createAccount(name: string): Promise<any>;
+    /**
+     * Authenticate application
+     *
+     * @param appId - Application Id
+     * @param appKey - Application Key
+     */
+    applicationAuth(appId: string, appKey: string): Promise<any>;
+    /**
+     * Create a new application
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param model - Payload {@link IProjectApplication}
+     */
+    createApplication(accountId: string, projectId: string, model: IProjectApplication): Promise<IProjectApplication>;
+    /**
+     * List all applications
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    getAllApplications(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Get application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     */
+    getApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Update application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     * @param model - Payload
+     */
+    updateApplication(accountId: string, projectId: string, applicationId: string, model: any): Promise<any>;
+    /**
+     * Delete application
+     *
+     * @param accountId - Account ID
+     * @param projectId - Project ID
+     * @param applicationId - Application ID
+     */
+    deleteApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Get account settings.
+     *
+     * @param accountId - Account Id
+     */
+    accountSettings(accountId: string): Promise<any>;
+    /**
+     * Update account settings
+     *
+     * @param accountId - Account ID
+     * @param settings - Updated account settings
+     */
+    updateAccountSettings(accountId: string, settings: any): Promise<any>;
+    /**
+     * Send a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    sendInvitation(invitation: IInvitation): Promise<any>;
+}

package/esm/services/WebRTCSignallingService.d.ts

@@ -0,0 +1,22 @@
+import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest, IWebRTCSignallingGetDetailsResponse, IWebRTCSignallingMessage, IWebRTCSignallingOutcome, IWebRTCSignallingResponseStream, IWebRTCSignallingStream } from '..';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { IStreamConfig } from '../models/IStreamConfig';
+import { ISubscriberStatus } from '../models/ISubscriberStatus';
+import { Subject } from 'rxjs';
+import { SubscriberStatusEnum } from '../models/SubscriberStatusEnum';
+export declare class WebRTCSignallingService implements IBaseService, ISubscriberStatus {
+    private config;
+    private logger;
+    private status;
+    status$: Subject<SubscriberStatusEnum>;
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    connectOperator(request: IOperatorConnectRequest): Promise<IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>>;
+    getDetails(request: IGetDetailsRequest): Promise<IWebRTCSignallingGetDetailsResponse>;
+    offerConnection(request: IOfferRequest): Promise<IWebRTCSignallingOutcome>;
+    addIceCandidate(request: IAddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+    private createSignallingStream;
+    private initStream;
+    protected getStream(config: IStreamConfig): IWebRTCSignallingStream;
+}

package/esm/services/WorkflowService.d.ts

@@ -0,0 +1,62 @@
+import type { Workflow, WorkflowBase } from '../models/workflow/Workflow';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class WorkflowService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get workflows for project
+     *
+     * @param projectId - Project Id
+     */
+    list(projectId: string): Promise<Workflow[]>;
+    /**
+     * Create a workflow
+     *
+     * @param projectId - Project Id
+     * @param model - Workflow
+     */
+    create(projectId: string, model: WorkflowBase): Promise<Workflow>;
+    /**
+     * Get a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    get(projectId: string, workflowId: string): Promise<Workflow>;
+    /**
+     * Update a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param model - Workflow
+     */
+    update(projectId: string, workflowId: string, model: Workflow): Promise<Workflow>;
+    /**
+     * Upload workflow asset
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param fileName - Name of file including extension
+     * @param arrayBuffer - data to upload
+     */
+    uploadAsset(projectId: string, workflowId: string, fileName: string, arrayBuffer: ArrayBuffer): Promise<void>;
+    protected uploadAssetWithHash(projectId: string, workflowId: string, fileName: string, arrayBuffer: ArrayBuffer, hash: string): Promise<void>;
+    /**
+     * Delete a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    delete(projectId: string, workflowId: string): Promise<void>;
+    /**
+     * Get deployed workflows on robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getDeployedWorkflows(projectId: string, callsign: string): Promise<Workflow[]>;
+}

package/esm/services/WorkflowService.js

@@ -0,0 +1,103 @@
+import { API_PROJECT_DEPLOYED_WORKFLOW_URL, API_PROJECT_WORKFLOW_ASSET_URL, API_PROJECT_WORKFLOW_ID_URL, API_PROJECT_WORKFLOW_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+import { getSha256Hex } from '../helpers/getSha256Hex';
+export class WorkflowService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`WorkflowService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.WORKFLOW_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Get workflows for project
+     *
+     * @param projectId - Project Id
+     */
+    async list(projectId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get workflows for ${projectId}.`);
+    }
+    /**
+     * Create a workflow
+     *
+     * @param projectId - Project Id
+     * @param model - Workflow
+     */
+    async create(projectId, model) {
+        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create workflow for ${projectId}.`);
+    }
+    /**
+     * Get a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    async get(projectId, workflowId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to get workflow for ${projectId}, workflowId ${workflowId}.`);
+    }
+    /**
+     * Update a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param model - Workflow
+     */
+    async update(projectId, workflowId, model) {
+        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), model, `Failed to update workflow for ${projectId}, workflowId ${workflowId}.`);
+    }
+    /**
+     * Upload workflow asset
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param fileName - Name of file including extension
+     * @param arrayBuffer - data to upload
+     */
+    async uploadAsset(projectId, workflowId, fileName, arrayBuffer) {
+        const hash = await getSha256Hex(arrayBuffer);
+        return this.uploadAssetWithHash(projectId, workflowId, fileName, arrayBuffer, hash);
+    }
+    async uploadAssetWithHash(projectId, workflowId, fileName, arrayBuffer, hash) {
+        // Get asset upload link
+        const createAssetResponse = await this.callPost(formatServiceUrl(API_PROJECT_WORKFLOW_ASSET_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), { name: fileName, type: 'file', hash }, `Failed to create asset for ${projectId}, workflowId ${workflowId}.`);
+        const { postContentLink } = createAssetResponse;
+        if (!postContentLink)
+            throw new Error('postContentLink is undefined');
+        // Get Google upload location
+        const postFileResponse = await fetch(postContentLink, {
+            method: 'POST',
+            headers: { 'x-goog-resumable': 'start' },
+        });
+        const putLocation = postFileResponse.headers.get('location');
+        if (!putLocation)
+            throw new Error('putLocation is undefined');
+        // Upload file to Google
+        const uploadResponse = await fetch(putLocation, { method: 'PUT', body: arrayBuffer });
+        if (uploadResponse.status !== 200)
+            throw new Error(`Failed to upload file: ${uploadResponse.statusText}`);
+    }
+    /**
+     * Delete a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    async delete(projectId, workflowId) {
+        return this.callDelete(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to delete workflow for ${projectId}, workflowId ${workflowId}.`);
+    }
+    /**
+     * Get deployed workflows on robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    async getDeployedWorkflows(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_PROJECT_DEPLOYED_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
+    }
+}

package/esm/services/WorkflowServiceNode.d.ts

@@ -0,0 +1,4 @@
+import { WorkflowService } from './WorkflowService';
+export declare class WorkflowServiceNode extends WorkflowService {
+    uploadAsset(projectId: string, workflowId: string, fileName: string, arrayBuffer: ArrayBuffer): Promise<void>;
+}

package/esm/services/WorkflowServiceNode.js

@@ -0,0 +1,8 @@
+import { WorkflowService } from './WorkflowService';
+import { getSha256HexNode } from '../helpers/getSha256HexNode';
+export class WorkflowServiceNode extends WorkflowService {
+    async uploadAsset(projectId, workflowId, fileName, arrayBuffer) {
+        const hash = await getSha256HexNode(arrayBuffer);
+        return this.uploadAssetWithHash(projectId, workflowId, fileName, arrayBuffer, hash);
+    }
+}

package/esm/services/index.d.ts

@@ -0,0 +1,28 @@
+export * from './AssetStorageService';
+export * from './AuthService';
+export * from './CallerService';
+export * from './CommandService';
+export * from './ConfigGroupService';
+export * from './ControlService';
+export * from './DashboardService';
+export * from './EventService';
+export * from './FileAccessorService';
+export * from './FunctionService';
+export * from './IntegrationService';
+export * from './ProfileService';
+export * from './ProjectService';
+export * from './RobotService';
+export * from './SearchService';
+export * from './StreamService';
+export * from './TelemetryService';
+export * from './UserService';
+export * from './WebRTCSignallingService';
+export * from './WorkflowService';
+export * from './ScheduleService';
+export * from './TimeSyncerService';
+export * from './PlatformTimeService';
+export * from './SpotProvisioningService';
+export * from './SpotProvisioningServiceNode';
+export * from './MapService';
+export * from './EvaluatorService';
+export * from './RTPWebRTCService';

package/esm/services/index.js

@@ -0,0 +1,28 @@
+export * from './AssetStorageService';
+export * from './AuthService';
+export * from './CallerService';
+export * from './CommandService';
+export * from './ConfigGroupService';
+export * from './ControlService';
+export * from './DashboardService';
+export * from './EventService';
+export * from './FileAccessorService';
+export * from './FunctionService';
+export * from './IntegrationService';
+export * from './ProfileService';
+export * from './ProjectService';
+export * from './RobotService';
+export * from './SearchService';
+export * from './StreamService';
+export * from './TelemetryService';
+export * from './UserService';
+export * from './WebRTCSignallingService';
+export * from './WorkflowService';
+export * from './ScheduleService';
+export * from './TimeSyncerService';
+export * from './PlatformTimeService';
+export * from './SpotProvisioningService';
+export * from './SpotProvisioningServiceNode';
+export * from './MapService';
+export * from './EvaluatorService';
+export * from './RTPWebRTCService';

package/esm/store/RocosStore.d.ts

@@ -0,0 +1,30 @@
+import { IRocosChangeMessage, IRocosSDKConfig } from '../models';
+import { IRocosSDK } from '../IRocosSDK';
+import { Subject } from 'rxjs';
+export declare class RocosStore {
+    private static changeSubject$?;
+    protected static instances: Record<string, IRocosSDK>;
+    /**
+     * A static method to get the change subject.
+     */
+    static getChangeSubject(): Subject<IRocosChangeMessage>;
+    /**
+     * A static method to get the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static getSDKInstance(config: IRocosSDKConfig): IRocosSDK;
+    /**
+     * A static method to put the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     * @param instance - SDK instance {@link IRocosSDK}
+     */
+    static putSDKInstance(config: IRocosSDKConfig, instance: IRocosSDK): void;
+    /**
+     * A static method to remove the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static removeSDKInstance(config: IRocosSDKConfig): void;
+}

package/package.json

@@ -1,10 +1,23 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.1",
+  "version": "3.0.1-alpha.14",
   "description": "Javascript SDK for rocos",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "author": "Rocos",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "node": "./cjs/index.js"
+    },
+    "./node": {
+      "import": "./esm/node/index.js",
+      "require": "./cjs/node/index.js",
+      "node": "./cjs/node/index.js"
+    }
+  },
+  "sideEffects": false,
+  "author": "DroneDeploy <support@dronedeploy.com> (https://www.dronedeploy.com/)",
   "scripts": {},
   "license": "MIT",
   "devDependencies": {},
@@ -14,6 +27,7 @@
     "@protobuf-ts/grpcweb-transport": "^2.9.1",
     "@protobuf-ts/plugin": "^2.9.1",
     "@protobuf-ts/runtime": "^2.9.1",
+    "@types/json-schema": "^7.0.14",
     "buffer": "^6.0.3",
     "loglevel": "^1.7.1",
     "loglevel-plugin-prefix": "^0.8.4",
@@ -23,7 +37,5 @@
     "rxjs": "^6.6.6 || ^7.0.0"
   },
   "repository": {},
-  "private": false,
-  "type": "module",
-  "sideEffects": false
+  "private": false
 }

package/IRocosSDK.d.ts

@@ -1,32 +0,0 @@
-import { AssetStorageService, AuthService, CallerService, CommandService, ConfigGroupService, ControlService, DashboardService, EvaluatorService, EventService, FileAccessorService, FunctionService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, SearchService, SpotProvisioningService, SpotProvisioningServiceNode, StreamService, TelemetryService, TimeSyncerService, UserService, WebRTCSignallingService, WorkflowService } from './services';
-import { IBaseService, IDebugLevel, ServiceEnum } from './models';
-export declare abstract class IRocosSDK {
-    abstract getService<T extends IBaseService>(name: ServiceEnum): T;
-    abstract getAuthService(): AuthService;
-    abstract getRobotService(): RobotService;
-    abstract getEventService(): EventService;
-    abstract getProjectService(): ProjectService;
-    abstract getTelemetryService(): TelemetryService;
-    abstract getCallerService(): CallerService;
-    abstract getControlService(): ControlService;
-    abstract getCommandService(): CommandService;
-    abstract getSearchService(): SearchService;
-    abstract getConfigGroupService(): ConfigGroupService;
-    abstract getDashboardService(): DashboardService;
-    abstract getFunctionService(): FunctionService;
-    abstract getStreamService(): StreamService;
-    abstract getUserService(): UserService;
-    abstract getMapService(): MapService;
-    abstract getTimeSyncerService(): TimeSyncerService;
-    abstract getWorkflowService(): WorkflowService;
-    abstract getAssetStorageService(): AssetStorageService;
-    abstract getProfileService(): ProfileService;
-    abstract getWebRTCSignallingService(): WebRTCSignallingService;
-    abstract getFileAccessorService(): FileAccessorService;
-    abstract getSpotProvisionerService(): SpotProvisioningService | SpotProvisioningServiceNode;
-    abstract getIntegrationService(): IntegrationService;
-    abstract getEvaluatorService(): EvaluatorService;
-    abstract cleanup(): Promise<boolean>;
-    abstract enableDebugMode(on: boolean): void;
-    abstract setDebugLevel(level: IDebugLevel): void;
-}