mqtt5-wasm 0.1.0

package/README.md

@@ -0,0 +1,49 @@
+# mqtt5-wasm
+
+MQTT v5.0 WebAssembly client and broker for browser environments.
+
+## Features
+
+- **WebSocket transport** - Connect to remote MQTT brokers
+- **In-tab broker** - Run a complete MQTT broker in the browser
+- **MessagePort/BroadcastChannel** - Inter-tab communication
+- **Full QoS support** - QoS 0, 1, and 2
+- **Automatic keepalive** - Connection health monitoring
+
+## Installation
+
+```toml
+[dependencies]
+mqtt5-wasm = "0.10"
+```
+
+Build with wasm-pack:
+
+```bash
+wasm-pack build --target web --features client,broker
+```
+
+## Usage
+
+```javascript
+import init, { WasmMqttClient } from "./pkg/mqtt5_wasm.js";
+
+await init();
+const client = new WasmMqttClient("browser-client");
+
+await client.connect("ws://broker.example.com:8080/mqtt");
+
+await client.subscribe_with_callback("sensors/#", (topic, payload) => {
+  console.log(`${topic}: ${new TextDecoder().decode(payload)}`);
+});
+
+await client.publish("sensors/temp", new TextEncoder().encode("25.5"));
+```
+
+## Documentation
+
+See the [main repository](https://github.com/LabOverWire/mqtt-lib) for complete documentation and examples.
+
+## License
+
+Licensed under either of Apache License, Version 2.0 or MIT license at your option.

package/mqtt5_wasm.d.ts

@@ -0,0 +1,292 @@
+/* tslint:disable */
+/* eslint-disable */
+export class WasmBroker {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  static with_config(wasm_config: WasmBrokerConfig): WasmBroker;
+  add_user(username: string, password: string): Promise<void>;
+  add_user_with_hash(username: string, password_hash: string): Promise<void>;
+  remove_user(username: string): Promise<boolean>;
+  has_user(username: string): Promise<boolean>;
+  user_count(): Promise<number>;
+  set_allow_anonymous(allow: boolean): void;
+  static hash_password(password: string): string;
+  create_client_port(): MessagePort;
+}
+export class WasmBrokerConfig {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  set max_clients(value: number);
+  set session_expiry_interval_secs(value: number);
+  set max_packet_size(value: number);
+  set topic_alias_maximum(value: number);
+  set retain_available(value: boolean);
+  set maximum_qos(value: number);
+  set wildcard_subscription_available(value: boolean);
+  set subscription_identifier_available(value: boolean);
+  set shared_subscription_available(value: boolean);
+  set server_keep_alive_secs(value: number | null | undefined);
+}
+export class WasmConnectOptions {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  set_will(will: WasmWillMessage): void;
+  clear_will(): void;
+  addUserProperty(key: string, value: string): void;
+  clearUserProperties(): void;
+  keepAlive: number;
+  cleanStart: boolean;
+  get username(): string | undefined;
+  set username(value: string | null | undefined);
+  set password(value: Uint8Array);
+  get sessionExpiryInterval(): number | undefined;
+  set sessionExpiryInterval(value: number | null | undefined);
+  get receiveMaximum(): number | undefined;
+  set receiveMaximum(value: number | null | undefined);
+  get maximumPacketSize(): number | undefined;
+  set maximumPacketSize(value: number | null | undefined);
+  get topicAliasMaximum(): number | undefined;
+  set topicAliasMaximum(value: number | null | undefined);
+  get requestResponseInformation(): boolean | undefined;
+  set requestResponseInformation(value: boolean | null | undefined);
+  get requestProblemInformation(): boolean | undefined;
+  set requestProblemInformation(value: boolean | null | undefined);
+  get authenticationMethod(): string | undefined;
+  set authenticationMethod(value: string | null | undefined);
+  set authenticationData(value: Uint8Array);
+}
+export class WasmMqttClient {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(client_id: string);
+  connect(url: string): Promise<void>;
+  connect_with_options(url: string, config: WasmConnectOptions): Promise<void>;
+  connect_message_port(port: MessagePort): Promise<void>;
+  connect_broadcast_channel(channel_name: string): Promise<void>;
+  publish(topic: string, payload: Uint8Array): Promise<void>;
+  publish_with_options(topic: string, payload: Uint8Array, options: WasmPublishOptions): Promise<void>;
+  publish_qos1(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
+  publish_qos2(topic: string, payload: Uint8Array, callback: Function): Promise<number>;
+  subscribe(topic: string): Promise<number>;
+  subscribe_with_options(topic: string, callback: Function, options: WasmSubscribeOptions): Promise<number>;
+  subscribe_with_callback(topic: string, callback: Function): Promise<number>;
+  unsubscribe(topic: string): Promise<number>;
+  disconnect(): Promise<void>;
+  is_connected(): boolean;
+  on_connect(callback: Function): void;
+  on_disconnect(callback: Function): void;
+  on_error(callback: Function): void;
+  on_auth_challenge(callback: Function): void;
+  respond_auth(auth_data: Uint8Array): Promise<void>;
+}
+export class WasmPublishOptions {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  addUserProperty(key: string, value: string): void;
+  clearUserProperties(): void;
+  qos: number;
+  retain: boolean;
+  get payloadFormatIndicator(): boolean | undefined;
+  set payloadFormatIndicator(value: boolean | null | undefined);
+  get messageExpiryInterval(): number | undefined;
+  set messageExpiryInterval(value: number | null | undefined);
+  get topicAlias(): number | undefined;
+  set topicAlias(value: number | null | undefined);
+  get responseTopic(): string | undefined;
+  set responseTopic(value: string | null | undefined);
+  set correlationData(value: Uint8Array);
+  get contentType(): string | undefined;
+  set contentType(value: string | null | undefined);
+}
+export class WasmSubscribeOptions {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  qos: number;
+  noLocal: boolean;
+  retainAsPublished: boolean;
+  retainHandling: number;
+  get subscriptionIdentifier(): number | undefined;
+  set subscriptionIdentifier(value: number | null | undefined);
+}
+export class WasmWillMessage {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(topic: string, payload: Uint8Array);
+  topic: string;
+  qos: number;
+  retain: boolean;
+  get willDelayInterval(): number | undefined;
+  set willDelayInterval(value: number | null | undefined);
+  get messageExpiryInterval(): number | undefined;
+  set messageExpiryInterval(value: number | null | undefined);
+  get contentType(): string | undefined;
+  set contentType(value: string | null | undefined);
+  get responseTopic(): string | undefined;
+  set responseTopic(value: string | null | undefined);
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_wasmbrokerconfig_free: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_new: () => number;
+  readonly wasmbrokerconfig_set_max_clients: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_session_expiry_interval_secs: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_max_packet_size: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_topic_alias_maximum: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_retain_available: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_maximum_qos: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_wildcard_subscription_available: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_subscription_identifier_available: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_shared_subscription_available: (a: number, b: number) => void;
+  readonly wasmbrokerconfig_set_server_keep_alive_secs: (a: number, b: number) => void;
+  readonly __wbg_wasmbroker_free: (a: number, b: number) => void;
+  readonly wasmbroker_new: () => [number, number, number];
+  readonly wasmbroker_with_config: (a: number) => [number, number, number];
+  readonly wasmbroker_add_user: (a: number, b: number, c: number, d: number, e: number) => any;
+  readonly wasmbroker_add_user_with_hash: (a: number, b: number, c: number, d: number, e: number) => any;
+  readonly wasmbroker_remove_user: (a: number, b: number, c: number) => any;
+  readonly wasmbroker_has_user: (a: number, b: number, c: number) => any;
+  readonly wasmbroker_user_count: (a: number) => any;
+  readonly wasmbroker_set_allow_anonymous: (a: number, b: number) => void;
+  readonly wasmbroker_hash_password: (a: number, b: number) => [number, number, number, number];
+  readonly wasmbroker_create_client_port: (a: number) => [number, number, number];
+  readonly __wbg_wasmmqttclient_free: (a: number, b: number) => void;
+  readonly wasmmqttclient_new: (a: number, b: number) => number;
+  readonly wasmmqttclient_connect: (a: number, b: number, c: number) => any;
+  readonly wasmmqttclient_connect_with_options: (a: number, b: number, c: number, d: number) => any;
+  readonly wasmmqttclient_connect_message_port: (a: number, b: any) => any;
+  readonly wasmmqttclient_connect_broadcast_channel: (a: number, b: number, c: number) => any;
+  readonly wasmmqttclient_publish: (a: number, b: number, c: number, d: number, e: number) => any;
+  readonly wasmmqttclient_publish_with_options: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  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_subscribe: (a: number, b: number, c: number) => any;
+  readonly wasmmqttclient_subscribe_with_options: (a: number, b: number, c: number, d: any, e: number) => any;
+  readonly wasmmqttclient_subscribe_with_callback: (a: number, b: number, c: number, d: any) => any;
+  readonly wasmmqttclient_unsubscribe: (a: number, b: number, c: number) => any;
+  readonly wasmmqttclient_disconnect: (a: number) => any;
+  readonly wasmmqttclient_is_connected: (a: number) => number;
+  readonly wasmmqttclient_on_connect: (a: number, b: any) => void;
+  readonly wasmmqttclient_on_disconnect: (a: number, b: any) => void;
+  readonly wasmmqttclient_on_error: (a: number, b: any) => void;
+  readonly wasmmqttclient_on_auth_challenge: (a: number, b: any) => void;
+  readonly wasmmqttclient_respond_auth: (a: number, b: number, c: number) => any;
+  readonly __wbg_wasmconnectoptions_free: (a: number, b: number) => void;
+  readonly wasmconnectoptions_new: () => number;
+  readonly wasmconnectoptions_keepAlive: (a: number) => number;
+  readonly wasmconnectoptions_set_keepAlive: (a: number, b: number) => void;
+  readonly wasmconnectoptions_cleanStart: (a: number) => number;
+  readonly wasmconnectoptions_set_cleanStart: (a: number, b: number) => void;
+  readonly wasmconnectoptions_username: (a: number) => [number, number];
+  readonly wasmconnectoptions_set_username: (a: number, b: number, c: number) => void;
+  readonly wasmconnectoptions_set_password: (a: number, b: number, c: number) => void;
+  readonly wasmconnectoptions_set_will: (a: number, b: number) => void;
+  readonly wasmconnectoptions_clear_will: (a: number) => void;
+  readonly wasmconnectoptions_sessionExpiryInterval: (a: number) => number;
+  readonly wasmconnectoptions_receiveMaximum: (a: number) => number;
+  readonly wasmconnectoptions_set_receiveMaximum: (a: number, b: number) => void;
+  readonly wasmconnectoptions_maximumPacketSize: (a: number) => number;
+  readonly wasmconnectoptions_set_maximumPacketSize: (a: number, b: number) => void;
+  readonly wasmconnectoptions_topicAliasMaximum: (a: number) => number;
+  readonly wasmconnectoptions_set_topicAliasMaximum: (a: number, b: number) => void;
+  readonly wasmconnectoptions_requestResponseInformation: (a: number) => number;
+  readonly wasmconnectoptions_set_requestResponseInformation: (a: number, b: number) => void;
+  readonly wasmconnectoptions_requestProblemInformation: (a: number) => number;
+  readonly wasmconnectoptions_set_requestProblemInformation: (a: number, b: number) => void;
+  readonly wasmconnectoptions_authenticationMethod: (a: number) => [number, number];
+  readonly wasmconnectoptions_set_authenticationMethod: (a: number, b: number, c: number) => void;
+  readonly wasmconnectoptions_set_authenticationData: (a: number, b: number, c: number) => void;
+  readonly wasmconnectoptions_addUserProperty: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wasmconnectoptions_clearUserProperties: (a: number) => void;
+  readonly __wbg_wasmpublishoptions_free: (a: number, b: number) => void;
+  readonly wasmpublishoptions_new: () => number;
+  readonly wasmpublishoptions_qos: (a: number) => number;
+  readonly wasmpublishoptions_set_qos: (a: number, b: number) => void;
+  readonly wasmpublishoptions_retain: (a: number) => number;
+  readonly wasmpublishoptions_set_retain: (a: number, b: number) => void;
+  readonly wasmpublishoptions_payloadFormatIndicator: (a: number) => number;
+  readonly wasmpublishoptions_set_payloadFormatIndicator: (a: number, b: number) => void;
+  readonly wasmpublishoptions_topicAlias: (a: number) => number;
+  readonly wasmpublishoptions_set_topicAlias: (a: number, b: number) => void;
+  readonly wasmpublishoptions_responseTopic: (a: number) => [number, number];
+  readonly wasmpublishoptions_set_responseTopic: (a: number, b: number, c: number) => void;
+  readonly wasmpublishoptions_set_correlationData: (a: number, b: number, c: number) => void;
+  readonly wasmpublishoptions_contentType: (a: number) => [number, number];
+  readonly wasmpublishoptions_set_contentType: (a: number, b: number, c: number) => void;
+  readonly wasmpublishoptions_addUserProperty: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wasmpublishoptions_clearUserProperties: (a: number) => void;
+  readonly __wbg_wasmsubscribeoptions_free: (a: number, b: number) => void;
+  readonly wasmsubscribeoptions_new: () => number;
+  readonly wasmsubscribeoptions_qos: (a: number) => number;
+  readonly wasmsubscribeoptions_set_qos: (a: number, b: number) => void;
+  readonly wasmsubscribeoptions_noLocal: (a: number) => number;
+  readonly wasmsubscribeoptions_set_noLocal: (a: number, b: number) => void;
+  readonly wasmsubscribeoptions_retainAsPublished: (a: number) => number;
+  readonly wasmsubscribeoptions_set_retainAsPublished: (a: number, b: number) => void;
+  readonly wasmsubscribeoptions_retainHandling: (a: number) => number;
+  readonly wasmsubscribeoptions_set_retainHandling: (a: number, b: number) => void;
+  readonly __wbg_wasmwillmessage_free: (a: number, b: number) => void;
+  readonly wasmwillmessage_new: (a: number, b: number, c: number, d: number) => number;
+  readonly wasmwillmessage_topic: (a: number) => [number, number];
+  readonly wasmwillmessage_set_topic: (a: number, b: number, c: number) => void;
+  readonly wasmwillmessage_qos: (a: number) => number;
+  readonly wasmwillmessage_set_qos: (a: number, b: number) => void;
+  readonly wasmwillmessage_retain: (a: number) => number;
+  readonly wasmwillmessage_set_retain: (a: number, b: number) => void;
+  readonly wasmwillmessage_contentType: (a: number) => [number, number];
+  readonly wasmwillmessage_set_contentType: (a: number, b: number, c: number) => void;
+  readonly wasmwillmessage_responseTopic: (a: number) => [number, number];
+  readonly wasmwillmessage_set_responseTopic: (a: number, b: number, c: number) => void;
+  readonly wasmconnectoptions_set_sessionExpiryInterval: (a: number, b: number) => void;
+  readonly wasmpublishoptions_set_messageExpiryInterval: (a: number, b: number) => void;
+  readonly wasmsubscribeoptions_set_subscriptionIdentifier: (a: number, b: number) => void;
+  readonly wasmwillmessage_set_willDelayInterval: (a: number, b: number) => void;
+  readonly wasmpublishoptions_messageExpiryInterval: (a: number) => number;
+  readonly wasmsubscribeoptions_subscriptionIdentifier: (a: number) => number;
+  readonly wasmwillmessage_willDelayInterval: (a: number) => number;
+  readonly wasmwillmessage_messageExpiryInterval: (a: number) => number;
+  readonly wasmwillmessage_set_messageExpiryInterval: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hacd56641ea4358f0: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h2a5cb8478cd1adb0: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h2d3fbbff27fe5544: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h07c691622f9242a9: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h4c33ce4d986075ed: (a: number, b: number) => void;
+  readonly wasm_bindgen__closure__destroy__he3a6d52737a61d69: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hbbb6f9316512cb4e: (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;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_externrefs: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;