0.0.16 - removes braid-text dependence

Author: dglittle

README.md

@@ -1,6 +1,6 @@
 # DOM Diffing and Synchronization over Braid-HTTP
 
-Efficiently diff and synchronization a DOM, either locally or over the network via [Braid-HTTP](https://datatracker.ietf.org/doc/html/draft-toomim-httpbis-braid-http).  Sync multiple browser & server DOMs over the network, via Dom Diffs.  Collaboratively edit live HTML.  Create mashups of UIs, interoperating via Dom Diffs.
+Efficiently diff and synchronize a DOM, either locally or over the network via [Braid-HTTP](https://datatracker.ietf.org/doc/html/draft-toomim-httpbis-braid-http).  Sync multiple browser & server DOMs over the network, via Dom Diffs.  Collaboratively edit live HTML.  Create mashups of UIs, interoperating via Dom Diffs.
 
 - Supports [Braid-HTTP 04](https://github.com/braid-org/braid-spec/blob/master/draft-toomim-httpbis-braid-http-04.txt) protocol
 - Uses Tree-sitter for robust, incremental HTML parsing
@@ -34,16 +34,16 @@ http_server.on("request", (req, res) => {
 })
 ```
 
-The first thing `serve_dom_diff` does is subscribe to an underlying textual resource using the suplied callback with the `subscribe` function. Then, it responds to the request with a braid subscription using the `simpleton` merge type for html, which consists of sending replacement html for a given `xpath`. Whenever changes are made to the underlying textual resource, `serve_dom_diff` will figure out the relevant changes to the DOM, and send these patches to all subscribed clients.
+`serve_dom_diff` first subscribes to an underlying textual resource using the provided callback. It then responds to the request with a Braid subscription using the `simpleton` merge type for HTML, which sends replacement HTML for a given `xpath`. When changes occur in the underlying textual resource, `serve_dom_diff` calculates the relevant DOM changes and sends these patches to all subscribed clients.
 
 ## Server API
 
-`serve_dom_diff(req, res, options)`
+`serve_dom_diff(req, res, braid_text_cb, options)`
   - `req`: Incoming HTTP request object.
   - `res`: Outgoing HTTP response object.
-  - `braid_text_cb`: 
-  - `options`: <small style="color:lightgrey">[optional]</small> An object containing additional options:
-    - `key`:  <small style="color:lightgrey">[optional]</small> ID of HTML resource to sync with. Defaults to `req.url`.
+  - `braid_text_cb`: Function called by `serve_dom_diff` to subscribe to the underlying textual resource. It receives a callback function with parameters like `({ version, parents, body, patches })` to be called for each new Braid version.
+  - `options`: (optional) An object containing additional options:
+    - `key`:  (optional) ID of HTML resource to sync with. Defaults to `req.url`.
   - This method handles Braid-HTTP requests for collaborative DOM editing.
 
 ## Client-side Usage
@@ -58,7 +58,7 @@ let dd = create_dom_diff(initialHtml)
 // Get current HTML
 let currentHtml = dd.get()
 
-// Apply a patch
+// Apply a patch and get the diff
 let diff = dd.patch(newHtml)
 
 // Apply DOM diff to actual DOM
@@ -67,14 +67,16 @@ apply_dom_diff(domElement, diff)
 
 ## Client API
 
-`init_dom_diff()`
+`async init_dom_diff()`
   - Initializes the DOM diffing system, loading necessary dependencies.
 
 `create_dom_diff(html)`
-  - Creates a new DOM diff object for the given HTML.
+  - Creates a new DOM diff object for the given `html`.
   - Returns an object with methods:
     - `get()`: Returns the current HTML.
-    - `patch(newHtml)`: Applies a patch and returns the diff.
+    - `patch(newHtml)`: Updates to the `newHtml` and returns the DOM diff to get there.
 
 `apply_dom_diff(dom, diff)`
   - Applies a diff to the given DOM element.
+  - `dom`: The target DOM element to update.
+  - `diff`: The diff object generated by `patch()`.

package.json

@@ -1,13 +1,12 @@
 {
   "name": "@braidjs/dom-diff",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "utilities for diffing html doms",
   "author": "Braid Working Group",
   "repository": "braid-org/dom-diff",
   "homepage": "https://braid.org",
   "dependencies": {
     "braid-http": "^0.3.20",
-    "braid-text": "^0.0.15",
     "web-tree-sitter": "^0.22.6"
   }
 }