@transitive-sdk/utils-web 0.15.0 → 0.16.1

package/dist/utils-web.js

@@ -406,8 +406,10 @@ var require_common = __commonJS({
         callback && callback(count);
       }, delay);
     };
-    var storageRequestToSelector = (topic) => pathToTopic2(topicToPath2(topic).map((value) => value == "$store" ? "+" : value).map((value) => value == "$storeTail" ? "#" : value));
-    var selectorToStorageRequest = (topic) => pathToTopic2(topicToPath2(topic).map((value) => value[0] == "+" ? "$store" : value).map((value) => value[0] == "#" ? "$storeTail" : value));
+    var metaPathToSelectorPath = (path) => path.map((value) => value[0] == "$" ? decodeURIComponent(value.slice(1)) : value);
+    var metaTopicToSelector = (topic) => pathToTopic2(metaPathToSelectorPath(topicToPath2(topic)));
+    var selectorPathToMetaPath = (path) => path.map((value) => ["+", "#"].includes(value[0]) ? `$${encodeURIComponent(value)}` : value);
+    var selectorToMetaTopic = (topic) => pathToTopic2(selectorPathToMetaPath(topicToPath2(topic)));
     var getRandomId = (bytes = 6) => {
       const buffer = new Uint8Array(bytes);
       crypto.getRandomValues(buffer);
@@ -497,8 +499,11 @@ var require_common = __commonJS({
       tryJSONParse,
       decodeJWT: decodeJWT3,
       visitAncestor,
-      storageRequestToSelector,
-      selectorToStorageRequest
+      // storageRequestToSelector, selectorToStorageRequest
+      metaPathToSelectorPath,
+      selectorPathToMetaPath,
+      metaTopicToSelector,
+      selectorToMetaTopic
     };
   }
 });
@@ -718,7 +723,7 @@ var require_MqttSync = __commonJS({
       encodeTopicElement,
       visitAncestor,
       getRandomId,
-      selectorToStorageRequest
+      selectorPathToMetaPath
     } = require_common();
     var { DataCache } = require_DataCache();
     var log2 = getLogger2("MqttSync");
@@ -805,9 +810,10 @@ var require_MqttSync = __commonJS({
             if (!inclMeta && path.some((field) => field[0] == "$")) {
               return;
             }
-            if (this.rpcHandlers[topic]) {
+            const rpcHandler = this.getRPCHandler(topic);
+            if (rpcHandler) {
               const json = mqttParsePayload(payload);
-              this.handleRPCRequest(topic, json);
+              this.handleRPCRequest(path, rpcHandler, json);
             } else if (this.rpcCallbacks[topic]) {
               const json = mqttParsePayload(payload);
               this.handleRPCResponse(topic, json);
@@ -1183,12 +1189,17 @@ var require_MqttSync = __commonJS({
       /* --------------------------------------------------------------------------
       *  Remote Procedure Calls (RPC)
       */
+      /** Given a (ground) topic find the matching RPC handler, if any. This is
+      * needed because RPC topics can include wildcards. */
+      getRPCHandler(topic) {
+        return _3.find(this.rpcHandlers, (_handler, topicSelector) => topicMatch(topicSelector, topic));
+      }
       /* Handle RPC requests  */
-      async handleRPCRequest(topic, json) {
-        log2.debug("handling RPC request for", topic, json);
-        const handler = this.rpcHandlers[topic];
-        const result = handler(json.args);
-        const responseTopic = `${topic.replace("/request", "/response")}/${json.id}`;
+      async handleRPCRequest(path, handler, json) {
+        log2.debug("handling RPC request for", path, json);
+        const commandTopic = pathToTopic2(path.slice(0, -1));
+        const result = handler(json.args, commandTopic);
+        const responseTopic = `${commandTopic}/response/${json.id}`;
         if (result instanceof Promise) {
           result.then((resultValue) => this.mqtt.publish(
             responseTopic,
@@ -1211,24 +1222,29 @@ var require_MqttSync = __commonJS({
         this.mqtt.unsubscribe(topic);
       }
       /** Register an RPC request handler. Example:
-       * ```js
-       * mqttSync.register('/mySquare', arg => {
-       *   log.debug('running /mySquare with args', arg);
-       *   return arg * arg;
-       * });
-       * ```
-       * Note that the command topic needs to be in the capabilities namespace like
-       * any other topic. In robot capabilities, as usual, these can start in `/`
-       * because the local mqtt bridge operated by the robot agent will place all
-       * topics in their respective namespace. In the cloud and on the web you will
-       * need to use the respective namespace, i.e.,
-       * `/orgId/deviceId/@scope/capName/capVersion/`.
-       *
-       * #### Async/Await
-       * Yes, you can make the handler `async` and use `await` inside of it. This
-       * will be handled correctly, i.e., MqttSync will await the result of the
-       * handler before responding to the RPC request client.
-       */
+      * ```js
+      * mqttSync.register('/mySquare', (arg, commandTopic) => {
+      *   log.debug('we got request on topic', commandTopic);
+      *   log.debug('running /mySquare with args', arg);
+      *   return arg * arg;
+      * });
+      * ```
+      * Note that the command topic needs to be in the capabilities namespace like
+      * any other topic. In robot capabilities, as usual, these can start in `/`
+      * because the local mqtt bridge operated by the robot agent will place all
+      * topics in their respective namespace. In the cloud and on the web you will
+      * need to use the respective namespace, i.e.,
+      * `/orgId/deviceId/@scope/capName/capVersion/`.
+      *
+      * You can use wildcards in the registered topic. The handler will receive the
+      * actual, ground topic the request was made on as the second argument. This
+      * allows you to make the RPCs behavior depend on the topic.
+      *
+      * #### Async/Await
+      * Yes, you can make the handler `async` and use `await` inside of it. This
+      * will be handled correctly, i.e., MqttSync will await the result of the
+      * handler before responding to the RPC request client.
+      */
       register(command, handler) {
         log2.debug("registering RPC handler for", command);
         const requestTopic = `${command}/request`;
@@ -1296,7 +1312,9 @@ var require_MqttSync = __commonJS({
       * service is running -- as it usually is inside the
       * transitiverobotics/clickhouse docker image). */
       requestHistoryStorage(topic, ttl = 1) {
-        const storageRequest = selectorToStorageRequest(topic);
+        const path = selectorPathToMetaPath(topicToPath2(topic));
+        path.splice(5, 0, "$store");
+        const storageRequest = pathToTopic2(path);
         this.mqtt.publish(storageRequest, String(ttl), { retain: true });
       }
     };

package/package.json

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