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

package/esm/models/TelemetryStatus.js

@@ -0,0 +1,14 @@
+export var TelemetryMonitorStatus;
+(function (TelemetryMonitorStatus) {
+    TelemetryMonitorStatus["UNKNOWN"] = "unknown";
+    TelemetryMonitorStatus["CONNECTED"] = "connected";
+    TelemetryMonitorStatus["DISCONNECTED"] = "disconnected";
+    TelemetryMonitorStatus["ERROR"] = "error";
+})(TelemetryMonitorStatus || (TelemetryMonitorStatus = {}));
+export var CallsignStatus;
+(function (CallsignStatus) {
+    CallsignStatus["UNKNOWN"] = "unknown";
+    CallsignStatus["ONLINE"] = "online";
+    CallsignStatus["OFFLINE"] = "offline";
+    CallsignStatus["ERROR"] = "error";
+})(CallsignStatus || (CallsignStatus = {}));

package/esm/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/esm/models/Token.js

@@ -51,7 +51,7 @@ export 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');
@@ -64,15 +64,15 @@ export 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 (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, '/'));
     }
 }

package/esm/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/esm/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/esm/models/graph/Position.d.ts

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

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

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

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

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

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

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

package/esm/models/graph/index.js

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

package/esm/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/esm/models/index.js

@@ -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/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/PaginatedResults.d.ts

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

package/esm/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/esm/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/esm/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/esm/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/esm/models/target/Target.js

@@ -0,0 +1,9 @@
+export const isTargetWgs84 = (position) => {
+    return Boolean(position) && 'lat' in position && 'lon' in position;
+};
+export const isTarget = (target) => {
+    return target.type === 'TARGET';
+};
+export const isAsset = (target) => {
+    return target.type === 'ASSET';
+};

package/esm/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/esm/node/RocosSDKNode.js

@@ -1,4 +1,4 @@
-import { AssetStorageService, AuthService, ConfigGroupService, DashboardService, EventService, FunctionService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, ScheduleService, SpotProvisioningServiceNode, StreamService, UserService, } from '../services';
+import { AssetStorageService, AuthService, ConfigGroupService, DashboardService, DeviceCredentialsService, EnvironmentService, EventService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, ScheduleService, SpotProvisioningServiceNode, StreamService, TargetService, UserService, } from '../services';
 import { ServiceEnum } from '../models';
 import { CallerServiceNode } from '../services/CallerServiceNode';
 import { CommandServiceNode } from '../services/CommandServiceNode';
