@wisemen/nestjs-typeorm 1.2.0 → 1.2.1

package/dist/extensions/readonly.d.ts

@@ -1,3 +1,21 @@
 import type { DataSource, EntityManager } from 'typeorm';
-export declare function readonly<T>(dataSource: DataSource, fn: () => Promise<T>): Promise<T>;
+/**
+ * Runs the provided callback in a readonly database context backed by a slave query runner.
+ *
+ * If a readonly context is already active, the callback is reused within that context instead of
+ * creating a new query runner. Starting a readonly context from inside a transaction is rejected
+ * because it would break the current transactional guarantees. Within the callback, injected
+ * TypeORM repositories automatically resolve against the active readonly manager, so repository
+ * operations also use the readonly query runner without requiring manual rebinding.
+ *
+ * @template T
+ * @param dataSource The TypeORM data source used to create the readonly query runner.
+ * @param runInReadonly Async callback that receives the readonly entity manager for all database
+ * access. Injected TypeORM repositories used inside this callback automatically participate in the
+ * same readonly context.
+ * @returns The value returned by `runInReadonly`.
+ * @throws {Error} If called while a transaction context is active.
+ * @throws {QueryRunnerProviderAlreadyReleasedError} If the current readonly context references a released query runner.
+ */
+export declare function readonly<T>(dataSource: DataSource, runInReadonly: (entityManager: EntityManager) => Promise<T>): Promise<T>;
 export declare function createReadonlyManagerProxy(defaultManager: EntityManager): EntityManager;

package/dist/extensions/readonly.js

@@ -1,7 +1,25 @@
 import { QueryRunnerProviderAlreadyReleasedError } from 'typeorm';
 import { isInTransaction, readonlyStorage } from './context.js';
