@liveblocks/client 0.17.0-test1 → 0.17.1

package/README.md

@@ -18,7 +18,8 @@
   </a>
 </p>
 
-A client that lets you interact with [Liveblocks](https://liveblocks.io) servers.
+A client that lets you interact with [Liveblocks](https://liveblocks.io)
+servers.
 
 ## Installation
 
@@ -28,25 +29,33 @@ 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) to start using
+  Liveblocks.
+- Explore the
+  [API Reference](https://liveblocks.io/docs/api-reference/liveblocks-client).
 
 ## 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)
+- 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)
 
 ## Releases
 
-For changelog, visit [https://github.com/liveblocks/liveblocks/releases](https://github.com/liveblocks/liveblocks/releases).
+For changelog, visit
+[https://github.com/liveblocks/liveblocks/releases](https://github.com/liveblocks/liveblocks/releases).
 
 ## Community
 
-- [Discord](https://discord.gg/X4YWJuH9VY) - To get involved with the Liveblocks community, ask questions and share tips.
-- [Twitter](https://twitter.com/liveblocks) - To receive updates, announcements, blog posts, and general Liveblocks tips.
+- [Discord](https://discord.gg/X4YWJuH9VY) - To get involved with the Liveblocks
+  community, ask questions and share tips.
+- [Twitter](https://twitter.com/liveblocks) - To receive updates, announcements,
+  blog posts, and general Liveblocks tips.
 
 ## License
 
-Licensed under the Apache License 2.0, Copyright © 2021-present [Liveblocks](https://liveblocks.io).
+Licensed under the Apache License 2.0, Copyright © 2021-present
+[Liveblocks](https://liveblocks.io).
 
 See [LICENSE](../../LICENSE) for more information.

package/index.d.ts

@@ -1,16 +1,17 @@
 import { C as ClientOptions, a as Client } from "./shared.js";
 export {
-  B as BroadcastOptions,
+  B as BaseUserMeta,
+  d as BroadcastOptions,
   a as Client,
   H as History,
   J as Json,
-  d as JsonObject,
+  e as JsonObject,
   L as LiveList,
   b as LiveMap,
   c as LiveObject,
-  e as LiveStructure,
-  f as Lson,
-  g as LsonObject,
+  f as LiveStructure,
+  g as Lson,
+  h as LsonObject,
   O as Others,
   P as Presence,
   R as Room,
@@ -39,7 +40,7 @@ export {
  *       body: JSON.stringify({ room })
  *     });
  *
- *     return await response.json();
+ *     return await response.json(); // should be: { token: "..." }
  *   }
  * });
  */

package/index.js

@@ -348,6 +348,10 @@ function makeStateMachine(state, context, mockedEffects) {
     }
   }
   function connect() {
+    var _context$polyfills$fe,
+      _context$polyfills,
+      _context$polyfills$We,
+      _context$polyfills2;
     if (
       "closed" !== state.connection.state &&
       "unavailable" !== state.connection.state
@@ -380,9 +384,28 @@ function makeStateMachine(state, context, mockedEffects) {
             );
           };
         }
-        if ("custom" === authentication.type) return authentication.callback;
+        if ("custom" === authentication.type) {
+          return function (room) {
+            return authentication.callback(room).then(function (response) {
+              if (!response || !response.token)
+                throw new Error(
+                  'Authentication error. We expect the authentication callback to return a token, but it does not. Hint: the return value should look like: { token: "..." }'
+                );
+              return response;
+            });
+          };
+        }
         throw new Error("Internal error. Unexpected authentication type");
-      })(context.authentication, context.fetchPolyfill),
+      })(
+        context.authentication,
+        null !=
+          (_context$polyfills$fe =
+            null == (_context$polyfills = context.polyfills)
+              ? void 0
+              : _context$polyfills.fetch)
+          ? _context$polyfills$fe
+          : context.fetchPolyfill
+      ),
       createWebSocket = (function (liveblocksServer, WebSocketPolyfill) {
         if ("undefined" == typeof window && null == WebSocketPolyfill)
           throw new Error(
@@ -390,9 +413,20 @@ function makeStateMachine(state, context, mockedEffects) {
           );
         var ws = WebSocketPolyfill || WebSocket;
         return function (token) {
-          return new ws(liveblocksServer + "/?token=" + token);
+          return new ws(
+            liveblocksServer + "/?token=" + token + "&version=0.17.1"
+          );
         };
-      })(context.liveblocksServer, context.WebSocketPolyfill);
+      })(
+        context.liveblocksServer,
+        null !=
+          (_context$polyfills$We =
+            null == (_context$polyfills2 = context.polyfills)
+              ? void 0
+              : _context$polyfills2.WebSocket)
+          ? _context$polyfills$We
+          : context.WebSocketPolyfill
+      );
     updateConnection({ state: "authenticating" }),
       effects.authenticate(auth, createWebSocket);
   }
