add @spinframework/spin-mqtt

Signed-off-by: karthik2804 <[email protected]>

Author: karthik2804

package-lock.json

@@ -0,0 +1,28 @@
+{
+  "name": "@spinframework/spin-mqtt",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && cp -r types/* dist/"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  },
+  "config": {
+    "wasiDep": {
+      "witDeps": [
+        {
+          "witPath": "./wit",
+          "package": "fermyon:[email protected]",
+          "world": "spin-mqtt"
+        }
+      ]
+    }
+  }
+}

packages/spin-mqtt/package.json

@@ -0,0 +1,50 @@
+import * as spinMqtt from 'fermyon:spin/[email protected]';
+
+/**
+ * Enum representing the Quality of Service (QoS) levels for MQTT.
+ * @enum {string}
+ */
+export enum QoS {
+    /** Messages are delivered at most once. */
+    AtMostOnce = 'at-most-once',
+    /** Messages are delivered at least once. */
+    AtLeastOnce = 'at-least-once',
+    /** Messages are delivered exactly once. */
+    ExactlyOnce = 'exactly-once',
+}
+
+/**
+ * Interface representing an MQTT connection with a method for publishing messages.
+ * @interface MqttConnection
+ */
+export interface MqttConnection {
+    /**
+     * Publishes a message to the specified MQTT topic.
+     * @param topic - The topic to publish the message to.
+     * @param payload - The message payload as a Uint8Array.
+     * @param qos - The Quality of Service level for message delivery.
+     */
+    publish: (topic: string, payload: Uint8Array, qos: QoS) => void;
+}
+
+/**
+ * Opens an MQTT connection with the specified parameters.
+ * @param {string} address - The address of the MQTT broker.
+ * @param {string} username - The username for the MQTT connection.
+ * @param {string} password - The password for the MQTT connection.
+ * @param {bigint} keepAliveIntervalInSecs - The keep-alive interval in seconds.
+ * @returns {MqttConnection} The MQTT connection object.
+ */
+export function open(
+    address: string,
+    username: string,
+    password: string,
+    keepAliveIntervalInSecs: bigint,
+): MqttConnection {
+    return spinMqtt.Connection.open(
+        address,
+        username,
+        password,
+        keepAliveIntervalInSecs,
+    );
+}

packages/spin-mqtt/src/index.ts

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "ES2020",
+        "lib": [
+            "ES2020",
+            "WebWorker"
+        ],
+        "moduleResolution": "node",
+        "declaration": true,
+        "outDir": "dist",
+        "strict": true,
+        "esModuleInterop": true,
+    },
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}

packages/spin-mqtt/tsconfig.json

@@ -0,0 +1,59 @@
+declare module 'fermyon:spin/[email protected]' {
+  /**
+   * Errors related to interacting with Mqtt
+   */
+  export type Error = ErrorInvalidAddress | ErrorTooManyConnections | ErrorConnectionFailed | ErrorOther;
+  /**
+   * An invalid address string
+   */
+  export interface ErrorInvalidAddress {
+    tag: 'invalid-address',
+  }
+  /**
+   * There are too many open connections
+   */
+  export interface ErrorTooManyConnections {
+    tag: 'too-many-connections',
+  }
+  /**
+   * Connection failure e.g. address not allowed.
+   */
+  export interface ErrorConnectionFailed {
+    tag: 'connection-failed',
+    val: string,
+  }
+  /**
+   * Some other error occurred
+   */
+  export interface ErrorOther {
+    tag: 'other',
+    val: string,
+  }
+  /**
+   * QoS for publishing Mqtt messages
+   * # Variants
+   * 
+   * ## `"at-most-once"`
+   * 
+   * ## `"at-least-once"`
+   * 
+   * ## `"exactly-once"`
+   */
+  export type Qos = 'at-most-once' | 'at-least-once' | 'exactly-once';
+  /**
+   * The message payload.
+   */
+  export type Payload = Uint8Array;
+
+  export class Connection {
+    /**
+    * Open a connection to the Mqtt instance at `address`.
+    */
+    static open(address: string, username: string, password: string, keepAliveIntervalInSecs: bigint): Connection;
+    /**
+    * Publish an Mqtt message to the specified `topic`.
+    */
+    publish(topic: string, payload: Payload, qos: Qos): void;
+  }
+
+}

packages/spin-mqtt/types/fermyon-spin-mqtt.d.ts

@@ -0,0 +1,37 @@
+package fermyon:spin@2.0.0;
+
+interface mqtt {
+  /// Errors related to interacting with Mqtt
+  variant error {
+      /// An invalid address string
+      invalid-address,
+      /// There are too many open connections
+      too-many-connections,    
+      /// Connection failure e.g. address not allowed.  
+      connection-failed(string),
+      /// Some other error occurred
+      other(string),
+  }
+
+  /// QoS for publishing Mqtt messages
+     enum qos {
+      at-most-once,
+      at-least-once,
+      exactly-once,
+  }
+
+  resource connection {
+    /// Open a connection to the Mqtt instance at `address`.
+    open: static func(address: string, username: string, password: string, keep-alive-interval-in-secs: u64) -> result<connection, error>;
+
+    /// Publish an Mqtt message to the specified `topic`.
+    publish: func(topic: string, payload: payload, qos: qos) -> result<_, error>;
+  }
+
+  /// The message payload.
+  type payload = list<u8>;
+}
+
+world spin-mqtt {
+  import mqtt;
+}