@dronedeploy/rocos-js-sdk 3.0.1-alpha.24 → 3.0.1-alpha.26

package/cjs/constants/api.d.ts

@@ -117,6 +117,7 @@ export declare const API_DD_INTEGRATION_PLANS_URL = "https://{url}/projects/{pro
 export declare const API_DD_INTEGRATION_PLAN_BY_ID_URL = "https://{url}/projects/{projectId}/dd/plan/{planId}";
 export declare const API_DD_INTEGRATION_OVERLAYS_URL = "https://{url}/projects/{projectId}/dd/overlays";
 export declare const API_DD_INTEGRATION_ISSUES_URL = "https://{url}/projects/{projectId}/dd/issues";
+export declare const API_DD_INTEGRATION_LOCATIONS_URL = "https://{url}/projects/{projectId}/dd/locations";
 export declare const API_MAPS_URL = "https://{url}/projects/{projectId}/maps";
 export declare const API_MAPS_DEPLOYED_URL = "https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}";
 export declare const API_MAPS_MERGE_URL = "https://{url}/projects/{projectId}/maps/merge";

package/cjs/constants/api.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API_PROJECT_ROBOT_DEFINITION_URL = exports.API_PROJECT_ROBOT_ATTRIBUTES_URL = exports.API_PROJECT_ROBOT_ID_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_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_INTEGRATION_TYPE_URL = exports.API_ACCOUNT_INTEGRATION_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_USER_PASSWORD_RESET_URL = exports.API_OTP_AUTH_URL = exports.API_OTP_URL = exports.API_USER_TOKEN_URL = exports.API_USER_AUTH_URL = exports.API_USER_URL = exports.API_ADMIN_USER_INVITATION_URL = exports.API_APPLICATION_AUTH_URL = void 0;
 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_EXPORT_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_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_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 = exports.API_PROJECT_ROBOT_EVENT_URL = exports.API_PROJECT_ROBOT_REGISTER_URL = void 0;
-exports.API_TARGETS_URL = exports.API_DEVICE_CREDENTIALS_AUTH_URL = exports.API_DEVICE_CREDENTIALS_URL = exports.API_LINKED_PROJECT_URL = exports.API_PROJECT_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_WORKFLOW_ASSET_URL = exports.API_PROJECT_WORKFLOW_ID_URL = exports.API_PROJECT_WORKFLOW_URL = exports.API_OBSERVATION_KEYS_URL = exports.API_OBSERVATIONS_URL = exports.API_MAPS_PANORAMA_OBSERVATIONS_URL = exports.API_MAPS_GEOJSON_URL = exports.API_MAPS_DEPLOY_URL = exports.API_MAPS_COPY_URL = exports.API_MAP_ID_URL = exports.API_MAPS_MERGE_URL = exports.API_MAPS_DEPLOYED_URL = exports.API_MAPS_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;
+exports.API_TARGETS_URL = exports.API_DEVICE_CREDENTIALS_AUTH_URL = exports.API_DEVICE_CREDENTIALS_URL = exports.API_LINKED_PROJECT_URL = exports.API_PROJECT_DEPLOYED_WORKFLOW_URL = exports.API_PROJECT_WORKFLOW_ASSET_URL = exports.API_PROJECT_WORKFLOW_ID_URL = exports.API_PROJECT_WORKFLOW_URL = exports.API_OBSERVATION_KEYS_URL = exports.API_OBSERVATIONS_URL = exports.API_MAPS_PANORAMA_OBSERVATIONS_URL = exports.API_MAPS_GEOJSON_URL = exports.API_MAPS_DEPLOY_URL = exports.API_MAPS_COPY_URL = exports.API_MAP_ID_URL = exports.API_MAPS_MERGE_URL = exports.API_MAPS_DEPLOYED_URL = exports.API_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;
 exports.API_APPLICATION_AUTH_URL = 'https://{url}/applications/auth';
 exports.API_ADMIN_USER_INVITATION_URL = 'https://{url}/admin/users/invitations';
 exports.API_USER_URL = 'https://{url}/users';
@@ -122,6 +122,7 @@ exports.API_DD_INTEGRATION_PLANS_URL = 'https://{url}/projects/{projectId}/dd/pl
 exports.API_DD_INTEGRATION_PLAN_BY_ID_URL = 'https://{url}/projects/{projectId}/dd/plan/{planId}';
 exports.API_DD_INTEGRATION_OVERLAYS_URL = 'https://{url}/projects/{projectId}/dd/overlays';
 exports.API_DD_INTEGRATION_ISSUES_URL = 'https://{url}/projects/{projectId}/dd/issues';
+exports.API_DD_INTEGRATION_LOCATIONS_URL = 'https://{url}/projects/{projectId}/dd/locations';
 exports.API_MAPS_URL = 'https://{url}/projects/{projectId}/maps';
 exports.API_MAPS_DEPLOYED_URL = 'https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}';
 exports.API_MAPS_MERGE_URL = 'https://{url}/projects/{projectId}/maps/merge';

