joist-knex 2.0.3 → 2.1.0

package/build/index.d.ts

@@ -1,5 +1,6 @@
 import { Entity, FilterAndSettings, MaybeAbstractEntityConstructor } from "joist-core";
 import { Knex } from "knex";
+import pg from "pg";
 /**
  * Builds the Knex queries from `em.find`-style parameters.
  *
@@ -26,4 +27,19 @@ export declare function buildQuery<T extends Entity>(knex: Knex, type: MaybeAbst
     pruneJoins?: boolean;
     keepAliases?: string[];
 }): Knex.QueryBuilder<{}, unknown[]>;
+/**
+ * Creates a Knex instance that delegates to an existing pg Pool or PoolClient
+ * instead of managing its own internal connection pool.
+ *
+ * When given a `pg.Pool`, each knex query acquires a connection from the pool and
+ * releases it when the query completes.
+ *
+ * When given a `pg.PoolClient`, all knex queries run on that specific client. This
+ * is useful when the client has an open transaction (via `BEGIN`) — the knex queries
+ * will participate in that transaction and be affected by `COMMIT`/`ROLLBACK`.
+ *
+ * The returned Knex instance has no internal pool, so there is no need to call
+ * `.destroy()` on it — the caller owns the Pool/PoolClient lifecycle.
+ */
+export declare function createKnex(poolOrClient: pg.Pool | pg.PoolClient): Knex;
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAe,8BAA8B,EAAkB,MAAM,YAAY,CAAC;AACpH,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAG5B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,8BAA8B,CAAC,CAAC,CAAC,EACvC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,GACA,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAclC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAe,8BAA8B,EAAkB,MAAM,YAAY,CAAC;AACpH,OAAO,EAA0B,IAAI,EAAE,MAAM,MAAM,CAAC;AACpD,OAAO,EAAE,MAAM,IAAI,CAAC;AAGpB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,8BAA8B,CAAC,CAAC,CAAC,EACvC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,GACA,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAclC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,UAAU,GAAG,IAAI,CAUtE"}

package/build/index.js

@@ -1,7 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildQuery = buildQuery;
+exports.createKnex = createKnex;
 const joist_core_1 = require("joist-core");
+const knex_1 = require("knex");
+const pg_1 = __importDefault(require("pg"));
 const buildKnexQuery_1 = require("./buildKnexQuery");
 /**
  * Builds the Knex queries from `em.find`-style parameters.
@@ -31,4 +37,30 @@ function buildQuery(knex, type, filter) {
     const parsed = (0, joist_core_1.parseFindQuery)(meta, where, { conditions, orderBy, pruneJoins, keepAliases, softDeletes });
     return (0, buildKnexQuery_1.buildKnexQuery)(knex, parsed, { limit, offset });
 }
+/**
+ * Creates a Knex instance that delegates to an existing pg Pool or PoolClient
+ * instead of managing its own internal connection pool.
+ *
+ * When given a `pg.Pool`, each knex query acquires a connection from the pool and
+ * releases it when the query completes.
+ *
+ * When given a `pg.PoolClient`, all knex queries run on that specific client. This
+ * is useful when the client has an open transaction (via `BEGIN`) — the knex queries
+ * will participate in that transaction and be affected by `COMMIT`/`ROLLBACK`.
+ *
+ * The returned Knex instance has no internal pool, so there is no need to call
+ * `.destroy()` on it — the caller owns the Pool/PoolClient lifecycle.
+ */
+function createKnex(poolOrClient) {
+    const knex = (0, knex_1.knex)({ client: "pg", connection: {}, pool: { max: 0 } });
+    if (poolOrClient instanceof pg_1.default.Pool) {
+        knex.client.acquireConnection = () => poolOrClient.connect();
+        knex.client.releaseConnection = (conn) => conn.release();
+    }
+    else {
+        knex.client.acquireConnection = () => poolOrClient;
+        knex.client.releaseConnection = () => { };
+    }
+    return knex;
+}
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AA0BA,gCAqBC;AA/CD,2CAAoH;AAEpH,qDAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,UAAU,CACxB,IAAU,EACV,IAAuC,EACvC,MAGC;IAED,MAAM,IAAI,GAAG,IAAA,wBAAW,EAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,EACJ,KAAK,EACL,UAAU,EACV,OAAO,EACP,KAAK,EACL,MAAM,EACN,UAAU,GAAG,IAAI,EACjB,WAAW,GAAG,EAAE,EAChB,WAAW,GAAG,SAAS,GACxB,GAAG,MAAM,CAAC;IACX,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,IAAI,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IAC1G,OAAO,IAAA,+BAAc,EAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACzD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AA2BA,gCAqBC;AAgBD,gCAUC;AA1ED,2CAAoH;AACpH,+BAAoD;AACpD,4CAAoB;AACpB,qDAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,UAAU,CACxB,IAAU,EACV,IAAuC,EACvC,MAGC;IAED,MAAM,IAAI,GAAG,IAAA,wBAAW,EAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,EACJ,KAAK,EACL,UAAU,EACV,OAAO,EACP,KAAK,EACL,MAAM,EACN,UAAU,GAAG,IAAI,EACjB,WAAW,GAAG,EAAE,EAChB,WAAW,GAAG,SAAS,GACxB,GAAG,MAAM,CAAC;IACX,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,IAAI,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IAC1G,OAAO,IAAA,+BAAc,EAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,UAAU,CAAC,YAAqC;IAC9D,MAAM,IAAI,GAAG,IAAA,WAAc,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAChF,IAAI,YAAY,YAAY,YAAE,CAAC,IAAI,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,iBAAiB,GAAG,CAAC,IAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1E,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,MAAM,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,iBAAiB,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joist-knex",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
     "build"
   ],
   "peerDependencies": {
-    "joist-core": "2.0.3",
+    "joist-core": "2.1.0",
     "knex": "^3.1.0",
     "pg": "^8.16.3"
   },