@liveblocks/client 0.15.0-alpha.3 → 0.15.1

package/lib/cjs/utils.js

@@ -1,225 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findNonSerializableValue = exports.mergeStorageUpdates = exports.getTreesDiffOperations = exports.selfOrRegister = exports.selfOrRegisterValue = exports.isCrdt = exports.deserialize = exports.isSameNodeOrChildOf = exports.remove = void 0;
-const live_1 = require("./live");
-const LiveList_1 = require("./LiveList");
-const LiveMap_1 = require("./LiveMap");
-const LiveObject_1 = require("./LiveObject");
-const LiveRegister_1 = require("./LiveRegister");
-function remove(array, item) {
-    for (let i = 0; i < array.length; i++) {
-        if (array[i] === item) {
-            array.splice(i, 1);
-            break;
-        }
-    }
-}
-exports.remove = remove;
-function isSameNodeOrChildOf(node, parent) {
-    if (node === parent) {
-        return true;
-    }
-    if (node._parent) {
-        return isSameNodeOrChildOf(node._parent, parent);
-    }
-    return false;
-}
-exports.isSameNodeOrChildOf = isSameNodeOrChildOf;
-function deserialize(entry, parentToChildren, doc) {
-    switch (entry[1].type) {
-        case live_1.CrdtType.Object: {
-            return LiveObject_1.LiveObject._deserialize(entry, parentToChildren, doc);
-        }
-        case live_1.CrdtType.List: {
-            return LiveList_1.LiveList._deserialize(entry, parentToChildren, doc);
-        }
-        case live_1.CrdtType.Map: {
-            return LiveMap_1.LiveMap._deserialize(entry, parentToChildren, doc);
-        }
-        case live_1.CrdtType.Register: {
-            return LiveRegister_1.LiveRegister._deserialize(entry, parentToChildren, doc);
-        }
-        default: {
-            throw new Error("Unexpected CRDT type");
-        }
-    }
-}
-exports.deserialize = deserialize;
-function isCrdt(obj) {
-    return (obj instanceof LiveObject_1.LiveObject ||
-        obj instanceof LiveMap_1.LiveMap ||
-        obj instanceof LiveList_1.LiveList ||
-        obj instanceof LiveRegister_1.LiveRegister);
-}
-exports.isCrdt = isCrdt;
-function selfOrRegisterValue(obj) {
-    if (obj instanceof LiveRegister_1.LiveRegister) {
-        return obj.data;
-    }
-    return obj;
-}
-exports.selfOrRegisterValue = selfOrRegisterValue;
-function selfOrRegister(obj) {
-    if (obj instanceof LiveObject_1.LiveObject ||
-        obj instanceof LiveMap_1.LiveMap ||
-        obj instanceof LiveList_1.LiveList) {
-        return obj;
-    }
-    else if (obj instanceof LiveRegister_1.LiveRegister) {
-        throw new Error("Internal error. LiveRegister should not be created from selfOrRegister");
-    }
-    else {
-        return new LiveRegister_1.LiveRegister(obj);
-    }
-}
-exports.selfOrRegister = selfOrRegister;
-function getTreesDiffOperations(currentItems, newItems) {
-    const ops = [];
-    currentItems.forEach((_, id) => {
-        if (!newItems.get(id)) {
-            // Delete crdt
-            ops.push({
-                type: live_1.OpType.DeleteCrdt,
-                id: id,
-            });
-        }
-    });
-    newItems.forEach((crdt, id) => {
-        const currentCrdt = currentItems.get(id);
-        if (currentCrdt) {
-            if (crdt.type === live_1.CrdtType.Object) {
-                if (JSON.stringify(crdt.data) !==
-                    JSON.stringify(currentCrdt.data)) {
-                    ops.push({
-                        type: live_1.OpType.UpdateObject,
-                        id: id,
-                        data: crdt.data,
-                    });
-                }
-            }
-            if (crdt.parentKey !== currentCrdt.parentKey) {
-                ops.push({
-                    type: live_1.OpType.SetParentKey,
-                    id: id,
-                    parentKey: crdt.parentKey,
-                });
-            }
-        }
-        else {
-            // new Crdt
-            switch (crdt.type) {
-                case live_1.CrdtType.Register:
-                    ops.push({
-                        type: live_1.OpType.CreateRegister,
-                        id: id,
-                        parentId: crdt.parentId,
-                        parentKey: crdt.parentKey,
-                        data: crdt.data,
-                    });
-                    break;
-                case live_1.CrdtType.List:
-                    ops.push({
-                        type: live_1.OpType.CreateList,
-                        id: id,
-                        parentId: crdt.parentId,
-                        parentKey: crdt.parentKey,
-                    });
-                    break;
-                case live_1.CrdtType.Object:
-                    ops.push({
-                        type: live_1.OpType.CreateObject,
-                        id: id,
-                        parentId: crdt.parentId,
-                        parentKey: crdt.parentKey,
-                        data: crdt.data,
-                    });
-                    break;
-                case live_1.CrdtType.Map:
-                    ops.push({
-                        type: live_1.OpType.CreateMap,
-                        id: id,
-                        parentId: crdt.parentId,
-                        parentKey: crdt.parentKey,
-                    });
-                    break;
-            }
-        }
-    });
-    return ops;
-}
-exports.getTreesDiffOperations = getTreesDiffOperations;
-function mergeStorageUpdates(first, second) {
-    if (!first) {
-        return second;
-    }
-    if (second.type === "LiveObject") {
-        const updates = first.updates;
-        for (const [key, value] of Object.entries(second.updates)) {
-            updates[key] = value;
-        }
-        return Object.assign(Object.assign({}, second), { updates: updates });
-    }
-    else if (second.type === "LiveMap") {
-        const updates = first.updates;
-        for (const [key, value] of Object.entries(second.updates)) {
-            updates[key] = value;
-        }
-        return Object.assign(Object.assign({}, second), { updates: updates });
-    }
-    else if (second.type === "LiveList") {
-        const updates = first.updates;
-        return Object.assign(Object.assign({}, second), { updates: updates.concat(second.updates) });
-    }
-    return second;
-}
-exports.mergeStorageUpdates = mergeStorageUpdates;
-function isPlain(value) {
-    const type = typeof value;
-    return (type === "undefined" ||
-        value === null ||
-        type === "string" ||
-        type === "boolean" ||
-        type === "number" ||
-        Array.isArray(value) ||
-        isPlainObject(value));
-}
-function isPlainObject(value) {
-    if (typeof value !== "object" || value === null)
-        return false;
-    let proto = Object.getPrototypeOf(value);
-    if (proto === null)
-        return true;
-    let baseProto = proto;
-    while (Object.getPrototypeOf(baseProto) !== null) {
-        baseProto = Object.getPrototypeOf(baseProto);
-    }
-    return proto === baseProto;
-}
-function findNonSerializableValue(value, path = "") {
-    if (!isPlain) {
-        return {
-            path: path || "root",
-            value: value,
-        };
-    }
-    if (typeof value !== "object" || value === null) {
-        return false;
-    }
-    for (const [key, nestedValue] of Object.entries(value)) {
-        const nestedPath = path ? path + "." + key : key;
-        if (!isPlain(nestedValue)) {
-            return {
-                path: nestedPath,
-                value: nestedValue,
-            };
-        }
-        if (typeof nestedValue === "object") {
-            const nonSerializableNestedValue = findNonSerializableValue(nestedValue, nestedPath);
-            if (nonSerializableNestedValue) {
-                return nonSerializableNestedValue;
-            }
-        }
-    }
-    return false;
-}
-exports.findNonSerializableValue = findNonSerializableValue;

