@liveblocks/client 0.15.0-alpha.2 → 0.15.0

package/lib/esm/LiveObject.js

@@ -1,449 +0,0 @@
-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 __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 _LiveObject_instances, _LiveObject_map, _LiveObject_propToLastUpdate, _LiveObject_applyUpdate, _LiveObject_applyDeleteObjectKey;
-import { AbstractCrdt } from "./AbstractCrdt";
-import { deserialize, isCrdt } from "./utils";
-import { CrdtType, OpType, } from "./live";
-/**
- * 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 class LiveObject extends AbstractCrdt {
-    constructor(object = {}) {
-        super();
-        _LiveObject_instances.add(this);
-        _LiveObject_map.set(this, void 0);
-        _LiveObject_propToLastUpdate.set(this, new Map());
-        for (const key in object) {
-            const value = object[key];
-            if (value instanceof AbstractCrdt) {
-                value._setParentLink(this, key);
-            }
-        }
-        __classPrivateFieldSet(this, _LiveObject_map, new Map(Object.entries(object)), "f");
-    }
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId, parentKey, doc) {
-        if (this._id == null) {
-            throw new Error("Cannot serialize item is not attached");
-        }
-        const ops = [];
-        const op = {
-            id: this._id,
-            opId: doc === null || doc === void 0 ? void 0 : doc.generateOpId(),
-            type: OpType.CreateObject,
-            parentId,
-            parentKey,
-            data: {},
-        };
-        ops.push(op);
-        for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
-            if (value instanceof AbstractCrdt) {
-                ops.push(...value._serialize(this._id, key, doc));
-            }
-            else {
-                op.data[key] = value;
-            }
-        }
-        return ops;
-    }
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item], parentToChildren, doc) {
-        if (item.type !== CrdtType.Object) {
-            throw new Error(`Tried to deserialize a record but item type is "${item.type}"`);
-        }
-        const object = new LiveObject(item.data);
-        object._attach(id, doc);
-        return this._deserializeChildren(object, parentToChildren, doc);
-    }
-    /**
-     * INTERNAL
-     */
-    static _deserializeChildren(object, parentToChildren, doc) {
-        const children = parentToChildren.get(object._id);
-        if (children == null) {
-            return object;
-        }
-        for (const entry of children) {
-            const crdt = entry[1];
-            if (crdt.parentKey == null) {
-                throw new Error("Tried to deserialize a crdt but it does not have a parentKey and is not the root");
-            }
-            const child = deserialize(entry, parentToChildren, doc);
-            child._setParentLink(object, crdt.parentKey);
-            __classPrivateFieldGet(object, _LiveObject_map, "f").set(crdt.parentKey, child);
-        }
-        return object;
-    }
-    /**
-     * INTERNAL
-     */
-    _attach(id, doc) {
-        super._attach(id, doc);
-        for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
-            if (value instanceof AbstractCrdt) {
-                value._attach(doc.generateId(), doc);
-            }
-        }
-    }
-    /**
-     * INTERNAL
-     */
-    _attachChild(id, key, child, isLocal) {
-        if (this._doc == null) {
-            throw new Error("Can't attach child if doc is not present");
-        }
-        const previousValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-        let reverse;
-        if (isCrdt(previousValue)) {
-            reverse = previousValue._serialize(this._id, key);
-            previousValue._detach();
-        }
-        else if (previousValue === undefined) {
-            reverse = [
-                { type: OpType.DeleteObjectKey, id: this._id, key: key },
-            ];
-        }
-        else {
-            reverse = [
-                {
-                    type: OpType.UpdateObject,
-                    id: this._id,
-                    data: { [key]: previousValue },
-                },
-            ];
-        }
-        __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, child);
-        child._setParentLink(this, key);
-        child._attach(id, this._doc);
-        return {
-            reverse,
-            modified: {
-                node: this,
-                type: "LiveObject",
-                updates: { [key]: { type: "update" } },
-            },
-        };
-    }
-    /**
-     * INTERNAL
-     */
-    _detachChild(child) {
-        if (child) {
-            const reverse = child._serialize(this._id, child._parentKey, this._doc);
-            for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
-                if (value === child) {
-                    __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
-                }
-            }
-            child._detach();
-            const storageUpdate = {
-                node: this,
-                type: "LiveObject",
-                updates: {
-                    [child._parentKey]: { type: "delete" },
-                },
-            };
-            return { modified: storageUpdate, reverse };
-        }
-        return { modified: false };
-    }
-    /**
-     * INTERNAL
-     */
-    _detachChildren() {
-        for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
-            __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
-            value._detach();
-        }
-    }
-    /**
-     * INTERNAL
-     */
-    _detach() {
-        super._detach();
-        for (const value of __classPrivateFieldGet(this, _LiveObject_map, "f").values()) {
-            if (isCrdt(value)) {
-                value._detach();
-            }
-        }
-    }
-    /**
-     * INTERNAL
-     */
-    _apply(op, isLocal) {
-        if (op.type === OpType.UpdateObject) {
-            return __classPrivateFieldGet(this, _LiveObject_instances, "m", _LiveObject_applyUpdate).call(this, op, isLocal);
-        }
-        else if (op.type === OpType.DeleteObjectKey) {
-            return __classPrivateFieldGet(this, _LiveObject_instances, "m", _LiveObject_applyDeleteObjectKey).call(this, op);
-        }
-        return super._apply(op, isLocal);
-    }
-    /**
-     * INTERNAL
-     */
-    _toSerializedCrdt() {
-        var _a;
-        return {
-            type: CrdtType.Object,
-            parentId: (_a = this._parent) === null || _a === void 0 ? void 0 : _a._id,
-            parentKey: this._parentKey,
-            data: this.toObject(),
-        };
-    }
-    /**
-     * INTERNAL
-     */
-    _getType() {
-        return "LiveObject";
-    }
-    /**
-     * Transform the LiveObject into a javascript object
-     */
-    toObject() {
-        return Object.fromEntries(__classPrivateFieldGet(this, _LiveObject_map, "f"));
-    }
-    /**
-     * 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(key, value) {
-        // TODO: Find out why typescript complains
-        this.update({ [key]: value });
-    }
-    /**
-     * Returns a specified property from the LiveObject.
-     * @param key The key of the property to get
-     */
-    get(key) {
-        return __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-    }
-    /**
-     * Deletes a key from the LiveObject
-     * @param key The key of the property to delete
-     */
-    delete(key) {
-        const keyAsString = key;
-        const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(keyAsString);
-        if (oldValue === undefined) {
-            return;
-        }
-        if (this._doc == null || this._id == null) {
-            if (oldValue instanceof AbstractCrdt) {
-                oldValue._detach();
-            }
-            __classPrivateFieldGet(this, _LiveObject_map, "f").delete(keyAsString);
-            return;
-        }
-        let reverse;
-        if (oldValue instanceof AbstractCrdt) {
-            oldValue._detach();
-            reverse = oldValue._serialize(this._id, keyAsString);
-        }
-        else {
-            reverse = [
-                {
-                    type: OpType.UpdateObject,
-                    data: { [keyAsString]: oldValue },
-                    id: this._id,
-                },
-            ];
-        }
-        __classPrivateFieldGet(this, _LiveObject_map, "f").delete(keyAsString);
-        const storageUpdates = new Map();
-        storageUpdates.set(this._id, {
-            node: this,
-            type: "LiveObject",
-            updates: { [key]: { type: "delete" } },
-        });
-        this._doc.dispatch([
-            {
-                type: OpType.DeleteObjectKey,
-                key: keyAsString,
-                id: this._id,
-                opId: this._doc.generateOpId(),
-            },
-        ], reverse, storageUpdates);
-    }
-    /**
-     * Adds or updates multiple properties at once with an object.
-     * @param overrides The object used to overrides properties
-     */
-    update(overrides) {
-        if (this._doc == null || this._id == null) {
-            for (const key in overrides) {
-                const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-                if (oldValue instanceof AbstractCrdt) {
-                    oldValue._detach();
-                }
-                const newValue = overrides[key];
-                if (newValue instanceof AbstractCrdt) {
-                    newValue._setParentLink(this, key);
-                }
-                __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, newValue);
-            }
-            return;
-        }
-        const ops = [];
-        const reverseOps = [];
-        const opId = this._doc.generateOpId();
-        const updatedProps = {};
-        const reverseUpdateOp = {
-            id: this._id,
-            type: OpType.UpdateObject,
-            data: {},
-        };
-        const updateDelta = {};
-        for (const key in overrides) {
-            __classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").set(key, opId);
-            const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-            if (oldValue instanceof AbstractCrdt) {
-                reverseOps.push(...oldValue._serialize(this._id, key));
-                oldValue._detach();
-            }
-            else if (oldValue === undefined) {
-                reverseOps.push({ type: OpType.DeleteObjectKey, id: this._id, key });
-            }
-            else {
-                reverseUpdateOp.data[key] = oldValue;
-            }
-            const newValue = overrides[key];
-            if (newValue instanceof AbstractCrdt) {
-                newValue._setParentLink(this, key);
-                newValue._attach(this._doc.generateId(), this._doc);
-                ops.push(...newValue._serialize(this._id, key, this._doc));
-            }
-            else {
-                updatedProps[key] = newValue;
-            }
-            __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, newValue);
-            updateDelta[key] = { type: "update" };
-        }
-        if (Object.keys(reverseUpdateOp.data).length !== 0) {
-            reverseOps.unshift(reverseUpdateOp);
-        }
-        if (Object.keys(updatedProps).length !== 0) {
-            ops.unshift({
-                opId,
-                id: this._id,
-                type: OpType.UpdateObject,
-                data: updatedProps,
-            });
-        }
-        const storageUpdates = new Map();
-        storageUpdates.set(this._id, {
-            node: this,
-            type: "LiveObject",
-            updates: updateDelta,
-        });
-        this._doc.dispatch(ops, reverseOps, storageUpdates);
-    }
-}
-_LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _LiveObject_instances = new WeakSet(), _LiveObject_applyUpdate = function _LiveObject_applyUpdate(op, isLocal) {
-    let isModified = false;
-    const reverse = [];
-    const reverseUpdate = {
-        type: OpType.UpdateObject,
-        id: this._id,
-        data: {},
-    };
-    reverse.push(reverseUpdate);
-    for (const key in op.data) {
-        const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-        if (oldValue instanceof AbstractCrdt) {
-            reverse.push(...oldValue._serialize(this._id, key));
-            oldValue._detach();
-        }
-        else if (oldValue !== undefined) {
-            reverseUpdate.data[key] = oldValue;
-        }
-        else if (oldValue === undefined) {
-            reverse.push({ type: OpType.DeleteObjectKey, id: this._id, key });
-        }
-    }
-    let updateDelta = {};
-    for (const key in op.data) {
-        if (isLocal) {
-            __classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").set(key, op.opId);
-        }
-        else if (__classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").get(key) == null) {
-            // Not modified localy so we apply update
-            isModified = true;
-        }
-        else if (__classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").get(key) === op.opId) {
-            // Acknowlegment from local operation
-            __classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").delete(key);
-            continue;
-        }
-        else {
-            // Conflict, ignore remote operation
-            continue;
-        }
-        const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-        if (isCrdt(oldValue)) {
-            oldValue._detach();
-        }
-        isModified = true;
-        updateDelta[key] = { type: "update" };
-        __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, op.data[key]);
-    }
-    if (Object.keys(reverseUpdate.data).length !== 0) {
-        reverse.unshift(reverseUpdate);
-    }
-    return isModified
-        ? {
-            modified: {
-                node: this,
-                type: "LiveObject",
-                updates: updateDelta,
-            },
-            reverse,
-        }
-        : { modified: false };
-}, _LiveObject_applyDeleteObjectKey = function _LiveObject_applyDeleteObjectKey(op) {
-    const key = op.key;
-    // If property does not exist, exit without notifying
-    if (__classPrivateFieldGet(this, _LiveObject_map, "f").has(key) === false) {
-        return { modified: false };
-    }
-    const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
-    let reverse = [];
-    if (isCrdt(oldValue)) {
-        reverse = oldValue._serialize(this._id, op.key);
-        oldValue._detach();
-    }
-    else if (oldValue !== undefined) {
-        reverse = [
-            {
-                type: OpType.UpdateObject,
-                id: this._id,
-                data: { [key]: oldValue },
-            },
-        ];
-    }
-    __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
-    return {
-        modified: {
-            node: this,
-            type: "LiveObject",
-            updates: { [op.key]: { type: "delete" } },
-        },
-        reverse,
-    };
-};

