@dronedeploy/rocos-js-sdk 3.0.1-alpha.1 → 3.0.1-alpha.14

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,80 @@
+export * from './asset-storage/AssetItem';
+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 './maps/Panorama';
+export * from './projects/ProjectUser';
+export * from './CallsignStatus';
+export * from './ExportDataQuery';
+export * from './HttpError';
+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 './IProjectInfo';
+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,80 @@
+export * from './asset-storage/AssetItem';
+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 './maps/Panorama';
+export * from './projects/ProjectUser';
+export * from './CallsignStatus';
+export * from './ExportDataQuery';
+export * from './HttpError';
+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 './IProjectInfo';
+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;
+}

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

@@ -0,0 +1,324 @@
+export interface Plan {
+    assets_data_location: string;
+    camera: Camera;
+    can_continue: boolean;
+    cancelled: boolean;
+    data: string;
+    date_creation: DateCreation;
+    date_images_captured: DateCreation;
+    date_modified: DateCreation;
+    deleted: boolean;
+    description: string;
+    drone: Drone;
+    fieldscans_bucket: string;
+    flight_logs_bucket: string;
+    flown: boolean;
+    flown_complete: boolean;
+    flown_waypoints: unknown[];
+    folder_id: string;
+    geometry: Geometry[];
+    group_ids: unknown[];
+    image_count: number;
+    image_stitch: number;
+    image_upload_count: number;
+    info: Info;
+    layer: LayerSummary;
+    layer_events: unknown[];
+    location: Geometry;
+    log: string;
+    metadata: unknown;
+    name: string;
+    notifications: Notifications;
+    offline_start: boolean;
+    options: Options;
+    organization_id: string;
+    parameters: unknown[];
+    previous_layers: unknown[];
+    quality_assurance: QualityAssurance;
+    record_type: string;
+    region: string;
+    sort_date: DateCreation;
+    source_image_bucket: string;
+    source_preprocessed_3d_bucket: string;
+    source_preprocessed_bucket: string;
+    source_preprocessed_pano_bucket: string;
+    source_video_bucket: string;
+    source_walkthrough_bucket: string;
+    stitch_started: boolean;
+    support_offline: boolean;
+    type: string;
+    user_offsets: unknown;
+    username: string;
+    waypoint_offset: number;
+    waypoints: unknown[];
+    workflow: Workflow;
+    latest_started_map_id: string;
+    latest_completed_map_id: string;
+    share_links: ShareLinks;
+    status: string;
+    time_to_completion_hrs: number;
+    imgproxy_domain: string;
+    gcp_tool_url: string;
+    _id: Id;
+}
+interface Id {
+    '$oid': string;
+}
+interface ShareLinks {
+    private: string;
+    public: string;
+    '3d_model'?: string;
+}
+interface Workflow {
+    fs_mode: string;
+    fs_recording: boolean;
+    is_map_engine: boolean;
+    job_type: string;
+    quality: number;
+    upload_canceled: boolean;
+    upload_mechanism: string;
+    uploading_user_id: string;
+    workflow_type: string;
+    uploaded_data_size: number;
+    uploaded_image_count: number;
+    smart_upload_id: string;
+    upload_start_time: number;
+}
+interface QualityAssurance {
+    checked: boolean;
+    name: string;
+    note: string;
+}
+interface Options {
+    auto_camera_settings: boolean;
+    auto_focus: boolean;
+    auto_settings: boolean;
+    crosshatch: boolean;
+    crosshatchGimbalPitch: number;
+    enhanced_3d: boolean;
+    frontlap: number;
+    fs_hd: boolean;
+    fs_only: boolean;
+    max_flight_speed: number;
+    no_turn: boolean;
+    perimeter_end_of_mission: boolean;
+    perimeters: Perimeter[];
+    show_existing_map: boolean;
+    sidelap: number;
+    skipLawnmowerPattern: boolean;
+    starting_waypoint: number;
+    split: number;
+    flight_mode: string;
+}
+interface Perimeter {
+    altitudeDelta: number;
+    distanceDelta: number;
+}
+interface Notifications {
+    sent_failure_email: boolean;
+    sent_success_email: boolean;
+}
+interface LayerSummary {
+    status: string;
+    user_status: string;
+    map_type: string;
+    last_update: number;
+    process_messages: unknown[];
+    log: string;
+    date_created: number;
+    layers: Layer[];
+    progress: Progress[];
+    user_elevation_offset: number;
+    date_started: number;
+    date_complete: number;
+    id: string;
+    model?: unknown;
+    job_type: string;
+    quality: number;
+    map_area: number;
+    plan_image_count: number;
+    resumed: boolean;
+    stitcher: string;
+    role: string;
+    industry: string;
+    image_angle_percentages: ImageAnglePercentages;
+    average_image_density: number;
+    average_image_altitude: number;
+    flown_app_plan_id?: unknown;
+    flown_app_version?: unknown;
+    flown_with_app: boolean;
+    camera_model: string;
+    processed_images: number;
+    size_of_processed_images: number;
+    image_stitch: number;
+    segmentation?: Segmentation;
+    total_photogrammetry_assets_mb: number;
+    max_photogrammetry_assets_mb: number;
+    quality_checks: QualityChecks;
+    feature_pre_extract_percentage: number;
+    feature_pre_extract_count: number;
+    dual: boolean;
+    radiometric: boolean;
+    thermal: boolean;
+    failure_info?: FailureInfo;
+    mainflow_exceptions?: MainFlowException[];
+    report_summary: ReportSummary;
+    total_output_data_size_mb: number;
+    processing_time: number;
+    processing_time_per_image: number;
+    processing_time_per_mb_imagery: number;
+    pipeline_info: PipelineInfo;
+    aligned_percentage?: number;
+    fusion_hole_percentage?: number;
+    ortho_holes?: number;
+    mesh_holes?: number;
+    reconstruction_quality?: number;
+    geotiff_ortho?: GeoTiffOrtho;
+    geotiff_dem?: GeoTiffOrtho;
+    point_cloud_size?: number;
+    dtm_smrf_window?: number;
+    tile_pyramid_ortho?: TilePyramidOrtho;
+    tile_pyramid_dtm?: TilePyramidOrtho;
+    tile_pyramid_dem?: TilePyramidOrtho;
+    gcp_accuracy_download?: string;
+}
+interface TilePyramidOrtho {
+    mb_before: number;
+    count: number;
+    mb_after: number;
+}
+interface GeoTiffOrtho {
+    processing_seconds: number;
+    mb_before: number;
+    mb_after: number;
+}
+interface PipelineInfo {
+    asset_size: number;
+    metrics: Metrics;
+}
+interface Metrics {
+    x_err?: number;
+    y_err?: number;
+    z_err?: number;
+    dem_res?: number;
+    ortho_res?: number;
+    aligned?: string;
+    rms_err?: number;
+}
+interface ReportSummary {
+    capture_date: number;
+    processed_date: number;
+    quality: Quality[];
+}
+interface Quality {
+    label: string;
+    thresh: string;
+    value: (number[] | number | string)[];
+    fmt?: string;
+}
+interface MainFlowException {
+    stage: string;
+    failure_reason?: unknown;
+    log_message: string;
+    fatal: boolean;
+}
+interface FailureInfo {
+    'stitching failed': boolean;
+    null: string;
+}
+interface QualityChecks {
+    nadir_images?: number;
+    feature_percent?: number;
+    used_relative_alt: boolean;
+    no_sensor_covar?: boolean;
+    no_camera_covar?: boolean;
+}
+interface Segmentation {
+    prediction_system: string;
+    segmentation_model: string;
+    resolution: number;
+    run_time_seconds: number;
+    gpu: string;
+    is_succeeded: boolean;
+    inference_expected_count: number;
+    inference_completed_count: number;
+    summary: Summary;
+}
+interface Summary {
+    sky: number[];
+    'floor-wood': number[];
+    tree: number[];
+    mountain: number[];
+    house: number[];
+}
+interface ImageAnglePercentages {
+    nadir: number;
+    oblique: number;
+    horizontal: number;
+    upward: number;
+}
+interface Progress {
+    time: number;
+    event: string;
+}
+interface Layer {
+    name: string;
+    url: string;
+    visible?: boolean;
+    opacity?: number;
+    max_native_zoom?: number;
+    stitch_time?: number;
+    host?: string;
+    format?: string;
+    data_location?: string;
+    min?: number;
+    max?: number;
+    fast_stitch?: boolean;
+    jit?: boolean;
+    jwt?: string;
+    histogram?: boolean;
+}
+interface Info {
+    extroWaypointsCount: number;
+    introWaypointsCount: number;
+    altitude: number;
+}
+interface Geometry {
+    lat: number;
+    lng: number;
+}
+interface Drone {
+    controller: Controller;
+    device: string;
+}
+interface Controller {
+    serials: unknown[];
+}
+interface DateCreation {
+    '$date': number;
+}
+interface Camera {
+    capture_delay: number;
+    focal: number;
+    h_proj: number;
+    min_capture_period: number;
+    name: string;
+    sensor_height: number;
+    sensor_width: number;
+    static_ring_value: number;
+    v_proj: number;
+    video: Video;
+    xres: number;
+    yres: number;
+}
+interface Video {
+    aspectRatios: AspectRatios;
+    crop: unknown[];
+}
+interface AspectRatios {
+    live_map_hd: number;
+    live_map: number;
+    live_map_ff_hd: number;
+    live_map_ff_sd: number;
+}
+export {};

