@dabble/patches 0.4.4 → 0.4.6

package/dist/net/websocket/AuthorizationProvider.js

@@ -1,19 +1,14 @@
-/**
- * A permissive provider that authorises every action.
- * WARNING: This should only be used for development/testing purposes.
- * Never use this in production as it allows unrestricted access.
- */
-export const allowAll = {
-    canAccess: () => true,
+import "../../chunk-IZ2YBCUP.js";
+const allowAll = {
+  canAccess: () => true
 };
-/**
- * A secure default provider that denies all access.
- * This forces developers to explicitly implement proper authorization.
- * Use this as the default to ensure security by default.
- */
-export const denyAll = {
-    canAccess: () => {
-        console.warn('Authorization check failed: No authorization provider configured. Access denied.');
-        return false;
-    },
+const denyAll = {
+  canAccess: () => {
+    console.warn("Authorization check failed: No authorization provider configured. Access denied.");
+    return false;
+  }
+};
+export {
+  allowAll,
+  denyAll
 };

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

@@ -1,20 +1,23 @@
-import { type Signal } from '../../event-signal.js';
-import type { Change, EditableVersionMetadata, ListVersionsOptions, PatchesSnapshot, PatchesState, VersionMetadata } from '../../types.js';
-import type { ConnectionState, PatchesAPI } from '../protocol/types.js';
-import { type WebSocketOptions } from './WebSocketTransport.js';
+import { Signal } from '../../event-signal.js';
+import { PatchesClient } from '../PatchesClient.js';
+import { ConnectionState } from '../protocol/types.js';
+import { WebSocketTransport, WebSocketOptions } from './WebSocketTransport.js';
+import '../../types.js';
+import '../../json-patch/JSONPatch.js';
+import '@dabble/delta';
+import '../../json-patch/types.js';
+import '../protocol/JSONRPCClient.js';
+
 /**
  * High-level client for the Patches real-time collaboration service.
  * This class provides document subscription, patch notification handling,
  * versioning, and other OT-specific functionality
  * over a WebSocket connection.
  */
-export declare class PatchesWebSocket implements PatchesAPI {
-    private rpc;
-    private transport;
+declare class PatchesWebSocket extends PatchesClient {
+    transport: WebSocketTransport;
     /** Signal emitted when the underlying WebSocket connection state changes. */
     readonly onStateChange: Signal<(state: ConnectionState) => void>;
-    /** Signal emitted when the server pushes document changes. */
-    readonly onChangesCommitted: Signal<(docId: string, changes: Change[]) => void>;
     /**
      * Creates a new Patches WebSocket client instance.
      * @param url - The WebSocket server URL to connect to
@@ -30,104 +33,6 @@ export declare class PatchesWebSocket implements PatchesAPI {
      * Terminates the connection to the Patches server.
      */
     disconnect(): void;
-    /**
-     * Subscribes the client to one or more documents to receive real-time updates.
-     * @param ids - Document ID or IDs to subscribe to.
-     * @returns A promise resolving with the list of successfully subscribed document IDs.
-     */
-    subscribe(ids: string | string[]): Promise<string[]>;
-    /**
-     * Unsubscribes the client from one or more documents.
-     * @param ids - Document ID or IDs to unsubscribe from.
-     * @returns A promise resolving when the unsubscription is confirmed.
-     */
-    unsubscribe(ids: string | string[]): Promise<void>;
-    /**
-     * Gets the latest state (content and revision) of a document.
-     * @param docId - The ID of the document.
-     * @returns A promise resolving with the document snapshot.
-     */
-    getDoc(docId: string, atRev?: number): Promise<PatchesState>;
-    /**
-     * Gets changes that occurred for a document after a specific revision number.
-     * @param docId - The ID of the document.
-     * @param rev - The revision number after which to fetch changes.
-     * @returns A promise resolving with an array of changes.
-     */
-    getChangesSince(docId: string, rev: number): Promise<Change[]>;
-    /**
-     * Applies a set of client-generated changes to a document on the server.
-     * @param docId - The ID of the document.
-     * @param changes - An array of changes to apply.
-     * @returns A promise resolving with the changes as committed by the server (potentially transformed).
-     */
-    commitChanges(docId: string, changes: Change[]): Promise<Change[]>;
-    /**
-     * Deletes a document on the server.
-     * @param docId - The ID of the document to delete.
-     * @returns A promise resolving when the deletion is confirmed.
-     */
-    deleteDoc(docId: string): Promise<void>;
-    /**
-     * Creates a named version snapshot of a document's current state on the server.
-     * @param docId - The ID of the document.
-     * @param name - A descriptive name for the version.
-     * @returns A promise resolving with the unique ID of the newly created version.
-     */
-    createVersion(docId: string, metadata: EditableVersionMetadata): Promise<string>;
-    /**
-     * Lists metadata for saved versions of a document.
-     * @param docId - The ID of the document.
-     * @param options - Options for filtering or pagination (e.g., limit, offset).
-     * @returns A promise resolving with an array of version metadata objects.
-     */
-    listVersions(docId: string, options?: ListVersionsOptions): Promise<VersionMetadata[]>;
-    /**
-     * Gets the document state snapshot corresponding to a specific version ID.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version to retrieve.
-     * @returns A promise resolving with the document snapshot for that version.
-     */
-    getVersionState(docId: string, versionId: string): Promise<PatchesSnapshot>;
-    /**
-     * Gets the original changes associated with a specific version ID.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version.
-     * @returns A promise resolving with an array of changes that constitute that version.
-     */
-    getVersionChanges(docId: string, versionId: string): Promise<Change[]>;
-    /**
-     * Updates the name of a specific version.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version to update.
-     * @param name - The new name for the version.
-     * @returns A promise resolving when the update is confirmed.
-     */
-    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>;
 }
+
+export { PatchesWebSocket };

package/dist/net/websocket/PatchesWebSocket.js

@@ -1,185 +1,38 @@
-import { signal } from '../../event-signal.js';
-import { JSONRPCClient } from '../protocol/JSONRPCClient.js';
-import { WebSocketTransport } from './WebSocketTransport.js';
-/**
- * High-level client for the Patches real-time collaboration service.
- * This class provides document subscription, patch notification handling,
- * versioning, and other OT-specific functionality
- * over a WebSocket connection.
- */
-export class PatchesWebSocket {
-    rpc;
-    transport;
-    // --- Public Signals ---
-    /** Signal emitted when the underlying WebSocket connection state changes. */
-    onStateChange;
-    /** Signal emitted when the server pushes document changes. */
-    onChangesCommitted = signal();
-    /**
-     * Creates a new Patches WebSocket client instance.
-     * @param url - The WebSocket server URL to connect to
-     * @param wsOptions - Optional configuration for the underlying WebSocket connection
-     */
-    constructor(url, wsOptions) {
-        this.transport = new WebSocketTransport(url, wsOptions);
-        this.rpc = new JSONRPCClient(this.transport);
-        this.onStateChange = this.transport.onStateChange;
-        // Register handlers for server-sent notifications
-        // Note: Type assertions might be needed if rpc.on doesn't infer strongly enough
-        this.rpc.on('changesCommitted', (params) => {
-            const { docId, changes } = params;
-            this.onChangesCommitted.emit(docId, changes);
-        });
-    }
-    // --- Connection Management ---
-    /**
-     * Establishes a connection to the Patches server.
-     * @returns A promise that resolves when the connection is established
-     */
-    async connect() {
-        await this.transport.connect();
-    }
-    /**
-     * Terminates the connection to the Patches server.
-     */
-    disconnect() {
-        // Unsubscribe rpc listeners? JSONRPCClient should handle this if transport disconnects.
-        this.transport.disconnect();
-        // Consider clearing signal listeners here if needed, though they are instance-based.
-    }
-    // --- Patches API Methods ---
-    // === Subscription Operations ===
-    /**
-     * Subscribes the client to one or more documents to receive real-time updates.
-     * @param ids - Document ID or IDs to subscribe to.
-     * @returns A promise resolving with the list of successfully subscribed document IDs.
-     */
-    async subscribe(ids) {
-        return this.rpc.request('subscribe', { ids });
-    }
-    /**
-     * Unsubscribes the client from one or more documents.
-     * @param ids - Document ID or IDs to unsubscribe from.
-     * @returns A promise resolving when the unsubscription is confirmed.
-     */
-    async unsubscribe(ids) {
-        return this.rpc.request('unsubscribe', { ids });
-    }
-    // === Document Operations ===
-    /**
-     * Gets the latest state (content and revision) of a document.
-     * @param docId - The ID of the document.
-     * @returns A promise resolving with the document snapshot.
-     */
-    async getDoc(docId, atRev) {
-        return this.rpc.request('getDoc', { docId, atRev });
-    }
-    /**
-     * Gets changes that occurred for a document after a specific revision number.
-     * @param docId - The ID of the document.
-     * @param rev - The revision number after which to fetch changes.
-     * @returns A promise resolving with an array of changes.
-     */
-    async getChangesSince(docId, rev) {
-        return this.rpc.request('getChangesSince', { docId, rev });
-    }
-    /**
-     * Applies a set of client-generated changes to a document on the server.
-     * @param docId - The ID of the document.
-     * @param changes - An array of changes to apply.
-     * @returns A promise resolving with the changes as committed by the server (potentially transformed).
-     */
-    async commitChanges(docId, changes) {
-        return this.rpc.request('commitChanges', { docId, changes });
-    }
-    /**
-     * Deletes a document on the server.
-     * @param docId - The ID of the document to delete.
-     * @returns A promise resolving when the deletion is confirmed.
-     */
-    async deleteDoc(docId) {
-        return this.rpc.request('deleteDoc', { docId });
-    }
-    // === Version Operations ===
-    /**
-     * Creates a named version snapshot of a document's current state on the server.
-     * @param docId - The ID of the document.
-     * @param name - A descriptive name for the version.
-     * @returns A promise resolving with the unique ID of the newly created version.
-     */
-    async createVersion(docId, metadata) {
-        return this.rpc.request('createVersion', { docId, metadata });
-    }
-    /**
-     * Lists metadata for saved versions of a document.
-     * @param docId - The ID of the document.
-     * @param options - Options for filtering or pagination (e.g., limit, offset).
-     * @returns A promise resolving with an array of version metadata objects.
-     */
-    async listVersions(docId, options) {
-        return this.rpc.request('listVersions', { docId, options });
-    }
-    /**
-     * Gets the document state snapshot corresponding to a specific version ID.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version to retrieve.
-     * @returns A promise resolving with the document snapshot for that version.
-     */
-    async getVersionState(docId, versionId) {
-        return this.rpc.request('getVersionState', { docId, versionId });
-    }
-    /**
-     * Gets the original changes associated with a specific version ID.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version.
-     * @returns A promise resolving with an array of changes that constitute that version.
-     */
-    async getVersionChanges(docId, versionId) {
-        return this.rpc.request('getVersionChanges', { docId, versionId });
-    }
-    /**
-     * Updates the name of a specific version.
-     * @param docId - The ID of the document.
-     * @param versionId - The ID of the version to update.
-     * @param name - The new name for the version.
-     * @returns A promise resolving when the update is confirmed.
-     */
-    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 });
-    }
+import "../../chunk-IZ2YBCUP.js";
+import {} from "../../event-signal.js";
+import { PatchesClient } from "../PatchesClient.js";
+import { WebSocketTransport } from "./WebSocketTransport.js";
+class PatchesWebSocket extends PatchesClient {
+  transport;
+  // --- Public Signals ---
+  /** Signal emitted when the underlying WebSocket connection state changes. */
+  onStateChange;
+  /**
+   * Creates a new Patches WebSocket client instance.
+   * @param url - The WebSocket server URL to connect to
+   * @param wsOptions - Optional configuration for the underlying WebSocket connection
+   */
+  constructor(url, wsOptions) {
+    const transport = new WebSocketTransport(url, wsOptions);
+    super(transport);
+    this.transport = transport;
+    this.onStateChange = this.transport.onStateChange;
+  }
+  // --- Connection Management ---
+  /**
+   * Establishes a connection to the Patches server.
+   * @returns A promise that resolves when the connection is established
+   */
+  async connect() {
+    await this.transport.connect();
+  }
+  /**
+   * Terminates the connection to the Patches server.
+   */
+  disconnect() {
+    this.transport.disconnect();
+  }
 }
+export {
+  PatchesWebSocket
+};

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

@@ -1,21 +1,28 @@
-import type { PatchesBranchManager } from '../../server/PatchesBranchManager.js';
-import type { PatchesHistoryManager } from '../../server/PatchesHistoryManager.js';
-import type { PatchesServer } from '../../server/PatchesServer.js';
-import type { Change, EditableVersionMetadata, ListChangesOptions, ListVersionsOptions } from '../../types.js';
+import { PatchesState, Change, ListVersionsOptions, VersionMetadata, EditableVersionMetadata, ListChangesOptions, Branch } from '../../types.js';
+import { PatchesBranchManager } from '../../server/PatchesBranchManager.js';
+import { PatchesHistoryManager } from '../../server/PatchesHistoryManager.js';
+import { PatchesServer } from '../../server/PatchesServer.js';
 import { JSONRPCServer } from '../protocol/JSONRPCServer.js';
-import { type AuthContext, type AuthorizationProvider } from './AuthorizationProvider.js';
+import { AuthorizationProvider, AuthContext } from './AuthorizationProvider.js';
+import '../../json-patch/JSONPatch.js';
+import '@dabble/delta';
+import '../../json-patch/types.js';
+import '../../server/types.js';
+import '../../event-signal.js';
+import '../protocol/types.js';
+
 /**
  * High-level client for the Patches real-time collaboration service.
  * This class provides document subscription, patch notification handling,
  * versioning, and other OT-specific functionality over a JSON RPC interface.
  */
-export interface RPCServerOptions {
+interface RPCServerOptions {
     patches: PatchesServer;
     history?: PatchesHistoryManager;
     branches?: PatchesBranchManager;
     auth?: AuthorizationProvider;
 }
-export declare class RPCServer {
+declare class RPCServer {
     rpc: JSONRPCServer;
     auth: AuthorizationProvider;
     protected patches: PatchesServer;
@@ -39,7 +46,7 @@ export declare class RPCServer {
     getDoc(params: {
         docId: string;
         atRev?: number;
-    }, ctx?: AuthContext): Promise<import("../../types.js").PatchesState<any>>;
+    }, ctx?: AuthContext): Promise<PatchesState<any>>;
     /**
      * Gets changes that occurred for a document after a specific revision number.
      * @param connectionId - The ID of the connection making the request
@@ -74,7 +81,7 @@ export declare class RPCServer {
     listVersions(params: {
         docId: string;
         options?: ListVersionsOptions;
-    }, ctx?: AuthContext): Promise<import("../../types.js").VersionMetadata[]>;
+    }, ctx?: AuthContext): Promise<VersionMetadata[]>;
     createVersion(params: {
         docId: string;
         metadata: EditableVersionMetadata;
@@ -98,7 +105,7 @@ export declare class RPCServer {
     }, ctx?: AuthContext): Promise<Change[]>;
     listBranches(params: {
         docId: string;
-    }, ctx?: AuthContext): Promise<import("../../types.js").Branch[]>;
+    }, ctx?: AuthContext): Promise<Branch[]>;
     createBranch(params: {
         docId: string;
         rev: number;
@@ -116,3 +123,5 @@ export declare class RPCServer {
     protected assertHistoryEnabled(): void;
     protected assertBranchingEnabled(): void;
 }
+
+export { RPCServer, type RPCServerOptions };