@dronedeploy/rocos-js-sdk 3.0.1-alpha.3 → 3.0.1-alpha.6

package/esm/models/SubscriberStatusEnum.d.ts

@@ -0,0 +1,6 @@
+export declare enum SubscriberStatusEnum {
+    STOPPED = "stopped",
+    ALIVE = "alive",
+    DEAD = "dead",
+    ERROR = "error"
+}

package/esm/models/Token.d.ts

@@ -0,0 +1,40 @@
+import { IToken } from './IToken';
+/** Represents a JWT token.
+ *
+ * @see https://jwt.io/
+ * @see https://tools.ietf.org/html/rfc7519
+ * */
+export declare class Token implements IToken {
+    /**
+     * The raw token value.
+     *
+     * @see bearer
+     */
+    readonly value: string;
+    readonly audience?: string;
+    readonly expires?: Date;
+    readonly issuedAt?: Date;
+    readonly issuer?: string;
+    readonly subject?: string;
+    readonly refreshToken?: string;
+    constructor(token: string, refreshToken?: string);
+    /** Convenience method to get the token in Bearer format. */
+    get bearer(): string;
+    /**
+     * Check if the token is expired
+     *
+     * You may optionally provide a threshold in minutes to check if the token will expire within that time.
+     * If no threshold is provided, the token will be considered expired if it has already expired.
+     *
+     * @returns true if the token is expired (or will expire within the threshold)
+     */
+    isExpiredIn(threshold?: number, unit?: 'minutes' | 'seconds' | 'hours'): boolean;
+    isExpired(): boolean;
+    private getJWTPayload;
+    /** Decode a base64 string.
+     *
+     * Supports both Node.js and browser environments.
+     * @private
+     */
+    private decodeBase64;
+}

package/esm/models/Widget.d.ts

@@ -0,0 +1,27 @@
+import { IWidget } from './IWidget';
+import { IWidgetLineGroup } from './IWidgetLineGroup';
+export declare class Widget implements IWidget {
+    connectionType: string;
+    widgetType: string;
+    widgetHeading: string;
+    dataURI: string;
+    source?: string;
+    units: string;
+    dataName: string;
+    key?: string;
+    valueExpression?: string;
+    decimalPlaces?: number;
+    widgetTimeout?: number;
+    minimumValue: number;
+    maximumValue: number;
+    lineGroups?: IWidgetLineGroup[];
+    rangeMin?: number;
+    rangeMax?: number;
+    tableFormat?: string;
+    videoServer?: string;
+    videoId?: string;
+    videoCommand?: string;
+    videoSourceType?: string;
+    html?: string;
+    constructor(init?: Partial<IWidget>);
+}

package/esm/models/WidgetLineGroup.d.ts

@@ -0,0 +1,10 @@
+import { IWidgetLineGroup } from './IWidgetLineGroup';
+export declare class WidgetLineGroup implements IWidgetLineGroup {
+    dataURI: string;
+    source?: string;
+    units: string;
+    dataLabel: string;
+    lineColor: string;
+    valueExpression?: string;
+    constructor(init?: Partial<IWidgetLineGroup>);
+}

package/esm/models/asset-storage/AssetModelItem.d.ts

@@ -0,0 +1,14 @@
+export interface AssetItemModel {
+    metadata?: {
+        [key: string]: string;
+    };
+    path?: string;
+    contentType?: string;
+    signedURL?: string;
+    name?: string;
+    modifiedTime?: number;
+    size?: number;
+}
+export interface AssetItemWithObservationsModel extends AssetItemModel {
+    observationCount?: number;
+}

package/esm/models/asset-storage/SyncIntegrations.d.ts