package/lib/esm/LiveRegister.d.ts

@@ -1,29 +0,0 @@
-import { AbstractCrdt, Doc, ApplyResult } from "./AbstractCrdt";
-import { SerializedCrdtWithId, Op, SerializedCrdt } from "./live";
-/**
- * INTERNAL
- */
-export declare class LiveRegister<TValue = any> extends AbstractCrdt {
-    #private;
-    constructor(data: TValue);
-    get data(): TValue;
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item]: SerializedCrdtWithId, parentToChildren: Map<string, SerializedCrdtWithId[]>, doc: Doc): LiveRegister<any>;
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId: string, parentKey: string, doc?: Doc): Op[];
-    /**
-     * INTERNAL
-     */
-    _toSerializedCrdt(): SerializedCrdt;
-    _attachChild(id: string, key: string, crdt: AbstractCrdt, isLocal: boolean): ApplyResult;
-    _detachChild(crdt: AbstractCrdt): ApplyResult;
-    _apply(op: Op, isLocal: boolean): ApplyResult;
-    /**
-     * INTERNAL
-     */
-    _getType(): string;
-}

package/lib/esm/LiveRegister.js

@@ -1,84 +0,0 @@
-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 __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 _LiveRegister_data;
-import { AbstractCrdt } from "./AbstractCrdt";
-import { CrdtType, OpType, } from "./live";
-/**
- * INTERNAL
- */
-export class LiveRegister extends AbstractCrdt {
-    constructor(data) {
-        super();
-        _LiveRegister_data.set(this, void 0);
-        __classPrivateFieldSet(this, _LiveRegister_data, data, "f");
-    }
-    get data() {
-        return __classPrivateFieldGet(this, _LiveRegister_data, "f");
-    }
-    /**
-     * INTERNAL
-     */
-    static _deserialize([id, item], parentToChildren, doc) {
-        if (item.type !== CrdtType.Register) {
-            throw new Error(`Tried to deserialize a map but item type is "${item.type}"`);
-        }
-        const register = new LiveRegister(item.data);
-        register._attach(id, doc);
-        return register;
-    }
-    /**
-     * INTERNAL
-     */
-    _serialize(parentId, parentKey, doc) {
-        if (this._id == null || parentId == null || parentKey == null) {
-            throw new Error("Cannot serialize register if parentId or parentKey is undefined");
-        }
-        return [
-            {
-                type: OpType.CreateRegister,
-                opId: doc === null || doc === void 0 ? void 0 : doc.generateOpId(),
-                id: this._id,
-                parentId,
-                parentKey,
-                data: this.data,
-            },
-        ];
-    }
-    /**
-     * INTERNAL
-     */
-    _toSerializedCrdt() {
-        var _a;
-        return {
-            type: CrdtType.Register,
-            parentId: (_a = this._parent) === null || _a === void 0 ? void 0 : _a._id,
-            parentKey: this._parentKey,
-            data: this.data,
-        };
-    }
-    _attachChild(id, key, crdt, isLocal) {
-        throw new Error("Method not implemented.");
-    }
-    _detachChild(crdt) {
-        throw new Error("Method not implemented.");
-    }
-    _apply(op, isLocal) {
-        return super._apply(op, isLocal);
-    }
-    /**
-     * INTERNAL
-     */
-    _getType() {
-        return "LiveRegister";
-    }
-}
-_LiveRegister_data = new WeakMap();

