@dabble/patches 0.5.4 → 0.5.6

package/dist/algorithms/server/createVersion.js

@@ -3,8 +3,8 @@ import { createVersionMetadata } from "../../data/version.js";
 import { getISO } from "../../utils/dates.js";
 async function createVersion(store, docId, state, changes, metadata) {
   if (changes.length === 0) return;
-  const baseRev = changes[0].baseRev;
-  if (baseRev === void 0) {
+  const startRev = changes[0].baseRev;
+  if (startRev === void 0) {
     throw new Error(`Client changes must include baseRev for doc ${docId}.`);
   }
   const sessionMetadata = createVersionMetadata({
@@ -12,8 +12,8 @@ async function createVersion(store, docId, state, changes, metadata) {
     // Convert client timestamps to UTC for version metadata (enables lexicographic sorting)
     startedAt: getISO(changes[0].createdAt),
     endedAt: getISO(changes[changes.length - 1].createdAt),
-    rev: changes[changes.length - 1].rev,
-    baseRev,
+    endRev: changes[changes.length - 1].rev,
+    startRev,
     ...metadata
   });
   await store.createVersion(docId, sessionMetadata, state, changes);

package/dist/algorithms/server/getSnapshotAtRevision.js

@@ -5,11 +5,11 @@ async function getSnapshotAtRevision(store, docId, rev) {
     reverse: true,
     startAfter: rev ? rev + 1 : void 0,
     origin: "main",
-    orderBy: "rev"
+    orderBy: "endRev"
   });
   const latestMainVersion = versions[0];
   const versionState = latestMainVersion && await store.loadVersionState(docId, latestMainVersion.id) || null;
-  const versionRev = latestMainVersion?.rev ?? 0;
+  const versionRev = latestMainVersion?.endRev ?? 0;
   const changesSinceVersion = await store.listChanges(docId, {
     startAfter: versionRev,
     endBefore: rev ? rev + 1 : void 0

package/dist/algorithms/server/handleOfflineSessionsAndBatches.js

@@ -46,8 +46,8 @@ async function handleOfflineSessionsAndBatches(store, sessionTimeoutMillis, docI
             // Convert client timestamps to UTC for version metadata (enables lexicographic sorting)
             startedAt: getISO(sessionChanges[0].createdAt),
             endedAt: getISO(sessionChanges[sessionChanges.length - 1].createdAt),
-            rev: sessionChanges[sessionChanges.length - 1].rev,
-            baseRev
+            endRev: sessionChanges[sessionChanges.length - 1].rev,
+            startRev: baseRev
           });
           await store.createVersion(docId, sessionMetadata, offlineBaseState, sessionChanges);
           parentId = sessionMetadata.id;

package/dist/json-patch/utils/log.d.ts

@@ -1,4 +1,4 @@
-declare let log: (...data: any[]) => void;
+declare let log: (...args: any[]) => void;
 declare function verbose(value: boolean): void;
 
 export { log, verbose };

package/dist/json-patch/utils/log.js

@@ -1,5 +1,5 @@
 import "../../chunk-IZ2YBCUP.js";
-let log = console.log;
+let log = () => void 0;
 function verbose(value) {
   log = value ? console.log : () => void 0;
 }

package/dist/server/PatchesBranchManager.js

@@ -32,15 +32,15 @@ class PatchesBranchManager {
       throw new Error("Cannot create a branch from another branch.");
     }
     const stateAtRev = (await this.patchesServer.getStateAtRevision(docId, rev)).state;
-    const branchDocId = createId();
+    const branchDocId = this.store.createBranchId ? await Promise.resolve(this.store.createBranchId(docId)) : createId(22);
     const now = getISO();
     const initialVersionMetadata = createVersionMetadata({
       origin: "main",
       // Branch doc versions are 'main' until merged
       startedAt: now,
       endedAt: now,
-      rev,
-      baseRev: rev,
+      endRev: rev,
+      startRev: rev,
       name: metadata?.name,
       groupId: branchDocId,
       branchName: metadata?.name
@@ -49,8 +49,8 @@ class PatchesBranchManager {
     const branch = {
       ...metadata,
       id: branchDocId,
-      branchedFromId: docId,
-      branchedRev: rev,
+      docId,
+      branchedAtRev: rev,
       createdAt: now,
       status: "open"
     };
@@ -88,8 +88,8 @@ class PatchesBranchManager {
     if (branch.status !== "open") {
       throw new Error(`Branch ${branchId} is not open (status: ${branch.status}). Cannot merge.`);
     }
-    const sourceDocId = branch.branchedFromId;
-    const branchStartRevOnSource = branch.branchedRev;
+    const sourceDocId = branch.docId;
+    const branchStartRevOnSource = branch.branchedAtRev;
     const branchChanges = await this.store.listChanges(branchId, {});
     if (branchChanges.length === 0) {
       console.log(`Branch ${branchId} has no changes to merge.`);
@@ -107,7 +107,7 @@ class PatchesBranchManager {
       const newVersionMetadata = createVersionMetadata({
         ...v,
         origin: versionOrigin,
-        baseRev: branchStartRevOnSource,
+        startRev: branchStartRevOnSource,
         groupId: branchId,
         branchName: branch.name,
         // Keep branchName for traceability
@@ -149,7 +149,7 @@ class PatchesBranchManager {
     return committedMergeChanges;
   }
 }
-const nonModifiableMetadataFields = /* @__PURE__ */ new Set(["id", "branchedFromId", "branchedRev", "createdAt", "status"]);
+const nonModifiableMetadataFields = /* @__PURE__ */ new Set(["id", "docId", "branchedAtRev", "createdAt", "status"]);
 function assertBranchMetadata(metadata) {
   if (!metadata) return;
   for (const key in metadata) {

package/dist/server/types.d.ts

@@ -24,10 +24,10 @@ interface PatchesStoreBackend {
     /** Update a version's metadata. */
     updateVersion(docId: string, versionId: string, metadata: EditableVersionMetadata): Promise<void>;
     /**
-     * Appends changes to an existing version, updating its state snapshot, endedAt, and rev.
+     * Appends changes to an existing version, updating its state snapshot, endedAt, and endRev.
      * Used when a session spans multiple batch submissions.
      */
-    appendVersionChanges(docId: string, versionId: string, changes: Change[], newEndedAt: string, newRev: number, newState: any): Promise<void>;
+    appendVersionChanges(docId: string, versionId: string, changes: Change[], newEndedAt: string, newEndRev: number, newState: any): Promise<void>;
     /** Lists version metadata based on filtering/sorting options. */
     listVersions(docId: string, options: ListVersionsOptions): Promise<VersionMetadata[]>;
     /** Loads the state snapshot for a specific version ID. */
@@ -41,6 +41,12 @@ interface PatchesStoreBackend {
  * Extends PatchesStoreBackend with methods specifically for managing branches.
  */
 interface BranchingStoreBackend extends PatchesStoreBackend {
+    /**
+     * Generates a unique ID for a new branch document.
+     * If not provided, a random 22-character ID is generated using createId().
+     * @param docId - The source document ID being branched from
+     */
+    createBranchId?(docId: string): Promise<string> | string;
     /** Lists metadata records for branches originating from a document. */
     listBranches(docId: string): Promise<Branch[]>;
     /** Loads the metadata record for a specific branch ID. */

package/dist/types.d.ts

@@ -68,9 +68,9 @@ interface Branch {
     /** The ID of the branch document. */
     id: string;
     /** The ID of the document this document was branched from. */
-    branchedFromId: string;
+    docId: string;
     /** The revision number on the source document where the branch occurred. */
-    branchedRev: number;
+    branchedAtRev: number;
     /** Server-side ISO timestamp when the branch was created (UTC with Z). */
     createdAt: string;
     /** Optional user-friendly name for the branch. */
@@ -80,7 +80,7 @@ interface Branch {
     /** Optional arbitrary metadata associated with the branch record. */
     [metadata: string]: any;
 }
-type EditableBranchMetadata = Disallowed<Branch, 'id' | 'branchedFromId' | 'branchedRev' | 'createdAt' | 'status'>;
+type EditableBranchMetadata = Disallowed<Branch, 'id' | 'docId' | 'branchedAtRev' | 'createdAt' | 'status'>;
 /**
  * Metadata, state snapshot, and included changes for a specific version.
  */
@@ -102,17 +102,17 @@ interface VersionMetadata {
     startedAt: string;
     /** Server-side ISO timestamp of version end (UTC with Z). */
     endedAt: string;
-    /** The revision number this version was created at. */
-    rev: number;
-    /** The revision number on the main timeline before the changes that created this version. If this is an offline/branch version, this is the revision number of the source document where the branch was created and not . */
-    baseRev: number;
+    /** The ending revision number of this version (the last change's rev). */
+    endRev: number;
+    /** The starting revision number of this version (the first change's baseRev). If this is an offline/branch version, this is the revision number of the source document where the branch was created. */
+    startRev: number;
     /** Optional arbitrary metadata associated with the version. */
     [metadata: string]: any;
 }
 type Disallowed<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> & {
     [P in K]?: never;
 };
-type EditableVersionMetadata = Disallowed<VersionMetadata, 'id' | 'parentId' | 'groupId' | 'origin' | 'branchName' | 'startedAt' | 'endedAt' | 'rev' | 'baseRev'>;
+type EditableVersionMetadata = Disallowed<VersionMetadata, 'id' | 'parentId' | 'groupId' | 'origin' | 'branchName' | 'startedAt' | 'endedAt' | 'endRev' | 'startRev'>;
 /**
  * Options for committing changes.
  */
@@ -155,8 +155,8 @@ interface ListVersionsOptions {
     endBefore?: number | string;
     /** Maximum number of versions to return. */
     limit?: number;
-    /** Sort by startedAt, rev, or baseRev. Defaults to 'rev'. */
-    orderBy?: 'startedAt' | 'rev' | 'baseRev';
+    /** Sort by startedAt, endRev, or startRev. Defaults to 'endRev'. */
+    orderBy?: 'startedAt' | 'endRev' | 'startRev';
     /** Return versions in descending order. Defaults to false (ascending). When reversed, startAfter and endBefore apply to the *reversed* list. */
     reverse?: boolean;
     /** Filter by the origin type. */

package/package.json

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