@dronedeploy/rocos-js-sdk 0.0.1 → 3.0.0-alpha.19

package/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/models/command/IRocosCommandMessageResponse.js

@@ -0,0 +1,29 @@
+var AckStatus;
+(function (AckStatus) {
+    AckStatus[AckStatus["RECEIVED"] = 0] = "RECEIVED";
+    AckStatus[AckStatus["QUEUED"] = 1] = "QUEUED";
+    AckStatus[AckStatus["PROGRESS"] = 2] = "PROGRESS";
+})(AckStatus || (AckStatus = {}));
+var Stage;
+(function (Stage) {
+    Stage[Stage["AGENT"] = 0] = "AGENT";
+    Stage[Stage["CLOUD_GATEWAY"] = 1] = "CLOUD_GATEWAY";
+    Stage[Stage["DEVICE_GATEWAY"] = 2] = "DEVICE_GATEWAY";
+})(Stage || (Stage = {}));
+var CommandReturnType;
+(function (CommandReturnType) {
+    CommandReturnType[CommandReturnType["COMMAND_OUTPUT"] = 0] = "COMMAND_OUTPUT";
+})(CommandReturnType || (CommandReturnType = {}));
+var ResultStatus;
+(function (ResultStatus) {
+    ResultStatus[ResultStatus["COMPLETE_SUCCESS"] = 0] = "COMPLETE_SUCCESS";
+    ResultStatus[ResultStatus["CANCELLED"] = 10] = "CANCELLED";
+    ResultStatus[ResultStatus["COMPLETE_ERROR"] = 11] = "COMPLETE_ERROR";
+    ResultStatus[ResultStatus["TIMED_OUT"] = 12] = "TIMED_OUT";
+    ResultStatus[ResultStatus["REJECTED_ID"] = 13] = "REJECTED_ID";
+    ResultStatus[ResultStatus["REJECTED_AUTH"] = 14] = "REJECTED_AUTH";
+    ResultStatus[ResultStatus["REJECTED_PARAMS"] = 15] = "REJECTED_PARAMS";
+    ResultStatus[ResultStatus["REJECTED_NO_RECEIVER"] = 16] = "REJECTED_NO_RECEIVER";
+    ResultStatus[ResultStatus["FATAL"] = 17] = "FATAL";
+})(ResultStatus || (ResultStatus = {}));
+export {};

package/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/models/command/RocosCommandResultStatus.js

@@ -0,0 +1,12 @@
+export var RocosCommandResultStatus;
+(function (RocosCommandResultStatus) {
+    RocosCommandResultStatus[RocosCommandResultStatus["COMPLETE_SUCCESS"] = 0] = "COMPLETE_SUCCESS";
+    RocosCommandResultStatus[RocosCommandResultStatus["CANCELLED"] = 10] = "CANCELLED";
+    RocosCommandResultStatus[RocosCommandResultStatus["COMPLETE_ERROR"] = 11] = "COMPLETE_ERROR";
+    RocosCommandResultStatus[RocosCommandResultStatus["TIMED_OUT"] = 12] = "TIMED_OUT";
+    RocosCommandResultStatus[RocosCommandResultStatus["REJECTED_ID"] = 13] = "REJECTED_ID";
+    RocosCommandResultStatus[RocosCommandResultStatus["REJECTED_AUTH"] = 14] = "REJECTED_AUTH";
+    RocosCommandResultStatus[RocosCommandResultStatus["REJECTED_PARAMS"] = 15] = "REJECTED_PARAMS";
+    RocosCommandResultStatus[RocosCommandResultStatus["REJECTED_NO_RECEIVER"] = 16] = "REJECTED_NO_RECEIVER";
+    RocosCommandResultStatus[RocosCommandResultStatus["FATAL"] = 17] = "FATAL";
+})(RocosCommandResultStatus || (RocosCommandResultStatus = {}));

package/models/command/index.d.ts

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

package/models/command/index.js

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

package/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/models/file/FileEnums.js

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

package/models/index.d.ts

@@ -0,0 +1,76 @@
+export * from './asset-storage/AssetModelItem';
+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/models/index.js

@@ -0,0 +1,76 @@
+export * from './asset-storage/AssetModelItem';
+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/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;
+}

package/models/integrations/Overlay.js

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