@liveblocks/core 1.1.1 → 1.1.2

package/dist/index.d.ts

@@ -686,11 +686,11 @@ declare function asArrayWithLegacyMethods<T>(arr: readonly T[]): ReadonlyArrayWi
  */
 declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     /**
-     * The connection id of the user. It is unique and increment at every new connection.
+     * The connection ID of the User. It is unique and increment at every new connection.
      */
     readonly connectionId: number;
     /**
-     * The id of the user that has been set in the authentication endpoint.
+     * The ID of the User that has been set in the authentication endpoint.
      * Useful to get additional information about the connected user.
      */
     readonly id: TUserMeta["id"];
@@ -699,7 +699,7 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
      */
     readonly info: TUserMeta["info"];
     /**
-     * The user presence.
+     * The user’s presence data.
      */
     readonly presence: TPresence;
     /**
@@ -1052,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
+     */
+    fetchYDoc(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
@@ -1109,6 +1120,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
+        readonly ydoc: Observable<string>;
     };
     /**
      * Batches modifications made during the given function.

package/dist/index.js

@@ -145,7 +145,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.1.1"
+  "1.1.2"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -3973,6 +3973,19 @@ var ServerMsgCode = /* @__PURE__ */ ((ServerMsgCode2) => {
   return ServerMsgCode2;
 })(ServerMsgCode || {});
 
+// src/lib/LegacyArray.ts
+function asArrayWithLegacyMethods(arr) {
+  Object.defineProperty(arr, "count", {
+    value: arr.length,
+    enumerable: false
+  });
+  Object.defineProperty(arr, "toArray", {
+    value: () => arr,
+    enumerable: false
+  });
+  return freeze(arr);
+}
+
 // src/refs/ImmutableRef.ts
 function merge(target, patch) {
   let updated = false;
@@ -4010,42 +4023,6 @@ var ImmutableRef = class {
   }
 };
 
-// src/refs/MeRef.ts
-var MeRef = class extends ImmutableRef {
-  constructor(initialPresence) {
-    super();
-    this._me = freeze(compactObject(initialPresence));
-  }
-  /** @internal */
-  _toImmutable() {
-    return this._me;
-  }
-  /**
-   * Patches the current "me" instance.
-   */
-  patch(patch) {
-    const oldMe = this._me;
-    const newMe = merge(oldMe, patch);
-    if (oldMe !== newMe) {
-      this._me = freeze(newMe);
-      this.invalidate();
-    }
-  }
-};
-
-// src/lib/LegacyArray.ts
-function asArrayWithLegacyMethods(arr) {
-  Object.defineProperty(arr, "count", {
-    value: arr.length,
-    enumerable: false
-  });
-  Object.defineProperty(arr, "toArray", {
-    value: () => arr,
-    enumerable: false
-  });
-  return freeze(arr);
-}
-
 // src/refs/OthersRef.ts
 function makeUser(conn, presence) {
   return freeze(compactObject(__spreadProps(__spreadValues({}, conn), { presence })));
@@ -4155,6 +4132,29 @@ var OthersRef = class extends ImmutableRef {
   }
 };
 
