@hocuspocus/provider 3.0.8-rc.0 → 3.1.0-rc.0

package/dist/hocuspocus-provider.cjs

@@ -88,37 +88,6 @@ const create$2 = () => new Set();
  */
 const from = Array.from;
 
-/**
- * Utility module to work with strings.
- *
- * @module string
- */
-
-const fromCharCode = String.fromCharCode;
-
-/**
- * @param {string} s
- * @return {string}
- */
-const toLowerCase = s => s.toLowerCase();
-
-const trimLeftRegex = /^\s*/g;
-
-/**
- * @param {string} s
- * @return {string}
- */
-const trimLeft = s => s.replace(trimLeftRegex, '');
-
-const fromCamelCaseRegex = /([A-Z])/g;
-
-/**
- * @param {string} s
- * @param {string} separator
- * @return {string}
- */
-const fromCamelCase = (s, separator) => trimLeft(s.replace(fromCamelCaseRegex, match => `${separator}${toLowerCase(match)}`));
-
 /**
  * @param {string} str
  * @return {Uint8Array}
@@ -770,22 +739,6 @@ class Observable {
  */
 const keys = Object.keys;
 
-/**
- * @todo implement mapToArray & map
- *
- * @template R
- * @param {Object<string,any>} obj
- * @param {function(any,string):R} f
- * @return {Array<R>}
- */
-const map = (obj, f) => {
-  const results = [];
-  for (const key in obj) {
-    results.push(f(obj[key], key));
-  }
-  return results
-};
-
 /**
  * @deprecated use object.size instead
  * @param {Object<string,any>} obj
@@ -899,16 +852,6 @@ const equalityDeep = (a, b) => {
   return true
 };
 
-/**
- * @template V
- * @template {V} OPTS
- *
- * @param {V} value
- * @param {Array<OPTS>} options
- */
-// @ts-ignore
-const isOneOf = (value, options) => options.includes(value);
-
 /**
  * @module awareness-protocol
  */
@@ -1209,37 +1152,6 @@ class EventEmitter {
     }
 }
 
