@dronedeploy/rocos-js-sdk 0.0.1 → 1.0.0-alpha-2

package/models/message/RocosSearchMessage.js

@@ -0,0 +1,24 @@
+import { RocosSearchRowMessage } from './RocosSearchRowMessage';
+export class RocosSearchMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromMessage(dataRow) {
+        const msg = new RocosSearchMessage();
+        const dateStr = dataRow.date;
+        const rows = dataRow.row;
+        // There are two date format: 1) unix timestamp (string); 2) custom: yyyy-MM-dd HH:mm:ss
+        if (+dateStr) {
+            // It's a unix timestamp. New version.
+            msg.date = new Date(+dateStr);
+        }
+        else {
+            // Old version.
+            msg.date = new Date(dateStr.replace(' ', 'T'));
+        }
+        msg.rows = rows.map((row) => {
+            return RocosSearchRowMessage.fromMessage(row);
+        });
+        return msg;
+    }
+}

package/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/models/message/RocosSearchRowMessage.js

@@ -0,0 +1,16 @@
+export class RocosSearchRowMessage {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    static fromMessage(row) {
+        const msg = new RocosSearchRowMessage();
+        msg.key = row.key;
+        msg.count = Number(row.count);
+        msg.avgSize = row.avgSize;
+        msg.totalSize = row.totalSize;
+        msg.payload = row.payload;
+        msg.transPerSecond = row.transPerSecond;
+        msg.bytesPerSecond = row.bytesPerSecond;
+        return msg;
+    }
+}

package/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/models/message/RocosTelemetryMessage.js

@@ -0,0 +1,63 @@
+import { GRPC_SOURCE_HEARTBEAT } from '../../constants/grpc';
+import { nanosecondToMillisecond } from '../../helpers/nanosecondToMillisecond';
+export class RocosTelemetryMessage {
+    static fromTelemetryMessage(msg, data, type) {
+        return {
+            isackable: false,
+            hasHeartbeat: msg.source === GRPC_SOURCE_HEARTBEAT,
+            isStreamMessage: false,
+            callsign: msg.callsign,
+            source: msg.source,
+            payload: RocosTelemetryMessage.getPayload(msg.payload, type),
+            createdAt: new Date(nanosecondToMillisecond(msg.created)),
+            uid: msg.uid,
+            seq: Number(msg.seq),
+            receivedAt: new Date(),
+            subId: data.subId,
+            projectId: data.projectId,
+            subscriberId: data.subscriberId,
+            type,
+        };
+    }
+    static fromTelemetryStreamMessage(msg, data, type) {
+        if (msg.content.oneofKind !== 'message') {
+            throw new Error(`Invalid message type. Expected message, received ${msg.content.oneofKind}`);
+        }
+        const telemetry = msg.content.message;
+        return {
+            isStreamMessage: true,
+            isackable: msg.isAckable,
+            hasHeartbeat: false,
+            callsign: telemetry.callsign,
+            source: telemetry.source,
+            payload: RocosTelemetryMessage.getPayload(telemetry.payload, type),
+            createdAt: new Date(nanosecondToMillisecond(telemetry.created)),
+            uid: telemetry.uid,
+            seq: Number(telemetry.seq),
+            receivedAt: new Date(),
+            subId: data.subId,
+            projectId: data.projectId,
+            subscriberId: data.subscriberId,
+            type,
+        };
+    }
+    static getPayloadAsString(payload) {
+        return new TextDecoder().decode(payload);
+    }
+    static getPayloadAsJSON(payload) {
+        return JSON.parse(RocosTelemetryMessage.getPayloadAsString(payload));
+    }
+    static getPayload(payload, type) {
+        switch (type) {
+            case 'string':
+                return RocosTelemetryMessage.getPayloadAsString(payload);
+            case 'json':
+                return this.getPayloadAsJSON(payload);
+            case 'none':
+                return null;
+            case 'raw':
+            default:
+                return payload;
+        }
+    }
+}

package/models/message/index.d.ts

@@ -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/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/models/params/ICallerParams.d.ts

@@ -0,0 +1,16 @@
+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[]>;
+}

package/models/params/ICallerParams.js

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

package/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/models/params/ICommandParams.js

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

package/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/models/params/IControlParams.js

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