package/cjs/helpers/cleanObject.js

@@ -5,7 +5,10 @@ const cleanObject = (object) => {
     return {
         ...(function _flatten(o) {
             return [...Object.entries(o)].reduce((obj, [key, val]) => {
-                if (typeof val === 'object') {
+                if (val === null) {
+                    obj[key] = val;
+                }
+                else if (typeof val === 'object') {
                     obj[key] = _flatten(val);
                 }
                 else if (typeof val === 'function') {

package/cjs/models/index.d.ts

@@ -30,6 +30,8 @@ export * from './stream/ITelemetryStream';
 export * from './stream/IWebRTCSignallingStream';
 export * from './integrations/Overlay';
 export * from './integrations/Plan';
+export * from './integrations/Location';
+export * from './integrations/PaginatedResults';
 export * from './maps/Map';
 export * from './maps/Panorama';
 export * from './projects/ProjectUser';

package/cjs/models/index.js

@@ -46,6 +46,8 @@ __exportStar(require("./stream/ITelemetryStream"), exports);
 __exportStar(require("./stream/IWebRTCSignallingStream"), exports);
 __exportStar(require("./integrations/Overlay"), exports);
 __exportStar(require("./integrations/Plan"), exports);
+__exportStar(require("./integrations/Location"), exports);
+__exportStar(require("./integrations/PaginatedResults"), exports);
 __exportStar(require("./maps/Map"), exports);
 __exportStar(require("./maps/Panorama"), exports);
 __exportStar(require("./projects/ProjectUser"), exports);

package/cjs/models/integrations/Location.d.ts

@@ -0,0 +1,24 @@
+export interface Location {
+    id: string;
+    name: string;
+    level?: {
+        id: string;
+    };
+    locationType?: {
+        id: string;
+        name: string;
+    };
+    shape: {
+        coordinates: Array<{
+            lat: number;
+            lng: number;
+        }>;
+        radiusMeters?: number;
+        shapeType: string;
+    };
+    shapeStyle: {
+        fillColor: string;
+        strokeColor: string;
+        fillOpacity: number;
+    };
+}

package/cjs/models/integrations/Location.js

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

package/cjs/models/integrations/PaginatedResults.d.ts

@@ -0,0 +1,4 @@
+export interface PaginatedResults<T> {
+    results: T[];
+    next?: string;
+}

package/cjs/models/integrations/PaginatedResults.js

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

package/cjs/services/IntegrationService.d.ts

@@ -1,4 +1,4 @@
-import { IBaseService, IRocosSDKConfig, Overlay, Plan, RocosError } from '../models';
+import { IBaseService, IRocosSDKConfig, Location, Overlay, PaginatedResults, Plan, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 /**
  * Integrations to retrieve data from the linked project in DroneDeploy
@@ -45,4 +45,10 @@ export declare class IntegrationService extends BaseServiceAbstract implements I
         lat: number;
         lng: number;
     }): Promise<void>;
+    /**
+     * Gets locations for the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    getLocations(projectId: string, pageStart?: string): Promise<PaginatedResults<Location>>;
 }

package/cjs/services/IntegrationService.js

@@ -72,5 +72,13 @@ class IntegrationService extends BaseServiceAbstract_1.BaseServiceAbstract {
             lng: location.lng,
         }, 'Failed to create issue.');
     }
+    /**
+     * Gets locations for the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    async getLocations(projectId, pageStart) {
+        return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_DD_INTEGRATION_LOCATIONS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get locations.', pageStart ? { page_start: pageStart } : undefined);
+    }
 }
 exports.IntegrationService = IntegrationService;

package/esm/constants/api.d.ts

@@ -117,6 +117,7 @@ export declare const API_DD_INTEGRATION_PLANS_URL = "https://{url}/projects/{pro
 export declare const API_DD_INTEGRATION_PLAN_BY_ID_URL = "https://{url}/projects/{projectId}/dd/plan/{planId}";
 export declare const API_DD_INTEGRATION_OVERLAYS_URL = "https://{url}/projects/{projectId}/dd/overlays";
 export declare const API_DD_INTEGRATION_ISSUES_URL = "https://{url}/projects/{projectId}/dd/issues";
+export declare const API_DD_INTEGRATION_LOCATIONS_URL = "https://{url}/projects/{projectId}/dd/locations";
 export declare const API_MAPS_URL = "https://{url}/projects/{projectId}/maps";
 export declare const API_MAPS_DEPLOYED_URL = "https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}";
 export declare const API_MAPS_MERGE_URL = "https://{url}/projects/{projectId}/maps/merge";

package/esm/constants/api.js

@@ -117,6 +117,7 @@ export const API_DD_INTEGRATION_PLANS_URL = 'https://{url}/projects/{projectId}/
 export const API_DD_INTEGRATION_PLAN_BY_ID_URL = 'https://{url}/projects/{projectId}/dd/plan/{planId}';
 export const API_DD_INTEGRATION_OVERLAYS_URL = 'https://{url}/projects/{projectId}/dd/overlays';
 export const API_DD_INTEGRATION_ISSUES_URL = 'https://{url}/projects/{projectId}/dd/issues';
+export const API_DD_INTEGRATION_LOCATIONS_URL = 'https://{url}/projects/{projectId}/dd/locations';
 export const API_MAPS_URL = 'https://{url}/projects/{projectId}/maps';
 export const API_MAPS_DEPLOYED_URL = 'https://{url}/projects/{projectId}/maps/deployed?callsign={callsign}';
 export const API_MAPS_MERGE_URL = 'https://{url}/projects/{projectId}/maps/merge';

package/esm/helpers/cleanObject.js

@@ -2,7 +2,10 @@ export const cleanObject = (object) => {
     return {
         ...(function _flatten(o) {
             return [...Object.entries(o)].reduce((obj, [key, val]) => {
-                if (typeof val === 'object') {
+                if (val === null) {
+                    obj[key] = val;
+                }
+                else if (typeof val === 'object') {
                     obj[key] = _flatten(val);
                 }
                 else if (typeof val === 'function') {

package/esm/models/index.d.ts

@@ -30,6 +30,8 @@ export * from './stream/ITelemetryStream';
 export * from './stream/IWebRTCSignallingStream';
 export * from './integrations/Overlay';
 export * from './integrations/Plan';
+export * from './integrations/Location';
+export * from './integrations/PaginatedResults';
 export * from './maps/Map';
 export * from './maps/Panorama';
 export * from './projects/ProjectUser';

package/esm/models/index.js

@@ -30,6 +30,8 @@ export * from './stream/ITelemetryStream';
 export * from './stream/IWebRTCSignallingStream';
 export * from './integrations/Overlay';
 export * from './integrations/Plan';
+export * from './integrations/Location';
+export * from './integrations/PaginatedResults';
 export * from './maps/Map';
 export * from './maps/Panorama';
 export * from './projects/ProjectUser';

package/esm/models/integrations/Location.d.ts

@@ -0,0 +1,24 @@
+export interface Location {
+    id: string;
+    name: string;
+    level?: {
+        id: string;
+    };
+    locationType?: {
+        id: string;
+        name: string;
+    };
+    shape: {
+        coordinates: Array<{
+            lat: number;
+            lng: number;
+        }>;
+        radiusMeters?: number;
+        shapeType: string;
+    };
+    shapeStyle: {
+        fillColor: string;
+        strokeColor: string;
+        fillOpacity: number;
+    };
+}

package/esm/models/integrations/Location.js

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

package/esm/models/integrations/PaginatedResults.d.ts

@@ -0,0 +1,4 @@
+export interface PaginatedResults<T> {
+    results: T[];
+    next?: string;
+}

package/esm/models/integrations/PaginatedResults.js

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

package/esm/services/IntegrationService.d.ts

@@ -1,4 +1,4 @@
-import { IBaseService, IRocosSDKConfig, Overlay, Plan, RocosError } from '../models';
+import { IBaseService, IRocosSDKConfig, Location, Overlay, PaginatedResults, Plan, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 /**
  * Integrations to retrieve data from the linked project in DroneDeploy
@@ -45,4 +45,10 @@ export declare class IntegrationService extends BaseServiceAbstract implements I
         lat: number;
         lng: number;
     }): Promise<void>;
+    /**
+     * Gets locations for the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    getLocations(projectId: string, pageStart?: string): Promise<PaginatedResults<Location>>;
 }

package/esm/services/IntegrationService.js

@@ -1,5 +1,5 @@
-import { API_DD_INTEGRATION_ISSUES_URL, API_DD_INTEGRATION_OVERLAYS_URL, API_DD_INTEGRATION_PLANS_URL, API_DD_INTEGRATION_PLAN_BY_ID_URL, } from '../constants/api';
-import { RocosError, errorCodes } from '../models';
+import { API_DD_INTEGRATION_ISSUES_URL, API_DD_INTEGRATION_LOCATIONS_URL, API_DD_INTEGRATION_OVERLAYS_URL, API_DD_INTEGRATION_PLANS_URL, API_DD_INTEGRATION_PLAN_BY_ID_URL, } from '../constants/api';
+import { RocosError, errorCodes, } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
 import { formatServiceUrl } from '../helpers/formatServiceUrl';
@@ -69,4 +69,12 @@ export class IntegrationService extends BaseServiceAbstract {
             lng: location.lng,
         }, 'Failed to create issue.');
     }
+    /**
+     * Gets locations for the provided project ID
+     * @param projectId Project ID
+     * @returns Plans list (limited to 50)
+     */
+    async getLocations(projectId, pageStart) {
+        return this.callGet(formatServiceUrl(API_DD_INTEGRATION_LOCATIONS_URL, { url: this.config.url, projectId }, this.config.insecure), 'Failed to get locations.', pageStart ? { page_start: pageStart } : undefined);
+    }
 }

package/package.json

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