@andrew_l/mongo-transaction 0.3.22 → 0.4.0

package/dist/index.d.mts

@@ -1,18 +1,17 @@
-import { Awaitable, Fn, AnyFunction, RetryOnErrorConfig } from '@andrew_l/toolkit';
-import { ClientSession, ClientSessionOptions } from 'mongodb';
-
+import { AnyFunction, Awaitable, Fn, RetryOnErrorConfig } from "@andrew_l/toolkit";
+import { ClientSession, ClientSessionOptions } from "mongodb";
 type OnMongoSessionCommittedResult<T> = {
-    /**
-     * Executes the provided function upon transaction commit.
-     *
-     * Returns `T` if the transaction is committed and the function completes successfully.
-     *
-     * Returns `undefined` if the transaction is explicitly aborted or ends without committing.
-     *
-     * Rejects if the function throws an error.
-     */
-    promise: Promise<T | undefined>;
-    cancel: () => void;
+  /**
+   * Executes the provided function upon transaction commit.
+   *
+   * Returns `T` if the transaction is committed and the function completes successfully.
+   *
+   * Returns `undefined` if the transaction is explicitly aborted or ends without committing.
+   *
+   * Rejects if the function throws an error.
+   */
+  promise: Promise<T | undefined>;
+  cancel: () => void;
 };
 /**
  * Executes the provided function upon transaction commit.
@@ -39,7 +38,6 @@ type OnMongoSessionCommittedResult<T> = {
  */
 declare function onMongoSessionCommitted<T>(fn: () => Awaitable<T>): OnMongoSessionCommittedResult<T>;
 declare function onMongoSessionCommitted<T>(session: ClientSession, fn: () => Awaitable<T>): OnMongoSessionCommittedResult<T>;
-
 /**
  * Returns the current transaction session if executed within `withMongoTransaction()` otherwise returns `null`
  *
@@ -56,37 +54,35 @@ declare function onMongoSessionCommitted<T>(session: ClientSession, fn: () => Aw
  * @group Hooks
  */
 declare function useMongoSession(): ClientSession | null;
-
 interface TransactionEffect {
-    /**
-     * Specifies when the transaction effect should run:
-     *
-     * `pre` -  execute immediately
-     *
-     *  `post` - execute before transaction commit
-     *
-     * @default: "pre"
-     */
-    flush: 'pre' | 'post';
-    /**
-     * Setup effect function. You can return a cleanup callback to be used as a rollback.
-     */
-    setup: EffectCallback;
-    /**
-     * Cleanup function.
-     */
-    cleanup?: EffectCleanup;
-    /**
-     * Useful for debugging execution logs.
-     */
-    name?: string;
-    dependencies?: readonly any[];
+  /**
+   * Specifies when the transaction effect should run:
+   *
+   * `pre` -  execute immediately
+   *
+   *  `post` - execute before transaction commit
+   *
+   * @default: "pre"
+   */
+  flush: 'pre' | 'post';
+  /**
+   * Setup effect function. You can return a cleanup callback to be used as a rollback.
+   */
+  setup: EffectCallback;
+  /**
+   * Cleanup function.
+   */
+  cleanup?: EffectCleanup;
+  /**
+   * Useful for debugging execution logs.
+   */
+  name?: string;
+  dependencies?: readonly any[];
 }
 type EffectCallback = () => Awaitable<EffectCleanup | void>;
 type EffectCleanup = () => Awaitable<void>;
 type OnCommittedCallback = () => Awaitable<void>;
 type OnRollbackCallback = () => Awaitable<void>;
-
 type UseTransactionEffectOptions = Partial<Pick<TransactionEffect, 'name' | 'flush' | 'dependencies'>>;
 /**
  * Executes a transactional effect with cleanup on error or rollback.
@@ -124,7 +120,6 @@ type UseTransactionEffectOptions = Partial<Pick<TransactionEffect, 'name' | 'flu
  * @group Hooks
  */
 declare function useTransactionEffect(setup: TransactionEffect['setup'], options?: UseTransactionEffectOptions): Promise<void>;
