@formant/data-sdk 1.357.8 → 1.357.9

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

@@ -1,106 +1,39 @@
-import { Device } from "./devices/Device";
-import { PeerDevice } from "./devices/PeerDevice";
-import { addDeviceToFleet } from "./api/addDeviceToFleet";
-import { aggregateTelemetry } from "./api/aggregateTelemetry";
-import { createShareLink } from "./api/createShareLink";
-import { deleteFleet } from "./api/deleteFleet";
-import { eventsCounter } from "./api/eventsCounter";
-import { getAnalyticStreams } from "./api/getAnalyticsStreams";
-import { getAnalyticsModules } from "./api/getAnalyticsModules";
 import { getAnalyticsRows } from "./api/getAnalyticsRows";
-import { getAnnotationCount } from "./api/getAnnotationCount";
-import { getAnnotationCountByIntervals } from "./api/getAnnotationCountByIntervals";
-import { getCurrentGroup } from "./api/getCurrentGroup";
 import { getDevices } from "./api/getDevices";
 import { getEvent } from "./api/getEvent";
-import { getFileUrl } from "./api/getFileUrl";
-import { getFleet } from "./api/getFleet";
-import { getFleetDevices } from "./api/getFleetDevices";
-import { getInterventions } from "./api/getInterventions";
 import { getLatestTelemetry } from "./api/getLatestTelemetry";
 import { getOnlineDevices } from "./api/getOnlineDevices";
-import { getPeers } from "./api/getPeers";
-import { getRealtimeSessions } from "./api/getRealtimeSessions";
 import { getStreams } from "./api/getStreams";
-import { getTaskReportRows } from "./api/getTaskReportRows";
-import { getTaskReportTables } from "./api/getTaskreportTables";
-import { getTelemetry } from "./api/getTelemetry";
 import { getViews } from "./api/getViews";
-import { listFleets } from "./api/listFleets";
-import { patchFleet } from "./api/patchFleet";
-import { patchStream } from "./api/patchStreams";
 import { patchView } from "./api/patchView";
-import { queryAnalytics } from "./api/queryAnalytics";
 import { queryDevices } from "./api/queryDevices";
-import { queryEvents } from "./api/queryEvents";
 import { queryTelemetry } from "./api/queryTelemetry";
-import { createFleet } from "./api/createFleet";
-import { getAllEventTriggerGroup } from "./api/getAllEventTriggerGroup";
-import { getEventTriggerGroup } from "./api/getEventTriggerGroup";
-import { patchEventTriggerGroup } from "./api/patchEventTriggerGroup";
 import { IDevice } from "./message-bus/listeners/EmbeddedAppMessage";
