@pluv/crdt-loro 0.16.0

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["pluv"],
+};

package/.turbo/turbo-build.log

@@ -0,0 +1,18 @@
+
+> @pluv/crdt-loro@0.16.0 build /home/runner/work/pluv/pluv/packages/crdt-loro
+> tsup src/index.ts --format esm,cjs --dts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.0.2
+CLI Target: es6
+ESM Build start
+CJS Build start
+ESM dist/index.mjs 18.48 KB
+ESM ⚡️ Build success in 118ms
+CJS dist/index.js 19.50 KB
+CJS ⚡️ Build success in 122ms
+DTS Build start
+DTS ⚡️ Build success in 2541ms
+DTS dist/index.d.mts 7.04 KB
+DTS dist/index.d.ts  7.04 KB

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @pluv/crdt-loro
+
+## 0.16.0
+
+### Patch Changes
+
+- @pluv/crdt@0.16.0
+- @pluv/types@0.16.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shoubhit Dash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,164 @@
+import { AbstractCrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtStorageJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { Loro, LoroMap, LoroText, LoroList } from 'loro-crdt';
+import { Json } from '@pluv/types';
+
+declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDoc<TStorage> {
+    value: Loro;
+    private _storage;
+    constructor(value?: TStorage);
+    applyEncodedState(params: DocApplyEncodedStateParams): this;
+    batchApplyEncodedState(updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[]): this;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    canRedo(): boolean;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    canUndo(): boolean;
+    destroy(): void;
+    get(key?: undefined): TStorage;
+    get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
+    getEncodedState(): string;
+    toJson(): InferCrdtStorageJson<TStorage>;
+    isEmpty(): boolean;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    redo(): this;
+    subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
+    /**
+     * TODO
+     * @description This method doesn't do anything yet.
+     */
+    track(): this;
+    /**
+     * TODO
+     * @description This method doesn't do anything yet. The callback will still be executed.
+     */
+    transact(fn: () => void): this;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    undo(): this;
+}
+
+declare class CrdtLoroMap<T extends unknown> extends AbstractCrdtType<LoroMap<Record<string, T>>, Record<string, InferLoroJson<T>>> {
+    readonly initialValue: readonly (readonly [key: string, value: T])[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: readonly (readonly [key: string, value: T])[]);
+    set doc(doc: CrdtLoroDoc<any>);
+    get size(): number;
+    get value(): LoroMap<Record<string, T>>;
+    set value(value: LoroMap<Record<string, T>>);
+    delete(prop: string): this;
+    set(prop: string, value: T): this;
+    toJson(): InferCrdtStorageJson<Record<string, InferLoroJson<T>>>;
+    private _guardInitialized;
+}
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => CrdtLoroMap<T>;
+
+declare class CrdtLoroObject<T extends Record<string, any>> extends AbstractCrdtType<LoroMap<T>, InferLoroJson<T>> {
+    readonly initialValue: readonly (readonly [key: string, value: T])[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value: T);
+    set doc(doc: CrdtLoroDoc<any>);
+    get size(): number;
+    get value(): LoroMap<T>;
+    set value(value: LoroMap<T>);
+    set(prop: string, value: T): this;
+    toJson(): InferCrdtStorageJson<InferLoroJson<T>>;
+    private _guardInitialized;
+}
+
+declare const object: <T extends Record<string, any>>(value: T) => CrdtLoroObject<T>;
+
+declare class CrdtLoroText extends AbstractCrdtType<LoroText, string> {
+    initalValue: string;
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: string);
+    set doc(doc: CrdtLoroDoc<any>);
+    get length(): number;
+    get value(): LoroText;
+    set value(value: LoroText);
+    delete(index: number, length?: number): this;
+    insert(index: number, text: string): this;
+    toJson(): string;
+    private _guardInitialized;
+}
+
+declare const text: (value?: string) => CrdtLoroText;
+
+type InferLoroType<T extends unknown> = T extends CrdtLoroArray<infer IType> ? LoroList<IType[]> : T extends CrdtLoroMap<infer IType> ? LoroMap<Record<string, IType>> : T extends CrdtLoroObject<infer IType> ? LoroMap<IType> : T extends CrdtLoroText ? LoroText : T extends Json ? T : never;
+type InferLoroJson<T extends unknown> = T extends CrdtLoroArray<infer IType> ? InferLoroJson<IType>[] : T extends CrdtLoroMap<infer IType> ? Record<string, InferLoroJson<IType>> : T extends CrdtLoroObject<infer IType> ? {
+    [P in keyof IType]: InferLoroJson<IType[P]>;
+} : T extends CrdtLoroText | LoroText ? string : T extends LoroList<infer IType> ? InferLoroJson<IType> : T extends LoroMap<infer IType> ? {
+    [P in keyof IType]: InferLoroJson<IType[P]>;
+} : T extends (infer IType)[] ? InferLoroJson<IType>[] : T extends Record<any, any> ? {
+    [P in keyof T]: InferLoroJson<T[P]>;
+} : T extends Json ? T : never;
+
+declare class CrdtLoroArray<T extends unknown> extends AbstractCrdtType<LoroList<T[]>, InferLoroJson<T>[]> {
+    readonly initialValue: T[] | readonly T[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: T[] | readonly T[]);
+    set doc(doc: CrdtLoroDoc<any>);
+    get length(): number;
+    get value(): LoroList<T[]>;
+    set value(value: LoroList<T[]>);
+    delete(index: number, length?: number): this;
+    insert(index: number, ...items: T[]): this;
+    push(...items: T[]): this;
+    unshift(...items: T[]): this;
+    toJson(): InferCrdtStorageJson<InferLoroJson<T>>[];
+    private _guardInitialized;
+}
+
+declare const array: <T extends unknown>(value?: T[] | readonly T[]) => CrdtLoroArray<T>;
+
+declare class CrdtLoroDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDocFactory<TStorage> {
+    private _initialStorage;
+    constructor(initialStorage?: () => TStorage);
+    getEmpty(): CrdtLoroDoc<TStorage>;
+    getFactory(initialStorage?: (() => TStorage) | undefined): CrdtLoroDocFactory<TStorage>;
+    getFresh(): CrdtLoroDoc<TStorage>;
+    getInitialized(initialStorage?: () => TStorage): CrdtLoroDoc<TStorage>;
+}
+
+declare const doc: <TStorage extends Record<string, AbstractCrdtType<any, any>>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+
+type loro_CrdtLoroArray<T extends unknown> = CrdtLoroArray<T>;
+declare const loro_CrdtLoroArray: typeof CrdtLoroArray;
+type loro_CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> = CrdtLoroDoc<TStorage>;
+declare const loro_CrdtLoroDoc: typeof CrdtLoroDoc;
+type loro_CrdtLoroMap<T extends unknown> = CrdtLoroMap<T>;
+declare const loro_CrdtLoroMap: typeof CrdtLoroMap;
+type loro_CrdtLoroObject<T extends Record<string, any>> = CrdtLoroObject<T>;
+declare const loro_CrdtLoroObject: typeof CrdtLoroObject;
+type loro_CrdtLoroText = CrdtLoroText;
+declare const loro_CrdtLoroText: typeof CrdtLoroText;
+type loro_InferLoroJson<T extends unknown> = InferLoroJson<T>;
+type loro_InferLoroType<T extends unknown> = InferLoroType<T>;
+declare const loro_array: typeof array;
+declare const loro_doc: typeof doc;
+declare const loro_map: typeof map;
+declare const loro_object: typeof object;
+declare const loro_text: typeof text;
+declare namespace loro {
+  export { loro_CrdtLoroArray as CrdtLoroArray, loro_CrdtLoroDoc as CrdtLoroDoc, loro_CrdtLoroMap as CrdtLoroMap, loro_CrdtLoroObject as CrdtLoroObject, loro_CrdtLoroText as CrdtLoroText, type loro_InferLoroJson as InferLoroJson, type loro_InferLoroType as InferLoroType, loro_array as array, loro_doc as doc, loro_map as map, loro_object as object, loro_text as text };
+}
+
+export { loro };

