@dronedeploy/rocos-js-sdk 3.0.14 → 3.0.16

package/cjs/models/Dashboard.d.ts

@@ -0,0 +1,6 @@
+export interface Dashboard {
+    dashboardId: string;
+    name: string;
+    profileId: string;
+    type: string;
+}

package/cjs/models/Dashboard.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/models/EventDefinition.d.ts

@@ -0,0 +1,52 @@
+export interface EventDefinitionList {
+    type?: 'event-definitions';
+    items: EventDefinition[];
+    version?: string;
+    robotDefinitionId?: string;
+    username?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface EventDefinition {
+    id: string;
+    actions?: (EventNotificationAction | EventSendCommandAction | EventHttpAction)[];
+    description?: string;
+    enabled?: boolean;
+    minDispatchInterval?: string;
+    name?: string;
+    trigger?: EventTrigger;
+}
+export interface EventNotificationAction {
+    level: string;
+    target: {
+        sendInAppNotification: boolean;
+    };
+    title: string;
+    content?: string;
+}
+export interface EventSendCommandAction {
+    executeLocally?: boolean;
+    id: string;
+    timeoutMs: string;
+}
+export interface EventHttpAction {
+    address: string;
+    method: string;
+    body: string;
+    timeoutMs: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export interface EventTrigger {
+    expressions?: {
+        operator: string;
+        threshold: number;
+        value: string;
+    }[];
+    mode?: string;
+    sampleInterval?: string;
+    source?: string;
+    useAdvance?: boolean;
+    advancedCondition?: string;
+}

package/cjs/models/EventDefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/models/RobotProfile.d.ts

@@ -0,0 +1,6 @@
+export interface RobotProfile {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string[];
+}

package/cjs/models/RobotProfile.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/services/EventService.d.ts

@@ -1,3 +1,4 @@
+import { EventDefinition, EventDefinitionList } from '../models/EventDefinition';
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { IBaseService } from '../models/IBaseService';
@@ -40,7 +41,7 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetEventDefinitions
      */
-    getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<any>;
+    getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<EventDefinitionList>;
     /**
      * Update events for a robot definition
      *
@@ -49,5 +50,5 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
      * @param model - Payload
      * @description - Renamed from robotDefAddEventDefinitions
      */
-    addDefinitionsForRobotDef(projectId: string, definitionId: string, model: any): Promise<any>;
+    addDefinitionsForRobotDef(projectId: string, definitionId: string, model: EventDefinition[]): Promise<void>;
 }

package/cjs/services/EventService.js

@@ -67,7 +67,6 @@ class EventService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetEventDefinitions
      */
-    // TODO: map the response object
     async getDefinitionsForRobotDef(projectId, definitionId) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get event definitions list for ${projectId}, definitionId ${definitionId}.`);
     }
@@ -79,9 +78,6 @@ class EventService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param model - Payload
      * @description - Renamed from robotDefAddEventDefinitions
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async addDefinitionsForRobotDef(projectId, definitionId, model) {
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update event definitions for ${projectId}, definitionId ${definitionId}.`);
     }

package/cjs/services/ProfileService.d.ts

@@ -1,7 +1,9 @@
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { Dashboard } from '../models/Dashboard';
 import { IBaseService } from '../models/IBaseService';
 import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { RobotProfile } from '../models/RobotProfile';
 export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
     protected getError(e: Error): RocosError;
@@ -20,7 +22,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param projectId - Project Id
      * @description - Renamed from robotDefsList
      */
-    list(projectId: string): Promise<any>;
+    list(projectId: string): Promise<RobotProfile[]>;
     /**
      * Delete robot definitions
      *
@@ -95,7 +97,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param profileId - Profile Id
      * @description - Renamed from robotDefDashboards
      */
-    dashboards(projectId: string, profileId: string): Promise<any>;
+    dashboards(projectId: string, profileId: string): Promise<Dashboard[]>;
     /**
      * Get Dashboard data which stored in Azure Blob.
      *
@@ -241,7 +243,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      *
      * @see import
      */