+import { Device } from "./devices/Device";
+import { PeerDevice } from "./devices/PeerDevice";
+/**
+ * Device context and query helpers for embedded custom modules.
+ * Not related to the admin-api /fleets resource (removed).
+ */
 export declare class Fleet {
     static defaultDeviceId: string | undefined;
     static knownContext: WeakRef<Device>[];
     static groupDevices: IDevice[] | undefined;
-    static createFleet: typeof createFleet;
-    static listFleets: typeof listFleets;
-    static getFleet: typeof getFleet;
-    static patchFleet: typeof patchFleet;
-    static deleteFleet: typeof deleteFleet;
-    static addDeviceToFleet: typeof addDeviceToFleet;
-    static getFleetDevices: typeof getFleetDevices;
     static setDefaultDevice(deviceId: string): Promise<void>;
     static getCurrentDevice(): Promise<Device>;
     static getPeerDevice(url: string): Promise<PeerDevice>;
     static getDevice(deviceId: string): Promise<Device>;
-    /**
-     * Sets the group devices for multi-device (coherence group) contexts.
-     * This is typically called automatically when overview_devices message is received.
-     * @param devices Array of device information from the host container
-     */
     static setGroupDevices(devices: IDevice[]): void;
-    /**
-     * Gets the group devices for multi-device contexts.
-     * Returns undefined if not in a group context (single device view).
-     * @returns Array of device information or undefined
-     */
     static getGroupDevices(): IDevice[] | undefined;
-    /**
-     * Gets all group devices as Device instances.
-     * Useful for modules that need full Device objects rather than just IDevice info.
-     * @returns Promise resolving to array of Device instances
-     */
     static getGroupDevicesAsDeviceInstances(): Promise<Device[]>;
-    static aggregateTelemetry: typeof aggregateTelemetry;
-    static createShareLink: typeof createShareLink;
-    static eventsCounter: typeof eventsCounter;
-    static getAnalyticStreams: typeof getAnalyticStreams;
-    static getAnalyticsModules: typeof getAnalyticsModules;
     static getAnalyticsRows: typeof getAnalyticsRows;
-    static getAnnotationCount: typeof getAnnotationCount;
-    static getAnnotationCountByIntervals: typeof getAnnotationCountByIntervals;
-    static getCurrentGroup: typeof getCurrentGroup;
     static getDevices: typeof getDevices;
     static getEvent: typeof getEvent;
-    static getFileUrl: typeof getFileUrl;
-    static getInterventions: typeof getInterventions;
-    static getLatestTelemetry: typeof getLatestTelemetry;
     static getOnlineDevices: typeof getOnlineDevices;
-    static getPeers: typeof getPeers;
-    static getRealtimeSessions: typeof getRealtimeSessions;
-    static getStreams: typeof getStreams;
-    static getTaskReportRows: typeof getTaskReportRows;
-    static getTaskReportTables: typeof getTaskReportTables;
-    static getTelemetry: typeof getTelemetry;
     static getViews: typeof getViews;
-    static patchStream: typeof patchStream;
     static patchView: typeof patchView;
-    static queryAnalytics: typeof queryAnalytics;
     static queryDevices: typeof queryDevices;
-    static queryEvents: typeof queryEvents;
     static queryTelemetry: typeof queryTelemetry;
-    static getAllEventTriggerGroup: typeof getAllEventTriggerGroup;
-    static getEventTriggerGroup: typeof getEventTriggerGroup;
-    static patchEventTriggergroup: typeof patchEventTriggerGroup;
+    static getLatestTelemetry: typeof getLatestTelemetry;
+    static getStreams: typeof getStreams;
 }

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

@@ -1,9 +1,4 @@
-import { createTeleopView, deleteTeleopView, fetchTeleopViews, getTeleopView, updateTeleopView } from "./api/teleopViews";
+import { fetchTeleopViews } from "./api/teleopViews";
 export declare class Views {
-    constructor();
-    static createTeleopView: typeof createTeleopView;
-    static updateTeleopView: typeof updateTeleopView;
-    static deleteTeleopView: typeof deleteTeleopView;
-    static getTeleopView: typeof getTeleopView;
     static fetchTeleopViews: typeof fetchTeleopViews;
 }

package/dist/types/data-sdk/src/api/teleopViews.d.ts

@@ -1,9 +1,6 @@
 import { RtcStreamType } from "../connector/model/IUniverseData";
 import { IsoDate } from "../model/IsoDate";
 import { ITags } from "../model/ITags";