package/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/models/params/IFileAccessorParams.js

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

package/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/models/params/ISearchParams.js

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

package/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/models/params/ITelemetryParams.js

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

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

package/models/params/IWebRTCSignallingParams.js

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

package/models/projects/ProjectUser.d.ts

@@ -0,0 +1,6 @@
+export interface ProjectUser {
+    id: string;
+    email: string;
+    name: string;
+    permission: string;
+}

package/models/projects/ProjectUser.js

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

package/models/schedule/IScheduleAction.d.ts

@@ -0,0 +1,13 @@
+export declare enum ActionType {
+    command = "command",
+    service = "service",
+    sendMessage = "control"
+}
+type AnyActionType = ActionType.service | ActionType.command | ActionType.sendMessage;
+export interface IScheduleAction<T extends ActionType = AnyActionType> {
+    type: T;
+    uri: string;
+    request?: string;
+    meta?: Record<string, unknown>;
+}
+export {};

package/models/schedule/IScheduleAction.js

@@ -0,0 +1,6 @@
+export var ActionType;
+(function (ActionType) {
+    ActionType["command"] = "command";
+    ActionType["service"] = "service";
+    ActionType["sendMessage"] = "control";
+})(ActionType || (ActionType = {}));

package/models/schedule/IScheduleInfo.d.ts

@@ -0,0 +1,11 @@
+import { IScheduleJob } from './IScheduleJob';
+export interface IScheduleInfo {
+    callsign: string;
+    projectId: string;
+    createdAt?: string;
+    updatedAt?: string;
+    jobs: IScheduleJob[];
+}
+export interface IScheduleInfoUpdate {
+    jobs: IScheduleJob[];
+}

package/models/schedule/IScheduleInfo.js

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

package/models/schedule/IScheduleJob.d.ts

@@ -0,0 +1,12 @@
+import { IScheduleAction } from './IScheduleAction';
+export interface IScheduleJob<UIData = Record<string, unknown>> {
+    uiData?: UIData;
+    name: string;
+    schedule: string;
+    jobId: string;
+    action: IScheduleAction;
+    skippable: boolean;
+    jitter: string;
+    enabled: boolean;
+    repeating: boolean;
+}

package/models/schedule/IScheduleJob.js

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

package/models/search/SearchQueryFilter.d.ts

@@ -0,0 +1,5 @@
+export declare class SearchQueryFilter {
+    keyword: string;
+    ids: string[];
+    constructor(init?: Partial<SearchQueryFilter>);
+}

package/models/search/SearchQueryFilter.js

@@ -0,0 +1,5 @@
+export class SearchQueryFilter {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}

package/models/search/SearchStreamQuery.d.ts

@@ -0,0 +1,15 @@
+import { SearchQueryFilter } from './SearchQueryFilter';
+import { SearchStreamQueryDateFieldType } from '../types';
+export declare class SearchStreamQuery {
+    filters: SearchQueryFilter[];
+    payloadIds: string[];
+    groupByFields: string[];
+    startDate: string | number;
+    endDate: string | number;
+    interval: string;
+    refreshDelay: number;
+    dateField?: SearchStreamQueryDateFieldType;
+    projectId: string;
+    disableDateHistogram: boolean;
+    constructor(init?: Partial<SearchStreamQuery>);
+}

package/models/search/SearchStreamQuery.js

@@ -0,0 +1,6 @@
+export class SearchStreamQuery {
+    constructor(init) {
+        this.disableDateHistogram = false;
+        Object.assign(this, init);
+    }
+}

package/models/stream/IBaseStream.d.ts

@@ -0,0 +1,8 @@
+import { BehaviorSubject } from 'rxjs';
+import { SubscriberStatusEnum } from '../SubscriberStatusEnum';
+export interface IBaseStream {
+    identifier: string;
+    statusStream$: BehaviorSubject<SubscriberStatusEnum>;
+    setToken: (token: string) => void;
+    stopStream: () => void;
+}

package/models/stream/IBaseStream.js

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

package/models/stream/ICallerStream.d.ts

