@dronedeploy/rocos-js-sdk 3.0.1-alpha.2 → 3.0.1-alpha.20

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

package/esm/models/projects/ProjectUser.d.ts

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

package/esm/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/esm/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/esm/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/esm/models/search/SearchQueryFilter.d.ts

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

package/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/models/target/Target.d.ts

@@ -0,0 +1,27 @@
+import { Quaternion } from '../graph/Quaternion';
+import { Vector3 } from '../graph/Vector3';
+/**
+ * Observation target model (such as an asset, a point of interest, a puddle, etc.)
+ */
+export interface Target {
+    /**
+     * Unique identifier of the target
+     */
+    id: string;
+    /**
+     * Name of the target
+     */
+    name: string;
+    /**
+     * Metadata associated with the target (key-value pairs) such as name, type, asset-id, etc.
+     */
+    data: Record<string, string>;
+    /**
+     * Position of the target in the 3D space
+     */
+    translation: Vector3;
+    /**
+     * Rotation of the target in the 3D space
+     */
+    rotation: Quaternion;
+}

package/esm/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/esm/models/workflow/Workflow.d.ts

@@ -0,0 +1,94 @@
+export type ResourceType = 'Manifest' | 'AgentGraph' | 'Javascript' | 'NodeDefinition' | 'Other';
+export interface Resource {
+    type: ResourceType;
+    data: string;
+    hash: string;
+    link: string;
+    contentLink?: string;
+    size?: number;
+    path?: string;
+}
+export interface Resources {
+    [key: string]: Resource;
+}
+export interface Author {
+    id: string;
+    name: string;
+    email: string;
+}
+interface ResponseBase {
+    id: string;
+    createdBy: string;
+    updatedBy: string;
+    dateCreated: number;
+    dateUpdated: number;
+}
+export interface WorkflowBase {
+    flowId: string;
+    name: string;
+    description?: string;
+    resources?: Resources;
+    type?: string;
+}
+export interface Workflow extends WorkflowBase, ResponseBase {
+    projectId: string;
+    author: Author;
+    latestVersion: string;
+    type: string;
+}
+export interface DeployedFlow {
+    flowId: string;
+    flow?: Workflow;
+    deployed?: boolean;
+}
+export interface WorkflowList extends Omit<WorkflowBase, 'resources'>, ResponseBase {
+    type?: 'cloud';
+    author: {
+        id: string;
+        name: string;
+        email: string;
+    } | Record<string, never>;
+}
+export interface WorkflowRevision {
+    id: string;
+    version: number;
+    authorName: string;
+    createdBy: string;
+    dateCreated: number;
+    description: string;
+    selected?: boolean;
+}
+export interface ManifestResource {
+    path: string;
+    provider: string;
+    runtime: string;
+    options: string[];
+}
+export interface ManifestArgument {
+    default?: string;
+    description?: string;
+    type: string;
+}
+export interface Manifest {
+    main: [string, string];
+    signals?: {
+        main: {
+            args: string[];
+            entry: [string, string];
+        };
+    };
+    arguments?: unknown | Record<string, ManifestArgument>;
+    resources: ManifestResource[];
+    mode?: 'cloud';
+}
+export interface CreateAssetResponse {
+    id: string;
+    name: string;
+    path: string;
+    dateCreated: number;
+    hash: string;
+    postContentLink: string;
+    type: 'file';
+    workflow: string;
+}
+export {};

package/esm/node/RocosSDKNode.d.ts

@@ -0,0 +1,47 @@
+import { EvaluatorService } from '../services';
+import { IBaseService, ServiceEnum } from '../models';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+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 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;
+    /**
+     * Gets the evaluator service
+     * @deprecated Not supported in Node.js
+     */
+    getEvaluatorService(): EvaluatorService;
+    /**
+     * Gets the WebRTC service
+     * @deprecated Not supported in Node.js
+     */
+    getRTPWebRTCService(): never;
+}

package/esm/node/RocosSDKNode.js

