braid-blob 0.0.54 → 0.0.56

package/README.md

@@ -13,10 +13,8 @@ npm install braid-blob
 ### Basic Server
 
 ```javascript
-var braid_blob = require('braid-blob')
-
 require('http').createServer((req, res) => {
-    braid_blob.serve(req, res)
+    require('braid-blob').serve(req, res)
 }).listen(8888)
 ```
 
@@ -38,9 +36,7 @@ node server-demo.js
 
 Then open http://localhost:8888 in your browser. You can drag and drop images to upload them, and open multiple browser windows to see real-time sync in action.
 
-<!-- TODO: Add demo video
-![Demo](demo.mp4)
--->
+<video src="https://github.com/user-attachments/assets/0418a03f-31f5-4fc4-9ad4-e49fab6394c9" controls width="600"></video>
 
 ## API
 
@@ -77,11 +73,7 @@ Bidirectionally synchronizes a blob between local storage and a remote URL.
 - `url` - Remote URL (URL object)
 - `options` - Optional configuration object
   - `signal` - AbortSignal for cancellation (use to stop sync)
-  - `content_type` / `accept` - Content type for requests
-  - `on_pre_connect` - Async callback before connection attempt
-  - `on_disconnect` - Callback when connection drops
-  - `on_unauthorized` - Callback on 401/403 responses
-  - `on_res` - Callback receiving the response object
+  - `content_type` - Content type for requests
 
 ### `braid_blob.get(key, options)`
 
@@ -90,11 +82,11 @@ Retrieves a blob from local storage or a remote URL.
 **Parameters:**
 - `key` - Local storage key (string) or remote URL (URL object)
 - `options` - Optional configuration object
-  - `version` - Request a specific version
-  - `parents` - Version parents for subscription fork-point
+  - `version` - Version ID to check existence (use with `head: true`)
+  - `parent` - Version ID; when subscribing, only receive updates newer than this
   - `subscribe` - Callback function for real-time updates
   - `head` - If true, returns only metadata (version, content_type) without body
-  - `content_type` / `accept` - Content type for the request
+  - `content_type` - Content type for the request
   - `signal` - AbortSignal for cancellation
 
 **Returns:** `{version, body, content_type}` object, or `null` if not found.
@@ -126,15 +118,15 @@ A simple browser client is included for subscribing to blob updates.
 
 ```html
 <script src="https://unpkg.com/braid-http@~1.3/braid-http-client.js"></script>
-<script src="/client.js"></script>
+<script src="http://localhost:8888/client.js"></script>
+<img id="image"/>
 <script>
     braid_blob_client('http://localhost:8888/blob.png', {
-        on_update: (blob, content_type, version) => {
-            // Called whenever the blob is updated
-            var url = URL.createObjectURL(new Blob([blob], { type: content_type }))
-            document.getElementById('image').src = url
-        },
-        on_delete: () => console.log('Blob was deleted'),
+        // Called whenever the blob is updated
+        on_update: (blob, content_type, version) =>
+            image.src = URL.createObjectURL(
+                new Blob([blob], { type: content_type })),
+        on_delete: () => image.src = '',
         on_error: (e) => console.error('Error:', e)
     })
 </script>
@@ -149,10 +141,8 @@ Subscribes to a blob endpoint and receives updates.
 - `options` - Configuration object
   - `on_update(blob, content_type, version)` - Callback for updates
   - `on_delete` - Callback when blob is deleted
-  - `on_error` - Callback for errors
-  - `on_res` - Callback receiving the response object
-
-**Returns:** `{ stop }` - Call `stop()` to unsubscribe.
+  - `on_error(e)` - Callback for errors
+  - `signal` - AbortSignal for cancellation
 
 ## Testing
 

package/client.js

@@ -6,27 +6,27 @@
 //       on_update: (blob, content_type, version) => {
 //           // Called whenever there's a new version of the blob
 //           console.log('New blob:', blob, content_type, version)
-//       }
+//       },
+//       on_delete: () => {
+//           // Called when the blob is deleted (404 status)
+//       },
+//       on_error: (error) => {
+//           // Called on connection or subscription errors
+//       },
+//       signal: ac.signal // optional AbortSignal to unsubscribe
 //   })
 //
-// Returns: { stop } - call stop() to unsubscribe
-//
 function braid_blob_client(url, options = {}) {
-    var ac = new AbortController()
-    var peer = Math.random().toString(36).substr(2)
     var current_version = null
 
     braid_fetch(url, {
         headers: { "Merge-Type": "aww" },
         subscribe: true,
         retry: () => true,
-        peer,
-        signal: ac.signal
+        signal: options.signal
     }).then(res => {
-        if (options.on_res) options.on_res(res)
-
         res.subscribe(async update => {
-            if (update.status === 404) {
+            if (update.status == 404) {
                 current_version = null
                 if (options.on_delete) options.on_delete()
                 return
@@ -40,12 +40,8 @@ function braid_blob_client(url, options = {}) {
                 current_version = version
                 if (options.on_update) options.on_update(update.body, content_type, update.version)
             }
-        }, options.on_error || (e => console.error('braid_blob_client error:', e)))
-    }).catch(options.on_error || (e => console.error('braid_blob_client error:', e)))
-
-    return {
-        stop: () => ac.abort()
-    }
+        }, e => options.on_error?.(e))
+    }).catch(e => options.on_error?.(e))
 
     function compare_events(a, b) {
         if (!a) a = ''
@@ -60,17 +56,12 @@ function braid_blob_client(url, options = {}) {
     }
 
     function get_event_seq(e) {
-        if (!e) return ''
-
         for (let i = e.length - 1; i >= 0; i--)
             if (e[i] === '-') return e.slice(i + 1)
         return e
     }
 
     function compare_seqs(a, b) {
-        if (!a) a = ''
-        if (!b) b = ''
-
         if (a.length !== b.length) return a.length - b.length
         if (a < b) return -1
         if (a > b) return 1

package/index.js

@@ -1,4 +1,4 @@
-var {http_server: braidify, fetch: braid_fetch} = require('braid-http')
+var {http_server: braidify, fetch: braid_fetch, free_cors} = require('braid-http')
 
 function create_braid_blob() {
     var braid_blob = {
@@ -127,6 +127,8 @@ function create_braid_blob() {
             options.key = url.pathname
         }
 
+        free_cors(res)
+
         braidify(req, res)
         if (res.is_multiplexer) return
 
@@ -757,11 +759,15 @@ function create_braid_blob() {
             }
         }
 
-        // Normalize version/parents strings to arrays
+        // Normalize parent -> parents
+        if (options.parent)
+            normalized.parents = options.parent
+
+        // Normalize version/parents: allow strings, wrap in array for internal use
         if (typeof normalized.version === 'string')
-            normalized.version = JSON.parse('[' + normalized.version + ']')
+            normalized.version = [normalized.version]
         if (typeof normalized.parents === 'string')
-            normalized.parents = JSON.parse('[' + normalized.parents + ']')
+            normalized.parents = [normalized.parents]
 
         return normalized
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-blob",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "Library for collaborative blobs over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-blob",

package/server-demo.js

@@ -23,12 +23,12 @@ var server = require("http").createServer(async (req, res) => {
         return
     }
 
-    if (url === '/' || url === '/index.html') {
+    if (url === '/') {
         res.writeHead(200, {
             "Content-Type": "text/html",
             "Cache-Control": "no-cache"
         })
-        require("fs").createReadStream(`${__dirname}/index.html`).pipe(res)
+        require("fs").createReadStream(`${__dirname}/client-demo.html`).pipe(res)
         return
     }