@liveblocks/client 0.17.5 → 0.17.8

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 LIVEBLOCKS PTY LTD
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -29,22 +29,22 @@ npm install @liveblocks/client
 
 ## Documentation
 
-- [Read the documentation](https://liveblocks.io/docs) to start using
-  Liveblocks.
-- Explore the
-  [API Reference](https://liveblocks.io/docs/api-reference/liveblocks-client).
+Read the [documentation](https://liveblocks.io/docs) for guides and API
+references.
 
 ## Examples
 
-- Browse our gallery of collaborative UI patterns.
-  [View examples gallery](https://liveblocks.io/examples)
-- Explore and clone any of our open-source examples.
-  [View code examples](https://github.com/liveblocks/liveblocks/tree/main/examples)
+Explore our [collaborative examples](https://liveblocks.io/examples) to help you
+get started.
+
+> All examples are open-source and live in this repository, within
+> [`/examples`](../../examples).
 
 ## Releases
 
-For changelog, visit
-[https://github.com/liveblocks/liveblocks/releases](https://github.com/liveblocks/liveblocks/releases).
+See the [latest changes](https://github.com/liveblocks/liveblocks/releases) or
+learn more about
+[upcoming releases](https://github.com/liveblocks/liveblocks/milestones).
 
 ## Community
 

package/index.js

@@ -161,7 +161,7 @@ function makeStateMachine(state, context, mockedEffects) {
           _state$pausedHistory,
           historyItem
         )
-      : state.undoStack.push(historyItem);
+      : (state.undoStack.push(historyItem), onHistoryChange());
   }
   function storageDispatch(ops, reverse, storageUpdates) {
     var _state$batch$ops, _state$batch$reverseO;
@@ -414,7 +414,7 @@ function makeStateMachine(state, context, mockedEffects) {
         var ws = WebSocketPolyfill || WebSocket;
         return function (token) {
           return new ws(
-            liveblocksServer + "/?token=" + token + "&version=0.17.5"
+            liveblocksServer + "/?token=" + token + "&version=0.17.8"
           );
         };
       })(
@@ -514,6 +514,18 @@ function makeStateMachine(state, context, mockedEffects) {
       (0, _step8.value)({ connectionId: message.actor, event: message.event });
     }
   }
+  function onHistoryChange() {
+    for (
+      var _step9,
+        _iterator9 = Json._createForOfIteratorHelperLoose(
+          state.listeners.history
+        );
+      !(_step9 = _iterator9()).done;
+
+    ) {
+      (0, _step9.value)({ canUndo: canUndo(), canRedo: canRedo() });
+    }
+  }
   function onUserJoinedMessage(message) {
     return (
       (state.users[message.actor] = {
@@ -552,13 +564,13 @@ function makeStateMachine(state, context, mockedEffects) {
             : Json.compact([parseServerMessage(data)]));
       if (null !== messages && 0 !== messages.length) {
         for (
-          var _step9,
+          var _step10,
             updates = { storageUpdates: new Map(), others: [] },
-            _iterator9 = Json._createForOfIteratorHelperLoose(messages);
-          !(_step9 = _iterator9()).done;
+            _iterator10 = Json._createForOfIteratorHelperLoose(messages);
+          !(_step10 = _iterator10()).done;
 
         ) {
-          var message = _step9.value;
+          var message = _step10.value;
           switch (message.type) {
             case Json.ServerMsgCode.USER_JOINED:
               updates.others.push(onUserJoinedMessage(message));
@@ -615,15 +627,15 @@ function makeStateMachine(state, context, mockedEffects) {
     ) {
       updateConnection({ state: "failed" });
       for (
-        var _step10,
+        var _step11,
           error = new LiveblocksError(event.reason, event.code),
-          _iterator10 = Json._createForOfIteratorHelperLoose(
+          _iterator11 = Json._createForOfIteratorHelperLoose(
             state.listeners.error
           );
-        !(_step10 = _iterator10()).done;
+        !(_step11 = _iterator11()).done;
 
       ) {
-        (0, _step10.value)(error);
+        (0, _step11.value)(error);
       }
       var _delay = getRetryDelay(!0);
       state.numberOfRetry++,
@@ -659,14 +671,14 @@ function makeStateMachine(state, context, mockedEffects) {
   function updateConnection(connection) {
     state.connection = connection;
     for (
-      var _step11,
-        _iterator11 = Json._createForOfIteratorHelperLoose(
+      var _step12,
+        _iterator12 = Json._createForOfIteratorHelperLoose(
           state.listeners.connection
         );
-      !(_step11 = _iterator11()).done;
+      !(_step12 = _iterator12()).done;
 
     ) {
-      (0, _step11.value)(connection.state);
+      (0, _step12.value)(connection.state);
     }
   }
   function getRetryDelay(slow) {
@@ -757,14 +769,14 @@ function makeStateMachine(state, context, mockedEffects) {
               data: state.buffer.presence,
             });
           for (
-            var _step12,
-              _iterator12 = Json._createForOfIteratorHelperLoose(
+            var _step13,
+              _iterator13 = Json._createForOfIteratorHelperLoose(
                 state.buffer.messages
               );
-            !(_step12 = _iterator12()).done;
+            !(_step13 = _iterator13()).done;
 
           ) {
-            var _event3 = _step12.value;
+            var _event3 = _step13.value;
             messages.push(_event3);
           }
           state.buffer.storageOperations.length > 0 &&
@@ -803,6 +815,12 @@ function makeStateMachine(state, context, mockedEffects) {
   }
   var _getInitialStatePromise = null,
     _getInitialStateResolver = null;
+  function canUndo() {
+    return state.undoStack.length > 0;
+  }
+  function canRedo() {
+    return state.redoStack.length > 0;
+  }
   return {
     onClose: onClose,
     onMessage: onMessage,
@@ -953,14 +971,16 @@ function makeStateMachine(state, context, mockedEffects) {
       if (null != historyItem) {
         state.isHistoryPaused = !1;
         var result = apply(historyItem, !0);
-        notify(result.updates), state.redoStack.push(result.reverse);
+        notify(result.updates),
+          state.redoStack.push(result.reverse),
+          onHistoryChange();
         for (
-          var _step13,
-            _iterator13 = Json._createForOfIteratorHelperLoose(historyItem);
-          !(_step13 = _iterator13()).done;
+          var _step14,
+            _iterator14 = Json._createForOfIteratorHelperLoose(historyItem);
+          !(_step14 = _iterator14()).done;
 
         ) {
-          var op = _step13.value;
+          var op = _step14.value;
           "presence" !== op.type && state.buffer.storageOperations.push(op);
         }
         tryFlushing();
@@ -973,19 +993,23 @@ function makeStateMachine(state, context, mockedEffects) {
       if (null != historyItem) {
         state.isHistoryPaused = !1;
         var result = apply(historyItem, !0);
-        notify(result.updates), state.undoStack.push(result.reverse);
+        notify(result.updates),
+          state.undoStack.push(result.reverse),
+          onHistoryChange();
         for (
-          var _step14,
-            _iterator14 = Json._createForOfIteratorHelperLoose(historyItem);
-          !(_step14 = _iterator14()).done;
+          var _step15,
+            _iterator15 = Json._createForOfIteratorHelperLoose(historyItem);
+          !(_step15 = _iterator15()).done;
 
         ) {
-          var op = _step14.value;
+          var op = _step15.value;
           "presence" !== op.type && state.buffer.storageOperations.push(op);
         }
         tryFlushing();
       }
     },
+    canUndo: canUndo,
+    canRedo: canRedo,
     pauseHistory: function () {
       (state.pausedHistory = []), (state.isHistoryPaused = !0);
     },
@@ -1058,6 +1082,7 @@ function createRoom(options, context) {
             error: [],
             connection: [],
             storage: [],
+            history: [],
           },
           numberOfRetry: 0,
           lastFlushTime: 0,
@@ -1113,6 +1138,8 @@ function createRoom(options, context) {
       history: {
         undo: machine.undo,
         redo: machine.redo,
+        canUndo: machine.canUndo,
+        canRedo: machine.canRedo,
         pause: machine.pauseHistory,
         resume: machine.resumeHistory,
       },

package/index.mjs

@@ -141,7 +141,7 @@ function makeStateMachine(state, context, mockedEffects) {
     state.undoStack.length >= 50 && state.undoStack.shift(),
       state.isHistoryPaused
         ? state.pausedHistory.unshift(...historyItem)
-        : state.undoStack.push(historyItem);
+        : (state.undoStack.push(historyItem), onHistoryChange());
   }
   function storageDispatch(ops, reverse, storageUpdates) {
     state.isBatching
@@ -337,7 +337,7 @@ function makeStateMachine(state, context, mockedEffects) {
           );
         const ws = WebSocketPolyfill || WebSocket;
         return (token) =>
-          new ws(`${liveblocksServer}/?token=${token}&version=0.17.5`);
+          new ws(`${liveblocksServer}/?token=${token}&version=0.17.8`);
       })(
         context.liveblocksServer,
         null !==
@@ -427,6 +427,10 @@ function makeStateMachine(state, context, mockedEffects) {
     for (const listener of state.listeners.event)
       listener({ connectionId: message.actor, event: message.event });
   }
+  function onHistoryChange() {
+    for (const listener of state.listeners.history)
+      listener({ canUndo: canUndo(), canRedo: canRedo() });
+  }
   function onUserJoinedMessage(message) {
     return (
       (state.users[message.actor] = {
@@ -655,6 +659,12 @@ function makeStateMachine(state, context, mockedEffects) {
   }
   let _getInitialStatePromise = null,
     _getInitialStateResolver = null;
+  function canUndo() {
+    return state.undoStack.length > 0;
+  }
+  function canRedo() {
+    return state.redoStack.length > 0;
+  }
   return {
     onClose: onClose,
     onMessage: onMessage,
@@ -795,7 +805,9 @@ function makeStateMachine(state, context, mockedEffects) {
       if (null == historyItem) return;
       state.isHistoryPaused = !1;
       const result = apply(historyItem, !0);
-      notify(result.updates), state.redoStack.push(result.reverse);
+      notify(result.updates),
+        state.redoStack.push(result.reverse),
+        onHistoryChange();
       for (const op of historyItem)
         "presence" !== op.type && state.buffer.storageOperations.push(op);
       tryFlushing();
@@ -807,11 +819,15 @@ function makeStateMachine(state, context, mockedEffects) {
       if (null == historyItem) return;
       state.isHistoryPaused = !1;
       const result = apply(historyItem, !0);
-      notify(result.updates), state.undoStack.push(result.reverse);
+      notify(result.updates),
+        state.undoStack.push(result.reverse),
+        onHistoryChange();
       for (const op of historyItem)
         "presence" !== op.type && state.buffer.storageOperations.push(op);
       tryFlushing();
     },
+    canUndo: canUndo,
+    canRedo: canRedo,
     pauseHistory: function () {
       (state.pausedHistory = []), (state.isHistoryPaused = !0);
     },
@@ -877,6 +893,7 @@ function createRoom(options, context) {
             error: [],
             connection: [],
             storage: [],
+            history: [],
           },
           numberOfRetry: 0,
           lastFlushTime: 0,
@@ -932,6 +949,8 @@ function createRoom(options, context) {
       history: {
         undo: machine.undo,
         redo: machine.redo,
+        canUndo: machine.canUndo,
+        canRedo: machine.canRedo,
         pause: machine.pauseHistory,
         resume: machine.resumeHistory,
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.17.5",
+  "version": "0.17.8",
   "description": "A client that lets you interact with Liveblocks servers.",
   "main": "./index.js",
   "module": "./index.mjs",
@@ -17,9 +17,6 @@
       "import": "./index.mjs"
     }
   },
-  "files": [
-    "**"
-  ],
   "keywords": [
     "liveblocks",
     "multiplayer",
@@ -29,47 +26,7 @@
   "bugs": {
     "url": "https://github.com/liveblocks/liveblocks/issues"
   },
-  "scripts": {
-    "build": "rollup -c && cp ./package.json ./README.md ./lib",
-    "format": "eslint --fix src/ test/ && prettier --write src/ test/",
-    "lint": "eslint src/ test/",
-    "test": "jest --watch --silent --verbose --config=./jest.config.js",
-    "test-ci": "jest --silent --verbose",
-    "test-e2e": "jest --silent --verbose --config=./jest.config.e2e.js"
-  },
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@babel/core": "^7.17.10",
-    "@babel/preset-env": "^7.17.10",
-    "@babel/preset-typescript": "^7.16.7",
-    "@rollup/plugin-babel": "^5.3.1",
-    "@rollup/plugin-node-resolve": "^13.1.3",
-    "@rollup/plugin-replace": "^4.0.0",
-    "@rollup/plugin-typescript": "^8.3.1",
-    "@types/jest": "^26.0.24",
-    "@types/node-fetch": "^2.6.1",
-    "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "dotenv": "^16.0.0",
-    "eslint": "^8.12.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "jest": "^28.0.3",
-    "jest-each": "^27.5.1",
-    "jest-environment-jsdom": "^28.1.0",
-    "msw": "^0.39.1",
-    "node-fetch": "2.6.7",
-    "regenerator-runtime": "^0.13.9",
-    "rollup": "^2.68.0",
-    "rollup-plugin-command": "^1.1.3",
-    "rollup-plugin-dts": "^4.2.2",
-    "rollup-plugin-prettier": "^2.2.2",
-    "rollup-plugin-terser": "^7.0.2",
-    "typescript": "^4.7.2",
-    "whatwg-fetch": "^3.6.2",
-    "ws": "^8.5.0"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/liveblocks/liveblocks.git",

package/shared.d.ts

@@ -312,6 +312,7 @@ declare type EventCallback<TRoomEvent extends Json> = ({
 }) => void;
 declare type ErrorCallback = (error: Error) => void;
 declare type ConnectionCallback = (state: ConnectionState) => void;
+declare type HistoryCallback = (event: HistoryEvent) => void;
 declare type UpdateDelta =
   | {
       type: "update";
@@ -604,6 +605,27 @@ interface History {
    * // room.getPresence() equals { selectedId: "yy" }
    */
   redo: () => void;
+  /**
+   * Returns whether there are any operations to undo.
+   *
+   * @example
+   * room.updatePresence({ selectedId: "xx" }, { addToHistory: true });
+   * // room.history.canUndo() is true
+   * room.history.undo();
+   * // room.history.canUndo() is false
+   */
+  canUndo: () => boolean;
+  /**
+   * Returns whether there are any operations to redo.
+   *
+   * @example
+   * room.updatePresence({ selectedId: "xx" }, { addToHistory: true });
+   * room.history.undo();
+   * // room.history.canRedo() is true
+   * room.history.redo();
+   * // room.history.canRedo() is false
+   */
+  canRedo: () => boolean;
   /**
    * All future modifications made on the Room will be merged together to create a single history item until resume is called.
    *
@@ -631,6 +653,10 @@ interface History {
    */
   resume: () => void;
 }
+interface HistoryEvent {
+  canUndo: boolean;
+  canRedo: boolean;
+}
 declare type Room<
   TPresence extends JsonObject,
   TStorage extends LsonObject,
@@ -648,6 +674,8 @@ declare type Room<
      *
      * @param listener the callback that is called every time the current user presence is updated with {@link Room.updatePresence}.
      *
+     * @returns Unsubscribe function.
+     *
      * @example
      * room.subscribe("my-presence", (presence) => {
      *   // Do something
@@ -659,6 +687,8 @@ declare type Room<
      *
      * @param listener the callback that is called when a user enters or leaves the room or when a user update its presence.
      *
+     * @returns Unsubscribe function.
+     *
      * @example
      * room.subscribe("others", (others) => {
      *   // Do something
@@ -673,6 +703,8 @@ declare type Room<
      *
      * @param listener the callback that is called when a user calls {@link Room.broadcastEvent}
      *
+     * @returns Unsubscribe function.
+     *
      * @example
      * room.subscribe("event", ({ event, connectionId }) => {
      *   // Do something
@@ -681,10 +713,14 @@ declare type Room<
     (type: "event", listener: EventCallback<TRoomEvent>): () => void;
     /**
      * Subscribe to errors thrown in the room.
+     *
+     * @returns Unsubscribe function.
      */
     (type: "error", listener: ErrorCallback): () => void;
     /**
      * Subscribe to connection state updates.
+     *
+     * @returns Unsubscribe function.
      */
     (type: "connection", listener: ConnectionCallback): () => void;
     /**
@@ -726,6 +762,17 @@ declare type Room<
         isDeep: true;
       }
     ): () => void;
+    /**
+     * Subscribe to the current user's history changes.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("history", ({ canUndo, canRedo }) => {
+     *   // Do something
+     * });
+     */
+    (type: "history", listener: HistoryCallback): () => void;
   };
   /**
    * Room's history contains functions that let you undo and redo operation made on by the current client on the presence and storage.

package/shared.js

@@ -571,6 +571,12 @@ function comparePosition(posA, posB) {
     'Impossible to compare similar position "' + posA + '" and "' + posB + '"'
   );
 }
+function compareNodePosition(itemA, itemB) {
+  return comparePosition(
+    itemA._getParentKeyOrThrow(),
+    itemB._getParentKeyOrThrow()
+  );
+}
 _Symbol$iterator$1 = Symbol.iterator;
 var LiveList = (function (_AbstractCrdt) {
   function LiveList(items) {
@@ -607,9 +613,7 @@ var LiveList = (function (_AbstractCrdt) {
           _id = _step$value[0],
           crdt = _step$value[1],
           child = deserialize([_id, crdt], parentToChildren, doc);
-        child._setParentLink(list, crdt.parentKey),
-          list._items.push(child),
-          sortListItem(list._items);
+        child._setParentLink(list, crdt.parentKey), list._insertAndSort(child);
       }
       return list;
     });
@@ -640,6 +644,12 @@ var LiveList = (function (_AbstractCrdt) {
       }
       return ops;
     }),
+    (_proto._insertAndSort = function (item) {
+      this._items.push(item), this._sortItems();
+    }),
+    (_proto._sortItems = function () {
+      this._items.sort(compareNodePosition);
+    }),
     (_proto._indexOfPosition = function (position) {
       return this._items.findIndex(function (item) {
         return item._getParentKeyOrThrow() === position;
@@ -700,8 +710,7 @@ var LiveList = (function (_AbstractCrdt) {
         _deleteDelta2 = this._detachItemAssociatedToSetOperation(op.deletedId);
       return (
         _deleteDelta2 && updates.push(_deleteDelta2),
-        this._items.push(child),
-        sortListItem(this._items),
+        this._insertAndSort(child),
         updates.push(insertDelta(this._indexOfPosition(key), child)),
         { reverse: [], modified: makeUpdate(this, updates) }
       );
@@ -737,8 +746,7 @@ var LiveList = (function (_AbstractCrdt) {
           this._items.splice(indexOfItemWithSamePosition, 1),
           delta.push(deleteDelta(indexOfItemWithSamePosition)));
         var previousIndex = this._items.indexOf(existingItem);
-        existingItem._setParentLink(this, op.parentKey),
-          sortListItem(this._items);
+        existingItem._setParentLink(this, op.parentKey), this._sortItems();
         var newIndex = this._items.indexOf(existingItem);
         return (
           newIndex !== previousIndex &&
@@ -750,8 +758,7 @@ var LiveList = (function (_AbstractCrdt) {
       if (orphan && this._implicitlyDeletedItems.has(orphan)) {
         orphan._setParentLink(this, op.parentKey),
           this._implicitlyDeletedItems.delete(orphan),
-          this._items.push(orphan),
-          sortListItem(this._items);
+          this._insertAndSort(orphan);
         var recreatedItemIndex = this._items.indexOf(orphan);
         return {
           modified: makeUpdate(
@@ -820,7 +827,7 @@ var LiveList = (function (_AbstractCrdt) {
         -1 !== itemIndexAtPosition &&
           this._shiftItemPosition(itemIndexAtPosition, key),
           existingItem._setParentLink(this, key),
-          sortListItem(this._items);
+          this._sortItems();
         var newIndex = this._indexOfPosition(key);
         return newIndex === oldPositionIndex
           ? { modified: !1 }
@@ -836,8 +843,7 @@ var LiveList = (function (_AbstractCrdt) {
         return (
           orphan._setParentLink(this, key),
           this._implicitlyDeletedItems.delete(orphan),
-          this._items.push(orphan),
-          sortListItem(this._items),
+          this._insertAndSort(orphan),
           {
             modified: makeUpdate(this, [
               insertDelta(this._indexOfPosition(key), orphan),
@@ -880,8 +886,7 @@ var LiveList = (function (_AbstractCrdt) {
         )),
         child._setParentLink(this, newKey));
       return (
-        this._items.push(child),
-        sortListItem(this._items),
+        this._insertAndSort(child),
         {
           modified: makeUpdate(this, [
             insertDelta(this._indexOfPosition(newKey), child),
@@ -916,8 +921,7 @@ var LiveList = (function (_AbstractCrdt) {
           { modified: makeUpdate(this, delta), reverse: reverse }
         );
       }
-      this._items.push(child),
-        sortListItem(this._items),
+      this._insertAndSort(child),
         this._detachItemAssociatedToSetOperation(op.deletedId);
       var newIndex = this._indexOfPosition(newKey);
       return {
@@ -961,8 +965,7 @@ var LiveList = (function (_AbstractCrdt) {
         return (
           this._implicitlyDeletedItems.delete(child),
           child._setParentLink(this, newKey),
-          this._items.push(child),
-          sortListItem(this._items),
+          this._insertAndSort(child),
           {
             modified: makeUpdate(this, [
               insertDelta(this._items.indexOf(child), child),
@@ -975,7 +978,7 @@ var LiveList = (function (_AbstractCrdt) {
         existingItemIndex = this._indexOfPosition(newKey);
       if (-1 === existingItemIndex) {
         var previousIndex = this._items.indexOf(child);
-        child._setParentLink(this, newKey), sortListItem(this._items);
+        child._setParentLink(this, newKey), this._sortItems();
         var _newIndex4 = this._items.indexOf(child);
         return _newIndex4 === previousIndex
           ? { modified: !1 }
@@ -996,7 +999,7 @@ var LiveList = (function (_AbstractCrdt) {
         )
       );
       var _previousIndex = this._items.indexOf(child);
-      child._setParentLink(this, newKey), sortListItem(this._items);
+      child._setParentLink(this, newKey), this._sortItems();
       var _newIndex5 = this._items.indexOf(child);
       return _newIndex5 === _previousIndex
         ? { modified: !1 }
@@ -1026,8 +1029,7 @@ var LiveList = (function (_AbstractCrdt) {
           );
         return (
           child._setParentLink(this, newKey),
-          this._items.push(child),
-          sortListItem(this._items),
+          this._insertAndSort(child),
           { modified: !1 }
         );
       }
@@ -1046,7 +1048,7 @@ var LiveList = (function (_AbstractCrdt) {
           )
         ),
         child._setParentLink(this, newKey),
-        sortListItem(this._items);
+        this._sortItems();
       var newIndex = this._items.indexOf(child);
       return previousIndex === newIndex
         ? { modified: !1 }
@@ -1072,7 +1074,7 @@ var LiveList = (function (_AbstractCrdt) {
               : _this$_items4._getParentKeyOrThrow()
           )
         );
-      child._setParentLink(this, newKey), sortListItem(this._items);
+      child._setParentLink(this, newKey), this._sortItems();
       var newIndex = this._items.indexOf(child);
       return previousIndex === newIndex
         ? { modified: !1 }
@@ -1130,8 +1132,7 @@ var LiveList = (function (_AbstractCrdt) {
         value = lsonToLiveNode(element);
       if (
         (value._setParentLink(this, position),
-        this._items.push(value),
-        sortListItem(this._items),
+        this._insertAndSort(value),
         this._doc && this._id)
       ) {
         var id = this._doc.generateId();
@@ -1172,7 +1173,7 @@ var LiveList = (function (_AbstractCrdt) {
         previousPosition = item._getParentKeyOrThrow();
       if (
         (item._setParentLink(this, position),
-        sortListItem(this._items),
+        this._sortItems(),
         this._doc && this._id)
       ) {
         var storageUpdates = new Map([
@@ -1349,8 +1350,7 @@ var LiveList = (function (_AbstractCrdt) {
       return (
         newItem._attach(op.id, nn(this._doc)),
         newItem._setParentLink(this, key),
-        this._items.push(newItem),
-        sortListItem(this._items),
+        this._insertAndSort(newItem),
         { newItem: newItem, newIndex: this._indexOfPosition(key) }
       );
     }),
@@ -1426,14 +1426,6 @@ function moveDelta(previousIndex, index, item) {
     item: item instanceof LiveRegister ? item.data : item,
   };
 }
-function sortListItem(items) {
-  items.sort(function (itemA, itemB) {
-    return comparePosition(
-      itemA._getParentKeyOrThrow(),
-      itemB._getParentKeyOrThrow()
-    );
-  });
-}
 function addIntentAndDeletedIdToOperation(ops, deletedId) {
   if (0 === ops.length)
     throw new Error(
@@ -2573,7 +2565,8 @@ function isJsonArray(data) {
       "others" === value ||
       "event" === value ||
       "error" === value ||
-      "connection" === value
+      "connection" === value ||
+      "history" === value
     );
   }),
   (exports.isRootCrdt = function (crdt) {

package/shared.mjs

@@ -66,7 +66,8 @@ function isRoomEventName(value) {
     "others" === value ||
     "event" === value ||
     "error" === value ||
-    "connection" === value
+    "connection" === value ||
+    "history" === value
   );
 }
 function HasParent(node, key) {
@@ -363,6 +364,12 @@ function comparePosition(posA, posB) {
     `Impossible to compare similar position "${posA}" and "${posB}"`
   );
 }
+function compareNodePosition(itemA, itemB) {
+  return comparePosition(
+    itemA._getParentKeyOrThrow(),
+    itemB._getParentKeyOrThrow()
+  );
+}
 class LiveList extends AbstractCrdt {
   constructor(items = []) {
     let position;
@@ -385,9 +392,7 @@ class LiveList extends AbstractCrdt {
     if (null == children) return list;
     for (const [id, crdt] of children) {
       const child = deserialize([id, crdt], parentToChildren, doc);
-      child._setParentLink(list, crdt.parentKey),
-        list._items.push(child),
-        sortListItem(list._items);
+      child._setParentLink(list, crdt.parentKey), list._insertAndSort(child);
     }
     return list;
   }
@@ -407,6 +412,12 @@ class LiveList extends AbstractCrdt {
       ops.push(...item._serialize(this._id, item._getParentKeyOrThrow(), doc));
     return ops;
   }
+  _insertAndSort(item) {
+    this._items.push(item), this._sortItems();
+  }
+  _sortItems() {
+    this._items.sort(compareNodePosition);
+  }
   _indexOfPosition(position) {
     return this._items.findIndex(
       (item) => item._getParentKeyOrThrow() === position
@@ -457,8 +468,7 @@ class LiveList extends AbstractCrdt {
         deleteDelta = this._detachItemAssociatedToSetOperation(op.deletedId);
       return (
         deleteDelta && updates.push(deleteDelta),
-        this._items.push(child),
-        sortListItem(this._items),
+        this._insertAndSort(child),
         updates.push(insertDelta(this._indexOfPosition(key), child)),
         { reverse: [], modified: makeUpdate(this, updates) }
       );
@@ -493,8 +503,7 @@ class LiveList extends AbstractCrdt {
         this._items.splice(indexOfItemWithSamePosition, 1),
         delta.push(deleteDelta(indexOfItemWithSamePosition)));
       const previousIndex = this._items.indexOf(existingItem);
-      existingItem._setParentLink(this, op.parentKey),
-        sortListItem(this._items);
+      existingItem._setParentLink(this, op.parentKey), this._sortItems();
       const newIndex = this._items.indexOf(existingItem);
       return (
         newIndex !== previousIndex &&
@@ -507,8 +516,7 @@ class LiveList extends AbstractCrdt {
       if (orphan && this._implicitlyDeletedItems.has(orphan)) {
         orphan._setParentLink(this, op.parentKey),
           this._implicitlyDeletedItems.delete(orphan),
-          this._items.push(orphan),
-          sortListItem(this._items);
+          this._insertAndSort(orphan);
         const recreatedItemIndex = this._items.indexOf(orphan);
         return {
           modified: makeUpdate(this, [
@@ -568,7 +576,7 @@ class LiveList extends AbstractCrdt {
         -1 !== itemIndexAtPosition &&
           this._shiftItemPosition(itemIndexAtPosition, key),
           existingItem._setParentLink(this, key),
-          sortListItem(this._items);
+          this._sortItems();
         const newIndex = this._indexOfPosition(key);
         return newIndex === oldPositionIndex
           ? { modified: !1 }
@@ -585,8 +593,7 @@ class LiveList extends AbstractCrdt {
       if (orphan && this._implicitlyDeletedItems.has(orphan)) {
         orphan._setParentLink(this, key),
           this._implicitlyDeletedItems.delete(orphan),
-          this._items.push(orphan),
-          sortListItem(this._items);
+          this._insertAndSort(orphan);
         return {
           modified: makeUpdate(this, [
             insertDelta(this._indexOfPosition(key), orphan),
@@ -629,7 +636,7 @@ class LiveList extends AbstractCrdt {
       )),
         child._setParentLink(this, newKey);
     }
-    this._items.push(child), sortListItem(this._items);
+    this._insertAndSort(child);
     return {
       modified: makeUpdate(this, [
         insertDelta(this._indexOfPosition(newKey), child),
@@ -663,8 +670,7 @@ class LiveList extends AbstractCrdt {
       );
     }
     {
-      this._items.push(child),
-        sortListItem(this._items),
+      this._insertAndSort(child),
         this._detachItemAssociatedToSetOperation(op.deletedId);
       const newIndex = this._indexOfPosition(newKey);
       return {
@@ -709,8 +715,7 @@ class LiveList extends AbstractCrdt {
     if (this._implicitlyDeletedItems.has(child)) {
       this._implicitlyDeletedItems.delete(child),
         child._setParentLink(this, newKey),
-        this._items.push(child),
-        sortListItem(this._items);
+        this._insertAndSort(child);
       return {
         modified: makeUpdate(this, [
           insertDelta(this._items.indexOf(child), child),
@@ -722,7 +727,7 @@ class LiveList extends AbstractCrdt {
     const existingItemIndex = this._indexOfPosition(newKey);
     if (-1 === existingItemIndex) {
       const previousIndex = this._items.indexOf(child);
-      child._setParentLink(this, newKey), sortListItem(this._items);
+      child._setParentLink(this, newKey), this._sortItems();
       const newIndex = this._items.indexOf(child);
       return newIndex === previousIndex
         ? { modified: !1 }
@@ -744,7 +749,7 @@ class LiveList extends AbstractCrdt {
         )
       );
       const previousIndex = this._items.indexOf(child);
-      child._setParentLink(this, newKey), sortListItem(this._items);
+      child._setParentLink(this, newKey), this._sortItems();
       const newIndex = this._items.indexOf(child);
       return newIndex === previousIndex
         ? { modified: !1 }
@@ -775,8 +780,7 @@ class LiveList extends AbstractCrdt {
             )
           ),
         child._setParentLink(this, newKey),
-        this._items.push(child),
-        sortListItem(this._items),
+        this._insertAndSort(child),
         { modified: !1 }
       );
     }
@@ -795,7 +799,7 @@ class LiveList extends AbstractCrdt {
           )
         ),
         child._setParentLink(this, newKey),
-        sortListItem(this._items);
+        this._sortItems();
       const newIndex = this._items.indexOf(child);
       return previousIndex === newIndex
         ? { modified: !1 }
@@ -823,7 +827,7 @@ class LiveList extends AbstractCrdt {
         )
       ),
       child._setParentLink(this, newKey),
-      sortListItem(this._items);
+      this._sortItems();
     const newIndex = this._items.indexOf(child);
     return previousIndex === newIndex
       ? { modified: !1 }
@@ -879,8 +883,7 @@ class LiveList extends AbstractCrdt {
       value = lsonToLiveNode(element);
     if (
       (value._setParentLink(this, position),
-      this._items.push(value),
-      sortListItem(this._items),
+      this._insertAndSort(value),
       this._doc && this._id)
     ) {
       const id = this._doc.generateId();
@@ -919,7 +922,7 @@ class LiveList extends AbstractCrdt {
       previousPosition = item._getParentKeyOrThrow();
     if (
       (item._setParentLink(this, position),
-      sortListItem(this._items),
+      this._sortItems(),
       this._doc && this._id)
     ) {
       const storageUpdates = new Map([
@@ -1073,8 +1076,7 @@ class LiveList extends AbstractCrdt {
     const newItem = creationOpToLiveNode(op);
     newItem._attach(op.id, nn(this._doc)),
       newItem._setParentLink(this, key),
-      this._items.push(newItem),
-      sortListItem(this._items);
+      this._insertAndSort(newItem);
     return { newItem: newItem, newIndex: this._indexOfPosition(key) };
   }
   _shiftItemPosition(index, key) {
@@ -1131,11 +1133,6 @@ function moveDelta(previousIndex, index, item) {
     item: item instanceof LiveRegister ? item.data : item,
   };
 }
-function sortListItem(items) {
-  items.sort((itemA, itemB) =>
-    comparePosition(itemA._getParentKeyOrThrow(), itemB._getParentKeyOrThrow())
-  );
-}
 function addIntentAndDeletedIdToOperation(ops, deletedId) {
   if (0 === ops.length)
     throw new Error(