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

package/cjs/models/Token.d.ts

@@ -31,10 +31,10 @@ export declare class Token implements IToken {
     isExpiredIn(threshold?: number, unit?: 'minutes' | 'seconds' | 'hours'): boolean;
     isExpired(): boolean;
     private getJWTPayload;
-    /** Decode a base64 string.
+    /** Decode a base64url string.
      *
      * Supports both Node.js and browser environments.
      * @private
      */
-    private decodeBase64;
+    private decodeBase64URL;
 }

package/cjs/models/Token.js

@@ -54,7 +54,7 @@ class Token {
             throw new Error('Invalid token, too many parts');
         }
         const [header, payload] = parts.slice(0, 2).map((part) => {
-            return JSON.parse(this.decodeBase64(part));
+            return JSON.parse(this.decodeBase64URL(part));
         });
         if (typeof payload !== 'object') {
             throw new Error('Invalid token, payload must be an object');
@@ -67,16 +67,16 @@ class Token {
         }
         return payload;
     }
-    /** Decode a base64 string.
+    /** Decode a base64url string.
      *
      * Supports both Node.js and browser environments.
      * @private
      */
-    decodeBase64(base64String) {
+    decodeBase64URL(base64String) {
         if (enviroment_1.isNode) {
-            return Buffer.from(base64String, 'base64').toString('utf-8');
+            return Buffer.from(base64String, 'base64url').toString('utf-8');
         }
-        return atob(base64String);
+        return atob(base64String.replace(/-/g, '+').replace(/_/g, '/'));
     }
 }
 exports.Token = Token;

package/cjs/models/asset-storage/{AssetModelItem.d.ts → AssetItem.d.ts}

@@ -1,3 +1,4 @@
+import { Observation } from '../maps/Panorama';
 export interface AssetItemModel {
     metadata?: {
         [key: string]: string;
@@ -11,4 +12,5 @@ export interface AssetItemModel {
 }
 export interface AssetItemWithObservationsModel extends AssetItemModel {
     observationCount?: number;
+    observations?: Observation[];
 }

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/models/device-credentials/DeviceCredentials.d.ts

@@ -0,0 +1,61 @@
+export interface DeviceCredentials {
+    [component: string]: {
+        [system: string]: DeviceCredential;
+    };
+}
+export interface DeviceCredential {
+    /**
+     * Device ID or username
+     */
+    id: string;
+    /**
+     * Device secret or password
+     */
+    key: string;
+}
+export interface DeviceCredentialCreate {
+    /**
+     * Will automatically be generated if not provided
+     */
+    id?: string;
+    /**
+     * Will automatically be generated if not provided
+     */
+    secret?: string;
+    /**
+     * The agent component the credentials are for e.g. dji, spot, etc.
+     */
+    component: string;
+    /**
+     * The system the credentials are for e.g. mqtt, rtmp, etc.
+     */
+    system: string;
+    /**
+     * Access control list for the credentials
+     */
+    acl?: DeviceCredentialACLItem[];
+}
+export interface DeviceCredentialACLItem {
+    /**
+     * The resource the ACL item is for e.g. /sys/product/{device_sn}/*
+     */
+    resource: string;
+    /**
+     * The action the ACL item is for e.g. allow, deny, ignore
+     */
+    action: DeviceCredentialAuthAction;
+}
+export type DeviceCredentialAuthAction = 'allow' | 'deny' | 'ignore';
+export interface DeviceCredentialAuth extends DeviceCredential {
+    /**
+     * The agent component the credentials are for e.g. dji, spot, etc.
+     */
+    component: string;
+    /**
+     * The system the credentials are for e.g. mqtt, rtmp, etc.
+     */
+    system: string;
+}
+export interface DeviceCredentialAuthResult {
+    result: 'allow' | 'deny';
+}

package/cjs/models/device-credentials/DeviceCredentials.js

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

package/cjs/models/graph/Position.d.ts

@@ -0,0 +1,6 @@
+export interface Position {
+    pitch: number;
+    yaw: number;
+    x?: number;
+    y?: number;
+}

package/cjs/models/graph/Position.js

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

package/cjs/models/graph/Quaternion.d.ts

@@ -0,0 +1,6 @@
+export interface Quaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}

package/cjs/models/graph/Quaternion.js

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

package/cjs/models/graph/Vector3.d.ts

@@ -0,0 +1,5 @@
+export interface Vector3 {
+    x: number;
+    y: number;
+    z: number;
+}

package/cjs/models/graph/Vector3.js

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

package/cjs/models/graph/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Position';
+export * from './Quaternion';
+export * from './Vector3';

package/cjs/models/graph/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Position"), exports);
+__exportStar(require("./Quaternion"), exports);
+__exportStar(require("./Vector3"), exports);

package/cjs/models/index.d.ts

@@ -1,4 +1,4 @@
-export * from './asset-storage/AssetModelItem';
+export * from './asset-storage/AssetItem';
 export * from './asset-storage/SyncIntegrations';
 export * from './schedule/IScheduleInfo';
 export * from './schedule/IScheduleAction';
@@ -30,13 +30,19 @@ 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';
-export * from './CallsignStatus';
+export * from './projects/ExternalProject';
+export * from './projects/NewProjectRequest';
+export * from './target/Target';
 export * from './ExportDataQuery';
 export * from './HttpError';
 export * from './IBaseService';
 export * from './IConfigGroup';
+export * from './IConnectedCallsign';
 export * from './IDebugLevel';
 export * from './IExportDataQuery';
 export * from './IFunctionConfig';
@@ -72,6 +78,7 @@ export * from './Stream';
 export * from './StreamOptions';
 export * from './StreamSource';
 export * from './SubscriberStatusEnum';
+export * from './TelemetryStatus';
 export * from './Token';
 export * from './types';
 export * from './Widget';

package/cjs/models/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./asset-storage/AssetModelItem"), exports);
+__exportStar(require("./asset-storage/AssetItem"), exports);
 __exportStar(require("./asset-storage/SyncIntegrations"), exports);
 __exportStar(require("./schedule/IScheduleInfo"), exports);
 __exportStar(require("./schedule/IScheduleAction"), exports);
@@ -46,13 +46,19 @@ __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);
-__exportStar(require("./CallsignStatus"), exports);
+__exportStar(require("./projects/ExternalProject"), exports);
+__exportStar(require("./projects/NewProjectRequest"), exports);
+__exportStar(require("./target/Target"), exports);
 __exportStar(require("./ExportDataQuery"), exports);
 __exportStar(require("./HttpError"), exports);
 __exportStar(require("./IBaseService"), exports);
 __exportStar(require("./IConfigGroup"), exports);
