@liveblocks/client 0.12.2 → 0.13.1

package/lib/cjs/doc.d.ts

@@ -1,347 +0,0 @@
-import { Op, SerializedCrdtWithId, SerializedList } from "./live";
-declare type Dispatch = (ops: Op[]) => void;
-export declare class Doc<T extends Record<string, any> = Record<string, any>> {
-    #private;
-    private constructor();
-    static from<T>(root: T, actor?: number, dispatch?: Dispatch): Doc<T>;
-    static load<T>(items: SerializedCrdtWithId[], actor: number, dispatch?: Dispatch): Doc<T>;
-    dispatch(ops: Op[]): void;
-    addItem(id: string, item: AbstractCrdt): void;
-    deleteItem(id: string): void;
-    getItem(id: string): AbstractCrdt | undefined;
-    apply(ops: Op[]): Op[];
-    get root(): LiveObject<T>;
-    addToUndoStack(ops: Op[]): void;
-    undo(): void;
-    redo(): void;
-    count(): number;
-    generateId(): string;
-    generateOpId(): string;
-}
-declare abstract class AbstractCrdt {
-    #private;
-    /**
-     * INTERNAL
-     */
-    protected get _doc(): Doc<Record<string, any>> | undefined;
-    /**
-     * INTERNAL
-     */
-    get _id(): string | undefined;
-    /**
-     * INTERNAL
-     */
-    get _parent(): AbstractCrdt | undefined;
-    /**
-     * INTERNAL
-     */
-    get _parentKey(): string | undefined;
-    _apply(op: Op): Op[];
-    /**
-     * INTERNAL
-     */
-    _setParentLink(parent: AbstractCrdt, key: string): void;
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    abstract _attachChild(id: string, key: string, crdt: AbstractCrdt): Op[];
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    abstract _detachChild(crdt: AbstractCrdt): void;
-    /**
-     * Subscribes to updates.
-     */
-    subscribe(listener: () => void): void;
-    /**
-     * Subscribes to updates and children updates.
-     */
-    subscribeDeep(listener: () => void): void;
-    /**
-     * Unsubscribes to updates.
-     */
-    unsubscribe(listener: () => void): void;
-    /**
-     * Unsubscribes to updates and children updates.
-     */
-    unsubscribeDeep(listener: () => void): void;
-    /**
-     * INTERNAL
-     */
-    _notify(onlyDeep?: boolean): void;
-    abstract _serialize(parentId: string, parentKey: string): Op[];
-}
-/**
- * The LiveObject class is similar to a JavaScript object that is synchronized on all clients.
- * Keys should be a string, and values should be serializable to JSON.
- * If multiple clients update the same property simultaneously, the last modification received by the Liveblocks servers is the winner.
- */
-export declare class LiveObject<T extends Record<string, any> = Record<string, any>> extends AbstractCrdt {
-    #private;
-    constructor(object?: T);
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId?: string, parentKey?: string): Op[];
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item]: SerializedCrdtWithId, parentToChildren: Map<string, SerializedCrdtWithId[]>, doc: Doc): LiveObject<{
-        [key: string]: any;
-    }>;
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    /**
-     * INTERNAL
-     */
-    _attachChild(id: string, key: keyof T, child: AbstractCrdt): Op[];
-    /**
-     * INTERNAL
-     */
-    _detachChild(child: AbstractCrdt): void;
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    /**
-     * INTERNAL
-     */
-    _apply(op: Op): Op[];
-    /**
-     * Transform the LiveObject into a javascript object
-     */
-    toObject(): T;
-    /**
-     * Adds or updates a property with a specified key and a value.
-     * @param key The key of the property to add
-     * @param value The value of the property to add
-     */
-    set<TKey extends keyof T>(key: TKey, value: T[TKey]): void;
-    /**
-     * Returns a specified property from the LiveObject.
-     * @param key The key of the property to get
-     */
-    get<TKey extends keyof T>(key: TKey): T[TKey];
-    /**
-     * Adds or updates multiple properties at once with an object.
-     * @param overrides The object used to overrides properties
-     */
-    update(overrides: Partial<T>): void;
-}
-/**
- * The LiveMap class is similar to a JavaScript Map that is synchronized on all clients.
- * Keys should be a string, and values should be serializable to JSON.
- * If multiple clients update the same property simultaneously, the last modification received by the Liveblocks servers is the winner.
- */
-export declare class LiveMap<TKey extends string, TValue> extends AbstractCrdt {
-    #private;
-    constructor(entries?: readonly (readonly [TKey, TValue])[] | null | undefined);
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId?: string, parentKey?: string): Op[];
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item]: SerializedCrdtWithId, parentToChildren: Map<string, SerializedCrdtWithId[]>, doc: Doc): LiveMap<string, unknown>;
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    /**
-     * INTERNAL
-     */
-    _attachChild(id: string, key: TKey, child: AbstractCrdt): Op[];
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    /**
-     * INTERNAL
-     */
-    _detachChild(child: AbstractCrdt): void;
-    /**
-     * Returns a specified element from the LiveMap.
-     * @param key The key of the element to return.
-     * @returns The element associated with the specified key, or undefined if the key can't be found in the LiveMap.
-     */
-    get(key: TKey): TValue | undefined;
-    /**
-     * Adds or updates an element with a specified key and a value.
-     * @param key The key of the element to add. Should be a string.
-     * @param value The value of the element to add. Should be serializable to JSON.
-     */
-    set(key: TKey, value: TValue): void;
-    /**
-     * Returns the number of elements in the LiveMap.
-     */
-    get size(): number;
-    /**
-     * Returns a boolean indicating whether an element with the specified key exists or not.
-     * @param key The key of the element to test for presence.
-     */
-    has(key: TKey): boolean;
-    /**
-     * Removes the specified element by key.
-     * @param key The key of the element to remove.
-     * @returns true if an element existed and has been removed, or false if the element does not exist.
-     */
-    delete(key: TKey): boolean;
-    /**
-     * Returns a new Iterator object that contains the [key, value] pairs for each element.
-     */
-    entries(): IterableIterator<[string, TValue]>;
-    /**
-     * Same function object as the initial value of the entries method.
-     */
-    [Symbol.iterator](): IterableIterator<[string, TValue]>;
-    /**
-     * Returns a new Iterator object that contains the keys for each element.
-     */
-    keys(): IterableIterator<TKey>;
-    /**
-     * Returns a new Iterator object that contains the values for each element.
-     */
-    values(): IterableIterator<TValue>;
-    /**
-     * Executes a provided function once per each key/value pair in the Map object, in insertion order.
-     * @param callback Function to execute for each entry in the map.
-     */
-    forEach(callback: (value: TValue, key: TKey, map: LiveMap<TKey, TValue>) => void): void;
-}
-/**
- * The LiveList class represents an ordered collection of items that is synchorinized across clients.
- */
-export declare class LiveList<T> extends AbstractCrdt {
-    #private;
-    constructor(items?: T[]);
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item]: [id: string, item: SerializedList], parentToChildren: Map<string, SerializedCrdtWithId[]>, doc: Doc): LiveList<never>;
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId?: string, parentKey?: string): Op[];
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    /**
-     * INTERNAL
-     */
-    _attachChild(id: string, key: string, child: AbstractCrdt): Op[];
-    /**
-     * INTERNAL
-     */
-    _detachChild(child: AbstractCrdt): void;
-    /**
-     * INTERNAL
-     */
-    _setChildKey(key: string, child: AbstractCrdt): void;
-    /**
-     * INTERNAL
-     */
-    _apply(op: Op): Op[];
-    /**
-     * Returns the number of elements.
-     */
-    get length(): number;
-    /**
-     * Adds one element to the end of the LiveList.
-     * @param element The element to add to the end of the LiveList.
-     */
-    push(element: T): void;
-    /**
-     * Inserts one element at a specified index.
-     * @param element The element to insert.
-     * @param index The index at which you want to insert the element.
-     */
-    insert(element: T, index: number): void;
-    /**
-     * Move one element from one index to another.
-     * @param index The index of the element to move
-     * @param targetIndex The index where the element should be after moving.
-     */
-    move(index: number, targetIndex: number): void;
-    /**
-     * Deletes an element at the specified index
-     * @param index The index of the element to delete
-     */
-    delete(index: number): void;
-    /**
-     * Returns an Array of all the elements in the LiveList.
-     */
-    toArray(): T[];
-    /**
-     * Tests whether all elements pass the test implemented by the provided function.
-     * @param predicate Function to test for each element, taking two arguments (the element and its index).
-     * @returns true if the predicate function returns a truthy value for every element. Otherwise, false.
-     */
-    every(predicate: (value: T, index: number) => unknown): boolean;
-    /**
-     * Creates an array with all elements that pass the test implemented by the provided function.
-     * @param predicate Function to test each element of the LiveList. Return a value that coerces to true to keep the element, or to false otherwise.
-     * @returns An array with the elements that pass the test.
-     */
-    filter(predicate: (value: T, index: number) => unknown): T[];
-    /**
-     * Returns the first element that satisfies the provided testing function.
-     * @param predicate Function to execute on each value.
-     * @returns The value of the first element in the LiveList that satisfies the provided testing function. Otherwise, undefined is returned.
-     */
-    find(predicate: (value: T, index: number) => unknown): T | undefined;
-    /**
-     * Returns the index of the first element in the LiveList that satisfies the provided testing function.
-     * @param predicate Function to execute on each value until the function returns true, indicating that the satisfying element was found.
-     * @returns The index of the first element in the LiveList that passes the test. Otherwise, -1.
-     */
-    findIndex(predicate: (value: T, index: number) => unknown): number;
-    /**
-     * Executes a provided function once for each element.
-     * @param callbackfn Function to execute on each element.
-     */
-    forEach(callbackfn: (value: T, index: number) => void): void;
-    /**
-     * Get the element at the specified index.
-     * @param index The index on the element to get.
-     * @returns The element at the specified index or undefined.
-     */
-    get(index: number): T | undefined;
-    /**
-     * Returns the first index at which a given element can be found in the LiveList, or -1 if it is not present.
-     * @param searchElement Element to locate.
-     * @param fromIndex The index to start the search at.
-     * @returns The first index of the element in the LiveList; -1 if not found.
-     */
-    indexOf(searchElement: T, fromIndex?: number): number;
-    /**
-     * Returns the last index at which a given element can be found in the LiveList, or -1 if it is not present. The LiveLsit is searched backwards, starting at fromIndex.
-     * @param searchElement Element to locate.
-     * @param fromIndex The index at which to start searching backwards.
-     * @returns
-     */
-    lastIndexOf(searchElement: T, fromIndex?: number): number;
-    /**
-     * Creates an array populated with the results of calling a provided function on every element.
-     * @param callback Function that is called for every element.
-     * @returns An array with each element being the result of the callback function.
-     */
-    map<U>(callback: (value: T, index: number) => U): U[];
-    /**
-     * Tests whether at least one element in the LiveList passes the test implemented by the provided function.
-     * @param predicate Function to test for each element.
-     * @returns true if the callback function returns a truthy value for at least one element. Otherwise, false.
-     */
-    some(predicate: (value: T, index: number) => unknown): boolean;
-    [Symbol.iterator](): IterableIterator<T>;
-}
-export {};