@@ -0,0 +1,8 @@
+import { ICallerInvokeParams, ICallerParams } from '../params/ICallerParams';
+import { IBaseStream } from './IBaseStream';
+import { IRocosCallerMessage } from '../message/IRocosCallerMessage';
+import { Observable } from 'rxjs';
+export interface ICallerStream extends IBaseStream {
+    invokeRequest: (params: ICallerInvokeParams) => Observable<IRocosCallerMessage>;
+    cancelRequest: (params: ICallerParams) => Observable<IRocosCallerMessage>;
+}

package/models/stream/ICallerStream.js

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

package/models/stream/ICommandStream.d.ts

@@ -0,0 +1,7 @@
+import { IBaseStream } from './IBaseStream';
+import { ICommandParams } from '../params/ICommandParams';
+import { IRocosCommandMessage } from '../message/IRocosCommandMessage';
+import { Observable } from 'rxjs';
+export interface ICommandStream extends IBaseStream {
+    invokeRequest: (params: ICommandParams) => Observable<IRocosCommandMessage>;
+}

package/models/stream/ICommandStream.js

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

package/models/stream/IControlStream.d.ts

@@ -0,0 +1,9 @@
+import { ControlActionType, IControlParams } from '../params/IControlParams';
+import { IBaseStream } from './IBaseStream';
+import { IRocosControlMessage } from '../message/IRocosControlMessage';
+import { Observable } from 'rxjs';
+export interface IControlStream extends IBaseStream {
+    sendCommand: (params: IControlParams) => void;
+    sendCommandWithAck: (params: IControlParams) => Observable<IRocosControlMessage>;
+    takeActionWithAck: (action: ControlActionType, params: IControlParams, ackTimeoutInSeconds: number) => Observable<string>;
+}

package/models/stream/IControlStream.js

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

package/models/stream/IFileAccessorStream.d.ts

@@ -0,0 +1,9 @@
+import { IFileAccessorParams, IFileAccessorReqOpParams } from '../params/IFileAccessorParams';
+import { IBaseStream } from './IBaseStream';
+import { IRocosOpResultMessage } from '../message/IRocosOpResultMessage';
+export interface IFileAccessorStream extends IBaseStream {
+    serverReqOp: (params: IFileAccessorReqOpParams) => Promise<IRocosOpResultMessage[]>;
+    listFolder: (params: IFileAccessorParams) => Promise<IRocosOpResultMessage[]>;
+    downloadFile: (params: IFileAccessorParams) => Promise<IRocosOpResultMessage[]>;
+    getDownloadFileLinkByUsingBlob: (params: IFileAccessorParams) => Promise<IRocosOpResultMessage[]>;
+}

package/models/stream/IFileAccessorStream.js

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

package/models/stream/ISearchStream.d.ts

@@ -0,0 +1,11 @@
+import { ISearchParams, ISearchQueryParams, ISearchStreamParams } from '../params/ISearchParams';
+import { IBaseStream } from './IBaseStream';
+import { IRocosSearchMessage } from '../message/IRocosSearchMessage';
+import { IRocosSearchStatusMessage } from '../message/IRocosSearchStatusMessage';
+import { Observable } from 'rxjs';
+export interface ISearchStream extends IBaseStream {
+    searchStream: (params: ISearchStreamParams) => Observable<IRocosSearchMessage[]>;
+    queryData: (params: ISearchQueryParams) => Promise<string>;
+    healthCheck: (params: ISearchParams) => Promise<IRocosSearchStatusMessage>;
+    deleteProjectData: (params: ISearchParams) => Promise<IRocosSearchStatusMessage>;
+}

package/models/stream/ISearchStream.js

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

package/models/stream/ITelemetryStream.d.ts

@@ -0,0 +1,10 @@
+import { IBaseStream } from './IBaseStream';
+import { IRocosTelemetryMessage } from '../message/IRocosTelemetryMessage';
+import { ITelemetryParams } from '../params/ITelemetryParams';
+import { Subject } from 'rxjs';
+export interface ITelemetryStream extends IBaseStream {
+    init: () => void;
+    addSubscription: (params: ITelemetryParams) => void;
+    messageStream$: Subject<IRocosTelemetryMessage>;
+    removeSubscription: (params: ITelemetryParams, terminateReceiverGroup?: boolean) => void;
+}

package/models/stream/ITelemetryStream.js

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

package/models/stream/IWebRTCSignallingStream.d.ts

