@pluv/crdt 1.0.0 → 1.0.2

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/crdt@1.0.0 build /home/runner/work/pluv/pluv/packages/crdt
+> @pluv/crdt@1.0.2 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.26 KB
-ESM ⚡️ Build success in 53ms
-CJS dist/index.js 2.43 KB
-CJS ⚡️ Build success in 53ms
+ESM dist/index.mjs 1.46 KB
+ESM ⚡️ Build success in 32ms
+CJS dist/index.js 2.63 KB
+CJS ⚡️ Build success in 32ms
 DTS Build start
-DTS ⚡️ Build success in 505ms
-DTS dist/index.d.mts 3.32 KB
-DTS dist/index.d.ts  3.32 KB
+DTS ⚡️ Build success in 475ms
+DTS dist/index.d.mts 3.48 KB
+DTS dist/index.d.ts  3.48 KB

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @pluv/crdt
 
+## 1.0.2
+
+### Patch Changes
+
+- @pluv/types@1.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- @pluv/types@1.0.1
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -15,26 +15,27 @@ interface DocBatchApplyEncodedStateParams {
     origin?: string;
     updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
 }
-interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<T>;
+interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
+    doc: AbstractCrdtDoc<TStorage>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
-declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
+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): T;
-    abstract get<TKey extends keyof T>(key: TKey): T[TKey];
+    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<T>) => void): () => void;
-    abstract toJson(): InferCrdtJson<T>;
-    abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
+    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;
@@ -43,8 +44,8 @@ declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, an
 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>;
     abstract getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+    resolveEncodedState(updates: string | string[] | readonly string[]): string | null;
 }
 
 declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
@@ -57,9 +58,10 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
     get<TKey extends never>(key: TKey): {}[TKey];
     getEncodedState(): string;
     isEmpty(): boolean;
+    rebuildStorage(): this;
     redo(): this;
-    subscribe(listener: (params: DocSubscribeCallbackParams<{}>) => void): () => void;
-    toJson(): {};
+    subscribe(listener: (params: DocSubscribeCallbackParams<any>) => void): () => void;
+    toJson(): any;
     track(): this;
     transact(fn: () => void, origin?: string | undefined): this;
     undo(): this;
@@ -67,9 +69,8 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
 
 declare class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
     getEmpty(): NoopCrdtDoc;
-    getFactory(initialStorage?: (() => {}) | undefined): NoopCrdtDocFactory;
-    getFresh(): NoopCrdtDoc;
-    getInitialized(initialStorage?: (() => {}) | undefined): NoopCrdtDoc;
+    getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory;
+    getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc;
 }
 
 declare const noop: {

package/dist/index.d.ts

@@ -15,26 +15,27 @@ interface DocBatchApplyEncodedStateParams {
     origin?: string;
     updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
 }
-interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<T>;
+interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
+    doc: AbstractCrdtDoc<TStorage>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
-declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
+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): T;
-    abstract get<TKey extends keyof T>(key: TKey): T[TKey];
+    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<T>) => void): () => void;
-    abstract toJson(): InferCrdtJson<T>;
-    abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
+    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;
@@ -43,8 +44,8 @@ declare abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, an
 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>;
     abstract getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+    resolveEncodedState(updates: string | string[] | readonly string[]): string | null;
 }
 
 declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
@@ -57,9 +58,10 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
     get<TKey extends never>(key: TKey): {}[TKey];
     getEncodedState(): string;
     isEmpty(): boolean;
+    rebuildStorage(): this;
     redo(): this;
-    subscribe(listener: (params: DocSubscribeCallbackParams<{}>) => void): () => void;
-    toJson(): {};
+    subscribe(listener: (params: DocSubscribeCallbackParams<any>) => void): () => void;
+    toJson(): any;
     track(): this;
     transact(fn: () => void, origin?: string | undefined): this;
     undo(): this;
