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

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;
+}

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

@@ -0,0 +1,6 @@
+import { IRocosCommandMessageHeartbeat } from '../command/IRocosCommandMessageHeartbeat';
+import { IRocosCommandMessageResponse } from '../command/IRocosCommandMessageResponse';
+export interface IRocosCommandMessage {
+    heartbeat?: IRocosCommandMessageHeartbeat;
+    response?: IRocosCommandMessageResponse;
+}

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

@@ -0,0 +1,7 @@
+export interface IRocosControlMessage {
+    success: boolean;
+    stage: string;
+    message: string;
+    txid: string;
+    seq: number;
+}

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

@@ -0,0 +1,6 @@
+import { FileResourceType } from '../file/FileEnums';
+export interface IRocosOpResultMessage {
+    path?: string;
+    data?: string;
+    type?: FileResourceType;
+}

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

@@ -0,0 +1,5 @@
+import { IRocosSearchRowMessage } from './IRocosSearchRowMessage';
+export interface IRocosSearchMessage {
+    date: Date;
+    rows: IRocosSearchRowMessage[];
+}

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

@@ -0,0 +1,9 @@
+export interface IRocosSearchRowMessage {
+    key: string;
+    count: number;
+    avgSize: number;
+    totalSize: number;
+    payload: string;
+    transPerSecond?: number;
+    bytesPerSecond?: number;
+}

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

@@ -0,0 +1,4 @@
+export interface IRocosSearchStatusMessage {
+    outcome: string;
+    error: string;
+}

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

@@ -0,0 +1,23 @@
+import { RocosTelemetryMessageType } from '../types';
+export interface IRocosTelemetryMessage<T extends RocosTelemetryMessageType = 'json', R = unknown> {
+    subId: string;
+    uid: string;
+    seq: number;
+    subscriberId?: string;
+    createdAt: Date;
+    projectId: string;
+    callsign: string;
+    source: string;
+    payload: PayloadType<R>[T];
+    type: T;
+    hasHeartbeat: boolean;
+    isackable: boolean;
+    isStreamMessage: boolean;
+    receivedAt: Date;
+}
+export interface PayloadType<R = unknown> {
+    'json': R;
+    'string': string;
+    'none': null;
+    'raw': Uint8Array;
+}

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

@@ -0,0 +1,5 @@
+import { SubscriberStatusEnum } from '../../models/SubscriberStatusEnum';
+export interface IStreamStatusMessage {
+    scope: string;
+    status: SubscriberStatusEnum;
+}

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

@@ -0,0 +1,10 @@
+import { IRocosCallerMessageChunks, IRocosCallerMessageHeartbeat, IRocosCallerMessageResponses } from '../caller';
+import { IRocosCallerMessage } from './IRocosCallerMessage';
+import { ResponseChannelMessage } from '../../grpc/serviette.v1_pb';
+export declare class RocosCallerMessage implements IRocosCallerMessage {
+    heartbeat?: IRocosCallerMessageHeartbeat;
+    responses?: IRocosCallerMessageResponses;
+    chunks?: IRocosCallerMessageChunks;
+    constructor(init?: Partial<IRocosCallerMessage>);
+    static fromModel(model: ResponseChannelMessage): RocosCallerMessage;
+}

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

@@ -0,0 +1,9 @@
+import { IRocosCommandMessageHeartbeat, IRocosCommandMessageResponse } from '../command';
+import { IRocosCommandMessage } from './IRocosCommandMessage';
+import { ResponseChannelMessage } from '../../grpc/rambo.v1_pb';
+export declare class RocosCommandMessage implements IRocosCommandMessage {
+    heartbeat?: IRocosCommandMessageHeartbeat;
+    response?: IRocosCommandMessageResponse;
+    constructor(init?: Partial<IRocosCommandMessage>);
+    static fromModel(model: ResponseChannelMessage): RocosCommandMessage;
+}

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