package/esm/models/maps/Map.d.ts

@@ -0,0 +1,11 @@
+export interface Map {
+    id: string;
+    description: string;
+    nodes: number;
+    edges: number;
+    sizeBytes: number;
+    deployed: boolean;
+    deployedCount: number;
+    isUploading: boolean;
+    isInCloud: boolean;
+}

package/esm/models/maps/Panorama.d.ts

@@ -0,0 +1,36 @@
+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 {
+    panoramaID: string;
+    id?: string;
+    name?: string;
+    data?: Record<string, string>;
+    geometry?: Position[];
+    center?: Position;
+}
+export interface Panorama {
+    transform: {
+        parent: string;
+        id: string;
+        rot: Quaternion;
+        pos: Vector3;
+    };
+    data: {
+        path: string;
+    };
+}

package/esm/models/message/IRocosCallerMessage.d.ts

@@ -0,0 +1,8 @@
+import { IRocosCallerMessageChunks } from '../caller/IRocosCallerMessageChunks';
+import { IRocosCallerMessageHeartbeat } from '../caller/IRocosCallerMessageHeartbeat';
+import { IRocosCallerMessageResponses } from '../caller/IRocosCallerMessageResponses';
+export interface IRocosCallerMessage {
+    heartbeat?: IRocosCallerMessageHeartbeat;
+    responses?: IRocosCallerMessageResponses;
+    chunks?: IRocosCallerMessageChunks;
+}

package/esm/models/message/IRocosChangeMessage.d.ts

@@ -0,0 +1,6 @@
+import { RocosChangeMessageType } from '../types';
+export interface IRocosChangeMessage<T = any> {
+    type: RocosChangeMessageType;
+    url: string;
+    data: T;
+}