@dabble/patches 0.2.19 → 0.2.20

package/dist/net/protocol/types.d.ts

@@ -1,5 +1,5 @@
 import type { Unsubscriber } from '../../event-signal.js';
-import type { Change, ListVersionsOptions, PatchesSnapshot, PatchesState, VersionMetadata } from '../../types';
+import type { Change, EditableVersionMetadata, ListVersionsOptions, PatchesSnapshot, PatchesState, VersionMetadata } from '../../types';
 /**
  * Represents the possible states of a network transport connection.
  * - 'connecting': Connection is being established
@@ -117,15 +117,15 @@ export interface PatchesAPI {
     /** Delete a document. */
     deleteDoc(docId: string): Promise<void>;
     /** Create a new named version snapshot of a document's current state. */
-    createVersion(docId: string, name: string): Promise<string>;
+    createVersion(docId: string, metadata: EditableVersionMetadata): Promise<string>;
     /** List metadata for saved versions of a document. */
     listVersions(docId: string, options?: ListVersionsOptions): Promise<VersionMetadata[]>;
     /** Get the state snapshot for a specific version ID. */
     getVersionState(docId: string, versionId: string): Promise<PatchesState>;
     /** Get the original Change objects associated with a specific version ID. */
     getVersionChanges(docId: string, versionId: string): Promise<Change[]>;
-    /** Update the name of a specific version. */
-    updateVersion(docId: string, versionId: string, updates: Pick<VersionMetadata, 'name'>): Promise<void>;
+    /** Update the name and other metadata of a specific version. */
+    updateVersion(docId: string, versionId: string, metadata: EditableVersionMetadata): Promise<void>;
 }
 export interface PatchesNotificationParams {
     docId: string;

package/dist/net/websocket/PatchesWebSocket.d.ts

@@ -1,5 +1,5 @@
 import { type Signal } from '../../event-signal.js';
-import type { Change, ListVersionsOptions, PatchesSnapshot, VersionMetadata } from '../../types.js';
+import type { Change, EditableVersionMetadata, ListVersionsOptions, PatchesSnapshot, VersionMetadata } from '../../types.js';
 import type { ConnectionState, PatchesAPI, PatchesNotificationParams } from '../protocol/types.js';
 import { type WebSocketOptions } from './WebSocketTransport.js';
 /**
@@ -74,7 +74,7 @@ export declare class PatchesWebSocket implements PatchesAPI {
      * @param name - A descriptive name for the version.
      * @returns A promise resolving with the unique ID of the newly created version.
      */
-    createVersion(docId: string, name: string): Promise<string>;
+    createVersion(docId: string, metadata: EditableVersionMetadata): Promise<string>;
     /**
      * Lists metadata for saved versions of a document.
      * @param docId - The ID of the document.
@@ -103,5 +103,31 @@ export declare class PatchesWebSocket implements PatchesAPI {
      * @param name - The new name for the version.
      * @returns A promise resolving when the update is confirmed.
      */
-    updateVersion(docId: string, versionId: string, updates: Pick<VersionMetadata, 'name'>): Promise<void>;
+    updateVersion(docId: string, versionId: string, metadata: EditableVersionMetadata): Promise<void>;
+    /**
+     * Lists all branches for a document.
+     * @param docId - The ID of the document.
+     * @returns A promise resolving with an array of branch metadata objects.
+     */
+    listBranches(docId: string): Promise<VersionMetadata[]>;
+    /**
+     * Creates a new branch for a document.
+     * @param docId - The ID of the document.
+     * @param rev - The revision number to base the new branch on.
+     * @param metadata - Optional metadata for the new branch.
+     * @returns A promise resolving with the unique ID of the newly created branch.
+     */
+    createBranch(docId: string, rev: number, metadata?: EditableVersionMetadata): Promise<string>;
+    /**
+     * Closes a branch on the server.
+     * @param branchId - The ID of the branch to close.
+     * @returns A promise resolving when the branch is closed.
+     */
+    closeBranch(branchId: string): Promise<void>;
+    /**
+     * Merges a branch on the server.
+     * @param branchId - The ID of the branch to merge.
+     * @returns A promise resolving when the merge is confirmed.
+     */
+    mergeBranch(branchId: string): Promise<void>;
 }

package/dist/net/websocket/PatchesWebSocket.js