@@ -0,0 +1,31 @@
+import { JSONSchema7 } from "json-schema";
+export interface AssetSyncDefinitionModel {
+    path: string;
+    enabled: boolean;
+    deleteFromRobotAfterSync?: boolean;
+    integration?: {
+        forward?: {
+            integrationId: string;
+        }[];
+    };
+}
+export interface AssetSyncDefinitionOverrideModel extends AssetSyncDefinitionModel {
+    _isOverridden: boolean;
+}
+export interface AssetSyncDefinitionsModel {
+    items: AssetSyncDefinitionModel[];
+    profileOverriddenItems?: AssetSyncDefinitionOverrideModel[];
+}
+export interface AssetSyncIntegrationProviderModel {
+    provider: string;
+    name: string;
+    schema: JSONSchema7;
+}
+export interface AssetSyncIntegrationModel extends CreateAssetSyncIntegrationModel {
+    id: string;
+}
+export interface CreateAssetSyncIntegrationModel {
+    provider: string;
+    name: string;
+    config: Map<string, string>;
+}

package/esm/models/caller/IRocosCallerMessageChunk.d.ts

@@ -0,0 +1,15 @@
+import { IRocosCallerMessageResponseAck } from './IRocosCallerMessageResponseAck';
+import { IRocosCallerMessageResponseResult } from './IRocosCallerMessageResponseResult';
+import { IRocosCallerMessageResponseUid } from './IRocosCallerMessageResponseUid';
+export interface IRocosCallerMessageChunk {
+    uid?: IRocosCallerMessageResponseUid;
+    chunkIndex: number;
+    chunkCount: number;
+    header?: {
+        created: string;
+        meta: Record<string, string>;
+    };
+    ack?: IRocosCallerMessageResponseAck;
+    result?: IRocosCallerMessageResponseResult;
+    payload?: Uint8Array;
+}

package/esm/models/caller/IRocosCallerMessageChunks.d.ts

@@ -0,0 +1,4 @@
+import { IRocosCallerMessageChunk } from './IRocosCallerMessageChunk';
+export interface IRocosCallerMessageChunks {
+    chunks: IRocosCallerMessageChunk[];
+}

package/esm/models/caller/IRocosCallerMessageHeartbeat.d.ts

@@ -0,0 +1,3 @@
+export interface IRocosCallerMessageHeartbeat {
+    [k: string]: never;
+}

package/esm/models/caller/IRocosCallerMessageResponse.d.ts

@@ -0,0 +1,10 @@
+import { IRocosCallerMessageResponseAck } from './IRocosCallerMessageResponseAck';
+import { IRocosCallerMessageResponseResult } from './IRocosCallerMessageResponseResult';
+import { IRocosCallerMessageResponseReturn } from './IRocosCallerMessageResponseReturn';
+import { IRocosCallerMessageResponseUid } from './IRocosCallerMessageResponseUid';
+export interface IRocosCallerMessageResponse {
+    uid?: IRocosCallerMessageResponseUid;
+    ack?: IRocosCallerMessageResponseAck;
+    result?: IRocosCallerMessageResponseResult;
+    return?: IRocosCallerMessageResponseReturn;
+}

package/esm/models/caller/IRocosCallerMessageResponseAck.d.ts

@@ -0,0 +1,16 @@
+export declare enum AckStatus {
+    RECEIVED = 0,
+    QUEUED = 1,
+    PROGRESS = 2,
+    CANCELLING = 3
+}
+export declare enum Stage {
+    AGENT = 0,
+    CLOUD_GATEWAY = 1,
+    DEVICE_GATEWAY = 2
+}
+export interface IRocosCallerMessageResponseAck {
+    stage: Stage;
+    status: AckStatus;
+    message: string;
+}

package/esm/models/caller/IRocosCallerMessageResponseResult.d.ts

@@ -0,0 +1,15 @@
+export declare enum ResultStatus {
+    COMPLETE_SUCCESS = 0,
+    CANCELLED = 10,
+    COMPLETE_ERROR = 11,
+    TIMED_OUT = 12,
+    REJECTED_ID = 13,
+    REJECTED_AUTH = 14,
+    REJECTED_PAYLOAD = 15,
+    REJECTED_NO_RECEIVER = 16,
+    FATAL = 17
+}
+export interface IRocosCallerMessageResponseResult {
+    status: ResultStatus;
+    message: string;
+}

