@formant/data-sdk 1.14.0 → 1.15.0

package/dist/data-sdk.es.js

@@ -4,7 +4,7 @@ var s = (a, e, t) => (de(a, typeof e != "symbol" ? e + "" : e, t), t);
 import { decode as G } from "base-64";
 import * as u from "date-fns";
 import { startOfMinute as he, addMinutes as le, roundToNearestMinutes as ue, addSeconds as me } from "date-fns";
-import { RtcClient as b, SignalingPromiseClient as j } from "@formant/realtime-sdk";
+import { RtcClient as A, SignalingPromiseClient as D } from "@formant/realtime-sdk";
 import { EventEmitter as fe } from "eventemitter3";
 import { deflate as we } from "pako";
 import { fromByteArray as pe } from "base64-js";
@@ -303,13 +303,13 @@ function Ce() {
     type: "hide_analytics_date_picker"
   });
 }
-function Se(a) {
+function Ee(a) {
   T({
     type: "go_to_device",
     deviceId: a
   });
 }
-function Ee(a) {
+function Se(a) {
   T({
     type: "go_to_time",
     time: a.getTime()
@@ -346,7 +346,7 @@ function Re(a, e) {
     after: e || 0
   });
 }
-function be(a) {
+function Ae(a) {
   const e = k();
   if (!e)
     throw new Error("No module context");
@@ -356,10 +356,10 @@ function be(a) {
     menus: a
   });
 }
-function Ae(a) {
+function be(a) {
   T({ type: "show_message", message: a });
 }
-function De(a, e) {
+function je(a, e) {
   const t = (n) => {
     const i = n.data;
     i.type === "channel_data" && i.channel === a && e({
@@ -369,7 +369,7 @@ function De(a, e) {
   };
   return window.addEventListener("message", t), () => window.removeEventListener("message", t);
 }
-function je(a) {
+function De(a) {
   const e = (t) => {
     const n = t.data;
     n.type === "module_menu_item_clicked" && a(n.menu);
@@ -641,8 +641,8 @@ const q = class {
 };
 let g = q;
 s(g, "getCurrentModuleContext", k), // senders
-s(g, "disableAnalyticsBottomBar", Ce), s(g, "goToDevice", Se), s(g, "goToTime", Ee), s(g, "refreshAuthToken", H), s(g, "requestModuleData", ke), s(g, "sendChannelData", Oe), s(g, "setModuleDateTimeRange", Re), s(g, "setupModuleMenus", be), s(g, "showMessage", Ae), // listeners
-s(g, "addAccessTokenRefreshListener", F), s(g, "addChannelDataListener", De), s(g, "addMenuListener", je), s(g, "addModuleConfigurationListener", Ne), s(g, "addModuleDataListener", Pe), s(g, "addOverviewDeviceListener", Le), s(g, "addStreamListener", Ue), // bidirectional
+s(g, "disableAnalyticsBottomBar", Ce), s(g, "goToDevice", Ee), s(g, "goToTime", Se), s(g, "refreshAuthToken", H), s(g, "requestModuleData", ke), s(g, "sendChannelData", Oe), s(g, "setModuleDateTimeRange", Re), s(g, "setupModuleMenus", Ae), s(g, "showMessage", be), // listeners
+s(g, "addAccessTokenRefreshListener", F), s(g, "addChannelDataListener", je), s(g, "addMenuListener", De), s(g, "addModuleConfigurationListener", Ne), s(g, "addModuleDataListener", Pe), s(g, "addOverviewDeviceListener", Le), s(g, "addStreamListener", Ue), // bidirectional
 s(g, "getDate", Je), s(g, "prompt", Ve), s(g, "_isOnline", null);
 function f(a, e) {
   if (a !== void 0)
@@ -730,8 +730,8 @@ Gt = O;
 const P = async () => f(r.token, "Realtime when user isn't authorized"), R = {
   [p.UNKNOWN]: new N({
     ttlMs: 2500,
-    createClient: (a) => new b({
-      signalingClient: new j(h),
+    createClient: (a) => new A({
+      signalingClient: new D(h),
       getToken: P,
       sessionType: p.UNKNOWN,
       receive: a
@@ -739,8 +739,8 @@ const P = async () => f(r.token, "Realtime when user isn't authorized"), R = {
   }),
   [p.TELEOP]: new N({
     ttlMs: 2500,
-    createClient: (a) => new b({
-      signalingClient: new j(h),
+    createClient: (a) => new A({
+      signalingClient: new D(h),
       getToken: P,
       sessionType: p.TELEOP,
       receive: a
@@ -748,8 +748,8 @@ const P = async () => f(r.token, "Realtime when user isn't authorized"), R = {
   }),
   [p.PORT_FORWARD]: new N({
     ttlMs: 2500,
-    createClient: (a) => new b({
-      signalingClient: new j(h),
+    createClient: (a) => new A({
+      signalingClient: new D(h),
       getToken: P,
       sessionType: p.PORT_FORWARD,
       receive: a
@@ -757,8 +757,8 @@ const P = async () => f(r.token, "Realtime when user isn't authorized"), R = {
   }),
   [p.OBSERVE]: new N({
     ttlMs: 2500,
-    createClient: (a) => new b({
-      signalingClient: new j(h),
+    createClient: (a) => new A({
+      signalingClient: new D(h),
       getToken: P,
       sessionType: p.OBSERVE,
       receive: a
@@ -766,8 +766,8 @@ const P = async () => f(r.token, "Realtime when user isn't authorized"), R = {
   }),
   [p.HEADLESS]: new N({
     ttlMs: 2500,
-    createClient: (a) => new b({
-      signalingClient: new j(h),
+    createClient: (a) => new A({
+      signalingClient: new D(h),
       getToken: P,
       sessionType: p.HEADLESS,
       receive: a
@@ -814,7 +814,7 @@ class Fe {
     });
   }
 }
-function A(a) {
+function b(a) {
   return new Promise((e) => setTimeout(e, a));
 }
 const We = (a) => a !== void 0 && a.capabilities !== void 0 && a.capabilitySet !== void 0;
@@ -1000,7 +1000,7 @@ class Xe extends X {
     i.set(d, !0), n.sendBinary(new Uint8Array([...c, ...t]));
     const y = (/* @__PURE__ */ new Date()).getTime();
     for (; (/* @__PURE__ */ new Date()).getTime() < y + o; )
-      if (await A(50), i.has(d)) {
+      if (await b(50), i.has(d)) {
         const m = i.get(d);
         if (m !== !0) {
           i.delete(d);
@@ -1047,7 +1047,7 @@ class Ye extends X {
     );
     const c = (/* @__PURE__ */ new Date()).getTime();
     for (; (/* @__PURE__ */ new Date()).getTime() < c + i; )
-      if (await A(50), n.has(o)) {
+      if (await b(50), n.has(o)) {
         const d = n.get(o);
         if (d !== !0) {
           n.delete(o);
@@ -1571,7 +1571,7 @@ async function mt(a) {
     }
   )).json();
 }
-class S extends Y {
+class E extends Y {
   constructor(e, t, n, i) {
     super(), this.id = e, this.name = t, this.organizationId = n, this.tags = i;
   }
@@ -1590,22 +1590,29 @@ class S extends Y {
       }
     )).json()).items;
   }
-  async getConfiguration() {
-    let e = await fetch(`${h}/v1/admin/devices/${this.id}`, {
+  /**
+   * Asynchronously retrieves the configuration document for a device.
+   *
+   * @param {boolean} getDesiredConfigurationVersion - Whether to retrieve the desired configuration version
+   * @returns {Promise<ConfigurationDocument>} A promise that resolves to the configuration document
+   * @throws {Error} Throws an error if the device has no configuration or has never been turned on
+   */
+  async getConfiguration(e = !1) {
+    let t = await fetch(`${h}/v1/admin/devices/${this.id}`, {
       method: "GET",
       headers: {
         "Content-Type": "application/json",
         Authorization: "Bearer " + r.token
       }
     });
-    const t = await e.json();
-    if (!t.state.reportedConfiguration)
+    const n = await t.json();
+    if (!n.state.reportedConfiguration)
       throw new Error(
         "Device has no configuration, has it ever been turned on?"
       );
-    const n = t.state.reportedConfiguration.version;
-    return e = await fetch(
-      `${h}/v1/admin/devices/${this.id}/configurations/${n}`,
+    const i = e ? n.desiredConfigurationVersion : n.state.reportedConfiguration.version;
+    return t = await fetch(
+      `${h}/v1/admin/devices/${this.id}/configurations/${i}`,
       {
         method: "GET",
         headers: {
@@ -1613,7 +1620,24 @@ class S extends Y {
           Authorization: "Bearer " + r.token
         }
       }
-    ), (await e.json()).document;
+    ), (await t.json()).document;
+  }
+  /**
+   * Asynchronously retrieves the device's agent version string
+   *
+   * @returns {Promise<string | undefined | null>} A promise that resolves to the agent version
+   * @throws {Error} Throws an error if the device info cannot be fetched
+   */
+  async getAgentVersion() {
+    var n;
+    const t = await (await fetch(`${h}/v1/admin/devices/${this.id}`, {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: "Bearer " + r.token
+      }
+    })).json();
+    return (n = t == null ? void 0 : t.state) == null ? void 0 : n.agentVersion;
   }
   async getFileUrl(e) {
     return (await (await fetch(`${h}/v1/admin/files/query`, {
@@ -1660,19 +1684,19 @@ class S extends Y {
     ), m = async () => {
       if ("isReady" in c)
         for (; !c.isReady(); )
-          this.assertNotCancelled(d), await A(100);
+          this.assertNotCancelled(d), await b(100);
       const w = await this.getRemoteDevicePeerId(c);
       this.assertNotCancelled(d);
       let v;
-      for (let D = 0; D < i && (v = await c.connect(w), !v); D++)
-        A(100), this.assertNotCancelled(d);
+      for (let j = 0; j < i && (v = await c.connect(w), !v); j++)
+        b(100), this.assertNotCancelled(d);
       if (!v)
         throw new Error(
           `Session could not be created: exhausted ${i} retries`
         );
       let C = 0;
       for (; !d && c.getConnectionStatus(w) !== "connected"; )
-        await A(100), C += 1;
+        await b(100), C += 1;
       return this.assertNotCancelled(d), console.debug(
         `${(/* @__PURE__ */ new Date()).toISOString()} :: Connection completed after ${C} retries`
       ), w;
@@ -1899,7 +1923,7 @@ class S extends Y {
     return e.scope.deviceIds = [this.id], await ee(e, t);
   }
 }
-s(S, "createDevice", dt), s(S, "patchDevice", ht), s(S, "getDevicesData", lt), s(S, "queryDevicesData", ut), s(S, "disableDevice", mt);
+s(E, "createDevice", dt), s(E, "patchDevice", ht), s(E, "getDevicesData", lt), s(E, "queryDevicesData", ut), s(E, "disableDevice", mt);
 class ft extends Y {
   constructor(t) {
     super();
@@ -1940,8 +1964,8 @@ class ft extends Y {
         if (m.length > 0) {
           const v = JSON.parse(m);
           if ((w = v.result) != null && w.datapoint) {
-            const C = v.result.datapoint, D = C.stream;
-            delete C.stream, this.streamTelemetry[D] = C;
+            const C = v.result.datapoint, j = C.stream;
+            delete C.stream, this.streamTelemetry[j] = C;
           }
         }
       });
@@ -1964,13 +1988,13 @@ class ft extends Y {
     this.rtcClient && console.warn(
       "overwriting existing rtcClient due to missing connectionMonitorInterval"
     );
-    const n = new b({
+    const n = new A({
       lanOnlyMode: !0,
       receive: this.handleMessage,
       sessionType: t
     });
     for (await n.connectLan(this.peerUrl); n.getConnectionStatus(this.peerUrl) !== "connected"; )
-      await A(100);
+      await b(100);
     this.rtcClient = n, this.initConnectionMonitoring();
   }
   initConnectionMonitoring() {
@@ -2107,7 +2131,7 @@ async function se(a) {
       Authorization: "Bearer " + r.token
     }
   })).json()).items.map(
-    (n) => new S(n.id, n.name, n.organizationId, n.tags)
+    (n) => new E(n.id, n.name, n.organizationId, n.tags)
   );
 }
 async function Ct() {
@@ -2133,7 +2157,7 @@ async function Ct() {
     type: "default"
   });
 }
-async function St(a) {
+async function Et(a) {
   if (!r.token)
     throw new Error("Not authenticated");
   const t = await (await fetch(`${h}/v1/admin/devices/${a}`, {
@@ -2143,7 +2167,7 @@ async function St(a) {
       Authorization: "Bearer " + r.token
     }
   })).json(), n = t.name;
-  return new S(a, n, t.organizationId, t.tags);
+  return new E(a, n, t.organizationId, t.tags);
 }
 async function M() {
   if (!r.token)
@@ -2157,7 +2181,7 @@ async function M() {
     }
   })).json();
   return e.items, e.items.map(
-    (t) => new S(
+    (t) => new E(
       t.id,
       t.name,
       t.organizationId,
@@ -2165,7 +2189,7 @@ async function M() {
     )
   );
 }
-async function Et(a) {
+async function St(a) {
   if (!r.token)
     throw new Error("Not authenticated");
   return (await (await fetch(
@@ -2216,7 +2240,7 @@ async function Rt(a) {
     }
   })).json()).items;
 }
-async function bt() {
+async function At() {
   if (!r.token)
     throw new Error("Not authenticated");
   return (await (await fetch(
@@ -2230,7 +2254,7 @@ async function bt() {
     }
   )).json()).items;
 }
-async function At(...a) {
+async function bt(...a) {
   const e = a.flat().filter((i) => !!i);
   return e.length === 0 ? [] : (await (await fetch(
     `${h}/v1/queries/stream-current-value`,
@@ -2246,7 +2270,7 @@ async function At(...a) {
     }
   )).json()).items;
 }
-async function Dt() {
+async function jt() {
   if (!r.token)
     throw new Error("Not authenticated");
   const t = (await (await fetch(`${h}/v1/queries/online-devices`, {
@@ -2258,7 +2282,7 @@ async function Dt() {
   })).json()).items;
   return (await M()).filter((i) => t.includes(i.id));
 }
-async function jt() {
+async function Dt() {
   if (!r.token)
     throw new Error("Not authenticated");
   const t = (await (await fetch(`${h}/v1/signaling/peers`, {
@@ -2428,14 +2452,14 @@ async function Ut(a, e) {
     }
   )).json();
 }
-const E = class {
+const S = class {
   static async setDefaultDevice(e) {
-    E.defaultDeviceId = e;
+    S.defaultDeviceId = e;
   }
   static async getCurrentDevice() {
     if (!r.token)
       throw new Error("Not authenticated");
-    if (!E.defaultDeviceId)
+    if (!S.defaultDeviceId)
       throw new Error("No known default device");
     const n = (await (await fetch(
       `${h}/v1/admin/device-details/query`,
@@ -2447,26 +2471,26 @@ const E = class {
         }
       }
     )).json()).items.find(
-      (c) => c.id === E.defaultDeviceId
-    ), i = n.name, o = new S(
-      E.defaultDeviceId,
+      (c) => c.id === S.defaultDeviceId
+    ), i = n.name, o = new E(
+      S.defaultDeviceId,
       i,
       f(r.currentOrganization),
       n.tags
     );
-    return E.knownContext.push(new WeakRef(o)), o;
+    return S.knownContext.push(new WeakRef(o)), o;
   }
   static async getPeerDevice(e) {
     const t = new ft(e);
     return t.id = await t.getDeviceId(), t;
   }
   static async getDevice(e) {
-    const t = await St(e);
-    return E.knownContext.push(new WeakRef(t)), t;
+    const t = await Et(e);
+    return S.knownContext.push(new WeakRef(t)), t;
   }
 };
-let l = E;
-s(l, "defaultDeviceId"), s(l, "knownContext", []), s(l, "createFleet", Mt), s(l, "listFleets", It), s(l, "getFleet", Ot), s(l, "patchFleet", _t), s(l, "deleteFleet", yt), s(l, "addDeviceToFleet", wt), s(l, "getFleetDevices", Rt), s(l, "aggregateTelemetry", pt), s(l, "createShareLink", ee), s(l, "eventsCounter", ne), s(l, "getAnalyticStreams", gt), s(l, "getAnalyticsModules", vt), s(l, "getAnalyticsRows", Tt), s(l, "getAnnotationCount", B), s(l, "getAnnotationCountByIntervals", ae), s(l, "getCurrentGroup", Ct), s(l, "getDevices", M), s(l, "getEvent", Et), s(l, "getFileUrl", kt), s(l, "getInterventions", bt), s(l, "getLatestTelemetry", At), s(l, "getOnlineDevices", Dt), s(l, "getPeers", re), s(l, "getRealtimeDevices", jt), s(l, "getRealtimeSessions", oe), s(l, "getStreams", Nt), s(l, "getTaskReportRows", Pt), s(l, "getTaskReportTables", Lt), s(l, "getTelemetry", ie), s(l, "getViews", Z), s(l, "patchStream", $t), s(l, "patchView", zt), s(l, "queryAnalytics", Bt), s(l, "queryDevices", se), s(l, "queryEvents", z), s(l, "queryTelemetry", _), s(l, "getAllEventTriggerGroup", qt), s(l, "getEventTriggerGroup", xt), s(l, "patchEventTriggergroup", Ut);
+let l = S;
+s(l, "defaultDeviceId"), s(l, "knownContext", []), s(l, "createFleet", Mt), s(l, "listFleets", It), s(l, "getFleet", Ot), s(l, "patchFleet", _t), s(l, "deleteFleet", yt), s(l, "addDeviceToFleet", wt), s(l, "getFleetDevices", Rt), s(l, "aggregateTelemetry", pt), s(l, "createShareLink", ee), s(l, "eventsCounter", ne), s(l, "getAnalyticStreams", gt), s(l, "getAnalyticsModules", vt), s(l, "getAnalyticsRows", Tt), s(l, "getAnnotationCount", B), s(l, "getAnnotationCountByIntervals", ae), s(l, "getCurrentGroup", Ct), s(l, "getDevices", M), s(l, "getEvent", St), s(l, "getFileUrl", kt), s(l, "getInterventions", At), s(l, "getLatestTelemetry", bt), s(l, "getOnlineDevices", jt), s(l, "getPeers", re), s(l, "getRealtimeDevices", Dt), s(l, "getRealtimeSessions", oe), s(l, "getStreams", Nt), s(l, "getTaskReportRows", Pt), s(l, "getTaskReportTables", Lt), s(l, "getTelemetry", ie), s(l, "getViews", Z), s(l, "patchStream", $t), s(l, "patchView", zt), s(l, "queryAnalytics", Bt), s(l, "queryDevices", se), s(l, "queryEvents", z), s(l, "queryTelemetry", _), s(l, "getAllEventTriggerGroup", qt), s(l, "getEventTriggerGroup", xt), s(l, "patchEventTriggergroup", Ut);
 class an {
   static async set(e, t, n) {
     try {
@@ -2876,7 +2900,7 @@ export {
   Xe as BinaryRequestDataChannel,
   Fe as CaptureStream,
   Ke as DataChannel,
-  S as Device,
+  E as Device,
   l as Fleet,
   an as KeyValue,
   Qe as Manipulator,