pg-promise 10.14.0 → 10.14.2

package/lib/assert.js

@@ -0,0 +1,10 @@
+const {assertOptions} = require(`assert-options`);
+
+// this to allow override options-related errors globally (for pg-promise)
+global.pgPromiseAssert = assertOptions;
+
+module.exports = {
+    assert() {
+        return global.pgPromiseAssert.apply(null, [...arguments]);
+    }
+};

package/lib/database.js

@@ -8,7 +8,7 @@
  */
 
 const {Events} = require(`./events`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 const {resultQuery, multiResultQuery, streamQuery} = require(`./special-query`);
 const {ConnectionContext} = require(`./context`);
 const {DatabasePool} = require(`./database-pool`);
@@ -1289,7 +1289,7 @@ function Database(cn, dc, config) {
          */
         obj.task = function () {
             const args = npm.pubUtils.taskArgs(arguments);
-            assertOptions(args.options, [`tag`]);
+            assert(args.options, [`tag`]);
             return taskProcessor.call(this, args, false);
         };
 
@@ -1347,7 +1347,7 @@ function Database(cn, dc, config) {
          */
         obj.taskIf = function () {
             const args = npm.pubUtils.taskArgs(arguments);
-            assertOptions(args.options, [`tag`, `cnd`]);
+            assert(args.options, [`tag`, `cnd`]);
             try {
                 let cnd = args.options.cnd;
                 if (`cnd` in args.options) {
@@ -1456,7 +1456,7 @@ function Database(cn, dc, config) {
          */
         obj.tx = function () {
             const args = npm.pubUtils.taskArgs(arguments);
-            assertOptions(args.options, [`tag`, `mode`]);
+            assert(args.options, [`tag`, `mode`]);
             return taskProcessor.call(this, args, true);
         };
 
@@ -1529,7 +1529,7 @@ function Database(cn, dc, config) {
          */
         obj.txIf = function () {
             const args = npm.pubUtils.taskArgs(arguments);
-            assertOptions(args.options, [`tag`, `mode`, `cnd`, `reusable`]);
+            assert(args.options, [`tag`, `mode`, `cnd`, `reusable`]);
             try {
                 let cnd;
                 if (`cnd` in args.options) {

package/lib/formatting.js

@@ -7,7 +7,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 
 const npm = {
     pgUtils: require(`pg/lib/utils`),
@@ -101,7 +101,7 @@ function formatValue({value, fm, cc, options}) {
             if (Array.isArray(value)) {
                 return $to.array(value, options);
             }
-            if (value instanceof Buffer) {
+            if (Buffer.isBuffer(value)) {
                 return $to.buffer(value, isRaw);
             }
             return $to.json(value, isRaw);
@@ -115,7 +115,7 @@ function formatValue({value, fm, cc, options}) {
 // Arrays of any depth/dimension are supported.
 //
 // Top-level empty arrays are formatted as literal '{}' to avoid the necessity of explicit type casting,
-// as the server cannot automatically infer the type of an empty non-literal array.
+// as the server cannot automatically infer the type of empty non-literal array.
 function formatArray(array, options) {
     const loop = a => `[` + a.map(value => Array.isArray(value) ? loop(value) : formatValue({
         value,
@@ -683,7 +683,7 @@ const $as = {
      * @returns {string}
      */
     array(arr, options) {
-        options = assertOptions(options, [`capSQL`]);
+        options = assert(options, [`capSQL`]);
         arr = resolveFunc(arr);
         if (isNull(arr)) {
             return `null`;
@@ -850,7 +850,7 @@ const $as = {
      * The function will throw an error, if any occurs during formatting.
      */
     format(query, values, options) {
-        options = assertOptions(options, [`capSQL`, `partial`, `def`]);
+        options = assert(options, [`capSQL`, `partial`, `def`]);
         const ctf = getCTF(query);
         if (ctf) {
             query = ctf.toPostgres.call(query, query);

package/lib/helpers/column-set.js

@@ -8,7 +8,7 @@
  */
 
 const {InnerState} = require(`../inner-state`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 const {TableName} = require(`./table-name`);
 const {Column} = require(`./column`);
 
@@ -172,7 +172,7 @@ class ColumnSet extends InnerState {
             throw new TypeError(`Invalid parameter 'columns' specified.`);
         }
 
-        opt = assertOptions(opt, [`table`, `inherit`]);
+        opt = assert(opt, [`table`, `inherit`]);
 
         if (!npm.utils.isNull(opt.table)) {
             this.table = (opt.table instanceof TableName) ? opt.table : new TableName(opt.table);
@@ -400,7 +400,7 @@ ColumnSet.prototype.assign = function (options) {
  *
  */
 ColumnSet.prototype.assignColumns = function (options) {
-    options = assertOptions(options, [`from`, `to`, `skip`]);
+    options = assert(options, [`from`, `to`, `skip`]);
     const skip = (typeof options.skip === `string` && [options.skip]) || ((Array.isArray(options.skip) || typeof options.skip === `function`) && options.skip);
     const from = (typeof options.from === `string` && options.from && (npm.formatting.as.alias(options.from) + `.`)) || ``;
     const to = (typeof options.to === `string` && options.to && (npm.formatting.as.alias(options.to) + `.`)) || ``;

package/lib/helpers/column.js

@@ -8,7 +8,7 @@
  */
 
 const {InnerState} = require(`../inner-state`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 
 const npm = {
     os: require(`os`),
@@ -142,7 +142,7 @@ class Column extends InnerState {
                 this.cnd = info.cnd;
             }
         } else {
-            col = assertOptions(col, [`name`, `prop`, `mod`, `cast`, `cnd`, `def`, `init`, `skip`]);
+            col = assert(col, [`name`, `prop`, `mod`, `cast`, `cnd`, `def`, `init`, `skip`]);
             if (`name` in col) {
                 if (!npm.utils.isText(col.name)) {
                     throw new TypeError(`Invalid 'name' value: ${npm.utils.toJson(col.name)}. A non-empty string was expected.`);

package/lib/helpers/methods/update.js

@@ -7,7 +7,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../../assert`);
 const {TableName} = require(`../table-name`);
 const {ColumnSet} = require(`../column-set`);
 
@@ -65,7 +65,7 @@ const npm = {
  * @param {*} [options.emptyUpdate]
  * This is a convenience option, to avoid throwing an error when generating a conditional update results in no columns.
  *
- * When present, regardless of the value, this option overrides the method's behaviour when applying `skip` logic results in no columns,
+ * When present, regardless of the value, this option overrides the method's behavior when applying `skip` logic results in no columns,
  * i.e. when every column is being skipped.
  *
  * By default, in that situation the method throws {@link external:Error Error} = `Cannot generate an UPDATE without any columns.`
@@ -168,7 +168,7 @@ function update(data, columns, table, options, capSQL) {
         columns = new ColumnSet(columns || data);
     }
 
-    options = assertOptions(options, [`tableAlias`, `valueAlias`, `emptyUpdate`]);
+    options = assert(options, [`tableAlias`, `valueAlias`, `emptyUpdate`]);
 
     const format = npm.formatting.as.format,
         useEmptyUpdate = `emptyUpdate` in options,

package/lib/helpers/table-name.js

@@ -7,7 +7,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 
 const npm = {
     utils: require(`../utils`),
@@ -65,7 +65,7 @@ class TableName {
         if (typeof table === `string`) {
             this.table = table;
         } else {
-            const config = assertOptions(table, [`table`, `schema`]);
+            const config = assert(table, [`table`, `schema`]);
             this.table = config.table;
             if (npm.utils.isText(config.schema)) {
                 this.schema = config.schema;

package/lib/main.js

@@ -13,7 +13,7 @@ const {PreparedStatement, ParameterizedQuery} = require(`./types`);
 const {QueryFile} = require(`./query-file`);
 const {queryResult} = require(`./query-result`);
 const {parsePromise} = require(`./promise-parser`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 
 const npm = {
     path: require(`path`),
@@ -191,7 +191,7 @@ let originalClientConnect;
  */
 function $main(options) {
 
-    options = assertOptions(options, [`pgFormatting`, `pgNative`, `promiseLib`, `noLocking`, `capSQL`, `noWarnings`,
+    options = assert(options, [`pgFormatting`, `pgNative`, `promiseLib`, `noLocking`, `capSQL`, `noWarnings`,
         `connect`, `disconnect`, `query`, `receive`, `task`, `transact`, `error`, `extend`, `schema`]);
 
     let pg = npm.pg;

package/lib/promise-adapter.js

@@ -7,7 +7,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 
 /**
  * @class PromiseAdapter
@@ -58,7 +58,7 @@ class PromiseAdapter {
             throw new TypeError(`Adapter requires an api configuration object.`);
         }
 
-        api = assertOptions(api, [`create`, `resolve`, `reject`, `all`]);
+        api = assert(api, [`create`, `resolve`, `reject`, `all`]);
 
         this.create = api.create;
         this.resolve = api.resolve;

package/lib/query-file.js

@@ -9,7 +9,7 @@
 
 const {InnerState} = require(`./inner-state`);
 const {QueryFileError} = require(`./errors`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 const {ColorConsole} = require(`./utils/color`);
 
 const npm = {
@@ -106,7 +106,7 @@ class QueryFile extends InnerState {
 
         let filePath = file;
 
-        options = assertOptions(options, {
+        options = assert(options, {
             debug: npm.utils.isDev(),
             minify: (options && options.compress && options.minify === undefined) ? true : undefined,
             compress: undefined,

package/lib/tx-mode.js

@@ -9,7 +9,7 @@
 
 const {InnerState} = require(`./inner-state`);
 const {addInspection} = require(`./utils`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`./assert`);
 
 /**
  * @enum {number}
@@ -103,7 +103,7 @@ const isolationLevel = {
 class TransactionMode extends InnerState {
 
     constructor(options) {
-        options = assertOptions(options, [`tiLevel`, `deferrable`, `readOnly`]);
+        options = assert(options, [`tiLevel`, `deferrable`, `readOnly`]);
         const {readOnly, deferrable} = options;
         let {tiLevel} = options;
         let level, accessMode, deferrableMode, begin = `begin`;

package/lib/types/parameterized-query.js

@@ -10,7 +10,7 @@
 const {ServerFormatting} = require(`./server-formatting`);
 const {ParameterizedQueryError} = require(`../errors`);
 const {QueryFile} = require(`../query-file`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 
 const npm = {
     EOL: require(`os`).EOL,
@@ -91,7 +91,7 @@ class ParameterizedQuery extends ServerFormatting {
                 text: options
             };
         } else {
-            options = assertOptions(options, [`text`, `values`, `binary`, `rowMode`]);
+            options = assert(options, [`text`, `values`, `binary`, `rowMode`]);
         }
         super(options);
     }

package/lib/types/prepared-statement.js

@@ -10,7 +10,7 @@
 const {ServerFormatting} = require(`./server-formatting`);
 const {PreparedStatementError} = require(`../errors`);
 const {QueryFile} = require(`../query-file`);
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 
 const npm = {
     EOL: require(`os`).EOL,
@@ -89,7 +89,7 @@ const npm = {
  */
 class PreparedStatement extends ServerFormatting {
     constructor(options) {
-        options = assertOptions(options, [`name`, `text`, `values`, `binary`, `rowMode`, `rows`]);
+        options = assert(options, [`name`, `text`, `values`, `binary`, `rowMode`, `rows`]);
         super(options);
     }
 

package/lib/utils/public.js

@@ -7,7 +7,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-const {assertOptions} = require(`assert-options`);
+const {assert} = require(`../assert`);
 
 const npm = {
     fs: require(`fs`),
@@ -187,7 +187,7 @@ function enumSql(dir, options, cb) {
     if (!npm.utils.isText(dir)) {
         throw new TypeError(`Parameter 'dir' must be a non-empty text string.`);
     }
-    options = assertOptions(options, [`recursive`, `ignoreErrors`]);
+    options = assert(options, [`recursive`, `ignoreErrors`]);
     cb = (typeof cb === `function`) ? cb : null;
     return _enumSql(dir, options, cb, ``);
 }

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "pg-promise",
-  "version": "10.14.0",
+  "version": "10.14.2",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
   "scripts": {
-    "test": "jasmine-node --captureExceptions test",
-    "test:native": "jasmine-node test --config PG_NATIVE true",
-    "doc": "jsdoc -c ./jsdoc/jsdoc.js ./jsdoc/README.md -t ./jsdoc/templates/custom",
+    "check-spelling": "cspell --config=.cspell.json \"**/*.{md,ts,js}\" --no-progress",
     "coverage": "istanbul cover ./node_modules/jasmine-node/bin/jasmine-node test",
+    "doc": "jsdoc -c ./jsdoc/jsdoc.js ./jsdoc/README.md -t ./jsdoc/templates/custom",
     "lint": "eslint ./lib ./test/*.js ./test/db --fix",
+    "test": "jasmine-node --captureExceptions test",
+    "test:native": "jasmine-node test --config PG_NATIVE true",
     "tslint": "tslint ./typescript/*.ts"
   },
   "files": [
@@ -39,7 +40,7 @@
     "node": ">=12.0"
   },
   "dependencies": {
-    "assert-options": "0.7.0",
+    "assert-options": "0.8.0",
     "pg": "8.8.0",
     "pg-minify": "1.6.2",
     "spex": "3.2.0"
@@ -48,13 +49,14 @@
     "@types/node": "18.11.9",
     "bluebird": "3.7.2",
     "coveralls": "3.1.1",
+    "cspell": "6.14.2",
     "eslint": "8.27.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
-    "jsdoc": "4.0.0",
+    "jsdoc": "3.6.11",
     "JSONStream": "1.3.5",
     "pg-query-stream": "4.2.4",
     "tslint": "6.1.3",
-    "typescript": "4.8.4"
+    "typescript": "4.9.3"
   }
 }

package/typescript/pg-promise.d.ts

@@ -21,6 +21,26 @@ import * as pg from './pg-subset';
 import * as pgMinify from 'pg-minify';
 import * as spexLib from 'spex';
 
+// internal namespace for "txMode" property:
+declare namespace _txMode {
+    // Transaction Isolation Level;
+    // API: http://vitaly-t.github.io/pg-promise/txMode.html#.isolationLevel
+    enum isolationLevel {
+        none = 0,
+        serializable = 1,
+        repeatableRead = 2,
+        readCommitted = 3
+    }
+
+    // TransactionMode class;
+    // API: http://vitaly-t.github.io/pg-promise/txMode.TransactionMode.html
+    class TransactionMode {
+        constructor(options?: { tiLevel?: isolationLevel, readOnly?: boolean, deferrable?: boolean })
+
+        begin(cap?: boolean): string
+    }
+}
+
 // Main protocol of the library;
 // API: http://vitaly-t.github.io/pg-promise/module-pg-promise.html
 declare namespace pgPromise {
@@ -269,7 +289,7 @@ declare namespace pgPromise {
         constructor(api: IPromiseConfig)
     }
 
-    const txMode: ITXMode;
+    const txMode: typeof _txMode;
     const utils: IUtils;
     const as: IFormatting;
 
@@ -311,7 +331,7 @@ declare namespace pgPromise {
         readonly spex: spexLib.ISpex
         readonly errors: typeof errors
         readonly utils: IUtils
-        readonly txMode: ITXMode
+        readonly txMode: typeof txMode
         readonly helpers: IHelpers
         readonly as: IFormatting
         readonly pg: typeof pg
@@ -353,7 +373,7 @@ declare namespace pgPromise {
         any<T = any>(query: QueryParam, values?: any): XPromise<T[]>
 
         // API: http://vitaly-t.github.io/pg-promise/Database.html#result
-        result<T = IResultExt>(query: QueryParam, values?: any, cb?: (value: IResultExt) => T, thisArg?: any): XPromise<T>
+        result<T, R = IResultExt<T>>(query: QueryParam, values?: any, cb?: (value: IResultExt<T>) => R, thisArg?: any): XPromise<R>
 
         // API: http://vitaly-t.github.io/pg-promise/Database.html#multiResult
         multiResult(query: QueryParam, values?: any): XPromise<pg.IResult[]>
@@ -398,7 +418,7 @@ declare namespace pgPromise {
 
         tx<T = any>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
-        tx<T = any>(options: { tag?: any, mode?: TransactionMode | null }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        tx<T = any>(options: { tag?: any, mode?: _txMode.TransactionMode | null }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
         // Conditional Transactions;
         // API: http://vitaly-t.github.io/pg-promise/Database.html#txIf
@@ -406,7 +426,7 @@ declare namespace pgPromise {
 
         txIf<T = any>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
-        txIf<T = any>(options: { tag?: any, mode?: TransactionMode | null, reusable?: boolean | ((t: ITask<Ext> & Ext) => boolean), cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean) }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        txIf<T = any>(options: { tag?: any, mode?: _txMode.TransactionMode | null, reusable?: boolean | ((t: ITask<Ext> & Ext) => boolean), cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean) }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
     }
 
     // Database object in connected state;
@@ -546,23 +566,6 @@ declare namespace pgPromise {
         }
     }
 
-    // Transaction Isolation Level;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.html#.isolationLevel
-    enum isolationLevel {
-        none = 0,
-        serializable = 1,
-        repeatableRead = 2,
-        readCommitted = 3
-    }
-
-    // TransactionMode class;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.TransactionMode.html
-    class TransactionMode {
-        constructor(options?: { tiLevel?: isolationLevel, readOnly?: boolean, deferrable?: boolean })
-
-        begin(cap?: boolean): string
-    }
-
     // Library's Initialization Options
     // API: http://vitaly-t.github.io/pg-promise/module-pg-promise.html
     interface IInitOptions<Ext = {}, C extends pg.IClient = pg.IClient> {
@@ -641,15 +644,8 @@ declare namespace pgPromise {
         value(value: any | (() => any)): string
     }
 
-    // Transaction Mode namespace;
-    // API: http://vitaly-t.github.io/pg-promise/txMode.html
-    interface ITXMode {
-        isolationLevel: typeof isolationLevel
-        TransactionMode: typeof TransactionMode
-    }
-
     interface ITaskArguments<T> extends IArguments {
-        options: { tag?: any, cnd?: any, mode?: TransactionMode | null } & T
+        options: { tag?: any, cnd?: any, mode?: _txMode.TransactionMode | null } & T
 
         cb(): any
     }