braid-text 0.3.21 → 0.3.23

package/README.md

@@ -69,11 +69,13 @@ 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:
+    - `put_cb`: <small style="color:lightgrey">[optional]</small> Callback invoked after a PUT changes a resource. Signature: `(key, val, {old_val, patches, version, parents})` 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
+      - `version` - The version after the PUT
+      - `parents` - The version prior to the PUT
   - 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

@@ -12,6 +12,8 @@
 //
 // url: resource endpoint
 //
+// headers:  custom headers that get forwarded through into the fetch
+//
 // on_patches?: (patches) => void
 //     processes incoming patches by applying them to the UI/textarea.
 //     Patches are guaranteed to be in-order and non-overlapping.
@@ -104,7 +106,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 +144,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 +332,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.21",
+  "version": "0.3.23",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",
@@ -9,8 +9,10 @@
     "test": "node test/test.js"
   },
   "main": "server.js",
+  "types": "server.d.ts",
   "files": [
     "server.js",
+    "server.d.ts",
     "simpleton-client.js",
     "client/simpleton-sync.js",
     "client/cursor-sync.js",

package/server.d.ts

@@ -0,0 +1,44 @@
+import { IncomingMessage, ServerResponse } from 'http'
+
+interface PutCallbackParams {
+  old_val: string
+  patches: Array<{ unit: string; range: string; content: string }> | null
+  version: string[]
+  parents: string[]
+}
+
+interface ServeOptions {
+  key?: string
+  put_cb?: (key: string, val: string, params: PutCallbackParams) => void
+}
+
+interface GetResult {
+  version: string[]
+  body: string | Uint8Array
+}
+
+interface Resource {
+  key: string
+  val: string
+  version: string[]
+}
+
+interface BraidText {
+  verbose: boolean
+  db_folder: string | null
+  cors: boolean
+  cache: Record<string, Promise<Resource>>
+
+  serve(req: IncomingMessage, res: ServerResponse, options?: ServeOptions): Promise<void>
+  get(key: string): Promise<string | null>
+  get(key: string, options: Record<string, any>): Promise<GetResult>
+  put(key: string, options: Record<string, any>): Promise<{ change_count: number }>
+  delete(key: string): Promise<void>
+  list(): Promise<string[]>
+  sync(a: string, b: string | URL, options?: Record<string, any>): Promise<void>
+  free_cors(res: ServerResponse): void
+  create_braid_text(): BraidText
+}
+
+declare const braidText: BraidText
+export = braidText

package/server.js

@@ -345,7 +345,7 @@ function create_braid_text() {
     braid_text.serve = async (req, res, options = {}) => {
         options = {
             key: req.url.split('?')[0], // Default key
-            put_cb: (key, val, old_val, patches) => { },  // Default callback when a PUT changes a key
+            put_cb: (key, val, params) => { },  // Default callback when a PUT changes a key
             ...options                  // Override with all options passed in
         }
 
@@ -556,6 +556,7 @@ function create_braid_text() {
                 }
 
                 var old_val = resource.val
+                var old_version = resource.version
                 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 })
 
@@ -577,7 +578,7 @@ function create_braid_text() {
             
                 res.setHeader("Version", get_current_version())
 
-                options.put_cb(options.key, resource.val, old_val, put_patches)
+                options.put_cb(options.key, resource.val, {old_val, patches: put_patches, version: resource.version, parents: old_version})
             } 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)