@@ -24,6 +24,9 @@ export class RocosSDKNode extends RocosSDK {
                 case ServiceEnum.ROBOT:
                     this.services[name] = new RobotService(config);
                     break;
+                case ServiceEnum.ENVIRONMENT:
+                    this.services[name] = new EnvironmentService(config);
+                    break;
                 case ServiceEnum.EVENT:
                     this.services[name] = new EventService(config);
                     break;
@@ -48,9 +51,6 @@ export class RocosSDKNode extends RocosSDK {
                 case ServiceEnum.DASHBOARD:
                     this.services[name] = new DashboardService(config);
                     break;
-                case ServiceEnum.FUNCTION:
-                    this.services[name] = new FunctionService(config);
-                    break;
                 case ServiceEnum.STREAM:
                     this.services[name] = new StreamService(config);
                     break;
@@ -81,6 +81,12 @@ export class RocosSDKNode extends RocosSDK {
                 case ServiceEnum.MAP:
                     this.services[name] = new MapService(config);
                     break;
+                case ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new DeviceCredentialsService(config);
+                    break;
+                case ServiceEnum.TARGET:
+                    this.services[name] = new TargetService(config);
+                    break;
             }
         }
         this.logger.debug(`Found service ${name}.`);
@@ -92,12 +98,6 @@ export class RocosSDKNode extends RocosSDK {
     getTelemetryService() {
         return this.getService(ServiceEnum.TELEMETRY);
     }
-    /**
-     * Gets the scheduler service.
-     */
-    getSchedulerService() {
-        return this.getService(ServiceEnum.SCHEDULE);
-    }
     /**
      * Gets the service call service.
      */

package/esm/services/AssetStorageService.d.ts

@@ -75,8 +75,16 @@ 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): Promise<AssetItemWithObservationsModel[]>;
+    listMappedAssets(projectId: string, start?: Date, end?: Date, includeObservations?: boolean): Promise<AssetItemWithObservationsModel[]>;
+    /**
+     * Get mapped asset
+     *
+     * @param projectId
+     * @param assetId
+     */
+    getMappedAsset(projectId: string, assetId: string): Promise<AssetItemWithObservationsModel>;
     /**
      * Set Robot Sync Definitions
      * @param projectId

package/esm/services/AssetStorageService.js

@@ -1,4 +1,4 @@
-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 { 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_MAPPED_ASSET_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';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
@@ -124,13 +124,24 @@ export class AssetStorageService extends BaseServiceAbstract {
      * @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)
      */
-    async listMappedAssets(projectId, start, end) {
+    async listMappedAssets(projectId, start, end, includeObservations) {
         return this.callGet(formatServiceUrl(API_PROJECT_MAPPED_ASSETS_PATH_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to list mapped assets for ${projectId}.`, {
             start: start?.toISOString() ?? '',
             end: end?.toISOString() ?? '',
+            includeObservations: includeObservations ? 'true' : 'false',
         });
     }
+    /**
+     * Get mapped asset
+     *
+     * @param projectId
+     * @param assetId
+     */
+    async getMappedAsset(projectId, assetId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_MAPPED_ASSET_PATH_URL, { url: this.config.url, projectId, assetId }, this.config.insecure), `Failed to get mapped asset for ${projectId} and id: ${assetId}.`);
+    }
     /**
      * Set Robot Sync Definitions
      * @param projectId

package/esm/services/AuthService.d.ts

@@ -1,10 +1,20 @@
+import { Observable } from 'rxjs';
 import { IBaseService, IRocosSDKConfig, RocosError, Token } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class AuthService extends BaseServiceAbstract implements IBaseService {
     protected config: IRocosSDKConfig;
     private token?;
     private tokenRefreshTimeoutId?;
+    private tokenSubject$;
     constructor(config: IRocosSDKConfig);
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * It will emit the current token when you subscribe and then emit new tokens when they are set.
+     */
+    get token$(): Observable<Token>;
     getStatus(): boolean;
     teardown(): void;
     protected getError(e: RocosError): RocosError;
@@ -62,9 +72,10 @@ export declare class AuthService extends BaseServiceAbstract implements IBaseSer
      * If you want to refresh the token regardless of the expiry time, use `refreshToken`.
      *
      * @param minutes the number of minutes before the token expires to refresh the token
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
-    refreshTokenIfExpired(minutes: number): Promise<void>;
+    refreshTokenIfExpired(minutes: number): Promise<boolean>;
     /** Start a 5-minute loop to check if the token needs to be refreshed
      *
      * This is useful when you are using GRPC services (i.e. telemetry) which does not automatically refresh the token.

package/esm/services/AuthService.js

@@ -1,19 +1,35 @@
 import { API_APPLICATION_AUTH_URL, API_OTP_AUTH_URL, API_OTP_URL, API_USER_TOKEN_URL } from '../constants/api';
+import { BehaviorSubject } from 'rxjs';
 import { RocosError, Token, errorCodes } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
 import { RocosStore } from '../store/RocosStore';
+import { filter } from 'rxjs/operators';
 import { formatServiceUrl } from '../helpers/formatServiceUrl';
 import { issuer } from '../constants/auth';
 export class AuthService extends BaseServiceAbstract {
     constructor(config) {
         super(config);
         this.config = config;
+        this.tokenSubject$ = new BehaviorSubject(null);
         this.config = config;
         this.logger = RocosLogger.getInstance(`AuthService(${this.config.url})`);
         if (this.config.token) {
             this.setToken(this.config.token);
         }
+        this.token$.subscribe((token) => {
+            RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: token.value });
+        });
+    }
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * It will emit the current token when you subscribe and then emit new tokens when they are set.
+     */
+    get token$() {
+        return this.tokenSubject$.asObservable().pipe(filter(Boolean));
     }
     getStatus() {
         return true;
@@ -39,7 +55,12 @@ export class AuthService extends BaseServiceAbstract {
         }
         this.config.token = this.token.value;
         // output a message for token change
-        RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: this.token.value });
+        if (this.isTokenValid(this.token)) {
+            this.tokenSubject$.next(this.token);
+        }
+        else {
+            void this.getToken();
+        }
     }
     /**
      * Clear token
@@ -163,6 +184,7 @@ export class AuthService extends BaseServiceAbstract {
      * If you want to refresh the token regardless of the expiry time, use `refreshToken`.
      *
      * @param minutes the number of minutes before the token expires to refresh the token
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
     async refreshTokenIfExpired(minutes) {
@@ -170,7 +192,9 @@ export class AuthService extends BaseServiceAbstract {
             this.logger.info('Token expires in 15 minutes. Refreshing.');
             const newToken = await this.refreshToken();
             this.setToken(newToken);
+            return true;
         }
+        return false;
     }
     /** Start a 5-minute loop to check if the token needs to be refreshed
      *

package/esm/services/BaseServiceAbstract.js

@@ -1,4 +1,4 @@
-import { RocosError, HttpError } from '../models';
+import { HttpError, RocosError } from '../models';
 import { getURLSearchParams } from '../helpers';
 import { RocosStore } from '../store/RocosStore';
 export class BaseServiceAbstract {

package/esm/services/DeviceCredentialsService.d.ts

@@ -0,0 +1,15 @@
+import { DeviceCredentialAuth, DeviceCredentialAuthResult, DeviceCredentialCreate, DeviceCredentials } from '../models/device-credentials/DeviceCredentials';
+import { IBaseService, IRocosSDKConfig, RocosError } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+/**
+ * Manage external devices authenticating with the platform
+ */
+export declare class DeviceCredentialsService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    protected getError(e: Error): RocosError;
+    list(projectId: string, callsign: string): Promise<DeviceCredentials>;
+    create(projectId: string, callsign: string, credentials: DeviceCredentialCreate, disableValidation?: boolean): Promise<DeviceCredentialCreate>;
+    delete(projectId: string, callsign: string, component: string, system: string): Promise<void>;
+    auth(credentials: DeviceCredentialAuth): Promise<DeviceCredentialAuthResult>;
+}