@liveblocks/core 3.14.0-pre3 → 3.14.0-pre5

package/dist/index.d.cts

@@ -716,6 +716,7 @@ type ObjectStorageNode = [id: string, value: SerializedObject];
 type ListStorageNode = [id: string, value: SerializedList];
 type MapStorageNode = [id: string, value: SerializedMap];
 type RegisterStorageNode = [id: string, value: SerializedRegister];
+type NodeMap = Map<string, SerializedCrdt>;
 type NodeStream = Iterable<StorageNode>;
 declare function isRootStorageNode(node: StorageNode): node is RootStorageNode;
 declare function isObjectStorageNode(node: StorageNode): node is RootStorageNode | ObjectStorageNode;
@@ -4614,11 +4615,6 @@ declare function convertToSubscriptionData(data: SubscriptionDataPlain): Subscri
 declare function convertToUserSubscriptionData(data: UserSubscriptionDataPlain): UserSubscriptionData;
 declare function convertToGroupData(data: GroupDataPlain): GroupData;
 
-/**
- * Lookup table for nodes (= SerializedCrdt values) by their IDs.
- */
-type NodeMap = Map<string, // Node ID
-SerializedCrdt>;
 /**
  * Reverse lookup table for all child nodes (= list of SerializedCrdt values)
  * by their parent node's IDs.
@@ -5068,6 +5064,9 @@ declare function shallow2(a: unknown, b: unknown): boolean;
 declare class SortedList<T> {
     #private;
     private constructor();
+    /**
+     * Creates an empty SortedList with the given "less than" function.
+     */
     static with<T>(lt: (a: T, b: T) => boolean): SortedList<T>;
     static from<T>(arr: readonly T[], lt: (a: T, b: T) => boolean): SortedList<T>;
     static fromAlreadySorted<T>(alreadySorted: T[], lt: (a: T, b: T) => boolean): SortedList<T>;
@@ -5077,8 +5076,9 @@ declare class SortedList<T> {
     clone(): SortedList<T>;
     /**
      * Adds a new item to the sorted list, such that it remains sorted.
+     * Returns the index where the item was inserted.
      */
-    add(value: T): void;
+    add(value: T): number;
     /**
      * Removes all values from the sorted list, making it empty again.
      * Returns whether the list was mutated or not.
@@ -5097,6 +5097,25 @@ declare class SortedList<T> {
      * Returns whether the list was mutated or not.
      */
     remove(value: T): boolean;
+    /**
+     * Removes the item at the given index.
+     * Returns the removed item, or undefined if index is out of bounds.
+     */
+    removeAt(index: number): T | undefined;
+    /**
+     * Repositions an item to maintain sorted order after its sort key has
+     * been mutated in-place. For example:
+     *
+     *   const item = sorted.at(3);
+     *   item.updatedAt = new Date();  // mutate the item's sort key in-place
+     *   sorted.reposition(item);      // restore sorted order
+     *
+     * Returns the new index of the item. Throws if the item is not in the list.
+     *
+     * Semantically equivalent to remove(value) + add(value), but optimized
+     * to avoid array shifting when the item only moves a short distance.
+     */
+    reposition(value: T): number;
     at(index: number): T | undefined;
     get length(): number;
     filter(predicate: (value: T) => boolean): IterableIterator<T>;

package/dist/index.d.ts

@@ -716,6 +716,7 @@ type ObjectStorageNode = [id: string, value: SerializedObject];
 type ListStorageNode = [id: string, value: SerializedList];
 type MapStorageNode = [id: string, value: SerializedMap];
 type RegisterStorageNode = [id: string, value: SerializedRegister];
+type NodeMap = Map<string, SerializedCrdt>;
 type NodeStream = Iterable<StorageNode>;
 declare function isRootStorageNode(node: StorageNode): node is RootStorageNode;
 declare function isObjectStorageNode(node: StorageNode): node is RootStorageNode | ObjectStorageNode;
@@ -4614,11 +4615,6 @@ declare function convertToSubscriptionData(data: SubscriptionDataPlain): Subscri
 declare function convertToUserSubscriptionData(data: UserSubscriptionDataPlain): UserSubscriptionData;
 declare function convertToGroupData(data: GroupDataPlain): GroupData;
 
-/**
- * Lookup table for nodes (= SerializedCrdt values) by their IDs.
- */
-type NodeMap = Map<string, // Node ID
-SerializedCrdt>;
 /**
  * Reverse lookup table for all child nodes (= list of SerializedCrdt values)
  * by their parent node's IDs.
@@ -5068,6 +5064,9 @@ declare function shallow2(a: unknown, b: unknown): boolean;
 declare class SortedList<T> {
     #private;
     private constructor();
+    /**
+     * Creates an empty SortedList with the given "less than" function.
+     */
     static with<T>(lt: (a: T, b: T) => boolean): SortedList<T>;
     static from<T>(arr: readonly T[], lt: (a: T, b: T) => boolean): SortedList<T>;
     static fromAlreadySorted<T>(alreadySorted: T[], lt: (a: T, b: T) => boolean): SortedList<T>;
@@ -5077,8 +5076,9 @@ declare class SortedList<T> {
     clone(): SortedList<T>;
     /**
      * Adds a new item to the sorted list, such that it remains sorted.
+     * Returns the index where the item was inserted.
      */
-    add(value: T): void;
+    add(value: T): number;
     /**
      * Removes all values from the sorted list, making it empty again.
      * Returns whether the list was mutated or not.
@@ -5097,6 +5097,25 @@ declare class SortedList<T> {
      * Returns whether the list was mutated or not.
      */
     remove(value: T): boolean;
+    /**
+     * Removes the item at the given index.
+     * Returns the removed item, or undefined if index is out of bounds.
+     */
+    removeAt(index: number): T | undefined;
+    /**
+     * Repositions an item to maintain sorted order after its sort key has
+     * been mutated in-place. For example:
+     *
+     *   const item = sorted.at(3);
+     *   item.updatedAt = new Date();  // mutate the item's sort key in-place
+     *   sorted.reposition(item);      // restore sorted order
+     *
+     * Returns the new index of the item. Throws if the item is not in the list.
+     *
+     * Semantically equivalent to remove(value) + add(value), but optimized
+     * to avoid array shifting when the item only moves a short distance.
+     */
+    reposition(value: T): number;
     at(index: number): T | undefined;
     get length(): number;
     filter(predicate: (value: T) => boolean): IterableIterator<T>;