package/esm/models/caller/IRocosCallerMessageResponseReturn.d.ts

@@ -0,0 +1,8 @@
+export interface IRocosCallerMessageResponseReturn {
+    header?: {
+        createdNs: string;
+        createdAt: Date;
+        meta: Record<string, string>;
+    };
+    payload: Uint8Array;
+}

package/esm/models/caller/IRocosCallerMessageResponseUid.d.ts

@@ -0,0 +1,10 @@
+export declare enum UIDVersion {
+    /**
+     * The UID is just a random 16 byte number (not a proper GUID).
+     */
+    HEADER_HASH_RAND = 0
+}
+export type IRocosCallerMessageResponseUid = {
+    version: UIDVersion;
+    hash?: string;
+};

package/esm/models/caller/IRocosCallerMessageResponses.d.ts

@@ -0,0 +1,4 @@
+import { IRocosCallerMessageResponse } from './IRocosCallerMessageResponse';
+export interface IRocosCallerMessageResponses {
+    responses: IRocosCallerMessageResponse[];
+}

package/esm/models/caller/RocosCallerResultStatus.d.ts

@@ -0,0 +1,11 @@
+export declare enum RocosCallerResultStatus {
+    COMPLETE_SUCCESS = 0,
+    CANCELLED = 10,
+    COMPLETE_ERROR = 11,
+    TIMED_OUT = 12,
+    REJECTED_ID = 13,
+    REJECTED_AUTH = 14,
+    REJECTED_PAYLOAD = 15,
+    REJECTED_NO_RECEIVER = 16,
+    FATAL = 17
+}

package/esm/models/caller/RocosResponseLevel.d.ts

@@ -0,0 +1,6 @@
+export declare enum RocosResponseLevel {
+    ALL = 0,
+    RETURN_AND_RESULT = 1,
+    RESULT_ONLY = 2,
+    NONE = 3
+}

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

@@ -0,0 +1,11 @@
+export * from './IRocosCallerMessageChunk';
+export * from './IRocosCallerMessageChunks';
+export * from './IRocosCallerMessageHeartbeat';
+export * from './IRocosCallerMessageResponse';
+export * from './IRocosCallerMessageResponseAck';
+export * from './IRocosCallerMessageResponseResult';
+export * from './IRocosCallerMessageResponseReturn';
+export * from './IRocosCallerMessageResponses';
+export * from './IRocosCallerMessageResponseUid';
+export * from './RocosCallerResultStatus';
+export * from './RocosResponseLevel';

package/esm/models/caller/index.js

@@ -0,0 +1,11 @@
+export * from './IRocosCallerMessageChunk';
+export * from './IRocosCallerMessageChunks';
+export * from './IRocosCallerMessageHeartbeat';
+export * from './IRocosCallerMessageResponse';
+export * from './IRocosCallerMessageResponseAck';
+export * from './IRocosCallerMessageResponseResult';
+export * from './IRocosCallerMessageResponseReturn';
+export * from './IRocosCallerMessageResponses';
+export * from './IRocosCallerMessageResponseUid';
+export * from './RocosCallerResultStatus';
+export * from './RocosResponseLevel';

package/esm/models/callsigns/CallsignsEnums.d.ts

@@ -0,0 +1,13 @@
+export declare enum CallsignsLookupType {
+    Query = 0,
+    List = 1
+}
+export declare enum CallsignsLogicalOperation {
+    OR = 0
+}
+export declare enum CallsignsQueryPredicateAttribute {
+    TAG = 0
+}
+export declare enum CallsignsComparisonOperation {
+    EQUAL = 0
+}

package/esm/models/callsigns/CallsignsLookup.d.ts

@@ -0,0 +1,8 @@
+import { CallsignsLookupType } from './CallsignsEnums';
+import { CallsignsQuery } from './CallsignsQuery';
+export declare class CallsignsLookup {
+    lookupValue: CallsignsQuery | string[];
+    lookupType: CallsignsLookupType;
+    constructor(lookupValue: string[] | CallsignsQuery);
+    toID(): string[];
+}