@@ -0,0 +1,76 @@
+import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest } from '../params/IWebRTCSignallingParams';
+import { IBaseStream } from './IBaseStream';
+export interface IWebRTCSignallingMessage {
+    videoId: string;
+    messageType: string;
+    payload: string;
+}
+export interface IWebRTCSignallingGetDetailsResponse {
+    operators: number;
+}
+export interface IWebRTCSignallingOutcome {
+    outcome: string;
+    message: string;
+}
+export interface IStatus {
+    details: string;
+    /**
+     * For gRPC, it will be the string value of a StatusCode enum value
+     * https://github.com/grpc/grpc/blob/a19d8dcfb50caa81cddc25bc1a6afdd7a2f497b7/include/grpcpp/impl/codegen/status_code_enum.h#L24
+     */
+    code: string;
+    metadata: Record<string, string | string[]>;
+}
+export interface IServiceError {
+    message: string;
+    code: number;
+    metadata: Record<string, string>;
+}
+/**
+ * Represent the gRPC stream for the established operation connection
+ */
+export interface IWebRTCSignallingResponseStream<T> extends AsyncIterable<T> {
+    /**
+     * Add a callback for every new datum.
+     * If a new message arrived, the "message" argument is set.
+     * If an error occurred, the "error" argument is set.
+     * If the stream is complete, the "complete" argument is `true`.
+     * Only one of the arguments is used at a time.
+     */
+    onNext(callback: (message: T | undefined, error: Error | undefined, complete: boolean) => void): () => void;
+    /**
+     * Add a callback for every new message.
+     */
+    onMessage(callback: (message: T) => void): () => void;
+    /**
+     * Add a callback for stream completion.
+     * Called only when all messages have been read without error.
+     * The stream is closed when this callback is called.
+     */
+    onComplete(callback: () => void): () => void;
+    /**
+     * Add a callback for errors.
+     * The stream is closed when this callback is called.
+     */
+    onError(callback: (reason: Error) => void): () => void;
+    /**
+     * Cancel the stream
+     */
+    cancel(): void;
+    status(): Promise<IStatus>;
+}
+export interface IWebRTCSignallingStream extends IBaseStream {
+    connectOperator: (request: IOperatorConnectRequest) => IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>;
+    /**
+     * Get the peer details
+     */
+    getDetails: (request: IGetDetailsRequest) => Promise<IWebRTCSignallingGetDetailsResponse>;
+    /**
+     * Offer the connection to the peer
+     */
+    offerConnection: (request: IOfferRequest) => Promise<IWebRTCSignallingOutcome>;
+    /**
+     * Add candidate about self
+     */
+    addIceCandidate: (request: IAddIceCandidateRequest) => Promise<IWebRTCSignallingOutcome>;
+}

package/models/stream/IWebRTCSignallingStream.js

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

package/models/types.d.ts

@@ -0,0 +1,5 @@
+export type RocosChangeMessageType = 'token' | 'user-token' | 'telemetry-subscription' | 'http-error';
+export type RobotModeType = 'physical' | 'virtual';
+export type RocosTelemetryMessageType = 'json' | 'string' | 'none' | 'raw';
+export type SearchStreamQueryDateFieldType = 'dateCreated' | 'dateReceived';
+export type ScheduleActionType = 'service' | 'command' | 'control';

package/models/types.js

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

package/node/RocosSDKNode.d.ts

@@ -0,0 +1,42 @@
+import { ScheduleService } from '../services';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { IBaseService } from '../models/IBaseService';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+import { ServiceEnum } from '../models/ServiceEnum';
+import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
+export declare class RocosSDKNode extends RocosSDK {
+    getService<T extends IBaseService>(name: ServiceEnum): T;
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService(): TelemetryServiceNode;
+    /**
+     * Gets the scheduler service.
+     */
+    getSchedulerService(): ScheduleService;
+    /**
+     * Gets the service call service.
+     */
+    getCallerService(): CallerServiceNode;
+    /**
+     * Gets the command service.
+     */
+    getCommandService(): CommandServiceNode;
+    /**
+     * Gets the robot control service.
+     */
+    getControlService(): ControlServiceNode;
+    /**
+     * Gets the search service.
+     */
+    getSearchService(): SearchServiceNode;
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorServiceNode
+     */
+    getFileAccessorService(): FileAccessorServiceNode;
+}