@@ -0,0 +1,143 @@
+import { AssetStorageService, AuthService, ConfigGroupService, DashboardService, DeviceCredentialsService, EventService, IntegrationService, MapService, ProfileService, ProjectService, RobotService, ScheduleService, SpotProvisioningServiceNode, StreamService, TargetService, UserService, } from '../services';
+import { ServiceEnum } from '../models';
+import { CallerServiceNode } from '../services/CallerServiceNode';
+import { CommandServiceNode } from '../services/CommandServiceNode';
+import { ControlServiceNode } from '../services/ControlServiceNode';
+import { FileAccessorServiceNode } from '../services/FileAccessorServiceNode';
+import { RocosSDK } from '../RocosSDK';
+import { SearchServiceNode } from '../services/SearchServiceNode';
+import { TelemetryServiceNode } from '../services/TelemetryServiceNode';
+import { WorkflowServiceNode } from '../services/WorkflowServiceNode';
+export class RocosSDKNode extends RocosSDK {
+    // eslint-disable-next-line max-lines-per-function
+    getService(name) {
+        if (!this.services?.[name]) {
+            this.logger.info(`Service ${name} does not exist, creating it now.`);
+            const config = this.overrideConfig(name);
+            switch (name) {
+                case ServiceEnum.AUTH:
+                    this.services[name] = new AuthService(config);
+                    break;
+                case ServiceEnum.TELEMETRY:
+                    this.services[name] = new TelemetryServiceNode(config);
+                    break;
+                case ServiceEnum.ROBOT:
+                    this.services[name] = new RobotService(config);
+                    break;
+                case ServiceEnum.EVENT:
+                    this.services[name] = new EventService(config);
+                    break;
+                case ServiceEnum.PROJECT:
+                    this.services[name] = new ProjectService(config);
+                    break;
+                case ServiceEnum.CALLER:
+                    this.services[name] = new CallerServiceNode(config);
+                    break;
+                case ServiceEnum.COMMAND:
+                    this.services[name] = new CommandServiceNode(config);
+                    break;
+                case ServiceEnum.CONTROL:
+                    this.services[name] = new ControlServiceNode(config);
+                    break;
+                case ServiceEnum.SEARCH:
+                    this.services[name] = new SearchServiceNode(config);
+                    break;
+                case ServiceEnum.CONFIG_GROUP:
+                    this.services[name] = new ConfigGroupService(config);
+                    break;
+                case ServiceEnum.DASHBOARD:
+                    this.services[name] = new DashboardService(config);
+                    break;
+                case ServiceEnum.STREAM:
+                    this.services[name] = new StreamService(config);
+                    break;
+                case ServiceEnum.USER:
+                    this.services[name] = new UserService(config);
+                    break;
+                case ServiceEnum.WORKFLOW:
+                    this.services[name] = new WorkflowServiceNode(config);
+                    break;
+                case ServiceEnum.ASSET_STORAGE:
+                    this.services[name] = new AssetStorageService(config);
+                    break;
+                case ServiceEnum.PROFILE:
+                    this.services[name] = new ProfileService(config);
+                    break;
+                case ServiceEnum.FILE_ACCESSOR:
+                    this.services[name] = new FileAccessorServiceNode(config);
+                    break;
+                case ServiceEnum.SPOT_PROVISIONER:
+                    this.services[name] = new SpotProvisioningServiceNode(config);
+                    break;
+                case ServiceEnum.SCHEDULE:
+                    this.services[name] = new ScheduleService(config);
+                    break;
+                case ServiceEnum.INTEGRATION:
+                    this.services[name] = new IntegrationService(config);
+                    break;
+                case ServiceEnum.MAP:
+                    this.services[name] = new MapService(config);
+                    break;
+                case ServiceEnum.DEVICE_CREDENTIALS:
+                    this.services[name] = new DeviceCredentialsService(config);
+                    break;
+                case ServiceEnum.TARGET:
+                    this.services[name] = new TargetService(config);
+                    break;
+            }
+        }
+        this.logger.debug(`Found service ${name}.`);
+        return this.services[name];
+    }
+    /**
+     * Gets the telemetry service.
+     */
+    getTelemetryService() {
+        return this.getService(ServiceEnum.TELEMETRY);
+    }
+    /**
+     * Gets the service call service.
+     */
+    getCallerService() {
+        return this.getService(ServiceEnum.CALLER);
+    }
+    /**
+     * Gets the command service.
+     */
+    getCommandService() {
+        return this.getService(ServiceEnum.COMMAND);
+    }
+    /**
+     * Gets the robot control service.
+     */
+    getControlService() {
+        return this.getService(ServiceEnum.CONTROL);
+    }
+    /**
+     * Gets the search service.
+     */
+    getSearchService() {
+        return this.getService(ServiceEnum.SEARCH);
+    }
+    /**
+     * Gets the file accessor service
+     * @returns FileAccessorServiceNode
+     */
+    getFileAccessorService() {
+        return this.getService(ServiceEnum.FILE_ACCESSOR);
+    }
+    /**
+     * Gets the evaluator service
+     * @deprecated Not supported in Node.js
+     */
+    getEvaluatorService() {
+        throw new Error('Evaluator service is not supported in NodeJS');
+    }
+    /**
+     * Gets the WebRTC service
+     * @deprecated Not supported in Node.js
+     */
+    getRTPWebRTCService() {
+        throw new Error('WebRTC service is not supported in NodeJS');
+    }
+}

package/esm/node/index.js

@@ -0,0 +1,7 @@
+export * from './RocosSDKNode';
+export * from '../services/CallerServiceNode';
+export * from '../services/CommandServiceNode';
+export * from '../services/ControlServiceNode';
+export * from '../services/FileAccessorServiceNode';
+export * from '../services/SearchServiceNode';
+export * from '../services/TelemetryServiceNode';