@@ -429,6 +463,8 @@ function makeStateMachine(state, context, mockedEffects) {
             ? {
                 connectionId: message.actor,
                 presence: message.data,
+                id: void 0,
+                info: void 0,
                 _hasReceivedInitialPresence: !0,
               }
             : {
@@ -812,46 +848,46 @@ function makeStateMachine(state, context, mockedEffects) {
           for (var _key6 in state.listeners) state.listeners[_key6] = [];
         })();
     },
-    subscribe: function (firstParam, listener, options) {
-      if (Json.isLiveNode(firstParam))
-        return (function (liveValue, innerCallback, options) {
-          return genericSubscribe(function (updates) {
-            for (
-              var _step,
-                relatedUpdates = [],
-                _iterator = Json._createForOfIteratorHelperLoose(updates);
-              !(_step = _iterator()).done;
+    subscribe: function (first, second, options) {
+      if (void 0 === second || "function" == typeof first) {
+        if ("function" == typeof first) return genericSubscribe(first);
+        throw new Error("Please specify a listener callback");
+      }
+      if (Json.isLiveNode(first)) {
+        var _node = first;
+        return null != options && options.isDeep
+          ? ((node = _node),
+            (callback = second),
+            genericSubscribe(function (updates) {
+              var relatedUpdates = updates.filter(function (update) {
+                return Json.isSameNodeOrChildOf(update.node, node);
+              });
+              relatedUpdates.length > 0 && callback(relatedUpdates);
+            }))
+          : (function (node, callback) {
+              return genericSubscribe(function (updates) {
+                for (
+                  var _step,
+                    _iterator = Json._createForOfIteratorHelperLoose(updates);
+                  !(_step = _iterator()).done;
 
-            ) {
-              var update = _step.value;
-              null != options &&
-              options.isDeep &&
-              Json.isSameNodeOrChildOf(update.node, liveValue)
-                ? relatedUpdates.push(update)
-                : update.node._id === liveValue._id &&
-                  innerCallback(update.node);
-            }
-            null != options &&
-              options.isDeep &&
-              relatedUpdates.length > 0 &&
-              innerCallback(relatedUpdates);
-          });
-        })(firstParam, listener, options);
-      if ("function" == typeof firstParam) return genericSubscribe(firstParam);
-      if (
-        "my-presence" !== (value = firstParam) &&
-        "others" !== value &&
-        "event" !== value &&
-        "error" !== value &&
-        "connection" !== value
-      )
-        throw new Error('"' + firstParam + '" is not a valid event name');
-      var value;
+                ) {
+                  var update = _step.value;
+                  update.node._id === node._id && callback(update.node);
+                }
+              });
+            })(_node, second);
+      }
+      var node, callback;
+      if (!Json.isRoomEventName(first))
+        throw new Error('"' + first + '" is not a valid event name');
+      var eventName = first,
+        eventListener = second;
       return (
-        state.listeners[firstParam].push(listener),
+        state.listeners[eventName].push(eventListener),
         function () {
-          var callbacks = state.listeners[firstParam];
-          Json.remove(callbacks, listener);
+          var callbacks = state.listeners[eventName];
+          Json.remove(callbacks, eventListener);
         }
       );
     },
@@ -1141,18 +1177,37 @@ var AuthenticationError = (function (_Error2) {
   return Json._inheritsLoose(AuthenticationError, _Error2), AuthenticationError;
 })(Json._wrapNativeSuper(Error));
 function prepareAuthentication(clientOptions) {
-  if ("string" == typeof clientOptions.publicApiKey)
+  var publicApiKey = clientOptions.publicApiKey,
+    authEndpoint = clientOptions.authEndpoint;
+  if (void 0 !== authEndpoint && void 0 !== publicApiKey)
+    throw new Error(
+      "You cannot use both publicApiKey and authEndpoint. Please use either publicApiKey or authEndpoint, but not both. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClient"
+    );
+  if ("string" == typeof publicApiKey) {
+    if (publicApiKey.startsWith("sk_"))
+      throw new Error(
+        "Invalid publicApiKey. You are using the secret key which is not supported. Please use the public key instead. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientPublicKey"
+      );
+    if (!publicApiKey.startsWith("pk_"))
+      throw new Error(
+        "Invalid key. Please use the public key format: pk_<public key>. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientPublicKey"
+      );
     return {
       type: "public",
-      publicApiKey: clientOptions.publicApiKey,
+      publicApiKey: publicApiKey,
       url:
         clientOptions.publicAuthorizeEndpoint ||
         "https://liveblocks.io/api/public/authorize",
     };
-  if ("string" == typeof clientOptions.authEndpoint)
-    return { type: "private", url: clientOptions.authEndpoint };
-  if ("function" == typeof clientOptions.authEndpoint)
-    return { type: "custom", callback: clientOptions.authEndpoint };
+  }
+  if ("string" == typeof authEndpoint)
+    return { type: "private", url: authEndpoint };
+  if ("function" == typeof authEndpoint)
+    return { type: "custom", callback: authEndpoint };
+  if (void 0 !== authEndpoint)
+    throw new Error(
+      "authEndpoint must be a string or a function. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientAuthEndpoint"
+    );
   throw new Error(
     "Invalid Liveblocks client options. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClient"
   );
@@ -1224,6 +1279,7 @@ function prepareAuthentication(clientOptions) {
               {
                 roomId: roomId,
                 throttleDelay: throttleDelay,
+                polyfills: clientOptions.polyfills,
                 WebSocketPolyfill: clientOptions.WebSocketPolyfill,
                 fetchPolyfill: clientOptions.fetchPolyfill,
                 liveblocksServer:
@@ -1238,11 +1294,17 @@ function prepareAuthentication(clientOptions) {
             !options.DO_NOT_USE_withoutConnecting)
           ) {
             if ("undefined" == typeof atob) {
-              if (null == clientOptions.atobPolyfill)
+              var _clientOptions$polyfi;
+              if (
+                null ==
+                (null == (_clientOptions$polyfi = clientOptions.polyfills)
+                  ? void 0
+                  : _clientOptions$polyfi.atob)
+              )
                 throw new Error(
                   "You need to polyfill atob to use the client in your environment. Please follow the instructions at https://liveblocks.io/docs/errors/liveblocks-client/atob-polyfill"
                 );
-              global.atob = clientOptions.atobPolyfill;
+              global.atob = clientOptions.polyfills.atob;
             }
             internalRoom.connect();
           }

package/index.mjs

@@ -1,29 +1,30 @@
 import {
   _ as __rest,
-  i as isLiveNode,
   r as remove,
+  i as isLiveNode,
+  a as isRoomEventName,
   S as ServerMsgCode,
   m as mergeStorageUpdates,
   W as WebsocketCloseCodes,
   C as ClientMsgCode,
   n as nn,
-  a as isPlainObject,
+  b as isPlainObject,
   p as parseRoomAuthToken,
-  b as isTokenExpired,
-  c as isSameNodeOrChildOf,
+  c as isTokenExpired,
+  d as isSameNodeOrChildOf,
   L as LiveObject,
   g as getTreesDiffOperations,
   O as OpSource,
-  d as OpCode,
-  e as isLiveList,
+  e as OpCode,
+  f as isLiveList,
   t as tryParseJson,
-  f as isJsonArray,
-  h as compact,
-  j as isRootCrdt,
-  k as isJsonObject,
-  l as errorIf,
+  h as isJsonArray,
+  j as compact,
+  k as isRootCrdt,
+  l as isJsonObject,
+  o as errorIf,
 } from "./shared.mjs";
-export { o as LiveList, q as LiveMap, L as LiveObject } from "./shared.mjs";
+export { q as LiveList, s as LiveMap, L as LiveObject } from "./shared.mjs";
 const BACKOFF_RETRY_DELAYS = [250, 500, 1e3, 2e3, 4e3, 8e3, 1e4],
   BACKOFF_RETRY_DELAYS_SLOW = [2e3, 3e4, 6e4, 3e5];
 function makeOthers(userMap) {
@@ -280,6 +281,7 @@ function makeStateMachine(state, context, mockedEffects) {
     }
   }
   function connect() {
+    var _a, _b, _c, _d;
     if (
       "closed" !== state.connection.state &&
       "unavailable" !== state.connection.state
@@ -307,17 +309,45 @@ function makeStateMachine(state, context, mockedEffects) {
               room: room,
             });
         }
-        if ("custom" === authentication.type) return authentication.callback;
+        if ("custom" === authentication.type) {
+          return (room) =>
+            authentication.callback(room).then((response) => {
+              if (!response || !response.token)
+                throw new Error(
+                  'Authentication error. We expect the authentication callback to return a token, but it does not. Hint: the return value should look like: { token: "..." }'
+                );
+              return response;
+            });
+        }
         throw new Error("Internal error. Unexpected authentication type");
-      })(context.authentication, context.fetchPolyfill),
+      })(
+        context.authentication,
+        null !==
+          (_b =
+            null === (_a = context.polyfills) || void 0 === _a
+              ? void 0
+              : _a.fetch) && void 0 !== _b
+          ? _b
+          : context.fetchPolyfill
+      ),
       createWebSocket = (function (liveblocksServer, WebSocketPolyfill) {
         if ("undefined" == typeof window && null == WebSocketPolyfill)
           throw new Error(
             "To use Liveblocks client in a non-dom environment, you need to provide a WebSocket polyfill."
           );
         const ws = WebSocketPolyfill || WebSocket;
-        return (token) => new ws(`${liveblocksServer}/?token=${token}`);
-      })(context.liveblocksServer, context.WebSocketPolyfill);
+        return (token) =>
+          new ws(`${liveblocksServer}/?token=${token}&version=0.17.1`);
+      })(
+        context.liveblocksServer,
+        null !==
+          (_d =
+            null === (_c = context.polyfills) || void 0 === _c
+              ? void 0
+              : _c.WebSocket) && void 0 !== _d
+          ? _d
+          : context.WebSocketPolyfill
+      );
     updateConnection({ state: "authenticating" }),
       effects.authenticate(auth, createWebSocket);
   }