package/lib/esm/AbstractCrdt.d.ts

@@ -1,68 +0,0 @@
-import { Op, SerializedCrdt } from "./live";
-import { StorageUpdate } from "./types";
-export declare type ApplyResult = {
-    reverse: Op[];
-    modified: StorageUpdate;
-} | {
-    modified: false;
-};
-export interface Doc {
-    generateId: () => string;
-    generateOpId: () => string;
-    getItem: (id: string) => AbstractCrdt | undefined;
-    addItem: (id: string, item: AbstractCrdt) => void;
-    deleteItem: (id: string) => void;
-    dispatch: (ops: Op[], reverseOps: Op[], storageUpdates: Map<string, StorageUpdate>) => void;
-}
-export declare abstract class AbstractCrdt {
-    #private;
-    /**
-     * INTERNAL
-     */
-    protected get _doc(): Doc | undefined;
-    /**
-     * INTERNAL
-     */
-    get _id(): string | undefined;
-    /**
-     * INTERNAL
-     */
-    get _parent(): AbstractCrdt | undefined;
-    /**
-     * INTERNAL
-     */
-    get _parentKey(): string | undefined;
-    /**
-     * INTERNAL
-     */
-    _apply(op: Op, isLocal: boolean): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _setParentLink(parent: AbstractCrdt, key: string): void;
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    /**
-     * INTERNAL
-     */
-    abstract _attachChild(id: string, key: string, crdt: AbstractCrdt, opId: string, isLocal: boolean): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    /**
-     * INTERNAL
-     */
-    abstract _detachChild(crdt: AbstractCrdt): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    abstract _serialize(parentId: string, parentKey: string, doc?: Doc): Op[];
-    /**
-     * INTERNAL
-     */
-    abstract _toSerializedCrdt(): SerializedCrdt;
-    abstract _getType(): string;
-}

