@pluv/crdt-loro 0.19.0 → 0.20.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/crdt-loro@0.19.0 build /home/runner/work/pluv/pluv/packages/crdt-loro
+> @pluv/crdt-loro@0.20.0 build /home/runner/work/pluv/pluv/packages/crdt-loro
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@ CLI tsup v8.1.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 18.22 KB
-ESM ⚡️ Build success in 114ms
-CJS dist/index.js 19.23 KB
-CJS ⚡️ Build success in 114ms
+CJS dist/index.js 9.39 KB
+CJS ⚡️ Build success in 80ms
+ESM dist/index.mjs 8.33 KB
+ESM ⚡️ Build success in 80ms
 DTS Build start
-DTS ⚡️ Build success in 2568ms
-DTS dist/index.d.mts 7.04 KB
-DTS dist/index.d.ts  7.04 KB
+DTS ⚡️ Build success in 1828ms
+DTS dist/index.d.mts 3.41 KB
+DTS dist/index.d.ts  3.41 KB

package/CHANGELOG.md

@@ -1,5 +1,82 @@
 # @pluv/crdt-loro
 
+## 0.20.0
+
+### Minor Changes
+
+- 9492085: **BREAKING**: `@pluv/crdt-yjs` and `@pluv/crdt-loro` have been updated so that the utilities to create shared-types/containers no-longer return a wrapper around the underlying shared-types and containers, but rather return the shared-types/containers directly.
+
+  This means that for methods such as `getStorage` from `@pluv/client` and `useStorage` from `@pluv/react`, the shared-types/containers are also returned instead of the wrapper types.
+
+  The motivation for these changes are so that pluv.io is supplementary to `yjs` and `loro-crdt`, instead of having these libraries be an internal implementation of pluv.io.
+
+  ```ts
+  // Before
+
+  import { yjs } from "@pluv/crdt-yjs";
+
+  yjs.array([]); // Returns CrdtYjsArray
+  yjs.object([]); // Returns CrdtYjsObject
+
+  const room: PluvRoom = /* ... */;
+
+  room.getStorage("messages"); // Returns AbstractCrdtType
+
+  const [, sharedType] = useStorage("messages"); // sharedType is an AbstractCrdtType
+  ```
+
+  ```ts
+  // Now
+
+  import { yjs } from "@pluv/crdt-yjs";
+
+  yjs.array([]); // Returns yjs.Array
+  yjs.object([]); // Returns yjs.Map
+
+  const room: PluvRoom = /* ... */;
+
+  room.getStorage("messages"); // Returns yjs.AbstractType
+
+  const [, sharedType] = useStorage("messages"); // sharedType is a yjs.AbstractType
+  ```
+
+  For `@pluv/crdt-loro` specifically, `@pluv/client` relies on [loro events and subscriptions](https://www.loro.dev/docs/tutorial/get_started#event) to detect changes. The `AbstractLoroCrdt` types previously called `Loro.commit` after each change as an abstraction, but now this no-longer happens. To ensure that changes to loro containers are properly handled in `@pluv/react`, make sure to commit your changes whenever possible:
+
+  ```ts
+  // Before
+
+  const [data, container] = useStorage("messages");
+
+  // This automatically called Loro.commit under the hood and rerendered the page with updated data.
+  container.push(loro.object({ name: "John Doe", age: 35 }));
+  ```
+
+  ```ts
+  // Now
+
+  const [data, container] = useStorage("messages");
+
+  const doc = useDoc();
+  const transact = useTransact();
+
+  // Updates need to be committed back to the doc whenever the changes need to be emitted to other users
+  // The returned data also will not update until the changes are commited
+
+  // The two operations below are functionally equivalent
+  transact(() => {
+    container.push(loro.object({ name: "John Doe", age: 35 }));
+  });
+
+  container.push(loro.object({ name: "John Doe", age: 35 }));
+  doc.value.commit();
+  ```
+
+### Patch Changes
+
+- Updated dependencies [9492085]
+  - @pluv/crdt@0.20.0
+  - @pluv/types@0.20.0
+
 ## 0.19.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,8 +1,12 @@
-import { AbstractCrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtStorageJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
-import { Loro, LoroMap, LoroText, LoroList } from 'loro-crdt';
-import { Json } from '@pluv/types';
+import { CrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { Loro, LoroList, LoroMap, LoroText } from 'loro-crdt';
 
-declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDoc<TStorage> {
+type LoroType<TValue extends unknown, TJson extends unknown = any> = TValue & CrdtType<TValue, TJson> & {
+    toJSON?: () => any;
+    toString?: () => string;
+};
+
+declare class CrdtLoroDoc<TStorage extends Record<string, LoroType<any, any>>> extends AbstractCrdtDoc<TStorage> {
     value: Loro;
     private _storage;
     constructor(value?: TStorage);
@@ -22,7 +26,8 @@ declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any,
     get(key?: undefined): TStorage;
     get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
     getEncodedState(): string;
-    toJson(): InferCrdtStorageJson<TStorage>;
+    toJson(): InferCrdtJson<TStorage>;
+    toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
     isEmpty(): boolean;
     /**
      * TODO
@@ -47,89 +52,7 @@ declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any,
     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> {
+declare class CrdtLoroDocFactory<TStorage extends Record<string, LoroType<any, any>>> extends AbstractCrdtDocFactory<TStorage> {
     private _initialStorage;
     constructor(initialStorage?: () => TStorage);
     getEmpty(): CrdtLoroDoc<TStorage>;
@@ -138,27 +61,26 @@ declare class CrdtLoroDocFactory<TStorage extends Record<string, AbstractCrdtTyp
     getInitialized(initialStorage?: () => TStorage): CrdtLoroDoc<TStorage>;
 }
 
-declare const doc: <TStorage extends Record<string, AbstractCrdtType<any, any>>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+declare const doc: <TStorage extends Record<string, any>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+
+declare const list: <T extends unknown>(value?: T[] | readonly T[]) => LoroType<LoroList<T>, T[]>;
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => LoroType<LoroMap<Record<string, T>>, Record<string, T>>;
+
+declare const object: <T extends Record<string, any>>(value: T) => LoroType<LoroMap<T>, T>;
+
+declare const text: (value?: string) => LoroType<LoroText, string>;
 
-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>;
+type loro_CrdtLoroDoc<TStorage extends Record<string, LoroType<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;
+type loro_LoroType<TValue extends unknown, TJson extends unknown = any> = LoroType<TValue, TJson>;
 declare const loro_doc: typeof doc;
+declare const loro_list: typeof list;
 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_CrdtLoroDoc as CrdtLoroDoc, type loro_LoroType as LoroType, loro_doc as doc, loro_list as list, loro_map as map, loro_object as object, loro_text as text };
 }
 
 export { loro };

package/dist/index.d.ts

@@ -1,8 +1,12 @@
-import { AbstractCrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtStorageJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
-import { Loro, LoroMap, LoroText, LoroList } from 'loro-crdt';
-import { Json } from '@pluv/types';
+import { CrdtType, AbstractCrdtDoc, DocApplyEncodedStateParams, InferCrdtJson, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { Loro, LoroList, LoroMap, LoroText } from 'loro-crdt';
 
-declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDoc<TStorage> {
+type LoroType<TValue extends unknown, TJson extends unknown = any> = TValue & CrdtType<TValue, TJson> & {
+    toJSON?: () => any;
+    toString?: () => string;
+};
+
+declare class CrdtLoroDoc<TStorage extends Record<string, LoroType<any, any>>> extends AbstractCrdtDoc<TStorage> {
     value: Loro;
     private _storage;
     constructor(value?: TStorage);
@@ -22,7 +26,8 @@ declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any,
     get(key?: undefined): TStorage;
     get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
     getEncodedState(): string;
-    toJson(): InferCrdtStorageJson<TStorage>;
+    toJson(): InferCrdtJson<TStorage>;
+    toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
     isEmpty(): boolean;
     /**
      * TODO
@@ -47,89 +52,7 @@ declare class CrdtLoroDoc<TStorage extends Record<string, AbstractCrdtType<any,
     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> {
+declare class CrdtLoroDocFactory<TStorage extends Record<string, LoroType<any, any>>> extends AbstractCrdtDocFactory<TStorage> {
     private _initialStorage;
     constructor(initialStorage?: () => TStorage);
     getEmpty(): CrdtLoroDoc<TStorage>;
@@ -138,27 +61,26 @@ declare class CrdtLoroDocFactory<TStorage extends Record<string, AbstractCrdtTyp
     getInitialized(initialStorage?: () => TStorage): CrdtLoroDoc<TStorage>;
 }
 
-declare const doc: <TStorage extends Record<string, AbstractCrdtType<any, any>>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+declare const doc: <TStorage extends Record<string, any>>(value?: () => TStorage) => CrdtLoroDocFactory<TStorage>;
+
+declare const list: <T extends unknown>(value?: T[] | readonly T[]) => LoroType<LoroList<T>, T[]>;
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => LoroType<LoroMap<Record<string, T>>, Record<string, T>>;
+
+declare const object: <T extends Record<string, any>>(value: T) => LoroType<LoroMap<T>, T>;
+
+declare const text: (value?: string) => LoroType<LoroText, string>;
 
-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>;
+type loro_CrdtLoroDoc<TStorage extends Record<string, LoroType<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;
+type loro_LoroType<TValue extends unknown, TJson extends unknown = any> = LoroType<TValue, TJson>;
 declare const loro_doc: typeof doc;
+declare const loro_list: typeof list;
 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_CrdtLoroDoc as CrdtLoroDoc, type loro_LoroType as LoroType, loro_doc as doc, loro_list as list, loro_map as map, loro_object as object, loro_text as text };
 }
 
 export { loro };