@formant/data-sdk 0.0.135 → 0.0.136

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

@@ -10,6 +10,7 @@ import { RtcStreamType } from "@formant/realtime-sdk/dist/model/RtcStreamType";
 import { IEventQuery } from "./main";
 import { AggregateLevel } from "./main";
 import { EventType } from "./main";
+import { IShare } from "./model/IShare";
 export interface ConfigurationDocument {
     urdfFiles: string[];
     telemetry?: {
@@ -147,4 +148,5 @@ export declare class Device implements IRealtimeDevice {
         date: string;
         events: import("./main").IEvent[];
     }[]>;
+    createShareLink(params: IShare): Promise<any>;
 }

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

@@ -11,6 +11,11 @@ import { IStream } from "./model/IStream";
 import { IView } from "./model/IView";
 import { AggregateLevel } from "./main";
 import { EventType } from "./main";
+import { IAnalyticsModule } from "./model/IAnalyticsModule";
+import { IStreamColumn } from "./model/IStreamColumn";
+import { ITaskReportColumn } from "./model/ITaskReportColumn";
+import { ISqlQuery } from "./model/ISqlQuery";
+import { ISqlResult } from "./model/ISqlResult";
 export interface TelemetryResult {
     deviceId: string;
     name: string;
@@ -63,4 +68,117 @@ export declare class Fleet {
         date: string;
         events: IEvent[];
     }[]>;
+    static getAnalyticsModules(): Promise<IAnalyticsModule>;
+    /**
+     * retrieves a list of all available data streams that can be used for running analytics.
+     * This function takes no arguments and returns a list of stream names that can be used for analyzing data.
+     * @example
+     * // Returns
+     *  [
+     *    {
+     *      streamName:  "$.agent.health",
+            streamType :  "health"
+          },
+          {
+     *      streamName:  "up.hours",
+            streamType :  "numeric"
+          }
+        ]
+     */
+    static getAnalyticStreams(): Promise<IStreamColumn[]>;
+    /**
+     * retrieves a list of all available tables  that can be used to create task reports.
+     * This function takes no arguments and returns a list of table names that can be used for creating task reports.
+     * @returns List all available tables
+     * @example
+     * // Returns
+     *[
+     *    {
+     *       name: "",
+     *       tableName: "TASK_REPORTS_CLEANING_MODE",
+     *       columns: [
+     *                 {
+     *                    name: "TYPE",
+     *                    isNullable: true,
+     *                    dataType: "string",
+     *                    tableName: "custom"
+     *                 }
+     *                ]
+     *    }
+     *]
+     */
+    static getTaskReportTables(): Promise<ITaskReportColumn[]>;
+    /**
+     *Retrieves all stream rows
+     * @example
+     * // Body
+     * const analytics = await Fleet.queryAnalytics({
+     *     aggregateLevel: "day",
+     *     orderByColumn: "TIMESTAMP",
+     *     streamColumns: [
+     *       {
+     *         streamName: "consumables_residual_percentage",
+     *         streamType: "numeric set",
+     *       },
+     *     ],
+     *   });
+     * //Returns
+     * {
+     *    aggregates: [],
+     *    columns: [
+     *              {
+     *                name: 'TIMESTAMP',
+     *                isNullable: true,
+     *                dataType: 'string',
+     *                tableName: 'NUMERIC_SET_MAIN'
+     *               }
+     * ],
+     *    items: [
+     *              {
+     *                axisLabel: "suction_blade",
+     *                name: "consumables_residual_percentage",
+     *                tableName: "NUMERIC_SET_TEST",
+     *                time: "2020-04-20T08:00:00.000Z",
+     *                type: "numeric set",
+     *                unitLabel: "percent"
+     *                }
+     * ],
+     *    rowCount: 14,
+     *    rows: []
+     *    sqlText: "SELECT dateadd(day, dayofweek(TIMESTAMP), to_timestamp_tz('4/20/2020')) AS TIMESTAMP, SUM(VALUE)"
+     * }
+     */
+    static queryAnalytics(query: ISqlQuery): Promise<ISqlResult>;
+    /**
+     * Retrieves all rows
+     * sqlQuery is required
+     * @param query
+     * @returns
+     */
+    static getAnalyticsRows(query: ISqlQuery): Promise<any>;
+    /**
+     * @param taskColumns is required
+     * @returns
+     * All task reports
+     * @example
+     * // Body
+     * const tasks = await Fleet.getTaskReports({
+     *     taskColumns: [
+     *       {
+     *         columns: [
+     *           {
+     *             dataType: "string",
+     *             isNullable: true,
+     *             name: "TYPE",
+     *             tableName: "custom",
+     *           },
+     *         ],
+     *         name: "DURATION_SECONDS",
+     *         tableName: "TASK_REPORTS_CLEANING_MODE",
+     *         yAxis: "DURATION_SECONDS",
+     *       },
+     *     ],
+     *   });
+     */
+    static getTaskReportRows(query: ISqlQuery): Promise<any>;
 }

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

@@ -116,3 +116,16 @@ export * from "./model/IAnnotationQuery";
 export * from "./model/IStream";
 export { IRtcSendConfiguration, IRtcStreamMessage, IRtcStreamPayload, } from "@formant/realtime-sdk";
 export * from "./model/JsonSchema";
+export * from "./utils/aggregateFunctionUtils";
+export * from "./model/IStreamColumn";
+export * from "./model/IAnalyticsModule";
+export * from "./model/ITaskReportColumn";
+export * from "./model/IView";
+export * from "./model/IShare";
+export * from "./model/ISqlQuery";
+export * from "./model/IScopeFilter";
+export * from "./model/ISqlColumn";
+export * from "./model/ISqlResult";
+export * from "./model/IAnalyticsModuleConfiguration";
+export * from "./model/IAggregateRow";
+export * from "./model/ISqlRow";

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

@@ -1 +1 @@
-export type AggregateLevel = "year" | "month" | "week" | "day" | "hour" | "minute" | "quarter";
+export type AggregateLevel = "year" | "month" | "week" | "day" | "12 hours" | "4 hours" | "hour" | "30 minutes" | "5 minutes" | "minute" | "30 seconds" | "5 seconds" | "second" | "quarter";

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

@@ -0,0 +1,2 @@
+import { analyticsAggregateTypes } from "./analyticsAggregteTypes";
+export type AnalyticsAggregateType = typeof analyticsAggregateTypes[number];

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

@@ -0,0 +1,2 @@
+import { analyicsChartTypes } from "./analyticsChartTypes";
+export type AnalyticsChartType = typeof analyicsChartTypes[number];

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

@@ -0,0 +1,8 @@
+import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
+export interface IAggregateRow {
+    unit?: string;
+    label?: string;
+    name: string;
+    value: number;
+    type: AnalyticsAggregateType;
+}

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

@@ -0,0 +1,15 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { Uuid } from "./Uuid";
+import { ISqlQuery } from "./ISqlQuery";
+import { IAnalyticsModuleConfiguration } from "./IAnalyticsModuleConfiguration";
+export interface IAnalyticsModule extends IBaseEntity {
+    id?: Uuid;
+    organizationId?: Uuid;
+    name: string;
+    query: ISqlQuery | null;
+    configuration: IAnalyticsModuleConfiguration | null;
+    layout: any | null;
+    data: any[] | null;
+    streamIds: Uuid[];
+    fullscreen?: boolean;
+}

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

@@ -0,0 +1,6 @@
+import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
+import { AnalyticsChartType } from "./AnalyticsChartType";
+export interface IAnalyticsModuleConfiguration {
+    chartType?: AnalyticsChartType;
+    aggregateType?: AnalyticsAggregateType;
+}

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

@@ -0,0 +1,6 @@
+import { IFilter } from "./IFilter";
+import { IsoDate } from "./IsoDate";
+export interface IScopeFilter extends IFilter {
+    start?: IsoDate;
+    end?: IsoDate;
+}

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

@@ -0,0 +1,16 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { Uuid } from "./Uuid";
+import { IScopeFilter } from "./IScopeFilter";
+import { IsoDate } from "./IsoDate";
+export interface IShare extends IBaseEntity {
+    organizationId?: Uuid;
+    userId?: Uuid;
+    code?: string;
+    scope: IScopeFilter;
+    time: IsoDate;
+    expiration?: IsoDate | null;
+    channelId?: Uuid;
+    message?: string;
+    userName?: string;
+    delegateTeleop?: boolean;
+}

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

@@ -0,0 +1,6 @@
+export interface ISqlColumn {
+    name: string;
+    tableName: string;
+    isNullable?: boolean;
+    dataType: "string" | "timestamp" | "boolean" | "number" | "null";
+}

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

@@ -0,0 +1,21 @@
+import { IsoDate } from "./IsoDate";
+import { IFilter } from "./IFilter";
+import { AggregateLevel } from "./AggregateLevel";
+import { IStreamColumn } from "./IStreamColumn";
+import { ITaskReportColumn } from "./ITaskReportColumn";
+export interface ISqlQuery extends IFilter {
+    sqlQuery?: string;
+    parameters?: string[];
+    start?: IsoDate;
+    end?: IsoDate;
+    streamColumns?: IStreamColumn[];
+    taskColumns?: ITaskReportColumn[];
+    aggregateLevel?: AggregateLevel;
+    limit?: number;
+    orderByColumn?: string;
+    orderByDescending?: boolean;
+    visibleColumns?: string[];
+    filters?: string[];
+    type?: "stream" | "task" | "advanced";
+    unit?: string;
+}

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

@@ -0,0 +1,12 @@
+import { IAggregateRow } from "./IAggregateRow";
+import { ISqlColumn } from "./ISqlColumn";
+import { ISqlRow } from "./ISqlRow";
+export interface ISqlResult {
+    rows: ISqlRow[];
+    columns: ISqlColumn[];
+    aggregates?: IAggregateRow[];
+    sqlText: string;
+    aggregateSqlText?: string;
+    rowCount: number;
+    unit?: string;
+}

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

@@ -0,0 +1,5 @@
+import { IsoDate } from "./IsoDate";
+export interface ISqlRow {
+    [key: string]: string | IsoDate | number | boolean | null;
+    tableName: string;
+}

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

@@ -0,0 +1,7 @@
+import { StreamType } from "./StreamType";
+import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
+export interface IStreamColumn {
+    streamName: string;
+    streamType: StreamType;
+    aggregateType?: AnalyticsAggregateType;
+}

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

@@ -0,0 +1,7 @@
+import { ISqlColumn } from "./ISqlColumn";
+export interface ITaskReportColumn {
+    tableName: string;
+    columns?: ISqlColumn[];
+    name: string;
+    yAxis?: string;
+}

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

@@ -0,0 +1 @@
+export declare const analyticsAggregateTypes: readonly ["avg", "sum", "count", "min", "max"];

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

@@ -0,0 +1 @@
+export declare const analyicsChartTypes: readonly ["line", "bar", "table", "pie", "summary"];

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

@@ -1,7 +1,8 @@
 import { INumericAggregate } from "../model/INumericAggregate";
-import { AggregateLevel } from "../main";
+export declare const vailableAggregationIntervals: readonly ["day", "week", "month", "year", "hour", "minute", "quarter"];
+export type ValidAggregationInterval = typeof vailableAggregationIntervals[number];
 export type IAggregateByDateFunctions = {
-    [key in AggregateLevel]: AggregateFunction;
+    [key in ValidAggregationInterval]: AggregateFunction;
 };
 export declare const aggregateFunctions: readonly ["interval", "start", "end", "sub", "get"];
 export type AggregateFunctions = typeof aggregateFunctions[number];
@@ -23,5 +24,5 @@ export declare const aggregateFunctionMap: {
     sum: typeof getSum;
     count: typeof getCount;
 };
-export declare const aggregateByDateFunctions: IAggregateByDateFunctions;
+export declare const aggregateByDateFunctions: any;
 export declare const formatTimeFrameText: (start: string, end: string) => string;

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

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

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

@@ -0,0 +1 @@
+export declare const timeout: (s: number) => Promise<unknown>;

package/package.json

@@ -18,7 +18,7 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.135",
+  "version": "0.0.136",
   "scripts": {
     "dev": "vite --port 9146",
     "build": "tsc && vite build",
@@ -27,6 +27,7 @@
     "docs": "typedoc src/main.ts --theme default --out ../../docs/data-sdk/"
   },
   "devDependencies": {
+    "@types/node": "^18.15.11",
     "typedoc": "^0.22.13",
     "typescript": "^4.3.2",
     "vite": "^2.5.4"