@liveblocks/core 1.1.0 → 1.1.1-yjs1

package/dist/index.d.ts

@@ -669,31 +669,6 @@ declare type Delegates<T extends BaseAuthResult> = {
     createSocket: (token: T) => IWebSocketInstance;
 };
 
-declare type AppOnlyAuthToken = {
-    appId: string;
-    roomId?: never;
-    scopes: string[];
-};
-declare type RoomAuthToken = {
-    appId: string;
-    roomId: string;
-    scopes: string[];
-    actor: number;
-    maxConnectionsPerRoom?: number;
-    info?: Json;
-    groupIds?: string[];
-} & ({
-    id: string;
-    anonymousId?: never;
-} | {
-    id?: never;
-    anonymousId: string;
-});
-declare type AuthToken = AppOnlyAuthToken | RoomAuthToken;
-declare function isAppOnlyAuthToken(data: JsonObject): data is AppOnlyAuthToken;
-declare function isRoomAuthToken(data: JsonObject): data is RoomAuthToken;
-declare function isAuthToken(data: JsonObject): data is AuthToken;
-
 declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
     /**
      * @deprecated Prefer the normal .length property on arrays.
@@ -1077,6 +1052,17 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         addToHistory: boolean;
     }): void;
+    /**
+     *
+     * Sends YJS document updates to liveblocks server
+     *
+     * @param {string} data the doc update to send to the server, base64 encoded uint8array
+     */
+    updateYDoc(data: string): void;
+    /**
+     * Sends a request for the current document from liveblocks server
+     */
+    getYDoc(stateVector: string): void;
     /**
      * Broadcasts an event to other users in the room. Event broadcasted to the room can be listened with {@link Room.subscribe}("event").
      * @param {any} event the event to broadcast. Should be serializable to JSON
@@ -1134,6 +1120,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
+        readonly docUpdated: Observable<string>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1456,12 +1443,14 @@ declare enum ClientMsgCode {
     UPDATE_PRESENCE = 100,
     BROADCAST_EVENT = 103,
     FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201
+    UPDATE_STORAGE = 201,
+    FETCH_YDOC = 300,
+    UPDATE_YDOC = 301
 }
 /**
  * Messages that can be sent from the client to the server.
  */
-declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg;
+declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg | FetchYDocClientMsg | UpdateYDocClientMsg;
 declare type BroadcastEventClientMsg<TRoomEvent extends Json> = {
     type: ClientMsgCode.BROADCAST_EVENT;
     event: TRoomEvent;
@@ -1499,6 +1488,14 @@ declare type UpdateStorageClientMsg = {
 declare type FetchStorageClientMsg = {
     readonly type: ClientMsgCode.FETCH_STORAGE;
 };
+declare type FetchYDocClientMsg = {
+    readonly type: ClientMsgCode.FETCH_YDOC;
+    readonly vector: string;
+};
+declare type UpdateYDocClientMsg = {
+    readonly type: ClientMsgCode.UPDATE_YDOC;
+    readonly update: string;
+};
 
 declare type IdTuple<T> = [id: string, value: T];
 declare enum CrdtType {
@@ -1548,12 +1545,13 @@ declare enum ServerMsgCode {
     ROOM_STATE = 104,
     INITIAL_STORAGE_STATE = 200,
     UPDATE_STORAGE = 201,
-    REJECT_STORAGE_OP = 299
+    REJECT_STORAGE_OP = 299,
+    UPDATE_YDOC = 300
 }
 /**
  * Messages that can be sent from the server to the client.
  */
-declare type ServerMsg<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = UpdatePresenceServerMsg<TPresence> | UserJoinServerMsg<TUserMeta> | UserLeftServerMsg | BroadcastedEventServerMsg<TRoomEvent> | RoomStateServerMsg<TUserMeta> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | RejectedStorageOpServerMsg;
+declare type ServerMsg<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = UpdatePresenceServerMsg<TPresence> | UserJoinServerMsg<TUserMeta> | UserLeftServerMsg | BroadcastedEventServerMsg<TRoomEvent> | RoomStateServerMsg<TUserMeta> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | RejectedStorageOpServerMsg | YDocUpdate;
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User updated their presence. For example, when a user moves their cursor.
@@ -1636,6 +1634,14 @@ declare type UserLeftServerMsg = {
     readonly type: ServerMsgCode.USER_LEFT;
     readonly actor: number;
 };
+/**
+ * Sent by the WebSocket server when the ydoc is updated or when requested based on stateVector passed.
+ * Contains a base64 encoded update
+ */
+declare type YDocUpdate = {
+    readonly type: ServerMsgCode.UPDATE_YDOC;
+    readonly update: string;
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User broadcasted an Event to everyone in the Room.
@@ -1884,4 +1890,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AppOnlyAuthToken, AuthToken, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { AckOp, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, FetchYDocClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };

package/dist/index.js

@@ -17,18 +17,6 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __objRest = (source, exclude) => {
-  var target = {};
-  for (var prop in source)
-    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
-      target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
-        target[prop] = source[prop];
-    }
-  return target;
-};
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -157,7 +145,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.1.0"
+  "1.1.1-yjs1"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -3924,13 +3912,6 @@ function isJsonObject(data) {
 }
 
 // src/protocol/AuthToken.ts
-function hasJwtMeta(data) {
-  if (!isPlainObject(data)) {
-    return false;
-  }
-  const { iat, exp } = data;
-  return typeof iat === "number" && typeof exp === "number";
-}
 function isTokenExpired(token) {
   const now = Date.now() / 1e3;
   const valid = now <= token.exp - 300 && now >= token.iat - 300;
@@ -3939,44 +3920,23 @@ function isTokenExpired(token) {
 function isStringList(value) {
   return Array.isArray(value) && value.every((i) => typeof i === "string");
 }
-function isAppOnlyAuthToken(data) {
-  return typeof data.appId === "string" && data.roomId === void 0 && isStringList(data.scopes);
+function isMinimalTokenPayload(data) {
+  return isPlainObject(data) && typeof data.iat === "number" && typeof data.exp === "number" && typeof data.actor === "number" && (data.id === void 0 || typeof data.id === "string") && isStringList(data.scopes);
 }
-function isRoomAuthToken(data) {
-  return typeof data.appId === "string" && typeof data.roomId === "string" && typeof data.actor === "number" && (data.id === void 0 || typeof data.id === "string") && isStringList(data.scopes) && (data.maxConnectionsPerRoom === void 0 || typeof data.maxConnectionsPerRoom === "number");
-}
-function isAuthToken(data) {
-  return isAppOnlyAuthToken(data) || isRoomAuthToken(data);
-}
-function parseJwtToken(token) {
-  const tokenParts = token.split(".");
+function parseAuthToken(rawTokenString) {
+  const tokenParts = rawTokenString.split(".");
   if (tokenParts.length !== 3) {
     throw new Error("Authentication error: invalid JWT token");
   }
-  const data = tryParseJson(b64decode(tokenParts[1]));
-  if (data && hasJwtMeta(data)) {
-    return data;
-  } else {
-    throw new Error("Authentication error: missing JWT metadata");
-  }
-}
-function parseRoomAuthToken(tokenString) {
-  const data = parseJwtToken(tokenString);
-  if (!(data && isRoomAuthToken(data))) {
+  const payload = tryParseJson(b64decode(tokenParts[1]));
+  if (!(payload && isMinimalTokenPayload(payload))) {
     throw new Error(
       "Authentication error: we expected a room token but did not get one. Hint: if you are using a callback, ensure the room is passed when creating the token. For more information: https://liveblocks.io/docs/api-reference/liveblocks-client#createClientCallback"
     );
   }
-  const _a = data, {
-    maxConnections: _legacyField
-  } = _a, parsedToken = __objRest(_a, [
-    // If this legacy field is found on the token, pretend it wasn't there,
-    // to make all internally used token payloads uniform
-    "maxConnections"
-  ]);
   return {
-    raw: tokenString,
-    parsed: parsedToken
+    raw: rawTokenString,
+    parsed: payload
   };
 }
 
@@ -3986,6 +3946,8 @@ var ClientMsgCode = /* @__PURE__ */ ((ClientMsgCode2) => {
   ClientMsgCode2[ClientMsgCode2["BROADCAST_EVENT"] = 103] = "BROADCAST_EVENT";
   ClientMsgCode2[ClientMsgCode2["FETCH_STORAGE"] = 200] = "FETCH_STORAGE";
   ClientMsgCode2[ClientMsgCode2["UPDATE_STORAGE"] = 201] = "UPDATE_STORAGE";
+  ClientMsgCode2[ClientMsgCode2["FETCH_YDOC"] = 300] = "FETCH_YDOC";
+  ClientMsgCode2[ClientMsgCode2["UPDATE_YDOC"] = 301] = "UPDATE_YDOC";
   return ClientMsgCode2;
 })(ClientMsgCode || {});
 
@@ -3999,6 +3961,7 @@ var ServerMsgCode = /* @__PURE__ */ ((ServerMsgCode2) => {
   ServerMsgCode2[ServerMsgCode2["INITIAL_STORAGE_STATE"] = 200] = "INITIAL_STORAGE_STATE";
   ServerMsgCode2[ServerMsgCode2["UPDATE_STORAGE"] = 201] = "UPDATE_STORAGE";
   ServerMsgCode2[ServerMsgCode2["REJECT_STORAGE_OP"] = 299] = "REJECT_STORAGE_OP";
+  ServerMsgCode2[ServerMsgCode2["UPDATE_YDOC"] = 300] = "UPDATE_YDOC";
   return ServerMsgCode2;
 })(ServerMsgCode || {});
 
@@ -4431,7 +4394,8 @@ function createRoom(options, config) {
     storage: makeEventSource(),
     history: makeEventSource(),
     storageDidLoad: makeEventSource(),
-    storageStatus: makeEventSource()
+    storageStatus: makeEventSource(),
+    docUpdated: makeEventSource()
   };
   function sendMessages(messageOrMessages) {
     var _a2, _b2;
@@ -4852,6 +4816,10 @@ function createRoom(options, config) {
             }
             break;
           }
+          case 300 /* UPDATE_YDOC */: {
+            eventHub.docUpdated.notify(message.update);
+            break;
+          }
           case 104 /* ROOM_STATE */: {
             updates.others.push(onRoomStateMessage(message));
             break;
@@ -4970,6 +4938,13 @@ ${Array.from(traces).join("\n\n")}`
     }
     return messages;
   }
+  function updateYDoc(update) {
+    context.buffer.messages.push({
+      type: 301 /* UPDATE_YDOC */,
+      update
+    });
+    flushNowOrSoon();
+  }
   function broadcastEvent(event, options2 = {
     shouldQueueEventIfNotReady: false
   }) {
@@ -5029,6 +5004,13 @@ ${Array.from(traces).join("\n\n")}`
       };
     });
   }
+  function getYDoc(vector) {
+    context.buffer.messages.push({
+      type: 300 /* FETCH_YDOC */,
+      vector
+    });
+    flushNowOrSoon();
+  }
   function undo() {
     if (context.activeBatch) {
       throw new Error("undo is not allowed during a batch");
@@ -5150,7 +5132,8 @@ ${Array.from(traces).join("\n\n")}`
     storage: eventHub.storage.observable,
     history: eventHub.history.observable,
     storageDidLoad: eventHub.storageDidLoad.observable,
-    storageStatus: eventHub.storageStatus.observable
+    storageStatus: eventHub.storageStatus.observable,
+    docUpdated: eventHub.docUpdated.observable
   };
   return {
     /* NOTE: Exposing __internal here only to allow testing implementation details in unit tests */
@@ -5185,6 +5168,7 @@ ${Array.from(traces).join("\n\n")}`
     destroy: () => managedSocket.destroy(),
     // Presence
     updatePresence,
+    updateYDoc,
     broadcastEvent,
     // Storage
     batch,
@@ -5196,6 +5180,7 @@ ${Array.from(traces).join("\n\n")}`
       pause: pauseHistory,
       resume: resumeHistory
     },
+    getYDoc,
     getStorage,
     getStorageSnapshot,
     getStorageStatus,
@@ -5311,7 +5296,7 @@ function makeCreateSocketDelegateForRoom(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.1.0"
+        "1.1.1-yjs1"
       ) : "dev"}`
     );
   };
@@ -5342,7 +5327,7 @@ function makeAuthDelegateForRoom(roomId, authentication, fetchPolyfill) {
       return fetchAuthEndpoint(fetcher, authentication.url, {
         room: roomId,
         publicApiKey: authentication.publicApiKey
-      }).then(({ token }) => parseRoomAuthToken(token));
+      }).then(({ token }) => parseAuthToken(token));
     });
   } else if (authentication.type === "private") {
     return () => __async(this, null, function* () {
@@ -5353,7 +5338,7 @@ function makeAuthDelegateForRoom(roomId, authentication, fetchPolyfill) {
       }
       return fetchAuthEndpoint(fetcher, authentication.url, {
         room: roomId
-      }).then(({ token }) => parseRoomAuthToken(token));
+      }).then(({ token }) => parseAuthToken(token));
     });
   } else if (authentication.type === "custom") {
     return () => __async(this, null, function* () {
@@ -5363,7 +5348,7 @@ function makeAuthDelegateForRoom(roomId, authentication, fetchPolyfill) {
           'We expect the authentication callback to return a token, but it does not. Hint: the return value should look like: { token: "..." }'
         );
       }
-      return parseRoomAuthToken(response.token);
+      return parseAuthToken(response.token);
     });
   } else {
     throw new Error("Internal error. Unexpected authentication type");
@@ -5964,7 +5949,4 @@ var WebsocketCloseCodes = /* @__PURE__ */ ((WebsocketCloseCodes2) => {
 
 
 
-
-
-
-exports.ClientMsgCode = ClientMsgCode; exports.CrdtType = CrdtType; exports.LiveList = LiveList; exports.LiveMap = LiveMap; exports.LiveObject = LiveObject; exports.OpCode = OpCode; exports.ServerMsgCode = ServerMsgCode; exports.WebsocketCloseCodes = WebsocketCloseCodes; exports.asArrayWithLegacyMethods = asArrayWithLegacyMethods; exports.asPos = asPos; exports.assert = assert; exports.assertNever = assertNever; exports.b64decode = b64decode; exports.createClient = createClient; exports.deprecate = deprecate; exports.deprecateIf = deprecateIf; exports.errorIf = errorIf; exports.freeze = freeze; exports.isAppOnlyAuthToken = isAppOnlyAuthToken; exports.isAuthToken = isAuthToken; exports.isChildCrdt = isChildCrdt; exports.isJsonArray = isJsonArray; exports.isJsonObject = isJsonObject; exports.isJsonScalar = isJsonScalar; exports.isPlainObject = isPlainObject; exports.isRoomAuthToken = isRoomAuthToken; exports.isRootCrdt = isRootCrdt; exports.legacy_patchImmutableObject = legacy_patchImmutableObject; exports.lsonToJson = lsonToJson; exports.makePosition = makePosition; exports.nn = nn; exports.patchLiveObjectKey = patchLiveObjectKey; exports.shallow = shallow; exports.throwUsageError = throwUsageError; exports.tryParseJson = tryParseJson; exports.withTimeout = withTimeout;
+exports.ClientMsgCode = ClientMsgCode; exports.CrdtType = CrdtType; exports.LiveList = LiveList; exports.LiveMap = LiveMap; exports.LiveObject = LiveObject; exports.OpCode = OpCode; exports.ServerMsgCode = ServerMsgCode; exports.WebsocketCloseCodes = WebsocketCloseCodes; exports.asArrayWithLegacyMethods = asArrayWithLegacyMethods; exports.asPos = asPos; exports.assert = assert; exports.assertNever = assertNever; exports.b64decode = b64decode; exports.createClient = createClient; exports.deprecate = deprecate; exports.deprecateIf = deprecateIf; exports.errorIf = errorIf; exports.freeze = freeze; exports.isChildCrdt = isChildCrdt; exports.isJsonArray = isJsonArray; exports.isJsonObject = isJsonObject; exports.isJsonScalar = isJsonScalar; exports.isPlainObject = isPlainObject; exports.isRootCrdt = isRootCrdt; exports.legacy_patchImmutableObject = legacy_patchImmutableObject; exports.lsonToJson = lsonToJson; exports.makePosition = makePosition; exports.nn = nn; exports.patchLiveObjectKey = patchLiveObjectKey; exports.shallow = shallow; exports.throwUsageError = throwUsageError; exports.tryParseJson = tryParseJson; exports.withTimeout = withTimeout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "1.1.0",
+  "version": "1.1.1-yjs1",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,7 +20,7 @@
   "scripts": {
     "dev": "tsup --watch",
     "build": "tsup",
-    "format": "eslint --fix src/; prettier --write src/",
+    "format": "(eslint --fix src/ || true) && prettier --write src/",
     "lint": "eslint src/",
     "test": "jest --silent --verbose --color=always",
     "test:types": "tsd",