@@ -67,9 +69,8 @@ declare class NoopCrdtDoc extends AbstractCrdtDoc<any> {
 
 declare class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
     getEmpty(): NoopCrdtDoc;
-    getFactory(initialStorage?: (() => {}) | undefined): NoopCrdtDocFactory;
-    getFresh(): NoopCrdtDoc;
-    getInitialized(initialStorage?: (() => {}) | undefined): NoopCrdtDoc;
+    getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory;
+    getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc;
 }
 
 declare const noop: {

package/dist/index.js

@@ -34,6 +34,11 @@ var AbstractCrdtDoc = class {
 
 // src/AbstractCrdtDocFactory.ts
 var AbstractCrdtDocFactory = class {
+  resolveEncodedState(updates) {
+    if (typeof updates === "string") return updates;
+    if (!updates.length) return null;
+    return this.getEmpty().batchApplyEncodedState({ updates }).getEncodedState();
+  }
 };
 
 // src/NoopCrdtDoc.ts
@@ -62,6 +67,9 @@ var NoopCrdtDoc = class extends AbstractCrdtDoc {
   isEmpty() {
     return true;
   }
+  rebuildStorage() {
+    return this;
+  }
   redo() {
     return this;
   }
@@ -91,9 +99,6 @@ var NoopCrdtDocFactory = class extends AbstractCrdtDocFactory {
   getFactory(initialStorage) {
     return this;
   }
-  getFresh() {
-    return new NoopCrdtDoc();
-  }
   getInitialized(initialStorage) {
     return new NoopCrdtDoc();
   }

package/dist/index.mjs

@@ -4,6 +4,11 @@ var AbstractCrdtDoc = class {
 
 // src/AbstractCrdtDocFactory.ts
 var AbstractCrdtDocFactory = class {
+  resolveEncodedState(updates) {
+    if (typeof updates === "string") return updates;
+    if (!updates.length) return null;
+    return this.getEmpty().batchApplyEncodedState({ updates }).getEncodedState();
+  }
 };
 
 // src/NoopCrdtDoc.ts
@@ -32,6 +37,9 @@ var NoopCrdtDoc = class extends AbstractCrdtDoc {
   isEmpty() {
     return true;
   }
+  rebuildStorage() {
+    return this;
+  }
   redo() {
     return this;
   }
@@ -61,9 +69,6 @@ var NoopCrdtDocFactory = class extends AbstractCrdtDocFactory {
   getFactory(initialStorage) {
     return this;
   }
-  getFresh() {
-    return new NoopCrdtDoc();
-  }
   getInitialized(initialStorage) {
     return new NoopCrdtDoc();
   }

package/package.json

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

package/src/AbstractCrdtDoc.ts

@@ -11,27 +11,30 @@ export interface DocBatchApplyEncodedStateParams {
     updates?: Maybe<readonly Maybe<string | Uint8Array>[]>;
 }
 
-export interface DocSubscribeCallbackParams<T extends Record<string, CrdtType<any, any>>> {
-    doc: AbstractCrdtDoc<T>;
+export interface DocSubscribeCallbackParams<TStorage extends Record<string, CrdtType<any, any>>> {
+    doc: AbstractCrdtDoc<TStorage>;
     local: boolean;
     origin?: string | null;
     update: string;
 }
 
-export abstract class AbstractCrdtDoc<T extends Record<string, CrdtType<any, any>>> {
+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): T;
-    public abstract get<TKey extends keyof T>(key: TKey): T[TKey];
+    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<T>) => void): () => void;
-    public abstract toJson(): InferCrdtJson<T>;
-    public abstract toJson<TKey extends keyof T>(type: TKey): InferCrdtJson<T[TKey]>;
+    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;

package/src/AbstractCrdtDocFactory.ts

@@ -4,6 +4,12 @@ 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 getFresh(): AbstractCrdtDoc<TStorage>;
     public abstract getInitialized(initialStorage?: () => TStorage): AbstractCrdtDoc<TStorage>;
+
+    public resolveEncodedState(updates: string | string[] | readonly string[]): string | null {
+        if (typeof updates === "string") return updates;
+        if (!updates.length) return null;
+
+        return this.getEmpty().batchApplyEncodedState({ updates }).getEncodedState();
+    }
 }

package/src/NoopCrdtDoc.ts

@@ -40,15 +40,19 @@ export class NoopCrdtDoc extends AbstractCrdtDoc<any> {
         return true;
     }
 
+    public rebuildStorage(): this {
+        return this;
+    }
+
     public redo(): this {
         return this;
     }
 
-    public subscribe(listener: (params: DocSubscribeCallbackParams<{}>) => void): () => void {
+    public subscribe(listener: (params: DocSubscribeCallbackParams<any>) => void): () => void {
         return () => undefined;
     }
 
-    public toJson(): {} {
+    public toJson(): any {
         return {};
     }
 

package/src/NoopCrdtDocFactory.ts

@@ -6,15 +6,11 @@ export class NoopCrdtDocFactory extends AbstractCrdtDocFactory<any> {
         return new NoopCrdtDoc();
     }
 
-    public getFactory(initialStorage?: (() => {}) | undefined): NoopCrdtDocFactory {
+    public getFactory(initialStorage?: (() => any) | undefined): NoopCrdtDocFactory {
         return this;
     }
 
-    public getFresh(): NoopCrdtDoc {
-        return new NoopCrdtDoc();
-    }
-
-    public getInitialized(initialStorage?: (() => {}) | undefined): NoopCrdtDoc {
+    public getInitialized(initialStorage?: (() => any) | undefined): NoopCrdtDoc {
         return new NoopCrdtDoc();
     }
 }

package/src/types.ts

@@ -1,6 +1,9 @@
 import type { Json } from "@pluv/types";
 
-export type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<TValue, "__pluvType"> & {
+export type CrdtType<TValue extends unknown, TJson extends unknown = any> = Omit<
+    TValue,
+    "__pluvType"
+> & {
     __pluvType: () => TJson;
 };