-/**
- * Utility module to work with urls.
- *
- * @module url
- */
-
-
-/**
- * @param {Object<string,string>} params
- * @return {string}
- */
-const encodeQueryParams = params =>
-  map(params, (val, key) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`).join('&');
-
-exports.MessageType = void 0;
-(function (MessageType) {
-    MessageType[MessageType["Sync"] = 0] = "Sync";
-    MessageType[MessageType["Awareness"] = 1] = "Awareness";
-    MessageType[MessageType["Auth"] = 2] = "Auth";
-    MessageType[MessageType["QueryAwareness"] = 3] = "QueryAwareness";
-    MessageType[MessageType["Stateless"] = 5] = "Stateless";
-    MessageType[MessageType["CLOSE"] = 7] = "CLOSE";
-    MessageType[MessageType["SyncStatus"] = 8] = "SyncStatus";
-})(exports.MessageType || (exports.MessageType = {}));
-exports.WebSocketStatus = void 0;
-(function (WebSocketStatus) {
-    WebSocketStatus["Connecting"] = "connecting";
-    WebSocketStatus["Connected"] = "connected";
-    WebSocketStatus["Disconnected"] = "disconnected";
-})(exports.WebSocketStatus || (exports.WebSocketStatus = {}));
-
 class IncomingMessage {
     constructor(data) {
         this.data = data;
@@ -1272,6 +1184,23 @@ class IncomingMessage {
     }
 }
 
+exports.MessageType = void 0;
+(function (MessageType) {
+    MessageType[MessageType["Sync"] = 0] = "Sync";
+    MessageType[MessageType["Awareness"] = 1] = "Awareness";
+    MessageType[MessageType["Auth"] = 2] = "Auth";
+    MessageType[MessageType["QueryAwareness"] = 3] = "QueryAwareness";
+    MessageType[MessageType["Stateless"] = 5] = "Stateless";
+    MessageType[MessageType["CLOSE"] = 7] = "CLOSE";
+    MessageType[MessageType["SyncStatus"] = 8] = "SyncStatus";
+})(exports.MessageType || (exports.MessageType = {}));
+exports.WebSocketStatus = void 0;
+(function (WebSocketStatus) {
+    WebSocketStatus["Connecting"] = "connecting";
+    WebSocketStatus["Connected"] = "connected";
+    WebSocketStatus["Disconnected"] = "disconnected";
+})(exports.WebSocketStatus || (exports.WebSocketStatus = {}));
+
 class OutgoingMessage {
     constructor() {
         this.encoder = createEncoder();
@@ -1302,14 +1231,10 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         super();
         this.messageQueue = [];
         this.configuration = {
-            url: '',
+            url: "",
             // @ts-ignore
             document: undefined,
             WebSocketPolyfill: undefined,
-            parameters: {},
-            connect: true,
-            broadcast: true,
-            forceSyncInterval: false,
             // TODO: this should depend on awareness.outdatedTime
             messageReconnectTimeout: 30000,
             // 1 second
@@ -1356,23 +1281,20 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         this.configuration.WebSocketPolyfill = configuration.WebSocketPolyfill
             ? configuration.WebSocketPolyfill
             : WebSocket;
-        this.on('open', this.configuration.onOpen);
-        this.on('open', this.onOpen.bind(this));
-        this.on('connect', this.configuration.onConnect);
-        this.on('message', this.configuration.onMessage);
-        this.on('outgoingMessage', this.configuration.onOutgoingMessage);
-        this.on('status', this.configuration.onStatus);
-        this.on('disconnect', this.configuration.onDisconnect);
-        this.on('close', this.configuration.onClose);
-        this.on('destroy', this.configuration.onDestroy);
-        this.on('awarenessUpdate', this.configuration.onAwarenessUpdate);
-        this.on('awarenessChange', this.configuration.onAwarenessChange);
-        this.on('close', this.onClose.bind(this));
-        this.on('message', this.onMessage.bind(this));
+        this.on("open", this.configuration.onOpen);
+        this.on("open", this.onOpen.bind(this));
+        this.on("connect", this.configuration.onConnect);
+        this.on("message", this.configuration.onMessage);
+        this.on("outgoingMessage", this.configuration.onOutgoingMessage);
+        this.on("status", this.configuration.onStatus);
+        this.on("disconnect", this.configuration.onDisconnect);
+        this.on("close", this.configuration.onClose);
+        this.on("destroy", this.configuration.onDestroy);
+        this.on("awarenessUpdate", this.configuration.onAwarenessUpdate);
+        this.on("awarenessChange", this.configuration.onAwarenessChange);
+        this.on("close", this.onClose.bind(this));
+        this.on("message", this.onMessage.bind(this));
         this.intervals.connectionChecker = setInterval(this.checkConnection.bind(this), this.configuration.messageReconnectTimeout / 10);
-        if (typeof configuration.connect !== 'undefined') {
-            this.shouldConnect = configuration.connect;
-        }
         if (!this.shouldConnect) {
             return;
         }
@@ -1387,13 +1309,16 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         if (this.status === exports.WebSocketStatus.Disconnected && this.shouldConnect) {
             this.connect();
         }
-        if (this.receivedOnOpenPayload && this.status === exports.WebSocketStatus.Connected) {
+        if (this.receivedOnOpenPayload &&
+            this.status === exports.WebSocketStatus.Connected) {
             provider.onOpen(this.receivedOnOpenPayload);
         }
     }
     detach(provider) {
         if (this.configuration.providerMap.has(provider.configuration.name)) {
-            provider.send(CloseMessage, { documentName: provider.configuration.name });
+            provider.send(CloseMessage, {
+                documentName: provider.configuration.name,
+            });
             this.configuration.providerMap.delete(provider.configuration.name);
         }
     }
@@ -1422,7 +1347,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
                 maxDelay: this.configuration.maxDelay,
                 jitter: this.configuration.jitter,
                 timeout: this.configuration.timeout,
-                beforeAttempt: context => {
+                beforeAttempt: (context) => {
                     if (!this.shouldConnect || cancelAttempt) {
                         context.abort();
                     }
@@ -1430,7 +1355,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             }).catch((error) => {
                 // If we aborted the connection attempt then don’t throw an error
                 // ref: https://github.com/lifeomic/attempt/blob/master/src/index.ts#L136
-                if (error && error.code !== 'ATTEMPT_ABORTED') {
+                if (error && error.code !== "ATTEMPT_ABORTED") {
                     throw error;
                 }
             });
@@ -1448,9 +1373,9 @@ class HocuspocusProviderWebsocket extends EventEmitter {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
     attachWebSocketListeners(ws, reject) {
         const { identifier } = ws;
-        const onMessageHandler = (payload) => this.emit('message', payload);
-        const onCloseHandler = (payload) => this.emit('close', { event: payload });
-        const onOpenHandler = (payload) => this.emit('open', payload);
+        const onMessageHandler = (payload) => this.emit("message", payload);
+        const onCloseHandler = (payload) => this.emit("close", { event: payload });
+        const onOpenHandler = (payload) => this.emit("open", payload);
         const onErrorHandler = (err) => {
             reject(err);
         };
@@ -1461,7 +1386,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             error: onErrorHandler,
         };
         const handlers = this.webSocketHandlers[ws.identifier];
-        Object.keys(handlers).forEach(name => {
+        Object.keys(handlers).forEach((name) => {
             ws.addEventListener(name, handlers[name]);
         });
     }
@@ -1471,7 +1396,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         }
         const { identifier } = this.webSocket;
         const handlers = this.webSocketHandlers[identifier];
-        Object.keys(handlers).forEach(name => {
+        Object.keys(handlers).forEach((name) => {
             var _a;
             (_a = this.webSocket) === null || _a === void 0 ? void 0 : _a.removeEventListener(name, handlers[name]);
             delete this.webSocketHandlers[identifier];
@@ -1489,13 +1414,13 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             this.identifier += 1;
             // Init the WebSocket connection
             const ws = new this.configuration.WebSocketPolyfill(this.url);
-            ws.binaryType = 'arraybuffer';
+            ws.binaryType = "arraybuffer";
             ws.identifier = this.identifier;
             this.attachWebSocketListeners(ws, reject);
             this.webSocket = ws;
             // Reset the status
             this.status = exports.WebSocketStatus.Connecting;
-            this.emit('status', { status: exports.WebSocketStatus.Connecting });
+            this.emit("status", { status: exports.WebSocketStatus.Connecting });
             // Store resolve/reject for later use
             this.connectionAttempt = {
                 resolve,
@@ -1516,9 +1441,9 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             this.connectionAttempt.resolve();
             this.connectionAttempt = null;
             this.status = exports.WebSocketStatus.Connected;
-            this.emit('status', { status: exports.WebSocketStatus.Connected });
-            this.emit('connect');
-            this.messageQueue.forEach(message => this.send(message));
+            this.emit("status", { status: exports.WebSocketStatus.Connected });
+            this.emit("connect");
+            this.messageQueue.forEach((message) => this.send(message));
             this.messageQueue = [];
         }
     }
@@ -1541,8 +1466,8 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             return;
         }
         // Don’t close the connection when a message was received recently
-        if (this.configuration.messageReconnectTimeout
-            >= getUnixTime() - this.lastMessageReceived) {
+        if (this.configuration.messageReconnectTimeout >=
+            getUnixTime() - this.lastMessageReceived) {
             return;
         }
         // No message received in a long time, not even your own
@@ -1554,7 +1479,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
             this.onClose({
                 event: {
                     code: 4408,
-                    reason: 'forced',
+                    reason: "forced",
                 },
             });
             this.closeTries = 0;
@@ -1566,14 +1491,13 @@ class HocuspocusProviderWebsocket extends EventEmitter {
     }
     // Ensure that the URL never ends with /
     get serverUrl() {
-        while (this.configuration.url[this.configuration.url.length - 1] === '/') {
+        while (this.configuration.url[this.configuration.url.length - 1] === "/") {
             return this.configuration.url.slice(0, this.configuration.url.length - 1);
         }
         return this.configuration.url;
     }
     get url() {
-        const encodedParams = encodeQueryParams(this.configuration.parameters);
-        return `${this.serverUrl}${encodedParams.length === 0 ? '' : `?${encodedParams}`}`;
+        return this.serverUrl;
     }
     disconnect() {
         this.shouldConnect = false;
@@ -1606,8 +1530,8 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         }
         // Let’s update the connection status.
         this.status = exports.WebSocketStatus.Disconnected;
-        this.emit('status', { status: exports.WebSocketStatus.Disconnected });
-        this.emit('disconnect', { event });
+        this.emit("status", { status: exports.WebSocketStatus.Disconnected });
+        this.emit("disconnect", { event });
         // trigger connect if no retry is running and we want to have a connection
         if (!this.cancelWebsocketRetry && this.shouldConnect) {
             setTimeout(() => {
@@ -1616,7 +1540,7 @@ class HocuspocusProviderWebsocket extends EventEmitter {
         }
     }
     destroy() {
-        this.emit('destroy');
+        this.emit("destroy");
         clearInterval(this.intervals.connectionChecker);
         // If there is still a connection attempt outstanding then we should stop
         // it before calling disconnect, otherwise it will be rejected in the onClose
@@ -1839,366 +1763,6 @@ class MessageReceiver {
     }
 }
 
-/**
- * Often used conditions.
- *
- * @module conditions
- */
-
-/**
- * @template T
- * @param {T|null|undefined} v
- * @return {T|null}
- */
-/* c8 ignore next */
-const undefinedToNull = v => v === undefined ? null : v;
-
-/* eslint-env browser */
-
-/**
- * Isomorphic variable storage.
- *
- * Uses LocalStorage in the browser and falls back to in-memory storage.
- *
- * @module storage
- */
-
-/* c8 ignore start */
-class VarStoragePolyfill {
-  constructor () {
-    this.map = new Map();
-  }
-
-  /**
-   * @param {string} key
-   * @param {any} newValue
-   */
-  setItem (key, newValue) {
-    this.map.set(key, newValue);
-  }
-
-  /**
-   * @param {string} key
-   */
-  getItem (key) {
-    return this.map.get(key)
-  }
-}
-/* c8 ignore stop */
-
-/**
- * @type {any}
- */
-let _localStorage = new VarStoragePolyfill();
-let usePolyfill = true;
-
-/* c8 ignore start */
-try {
-  // if the same-origin rule is violated, accessing localStorage might thrown an error
-  if (typeof localStorage !== 'undefined' && localStorage) {
-    _localStorage = localStorage;
-    usePolyfill = false;
-  }
-} catch (e) { }
-/* c8 ignore stop */
-
-/**
- * This is basically localStorage in browser, or a polyfill in nodejs
- */
-/* c8 ignore next */
-const varStorage = _localStorage;
-
-/**
- * A polyfill for `addEventListener('storage', event => {..})` that does nothing if the polyfill is being used.
- *
- * @param {function({ key: string, newValue: string, oldValue: string }): void} eventHandler
- * @function
- */
-/* c8 ignore next */
-const onChange = eventHandler => usePolyfill || addEventListener('storage', /** @type {any} */ (eventHandler));
-
-/**
- * A polyfill for `removeEventListener('storage', event => {..})` that does nothing if the polyfill is being used.
- *
- * @param {function({ key: string, newValue: string, oldValue: string }): void} eventHandler
- * @function
- */
-/* c8 ignore next */
-const offChange = eventHandler => usePolyfill || removeEventListener('storage', /** @type {any} */ (eventHandler));
-
-/**
- * Isomorphic module to work access the environment (query params, env variables).
- *
- * @module environment
- */
-
-
-/* c8 ignore next 2 */
-// @ts-ignore
-const isNode = typeof process !== 'undefined' && process.release && /node|io\.js/.test(process.release.name) && Object.prototype.toString.call(typeof process !== 'undefined' ? process : 0) === '[object process]';
-
-/* c8 ignore next */
-const isBrowser = typeof window !== 'undefined' && typeof document !== 'undefined' && !isNode;
-
-/**
- * @type {Map<string,string>}
- */
-let params;
-
-/* c8 ignore start */
-const computeParams = () => {
-  if (params === undefined) {
-    if (isNode) {
-      params = create();
-      const pargs = process.argv;
-      let currParamName = null;
-      for (let i = 0; i < pargs.length; i++) {
-        const parg = pargs[i];
-        if (parg[0] === '-') {
-          if (currParamName !== null) {
-            params.set(currParamName, '');
-          }
-          currParamName = parg;
-        } else {
-          if (currParamName !== null) {
-            params.set(currParamName, parg);
-            currParamName = null;
-          }
-        }
-      }
-      if (currParamName !== null) {
-        params.set(currParamName, '');
-      }
-      // in ReactNative for example this would not be true (unless connected to the Remote Debugger)
-    } else if (typeof location === 'object') {
-      params = create(); // eslint-disable-next-line no-undef
-      (location.search || '?').slice(1).split('&').forEach((kv) => {
-        if (kv.length !== 0) {
-          const [key, value] = kv.split('=');
-          params.set(`--${fromCamelCase(key, '-')}`, value);
-          params.set(`-${fromCamelCase(key, '-')}`, value);
-        }
-      });
-    } else {
-      params = create();
-    }
-  }
-  return params
-};
-/* c8 ignore stop */
-
-/**
- * @param {string} name
- * @return {boolean}
- */
-/* c8 ignore next */
-const hasParam = (name) => computeParams().has(name);
-
-/**
- * @param {string} name
- * @return {string|null}
- */
-/* c8 ignore next 4 */
-const getVariable = (name) =>
-  isNode
-    ? undefinedToNull(process.env[name.toUpperCase().replaceAll('-', '_')])
-    : undefinedToNull(varStorage.getItem(name));
-
-/**
- * @param {string} name
- * @return {boolean}
- */
-/* c8 ignore next 2 */
-const hasConf = (name) =>
-  hasParam('--' + name) || getVariable(name) !== null;
-
-/* c8 ignore next */
-hasConf('production');
-
-/* c8 ignore next 2 */
-const forceColor = isNode &&
-  isOneOf(process.env.FORCE_COLOR, ['true', '1', '2']);
-
-/* c8 ignore start */
-/**
- * Color is enabled by default if the terminal supports it.
- *
- * Explicitly enable color using `--color` parameter
- * Disable color using `--no-color` parameter or using `NO_COLOR=1` environment variable.
- * `FORCE_COLOR=1` enables color and takes precedence over all.
- */
-forceColor || (
-  !hasParam('--no-colors') && // @todo deprecate --no-colors
-  !hasConf('no-color') &&
-  (!isNode || process.stdout.isTTY) && (
-    !isNode ||
-    hasParam('--color') ||
-    getVariable('COLORTERM') !== null ||
-    (getVariable('TERM') || '').includes('color')
-  )
-);
-/* c8 ignore stop */
-
-/**
- * Utility functions to work with buffers (Uint8Array).
- *
- * @module buffer
- */
-
-
-/**
- * @param {number} len
- */
-const createUint8ArrayFromLen = len => new Uint8Array(len);
-
-/**
- * Create Uint8Array with initial content from buffer
- *
- * @param {ArrayBuffer} buffer
- * @param {number} byteOffset
- * @param {number} length
- */
-const createUint8ArrayViewFromArrayBuffer = (buffer, byteOffset, length) => new Uint8Array(buffer, byteOffset, length);
-
-/**
- * Create Uint8Array with initial content from buffer
- *
- * @param {ArrayBuffer} buffer
- */
-const createUint8ArrayFromArrayBuffer = buffer => new Uint8Array(buffer);
-
-/* c8 ignore start */
-/**
- * @param {Uint8Array} bytes
- * @return {string}
- */
-const toBase64Browser = bytes => {
-  let s = '';
-  for (let i = 0; i < bytes.byteLength; i++) {
-    s += fromCharCode(bytes[i]);
-  }
-  // eslint-disable-next-line no-undef
-  return btoa(s)
-};
-/* c8 ignore stop */
-
-/**
- * @param {Uint8Array} bytes
- * @return {string}
- */
-const toBase64Node = bytes => Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength).toString('base64');
-
-/* c8 ignore start */
-/**
- * @param {string} s
- * @return {Uint8Array}
- */
-const fromBase64Browser = s => {
-  // eslint-disable-next-line no-undef
-  const a = atob(s);
-  const bytes = createUint8ArrayFromLen(a.length);
-  for (let i = 0; i < a.length; i++) {
-    bytes[i] = a.charCodeAt(i);
-  }
-  return bytes
-};
-/* c8 ignore stop */
-
-/**
- * @param {string} s
- */
-const fromBase64Node = s => {
-  const buf = Buffer.from(s, 'base64');
-  return createUint8ArrayViewFromArrayBuffer(buf.buffer, buf.byteOffset, buf.byteLength)
-};
-
-/* c8 ignore next */
-const toBase64 = isBrowser ? toBase64Browser : toBase64Node;
-
-/* c8 ignore next */
-const fromBase64 = isBrowser ? fromBase64Browser : fromBase64Node;
-
-/* eslint-env browser */
-
-
-/**
- * @typedef {Object} Channel
- * @property {Set<function(any, any):any>} Channel.subs
- * @property {any} Channel.bc
- */
-
-/**
- * @type {Map<string, Channel>}
- */
-const channels = new Map();
-
-/* c8 ignore start */
-class LocalStoragePolyfill {
-  /**
-   * @param {string} room
-   */
-  constructor (room) {
-    this.room = room;
-    /**
-     * @type {null|function({data:ArrayBuffer}):void}
-     */
-    this.onmessage = null;
-    /**
-     * @param {any} e
-     */
-    this._onChange = e => e.key === room && this.onmessage !== null && this.onmessage({ data: fromBase64(e.newValue || '') });
-    onChange(this._onChange);
-  }
-
-  /**
-   * @param {ArrayBuffer} buf
-   */
-  postMessage (buf) {
-    varStorage.setItem(this.room, toBase64(createUint8ArrayFromArrayBuffer(buf)));
-  }
-
-  close () {
-    offChange(this._onChange);
-  }
-}
-/* c8 ignore stop */
-
-// Use BroadcastChannel or Polyfill
-/* c8 ignore next */
-const BC = typeof BroadcastChannel === 'undefined' ? LocalStoragePolyfill : BroadcastChannel;
-
-/**
- * @param {string} room
- * @return {Channel}
- */
-const getChannel = room =>
-  setIfUndefined(channels, room, () => {
-    const subs = create$2();
-    const bc = new BC(room);
-    /**
-     * @param {{data:ArrayBuffer}} e
-     */
-    /* c8 ignore next */
-    bc.onmessage = e => subs.forEach(sub => sub(e.data, 'broadcastchannel'));
-    return {
-      bc, subs
-    }
-  });
-
-/**
- * Publish data to all subscribers (including subscribers on this tab)
- *
- * @function
- * @param {string} room
- * @param {any} data
- * @param {any} [origin]
- */
-const publish = (room, data, origin = null) => {
-  const c = getChannel(room);
-  c.bc.postMessage(data);
-  c.subs.forEach(sub => sub(data, origin));
-};
-
 class MessageSender {
     constructor(Message, args = {}) {
         this.message = new Message();
@@ -2210,9 +1774,6 @@ class MessageSender {
     send(webSocket) {
         webSocket === null || webSocket === void 0 ? void 0 : webSocket.send(this.create());
     }
-    broadcast(channel) {
-        publish(channel, this.create());
-    }
 }
 
 class AuthenticationMessage extends OutgoingMessage {