@liveblocks/react 0.18.1 → 0.18.3-test1

package/{index.d.ts → dist/index.d.ts}

@@ -1,7 +1,7 @@
 import { ReactElement, ReactNode } from 'react';
 import { JsonObject, LsonObject, BaseUserMeta, LiveObject, User, Others, Json, Room, BroadcastOptions, History, Client } from '@liveblocks/client';
 export { Json, JsonObject, shallow } from '@liveblocks/client';
-import { ToImmutable, Resolve, RoomInitializers } from '@liveblocks/client/internal';
+import { ToImmutable, Resolve, RoomInitializers } from '@liveblocks/core';
 
 declare type Props = {
     fallback: NonNullable<ReactNode> | null;
@@ -32,6 +32,30 @@ declare type RoomProviderProps<TPresence extends JsonObject, TStorage extends Ls
      */
     id: string;
     children: React.ReactNode;
+    /**
+     * Whether or not the room should connect to Liveblocks servers
+     * when the RoomProvider is rendered.
+     *
+     * By default equals to `typeof window !== "undefined"`,
+     * meaning the RoomProvider tries to connect to Liveblocks servers
+     * only on the client side.
+     */
+    shouldInitiallyConnect?: boolean;
+    /**
+     * If you're on React 17 or lower, pass in a reference to
+     * `ReactDOM.unstable_batchedUpdates` or
+     * `ReactNative.unstable_batchedUpdates` here.
+     *
+     * @example
+     * import { unstable_batchedUpdates } from "react-dom";
+     *
+     * <RoomProvider ... unstable_batchedUpdates={unstable_batchedUpdates} />
+     *
+     * This will prevent you from running into the so-called "stale props"
+     * and/or "zombie child" problem that React 17 and lower can suffer from.
+     * Not necessary when you're on React v18 or later.
+     */
+    unstable_batchedUpdates?: (cb: () => void) => void;
 } & RoomInitializers<TPresence, TStorage>>;
 /**
  * For any function type, returns a similar function type, but without the
@@ -318,16 +342,6 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
      * );
      */
     useOthersMapped<T>(itemSelector: (other: User<TPresence, TUserMeta>) => T, itemIsEqual?: (prev: T, curr: T) => boolean): ReadonlyArray<readonly [connectionId: number, data: T]>;
-    /**
-     * Given a connection ID (as obtained by using `useOthersConnectionIds`), you can
-     * call this selector deep down in your component stack to only have the
-     * component re-render if properties for this particular user change.
-     *
-     * @example
-     * // Returns full user and re-renders whenever anything on the user changes
-     * const secondUser = useOther(2);
-     */
-    useOther(connectionId: number): User<TPresence, TUserMeta>;
     /**
      * Given a connection ID (as obtained by using `useOthersConnectionIds`), you
      * can call this selector deep down in your component stack to only have the
@@ -635,17 +649,6 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
          * );
          */
         useOthersMapped<T>(itemSelector: (other: User<TPresence, TUserMeta>) => T, itemIsEqual?: (prev: T, curr: T) => boolean): ReadonlyArray<readonly [connectionId: number, data: T]>;
