postgrejs 3.10.0 → 3.10.1

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Changelog
 
-### [v3.10.0](https://github.com/panates/postgrejs/compare/v3.9.0...v3.10.0) - 
+### [v3.10.1](https://github.com/panates/postgrejs/compare/v3.10.0...v3.10.1) - 
+
+#### 🚀 New Features
+
+- feat: accept `connectionString`, and answer a key from another client @Eray Hanoğlu 
+
+### [v3.10.0](https://github.com/panates/postgrejs/compare/v3.9.0...v3.10.0) -  22 September 2026 
 
 #### Breaking Changes :warning:
 
@@ -21,6 +27,10 @@
 - fix: sign only the interval components that have one, and add toPostgres() @Eray Hanoğlu 
 - fix: read the database out of a `postgresql://` URL @Eray Hanoğlu 
 
+#### 📖 Documentation Changes
+
+- docs: name the migration note after the release it is for @Eray Hanoğlu 
+
 ### [v3.9.0](https://github.com/panates/postgrejs/compare/v3.8.0...v3.9.0) -  22 September 2026 
 
 #### 🚀 New Features

package/interfaces/database-connection-params.d.ts

@@ -5,6 +5,16 @@ import type { DebugLogger } from '../types.js';
 import type { DataMappingOptions } from './data-mapping-options.js';
 import type { QueryOptions } from './query-options.js';
 export interface DatabaseConnectionParams {
+    /**
+     * A whole connection string, as an alternative to the fields below -
+     * `pg`'s spelling of what this client also accepts as a bare string
+     * (`new Connection('postgres://...')`).
+     *
+     * Like `pg`, what the string names wins over a field of the same name
+     * beside it, so a value the string carries is not quietly overridden
+     * by one that was left in the object.
+     */
+    connectionString?: string;
     host?: string;
     port?: number;
     user?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "postgrejs",
   "description": "Professional PostgreSQL client NodeJS",
-  "version": "3.10.0",
+  "version": "3.10.1",
   "author": "Panates",
   "license": "BSD-3-Clause",
   "dependencies": {

package/util/connection-config.js

@@ -1,12 +1,66 @@
 import { merge } from '@jsopen/objects';
 import { configFromEnv } from './config-from-env.js';
+/**
+ * Spellings from other clients that mean something here under a
+ * different name.
+ *
+ * Nothing checks that a configuration's keys are keys this client knows,
+ * and it deliberately stays that way: a `PoolConfiguration` carries
+ * `lightning-pool`'s own options, which are not declared here, and
+ * callers pass configurations that carry their own fields. An allowlist
+ * would reject those, and would have to be kept current forever.
+ *
+ * What is caught instead is the short list of names that are *wrong* -
+ * each is the right idea under another client's spelling, so it can be
+ * answered with the name that works rather than merely refused.
+ */
+const FOREIGN_KEYS = {
+    connection_string: 'connectionString',
+    connectionUri: 'connectionString',
+    uri: 'connectionString',
+    url: 'connectionString',
+    dbname: 'database',
+    db: 'database',
+    username: 'user',
+    pass: 'password',
+    passwd: 'password',
+    hostname: 'host',
+    application_name: 'applicationName',
+    connect_timeout: 'connectTimeoutMs',
+    connectionTimeoutMillis: 'connectTimeoutMs',
+};
+function checkForeignKeys(config) {
+    let k;
+    for (k in config) {
+        const meant = FOREIGN_KEYS[k];
+        if (meant && config[k] !== undefined)
+            throw new TypeError(`"${k}" is not a connection option here - did you mean "${meant}"? ` +
+                'An option this client does not know is otherwise ignored, so a ' +
+                'name that is nearly right does nothing and says nothing.');
+    }
+}
 export function getConnectionConfig(config) {
     const cfg = configFromEnv();
     if (typeof config === 'string') {
         merge(cfg, parseConnectionString(config));
     }
     else if (typeof config === 'object') {
+        checkForeignKeys(config);
         merge(cfg, config);
+        // `pg`'s spelling of the same thing, and what `drizzle-orm`'s first
+        // example writes - so it is the single most likely key someone
+        // moving from `pg` puts here. Ignored, it did not fail: it connected
+        // to whatever the environment defaults to, which in development is
+        // usually a database that exists, so the mistake surfaced as missing
+        // tables or as writes landing somewhere else. Applied after the
+        // merge and not before it, because `pg` lets the string win over the
+        // fields beside it.
+        const cs = cfg.connectionString;
+        if (cs !== undefined) {
+            delete cfg.connectionString;
+            if (cs)
+                merge(cfg, parseConnectionString('' + cs));
+        }
     }
     if (cfg.host) {
         const explicitRequireSSL = cfg.requireSSL;