mqtt5-wasm 0.7.0 → 0.7.1

package/mqtt5_wasm.d.ts

@@ -5,6 +5,10 @@ export class WasmBridgeConfig {
   free(): void;
   [Symbol.dispose](): void;
   constructor(name: string);
+  /**
+   * # Errors
+   * Returns an error if the bridge configuration is invalid.
+   */
   validate(): void;
   add_topic(mapping: WasmTopicMapping): void;
   set password(value: string | null | undefined);
@@ -23,19 +27,47 @@ export enum WasmBridgeDirection {
 export class WasmBroker {
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * # Errors
+   * Returns an error if the bridge cannot be added.
+   */
   add_bridge(config: WasmBridgeConfig, remote_port: MessagePort): Promise<void>;
   list_roles(): Promise<string[]>;
   role_count(): Promise<number>;
   user_count(): Promise<number>;
+  /**
+   * # Errors
+   * Returns an error if the role does not exist.
+   */
   assign_role(username: string, role_name: string): Promise<void>;
   clear_roles(): Promise<void>;
   remove_role(name: string): Promise<boolean>;
   remove_user(username: string): Promise<boolean>;
+  /**
+   * # Errors
+   * Returns an error if broker initialization fails.
+   */
   static with_config(wasm_config: WasmBrokerConfig): WasmBroker;
+  /**
+   * # Errors
+   * Returns an error if the permission string is invalid.
+   */
   add_acl_rule(username: string, topic_pattern: string, permission: string): Promise<void>;
   list_bridges(): string[];
+  /**
+   * # Errors
+   * Returns an error if the permission string is invalid or role does not exist.
+   */
   add_role_rule(role_name: string, topic_pattern: string, permission: string): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if password hashing fails.
+   */
   static hash_password(password: string): string;
+  /**
+   * # Errors
+   * Returns an error if the bridge cannot be removed.
+   */
   remove_bridge(name: string): Promise<void>;
   unassign_role(username: string, role_name: string): Promise<boolean>;
   acl_rule_count(): Promise<number>;
@@ -45,10 +77,22 @@ export class WasmBroker {
   start_sys_topics(): void;
   stop_all_bridges(): Promise<void>;
   add_user_with_hash(username: string, password_hash: string): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if the `MessageChannel` cannot be created.
+   */
   create_client_port(): MessagePort;
   start_sys_topics_with_interval_secs(interval_secs: number): void;
+  /**
+   * # Errors
+   * Returns an error if broker initialization fails.
+   */
   constructor();
   add_role(name: string): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if adding the user fails.
+   */
   add_user(username: string, password: string): Promise<void>;
   has_user(username: string): Promise<boolean>;
 }
@@ -117,26 +161,86 @@ export class WasmMessageProperties {
 export class WasmMqttClient {
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * # Errors
+   * Returns an error if disconnect fails.
+   */
   disconnect(): Promise<void>;
   on_connect(callback: Function): void;
+  /**
+   * # Errors
+   * Returns an error if not connected or unsubscribe fails.
+   */
   unsubscribe(topic: string): Promise<number>;
   is_connected(): boolean;
+  /**
+   * # Errors
+   * Returns an error if not connected or publish fails.
+   */
   publish_qos1(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
+  /**
+   * # Errors
+   * Returns an error if not connected or publish fails.
+   */
   publish_qos2(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
-  respond_auth(auth_data: Uint8Array): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if no auth method is set or send fails.
+   */
+  respond_auth(auth_data: Uint8Array): void;
   on_disconnect(callback: Function): void;
   on_auth_challenge(callback: Function): void;
+  /**
+   * # Errors
+   * Returns an error if connection fails.
+   */
   connect_message_port(port: MessagePort): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if connection fails.
+   */
   connect_with_options(url: string, config: WasmConnectOptions): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if not connected or publish fails.
+   */
   publish_with_options(topic: string, payload: Uint8Array, options: WasmPublishOptions): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if not connected or subscribe fails.
+   */
   subscribe_with_options(topic: string, callback: Function, options: WasmSubscribeOptions): Promise<number>;
+  /**
+   * # Errors
+   * Returns an error if not connected or subscribe fails.
+   */
   subscribe_with_callback(topic: string, callback: Function): Promise<number>;
+  /**
+   * # Errors
+   * Returns an error if connection fails.
+   */
   connect_broadcast_channel(channel_name: string): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if connection fails.
+   */
   connect_message_port_with_options(port: MessagePort, config: WasmConnectOptions): Promise<void>;
   constructor(client_id: string);
+  /**
+   * # Errors
+   * Returns an error if connection fails.
+   */
   connect(url: string): Promise<void>;
+  /**
+   * # Errors
+   * Returns an error if not connected or publish fails.
+   */
   publish(topic: string, payload: Uint8Array): Promise<void>;
   on_error(callback: Function): void;
+  /**
+   * # Errors
+   * Returns an error if not connected or subscribe fails.
+   */
   subscribe(topic: string): Promise<number>;
 }
 
@@ -313,7 +417,7 @@ export interface InitOutput {
   readonly wasmmqttclient_publish_qos1: (a: number, b: number, c: number, d: number, e: number, f: any) => any;
   readonly wasmmqttclient_publish_qos2: (a: number, b: number, c: number, d: number, e: number, f: any) => any;
   readonly wasmmqttclient_publish_with_options: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
-  readonly wasmmqttclient_respond_auth: (a: number, b: number, c: number) => any;
+  readonly wasmmqttclient_respond_auth: (a: number, b: number, c: number) => [number, number];
   readonly wasmmqttclient_subscribe: (a: number, b: number, c: number) => any;
   readonly wasmmqttclient_subscribe_with_callback: (a: number, b: number, c: number, d: any) => any;
   readonly wasmmqttclient_subscribe_with_options: (a: number, b: number, c: number, d: any, e: number) => any;
@@ -366,12 +470,12 @@ export interface InitOutput {
   readonly wasmwillmessage_set_willDelayInterval: (a: number, b: number) => void;
   readonly wasmwillmessage_topic: (a: number) => [number, number];
   readonly wasmwillmessage_willDelayInterval: (a: number) => number;
-  readonly wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__h849099dfd9acf928: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__h25acc308bc5379fe: (a: number, b: number) => void;
   readonly wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b: (a: number, b: number) => void;
   readonly wasm_bindgen__closure__destroy__he9d43d9a42a0e056: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h849099dfd9acf928: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h16c2392199b99db1: (a: number, b: number) => void;
   readonly wasm_bindgen__convert__closures_____invoke__h1ee277075b103ebf: (a: number, b: number, c: any, d: any) => void;
   readonly __wbindgen_malloc: (a: number, b: number) => number;
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/mqtt5_wasm.js

@@ -251,16 +251,16 @@ if (!('encodeInto' in cachedTextEncoder)) {
 
 let WASM_VECTOR_LEN = 0;
 
-function wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0(arg0, arg1, arg2) {
-    wasm.wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0(arg0, arg1, arg2);
+function wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b(arg0, arg1) {
+    wasm.wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b(arg0, arg1);
 }
 
-function wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a(arg0, arg1, arg2) {
-    wasm.wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a(arg0, arg1, arg2);
+function wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0(arg0, arg1, arg2) {
+    wasm.wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0(arg0, arg1, arg2);
 }
 
-function wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b(arg0, arg1) {
-    wasm.wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b(arg0, arg1);
+function wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095(arg0, arg1, arg2) {
+    wasm.wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095(arg0, arg1, arg2);
 }
 
 function wasm_bindgen__convert__closures_____invoke__h1ee277075b103ebf(arg0, arg1, arg2, arg3) {
@@ -367,6 +367,10 @@ export class WasmBridgeConfig {
         WasmBridgeConfigFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
+    /**
+     * # Errors
+     * Returns an error if the bridge configuration is invalid.
+     */
     validate() {
         const ret = wasm.wasmbridgeconfig_validate(this.__wbg_ptr);
         if (ret[1]) {
@@ -412,6 +416,8 @@ export class WasmBroker {
         wasm.__wbg_wasmbroker_free(ptr, 0);
     }
     /**
+     * # Errors
+     * Returns an error if the bridge cannot be added.
      * @param {WasmBridgeConfig} config
      * @param {MessagePort} remote_port
      * @returns {Promise<void>}
@@ -444,6 +450,8 @@ export class WasmBroker {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if the role does not exist.
      * @param {string} username
      * @param {string} role_name
      * @returns {Promise<void>}
@@ -484,6 +492,8 @@ export class WasmBroker {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if broker initialization fails.
      * @param {WasmBrokerConfig} wasm_config
      * @returns {WasmBroker}
      */
@@ -497,6 +507,8 @@ export class WasmBroker {
         return WasmBroker.__wrap(ret[0]);
     }
     /**
+     * # Errors
+     * Returns an error if the permission string is invalid.
      * @param {string} username
      * @param {string} topic_pattern
      * @param {string} permission
@@ -522,6 +534,8 @@ export class WasmBroker {
         return v1;
     }
     /**
+     * # Errors
+     * Returns an error if the permission string is invalid or role does not exist.
      * @param {string} role_name
      * @param {string} topic_pattern
      * @param {string} permission
@@ -538,6 +552,8 @@ export class WasmBroker {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if password hashing fails.
      * @param {string} password
      * @returns {string}
      */
@@ -562,6 +578,8 @@ export class WasmBroker {
         }
     }
     /**
+     * # Errors
+     * Returns an error if the bridge cannot be removed.
      * @param {string} name
      * @returns {Promise<void>}
      */
@@ -635,6 +653,8 @@ export class WasmBroker {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if the `MessageChannel` cannot be created.
      * @returns {MessagePort}
      */
     create_client_port() {
@@ -650,6 +670,10 @@ export class WasmBroker {
     start_sys_topics_with_interval_secs(interval_secs) {
         wasm.wasmbroker_start_sys_topics_with_interval_secs(this.__wbg_ptr, interval_secs);
     }
+    /**
+     * # Errors
+     * Returns an error if broker initialization fails.
+     */
     constructor() {
         const ret = wasm.wasmbroker_new();
         if (ret[2]) {
@@ -670,6 +694,8 @@ export class WasmBroker {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if adding the user fails.
      * @param {string} username
      * @param {string} password
      * @returns {Promise<void>}
@@ -1098,6 +1124,8 @@ export class WasmMqttClient {
         wasm.__wbg_wasmmqttclient_free(ptr, 0);
     }
     /**
+     * # Errors
+     * Returns an error if disconnect fails.
      * @returns {Promise<void>}
      */
     disconnect() {
@@ -1111,6 +1139,8 @@ export class WasmMqttClient {
         wasm.wasmmqttclient_on_connect(this.__wbg_ptr, callback);
     }
     /**
+     * # Errors
+     * Returns an error if not connected or unsubscribe fails.
      * @param {string} topic
      * @returns {Promise<number>}
      */
@@ -1128,6 +1158,8 @@ export class WasmMqttClient {
         return ret !== 0;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
      * @param {string} topic
      * @param {Uint8Array} payload
      * @param {Function} callback
@@ -1142,6 +1174,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
      * @param {string} topic
      * @param {Uint8Array} payload
      * @param {Function} callback
@@ -1156,14 +1190,17 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if no auth method is set or send fails.
      * @param {Uint8Array} auth_data
-     * @returns {Promise<void>}
      */
     respond_auth(auth_data) {
         const ptr0 = passArray8ToWasm0(auth_data, wasm.__wbindgen_malloc);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.wasmmqttclient_respond_auth(this.__wbg_ptr, ptr0, len0);
-        return ret;
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
     }
     /**
      * @param {Function} callback
@@ -1178,6 +1215,8 @@ export class WasmMqttClient {
         wasm.wasmmqttclient_on_auth_challenge(this.__wbg_ptr, callback);
     }
     /**
+     * # Errors
+     * Returns an error if connection fails.
      * @param {MessagePort} port
      * @returns {Promise<void>}
      */
@@ -1186,6 +1225,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if connection fails.
      * @param {string} url
      * @param {WasmConnectOptions} config
      * @returns {Promise<void>}
@@ -1198,6 +1239,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
      * @param {string} topic
      * @param {Uint8Array} payload
      * @param {WasmPublishOptions} options
@@ -1213,6 +1256,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
      * @param {string} topic
      * @param {Function} callback
      * @param {WasmSubscribeOptions} options
@@ -1226,6 +1271,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
      * @param {string} topic
      * @param {Function} callback
      * @returns {Promise<number>}
@@ -1237,6 +1284,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if connection fails.
      * @param {string} channel_name
      * @returns {Promise<void>}
      */
@@ -1247,6 +1296,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if connection fails.
      * @param {MessagePort} port
      * @param {WasmConnectOptions} config
      * @returns {Promise<void>}
@@ -1268,6 +1319,8 @@ export class WasmMqttClient {
         return this;
     }
     /**
+     * # Errors
+     * Returns an error if connection fails.
      * @param {string} url
      * @returns {Promise<void>}
      */
@@ -1278,6 +1331,8 @@ export class WasmMqttClient {
         return ret;
     }
     /**
+     * # Errors
+     * Returns an error if not connected or publish fails.
      * @param {string} topic
      * @param {Uint8Array} payload
      * @returns {Promise<void>}
@@ -1297,6 +1352,8 @@ export class WasmMqttClient {
         wasm.wasmmqttclient_on_error(this.__wbg_ptr, callback);
     }
     /**
+     * # Errors
+     * Returns an error if not connected or subscribe fails.
      * @param {string} topic
      * @returns {Promise<number>}
      */
@@ -1788,6 +1845,9 @@ function __wbg_get_imports() {
     imports.wbg.__wbg__wbg_cb_unref_87dfb5aaa0cbcea7 = function(arg0) {
         arg0._wbg_cb_unref();
     };
+    imports.wbg.__wbg_addEventListener_6a82629b3d430a48 = function() { return handleError(function (arg0, arg1, arg2, arg3) {
+        arg0.addEventListener(getStringFromWasm0(arg1, arg2), arg3);
+    }, arguments) };
     imports.wbg.__wbg_buffer_6cb2fecb1f253d71 = function(arg0) {
         const ret = arg0.buffer;
         return ret;
@@ -2048,24 +2108,19 @@ function __wbg_get_imports() {
         const ret = v0;
         return ret;
     };
-    imports.wbg.__wbindgen_cast_5208882bb9fe3820 = function(arg0, arg1) {
-        // Cast intrinsic for `Closure(Closure { dtor_idx: 358, function: Function { arguments: [], shim_idx: 359, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    imports.wbg.__wbindgen_cast_7249b77047b5c954 = function(arg0, arg1) {
+        // Cast intrinsic for `Closure(Closure { dtor_idx: 355, function: Function { arguments: [], shim_idx: 356, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
         const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__he9d43d9a42a0e056, wasm_bindgen__convert__closures_____invoke__hf9723d0014506a5b);
         return ret;
     };
-    imports.wbg.__wbindgen_cast_663c73182bf372f2 = function(arg0, arg1) {
-        // Cast intrinsic for `Closure(Closure { dtor_idx: 369, function: Function { arguments: [Externref], shim_idx: 370, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h849099dfd9acf928, wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0);
-        return ret;
-    };
     imports.wbg.__wbindgen_cast_a6d58121ace2ceaa = function(arg0, arg1) {
         // Cast intrinsic for `Closure(Closure { dtor_idx: 7, function: Function { arguments: [NamedExternref("ErrorEvent")], shim_idx: 8, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h25acc308bc5379fe, wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a);
+        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h16c2392199b99db1, wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095);
         return ret;
     };
     imports.wbg.__wbindgen_cast_d3f7166d7f91ad34 = function(arg0, arg1) {
         // Cast intrinsic for `Closure(Closure { dtor_idx: 7, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 8, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h25acc308bc5379fe, wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a);
+        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h16c2392199b99db1, wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095);
         return ret;
     };
     imports.wbg.__wbindgen_cast_d6cd19b81560fd6e = function(arg0) {
@@ -2073,9 +2128,14 @@ function __wbg_get_imports() {
         const ret = arg0;
         return ret;
     };
+    imports.wbg.__wbindgen_cast_e7f97fba0726b4ab = function(arg0, arg1) {
+        // Cast intrinsic for `Closure(Closure { dtor_idx: 366, function: Function { arguments: [Externref], shim_idx: 367, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h849099dfd9acf928, wasm_bindgen__convert__closures_____invoke__ha9d3e198cd0951b0);
+        return ret;
+    };
     imports.wbg.__wbindgen_cast_fac85390ef55bfaa = function(arg0, arg1) {
         // Cast intrinsic for `Closure(Closure { dtor_idx: 7, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 8, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h25acc308bc5379fe, wasm_bindgen__convert__closures_____invoke__h083737b2f77d415a);
+        const ret = makeMutClosure(arg0, arg1, wasm.wasm_bindgen__closure__destroy__h16c2392199b99db1, wasm_bindgen__convert__closures_____invoke__h062394b5bffa0095);
         return ret;
     };
     imports.wbg.__wbindgen_init_externref_table = function() {

package/package.json

@@ -5,7 +5,7 @@
     "fabriciobracht <fabricio@bracht.dev>"
   ],
   "description": "MQTT v5.0 WebAssembly client and broker for browser environments",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",