fixed typos, added subscribe, added messaging-request-reply world, an…

…d nits

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

.github/workflows/main.yml

@@ -14,4 +14,4 @@ jobs:
     - uses: WebAssembly/wit-abi-up-to-date@v17
       with:
         wit-bindgen: '0.18.0'
-        worlds: 'imports messaging'
+        worlds: 'imports imports-request-reply messaging-core messaging-request-reply'

README.md

@@ -12,6 +12,7 @@ A proposed [WebAssembly System Interface](https://github.com/WebAssembly/WASI) A
   - [Introduction](#introduction)
   - [Goals](#goals)
   - [Portability criteria](#portability-criteria)
+  - [Dev notes](#dev-notes)
 
 ## Current Phase
 
@@ -28,7 +29,7 @@ A proposed [WebAssembly System Interface](https://github.com/WebAssembly/WASI) A
 ## Phase 4 Advancement Criteria
 
 `wasi-messaging` should have at least two implementations for both open source message brokers (such
-as Kafka, NATS, or Redis) and two for cloud service providers
+as Kafka, or NATS) and two for cloud service providers
 
 ## Introduction
 
@@ -69,11 +70,21 @@ send a message from all major messaging systems. This includes anything implemen
 standards like MQTT and AMQP, specific technologies like NATS and Kafka, and cloud provider
 implementations like Azure Service Bus and AWS SQS. This _does not_ mean it implements the full set
 of features of each of the messaging systems. In fact, it is expected that most implementations will
-need to do work to adapt their system to this interface (i.e. in Kafka, you'd have to mark the
+need to do work to adapt their system to this interface (i.e., in Kafka, you'd have to mark the
 message as completed once the call to `handle` returns). As mentioned above, this should still be
 completely compatible with any more advanced use cases of the various message systems. For example,
 if you have a queue of work that is currently being handled by a pre-existing piece of software
 outside of Wasm components, a component could use this interface to publish messages that get
 ingested into this queue. Another way to state the portability criteria is that this implementation
-should not break the possibilty of a component consuming this interface to be integrated in with a
+should not break the possibility of a component consuming this interface to be integrated in with a
 more advanced messaging use case
+
+## Dev notes
+
+To regenerate the `.md` files, run: 
+```sh
+wit-bindgen markdown ./wit/ -w imports --html-in-md
+wit-bindgen markdown ./wit/ -w imports-request-reply --html-in-md
+wit-bindgen markdown ./wit/ -w messaging-core --html-in-md
+wit-bindgen markdown ./wit/ -w messaging-request-reply --html-in-md
+```

imports.md

@@ -1,151 +1,164 @@
-<h1><a name="imports">World imports</a></h1>
+<h1><a id="imports"></a>World imports</h1>
 <ul>
 <li>Imports:
 <ul>
-<li>interface <a href="#wasi:messaging_types_0.2.0_draft"><code>wasi:messaging/[email protected]</code></a></li>
-<li>interface <a href="#wasi:messaging_producer_0.2.0_draft"><code>wasi:messaging/[email protected]</code></a></li>
+<li>interface <a href="#wasi_messaging_types_0_2_0_draft"><code>wasi:messaging/[email protected]</code></a></li>
+<li>interface <a href="#wasi_messaging_producer_0_2_0_draft"><code>wasi:messaging/[email protected]</code></a></li>
 </ul>
 </li>
 </ul>
-<h2><a name="wasi:messaging_types_0.2.0_draft"></a>Import interface wasi:messaging/[email protected]</h2>
+<h2><a id="wasi_messaging_types_0_2_0_draft"></a>Import interface wasi:messaging/[email protected]</h2>
 <hr />
 <h3>Types</h3>
-<h4><a name="client"></a><code>resource client</code></h4>
+<h4><a id="client"></a><code>resource client</code></h4>
 <p>A connection to a message-exchange service (e.g., buffer, broker, etc.).</p>
-<h4><a name="error"></a><code>variant error</code></h4>
+<h4><a id="error"></a><code>variant error</code></h4>
 <p>Errors that can occur when using the messaging interface.</p>
 <h5>Variant Cases</h5>
 <ul>
 <li>
-<p><a name="error.timeout"></a><code>timeout</code></p>
+<p><a id="error.timeout"></a><code>timeout</code></p>
 <p>The request or operation timed out.
 </li>
 <li>
-<p><a name="error.connection"></a><code>connection</code>: <code>string</code></p>
+<p><a id="error.connection"></a><code>connection</code>: <code>string</code></p>
 <p>An error occurred with the connection. Includes a message for additional context
 </li>
 <li>
-<p><a name="error.other"></a><code>other</code>: <code>string</code></p>
+<p><a id="error.permission_denied"></a><code>permission-denied</code>: <code>string</code></p>
+<p>A permission error occurred. Includes a message for additional context
+</li>
+<li>
+<p><a id="error.other"></a><code>other</code>: <code>string</code></p>
 <p>A catch all for other types of errors
 </li>
 </ul>
-<h4><a name="message"></a><code>resource message</code></h4>
+<h4><a id="message"></a><code>resource message</code></h4>
 <h2>A message with a binary payload and additional information</h2>
 <h3>Functions</h3>
-<h4><a name="static_client.connect"></a><code>[static]client.connect: func</code></h4>
+<h4><a id="static_client_connect"></a><code>[static]client.connect: func</code></h4>
+<h5>Params</h5>
+<ul>
+<li><a id="static_client_connect.name"></a><code>name</code>: <code>string</code></li>
+</ul>
+<h5>Return values</h5>
+<ul>
+<li><a id="static_client_connect.0"></a> result&lt;own&lt;<a href="#client"><a href="#client"><code>client</code></a></a>&gt;, <a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
+</ul>
+<h4><a id="method_client_disconnect"></a><code>[method]client.disconnect: func</code></h4>
 <h5>Params</h5>
 <ul>
-<li><a name="static_client.connect.name"></a><code>name</code>: <code>string</code></li>
+<li><a id="method_client_disconnect.self"></a><code>self</code>: borrow&lt;<a href="#client"><a href="#client"><code>client</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="static_client.connect.0"></a> result&lt;own&lt;<a href="#client"><a href="#client"><code>client</code></a></a>&gt;, <a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
+<li><a id="method_client_disconnect.0"></a> result&lt;_, <a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
 </ul>
-<h4><a name="constructor_message"></a><code>[constructor]message: func</code></h4>
+<h4><a id="constructor_message"></a><code>[constructor]message: func</code></h4>
 <h5>Params</h5>
 <ul>
-<li><a name="constructor_message.topic"></a><code>topic</code>: <code>string</code></li>
-<li><a name="constructor_message.data"></a><code>data</code>: list&lt;<code>u8</code>&gt;</li>
+<li><a id="constructor_message.topic"></a><code>topic</code>: <code>string</code></li>
+<li><a id="constructor_message.data"></a><code>data</code>: list&lt;<code>u8</code>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="constructor_message.0"></a> own&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="constructor_message.0"></a> own&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
-<h4><a name="method_message.topic"></a><code>[method]message.topic: func</code></h4>
+<h4><a id="method_message_topic"></a><code>[method]message.topic: func</code></h4>
 <p>The topic/subject/channel this message was received or should be sent on</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.topic.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_topic.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="method_message.topic.0"></a> <code>string</code></li>
+<li><a id="method_message_topic.0"></a> <code>string</code></li>
 </ul>
-<h4><a name="method_message.set_topic"></a><code>[method]message.set-topic: func</code></h4>
+<h4><a id="method_message_set_topic"></a><code>[method]message.set-topic: func</code></h4>
 <p>Set the topic/subject/channel this message should be sent on</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.set_topic.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
-<li><a name="method_message.set_topic.topic"></a><code>topic</code>: <code>string</code></li>
+<li><a id="method_message_set_topic.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_set_topic.topic"></a><code>topic</code>: <code>string</code></li>
 </ul>
-<h4><a name="method_message.content_type"></a><code>[method]message.content-type: func</code></h4>
+<h4><a id="method_message_content_type"></a><code>[method]message.content-type: func</code></h4>
 <p>An optional content-type describing the format of the data in the message. This is
 sometimes described as the &quot;format&quot; type</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.content_type.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_content_type.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="method_message.content_type.0"></a> option&lt;<code>string</code>&gt;</li>
+<li><a id="method_message_content_type.0"></a> option&lt;<code>string</code>&gt;</li>
 </ul>
-<h4><a name="method_message.set_content_type"></a><code>[method]message.set-content-type: func</code></h4>
+<h4><a id="method_message_set_content_type"></a><code>[method]message.set-content-type: func</code></h4>
 <p>Set the content-type describing the format of the data in the message. This is
 sometimes described as the &quot;format&quot; type</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.set_content_type.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
-<li><a name="method_message.set_content_type.content_type"></a><code>content-type</code>: <code>string</code></li>
+<li><a id="method_message_set_content_type.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_set_content_type.content_type"></a><code>content-type</code>: <code>string</code></li>
 </ul>
-<h4><a name="method_message.data"></a><code>[method]message.data: func</code></h4>
+<h4><a id="method_message_data"></a><code>[method]message.data: func</code></h4>
 <p>An opaque blob of data</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.data.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_data.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="method_message.data.0"></a> list&lt;<code>u8</code>&gt;</li>
+<li><a id="method_message_data.0"></a> list&lt;<code>u8</code>&gt;</li>
 </ul>
-<h4><a name="method_message.set_data"></a><code>[method]message.set-data: func</code></h4>
+<h4><a id="method_message_set_data"></a><code>[method]message.set-data: func</code></h4>
 <p>Set the opaque blob of data for this message, discarding the old value</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.set_data.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
-<li><a name="method_message.set_data.data"></a><code>data</code>: list&lt;<code>u8</code>&gt;</li>
+<li><a id="method_message_set_data.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_set_data.data"></a><code>data</code>: list&lt;<code>u8</code>&gt;</li>
 </ul>
-<h4><a name="method_message.metadata"></a><code>[method]message.metadata: func</code></h4>
+<h4><a id="method_message_metadata"></a><code>[method]message.metadata: func</code></h4>
 <p>Optional metadata (also called headers or attributes in some systems) attached to the
 message</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.metadata.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_metadata.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="method_message.metadata.0"></a> option&lt;list&lt;(<code>string</code>, <code>string</code>)&gt;&gt;</li>
+<li><a id="method_message_metadata.0"></a> option&lt;list&lt;(<code>string</code>, <code>string</code>)&gt;&gt;</li>
 </ul>
-<h4><a name="method_message.add_metadata"></a><code>[method]message.add-metadata: func</code></h4>
+<h4><a id="method_message_add_metadata"></a><code>[method]message.add-metadata: func</code></h4>
 <p>Add a new key-value pair to the metadata, overwriting any existing value for the same key</p>
 <h5>Params</h5>
 <ul>
-<li><a name="method_message.add_metadata.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
-<li><a name="method_message.add_metadata.key"></a><code>key</code>: <code>string</code></li>
-<li><a name="method_message.add_metadata.value"></a><code>value</code>: <code>string</code></li>
+<li><a id="method_message_add_metadata.self"></a><code>self</code>: borrow&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="method_message_add_metadata.key"></a><code>key</code>: <code>string</code></li>
+<li><a id="method_message_add_metadata.value"></a><code>value</code>: <code>string</code></li>
 </ul>
-<h2><a name="wasi:messaging_producer_0.2.0_draft"></a>Import interface wasi:messaging/[email protected]</h2>
+<h2><a id="wasi_messaging_producer_0_2_0_draft"></a>Import interface wasi:messaging/[email protected]</h2>
 <p>The producer interface is used to send messages to a channel/topic.</p>
 <hr />
 <h3>Types</h3>
-<h4><a name="client"></a><code>type client</code></h4>
+<h4><a id="client"></a><code>type client</code></h4>
 <p><a href="#client"><a href="#client"><code>client</code></a></a></p>
 <p>
-#### <a name="message"></a>`type message`
+#### <a id="message"></a>`type message`
 [`message`](#message)
 <p>
-#### <a name="error"></a>`type error`
+#### <a id="error"></a>`type error`
 [`error`](#error)
 <p>
 ----
 <h3>Functions</h3>
-<h4><a name="send"></a><code>send: func</code></h4>
+<h4><a id="send"></a><code>send: func</code></h4>
 <p>Sends the message using the given client.</p>
 <h5>Params</h5>
 <ul>
-<li><a name="send.c"></a><code>c</code>: own&lt;<a href="#client"><a href="#client"><code>client</code></a></a>&gt;</li>
-<li><a name="send.m"></a><code>m</code>: own&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
+<li><a id="send.c"></a><code>c</code>: borrow&lt;<a href="#client"><a href="#client"><code>client</code></a></a>&gt;</li>
+<li><a id="send.m"></a><code>m</code>: own&lt;<a href="#message"><a href="#message"><code>message</code></a></a>&gt;</li>
 </ul>
 <h5>Return values</h5>
 <ul>
-<li><a name="send.0"></a> result&lt;_, <a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
+<li><a id="send.0"></a> result&lt;_, <a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
 </ul>