-
 /**
  * Registers a callback to be executed upon transaction commitment, with support
  * for dependency-based updates.
@@ -167,7 +162,6 @@ declare function useTransactionEffect(setup: TransactionEffect['setup'], options
  * @group Hooks
  */
 declare function onCommitted(callback: OnCommittedCallback, dependencies?: readonly any[]): Fn;
-
 /**
  * Registers a callback to be executed upon transaction rollback, with support
  * for dependency-based updates.
@@ -210,47 +204,46 @@ declare function onCommitted(callback: OnCommittedCallback, dependencies?: reado
  * @group Hooks
  */
 declare function onRollback(callback: OnRollbackCallback, dependencies?: readonly any[]): Fn;
-
 interface MongoClientLike {
-    startSession(options: Record<string, any>): ClientSessionLike;
+  startSession(options: Record<string, any>): ClientSessionLike;
 }
 interface ClientSessionLike {
-    withTransaction(fn: AnyFunction): Promise<any>;
-    endSession(): Promise<void>;
+  withTransaction(fn: AnyFunction): Promise<any>;
+  endSession(): Promise<void>;
 }
 type ConnectionValue = MongoClientLike | (() => Awaitable<MongoClientLike>);
 type Callback<T, K = any, Args extends Array<any> = any[]> = (this: K, session: ClientSession, ...args: Args) => Awaitable<T>;
 interface WithMongoTransactionOptions<T, K = any, Args extends Array<any> = any[]> {
-    /**
-     * Mongodb connection getter
-     */
-    connection: ConnectionValue;
-    /**
-     * Transaction session options
-     *
-     * @default: {
-     *   defaultTransactionOptions: {
-     *     readPreference: 'primary',
-     *     readConcern: { level: 'local' },
-     *     writeConcern: { w: 'majority' },
-     *   }
-     * }
-     */
-    sessionOptions?: ClientSessionOptions;
-    /**
-     * Configures a timeoutMS expiry for the entire withTransactionCallback.
-     *
-     * @remarks
-     * - The remaining timeout will not be applied to callback operations that do not use the ClientSession.
-     * - Overriding timeoutMS for operations executed using the explicit session inside the provided callback will result in a client-side error.
-     */
-    timeoutMS?: number;
-    /**
-     * Transaction function that will be executed
-     *
-     * ⚠️ Possible several times!
-     */
-    fn: Callback<T, K, Args>;
+  /**
+   * Mongodb connection getter
+   */
+  connection: ConnectionValue;
+  /**
+   * Transaction session options
+   *
+   * @default: {
+   *   defaultTransactionOptions: {
+   *     readPreference: 'primary',
+   *     readConcern: { level: 'local' },
+   *     writeConcern: { w: 'majority' },
+   *   }
+   * }
+   */
+  sessionOptions?: ClientSessionOptions;
+  /**
+   * Configures a timeoutMS expiry for the entire withTransactionCallback.
+   *
+   * @remarks
+   * - The remaining timeout will not be applied to callback operations that do not use the ClientSession.
+   * - Overriding timeoutMS for operations executed using the explicit session inside the provided callback will result in a client-side error.
+   */
+  timeoutMS?: number;
+  /**
+   * Transaction function that will be executed
+   *
+   * ⚠️ Possible several times!
+   */
+  fn: Callback<T, K, Args>;
 }
 type WithMongoTransactionWrapped<T, K = any, Args extends Array<any> = any[]> = (this: K, ...args: Args) => Promise<T>;
 /**
@@ -294,9 +287,7 @@ declare function withMongoTransaction<T, K = any, Args extends Array<any> = any[
  * });
  */
 declare function withMongoTransaction<T, K = any, Args extends Array<any> = any[]>(connection: ConnectionValue, fn: Callback<T, K, Args>, options?: Omit<WithMongoTransactionOptions<any>, 'fn' | 'connection'>): WithMongoTransactionWrapped<T, K, Args>;
