mqtt-plus 0.9.8 → 0.9.9

package/README.md

@@ -47,9 +47,9 @@ communication patterns with type safety:
   Service Call is a *bi-directional* communication pattern.
   A Service is the combination of a service name and optionally zero or more arguments.
   You *register* for a service.
-  When a service is *called*, a single particular registrator (in case
-  of a directed service call) or one arbitrary registrator is called and
-  receives the arguments as the request. The registrator then has to
+  When a service is *called*, a single particular registrant (in case
+  of a directed service call) or one arbitrary registrant is called and
+  receives the arguments as the request. The registrant then has to
   provide the service response.
 
   In contrast to the regular uni-directional MQTT message
@@ -72,7 +72,8 @@ communication patterns with type safety:
 
   In contrast to the regular MQTT message publish/subscribe, this
   pattern allows to transfer arbitrary amounts of arbitrary data by
-  chunking the data via a stream.
+  chunking the data via a stream. Additionally, it supports optional
+  metadata transfer alongside the resource data.
 
   ![Resource Transfer](doc/mqtt-plus-3-resource-transfer.svg)
 
@@ -229,7 +230,7 @@ The **MQTT+** API provides the following methods:
   The `callback` is called with the `params` passed to a remote `call()`.
   The return value of `callback` will resolve the `Promise` returned by the remote `call()`.
 
-  Internally, on the MQTT broker, the topics by
+  Internally, on the MQTT broker, the topics generated by
   `topicMake(service, "service-call-request")` (default: `${service}/service-call-request/any` and
   `${service}/service-call-request/${peerId}`) are subscribed. Returns a
   `Registration` object with an `unregister()` method.
@@ -246,6 +247,7 @@ The **MQTT+** API provides the following methods:
                   sender: string,
                   receiver?: string,
                   resource: Buffer | Readable | null,
+                  meta?: Record<string, any>,
                   stream?: Readable,
                   buffer?: Promise<Buffer>
               }
@@ -258,10 +260,12 @@ The **MQTT+** API provides the following methods:
 
   For **fetch requests**: The `callback` is called with the `params` passed to a remote `fetch()`.
   The `callback` should set `info.resource` to a `Buffer` or `Readable` containing the resource data.
+  Optionally, the `callback` can set `info.meta` to a `Record<string, any>` to send metadata back with the response.
 
   For **pushed data**: The `callback` is called with the `params` passed to a remote `push()`.
   The `info.stream` provides a Node.js `Readable` stream for consuming the pushed data.
   The `info.buffer` provides a lazy `Promise<Buffer>` that resolves to the complete data once the stream ends.
+  The `info.meta` contains optional metadata sent by the pusher via `push()`.
 
   Internally, on the MQTT broker, the topics by
   `topicMake(resource, "resource-transfer-request")` and `topicMake(resource, "resource-transfer-response")`
@@ -319,17 +323,20 @@ The **MQTT+** API provides the following methods:
           receiver?: Receiver,
           options?:  MQTT::IClientSubscribeOptions,
           ...params: any[]
-      ): Promise<{ stream: Readable, buffer: Promise<Buffer> }>
+      ): Promise<{ stream: Readable, buffer: Promise<Buffer>, meta: Promise<Record<string, any> | undefined> }>
 
   Fetches a resource from any resource provisioner or from a specific provisioner.
   The optional `receiver` directs the call to a specific provisioner only.
   The optional `options` allows setting MQTT.js `publish()` options like `qos` or `retain`.
 
-  Returns an object with a `stream` (`Readable`) for consuming the transferred data
-  and a lazy `buffer` (`Promise<Buffer>`) that resolves to the complete data once the stream ends.
+  Returns an object with a `stream` (`Readable`) for consuming the transferred data,
+  a lazy `buffer` (`Promise<Buffer>`) that resolves to the complete data once the stream ends,
+  and a `meta` (`Promise<Record<string, any> | undefined>`) that resolves to optional metadata
+  sent by the provisioner when the first chunk arrives.
 
   The remote `provision()` `callback` is called with `params` and
   should set `info.resource` to a `Buffer` or `Readable` containing the resource data.
+  Optionally, the `callback` can set `info.meta` to send metadata back with the response.
   If the remote `callback` throws an exception, this destroys the stream with the error.
 
   Internally, on the MQTT broker, the topic by
