@liveblocks/server 1.6.0 → 1.6.2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
+import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, CreateOp, HasOpId, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
 export { BroadcastEventClientMsg, ClientMsg, ClientWireOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, FetchYDocClientMsg, HasOpId, IgnoredOp, Op, RoomStateServerMsg, ServerMsg, ServerWireOp, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UpdateYDocClientMsg } from '@liveblocks/core';
 import * as decoders from 'decoders';
 import { Decoder } from 'decoders';
@@ -1121,7 +1121,18 @@ declare class Logger {
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 
-type ApplyOpResult = OpAccepted | OpIgnored;
+/**
+ * The three possible outcomes of applying a client op. They differ along
+ * when the op (first) changed storage state, who hears about it, and what
+ * gets sent back to the originating client:
+ *
+ * |             | state change | fan out to others | reply to sender  |
+ * |-------------|--------------|-------------------|------------------|
+ * | OpAccepted  | now          | yes               | ack echo (+ fix) |
+ * | OpRectified | in the past  | no                | ack echo + fix   |
+ * | OpIgnored   | never        | no                | bare (H)Ack      |
+ */
+type ApplyOpResult = OpAccepted | OpIgnored | OpRectified;
 type OpAccepted = {
     action: "accepted";
     op: ClientWireOp;
@@ -1131,6 +1142,24 @@ type OpIgnored = {
     action: "ignored";
     ignoredOpId?: string;
 };
+type OpRectified = {
+    action: "rectified";
+    /**
+     * Echo of the client's op, with the stored, authoritative parentKey. Sent
+     * back to the originating client as the acknowledgement, instead of the
+     * bare (H)Ack. Used for re-sent CREATE ops whose node the server already
+     * stored: the echo carries the authoritative position, so the client can
+     * correct any optimistic local position it may have predicted while the op
+     * was pending. Never fanned out to others: they already received the op
+     * when it was originally accepted.
+     */
+    ackOp: CreateOp & HasOpId;
+    /**
+     * A corrective op to send back to the originating client, stating that
+     * same authoritative position (see ackOp).
+     */
+    fix: FixOp;
+};
 declare class Storage {
     readonly driver: IStorageDriver;
     constructor(driver: IStorageDriver);
@@ -1410,7 +1439,7 @@ type RoomOptions<SM, CM extends JsonObject, C> = {
          * Therefore, only ever use this hook to implement a side effect (like
          * trigger a notification), don't read storage in this hook directly.
          */
-        postClientMsgStorageDidUpdate?: (ctx?: C) => void | Promise<void>;
+        postClientMsgStorageDidUpdate?: (ctx?: C, sess?: BrowserSession<SM, CM>) => void | Promise<void>;
         /**
          * Called when Yjs Storage for the room was updated.
          *
@@ -1782,6 +1811,33 @@ declare class NestedMap<K1, K2, V> {
     deleteAll(key1: K1): void;
 }
 
+/**
+ * Copyright (c) Liveblocks Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+/**
+ * Compares two semver-ish version strings (`major.minor.patch` with an optional
+ * `-prerelease` suffix). Returns a negative number if `a < b`, a positive number
+ * if `a > b`, and `0` if they're equal.
+ *
+ * Missing numeric components are treated as `0`, so `"3.21"` and `"3.21.0"`
+ * compare equal. A final release outranks any of its prereleases
+ * (`"3.14.0" > "3.14.0-rc1"`); prereleases are otherwise compared lexically.
+ */
+declare function cmpSemver(a: string, b: string): number;
+
 /**
  * Copyright (c) Liveblocks Inc.
  *
@@ -1938,4 +1994,4 @@ declare class InMemoryDriver implements IStorageDriver {
     private _loadNodesApi;
 }
 
-export { type ActorID, type AddFeedClientMsg, type AddFeedMessageClientMsg, BackendSession, BrowserSession, ConsoleTarget, type CreateTicketOptions, DefaultMap, type DeleteFeedClientMsg, type DeleteFeedMessageClientMsg, type Feed, type FeedDeletedServerMsg, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesServerMsg, type FeedMessagesUpdatedServerMsg, FeedMsgCode, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedsAddedServerMsg, type FeedsListServerMsg, type FeedsServerMsg, type FeedsUpdatedServerMsg, type FetchFeedMessagesClientMsg, type FetchFeedsClientMsg, type FixOp, type Guid, type IReadableSnapshot, type IServerWebSocket, type IStorageDriver, type IUserData, InMemoryDriver, type LeasedSession, type ListFeedMessagesOptions, type ListFeedMessagesResult, type ListFeedsOptions, type ListFeedsResult, LogLevel, LogTarget, Logger, type MetadataDB, type Millis, NestedMap, type NodeMap, type NodeStream, type NodeTuple, type Pos, ProtocolVersion, ROOT_YDOC_ID, Room, type SessionKey, type Ticket, UniqueMap, type UpdateFeedClientMsg, type UpdateFeedMessageClientMsg, type YDocId, type YUpdate, type YVector, ackIgnoredOp, clientMsgDecoder, concatUint8Arrays, feedFailureServerMsg, feedMetadataIdDecoder, feedMetadataUpdateDecoder, feedRequestFailed, fetchFeedsMetadataFilterDecoder, guidDecoder, isLeasedSessionExpired, jsonObjectYolo, jsonYolo, type jstring, makeInMemorySnapshot, makeMetadataDB, mapFeedError, optionalFeedMetadataDecoder, plainLsonToNodeStream, protocolVersionDecoder, quote, serialize as serializeServerMsg, snapshotToLossyJson_eager, snapshotToLossyJson_lazy, snapshotToNodeStream, snapshotToPlainLson_eager, snapshotToPlainLson_lazy, Storage as test_only__Storage, YjsStorage as test_only__YjsStorage, transientClientMsgDecoder, tryCatch };
+export { type ActorID, type AddFeedClientMsg, type AddFeedMessageClientMsg, BackendSession, BrowserSession, ConsoleTarget, type CreateTicketOptions, DefaultMap, type DeleteFeedClientMsg, type DeleteFeedMessageClientMsg, type Feed, type FeedDeletedServerMsg, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesServerMsg, type FeedMessagesUpdatedServerMsg, FeedMsgCode, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedsAddedServerMsg, type FeedsListServerMsg, type FeedsServerMsg, type FeedsUpdatedServerMsg, type FetchFeedMessagesClientMsg, type FetchFeedsClientMsg, type FixOp, type Guid, type IReadableSnapshot, type IServerWebSocket, type IStorageDriver, type IUserData, InMemoryDriver, type LeasedSession, type ListFeedMessagesOptions, type ListFeedMessagesResult, type ListFeedsOptions, type ListFeedsResult, LogLevel, LogTarget, Logger, type MetadataDB, type Millis, NestedMap, type NodeMap, type NodeStream, type NodeTuple, type Pos, ProtocolVersion, ROOT_YDOC_ID, Room, type SessionKey, type Ticket, UniqueMap, type UpdateFeedClientMsg, type UpdateFeedMessageClientMsg, type YDocId, type YUpdate, type YVector, ackIgnoredOp, clientMsgDecoder, cmpSemver, concatUint8Arrays, feedFailureServerMsg, feedMetadataIdDecoder, feedMetadataUpdateDecoder, feedRequestFailed, fetchFeedsMetadataFilterDecoder, guidDecoder, isLeasedSessionExpired, jsonObjectYolo, jsonYolo, type jstring, makeInMemorySnapshot, makeMetadataDB, mapFeedError, optionalFeedMetadataDecoder, plainLsonToNodeStream, protocolVersionDecoder, quote, serialize as serializeServerMsg, snapshotToLossyJson_eager, snapshotToLossyJson_lazy, snapshotToNodeStream, snapshotToPlainLson_eager, snapshotToPlainLson_lazy, Storage as test_only__Storage, YjsStorage as test_only__YjsStorage, transientClientMsgDecoder, tryCatch };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
+import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, CreateOp, HasOpId, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
 export { BroadcastEventClientMsg, ClientMsg, ClientWireOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, FetchYDocClientMsg, HasOpId, IgnoredOp, Op, RoomStateServerMsg, ServerMsg, ServerWireOp, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UpdateYDocClientMsg } from '@liveblocks/core';
 import * as decoders from 'decoders';
 import { Decoder } from 'decoders';
@@ -1121,7 +1121,18 @@ declare class Logger {
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 
-type ApplyOpResult = OpAccepted | OpIgnored;
+/**
+ * The three possible outcomes of applying a client op. They differ along
+ * when the op (first) changed storage state, who hears about it, and what
+ * gets sent back to the originating client:
+ *
+ * |             | state change | fan out to others | reply to sender  |
+ * |-------------|--------------|-------------------|------------------|
+ * | OpAccepted  | now          | yes               | ack echo (+ fix) |
+ * | OpRectified | in the past  | no                | ack echo + fix   |
+ * | OpIgnored   | never        | no                | bare (H)Ack      |
+ */
+type ApplyOpResult = OpAccepted | OpIgnored | OpRectified;
 type OpAccepted = {
     action: "accepted";
     op: ClientWireOp;
@@ -1131,6 +1142,24 @@ type OpIgnored = {
     action: "ignored";
     ignoredOpId?: string;
 };
+type OpRectified = {
+    action: "rectified";
+    /**
+     * Echo of the client's op, with the stored, authoritative parentKey. Sent
+     * back to the originating client as the acknowledgement, instead of the
+     * bare (H)Ack. Used for re-sent CREATE ops whose node the server already
+     * stored: the echo carries the authoritative position, so the client can
+     * correct any optimistic local position it may have predicted while the op
+     * was pending. Never fanned out to others: they already received the op
+     * when it was originally accepted.
+     */
+    ackOp: CreateOp & HasOpId;
+    /**
+     * A corrective op to send back to the originating client, stating that
+     * same authoritative position (see ackOp).
+     */
+    fix: FixOp;
+};
 declare class Storage {
     readonly driver: IStorageDriver;
     constructor(driver: IStorageDriver);
@@ -1410,7 +1439,7 @@ type RoomOptions<SM, CM extends JsonObject, C> = {
          * Therefore, only ever use this hook to implement a side effect (like
          * trigger a notification), don't read storage in this hook directly.
          */
-        postClientMsgStorageDidUpdate?: (ctx?: C) => void | Promise<void>;
+        postClientMsgStorageDidUpdate?: (ctx?: C, sess?: BrowserSession<SM, CM>) => void | Promise<void>;
         /**
          * Called when Yjs Storage for the room was updated.
          *
@@ -1782,6 +1811,33 @@ declare class NestedMap<K1, K2, V> {
     deleteAll(key1: K1): void;
 }
 
+/**
+ * Copyright (c) Liveblocks Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+/**
+ * Compares two semver-ish version strings (`major.minor.patch` with an optional
+ * `-prerelease` suffix). Returns a negative number if `a < b`, a positive number
+ * if `a > b`, and `0` if they're equal.
+ *
+ * Missing numeric components are treated as `0`, so `"3.21"` and `"3.21.0"`
+ * compare equal. A final release outranks any of its prereleases
+ * (`"3.14.0" > "3.14.0-rc1"`); prereleases are otherwise compared lexically.
+ */
+declare function cmpSemver(a: string, b: string): number;
+
 /**
  * Copyright (c) Liveblocks Inc.
  *
@@ -1938,4 +1994,4 @@ declare class InMemoryDriver implements IStorageDriver {
     private _loadNodesApi;
 }
 
-export { type ActorID, type AddFeedClientMsg, type AddFeedMessageClientMsg, BackendSession, BrowserSession, ConsoleTarget, type CreateTicketOptions, DefaultMap, type DeleteFeedClientMsg, type DeleteFeedMessageClientMsg, type Feed, type FeedDeletedServerMsg, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesServerMsg, type FeedMessagesUpdatedServerMsg, FeedMsgCode, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedsAddedServerMsg, type FeedsListServerMsg, type FeedsServerMsg, type FeedsUpdatedServerMsg, type FetchFeedMessagesClientMsg, type FetchFeedsClientMsg, type FixOp, type Guid, type IReadableSnapshot, type IServerWebSocket, type IStorageDriver, type IUserData, InMemoryDriver, type LeasedSession, type ListFeedMessagesOptions, type ListFeedMessagesResult, type ListFeedsOptions, type ListFeedsResult, LogLevel, LogTarget, Logger, type MetadataDB, type Millis, NestedMap, type NodeMap, type NodeStream, type NodeTuple, type Pos, ProtocolVersion, ROOT_YDOC_ID, Room, type SessionKey, type Ticket, UniqueMap, type UpdateFeedClientMsg, type UpdateFeedMessageClientMsg, type YDocId, type YUpdate, type YVector, ackIgnoredOp, clientMsgDecoder, concatUint8Arrays, feedFailureServerMsg, feedMetadataIdDecoder, feedMetadataUpdateDecoder, feedRequestFailed, fetchFeedsMetadataFilterDecoder, guidDecoder, isLeasedSessionExpired, jsonObjectYolo, jsonYolo, type jstring, makeInMemorySnapshot, makeMetadataDB, mapFeedError, optionalFeedMetadataDecoder, plainLsonToNodeStream, protocolVersionDecoder, quote, serialize as serializeServerMsg, snapshotToLossyJson_eager, snapshotToLossyJson_lazy, snapshotToNodeStream, snapshotToPlainLson_eager, snapshotToPlainLson_lazy, Storage as test_only__Storage, YjsStorage as test_only__YjsStorage, transientClientMsgDecoder, tryCatch };
+export { type ActorID, type AddFeedClientMsg, type AddFeedMessageClientMsg, BackendSession, BrowserSession, ConsoleTarget, type CreateTicketOptions, DefaultMap, type DeleteFeedClientMsg, type DeleteFeedMessageClientMsg, type Feed, type FeedDeletedServerMsg, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesServerMsg, type FeedMessagesUpdatedServerMsg, FeedMsgCode, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedsAddedServerMsg, type FeedsListServerMsg, type FeedsServerMsg, type FeedsUpdatedServerMsg, type FetchFeedMessagesClientMsg, type FetchFeedsClientMsg, type FixOp, type Guid, type IReadableSnapshot, type IServerWebSocket, type IStorageDriver, type IUserData, InMemoryDriver, type LeasedSession, type ListFeedMessagesOptions, type ListFeedMessagesResult, type ListFeedsOptions, type ListFeedsResult, LogLevel, LogTarget, Logger, type MetadataDB, type Millis, NestedMap, type NodeMap, type NodeStream, type NodeTuple, type Pos, ProtocolVersion, ROOT_YDOC_ID, Room, type SessionKey, type Ticket, UniqueMap, type UpdateFeedClientMsg, type UpdateFeedMessageClientMsg, type YDocId, type YUpdate, type YVector, ackIgnoredOp, clientMsgDecoder, cmpSemver, concatUint8Arrays, feedFailureServerMsg, feedMetadataIdDecoder, feedMetadataUpdateDecoder, feedRequestFailed, fetchFeedsMetadataFilterDecoder, guidDecoder, isLeasedSessionExpired, jsonObjectYolo, jsonYolo, type jstring, makeInMemorySnapshot, makeMetadataDB, mapFeedError, optionalFeedMetadataDecoder, plainLsonToNodeStream, protocolVersionDecoder, quote, serialize as serializeServerMsg, snapshotToLossyJson_eager, snapshotToLossyJson_lazy, snapshotToNodeStream, snapshotToPlainLson_eager, snapshotToPlainLson_lazy, Storage as test_only__Storage, YjsStorage as test_only__YjsStorage, transientClientMsgDecoder, tryCatch };

package/dist/index.js

@@ -1563,6 +1563,13 @@ function accept(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 nodeFromCreateChildOp(op2) {
   switch (op2.type) {
     case OpCode2.CREATE_LIST:
@@ -1652,6 +1659,12 @@ var Storage = class {
   }
   applyCreateOp(op2) {
     if (this.driver.has_node(op2.id)) {
+      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 ignore(op2);
     }
     const node = nodeFromCreateChildOp(op2);
@@ -3109,17 +3122,21 @@ var Room = class {
         const opsToForward = result.flatMap(
           (r) => r.action === "accepted" ? [r.op] : []
         );
-        const opsToSendBack = result.flatMap((r) => {
-          switch (r.action) {
-            case "ignored":
-              return r.ignoredOpId !== void 0 ? [ackIgnoredOp(r.ignoredOpId)] : [];
-            case "accepted":
-              return r.fix !== void 0 ? [r.fix] : [];
-            // istanbul ignore next
-            default:
-              return assertNever3(r, "Unhandled case");
+        const opsToSendBack = result.flatMap(
+          (r) => {
+            switch (r.action) {
+              case "ignored":
+                return r.ignoredOpId !== void 0 ? [ackIgnoredOp(r.ignoredOpId)] : [];
+              case "rectified":
+                return [r.ackOp, r.fix];
+              case "accepted":
+                return r.fix !== void 0 ? [r.fix] : [];
+              // istanbul ignore next
+              default:
+                return assertNever3(r, "Unhandled case");
+            }
           }
-        });
+        );
         if (opsToForward.length > 0) {
           scheduleFanOut({
             type: ServerMsgCode2.UPDATE_STORAGE,
@@ -3137,7 +3154,7 @@ var Room = class {
           });
         }
         if (opsToForward.length > 0) {
-          const p$ = this.hooks.postClientMsgStorageDidUpdate?.(ctx);
+          const p$ = this.hooks.postClientMsgStorageDidUpdate?.(ctx, session);
           if (p$) defer(p$);
         }
         break;
@@ -3378,6 +3395,23 @@ var Room = class {
 };
 _logger = new WeakMap();
 __debug2 = new WeakMap();
+
+// src/lib/semver.ts
+function cmpSemver(a, b) {
+  const [coreA = "", preA] = a.split("-", 2);
+  const [coreB = "", preB] = b.split("-", 2);
+  const partsA = coreA.split(".").map(Number);
+  const partsB = coreB.split(".").map(Number);
+  for (let i = 0; i < 3; i++) {
+    const pa = partsA[i] ?? 0;
+    const pb = partsB[i] ?? 0;
+    if (pa !== pb) return pa - pb;
+  }
+  if (!preA && preB) return 1;
+  if (preA && !preB) return -1;
+  if (preA && preB) return preA < preB ? -1 : preA > preB ? 1 : 0;
+  return 0;
+}
 export {
   BackendSession,
   BrowserSession,
@@ -3396,6 +3430,7 @@ export {
   UniqueMap,
   ackIgnoredOp,
   clientMsgDecoder,
+  cmpSemver,
   concatUint8Arrays,
   feedFailureServerMsg,
   feedMetadataIdDecoder,