-
-interface WithTransactionOptions extends Partial<RetryOnErrorConfig> {
-}
+interface WithTransactionOptions extends Partial<RetryOnErrorConfig> {}
 /**
  * Wraps a function with transaction context, enabling retry logic and transactional effects.
  *
@@ -343,15 +334,22 @@ interface WithTransactionOptions extends Partial<RetryOnErrorConfig> {
  *
  * @group Main
  */
-declare function withTransaction<T, K = any, Args extends Array<any> = any[]>(fn: (this: K, ...args: Args) => T, { beforeRetryCallback, shouldRetryBasedOnError, maxAttempts, maxRetriesNumber, delayFactor, delayMaxMs, delayMinMs, }?: WithTransactionOptions): (this: K, ...args: Args) => Promise<Awaited<T>>;
-
+declare function withTransaction<T, K = any, Args extends Array<any> = any[]>(fn: (this: K, ...args: Args) => T, {
+  beforeRetryCallback,
+  shouldRetryBasedOnError,
+  maxAttempts,
+  maxRetriesNumber,
+  delayFactor,
+  delayMaxMs,
+  delayMinMs
+}?: WithTransactionOptions): (this: K, ...args: Args) => Promise<Awaited<T>>;
 interface TransactionControlled<T, K = any, Args extends Array<any> = any[]> {
-    run: (this: K, ...args: Args) => Promise<void>;
-    commit: () => Promise<void>;
-    rollback: () => Promise<void>;
-    result: Readonly<T | undefined>;
-    error: Readonly<Error | undefined>;
-    active: boolean;
+  run: (this: K, ...args: Args) => Promise<void>;
+  commit: () => Promise<void>;
+  rollback: () => Promise<void>;
+  result: Readonly<T | undefined>;
+  error: Readonly<Error | undefined>;
+  active: boolean;
 }
 /**
  * Wraps a function and returns a `TransactionControlled` interface, allowing manual control
@@ -387,5 +385,5 @@ interface TransactionControlled<T, K = any, Args extends Array<any> = any[]> {
  * @group Main
  */
 declare function withTransactionControlled<T, K = any, Args extends Array<any> = any[]>(fn: (this: K, ...args: Args) => T): TransactionControlled<Awaited<T>, K, Args>;