-        /**
-         * Given a connection ID (as obtained by using `useOthersConnectionIds`),
-         * you can call this selector deep down in your component stack to only
-         * have the component re-render if properties for this particular user
-         * change.
-         *
-         * @example
-         * // Returns full user and re-renders whenever anything on the user changes
-         * const secondUser = useOther(2);
-         */
-        useOther(connectionId: number): User<TPresence, TUserMeta>;
         /**
          * Given a connection ID (as obtained by using `useOthersConnectionIds`),
          * you can call this selector deep down in your component stack to only

package/{index.js → dist/index.js}

@@ -12,7 +12,11 @@ function ClientSideSuspense(props) {
 
 // src/factory.tsx
 var _client = require('@liveblocks/client');
-var _internal = require('@liveblocks/client/internal');
+
+
+
+
+var _core = require('@liveblocks/core');
 
 var _withselector = require('use-sync-external-store/shim/with-selector');
 
@@ -33,10 +37,22 @@ function useInitial(value) {
 var noop = () => {
 };
 var identity = (x) => x;
-function useSyncExternalStore(s, g, gg) {
-  return _withselector.useSyncExternalStoreWithSelector.call(void 0, s, g, gg, identity);
+var missing_unstable_batchedUpdates = (reactVersion, roomId) => `We noticed you\u2019re using React ${reactVersion}. Please pass unstable_batchedUpdates at the RoomProvider level until you\u2019re ready to upgrade to React 18:
+
+    import { unstable_batchedUpdates } from "react-dom";  // or "react-native"
+
+    <RoomProvider id=${JSON.stringify(
+  roomId
+)} ... unstable_batchedUpdates={unstable_batchedUpdates}>
+      ...
+    </RoomProvider>
+
+Why? Please see https://liveblocks.io/docs/guides/troubleshooting#stale-props-zombie-child for more information`;
+var superfluous_unstable_batchedUpdates = "You don\u2019t need to pass unstable_batchedUpdates to RoomProvider anymore, since you\u2019re on React 18+ already.";
+function useSyncExternalStore(s, gs, gss) {
+  return _withselector.useSyncExternalStoreWithSelector.call(void 0, s, gs, gss, identity);
 }
-var EMPTY_OTHERS = _internal.asArrayWithLegacyMethods.call(void 0, []);
+var EMPTY_OTHERS = _core.asArrayWithLegacyMethods.call(void 0, []);
 function getEmptyOthers() {
   return EMPTY_OTHERS;
 }
@@ -70,7 +86,13 @@ function makeMutationContext(room) {
 function createRoomContext(client) {
   const RoomContext = React2.createContext(null);
   function RoomProvider(props) {
-    const { id: roomId, initialPresence, initialStorage } = props;
+    const {
+      id: roomId,
+      initialPresence,
+      initialStorage,
+      unstable_batchedUpdates,
+      shouldInitiallyConnect
+    } = props;
     if (process.env.NODE_ENV !== "production") {
       if (!roomId) {
         throw new Error(
@@ -80,16 +102,29 @@ function createRoomContext(client) {
       if (typeof roomId !== "string") {
         throw new Error("RoomProvider id property should be a string.");
       }
+      const majorReactVersion = parseInt(React2.version) || 1;
+      const oldReactVersion = majorReactVersion < 18;
+      _core.errorIf.call(void 0, 
+        oldReactVersion && props.unstable_batchedUpdates === void 0,
+        missing_unstable_batchedUpdates(majorReactVersion, roomId)
+      );
+      _core.deprecateIf.call(void 0, 
+        !oldReactVersion && props.unstable_batchedUpdates !== void 0,
+        superfluous_unstable_batchedUpdates
+      );
     }
     const frozen = useInitial({
       initialPresence,
-      initialStorage
+      initialStorage,
+      unstable_batchedUpdates,
+      shouldInitiallyConnect: shouldInitiallyConnect === void 0 ? typeof window !== "undefined" : shouldInitiallyConnect
     });
     const [room, setRoom] = React2.useState(
       () => client.enter(roomId, {
-        initialPresence,
-        initialStorage,
-        DO_NOT_USE_withoutConnecting: typeof window === "undefined"
+        initialPresence: frozen.initialPresence,
+        initialStorage: frozen.initialStorage,
+        unstable_batchedUpdates: frozen.unstable_batchedUpdates,
+        shouldInitiallyConnect: frozen.shouldInitiallyConnect
       })
     );
     React2.useEffect(() => {
@@ -97,7 +132,8 @@ function createRoomContext(client) {
         client.enter(roomId, {
           initialPresence: frozen.initialPresence,
           initialStorage: frozen.initialStorage,
-          DO_NOT_USE_withoutConnecting: typeof window === "undefined"
+          unstable_batchedUpdates: frozen.unstable_batchedUpdates,
+          withoutConnecting: frozen.shouldInitiallyConnect
         })
       );
       return () => {
@@ -164,50 +200,34 @@ function createRoomContext(client) {
     );
     return useOthers(wrappedSelector, wrappedIsEqual);
   }
-  const sentinel = Symbol();
+  const NOT_FOUND = Symbol();
   function useOther(connectionId, selector, isEqual) {
-    const _useCallback = React2.useCallback;
-    const _useOthers = useOthers;
-    if (selector === void 0) {
-      const selector2 = _useCallback(
-        (others) => others.find((other2) => other2.connectionId === connectionId),
-        [connectionId]
-      );
-      const other = _useOthers(selector2, _client.shallow);
-      if (other === void 0) {
-        throw new Error(
-          `No such other user with connection id ${connectionId} exists`
+    const wrappedSelector = React2.useCallback(
+      (others) => {
+        const other2 = others.find(
+          (other3) => other3.connectionId === connectionId
         );
-      }
-      return other;
-    } else {
-      const wrappedSelector = _useCallback(
-        (others) => {
-          const other2 = others.find(
-            (other3) => other3.connectionId === connectionId
-          );
-          return other2 !== void 0 ? selector(other2) : sentinel;
-        },
-        [connectionId, selector]
-      );
-      const wrappedIsEqual = _useCallback(
-        (prev, curr) => {
-          if (prev === sentinel || curr === sentinel) {
-            return prev === curr;
-          }
-          const eq = isEqual != null ? isEqual : Object.is;
-          return eq(prev, curr);
-        },
-        [isEqual]
+        return other2 !== void 0 ? selector(other2) : NOT_FOUND;
+      },
+      [connectionId, selector]
+    );
+    const wrappedIsEqual = React2.useCallback(
+      (prev, curr) => {
+        if (prev === NOT_FOUND || curr === NOT_FOUND) {
+          return prev === curr;
+        }
+        const eq = isEqual != null ? isEqual : Object.is;
+        return eq(prev, curr);
+      },
+      [isEqual]
+    );
+    const other = useOthers(wrappedSelector, wrappedIsEqual);
+    if (other === NOT_FOUND) {
+      throw new Error(
+        `No such other user with connection id ${connectionId} exists`
       );
-      const other = _useOthers(wrappedSelector, wrappedIsEqual);
-      if (other === sentinel) {
-        throw new Error(
-          `No such other user with connection id ${connectionId} exists`
-        );
-      }
-      return other;
     }
+    return other;
   }
   function useBroadcastEvent() {
     const room = useRoom();
@@ -443,11 +463,7 @@ function createRoomContext(client) {
   }
   function useOtherSuspense(connectionId, selector, isEqual) {
     useSuspendUntilPresenceLoaded();
-    return useOther(
-      connectionId,
-      selector,
-      isEqual
-    );
+    return useOther(connectionId, selector, isEqual);
   }
   function useLegacyKeySuspense(key) {
     useSuspendUntilStorageLoaded();

package/package.json

@@ -1,17 +1,14 @@
 {
   "name": "@liveblocks/react",
-  "version": "0.18.1",
+  "version": "0.18.3-test1",
   "description": "A set of React hooks and providers to use Liveblocks declaratively.",
-  "main": "./index.js",
-  "module": "./index.mjs",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./index.js",
-      "import": "./index.mjs",
-      "types": "./index.d.ts"
-    }
-  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**",
+    "README.md"
+  ],
   "keywords": [
     "react",
     "liveblocks",
@@ -22,14 +19,46 @@
   "bugs": {
     "url": "https://github.com/liveblocks/liveblocks/issues"
   },
+  "scripts": {
+    "build": "tsup && ../../scripts/build.sh",
+    "start": "tsup --watch",
+    "format": "eslint --fix src/ && prettier --write src/",
+    "lint": "eslint src/ && npm run check:exports",
+    "check:exports": "tsc scripts/check-factory-exports.ts && node scripts/check-factory-exports.js",
+    "test": "jest --watch --silent --verbose",
+    "test-ci": "jest --silent --verbose"
+  },
   "license": "Apache-2.0",
   "dependencies": {
-    "use-sync-external-store": "^1.2.0"
+    "use-sync-external-store": "^1.2.0",
+    "@liveblocks/core": "0.18.3-test1",
+    "@liveblocks/client": "0.18.3-test1"
   },
   "peerDependencies": {
-    "@liveblocks/client": "0.18.1",
     "react": "^16.14.0 || ^17 || ^18"
   },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.1.1",
+    "@types/jest": "^29.1.2",
+    "@types/use-sync-external-store": "^0.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
+    "eslint": "^8.12.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "jest": "^29.1.2",
+    "jest-environment-jsdom": "^29.1.2",
+    "msw": "^0.27.1",
+    "prettier": "^2.7.1",
+    "react-error-boundary": "^3.1.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.8.1",
+    "tsup": "^6.2.2",
+    "typescript": "^4.7.3",
+    "whatwg-fetch": "^3.6.2"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/liveblocks/liveblocks.git",

package/.built-by-link-script

@@ -1 +0,0 @@
-ab4dc80c03188cfbc87c124cad9c824347a785b0

package/LICENSE

@@ -1,201 +0,0 @@
-                                 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.