package/dist/index.d.ts

@@ -0,0 +1,164 @@
+import { AbstractCrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtStorageJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { Loro, LoroMap, LoroText, LoroList } from 'loro-crdt';
+import { Json } from '@pluv/types';
+
+declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDoc<TStorage> {
+    value: Loro;
+    private _storage;
+    constructor(value?: TStorage);
+    applyEncodedState(params: DocApplyEncodedStateParams): this;
+    batchApplyEncodedState(updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[]): this;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    canRedo(): boolean;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    canUndo(): boolean;
+    destroy(): void;
+    get(key?: undefined): TStorage;
+    get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
+    getEncodedState(): string;
+    toJson(): InferCrdtStorageJson<TStorage>;
+    isEmpty(): boolean;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    redo(): this;
+    subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
+    /**
+     * TODO
+     * @description This method doesn't do anything yet.
+     */
+    track(): this;
+    /**
+     * TODO
+     * @description This method doesn't do anything yet. The callback will still be executed.
+     */
+    transact(fn: () => void): this;
+    /**
+     * TODO
+     * @description This method is not yet supported for loro
+     */
+    undo(): this;
+}
+
+declare class CrdtLoroMap<T extends unknown> extends AbstractCrdtType<LoroMap<Record<string, T>>, Record<string, InferLoroJson<T>>> {
+    readonly initialValue: readonly (readonly [key: string, value: T])[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: readonly (readonly [key: string, value: T])[]);
+    set doc(doc: CrdtLoroDoc<any>);
+    get size(): number;
+    get value(): LoroMap<Record<string, T>>;
+    set value(value: LoroMap<Record<string, T>>);
+    delete(prop: string): this;
+    set(prop: string, value: T): this;
+    toJson(): InferCrdtStorageJson<Record<string, InferLoroJson<T>>>;
+    private _guardInitialized;
+}
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => CrdtLoroMap<T>;
+
+declare class CrdtLoroObject<T extends Record<string, any>> extends AbstractCrdtType<LoroMap<T>, InferLoroJson<T>> {
+    readonly initialValue: readonly (readonly [key: string, value: T])[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value: T);
+    set doc(doc: CrdtLoroDoc<any>);
+    get size(): number;
+    get value(): LoroMap<T>;
+    set value(value: LoroMap<T>);
+    set(prop: string, value: T): this;
+    toJson(): InferCrdtStorageJson<InferLoroJson<T>>;
+    private _guardInitialized;
+}
+
+declare const object: <T extends Record<string, any>>(value: T) => CrdtLoroObject<T>;
+
+declare class CrdtLoroText extends AbstractCrdtType<LoroText, string> {
+    initalValue: string;
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: string);
+    set doc(doc: CrdtLoroDoc<any>);
+    get length(): number;
+    get value(): LoroText;
+    set value(value: LoroText);
+    delete(index: number, length?: number): this;
+    insert(index: number, text: string): this;
+    toJson(): string;
+    private _guardInitialized;
+}
+
+declare const text: (value?: string) => CrdtLoroText;
+
+type InferLoroType<T extends unknown> = T extends CrdtLoroArray<infer IType> ? LoroList<IType[]> : T extends CrdtLoroMap<infer IType> ? LoroMap<Record<string, IType>> : T extends CrdtLoroObject<infer IType> ? LoroMap<IType> : T extends CrdtLoroText ? LoroText : T extends Json ? T : never;
+type InferLoroJson<T extends unknown> = T extends CrdtLoroArray<infer IType> ? InferLoroJson<IType>[] : T extends CrdtLoroMap<infer IType> ? Record<string, InferLoroJson<IType>> : T extends CrdtLoroObject<infer IType> ? {
+    [P in keyof IType]: InferLoroJson<IType[P]>;
+} : T extends CrdtLoroText | LoroText ? string : T extends LoroList<infer IType> ? InferLoroJson<IType> : T extends LoroMap<infer IType> ? {
+    [P in keyof IType]: InferLoroJson<IType[P]>;
+} : T extends (infer IType)[] ? InferLoroJson<IType>[] : T extends Record<any, any> ? {
+    [P in keyof T]: InferLoroJson<T[P]>;
+} : T extends Json ? T : never;
+
+declare class CrdtLoroArray<T extends unknown> extends AbstractCrdtType<LoroList<T[]>, InferLoroJson<T>[]> {
+    readonly initialValue: T[] | readonly T[];
+    private _doc;
+    private _initialized;
+    private _value;
+    constructor(value?: T[] | readonly T[]);
+    set doc(doc: CrdtLoroDoc<any>);
+    get length(): number;
+    get value(): LoroList<T[]>;
+    set value(value: LoroList<T[]>);
+    delete(index: number, length?: number): this;
+    insert(index: number, ...items: T[]): this;
+    push(...items: T[]): this;
+    unshift(...items: T[]): this;
+    toJson(): InferCrdtStorageJson<InferLoroJson<T>>[];
+    private _guardInitialized;
+}
+
+declare const array: <T extends unknown>(value?: T[] | readonly T[]) => CrdtLoroArray<T>;
+
+declare class CrdtLoroDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDocFactory<TStorage> {
+    private _initialStorage;
+    constructor(initialStorage?: () => TStorage);
+    getEmpty(): CrdtLoroDoc<TStorage>;
+    getFactory(initialStorage?: (() => TStorage) | undefined): CrdtLoroDocFactory<TStorage>;
+    getFresh(): CrdtLoroDoc<TStorage>;
+    getInitialized(initialStorage?: () => TStorage): CrdtLoroDoc<TStorage>;
+}
+
+declare const doc: <TStorage extends Record<string, AbstractCrdtType<any, any>>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+
+type loro_CrdtLoroArray<T extends unknown> = CrdtLoroArray<T>;
+declare const loro_CrdtLoroArray: typeof CrdtLoroArray;
+type loro_CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> = CrdtLoroDoc<TStorage>;
+declare const loro_CrdtLoroDoc: typeof CrdtLoroDoc;
+type loro_CrdtLoroMap<T extends unknown> = CrdtLoroMap<T>;
+declare const loro_CrdtLoroMap: typeof CrdtLoroMap;
+type loro_CrdtLoroObject<T extends Record<string, any>> = CrdtLoroObject<T>;
+declare const loro_CrdtLoroObject: typeof CrdtLoroObject;
+type loro_CrdtLoroText = CrdtLoroText;
+declare const loro_CrdtLoroText: typeof CrdtLoroText;
+type loro_InferLoroJson<T extends unknown> = InferLoroJson<T>;
+type loro_InferLoroType<T extends unknown> = InferLoroType<T>;
+declare const loro_array: typeof array;
+declare const loro_doc: typeof doc;
+declare const loro_map: typeof map;
+declare const loro_object: typeof object;
+declare const loro_text: typeof text;
+declare namespace loro {
+  export { loro_CrdtLoroArray as CrdtLoroArray, loro_CrdtLoroDoc as CrdtLoroDoc, loro_CrdtLoroMap as CrdtLoroMap, loro_CrdtLoroObject as CrdtLoroObject, loro_CrdtLoroText as CrdtLoroText, type loro_InferLoroJson as InferLoroJson, type loro_InferLoroType as InferLoroType, loro_array as array, loro_doc as doc, loro_map as map, loro_object as object, loro_text as text };
+}
+
+export { loro };