package/esm/models/callsigns/CallsignsQuery.d.ts

@@ -0,0 +1,9 @@
+import { CallsignsLogicalOperation } from './CallsignsEnums';
+import { CallsignsQueryPredicate } from './CallsignsQueryPredicate';
+export declare class CallsignsQuery {
+    operation: CallsignsLogicalOperation;
+    predicates: CallsignsQueryPredicate[];
+    constructor(init?: Partial<CallsignsQuery>);
+    toJSON(): Record<string, any>;
+    toJSONString(): string;
+}

package/esm/models/callsigns/CallsignsQueryPredicate.d.ts

@@ -0,0 +1,9 @@
+import { CallsignsComparisonOperation, CallsignsQueryPredicateAttribute } from './CallsignsEnums';
+export declare class CallsignsQueryPredicate {
+    attribute: CallsignsQueryPredicateAttribute;
+    operation: CallsignsComparisonOperation;
+    value: string;
+    constructor(init?: Partial<CallsignsQueryPredicate>);
+    toJSON(): Record<string, any>;
+    toJSONString(): string;
+}

package/esm/models/command/IRocosCommandMessageHeartbeat.d.ts

@@ -0,0 +1 @@
+export type IRocosCommandMessageHeartbeat = Record<string, never>;

package/esm/models/command/IRocosCommandMessageResponse.d.ts

@@ -0,0 +1,55 @@
+export interface IRocosCommandMessageResponse {
+    /** The unique transaction id of the command request.
+     *
+     * Used to map the command execution flow
+     */
+    txid: string;
+    ack?: Ack;
+    return?: CommandReturn;
+    /** The sequence number of the command response message, starting at zero.
+     *
+     * It is possible due to retry logic that the controller receives the same command response twice (i.e. a message with the same sequence number twice).
+     * The client should drop any messages it receives for which it has received the sequence number previously, for the given transaction ID.
+     */
+    result?: CommandResult;
+}
+interface Ack {
+    stage: Stage;
+    status: AckStatus;
+    message: string;
+}
+declare enum AckStatus {
+    RECEIVED = 0,
+    QUEUED = 1,
+    PROGRESS = 2
+}
+declare enum Stage {
+    AGENT = 0,
+    CLOUD_GATEWAY = 1,
+    DEVICE_GATEWAY = 2
+}
+interface CommandResult {
+    status: ResultStatus;
+    message: string;
+}
+interface CommandReturn {
+    type: CommandReturnType;
+    message: string;
+    payload: Uint8Array;
+    meta: Record<string, string>;
+}
+declare enum CommandReturnType {
+    COMMAND_OUTPUT = 0
+}
+declare enum ResultStatus {
+    COMPLETE_SUCCESS = 0,
+    CANCELLED = 10,
+    COMPLETE_ERROR = 11,
+    TIMED_OUT = 12,
+    REJECTED_ID = 13,
+    REJECTED_AUTH = 14,
+    REJECTED_PARAMS = 15,
+    REJECTED_NO_RECEIVER = 16,
+    FATAL = 17
+}
+export {};

package/esm/models/command/RocosCommandResultStatus.d.ts

@@ -0,0 +1,11 @@
+export declare enum RocosCommandResultStatus {
+    COMPLETE_SUCCESS = 0,
+    CANCELLED = 10,
+    COMPLETE_ERROR = 11,
+    TIMED_OUT = 12,
+    REJECTED_ID = 13,
+    REJECTED_AUTH = 14,
+    REJECTED_PARAMS = 15,
+    REJECTED_NO_RECEIVER = 16,
+    FATAL = 17
+}

package/esm/models/command/index.js

@@ -0,0 +1,4 @@
+export * from '../ResponseLevelEnum';
+export * from './IRocosCommandMessageHeartbeat';
+export * from './IRocosCommandMessageResponse';
+export * from './RocosCommandResultStatus';

