@formant/data-sdk 0.0.117 → 0.0.119

package/dist/types/common/duration.d.ts

@@ -0,0 +1,10 @@
+export declare const duration: {
+    readonly millisecond: 1;
+    readonly second: 1000;
+    readonly minute: number;
+    readonly hour: number;
+    readonly day: number;
+    readonly week: number;
+    readonly month: number;
+    readonly year: number;
+};

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

@@ -1,6 +1,12 @@
+import { IStreamData, StreamType } from "./main";
+import { JsonSchema } from "./model/JsonSchema";
 export type AppMessage = {
     type: "go_to_time";
     time: number;
+} | {
+    type: "prompt";
+    promptId: string;
+    schema: JsonSchema;
 } | {
     type: "go_to_device";
     deviceId: string;
@@ -58,6 +64,10 @@ export type EmbeddedAppMessage = {
     channel: string;
     source: string;
     data: any;
+} | {
+    type: "prompt_response";
+    promptId: string;
+    data: string;
 } | ModuleConfigurationMessage;
 export interface ModuleData {
     queryRange: QueryRange;
@@ -105,10 +115,12 @@ export declare class App {
     static addMenuListener(handler: (label: string) => void): void;
     static addAccessTokenRefreshListener(handler: (token: string) => void): void;
     static addModuleDataListener(handler: (data: ModuleData) => void): void;
+    static addStreamListener<T extends StreamType>(streamName: string, streamType: T, handler: (response: IStreamData<T>[] | "too much data" | undefined) => void): () => void;
     static addModuleConfigurationListener(handler: (event: ModuleConfigurationMessage) => void): void;
     static addChannelDataListener(channel: string, handler: (e: {
         source: string;
         data: any;
     }) => void): void;
     static requestOverviewDevices(handler: (data: any) => void): void;
+    static prompt(schema: JsonSchema): Promise<any>;
 }

package/dist/types/data-sdk/src/cache/StoreCache.d.ts

@@ -0,0 +1,17 @@
+export declare class StoreCache<Key, Value> {
+    private entries;
+    private metadata;
+    private capacity;
+    private timeout;
+    constructor({ capacity, timeout, }?: {
+        capacity?: number;
+        timeout?: number;
+    });
+    get(key: Key, generator?: () => Promise<Value>): Value | undefined;
+    set(key: Key, value: Value): void;
+    clear(): void;
+    clearKey(key: string): void;
+    private keyToCacheKey;
+    private deleteOldestEntry;
+    private generate;
+}

package/dist/types/data-sdk/src/cache/filterDataByTime.d.ts

@@ -0,0 +1,2 @@
+import { IStreamData } from "../model/IStreamData";
+export declare function filterDataByTime(datas: IStreamData[], start: Date, end: Date): IStreamData[];

package/dist/types/data-sdk/src/cache/filterDataByType.d.ts

@@ -0,0 +1,3 @@
+import { IStreamData } from "../model/IStreamData";
+import { StreamType } from "../model/StreamType";
+export declare function filterDataByType<T extends StreamType>(datas: IStreamData[], type: T): IStreamData<T>[];

package/dist/types/data-sdk/src/cache/queryStore.d.ts

@@ -0,0 +1,11 @@
+import { IStreamData } from "../model/IStreamData";
+import { StreamType } from "../model/StreamType";
+import { IFilter } from "../model/IFilter";
+export declare class QueryStore {
+    private queryStoreCache;
+    private liveQueryStoreCache;
+    moduleQuery<T extends StreamType>(filter: IFilter, name: string, type: T, start: Date, end: Date, latestOnly?: boolean): IStreamData<T>[] | "too much data" | undefined;
+    query(filter: IFilter, start: Date, end: Date, latestOnly?: boolean): IStreamData[] | "too much data" | undefined;
+    private queryCache;
+    private liveQueryCache;
+}

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

@@ -111,4 +111,6 @@ export * from "./model/Timestamp";
 export * from "./model/Uuid";
 export * from "./model/videoMimeTypes";
 export * from "./model/VideoMimeType";
+export * from "./model/IDeviceQuery";
 export { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, } from "@formant/realtime-sdk";
+export * from "./model/JsonSchema";

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

@@ -0,0 +1,38 @@
+import { StreamType } from "./StreamType";
+export type FieldType = "string" | "integer" | "number" | "array" | "object" | "bool" | "boolean" | "$formant.stream";
+export interface IJsonBaseSchema<T extends FieldType> {
+    title: string;
+    description: string;
+    type: T;
+    default?: string;
+    required?: string[];
+    $schema?: string;
+    "$formant.visible.when"?: [string, "=", string];
+}
+export interface IPropertyObject {
+    [key: string]: JsonSchema;
+}
+export interface IJsonObjectSchema extends IJsonBaseSchema<"object"> {
+    items: IPropertyObject;
+    properties: IPropertyObject;
+    "$formant.documentationUrl"?: string;
+}
+export interface IJsonArraySchema extends IJsonBaseSchema<"array"> {
+    items: {
+        type: "integer" | "number" | "string" | "object";
+        properties: IPropertyObject;
+        required?: string[];
+        "$formant.itemName"?: string;
+    };
+}
+export interface IJsonStringSchema extends IJsonBaseSchema<"string"> {
+    enum?: string[];
+    "$formant.streams.byType"?: StreamType;
+    "$formant.placeholder"?: string;
+    "$formant.groups": boolean;
+    "$formant.date": boolean;
+}
+export type IJsonBooleanSchema = IJsonBaseSchema<"boolean">;
+export type IJsonIntegerSchema = IJsonBaseSchema<"integer">;
+export type IJsonNumberSchema = IJsonBaseSchema<"number">;
+export type JsonSchema = IJsonObjectSchema | IJsonStringSchema | IJsonArraySchema | IJsonBooleanSchema | IJsonIntegerSchema | IJsonNumberSchema;

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

@@ -1,5 +1,5 @@
 import { INumericAggregate, IStreamAggregateData, IStreamTypeMap } from "../main";
-type WireINumericSetAggregateMap = {
+export type WireINumericSetAggregateMap = {
     [id: string]: {
         value: INumericAggregate;
         unit?: string;
@@ -22,4 +22,3 @@ export declare function reduceNumericStreamAggregates(stream: IStreamAggregateDa
 export declare function reduceNumericSetStreamAggregates(stream: IStreamAggregateData<keyof IStreamTypeMap>, numericSetKey: string): INumericAggregate;
 export declare function combineNumericAggregates(e1: INumericAggregate, e2: INumericAggregate): INumericAggregate;
 export declare function combineNumericSetAggregates(e1: WireINumericSetAggregateMap, e2: WireINumericSetAggregateMap): WireINumericSetAggregateMap;
-export {};

package/package.json

@@ -18,7 +18,7 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.117",
+  "version": "0.0.119",
   "scripts": {
     "dev": "vite --port 9146",
     "build": "tsc && vite build",
@@ -27,12 +27,13 @@
     "docs": "typedoc src/main.ts --theme default --out ../../docs/data-sdk/"
   },
   "devDependencies": {
+    "typedoc": "^0.22.13",
     "typescript": "^4.3.2",
-    "vite": "^2.5.4",
-    "typedoc": "^0.22.13"
+    "vite": "^2.5.4"
   },
   "types": "./dist/types/data-sdk/src/main.d.ts",
   "dependencies": {
-    "@formant/realtime-sdk": "^0.0.19"
+    "@formant/realtime-sdk": "^0.0.19",
+    "date-fns": "^2.29.3"
   }
 }