@dronedeploy/rocos-js-sdk 3.0.1-alpha.5 → 3.0.1-alpha.7

package/esm/helpers/getSha256HexNode.js

@@ -0,0 +1,6 @@
+import crypto from 'crypto';
+export const getSha256HexNode = async (arrayBuffer) => {
+    const hashBuffer = await crypto.subtle.digest('SHA-256', arrayBuffer);
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    return hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
+};

package/esm/helpers/getSha256HexNode.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/helpers/getSha256HexNode.spec.js

@@ -0,0 +1,8 @@
+import { getSha256HexNode } from './getSha256HexNode';
+describe('getSha256HexNode', () => {
+    it('should return the correct SHA-256 hash', async () => {
+        const buffer = new TextEncoder().encode('Hello, World!');
+        const hash = await getSha256HexNode(buffer);
+        expect(hash).toBe('dffd6021bb2bd5b0af676290809ec3a53191dd81c7f70a4b28688a362182986f');
+    });
+});

package/esm/models/IRocosSDKConfig.d.ts

@@ -1,6 +1,9 @@
 import { IStreamOptions } from './IStreamOptions';
-export type IRocosSDKConfig = IRocosSDKConfigApp | IRocosSDKConfigToken;
-interface IRocosSDKConfigBase {
+import { ServiceEnum } from './ServiceEnum';
+export type IRocosSDKConfig = AuthorisedConfig & {
+    overrides?: Partial<Record<ServiceEnum, Partial<AuthorisedConfig>>>;
+};
+interface ConfigBase {
     url: string;
     token?: string;
     refreshToken?: string;
@@ -8,12 +11,13 @@ interface IRocosSDKConfigBase {
     port?: number;
     insecure?: boolean;
 }
-export interface IRocosSDKConfigApp extends IRocosSDKConfigBase {
+export interface IRocosSDKConfigApp extends ConfigBase {
     appId: string;
     appKey: string;
 }
-export interface IRocosSDKConfigToken extends IRocosSDKConfigBase {
+export interface IRocosSDKConfigToken extends ConfigBase {
     token: string;
     refreshToken?: string;
 }
+export type AuthorisedConfig = IRocosSDKConfigApp | IRocosSDKConfigToken;
 export {};

package/esm/models/workflow/Workflow.d.ts

@@ -1,12 +1,12 @@
-export type ResourceType = 'Manifest' | 'AgentGraph' | 'Javascript' | 'NodeDefinition';
+export type ResourceType = 'Manifest' | 'AgentGraph' | 'Javascript' | 'NodeDefinition' | 'Other';
 export interface Resource {
     type: ResourceType;
     data: string;
-    contentLink: string;
     hash: string;
     link: string;
-    path: string;
-    size: number;
+    contentLink?: string;
+    size?: number;
+    path?: string;
 }
 export interface Resources {
     [key: string]: Resource;
@@ -16,21 +16,79 @@ export interface Author {
     name: string;
     email: string;
 }
+interface ResponseBase {
+    id: string;
+    createdBy: string;
+    updatedBy: string;
+    dateCreated: number;
+    dateUpdated: number;
+}
 export interface WorkflowBase {
     flowId: string;
     name: string;
-    description: string;
+    description?: string;
     resources?: Resources;
     type?: string;
 }
-export interface Workflow extends WorkflowBase {
-    id: string;
+export interface Workflow extends WorkflowBase, ResponseBase {
     projectId: string;
-    createdBy: string;
-    updatedBy: string;
     author: Author;
-    dateCreated: number;
-    dateUpdated: number;
     latestVersion: string;
     type: string;
 }
+export interface DeployedFlow {
+    flowId: string;
+    flow?: Workflow;
+    deployed?: boolean;
+}
+export interface WorkflowList extends Omit<WorkflowBase, 'resources'>, ResponseBase {
+    type?: 'cloud';
+    author: {
+        id: string;
+        name: string;
+        email: string;
+    } | Record<string, never>;
+}
+export interface WorkflowRevision {
+    id: string;
+    version: number;
+    authorName: string;
+    createdBy: string;
+    dateCreated: number;
+    description: string;
+    selected?: boolean;
+}
+export interface ManifestResource {
+    path: string;
+    provider: string;
+    runtime: string;
+    options: string[];
+}
+export interface ManifestArgument {
+    default?: string;
+    description?: string;
+    type: string;
+}
+export interface Manifest {
+    main: [string, string];
+    signals?: {
+        main: {
+            args: string[];
+            entry: [string, string];
+        };
+    };
+    arguments?: unknown | Record<string, ManifestArgument>;
+    resources: ManifestResource[];
+    mode?: 'cloud';
+}
+export interface CreateAssetResponse {
+    id: string;
+    name: string;
+    path: string;
+    dateCreated: number;
+    hash: string;
+    postContentLink: string;
+    type: 'file';
+    workflow: string;
+}
+export {};

package/esm/node/RocosSDKNode.d.ts

@@ -1,12 +1,11 @@
 import { EvaluatorService, ScheduleService } from '../services';
+import { IBaseService, ServiceEnum } from '../models';
 import { CallerServiceNode } from '../services/CallerServiceNode';
 import { CommandServiceNode } from '../services/CommandServiceNode';
 import { ControlServiceNode } from '../services/ControlServiceNode';
 import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
-import { IBaseService } from '../models/IBaseService';
 import { RocosSDK } from '../RocosSDK';
 import { SearchServiceNode } from '../services/SearchServiceNode';
-import { ServiceEnum } from '../models/ServiceEnum';
 import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
 export declare class RocosSDKNode extends RocosSDK {
     getService<T extends IBaseService>(name: ServiceEnum): T;

package/esm/node/RocosSDKNode.js

@@ -1,96 +1,85 @@
-import { MapService, ScheduleService, SpotProvisioningServiceNode } from '../services';
-import { AssetStorageService } from '../services/AssetStorageService';
-import { AuthService } from '../services/AuthService';
+import { AssetStorageService, AuthService, ConfigGroupService, DashboardService, EventService, FunctionService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, ScheduleService, SpotProvisioningServiceNode, StreamService, UserService, } from '../services';
+import { ServiceEnum } from '../models';
 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';
+import { WorkflowServiceNode } from '../services/WorkflowServiceNode';
 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.`);
+            const config = this.overrideConfig(name);
             switch (name) {
                 case ServiceEnum.AUTH:
-                    this.services[name] = new AuthService(this.config);
+                    this.services[name] = new AuthService(config);
                     break;
                 case ServiceEnum.TELEMETRY:
-                    this.services[name] = new TelemetryServiceNode(this.config);
+                    this.services[name] = new TelemetryServiceNode(config);
                     break;
                 case ServiceEnum.ROBOT:
-                    this.services[name] = new RobotService(this.config);
+                    this.services[name] = new RobotService(config);
                     break;
                 case ServiceEnum.EVENT:
-                    this.services[name] = new EventService(this.config);
+                    this.services[name] = new EventService(config);
                     break;
                 case ServiceEnum.PROJECT:
-                    this.services[name] = new ProjectService(this.config);
+                    this.services[name] = new ProjectService(config);
                     break;
                 case ServiceEnum.CALLER:
-                    this.services[name] = new CallerServiceNode(this.config);
+                    this.services[name] = new CallerServiceNode(config);
                     break;
                 case ServiceEnum.COMMAND:
-                    this.services[name] = new CommandServiceNode(this.config);
+                    this.services[name] = new CommandServiceNode(config);
                     break;
                 case ServiceEnum.CONTROL:
-                    this.services[name] = new ControlServiceNode(this.config);
+                    this.services[name] = new ControlServiceNode(config);
                     break;
                 case ServiceEnum.SEARCH:
-                    this.services[name] = new SearchServiceNode(this.config);
+                    this.services[name] = new SearchServiceNode(config);
                     break;
                 case ServiceEnum.CONFIG_GROUP:
-                    this.services[name] = new ConfigGroupService(this.config);
+                    this.services[name] = new ConfigGroupService(config);
                     break;
                 case ServiceEnum.DASHBOARD:
-                    this.services[name] = new DashboardService(this.config);
+                    this.services[name] = new DashboardService(config);
                     break;
                 case ServiceEnum.FUNCTION:
-                    this.services[name] = new FunctionService(this.config);
+                    this.services[name] = new FunctionService(config);
                     break;
                 case ServiceEnum.STREAM:
-                    this.services[name] = new StreamService(this.config);
+                    this.services[name] = new StreamService(config);
                     break;
                 case ServiceEnum.USER:
-                    this.services[name] = new UserService(this.config);
+                    this.services[name] = new UserService(config);
                     break;
                 case ServiceEnum.WORKFLOW:
-                    this.services[name] = new WorkflowService(this.config);
+                    this.services[name] = new WorkflowServiceNode(config);
                     break;
                 case ServiceEnum.ASSET_STORAGE:
-                    this.services[name] = new AssetStorageService(this.config);
+                    this.services[name] = new AssetStorageService(config);
                     break;
                 case ServiceEnum.PROFILE:
-                    this.services[name] = new ProfileService(this.config);
+                    this.services[name] = new ProfileService(config);
                     break;
                 case ServiceEnum.FILE_ACCESSOR:
-                    this.services[name] = new FileAccessorServiceNode(this.config);
+                    this.services[name] = new FileAccessorServiceNode(config);
                     break;
                 case ServiceEnum.SPOT_PROVISIONER:
-                    this.services[name] = new SpotProvisioningServiceNode(this.config);
+                    this.services[name] = new SpotProvisioningServiceNode(config);
                     break;
                 case ServiceEnum.SCHEDULE:
-                    this.services[name] = new ScheduleService(this.config);
+                    this.services[name] = new ScheduleService(config);
                     break;
                 case ServiceEnum.INTEGRATION:
-                    this.services[name] = new IntegrationService(this.config);
+                    this.services[name] = new IntegrationService(config);
                     break;
                 case ServiceEnum.MAP:
-                    this.services[name] = new MapService(this.config);
+                    this.services[name] = new MapService(config);
                     break;
             }
         }

package/esm/services/AssetStorageService.js

@@ -1,5 +1,5 @@
-import { API_PROJECT_ASSET_INTEGRATION_PATH_URL, API_PROJECT_ASSET_INTEGRATION_PROVIDERS_PATH_URL, API_PROJECT_ASSET_INTEGRATIONS_PATH_URL, 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_MAPPED_ASSETS_PATH_URL, API_PROJECT_MISSION_ASSET_PATH_URL, API_PROJECT_MISSION_ASSETS_PATH_URL, API_PROJECT_ROBOT_ASSET_PATH_URL, } from '../constants/api';
-import { errorCodes, RocosError } from '../models/RocosError';
+import { API_PROJECT_ASSET_INTEGRATIONS_PATH_URL, API_PROJECT_ASSET_INTEGRATION_PATH_URL, API_PROJECT_ASSET_INTEGRATION_PROVIDERS_PATH_URL, 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_MAPPED_ASSETS_PATH_URL, API_PROJECT_MISSION_ASSETS_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';
@@ -208,7 +208,7 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param integration
      */
     updateSyncIntegration(projectId, integrationId, integration) {
-        return this.callPut(formatServiceUrl(API_PROJECT_ASSET_INTEGRATION_PATH_URL, { url: this.config.url, projectId, integrationId: integrationId }, this.config.insecure), integration, `Failed to update asset sync integrations for ${projectId}.`);
+        return this.callPut(formatServiceUrl(API_PROJECT_ASSET_INTEGRATION_PATH_URL, { url: this.config.url, projectId, integrationId }, this.config.insecure), integration, `Failed to update asset sync integrations for ${projectId}.`);
     }
     /**
      * Delete a Sync Integration

package/esm/services/BaseStreamService.js

@@ -14,6 +14,8 @@ export class BaseStreamService {
         return this.status;
     }
     async initStream(stream) {
+        if (this.config.insecure)
+            return; // no need to init auth for insecure connections
         const authService = RocosStore.getSDKInstance(this.config).getAuthService();
         if (!this.config.token || !authService.isTokenValid(new Token(this.config.token))) {
             try {

package/esm/services/WorkflowService.d.ts

@@ -1,5 +1,5 @@
-import { RocosError } from '../models/RocosError';
 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';
@@ -13,11 +13,6 @@ export declare class WorkflowService extends BaseServiceAbstract implements IBas
      * @param projectId - Project Id
      */
     list(projectId: string): Promise<Workflow[]>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Use list instead.
-     */
-    getAll: (projectId: string) => Promise<Workflow[]>;
     /**
      * Create a workflow
      *
@@ -32,11 +27,6 @@ export declare class WorkflowService extends BaseServiceAbstract implements IBas
      * @param workflowId - Workflow Id
      */
     get(projectId: string, workflowId: string): Promise<Workflow>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Use get instead.
-     */
-    getOne: (projectId: string, workflowId: string) => Promise<Workflow>;
     /**
      * Update a workflow
      *
@@ -45,6 +35,16 @@ export declare class WorkflowService extends BaseServiceAbstract implements IBas
      * @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
      *
@@ -59,9 +59,4 @@ export declare class WorkflowService extends BaseServiceAbstract implements IBas
      * @param callsign - Robot callsign
      */
     getDeployedWorkflows(projectId: string, callsign: string): Promise<Workflow[]>;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Use getDeployedWorkflow instead.
-     */
-    getDeployedOnRobot: (projectId: string, callsign: string) => Promise<Workflow[]>;
 }

package/esm/services/WorkflowService.js

@@ -1,26 +1,12 @@
-import { API_PROJECT_DEPLOYED_WORKFLOW_URL, API_PROJECT_WORKFLOW_ID_URL, API_PROJECT_WORKFLOW_URL, } from '../constants/api';
+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);
-        /**
-         * @deprecated This method is deprecated and will be removed in a future version.
-         * Use list instead.
-         */
-        this.getAll = this.list;
-        /**
-         * @deprecated This method is deprecated and will be removed in a future version.
-         * Use get instead.
-         */
-        this.getOne = this.get;
-        /**
-         * @deprecated This method is deprecated and will be removed in a future version.
-         * Use getDeployedWorkflow instead.
-         */
-        this.getDeployedOnRobot = this.getDeployedWorkflows;
         this.logger = RocosLogger.getInstance(`WorkflowService(${this.config.url})`);
     }
     getError(e) {
@@ -65,6 +51,37 @@ export class WorkflowService extends BaseServiceAbstract {
     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
      *

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.5",
+  "version": "3.0.1-alpha.7",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",