mhx 2026.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.mbt.md

@@ -0,0 +1,298 @@
+# mhx - MoonBit Hypermedia X
+
+A type-safe Hypermedia-Driven Architecture (HDA) library for MoonBit/WebAssembly, inspired by [htmx](https://htmx.org).
+
+## Features
+
+- **Type-safe trigger parsing** - Parser combinator-based DSL for `mx-trigger` attributes with compile-time safety
+- **Event delegation** - Efficient single-listener pattern for handling DOM events
+- **Async fetch** - Callback-based HTTP requests with request queuing and sync strategies
+- **Timing modifiers** - Built-in support for `delay`, `throttle`, and `debounce`
+- **MutationObserver integration** - Automatic processing of dynamically added elements
+- **Minimal footprint** - Leverages WasmGC and JS String Builtins for zero-copy DOM interop
+
+## Installation
+
+Add to your `moon.mod.json`:
+
+```json
+{
+  "deps": {
+    "f4ah6o/mhx": "0.1.0"
+  }
+}
+```
+
+## Usage
+
+### HTML Attributes
+
+mhx uses `mx-*` attributes (not `hx-*`) to define hypermedia behaviors:
+
+```html
+<!-- Simple GET request -->
+<button mx-get="/api/data" mx-target="#result">
+  Load Data
+</button>
+
+<!-- POST with trigger modifiers -->
+<form mx-post="/api/submit" mx-trigger="submit" mx-swap="outerHTML">
+  <input name="email" type="email" />
+  <button type="submit">Submit</button>
+</form>
+
+<!-- Click with delay and filter -->
+<button mx-get="/api/action"
+        mx-trigger="click[ctrlKey] delay:500ms">
+  Ctrl+Click (with 500ms delay)
+</button>
+
+<!-- Debounced input -->
+<input mx-get="/api/search"
+       mx-trigger="input changed debounce:300ms"
+       mx-target="#search-results"
+       name="q" />
+```
+
+### Supported Attributes
+
+| Attribute | Description |
+|-----------|-------------|
+| `mx-get` | Issue GET request to URL |
+| `mx-post` | Issue POST request to URL |
+| `mx-put` | Issue PUT request to URL |
+| `mx-patch` | Issue PATCH request to URL |
+| `mx-delete` | Issue DELETE request to URL |
+| `mx-trigger` | Event that triggers the request |
+| `mx-target` | CSS selector for response target |
+| `mx-swap` | How to swap the response into DOM |
+| `mx-sync` | Request synchronization strategy |
+| `mx-vals` | JSON values to include in request |
+
+### Trigger Syntax
+
+The `mx-trigger` attribute supports a rich DSL:
+
+```
+event[filter] modifier:value, event2[filter2]
+```
+
+**Events:**
+- Standard DOM events: `click`, `submit`, `input`, `change`, `keyup`, etc.
+- Special events: `load`, `revealed`, `intersect`
+
+**Modifiers:**
+- `once` - Fire only once
+- `changed` - Fire only when value changes
+- `delay:Nms` - Delay before firing
+- `throttle:Nms` - Fire at most once per interval
+- `debounce:Nms` - Fire after quiet period
+- `from:selector` - Listen on different element
+- `target:selector` - Specify action target
+- `consume` - Stop event propagation
+- `prevent` - Prevent default behavior
+- `queue:mode` - Request queue mode (`drop`, `replace`, `first`, `last`, `all`). Example: `queue all`.
+
+**Filters:**
+- `[ctrlKey]` - Require Ctrl key
+- `[shiftKey]` - Require Shift key
+- `[altKey]` - Require Alt key
+- `[target.value!='']` - Custom JS expression
+
+### Swap Strategies
+
+| Strategy | Description |
+|----------|-------------|
+| `innerHTML` | Replace inner content (default) |
+| `outerHTML` | Replace entire element |
+| `beforebegin` | Insert before element |
+| `afterbegin` | Insert at start of element |
+| `beforeend` | Insert at end of element |
+| `afterend` | Insert after element |
+| `delete` | Remove the element |
+| `none` | No swap, just trigger events |
+
+### Selectors
+
+Target and from selectors support:
+- `this` - Current element
+- `closest selector` - Find closest ancestor
+- `find selector` - Find within element
+- `body`, `document`, `window` - Special targets
+- Any CSS selector
+
+## Architecture
+
+```
+src/
++-- ffi/           # FFI bindings + mhx_ffi.js
+|   +-- element.mbt, document.mbt, event.mbt
+|   +-- fetch.mbt, mutation_observer.mbt
+|   +-- mhx_ffi.js  # JS glue code
++-- event/         # Event system
+|   +-- delegation.mbt, cache.mbt, handler.mbt, timing.mbt
++-- network/       # HTTP layer
+|   +-- request.mbt, manager.mbt, async_fetch.mbt
++-- swap/          # DOM swap operations
++-- core/          # Main integration
+    +-- mhx.mbt, error.mbt
+```
+
+Shared specification types and parsers now live in `mhx-spec.mbt/`.
+
+### Key Components
+
+- **TriggerDef** - Typed AST for trigger definitions
+- **Modifier** - Enum of all trigger modifiers (Once, Delay, Throttle, etc.)
+- **Selector** - Typed selector expressions (This, Closest, Find, Css)
+- **EventDelegator** - Central event handling with delegation pattern
+- **ConfigCache** - Caches parsed configurations per element
+- **TimingManager** - Manages delay/throttle/debounce state
+- **RequestManager** - Handles request queuing and sync strategies
+
+## API
+
+### Initialization
+
+```moonbit
+// Initialize mhx on document load
+fn main {
+  @core.init_mhx()
+}
+```
+
+### Processing Dynamic Content
+
+```moonbit
+// Process newly added elements
+let element = document.query_selector("#new-content")
+@core.process(element)
+```
+
+### Error Handling
+
+```moonbit
+// Set custom error handler
+@core.set_error_handler(fn(error : MhxError) {
+  match error {
+    Parse(msg, pos) => console.error("Parse error: " + msg)
+    Network(status, msg) => console.error("Network error: " + msg)
+    Timeout => console.error("Request timed out")
+    _ => console.error("Error: " + error.to_string())
+  }
+})
+```
+
+## Development
+
+```bash
+# Check types
+moon check --target js
+
+# Run tests
+moon test --target js
+
+# Format code
+moon fmt
+
+# Build
+moon build --target js
+```
+
+## Comparison with htmx
+
+| Feature | htmx | mhx |
+|---------|------|-----|
+| Language | JavaScript | MoonBit/Wasm |
+| Attribute prefix | `hx-*` | `mx-*` |
+| Parsing | Regex/string split | Parser combinator |
+| Type safety | Runtime | Compile-time |
+| Error messages | Generic | Precise location |
+| Bundle size | ~14KB gzip | <10KB (estimated) |
+| DOM interop | Native | WasmGC + externref |
+
+## Use mhx with tmpx
+
+[tmpx](https://mooncakes.io/docs/#/f4ah6o/tmpx/) is a typed, functional HTML template DSL for MoonBit. While tmpx provides `hx-*` helpers for htmx, you can use mhx attributes directly:
+
+### Basic mhx Attributes
+
+```moonbit
+// Using generic attr function for mx-* attributes
+let button = @tmpx.button(
+  [
+    @tmpx.attr("mx-get", "/api/data"),
+    @tmpx.attr("mx-target", "#result"),
+    @tmpx.attr("mx-swap", "innerHTML"),
+  ],
+  [@tmpx.text("Load Data")],
+)
+```
+
+### Full Example: Server-Side Template
+
+```moonbit
+fn ticket_card(id : Int, title : String) -> @tmpx.Node {
+  @tmpx.div(
+    [
+      @tmpx.class_("card"),
+      @tmpx.attr("mx-get", "/partials/ticket/\{id}"),
+      @tmpx.attr("mx-target", "#pane-center"),
+      @tmpx.attr("mx-swap", "innerHTML"),
+      @tmpx.attr("mx-trigger", "click"),
+    ],
+    [
+      @tmpx.h2([], [@tmpx.text("Ticket #\{id}")]),
+      @tmpx.p([], [@tmpx.text(title)]),
+    ],
+  )
+}
+
+fn search_form() -> @tmpx.Node {
+  @tmpx.input_(
+    [
+      @tmpx.type_("text"),
+      @tmpx.name_("q"),
+      @tmpx.attr("mx-get", "/api/search"),
+      @tmpx.attr("mx-trigger", "input changed debounce:300ms"),
+      @tmpx.attr("mx-target", "#search-results"),
+    ],
+  )
+}
+```
+
+### Architecture with tmpx + mhx
+
+```
+Server (MoonBit + tmpx)          Browser (MoonBit/Wasm + mhx)
++------------------------+       +---------------------------+
+| Generate HTML with     |       | Parse mx-* attributes     |
+| mx-* attributes using  | ----> | Handle events             |
+| tmpx templates         | <---- | Fetch HTML fragments      |
+| Return HTML fragments  |       | Swap into DOM             |
++------------------------+       +---------------------------+
+```
+
+This architecture keeps all your code in MoonBit while following HATEOAS principles - the server returns hypermedia (HTML), not data (JSON).
+
+## License
+
+Apache-2.0
+## npm Distribution
+
+The JavaScript runtime can be packaged for npm with the compiled output in `dist/`.
+
+1. Build the JS runtime:
+
+```bash
+moon -C mhx.mbt build --target js
+```
+
+2. Copy the JS output and FFI into `dist/`:
+
+- `dist/index.js` (compiled output)
+- `dist/mhx_ffi.js` (FFI glue)
+
+3. Use the npm wrapper entry:
+
+- `npm/index.js` initializes the FFI via `initMhxFfi` and re-exports the public API.