package/esm/models/file/FileEnums.d.ts

@@ -0,0 +1,30 @@
+export declare enum OpRequestTarget {
+    AGENT = 0,
+    SERVER = 1
+}
+export declare enum OpCode {
+    NOP = 0,
+    INFO = 1,
+    UPLOAD = 2,
+    DOWNLOAD = 3,
+    DELETE = 4,
+    MKDIR = 5,
+    READFILE = 6,
+    WAITFOR = 7,
+    WRITEFILE = 8,
+    MV = 9,
+    CP = 10,
+    CHMOD = 11,
+    CHOWN = 12,
+    P2PUP = 13,
+    P2PDN = 14,
+    BLOBPUT = 15,
+    BLOBGET = 16,
+    BLOBSAS = 17
+}
+export declare enum FileResourceType {
+    NONE = 0,
+    DIRINFO = 1,
+    FILE = 2,
+    SAS = 32
+}

package/esm/models/index.d.ts

@@ -0,0 +1,77 @@
+export * from './asset-storage/AssetModelItem';
+export * from './asset-storage/SyncIntegrations';
+export * from './schedule/IScheduleInfo';
+export * from './schedule/IScheduleAction';
+export * from './schedule/IScheduleJob';
+export * from './caller';
+export * from './callsigns/CallsignsEnums';
+export * from './callsigns/CallsignsLookup';
+export * from './callsigns/CallsignsQuery';
+export * from './callsigns/CallsignsQueryPredicate';
+export * from './command';
+export * from './file/FileEnums';
+export * from './message';
+export * from './params/ICallerParams';
+export * from './params/ICommandParams';
+export * from './params/IControlParams';
+export * from './params/IFileAccessorParams';
+export * from './params/ISearchParams';
+export * from './params/ITelemetryParams';
+export * from './params/IWebRTCSignallingParams';
+export * from './search/SearchQueryFilter';
+export * from './search/SearchStreamQuery';
+export * from './stream/IBaseStream';
+export * from './stream/ICallerStream';
+export * from './stream/ICommandStream';
+export * from './stream/IControlStream';
+export * from './stream/IFileAccessorStream';
+export * from './stream/ISearchStream';
+export * from './stream/ITelemetryStream';
+export * from './stream/IWebRTCSignallingStream';
+export * from './integrations/Overlay';
+export * from './integrations/Plan';
+export * from './maps/Map';
+export * from './projects/ProjectUser';
+export * from './CallsignStatus';
+export * from './ExportDataQuery';
+export * from './IBaseService';
+export * from './IConfigGroup';
+export * from './IDebugLevel';
+export * from './IExportDataQuery';
+export * from './IFunctionConfig';
+export * from './IInvitation';
+export * from './IInvitationExists';
+export * from './IOperation';
+export * from './IPersonalAccessToken';
+export * from './IProject';
+export * from './IProjectApplication';
+export * from './IRobot';
+export * from './IRobotConfig';
+export * from './IRobotPlugin';
+export * from './IRobotSettings';
+export * from './IRobotTemplate';
+export * from './IRocosSDKConfig';
+export * from './ISource';
+export * from './IStream';
+export * from './IStreamConfig';
+export * from './IStreamOptions';
+export * from './IStreamSource';
+export * from './ITelemetryStreamConfig';
+export * from './IToken';
+export * from './IWidget';
+export * from './IWidgetLineGroup';
+export * from './Robot';
+export * from './RobotConfig';
+export * from './RobotPlugin';
+export * from './RobotTemplate';
+export * from './RocosError';
+export * from './ServiceEnum';
+export * from './Stream';
+export * from './StreamOptions';
+export * from './StreamSource';
+export * from './SubscriberStatusEnum';
+export * from './Token';
+export * from './types';
+export * from './Widget';
+export * from './WidgetLineGroup';
+export * from './workflow/Workflow';

package/esm/models/index.js