@@ -351,6 +381,8 @@ function makeStateMachine(state, context, mockedEffects) {
             ? {
                 connectionId: message.actor,
                 presence: message.data,
+                id: void 0,
+                info: void 0,
                 _hasReceivedInitialPresence: !0,
               }
             : {
@@ -664,37 +696,41 @@ function makeStateMachine(state, context, mockedEffects) {
           for (const key in state.listeners) state.listeners[key] = [];
         })();
     },
-    subscribe: function (firstParam, listener, options) {
-      if (isLiveNode(firstParam))
-        return (function (liveValue, innerCallback, options) {
+    subscribe: function (first, second, options) {
+      if (void 0 === second || "function" == typeof first) {
+        if ("function" == typeof first) {
+          return genericSubscribe(first);
+        }
+        throw new Error("Please specify a listener callback");
+      }
+      if (isLiveNode(first)) {
+        const node = first;
+        if (null == options ? void 0 : options.isDeep) {
+          return (function (node, callback) {
+            return genericSubscribe((updates) => {
+              const relatedUpdates = updates.filter((update) =>
+                isSameNodeOrChildOf(update.node, node)
+              );
+              relatedUpdates.length > 0 && callback(relatedUpdates);
+            });
+          })(node, second);
+        }
+        return (function (node, callback) {
           return genericSubscribe((updates) => {
-            const relatedUpdates = [];
             for (const update of updates)
-              (null == options ? void 0 : options.isDeep) &&
-              isSameNodeOrChildOf(update.node, liveValue)
-                ? relatedUpdates.push(update)
-                : update.node._id === liveValue._id &&
-                  innerCallback(update.node);
-            (null == options ? void 0 : options.isDeep) &&
-              relatedUpdates.length > 0 &&
-              innerCallback(relatedUpdates);
+              update.node._id === node._id && callback(update.node);
           });
-        })(firstParam, listener, options);
-      if ("function" == typeof firstParam) return genericSubscribe(firstParam);
-      if (
-        "my-presence" !== (value = firstParam) &&
-        "others" !== value &&
-        "event" !== value &&
-        "error" !== value &&
-        "connection" !== value
-      )
-        throw new Error(`"${firstParam}" is not a valid event name`);
-      var value;
+        })(node, second);
+      }
+      if (!isRoomEventName(first))
+        throw new Error(`"${first}" is not a valid event name`);
+      const eventName = first,
+        eventListener = second;
       return (
-        state.listeners[firstParam].push(listener),
+        state.listeners[eventName].push(eventListener),
         () => {
-          const callbacks = state.listeners[firstParam];
-          remove(callbacks, listener);
+          const callbacks = state.listeners[eventName];
+          remove(callbacks, eventListener);
         }
       );
     },
@@ -980,6 +1016,7 @@ function createClient(options) {
         return internalRoom ? internalRoom.room : null;
       },
       enter: function (roomId, options = {}) {
+        var _a;
         let internalRoom = rooms.get(roomId);
         if (internalRoom) return internalRoom.room;
         if (
@@ -1001,6 +1038,7 @@ function createClient(options) {
             {
               roomId: roomId,
               throttleDelay: throttleDelay,
+              polyfills: clientOptions.polyfills,
               WebSocketPolyfill: clientOptions.WebSocketPolyfill,
               fetchPolyfill: clientOptions.fetchPolyfill,
               liveblocksServer:
@@ -1015,11 +1053,16 @@ function createClient(options) {
           !options.DO_NOT_USE_withoutConnecting)
         ) {
           if ("undefined" == typeof atob) {
-            if (null == clientOptions.atobPolyfill)
+            if (
+              null ==
+              (null === (_a = clientOptions.polyfills) || void 0 === _a
+                ? void 0
+                : _a.atob)
+            )
               throw new Error(
                 "You need to polyfill atob to use the client in your environment. Please follow the instructions at https://liveblocks.io/docs/errors/liveblocks-client/atob-polyfill"
               );
-            global.atob = clientOptions.atobPolyfill;
+            global.atob = clientOptions.polyfills.atob;
           }
           internalRoom.connect();
         }
@@ -1033,18 +1076,37 @@ function createClient(options) {
   );
 }
 function prepareAuthentication(clientOptions) {
-  if ("string" == typeof clientOptions.publicApiKey)
+  const { publicApiKey: publicApiKey, authEndpoint: authEndpoint } =
+    clientOptions;
+  if (void 0 !== authEndpoint && void 0 !== publicApiKey)
+    throw new Error(
+      "You cannot use both publicApiKey and authEndpoint. Please use either publicApiKey or authEndpoint, but not both. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClient"
+    );
+  if ("string" == typeof publicApiKey) {
+    if (publicApiKey.startsWith("sk_"))
+      throw new Error(
+        "Invalid publicApiKey. You are using the secret key which is not supported. Please use the public key instead. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientPublicKey"
+      );
+    if (!publicApiKey.startsWith("pk_"))
+      throw new Error(
+        "Invalid key. Please use the public key format: pk_<public key>. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientPublicKey"
+      );
     return {
       type: "public",
-      publicApiKey: clientOptions.publicApiKey,
+      publicApiKey: publicApiKey,
       url:
         clientOptions.publicAuthorizeEndpoint ||
         "https://liveblocks.io/api/public/authorize",
     };
-  if ("string" == typeof clientOptions.authEndpoint)
-    return { type: "private", url: clientOptions.authEndpoint };
-  if ("function" == typeof clientOptions.authEndpoint)
-    return { type: "custom", callback: clientOptions.authEndpoint };
+  }
+  if ("string" == typeof authEndpoint)
+    return { type: "private", url: authEndpoint };
+  if ("function" == typeof authEndpoint)
+    return { type: "custom", callback: authEndpoint };
+  if (void 0 !== authEndpoint)
+    throw new Error(
+      "authEndpoint must be a string or a function. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientAuthEndpoint"
+    );
   throw new Error(
     "Invalid Liveblocks client options. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClient"
   );