@formant/data-sdk 0.0.63 → 0.0.66

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

@@ -0,0 +1,6 @@
+import { ITransform } from "./ITransform";
+export interface IPointCloud {
+    url: string;
+    size?: number;
+    worldToLocal?: ITransform;
+}

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

@@ -0,0 +1,3 @@
+import { IRtcSessionRecord } from "./IRtcSessionRecord";
+export interface IPortForwardingSessionRecord extends IRtcSessionRecord<"port-forwarding-session-record"> {
+}

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

@@ -0,0 +1,6 @@
+export interface IQuaternion {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}

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

@@ -0,0 +1,8 @@
+import { AggregateLevel } from "./AggregateLevel";
+import { IFilter } from "./IFilter";
+import { IsoDate } from "./IsoDate";
+export interface IQuery extends IFilter {
+    aggregate?: AggregateLevel;
+    start: IsoDate;
+    end: IsoDate;
+}

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

@@ -0,0 +1,9 @@
+import { Uuid } from "./Uuid";
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+export interface IRtcSessionRecord<T extends "teleop-session-record" | "port-forwarding-session-record"> extends IBaseEvent<T> {
+    sessionId: Uuid;
+    userId: Uuid;
+    deviceId: Uuid;
+    endTime: IsoDate;
+}

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

@@ -0,0 +1,6 @@
+export interface ISelectionRequestData {
+    instruction: string;
+    imageUrl: string;
+    options: string[];
+    hint?: number;
+}

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

@@ -0,0 +1,3 @@
+export interface ISelectionResponseData {
+    value: number;
+}

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/ISpreadsheetIdRange.d.ts

@@ -0,0 +1,4 @@
+export interface ISpreadsheetIdRange {
+    spreadsheetId: string;
+    range: string;
+}

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

@@ -0,0 +1,11 @@
+import { IDataPoint } from "./IDataPoint";
+import { ITags } from "./ITags";
+import { StreamType } from "./StreamType";
+import { Uuid } from "./Uuid";
+export interface IStreamData<T extends StreamType = StreamType> {
+    deviceId: Uuid;
+    name: string;
+    type: T;
+    tags: ITags;
+    points: IDataPoint<T>[];
+}

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

@@ -0,0 +1,27 @@
+import { IBattery } from "./IBattery";
+import { IBitset } from "./IBitset";
+import { IFile } from "./IFile";
+import { IHealth } from "./IHealth";
+import { IImage } from "./IImage";
+import { ILocalization } from "./ILocalization";
+import { ILocation } from "./ILocation";
+import { INumericSetEntry } from "./INumericSetEntry";
+import { IPointCloud } from "./IPointCloud";
+import { ITransformNode } from "./ITransformNode";
+import { IVideo } from "./IVideo";
+export interface IStreamTypeMap {
+    bitset: IBitset;
+    localization: ILocalization;
+    "point cloud": IPointCloud;
+    location: ILocation;
+    file: IFile;
+    health: IHealth;
+    "transform tree": ITransformNode;
+    battery: IBattery;
+    video: IVideo;
+    "numeric set": INumericSetEntry[];
+    json: string;
+    image: IImage;
+    numeric: number;
+    text: string;
+}

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

@@ -0,0 +1,3 @@
+import { IBaseEvent } from "./IBaseEvent";
+export interface ISystemEvent extends IBaseEvent<"system"> {
+}

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/ITagSets.d.ts

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

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

@@ -0,0 +1,4 @@
+import { Uuid } from "./Uuid";
+export interface ITaggedUsers {
+    [key: string]: Uuid[];
+}

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

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

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

@@ -0,0 +1,3 @@
+export interface ITeleopRequestData {
+    instruction: string;
+}

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

@@ -0,0 +1,4 @@
+export interface ITeleopResponseData {
+    state: "inProgress" | "requestAssistance" | "success" | "failure";
+    notes?: string;
+}

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

@@ -0,0 +1,3 @@
+import { IRtcSessionRecord } from "./IRtcSessionRecord";
+export interface ITeleopSessionRecord extends IRtcSessionRecord<"teleop-session-record"> {
+}

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

@@ -0,0 +1,6 @@
+import { IQuaternion } from "./IQuaternion";
+import { IVector3 } from "./IVector3";
+export interface ITransform {
+    translation: IVector3;
+    rotation: IQuaternion;
+}

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

@@ -0,0 +1,7 @@
+import { ITransform } from "./ITransform";
+export interface ITransformNode {
+    name?: string;
+    transform?: ITransform;
+    children?: ITransformNode[];
+    url?: string;
+}

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

@@ -0,0 +1,10 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Severity } from "./Severity";
+import { Uuid } from "./Uuid";
+export interface ITriggeredEvent extends IBaseEvent<"triggered-event"> {
+    severity: Severity;
+    eventTriggerId: Uuid;
+    interval: number;
+    intervalStart?: IsoDate;
+}

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

@@ -0,0 +1,5 @@
+import { IVector3 } from "./IVector3";
+export interface ITwist {
+    linear: IVector3;
+    angular: IVector3;
+}

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/IVector3.d.ts

@@ -0,0 +1,5 @@
+export interface IVector3 {
+    x: number;
+    y: number;
+    z: number;
+}

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

@@ -0,0 +1,7 @@
+import { VideoMimeType } from "./VideoMimeType";
+export interface IVideo {
+    url: string;
+    size?: number;
+    duration: number;
+    mimeType: VideoMimeType;
+}

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

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

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

@@ -0,0 +1 @@
+export declare type IsoDate = string;

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

@@ -0,0 +1,2 @@
+import { severities } from "./severities";
+export declare type Severity = typeof severities[number];

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

@@ -0,0 +1 @@
+export declare type SortOrder = "asc" | "desc";

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

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

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

@@ -0,0 +1 @@
+export declare type Timestamp = number;

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

@@ -0,0 +1 @@
+export declare type Uuid = string;

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

@@ -0,0 +1,2 @@
+import { videoMimeTypes } from "./videoMimeTypes";
+export declare type VideoMimeType = typeof videoMimeTypes[number];

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/eventTypes.d.ts

@@ -0,0 +1 @@
+export declare const eventTypes: readonly ["triggered-event", "intervention-request", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation"];

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

@@ -0,0 +1 @@
+export declare const healthStatuses: readonly ["unknown", "operational", "offline", "error"];

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

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

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

@@ -0,0 +1 @@
+export declare const severities: readonly ["info", "warning", "error", "critical"];

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

@@ -0,0 +1 @@
+export declare const videoMimeTypes: readonly ["video/mp4"];

package/package.json

@@ -18,22 +18,22 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.63",
+  "version": "0.0.66",
   "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"
   }
 }