-    export(projectId: string, definitionId: string): Promise<Record<string, unknown>>;
+    export(projectId: string, definitionId: string): Promise<Blob>;
     /** Import robot definition from JSON format
      *
      * Accepts a previously exported robot definition

package/cjs/services/ProfileService.js

@@ -36,7 +36,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId - Project Id
      * @description - Renamed from robotDefsList
      */
-    // TODO: map the response object
     async list(projectId) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get robot definitions.');
     }
@@ -146,7 +145,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param profileId - Profile Id
      * @description - Renamed from robotDefDashboards
      */
-    // TODO: map the response object
     async dashboards(projectId, profileId) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_PROFILE_DASHBOARD_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), 'Failed to get dashboards for a profile.');
     }
@@ -358,7 +356,7 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @see import
      */
     async export(projectId, definitionId) {
-        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_EXPORT, { url: this.config.url, projectId, definitionId }, this.config.insecure), undefined, `Failed to export robot definition for ${projectId}, definitionId  ${definitionId}.`);
+        return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_EXPORT, { url: this.config.url, projectId, definitionId }, this.config.insecure), undefined, `Failed to export robot definition for ${projectId}, definitionId  ${definitionId}.`, { responseType: 'blob' });
     }
     /** Import robot definition from JSON format
      *

package/cjs/services/TelemetryService.js

@@ -38,7 +38,7 @@ class TelemetryService extends BaseStreamService_1.BaseStreamService {
      */
     subscribe(params) {
         const sources = (0, arrayUnique_1.arrayUnique)(params.sources).map((item) => item.trim()) ?? [];
-        if (!params?.callsigns && params?.query) {
+        if (!params?.callsigns && !params?.query) {
             this.logger.error('Error: params need to contain either callsigns or query', params);
             throw new models_1.RocosError('Params need to contain either callsigns or query.', models_1.errorCodes.TELEMETRY_SERVICE_ERROR);
         }

package/esm/models/Dashboard.d.ts

@@ -0,0 +1,6 @@
+export interface Dashboard {
+    dashboardId: string;
+    name: string;
+    profileId: string;
+    type: string;
+}

package/esm/models/Dashboard.js

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

package/esm/models/EventDefinition.d.ts

@@ -0,0 +1,52 @@
+export interface EventDefinitionList {
+    type?: 'event-definitions';
+    items: EventDefinition[];
+    version?: string;
+    robotDefinitionId?: string;
+    username?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface EventDefinition {
+    id: string;
+    actions?: (EventNotificationAction | EventSendCommandAction | EventHttpAction)[];
+    description?: string;
+    enabled?: boolean;
+    minDispatchInterval?: string;
+    name?: string;
+    trigger?: EventTrigger;
+}
+export interface EventNotificationAction {
+    level: string;
+    target: {
+        sendInAppNotification: boolean;
+    };
+    title: string;
+    content?: string;
+}
+export interface EventSendCommandAction {
+    executeLocally?: boolean;
+    id: string;
+    timeoutMs: string;
+}
+export interface EventHttpAction {
+    address: string;
+    method: string;
+    body: string;
+    timeoutMs: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export interface EventTrigger {
+    expressions?: {
+        operator: string;
+        threshold: number;
+        value: string;
+    }[];
+    mode?: string;
+    sampleInterval?: string;
+    source?: string;
+    useAdvance?: boolean;
+    advancedCondition?: string;
+}

package/esm/models/EventDefinition.js

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

package/esm/models/RobotProfile.d.ts

@@ -0,0 +1,6 @@
+export interface RobotProfile {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string[];
+}

package/esm/models/RobotProfile.js

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

package/esm/services/EventService.d.ts

@@ -1,3 +1,4 @@
+import { EventDefinition, EventDefinitionList } from '../models/EventDefinition';
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { IBaseService } from '../models/IBaseService';
@@ -40,7 +41,7 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetEventDefinitions
      */
-    getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<any>;
+    getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<EventDefinitionList>;
     /**
      * Update events for a robot definition
      *
@@ -49,5 +50,5 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
      * @param model - Payload
      * @description - Renamed from robotDefAddEventDefinitions
      */
-    addDefinitionsForRobotDef(projectId: string, definitionId: string, model: any): Promise<any>;
+    addDefinitionsForRobotDef(projectId: string, definitionId: string, model: EventDefinition[]): Promise<void>;
 }

package/esm/services/EventService.js

@@ -64,7 +64,6 @@ export class EventService extends BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetEventDefinitions
      */
-    // TODO: map the response object
     async getDefinitionsForRobotDef(projectId, definitionId) {
         return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get event definitions list for ${projectId}, definitionId ${definitionId}.`);
     }
@@ -76,9 +75,6 @@ export class EventService extends BaseServiceAbstract {
      * @param model - Payload
      * @description - Renamed from robotDefAddEventDefinitions
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async addDefinitionsForRobotDef(projectId, definitionId, model) {
         return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_EVENT_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update event definitions for ${projectId}, definitionId ${definitionId}.`);
     }

package/esm/services/ProfileService.d.ts

@@ -1,7 +1,9 @@
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { Dashboard } from '../models/Dashboard';
 import { IBaseService } from '../models/IBaseService';
 import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { RobotProfile } from '../models/RobotProfile';
 export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
     protected getError(e: Error): RocosError;
@@ -20,7 +22,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param projectId - Project Id
      * @description - Renamed from robotDefsList
      */
-    list(projectId: string): Promise<any>;
+    list(projectId: string): Promise<RobotProfile[]>;
     /**
      * Delete robot definitions
      *
@@ -95,7 +97,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param profileId - Profile Id
      * @description - Renamed from robotDefDashboards
      */
-    dashboards(projectId: string, profileId: string): Promise<any>;
+    dashboards(projectId: string, profileId: string): Promise<Dashboard[]>;
     /**
      * Get Dashboard data which stored in Azure Blob.
      *
@@ -241,7 +243,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      *
      * @see import
      */
-    export(projectId: string, definitionId: string): Promise<Record<string, unknown>>;
+    export(projectId: string, definitionId: string): Promise<Blob>;
     /** Import robot definition from JSON format
      *
      * Accepts a previously exported robot definition

package/esm/services/ProfileService.js

@@ -33,7 +33,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @description - Renamed from robotDefsList
      */
-    // TODO: map the response object
     async list(projectId) {
         return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get robot definitions.');
     }
@@ -143,7 +142,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param profileId - Profile Id
      * @description - Renamed from robotDefDashboards
      */
-    // TODO: map the response object
     async dashboards(projectId, profileId) {
         return this.callGet(formatServiceUrl(API_PROJECT_PROFILE_DASHBOARD_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), 'Failed to get dashboards for a profile.');
     }
@@ -355,7 +353,7 @@ export class ProfileService extends BaseServiceAbstract {
      * @see import
      */
     async export(projectId, definitionId) {
-        return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_EXPORT, { url: this.config.url, projectId, definitionId }, this.config.insecure), undefined, `Failed to export robot definition for ${projectId}, definitionId  ${definitionId}.`);
+        return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_EXPORT, { url: this.config.url, projectId, definitionId }, this.config.insecure), undefined, `Failed to export robot definition for ${projectId}, definitionId  ${definitionId}.`, { responseType: 'blob' });
     }
     /** Import robot definition from JSON format
      *

package/esm/services/TelemetryService.js

@@ -35,7 +35,7 @@ export class TelemetryService extends BaseStreamService {
      */
     subscribe(params) {
         const sources = arrayUnique(params.sources).map((item) => item.trim()) ?? [];
-        if (!params?.callsigns && params?.query) {
+        if (!params?.callsigns && !params?.query) {
             this.logger.error('Error: params need to contain either callsigns or query', params);
             throw new RocosError('Params need to contain either callsigns or query.', errorCodes.TELEMETRY_SERVICE_ERROR);
         }

package/package.json

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