@formant/data-sdk 1.0.0-rc.2 → 1.0.0

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

@@ -9,6 +9,7 @@ export type AppMessage = {
     type: "request_date";
     minTime?: Date;
     maxTime?: Date;
+    time?: Date;
 } | {
     type: "go_to_time";
     time: number;
@@ -150,7 +151,7 @@ export declare class App {
         okText?: string;
         cancelText?: string;
     }): Promise<any>;
-    static getDate(minTime?: Date, maxTime?: Date): Promise<unknown>;
+    static getDate(time?: Date, minTime?: Date, maxTime?: Date): Promise<unknown>;
     static disableAnalyticsBottomBar(): Promise<void>;
     private static _isOnline;
     private static _handleOnlineEvent;

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

@@ -0,0 +1,20 @@
+import { RtcClient, RtcClientV1 } from "@formant/realtime-sdk";
+import { SessionType } from "./model/SessionType";
+import { RtcClientPool } from "./utils/RtcClientPool";
+export declare const AppRtcClientPools: {
+    readonly unknown: RtcClientPool<RtcClient>;
+    readonly teleop: RtcClientPool<RtcClient>;
+    readonly portForward: RtcClientPool<RtcClient>;
+    readonly observe: RtcClientPool<RtcClient>;
+    readonly 0: RtcClientPool<RtcClient>;
+    readonly 1: RtcClientPool<RtcClient>;
+    readonly 2: RtcClientPool<RtcClient>;
+    readonly 3: RtcClientPool<RtcClient>;
+};
+export declare const defaultRtcClientPool: RtcClientPool<RtcClient>;
+export declare const v1RtcClientPool: RtcClientPool<RtcClientV1>;
+export declare const getRtcClientPool: (options: {
+    version: string;
+    sessionType?: SessionType;
+}) => RtcClientPool<RtcClient> | RtcClientPool<RtcClientV1>;
+export declare function debug(): void;

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

@@ -15,10 +15,10 @@ import { IEventQuery } from "./model/IEventQuery";
 import { AggregateLevel } from "./model/AggregateLevel";
 import { EventType } from "./model/EventType";
 import { IShare } from "./model/IShare";
