@liveblocks/core 3.19.3 → 3.19.5-rc1

package/dist/index.d.cts

@@ -454,40 +454,40 @@ type UpdateObjectOp = {
 type CreateObjectOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_OBJECT;
     readonly parentId: string;
     readonly parentKey: string;
     readonly data: JsonObject;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateListOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_LIST;
     readonly parentId: string;
     readonly parentKey: string;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateMapOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_MAP;
     readonly parentId: string;
     readonly parentKey: string;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateRegisterOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_REGISTER;
     readonly parentId: string;
     readonly parentKey: string;
     readonly data: Json;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type DeleteCrdtOp = {
     readonly opId?: string;
@@ -519,6 +519,7 @@ type HasOpId = {
  * acknowledge the receipt.
  */
 type ClientWireOp = Op & HasOpId;
+type ClientWireCreateOp = CreateOp & HasOpId;
 /**
  * ServerWireOp: Ops sent from server → client. Three variants:
  * 1. ClientWireOp — Full echo back of our own op, confirming it was applied
@@ -864,6 +865,21 @@ type LiveListUpdate = LiveListUpdates<Lson>;
  */
 type StorageUpdate = LiveMapUpdate | LiveObjectUpdate | LiveListUpdate;
 
+/**
+ * Read-only query surface over {@link UnacknowledgedOps}, handed to CRDTs so
+ * they can look up their own still-pending Create ops without being able to
+ * mutate the set (only the room adds/acks).
+ */
+interface ReadonlyUnacknowledgedOps {
+    /** Still-unacknowledged Create ops whose `parentId` is the given one. */
+    getByParentId(parentId: string): Iterable<ClientWireCreateOp>;
+    /**
+     * Still-unacknowledged Create ops whose `parentId` and `parentKey` are both
+     * the given ones (i.e. targeting one exact position).
+     */
+    getByParentIdAndKey(parentId: string, parentKey: string): Iterable<ClientWireCreateOp>;
+}
+
 /**
  * The managed pool is a namespace registry (i.e. a context) that "owns" all
  * the individual live nodes, ensuring each one has a unique ID, and holding on
@@ -892,6 +908,11 @@ interface ManagedPool {
      * @returns {void}
      */
     assertStorageIsWritable: () => void;
+    /**
+     * Read-only view of the client's still-unacknowledged ops (sent or
+     * pending-send, not yet confirmed by the server).
+     */
+    readonly unacknowledgedOps: ReadonlyUnacknowledgedOps;
 }
 type CreateManagedPoolOptions = {
     /**
@@ -911,6 +932,13 @@ type CreateManagedPoolOptions = {
      * have an effect upstream.
      */
     isStorageWritable?: () => boolean;
+    /**
+     * Read-only view of the client's still-unacknowledged ops. Used by CRDTs
+     * (e.g. LiveList) to know which of their optimistic mutations the server
+     * hasn't confirmed yet. Defaults to an empty view (e.g. server-side pools
+     * that dispatch-and-flush have no optimistic state to track).
+     */
+    unacknowledgedOps?: ReadonlyUnacknowledgedOps;
 };
 /**
  * @private Private API, never use this API directly.
@@ -5457,6 +5485,13 @@ declare class SortedList<T> {
     reposition(value: T): number;
     at(index: number): T | undefined;
     get length(): number;
+    /**
+     * Whether the given value is present, by identity. O(log n) plus the length
+     * of any run of items that share its sort key (normally 1). Bisects on the
+     * value's own key, so it only finds values sitting at their sorted position,
+     * which is true for any item currently in the list.
+     */
+    includes(value: T): boolean;
     filter(predicate: (value: T) => boolean): IterableIterator<T>;
     findAllRight(predicate: (value: T, index: number) => unknown): IterableIterator<T>;
     [Symbol.iterator](): IterableIterator<T>;

package/dist/index.d.ts

@@ -454,40 +454,40 @@ type UpdateObjectOp = {
 type CreateObjectOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_OBJECT;
     readonly parentId: string;
     readonly parentKey: string;
     readonly data: JsonObject;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateListOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_LIST;
     readonly parentId: string;
     readonly parentKey: string;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateMapOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_MAP;
     readonly parentId: string;
     readonly parentKey: string;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type CreateRegisterOp = {
     readonly opId?: string;
     readonly id: string;
-    readonly intent?: "set";
-    readonly deletedId?: string;
     readonly type: OpCode.CREATE_REGISTER;
     readonly parentId: string;
     readonly parentKey: string;
     readonly data: Json;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
 };
 type DeleteCrdtOp = {
     readonly opId?: string;
@@ -519,6 +519,7 @@ type HasOpId = {
  * acknowledge the receipt.
  */
 type ClientWireOp = Op & HasOpId;
+type ClientWireCreateOp = CreateOp & HasOpId;
 /**
  * ServerWireOp: Ops sent from server → client. Three variants:
  * 1. ClientWireOp — Full echo back of our own op, confirming it was applied
@@ -864,6 +865,21 @@ type LiveListUpdate = LiveListUpdates<Lson>;
  */
 type StorageUpdate = LiveMapUpdate | LiveObjectUpdate | LiveListUpdate;
 
+/**
+ * Read-only query surface over {@link UnacknowledgedOps}, handed to CRDTs so
+ * they can look up their own still-pending Create ops without being able to
+ * mutate the set (only the room adds/acks).
+ */
+interface ReadonlyUnacknowledgedOps {
+    /** Still-unacknowledged Create ops whose `parentId` is the given one. */
+    getByParentId(parentId: string): Iterable<ClientWireCreateOp>;
+    /**
+     * Still-unacknowledged Create ops whose `parentId` and `parentKey` are both
+     * the given ones (i.e. targeting one exact position).
+     */
+    getByParentIdAndKey(parentId: string, parentKey: string): Iterable<ClientWireCreateOp>;
+}
+
 /**
  * The managed pool is a namespace registry (i.e. a context) that "owns" all
  * the individual live nodes, ensuring each one has a unique ID, and holding on
@@ -892,6 +908,11 @@ interface ManagedPool {
      * @returns {void}
      */
     assertStorageIsWritable: () => void;
+    /**
+     * Read-only view of the client's still-unacknowledged ops (sent or
+     * pending-send, not yet confirmed by the server).
+     */
+    readonly unacknowledgedOps: ReadonlyUnacknowledgedOps;
 }
 type CreateManagedPoolOptions = {
     /**
@@ -911,6 +932,13 @@ type CreateManagedPoolOptions = {
      * have an effect upstream.
      */
     isStorageWritable?: () => boolean;
+    /**
+     * Read-only view of the client's still-unacknowledged ops. Used by CRDTs
+     * (e.g. LiveList) to know which of their optimistic mutations the server
+     * hasn't confirmed yet. Defaults to an empty view (e.g. server-side pools
+     * that dispatch-and-flush have no optimistic state to track).
+     */
+    unacknowledgedOps?: ReadonlyUnacknowledgedOps;
 };
 /**
  * @private Private API, never use this API directly.
@@ -5457,6 +5485,13 @@ declare class SortedList<T> {
     reposition(value: T): number;
     at(index: number): T | undefined;
     get length(): number;
+    /**
+     * Whether the given value is present, by identity. O(log n) plus the length
+     * of any run of items that share its sort key (normally 1). Bisects on the
+     * value's own key, so it only finds values sitting at their sorted position,
+     * which is true for any item currently in the list.
+     */
+    includes(value: T): boolean;
     filter(predicate: (value: T) => boolean): IterableIterator<T>;
     findAllRight(predicate: (value: T, index: number) => unknown): IterableIterator<T>;
     [Symbol.iterator](): IterableIterator<T>;