pg-promise 11.14.0 → 11.15.0

package/README.md

@@ -2,7 +2,7 @@ pg-promise
 ==========
 
 [![Build Status](https://github.com/vitaly-t/pg-promise/actions/workflows/ci.yml/badge.svg)](https://github.com/vitaly-t/pg-promise/actions/workflows/ci.yml)
-[![Node Version](https://img.shields.io/badge/nodejs-14%20--%2024-green.svg?logo=node.js&style=flat)](https://nodejs.org)
+[![Node Version](https://img.shields.io/badge/nodejs-16%20--%2024-green.svg?logo=node.js&style=flat)](https://nodejs.org)
 [![Postgres Version](https://img.shields.io/badge/postgresql-10%20--%2016-green.svg?logo=postgresql&style=flat)](https://www.postgresql.org)
 
 ---

package/lib/events.js

@@ -531,7 +531,6 @@ module.exports = {Events};
  * It is set for all events.
  * 
  * @property {string|undefined} queryFilePath
- * **Added in v11.14**<br/>
  * File path of a {@link QueryFile}, if the query comes from an external SQL file.
  * This is set only when the query originates from a {@link QueryFile} and only for events {@link event:query query} and {@link event:error error}.
  *

package/lib/index.js

@@ -12,17 +12,18 @@ var v = process.versions.node.split('.'),
     highVer = +v[0];
 
 // istanbul ignore next
-if (highVer < 14) {
+if (highVer < 16) {
 
-    // From pg-promise v11.0.0, the oldest supported Node.js is v14.0.0
+    // From pg-promise v11.15.0, the oldest supported Node.js is v16.0.0
 
-    // Node.js v12.0.0 was supported up to pg-promise v10.15.4
-    // Node.js v8.0.0 was supported up to pg-promise v10.14.2
+    // Node.js v14.x was supported up to pg-promise v11.14.0
+    // Node.js v12.x was supported up to pg-promise v10.15.4
+    // Node.js v8.x was supported up to pg-promise v10.14.2
     // Node.js v7.6.0 was supported up to pg-promise v10.3.5
     // Node.js v4.5.0 was supported up to pg-promise v8.7.5
     // Node.js v0.10 was supported up to pg-promise v5.5.8
 
-    throw new Error('Minimum Node.js version supported by pg-promise is 14.0.0');
+    throw new Error('Minimum Node.js version supported by pg-promise is 16.0.0');
 }
 
 module.exports = require('./main');

package/lib/main.js

@@ -36,7 +36,7 @@ let originalClientConnect;
  * @module pg-promise
  *
  * @description
- * ## pg-promise v11.14
+ * ## pg-promise v11.15
  * All documentation here is for the latest official release only.
  *
  * ### Initialization Options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "11.14.0",
+  "version": "11.15.0",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -38,25 +38,25 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=14.0"
+    "node": ">=16.0"
   },
   "dependencies": {
     "assert-options": "0.8.3",
-    "pg": "8.14.1",
-    "pg-minify": "1.7.0",
+    "pg": "8.16.3",
+    "pg-minify": "1.8.0",
     "spex": "3.4.1"
   },
   "peerDependencies": {
-    "pg-query-stream": "4.8.1"
+    "pg-query-stream": "4.10.3"
   },
   "devDependencies": {
-    "@eslint/js": "9.28.0",
-    "@types/node": "22.15.29",
+    "@eslint/js": "9.30.1",
+    "@types/node": "24.0.10",
     "bluebird": "3.7.2",
     "coveralls": "3.1.1",
-    "cspell": "9.0.2",
-    "eslint": "9.28.0",
-    "globals": "16.2.0",
+    "cspell": "9.1.3",
+    "eslint": "9.30.1",
+    "globals": "16.3.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
     "jsdoc": "4.0.4",

package/typescript/README.md

@@ -21,7 +21,7 @@ const {value} = await db.one('SELECT 123 as value');
 #### With Extensions
 
 The library supports dynamic protocol extensions, via event [extend], which requires
-explicit extension interface to be declared and parameterized, as shown below.
+an explicit extension interface to be declared and parameterized, as shown below.
 
 ```ts
 import * as pgPromise from 'pg-promise';

package/typescript/pg-promise.d.ts

@@ -7,17 +7,6 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-/////////////////////////////////////////
-// Requires pg-promise v11.0.0 or later.
-/////////////////////////////////////////
-
-// We use ES6 as static promise here, because generic promises are still not supported.
-// Follow the links below:
-// https://stackoverflow.com/questions/36593087/using-a-custom-promise-as-a-generic-type
-// https://github.com/Microsoft/TypeScript/issues/1213
-
-type XPromise<T> = Promise<T>;
-
 import * as pg from './pg-subset';
 import * as pgMinify from 'pg-minify';
 import * as spexLib from 'spex';
@@ -138,13 +127,13 @@ declare namespace pgPromise {
     }
 
     interface IPromiseConfig {
-        create(resolve: (value?: any) => void, reject?: (reason?: any) => void): XPromise<any>
+        create(resolve: (value?: any) => void, reject?: (reason?: any) => void): Promise<any>
 
         resolve(value?: any): void
 
         reject(reason?: any): void
 
-        all(iterable: any): XPromise<any>
+        all(iterable: any): Promise<any>
     }
 
     type FormattingFilter = '^' | '~' | '#' | ':raw' | ':alias' | ':name' | ':json' | ':csv' | ':list' | ':value';
@@ -308,7 +297,7 @@ declare namespace pgPromise {
     // We export this interface only to be able to help IntelliSense cast extension types correctly,
     // which doesn't always work, depending on the version of IntelliSense being used.
     interface IDatabase<Ext, C extends pg.IClient = pg.IClient> extends IBaseProtocol<Ext> {
-        connect(options?: IConnectionOptions<C>): XPromise<IConnected<Ext, C>>
+        connect(options?: IConnectionOptions<C>): Promise<IConnected<Ext, C>>
 
         /////////////////////////////////////////////////////////////////////////////
         // Hidden, read-only properties, for integrating with third-party libraries:
@@ -369,89 +358,89 @@ declare namespace pgPromise {
     interface IBaseProtocol<Ext> {
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#query
-        query<T = any>(query: QueryParam, values?: any, qrm?: queryResult): XPromise<T>
+        query<T = any>(query: QueryParam, values?: any, qrm?: queryResult): Promise<T>
 
         // result-specific methods;
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#none
-        none(query: QueryParam, values?: any): XPromise<null>
+        none(query: QueryParam, values?: any): Promise<null>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#one
-        one<T = any>(query: QueryParam, values?: any, cb?: (value: any) => T, thisArg?: any): XPromise<T>
+        one<T = any>(query: QueryParam, values?: any, cb?: (value: any) => T, thisArg?: any): Promise<T>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#oneOrNone
-        oneOrNone<T = any>(query: QueryParam, values?: any, cb?: (value: any) => T, thisArg?: any): XPromise<T | null>
+        oneOrNone<T = any>(query: QueryParam, values?: any, cb?: (value: any) => T, thisArg?: any): Promise<T | null>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#many
-        many<T = any>(query: QueryParam, values?: any): XPromise<T[]>
+        many<T = any>(query: QueryParam, values?: any): Promise<T[]>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#manyOrNone
-        manyOrNone<T = any>(query: QueryParam, values?: any): XPromise<T[]>
+        manyOrNone<T = any>(query: QueryParam, values?: any): Promise<T[]>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#any
-        any<T = any>(query: QueryParam, values?: any): XPromise<T[]>
+        any<T = any>(query: QueryParam, values?: any): Promise<T[]>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#result
-        result<T, R = IResultExt<T>>(query: QueryParam, values?: any, cb?: (value: IResultExt<T>) => R, thisArg?: any): XPromise<R>
+        result<T, R = IResultExt<T>>(query: QueryParam, values?: any, cb?: (value: IResultExt<T>) => R, thisArg?: any): Promise<R>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#multiResult
-        multiResult(query: QueryParam, values?: any): XPromise<pg.IResult[]>
+        multiResult(query: QueryParam, values?: any): Promise<pg.IResult[]>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#multi
-        multi<T = any>(query: QueryParam, values?: any): XPromise<Array<T[]>>
+        multi<T = any>(query: QueryParam, values?: any): Promise<Array<T[]>>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#stream
-        stream(qs: NodeJS.ReadableStream, init: (stream: NodeJS.ReadableStream) => void): XPromise<{
+        stream(qs: NodeJS.ReadableStream, init: (stream: NodeJS.ReadableStream) => void): Promise<{
             processed: number,
             duration: number
         }>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#func
-        func<T = any>(funcName: string, values?: any, qrm?: queryResult): XPromise<T>
+        func<T = any>(funcName: string, values?: any, qrm?: queryResult): Promise<T>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#proc
-        proc<T = any>(procName: string, values?: any, cb?: (value: any) => T, thisArg?: any): XPromise<T | null>
+        proc<T = any>(procName: string, values?: any, cb?: (value: any) => T, thisArg?: any): Promise<T | null>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#map
-        map<T = any>(query: QueryParam, values: any, cb: (row: any, index: number, data: any[]) => T, thisArg?: any): XPromise<T[]>
+        map<T = any>(query: QueryParam, values: any, cb: (row: any, index: number, data: any[]) => T, thisArg?: any): Promise<T[]>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#each
-        each<T = any>(query: QueryParam, values: any, cb: (row: any, index: number, data: any[]) => void, thisArg?: any): XPromise<T[]>
+        each<T = any>(query: QueryParam, values: any, cb: (row: any, index: number, data: any[]) => void, thisArg?: any): Promise<T[]>
 
         // Tasks;
         // API: https://vitaly-t.github.io/pg-promise/Database.html#task
-        task<T>(cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        task<T>(cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        task<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        task<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        task<T>(options: { tag?: any }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        task<T>(options: { tag?: any }, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
         // Conditional Tasks;
         // API: https://vitaly-t.github.io/pg-promise/Database.html#taskIf
-        taskIf<T>(cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        taskIf<T>(cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        taskIf<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        taskIf<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        taskIf<T>(options: ITaskIfOptions<Ext>, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        taskIf<T>(options: ITaskIfOptions<Ext>, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
         // Transactions;
         // API: https://vitaly-t.github.io/pg-promise/Database.html#tx
-        tx<T>(cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        tx<T>(cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        tx<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        tx<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
         tx<T>(options: {
             tag?: any,
             mode?: _txMode.TransactionMode | null
-        }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        }, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
         // Conditional Transactions;
         // API: https://vitaly-t.github.io/pg-promise/Database.html#txIf
-        txIf<T>(cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        txIf<T>(cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        txIf<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        txIf<T>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
 
-        txIf<T>(options: ITxIfOptions<Ext>, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        txIf<T>(options: ITxIfOptions<Ext>, cb: (t: ITask<Ext> & Ext) => T | Promise<T>): Promise<T>
     }
 
     // Database object in connected state;
@@ -465,10 +454,10 @@ declare namespace pgPromise {
 
         // But for direct connections (connect({direct: true})), `kill` flag is ignored, because
         // the connection is always closed physically, which may take time, and so in this case
-        // the method returns a Promise, to indicate when the connection finished closing.
-        done(kill?: boolean): void | XPromise<void>;
+        // the method returns a Promise to indicate when the connection finished closing.
+        done(kill?: boolean): void | Promise<void>;
 
-        // Repeated calls are not allowed, and will throw an error.
+        // Repeated calls are not allowed and will throw an error.
     }
 
     // Event context extension for tasks + transactions;
@@ -510,7 +499,7 @@ declare namespace pgPromise {
         query: any
         params: any,
         values: any,
-        queryFilePath?: string, 
+        queryFilePath?: string,
         ctx: ITaskContext
     }
 
@@ -609,7 +598,7 @@ declare namespace pgPromise {
 
         query?(e: IEventContext<C>): void
 
-        // NOTE: result is undefined when data comes from QueryStream, i.e. via method Database.stream
+        // NOTE: The result is undefined when data comes from QueryStream, i.e. via method Database.stream
         receive?(e: { data: any[], result: IResultExt | void, ctx: IEventContext<C> }): void
 
         task?(e: IEventContext<C>): void
@@ -723,13 +712,13 @@ declare namespace pgPromise {
     }
 
     interface IGenericPromise {
-        (cb: (resolve: (value?: any) => void, reject: (reason?: any) => void) => void): XPromise<any>
+        (cb: (resolve: (value?: any) => void, reject: (reason?: any) => void) => void): Promise<any>
 
         resolve(value?: any): void
 
         reject(reason?: any): void
 
-        all(iterable: any): XPromise<any>
+        all(iterable: any): Promise<any>
     }
 }
 

package/typescript/pg-subset.d.ts

@@ -30,7 +30,7 @@ declare namespace pg {
         oid: number
         dataTypeID: number
 
-        // NOTE: properties below are not available within Native Bindings:
+        // NOTE: The properties below are not available within Native Bindings:
 
         tableID: number
         columnID: number