@dronedeploy/rocos-js-sdk 3.0.15-hotifix.1 → 3.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/constants/api.d.ts +1 -0
- package/cjs/constants/api.js +4 -3
- package/cjs/models/ConnectionStatus.d.ts +6 -0
- package/cjs/models/ConnectionStatus.js +2 -0
- package/cjs/models/Dashboard.d.ts +6 -0
- package/cjs/models/Dashboard.js +2 -0
- package/cjs/models/EventDefinition.d.ts +52 -0
- package/cjs/models/EventDefinition.js +2 -0
- package/cjs/models/IRobot.d.ts +5 -0
- package/cjs/models/RobotProfile.d.ts +6 -0
- package/cjs/models/RobotProfile.js +2 -0
- package/cjs/services/EventService.d.ts +3 -2
- package/cjs/services/EventService.js +0 -4
- package/cjs/services/ProfileService.d.ts +4 -2
- package/cjs/services/ProfileService.js +0 -2
- package/cjs/services/RobotService.d.ts +7 -1
- package/cjs/services/RobotService.js +9 -0
- package/esm/constants/api.d.ts +1 -0
- package/esm/constants/api.js +1 -0
- package/esm/models/ConnectionStatus.d.ts +6 -0
- package/esm/models/ConnectionStatus.js +1 -0
- package/esm/models/Dashboard.d.ts +6 -0
- package/esm/models/Dashboard.js +1 -0
- package/esm/models/EventDefinition.d.ts +52 -0
- package/esm/models/EventDefinition.js +1 -0
- package/esm/models/IRobot.d.ts +5 -0
- package/esm/models/RobotProfile.d.ts +6 -0
- package/esm/models/RobotProfile.js +1 -0
- package/esm/services/EventService.d.ts +3 -2
- package/esm/services/EventService.js +0 -4
- package/esm/services/ProfileService.d.ts +4 -2
- package/esm/services/ProfileService.js +0 -2
- package/esm/services/RobotService.d.ts +7 -1
- package/esm/services/RobotService.js +10 -1
- package/package.json +1 -1
package/cjs/constants/api.d.ts
CHANGED
@@ -42,6 +42,7 @@ export declare const API_PROJECT_MISSION_ASSET_PATH_URL = "https://{url}/project
|
|
42
42
|
export declare const API_PROJECT_MAPPED_ASSETS_PATH_URL = "https://{url}/projects/{projectId}/mappedassets";
|
43
43
|
export declare const API_PROJECT_MAPPED_ASSET_PATH_URL = "https://{url}/projects/{projectId}/mappedassets/{assetId}";
|
44
44
|
export declare const API_PROJECT_ROBOT_URL = "https://{url}/projects/{projectId}/robots";
|
45
|
+
export declare const API_ACCOUNT_ROBOT_URL = "https://{url}/accounts/{accountId}/robots";
|
45
46
|
export declare const API_PROJECT_ROBOT_ID_URL = "https://{url}/projects/{projectId}/robots/{callsign}";
|
46
47
|
export declare const API_PROJECT_ROBOT_ATTRIBUTES_URL = "https://{url}/projects/{projectId}/robots/{callsign}/attributes";
|
47
48
|
export declare const API_PROJECT_ROBOT_DEFINITION_URL = "https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions";
|
package/cjs/constants/api.js
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
"use strict";
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
3
|
-
exports.
|
4
|
-
exports.
|
5
|
-
exports.API_DEVICE_CREDENTIALS_AUTH_URL = exports.API_DEVICE_CREDENTIALS_URL = exports.API_LINKED_PROJECT_URL = exports.API_PROJECT_WORKFLOW_IMPORT_URL = exports.API_PROJECT_WORKFLOW_EXPORT_URL = exports.API_PROJECT_WORKFLOW_AFFECTED_URL = exports.API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_PROFILE_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_ROBOT_NO_PROFILE_DEPLOYMENTS_URL = exports.API_PROJECT_PROFILE_DEPLOYMENTS_URL = exports.API_PROJECT_ROBOT_DEPLOYMENTS_URL = exports.API_PROJECT_WORKFLOW_ASSET_ID_URL = exports.API_PROJECT_WORKFLOW_ASSET_URL = exports.API_PROJECT_WORKFLOW_ID_URL = exports.API_PROJECT_WORKFLOW_URL = exports.API_GRAPHS_ASSETS_URL = exports.API_GRAPHS_ASSETS_UPLOAD_URL = exports.API_GRAPHS_TARGETS_URL = exports.API_GRAPHS_TARGET_UPLOAD_URL = exports.API_GRAPHS_OBSERVATION_KEYS_URL = exports.API_GRAPHS_OBSERVATIONS_URL = exports.API_GRAPHS_PANORAMA_OBSERVATIONS_URL = exports.API_GRAPHS_PANORAMA = exports.API_GRAPHS_MAPS_GEOJSON_URL = exports.API_GRAPHS_MAPS_DEPLOY_URL = exports.API_GRAPHS_MAPS_COPY_URL = exports.API_GRAPHS_MAP_ID_URL = exports.API_GRAPHS_MAPS_MERGE_URL = exports.API_GRAPHS_MAPS_DEPLOYED_URL = exports.API_GRAPHS_MAPS_URL = exports.API_DD_INTEGRATION_LOCATIONS_URL = exports.API_DD_INTEGRATION_ISSUES_URL = exports.API_DD_INTEGRATION_OVERLAYS_URL = exports.API_DD_INTEGRATION_PLAN_BY_ID_URL = exports.API_DD_INTEGRATION_PLANS_URL = exports.API_SPOTTY_URL = exports.API_PROJECT_SCHEDULES_URL = exports.API_SOURCE_ID_URL = exports.API_SOURCE_URL = exports.API_SOURCE_SCHEMA_URL = exports.API_TEMPLATE_EXPORTER_URL = exports.API_TEMPLATE_PROVISION_ID_URL = exports.API_TEMPLATE_PROVISION_URL = exports.API_TEMPLATE_DEPLOY_URL = exports.API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = exports.API_PROJECT_PROFILE_DASHBOARD_ID_URL = exports.API_PROJECT_PROFILE_DASHBOARD_URL = exports.API_PROJECT_CALLSIGN_STREAM_URL = exports.API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = void 0;
|
3
|
+
exports.API_PROJECT_ROBOT_EVENT_URL = exports.API_PROJECT_ROBOT_REGISTER_URL = exports.API_PROJECT_ROBOT_DEFINITION_URL = exports.API_PROJECT_ROBOT_ATTRIBUTES_URL = exports.API_PROJECT_ROBOT_ID_URL = exports.API_ACCOUNT_ROBOT_URL = exports.API_PROJECT_ROBOT_URL = exports.API_PROJECT_MAPPED_ASSET_PATH_URL = exports.API_PROJECT_MAPPED_ASSETS_PATH_URL = exports.API_PROJECT_MISSION_ASSET_PATH_URL = exports.API_PROJECT_MISSION_ASSETS_PATH_URL = exports.API_PROJECT_FLOW_ASSET_PATH_URL = exports.API_PROJECT_ROBOT_ASSET_PATH_URL = exports.API_PROJECT_ASSET_INTEGRATION_PATH_URL = exports.API_PROJECT_ASSET_INTEGRATIONS_PATH_URL = exports.API_PROJECT_ASSET_INTEGRATION_PROVIDERS_PATH_URL = exports.API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL = exports.API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL = exports.API_PROJECT_ASSET_PATH_URL = exports.API_PROJECT_ASSET_URL = exports.API_PROJECT_USERS_URL = exports.API_PROJECT_ID_URL = exports.API_PROJECT_URL = exports.API_ACCOUNT_EXTERNAL_PROJECTS_URL = exports.API_ACCOUNT_PROJECT_APPLICATION_ID_URL = exports.API_ACCOUNT_PROJECT_APPLICATION_URL = exports.API_ACCOUNT_PROJECT_USER_ID_URL = exports.API_ACCOUNT_PROJECT_USER_URL = exports.API_ACCOUNT_PROJECT_ID_URL = exports.API_ACCOUNT_PROJECT_URL = exports.API_SERVER_TIME_URL = exports.API_ACCOUNT_SETTINGS_URL = exports.API_AUTH_USER_ACCOUNT_USER_ID_URL = exports.API_AUTH_USER_ACCOUNT_USER_URL = exports.API_ACCOUNT_ACTIVATE_URL = exports.API_ACCOUNT_ID_URL = exports.API_ACCOUNT_URL = exports.API_USER_PAT_TOKEN_URL = exports.API_USER_PAT_URL = exports.API_USER_VERIFY_EMAIL_URL = exports.API_USER_INVITATION_CHECK_URL = exports.API_USER_INVITATION_ACCEPT_URL = exports.API_USER_INVITATION_URL = exports.API_USER_PASSWORD_FORGOT_URL = exports.API_OTP_AUTH_URL = exports.API_OTP_URL = exports.API_USER_TOKEN_URL = exports.API_USER_URL = exports.API_ADMIN_USER_INVITATION_URL = exports.API_APPLICATION_AUTH_URL = void 0;
|
4
|
+
exports.API_PROJECT_ROBOT_DASHBOARD_URL = exports.API_PROJECT_STREAM_CALLSIGN_URL = exports.API_PROJECT_STREAM_DATA_URL = exports.API_PROJECT_STREAM_ID_URL = exports.API_PROJECT_STREAM_URL = exports.API_PROJECT_GROUP_TYPE_OWNER_OVERRIDE_URL = exports.API_PROJECT_GROUP_TYPE_OWNER_ID_URL = exports.API_PROJECT_GROUP_TYPE_VERSION_URL = exports.API_PROJECT_GROUP_TYPE_CONFIG_URL = exports.API_PROJECT_GROUP_TYPE_PUBLISH_URL = exports.API_PROJECT_GROUP_TYPE_ID_URL = exports.API_PROJECT_GROUP_TYPE_URL = exports.API_PROJECT_ENVIRONMENT_URL = exports.API_PROJECT_DEFINITION_IMPORT = exports.API_PROJECT_DEFINITION_EXPORT = exports.API_PROJECT_DEFINITION_GAMEPAD_URL = exports.API_PROJECT_DEFINITION_TRIGGER_URL = exports.API_PROJECT_DEFINITION_BUTTON_URL = exports.API_PROJECT_DEFINITION_ACTION_URL = exports.API_PROJECT_DEFINITION_EVENT_URL = exports.API_PROJECT_DEFINITION_COMMAND2_URL = exports.API_PROJECT_DEFINITION_COMMAND_URL = exports.API_PROJECT_DEFINITION_AGENT_URL = exports.API_PROJECT_DEFINITION_SETTING_URL = exports.API_PROJECT_DEFINITION_BLOB_URL = exports.API_PROJECT_DEFINITION_DASHBOARD_URL = exports.API_PROJECT_DEFINITION_COPY_URL = exports.API_PROJECT_DEFINITION_STREAM_URL = exports.API_PROJECT_DEFINITION_ID_URL = exports.API_PROJECT_DEFINITION_URL = exports.API_PROJECT_VROBOT_DEPLOY_URL = exports.API_PROJECT_VROBOT_DETAILS_URL = exports.API_PROJECT_COLLECTION_DOCS_URL = exports.API_PROJECT_COLLECTION_ID_URL = exports.API_PROJECT_DASHBOARD_CUSTOM_WIDGET_URL = exports.API_PROJECT_DASHBOARD_WIDGET_URL = exports.API_PROJECT_DASHBOARD_ID_URL = exports.API_PROJECT_DASHBOARD_URL = exports.API_PROJECT_OPERATION_ID_URL = exports.API_PROJECT_OPERATION_URL = exports.API_PROJECT_ROBOT_CONFIGS_CONNECTION_URL = exports.API_PROJECT_ROBOT_CONFIGS_CONNECTIONS_URL = exports.API_PROJECT_ROBOT_GAMEPAD_URL = exports.API_PROJECT_ROBOT_TRIGGER_URL = exports.API_PROJECT_ROBOT_BUTTON_URL = exports.API_PROJECT_ROBOT_COMMAND2_URL = exports.API_PROJECT_ROBOT_COMMAND_URL = exports.API_PROJECT_ROBOT_AGENT_URL = exports.API_PROJECT_ROBOT_SETTING_URL = exports.API_PROJECT_ROBOT_EVENT_HISTORY_URL = void 0;
|
5
|
+
exports.API_DEVICE_CREDENTIALS_AUTH_URL = exports.API_DEVICE_CREDENTIALS_URL = exports.API_LINKED_PROJECT_URL = exports.API_PROJECT_WORKFLOW_IMPORT_URL = exports.API_PROJECT_WORKFLOW_EXPORT_URL = exports.API_PROJECT_WORKFLOW_AFFECTED_URL = exports.API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_PROFILE_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_ROBOT_NO_PROFILE_DEPLOYMENTS_URL = exports.API_PROJECT_PROFILE_DEPLOYMENTS_URL = exports.API_PROJECT_ROBOT_DEPLOYMENTS_URL = exports.API_PROJECT_WORKFLOW_ASSET_ID_URL = exports.API_PROJECT_WORKFLOW_ASSET_URL = exports.API_PROJECT_WORKFLOW_ID_URL = exports.API_PROJECT_WORKFLOW_URL = exports.API_GRAPHS_ASSETS_URL = exports.API_GRAPHS_ASSETS_UPLOAD_URL = exports.API_GRAPHS_TARGETS_URL = exports.API_GRAPHS_TARGET_UPLOAD_URL = exports.API_GRAPHS_OBSERVATION_KEYS_URL = exports.API_GRAPHS_OBSERVATIONS_URL = exports.API_GRAPHS_PANORAMA_OBSERVATIONS_URL = exports.API_GRAPHS_PANORAMA = exports.API_GRAPHS_MAPS_GEOJSON_URL = exports.API_GRAPHS_MAPS_DEPLOY_URL = exports.API_GRAPHS_MAPS_COPY_URL = exports.API_GRAPHS_MAP_ID_URL = exports.API_GRAPHS_MAPS_MERGE_URL = exports.API_GRAPHS_MAPS_DEPLOYED_URL = exports.API_GRAPHS_MAPS_URL = exports.API_DD_INTEGRATION_LOCATIONS_URL = exports.API_DD_INTEGRATION_ISSUES_URL = exports.API_DD_INTEGRATION_OVERLAYS_URL = exports.API_DD_INTEGRATION_PLAN_BY_ID_URL = exports.API_DD_INTEGRATION_PLANS_URL = exports.API_SPOTTY_URL = exports.API_PROJECT_SCHEDULES_URL = exports.API_SOURCE_ID_URL = exports.API_SOURCE_URL = exports.API_SOURCE_SCHEMA_URL = exports.API_TEMPLATE_EXPORTER_URL = exports.API_TEMPLATE_PROVISION_ID_URL = exports.API_TEMPLATE_PROVISION_URL = exports.API_TEMPLATE_DEPLOY_URL = exports.API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL = exports.API_PROJECT_PROFILE_DASHBOARD_ID_URL = exports.API_PROJECT_PROFILE_DASHBOARD_URL = exports.API_PROJECT_CALLSIGN_STREAM_URL = exports.API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL = exports.API_PROJECT_ROBOT_DASHBOARD_ID_URL = void 0;
|
6
6
|
exports.API_APPLICATION_AUTH_URL = 'https://{url}/applications/auth';
|
7
7
|
exports.API_ADMIN_USER_INVITATION_URL = 'https://{url}/admin/users/invitations';
|
8
8
|
exports.API_USER_URL = 'https://{url}/users';
|
@@ -47,6 +47,7 @@ exports.API_PROJECT_MISSION_ASSET_PATH_URL = 'https://{url}/projects/{projectId}
|
|
47
47
|
exports.API_PROJECT_MAPPED_ASSETS_PATH_URL = 'https://{url}/projects/{projectId}/mappedassets';
|
48
48
|
exports.API_PROJECT_MAPPED_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/mappedassets/{assetId}';
|
49
49
|
exports.API_PROJECT_ROBOT_URL = 'https://{url}/projects/{projectId}/robots';
|
50
|
+
exports.API_ACCOUNT_ROBOT_URL = 'https://{url}/accounts/{accountId}/robots';
|
50
51
|
exports.API_PROJECT_ROBOT_ID_URL = 'https://{url}/projects/{projectId}/robots/{callsign}';
|
51
52
|
exports.API_PROJECT_ROBOT_ATTRIBUTES_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/attributes';
|
52
53
|
exports.API_PROJECT_ROBOT_DEFINITION_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions';
|
@@ -0,0 +1,52 @@
|
|
1
|
+
export interface EventDefinitionList {
|
2
|
+
type?: 'event-definitions';
|
3
|
+
items: EventDefinition[];
|
4
|
+
version?: string;
|
5
|
+
robotDefinitionId?: string;
|
6
|
+
username?: string;
|
7
|
+
createdAt?: string;
|
8
|
+
updatedAt?: string;
|
9
|
+
}
|
10
|
+
export interface EventDefinition {
|
11
|
+
id: string;
|
12
|
+
actions?: (EventNotificationAction | EventSendCommandAction | EventHttpAction)[];
|
13
|
+
description?: string;
|
14
|
+
enabled?: boolean;
|
15
|
+
minDispatchInterval?: string;
|
16
|
+
name?: string;
|
17
|
+
trigger?: EventTrigger;
|
18
|
+
}
|
19
|
+
export interface EventNotificationAction {
|
20
|
+
level: string;
|
21
|
+
target: {
|
22
|
+
sendInAppNotification: boolean;
|
23
|
+
};
|
24
|
+
title: string;
|
25
|
+
content?: string;
|
26
|
+
}
|
27
|
+
export interface EventSendCommandAction {
|
28
|
+
executeLocally?: boolean;
|
29
|
+
id: string;
|
30
|
+
timeoutMs: string;
|
31
|
+
}
|
32
|
+
export interface EventHttpAction {
|
33
|
+
address: string;
|
34
|
+
method: string;
|
35
|
+
body: string;
|
36
|
+
timeoutMs: string;
|
37
|
+
headers?: {
|
38
|
+
[key: string]: string;
|
39
|
+
};
|
40
|
+
}
|
41
|
+
export interface EventTrigger {
|
42
|
+
expressions?: {
|
43
|
+
operator: string;
|
44
|
+
threshold: number;
|
45
|
+
value: string;
|
46
|
+
}[];
|
47
|
+
mode?: string;
|
48
|
+
sampleInterval?: string;
|
49
|
+
source?: string;
|
50
|
+
useAdvance?: boolean;
|
51
|
+
advancedCondition?: string;
|
52
|
+
}
|
package/cjs/models/IRobot.d.ts
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
import { ConnectionStatus } from './ConnectionStatus';
|
1
2
|
import { RobotModeType } from './types';
|
2
3
|
export interface IRobot {
|
3
4
|
tags?: string[];
|
@@ -16,3 +17,7 @@ export interface IRobot {
|
|
16
17
|
robotDefinitionName?: string;
|
17
18
|
robotDefinitionTags?: string[];
|
18
19
|
}
|
20
|
+
export type IRobotListItem = IRobot & {
|
21
|
+
linkedProjectId?: string;
|
22
|
+
connection?: ConnectionStatus;
|
23
|
+
};
|
@@ -1,3 +1,4 @@
|
|
1
|
+
import { EventDefinition, EventDefinitionList } from '../models/EventDefinition';
|
1
2
|
import { RocosError } from '../models/RocosError';
|
2
3
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
4
|
import { IBaseService } from '../models/IBaseService';
|
@@ -40,7 +41,7 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
|
|
40
41
|
* @param definitionId - Robot definition Id
|
41
42
|
* @description - Renamed from robotDefGetEventDefinitions
|
42
43
|
*/
|
43
|
-
getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<
|
44
|
+
getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<EventDefinitionList>;
|
44
45
|
/**
|
45
46
|
* Update events for a robot definition
|
46
47
|
*
|
@@ -49,5 +50,5 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
|
|
49
50
|
* @param model - Payload
|
50
51
|
* @description - Renamed from robotDefAddEventDefinitions
|
51
52
|
*/
|
52
|
-
addDefinitionsForRobotDef(projectId: string, definitionId: string, model:
|
53
|
+
addDefinitionsForRobotDef(projectId: string, definitionId: string, model: EventDefinition[]): Promise<void>;
|
53
54
|
}
|
@@ -67,7 +67,6 @@ class EventService extends BaseServiceAbstract_1.BaseServiceAbstract {
|
|
67
67
|
* @param definitionId - Robot definition Id
|
68
68
|
* @description - Renamed from robotDefGetEventDefinitions
|
69
69
|
*/
|
70
|
-
// TODO: map the response object
|
71
70
|
async getDefinitionsForRobotDef(projectId, definitionId) {
|
72
71
|
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}.`);
|
73
72
|
}
|
@@ -79,9 +78,6 @@ class EventService extends BaseServiceAbstract_1.BaseServiceAbstract {
|
|
79
78
|
* @param model - Payload
|
80
79
|
* @description - Renamed from robotDefAddEventDefinitions
|
81
80
|
*/
|
82
|
-
// TODO: map the request model
|
83
|
-
// TODO: map the response object
|
84
|
-
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
|
85
81
|
async addDefinitionsForRobotDef(projectId, definitionId, model) {
|
86
82
|
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}.`);
|
87
83
|
}
|
@@ -1,7 +1,9 @@
|
|
1
1
|
import { RocosError } from '../models/RocosError';
|
2
2
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
|
+
import { Dashboard } from '../models/Dashboard';
|
3
4
|
import { IBaseService } from '../models/IBaseService';
|
4
5
|
import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
|
6
|
+
import { RobotProfile } from '../models/RobotProfile';
|
5
7
|
export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
|
6
8
|
constructor(config: IRocosSDKConfig);
|
7
9
|
protected getError(e: Error): RocosError;
|
@@ -20,7 +22,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
|
|
20
22
|
* @param projectId - Project Id
|
21
23
|
* @description - Renamed from robotDefsList
|
22
24
|
*/
|
23
|
-
list(projectId: string): Promise<
|
25
|
+
list(projectId: string): Promise<RobotProfile[]>;
|
24
26
|
/**
|
25
27
|
* Delete robot definitions
|
26
28
|
*
|
@@ -95,7 +97,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
|
|
95
97
|
* @param profileId - Profile Id
|
96
98
|
* @description - Renamed from robotDefDashboards
|
97
99
|
*/
|
98
|
-
dashboards(projectId: string, profileId: string): Promise<
|
100
|
+
dashboards(projectId: string, profileId: string): Promise<Dashboard[]>;
|
99
101
|
/**
|
100
102
|
* Get Dashboard data which stored in Azure Blob.
|
101
103
|
*
|
@@ -36,7 +36,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
|
|
36
36
|
* @param projectId - Project Id
|
37
37
|
* @description - Renamed from robotDefsList
|
38
38
|
*/
|
39
|
-
// TODO: map the response object
|
40
39
|
async list(projectId) {
|
41
40
|
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.');
|
42
41
|
}
|
@@ -146,7 +145,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
|
|
146
145
|
* @param profileId - Profile Id
|
147
146
|
* @description - Renamed from robotDefDashboards
|
148
147
|
*/
|
149
|
-
// TODO: map the response object
|
150
148
|
async dashboards(projectId, profileId) {
|
151
149
|
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.');
|
152
150
|
}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { IBaseService, IConnectedCallsign, IRobot, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
|
1
|
+
import { IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
|
2
2
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
3
|
export declare class RobotService extends BaseServiceAbstract implements IBaseService {
|
4
4
|
constructor(config: IRocosSDKConfig);
|
@@ -10,6 +10,12 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
|
|
10
10
|
* @param projectId - Project Id
|
11
11
|
*/
|
12
12
|
getRobots(projectId: string): Promise<IRobot[]>;
|
13
|
+
/**
|
14
|
+
* Get a list of robots by account id.
|
15
|
+
*
|
16
|
+
* @param accountId - Account Id
|
17
|
+
*/
|
18
|
+
getRobotsByAccountId(accountId: string): Promise<IRobotListItem[]>;
|
13
19
|
/**
|
14
20
|
* Create a new robot.
|
15
21
|
*
|
@@ -27,6 +27,15 @@ class RobotService extends BaseServiceAbstract_1.BaseServiceAbstract {
|
|
27
27
|
const data = await this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get robots list for ${projectId}.`);
|
28
28
|
return data.map((item) => (0, cleanObject_1.cleanObject)(new models_1.Robot(item)));
|
29
29
|
}
|
30
|
+
/**
|
31
|
+
* Get a list of robots by account id.
|
32
|
+
*
|
33
|
+
* @param accountId - Account Id
|
34
|
+
*/
|
35
|
+
async getRobotsByAccountId(accountId) {
|
36
|
+
const data = await this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_ACCOUNT_ROBOT_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to get robots list for organization: ${accountId}.`);
|
37
|
+
return data;
|
38
|
+
}
|
30
39
|
/**
|
31
40
|
* Create a new robot.
|
32
41
|
*
|
package/esm/constants/api.d.ts
CHANGED
@@ -42,6 +42,7 @@ export declare const API_PROJECT_MISSION_ASSET_PATH_URL = "https://{url}/project
|
|
42
42
|
export declare const API_PROJECT_MAPPED_ASSETS_PATH_URL = "https://{url}/projects/{projectId}/mappedassets";
|
43
43
|
export declare const API_PROJECT_MAPPED_ASSET_PATH_URL = "https://{url}/projects/{projectId}/mappedassets/{assetId}";
|
44
44
|
export declare const API_PROJECT_ROBOT_URL = "https://{url}/projects/{projectId}/robots";
|
45
|
+
export declare const API_ACCOUNT_ROBOT_URL = "https://{url}/accounts/{accountId}/robots";
|
45
46
|
export declare const API_PROJECT_ROBOT_ID_URL = "https://{url}/projects/{projectId}/robots/{callsign}";
|
46
47
|
export declare const API_PROJECT_ROBOT_ATTRIBUTES_URL = "https://{url}/projects/{projectId}/robots/{callsign}/attributes";
|
47
48
|
export declare const API_PROJECT_ROBOT_DEFINITION_URL = "https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions";
|
package/esm/constants/api.js
CHANGED
@@ -42,6 +42,7 @@ export const API_PROJECT_MISSION_ASSET_PATH_URL = 'https://{url}/projects/{proje
|
|
42
42
|
export const API_PROJECT_MAPPED_ASSETS_PATH_URL = 'https://{url}/projects/{projectId}/mappedassets';
|
43
43
|
export const API_PROJECT_MAPPED_ASSET_PATH_URL = 'https://{url}/projects/{projectId}/mappedassets/{assetId}';
|
44
44
|
export const API_PROJECT_ROBOT_URL = 'https://{url}/projects/{projectId}/robots';
|
45
|
+
export const API_ACCOUNT_ROBOT_URL = 'https://{url}/accounts/{accountId}/robots';
|
45
46
|
export const API_PROJECT_ROBOT_ID_URL = 'https://{url}/projects/{projectId}/robots/{callsign}';
|
46
47
|
export const API_PROJECT_ROBOT_ATTRIBUTES_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/attributes';
|
47
48
|
export const API_PROJECT_ROBOT_DEFINITION_URL = 'https://{url}/projects/{projectId}/robots/{callsign}/robot-definitions';
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|
@@ -0,0 +1,52 @@
|
|
1
|
+
export interface EventDefinitionList {
|
2
|
+
type?: 'event-definitions';
|
3
|
+
items: EventDefinition[];
|
4
|
+
version?: string;
|
5
|
+
robotDefinitionId?: string;
|
6
|
+
username?: string;
|
7
|
+
createdAt?: string;
|
8
|
+
updatedAt?: string;
|
9
|
+
}
|
10
|
+
export interface EventDefinition {
|
11
|
+
id: string;
|
12
|
+
actions?: (EventNotificationAction | EventSendCommandAction | EventHttpAction)[];
|
13
|
+
description?: string;
|
14
|
+
enabled?: boolean;
|
15
|
+
minDispatchInterval?: string;
|
16
|
+
name?: string;
|
17
|
+
trigger?: EventTrigger;
|
18
|
+
}
|
19
|
+
export interface EventNotificationAction {
|
20
|
+
level: string;
|
21
|
+
target: {
|
22
|
+
sendInAppNotification: boolean;
|
23
|
+
};
|
24
|
+
title: string;
|
25
|
+
content?: string;
|
26
|
+
}
|
27
|
+
export interface EventSendCommandAction {
|
28
|
+
executeLocally?: boolean;
|
29
|
+
id: string;
|
30
|
+
timeoutMs: string;
|
31
|
+
}
|
32
|
+
export interface EventHttpAction {
|
33
|
+
address: string;
|
34
|
+
method: string;
|
35
|
+
body: string;
|
36
|
+
timeoutMs: string;
|
37
|
+
headers?: {
|
38
|
+
[key: string]: string;
|
39
|
+
};
|
40
|
+
}
|
41
|
+
export interface EventTrigger {
|
42
|
+
expressions?: {
|
43
|
+
operator: string;
|
44
|
+
threshold: number;
|
45
|
+
value: string;
|
46
|
+
}[];
|
47
|
+
mode?: string;
|
48
|
+
sampleInterval?: string;
|
49
|
+
source?: string;
|
50
|
+
useAdvance?: boolean;
|
51
|
+
advancedCondition?: string;
|
52
|
+
}
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|
package/esm/models/IRobot.d.ts
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
import { ConnectionStatus } from './ConnectionStatus';
|
1
2
|
import { RobotModeType } from './types';
|
2
3
|
export interface IRobot {
|
3
4
|
tags?: string[];
|
@@ -16,3 +17,7 @@ export interface IRobot {
|
|
16
17
|
robotDefinitionName?: string;
|
17
18
|
robotDefinitionTags?: string[];
|
18
19
|
}
|
20
|
+
export type IRobotListItem = IRobot & {
|
21
|
+
linkedProjectId?: string;
|
22
|
+
connection?: ConnectionStatus;
|
23
|
+
};
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|
@@ -1,3 +1,4 @@
|
|
1
|
+
import { EventDefinition, EventDefinitionList } from '../models/EventDefinition';
|
1
2
|
import { RocosError } from '../models/RocosError';
|
2
3
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
4
|
import { IBaseService } from '../models/IBaseService';
|
@@ -40,7 +41,7 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
|
|
40
41
|
* @param definitionId - Robot definition Id
|
41
42
|
* @description - Renamed from robotDefGetEventDefinitions
|
42
43
|
*/
|
43
|
-
getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<
|
44
|
+
getDefinitionsForRobotDef(projectId: string, definitionId: string): Promise<EventDefinitionList>;
|
44
45
|
/**
|
45
46
|
* Update events for a robot definition
|
46
47
|
*
|
@@ -49,5 +50,5 @@ export declare class EventService extends BaseServiceAbstract implements IBaseSe
|
|
49
50
|
* @param model - Payload
|
50
51
|
* @description - Renamed from robotDefAddEventDefinitions
|
51
52
|
*/
|
52
|
-
addDefinitionsForRobotDef(projectId: string, definitionId: string, model:
|
53
|
+
addDefinitionsForRobotDef(projectId: string, definitionId: string, model: EventDefinition[]): Promise<void>;
|
53
54
|
}
|
@@ -64,7 +64,6 @@ export class EventService extends BaseServiceAbstract {
|
|
64
64
|
* @param definitionId - Robot definition Id
|
65
65
|
* @description - Renamed from robotDefGetEventDefinitions
|
66
66
|
*/
|
67
|
-
// TODO: map the response object
|
68
67
|
async getDefinitionsForRobotDef(projectId, definitionId) {
|
69
68
|
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}.`);
|
70
69
|
}
|
@@ -76,9 +75,6 @@ export class EventService extends BaseServiceAbstract {
|
|
76
75
|
* @param model - Payload
|
77
76
|
* @description - Renamed from robotDefAddEventDefinitions
|
78
77
|
*/
|
79
|
-
// TODO: map the request model
|
80
|
-
// TODO: map the response object
|
81
|
-
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
|
82
78
|
async addDefinitionsForRobotDef(projectId, definitionId, model) {
|
83
79
|
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}.`);
|
84
80
|
}
|
@@ -1,7 +1,9 @@
|
|
1
1
|
import { RocosError } from '../models/RocosError';
|
2
2
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
|
+
import { Dashboard } from '../models/Dashboard';
|
3
4
|
import { IBaseService } from '../models/IBaseService';
|
4
5
|
import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
|
6
|
+
import { RobotProfile } from '../models/RobotProfile';
|
5
7
|
export declare class ProfileService extends BaseServiceAbstract implements IBaseService {
|
6
8
|
constructor(config: IRocosSDKConfig);
|
7
9
|
protected getError(e: Error): RocosError;
|
@@ -20,7 +22,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
|
|
20
22
|
* @param projectId - Project Id
|
21
23
|
* @description - Renamed from robotDefsList
|
22
24
|
*/
|
23
|
-
list(projectId: string): Promise<
|
25
|
+
list(projectId: string): Promise<RobotProfile[]>;
|
24
26
|
/**
|
25
27
|
* Delete robot definitions
|
26
28
|
*
|
@@ -95,7 +97,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
|
|
95
97
|
* @param profileId - Profile Id
|
96
98
|
* @description - Renamed from robotDefDashboards
|
97
99
|
*/
|
98
|
-
dashboards(projectId: string, profileId: string): Promise<
|
100
|
+
dashboards(projectId: string, profileId: string): Promise<Dashboard[]>;
|
99
101
|
/**
|
100
102
|
* Get Dashboard data which stored in Azure Blob.
|
101
103
|
*
|
@@ -33,7 +33,6 @@ export class ProfileService extends BaseServiceAbstract {
|
|
33
33
|
* @param projectId - Project Id
|
34
34
|
* @description - Renamed from robotDefsList
|
35
35
|
*/
|
36
|
-
// TODO: map the response object
|
37
36
|
async list(projectId) {
|
38
37
|
return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get robot definitions.');
|
39
38
|
}
|
@@ -143,7 +142,6 @@ export class ProfileService extends BaseServiceAbstract {
|
|
143
142
|
* @param profileId - Profile Id
|
144
143
|
* @description - Renamed from robotDefDashboards
|
145
144
|
*/
|
146
|
-
// TODO: map the response object
|
147
145
|
async dashboards(projectId, profileId) {
|
148
146
|
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.');
|
149
147
|
}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { IBaseService, IConnectedCallsign, IRobot, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
|
1
|
+
import { IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
|
2
2
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
3
3
|
export declare class RobotService extends BaseServiceAbstract implements IBaseService {
|
4
4
|
constructor(config: IRocosSDKConfig);
|
@@ -10,6 +10,12 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
|
|
10
10
|
* @param projectId - Project Id
|
11
11
|
*/
|
12
12
|
getRobots(projectId: string): Promise<IRobot[]>;
|
13
|
+
/**
|
14
|
+
* Get a list of robots by account id.
|
15
|
+
*
|
16
|
+
* @param accountId - Account Id
|
17
|
+
*/
|
18
|
+
getRobotsByAccountId(accountId: string): Promise<IRobotListItem[]>;
|
13
19
|
/**
|
14
20
|
* Create a new robot.
|
15
21
|
*
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_PROFILE_DASHBOARD_ID_URL, API_PROJECT_PROFILE_DASHBOARD_URL, API_PROJECT_ROBOT_AGENT_URL, API_PROJECT_ROBOT_ATTRIBUTES_URL, API_PROJECT_ROBOT_BUTTON_URL, API_PROJECT_ROBOT_COMMAND2_URL, API_PROJECT_ROBOT_COMMAND_URL, API_PROJECT_ROBOT_CONFIGS_CONNECTIONS_URL, API_PROJECT_ROBOT_CONFIGS_CONNECTION_URL, API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_ROBOT_DASHBOARD_ID_URL, API_PROJECT_ROBOT_DASHBOARD_URL, API_PROJECT_ROBOT_GAMEPAD_URL, API_PROJECT_ROBOT_ID_URL, API_PROJECT_ROBOT_REGISTER_URL, API_PROJECT_ROBOT_SETTING_URL, API_PROJECT_ROBOT_TRIGGER_URL, API_PROJECT_ROBOT_URL, API_PROJECT_VROBOT_DEPLOY_URL, API_PROJECT_VROBOT_DETAILS_URL, API_SOURCE_SCHEMA_URL, API_TEMPLATE_DEPLOY_URL, } from '../constants/api';
|
1
|
+
import { API_ACCOUNT_ROBOT_URL, API_PROJECT_PROFILE_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_PROFILE_DASHBOARD_ID_URL, API_PROJECT_PROFILE_DASHBOARD_URL, API_PROJECT_ROBOT_AGENT_URL, API_PROJECT_ROBOT_ATTRIBUTES_URL, API_PROJECT_ROBOT_BUTTON_URL, API_PROJECT_ROBOT_COMMAND2_URL, API_PROJECT_ROBOT_COMMAND_URL, API_PROJECT_ROBOT_CONFIGS_CONNECTIONS_URL, API_PROJECT_ROBOT_CONFIGS_CONNECTION_URL, API_PROJECT_ROBOT_DASHBOARD_CUSTOM_WIDGET_URL, API_PROJECT_ROBOT_DASHBOARD_ID_URL, API_PROJECT_ROBOT_DASHBOARD_URL, API_PROJECT_ROBOT_GAMEPAD_URL, API_PROJECT_ROBOT_ID_URL, API_PROJECT_ROBOT_REGISTER_URL, API_PROJECT_ROBOT_SETTING_URL, API_PROJECT_ROBOT_TRIGGER_URL, API_PROJECT_ROBOT_URL, API_PROJECT_VROBOT_DEPLOY_URL, API_PROJECT_VROBOT_DETAILS_URL, API_SOURCE_SCHEMA_URL, API_TEMPLATE_DEPLOY_URL, } from '../constants/api';
|
2
2
|
import { Robot, RobotTemplate, RocosError, errorCodes, } from '../models';
|
3
3
|
import { BaseServiceAbstract } from './BaseServiceAbstract';
|
4
4
|
import { RocosLogger } from '../logger/RocosLogger';
|
@@ -24,6 +24,15 @@ export class RobotService extends BaseServiceAbstract {
|
|
24
24
|
const data = await this.callGet(formatServiceUrl(API_PROJECT_ROBOT_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get robots list for ${projectId}.`);
|
25
25
|
return data.map((item) => cleanObject(new Robot(item)));
|
26
26
|
}
|
27
|
+
/**
|
28
|
+
* Get a list of robots by account id.
|
29
|
+
*
|
30
|
+
* @param accountId - Account Id
|
31
|
+
*/
|
32
|
+
async getRobotsByAccountId(accountId) {
|
33
|
+
const data = await this.callGet(formatServiceUrl(API_ACCOUNT_ROBOT_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to get robots list for organization: ${accountId}.`);
|
34
|
+
return data;
|
35
|
+
}
|
27
36
|
/**
|
28
37
|
* Create a new robot.
|
29
38
|
*
|