@dronedeploy/rocos-js-sdk 0.0.1 → 3.0.0-alpha.6

package/services/WorkflowService.js

@@ -0,0 +1,118 @@
+import { API_PROJECT_CALLSIGN_WORKFLOW_URL, API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_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';
+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;
+    }
+    /**
+     * Create workflow
+     *
+     * @param projectId - Project Id
+     * @param model - Payload
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async createOne(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 workflows for project
+     *
+     * @param projectId - Project Id
+     * @param includeRocosGraph - Include Rocos graph
+     * @param includeStats - Include stats
+     * @param opsId - Ops Id
+     * @param workflowIds - Workflow Id's
+     */
+    // TODO: map the response object
+    async getAll(projectId, includeRocosGraph = false, includeStats = false, opsId, workflowIds) {
+        const params = {
+            includeRocosGraph: includeRocosGraph ? 1 : 0,
+            includeStats: includeStats ? 1 : 0,
+        };
+        if (opsId) {
+            params.opsId = opsId;
+        }
+        if (workflowIds) {
+            params.workflowIds = workflowIds.join(',');
+        }
+        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get workflows for ${projectId}.`, params);
+    }
+    /**
+     * Get a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param includeInstances - Include instances
+     */
+    // TODO: map the response object
+    async getOne(projectId, workflowId, includeInstances = false) {
+        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}.`, { includeInstances: includeInstances ? 1 : 0 });
+    }
+    /**
+     * Update a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param model - Payload
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async updateOne(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}.`);
+    }
+    /**
+     * Delete a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    // TODO: map the response object
+    async deleteOne(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 all workflows for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    // TODO: map the response object
+    async getAllOfRobot(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get workflows for ${projectId}, callsign ${callsign}.`);
+    }
+    /**
+     * Update workflows for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async updateAllForRobot(projectId, callsign, model) {
+        return this.callPut(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
+    }
+    /**
+     * Get deployed workflows on robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    async getDeployedOnRobot(projectId, callsign) {
+        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
+    }
+}

package/services/index.d.ts

@@ -0,0 +1,26 @@
+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';

package/services/index.js

@@ -0,0 +1,26 @@
+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';

package/store/RocosStore.d.ts

@@ -0,0 +1,31 @@
+import { IRocosChangeMessage } from '../models/message/IRocosChangeMessage';
+import { IRocosSDK } from '../IRocosSDK';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+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/store/RocosStore.js

@@ -0,0 +1,47 @@
+import { Subject } from 'rxjs';
+import { getUniqueConfigKey } from '../helpers/getUniqueConfigKey';
+export class RocosStore {
+    /**
+     * A static method to get the change subject.
+     */
+    static getChangeSubject() {
+        if (!RocosStore.changeSubject$) {
+            RocosStore.changeSubject$ = new Subject();
+        }
+        return RocosStore.changeSubject$;
+    }
+    /**
+     * A static method to get the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static getSDKInstance(config) {
+        const uniqueConfigKey = getUniqueConfigKey(config);
+        return RocosStore.instances[uniqueConfigKey];
+    }
+    /**
+     * 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, instance) {
+        const uniqueConfigKey = getUniqueConfigKey(config);
+        if (!RocosStore.instances?.[uniqueConfigKey]) {
+            RocosStore.instances[uniqueConfigKey] = instance;
+        }
+    }
+    /**
+     * A static method to remove the SDK instance from instance register.
+     *
+     * @param config - SDK config {@link IRocosSDKConfig}
+     */
+    static removeSDKInstance(config) {
+        const uniqueConfigKey = getUniqueConfigKey(config);
+        if (RocosStore.instances?.[uniqueConfigKey]) {
+            delete RocosStore.instances[uniqueConfigKey];
+        }
+    }
+}
+// TODO(matej): migrate to non static instance registry
+RocosStore.instances = {};