README.md

@@ -82,7 +82,7 @@ import { WebsocketProvider } from 'y-websocket'
 wsOpts = {
   // Set this to `false` if you want to connect manually using wsProvider.connect()
   connect: true,
-  // Specify a query-string that will be url-encoded and attached to the `serverUrl`
+  // Specify a query-string / url parameters that will be url-encoded and attached to the `serverUrl`
   // I.e. params = { auth: "bearer" } will be transformed to "?auth=bearer"
   params: {}, // Object<string,string>
   // You may polyill the Websocket object (https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).
@@ -106,6 +106,10 @@ wsOpts = {
   <dd>True if this instance is currently communicating to other browser-windows via BroadcastChannel.</dd>
   <b><code>wsProvider.synced: boolean</code></b>
   <dd>True if this instance is currently connected and synced with the server.</dd>
+  <b><code>wsProvider.params : boolean</code></b>
+  <dd>The specified url parameters. This can be safely updated, the new values
+    will be used when a new connction is established. If this contains an
+    auth token, it should be updated regularly.</dd>
   <b><code>wsProvider.disconnect()</code></b>
   <dd>Disconnect from the server and don't try to reconnect.</dd>
   <b><code>wsProvider.connect()</code></b>

bin/callback.cjs

@@ -44,7 +44,7 @@ const callbackRequest = (url, timeout, data) => {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
-      'Content-Length': data.length
+      'Content-Length': Buffer.byteLength(data)
     }
   }
   const req = http.request(options)

bin/server.cjs

@@ -1,8 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * @type {any}
- */
 const WebSocket = require('ws')
 const http = require('http')
 const number = require('lib0/number')
@@ -21,14 +18,12 @@ wss.on('connection', setupWSConnection)
 
 server.on('upgrade', (request, socket, head) => {
   // You may check auth of request here..
+  // Call `wss.HandleUpgrade` *after* you checked whether the client has access
+  // (e.g. by checking cookies, or url parameters).
   // See https://github.com/websockets/ws#client-authentication
-  /**
-   * @param {any} ws
-   */
-  const handleAuth = ws => {
+  wss.handleUpgrade(request, socket, head, /** @param {any} ws */ ws => {
     wss.emit('connection', ws, request)
-  }
-  wss.handleUpgrade(request, socket, head, handleAuth)
+  })
 })
 
 server.listen(port, host, () => {

bin/utils.cjs

@@ -142,11 +142,11 @@ class WSSharedDoc extends Y.Doc {
     this.awareness.on('update', awarenessChangeHandler)
     this.on('update', /** @type {any} */ (updateHandler))
     if (isCallbackSet) {
-      this.on('update', debounce(
+      this.on('update', /** @type {any} */ (debounce(
         callbackHandler,
         CALLBACK_DEBOUNCE_WAIT,
         { maxWait: CALLBACK_DEBOUNCE_MAXWAIT }
-      ))
+      )))
     }
     this.whenInitialized = contentInitializor(this)
   }
@@ -233,15 +233,15 @@ const closeConn = (doc, conn) => {
 
 /**
  * @param {WSSharedDoc} doc
- * @param {any} conn
+ * @param {import('ws').WebSocket} conn
  * @param {Uint8Array} m
  */
 const send = (doc, conn, m) => {
   if (conn.readyState !== wsReadyStateConnecting && conn.readyState !== wsReadyStateOpen) {
     closeConn(doc, conn)
   }
   try {
-    conn.send(m, /** @param {any} err */ err => { err != null && closeConn(doc, conn) })
+    conn.send(m, {}, err => { err != null && closeConn(doc, conn) })
   } catch (e) {
     closeConn(doc, conn)
   }
@@ -250,11 +250,11 @@ const send = (doc, conn, m) => {
 const pingTimeout = 30000
 
 /**
- * @param {any} conn
- * @param {any} req
+ * @param {import('ws').WebSocket} conn
+ * @param {import('http').IncomingMessage} req
  * @param {any} opts
  */
-exports.setupWSConnection = (conn, req, { docName = req.url.slice(1).split('?')[0], gc = true } = {}) => {
+exports.setupWSConnection = (conn, req, { docName = (req.url || '').slice(1).split('?')[0], gc = true } = {}) => {
   conn.binaryType = 'arraybuffer'
   // get doc, initialize if it does not exist yet
   const doc = getYDoc(docName, gc)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "y-websocket",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Websockets provider for Yjs",
   "main": "./dist/y-websocket.cjs",
   "module": "./src/y-websocket.js",
@@ -64,7 +64,9 @@
     "y-protocols": "^1.0.5"
   },
   "devDependencies": {
+    "@types/lodash.debounce": "^4.0.9",
     "@types/node": "^18.15.0",
+    "@types/ws": "^8.5.10",
     "rollup": "^3.19.1",
     "standard": "^12.0.1",
     "typescript": "^4.9.5",

src/y-websocket.js

@@ -245,7 +245,7 @@ export class WebsocketProvider extends Observable {
    * @param {object} opts
    * @param {boolean} [opts.connect]
    * @param {awarenessProtocol.Awareness} [opts.awareness]
-   * @param {Object<string,string>} [opts.params]
+   * @param {Object<string,string>} [opts.params] specify url parameters
    * @param {typeof WebSocket} [opts.WebSocketPolyfill] Optionall provide a WebSocket polyfill
    * @param {number} [opts.resyncInterval] Request server state every `resyncInterval` milliseconds
    * @param {number} [opts.maxBackoffTime] Maximum amount of time to wait before trying to reconnect (we try to reconnect using exponential backoff)
@@ -265,11 +265,15 @@ export class WebsocketProvider extends Observable {
     while (serverUrl[serverUrl.length - 1] === '/') {
       serverUrl = serverUrl.slice(0, serverUrl.length - 1)
     }
-    const encodedParams = url.encodeQueryParams(params)
-    this.maxBackoffTime = maxBackoffTime
+    this.serverUrl = serverUrl
     this.bcChannel = serverUrl + '/' + roomname
-    this.url = serverUrl + '/' + roomname +
-      (encodedParams.length === 0 ? '' : '?' + encodedParams)
+    this.maxBackoffTime = maxBackoffTime
+    /**
+     * The specified url parameters. This can be safely updated. The changed parameters will be used
+     * when a new connection is established.
+     * @type {Object<string,string>}
+     */
+    this.params = params
     this.roomname = roomname
     this.doc = doc
     this._WS = WebSocketPolyfill
@@ -378,6 +382,12 @@ export class WebsocketProvider extends Observable {
     }
   }
 
+  get url () {
+    const encodedParams = url.encodeQueryParams(this.params)
+    return this.serverUrl + '/' + this.roomname +
+      (encodedParams.length === 0 ? '' : '?' + encodedParams)
+  }
+
   /**
    * @type {boolean}
    */