+import { ITags } from "./model/ITags";
+import { SessionType } from "./model/SessionType";
 export interface ConfigurationDocument {
-    tags: {
-        [key: string]: string;
-    };
+    tags: ITags;
     urdfFiles: string[];
     telemetry?: {
         streams?: {
@@ -93,10 +93,11 @@ export type RealtimeVideoStream = {
 export type RealtimeDataStream = {
     name: string;
 };
-export declare const SessionType: {
-    Teleop: number;
-    Observe: number;
-};
+interface IStartRealtimeConnectionOptions {
+    sessionType?: SessionType;
+    deadlineMs?: number;
+    maxConnectRetries?: number;
+}
 export interface IRealtimeDevice {
     startRealtimeConnection(sessionType?: number): Promise<void>;
     startListeningToRealtimeDataStream(stream: RealtimeDataStream): Promise<void>;
@@ -122,13 +123,12 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
     getRealtimePing(): number | undefined;
     /**
      * Starts a real-time connection with the remote device using WebRTC.
-     * @param {number} [sessionType] - Optional session type to be used for the connection.
+     * @param {number} [options] - Optional session type to be used for the connection.
      * @throws `Error`  If the connection could not be established or if a connection already exists.
      * @returns {void}
      */
-    startRealtimeConnection(sessionType?: number): Promise<void>;
+    startRealtimeConnection(options?: SessionType | IStartRealtimeConnectionOptions): Promise<void>;
     private getRemoteDevicePeerId;
-    private createSession;
     private initConnectionMonitoring;
     private isV2Signaling;
     private stopConnectionMonitoring;
@@ -179,3 +179,4 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
     createShareLink(share: IShare, view: string): Promise<string | null>;
     private getRemotePeerId;
 }
+export {};

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

@@ -1,20 +1,24 @@
 import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
 import { Device } from "./Device";
+import { AggregateLevel } from "./model/AggregateLevel";
+import { EventType } from "./model/EventType";
+import { IAnalyticsModule } from "./model/IAnalyticsModule";
+import { IDeviceQuery } from "./model/IDeviceQuery";
 import { IEvent } from "./model/IEvent";
 import { IEventQuery } from "./model/IEventQuery";
 import { IQuery } from "./model/IQuery";
-import { IStreamAggregateData } from "./model/IStreamAggregateData";
-import { IStreamData } from "./model/IStreamData";
-import { PeerDevice } from "./PeerDevice";
-import { IDeviceQuery } from "./model/IDeviceQuery";
+import { IShare } from "./model/IShare";
+import { ISqlQuery } from "./model/ISqlQuery";
+import { ISqlResult } from "./model/ISqlResult";
 import { IStream } from "./model/IStream";
-import { IView } from "./model/IView";
-import { EventType, AggregateLevel, IShare, IStreamTypeMap, IStreamCurrentValue } from "./main";
-import { IAnalyticsModule } from "./model/IAnalyticsModule";
+import { IStreamAggregateData } from "./model/IStreamAggregateData";
 import { IStreamColumn } from "./model/IStreamColumn";
+import { IStreamCurrentValue } from "./model/IStreamCurrentValue";
+import { IStreamData } from "./model/IStreamData";
+import { IStreamTypeMap } from "./model/IStreamTypeMap";
 import { ITaskReportColumn } from "./model/ITaskReportColumn";
-import { ISqlQuery } from "./model/ISqlQuery";
-import { ISqlResult } from "./model/ISqlResult";
+import { IView } from "./model/IView";
+import { PeerDevice } from "./PeerDevice";
 export interface TelemetryResult {
     deviceId: string;
     name: string;

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

@@ -114,7 +114,8 @@ export * from "./model/VideoMimeType";
 export * from "./model/IDeviceQuery";
 export * from "./model/IAnnotationQuery";
 export * from "./model/IStream";
-export { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, } from "@formant/realtime-sdk";
+export { SessionTypeConstants as SessionType } from "./model/SessionType";
+export type { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, } from "@formant/realtime-sdk";
 export * from "./model/JsonSchema";
 export * from "./utils/aggregateFunctionUtils";
 export * from "./model/IStreamColumn";

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

@@ -0,0 +1,2 @@
+import { aggregateTypes } from "./aggregateTypes";
+export type AggregateType = (typeof aggregateTypes)[number];

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

@@ -0,0 +1,5 @@
+export interface IH264VideoFrame {
+    index: number;
+    flags: number;
+    frame_data: string;
+}

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

@@ -0,0 +1,8 @@
+import { ITransform } from "./ITransform";
+export interface IJointState {
+    world_to_local?: ITransform;
+    name: string[];
+    position: number[];
+    velocity?: number[];
+    effort?: number[];
+}

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

@@ -0,0 +1,27 @@
+import { IColorRGBA } from "./IColorRGBA";
+import { IQuaternion } from "./IQuaternion";
+import { IVector3 } from "./IVector3";
+export interface IMarker3D {
+    world_to_local?: {
+        position: IVector3;
+        orientation: IQuaternion;
+    };
+    ns: string;
+    id: number;
+    type: number;
+    action: number;
+    pose: {
+        position: IVector3;
+        orientation: IQuaternion;
+    };
+    scale: IVector3;
+    color: IColorRGBA;
+    lifetime: number;
+    frame_id: string;
+    frame_locked: boolean;
+    points: IVector3[];
+    colors: IColorRGBA[];
+    text: string;
+    mesh_resource: string;
+    mesh_use_embedded_materials: boolean;
+}

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

@@ -0,0 +1,4 @@
+import { IMarker3D } from "./IMarker3D";
+export interface IMarker3DArray {
+    markers: IMarker3D[];
+}

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

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IPoseWithCovariance {
+    pose: ITransform;
+    covariance: Array<number>;
+}

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

@@ -0,0 +1,5 @@
+import { ITransform } from "./ITransform";
+export interface IRtcPointCloud {
+    world_to_local?: ITransform;
+    data: string;
+}

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

@@ -0,0 +1,4 @@
+export interface IVector2 {
+    x: number;
+    y: number;
+}

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

@@ -0,0 +1,2 @@
+import { marker3DActions } from "./marker3DActions";
+export type Marker3DAction = (typeof marker3DActions)[number];

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

@@ -0,0 +1,2 @@
+import { marker3DTypes } from "./marker3DTypes";
+export type Marker3DType = (typeof marker3DTypes)[number];

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

@@ -0,0 +1,22 @@
+import { IRtcClientConfiguration } from "@formant/realtime-sdk";
+export type SessionType = NonNullable<IRtcClientConfiguration["sessionType"]>;
+export declare const SessionTypes: {
+    readonly UNKNOWN: 0;
+    readonly TELEOP: 1;
+    readonly PORT_FORWARD: 2;
+    readonly OBSERVE: 3;
+};
+export declare const SessionTypeConstants: {
+    readonly Unknown: 0;
+    readonly Teleop: 1;
+    readonly PortForward: 2;
+    readonly Observe: 3;
+    readonly unknown: 0;
+    readonly teleop: 1;
+    readonly portForward: 2;
+    readonly observe: 3;
+    readonly UNKNOWN: 0;
+    readonly TELEOP: 1;
+    readonly PORT_FORWARD: 2;
+    readonly OBSERVE: 3;
+};

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

@@ -0,0 +1 @@
+export declare const aggregateTypes: readonly ["min", "max", "standard deviation", "average", "sum", "count"];

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

@@ -0,0 +1 @@
+export declare const marker3DActions: readonly ["add", "modify", "delete", "delete_all"];

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

@@ -0,0 +1 @@
+export declare const marker3DTypes: readonly ["arrow", "cube", "sphere", "cylinder", "line_strip", "line_list", "cube_list", "sphere_list", "points", "text_view_facing", "mesh_resource", "triangle_list"];

package/dist/types/data-sdk/src/utils/RtcClientPool.d.ts

@@ -0,0 +1,25 @@
+import { RtcClient, RtcClientV1, IRtcClientConfiguration } from "@formant/realtime-sdk";
+type ReceiveFn = IRtcClientConfiguration["receive"];
+type CreateClientFn<T extends RtcClient | RtcClientV1> = (receive: ReceiveFn) => T;
+export interface IRtcClientPoolOptions<T extends RtcClient | RtcClientV1> {
+    createClient: CreateClientFn<T>;
+    ttlMs?: number;
+}
+declare const singleton: unique symbol;
+export declare class RtcClientPool<T extends RtcClient | RtcClientV1> {
+    [singleton]: T | null;
+    private readonly createClient;
+    private readonly ttlMs;
+    private readonly proxyHandler;
+    private proxyReceivers;
+    private teardownTimeout;
+    constructor(options: IRtcClientPoolOptions<T>);
+    get isActive(): boolean;
+    get size(): number;
+    get(onReceive?: ReceiveFn): T;
+    private allocate;
+    private teardown;
+    private dispatch;
+    private releaseInstance;
+}
+export {};

package/dist/types/data-sdk/src/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from "./numericAggregateUtils";
 export * from "./timeout";
 export * from "./serializeHash";
 export * from "./isRtcPeer";
+export { getRtcClientVersion } from "./rtcClientVersion";

package/dist/types/data-sdk/src/utils/isRtcPeer.d.ts

@@ -1,2 +1,2 @@
 import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
-export declare const isRtcPeer: (_: IRtcPeer | any) => _ is IRtcPeer;
+export declare const isRtcPeer: (peer: IRtcPeer | undefined) => peer is IRtcPeer;

package/dist/types/data-sdk/src/utils/rtcClientVersion.d.ts

@@ -0,0 +1,2 @@
+export declare function overrideRtcClientVersion(newVersion: string | null): void;
+export declare function getRtcClientVersion(): string | null;

package/package.json

@@ -24,18 +24,19 @@
       }
     }
   },
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0",
   "scripts": {
-    "preversion": "make",
+    "preversion": "npm run test && tsc --project ./configs/tsconfig.type-check.json",
+    "postversion": "make",
     "dev": "vite --port 5173",
-    "build": "tsc && vite build",
+    "build": "tsc -p ./configs/tsconfig.demo.json && vite build",
     "serve": "vite preview",
     "test": "concurrently --kill-others-on-fail npm:test:*",
     "test:unit": "vitest run",
     "coverage": "vitest run --coverage",
     "prettier:check": "prettier --check src/",
     "prettier:write": "prettier --write src/",
-    "types": "tsc --project ./tsconfig.types.json",
+    "types": "tsc --project ./configs/tsconfig.types.json",
     "docs": "typedoc src/main.ts --theme default --out ../../docs/data-sdk/"
   },
   "devDependencies": {