@@ -0,0 +1,77 @@
+export * from './asset-storage/AssetModelItem';
+export * from './asset-storage/SyncIntegrations';
+export * from './schedule/IScheduleInfo';
+export * from './schedule/IScheduleAction';
+export * from './schedule/IScheduleJob';
+export * from './caller';
+export * from './callsigns/CallsignsEnums';
+export * from './callsigns/CallsignsLookup';
+export * from './callsigns/CallsignsQuery';
+export * from './callsigns/CallsignsQueryPredicate';
+export * from './command';
+export * from './file/FileEnums';
+export * from './message';
+export * from './params/ICallerParams';
+export * from './params/ICommandParams';
+export * from './params/IControlParams';
+export * from './params/IFileAccessorParams';
+export * from './params/ISearchParams';
+export * from './params/ITelemetryParams';
+export * from './params/IWebRTCSignallingParams';
+export * from './search/SearchQueryFilter';
+export * from './search/SearchStreamQuery';
+export * from './stream/IBaseStream';
+export * from './stream/ICallerStream';
+export * from './stream/ICommandStream';
+export * from './stream/IControlStream';
+export * from './stream/IFileAccessorStream';
+export * from './stream/ISearchStream';
+export * from './stream/ITelemetryStream';
+export * from './stream/IWebRTCSignallingStream';
+export * from './integrations/Overlay';
+export * from './integrations/Plan';
+export * from './maps/Map';
+export * from './projects/ProjectUser';
+export * from './CallsignStatus';
+export * from './ExportDataQuery';
+export * from './IBaseService';
+export * from './IConfigGroup';
+export * from './IDebugLevel';
+export * from './IExportDataQuery';
+export * from './IFunctionConfig';
+export * from './IInvitation';
+export * from './IInvitationExists';
+export * from './IOperation';
+export * from './IPersonalAccessToken';
+export * from './IProject';
+export * from './IProjectApplication';
+export * from './IRobot';
+export * from './IRobotConfig';
+export * from './IRobotPlugin';
+export * from './IRobotSettings';
+export * from './IRobotTemplate';
+export * from './IRocosSDKConfig';
+export * from './ISource';
+export * from './IStream';
+export * from './IStreamConfig';
+export * from './IStreamOptions';
+export * from './IStreamSource';
+export * from './ITelemetryStreamConfig';
+export * from './IToken';
+export * from './IWidget';
+export * from './IWidgetLineGroup';
+export * from './Robot';
+export * from './RobotConfig';
+export * from './RobotPlugin';
+export * from './RobotTemplate';
+export * from './RocosError';
+export * from './ServiceEnum';
+export * from './Stream';
+export * from './StreamOptions';
+export * from './StreamSource';
+export * from './SubscriberStatusEnum';
+export * from './Token';
+export * from './types';
+export * from './Widget';
+export * from './WidgetLineGroup';
+export * from './workflow/Workflow';

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

@@ -0,0 +1,49 @@
+export interface Overlay {
+    region: string;
+    group_ids: string[];
+    layer_type: string;
+    status: string;
+    date_creation: number;
+    date_modified: number;
+    marker_positions: MarkerPositions;
+    name: string;
+    organization_id: string;
+    original_file_type?: string;
+    folder_id?: string;
+    user_id: string;
+    visible: boolean;
+    opacity: number;
+    url: string;
+    conversion_type?: string;
+    geometry?: Geometry;
+    original_file_url?: string;
+    vector_url: string;
+    tile_layer?: TileLayer;
+    id: string;
+    plan_id: string;
+    jwt: string;
+}
+export interface MarkerPositions {
+    marker1?: Marker1;
+    marker2?: Marker2;
+}
+export interface Marker1 {
+    color: string;
+    imageX: number;
+    imageY: number;
+}
+export interface Marker2 {
+    color: string;
+    imageX: number;
+    imageY: number;
+}
+export interface Geometry {
+    type: string;
+    coordinates: number[][][];
+}
+export interface TileLayer {
+    url: string;
+    min_zoom: number;
+    max_zoom: number;
+    jwt_token: string;
+}