mqtt-plus 1.4.6 → 1.4.7

package/AGENTS.md

@@ -129,7 +129,9 @@ Test files live in `tst/`:
 | File                              | Role |
 |-----------------------------------|------|
 | `tst/mqtt-plus-0-fixture.ts`      | Shared test fixture setup (broker, MQTTp instances, etc.) |
-| `tst/mqtt-plus-0-mosquitto.ts`    | Helper for starting/stopping the Mosquitto MQTT broker |
+| `tst/mqtt-plus-0-broker.ts`       | Broker dispatch: creates Aedes or Mosquitto broker based on env |
+| `tst/mqtt-plus-0-broker-aedes.ts` | Helper for starting/stopping the Aedes MQTT broker |
+| `tst/mqtt-plus-0-broker-mosquitto.ts` | Helper for starting/stopping the Mosquitto MQTT broker |
 | `tst/mqtt-plus-1-api.spec.ts`     | API type and endpoint definition tests |
 | `tst/mqtt-plus-2-event.spec.ts`   | Event Emission pattern tests |
 | `tst/mqtt-plus-3-service.spec.ts` | Service Call / RPC pattern tests |

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 ChangeLog
 =========
 
+1.5.0 (2026-02-22)
+------------------
+
+- IMPROVEMENT: provide a global "share" option
+- IMPROVEMENT: use timer utility code for internal timing
+- IMPROVEMENT: improve error handling
+- IMPROVEMENT: make code more type-safe
+- IMPROVEMENT: make "stream" and "buffer" fields mandatory in sink() "info" object
+- IMPROVEMENT: make test suite more robust and support async/non-async handlers
+- IMPROVEMENT: add Aedes MQTT broker support to not require Docker for the test suite
+- BUGFIX: fix leak in subscription handling
+- BUGFIX: workaround for ESM-only "plazy" module when used from CJS context
+- BUGFIX: fix ACL handling
+- CLEANUP: various code cleanups
+- CLEANUP: remove unused fields from protocol messages
+- CLEANUP: add protection and align code with implementation
+- CLEANUP: improve console output and use Chalk for colored rendering
+- CLEANUP: improve about description and text
+- DOCUMENTATION: switch about information to Markdown and SVG format
+- DOCUMENTATION: add hint to NPM
+- DOCUMENTATION: fix name of peer dependency
+
 1.4.6 (2026-02-22)
 ------------------
 

package/README.md

