@liveblocks/server 1.6.2 → 1.8.0-pre1

package/dist/index.js

@@ -12,12 +12,12 @@ var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "
 // src/decoders/ClientMsg.ts
 import { ClientMsgCode } from "@liveblocks/core";
 import {
-  array as array2,
+  array as array3,
   boolean,
   constant as constant2,
   jsonObject,
   nonEmptyString,
-  number,
+  number as number2,
   object as object2,
   optional as optional3,
   string as string3,
@@ -158,14 +158,28 @@ var jsonObjectYolo = jsonYolo.refine(
 // src/decoders/Op.ts
 import { OpCode } from "@liveblocks/core";
 import {
+  array as array2,
   constant,
+  either as either2,
+  number,
   object,
   oneOf,
   optional as optional2,
+  sized as sized2,
+  startsWith,
   string as string2,
-  taggedUnion
+  taggedUnion,
+  tuple
 } from "decoders";
 var intent = oneOf(["set", "push"]);
+var storageFileId = sized2(startsWith("fl_"), { size: 24 });
+var fileSize = number.refine(
+  (value) => Number.isSafeInteger(value) && value >= 0,
+  "Must be a valid file size"
+);
+var liveTextVersion = number.reject(
+  (value) => Number.isSafeInteger(value) && value >= 0 ? null : "Must be a non-negative safe integer"
+);
 var updateObjectOp = object({
   type: constant(OpCode.UPDATE_OBJECT),
   opId: string2,
@@ -210,6 +224,64 @@ var createRegisterOp = object({
   intent: optional2(intent),
   deletedId: optional2(string2)
 });
+var liveTextSegment = either2(
+  tuple(string2),
+  tuple(string2, jsonObjectYolo)
+);
+var liveTextData = array2(liveTextSegment);
+var textOperation = taggedUnion("type", {
+  insert: object({
+    type: constant("insert"),
+    index: number,
+    text: string2,
+    attributes: optional2(jsonObjectYolo)
+  }),
+  delete: object({
+    type: constant("delete"),
+    index: number,
+    length: number
+  }),
+  format: object({
+    type: constant("format"),
+    index: number,
+    length: number,
+    attributes: jsonObjectYolo
+  })
+});
+var createTextOp = object({
+  type: constant(OpCode.CREATE_TEXT),
+  opId: string2,
+  id: string2,
+  parentId: string2,
+  parentKey: string2,
+  data: liveTextData,
+  version: liveTextVersion,
+  intent: optional2(intent),
+  deletedId: optional2(string2)
+});
+var createFileOp = object({
+  type: constant(OpCode.CREATE_FILE),
+  opId: string2,
+  id: string2,
+  parentId: string2,
+  parentKey: string2,
+  data: object({
+    id: storageFileId,
+    name: string2,
+    size: fileSize,
+    mimeType: string2
+  }),
+  intent: optional2(intent),
+  deletedId: optional2(string2)
+});
+var updateTextOp = object({
+  type: constant(OpCode.UPDATE_TEXT),
+  opId: string2,
+  id: string2,
+  baseVersion: liveTextVersion,
+  version: optional2(liveTextVersion),
+  ops: array2(textOperation)
+});
 var deleteCrdtOp = object({
   type: constant(OpCode.DELETE_CRDT),
   opId: string2,
@@ -233,6 +305,9 @@ var op = taggedUnion("type", {
   [OpCode.CREATE_LIST]: createListOp,
   [OpCode.CREATE_MAP]: createMapOp,
   [OpCode.CREATE_REGISTER]: createRegisterOp,
+  [OpCode.CREATE_TEXT]: createTextOp,
+  [OpCode.UPDATE_TEXT]: updateTextOp,
+  [OpCode.CREATE_FILE]: createFileOp,
   [OpCode.DELETE_CRDT]: deleteCrdtOp,
   [OpCode.SET_PARENT_KEY]: setParentKeyOp,
   [OpCode.DELETE_OBJECT_KEY]: deleteObjectKeyOp
@@ -247,7 +322,7 @@ var ROOT_YDOC_ID = "root";
 var updatePresenceClientMsg = object2({
   type: constant2(ClientMsgCode.UPDATE_PRESENCE),
   data: jsonObjectYolo,
-  targetActor: optional3(number)
+  targetActor: optional3(number2)
 });
 var broadcastEventClientMsg = object2({
   type: constant2(ClientMsgCode.BROADCAST_EVENT),
@@ -258,7 +333,7 @@ var fetchStorageClientMsg = object2({
 });
 var updateStorageClientMsg = object2({
   type: constant2(ClientMsgCode.UPDATE_STORAGE),
-  ops: array2(op)
+  ops: array3(op)
 });
 var fetchYDocClientMsg = object2({
   type: constant2(ClientMsgCode.FETCH_YDOC),
@@ -278,8 +353,8 @@ var fetchFeedsClientMsg = object2({
   type: constant2(FeedMsgCode.FETCH_FEEDS),
   requestId: string3,
   cursor: optional3(string3),
-  since: optional3(number),
-  limit: optional3(number),
+  since: optional3(number2),
+  limit: optional3(number2),
   metadata: fetchFeedsMetadataFilterDecoder
 });
 var fetchFeedMessagesClientMsg = object2({
@@ -287,14 +362,14 @@ var fetchFeedMessagesClientMsg = object2({
   requestId: string3,
   feedId: nonEmptyString,
   cursor: optional3(string3),
-  since: optional3(number),
-  limit: optional3(number)
+  since: optional3(number2),
+  limit: optional3(number2)
 });
 var addFeedClientMsg = object2({
   type: constant2(FeedMsgCode.ADD_FEED),
   feedId: string3,
   metadata: optionalFeedMetadataDecoder,
-  timestamp: optional3(number),
+  timestamp: optional3(number2),
   requestId: optional3(string3)
 });
 var updateFeedClientMsg = object2({
@@ -313,7 +388,7 @@ var addFeedMessageClientMsg = object2({
   feedId: string3,
   data: jsonObject,
   id: optional3(string3),
-  timestamp: optional3(number),
+  timestamp: optional3(number2),
   requestId: optional3(string3)
 });
 var updateFeedMessageClientMsg = object2({
@@ -321,7 +396,7 @@ var updateFeedMessageClientMsg = object2({
   feedId: string3,
   messageId: string3,
   data: jsonObject,
-  timestamp: optional3(number),
+  timestamp: optional3(number2),
   requestId: optional3(string3)
 });
 var deleteFeedMessageClientMsg = object2({
@@ -372,6 +447,10 @@ function buildNode(snapshot2, id) {
     return buildList(snapshot2, id);
   } else if (node.type === CrdtType.MAP) {
     return buildMap(snapshot2, id);
+  } else if (node.type === CrdtType.TEXT) {
+    return node.data;
+  } else if (node.type === CrdtType.FILE) {
+    return node.data;
   } else {
     return node.data;
   }
@@ -415,6 +494,10 @@ function* emit(snapshot2, id) {
     yield* emitMap(snapshot2, id);
   } else if (node.type === CrdtType.REGISTER) {
     yield JSON.stringify(node.data);
+  } else if (node.type === CrdtType.TEXT) {
+    yield JSON.stringify(node.data);
+  } else if (node.type === CrdtType.FILE) {
+    yield JSON.stringify(node.data);
   }
 }
 function* emitObject(snapshot2, id, staticJson) {
@@ -486,6 +569,29 @@ function* iterJson(key, data, parent, state) {
       case "LiveMap":
         yield* iterMap(key, data.data, parent, state);
         return;
+      case "LiveText":
+        yield [
+          generateId(state),
+          {
+            type: CrdtType2.TEXT,
+            data: data.data,
+            version: data.version ?? 0,
+            parentId: parent[0],
+            parentKey: key
+          }
+        ];
+        return;
+      case "LiveFile":
+        yield [
+          generateId(state),
+          {
+            type: CrdtType2.FILE,
+            data: data.data,
+            parentId: parent[0],
+            parentKey: key
+          }
+        ];
+        return;
       // istanbul ignore next
       default:
         assertNever(data, "Unknown `liveblocksType` field");
@@ -570,6 +676,13 @@ function buildNode2(snapshot2, id) {
     return buildList2(snapshot2, id);
   } else if (node.type === CrdtType2.MAP) {
     return buildMap2(snapshot2, id);
+  } else if (node.type === CrdtType2.TEXT) {
+    return {
+      liveblocksType: "LiveText",
+      data: node.data
+    };
+  } else if (node.type === CrdtType2.FILE) {
+    return { liveblocksType: "LiveFile", data: node.data };
   } else {
     return node.data ?? null;
   }
@@ -616,6 +729,15 @@ function* emit2(snapshot2, id) {
     yield* emitMap2(snapshot2, id);
   } else if (node.type === CrdtType2.REGISTER) {
     yield JSON.stringify(node.data ?? null);
+  } else if (node.type === CrdtType2.TEXT) {
+    yield JSON.stringify({
+      liveblocksType: "LiveText",
+      data: node.data
+    });
+  } else if (node.type === CrdtType2.FILE) {
+    yield '{"liveblocksType":"LiveFile","data":';
+    yield JSON.stringify(node.data);
+    yield "}";
   }
 }
 function* emitObject2(snapshot2, id, staticJson) {
@@ -837,7 +959,7 @@ import {
   WebsocketCloseCodes as CloseCode
 } from "@liveblocks/core";
 import { Mutex, tryAcquire } from "async-mutex";
-import { array as array3, formatInline } from "decoders";
+import { array as array4, formatInline } from "decoders";
 import { chunkedByCost } from "itertools";
 import { nanoid as nanoid2 } from "nanoid";
 
@@ -1012,9 +1134,10 @@ function buildReverseLookup(nodes) {
         delete node.data[key];
       }
     }
-    if (node.type !== CrdtType4.REGISTER) {
+    const isLeafNode = node.type === CrdtType4.REGISTER || node.type === CrdtType4.FILE || node.type === CrdtType4.TEXT;
+    if (!isLeafNode) {
       queue.push(...revNodes.valuesAt(nodeId));
-    } else {
+    } else if (node.type === CrdtType4.REGISTER) {
       const parent = nodes.get(node.parentId);
       if (parent?.type === CrdtType4.OBJECT) {
         continue;
@@ -1035,7 +1158,6 @@ function hasStaticDataAt(node, key) {
   return node.type === CrdtType4.OBJECT && Object.prototype.hasOwnProperty.call(node.data, key) && node.data[key] !== void 0;
 }
 var InMemoryDriver = class {
-  // Key: `${feedId}:${messageId}`
   constructor(options) {
     __publicField(this, "_nextActor");
     __publicField(this, "_nodes");
@@ -1045,12 +1167,15 @@ var InMemoryDriver = class {
     __publicField(this, "_leasedSessions");
     __publicField(this, "_feeds");
     __publicField(this, "_feedMessages");
+    // Key: `${feedId}:${messageId}`
+    __publicField(this, "_liveTextHistory");
     this._nodes = /* @__PURE__ */ new Map();
     this._metadb = /* @__PURE__ */ new Map();
     this._ydb = /* @__PURE__ */ new Map();
     this._leasedSessions = /* @__PURE__ */ new Map();
     this._feeds = /* @__PURE__ */ new Map();
     this._feedMessages = /* @__PURE__ */ new Map();
+    this._liveTextHistory = /* @__PURE__ */ new Map();
     this._nextActor = options?.initialActor ?? -1;
     for (const [key, value] of options?.initialNodes ?? []) {
       this._nodes.set(key, value);
@@ -1066,10 +1191,40 @@ var InMemoryDriver = class {
   DANGEROUSLY_reset_nodes(doc) {
     this.reinitialize();
     this._nodes.clear();
+    this._liveTextHistory.clear();
     for (const [id, node] of plainLsonToNodeStream(doc)) {
       this._nodes.set(id, node);
     }
   }
+  get_live_text_history_since(nodeId, version) {
+    return (this._liveTextHistory.get(nodeId) ?? []).filter((entry) => entry.version > version).sort((left, right) => left.version - right.version).map((entry) => ({ ...entry, ops: [...entry.ops] }));
+  }
+  get_live_text_history_by_op_id(nodeId, opId) {
+    const entry = (this._liveTextHistory.get(nodeId) ?? []).find(
+      (item) => item.opId === opId
+    );
+    return entry === void 0 ? void 0 : { ...entry, ops: [...entry.ops] };
+  }
+  append_live_text_history(entry) {
+    const history = this._liveTextHistory.get(entry.nodeId) ?? [];
+    history.push({ ...entry, ops: [...entry.ops] });
+    history.sort((left, right) => left.version - right.version);
+    this._liveTextHistory.set(entry.nodeId, history);
+  }
+  purge_live_text_history_before(nodeId, minVersionToKeep) {
+    const history = this._liveTextHistory.get(nodeId);
+    if (history === void 0) {
+      return;
+    }
+    const retained = history.filter(
+      (entry) => entry.version >= minVersionToKeep
+    );
+    if (retained.length === 0) {
+      this._liveTextHistory.delete(nodeId);
+    } else {
+      this._liveTextHistory.set(nodeId, retained);
+    }
+  }
   get_meta(key) {
     return this._metadb.get(key);
   }
@@ -1345,6 +1500,7 @@ var InMemoryDriver = class {
   }
   _loadNodesApi() {
     const nodes = this._nodes;
+    const liveTextHistory = this._liveTextHistory;
     if (!nodes.has("root")) {
       nodes.set("root", { type: CrdtType4.OBJECT, data: {} });
     }
@@ -1377,6 +1533,9 @@ var InMemoryDriver = class {
       if (node.type === CrdtType4.REGISTER && parentNode.type === CrdtType4.OBJECT) {
         throw new Error("Cannot add register under object");
       }
+      if (parentNode.type === CrdtType4.FILE) {
+        throw new Error("Cannot add child under file");
+      }
       const conflictingSiblingId = revNodes.get(node.parentId, node.parentKey);
       if (conflictingSiblingId !== id) {
         const parentNode2 = nodes.get(node.parentId);
@@ -1432,6 +1591,7 @@ var InMemoryDriver = class {
         const currid = queue.pop();
         queue.push(...revNodes.valuesAt(currid));
         nodes.delete(currid);
+        liveTextHistory.delete(currid);
         revNodes.deleteAll(currid);
       }
     }
@@ -1551,24 +1711,27 @@ function makeNewInMemoryDriver(options) {
 
 // src/Storage.ts
 import {
+  applyLiveTextOperations,
   asPos as asPos2,
   assertNever as assertNever2,
   CrdtType as CrdtType5,
   makePosition as makePosition2,
-  OpCode as OpCode2
+  OpCode as OpCode2,
+  transformTextOperations
 } from "@liveblocks/core";
+var LIVE_TEXT_HISTORY_LIMIT = 1e3;
+var LIVE_TEXT_HISTORY_TOO_OLD_REASON = "LiveText operation is older than retained history";
 function accept(op2, fix) {
   return { action: "accepted", op: op2, fix };
 }
 function ignore(ignoredOp) {
   return { action: "ignored", ignoredOpId: ignoredOp.opId };
 }
-function rectify(op2, parentKey) {
-  return {
-    action: "rectified",
-    ackOp: { ...op2, parentKey },
-    fix: { type: OpCode2.SET_PARENT_KEY, id: op2.id, parentKey }
-  };
+function reject(op2, reason) {
+  return { action: "rejected", opIds: [op2.opId], reason };
+}
+function rectify(ackOp, fix) {
+  return { action: "rectified", ackOp, fix };
 }
 function nodeFromCreateChildOp(op2) {
   switch (op2.type) {
@@ -1598,6 +1761,21 @@ function nodeFromCreateChildOp(op2) {
         parentKey: op2.parentKey,
         data: op2.data
       };
+    case OpCode2.CREATE_TEXT:
+      return {
+        type: CrdtType5.TEXT,
+        parentId: op2.parentId,
+        parentKey: op2.parentKey,
+        data: op2.data,
+        version: op2.version
+      };
+    case OpCode2.CREATE_FILE:
+      return {
+        type: CrdtType5.FILE,
+        parentId: op2.parentId,
+        parentKey: op2.parentKey,
+        data: op2.data
+      };
     // istanbul ignore next
     default:
       return assertNever2(op2, "Unknown op code");
@@ -1639,9 +1817,13 @@ var Storage = class {
       case OpCode2.CREATE_MAP:
       case OpCode2.CREATE_REGISTER:
       case OpCode2.CREATE_OBJECT:
+      case OpCode2.CREATE_TEXT:
+      case OpCode2.CREATE_FILE:
         return this.applyCreateOp(op2);
       case OpCode2.UPDATE_OBJECT:
         return this.applyUpdateObjectOp(op2);
+      case OpCode2.UPDATE_TEXT:
+        return this.applyUpdateTextOp(op2);
       case OpCode2.SET_PARENT_KEY:
         return this.applySetParentKeyOp(op2);
       case OpCode2.DELETE_OBJECT_KEY:
@@ -1662,7 +1844,14 @@ var Storage = class {
       if (op2.intent === "push") {
         const stored = this.driver.get_node(op2.id);
         if (stored?.parentId !== void 0 && this.driver.get_node(stored.parentId)?.type === CrdtType5.LIST) {
-          return rectify(op2, stored.parentKey);
+          return rectify(
+            { ...op2, parentKey: stored.parentKey },
+            {
+              type: OpCode2.SET_PARENT_KEY,
+              id: op2.id,
+              parentKey: stored.parentKey
+            }
+          );
         }
       }
       return ignore(op2);
@@ -1684,6 +1873,8 @@ var Storage = class {
       case CrdtType5.LIST:
         return this.createChildAsListItem(op2, node);
       case CrdtType5.REGISTER:
+      case CrdtType5.TEXT:
+      case CrdtType5.FILE:
         return ignore(op2);
       // istanbul ignore next
       default:
@@ -1740,6 +1931,59 @@ var Storage = class {
     this.driver.set_object_data(op2.id, op2.data, true);
     return accept(op2);
   }
+  applyUpdateTextOp(op2) {
+    const node = this.driver.get_node(op2.id);
+    if (node?.type !== CrdtType5.TEXT) {
+      return ignore(op2);
+    }
+    const duplicate = this.driver.get_live_text_history_by_op_id(
+      op2.id,
+      op2.opId
+    );
+    if (duplicate !== void 0) {
+      return rectify({
+        ...op2,
+        baseVersion: duplicate.baseVersion,
+        version: duplicate.version,
+        ops: [...duplicate.ops]
+      });
+    }
+    if (op2.ops.length === 0) {
+      return ignore(op2);
+    }
+    if (op2.baseVersion > node.version) {
+      return reject(op2, "LiveText operation base version is ahead of storage");
+    }
+    const history = op2.baseVersion < node.version ? this.driver.get_live_text_history_since(op2.id, op2.baseVersion) : [];
+    if (op2.baseVersion < node.version && history.length !== node.version - op2.baseVersion) {
+      return reject(op2, LIVE_TEXT_HISTORY_TOO_OLD_REASON);
+    }
+    const acceptedOps = history.flatMap((entry) => entry.ops);
+    const ops = acceptedOps.length > 0 ? transformTextOperations(op2.ops, acceptedOps, "after") : op2.ops;
+    const version = node.version + 1;
+    const data = applyLiveTextOperations(node.data, ops);
+    this.driver.set_child(
+      op2.id,
+      {
+        ...node,
+        data,
+        version
+      },
+      true
+    );
+    this.driver.append_live_text_history({
+      nodeId: op2.id,
+      baseVersion: node.version,
+      version,
+      opId: op2.opId,
+      ops: [...ops]
+    });
+    this.driver.purge_live_text_history_before(
+      op2.id,
+      Math.max(0, version - LIVE_TEXT_HISTORY_LIMIT + 1)
+    );
+    return accept({ ...op2, baseVersion: node.version, version, ops: [...ops] });
+  }
   applyDeleteCrdtOp(op2) {
     this.driver.delete_node(op2.id);
     return accept(op2);
@@ -2157,7 +2401,7 @@ function isLeasedSessionExpired(leasedSession) {
 
 // src/Room.ts
 var MB = 1024 * 1024;
-var messagesDecoder = array3(clientMsgDecoder);
+var messagesDecoder = array4(clientMsgDecoder);
 var ServerMsgCode2 = { ...CoreServerMsgCode, ...FeedMsgCode };
 var HIGHEST_PROTOCOL_VERSION = Math.max(
   ...Object.values(ProtocolVersion).filter(
@@ -3128,9 +3372,11 @@ var Room = class {
               case "ignored":
                 return r.ignoredOpId !== void 0 ? [ackIgnoredOp(r.ignoredOpId)] : [];
               case "rectified":
-                return [r.ackOp, r.fix];
+                return r.fix !== void 0 ? [r.ackOp, r.fix] : [r.ackOp];
               case "accepted":
                 return r.fix !== void 0 ? [r.fix] : [];
+              case "rejected":
+                return [];
               // istanbul ignore next
               default:
                 return assertNever3(r, "Unhandled case");
@@ -3153,6 +3399,13 @@ var Room = class {
             ops: opsToSendBack
           });
         }
+        for (const rejected of result.filter((r) => r.action === "rejected")) {
+          replyImmediately({
+            type: ServerMsgCode2.REJECT_STORAGE_OP,
+            opIds: rejected.opIds,
+            reason: rejected.reason
+          });
+        }
         if (opsToForward.length > 0) {
           const p$ = this.hooks.postClientMsgStorageDidUpdate?.(ctx, session);
           if (p$) defer(p$);