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

package/services/ProjectService.d.ts

@@ -0,0 +1,110 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IOperation } from '../models/IOperation';
+import { IProject } from '../models/IProject';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { ProjectUser } from '../models';
+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<any>;
+    /**
+     * 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<IProject>;
+    /**
+     * 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<IProject[]>;
+    /**
+     * 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[]>;
+}

package/services/ProjectService.js

@@ -0,0 +1,160 @@
+import { API_ACCOUNT_PROJECT_ID_URL, API_ACCOUNT_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 { RocosError, errorCodes } from '../models/RocosError';
+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.');
+    }
+}

package/services/RobotService.d.ts

@@ -0,0 +1,278 @@
+import { IBaseService, IRobot, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+export declare class RobotService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get a list of robots.
+     *
+     * @param projectId - Project Id
+     */
+    getRobots(projectId: string): Promise<IRobot[]>;
+    /**
+     * Create a new robot.
+     *
+     * @param projectId
+     * @param robot - Robot payload {@link IRobot}
+     */
+    create(projectId: string, robot: IRobot): Promise<any>;
+    /**
+     * Update robot information.
+     *
+     * @param projectId Project Id
+     * @param robot - Robot payload {@link IRobot}
+     */
+    update(projectId: string, robot: IRobot): Promise<any>;
+    /**
+     * Delete the robots by callsign list
+     *
+     * @param projectId - Project Id
+     * @param callsignIds - Callsign list
+     */
+    delete(projectId: string, callsignIds: string[]): Promise<any>;
+    /**
+     * Get robot information by project id and callsign of the robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    info(projectId: string, callsign: string): Promise<IRobot>;
+    /**
+     * Get robot information by project id and callsign of the robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    attributes(projectId: string, callsign: string): Promise<Record<string, string>>;
+    /**
+     * Register the specified callsign
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    register(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Robot Templates
+     */
+    templates(): Promise<IRobotTemplate[]>;
+    /**
+     * Get the deployment details of virtual robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Virtual Robot Callsign
+     */
+    virtualRobotDeploymentDetails(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Deploy a virtual robot by project id and callsign
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot's Callsign
+     */
+    deployVirtualRobot(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Get data sources tree components JSON schema
+     */
+    dataSourcesSchema(): Promise<any>;
+    /**
+     * Delete a robot dashboard.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    deleteRobotDashboardsV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Delete a profile dashboard.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    deleteDashboardsV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get a list of robot dashboards.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     */
+    listRobotDashboardsV2(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Get a list of profile dashboards.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     */
+    listDashboardsV2(projectId: string, profileId: string): Promise<any>;
+    /**
+     * Get a profile dashboard.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    robotDefDashboardsV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get Dashboard data which stored in Azure Blob.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    robotDefDashboardBlobV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Create dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param model - Payload
+     */
+    createRobotDashboardsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Create dashboard for a profile.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param model - Payload
+     */
+    createDashboardsV2(projectId: string, profileId: string, model: any): Promise<any>;
+    /**
+     * Update dashboard for a profile.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     * @param model - Payload
+     */
+    robotDefUpdateDashboardsV2(projectId: string, profileId: string, dashboardId: string, model: any): Promise<any>;
+    /**
+     * Get a list of dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    getDashboardsV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Get robot dashboard which stored in Azure Blob.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    getDashboardBlobV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Update dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     * @param model - Payload
+     */
+    updateDashboardsV2(projectId: string, callsign: string, dashboardId: string, model: any): Promise<any>;
+    /**
+     * Get robot settings
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getSettings(projectId: string, callsign: string): Promise<IRobotSettings>;
+    /**
+     * Update robot settings.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateSettings(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get agent settings for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getAgentSettings(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update agent settings for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateAgentSettings(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get commands for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getCommands(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update commands for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateCommands(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get command V2 for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getCommandsV2(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update command V2 for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateCommandsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get buttons for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getButtons(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update buttons for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateButtons(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get triggers for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getTriggers(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update triggers for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateTriggers(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get gamepads for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getGamepads(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update gamepads for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - \payload
+     */
+    updateGamepads(projectId: string, callsign: string, model: any): Promise<any>;
+}