@pluv/crdt 0.18.0 → 0.20.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @pluv/crdt@0.18.0 build /home/runner/work/pluv/pluv/packages/crdt
+> @pluv/crdt@0.20.0 build /home/runner/work/pluv/pluv/packages/crdt
 > 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 1.34 KB
-ESM ⚡️ Build success in 27ms
-CJS dist/index.js 2.54 KB
-CJS ⚡️ Build success in 27ms
-DTS Build start
-DTS ⚡️ Build success in 596ms
-DTS dist/index.d.mts 3.31 KB
-DTS dist/index.d.ts  3.31 KB
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.1.0
+CLI Target: es6
+ESM Build start
+CJS Build start
+ESM dist/index.mjs 1.26 KB
+ESM ⚡️ Build success in 22ms
+CJS dist/index.js 2.42 KB
+CJS ⚡️ Build success in 23ms
+DTS Build start
+DTS ⚡️ Build success in 500ms
+DTS dist/index.d.mts 3.22 KB
+DTS dist/index.d.ts  3.22 KB

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # @pluv/crdt
 
+## 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
+
+- @pluv/types@0.20.0
+
+## 0.19.0
+
+### Patch Changes
+
+- @pluv/types@0.19.0
+
 ## 0.18.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,25 +1,23 @@
 import { Json } from '@pluv/types';
 
-type InferCrdtStorageJson<T extends unknown> = T extends AbstractCrdtType<any, infer ICrdtJson> ? InferCrdtStorageJson<ICrdtJson> : T extends Record<string, any> ? {
-    [P in keyof T]: InferCrdtStorageJson<T[P]>;
-} : T extends (infer IArrayCrdtItem)[] ? InferCrdtStorageJson<IArrayCrdtItem>[] : T extends readonly (infer IReadonlyArrayCrdtItem)[] ? InferCrdtStorageJson<IReadonlyArrayCrdtItem> : T extends Json ? T : string;
-
-declare abstract class AbstractCrdtType<TValue extends unknown, TJson extends unknown> {
-    abstract value: TValue;
-    abstract toJson(): InferCrdtStorageJson<TJson>;
-}
+type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
+    __pluvType: () => TJson;
+};
+type InferCrdtJson<T extends unknown> = T extends CrdtType<any, infer IJson> ? InferCrdtJson<IJson> : T extends Record<string, any> ? {
+    [P in keyof T]: InferCrdtJson<T[P]>;
+} : T extends (infer IJson)[] ? InferCrdtJson<IJson>[] : T extends readonly (infer IJson)[] ? readonly InferCrdtJson<IJson>[] : T extends Json ? T : string;
 
 interface DocApplyEncodedStateParams {
     origin?: string;
     update?: string | Uint8Array;
 }
