braid-text 0.3.20 → 0.3.22

package/README.md

@@ -69,6 +69,11 @@ http_server.on("request", (req, res) => {
   - `res`: Outgoing HTTP response object.
   - `options`: <small style="color:lightgrey">[optional]</small> An object containing additional options:
     - `key`:  <small style="color:lightgrey">[optional]</small> ID of text resource to sync with.  Defaults to `req.url`.
+    - `put_cb`: <small style="color:lightgrey">[optional]</small> Callback invoked after a PUT changes a resource. Signature: `(key, val, old_val, patches)` where:
+      - `key` - The resource key
+      - `val` - The new document text after the PUT
+      - `old_val` - The document text before the PUT
+      - `patches` - Array of patches applied (each `{unit, range, content}`), or `null` for full-body replacements
   - This is the main method of this library, and does all the work to handle Braid-HTTP `GET` and `PUT` requests concerned with a specific text resource.
 
 `await braid_text.get(key)`

package/client/simpleton-sync.js

@@ -104,7 +104,8 @@ function simpleton_client(url, {
     get_patches,
     get_state,
     content_type,
-
+    headers: user_headers,    // The user can pass in custom headers
+                              // that are forwared into the fetch
     on_error,
     on_res,
     on_online,
@@ -141,7 +142,8 @@ function simpleton_client(url, {
         retry: () => true,
         parents: () => client_version.length ? client_version : null,
         onSubscriptionStatus: status => on_online && on_online(status.online),
-        headers: { "Merge-Type": "simpleton",
+        headers: { ...user_headers,
+                   "Merge-Type": "simpleton",
                    ...content_type && {Accept: content_type} },
     }).then(res => {
         if (on_res) on_res(res)
@@ -328,6 +330,7 @@ function simpleton_client(url, {
                         peer, version, parents, patches,
                         retry: (res) => res.status !== 550,
                         headers: {
+                            ...user_headers,
                             "Merge-Type": "simpleton",
                             ...send_digests && {
                                 "Repr-Digest": await get_digest(client_state) },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-text",
-  "version": "0.3.20",
+  "version": "0.3.22",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",

package/server.js

@@ -345,11 +345,11 @@ function create_braid_text() {
     braid_text.serve = async (req, res, options = {}) => {
         options = {
             key: req.url.split('?')[0], // Default key
-            put_cb: (key, val) => { },  // Default callback when a PUT changes a key
+            put_cb: (key, val, old_val, patches) => { },  // Default callback when a PUT changes a key
             ...options                  // Override with all options passed in
         }
 
-        braid_text.free_cors(res)
+        if (braid_text.cors !== false) braid_text.free_cors(res)
 
         function my_end(statusCode, x, statusText, headers) {
             res.writeHead(statusCode, statusText, headers)
@@ -555,6 +555,8 @@ function create_braid_text() {
                         })
                 }
 
+                var old_val = resource.val
+                var put_patches = patches ? patches.map(p => ({unit: p.unit, range: p.range, content: p.content})) : null
                 var {change_count} = await braid_text.put(resource, { peer, version: req.version, parents: req.parents, patches, body, merge_type })
 
                 // if Repr-Digest is set,
@@ -575,7 +577,7 @@ function create_braid_text() {
             
                 res.setHeader("Version", get_current_version())
 
-                options.put_cb(options.key, resource.val)
+                options.put_cb(options.key, resource.val, old_val, put_patches)
             } catch (e) {
                 console.log(`${req.method} ERROR: ${e.stack}`)
                 return done_my_turn(500, "The server failed to apply this version. The error generated was: " + e)
@@ -653,7 +655,7 @@ function create_braid_text() {
 
         if (!options) {
             // if it doesn't exist already, don't create it in this case
-            if (!braid_text.cache[key]) return
+            if (!braid_text.cache[key]) return null
             return (await get_resource(key)).val
         }
 
@@ -897,6 +899,10 @@ function create_braid_text() {
 
             let change_count = patches.reduce((a, b) => a + b.content_codepoints.length + (b.range[1] - b.range[0]), 0)
 
+            // Nothing to do: e.g. PUT with empty body on an already-empty doc,
+            // or patches that delete and insert zero characters.
+            if (change_count === 0) return { change_count }
+
             version = version?.[0] || `${(is_valid_actor(peer) && peer) || Math.random().toString(36).slice(2, 7)}-${change_count - 1}`
 
             let v = decode_version(version)