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

package/esm/services/ProfileService.d.ts

@@ -0,0 +1,244 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     *  Create a robot definition
+     *
+     * @param projectId - Project Id
+     * @param model - Payload
+     * @description - Renamed from robotDefsCreate
+     */
+    create(projectId: string, model: any): Promise<any>;
+    /**
+     * Get robot definitions
+     *
+     * @param projectId - Project Id
+     * @description - Renamed from robotDefsList
+     */
+    list(projectId: string): Promise<any>;
+    /**
+     * Delete robot definitions
+     *
+     * @param projectId - Project Id
+     * @param defIds - Definition Id's
+     * @description - Renamed from robotDefsRemove
+     */
+    remove(projectId: string, defIds: string[]): Promise<any>;
+    /**
+     * Get a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @description - Renamed from robotDefsGetOne
+     */
+    get(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Delete a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @description - Renamed from robotDefsDeleteOne
+     */
+    delete(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @param model - Definition payload
+     * @description - Renamed from robotDefsUpdateOne
+     */
+    update(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get definitions for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @description - Renamed from robotDefsForRobot
+     */
+    getForRobot(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update storage streams for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefsUpdateStorageStreams
+     */
+    updateStorageStreams(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Copy a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefCopyDef
+     */
+    copyDef(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get robot list got a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Definition Id
+     * @description - Renamed from robotListForDefs
+     */
+    robotList(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Get dashboards for a definition
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @description - Renamed from robotDefDashboards
+     */
+    dashboards(projectId: string, profileId: string): Promise<any>;
+    /**
+     * Get Dashboard data which stored in Azure Blob.
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot Profile Id
+     * @description - Renamed from robotDefDashboardBlob
+     */
+    dashboardBlob(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update dashboard for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot Profile Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateDashboards
+     */
+    updateDashboards(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get settings for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot Profile Id
+     * @description - Renamed from robotDefGetSettings
+     */
+    getSettings(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update settings for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot Profile Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateSettings
+     */
+    updateSettings(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get agent settings
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetAgentSettings
+     */
+    getAgentSettings(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update agent settings
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateAgentSettings
+     */
+    updateAgentSettings(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get commands fora robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetCommands
+     */
+    getCommands(projectId: string, definitionId: string): Promise<any>;
+    /**
+     *
+     * Update commands fora robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateCommands
+     */
+    updateCommands(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get command V2 for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetCommandsV2
+     */
+    getCommandsV2(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update command V2 for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateCommandsV2
+     */
+    updateCommandsV2(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get command actions for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetCommandActions
+     */
+    getCommandActions(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Get buttons for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetButtons
+     */
+    getButtons(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update buttons for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateButtons
+     */
+    updateButtons(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get triggers for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetTriggers
+     */
+    getTriggers(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update triggers for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - Payload
+     * @description - Renamed from robotDefUpdateTriggers
+     */
+    updateTriggers(projectId: string, definitionId: string, model: any): Promise<any>;
+    /**
+     * Get gamepads for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @description - Renamed from robotDefGetGamepads
+     */
+    getGamepads(projectId: string, definitionId: string): Promise<any>;
+    /**
+     * Update gamepads for a robot definition
+     *
+     * @param projectId - Project Id
+     * @param definitionId - Robot definition Id
+     * @param model - \payload
+     * @description - Renamed from robotDefUpdateGamepads
+     */
+    updateGamepads(projectId: string, definitionId: string, model: any): Promise<any>;
+}

package/esm/services/ProjectService.d.ts

@@ -0,0 +1,106 @@
+import { IBaseService, IOperation, IProject, IProjectInfo, IRocosSDKConfig, ProjectUser, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+export declare class ProjectService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Create a new project.
+     *
+     * @param project - Project payload {@link IProject}
+     */
+    create(project: IProject): Promise<any>;
+    /**
+     * Get projects list by current account info
+     */
+    list(): Promise<IProjectInfo[]>;
+    /**
+     * Update project information.
+     *
+     * @param projectId - Project Id
+     * @param project - Project payload {@link IProject}
+     */
+    update(projectId: string, project: IProject): Promise<any>;
+    /**
+     * Get project information by project id.
+     *
+     * @param projectId - Project Id
+     */
+    info(projectId: string): Promise<IProjectInfo>;
+    /**
+     * Delete project by account id and project id.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    delete(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Get projects under account by using the account id.
+     *
+     * @param accountId - Account Id
+     */
+    projectsUnderAccount(accountId: string): Promise<IProjectInfo[]>;
+    /**
+     * Create a project under a specified account
+     *
+     * @param accountId - Account Id
+     * @param project - Project payload {@link IProject}
+     */
+    createProjectUnderAccount(accountId: string, project: IProject): Promise<any>;
+    /**
+     * Get project pre-configured templates
+     */
+    templates(): Promise<any>;
+    /**
+     * Create project by template.
+     *
+     * @param templateId - Template Id, From back-end responses
+     * @param body - Optional parameters
+     */
+    createProjectByTemplate(templateId: string, body?: any): Promise<any>;
+    /**
+     * Operations related functions
+     */
+    /**
+     * Create a new project.
+     *
+     * @param projectId - Project Id
+     * @param operation - Operation payload {@link IOperation}
+     */
+    createOperation(projectId: string, operation: IOperation): Promise<any>;
+    /**
+     * Get operations list by project id
+     *
+     * @param projectId - Project Id
+     */
+    getOperationsList(projectId: string): Promise<any>;
+    /**
+     * Get operation by project Id and operation Id.
+     *
+     * @param projectId - Project Id
+     * @param operationId - Operation Id
+     */
+    getOperation(projectId: string, operationId: string): Promise<any>;
+    /**
+     * Delete operations for project.
+     *
+     * @param projectId - Project Id
+     * @param operationIds - Operation Ids
+     */
+    deleteOperationsForProject(projectId: string, operationIds: string[]): Promise<any>;
+    /**
+     * Update operation.
+     *
+     * @param projectId - Project Id
+     * @param operationId - Operation Id
+     * @param operation - Operation payload {@link IOperation}
+     */
+    updateOperation(projectId: string, operationId: string, operation: IOperation): Promise<any>;
+    /**
+     * List users for a project
+     * @param projectId - Project Id
+     * @returns Returns list of users for a given project
+     */
+    listUsers(projectId: string): Promise<ProjectUser[]>;
+    getProjectByLinkedProjectId(linkedProjectId: string): Promise<IProject>;
+}

package/esm/services/ProjectService.js

@@ -0,0 +1,163 @@
+import { API_ACCOUNT_PROJECT_ID_URL, API_ACCOUNT_PROJECT_URL, API_LINKED_PROJECT_URL, API_PROJECT_ID_URL, API_PROJECT_OPERATION_ID_URL, API_PROJECT_OPERATION_URL, API_PROJECT_URL, API_PROJECT_USERS_URL, API_TEMPLATE_PROVISION_ID_URL, API_TEMPLATE_PROVISION_URL, } from '../constants/api';
+import { errorCodes, RocosError, } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class ProjectService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`ProjectService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.PROJECT_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Create a new project.
+     *
+     * @param project - Project payload {@link IProject}
+     */
+    // TODO: map the response object
+    async create(project) {
+        return this.callPost(formatServiceUrl(API_PROJECT_URL, { url: this.config.url }, this.config.insecure), project, 'Failed to create project.');
+    }
+    /**
+     * Get projects list by current account info
+     */
+    // TODO: map the response object
+    async list() {
+        return this.callGet(formatServiceUrl(API_PROJECT_URL, { url: this.config.url }, this.config.insecure), 'Failed to get project list.');
+    }
+    /**
+     * Update project information.
+     *
+     * @param projectId - Project Id
+     * @param project - Project payload {@link IProject}
+     */
+    // TODO: map the response object
+    async update(projectId, project) {
+        return this.callPut(formatServiceUrl(API_PROJECT_ID_URL, { url: this.config.url, projectId }, this.config.insecure), project, `Failed to update project for ${projectId}.`);
+    }
+    /**
+     * Get project information by project id.
+     *
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async info(projectId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ID_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get project info for ${projectId}.`);
+    }
+    /**
+     * Delete project by account id and project id.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async delete(accountId, projectId) {
+        return this.callDelete(formatServiceUrl(API_ACCOUNT_PROJECT_ID_URL, { url: this.config.url, accountId, projectId }, this.config.insecure), `Failed to delete project for ${accountId}, projectId ${projectId}.`);
+    }
+    /**
+     * Get projects under account by using the account id.
+     *
+     * @param accountId - Account Id
+     */
+    async projectsUnderAccount(accountId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_PROJECT_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to get account projects for ${accountId}.`);
+    }
+    /**
+     * Create a project under a specified account
+     *
+     * @param accountId - Account Id
+     * @param project - Project payload {@link IProject}
+     */
+    // TODO: map the response object
+    async createProjectUnderAccount(accountId, project) {
+        return this.callPost(formatServiceUrl(API_ACCOUNT_PROJECT_URL, { url: this.config.url, accountId }, this.config.insecure), project, `Failed to create account project for ${accountId}.`);
+    }
+    /**
+     * Get project pre-configured templates
+     */
+    // TODO: map the response object
+    async templates() {
+        return this.callGet(formatServiceUrl(API_TEMPLATE_PROVISION_URL, { url: this.config.url }, this.config.insecure), 'Failed to get project templates.');
+    }
+    /**
+     * Create project by template.
+     *
+     * @param templateId - Template Id, From back-end responses
+     * @param body - Optional parameters
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async createProjectByTemplate(templateId, body) {
+        return this.callPost(formatServiceUrl(API_TEMPLATE_PROVISION_ID_URL, { url: this.config.url, templateId }, this.config.insecure), body, `Failed to create project template for ${templateId}.`);
+    }
+    /**
+     * Operations related functions
+     */
+    /**
+     * Create a new project.
+     *
+     * @param projectId - Project Id
+     * @param operation - Operation payload {@link IOperation}
+     */
+    // TODO: map the response object
+    async createOperation(projectId, operation) {
+        return this.callPost(formatServiceUrl(API_PROJECT_OPERATION_URL, { url: this.config.url, projectId }, this.config.insecure), operation, `Failed to create project operation for ${projectId}.`);
+    }
+    /**
+     * Get operations list by project id
+     *
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async getOperationsList(projectId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_OPERATION_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get project operations for ${projectId}.`);
+    }
+    /**
+     * Get operation by project Id and operation Id.
+     *
+     * @param projectId - Project Id
+     * @param operationId - Operation Id
+     */
+    // TODO: map the response object
+    async getOperation(projectId, operationId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_OPERATION_ID_URL, { url: this.config.url, projectId, operationId }, this.config.insecure), `Failed to get project operation for ${projectId}, operationId ${operationId}.`);
+    }
+    /**
+     * Delete operations for project.
+     *
+     * @param projectId - Project Id
+     * @param operationIds - Operation Ids
+     */
+    // TODO: map the response object
+    async deleteOperationsForProject(projectId, operationIds) {
+        return this.callDelete(formatServiceUrl(API_PROJECT_OPERATION_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to delete project operations for ${projectId}.`, operationIds);
+    }
+    /**
+     * Update operation.
+     *
+     * @param projectId - Project Id
+     * @param operationId - Operation Id
+     * @param operation - Operation payload {@link IOperation}
+     */
+    // TODO: map the response object
+    async updateOperation(projectId, operationId, operation) {
+        return this.callPut(formatServiceUrl(API_PROJECT_OPERATION_ID_URL, { url: this.config.url, projectId, operationId }, this.config.insecure), operation, `Failed to update project operation for ${projectId}, operationId ${operationId}.`);
+    }
+    /**
+     * List users for a project
+     * @param projectId - Project Id
+     * @returns Returns list of users for a given project
+     */
+    async listUsers(projectId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_USERS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get project users list.');
+    }
+    async getProjectByLinkedProjectId(linkedProjectId) {
+        return this.callGet(formatServiceUrl(API_LINKED_PROJECT_URL, { url: this.config.url, linkedProjectId }, this.config.insecure), `Failed to get project info for linked project ID: ${linkedProjectId}.`);
+    }
+}

package/esm/services/RTPWebRTCService.d.ts

@@ -0,0 +1,102 @@
+import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { Observable } from 'rxjs';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+export declare enum WebRTCEventType {
+    LoadingTURNConfigs = "loading-turn-configs",
+    Disconnected = "disconnected",
+    DataChannelOpen = "data-channel-open",
+    CreatingOffer = "creating-offer",
+    AddingRemoteTrack = "adding-remote-track",
+    ICEConnectionStateChange = "ice-connection-state-change",
+    SendingOffer = "sending-offer",
+    FailedGettingTURNConfig = "failed-getting-turn-config",
+    GotTURNConfig = "got-turn-config",
+    FailedGettingAnswer = "failed-getting-answer",
+    GotAnswer = "got-answer",
+    DataChannelMessage = "data-channel-message"
+}
+interface EventMetadata {
+    [WebRTCEventType.ICEConnectionStateChange]: {
+        state: RTCIceConnectionState;
+    };
+    [WebRTCEventType.DataChannelMessage]: {
+        label: string;
+        data: string;
+    };
+}
+interface Event<T extends WebRTCEventType> {
+    type: T;
+    metadata: T extends keyof EventMetadata ? EventMetadata[T] : undefined;
+}
+export type WebRTCEvent = {
+    [K in keyof typeof WebRTCEventType]: Event<(typeof WebRTCEventType)[K]>;
+}[keyof typeof WebRTCEventType];
+export interface PeerConnectionParams {
+    projectId: string;
+    callsign: string;
+    logLevel?: 'trace';
+}
+interface InternalPeerConnectionParams extends PeerConnectionParams {
+    endpoint: {
+        host: string;
+        port: number;
+        insecure: boolean;
+    };
+    token: string;
+}
+export declare class RTPWebRTCService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    /** Create a new peer connection with a robot
+     *
+     * To connect, call `connect` on the returned connection
+     *
+     * If `logLevel` is set to trace, the connection will emit all messages as events
+     */
+    createPeerConnection(params: PeerConnectionParams): WebRTCConnection;
+}
+export declare class WebRTCConnection {
+    private pc?;
+    private sendChannel?;
+    private readonly endpoint;
+    private readonly token;
+    private readonly projectId;
+    private readonly callsign;
+    private readonly logLevel?;
+    private errorsSubject$;
+    private streamsSubject$;
+    private eventsSubject$;
+    readonly errors$: Observable<Error>;
+    readonly events$: Observable<WebRTCEvent>;
+    readonly streams$: Observable<MediaStream[]>;
+    constructor(params: InternalPeerConnectionParams);
+    get peerConnectionAvailable(): boolean;
+    /** Connect to the robot
+     *
+     * This will create a new peer connection, and send an offer to the robot.
+     * If a connection already exists, it will be disconnected first
+     *
+     * @throws {Error} if the offer fails
+     * @returns {Promise<void>} resolves when the connection is established
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the robot
+     */
+    disconnect(): void;
+    /**
+     * Subscribe to a video or audio topic
+     *
+     * This will send a message to the robot to start streaming the requested topic.
+     *
+     * Any data received will be sent to the streams emitted by `streams$`
+     */
+    subscribeToTopic(topic: string, type: 'video' | 'audio'): void;
+    private sendOffer;
+    private loadConfig;
+    private createPeerConnection;
+    private getEndpoint;
+    private log;
+}
+export {};