-interface DocSubscribeCallbackParams<T extends Record<string, AbstractCrdtType<any, any>>> {
+interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
     doc: AbstractCrdtDoc<T>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
-declare abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType<any, any>>> {
+declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
     abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
     abstract batchApplyEncodedState(updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[]): this;
     abstract canRedo(): boolean;
@@ -31,13 +29,14 @@ declare abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType
     abstract isEmpty(): boolean;
     abstract redo(): this;
     abstract subscribe(listener: (params: DocSubscribeCallbackParams<T>) => void): () => void;
-    abstract toJson(): InferCrdtStorageJson<T>;
+    abstract toJson(): InferCrdtJson<T>;
+    abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
     abstract track(): this;
     abstract transact(fn: () => void, origin?: string): this;
     abstract undo(): this;
 }
 
-declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> {
+declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, CrdtType<any, any>>> {
     abstract getEmpty(): AbstractCrdtDoc<TStorage>;
     abstract getFactory(initialStorage?: () => TStorage): AbstractCrdtDocFactory<TStorage>;
     abstract getFresh(): AbstractCrdtDoc<TStorage>;
@@ -73,4 +72,4 @@ declare const noop: {
     doc: (args?: any) => NoopCrdtDocFactory;
 };
 
-export { AbstractCrdtDoc, AbstractCrdtDocFactory, AbstractCrdtType, type DocApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtStorageJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };
+export { AbstractCrdtDoc, AbstractCrdtDocFactory, type CrdtType, type DocApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };

package/dist/index.d.ts

@@ -1,25 +1,23 @@
 import { Json } from '@pluv/types';
 
-type InferCrdtStorageJson<T extends unknown> = T extends AbstractCrdtType<any, infer ICrdtJson> ? InferCrdtStorageJson<ICrdtJson> : T extends Record<string, any> ? {
-    [P in keyof T]: InferCrdtStorageJson<T[P]>;
-} : T extends (infer IArrayCrdtItem)[] ? InferCrdtStorageJson<IArrayCrdtItem>[] : T extends readonly (infer IReadonlyArrayCrdtItem)[] ? InferCrdtStorageJson<IReadonlyArrayCrdtItem> : T extends Json ? T : string;
-
-declare abstract class AbstractCrdtType<TValue extends unknown, TJson extends unknown> {
-    abstract value: TValue;
-    abstract toJson(): InferCrdtStorageJson<TJson>;
-}
+type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
+    __pluvType: () => TJson;
+};
+type InferCrdtJson<T extends unknown> = T extends CrdtType<any, infer IJson> ? InferCrdtJson<IJson> : T extends Record<string, any> ? {
+    [P in keyof T]: InferCrdtJson<T[P]>;
+} : T extends (infer IJson)[] ? InferCrdtJson<IJson>[] : T extends readonly (infer IJson)[] ? readonly InferCrdtJson<IJson>[] : T extends Json ? T : string;
 
 interface DocApplyEncodedStateParams {
     origin?: string;
     update?: string | Uint8Array;
 }
-interface DocSubscribeCallbackParams<T extends Record<string, AbstractCrdtType<any, any>>> {
+interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
     doc: AbstractCrdtDoc<T>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
-declare abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType<any, any>>> {
+declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
     abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
     abstract batchApplyEncodedState(updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[]): this;
     abstract canRedo(): boolean;
@@ -31,13 +29,14 @@ declare abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType
     abstract isEmpty(): boolean;
     abstract redo(): this;
     abstract subscribe(listener: (params: DocSubscribeCallbackParams<T>) => void): () => void;
-    abstract toJson(): InferCrdtStorageJson<T>;
+    abstract toJson(): InferCrdtJson<T>;
+    abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
     abstract track(): this;
     abstract transact(fn: () => void, origin?: string): this;
     abstract undo(): this;
 }
 
-declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> {
+declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, CrdtType<any, any>>> {
     abstract getEmpty(): AbstractCrdtDoc<TStorage>;
     abstract getFactory(initialStorage?: () => TStorage): AbstractCrdtDocFactory<TStorage>;
     abstract getFresh(): AbstractCrdtDoc<TStorage>;
@@ -73,4 +72,4 @@ declare const noop: {
     doc: (args?: any) => NoopCrdtDocFactory;
 };
 
-export { AbstractCrdtDoc, AbstractCrdtDocFactory, AbstractCrdtType, type DocApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtStorageJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };
+export { AbstractCrdtDoc, AbstractCrdtDocFactory, type CrdtType, type DocApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };

package/dist/index.js

@@ -22,7 +22,6 @@ var src_exports = {};
 __export(src_exports, {
   AbstractCrdtDoc: () => AbstractCrdtDoc,
   AbstractCrdtDocFactory: () => AbstractCrdtDocFactory,
-  AbstractCrdtType: () => AbstractCrdtType,
   NoopCrdtDoc: () => NoopCrdtDoc,
   NoopCrdtDocFactory: () => NoopCrdtDocFactory,
   noop: () => noop
@@ -37,10 +36,6 @@ var AbstractCrdtDoc = class {
 var AbstractCrdtDocFactory = class {
 };
 
-// src/AbstractCrdtType.ts
-var AbstractCrdtType = class {
-};
-
 // src/NoopCrdtDoc.ts
 var NoopCrdtDoc = class extends AbstractCrdtDoc {
   applyEncodedState(params) {
@@ -112,7 +107,6 @@ var noop = {
 0 && (module.exports = {
   AbstractCrdtDoc,
   AbstractCrdtDocFactory,
-  AbstractCrdtType,
   NoopCrdtDoc,
   NoopCrdtDocFactory,
   noop

package/dist/index.mjs

@@ -6,10 +6,6 @@ var AbstractCrdtDoc = class {
 var AbstractCrdtDocFactory = class {
 };
 
-// src/AbstractCrdtType.ts
-var AbstractCrdtType = class {
-};
-
 // src/NoopCrdtDoc.ts
 var NoopCrdtDoc = class extends AbstractCrdtDoc {
   applyEncodedState(params) {
@@ -80,7 +76,6 @@ var noop = {
 export {
   AbstractCrdtDoc,
   AbstractCrdtDocFactory,
-  AbstractCrdtType,
   NoopCrdtDoc,
   NoopCrdtDocFactory,
   noop

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/crdt",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "crdt base for @pluv/io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,14 +17,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@pluv/types": "^0.18.0"
+    "@pluv/types": "^0.20.0"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
-    "tsup": "^8.0.2",
+    "tsup": "^8.1.0",
     "typescript": "^5.4.5",
-    "@pluv/tsconfig": "^0.18.0",
-    "eslint-config-pluv": "^0.18.0"
+    "@pluv/tsconfig": "^0.20.0",
+    "eslint-config-pluv": "^0.20.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/AbstractCrdtDoc.ts

@@ -1,19 +1,18 @@
-import { AbstractCrdtType } from "./AbstractCrdtType";
-import type { InferCrdtStorageJson } from "./types";
+import type { CrdtType, InferCrdtJson } from "./types";
 
 export interface DocApplyEncodedStateParams {
     origin?: string;
     update?: string | Uint8Array;
 }
 
-export interface DocSubscribeCallbackParams<T extends Record<string, AbstractCrdtType<any, any>>> {
+export interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
     doc: AbstractCrdtDoc<T>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
 
-export abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType<any, any>>> {
+export abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
     public abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
     public abstract batchApplyEncodedState(
         updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[],
@@ -27,7 +26,8 @@ export abstract class AbstractCrdtDoc<T extends Record<string, AbstractCrdtType<
     public abstract isEmpty(): boolean;
     public abstract redo(): this;
     public abstract subscribe(listener: (params: DocSubscribeCallbackParams<T>) => void): () => void;
-    public abstract toJson(): InferCrdtStorageJson<T>;
+    public abstract toJson(): InferCrdtJson<T>;
+    public abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
     public abstract track(): this;
     public abstract transact(fn: () => void, origin?: string): this;
     public abstract undo(): this;

package/src/AbstractCrdtDocFactory.ts

@@ -1,7 +1,7 @@
-import { AbstractCrdtDoc } from "./AbstractCrdtDoc";
-import type { AbstractCrdtType } from "./AbstractCrdtType";
+import type { AbstractCrdtDoc } from "./AbstractCrdtDoc";
+import type { CrdtType } from "./types";
 
-export abstract class AbstractCrdtDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> {
+export abstract class AbstractCrdtDocFactory<TStorage extends Record<string, CrdtType<any, any>>> {
     public abstract getEmpty(): AbstractCrdtDoc<TStorage>;
     public abstract getFactory(initialStorage?: () => TStorage): AbstractCrdtDocFactory<TStorage>;
     public abstract getFresh(): AbstractCrdtDoc<TStorage>;

package/src/index.ts

@@ -1,8 +1,7 @@
 export { AbstractCrdtDoc } from "./AbstractCrdtDoc";
 export type { DocApplyEncodedStateParams, DocSubscribeCallbackParams } from "./AbstractCrdtDoc";
 export { AbstractCrdtDocFactory } from "./AbstractCrdtDocFactory";
-export { AbstractCrdtType } from "./AbstractCrdtType";
 export { NoopCrdtDoc } from "./NoopCrdtDoc";
 export { NoopCrdtDocFactory } from "./NoopCrdtDocFactory";
 export { noop } from "./noop";
-export type { InferCrdtStorageJson } from "./types";
+export type { CrdtType, InferCrdtJson } from "./types";

package/src/types.ts

@@ -1,15 +1,18 @@
 import type { Json } from "@pluv/types";
-import type { AbstractCrdtType } from "./AbstractCrdtType";
 
-export type InferCrdtStorageJson<T extends unknown> =
-    T extends AbstractCrdtType<any, infer ICrdtJson>
-        ? InferCrdtStorageJson<ICrdtJson>
+export type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
+    __pluvType: () => TJson;
+};
+
+export type InferCrdtJson<T extends unknown> =
+    T extends CrdtType<any, infer IJson>
+        ? InferCrdtJson<IJson>
         : T extends Record<string, any>
-          ? { [P in keyof T]: InferCrdtStorageJson<T[P]> }
-          : T extends (infer IArrayCrdtItem)[]
-            ? InferCrdtStorageJson<IArrayCrdtItem>[]
-            : T extends readonly (infer IReadonlyArrayCrdtItem)[]
-              ? InferCrdtStorageJson<IReadonlyArrayCrdtItem>
+          ? { [P in keyof T]: InferCrdtJson<T[P]> }
+          : T extends (infer IJson)[]
+            ? InferCrdtJson<IJson>[]
+            : T extends readonly (infer IJson)[]
+              ? readonly InferCrdtJson<IJson>[]
               : T extends Json
                 ? T
                 : string;

package/src/AbstractCrdtType.ts

@@ -1,7 +0,0 @@
-import type { InferCrdtStorageJson } from "./types";
-
-export abstract class AbstractCrdtType<TValue extends unknown, TJson extends unknown> {
-    public abstract value: TValue;
-
-    public abstract toJson(): InferCrdtStorageJson<TJson>;
-}