@@ -6,8 +6,7 @@ MQTT+
 
 [MQTT](http://mqtt.org/) [Communication Patterns](doc/mqtt-plus-comm.md)
 
-<p/>
-<img src="https://nodei.co/npm/mqtt-plus.png?downloads=true&stars=true" alt=""/>
+[![NPM](https://nodei.co/npm/mqtt-plus.svg?downloads=true&stars=true)](https://nodei.co/npm/mqtt-plus/)
 
 [![github (author stars)](https://img.shields.io/github/stars/rse?logo=github&label=author%20stars&color=%233377aa)](https://github.com/rse)
 [![github (author followers)](https://img.shields.io/github/followers/rse?label=author%20followers&logo=github&color=%234477aa)](https://github.com/rse)
@@ -18,7 +17,7 @@ About
 **MQTT+** is a companion add-on API for the TypeScript/JavaScript
 API [MQTT.js](https://www.npmjs.com/package/mqtt), designed to
 extend [MQTT](http://mqtt.org/) with higher-level
-[communication patterns](doc/mqtt-plus-comm.md) while preserving full type-safety.
+[communication patterns](doc/mqtt-plus-comm.md) while preserving full type safety.
 It provides four core communication patterns: fire-and-forget *Event
 Emission*, RPC-style *Service Call*, stream-based *Sink Push*, and
 stream-based *Source Fetch*.
@@ -31,7 +30,7 @@ or [JSON](https://ecma-international.org/publications-and-standards/standards/ec
 The result is a more expressive and maintainable messaging layer
 without sacrificing [MQTT](http://mqtt.org/)’s excellent robustness and
 scalability.
-**MQTT+** is particularly well suited for systems built around a
+**MQTT+** is particularly well-suited for systems built around a
 [*Hub & Spoke*](https://en.wikipedia.org/wiki/Spoke%E2%80%93hub_distribution_paradigm)
 communication architecture, where typed API contracts and controlled interaction flows are
 critical for reliability and long-term maintainability.
@@ -39,6 +38,11 @@ critical for reliability and long-term maintainability.
 Installation
 ------------
 
+**MQTT+** is published as a Node Package Manager (NPM) package named
+[`mqtt-plus`](https://npmjs.com/mqtt-plus).
+Install it, together with its peer dependency MQTT.js, with
+the help of the NPM Command-Line Interface (CLI):
+
 ```shell
 $ npm install mqtt mqtt-plus
 ```
@@ -48,7 +52,7 @@ Usage
 
 The following is a simple but self-contained example usage of
 **MQTT+** based on a common API, a server part, a client part,
-and a MQTT infrastructure. It can be found in the file
+and an MQTT infrastructure. It can be found in the file
 [sample.ts](sample/sample.ts) and can be executed from the **MQTT+**
 source tree via `npm start sample` (assuming the prerequisite *Docker* is
 available for the underlying *Mosquitto* broker based infrastructure):
@@ -92,8 +96,8 @@ const Server = async (api: MQTTp<API>, log: (msg: string, ...args: any[]) => voi
     await api.sink("example/upload", async (filename, info) => {
         log("example/upload: SERVER:", filename)
         const chunks: Uint8Array[] = []
-        info.stream!.on("data", (chunk: Uint8Array) => { chunks.push(chunk) })
-        await new Promise<void>((resolve) => { info.stream!.once("end", resolve) })
+        info.stream.on("data", (chunk: Uint8Array) => { chunks.push(chunk) })
+        await new Promise<void>((resolve) => { info.stream.once("end", resolve) })
         const total = chunks.reduce((n, c) => n + c.length, 0)
         log("received", total, "bytes")
     })
@@ -171,7 +175,7 @@ Notice
 ------
 
 > [!Note]
-> **MQTT+** and its peer dependency **MQTT** provide a powerful
+> **MQTT+** and its peer dependency **MQTT.js** provide a powerful
 > functionality, but are not small in size. **MQTT+** is 3.500 LoC
 > and 75 KB in size (ESM and CJS format). When bundled with all its
 > dependencies, it is 220 KB in size (UMD format). Its peer dependency

package/doc/mqtt-plus-api.md

@@ -17,6 +17,7 @@ Construction
             id:          string
             codec:       "cbor" | "json"
             timeout:     number
+            share:       string
             chunkSize:   number
             chunkCredit: number
             topicMake:   (name: string, operation: string, peerId?: string) => string
@@ -36,6 +37,14 @@ describing the available events, services, sources, and sinks.
   - `id`: Custom MQTT peer identifier (default: auto-generated NanoID).
   - `codec`: Encoding format, either `cbor` or `json` (default: `cbor`).
   - `timeout`: Communication timeout in milliseconds (default: `10000`).
+  - `share`: Default
+    [MQTT Shared Subscription](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250)
+    group name for `service()`, `source()`, and `sink()` registrations
+    (default: `""`). Set to a non-empty string (e.g., `"default"`) to
+    enable shared subscriptions globally, which internally prefixes
+    topics with `$share/<share>/`. This global default can be overridden
+    per-call via the `share` option on `event()`, `service()`,
+    `source()`, and `sink()`.
   - `chunkSize`: Chunk size in bytes for source/sink transfers (default: `16384`).
   - `chunkCredit`: Number of credit units for flow control in source/sink
     chunked transfers (default: `4`). Controls how many chunks can be
@@ -235,7 +244,8 @@ Register for an event.
   [MQTT Shared Subscriptions](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250)
   (MQTT 5.0) for load-balancing messages across multiple registrations
   by specifying a group name. This internally prefixes the event with
-  `$share/<share>/`.
+  `$share/<share>/`. By default no shared subscription is used for
+  events (unlike `service()`, `source()`, and `sink()`).
 
 - The optional `auth` enables authentication validation on incoming events.
   When set to a role name string (e.g., `"admin"`), authentication is required
@@ -364,7 +374,8 @@ Register a service.
   [MQTT Shared Subscriptions](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250)
   (MQTT 5.0) for load-balancing service calls across multiple services
   by specifying a group name. This internally prefixes the service
-  with `$share/<share>/`. By default a share named `default` is used.
+  with `$share/<share>/`. Defaults to the global `share` constructor
+  option (default: `""`).
 
 - The optional `auth` enables authentication validation on incoming service calls.
   When set to a role name string (e.g., `"admin"`), authentication is required
@@ -464,8 +475,8 @@ Register a sink for receiving data.
   [MQTT Shared Subscriptions](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250)
   (MQTT 5.0) for load-balancing sink pushes across multiple sink
   handlers by specifying a group name. This internally prefixes the
-  sink with `$share/<share>/`. By default a share named `default` is
-  used.
+  sink with `$share/<share>/`. Defaults to the global `share` constructor
+  option (default: `""`).
 
 - The optional `auth` enables authentication validation on incoming sink pushes.
   When set to a role name string (e.g., `"admin"`), authentication
@@ -587,8 +598,8 @@ Register a source for sending data.
   [MQTT Shared Subscriptions](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250)
   (MQTT 5.0) for load-balancing source requests across multiple
   sources by specifying a group name. This internally prefixes the
-  source with `$share/<share>/`. By default a share named `default` is
-  used.
+  source with `$share/<share>/`. Defaults to the global `share` constructor
+  option (default: `""`).
 
 - The optional `auth` enables authentication validation on incoming source fetches.
   When set to a role name string (e.g., `"admin"`), authentication

package/doc/mqtt-plus-broker-setup.md

@@ -137,16 +137,16 @@ pattern read      example/client/+/source-fetch-chunk/%c
 #   ---- sink push ----
 
 topic   read      example/server/+/sink-push-request/any
-topic   read      $share/default/example/server/+/sink-push-request/any
+topic   read      $share/server/example/server/+/sink-push-request/any
 pattern read      example/server/+/sink-push-request/%c
-pattern read      $share/default/example/server/+/sink-push-request/%c
+pattern read      $share/server/example/server/+/sink-push-request/%c
 topic   write     example/server/+/sink-push-response/+
 pattern read      example/server/+/sink-push-chunk/%c
-pattern read      $share/default/example/server/+/sink-push-chunk/%c
-topic   write     example/client/+/sink-push-credit/+
+pattern read      $share/server/example/server/+/sink-push-chunk/%c
 
 topic   write     example/client/+/sink-push-request/+
 pattern read      example/client/+/sink-push-response/%c
+topic   write     example/client/+/sink-push-credit/+
 topic   write     example/client/+/sink-push-chunk/+
 ```
 

package/dst-stage1/mqtt-plus-base.d.ts

@@ -6,8 +6,8 @@ import type { Spool } from "./mqtt-plus-error";
 export declare class BaseTrait<T extends APISchema = APISchema> extends TraceTrait<T> {
     private mqtt;
     private messageHandler;
-    protected onRequest: Map<string, (message: any, topicName: string) => void>;
-    protected onResponse: Map<string, (message: any, topicName: string) => void>;
+    protected onRequest: Map<string, (message: any, topicName: string) => void | Promise<void>>;
+    protected onResponse: Map<string, (message: any, topicName: string) => void | Promise<void>>;
     constructor(mqtt: MqttClient | null, options?: Partial<APIOptions>);
     destroy(): Promise<void>;
     protected makeRegistration(spool: Spool, kind: string, name: string, key: string): Registration;

package/dst-stage1/mqtt-plus-base.js

@@ -21,10 +21,9 @@
 **  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 **  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
-/*  external requirements  */
-import PLazy from "p-lazy";
 import { TraceTrait } from "./mqtt-plus-trace";
 import { ensureError } from "./mqtt-plus-error";
+import { PLazy } from "./mqtt-plus-util";
 /*  MQTTp Base class with shared infrastructure  */
 export class BaseTrait extends TraceTrait {
     /*  construct API class  */
@@ -189,24 +188,18 @@ export class BaseTrait extends TraceTrait {
             /*  dispatch request message  */
             const handler = this.onRequest.get(`${topicMatch.operation}:${message.name}`);
             if (handler !== undefined) {
-                try {
-                    handler(message, topicMatch.name);
-                }
-                catch (err) {
+                Promise.resolve(handler(message, topicMatch.name)).catch((err) => {
                     this.error(ensureError(err, `dispatching request message from MQTT topic "${topic}" failed`));
-                }
+                });
             }
         }
         else if (this.msg.isResponse(message)) {
             /*  dispatch response message  */
             const handler = this.onResponse.get(`${topicMatch.operation}:${message.id}`);
             if (handler !== undefined) {
-                try {
-                    handler(message, topicMatch.name);
-                }
-                catch (err) {
+                Promise.resolve(handler(message, topicMatch.name)).catch((err) => {
                     this.error(ensureError(err, `dispatching response message from MQTT topic "${topic}" failed`));
-                }
+                });
             }
         }
     }

package/dst-stage1/mqtt-plus-codec.js

@@ -65,16 +65,16 @@ class Codec {
             try {
                 result = CBOR.encode(data, { types: this.types });
             }
-            catch (ex) {
-                throw new Error("failed to encode CBOR format", { cause: ex });
+            catch (err) {
+                throw new Error("failed to encode CBOR format", { cause: err });
             }
         }
         else if (this.format === "json") {
             try {
                 result = JSONX.stringify(data);
             }
-            catch (ex) {
-                throw new Error("failed to encode JSON format", { cause: ex });
+            catch (err) {
+                throw new Error("failed to encode JSON format", { cause: err });
             }
         }
         else
@@ -89,8 +89,8 @@ class Codec {
             try {
                 result = CBOR.decode(data, { tags: this.tags });
             }
-            catch (ex) {
-                throw new Error("failed to decode CBOR format", { cause: ex });
+            catch (err) {
+                throw new Error("failed to decode CBOR format", { cause: err });
             }
         }
         else if (this.format === "json") {
@@ -99,8 +99,8 @@ class Codec {
             try {
                 result = JSONX.parse(data);
             }
-            catch (ex) {
-                throw new Error("failed to decode JSON format", { cause: ex });
+            catch (err) {
+                throw new Error("failed to decode JSON format", { cause: err });
             }
         }
         else

package/dst-stage1/mqtt-plus-event.js

@@ -68,8 +68,8 @@ export class EventTrait extends AuthTrait {
                 info.meta = request.meta;
             /*  asynchronously execute handler  */
             Promise.resolve().then(async () => {
-                if (topicName !== name)
-                    throw new Error(`event name mismatch (topic: "${topicName}", payload: "${name}")`);
+                if (topicName !== request.name)
+                    throw new Error(`event name mismatch (topic: "${topicName}", payload: "${request.name}")`);
                 if (auth)
                     info.authenticated = await this.authenticated(request.sender, request.auth, auth);
                 if (info.authenticated !== undefined && !info.authenticated)

package/dst-stage1/mqtt-plus-info.d.ts

@@ -14,7 +14,7 @@ export interface InfoSource extends InfoBase {
     buffer?: Promise<Uint8Array>;
 }
 export interface InfoSink extends InfoBase {
-    stream?: Readable;
-    buffer?: Promise<Uint8Array>;
+    stream: Readable;
+    buffer: Promise<Uint8Array>;
 }
 export type WithInfo<F, I extends InfoBase> = F extends (...args: infer P) => infer R ? (...args: [...P, info: I]) => R : never;

package/dst-stage1/mqtt-plus-msg.d.ts

@@ -38,10 +38,8 @@ export declare class SinkPushRequest extends Base {
 export declare class SinkPushResponse extends Base {
     name: string;
     error?: string | undefined;
-    auth?: string[] | undefined;
-    meta?: Record<string, any> | undefined;
     credit?: number | undefined;
-    constructor(id: string, name: string, error?: string | undefined, sender?: string, receiver?: string, auth?: string[] | undefined, meta?: Record<string, any> | undefined, credit?: number | undefined);
+    constructor(id: string, name: string, error?: string | undefined, sender?: string, receiver?: string, credit?: number | undefined);
 }
 export declare class SinkPushChunk extends Base {
     name: string;
@@ -66,9 +64,8 @@ export declare class SourceFetchRequest extends Base {
 export declare class SourceFetchResponse extends Base {
     name: string;
     error?: string | undefined;
-    auth?: string[] | undefined;
     meta?: Record<string, any> | undefined;
-    constructor(id: string, name: string, error?: string | undefined, sender?: string, receiver?: string, auth?: string[] | undefined, meta?: Record<string, any> | undefined);
+    constructor(id: string, name: string, error?: string | undefined, sender?: string, receiver?: string, meta?: Record<string, any> | undefined);
 }
 export declare class SourceFetchChunk extends Base {
     name: string;
@@ -87,11 +84,11 @@ declare class Msg {
     makeServiceCallRequest(id: string, name: string, params?: any[], sender?: string, receiver?: string, auth?: string[], meta?: Record<string, any>): ServiceCallRequest;
     makeServiceCallResponse(id: string, result?: any, error?: string, sender?: string, receiver?: string): ServiceCallResponse;
     makeSinkPushRequest(id: string, name: string, params?: any[], sender?: string, receiver?: string, auth?: string[], meta?: Record<string, any>): SinkPushRequest;
-    makeSinkPushResponse(id: string, name: string, error?: string, sender?: string, receiver?: string, auth?: string[], meta?: Record<string, any>, credit?: number): SinkPushResponse;
+    makeSinkPushResponse(id: string, name: string, error?: string, sender?: string, receiver?: string, credit?: number): SinkPushResponse;
     makeSinkPushChunk(id: string, name: string, chunk?: Uint8Array, error?: string, final?: boolean, sender?: string, receiver?: string): SinkPushChunk;
     makeSinkPushCredit(id: string, name: string, credit: number, sender?: string, receiver?: string): SinkPushCredit;
     makeSourceFetchRequest(id: string, name: string, params?: any[], sender?: string, receiver?: string, auth?: string[], meta?: Record<string, any>, credit?: number): SourceFetchRequest;
-    makeSourceFetchResponse(id: string, name: string, error?: string, sender?: string, receiver?: string, auth?: string[], meta?: Record<string, any>): SourceFetchResponse;
+    makeSourceFetchResponse(id: string, name: string, error?: string, sender?: string, receiver?: string, meta?: Record<string, any>): SourceFetchResponse;
     makeSourceFetchChunk(id: string, name: string, chunk?: Uint8Array, error?: string, final?: boolean, sender?: string, receiver?: string): SourceFetchChunk;
     makeSourceFetchCredit(id: string, name: string, credit: number, sender?: string, receiver?: string): SourceFetchCredit;
     parse(obj: any): EventEmission | ServiceCallRequest | ServiceCallResponse | SinkPushRequest | SinkPushResponse | SinkPushChunk | SinkPushCredit | SourceFetchRequest | SourceFetchResponse | SourceFetchChunk | SourceFetchCredit;

package/dst-stage1/mqtt-plus-msg.js

@@ -116,12 +116,10 @@ const SinkPushRequestSchema = v.strictObject({
 });
 /*  sink push response (ack/nak)  */
 export class SinkPushResponse extends Base {
-    constructor(id, name, error, sender, receiver, auth, meta, credit) {
+    constructor(id, name, error, sender, receiver, credit) {
         super("sink-push-response", id, sender, receiver);
         this.name = name;
         this.error = error;
-        this.auth = auth;
-        this.meta = meta;
         this.credit = credit;
     }
 }
@@ -130,8 +128,6 @@ const SinkPushResponseSchema = v.strictObject({
     type: v.literal("sink-push-response"),
     name: v.string(),
     error: v.optional(v.string()),
-    auth: v.optional(AuthSchema),
-    meta: v.optional(MetaSchema),
     credit: v.optional(v.pipe(v.number(), v.integer(), v.minValue(1)))
 });
 /*  sink push chunk (actual data transfer)  */
@@ -188,11 +184,10 @@ const SourceFetchRequestSchema = v.strictObject({
 });
 /*  source fetch response (ack/nak)  */
 export class SourceFetchResponse extends Base {
-    constructor(id, name, error, sender, receiver, auth, meta) {
+    constructor(id, name, error, sender, receiver, meta) {
         super("source-fetch-response", id, sender, receiver);
         this.name = name;
         this.error = error;
-        this.auth = auth;
         this.meta = meta;
     }
 }
@@ -201,7 +196,6 @@ const SourceFetchResponseSchema = v.strictObject({
     type: v.literal("source-fetch-response"),
     name: v.string(),
     error: v.optional(v.string()),
-    auth: v.optional(AuthSchema),
     meta: v.optional(MetaSchema)
 });
 /*  source fetch chunk (actual data transfer)  */
@@ -251,8 +245,8 @@ class Msg {
     makeSinkPushRequest(id, name, params, sender, receiver, auth, meta) {
         return new SinkPushRequest(id, name, params, sender, receiver, auth, meta);
     }
-    makeSinkPushResponse(id, name, error, sender, receiver, auth, meta, credit) {
-        return new SinkPushResponse(id, name, error, sender, receiver, auth, meta, credit);
+    makeSinkPushResponse(id, name, error, sender, receiver, credit) {
+        return new SinkPushResponse(id, name, error, sender, receiver, credit);
     }
     makeSinkPushChunk(id, name, chunk, error, final, sender, receiver) {
         return new SinkPushChunk(id, name, chunk, error, final, sender, receiver);
@@ -263,8 +257,8 @@ class Msg {
     makeSourceFetchRequest(id, name, params, sender, receiver, auth, meta, credit) {
         return new SourceFetchRequest(id, name, params, sender, receiver, auth, meta, credit);
     }
-    makeSourceFetchResponse(id, name, error, sender, receiver, auth, meta) {
-        return new SourceFetchResponse(id, name, error, sender, receiver, auth, meta);
+    makeSourceFetchResponse(id, name, error, sender, receiver, meta) {
+        return new SourceFetchResponse(id, name, error, sender, receiver, meta);
     }
     makeSourceFetchChunk(id, name, chunk, error, final, sender, receiver) {
         return new SourceFetchChunk(id, name, chunk, error, final, sender, receiver);
@@ -280,9 +274,9 @@ class Msg {
         /*  sanity check version  */
         if (typeof obj.version !== "string")
             throw new Error("invalid object: missing or invalid \"version\" field");
-        const m = obj.version.match(/^MQTT\+\/(\d+\.\d+)$/);
-        const V = m !== null ? versionToNum(m[1]) : 0.0;
-        if (V !== version)
+        const match = obj.version.match(/^MQTT\+\/(\d+\.\d+)$/);
+        const versionNum = match !== null ? versionToNum(match[1]) : 0;
+        if (versionNum !== version)
             throw new Error(`protocol version mismatch (expected version ${VERSION}, got version ${obj.version})`);
         /*  helper function for Valibot-based validation  */
         const parseObject = (obj, name, schema) => {
@@ -314,7 +308,7 @@ class Msg {
         }
         else if (obj.type === "sink-push-response") {
             const out = parseObject(obj, "SinkPushResponse", SinkPushResponseSchema);
-            return this.makeSinkPushResponse(out.id, out.name, out.error, out.sender, out.receiver, out.auth, out.meta, out.credit);
+            return this.makeSinkPushResponse(out.id, out.name, out.error, out.sender, out.receiver, out.credit);
         }
         else if (obj.type === "sink-push-chunk") {
             const out = parseObject(obj, "SinkPushChunk", SinkPushChunkSchema);
@@ -330,7 +324,7 @@ class Msg {
         }
         else if (obj.type === "source-fetch-response") {
             const out = parseObject(obj, "SourceFetchResponse", SourceFetchResponseSchema);
-            return this.makeSourceFetchResponse(out.id, out.name, out.error, out.sender, out.receiver, out.auth, out.meta);
+            return this.makeSourceFetchResponse(out.id, out.name, out.error, out.sender, out.receiver, out.meta);
         }
         else if (obj.type === "source-fetch-chunk") {
             const out = parseObject(obj, "SourceFetchChunk", SourceFetchChunkSchema);

package/dst-stage1/mqtt-plus-options.d.ts

@@ -10,6 +10,7 @@ export interface APIOptions {
     id: string;
     codec: "cbor" | "json";
     timeout: number;
+    share: string;
     chunkSize: number;
     chunkCredit: number;
     topicMake: TopicMake;

package/dst-stage1/mqtt-plus-options.js

@@ -32,6 +32,7 @@ export class OptionsTrait {
             id: nanoid(),
             codec: "cbor",
             timeout: 10 * 1000,
+            share: "",
             chunkSize: 16 * 1024,
             chunkCredit: 4,
             topicMake: (name, operation, peerId) => {

package/dst-stage1/mqtt-plus-service.js

@@ -32,14 +32,14 @@ export class ServiceTrait extends EventTrait {
         let name;
         let callback;
         let options = {};
-        let share = "default";
+        let share = this.options.share;
         let auth;
         if (typeof nameOrConfig === "object" && nameOrConfig !== null) {
             /*  object-based API  */
             name = nameOrConfig.name;
             callback = nameOrConfig.callback;
             options = nameOrConfig.options ?? {};
-            share = nameOrConfig.share ?? "default";
+            share = nameOrConfig.share ?? this.options.share;
             auth = nameOrConfig.auth;
         }
         else {
@@ -53,7 +53,7 @@ export class ServiceTrait extends EventTrait {
         if (this.onRequest.has(`service-call-request:${name}`))
             throw new Error(`service: service "${name}" already registered`);
         /*  generate the corresponding MQTT topics for broadcast and direct use  */
-        const topicS = `$share/${share}/${name}`;
+        const topicS = share !== "" ? `$share/${share}/${name}` : name;
         const topicB = this.options.topicMake(topicS, "service-call-request");
         const topicD = this.options.topicMake(name, "service-call-request", this.options.id);
         /*  remember the registration  */
@@ -72,8 +72,8 @@ export class ServiceTrait extends EventTrait {
                 info.meta = request.meta;
             /*  asynchronously execute handler and send response  */
             Promise.resolve().then(async () => {
-                if (topicName !== name)
-                    throw new Error(`service name mismatch (topic: "${topicName}", payload: "${name}")`);
+                if (topicName !== request.name)
+                    throw new Error(`service name mismatch (topic: "${topicName}", payload: "${request.name}")`);
                 if (auth)
                     info.authenticated = await this.authenticated(senderId, request.auth, auth);
                 if (info.authenticated !== undefined && !info.authenticated)
@@ -134,18 +134,13 @@ export class ServiceTrait extends EventTrait {
         await run(`subscribe to MQTT topic "${responseTopic}"`, spool, () => this.subscriptions.subscribe(responseTopic, { qos: options.qos ?? 2 }));
         spool.roll(() => this.subscriptions.unsubscribe(responseTopic));
         /*  create promise for MQTT response handling  */
+        const timerId = `service-call:${requestId}`;
         const promise = new Promise((resolve, reject) => {
-            let timer = setTimeout(async () => {
-                timer = null;
+            this.timerRefresh(timerId, async () => {
                 await spool.unroll();
                 reject(new Error("communication timeout"));
-            }, this.options.timeout);
-            spool.roll(() => {
-                if (timer !== null) {
-                    clearTimeout(timer);
-                    timer = null;
-                }
             });
+            spool.roll(() => { this.timerClear(timerId); });
             this.onResponse.set(`service-call-response:${requestId}`, async (response) => {
                 await spool.unroll();
                 if (response.error !== undefined)