@transitive-sdk/utils-web 0.16.2 → 0.16.3

package/dist/utils-web.js

@@ -469,6 +469,14 @@ var require_common = __commonJS({
       !parts.h && (rtv += `${parts.s}s`);
       return rtv.trim();
     };
+    var doOnceCache = {};
+    var doOnce = (fn, key = void 0) => {
+      key ||= fn.toString();
+      if (doOnceCache[key])
+        return;
+      fn();
+      doOnceCache[key] = true;
+    };
     module2.exports = {
       parseMQTTUsername,
       parseMQTTTopic,
@@ -503,7 +511,8 @@ var require_common = __commonJS({
       metaPathToSelectorPath,
       selectorPathToMetaPath,
       metaTopicToSelector,
-      selectorToMetaTopic
+      selectorToMetaTopic,
+      doOnce
     };
   }
 });
@@ -754,7 +763,7 @@ var require_MqttSync = __commonJS({
       achieve the "should-be" state. Note that we cannot use a structured document
       for storing these publishedMessages since we need to be able to store separate
       values at non-leaf nodes in the object (just like mqtt, where you can have
-      /a/b = 1 and /a/b/c = 1 at the same time). Note: not used in atomic mode.
+      `/a/b = 1` and `/a/b/c = 1` at the same time). Note: not used in atomic mode.
       Note: we use specialKey in this DataCache to allow overlapping
       topics (e.g., `/a/b/$_ = 1` and `/a/$_ = {b: 2}`)
       */
@@ -844,8 +853,8 @@ var require_MqttSync = __commonJS({
       /**
       * Publish all values at the given level of the given object under the given
       * topic (plus sub-key, of course).
-      * TODO: Is this OK, or do we need to go through this.publish?
       */
+      // TODO: Is this OK, or do we need to go through this.publish?
       publishAtLevel(topic, value, level) {
         log2.debug(`publishingAtLevel ${level}`, topic, value);
         if (level > 0) {
@@ -1319,8 +1328,31 @@ var require_MqttSync = __commonJS({
         this.mqtt.publish(storageRequest, String(ttl), { retain: true });
       }
       /** Query a topics history (if stored). Convenience function to make RPC call
-       * to the mqtt2clickhouse service.
-      * @param params = {topic, since, until, orderBy, limit} */
+      * to the mqtt2clickhouse service. For details see `clickhouse.queryMQTTHistory`
+      * in utils/clickhouse.
+      * @param {object} params
+      * @param {object} params.topic - A topic with wildcards selecting what
+      * to retrieve.
+      * @param {number} [params.since] - A time (seconds since epoch) from when on
+      * to retrieve history.
+      * @param {number} [params.until] - A time (seconds since epoch) until when on
+      * to retrieve history.
+      * @param {[string]} [params.path] - A path into the payload to extract, e.g.,
+      * `['a', 'b']` would retrieve the value 123 from `{a: {b: 123}}`. Requires `type`.
+      * @param {string} [params.type] - Type of element to extract using `path`.
+      * For available types, see https://clickhouse.com/docs/sql-reference/data-types.
+      * @param {string} [params.orderBy] - an `ORDER BY` statement to use for sorting
+      * results.
+      * @param {integer} [params.limit] - Max number of results to return, after grouping.
+      * @param {integer} [params.bins] - Into how many bins to aggregate (if given,
+      * requires `since`).
+      * @param {string} [params.agg] - Aggregation function to use (if `aggSeconds`
+      * or `bins` and `since` are given). Defaults to `count` (which works for any
+      * data type). See
+      * https://clickhouse.com/docs/sql-reference/aggregate-functions/reference.
+      * @param {integer} [params.aggSeconds] - How many seconds to group together
+      * (alternative to `bins` + `since`).
+      * */
       async queryHistory(params) {
         const path = topicToPath2(params.topic);
         const rpc = selectorToMetaTopic(`${pathToTopic2(path.slice(0, 5))}/$queryMQTTHistory`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transitive-sdk/utils-web",
-  "version": "0.16.2",
+  "version": "0.16.3",
   "description": "Web utils for the Transitive framework",
   "homepage": "https://transitiverobotics.com",
   "repository": {