@@ -343,6 +350,7 @@ The **MQTT+** API provides the following methods:
       push(
           resource:       string,
           streamOrBuffer: Readable | Buffer,
+          meta?:          Meta,
           receiver?:      Receiver,
           options?:       MQTT::IClientPublishOptions,
           ...params:      any[]
@@ -350,6 +358,8 @@ The **MQTT+** API provides the following methods:
 
   Pushes a resource to all provisioners or a specific provisioner.
   The `streamOrBuffer` is either a Node.js `Readable` stream or a `Buffer` providing the data to push.
+  The optional `meta` (wrapped via `meta()`) sends metadata alongside the resource data,
+  which becomes available on the provisioner side via `info.meta`.
   The optional `receiver` directs the push to a specific provisioner only.
   The optional `options` allows setting MQTT.js `publish()` options like `qos` or `retain`.
 
@@ -359,8 +369,9 @@ The **MQTT+** API provides the following methods:
   The returned `Promise` resolves when the entire data has been pushed.
 
   The remote `provision()` `callback` is called with `params` and an `info` object
-  containing `stream` (`Readable`) for consuming the pushed data and
-  `buffer` (lazy `Promise<Buffer>`) that resolves to the complete data once the stream ends.
+  containing `stream` (`Readable`) for consuming the pushed data,
+  `buffer` (lazy `Promise<Buffer>`) that resolves to the complete data once the stream ends,
+  and `meta` (`Record<string, any> | undefined`) containing the metadata sent by the pusher.
 
   Internally, publishes to the MQTT topic by `topicMake(resource, "resource-transfer-response", peerId)`
   (default: `${resource}/resource-transfer-response/any` or `${resource}/resource-transfer-response/${peerId}`).
@@ -374,6 +385,16 @@ The **MQTT+** API provides the following methods:
   Wrap a receiver ID string for use with `emit()`, `call()`, `fetch()` or `push()` to direct the
   message to a specific receiver. Returns a `Receiver` object.
 
+- **Meta Wrapping**:<br/>
+
+      meta(
+          data: Record<string, any>
+      ): Meta
+
+  Wrap a metadata object for use with `push()` to send metadata alongside the resource data.
+  The metadata is transferred with the first chunk and becomes available on the provisioner
+  side via `info.meta`. Returns a `Meta` object.
+
 Internals
 ---------
 
@@ -556,9 +577,9 @@ The output will be:
 ```
 $ node sample.ts
 CONNECT
-RECEIVED example/hello/service-call-request/any {"id":"vwLzfQDu2uEeOdOfIlT42","sender":"2IBMSk0NPnrz1AeTERoea","service":"example/hello","params":["world",42]}
+RECEIVED example/hello/service-call-request/any {"type":"service-call-request","id":"vwLzfQDu2uEeOdOfIlT42","sender":"2IBMSk0NPnrz1AeTERoea","service":"example/hello","params":["world",42]}
 example/hello: request: world 42 from: 2IBMSk0NPnrz1AeTERoea
-RECEIVED example/hello/service-call-response/2IBMSk0NPnrz1AeTERoea {"id":"vwLzfQDu2uEeOdOfIlT42","sender":"2IBMSk0NPnrz1AeTERoea","receiver":"2IBMSk0NPnrz1AeTERoea","result":"world:42"}
+RECEIVED example/hello/service-call-response/2IBMSk0NPnrz1AeTERoea {"type":"service-call-response","id":"vwLzfQDu2uEeOdOfIlT42","sender":"2IBMSk0NPnrz1AeTERoea","receiver":"2IBMSk0NPnrz1AeTERoea","result":"world:42"}
 example/hello success: world:42
 CLOSE
 ```

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

@@ -1,15 +1,17 @@
 import { MqttClient, IClientPublishOptions, IClientSubscribeOptions } from "mqtt";
 import { APISchema } from "./mqtt-plus-api";
 import { APIOptions } from "./mqtt-plus-options";
-import { ReceiverTrait } from "./mqtt-plus-receiver";
-export declare class BaseTrait<T extends APISchema = APISchema> extends ReceiverTrait<T> {
+import { MetaTrait } from "./mqtt-plus-meta";
+export declare class BaseTrait<T extends APISchema = APISchema> extends MetaTrait<T> {
     protected mqtt: MqttClient;
+    private _messageHandler;
     constructor(mqtt: MqttClient, options?: Partial<APIOptions>);
     destroy(): void;
     protected _subscribeTopic(topic: string, options?: Partial<IClientSubscribeOptions>): Promise<void>;
     protected _unsubscribeTopic(topic: string): Promise<void>;
     private _isIClientPublishOptions;
     protected _parseCallArgs<U extends any[]>(args: any[]): {
+        meta?: Record<string, any>;
         receiver?: string;
         options: IClientPublishOptions;
         params: U;

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

@@ -21,22 +21,23 @@
 **  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 **  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
-import { ReceiverTrait } from "./mqtt-plus-receiver";
+import { MetaTrait } from "./mqtt-plus-meta";
 /*  MQTTp Base class with shared infrastructure  */
-export class BaseTrait extends ReceiverTrait {
+export class BaseTrait extends MetaTrait {
     /*  construct API class  */
     constructor(mqtt, options = {}) {
         super(options);
         /*  store MQTT client  */
         this.mqtt = mqtt;
         /*  hook into the MQTT message processing  */
-        this.mqtt.on("message", (topic, message, packet) => {
+        this._messageHandler = (topic, message, packet) => {
             this._onMessage(topic, message, packet);
-        });
+        };
+        this.mqtt.on("message", this._messageHandler);
     }
     /*  destroy API class  */
     destroy() {
-        this.mqtt.removeAllListeners();
+        this.mqtt.off("message", this._messageHandler);
     }
     /*  subscribe to an MQTT topic (Promise-based)  */
     async _subscribeTopic(topic, options = {}) {
@@ -67,8 +68,13 @@ export class BaseTrait extends ReceiverTrait {
         const keys = ["qos", "retain", "dup", "properties", "cbStorePut"];
         return Object.keys(arg).every((key) => keys.includes(key));
     }
-    /*  parse optional peerId and options from variadic arguments  */
+    /*  parse optional meta, receiver and options from variadic arguments  */
     _parseCallArgs(args) {
+        /*  extract optional meta from arguments  */
+        let meta;
+        if (args.length > 0 && this._isMeta(args[0]))
+            meta = this._getMeta(args.shift());
+        /*  extract optional receiver and options from arguments  */
         let receiver;
         let options = {};
         let params = args;
@@ -85,11 +91,11 @@ export class BaseTrait extends ReceiverTrait {
             options = args[0];
             params = args.slice(1);
         }
-        return { receiver, options, params };
+        return { meta, receiver, options, params };
     }
     /*  handle incoming MQTT message  */
     _onMessage(topic, message, packet) {
-        /*  try to parse payload as payload  */
+        /*  try to parse message as payload  */
         let parsed;
         try {
             let input = message;

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

@@ -83,7 +83,7 @@ export class EventTrait extends BaseTrait {
         /*  generate corresponding MQTT topic  */
         const topic = this.options.topicMake(event, "event-emission", receiver);
         /*  publish message to MQTT topic  */
-        this.mqtt.publish(topic, message, { qos: 2, ...options });
+        this.mqtt.publish(topic, message, { qos: 0, ...options });
     }
     /*  dispatch message (Event pattern handling)  */
     _dispatchMessage(topic, parsed) {

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

@@ -9,6 +9,7 @@ export interface InfoService extends InfoBase {
 }
 export interface InfoResource extends InfoBase {
     resource: Buffer | Readable | null;
+    meta?: Record<string, any>;
     stream?: Readable;
     buffer?: Promise<Buffer>;
 }

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

@@ -0,0 +1,12 @@
+import { APISchema } from "./mqtt-plus-api";
+import { ReceiverTrait } from "./mqtt-plus-receiver";
+export type Meta = {
+    __meta: Record<string, any>;
+};
+export declare class MetaTrait<T extends APISchema = APISchema> extends ReceiverTrait<T> {
+    meta(data: Record<string, any>): {
+        __meta: Record<string, any>;
+    };
+    protected _getMeta(obj: Meta): Record<string, any>;
+    protected _isMeta(obj: any): obj is Meta;
+}

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

@@ -0,0 +1,43 @@
+/*
+**  MQTT+ -- MQTT Communication Patterns
+**  Copyright (c) 2018-2026 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**
+**  Permission is hereby granted, free of charge, to any person obtaining
+**  a copy of this software and associated documentation files (the
+**  "Software"), to deal in the Software without restriction, including
+**  without limitation the rights to use, copy, modify, merge, publish,
+**  distribute, sublicense, and/or sell copies of the Software, and to
+**  permit persons to whom the Software is furnished to do so, subject to
+**  the following conditions:
+**
+**  The above copyright notice and this permission notice shall be included
+**  in all copies or substantial portions of the Software.
+**
+**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+**  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+**  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+**  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+**  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+**  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+**  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+import { ReceiverTrait } from "./mqtt-plus-receiver";
+/*  Meta trait  */
+export class MetaTrait extends ReceiverTrait {
+    /*  wrap meta object into wrapper (required for type-safe overloading)  */
+    meta(data) {
+        return { __meta: data };
+    }
+    /*  return meta object from wrapper object  */
+    _getMeta(obj) {
+        return obj.__meta;
+    }
+    /*  detect meta wrapper object  */
+    _isMeta(obj) {
+        return (typeof obj === "object"
+            && obj !== null
+            && "__meta" in obj
+            && typeof obj.__meta === "object"
+            && obj.__meta !== null);
+    }
+}

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

@@ -31,16 +31,17 @@ export declare class ResourceTransferResponse extends Base {
     resource?: string | undefined;
     params?: any[] | undefined;
     chunk?: Buffer | undefined;
+    meta?: Record<string, any> | undefined;
     error?: string | undefined;
     final?: boolean | undefined;
-    constructor(id: string, resource?: string | undefined, params?: any[] | undefined, chunk?: Buffer | undefined, error?: string | undefined, final?: boolean | undefined, sender?: string, receiver?: string);
+    constructor(id: string, resource?: string | undefined, params?: any[] | undefined, chunk?: Buffer | undefined, meta?: Record<string, any> | undefined, error?: string | undefined, final?: boolean | undefined, sender?: string, receiver?: string);
 }
 export default class Msg {
     makeEventEmission(id: string, event: string, params?: any[], sender?: string, receiver?: string): EventEmission;
     makeServiceCallRequest(id: string, service: string, params?: any[], sender?: string, receiver?: string): ServiceCallRequest;
     makeServiceCallResponse(id: string, result?: any, error?: string, sender?: string, receiver?: string): ServiceCallResponse;
     makeResourceTransferRequest(id: string, resource: string, params?: any[], sender?: string, receiver?: string): ResourceTransferRequest;
-    makeResourceTransferResponse(id: string, resource?: string, params?: any[], chunk?: Buffer, error?: string, final?: boolean, sender?: string, receiver?: string): ResourceTransferResponse;
+    makeResourceTransferResponse(id: string, resource?: string, params?: any[], chunk?: Buffer, meta?: Record<string, any>, error?: string, final?: boolean, sender?: string, receiver?: string): ResourceTransferResponse;
     parse(obj: any): EventEmission | ServiceCallRequest | ServiceCallResponse | ResourceTransferRequest | ResourceTransferResponse;
 }
 export declare class MsgTrait<T extends APISchema = APISchema> extends CodecTrait<T> {

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

@@ -65,11 +65,12 @@ export class ResourceTransferRequest extends Base {
 }
 /*  resource response  */
 export class ResourceTransferResponse extends Base {
-    constructor(id, resource, params, chunk, error, final, sender, receiver) {
+    constructor(id, resource, params, chunk, meta, error, final, sender, receiver) {
         super("resource-transfer-response", id, sender, receiver);
         this.resource = resource;
         this.params = params;
         this.chunk = chunk;
+        this.meta = meta;
         this.error = error;
         this.final = final;
     }
@@ -93,8 +94,8 @@ export default class Msg {
         return new ResourceTransferRequest(id, resource, params, sender, receiver);
     }
     /*  factory for resource response  */
-    makeResourceTransferResponse(id, resource, params, chunk, error, final, sender, receiver) {
-        return new ResourceTransferResponse(id, resource, params, chunk, error, final, sender, receiver);
+    makeResourceTransferResponse(id, resource, params, chunk, meta, error, final, sender, receiver) {
+        return new ResourceTransferResponse(id, resource, params, chunk, meta, error, final, sender, receiver);
     }
     /*  parse any object into typed object  */
     parse(obj) {
@@ -153,21 +154,24 @@ export default class Msg {
                 throw new Error("invalid ResourceTransferResponse object: \"resource\" field must be a string");
             if (obj.chunk !== undefined && typeof obj.chunk !== "object")
                 throw new Error("invalid ResourceTransferResponse object: \"chunk\" field must be an object");
+            if (obj.meta !== undefined && (typeof obj.meta !== "object" || obj.meta === null || Array.isArray(obj.meta)))
+                throw new Error("invalid ResourceTransferResponse object: \"meta\" field must be an object");
             if (obj.error !== undefined && typeof obj.error !== "string")
                 throw new Error("invalid ResourceTransferResponse object: \"error\" field must be a string");
             if (obj.final !== undefined && typeof obj.final !== "boolean")
                 throw new Error("invalid ResourceTransferResponse object: \"final\" field must be a boolean");
             if (!validParams(obj))
                 throw new Error("invalid ResourceTransferResponse object: \"params\" field must be an array");
-            if (anyFieldsExcept(obj, ["type", "id", "resource", "params", "chunk", "error", "final", "sender", "receiver"]))
+            if (anyFieldsExcept(obj, ["type", "id", "resource", "params",
+                "chunk", "meta", "error", "final", "sender", "receiver"]))
                 throw new Error("invalid ResourceTransferResponse object: contains unknown fields");
-            return this.makeResourceTransferResponse(obj.id, obj.resource, obj.params, obj.chunk, obj.error, obj.final, obj.sender, obj.receiver);
+            return this.makeResourceTransferResponse(obj.id, obj.resource, obj.params, obj.chunk, obj.meta, obj.error, obj.final, obj.sender, obj.receiver);
         }
         else
             throw new Error("invalid object: not of any known type");
     }
 }
-/*  Msg trait  */
+/*  message trait  */
 export class MsgTrait extends CodecTrait {
     constructor() {
         super(...arguments);

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

@@ -38,7 +38,11 @@ export class OptionsTrait {
             },
             topicMatch: (topic) => {
                 const m = topic.match(/^(.+)\/([^/]+)\/([^/]+)$/);
-                return m ? { name: m[1], operation: m[2], peerId: m[3] === "any" ? undefined : m[3] } : null;
+                return m ? {
+                    name: m[1],
+                    operation: m[2],
+                    peerId: m[3] === "any" ? undefined : m[3]
+                } : null;
             },
             ...options
         };

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

@@ -3,6 +3,7 @@ import { IClientPublishOptions, IClientSubscribeOptions } from "mqtt";
 import { APISchema, ResourceKeys } from "./mqtt-plus-api";
 import type { WithInfo, InfoResource } from "./mqtt-plus-info";
 import type { Receiver } from "./mqtt-plus-receiver";
+import type { Meta } from "./mqtt-plus-meta";
 import { ServiceTrait } from "./mqtt-plus-service";
 export interface Provisioning {
     unprovision(): Promise<void>;
@@ -11,12 +12,9 @@ export declare class ResourceTrait<T extends APISchema = APISchema> extends Serv
     private provisionings;
     private callbacks;
     private pushStreams;
+    private pushTimers;
     provision<K extends ResourceKeys<T> & string>(resource: K, callback: WithInfo<T[K], InfoResource>): Promise<Provisioning>;
     provision<K extends ResourceKeys<T> & string>(resource: K, options: Partial<IClientSubscribeOptions>, callback: WithInfo<T[K], InfoResource>): Promise<Provisioning>;
-    private _collectStreamToBuffer;
-    private _chunkToBuffer;
-    private _sendBufferAsChunks;
-    private _sendStreamAsChunks;
     push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, ...params: Parameters<T[K]>): Promise<void>;
     push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, receiver: Receiver, ...params: Parameters<T[K]>): Promise<void>;
     push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
@@ -25,21 +23,33 @@ export declare class ResourceTrait<T extends APISchema = APISchema> extends Serv
     push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, receiver: Receiver, ...params: Parameters<T[K]>): Promise<void>;
     push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
     push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, receiver: Receiver, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, meta: Meta, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, meta: Meta, receiver: Receiver, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, meta: Meta, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, buffer: Buffer, meta: Meta, receiver: Receiver, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, meta: Meta, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, meta: Meta, receiver: Receiver, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, meta: Meta, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
+    push<K extends ResourceKeys<T> & string>(resource: K, stream: Readable, meta: Meta, receiver: Receiver, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<void>;
     fetch<K extends ResourceKeys<T> & string>(resource: K, ...params: Parameters<T[K]>): Promise<{
         stream: Readable;
         buffer: Promise<Buffer>;
+        meta: Promise<Record<string, any> | undefined>;
     }>;
     fetch<K extends ResourceKeys<T> & string>(resource: K, receiver: Receiver, ...params: Parameters<T[K]>): Promise<{
         stream: Readable;
         buffer: Promise<Buffer>;
+        meta: Promise<Record<string, any> | undefined>;
     }>;
     fetch<K extends ResourceKeys<T> & string>(resource: K, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<{
         stream: Readable;
         buffer: Promise<Buffer>;
+        meta: Promise<Record<string, any> | undefined>;
     }>;
     fetch<K extends ResourceKeys<T> & string>(resource: K, receiver: Receiver, options: IClientPublishOptions, ...params: Parameters<T[K]>): Promise<{
         stream: Readable;
         buffer: Promise<Buffer>;
+        meta: Promise<Record<string, any> | undefined>;
     }>;
     protected _dispatchMessage(topic: string, parsed: any): void;
 }