@@ -0,0 +1,11 @@
+import { ControlAck } from '../../grpc/conker_pb';
+import { IRocosControlMessage } from './IRocosControlMessage';
+export declare class RocosControlMessage implements IRocosControlMessage {
+    success: boolean;
+    stage: string;
+    message: string;
+    txid: string;
+    seq: number;
+    constructor(init?: Partial<IRocosControlMessage>);
+    static fromMessage(ack: ControlAck): IRocosControlMessage;
+}

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

@@ -0,0 +1,10 @@
+import { OpResult, OpResults } from '../../grpc/filagree_pb';
+import { FileResourceType } from '../file/FileEnums';
+import { IRocosOpResultMessage } from './IRocosOpResultMessage';
+export declare class RocosOpResultMessage implements IRocosOpResultMessage {
+    path?: string;
+    data?: string;
+    type?: FileResourceType;
+    static fromMessages(results: OpResults): RocosOpResultMessage[];
+    static fromMessage(result: OpResult): RocosOpResultMessage;
+}

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

@@ -0,0 +1,9 @@
+import { DataRow } from '../../grpc/slowlane_pb';
+import { IRocosSearchMessage } from './IRocosSearchMessage';
+import { IRocosSearchRowMessage } from './IRocosSearchRowMessage';
+export declare class RocosSearchMessage implements IRocosSearchMessage {
+    date: Date;
+    rows: IRocosSearchRowMessage[];
+    constructor(init?: Partial<IRocosSearchMessage>);
+    static fromMessage(dataRow: DataRow): IRocosSearchMessage;
+}

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

@@ -0,0 +1,13 @@
+import { IRocosSearchRowMessage } from './IRocosSearchRowMessage';
+import { Row } from '../../grpc/slowlane_pb';
+export declare class RocosSearchRowMessage implements IRocosSearchRowMessage {
+    key: string;
+    count: number;
+    avgSize: number;
+    totalSize: number;
+    payload: string;
+    transPerSecond?: number;
+    bytesPerSecond?: number;
+    constructor(init?: Partial<IRocosSearchRowMessage>);
+    static fromMessage(row: Row): IRocosSearchRowMessage;
+}

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

@@ -0,0 +1,10 @@
+import { IRocosTelemetryMessage, PayloadType } from './IRocosTelemetryMessage';
+import { TelemetryMessage, TelemetryStreamMessage } from '../../grpc/teletubby_pb';
+import { RocosTelemetryMessageType } from '../types';
+export declare class RocosTelemetryMessage {
+    static fromTelemetryMessage<T extends RocosTelemetryMessageType>(msg: TelemetryMessage, data: Pick<IRocosTelemetryMessage, 'subId' | 'projectId' | 'subscriberId'>, type: T): IRocosTelemetryMessage<T>;
+    static fromTelemetryStreamMessage<T extends RocosTelemetryMessageType>(msg: TelemetryStreamMessage, data: Pick<IRocosTelemetryMessage, 'subId' | 'projectId' | 'subscriberId'>, type: T): IRocosTelemetryMessage<T>;
+    static getPayloadAsString(payload: Uint8Array): PayloadType['string'];
+    static getPayloadAsJSON(payload: Uint8Array): PayloadType['json'];
+    static getPayload<T extends RocosTelemetryMessageType>(payload: Uint8Array, type: T): PayloadType[T];
+}

package/esm/models/message/index.js

@@ -0,0 +1,17 @@
+export * from './IRocosCallerMessage';
+export * from './IRocosChangeMessage';
+export * from './IRocosCommandMessage';
+export * from './IRocosControlMessage';
+export * from './IRocosOpResultMessage';
+export * from './IRocosSearchMessage';
+export * from './IRocosSearchRowMessage';
+export * from './IRocosSearchStatusMessage';
+export * from './IRocosTelemetryMessage';
+export * from './IStreamStatusMessage';
+export * from './RocosCallerMessage';
+export * from './RocosCommandMessage';
+export * from './RocosControlMessage';
+export * from './RocosOpResultMessage';
+export * from './RocosSearchMessage';
+export * from './RocosSearchRowMessage';
+export * from './RocosTelemetryMessage';