-export interface IDictionary<T = string> {
-    [key: string]: T;
-}
 export interface ITeleopViewModule {
     id: string;
     type: string;
@@ -61,13 +58,8 @@ export type ModuleConfigItem = {
     type: "named-number";
     defaultValue: number;
 };
-export type ConfigValue = string | number | boolean | any[];
+export type ConfigValue = string | number | boolean | unknown[];
 export type ModuleConfig = {
     [key: string]: ConfigValue;
 };
-export declare function request<T>(endpoint: string, options?: RequestInit): Promise<T>;
 export declare function fetchTeleopViews(): Promise<ITeleopView[]>;
-export declare function getTeleopView(id: string): Promise<ITeleopView>;
-export declare function createTeleopView(view: Omit<ITeleopView, "id" | "organizationId" | "createdAt" | "updatedAt">): Promise<ITeleopView>;
-export declare function updateTeleopView(id: string, view: Partial<ITeleopView>): Promise<ITeleopView>;
-export declare function deleteTeleopView(id: string): Promise<void>;

package/dist/types/data-sdk/src/connector/data/BaseUniverseDataConnector.d.ts

@@ -39,7 +39,7 @@ export declare class BasicUniverseDataConnector {
     sendRealtimePose(deviceId: string, streamName: string, pose: ITransform): Promise<void>;
     sendRealtimeBoolean(deviceId: string, streamName: string, value: boolean): Promise<void>;
     sendRealtimeBitset(deviceId: string, streamName: string, bitset: IBitset): Promise<void>;
-    getUrdfs(deviceId: string): Promise<string[]>;
+    getUrdfs(_deviceId: string): Promise<string[]>;
     getTelemetryStreams(_deviceId: string): Promise<ITelemetryStream[]>;
     getTeleopRosStreams(_deviceId: string): Promise<ITelemetryRosStream[]>;
     getHardwareStreams(_deviceId: string): Promise<IRealtimeStream[]>;

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

@@ -1,7 +1,6 @@
 import { IRtcPeer } from "@formant/realtime-sdk";
 import { createDevice } from "../api/createDevice";
 import { disableDevice } from "../api/disableDevice";
-import { getDevicesData } from "../api/getDevicesData";
 import { patchDevice } from "../api/patchDevice";
 import { queryDevicesData } from "../api/queryDevicesData";
 import { CaptureStream } from "../CaptureStream";
@@ -12,7 +11,6 @@ import { IEventQuery } from "../model/IEventQuery";
 import { IInterventionResponse } from "../model/IInterventionResponse";
 import { IInterventionTypeMap } from "../model/IInterventionTypeMap";
 import { InterventionType } from "../model/InterventionType";
-import { IShare } from "../model/IShare";
 import { ITags } from "../model/ITags";
 import { SessionType } from "../model/SessionType";
 import { TelemetryResult } from "../model/TelemetryResult";
@@ -38,7 +36,7 @@ export declare class Device extends BaseDevice {
     private connectionMonitorConsecutiveFailures;
     static createDevice: typeof createDevice;
     static patchDevice: typeof patchDevice;
-    static getDevicesData: typeof getDevicesData;
+    static getDevicesData: typeof queryDevicesData;
     static queryDevicesData: typeof queryDevicesData;
     static disableDevice: typeof disableDevice;
     getLatestTelemetry(): Promise<any>;
@@ -59,7 +57,6 @@ export declare class Device extends BaseDevice {
      * @throws {Error} Throws an error if the device info cannot be fetched
      */
     getAgentVersion(): Promise<string | undefined | null>;
-    getFileUrl(fileId: string): Promise<string[]>;
     /**
      * Starts a real-time connection with the remote device using WebRTC.
      * @param {number} [options] - Optional session type to be used for the connection.
@@ -98,5 +95,4 @@ export declare class Device extends BaseDevice {
         date: string;
         events: IEvent[];
     }[]>;
-    createShareLink(share: IShare, view: string): Promise<string | null>;
 }

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

@@ -1,4 +1,3 @@
-export { Account } from "./Account";
 export { App } from "./App";
 export { AudioPlayer } from "./AudioPlayer";
 export { Authentication } from "./Authentication";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formant/data-sdk",
-  "version": "1.357.8",
+  "version": "1.357.9",
   "description": "A library for getting data from Formant",
   "repository": {
     "type": "git",
@@ -26,6 +26,7 @@
     }
   },
   "scripts": {
+    "prepare": "lefthook install",
     "preversion": "npm run verify",
     "postversion": "make",
     "dev": "vite --port 5173",
@@ -47,6 +48,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.11.1",
+    "@evilmartians/lefthook": "^1.13.6",
     "@formant/realtime-sdk": "^1.4.11",
     "@types/base-64": "^1.0.0",
     "@types/fast-json-stable-stringify": "=2.0.0",

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

@@ -1,10 +0,0 @@
-import { IAccount } from "./model/IAccount";
-import { IAccountTree } from "./model/IAccountTree";
-export declare class Account {
-    static listAccounts(): Promise<IAccount[]>;
-    static createAccounts(account: IAccount): Promise<IAccount>;
-    static getAccount(id: string): Promise<IAccount>;
-    static patchAccount(id: string, account: Partial<Account>): Promise<IAccount>;
-    static deleteAccount(id: string): Promise<void>;
-    static getAccountTree(id: string): Promise<IAccountTree>;
-}

package/dist/types/data-sdk/src/api/addDeviceToFleet.d.ts

@@ -1 +0,0 @@
-export declare function addDeviceToFleet(deviceId: string, fleetId: string): Promise<any>;

package/dist/types/data-sdk/src/api/aggregateTelemetry.d.ts

@@ -1,3 +0,0 @@
-import { IQuery } from "../model/IQuery";
-import { IStreamAggregateData } from "../model/IStreamAggregateData";
-export declare function aggregateTelemetry(query: IQuery): Promise<IStreamAggregateData<keyof import("../main").IStreamTypeMap>[]>;

package/dist/types/data-sdk/src/api/createFleet.d.ts

@@ -1,2 +0,0 @@
-import { IFleet } from "../model/IFleet";
-export declare function createFleet(fleet: IFleet): Promise<IFleet>;

package/dist/types/data-sdk/src/api/createShareLink.d.ts

@@ -1,22 +0,0 @@
-import { IShare } from "../model/IShare";
-/**
- * @param scope is required
- * @param time is required
- * @param view View name
- * @returns
- * Share link
- * @example
- * // Body
- * const link = await createShareLink({
- *     delegateTeleop: false
- *     message: "See bot in action",
- *     scope: {
- *       deviceIds: ["d64520a6-a308-4a59-9267-b7f8a7bfc7ab"],
- *       start: "2023-04-04T19:51:47.125Z",
- *       end: "2023-04-04T20:51:47.125Z"
- *      },
- *      time: "2023-04-04T20:21:47.125Z",
- *      userName: "User",
- *   });
- */
-export declare function createShareLink(share: IShare, view: string): Promise<string | null>;

package/dist/types/data-sdk/src/api/deleteFleet.d.ts

@@ -1 +0,0 @@
-export declare function deleteFleet(id: string): Promise<void>;

package/dist/types/data-sdk/src/api/getAllEventTriggerGroup.d.ts

@@ -1,2 +0,0 @@
-import { IEventTriggerGroup } from "../model/IEventTriggerGroup";
-export declare function getAllEventTriggerGroup(): Promise<IEventTriggerGroup[]>;

package/dist/types/data-sdk/src/api/getAnalyticsModules.d.ts

@@ -1,2 +0,0 @@
-import { IAnalyticsModule } from "../model/IAnalyticsModule";
-export declare function getAnalyticsModules(): Promise<IAnalyticsModule>;

package/dist/types/data-sdk/src/api/getAnalyticsStreams.d.ts

@@ -1,18 +0,0 @@
-import { IStreamColumn } from "../model/IStreamColumn";
-/**
- * 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"
-        }
- ]
- */
-export declare function getAnalyticStreams(): Promise<IStreamColumn[]>;

package/dist/types/data-sdk/src/api/getCurrentGroup.d.ts

@@ -1,2 +0,0 @@
-import { Device } from "../devices/Device";
-export declare function getCurrentGroup(): Promise<Device[] | undefined>;

package/dist/types/data-sdk/src/api/getDevicesData.d.ts

@@ -1,2 +0,0 @@
-import { IDevice } from "../model/IDevice";
-export declare function getDevicesData(): Promise<IDevice[]>;

package/dist/types/data-sdk/src/api/getEventTriggerGroup.d.ts

@@ -1,2 +0,0 @@
-import { IEventTriggerGroup } from "../model/IEventTriggerGroup";
-export declare function getEventTriggerGroup(id: string): Promise<IEventTriggerGroup>;

package/dist/types/data-sdk/src/api/getFileUrl.d.ts

@@ -1 +0,0 @@
-export declare function getFileUrl(uuid: string): Promise<string>;

package/dist/types/data-sdk/src/api/getFleet.d.ts

@@ -1,2 +0,0 @@
-import { IFleet } from "../model/IFleet";
-export declare function getFleet(id: string): Promise<IFleet>;

package/dist/types/data-sdk/src/api/getFleetDevices.d.ts

@@ -1 +0,0 @@
-export declare function getFleetDevices(id: string): Promise<void>;

package/dist/types/data-sdk/src/api/getInterventions.d.ts

@@ -1,2 +0,0 @@
-import { IEvent } from "../model/IEvent";
-export declare function getInterventions(): Promise<IEvent[]>;

package/dist/types/data-sdk/src/api/getTaskReportRows.d.ts

@@ -1,26 +0,0 @@
-import { ISqlQuery } from "../model/ISqlQuery";
-/**
- * @param taskColumns is required
- * @returns
- * All task reports
- * @example
- * // Body
- * const tasks = await getTaskReports({
- *     taskColumns: [
- *       {
- *         columns: [
- *           {
- *             dataType: "string",
- *             isNullable: true,
- *             name: "TYPE",
- *             tableName: "custom",
- *           },
- *         ],
- *         name: "DURATION_SECONDS",
- *         tableName: "TASK_REPORTS_CLEANING_MODE",
- *         yAxis: "DURATION_SECONDS",
- *       },
- *     ],
- *   });
- */
-export declare function getTaskReportRows(query: ISqlQuery): Promise<any>;

package/dist/types/data-sdk/src/api/getTaskreportTables.d.ts

@@ -1,23 +0,0 @@
-import { ITaskReportColumn } from "../model/ITaskReportColumn";
-/**
- * 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"
- *                 }
- *                ]
- *    }
- *]
- */
-export declare function getTaskReportTables(): Promise<ITaskReportColumn[]>;

package/dist/types/data-sdk/src/api/listFleets.d.ts

@@ -1,2 +0,0 @@
-import { IFleet } from "../model/IFleet";
-export declare function listFleets(): Promise<IFleet[]>;

package/dist/types/data-sdk/src/api/patchEventTriggerGroup.d.ts

@@ -1,2 +0,0 @@
-import { IEventTriggerGroup } from "../model/IEventTriggerGroup";
-export declare function patchEventTriggerGroup(id: string, eventTrigger: Partial<IEventTriggerGroup>): Promise<IEventTriggerGroup>;

package/dist/types/data-sdk/src/api/patchFleet.d.ts

@@ -1,2 +0,0 @@
-import { IFleet } from "../model/IFleet";
-export declare function patchFleet(id: string, role: Partial<IFleet>): Promise<IFleet>;

package/dist/types/data-sdk/src/api/patchStreams.d.ts

@@ -1,2 +0,0 @@
-import { IStream } from "../model/IStream";
-export declare function patchStream(stream: IStream): Promise<IStream>;

package/dist/types/data-sdk/src/api/queryAnalytics.d.ts

@@ -1,43 +0,0 @@
-import { ISqlQuery } from "../model/ISqlQuery";
-import { ISqlResult } from "../model/ISqlResult";
-/**
- *Retrieves all stream rows
- * @example
- * // Body
- * const analytics = await 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)"
- * }
- */
-export declare function queryAnalytics(query: ISqlQuery): Promise<ISqlResult>;