@loro-dev/flock 4.1.0 → 4.3.0

package/dist/index.d.mts

@@ -187,6 +187,37 @@ declare class Flock {
   getMvr(key: KeyPart[]): Value[];
   scan(options?: ScanOptions): ScanRow[];
   subscribe(listener: (batch: EventBatch) => void): () => void;
+  /**
+   * Execute operations within a transaction. All put/delete operations inside
+   * the callback will be batched and emitted as a single EventBatch when the
+   * transaction commits successfully.
+   *
+   * If the callback throws an error, the transaction is rolled back and no
+   * events are emitted. Note: Data changes are NOT rolled back - only event
+   * emission is affected.
+   *
+   * The callback must be synchronous. For async operations, use FlockSQLite.
+   *
+   * @param callback - Synchronous function containing put/delete operations
+   * @returns The return value of the callback
+   * @throws Error if nested transaction attempted
+   * @throws Error if import is called during the transaction (auto-commits first)
+   *
+   * @example
+   * ```ts
+   * flock.txn(() => {
+   *   flock.put(["a"], 1);
+   *   flock.put(["b"], 2);
+   *   flock.put(["c"], 3);
+   * });
+   * // Subscribers receive a single EventBatch with 3 events
+   * ```
+   */
+  txn<T>(callback: () => T): T;
+  /**
+   * Check if a transaction is currently active.
+   */
+  isInTxn(): boolean;
 }
 //#endregion
 export { EntryClock, EntryInfo, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry, decodeVersionVector, encodeVersionVector };

package/dist/index.d.ts

@@ -187,6 +187,37 @@ declare class Flock {
   getMvr(key: KeyPart[]): Value[];
   scan(options?: ScanOptions): ScanRow[];
   subscribe(listener: (batch: EventBatch) => void): () => void;
+  /**
+   * Execute operations within a transaction. All put/delete operations inside
+   * the callback will be batched and emitted as a single EventBatch when the
+   * transaction commits successfully.
+   *
+   * If the callback throws an error, the transaction is rolled back and no
+   * events are emitted. Note: Data changes are NOT rolled back - only event
+   * emission is affected.
+   *
+   * The callback must be synchronous. For async operations, use FlockSQLite.
+   *
+   * @param callback - Synchronous function containing put/delete operations
+   * @returns The return value of the callback
+   * @throws Error if nested transaction attempted
+   * @throws Error if import is called during the transaction (auto-commits first)
+   *
+   * @example
+   * ```ts
+   * flock.txn(() => {
+   *   flock.put(["a"], 1);
+   *   flock.put(["b"], 2);
+   *   flock.put(["c"], 3);
+   * });
+   * // Subscribers receive a single EventBatch with 3 events
+   * ```
+   */
+  txn<T>(callback: () => T): T;
+  /**
+   * Check if a transaction is currently active.
+   */
+  isInTxn(): boolean;
 }
 //#endregion
 export { EntryClock, EntryInfo, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry, decodeVersionVector, encodeVersionVector };