npm - braid-text - Versions diffs - 0.5.9 → 0.5.12 - Mend

braid-text 0.5.9 → 0.5.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/client/editor.html CHANGED Viewed

@@ -1,5 +1,5 @@
 <body style="margin: 0; padding: 0; box-sizing: border-box">
-  <synced-textarea id="the_editor" style="width: 100%; height: 100vh;"></synced-textarea>
+  <sync-area id="the_editor" style="width: 100%; height: 100vh;"></sync-area>
 </body>
 <script src="https://unpkg.com/braid-http@~1.3/braid-http-client.js"></script>
 <script src="/myers-diff.js"></script>

package/client/simpleton.js CHANGED Viewed

@@ -63,8 +63,8 @@ function simpleton_client(url, {
     get_patches,
     on_update,
-    on_error,
-    on_online,
+    on_error,                 // (error) =>
+    on_online,                // (is_online) =>
     on_ack,
     headers,                  // The user can pass in custom headers

package/client/syncarea.js CHANGED Viewed

@@ -1,5 +1,5 @@
 // ============================================================
-// <synced-textarea> — a textarea wired to a braid-http resource
+// <sync-area> — a textarea wired to a braid-http resource
 // ============================================================
 //
 // A drop-in replacement for <textarea> that stays in sync with a
@@ -12,19 +12,20 @@
 //   src     — the URL to sync to
 //   cursors — sync cursors too (default: true; set cursors="false" to disable)
 //   bearer  — Bearer token for servers using "Authorization: Bearer X" headers
+//   accept  — Accept (and Content-Type) for the resource (e.g. "text/markdown")
 //
 // The following attributes are relayed to the inner textarea:
 //   placeholder, readonly, rows, cols, wrap, spellcheck, autofocus,
 //   disabled, aria-label, aria-labelledby, aria-describedby
 //
-// Changes to src, cursors, or bearer restart the sync.
+// Changes to src, cursors, bearer, or accept restart the sync.
 // Changes to any other attribute are just forwarded to the inner textarea.
 //
 // You can always manipulate the inner textarea directly via the .textarea property.
 // Attributes in this list restart the sync when they change.
-const CONNECTION_ATTRS = ['src', 'bearer', 'cursors']
+const CONNECTION_ATTRS = ['src', 'bearer', 'cursors', 'accept']
 // Attributes in this list are relayed straight to the inner textarea.
 const FORWARD_ATTRS = ['placeholder', 'readonly', 'rows', 'cols',
@@ -32,7 +33,7 @@ const FORWARD_ATTRS = ['placeholder', 'readonly', 'rows', 'cols',
                        'aria-label', 'aria-labelledby', 'aria-describedby']
-class SyncedTextarea extends HTMLElement {
+class SyncArea extends HTMLElement {
     static observedAttributes = [...CONNECTION_ATTRS, ...FORWARD_ATTRS, 'disabled']
@@ -58,8 +59,9 @@ class SyncedTextarea extends HTMLElement {
     // Builds the inner textarea, wires up events, starts simpleton_client
     // and cursor_highlights if enabled.
     connect() {
+        console.log('DBG sync-area: connect', {src: this.getAttribute('src'), accept: this.getAttribute('accept')})
         if (this.firstChild)
-            console.warn('<synced-textarea> ignoring existing child content')
+            console.warn('<sync-area> ignoring existing child content')
         while (this.firstChild) this.removeChild(this.firstChild)
         // Create the inner textarea, and fill the outer element with it.
@@ -80,7 +82,7 @@ class SyncedTextarea extends HTMLElement {
         this.update_disabled()
         // Re-dispatch the inner textarea's focus/blur events on the outer,
-        // so listeners on <synced-textarea> see them.
+        // so listeners on <sync-area> see them.
         textarea.addEventListener('focus', () =>
             this.dispatchEvent(new FocusEvent('focus')))
         textarea.addEventListener('blur', () =>
@@ -109,6 +111,7 @@ class SyncedTextarea extends HTMLElement {
         // The main sync client.
         this.client = simpleton_client(url, {
             headers,
+            content_type: this.getAttribute('accept') || undefined,
             on_online: (online) => { online ? cursors?.online() : cursors?.offline() },
             on_update: (update) => {
                 this.waiting_for_first_update = false
@@ -218,4 +221,4 @@ class SyncedTextarea extends HTMLElement {
 }
-customElements.define('synced-textarea', SyncedTextarea)
+customElements.define('sync-area', SyncArea)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "braid-text",
-  "version": "0.5.9",
+  "version": "0.5.12",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",
@@ -27,7 +27,10 @@
   ],
   "dependencies": {
     "@braid.org/diamond-types-node": "^2.0.1",
-    "braid-http": "~1.3.124"
+    "braid-http": "~1.3.125"
+  },
+  "devDependencies": {
+    "yjs": "^13.6.0"
   },
   "peerDependencies": {
     "yjs": "^13.6.0"

package/server.js CHANGED Viewed

@@ -329,10 +329,16 @@ function create_braid_text() {
     braid_text.serve = async (req, res, options = {}) => {
         options = {
             key: req.url.split('?')[0],
+            content_type: 'text/plain',
             put_cb: (key, val, params) => { },
             ...options
         }
+        // Ensure charset=utf-8 on the content type
+        var content_type = options.content_type
+        if (!content_type.includes('charset='))
+            content_type += '; charset=utf-8'
         // ── Setup: prepare the response and load the resource ──
         if (braid_text.cors !== false) braid_text.free_cors(res)
@@ -370,19 +376,6 @@ function create_braid_text() {
             is_write = req.method === 'PUT' || req.method === 'POST' || req.method === 'PATCH',
             is_head  = req.method === 'HEAD'
-        // ── Ensure the response is labeled as utf-8 text ──
-        if (!res.getHeader('content-type')) res.setHeader('Content-Type', 'text/plain')
-        var ct = res.getHeader('Content-Type'),
-            ct_parts = ct.split(';').map(p => p.trim())
-        var charset = ct_parts.find(p => p.toLowerCase().startsWith('charset='))
-        if (!charset)
-            res.setHeader('Content-Type', `${ct}; charset=utf-8`)
-        else if (charset.toLowerCase() !== 'charset=utf-8')
-            res.setHeader('Content-Type', ct_parts
-                          .map(p => p.toLowerCase().startsWith('charset=') ? 'charset=utf-8' : p)
-                          .join('; '))
         // ── Handle simple methods that don't need further processing ──
         if (req.method === 'OPTIONS') return my_end(200)
@@ -408,8 +401,8 @@ function create_braid_text() {
                     Version: ascii_ify(unknowns.map(e => JSON.stringify(e)).join(', '))
                 })
-            var has_parents = req.parents && req.parents.length > 0
-            var has_version = req.version && req.version.length > 0
+            var has_parents = Array.isArray(req.parents)
+            var has_version = Array.isArray(req.version)
             if (req.subscribe && has_version)
                 return my_end(400, 'Version header is not allowed with Subscribe — use Parents instead')
@@ -442,7 +435,7 @@ function create_braid_text() {
             // HEAD: headers only, no body needed
             if (is_head) {
-                // Always include the version of what would be returned
+                res.setHeader('Content-Type', content_type)
                 if (!getting.history)
                     res.setHeader('Version', current_version())
                 return my_end(200)
@@ -469,13 +462,25 @@ function create_braid_text() {
                     // Range of history: send as 209 Multiresponse
                     res.startSubscription()
                     for (var u of result)
-                        res.sendVersion({
+                        res.sendUpdate({
                             version: [u.version],
                             parents: u.parents,
                             patches: [{ unit: u.unit, range: u.range, content: u.content }],
+                            content_type,
                         })
                     return res.end()
+                } else if (false) {
+                    // New path: use sendUpdate (currently broken, investigating)
+                    res.sendUpdate({
+                        version: result.version,
+                        'Repr-Digest': get_digest(result.body),
+                        content_type,
+                        body: result.body,
+                    })
+                    return res.end()
                 } else {
+                    // Old path: explicit headers
+                    res.setHeader('Content-Type', content_type)
                     res.setHeader('Version', ascii_ify(result.version
                                                        .map(v => JSON.stringify(v))
                                                        .join(', ')))
@@ -514,7 +519,9 @@ function create_braid_text() {
                                 update.patch = update.patches[0]
                                 delete update.patches
                             }
-                            res.sendVersion(update)
+                            if (!update.encoding)
+                                update.content_type = content_type
+                            res.sendUpdate(update)
                         },
                     })
                     // Ensure headers are sent even if .get() didn't send
@@ -685,8 +692,8 @@ function create_braid_text() {
         var version = resource.version
         var merge_type = options.range_unit === 'yjs-text' ? 'yjs'
             : (options.merge_type || 'simpleton')
-        var has_parents = options.parents && options.parents.length > 0
-        var has_version = options.version && options.version.length > 0
+        var has_parents = Array.isArray(options.parents)
+        var has_version = Array.isArray(options.version)
         if (options.subscribe && has_version)
             throw new Error('version is not allowed with subscribe — use parents instead')
@@ -704,21 +711,9 @@ function create_braid_text() {
         }
         getting.single_snapshot = !getting.subscribe && !getting.history
-        // Single snapshot: return the text (optionally at a specific version)
-        if (getting.single_snapshot) {
-            if (has_version) {
-                await ensure_dt_exists(resource)
-                return options.full_response
-                    ? { version: options.version, body: dt_get_string(resource.dt.doc, options.version) }
-                    : dt_get_string(resource.dt.doc, options.version)
-            }
-            return options.full_response ? { version, body: resource.val } : resource.val
-        }
         // DT binary encoding: a transport optimization usable by any merge type.
         // Returns raw DT bytes instead of text.
-        if (getting.history && !getting.subscribe && getting.transfer_encoding === 'dt') {
-            // TODO: move this into the dt/simpleton merge_type cases below
+        if (!getting.subscribe && getting.transfer_encoding === 'dt') {
             await ensure_dt_exists(resource)
             // If requesting the current version, skip the version lookup
             // (faster than asking DT about a version we already have)
@@ -742,6 +737,17 @@ function create_braid_text() {
             return { body: bytes }
         }
+        // Single snapshot: return the text (optionally at a specific version)
+        if (getting.single_snapshot) {
+            if (has_version) {
+                await ensure_dt_exists(resource)
+                return options.full_response
+                    ? { version: options.version, body: dt_get_string(resource.dt.doc, options.version) }
+                    : dt_get_string(resource.dt.doc, options.version)
+            }
+            return options.full_response ? { version, body: resource.val } : resource.val
+        }
         // Each merge-type has a different way of getting history
         switch (merge_type) {