@dronedeploy/rocos-js-sdk 3.0.1-alpha.8 → 3.0.1-alpha.9

package/cjs/models/asset-storage/SyncIntegrations.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema7 } from "json-schema";
+import { JSONSchema7 } from 'json-schema';
 export interface AssetSyncDefinitionModel {
     path: string;
     enabled: boolean;

package/cjs/services/AssetStorageService.d.ts

@@ -1,9 +1,5 @@
-import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel } from '../models';
-import { RocosError } from '../models/RocosError';
+import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel, CreateAssetSyncIntegrationModel, IBaseService, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-import { CreateAssetSyncIntegrationModel } from '../models/asset-storage/SyncIntegrations';
 export declare class AssetStorageService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
     protected getError(e: Error): RocosError;
@@ -15,7 +11,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    create(projectId: string, filePath: string, file: File): Promise<any>;
+    create(projectId: string, filePath: string, file: File): Promise<AssetItemModel>;
     /**
      * Update a project asset
      *
@@ -23,28 +19,23 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    update(projectId: string, filePath: string, file: File): Promise<any>;
+    update(projectId: string, filePath: string, file: File): Promise<AssetItemModel>;
     /**
      * Delete a project asset
      *
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    delete(projectId: string, filePath: string): Promise<any>;
-    /**
-     * Lost assets for a project or project file path
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     */
-    list(projectId: string, filePath?: string): Promise<any>;
+    delete(projectId: string, filePath: string): Promise<unknown>;
+    list(projectId: string): Promise<AssetItemModel[]>;
+    list(projectId: string, filePath: string): Promise<unknown>;
     /**
      * Get a project asset
      *
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    getAsset(projectId: string, filePath: string): Promise<any>;
+    getAsset(projectId: string, filePath: string): Promise<Blob>;
     /**
      * List assets for a robot
      *
@@ -91,8 +82,9 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param projectId
      * @param callsign
      * @param definition
+     * @param syncNow - Sync configured paths immediately
      */
-    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionModel): Promise<AssetSyncDefinitionsModel>;
+    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionsModel, syncNow?: boolean): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Robot Sync Definitions
      * @param projectId
@@ -105,7 +97,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param profileId
      * @param definition
      */
-    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionModel): Promise<any>;
+    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionsModel): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Profile Sync Definitions
      * @param projectId

package/cjs/services/AssetStorageService.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetStorageService = void 0;
 const api_1 = require("../constants/api");
-const RocosError_1 = require("../models/RocosError");
+const models_1 = require("../models");
 const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
 const RocosLogger_1 = require("../logger/RocosLogger");
 const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
