@slonik/pg-driver 43.0.6

package/README.md

@@ -0,0 +1,6 @@
+# Slonik Driver for `pg`
+
+```ts
+import {
+  createPgDriverFactory,
+} from '@slonik/pg-driver';

package/dist/factories/createPgDriverFactory.d.ts

@@ -0,0 +1,3 @@
+import { type DriverFactory } from '@slonik/driver';
+export declare const createPgDriverFactory: () => DriverFactory;
+//# sourceMappingURL=createPgDriverFactory.d.ts.map

package/dist/factories/createPgDriverFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPgDriverFactory.d.ts","sourceRoot":"","sources":["../../src/factories/createPgDriverFactory.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,KAAK,aAAa,EAEnB,MAAM,gBAAgB,CAAC;AAqPxB,eAAO,MAAM,qBAAqB,QAAO,aAgIxC,CAAC"}

package/dist/factories/createPgDriverFactory.js

@@ -0,0 +1,274 @@
+"use strict";
+/* eslint-disable canonical/id-match */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPgDriverFactory = void 0;
+const driver_1 = require("@slonik/driver");
+const errors_1 = require("@slonik/errors");
+const utilities_1 = require("@slonik/utilities");
+const node_stream_1 = require("node:stream");
+// eslint-disable-next-line no-restricted-imports
+const pg_1 = require("pg");
+const pg_query_stream_1 = __importDefault(require("pg-query-stream"));
+const pg_types_1 = require("pg-types");
+const postgres_array_1 = require("postgres-array");
+const createTypeOverrides = async (connection, typeParsers) => {
+    const typeNames = typeParsers.map((typeParser) => {
+        return typeParser.name;
+    });
+    const postgresTypes = (await connection.query(`
+        SELECT
+          oid,
+          typarray,
+          typname
+        FROM pg_type
+        WHERE typname = ANY($1::text[])
+      `, [typeNames])).rows;
+    const parsers = {};
+    for (const typeParser of typeParsers) {
+        const postgresType = postgresTypes.find((maybeTargetPostgresType) => {
+            return maybeTargetPostgresType.typname === typeParser.name;
+        });
+        if (!postgresType) {
+            throw new Error('Database type "' + typeParser.name + '" not found.');
+        }
+        parsers[postgresType.oid] = (value) => {
+            return typeParser.parse(value);
+        };
+        if (postgresType.typarray) {
+            parsers[postgresType.typarray] = (arrayValue) => {
+                return (0, postgres_array_1.parse)(arrayValue).map((value) => {
+                    return typeParser.parse(value);
+                });
+            };
+        }
+    }
+    return (oid) => {
+        if (parsers[oid]) {
+            return parsers[oid];
+        }
+        return (0, pg_types_1.getTypeParser)(oid);
+    };
+};
+const createClientConfiguration = (clientConfiguration) => {
+    const connectionOptions = (0, utilities_1.parseDsn)(clientConfiguration.connectionUri);
+    const poolConfiguration = {
+        application_name: connectionOptions.applicationName,
+        database: connectionOptions.databaseName,
+        host: connectionOptions.host,
+        options: connectionOptions.options,
+        password: connectionOptions.password,
+        port: connectionOptions.port,
+        ssl: false,
+        user: connectionOptions.username,
+    };
+    if (clientConfiguration.ssl) {
+        poolConfiguration.ssl = clientConfiguration.ssl;
+    }
+    else if (connectionOptions.sslMode === 'disable') {
+        poolConfiguration.ssl = false;
+    }
+    else if (connectionOptions.sslMode === 'require') {
+        poolConfiguration.ssl = true;
+    }
+    else if (connectionOptions.sslMode === 'no-verify') {
+        poolConfiguration.ssl = {
+            rejectUnauthorized: false,
+        };
+    }
+    if (clientConfiguration.connectionTimeout !== 'DISABLE_TIMEOUT') {
+        if (clientConfiguration.connectionTimeout === 0) {
+            poolConfiguration.connectionTimeoutMillis = 1;
+        }
+        else {
+            poolConfiguration.connectionTimeoutMillis =
+                clientConfiguration.connectionTimeout;
+        }
+    }
+    if (clientConfiguration.statementTimeout !== 'DISABLE_TIMEOUT') {
+        if (clientConfiguration.statementTimeout === 0) {
+            poolConfiguration.statement_timeout = 1;
+        }
+        else {
+            poolConfiguration.statement_timeout =
+                clientConfiguration.statementTimeout;
+        }
+    }
+    if (clientConfiguration.idleInTransactionSessionTimeout !== 'DISABLE_TIMEOUT') {
+        if (clientConfiguration.idleInTransactionSessionTimeout === 0) {
+            poolConfiguration.idle_in_transaction_session_timeout = 1;
+        }
+        else {
+            poolConfiguration.idle_in_transaction_session_timeout =
+                clientConfiguration.idleInTransactionSessionTimeout;
+        }
+    }
+    return poolConfiguration;
+};
+const queryTypeOverrides = async (pgClientConfiguration, driverConfiguration) => {
+    const client = new pg_1.Client(pgClientConfiguration);
+    await client.connect();
+    const typeOverrides = await createTypeOverrides(client, driverConfiguration.typeParsers);
+    await client.end();
+    return typeOverrides;
+};
+const isErrorWithCode = (error) => {
+    return 'code' in error;
+};
+// query is not available for connection-level errors.
+// TODO evaluate if we can remove query from the error object.
+// I suspect we should not be even using InputSyntaxError as one of the error types.
+// @see https://github.com/gajus/slonik/issues/557
+const wrapError = (error, query) => {
+    if (error.message.toLowerCase().includes('connection terminated unexpectedly')) {
+        return new errors_1.BackendTerminatedUnexpectedlyError(error);
+    }
+    if (error.message.toLowerCase().includes('connection terminated')) {
+        return new errors_1.BackendTerminatedError(error);
+    }
+    if (!isErrorWithCode(error)) {
+        return error;
+    }
+    if (error.code === '22P02') {
+        return new errors_1.InvalidInputError(error.message);
+    }
+    if (error.code === '25P03') {
+        return new errors_1.IdleTransactionTimeoutError(error);
+    }
+    if (error.code === '57P01') {
+        return new errors_1.BackendTerminatedError(error);
+    }
+    if (error.code === '57014' &&
+        // The code alone is not enough to distinguish between a statement timeout and a statement cancellation.
+        error.message.includes('canceling statement due to user request')) {
+        return new errors_1.StatementCancelledError(error);
+    }
+    if (error.code === '57014') {
+        return new errors_1.StatementTimeoutError(error);
+    }
+    if (error.code === '23502') {
+        return new errors_1.NotNullIntegrityConstraintViolationError(error);
+    }
+    if (error.code === '23503') {
+        return new errors_1.ForeignKeyIntegrityConstraintViolationError(error);
+    }
+    if (error.code === '23505') {
+        return new errors_1.UniqueIntegrityConstraintViolationError(error);
+    }
+    if (error.code === '23514') {
+        return new errors_1.CheckIntegrityConstraintViolationError(error);
+    }
+    if (error.code === '42601') {
+        if (!query) {
+            return new errors_1.UnexpectedStateError('Expected query to be provided');
+        }
+        return new errors_1.InputSyntaxError(error, query);
+    }
+    return error;
+};
+const createPgDriverFactory = () => {
+    return (0, driver_1.createDriverFactory)(async ({ driverConfiguration }) => {
+        const clientConfiguration = createClientConfiguration(driverConfiguration);
+        // eslint-disable-next-line require-atomic-updates
+        clientConfiguration.types = {
+            getTypeParser: await queryTypeOverrides(clientConfiguration, driverConfiguration),
+        };
+        return {
+            createPoolClient: async ({ clientEventEmitter }) => {
+                const client = new pg_1.Client(clientConfiguration);
+                // We will see this triggered when the connection is terminated, e.g.
+                // "terminates transactions that are idle beyond idleInTransactionSessionTimeout" test.
+                const onError = (error) => {
+                    clientEventEmitter.emit('error', wrapError(error, null));
+                };
+                const onNotice = (notice) => {
+                    if (notice.message) {
+                        clientEventEmitter.emit('notice', {
+                            message: notice.message,
+                        });
+                    }
+                };
+                client.on('error', onError);
+                client.on('notice', onNotice);
+                return {
+                    connect: async () => {
+                        await client.connect();
+                    },
+                    end: async () => {
+                        await client.end();
+                        client.removeListener('error', onError);
+                        client.removeListener('notice', onNotice);
+                    },
+                    query: async (sql, values) => {
+                        let result;
+                        try {
+                            result = await client.query(sql, values);
+                        }
+                        catch (error) {
+                            throw wrapError(error, {
+                                sql,
+                                values: values,
+                            });
+                        }
+                        if (Array.isArray(result)) {
+                            throw new errors_1.InvalidInputError('Must not use multiple statements in a single query.');
+                        }
+                        return {
+                            command: result.command,
+                            fields: result.fields.map((field) => {
+                                return {
+                                    dataTypeId: field.dataTypeID,
+                                    name: field.name,
+                                };
+                            }),
+                            rowCount: result.rowCount,
+                            rows: result.rows,
+                        };
+                    },
+                    stream: (sql, values) => {
+                        const stream = client.query(new pg_query_stream_1.default(sql, values));
+                        let fields = [];
+                        // `rowDescription` will not fire if the query produces a syntax error.
+                        // Also, `rowDescription` won't fire until client starts consuming the stream.
+                        // This is why we cannot simply await for `rowDescription` event before starting to pipe the stream.
+                        // @ts-expect-error – https://github.com/brianc/node-postgres/issues/3015
+                        client.connection.once('rowDescription', (rowDescription) => {
+                            fields = rowDescription.fields.map((field) => {
+                                return {
+                                    dataTypeId: field.dataTypeID,
+                                    name: field.name,
+                                };
+                            });
+                        });
+                        const transform = new node_stream_1.Transform({
+                            objectMode: true,
+                            async transform(datum, enc, callback) {
+                                if (!fields) {
+                                    callback(new Error('Fields not available'));
+                                    return;
+                                }
+                                // eslint-disable-next-line @babel/no-invalid-this
+                                this.push({
+                                    fields,
+                                    row: datum,
+                                });
+                                callback();
+                            },
+                        });
+                        stream.on('error', (error) => {
+                            transform.emit('error', wrapError(error, {
+                                sql,
+                                values: values,
+                            }));
+                        });
+                        return stream.pipe(transform);
+                    },
+                };
+            },
+        };
+    });
+};
+exports.createPgDriverFactory = createPgDriverFactory;
+//# sourceMappingURL=createPgDriverFactory.js.map

package/dist/factories/createPgDriverFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPgDriverFactory.js","sourceRoot":"","sources":["../../src/factories/createPgDriverFactory.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;;;;AAEvC,2CAMwB;AACxB,2CAawB;AAGxB,iDAA6C;AAC7C,6CAAwC;AACxC,iDAAiD;AACjD,2BAIY;AACZ,sEAA0C;AAC1C,uCAAgE;AAChE,mDAAqD;AAWrD,MAAM,mBAAmB,GAAG,KAAK,EAC/B,UAAkB,EAClB,WAAwC,EAChB,EAAE;IAC1B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAC/C,OAAO,UAAU,CAAC,IAAI,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,CACpB,MAAM,UAAU,CAAC,KAAK,CACpB;;;;;;;OAOC,EACD,CAAC,SAAS,CAAC,CACZ,CACF,CAAC,IAAsB,CAAC;IAEzB,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,uBAAuB,EAAE,EAAE;YAClE,OAAO,uBAAuB,CAAC,OAAO,KAAK,UAAU,CAAC,IAAI,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,UAAU,CAAC,IAAI,GAAG,cAAc,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;YACpC,OAAO,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC;QAEF,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC1B,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE;gBAC9C,OAAO,IAAA,sBAAU,EAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC1C,OAAO,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACjC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,EAAE;QACrB,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;QAED,OAAO,IAAA,wBAAmB,EAAC,GAAG,CAAC,CAAC;IAClC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAChC,mBAAwC,EACL,EAAE;IACrC,MAAM,iBAAiB,GAAG,IAAA,oBAAQ,EAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAEtE,MAAM,iBAAiB,GAAsC;QAC3D,gBAAgB,EAAE,iBAAiB,CAAC,eAAe;QACnD,QAAQ,EAAE,iBAAiB,CAAC,YAAY;QACxC,IAAI,EAAE,iBAAiB,CAAC,IAAI;QAC5B,OAAO,EAAE,iBAAiB,CAAC,OAAO;QAClC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;QACpC,IAAI,EAAE,iBAAiB,CAAC,IAAI;QAC5B,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,iBAAiB,CAAC,QAAQ;KACjC,CAAC;IAEF,IAAI,mBAAmB,CAAC,GAAG,EAAE,CAAC;QAC5B,iBAAiB,CAAC,GAAG,GAAG,mBAAmB,CAAC,GAAG,CAAC;IAClD,CAAC;SAAM,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnD,iBAAiB,CAAC,GAAG,GAAG,KAAK,CAAC;IAChC,CAAC;SAAM,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnD,iBAAiB,CAAC,GAAG,GAAG,IAAI,CAAC;IAC/B,CAAC;SAAM,IAAI,iBAAiB,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;QACrD,iBAAiB,CAAC,GAAG,GAAG;YACtB,kBAAkB,EAAE,KAAK;SAC1B,CAAC;IACJ,CAAC;IAED,IAAI,mBAAmB,CAAC,iBAAiB,KAAK,iBAAiB,EAAE,CAAC;QAChE,IAAI,mBAAmB,CAAC,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAChD,iBAAiB,CAAC,uBAAuB,GAAG,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,iBAAiB,CAAC,uBAAuB;gBACvC,mBAAmB,CAAC,iBAAiB,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,IAAI,mBAAmB,CAAC,gBAAgB,KAAK,iBAAiB,EAAE,CAAC;QAC/D,IAAI,mBAAmB,CAAC,gBAAgB,KAAK,CAAC,EAAE,CAAC;YAC/C,iBAAiB,CAAC,iBAAiB,GAAG,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,iBAAiB,CAAC,iBAAiB;gBACjC,mBAAmB,CAAC,gBAAgB,CAAC;QACzC,CAAC;IACH,CAAC;IAED,IACE,mBAAmB,CAAC,+BAA+B,KAAK,iBAAiB,EACzE,CAAC;QACD,IAAI,mBAAmB,CAAC,+BAA+B,KAAK,CAAC,EAAE,CAAC;YAC9D,iBAAiB,CAAC,mCAAmC,GAAG,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,iBAAiB,CAAC,mCAAmC;gBACnD,mBAAmB,CAAC,+BAA+B,CAAC;QACxD,CAAC;IACH,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAC9B,qBAAwD,EACxD,mBAAwC,EAChB,EAAE;IAC1B,MAAM,MAAM,GAAG,IAAI,WAAM,CAAC,qBAAqB,CAAC,CAAC;IAEjD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAC7C,MAAM,EACN,mBAAmB,CAAC,WAAW,CAChC,CAAC;IAEF,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;IAEnB,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAY,EAA0B,EAAE;IAC/D,OAAO,MAAM,IAAI,KAAK,CAAC;AACzB,CAAC,CAAC;AAEF,sDAAsD;AACtD,8DAA8D;AAC9D,oFAAoF;AACpF,kDAAkD;AAClD,MAAM,SAAS,GAAG,CAAC,KAAY,EAAE,KAAmB,EAAE,EAAE;IACtD,IACE,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC,EAC1E,CAAC;QACD,OAAO,IAAI,2CAAkC,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAClE,OAAO,IAAI,+BAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,0BAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,oCAA2B,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,+BAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,IACE,KAAK,CAAC,IAAI,KAAK,OAAO;QACtB,wGAAwG;QACxG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,yCAAyC,CAAC,EACjE,CAAC;QACD,OAAO,IAAI,gCAAuB,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,8BAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,iDAAwC,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,oDAA2C,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,gDAAuC,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,IAAI,+CAAsC,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,6BAAoB,CAAC,+BAA+B,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,IAAI,yBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEK,MAAM,qBAAqB,GAAG,GAAkB,EAAE;IACvD,OAAO,IAAA,4BAAmB,EAAC,KAAK,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE;QAC3D,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;QAE3E,kDAAkD;QAClD,mBAAmB,CAAC,KAAK,GAAG;YAC1B,aAAa,EAAE,MAAM,kBAAkB,CACrC,mBAAmB,EACnB,mBAAmB,CACpB;SACF,CAAC;QAEF,OAAO;YACL,gBAAgB,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAE,EAAE,EAAE;gBACjD,MAAM,MAAM,GAAG,IAAI,WAAM,CAAC,mBAAmB,CAAC,CAAC;gBAE/C,qEAAqE;gBACrE,uFAAuF;gBACvF,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;oBACxB,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC3D,CAAC,CAAC;gBAEF,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,EAAE;oBAC1B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;wBACnB,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE;4BAChC,OAAO,EAAE,MAAM,CAAC,OAAO;yBACxB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC,CAAC;gBAEF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC5B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAE9B,OAAO;oBACL,OAAO,EAAE,KAAK,IAAI,EAAE;wBAClB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;oBACzB,CAAC;oBACD,GAAG,EAAE,KAAK,IAAI,EAAE;wBACd,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;wBAEnB,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBACxC,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBAC5C,CAAC;oBACD,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;wBAC3B,IAAI,MAAM,CAAC;wBAEX,IAAI,CAAC;4BACH,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAmB,CAAC,CAAC;wBACxD,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,MAAM,SAAS,CAAC,KAAK,EAAE;gCACrB,GAAG;gCACH,MAAM,EAAE,MAA6C;6BACtD,CAAC,CAAC;wBACL,CAAC;wBAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;4BAC1B,MAAM,IAAI,0BAAiB,CACzB,qDAAqD,CACtD,CAAC;wBACJ,CAAC;wBAED,OAAO;4BACL,OAAO,EAAE,MAAM,CAAC,OAAwB;4BACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gCAClC,OAAO;oCACL,UAAU,EAAE,KAAK,CAAC,UAAU;oCAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;iCACjB,CAAC;4BACJ,CAAC,CAAC;4BACF,QAAQ,EAAE,MAAM,CAAC,QAAQ;4BACzB,IAAI,EAAE,MAAM,CAAC,IAAI;yBAClB,CAAC;oBACJ,CAAC;oBACD,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;wBACtB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CACzB,IAAI,yBAAW,CAAC,GAAG,EAAE,MAAmB,CAAC,CAC1C,CAAC;wBAEF,IAAI,MAAM,GAAqB,EAAE,CAAC;wBAElC,uEAAuE;wBACvE,8EAA8E;wBAC9E,oGAAoG;wBACpG,yEAAyE;wBACzE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,cAAc,EAAE,EAAE;4BAC1D,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gCAC3C,OAAO;oCACL,UAAU,EAAE,KAAK,CAAC,UAAU;oCAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;iCACjB,CAAC;4BACJ,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;wBAEH,MAAM,SAAS,GAAG,IAAI,uBAAS,CAAC;4BAC9B,UAAU,EAAE,IAAI;4BAChB,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ;gCAClC,IAAI,CAAC,MAAM,EAAE,CAAC;oCACZ,QAAQ,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;oCAE5C,OAAO;gCACT,CAAC;gCAED,kDAAkD;gCAClD,IAAI,CAAC,IAAI,CAAC;oCACR,MAAM;oCACN,GAAG,EAAE,KAAK;iCACX,CAAC,CAAC;gCAEH,QAAQ,EAAE,CAAC;4BACb,CAAC;yBACF,CAAC,CAAC;wBAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;4BAC3B,SAAS,CAAC,IAAI,CACZ,OAAO,EACP,SAAS,CAAC,KAAK,EAAE;gCACf,GAAG;gCACH,MAAM,EAAE,MAAoC;6BAC7C,CAAC,CACH,CAAC;wBACJ,CAAC,CAAC,CAAC;wBAEH,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,CAAC;iBACF,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAhIW,QAAA,qBAAqB,yBAgIhC"}

package/dist/factories/createPgDriverFactory.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createPgDriverFactory.test.d.ts.map

package/dist/factories/createPgDriverFactory.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPgDriverFactory.test.d.ts","sourceRoot":"","sources":["../../src/factories/createPgDriverFactory.test.ts"],"names":[],"mappings":""}

package/dist/factories/createPgDriverFactory.test.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+(0, ava_1.default)('ok', (t) => {
+    t.pass();
+});
+//# sourceMappingURL=createPgDriverFactory.test.js.map

package/dist/factories/createPgDriverFactory.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPgDriverFactory.test.js","sourceRoot":"","sources":["../../src/factories/createPgDriverFactory.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AAEvB,IAAA,aAAI,EAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;IACf,CAAC,CAAC,IAAI,EAAE,CAAC;AACX,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createPgDriverFactory } from './factories/createPgDriverFactory';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPgDriverFactory = void 0;
+var createPgDriverFactory_1 = require("./factories/createPgDriverFactory");
+Object.defineProperty(exports, "createPgDriverFactory", { enumerable: true, get: function () { return createPgDriverFactory_1.createPgDriverFactory; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2EAA0E;AAAjE,8HAAA,qBAAqB,OAAA"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "author": {
+    "email": "gajus@gajus.com",
+    "name": "Gajus Kuizinas",
+    "url": "http://gajus.com"
+  },
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "files": [
+      "src/**/*.test.ts"
+    ],
+    "require": [
+      "ts-node/register/transpile-only"
+    ]
+  },
+  "dependencies": {
+    "@slonik/driver": "^43.0.6",
+    "@slonik/errors": "^43.0.6",
+    "@slonik/sql-tag": "^43.0.6",
+    "@slonik/types": "^43.0.6",
+    "@slonik/utilities": "^43.0.6",
+    "pg-query-stream": "^4.5.5",
+    "pg-types": "^4.0.2",
+    "pg": "^8.11.5",
+    "postgres-array": "^3.0.2"
+  },
+  "description": "A Node.js PostgreSQL client with strict types, detailed logging and assertions.",
+  "devDependencies": {
+    "@types/pg": "^8.11.6",
+    "@types/node": "^18.15.3",
+    "ava": "^5.3.1",
+    "cspell": "^8.6.0",
+    "eslint": "^8.57.0",
+    "eslint-config-canonical": "^42.8.1",
+    "nyc": "^15.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.4.3"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "./src",
+    "./dist"
+  ],
+  "keywords": [
+    "postgresql",
+    "promise",
+    "types"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "name": "@slonik/pg-driver",
+  "nyc": {
+    "all": true,
+    "exclude": [
+      "**/*.d.ts"
+    ],
+    "include": [
+      "src/**/*.ts"
+    ],
+    "reporter": [
+      "html",
+      "text-summary"
+    ],
+    "require": [
+      "ts-node/register/transpile-only"
+    ],
+    "silent": true,
+    "sourceMap": false
+  },
+  "peerDependencies": {
+    "zod": "^3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gajus/slonik"
+  },
+  "scripts": {
+    "build": "rm -fr ./dist && tsc --project ./tsconfig.json",
+    "lint": "npm run lint:cspell && npm run lint:eslint && npm run lint:tsc",
+    "lint:cspell": "cspell . --no-progress --gitignore",
+    "lint:eslint": "eslint --cache ./src",
+    "lint:tsc": "tsc --noEmit",
+    "test": "nyc ava --verbose --serial"
+  },
+  "types": "./dist/index.d.ts",
+  "version": "43.0.6"
+}

package/src/factories/createPgDriverFactory.test.ts

@@ -0,0 +1,5 @@
+import test from 'ava';
+
+test('ok', (t) => {
+  t.pass();
+});

package/src/factories/createPgDriverFactory.ts

@@ -0,0 +1,382 @@
+/* eslint-disable canonical/id-match */
+
+import {
+  createDriverFactory,
+  type DriverCommand,
+  type DriverConfiguration,
+  type DriverFactory,
+  type DriverTypeParser,
+} from '@slonik/driver';
+import {
+  BackendTerminatedError,
+  BackendTerminatedUnexpectedlyError,
+  CheckIntegrityConstraintViolationError,
+  ForeignKeyIntegrityConstraintViolationError,
+  IdleTransactionTimeoutError,
+  InputSyntaxError,
+  InvalidInputError,
+  NotNullIntegrityConstraintViolationError,
+  StatementCancelledError,
+  StatementTimeoutError,
+  UnexpectedStateError,
+  UniqueIntegrityConstraintViolationError,
+} from '@slonik/errors';
+import { type PrimitiveValueExpression } from '@slonik/sql-tag';
+import { type Field, type Query } from '@slonik/types';
+import { parseDsn } from '@slonik/utilities';
+import { Transform } from 'node:stream';
+// eslint-disable-next-line no-restricted-imports
+import {
+  Client,
+  type ClientConfig as NativePostgresClientConfiguration,
+  type DatabaseError,
+} from 'pg';
+import QueryStream from 'pg-query-stream';
+import { getTypeParser as getNativeTypeParser } from 'pg-types';
+import { parse as parseArray } from 'postgres-array';
+
+type PostgresType = {
+  oid: string;
+  typarray: string;
+  typname: string;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type TypeOverrides = (oid: number) => any;
+
+const createTypeOverrides = async (
+  connection: Client,
+  typeParsers: readonly DriverTypeParser[],
+): Promise<TypeOverrides> => {
+  const typeNames = typeParsers.map((typeParser) => {
+    return typeParser.name;
+  });
+
+  const postgresTypes = (
+    await connection.query(
+      `
+        SELECT
+          oid,
+          typarray,
+          typname
+        FROM pg_type
+        WHERE typname = ANY($1::text[])
+      `,
+      [typeNames],
+    )
+  ).rows as PostgresType[];
+
+  const parsers = {};
+
+  for (const typeParser of typeParsers) {
+    const postgresType = postgresTypes.find((maybeTargetPostgresType) => {
+      return maybeTargetPostgresType.typname === typeParser.name;
+    });
+
+    if (!postgresType) {
+      throw new Error('Database type "' + typeParser.name + '" not found.');
+    }
+
+    parsers[postgresType.oid] = (value) => {
+      return typeParser.parse(value);
+    };
+
+    if (postgresType.typarray) {
+      parsers[postgresType.typarray] = (arrayValue) => {
+        return parseArray(arrayValue).map((value) => {
+          return typeParser.parse(value);
+        });
+      };
+    }
+  }
+
+  return (oid: number) => {
+    if (parsers[oid]) {
+      return parsers[oid];
+    }
+
+    return getNativeTypeParser(oid);
+  };
+};
+
+const createClientConfiguration = (
+  clientConfiguration: DriverConfiguration,
+): NativePostgresClientConfiguration => {
+  const connectionOptions = parseDsn(clientConfiguration.connectionUri);
+
+  const poolConfiguration: NativePostgresClientConfiguration = {
+    application_name: connectionOptions.applicationName,
+    database: connectionOptions.databaseName,
+    host: connectionOptions.host,
+    options: connectionOptions.options,
+    password: connectionOptions.password,
+    port: connectionOptions.port,
+    ssl: false,
+    user: connectionOptions.username,
+  };
+
+  if (clientConfiguration.ssl) {
+    poolConfiguration.ssl = clientConfiguration.ssl;
+  } else if (connectionOptions.sslMode === 'disable') {
+    poolConfiguration.ssl = false;
+  } else if (connectionOptions.sslMode === 'require') {
+    poolConfiguration.ssl = true;
+  } else if (connectionOptions.sslMode === 'no-verify') {
+    poolConfiguration.ssl = {
+      rejectUnauthorized: false,
+    };
+  }
+
+  if (clientConfiguration.connectionTimeout !== 'DISABLE_TIMEOUT') {
+    if (clientConfiguration.connectionTimeout === 0) {
+      poolConfiguration.connectionTimeoutMillis = 1;
+    } else {
+      poolConfiguration.connectionTimeoutMillis =
+        clientConfiguration.connectionTimeout;
+    }
+  }
+
+  if (clientConfiguration.statementTimeout !== 'DISABLE_TIMEOUT') {
+    if (clientConfiguration.statementTimeout === 0) {
+      poolConfiguration.statement_timeout = 1;
+    } else {
+      poolConfiguration.statement_timeout =
+        clientConfiguration.statementTimeout;
+    }
+  }
+
+  if (
+    clientConfiguration.idleInTransactionSessionTimeout !== 'DISABLE_TIMEOUT'
+  ) {
+    if (clientConfiguration.idleInTransactionSessionTimeout === 0) {
+      poolConfiguration.idle_in_transaction_session_timeout = 1;
+    } else {
+      poolConfiguration.idle_in_transaction_session_timeout =
+        clientConfiguration.idleInTransactionSessionTimeout;
+    }
+  }
+
+  return poolConfiguration;
+};
+
+const queryTypeOverrides = async (
+  pgClientConfiguration: NativePostgresClientConfiguration,
+  driverConfiguration: DriverConfiguration,
+): Promise<TypeOverrides> => {
+  const client = new Client(pgClientConfiguration);
+
+  await client.connect();
+
+  const typeOverrides = await createTypeOverrides(
+    client,
+    driverConfiguration.typeParsers,
+  );
+
+  await client.end();
+
+  return typeOverrides;
+};
+
+const isErrorWithCode = (error: Error): error is DatabaseError => {
+  return 'code' in error;
+};
+
+// query is not available for connection-level errors.
+// TODO evaluate if we can remove query from the error object.
+// I suspect we should not be even using InputSyntaxError as one of the error types.
+// @see https://github.com/gajus/slonik/issues/557
+const wrapError = (error: Error, query: Query | null) => {
+  if (
+    error.message.toLowerCase().includes('connection terminated unexpectedly')
+  ) {
+    return new BackendTerminatedUnexpectedlyError(error);
+  }
+
+  if (error.message.toLowerCase().includes('connection terminated')) {
+    return new BackendTerminatedError(error);
+  }
+
+  if (!isErrorWithCode(error)) {
+    return error;
+  }
+
+  if (error.code === '22P02') {
+    return new InvalidInputError(error.message);
+  }
+
+  if (error.code === '25P03') {
+    return new IdleTransactionTimeoutError(error);
+  }
+
+  if (error.code === '57P01') {
+    return new BackendTerminatedError(error);
+  }
+
+  if (
+    error.code === '57014' &&
+    // The code alone is not enough to distinguish between a statement timeout and a statement cancellation.
+    error.message.includes('canceling statement due to user request')
+  ) {
+    return new StatementCancelledError(error);
+  }
+
+  if (error.code === '57014') {
+    return new StatementTimeoutError(error);
+  }
+
+  if (error.code === '23502') {
+    return new NotNullIntegrityConstraintViolationError(error);
+  }
+
+  if (error.code === '23503') {
+    return new ForeignKeyIntegrityConstraintViolationError(error);
+  }
+
+  if (error.code === '23505') {
+    return new UniqueIntegrityConstraintViolationError(error);
+  }
+
+  if (error.code === '23514') {
+    return new CheckIntegrityConstraintViolationError(error);
+  }
+
+  if (error.code === '42601') {
+    if (!query) {
+      return new UnexpectedStateError('Expected query to be provided');
+    }
+
+    return new InputSyntaxError(error, query);
+  }
+
+  return error;
+};
+
+export const createPgDriverFactory = (): DriverFactory => {
+  return createDriverFactory(async ({ driverConfiguration }) => {
+    const clientConfiguration = createClientConfiguration(driverConfiguration);
+
+    // eslint-disable-next-line require-atomic-updates
+    clientConfiguration.types = {
+      getTypeParser: await queryTypeOverrides(
+        clientConfiguration,
+        driverConfiguration,
+      ),
+    };
+
+    return {
+      createPoolClient: async ({ clientEventEmitter }) => {
+        const client = new Client(clientConfiguration);
+
+        // We will see this triggered when the connection is terminated, e.g.
+        // "terminates transactions that are idle beyond idleInTransactionSessionTimeout" test.
+        const onError = (error) => {
+          clientEventEmitter.emit('error', wrapError(error, null));
+        };
+
+        const onNotice = (notice) => {
+          if (notice.message) {
+            clientEventEmitter.emit('notice', {
+              message: notice.message,
+            });
+          }
+        };
+
+        client.on('error', onError);
+        client.on('notice', onNotice);
+
+        return {
+          connect: async () => {
+            await client.connect();
+          },
+          end: async () => {
+            await client.end();
+
+            client.removeListener('error', onError);
+            client.removeListener('notice', onNotice);
+          },
+          query: async (sql, values) => {
+            let result;
+
+            try {
+              result = await client.query(sql, values as unknown[]);
+            } catch (error) {
+              throw wrapError(error, {
+                sql,
+                values: values as readonly PrimitiveValueExpression[],
+              });
+            }
+
+            if (Array.isArray(result)) {
+              throw new InvalidInputError(
+                'Must not use multiple statements in a single query.',
+              );
+            }
+
+            return {
+              command: result.command as DriverCommand,
+              fields: result.fields.map((field) => {
+                return {
+                  dataTypeId: field.dataTypeID,
+                  name: field.name,
+                };
+              }),
+              rowCount: result.rowCount,
+              rows: result.rows,
+            };
+          },
+          stream: (sql, values) => {
+            const stream = client.query(
+              new QueryStream(sql, values as unknown[]),
+            );
+
+            let fields: readonly Field[] = [];
+
+            // `rowDescription` will not fire if the query produces a syntax error.
+            // Also, `rowDescription` won't fire until client starts consuming the stream.
+            // This is why we cannot simply await for `rowDescription` event before starting to pipe the stream.
+            // @ts-expect-error – https://github.com/brianc/node-postgres/issues/3015
+            client.connection.once('rowDescription', (rowDescription) => {
+              fields = rowDescription.fields.map((field) => {
+                return {
+                  dataTypeId: field.dataTypeID,
+                  name: field.name,
+                };
+              });
+            });
+
+            const transform = new Transform({
+              objectMode: true,
+              async transform(datum, enc, callback) {
+                if (!fields) {
+                  callback(new Error('Fields not available'));
+
+                  return;
+                }
+
+                // eslint-disable-next-line @babel/no-invalid-this
+                this.push({
+                  fields,
+                  row: datum,
+                });
+
+                callback();
+              },
+            });
+
+            stream.on('error', (error) => {
+              transform.emit(
+                'error',
+                wrapError(error, {
+                  sql,
+                  values: values as PrimitiveValueExpression[],
+                }),
+              );
+            });
+
+            return stream.pipe(transform);
+          },
+        };
+      },
+    };
+  });
+};

package/src/index.ts

@@ -0,0 +1 @@
+export { createPgDriverFactory } from './factories/createPgDriverFactory';