-
 export { type OnMongoSessionCommittedResult, type TransactionControlled, type UseTransactionEffectOptions, type WithMongoTransactionOptions, type WithTransactionOptions, onCommitted, onMongoSessionCommitted, onRollback, useMongoSession, useTransactionEffect, withMongoTransaction, withTransaction, withTransactionControlled };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":["T","promise","Promise","cancel","Awaitable","fn","OnMongoSessionCommittedResult","ClientSession","session","T","ClientSession","fallback","contextValue","flush","setup","EffectCallback","cleanup","EffectCleanup","name","dependencies","Awaitable","callback","OnCommittedCallback","OnRollbackCallback","effects","cursor","byCursor","TransactionEffect","committed","TransactionOnCommitted","rollbacks","TransactionOnRollback","T","Args","fn","log","Logger","_active","error","Error","result","run","this","args","Promise","hooks","TransactionScopeHooks","constructor","active","_run","self","commit","rollback","reset","clean","TransactionScope","Awaited","scope","reason","effect","Partial","Pick","TransactionEffect","setup","UseTransactionEffectOptions","options","Promise","OnCommittedCallback","callback","dependencies","Fn","OnRollbackCallback","callback","dependencies","Fn","startSession","Record","options","ClientSessionLike","withTransaction","AnyFunction","fn","Promise","endSession","MongoClientLike","Awaitable","T","K","Args","Array","this","ClientSession","session","args","connection","ConnectionValue","sessionOptions","ClientSessionOptions","timeoutMS","Callback","WithMongoTransactionOptions","WithMongoTransactionWrapped","Omit","Partial","RetryOnErrorConfig","T","K","Args","Array","this","args","fn","beforeRetryCallback","shouldRetryBasedOnError","maxAttempts","maxRetriesNumber","delayFactor","delayMaxMs","delayMinMs","WithTransactionOptions","Promise","Awaited","T","K","Args","Array","run","this","args","Promise","commit","rollback","result","Readonly","error","Error","active","fn","TransactionControlled","Awaited"],"sources":["../src/hooks/onMongoSessionCommitted.d.ts","../src/hooks/useMongoSession.d.ts","../src/scope.d.ts","../src/hooks/useTransactionEffect.d.ts","../src/hooks/onCommitted.d.ts","../src/hooks/onRollback.d.ts","../src/withMongoTransaction.d.ts","../src/withTransaction.d.ts","../src/withTransactionControlled.d.ts"],"mappings":";;KAEY,6BAAA;EAAA;;;;;;;;;EAURC,OAAAA,EAAS,OAAO,CAAC,CAAA;EACjBE,MAAAA;AAAAA;;;;;;;;;;;;;;;;AAyBuG;AAC3G;;;;;;;iBADwB,uBAAA,IAA2BE,EAAAA,QAAU,SAAA,CAAU,CAAA,IAAK,6BAAA,CAA8B,CAAA;AAAA,iBAClF,uBAAA,IAA2BG,OAAAA,EAAS,aAAA,EAAeH,EAAAA,QAAU,SAAA,CAAU,CAAA,IAAK,6BAAA,CAA8B,CAAA;;AArClI;;;;;;;;;;AAWU;AAyBV;;;iBCrBwB,eAAA,IAAmB,aAAa;AAAA,UChBvC,iBAAA;;AFCjB;;;;;;;;EESIQ,KAAAA;EFEM;AAAA;AAyBV;EEvBIC,KAAAA,EAAO,cAAA;EFuBoC;;;EEnB3CE,OAAAA,GAAU,aAAa;EFmBiD;;;EEfxEE,IAAAA;EACAC,YAAAA;AAAAA;AAAAA,KAEQ,cAAA,SAAuB,SAAS,CAAC,aAAA;AAAA,KACjC,aAAA,SAAsB,SAAS;AAAA,KAK/B,mBAAA,SAA4B,SAAS;AAAA,KAKrC,kBAAA,SAA2B,SAAS;AAAA,KCpCpC,2BAAA,GAA8B,OAAA,CAAQ,IAAA,CAAK,iBAAA;;AHCvD;;;;;;;;;;AAWU;AAyBV;;;;;;;;;;;;;;;;AAA2G;AAC3G;;;;;;iBGFwB,oBAAA,CAAqB4C,KAAAA,EAAO,iBAAA,WAA4BE,OAAAA,GAAU,2BAAA,GAA8B,OAAA;;AHnCxH;;;;;;;;;;AAWU;AAyBV;;;;;;;;;;;;;;;;AAA2G;AAC3G;;;;;;;;;;;;iBIIwB,WAAA,CAAYG,QAAAA,EAAU,mBAAA,EAAqBC,YAAAA,oBAAgC,EAAE;;AJzCrG;;;;;;;;;;AAWU;AAyBV;;;;;;;;;;;;;;;;AAA2G;AAC3G;;;;;;;;;;;;iBKIwB,UAAA,CAAWG,QAAAA,EAAU,kBAAA,EAAoBC,YAAAA,oBAAgC,EAAE;AAAA,UCzClF,eAAA;EACbE,YAAAA,CAAaE,OAAAA,EAAS,MAAA,gBAAsB,iBAAiB;AAAA;AAAA,UAEhD,iBAAA;EACbE,eAAAA,CAAgBE,EAAAA,EAAI,WAAA,GAAc,OAAA;EAClCE,UAAAA,IAAc,OAAA;AAAA;AAAA,KAEb,eAAA,GAAkB,eAAA,UAAyB,SAAA,CAAU,eAAA;AAAA,KACrD,QAAA,0BAAkC,KAAA,kBAAuBO,IAAAA,EAAM,CAAA,EAAGE,OAAAA,EAAS,aAAA,KAAkBC,IAAAA,EAAM,IAAA,KAAS,SAAA,CAAU,CAAA;AAAA,UAC1G,2BAAA,0BAAqD,KAAA;ENE5D;AAAA;AAyBV;EMvBIC,UAAAA,EAAY,eAAA;ENuB+B;;;;;;;;;;;EMX3CE,cAAAA,GAAiB,oBAAA;ENWqFhG;;AAAC;AAC3G;;;;EMJIkG,SAAAA;ENIiF;;;;;EMEjFjB,EAAAA,EAAI,QAAA,CAAS,CAAA,EAAG,CAAA,EAAG,IAAA;AAAA;AAAA,KAElB,2BAAA,0BAAqD,KAAA,kBAAuBS,IAAAA,EAAM,CAAA,KAAMG,IAAAA,EAAM,IAAA,KAAS,OAAA,CAAQ,CAAA;;;;;;;ANJe;;ACtBnI;;;;AAAwD;;AChBxD;;;;;;;;iBIiEwB,oBAAA,0BAA8C,KAAA,eAAoBhB,OAAAA,EAAS,2BAAA,CAA4B,CAAA,EAAG,CAAA,EAAG,IAAA,IAAQ,2BAAA,CAA4B,CAAA,EAAG,CAAA,EAAG,IAAA;;;;AJ1C/J;AAEhB;;;;AAA0D;AAC1D;;;;AAA2C;AAK3C;;;iBIoDwB,oBAAA,0BAA8C,KAAA,eAAoBiB,UAAAA,EAAY,eAAA,EAAiBb,EAAAA,EAAI,QAAA,CAAS,CAAA,EAAG,CAAA,EAAG,IAAA,GAAOJ,OAAAA,GAAU,IAAA,CAAK,2BAAA,8BAAyD,2BAAA,CAA4B,CAAA,EAAG,CAAA,EAAG,IAAA;AAAA,UCnF1O,sBAAA,SAA+B,OAAO,CAAC,kBAAA;APCxD;;;;;;;;;;AAWU;AAyBV;;;;;;;;;;;;;;;;AAA2G;AAC3G;;;;;;;;;;;;;;;;;;AArCA,iBO+CwB,eAAA,0BAAyC,KAAA,eAAoBkC,EAAAA,GAAKF,IAAAA,EAAM,CAAA,KAAMC,IAAAA,EAAM,IAAA,KAAS,CAAA;EAAKE,mBAAAA;EAAqBC,uBAAAA;EAAyBC,WAAAA;EAAaC,gBAAAA;EAAkBC,WAAAA;EAAaC,UAAAA;EAAYC;AAAAA,IAAgB,sBAAA,IAA0BT,IAAAA,EAAM,CAAA,KAAMC,IAAAA,EAAM,IAAA,KAAS,OAAA,CAAQ,OAAA,CAAQ,CAAA;AAAA,UCjDpS,qBAAA,0BAA+C,KAAA;EAC5DgB,GAAAA,GAAMC,IAAAA,EAAM,CAAA,KAAMC,IAAAA,EAAM,IAAA,KAAS,OAAA;EACjCE,MAAAA,QAAc,OAAA;EACdC,QAAAA,QAAgB,OAAA;EAChBC,MAAAA,EAAQ,QAAA,CAAS,CAAA;EACjBE,KAAAA,EAAO,QAAA,CAAS,KAAA;EAChBE,MAAAA;AAAAA;;;;;;AROM;AAyBV;;;;;;;;;;;;;;;;AAA2G;AAC3G;;;;;;;;;;iBQEwB,yBAAA,0BAAmD,KAAA,eAAoBC,EAAAA,GAAKV,IAAAA,EAAM,CAAA,KAAMC,IAAAA,EAAM,IAAA,KAAS,CAAA,GAAI,qBAAA,CAAsB,OAAA,CAAQ,CAAA,GAAI,CAAA,EAAG,IAAA"}