+__exportStar(require("./IConnectedCallsign"), exports);
 __exportStar(require("./IDebugLevel"), exports);
 __exportStar(require("./IExportDataQuery"), exports);
 __exportStar(require("./IFunctionConfig"), exports);
@@ -88,6 +94,7 @@ __exportStar(require("./Stream"), exports);
 __exportStar(require("./StreamOptions"), exports);
 __exportStar(require("./StreamSource"), exports);
 __exportStar(require("./SubscriberStatusEnum"), exports);
+__exportStar(require("./TelemetryStatus"), exports);
 __exportStar(require("./Token"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./Widget"), 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/models/maps/Panorama.d.ts

@@ -1,28 +1,18 @@
-export interface Position {
-    pitch: number;
-    yaw: number;
-    x?: number;
-    y?: number;
-}
-export interface Quaternion {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}
-export interface Vector3 {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface Observation {
+import { Position, Quaternion, Vector3 } from '../graph';
+interface ObservationBase {
+    name: string;
     panoramaID: string;
-    id?: string;
-    name?: string;
+    assetID?: string;
+    type?: 'asset' | 'target';
     data?: Record<string, string>;
-    geometry: Position[];
+    geometry?: Position[];
     center?: Position;
 }
+export interface Observation extends ObservationBase {
+    id: string;
+}
+export interface CreateObservation extends ObservationBase {
+}
 export interface Panorama {
     transform: {
         parent: string;
@@ -34,3 +24,4 @@ export interface Panorama {
         path: string;
     };
 }
+export {};

package/cjs/models/projects/ExternalProject.d.ts

@@ -0,0 +1,10 @@
+export interface ExternalProject {
+    id: string;
+    name: string;
+    isLinked: boolean;
+    createdAt?: number;
+    location?: {
+        lng: number;
+        lat: number;
+    };
+}

package/cjs/models/projects/ExternalProject.js

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

package/cjs/models/projects/NewProjectRequest.d.ts

@@ -0,0 +1,8 @@
+export interface NewProjectRequest {
+    accountId: string;
+    projectName: string;
+    description?: string;
+    linkedProjectId?: string;
+    lat?: number;
+    lng?: number;
+}

package/cjs/models/projects/NewProjectRequest.js

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

package/cjs/models/target/Target.d.ts

@@ -0,0 +1,30 @@
+import { Quaternion } from '../graph/Quaternion';
+import { Vector3 } from '../graph/Vector3';
+export interface TargetBase {
+    id: string;
+    name: string;
+    data?: Record<string, string>;
+    translation?: Vector3;
+    rotation?: Quaternion;
+    media?: TargetMedia[];
+    position?: TargetWgs84 | Vector3;
+    frame?: string;
+}
+export interface TargetMedia {
+    id: string;
+    data: Record<string, string>;
+}
+export interface TargetWgs84 {
+    lat: number;
+    lon: number;
+    alt?: number;
+}
+export declare const isTargetWgs84: (position: TargetWgs84 | Vector3) => position is TargetWgs84;
+export interface Target extends TargetBase {
+    type: 'TARGET';
+}
+export declare const isTarget: (target: Target | Asset) => target is Target;
+export interface Asset extends TargetBase {
+    type: 'ASSET';
+}
+export declare const isAsset: (target: Target | Asset) => target is Asset;

package/cjs/models/target/Target.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAsset = exports.isTarget = exports.isTargetWgs84 = void 0;
+const isTargetWgs84 = (position) => {
+    return Boolean(position) && 'lat' in position && 'lon' in position;
+};
+exports.isTargetWgs84 = isTargetWgs84;
+const isTarget = (target) => {
+    return target.type === 'TARGET';
+};
+exports.isTarget = isTarget;
+const isAsset = (target) => {
+    return target.type === 'ASSET';
+};
+exports.isAsset = isAsset;

package/cjs/node/RocosSDKNode.d.ts

@@ -1,4 +1,4 @@
-import { EvaluatorService, ScheduleService } from '../services';
+import { EvaluatorService } from '../services';
 import { IBaseService, ServiceEnum } from '../models';
 import { CallerServiceNode } from '../services/CallerServiceNode';
 import { CommandServiceNode } from '../services/CommandServiceNode';
@@ -13,10 +13,6 @@ export declare class RocosSDKNode extends RocosSDK {
      * Gets the telemetry service.
      */
     getTelemetryService(): TelemetryServiceNode;
-    /**
-     * Gets the scheduler service.
-     */
-    getSchedulerService(): ScheduleService;
     /**
      * Gets the service call service.
      */

package/cjs/node/RocosSDKNode.js

@@ -27,6 +27,9 @@ class RocosSDKNode extends RocosSDK_1.RocosSDK {
                 case models_1.ServiceEnum.ROBOT:
                     this.services[name] = new services_1.RobotService(config);
                     break;
+                case models_1.ServiceEnum.ENVIRONMENT:
+                    this.services[name] = new services_1.EnvironmentService(config);
+                    break;
                 case models_1.ServiceEnum.EVENT:
                     this.services[name] = new services_1.EventService(config);
                     break;
@@ -51,9 +54,6 @@ class RocosSDKNode extends RocosSDK_1.RocosSDK {
                 case models_1.ServiceEnum.DASHBOARD:
                     this.services[name] = new services_1.DashboardService(config);
                     break;
-                case models_1.ServiceEnum.FUNCTION:
-                    this.services[name] = new services_1.FunctionService(config);
-                    break;
                 case models_1.ServiceEnum.STREAM:
                     this.services[name] = new services_1.StreamService(config);
                     break;
@@ -84,6 +84,12 @@ class RocosSDKNode extends RocosSDK_1.RocosSDK {
                 case models_1.ServiceEnum.MAP:
                     this.services[name] = new services_1.MapService(config);
                     break;
+                case models_1.ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new services_1.DeviceCredentialsService(config);
+                    break;
+                case models_1.ServiceEnum.TARGET:
+                    this.services[name] = new services_1.TargetService(config);
+                    break;
             }
         }
         this.logger.debug(`Found service ${name}.`);
@@ -95,12 +101,6 @@ class RocosSDKNode extends RocosSDK_1.RocosSDK {
     getTelemetryService() {
         return this.getService(models_1.ServiceEnum.TELEMETRY);
     }
-    /**
-     * Gets the scheduler service.
-     */
-    getSchedulerService() {
-        return this.getService(models_1.ServiceEnum.SCHEDULE);
-    }
     /**
      * Gets the service call service.
      */

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
      *
@@ -84,15 +75,24 @@ export declare class AssetStorageService extends BaseServiceAbstract implements
      * @param projectId
      * @param start Start date for the query (optional)
      * @param end End date for the query (optional)
+     * @param includeObservations If observations should be included in the response (optional)
+     */
+    listMappedAssets(projectId: string, start?: Date, end?: Date, includeObservations?: boolean): Promise<AssetItemWithObservationsModel[]>;
+    /**
+     * Get mapped asset
+     *
+     * @param projectId
+     * @param assetId
      */
-    listMappedAssets(projectId: string, start?: Date, end?: Date): Promise<AssetItemWithObservationsModel[]>;
+    getMappedAsset(projectId: string, assetId: string): Promise<AssetItemWithObservationsModel>;
     /**
      * Set Robot Sync Definitions
      * @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 +105,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