package/esm/models/params/ICallerParams.d.ts

@@ -0,0 +1,26 @@
+import { RocosResponseLevel } from '../caller';
+export interface ICallerParams {
+    uid: string;
+    projectId: string;
+    callsign: string;
+    subSystem: string;
+    component?: string;
+    topic?: string;
+}
+export interface ICallerInvokeParams extends ICallerParams {
+    component: string;
+    topic: string;
+    responseLevelNumber: RocosResponseLevel | number;
+    payload: string;
+    query?: Record<string, string[]>;
+}
+export interface ICallerCallParams {
+    projectId: string;
+    callsign: string;
+    source: string;
+    payload?: unknown;
+    options?: {
+        uid?: string;
+        query?: Record<string, string[]>;
+    };
+}

package/esm/models/params/ICommandParams.d.ts

@@ -0,0 +1,9 @@
+import { ResponseLevelEnum } from '../ResponseLevelEnum';
+export interface ICommandParams {
+    projectId: string;
+    callsign: string;
+    commandId: string;
+    parameters: Record<string, string>;
+    timeoutMs?: number;
+    responseLevel?: ResponseLevelEnum;
+}

package/esm/models/params/IControlParams.d.ts

@@ -0,0 +1,8 @@
+export interface IControlParams {
+    projectId: string;
+    callsign: string;
+    destination: string;
+    payload: string;
+    meta?: Record<string, string>;
+}
+export type ControlActionType = 'rosbridge-control';

package/esm/models/params/IFileAccessorParams.d.ts

@@ -0,0 +1,11 @@
+import { OpCode, OpRequestTarget } from '../file/FileEnums';
+export interface IFileAccessorParams {
+    projectId: string;
+    callsign: string;
+    path: string;
+}
+export interface IFileAccessorReqOpParams extends IFileAccessorParams {
+    opCode: OpCode;
+    target?: OpRequestTarget;
+    args?: Record<string, string>;
+}

package/esm/models/params/ISearchParams.d.ts

@@ -0,0 +1,10 @@
+import { SearchStreamQuery } from '../search/SearchStreamQuery';
+export interface ISearchParams {
+    projectId: string;
+}
+export interface ISearchStreamParams extends ISearchParams {
+    query: SearchStreamQuery;
+}
+export interface ISearchQueryParams extends ISearchParams {
+    query: string;
+}

package/esm/models/params/ITelemetryParams.d.ts

@@ -0,0 +1,18 @@
+import { CallsignsQuery } from '../callsigns/CallsignsQuery';
+export interface ITelemetryParams {
+    uniqueId: string;
+    callsigns: string[];
+    sources: string[];
+}
+export interface ITelemetryCountParams extends ITelemetryParams {
+    count: number;
+}
+export interface ITelemetrySubscriptionParams {
+    projectId: string;
+    sources: string[];
+    callsigns?: string[];
+    scope?: string;
+    query?: CallsignsQuery;
+    terminateReceiverGroupOnUnsubscribe?: boolean;
+}
+export type ITelemetrySubscriptions = Map<string, ITelemetryCountParams>;

package/esm/models/params/IWebRTCSignallingParams.d.ts

@@ -0,0 +1,21 @@
+export interface IOperatorConnectRequest {
+    videoId: string;
+    projectId: string;
+}
+export interface IGetDetailsRequest {
+    videoId: string;
+    projectId: string;
+}
+export interface IOfferRequest {
+    projectId: string;
+    rtcSessionDescription: RTCSessionDescription;
+    videoCommand: string;
+    videoId: string;
+    clientId: string;
+    videoFormat: string;
+}
+export interface IAddIceCandidateRequest {
+    projectId: string;
+    videoId: string;
+    candidate: string;
+}