@formant/data-sdk 0.0.64 → 0.0.67

package/dist/types/data-sdk/src/App.d.ts

@@ -1,3 +1,44 @@
+export declare type AppMessage = {
+    type: "go_to_time";
+    time: number;
+} | {
+    type: "request_module_data";
+    module: string;
+} | {
+    type: "show_message";
+    message: string;
+} | {
+    type: "refresh_auth_token";
+    module: string;
+} | {
+    type: "set_module_data_time_range";
+    module: string;
+    before: number;
+    after: number;
+} | {
+    type: "setup_module_menus";
+    module: string;
+    menus: {
+        label: string;
+    }[];
+};
+export declare type EmbeddedAppMessage = {
+    type: "module_menu_item_clicked";
+    menu: string;
+} | {
+    type: "auth_token";
+    token: string;
+} | {
+    type: "module_data";
+    streams: {
+        [x: string]: any;
+    };
+    time: number;
+    queryRange: {
+        start: number;
+        end: number;
+    };
+};
 export interface ModuleData {
     queryRange: QueryRange;
     time: number;

package/dist/types/data-sdk/src/DataChannel.d.ts

@@ -1,5 +1,5 @@
-declare type DataChannelStringListener = (message: string) => void;
-declare type DataChannelBinaryListener = (message: Uint8Array) => void;
+export declare type DataChannelStringListener = (message: string) => void;
+export declare type DataChannelBinaryListener = (message: Uint8Array) => void;
 export declare class DataChannel {
     private dataChannel;
     ready: boolean;
@@ -16,4 +16,3 @@ export declare class DataChannel {
     addBinaryListener(listener: DataChannelBinaryListener): void;
     removeBinaryListener(listener: DataChannelBinaryListener): void;
 }
-export {};

package/dist/types/data-sdk/src/Device.d.ts

@@ -3,6 +3,9 @@ import { DataChannel } from "./DataChannel";
 import { CaptureStream } from "./CaptureStream";
 import { Manipulator } from "./Manipulator";
 import { TextRequestDataChannel, BinaryRequestDataChannel } from "./RequestDataChannel";
+import { InterventionType } from "./main";
+import { IInterventionTypeMap } from "./main";
+import { IInterventionResponse } from "./main";
 export interface ConfigurationDocument {
     urdfFiles: string[];
     telemetry?: {
@@ -87,4 +90,8 @@ export declare class Device {
         [key in string]: string[];
     }): Promise<import("./Fleet").TelemetryResult[]>;
     getTelemetryStreams(): Promise<TelemetryStream[]>;
+    createInterventionRequest<T extends InterventionType>(message: string, interventionType: InterventionType, interventionRequest: IInterventionTypeMap[T]["request"], tags?: {
+        [key in string]: string[];
+    }): Promise<(id: string) => IInterventionTypeMap[T]["response"]>;
+    addInterventionResponse<T extends InterventionType>(interventionId: string, interventionType: InterventionType, data: IInterventionTypeMap[T]["response"]): Promise<IInterventionResponse>;
 }

package/dist/types/data-sdk/src/Fleet.d.ts

@@ -4,13 +4,6 @@ import { IEventQuery } from "./model/IEventQuery";
 import { IEvent } from "./model/IEvent";
 import { IQuery } from "./model/IQuery";
 import { IStreamData } from "./model/IStreamData";
-export interface User {
-    firstName: string;
-    lastName: string;
-    email: string;
-    organizationId: string;
-    id: string;
-}
 export interface TelemetryResult {
     deviceId: string;
     name: string;
@@ -38,6 +31,7 @@ export declare class Fleet {
         [key in string]: string[];
     }): Promise<TelemetryResult[]>;
     static getFileUrl(uuid: string): Promise<string>;
-    static queryTelemetry(query: IQuery): Promise<IStreamData<keyof import("./model/IStreamTypeMap").IStreamTypeMap>[]>;
+    static queryTelemetry(query: IQuery): Promise<IStreamData<keyof import("./main").IStreamTypeMap>[]>;
     static queryEvents(query: IEventQuery): Promise<IEvent[]>;
+    static getInterventions(): Promise<IEvent[]>;
 }

package/dist/types/data-sdk/src/main.d.ts

@@ -1,4 +1,4 @@
-export { Fleet } from "./Fleet";
+export * from "./Fleet";
 export * from "./Authentication";
 export * from "./Device";
 export * from "./DataChannel";
@@ -7,3 +7,97 @@ export * from "./Manipulator";
 export * from "./RequestDataChannel";
 export * from "./App";
 export * from "./KeyValue";
+export * from "./model/accessLevels";
+export * from "./model/AccessLevel";
+export * from "./model/aggregateLevels";
+export * from "./model/AggregateLevel";
+export * from "./model/AnnotationAreaType";
+export * from "./model/annotationTypes";
+export * from "./model/AnnotationType";
+export * from "./model/EventSortableColumn";
+export * from "./model/eventTypes";
+export * from "./model/EventType";
+export * from "./model/healthStatuses";
+export * from "./model/HealthStatus";
+export * from "./model/HexRgbColor";
+export * from "./model/IAnnotationAreaTypeMap";
+export * from "./model/IAnnotation";
+export * from "./model/IBaseEntity";
+export * from "./model/IBaseEvent";
+export * from "./model/IBattery";
+export * from "./model/IBitset";
+export * from "./model/IBoundingBox";
+export * from "./model/ICommandDeliveryEvent";
+export * from "./model/ICommandEventBase";
+export * from "./model/ICommandParameter";
+export * from "./model/ICommandRequestEvent";
+export * from "./model/ICommandRequest";
+export * from "./model/ICommandResponseEvent";
+export * from "./model/ICommandResponse";
+export * from "./model/IComment";
+export * from "./model/IConfigurationMap";
+export * from "./model/ICustomEvent";
+export * from "./model/IDataPoint";
+export * from "./model/IEventFilter";
+export * from "./model/IEventQuery";
+export * from "./model/IEventSort";
+export * from "./model/IEvent";
+export * from "./model/IFieldParametersTypeMap";
+export * from "./model/IFileInfo";
+export * from "./model/IFile";
+export * from "./model/IFilter";
+export * from "./model/IGoalID";
+export * from "./model/IGoal";
+export * from "./model/IHealth";
+export * from "./model/IImageAnnotation";
+export * from "./model/IImage";
+export * from "./model/IInterventionRequest";
+export * from "./model/IInterventionResponse";
+export * from "./model/IInterventionTypeMap";
+export * from "./model/ILabeledPolygon";
+export * from "./model/ILabelingRequestData";
+export * from "./model/ILabelingResponseData";
+export * from "./model/ILabel";
+export * from "./model/ILocalization";
+export * from "./model/ILocation";
+export * from "./model/IMap";
+export * from "./model/interventionTypes";
+export * from "./model/InterventionType";
+export * from "./model/INumericSetEntry";
+export * from "./model/IOdometry";
+export * from "./model/IPath";
+export * from "./model/IPointCloud";
+export * from "./model/IPortForwardingSessionRecord";
+export * from "./model/IQuaternion";
+export * from "./model/IQuery";
+export * from "./model/IRtcSessionRecord";
+export * from "./model/ISelectionRequestData";
+export * from "./model/ISelectionResponseData";
+export * from "./model/ISheetParameters";
+export * from "./model/IsoDate";
+export * from "./model/ISpreadsheetIdRange";
+export * from "./model/IStreamData";
+export * from "./model/IStreamTypeMap";
+export * from "./model/ISystemEvent";
+export * from "./model/ITaggedUsers";
+export * from "./model/ITagParameters";
+export * from "./model/ITagSets";
+export * from "./model/ITags";
+export * from "./model/ITeleopRequestData";
+export * from "./model/ITeleopResponseData";
+export * from "./model/ITeleopSessionRecord";
+export * from "./model/ITransformNode";
+export * from "./model/ITransform";
+export * from "./model/ITriggeredEvent";
+export * from "./model/ITwist";
+export * from "./model/IUserParameters";
+export * from "./model/IVector3";
+export * from "./model/IVideo";
+export * from "./model/severities";
+export * from "./model/Severity";
+export * from "./model/SortOrder";
+export * from "./model/StreamType";
+export * from "./model/Timestamp";
+export * from "./model/Uuid";
+export * from "./model/videoMimeTypes";
+export * from "./model/VideoMimeType";

package/dist/types/data-sdk/src/model/AccessLevel.d.ts

@@ -0,0 +1,5 @@
+import { accessLevels } from "./accessLevels";
+export declare type AccessLevel = typeof accessLevels[number];
+export declare const viewer: "viewer" | "operator" | "administrator";
+export declare const operator: "viewer" | "operator" | "administrator";
+export declare const administrator: "viewer" | "operator" | "administrator";

package/dist/types/data-sdk/src/model/AnnotationType.d.ts

@@ -0,0 +1,2 @@
+import { IFieldParametersTypeMap } from "./IFieldParametersTypeMap";
+export declare type AnnotationType = keyof IFieldParametersTypeMap;

package/dist/types/data-sdk/src/model/ICommandParameter.d.ts

@@ -0,0 +1,9 @@
+import { IConfigurationMap } from "./IConfigurationMap";
+import { IFileInfo } from "./IFileInfo";
+import { IsoDate } from "./IsoDate";
+export interface ICommandParameter {
+    value?: string;
+    meta?: IConfigurationMap;
+    scrubberTime: IsoDate;
+    files?: IFileInfo[];
+}

package/dist/types/data-sdk/src/model/ICommandRequest.d.ts

@@ -0,0 +1,9 @@
+import { ICommandParameter } from "./ICommandParameter";
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface ICommandRequest {
+    id: Uuid;
+    command: string;
+    parameter: ICommandParameter;
+    createdAt: IsoDate;
+}

package/dist/types/data-sdk/src/model/ICommandResponse.d.ts

@@ -0,0 +1,13 @@
+import { IsoDate } from "./IsoDate";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface ICommandResponse {
+    time: IsoDate;
+    message: string;
+    success: boolean;
+    replyToCommandRequestId: Uuid;
+    streamName?: string;
+    streamType?: StreamType;
+    tags?: ITags;
+}

package/dist/types/data-sdk/src/model/IConfigurationMap.d.ts

@@ -0,0 +1,3 @@
+export interface IConfigurationMap {
+    [key: string]: string;
+}

package/dist/types/data-sdk/src/model/IFieldParametersTypeMap.d.ts

@@ -0,0 +1,8 @@
+import { ISheetParameters } from "./ISheetParameters";
+import { ITagParameters } from "./ITagParameters";
+import { IUserParameters } from "./IUserParameters";
+export interface IFieldParametersTypeMap {
+    tag: ITagParameters;
+    sheet: ISheetParameters;
+    user: IUserParameters;
+}

package/dist/types/data-sdk/src/model/IFileInfo.d.ts

@@ -0,0 +1,6 @@
+import { Uuid } from "./Uuid";
+export interface IFileInfo {
+    id: Uuid;
+    name?: string;
+    url?: string;
+}

package/dist/types/data-sdk/src/model/IGoalID.d.ts

@@ -0,0 +1,3 @@
+export interface IGoalID {
+    id?: string;
+}

package/dist/types/data-sdk/src/model/ISheetParameters.d.ts

@@ -0,0 +1,5 @@
+export interface ISheetParameters {
+    url?: string;
+    spreadsheetId: string;
+    range: string;
+}

package/dist/types/data-sdk/src/model/ITagParameters.d.ts

@@ -0,0 +1,3 @@
+export interface ITagParameters {
+    choices: string[];
+}

package/dist/types/data-sdk/src/model/IUserParameters.d.ts

@@ -0,0 +1,4 @@
+import { AccessLevel } from "./AccessLevel";
+export interface IUserParameters {
+    roles?: AccessLevel[];
+}

package/dist/types/data-sdk/src/model/accessLevels.d.ts

@@ -0,0 +1 @@
+export declare const accessLevels: readonly ["viewer", "operator", "administrator"];

package/dist/types/data-sdk/src/model/aggregateLevels.d.ts

@@ -0,0 +1,2 @@
+import { AggregateLevel } from "./AggregateLevel";
+export declare const aggregateLevels: AggregateLevel[];

package/dist/types/data-sdk/src/model/annotationTypes.d.ts

@@ -0,0 +1 @@
+export declare const annotationTypes: string[];

package/dist/types/data-sdk/src/model/interventionTypes.d.ts

@@ -0,0 +1 @@
+export declare const interventionTypes: string[];

package/package.json

@@ -18,22 +18,22 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.64",
+  "version": "0.0.67",
   "scripts": {
     "dev": "vite --port 9146",
     "build": "tsc && vite build",
     "serve": "vite preview",
     "types": "tsc src/*.ts --lib ESNext,DOM --declaration --emitDeclarationOnly --downlevelIteration --outDir dist/types",
-    "docs": "typedoc src/main.ts --theme minimal --out ../../docs/data-sdk/"
+    "docs": "typedoc src/main.ts --theme default --out ../../docs/data-sdk/"
   },
   "devDependencies": {
-    "typedoc": "^0.21.9",
     "typescript": "^4.3.2",
     "vite": "^2.5.4"
   },
   "types": "./dist/types/data-sdk/src/main.d.ts",
   "dependencies": {
+    "@formant/realtime-sdk": "0.0.7",
     "@types/google-protobuf": "^3.15.5",
-    "@formant/realtime-sdk": "0.0.7"
+    "typedoc": "^0.22.13"
   }
 }