@pluv/crdt 1.0.2 → 2.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/crdt@1.0.2 build /home/runner/work/pluv/pluv/packages/crdt
+> @pluv/crdt@2.0.0 build /home/runner/work/pluv/pluv/packages/crdt
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 1.46 KB
-ESM ⚡️ Build success in 32ms
+ESM dist/index.mjs 1.51 KB
+ESM ⚡️ Build success in 24ms
 CJS dist/index.js 2.63 KB
-CJS ⚡️ Build success in 32ms
+CJS ⚡️ Build success in 24ms
 DTS Build start
-DTS ⚡️ Build success in 475ms
-DTS dist/index.d.mts 3.48 KB
-DTS dist/index.d.ts  3.48 KB
+DTS ⚡️ Build success in 507ms
+DTS dist/index.d.mts 2.78 KB
+DTS dist/index.d.ts  2.78 KB

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @pluv/crdt
 
+## 2.0.0
+
+### Patch Changes
+
+- 047a1d8: Moved several internal types to `@pluv/types`.
+- Updated dependencies [047a1d8]
+  - @pluv/types@2.0.0
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { Json, Maybe } from '@pluv/types';
+import { Json, CrdtDocLike, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams } from '@pluv/types';
+export { CrdtDocLike, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams } from '@pluv/types';
 
 type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
     __pluvType: () => TJson;
@@ -6,49 +7,20 @@ type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue
 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?: Maybe<string | Uint8Array>;
-}
-interface DocBatchApplyEncodedStateParams {
-    origin?: string;
-    updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
-}
-interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<TStorage>;
-    local: boolean;
-    origin?: string | null;
-    update: string;
-}
-declare abstract class AbstractCrdtDoc<TStorage extends Record<string, CrdtType<any, any>>> {
-    abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
-    abstract batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
-    abstract canRedo(): boolean;
-    abstract canUndo(): boolean;
-    abstract destroy(): void;
-    abstract get(key?: undefined): TStorage;
-    abstract get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
-    abstract getEncodedState(): string;
-    abstract isEmpty(): boolean;
-    abstract rebuildStorage(reference: TStorage): this;
-    abstract redo(): this;
-    abstract subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
-    abstract toJson(): InferCrdtJson<TStorage>;
-    abstract toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
-    abstract track(): this;
-    abstract transact(fn: () => void, origin?: string): this;
-    abstract undo(): this;
-}
+type InferInitialStorageFn<TFactory extends AbstractCrdtDocFactory<any>> = TFactory["_initialStorage"];
+type InferStorage<TFactory extends AbstractCrdtDocFactory<any>> = ReturnType<InferInitialStorageFn<TFactory>>;
+type InferBuilder<TFactory extends AbstractCrdtDocFactory<any>> = Parameters<InferInitialStorageFn<TFactory>>[0];
 
 declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, CrdtType<any, any>>> {
-    abstract getEmpty(): AbstractCrdtDoc<TStorage>;
-    abstract getFactory(initialStorage?: () => TStorage): AbstractCrdtDocFactory<TStorage>;
-    abstract getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+    _initialStorage: (builder: any) => TStorage;
+    constructor(initialStorage: (builder: any) => TStorage);
+    abstract getEmpty(): CrdtDocLike<TStorage>;
+    abstract getFactory(initialStorage?: (builder: any) => TStorage): AbstractCrdtDocFactory<TStorage>;
+    abstract getInitialized(initialStorage?: (builder: any) => TStorage): CrdtDocLike<TStorage>;
     resolveEncodedState(updates: string | string[] | readonly string[]): string | null;
 }
 
-declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
+declare class NoopCrdtDoc implements CrdtDocLike<any> {
     applyEncodedState(params: DocApplyEncodedStateParams): this;
     batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
     canRedo(): boolean;
@@ -68,13 +40,14 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
 }
 
 declare class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
+    constructor(initialStorage?: () => {});
     getEmpty(): NoopCrdtDoc;