-export async function readonly(dataSource, fn) {
-    // Disallow starting a readonly scope while in a transaction
+import assert from 'node:assert';
+/**
+ * Runs the provided callback in a readonly database context backed by a slave query runner.
+ *
+ * If a readonly context is already active, the callback is reused within that context instead of
+ * creating a new query runner. Starting a readonly context from inside a transaction is rejected
+ * because it would break the current transactional guarantees. Within the callback, injected
+ * TypeORM repositories automatically resolve against the active readonly manager, so repository
+ * operations also use the readonly query runner without requiring manual rebinding.
+ *
+ * @template T
+ * @param dataSource The TypeORM data source used to create the readonly query runner.
+ * @param runInReadonly Async callback that receives the readonly entity manager for all database
+ * access. Injected TypeORM repositories used inside this callback automatically participate in the
+ * same readonly context.
+ * @returns The value returned by `runInReadonly`.
+ * @throws {Error} If called while a transaction context is active.
+ * @throws {QueryRunnerProviderAlreadyReleasedError} If the current readonly context references a released query runner.
+ */
+export async function readonly(dataSource, runInReadonly) {
     if (isInTransaction()) {
         throw new Error('Cannot start a readonly context inside a transaction');
     }
@@ -10,11 +28,13 @@ export async function readonly(dataSource, fn) {
         throw new QueryRunnerProviderAlreadyReleasedError();
     }
     if (existing != null) {
-        return await fn();
+        assert(existing.queryRunner !== undefined, 'existing readonly without queryRunner');
+        return await runInReadonly(existing.queryRunner.manager);
     }
     const queryRunner = dataSource.createQueryRunner('slave');
     try {
-        return await readonlyStorage.run(queryRunner.manager, fn);
+        const callback = async () => await runInReadonly(queryRunner.manager);
+        return await readonlyStorage.run(queryRunner.manager, callback);
     }
     finally {
         await queryRunner.release();

package/dist/extensions/readonly.js.map

@@ -1 +1 @@
-{"version":3,"file":"readonly.js","sourceRoot":"","sources":["../../lib/extensions/readonly.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uCAAuC,EAAE,MAAM,SAAS,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAE/D,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,UAAsB,EACtB,EAAoB;IAEpB,4DAA4D;IAC5D,IAAI,eAAe,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACzE,CAAC;IACD,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAA;IAE3C,IAAI,QAAQ,EAAE,WAAW,IAAI,IAAI,IAAI,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QACrE,MAAM,IAAI,uCAAuC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAEzD,IAAI,CAAC;QACH,OAAO,MAAM,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAC3D,CAAC;YAAS,CAAC;QACT,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;IAC7B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAE,cAA6B;IACvE,OAAO,IAAI,KAAK,CAAC,cAAc,EAAE;QAC/B,GAAG,CAAE,MAAM,EAAE,IAAI;YACf,MAAM,OAAO,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAA;YAE1C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC3B,OAAO,CAAC,GAAG,EAAE;wBACX,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;oBACpF,CAAC,CAAY,CAAA;gBACf,CAAC;gBAED,OAAO,OAAO,CAAC,IAAI,CAAY,CAAA;YACjC,CAAC;YAED,OAAO,MAAM,CAAC,IAAI,CAAY,CAAA;QAChC,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"readonly.js","sourceRoot":"","sources":["../../lib/extensions/readonly.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uCAAuC,EAAE,MAAM,SAAS,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,UAAsB,EACtB,aAA2D;IAE3D,IAAI,eAAe,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAA;IAC3C,IAAI,QAAQ,EAAE,WAAW,IAAI,IAAI,IAAI,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QACrE,MAAM,IAAI,uCAAuC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,uCAAuC,CAAC,CAAA;QACnF,OAAO,MAAM,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IAC1D,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAEzD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE,CAAC,MAAM,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACrE,OAAO,MAAM,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IACjE,CAAC;YAAS,CAAC;QACT,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;IAC7B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAE,cAA6B;IACvE,OAAO,IAAI,KAAK,CAAC,cAAc,EAAE;QAC/B,GAAG,CAAE,MAAM,EAAE,IAAI;YACf,MAAM,OAAO,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAA;YAE1C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC3B,OAAO,CAAC,GAAG,EAAE;wBACX,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;oBACpF,CAAC,CAAY,CAAA;gBACf,CAAC;gBAED,OAAO,OAAO,CAAC,IAAI,CAAY,CAAA;YACjC,CAAC;YAED,OAAO,MAAM,CAAC,IAAI,CAAY,CAAA;QAChC,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}

package/dist/extensions/transaction.d.ts

@@ -1,3 +1,20 @@
 import type { DataSource, EntityManager } from 'typeorm';
+/**
+ * Runs the provided callback inside a transaction and exposes the active transaction manager.
+ *
+ * If a transaction is already active, the callback is executed as a nested TypeORM transaction on
+ * the current manager. Starting a transaction from inside a readonly context is rejected because
+ * writes must not escape the readonly boundary. Within the callback, injected TypeORM repositories
+ * automatically resolve against the active transaction manager, so repository operations join the
+ * same transaction without requiring manual rebinding.
+ *
+ * @template T
+ * @param dataSource The TypeORM data source used to start the transaction when none is active.
+ * @param runInTransaction Async callback that receives the transaction-bound entity manager.
+ * Injected TypeORM repositories used inside this callback automatically participate in the same
+ * transaction context.
+ * @returns The value returned by `runInTransaction`.
+ * @throws {Error} If called while a readonly context is active.
+ */
 export declare function transaction<T>(dataSource: DataSource, runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
 export declare function createTransactionManagerProxy(manager: EntityManager): EntityManager;

package/dist/extensions/transaction.js

@@ -1,4 +1,21 @@
 import { isInReadonly, transactionStorage } from './context.js';
+/**
+ * Runs the provided callback inside a transaction and exposes the active transaction manager.
+ *
+ * If a transaction is already active, the callback is executed as a nested TypeORM transaction on
+ * the current manager. Starting a transaction from inside a readonly context is rejected because
+ * writes must not escape the readonly boundary. Within the callback, injected TypeORM repositories
+ * automatically resolve against the active transaction manager, so repository operations join the
+ * same transaction without requiring manual rebinding.
+ *
+ * @template T
+ * @param dataSource The TypeORM data source used to start the transaction when none is active.
+ * @param runInTransaction Async callback that receives the transaction-bound entity manager.
+ * Injected TypeORM repositories used inside this callback automatically participate in the same
+ * transaction context.
+ * @returns The value returned by `runInTransaction`.
+ * @throws {Error} If called while a readonly context is active.
+ */
 export async function transaction(dataSource, runInTransaction) {
     if (isInReadonly()) {
         throw new Error('Cannot start a transaction inside a readonly context');

package/dist/extensions/transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../lib/extensions/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAE/D,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,UAAsB,EACtB,gBAA8D;IAE9D,IAAI,YAAY,EAAE,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACzE,CAAC;IACD,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAA;IAExD,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC/B,OAAO,MAAM,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAA;IAC/D,CAAC;IAED,OAAO,MAAM,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACpD,OAAO,MAAM,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtD,OAAO,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAE,OAAsB;IACnE,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;QACxB,GAAG,CAAE,MAAM,EAAE,IAAI;YACf,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAA;YAE7C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,OAAO,OAAO,CAAC,IAAI,CAAY,CAAA;YACjC,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CAAC,IAAI,CAAY,CAAA;YAChC,CAAC;QACH,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../lib/extensions/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAE/D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,UAAsB,EACtB,gBAA8D;IAE9D,IAAI,YAAY,EAAE,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACzE,CAAC;IACD,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAA;IAExD,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC/B,OAAO,MAAM,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAA;IAC/D,CAAC;IAED,OAAO,MAAM,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACpD,OAAO,MAAM,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtD,OAAO,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAE,OAAsB;IACnE,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;QACxB,GAAG,CAAE,MAAM,EAAE,IAAI;YACf,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAA;YAE7C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,OAAO,OAAO,CAAC,IAAI,CAAY,CAAA;YACjC,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CAAC,IAAI,CAAY,CAAA;YAChC,CAAC;QACH,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wisemen/nestjs-typeorm",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "publishConfig": {
     "access": "public"
   },