+// src/refs/PatchableRef.ts
+var PatchableRef = class extends ImmutableRef {
+  constructor(data) {
+    super();
+    this._data = freeze(compactObject(data));
+  }
+  /** @internal */
+  _toImmutable() {
+    return this._data;
+  }
+  /**
+   * Patches the current object.
+   */
+  patch(patch) {
+    const oldMe = this._data;
+    const newMe = merge(oldMe, patch);
+    if (oldMe !== newMe) {
+      this._data = freeze(newMe);
+      this.invalidate();
+    }
+  }
+};
+
 // src/refs/ValueRef.ts
 var ValueRef = class extends ImmutableRef {
   constructor(initialValue) {
@@ -4237,7 +4237,7 @@ function createRoom(options, config) {
       storageOperations: []
     },
     sessionInfo: new ValueRef(null),
-    me: new MeRef(initialPresence),
+    me: new PatchableRef(initialPresence),
     others: new OthersRef(),
     initialStorage,
     idFactory: null,
@@ -4262,9 +4262,10 @@ function createRoom(options, config) {
     const token = (_a2 = managedSocket.token) == null ? void 0 : _a2.parsed;
     if (token !== void 0 && token !== lastToken) {
       context.sessionInfo.set({
-        id: token.actor,
         userInfo: token.info,
         userId: token.id,
+        // NOTE: In the future, these fields will get assigned in the connection phase
+        actor: token.actor,
         isReadOnly: isStorageReadOnly(token.scopes)
       });
       lastToken = token;
@@ -4316,7 +4317,7 @@ function createRoom(options, config) {
         __spreadValues({}, context.me.current)
       )
     };
-    context.idFactory = makeIdFactory(sessionInfo.id);
+    context.idFactory = makeIdFactory(sessionInfo.actor);
     if (_getStorage$ !== null) {
       refreshStorage({ flush: false });
     }
@@ -4402,7 +4403,8 @@ function createRoom(options, config) {
     storage: makeEventSource(),
     history: makeEventSource(),
     storageDidLoad: makeEventSource(),
-    storageStatus: makeEventSource()
+    storageStatus: makeEventSource(),
+    ydoc: makeEventSource()
   };
   function sendMessages(messageOrMessages) {
     var _a2, _b2;
@@ -4432,7 +4434,7 @@ function createRoom(options, config) {
     context.me,
     (info, me) => {
       return info !== null ? {
-        connectionId: info.id,
+        connectionId: info.actor,
         id: info.userId,
         info: info.userInfo,
         presence: me,
@@ -4509,7 +4511,7 @@ function createRoom(options, config) {
   function getConnectionId() {
     const info = context.sessionInfo.current;
     if (info) {
-      return info.id;
+      return info.actor;
     }
     throw new Error(
       "Internal. Tried to get connection id but connection was never open"
@@ -4823,6 +4825,10 @@ function createRoom(options, config) {
             }
             break;
           }
+          case 300 /* UPDATE_YDOC */: {
+            eventHub.ydoc.notify(message.update);
+            break;
+          }
           case 104 /* ROOM_STATE */: {
             updates.others.push(onRoomStateMessage(message));
             break;
@@ -4941,6 +4947,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
   }) {
@@ -5000,6 +5013,13 @@ ${Array.from(traces).join("\n\n")}`
       };
     });
   }
+  function fetchYDoc(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");
@@ -5121,7 +5141,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,
+    ydoc: eventHub.ydoc.observable
   };
   return {
     /* NOTE: Exposing __internal here only to allow testing implementation details in unit tests */
@@ -5156,6 +5177,7 @@ ${Array.from(traces).join("\n\n")}`
     destroy: () => managedSocket.destroy(),
     // Presence
     updatePresence,
+    updateYDoc,
     broadcastEvent,
     // Storage
     batch,
@@ -5167,6 +5189,7 @@ ${Array.from(traces).join("\n\n")}`
       pause: pauseHistory,
       resume: resumeHistory
     },
+    fetchYDoc,
     getStorage,
     getStorageSnapshot,
     getStorageStatus,
@@ -5282,7 +5305,7 @@ function makeCreateSocketDelegateForRoom(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.1.1"
+        "1.1.2"
       ) : "dev"}`
     );
   };
@@ -5547,6 +5570,35 @@ function buildLiveblocksPublicAuthorizeEndpoint(options, roomId) {
   )}/public/authorize`;
 }
 
+// src/crdts/utils.ts
+function toPlainLson(lson) {
+  if (lson instanceof LiveObject) {
+    return {
+      liveblocksType: "LiveObject",
+      data: Object.fromEntries(
+        Object.entries(lson.toObject()).map(([key, value]) => [
+          key,
+          value ? toPlainLson(value) : ""
+        ])
+      )
+    };
+  } else if (lson instanceof LiveMap) {
+    return {
+      liveblocksType: "LiveMap",
+      data: Object.fromEntries(
+        [...lson].map(([key, value]) => [key, toPlainLson(value)])
+      )
+    };
+  } else if (lson instanceof LiveList) {
+    return {
+      liveblocksType: "LiveList",
+      data: [...lson].map((item) => toPlainLson(item))
+    };
+  } else {
+    return lson;
+  }
+}
+
 // src/immutable.ts
 function lsonObjectToJson(obj) {
   const result = {};
@@ -5935,4 +5987,5 @@ 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.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;
+
+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.toPlainLson = toPlainLson; exports.tryParseJson = tryParseJson; exports.withTimeout = withTimeout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -27,9 +27,9 @@
     "test:types": "tsd",
     "test:watch": "jest --silent --verbose --color=always --watch",
     "test:e2e": "jest --silent --verbose --color=always --config=./jest.config.e2e.js",
-    "test:deps": "depcruise src --exclude __tests__ --config",
-    "showdeps": "depcruise src --include-only '^src' --exclude='__tests__' --config --output-type dot | dot -T svg > /tmp/dependency-graph.svg && open /tmp/dependency-graph.svg",
-    "showdeps:high-level": "depcruise src --include-only '^src' --exclude='(^src/index.ts|shallow.ts|__tests__)' --collapse='^src/(refs|lib|compat|types|crdts|protocol)' --config --output-type dot | dot -T svg > /tmp/dependency-graph.svg && open /tmp/dependency-graph.svg"
+    "test:deps": "depcruise src --exclude __tests__",
+    "showdeps": "depcruise src --include-only '^src' --exclude='__tests__' --output-type dot | dot -T svg > /tmp/dependency-graph.svg && open /tmp/dependency-graph.svg",
+    "showdeps:high-level": "depcruise src --include-only '^src' --exclude='(^src/index.ts|shallow.ts|__tests__)' --collapse='^src/(refs|lib|compat|types|crdts|protocol)' --output-type dot | dot -T svg > /tmp/dependency-graph.svg && open /tmp/dependency-graph.svg"
   },
   "license": "Apache-2.0",
   "devDependencies": {