package/lib/esm/authentication.d.ts

@@ -1,3 +0,0 @@
-import { AuthEndpoint, AuthenticationToken } from "./types";
-export default function auth(endpoint: AuthEndpoint, room: string, publicApiKey?: string): Promise<string>;
-export declare function parseToken(token: string): AuthenticationToken;

package/lib/esm/authentication.js

@@ -1,66 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-function fetchAuthorize(endpoint, room, publicApiKey) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const res = yield fetch(endpoint, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                room,
-                publicApiKey,
-            }),
-        });
-        if (!res.ok) {
-            throw new AuthenticationError(`Authentication error. Liveblocks could not parse the response of your authentication "${endpoint}"`);
-        }
-        let authResponse = null;
-        try {
-            authResponse = yield res.json();
-        }
-        catch (er) {
-            throw new AuthenticationError(`Authentication error. Liveblocks could not parse the response of your authentication "${endpoint}"`);
-        }
-        if (typeof authResponse.token !== "string") {
-            throw new AuthenticationError(`Authentication error. Liveblocks could not parse the response of your authentication "${endpoint}"`);
-        }
-        return authResponse.token;
-    });
-}
-export default function auth(endpoint, room, publicApiKey) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (typeof endpoint === "string") {
-            return fetchAuthorize(endpoint, room, publicApiKey);
-        }
-        if (typeof endpoint === "function") {
-            const { token } = yield endpoint(room);
-            // TODO: Validation
-            return token;
-        }
-        throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
-    });
-}
-class AuthenticationError extends Error {
-    constructor(message) {
-        super(message);
-    }
-}
-export function parseToken(token) {
-    const tokenParts = token.split(".");
-    if (tokenParts.length !== 3) {
-        throw new AuthenticationError(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
-    }
-    const data = JSON.parse(atob(tokenParts[1]));
-    if (typeof data.actor !== "number") {
-        throw new AuthenticationError(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
-    }
-    return data;
-}

package/lib/esm/client.d.ts

@@ -1,27 +0,0 @@
-import { ClientOptions, Client } from "./types";
-/**
- * Create a client that will be responsible to communicate with liveblocks servers.
- *
- * @example
- * const client = createClient({
- *   authEndpoint: "/api/auth"
- * });
- *
- * // It's also possible to use a function to call your authentication endpoint.
- * // Useful to add additional headers or use an API wrapper (like Firebase functions)
- * const client = createClient({
- *   authEndpoint: async (room) => {
- *     const response = await fetch("/api/auth", {
- *       method: "POST",
- *       headers: {
- *          Authentication: "token",
- *          "Content-Type": "application/json"
- *       },
- *       body: JSON.stringify({ room })
- *     });
- *
- *     return await response.json();
- *   }
- * });
- */
-export declare function createClient(options: ClientOptions): Client;