@dabble/patches 0.3.1 → 0.3.2

package/dist/algorithms/client/makeChange.d.ts

@@ -1,3 +1,3 @@
 import type { JSONPatch } from '../..';
-import type { Change, PatchesSnapshot } from '../../types.js';
-export declare function makeChange<T = any>(snapshot: PatchesSnapshot<T>, mutator: (draft: T, patch: JSONPatch) => void, changeMetadata?: Record<string, any>, maxPayloadBytes?: number): Change[];
+import type { Change, DeepRequired, PatchesSnapshot } from '../../types.js';
+export declare function makeChange<T = any>(snapshot: PatchesSnapshot<T>, mutator: (draft: DeepRequired<T>, patch: JSONPatch) => void, changeMetadata?: Record<string, any>, maxPayloadBytes?: number): Change[];

package/dist/client/PatchesDoc.d.ts

@@ -1,6 +1,6 @@
 import { type Unsubscriber } from '../event-signal.js';
 import type { JSONPatch } from '../json-patch/JSONPatch.js';
-import type { Change, PatchesSnapshot, SyncingState } from '../types.js';
+import type { Change, DeepRequired, PatchesSnapshot, SyncingState } from '../types.js';
 /**
  * Options for creating a PatchesDoc instance
  */
@@ -71,7 +71,7 @@ export declare class PatchesDoc<T extends object = object> {
      * @param mutator Function modifying a draft state.
      * @returns The generated Change object or null if no changes occurred.
      */
-    change(mutator: (draft: T, patch: JSONPatch) => void): Change[];
+    change(mutator: (draft: DeepRequired<T>, patch: JSONPatch) => void): Change[];
     /**
      * Returns the pending changes for this document.
      * @returns The pending changes.

package/dist/json-patch/createJSONPatch.d.ts

@@ -1,3 +1,4 @@
+import type { DeepRequired } from '../types.js';
 import { JSONPatch } from './JSONPatch.js';
 /**
  * Creates a `JSONPatch` instance by tracking changes made to a proxy object within an updater function.
@@ -32,4 +33,4 @@ import { JSONPatch } from './JSONPatch.js';
  * // ]
  * ```
  */
-export declare function createJSONPatch<T>(target: T, updater: (proxy: T, patch: JSONPatch) => void): JSONPatch;
+export declare function createJSONPatch<T>(target: T, updater: (proxy: DeepRequired<T>, patch: JSONPatch) => void): JSONPatch;

package/dist/json-patch/patchProxy.d.ts

@@ -1,3 +1,4 @@
+import type { DeepRequired } from '../types.js';
 import { JSONPatch } from './JSONPatch.js';
 /**
  * Creates a proxy object that can be used in two ways:
@@ -37,5 +38,5 @@ import { JSONPatch } from './JSONPatch.js';
  * @param patch The `JSONPatch` instance to add generated operations to (required for automatic patch generation mode).
  * @returns A proxy object of type T.
  */
-export declare function createPatchProxy<T>(): T;
-export declare function createPatchProxy<T>(target: T, patch: JSONPatch): T;
+export declare function createPatchProxy<T>(): DeepRequired<T>;
+export declare function createPatchProxy<T>(target: T, patch: JSONPatch): DeepRequired<T>;

package/dist/net/PatchesSync.d.ts

@@ -1,23 +1,30 @@
 import { Patches } from '../client/Patches.js';
+import type { PatchesStore } from '../client/PatchesStore.js';
 import type { Change, SyncingState } from '../types.js';
 import type { ConnectionState } from './protocol/types.js';
+import { PatchesWebSocket } from './websocket/PatchesWebSocket.js';
 import type { WebSocketOptions } from './websocket/WebSocketTransport.js';
 export interface PatchesSyncState {
     online: boolean;
     connected: boolean;
     syncing: SyncingState;
 }
+export interface PatchesSyncOptions {
+    subscribeFilter?: (docIds: string[]) => string[];
+    websocket?: WebSocketOptions;
+}
 /**
  * Handles WebSocket connection, document subscriptions, and syncing logic between
  * the Patches instance and the server.
  */
 export declare class PatchesSync {
-    private ws;
-    private patches;
-    private store;
-    private maxPayloadBytes?;
-    private trackedDocs;
-    private _state;
+    protected options?: PatchesSyncOptions | undefined;
+    protected ws: PatchesWebSocket;
+    protected patches: Patches;
+    protected store: PatchesStore;
+    protected maxPayloadBytes?: number;
+    protected trackedDocs: Set<string>;
+    protected _state: PatchesSyncState;
     /**
      * Signal emitted when the sync state changes.
      */
@@ -28,7 +35,7 @@ export declare class PatchesSync {
     readonly onError: import("../event-signal.js").Signal<(error: Error, context?: {
         docId?: string;
     }) => void>;
-    constructor(patches: Patches, url: string, wsOptions?: WebSocketOptions);
+    constructor(patches: Patches, url: string, options?: PatchesSyncOptions | undefined);
     /**
      * Gets the current sync state.
      */

package/dist/net/PatchesSync.js

@@ -50,8 +50,8 @@ let PatchesSync = (() => {
     let _syncDoc_decorators;
     let __receiveCommittedChanges_decorators;
     return _a = class PatchesSync {
-            constructor(patches, url, wsOptions) {
-                this.ws = __runInitializers(this, _instanceExtraInitializers);
+            constructor(patches, url, options) {
+                this.options = (__runInitializers(this, _instanceExtraInitializers), options);
                 this._state = { online: false, connected: false, syncing: null };
                 /**
                  * Signal emitted when the sync state changes.
@@ -64,7 +64,7 @@ let PatchesSync = (() => {
                 this.patches = patches;
                 this.store = patches.store;
                 this.maxPayloadBytes = patches.docOptions?.maxPayloadBytes;
-                this.ws = new PatchesWebSocket(url, wsOptions);
+                this.ws = new PatchesWebSocket(url, options?.websocket);
                 this._state.online = onlineState.isOnline;
                 this.trackedDocs = new Set(patches.trackedDocs);
                 // --- Event Listeners ---
@@ -131,7 +131,10 @@ let PatchesSync = (() => {
                     // Subscribe to active docs
                     if (activeDocIds.length > 0) {
                         try {
-                            await this.ws.subscribe(activeDocIds);
+                            const subscribeIds = this.options?.subscribeFilter?.(activeDocIds) || activeDocIds;
+                            if (subscribeIds.length) {
+                                await this.ws.subscribe(subscribeIds);
+                            }
                         }
                         catch (err) {
                             console.warn('Error subscribing to active docs during sync:', err);
@@ -338,9 +341,17 @@ let PatchesSync = (() => {
                 if (!newIds.length)
                     return;
                 newIds.forEach(id => this.trackedDocs.add(id));
+                let subscribeIds = newIds;
+                // If a subscribe filter is provided, filter out docs that are already tracked
+                if (this.options?.subscribeFilter) {
+                    const alreadyTracked = this.options.subscribeFilter([...this.trackedDocs]);
+                    subscribeIds = subscribeIds.filter(id => !alreadyTracked.includes(id));
+                }
                 if (this.state.connected) {
                     try {
-                        await this.ws.subscribe(newIds);
+                        if (subscribeIds.length) {
+                            await this.ws.subscribe(subscribeIds);
+                        }
                         // Trigger sync for newly tracked docs immediately
                         await Promise.all(newIds.map(id => this.syncDoc(id)));
                     }

package/dist/server/PatchesServer.d.ts

@@ -1,5 +1,5 @@
 import type { JSONPatch } from '../json-patch/JSONPatch.js';
-import type { Change, EditableVersionMetadata, PatchesState } from '../types.js';
+import type { Change, DeepRequired, EditableVersionMetadata, PatchesState } from '../types.js';
 import type { PatchesStoreBackend } from './types.js';
 /**
  * Configuration options for the PatchesServer.
@@ -61,7 +61,7 @@ export declare class PatchesServer {
      * @param mutator
      * @returns
      */
-    change<T = Record<string, any>>(docId: string, mutator: (draft: T, patch: JSONPatch) => void, metadata?: Record<string, any>): Promise<Change | null>;
+    change<T = Record<string, any>>(docId: string, mutator: (draft: DeepRequired<T>, patch: JSONPatch) => void, metadata?: Record<string, any>): Promise<Change | null>;
     /**
      * Deletes a document.
      * @param docId The document ID.

package/dist/types.d.ts

@@ -124,4 +124,14 @@ export interface ListVersionsOptions {
     /** Filter by the group ID (branch ID or offline batch ID). */
     groupId?: string;
 }
+/**
+ * Makes optional object properties required for Proxies that allow setting deep properties.
+ */
+export type DeepRequired<T> = {
+    [P in keyof T as undefined extends T[P] ? never : P]: T[P] extends object ? DeepRequired<T[P]> : T[P];
+} & {
+    [P in keyof T as undefined extends T[P] ? T[P] extends object | undefined ? T[P] extends Function | Date | RegExp | Array<any> | null | undefined ? never : P : never : never]-?: T[P] extends object | undefined ? DeepRequired<T[P]> : T[P];
+} & {
+    [P in keyof T as undefined extends T[P] ? T[P] extends object | undefined ? T[P] extends Function | Date | RegExp | Array<any> | null | undefined ? P : never : P : never]?: T[P];
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dabble/patches",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Immutable JSON Patch implementation based on RFC 6902 supporting operational transformation and last-writer-wins",
   "author": "Jacob Wright <jacwright@gmail.com>",
   "bugs": {
@@ -56,6 +56,8 @@
     "prepare": "npm run build",
     "test": "vitest run",
     "tdd": "vitest",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
     "lint": "eslint src tests",
     "lint:fix": "eslint src tests --fix"
   },
@@ -67,16 +69,16 @@
     "simplified-concurrency": "^0.2.0"
   },
   "devDependencies": {
-    "@sveltejs/package": "^2.3.11",
+    "@sveltejs/package": "^2.5.0",
     "@types/simple-peer": "^9.11.8",
-    "@typescript-eslint/eslint-plugin": "^8.33.1",
-    "@typescript-eslint/parser": "^8.33.1",
-    "eslint": "^9.28.0",
-    "fake-indexeddb": "^6.0.0",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vite-plugin-dts": "^4.5.3",
-    "vitest": "^3.1.3"
+    "@typescript-eslint/eslint-plugin": "^8.42.0",
+    "@typescript-eslint/parser": "^8.42.0",
+    "eslint": "^9.35.0",
+    "fake-indexeddb": "^6.2.2",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.4",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4"
   }
 }