@formant/data-sdk 0.0.147 → 1.0.0-rc.1

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

@@ -48,6 +48,8 @@ export type AppMessage = {
     data: any;
 } | {
     type: "request_devices";
+} | {
+    type: "formant_online";
 };
 export type ModuleConfigurationMessage = {
     type: "module_configuration";
@@ -85,6 +87,9 @@ export type EmbeddedAppMessage = {
     type: "prompt_response";
     promptId: string;
     data: any;
+} | {
+    type: "formant_online";
+    online: boolean;
 } | ModuleConfigurationMessage;
 export interface ModuleData {
     queryRange: QueryRange;
@@ -144,4 +149,10 @@ export declare class App {
         cancelText?: string;
     }): Promise<any>;
     static getDate(minTime?: Date, maxTime?: Date): Promise<unknown>;
+    private static _isOnline;
+    private static _handleOnlineEvent;
+    static get isOnline(): boolean | null;
+    static listenForConnectionEvents(): void;
+    static checkConnection(deadlineMs?: number): Promise<boolean>;
+    static waitForConnection(deadlineMs?: number): Promise<void>;
 }

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

@@ -1,19 +1,24 @@
 /// <reference types="node" />
+import { EventEmitter } from "events";
 import { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, RtcClient, RtcClientV1 } from "@formant/realtime-sdk";
+import { RtcStreamType } from "@formant/realtime-sdk/dist/model/RtcStreamType";
+import { IRtcPeer } from "@formant/realtime-sdk/dist/model/IRtcPeer";
 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";
-import { RtcStreamType } from "@formant/realtime-sdk/dist/model/RtcStreamType";
-import { IEventQuery } from "./main";
-import { AggregateLevel } from "./main";
-import { EventType } from "./main";
+import { Uuid } from "./model/Uuid";
+import { InterventionType } from "./model/InterventionType";
+import { IInterventionTypeMap } from "./model/IInterventionTypeMap";
+import { IInterventionResponse } from "./model/IInterventionResponse";
+import { IEventQuery } from "./model/IEventQuery";
+import { AggregateLevel } from "./model/AggregateLevel";
+import { EventType } from "./model/EventType";
 import { IShare } from "./model/IShare";
-import { EventEmitter } from "events";
 export interface ConfigurationDocument {
+    tags: {
+        [key: string]: string;
+    };
     urdfFiles: string[];
     telemetry?: {
         streams?: {
@@ -37,6 +42,7 @@ export interface ConfigurationDocument {
             topicType: string;
         }[];
     };
+    adapters?: IAdapterConfiguration[];
 }
 export interface Command {
     id: string;
@@ -59,6 +65,13 @@ export interface TelemetryStream {
     name: string;
     onDemand: boolean;
 }
+export interface IAdapterConfiguration {
+    id: Uuid;
+    name: string;
+    fileId: Uuid;
+    execCommand: string;
+    configuration?: string;
+}
 export type RealtimeMessage = {
     header: {
         created: number;
@@ -97,7 +110,7 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
     name: string;
     private organizationId;
     rtcClient: RtcClient | RtcClientV1 | undefined;
-    remoteDevicePeerId: string | undefined;
+    remoteDevicePeerId: string | null;
     realtimeListeners: RealtimeListener[];
     private connectionMonitorInterval;
     constructor(id: string, name: string, organizationId: string);
@@ -107,7 +120,15 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
     private handleMessage;
     getRealtimeStatus(): "disconnected" | "connecting" | "connected";
     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.
+     * @throws `Error`  If the connection could not be established or if a connection already exists.
+     * @returns {void}
+     */
     startRealtimeConnection(sessionType?: number): Promise<void>;
+    private getRemoteDevicePeerId;
+    private createSession;
     private initConnectionMonitoring;
     private isV2Signaling;
     private stopConnectionMonitoring;
@@ -124,7 +145,7 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
     enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
     changeStreamAudioType(streamName: string, newFormat: "wav" | "opus"): Promise<void>;
     disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>;
-    getRemotePeer(): Promise<import("@formant/realtime-sdk/dist/model/IRtcPeer").IRtcPeer>;
+    getRemotePeer(): Promise<IRtcPeer>;
     stopRealtimeConnection(): Promise<void>;
     isInRealtimeSession(): Promise<boolean>;
     getAvailableCommands(): Promise<Command[]>;
@@ -156,4 +177,5 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
         events: import("./main").IEvent[];
     }[]>;
     createShareLink(share: IShare, view: string): Promise<string | null>;
+    private getRemotePeerId;
 }

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

@@ -9,7 +9,7 @@ import { PeerDevice } from "./PeerDevice";
 import { IDeviceQuery } from "./model/IDeviceQuery";
 import { IStream } from "./model/IStream";
 import { IView } from "./model/IView";
-import { EventType, AggregateLevel, IShare } from "./main";
+import { EventType, AggregateLevel, IShare, IStreamTypeMap, IStreamCurrentValue } from "./main";
 import { IAnalyticsModule } from "./model/IAnalyticsModule";
 import { IStreamColumn } from "./model/IStreamColumn";
 import { ITaskReportColumn } from "./model/ITaskReportColumn";
@@ -39,13 +39,13 @@ export declare class Fleet {
         [key in string]: string[];
     }>;
     static getRealtimeDevices(): Promise<Device[]>;
-    static getLatestTelemetry(deviceIdOrDeviceIds?: string | string[]): Promise<any>;
+    static getLatestTelemetry(...ids: (string | string[])[]): Promise<IStreamCurrentValue<keyof IStreamTypeMap>[]>;
     static getTelemetry(deviceIdOrDeviceIds: string | string[], streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {
         [key in string]: string[];
     }): Promise<TelemetryResult[]>;
     static getFileUrl(uuid: string): Promise<string>;
-    static queryTelemetry(query: IQuery): Promise<IStreamData<keyof import("./main").IStreamTypeMap>[]>;
-    static aggregateTelemetry(query: IQuery): Promise<IStreamAggregateData<keyof import("./main").IStreamTypeMap>[]>;
+    static queryTelemetry(query: IQuery): Promise<IStreamData<keyof IStreamTypeMap>[]>;
+    static aggregateTelemetry(query: IQuery): Promise<IStreamAggregateData<keyof IStreamTypeMap>[]>;
     static queryEvents(query: IEventQuery): Promise<IEvent[]>;
     static getEvent(uuid: string): Promise<IEvent>;
     static getInterventions(): Promise<IEvent[]>;

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

@@ -2,3 +2,4 @@ export * from "./aggregateFunctionUtils";
 export * from "./numericAggregateUtils";
 export * from "./timeout";
 export * from "./serializeHash";
+export * from "./isRtcPeer";

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

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

package/package.json

@@ -24,9 +24,10 @@
       }
     }
   },
-  "version": "0.0.147",
+  "version": "1.0.0-rc.1",
   "scripts": {
-    "dev": "vite --port 9146",
+    "preversion": "make",
+    "dev": "vite --port 5173",
     "build": "tsc && vite build",
     "serve": "vite preview",
     "test": "concurrently --kill-others-on-fail npm:test:*",