-    getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory;
-    getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc;
+    getFactory(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDocFactory;
+    getInitialized(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDoc;
 }
 
 declare const noop: {
     doc: (args?: any) => NoopCrdtDocFactory;
 };
 
-export { AbstractCrdtDoc, AbstractCrdtDocFactory, type CrdtType, type DocApplyEncodedStateParams, type DocBatchApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };
+export { AbstractCrdtDocFactory, type CrdtType, type InferBuilder, type InferCrdtJson, type InferInitialStorageFn, type InferStorage, NoopCrdtDoc, NoopCrdtDocFactory, noop };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { Json, Maybe } from '@pluv/types';
+import { Json, CrdtDocLike, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams } from '@pluv/types';
+export { CrdtDocLike, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams } from '@pluv/types';
 
 type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
     __pluvType: () => TJson;
@@ -6,49 +7,20 @@ type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue
 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?: Maybe<string | Uint8Array>;
-}
-interface DocBatchApplyEncodedStateParams {
-    origin?: string;
-    updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
-}
-interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<TStorage>;
-    local: boolean;
-    origin?: string | null;
-    update: string;
-}
-declare abstract class AbstractCrdtDoc<TStorage extends Record<string, CrdtType<any, any>>> {
-    abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
-    abstract batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
-    abstract canRedo(): boolean;
-    abstract canUndo(): boolean;
-    abstract destroy(): void;
-    abstract get(key?: undefined): TStorage;
-    abstract get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
-    abstract getEncodedState(): string;
-    abstract isEmpty(): boolean;
-    abstract rebuildStorage(reference: TStorage): this;
-    abstract redo(): this;
-    abstract subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
-    abstract toJson(): InferCrdtJson<TStorage>;
-    abstract toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
-    abstract track(): this;
-    abstract transact(fn: () => void, origin?: string): this;
-    abstract undo(): this;
-}
+type InferInitialStorageFn<TFactory extends AbstractCrdtDocFactory<any>> = TFactory["_initialStorage"];
+type InferStorage<TFactory extends AbstractCrdtDocFactory<any>> = ReturnType<InferInitialStorageFn<TFactory>>;
+type InferBuilder<TFactory extends AbstractCrdtDocFactory<any>> = Parameters<InferInitialStorageFn<TFactory>>[0];
 
 declare abstract class AbstractCrdtDocFactory<TStorage extends Record<string, CrdtType<any, any>>> {
-    abstract getEmpty(): AbstractCrdtDoc<TStorage>;
-    abstract getFactory(initialStorage?: () => TStorage): AbstractCrdtDocFactory<TStorage>;
-    abstract getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+    _initialStorage: (builder: any) => TStorage;
+    constructor(initialStorage: (builder: any) => TStorage);
+    abstract getEmpty(): CrdtDocLike<TStorage>;
+    abstract getFactory(initialStorage?: (builder: any) => TStorage): AbstractCrdtDocFactory<TStorage>;
+    abstract getInitialized(initialStorage?: (builder: any) => TStorage): CrdtDocLike<TStorage>;
     resolveEncodedState(updates: string | string[] | readonly string[]): string | null;
 }
 
-declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
+declare class NoopCrdtDoc implements CrdtDocLike<any> {
     applyEncodedState(params: DocApplyEncodedStateParams): this;
     batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
     canRedo(): boolean;
@@ -68,13 +40,14 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
 }
 
 declare class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
+    constructor(initialStorage?: () => {});
     getEmpty(): NoopCrdtDoc;