package/lib/esm/AbstractCrdt.js

@@ -1,91 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _AbstractCrdt_parent, _AbstractCrdt_doc, _AbstractCrdt_id, _AbstractCrdt_parentKey;
-import { OpType } from "./live";
-export class AbstractCrdt {
-    constructor() {
-        _AbstractCrdt_parent.set(this, void 0);
-        _AbstractCrdt_doc.set(this, void 0);
-        _AbstractCrdt_id.set(this, void 0);
-        _AbstractCrdt_parentKey.set(this, void 0);
-    }
-    /**
-     * INTERNAL
-     */
-    get _doc() {
-        return __classPrivateFieldGet(this, _AbstractCrdt_doc, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    get _id() {
-        return __classPrivateFieldGet(this, _AbstractCrdt_id, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    get _parent() {
-        return __classPrivateFieldGet(this, _AbstractCrdt_parent, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    get _parentKey() {
-        return __classPrivateFieldGet(this, _AbstractCrdt_parentKey, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    _apply(op, isLocal) {
-        switch (op.type) {
-            case OpType.DeleteCrdt: {
-                if (this._parent != null && this._parentKey != null) {
-                    return this._parent._detachChild(this);
-                }
-                return { modified: false };
-            }
-        }
-        return { modified: false };
-    }
-    /**
-     * INTERNAL
-     */
-    _setParentLink(parent, key) {
-        if (__classPrivateFieldGet(this, _AbstractCrdt_parent, "f") != null && __classPrivateFieldGet(this, _AbstractCrdt_parent, "f") !== parent) {
-            throw new Error("Cannot attach parent if it already exist");
-        }
-        __classPrivateFieldSet(this, _AbstractCrdt_parentKey, key, "f");
-        __classPrivateFieldSet(this, _AbstractCrdt_parent, parent, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    _attach(id, doc) {
-        if (__classPrivateFieldGet(this, _AbstractCrdt_id, "f") || __classPrivateFieldGet(this, _AbstractCrdt_doc, "f")) {
-            throw new Error("Cannot attach if CRDT is already attached");
-        }
-        doc.addItem(id, this);
-        __classPrivateFieldSet(this, _AbstractCrdt_id, id, "f");
-        __classPrivateFieldSet(this, _AbstractCrdt_doc, doc, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    _detach() {
-        if (__classPrivateFieldGet(this, _AbstractCrdt_doc, "f") && __classPrivateFieldGet(this, _AbstractCrdt_id, "f")) {
-            __classPrivateFieldGet(this, _AbstractCrdt_doc, "f").deleteItem(__classPrivateFieldGet(this, _AbstractCrdt_id, "f"));
-        }
-        __classPrivateFieldSet(this, _AbstractCrdt_parent, undefined, "f");
-        __classPrivateFieldSet(this, _AbstractCrdt_doc, undefined, "f");
-    }
-}
-_AbstractCrdt_parent = new WeakMap(), _AbstractCrdt_doc = new WeakMap(), _AbstractCrdt_id = new WeakMap(), _AbstractCrdt_parentKey = new WeakMap();

package/lib/esm/LiveList.d.ts

@@ -1,144 +0,0 @@
-import { AbstractCrdt, Doc, ApplyResult } from "./AbstractCrdt";
-import { SerializedList, SerializedCrdtWithId, Op, SerializedCrdt } from "./live";
-/**
- * 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, doc?: Doc): Op[];
-    _indexOfPosition(position: string): number;
-    /**
-     * INTERNAL
-     */
-    _attach(id: string, doc: Doc): void;
-    /**
-     * INTERNAL
-     */
-    _detach(): void;
-    /**
-     * INTERNAL
-     */
-    _attachChild(id: string, key: string, child: AbstractCrdt, opId: string, isLocal: boolean): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _detachChild(child: AbstractCrdt): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _setChildKey(key: string, child: AbstractCrdt, previousKey: string): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _apply(op: Op, isLocal: boolean): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _getType(): string;
-    /**
-     * INTERNAL
-     */
-    _toSerializedCrdt(): SerializedCrdt;
-    /**
-     * 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;
-    clear(): void;
-    /**
-     * Returns an Array of all the elements in the LiveList.
-     */
-    toArray(): T[];
-    toCrdtArray(): AbstractCrdt[];
-    /**
-     * 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>;
-}