braid-text 0.0.10 → 0.0.13

package/README.md

@@ -16,6 +16,8 @@ This library provides a simple http route handler, along with client code, enabl
 
 This library makes it safe, easy & efficient to add collaborative text editing to every user-editable string in your web app.  Make your app multiplayer!
 
+Check out the [**demo video**](https://braid.org/video/https://invisiblecollege.s3.us-west-1.amazonaws.com/braid-meeting-86.mp4#4755) 📺 from the Braid 86 release!
+
 ### Demo: a Wiki!
 
 This will run a collaboratively-editable wiki:

package/index.js

@@ -118,20 +118,28 @@ braid_text.serve = async (req, res, options = {}) => {
                 done()
             })
         )
-        let patches = await req.patches()
+        let patches = null
+        let ee = null
+        try {
+            patches = await req.patches()
+        } catch (e) { ee = e }
         await my_prev_put_p
 
-        let body = null
-        if (patches[0]?.unit === 'everything') {
-            body = patches[0].content
-            patches = null
-        }
-
         try {
+            if (ee) throw ee
+
+            let body = null
+            if (patches[0]?.unit === 'everything') {
+                body = patches[0].content
+                patches = null
+            }
+
             await braid_text.put(resource, { peer, version: req.version, parents: req.parents, patches, body, merge_type: req.headers["merge-type"] })
+
+            options.put_cb(options.key, resource.doc.get())
         } catch (e) {
             console.log(`EEE= ${e}:${e.stack}`)
-            // we couldn't apply the version, presumably because we're missing its parents.
+            // we couldn't apply the version, possibly because we're missing its parents,
             // we want to send a 4XX error, so the client will resend this request later,
             // hopefully after we've received the necessary parents.
 
@@ -155,11 +163,9 @@ braid_text.serve = async (req, res, options = {}) => {
             // - 428 Precondition Required
             //     - pros: the name sounds right
             //     - cons: typically implies that the request was missing an http conditional field like If-Match. that is to say, it implies that the request is missing a precondition, not that the server is missing a precondition
-            return done_my_turn(425, "The server is missing the parents of this version.")
+            return done_my_turn(425, "The server failed to apply this version.")
         }
 
-        options.put_cb(options.key, resource.doc.get())
-
         return done_my_turn(200)
     }
 
@@ -544,11 +550,7 @@ async function file_sync(key, process_delta, get_init) {
     let threshold = 0
 
     // Ensure the existence of db_folder
-    try {
-        await fs.promises.access(braid_text.db_folder);
-    } catch (err) {
-        await fs.promises.mkdir(braid_text.db_folder, { recursive: true });
-    }
+    await fs.promises.mkdir(braid_text.db_folder, { recursive: true });
 
     // Read existing files and sort by numbers.
     const files = (await get_files_for_key(key))
@@ -1273,29 +1275,23 @@ function codePoints_to_index(str, codePoints) {
 }
 
 function encode_filename(filename) {
-  // Replace all '!' with '%21'
-  let encoded = filename.replace(/!/g, '%21');
-  
-  // Encode the filename using encodeURIComponent()
-  encoded = encodeURIComponent(encoded);
-  
-  // Replace all '%2F' (for '/') with '!'
-  encoded = encoded.replace(/%2F/g, '!');
-  
-  return encoded;
+    // Swap all "!" and "/" characters
+    let swapped = filename.replace(/[!/]/g, (match) => (match === "!" ? "/" : "!"))
+
+    // Encode the filename using encodeURIComponent()
+    let encoded = encodeURIComponent(swapped)
+
+    return encoded
 }
 
 function decode_filename(encodedFilename) {
-  // Replace all '!' with '%2F'
-  let decoded = encodedFilename.replace(/!/g, '%2F');
-  
-  // Decode the filename using decodeURIComponent()
-  decoded = decodeURIComponent(decoded);
-  
-  // Replace all '%21' with '!'
-  decoded = decoded.replace(/%21/g, '!');
-  
-  return decoded;
+    // Decode the filename using decodeURIComponent()
+    let decoded = decodeURIComponent(encodedFilename)
+
+    // Swap all "/" and "!" characters
+    decoded = decoded.replace(/[!/]/g, (match) => (match === "/" ? "!" : "/"))
+
+    return decoded
 }
 
 module.exports = braid_text

package/package.json

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

package/server-demo.js

@@ -11,6 +11,11 @@ var braid_text = require("./index.js")
 var server = require("http").createServer(async (req, res) => {
     console.log(`${req.method} ${req.url}`)
 
+    // Free the CORS
+    free_the_cors(req, res)
+    if (req.method === 'OPTIONS') return
+
+
     if (req.url.endsWith("?editor")) {
         res.writeHead(200, { "Content-Type": "text/html", "Cache-Control": "no-cache" })
         require("fs").createReadStream("./editor.html").pipe(res)
@@ -30,9 +35,6 @@ var server = require("http").createServer(async (req, res) => {
     //     var pages = await braid_text.list()
     //     res.writeHead(200, {
     //         "Content-Type": "application/json",
-    //         "Access-Control-Allow-Origin": "*",
-    //         "Access-Control-Allow-Methods": "*",
-    //         "Access-Control-Allow-Headers": "*",
     //         "Access-Control-Expose-Headers": "*"
     //     })
     //     res.end(JSON.stringify(pages))
@@ -73,3 +75,21 @@ var server = require("http").createServer(async (req, res) => {
 server.listen(port, () => {
     console.log(`server started on port ${port}`)
 })
+
+
+// Free the CORS!
+function free_the_cors (req, res) {
+    res.setHeader('Range-Request-Allow-Methods', 'PATCH, PUT')
+    res.setHeader('Range-Request-Allow-Units', 'json')
+    res.setHeader("Patches", "OK")
+    var free_the_cors = {
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Methods": "OPTIONS, HEAD, GET, PUT, UNSUBSCRIBE",
+        "Access-Control-Allow-Headers": "subscribe, client, version, parents, merge-type, content-type, content-range, patches, cache-control, peer"
+    }
+    Object.entries(free_the_cors).forEach(x => res.setHeader(x[0], x[1]))
+    if (req.method === 'OPTIONS') {
+        res.writeHead(200)
+        res.end()
+    }
+}