@@ -12,7 +12,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
         this.logger = RocosLogger_1.RocosLogger.getInstance(`AssetStorageService(${this.config.url})`);
     }
     getError(e) {
-        return new RocosError_1.RocosError(e, RocosError_1.errorCodes.ASSET_STORAGE_SERVICE_ERROR);
+        return new models_1.RocosError(e, models_1.errorCodes.ASSET_STORAGE_SERVICE_ERROR);
     }
     getStatus() {
         return true;
@@ -24,7 +24,6 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    // TODO: map the response object
     async create(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
@@ -37,7 +36,6 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    // TODO: map the response object
     async update(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
@@ -59,7 +57,6 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    // TODO: map the response object
     async list(projectId, filePath) {
         let url = '';
         if (filePath) {
@@ -76,7 +73,6 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    // TODO: map the response object
     async getAsset(projectId, filePath) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
             responseType: 'blob',
@@ -143,14 +139,18 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId
      * @param callsign
      * @param definition
+     * @param syncNow - Sync configured paths immediately
      */
-    setRobotSyncDefinitions(projectId, callsign, definition) {
+    setRobotSyncDefinitions(projectId, callsign, definition, syncNow = false) {
+        const url = (0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure);
         const httpOptions = {
             headers: {
                 'content-type': 'application/json',
             },
         };
-        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
+        return this.callPost(url, definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions, {
+            syncNow,
+        });
     }
     /**
      * Get Robot Sync Definitions

package/cjs/services/BaseServiceAbstract.d.ts

@@ -21,7 +21,7 @@ export declare abstract class BaseServiceAbstract {
     protected logger: Logger;
     protected constructor(config: IRocosSDKConfig);
     protected abstract getError(e: Error): RocosError;
-    protected callPost<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig): Promise<Response>;
+    protected callPost<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig, params?: QueryParams): Promise<Response>;
     protected callPut<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig): Promise<Response>;
     protected callDelete<Response = unknown, Payload = unknown>(url: string, errorMessage: string, payload?: Payload): Promise<Response>;
     protected callGet<Response = unknown>(url: string, errorMessage: string, params?: QueryParams, config?: RequestConfig): Promise<Response>;

package/cjs/services/BaseServiceAbstract.js

@@ -8,8 +8,8 @@ class BaseServiceAbstract {
     constructor(config) {
         this.config = config;
     }
-    async callPost(url, payload, errorMessage, config) {
-        return this.call(url, 'POST', { errorMessage, payload, config });
+    async callPost(url, payload, errorMessage, config, params) {
+        return this.call(url, 'POST', { errorMessage, payload, config, params });
     }
     async callPut(url, payload, errorMessage, config) {
         return this.call(url, 'PUT', { errorMessage, payload, config });

package/esm/models/asset-storage/SyncIntegrations.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema7 } from "json-schema";
+import { JSONSchema7 } from 'json-schema';
 export interface AssetSyncDefinitionModel {
     path: string;
     enabled: boolean;

package/esm/services/AssetStorageService.d.ts

@@ -1,9 +1,5 @@
-import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel } from '../models';
-import { RocosError } from '../models/RocosError';
+import { AssetItemModel, AssetItemWithObservationsModel, AssetSyncDefinitionsModel, AssetSyncIntegrationModel, AssetSyncIntegrationProviderModel, CreateAssetSyncIntegrationModel, IBaseService, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-import { CreateAssetSyncIntegrationModel } from '../models/asset-storage/SyncIntegrations';
 export declare class AssetStorageService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
     protected getError(e: Error): RocosError;
@@ -15,7 +11,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    create(projectId: string, filePath: string, file: File): Promise<any>;
+    create(projectId: string, filePath: string, file: File): Promise<AssetItemModel>;
     /**
      * Update a project asset
      *
@@ -23,28 +19,23 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    update(projectId: string, filePath: string, file: File): Promise<any>;
+    update(projectId: string, filePath: string, file: File): Promise<AssetItemModel>;
     /**
      * Delete a project asset
      *
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    delete(projectId: string, filePath: string): Promise<any>;
-    /**
-     * Lost assets for a project or project file path
-     *
-     * @param projectId - Project Id
-     * @param filePath - Path to asset file
-     */
-    list(projectId: string, filePath?: string): Promise<any>;
+    delete(projectId: string, filePath: string): Promise<unknown>;
+    list(projectId: string): Promise<AssetItemModel[]>;
+    list(projectId: string, filePath: string): Promise<unknown>;
     /**
      * Get a project asset
      *
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    getAsset(projectId: string, filePath: string): Promise<any>;
+    getAsset(projectId: string, filePath: string): Promise<Blob>;
     /**
      * List assets for a robot
      *
@@ -91,8 +82,9 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param projectId
      * @param callsign
      * @param definition
+     * @param syncNow - Sync configured paths immediately
      */
-    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionModel): Promise<AssetSyncDefinitionsModel>;
+    setRobotSyncDefinitions(projectId: string, callsign: string, definition: AssetSyncDefinitionsModel, syncNow?: boolean): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Robot Sync Definitions
      * @param projectId
@@ -105,7 +97,7 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param profileId
      * @param definition
      */
-    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionModel): Promise<any>;
+    setProfileSyncDefinitions(projectId: string, profileId: string, definition: AssetSyncDefinitionsModel): Promise<AssetSyncDefinitionsModel>;
     /**
      * Get Profile Sync Definitions
      * @param projectId

package/esm/services/AssetStorageService.js

@@ -1,5 +1,5 @@
 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 { RocosError, errorCodes, } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
 import { formatServiceUrl } from '../helpers/formatServiceUrl';
@@ -21,7 +21,6 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    // TODO: map the response object
     async create(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
@@ -34,7 +33,6 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param filePath - Path to asset file
      * @param file - File payload
      */
-    // TODO: map the response object
     async update(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
@@ -56,7 +54,6 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    // TODO: map the response object
     async list(projectId, filePath) {
         let url = '';
         if (filePath) {
@@ -73,7 +70,6 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @param filePath - Path to asset file
      */
-    // TODO: map the response object
     async getAsset(projectId, filePath) {
         return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
             responseType: 'blob',
@@ -140,14 +136,18 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @param projectId
      * @param callsign
      * @param definition
+     * @param syncNow - Sync configured paths immediately
      */
-    setRobotSyncDefinitions(projectId, callsign, definition) {
+    setRobotSyncDefinitions(projectId, callsign, definition, syncNow = false) {
+        const url = formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure);
         const httpOptions = {
             headers: {
                 'content-type': 'application/json',
             },
         };
-        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
+        return this.callPost(url, definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions, {
+            syncNow,
+        });
     }
     /**
      * Get Robot Sync Definitions

package/esm/services/BaseServiceAbstract.d.ts

@@ -21,7 +21,7 @@ export declare abstract class BaseServiceAbstract {
     protected logger: Logger;
     protected constructor(config: IRocosSDKConfig);
     protected abstract getError(e: Error): RocosError;
-    protected callPost<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig): Promise<Response>;
+    protected callPost<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig, params?: QueryParams): Promise<Response>;
     protected callPut<Response = unknown, Payload = unknown>(url: string, payload: Payload, errorMessage: string, config?: RequestConfig): Promise<Response>;
     protected callDelete<Response = unknown, Payload = unknown>(url: string, errorMessage: string, payload?: Payload): Promise<Response>;
     protected callGet<Response = unknown>(url: string, errorMessage: string, params?: QueryParams, config?: RequestConfig): Promise<Response>;

package/esm/services/BaseServiceAbstract.js

@@ -5,8 +5,8 @@ export class BaseServiceAbstract {
     constructor(config) {
         this.config = config;
     }
-    async callPost(url, payload, errorMessage, config) {
-        return this.call(url, 'POST', { errorMessage, payload, config });
+    async callPost(url, payload, errorMessage, config, params) {
+        return this.call(url, 'POST', { errorMessage, payload, config, params });
     }
     async callPut(url, payload, errorMessage, config) {
         return this.call(url, 'PUT', { errorMessage, payload, config });

package/package.json

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