@@ -101,8 +101,8 @@ export class PatchesWebSocket {
      * @param name - A descriptive name for the version.
      * @returns A promise resolving with the unique ID of the newly created version.
      */
-    async createVersion(docId, name) {
-        return this.rpc.request('createVersion', { docId, name });
+    async createVersion(docId, metadata) {
+        return this.rpc.request('createVersion', { docId, metadata });
     }
     /**
      * Lists metadata for saved versions of a document.
@@ -138,7 +138,42 @@ export class PatchesWebSocket {
      * @param name - The new name for the version.
      * @returns A promise resolving when the update is confirmed.
      */
-    async updateVersion(docId, versionId, updates) {
-        return this.rpc.request('updateVersion', { docId, versionId, updates });
+    async updateVersion(docId, versionId, metadata) {
+        return this.rpc.request('updateVersion', { docId, versionId, metadata });
+    }
+    // === Branch Operations ===
+    /**
+     * Lists all branches for a document.
+     * @param docId - The ID of the document.
+     * @returns A promise resolving with an array of branch metadata objects.
+     */
+    async listBranches(docId) {
+        return this.rpc.request('listBranches', { docId });
+    }
+    /**
+     * Creates a new branch for a document.
+     * @param docId - The ID of the document.
+     * @param rev - The revision number to base the new branch on.
+     * @param metadata - Optional metadata for the new branch.
+     * @returns A promise resolving with the unique ID of the newly created branch.
+     */
+    async createBranch(docId, rev, metadata) {
+        return this.rpc.request('createBranch', { docId, rev, metadata });
+    }
+    /**
+     * Closes a branch on the server.
+     * @param branchId - The ID of the branch to close.
+     * @returns A promise resolving when the branch is closed.
+     */
+    async closeBranch(branchId) {
+        return this.rpc.request('closeBranch', { branchId });
+    }
+    /**
+     * Merges a branch on the server.
+     * @param branchId - The ID of the branch to merge.
+     * @returns A promise resolving when the merge is confirmed.
+     */
+    async mergeBranch(branchId) {
+        return this.rpc.request('mergeBranch', { branchId });
     }
 }

package/dist/net/websocket/WebSocketServer.d.ts

@@ -1,7 +1,7 @@
 import type { PatchesBranchManager } from '../../server/PatchesBranchManager.js';
 import type { PatchesHistoryManager } from '../../server/PatchesHistoryManager.js';
 import type { PatchesServer } from '../../server/PatchesServer.js';
-import type { Change, ListVersionsOptions, VersionMetadata } from '../../types.js';
+import type { Change, EditableVersionMetadata, ListVersionsOptions } from '../../types.js';
 import { JSONRPCServer } from '../protocol/JSONRPCServer.js';
 import type { ServerTransport } from '../protocol/types.js';
 import type { AuthorizationProvider } from './AuthorizationProvider.js';
@@ -35,6 +35,8 @@ export declare class WebSocketServer {
     protected assertAccess(connectionId: string, docId: string, kind: 'read' | 'write', method: string, params?: Record<string, any>): Promise<void>;
     protected assertRead(connectionId: string, docId: string, method: string, params?: Record<string, any>): Promise<void>;
     protected assertWrite(connectionId: string, docId: string, method: string, params?: Record<string, any>): Promise<void>;
+    protected assertHistoryEnabled(): void;
+    protected assertBranchingEnabled(): void;
     /**
      * Subscribes the client to one or more documents to receive real-time updates.
      * @param connectionId - The ID of the connection making the request
@@ -98,15 +100,15 @@ export declare class WebSocketServer {
     listVersions(connectionId: string, params: {
         docId: string;
         options?: ListVersionsOptions;
-    }): Promise<VersionMetadata[]>;
+    }): Promise<import("../../types.js").VersionMetadata[]>;
     createVersion(connectionId: string, params: {
         docId: string;
-        name: string;
+        metadata: EditableVersionMetadata;
     }): Promise<string>;
     updateVersion(connectionId: string, params: {
         docId: string;
         versionId: string;
-        updates: Pick<VersionMetadata, 'name'>;
+        metadata: EditableVersionMetadata;
     }): Promise<void>;
     getStateAtVersion(connectionId: string, params: {
         docId: string;
@@ -131,12 +133,10 @@ export declare class WebSocketServer {
     createBranch(connectionId: string, params: {
         docId: string;
         rev: number;
-        branchName?: string;
-        metadata?: Record<string, any>;
+        metadata?: EditableVersionMetadata;
     }): Promise<string>;
     closeBranch(connectionId: string, params: {
         branchId: string;
-        status?: 'merged' | 'closed';
     }): Promise<void>;
     mergeBranch(connectionId: string, params: {
         branchId: string;

package/dist/net/websocket/WebSocketServer.js

@@ -54,6 +54,16 @@ export class WebSocketServer {
     assertWrite(connectionId, docId, method, params) {
         return this.assertAccess(connectionId, docId, 'write', method, params);
     }
+    assertHistoryEnabled() {
+        if (!this.history) {
+            throw new Error('History is not enabled');
+        }
+    }
+    assertBranchingEnabled() {
+        if (!this.branches) {
+            throw new Error('Branching is not enabled');
+        }
+    }
     // --- Patches API Methods ---
     // === Subscription Operations ===
     /**
@@ -154,31 +164,37 @@ export class WebSocketServer {
     // History Manager wrappers
     // ---------------------------------------------------------------------------
     async listVersions(connectionId, params) {
+        this.assertHistoryEnabled();
         const { docId, options } = params;
         await this.assertRead(connectionId, docId, 'listVersions', params);
         return this.history.listVersions(docId, options ?? {});
     }
     async createVersion(connectionId, params) {
-        const { docId, name } = params;
+        this.assertHistoryEnabled();
+        const { docId, metadata } = params;
         await this.assertWrite(connectionId, docId, 'createVersion', params);
-        return this.history.createVersion(docId, name);
+        return this.history.createVersion(docId, metadata);
     }
     async updateVersion(connectionId, params) {
-        const { docId, versionId, updates } = params;
+        this.assertHistoryEnabled();
+        const { docId, versionId, metadata } = params;
         await this.assertWrite(connectionId, docId, 'updateVersion', params);
-        return this.history.updateVersion(docId, versionId, updates);
+        return this.history.updateVersion(docId, versionId, metadata);
     }
     async getStateAtVersion(connectionId, params) {
+        this.assertHistoryEnabled();
         const { docId, versionId } = params;
         await this.assertRead(connectionId, docId, 'getStateAtVersion', params);
         return this.history.getStateAtVersion(docId, versionId);
     }
     async getChangesForVersion(connectionId, params) {
+        this.assertHistoryEnabled();
         const { docId, versionId } = params;
         await this.assertRead(connectionId, docId, 'getChangesForVersion', params);
         return this.history.getChangesForVersion(docId, versionId);
     }
     async listServerChanges(connectionId, params) {
+        this.assertHistoryEnabled();
         const { docId, options } = params;
         await this.assertRead(connectionId, docId, 'listServerChanges', params);
         return this.history.listServerChanges(docId, options ?? {});
@@ -187,21 +203,25 @@ export class WebSocketServer {
     // Branch Manager wrappers
     // ---------------------------------------------------------------------------
     async listBranches(connectionId, params) {
+        this.assertBranchingEnabled();
         const { docId } = params;
         await this.assertRead(connectionId, docId, 'listBranches', params);
         return this.branches.listBranches(docId);
     }
     async createBranch(connectionId, params) {
-        const { docId } = params;
+        this.assertBranchingEnabled();
+        const { docId, rev, metadata } = params;
         await this.assertWrite(connectionId, docId, 'createBranch', params);
-        return this.branches.createBranch(docId, params.rev, params.branchName, params.metadata);
+        return this.branches.createBranch(docId, rev, metadata);
     }
     async closeBranch(connectionId, params) {
+        this.assertBranchingEnabled();
         const { branchId } = params;
         await this.assertWrite(connectionId, branchId, 'closeBranch', params);
-        return this.branches.closeBranch(branchId, params.status ?? 'closed');
+        return this.branches.closeBranch(branchId, 'closed');
     }
     async mergeBranch(connectionId, params) {
+        this.assertBranchingEnabled();
         const { branchId } = params;
         await this.assertWrite(connectionId, branchId, 'mergeBranch', params);
         return this.branches.mergeBranch(branchId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dabble/patches",
-  "version": "0.2.19",
+  "version": "0.2.20",
   "description": "Immutable JSON Patch implementation based on RFC 6902 supporting operational transformation and last-writer-wins",
   "author": "Jacob Wright <jacwright@gmail.com>",
   "bugs": {