pg-promise 11.6.0 → 11.7.1

package/lib/helpers/index.js

@@ -9,7 +9,7 @@
 
 const {Column} = require('./column');
 const {ColumnSet} = require('./column-set');
-const {TableName} = require('./table-name');
+const {TableName, _TN} = require('./table-name');
 const method = require('./methods');
 
 /**
@@ -24,6 +24,9 @@ const method = require('./methods');
  * @property {function} TableName
  * {@link helpers.TableName TableName} class constructor.
  *
+ * @property {function} _TN
+ * {@link helpers._TN _TN} Table-Name conversion function.
+ *
  * @property {function} ColumnSet
  * {@link helpers.ColumnSet ColumnSet} class constructor.
  *
@@ -64,6 +67,7 @@ module.exports = config => {
             return method.sets(data, columns, capSQL());
         },
         TableName,
+        _TN,
         ColumnSet,
         Column
     };

package/lib/helpers/table-name.js

@@ -46,6 +46,7 @@ const npm = {
  * @returns {helpers.TableName}
  *
  * @see
+ * {@link helpers._TN _TN},
  * {@link helpers.TableName#toPostgres toPostgres}
  *
  * @example
@@ -125,4 +126,36 @@ npm.utils.addInspection(TableName, function () {
     return this.toString();
 });
 
-module.exports = {TableName};
+/**
+ *
+ * @interface Table
+ * @description
+ * Structure for any table name/path.
+ *
+ * @property {string} [schema] - schema name, if specified
+ * @property {string} table - table name
+ */
+
+/**
+ * @function helpers._TN
+ * @description
+ * Table-Name helper function, to convert any `"schema.table"` string
+ * into `{schema, table}` object.
+ *
+ * @example
+ * const {ColumnSet, _TN} = pgp.helpers;
+ *
+ * // Using as a regular function:
+ * const cs1 = new ColumnSet(['id', 'name'], {table: _TN('schema.table')});
+ *
+ * // Using as a template-tag function:
+ * const cs2 = new ColumnSet(['id', 'name'], {table: _TN`schema.table`});
+ *
+ * @returns {Table}
+ */
+function _TN(s) {
+    const [schema, table] = (s.raw ? s[0] : s).split('.');
+    return table === undefined ? {table: schema} : {schema, table};
+}
+
+module.exports = {TableName, _TN};

package/lib/main.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "11.6.0",
+  "version": "11.7.1",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -43,21 +43,23 @@
   "dependencies": {
     "assert-options": "0.8.1",
     "pg": "8.11.5",
-    "pg-minify": "1.6.3",
+    "pg-minify": "1.6.4",
     "spex": "3.3.0"
   },
   "devDependencies": {
-    "@types/node": "20.12.5",
+    "@eslint/js": "9.3.0",
+    "@types/node": "20.12.12",
     "bluebird": "3.7.2",
     "coveralls": "3.1.1",
-    "cspell": "8.6.1",
-    "eslint": "8.57.0",
+    "cspell": "8.8.3",
+    "eslint": "9.3.0",
+    "globals": "15.3.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
-    "jsdoc": "4.0.2",
+    "jsdoc": "4.0.3",
     "JSONStream": "1.3.5",
     "pg-query-stream": "4.5.5",
     "tslint": "6.1.3",
-    "typescript": "5.4.4"
+    "typescript": "5.4.5"
   }
 }

package/typescript/pg-promise.d.ts

@@ -130,8 +130,8 @@ declare namespace pgPromise {
     }
 
     interface ITable {
-        table: string
         schema?: string
+        table: string
     }
 
     interface IPromiseConfig {
@@ -207,7 +207,11 @@ declare namespace pgPromise {
 
         assign(source?: { source?: object, prefix?: string }): string
 
-        assignColumns(options?: { from?: string, to?: string, skip?: string | string[] | ((c: Column<T>) => boolean) }): string
+        assignColumns(options?: {
+            from?: string,
+            to?: string,
+            skip?: string | string[] | ((c: Column<T>) => boolean)
+        }): string
 
         extend<S>(columns: Column<T> | ColumnSet<T> | Array<string | IColumnConfig<T> | Column<T>>): ColumnSet<S>
 
@@ -382,7 +386,10 @@ declare namespace pgPromise {
         multi<T = any>(query: QueryParam, values?: any): XPromise<Array<T[]>>
 
         // API: https://vitaly-t.github.io/pg-promise/Database.html#stream
-        stream(qs: NodeJS.ReadableStream, init: (stream: NodeJS.ReadableStream) => void): XPromise<{ processed: number, duration: number }>
+        stream(qs: NodeJS.ReadableStream, init: (stream: NodeJS.ReadableStream) => void): XPromise<{
+            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>
@@ -410,7 +417,10 @@ declare namespace pgPromise {
 
         taskIf<T = any>(tag: string | number, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
-        taskIf<T = any>(options: { tag?: any, cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean) }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
+        taskIf<T = any>(options: {
+            tag?: any,
+            cnd?: boolean | ((t: ITask<Ext> & Ext) => boolean)
+        }, cb: (t: ITask<Ext> & Ext) => T | XPromise<T>): XPromise<T>
 
         // Transactions;
         // API: https://vitaly-t.github.io/pg-promise/Database.html#tx
@@ -418,7 +428,10 @@ 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?: _txMode.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: https://vitaly-t.github.io/pg-promise/Database.html#txIf
@@ -426,7 +439,12 @@ 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?: _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>
+        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;
@@ -656,7 +674,10 @@ declare namespace pgPromise {
 
         camelizeVar(text: string): string
 
-        enumSql(dir: string, options?: { recursive?: boolean, ignoreErrors?: boolean }, cb?: (file: string, name: string, path: string) => any): any
+        enumSql(dir: string, options?: {
+            recursive?: boolean,
+            ignoreErrors?: boolean
+        }, cb?: (file: string, name: string, path: string) => any): any
 
         taskArgs<T = {}>(args: IArguments): ITaskArguments<T>
     }
@@ -665,11 +686,19 @@ declare namespace pgPromise {
     // API: https://vitaly-t.github.io/pg-promise/helpers.html
     interface IHelpers {
 
-        concat(queries: Array<string | QueryFile | { query: string | QueryFile, values?: any, options?: IFormattingOptions }>): string
+        concat(queries: Array<string | QueryFile | {
+            query: string | QueryFile,
+            values?: any,
+            options?: IFormattingOptions
+        }>): string
 
         insert(data: object | object[], columns?: QueryColumns<any> | null, table?: string | ITable | TableName): string
 
-        update(data: object | object[], columns?: QueryColumns<any> | null, table?: string | ITable | TableName, options?: { tableAlias?: string, valueAlias?: string, emptyUpdate?: any }): any
+        update(data: object | object[], columns?: QueryColumns<any> | null, table?: string | ITable | TableName, options?: {
+            tableAlias?: string,
+            valueAlias?: string,
+            emptyUpdate?: any
+        }): any
 
         values(data: object | object[], columns?: QueryColumns<any> | null): string
 
@@ -678,6 +707,8 @@ declare namespace pgPromise {
         Column: typeof Column
         ColumnSet: typeof ColumnSet
         TableName: typeof TableName
+
+        _TN: (data: TemplateStringsArray | string) => ITable
     }
 
     interface IGenericPromise {