-    getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory;
-    getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc;
+    getFactory(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDocFactory;
+    getInitialized(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDoc;
 }
 
 declare const noop: {
     doc: (args?: any) => NoopCrdtDocFactory;
 };
 
-export { AbstractCrdtDoc, AbstractCrdtDocFactory, type CrdtType, type DocApplyEncodedStateParams, type DocBatchApplyEncodedStateParams, type DocSubscribeCallbackParams, type InferCrdtJson, NoopCrdtDoc, NoopCrdtDocFactory, noop };
+export { AbstractCrdtDocFactory, type CrdtType, type InferBuilder, type InferCrdtJson, type InferInitialStorageFn, type InferStorage, NoopCrdtDoc, NoopCrdtDocFactory, noop };

package/dist/index.js

@@ -20,7 +20,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  AbstractCrdtDoc: () => AbstractCrdtDoc,
   AbstractCrdtDocFactory: () => AbstractCrdtDocFactory,
   NoopCrdtDoc: () => NoopCrdtDoc,
   NoopCrdtDocFactory: () => NoopCrdtDocFactory,
@@ -28,12 +27,11 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/AbstractCrdtDoc.ts
-var AbstractCrdtDoc = class {
-};
-
 // src/AbstractCrdtDocFactory.ts
 var AbstractCrdtDocFactory = class {
+  constructor(initialStorage) {
+    this._initialStorage = initialStorage;
+  }
   resolveEncodedState(updates) {
     if (typeof updates === "string") return updates;
     if (!updates.length) return null;
@@ -42,7 +40,7 @@ var AbstractCrdtDocFactory = class {
 };
 
 // src/NoopCrdtDoc.ts
-var NoopCrdtDoc = class extends AbstractCrdtDoc {
+var NoopCrdtDoc = class {
   applyEncodedState(params) {
     return this;
   }
@@ -93,6 +91,9 @@ var NoopCrdtDoc = class extends AbstractCrdtDoc {
 
 // src/NoopCrdtDocFactory.ts
 var NoopCrdtDocFactory = class extends AbstractCrdtDocFactory {
+  constructor(initialStorage = () => ({})) {
+    super(initialStorage);
+  }
   getEmpty() {
     return new NoopCrdtDoc();
   }
@@ -110,7 +111,6 @@ var noop = {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  AbstractCrdtDoc,
   AbstractCrdtDocFactory,
   NoopCrdtDoc,
   NoopCrdtDocFactory,

package/dist/index.mjs

@@ -1,9 +1,8 @@
-// src/AbstractCrdtDoc.ts
-var AbstractCrdtDoc = class {
-};
-
 // src/AbstractCrdtDocFactory.ts
 var AbstractCrdtDocFactory = class {
+  constructor(initialStorage) {
+    this._initialStorage = initialStorage;
+  }
   resolveEncodedState(updates) {
     if (typeof updates === "string") return updates;
     if (!updates.length) return null;
@@ -12,7 +11,7 @@ var AbstractCrdtDocFactory = class {
 };
 
 // src/NoopCrdtDoc.ts
-var NoopCrdtDoc = class extends AbstractCrdtDoc {
+var NoopCrdtDoc = class {
   applyEncodedState(params) {
     return this;
   }
@@ -63,6 +62,9 @@ var NoopCrdtDoc = class extends AbstractCrdtDoc {
 
 // src/NoopCrdtDocFactory.ts
 var NoopCrdtDocFactory = class extends AbstractCrdtDocFactory {
+  constructor(initialStorage = () => ({})) {
+    super(initialStorage);
+  }
   getEmpty() {
     return new NoopCrdtDoc();
   }
@@ -79,7 +81,6 @@ var noop = {
   doc: (args) => new NoopCrdtDocFactory()
 };
 export {
-  AbstractCrdtDoc,
   AbstractCrdtDocFactory,
   NoopCrdtDoc,
   NoopCrdtDocFactory,

package/package.json

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

package/src/AbstractCrdtDocFactory.ts

@@ -1,10 +1,20 @@
-import type { AbstractCrdtDoc } from "./AbstractCrdtDoc";
+import type { CrdtDocLike } from "@pluv/types";
 import type { CrdtType } from "./types";
 
 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 getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+    public _initialStorage: (builder: any) => TStorage;
+
+    constructor(initialStorage: (builder: any) => TStorage) {
+        this._initialStorage = initialStorage;
+    }
+
+    public abstract getEmpty(): CrdtDocLike<TStorage>;
+    public abstract getFactory(
+        initialStorage?: (builder: any) => TStorage,
+    ): AbstractCrdtDocFactory<TStorage>;
+    public abstract getInitialized(
+        initialStorage?: (builder: any) => TStorage,
+    ): CrdtDocLike<TStorage>;
 
     public resolveEncodedState(updates: string | string[] | readonly string[]): string | null {
         if (typeof updates === "string") return updates;

package/src/NoopCrdtDoc.ts

@@ -1,11 +1,11 @@
-import type {
+import {
+    CrdtDocLike,
     DocApplyEncodedStateParams,
     DocBatchApplyEncodedStateParams,
     DocSubscribeCallbackParams,
-} from "./AbstractCrdtDoc";
-import { AbstractCrdtDoc } from "./AbstractCrdtDoc";
+} from "@pluv/types";
 
-export class NoopCrdtDoc extends AbstractCrdtDoc<any> {
+export class NoopCrdtDoc implements CrdtDocLike<any> {
     public applyEncodedState(params: DocApplyEncodedStateParams): this {
         return this;
     }

package/src/NoopCrdtDocFactory.ts

@@ -2,15 +2,19 @@ import { AbstractCrdtDocFactory } from "./AbstractCrdtDocFactory";
 import { NoopCrdtDoc } from "./NoopCrdtDoc";
 
 export class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
+    constructor(initialStorage: () => {} = () => ({})) {
+        super(initialStorage);
+    }
+
     public getEmpty(): NoopCrdtDoc {
         return new NoopCrdtDoc();
     }
 
-    public getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory {
+    public getFactory(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDocFactory {
         return this;
     }
 
-    public getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc {
+    public getInitialized(initialStorage?: ((builder: any) => any) | undefined): NoopCrdtDoc {
         return new NoopCrdtDoc();
     }
 }

package/src/index.ts

@@ -1,11 +1,17 @@
-export { AbstractCrdtDoc } from "./AbstractCrdtDoc";
 export type {
+    CrdtDocLike,
     DocApplyEncodedStateParams,
     DocBatchApplyEncodedStateParams,
     DocSubscribeCallbackParams,
-} from "./AbstractCrdtDoc";
+} from "@pluv/types";
 export { AbstractCrdtDocFactory } from "./AbstractCrdtDocFactory";
 export { noop } from "./noop";
 export { NoopCrdtDoc } from "./NoopCrdtDoc";
 export { NoopCrdtDocFactory } from "./NoopCrdtDocFactory";
-export type { CrdtType, InferCrdtJson } from "./types";
+export type {
+    CrdtType,
+    InferBuilder,
+    InferCrdtJson,
+    InferInitialStorageFn,
+    InferStorage,
+} from "./types";

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { Json } from "@pluv/types";
+import { AbstractCrdtDocFactory } from "./AbstractCrdtDocFactory";
 
 export type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<
     TValue,
@@ -19,3 +20,14 @@ export type InferCrdtJson<T extends unknown> =
               : T extends Json
                 ? T
                 : string;
+
+export type InferInitialStorageFn<TFactory extends AbstractCrdtDocFactory<any>> =
+    TFactory["_initialStorage"];
+
+export type InferStorage<TFactory extends AbstractCrdtDocFactory<any>> = ReturnType<
+    InferInitialStorageFn<TFactory>
+>;
+
+export type InferBuilder<TFactory extends AbstractCrdtDocFactory<any>> = Parameters<
+    InferInitialStorageFn<TFactory>
+>[0];

package/src/AbstractCrdtDoc.ts

@@ -1,41 +0,0 @@
-import type { Maybe } from "@pluv/types";
-import type { CrdtType, InferCrdtJson } from "./types";
-
-export interface DocApplyEncodedStateParams {
-    origin?: string;
-    update?: Maybe<string | Uint8Array>;
-}
-
-export interface DocBatchApplyEncodedStateParams {
-    origin?: string;
-    updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
-}
-
-export interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<TStorage>;
-    local: boolean;
-    origin?: string | null;
-    update: string;
-}
-
-export abstract class AbstractCrdtDoc<TStorage extends Record<string, CrdtType<any, any>>> {
-    public abstract applyEncodedState(params: DocApplyEncodedStateParams): this;
-    public abstract batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
-    public abstract canRedo(): boolean;
-    public abstract canUndo(): boolean;
-    public abstract destroy(): void;
-    public abstract get(key?: undefined): TStorage;
-    public abstract get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
-    public abstract getEncodedState(): string;
-    public abstract isEmpty(): boolean;
-    public abstract rebuildStorage(reference: TStorage): this;
-    public abstract redo(): this;
-    public abstract subscribe(
-        listener: (params: DocSubscribeCallbackParams<TStorage>) => void,
-    ): () => void;
-    public abstract toJson(): InferCrdtJson<TStorage>;
-    public abstract toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
-    public abstract track(): this;
-    public abstract transact(fn: () => void, origin?: string): this;
-    public abstract undo(): this;
-}