postgrejs 2.19.0 → 2.20.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v2.20.0
+[2024-09-14]
+
+### Changes
+
+* chore: Typing improvements ([`adb46c3`](https://github.com/panates/postgrejs/commit/adb46c3ae486e9182aa9a979bed4848c71e69af4))
+* chore: Typing improvements ([`d414463`](https://github.com/panates/postgrejs/commit/d41446345caa940294996b5662683acca12d9578))
+
 # v2.19.0
 [2024-08-20]
 

package/cjs/connection/intl-connection.js

@@ -55,7 +55,7 @@ class IntlConnection extends safe_event_emitter_js_1.SafeEventEmitter {
         if (this.socket.state === constants_js_1.ConnectionState.READY)
             return;
         await new Promise((resolve, reject) => {
-            const handleConnectError = err => reject(err);
+            const handleConnectError = (err) => reject(err);
             this.socket.once('ready', () => {
                 this.socket.removeListener('error', handleConnectError);
                 resolve();
@@ -198,6 +198,7 @@ class IntlConnection extends safe_event_emitter_js_1.SafeEventEmitter {
                     case protocol_js_1.Protocol.BackendMessageCode.DataRow:
                         {
                             let row = msg.columns.map((x) => x.toString('utf8'));
+                            // The null override assumes we can trust PG to always send the RowDescription first
                             (0, parse_row_js_1.parseRow)(parsers, row, opts);
                             if (opts.objectRows && current.fields)
                                 row = (0, convert_row_to_object_js_1.convertRowToObject)(current.fields, row);

package/cjs/connection/portal.js

@@ -91,7 +91,9 @@ class Portal {
                         break;
                     case protocol_js_1.Protocol.BackendMessageCode.DataRow:
                         if (Array.isArray(this._columnFormat)) {
-                            rows.push(msg.columns.map((buf, i) => this._columnFormat[i] === protocol_js_1.Protocol.DataFormat.text ? buf.toString('utf8') : buf));
+                            rows.push(msg.columns.map((buf, i) => this._columnFormat[i] === protocol_js_1.Protocol.DataFormat.text
+                                ? buf.toString('utf8')
+                                : buf));
                         }
                         else if (this._columnFormat === protocol_js_1.Protocol.DataFormat.binary)
                             rows.push(msg.columns);

package/cjs/data-types/bytea-type.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArrayByteaType = exports.ByteaType = void 0;
 const tslib_1 = require("tslib");
+// @ts-ignore -- no type definitions for decodeBytea
 const postgres_bytea_1 = tslib_1.__importDefault(require("postgres-bytea"));
 const constants_js_1 = require("../constants.js");
 exports.ByteaType = {

package/cjs/protocol/frontend.js

@@ -100,13 +100,17 @@ class Frontend {
             io.writeUInt16BE(params.length);
             for (let i = 0; i < params?.length; i++) {
                 let v = params[i];
-                if (v == null) {
+                if (v === null || v === undefined) {
                     io.writeInt32BE(-1);
                     continue;
                 }
                 const dataTypeOid = paramTypes ? paramTypes[i] : undefined;
                 const dt = dataTypeOid ? args.typeMap.get(dataTypeOid) : undefined;
                 if (dt) {
+                    if (typeof dt.encodeAsNull === 'function' && dt.encodeAsNull(v, queryOptions)) {
+                        io.writeInt32BE(-1);
+                        continue;
+                    }
                     if (typeof dt.encodeBinary === 'function') {
                         // Set param format to binary
                         io.buffer.writeInt16BE(protocol_js_1.Protocol.DataFormat.binary, formatOffset + i * 2);

package/cjs/protocol/pg-socket.js

@@ -45,7 +45,7 @@ class PgSocket extends safe_event_emitter_js_1.SafeEventEmitter {
         this._state = constants_js_1.ConnectionState.CONNECTING;
         const options = this.options;
         const socket = (this._socket = new net_1.default.Socket());
-        const errorHandler = err => {
+        const errorHandler = (err) => {
             this._state = constants_js_1.ConnectionState.CLOSED;
             this._removeListeners();
             this._reset();

package/cjs/protocol/sasl.js

@@ -86,7 +86,7 @@ var SASL;
     const hi = function (text, salt, iterations) {
         return crypto_1.default.pbkdf2Sync(text, Buffer.from(salt, 'base64'), iterations, 32, 'sha256');
     };
-    const encode64 = str => Buffer.from(str).toString('base64');
+    const encode64 = (str) => Buffer.from(str).toString('base64');
     const hmac = function (key, msg) {
         return crypto_1.default.createHmac('sha256', key).update(msg).digest();
     };

package/cjs/tsconfig-build-cjs.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../src/constants.ts","../../src/data-type-map.ts","../../src/index.ts","../../src/safe-event-emitter.ts","../../src/types.ts","../../src/connection/bind-param.ts","../../src/connection/connection.ts","../../src/connection/cursor.ts","../../src/connection/intl-connection.ts","../../src/connection/pool.ts","../../src/connection/portal.ts","../../src/connection/prepared-statement.ts","../../src/data-types/bool-type.ts","../../src/data-types/box-type.ts","../../src/data-types/bytea-type.ts","../../src/data-types/char-type.ts","../../src/data-types/circle-type.ts","../../src/data-types/date-type.ts","../../src/data-types/float4-type.ts","../../src/data-types/float8-type.ts","../../src/data-types/int2-type.ts","../../src/data-types/int2-vector-type.ts","../../src/data-types/int4-type.ts","../../src/data-types/int8-type.ts","../../src/data-types/json-type.ts","../../src/data-types/jsonb-type.ts","../../src/data-types/lseg-type.ts","../../src/data-types/numeric-type.ts","../../src/data-types/oid-type.ts","../../src/data-types/point-type.ts","../../src/data-types/time-type.ts","../../src/data-types/timestamp-type.ts","../../src/data-types/timestamptz-type.ts","../../src/data-types/uuid-type.ts","../../src/data-types/varchar-type.ts","../../src/interfaces/command-result.ts","../../src/interfaces/data-mapping-options.ts","../../src/interfaces/data-type.ts","../../src/interfaces/database-connection-params.ts","../../src/interfaces/field-info.ts","../../src/interfaces/query-options.ts","../../src/interfaces/query-result.ts","../../src/interfaces/script-execute-options.ts","../../src/interfaces/script-result.ts","../../src/interfaces/statement-prepare-options.ts","../../src/protocol/backend.ts","../../src/protocol/buffer-reader.ts","../../src/protocol/database-error.ts","../../src/protocol/frontend.ts","../../src/protocol/pg-socket.ts","../../src/protocol/protocol.ts","../../src/protocol/sasl.ts","../../src/protocol/smart-buffer.ts","../../src/util/array-calculatedim.ts","../../src/util/bigint-methods.ts","../../src/util/config-from-env.ts","../../src/util/connection-config.ts","../../src/util/convert-row-to-object.ts","../../src/util/decode-binaryarray.ts","../../src/util/encode-binaryarray.ts","../../src/util/escape-literal.ts","../../src/util/fast-parseint.ts","../../src/util/get-parsers.ts","../../src/util/parse-array.ts","../../src/util/parse-datetime.ts","../../src/util/parse-row.ts","../../src/util/parse-time.ts","../../src/util/stringify-arrayliteral.ts","../../src/util/stringify-for-sql.ts","../../src/util/wrap-row-description.ts"],"version":"5.6.2"}

package/esm/connection/intl-connection.js

@@ -51,7 +51,7 @@ export class IntlConnection extends SafeEventEmitter {
         if (this.socket.state === ConnectionState.READY)
             return;
         await new Promise((resolve, reject) => {
-            const handleConnectError = err => reject(err);
+            const handleConnectError = (err) => reject(err);
             this.socket.once('ready', () => {
                 this.socket.removeListener('error', handleConnectError);
                 resolve();
@@ -194,6 +194,7 @@ export class IntlConnection extends SafeEventEmitter {
                     case Protocol.BackendMessageCode.DataRow:
                         {
                             let row = msg.columns.map((x) => x.toString('utf8'));
+                            // The null override assumes we can trust PG to always send the RowDescription first
                             parseRow(parsers, row, opts);
                             if (opts.objectRows && current.fields)
                                 row = convertRowToObject(current.fields, row);

package/esm/connection/portal.js

@@ -88,7 +88,9 @@ export class Portal {
                         break;
                     case Protocol.BackendMessageCode.DataRow:
                         if (Array.isArray(this._columnFormat)) {
-                            rows.push(msg.columns.map((buf, i) => this._columnFormat[i] === Protocol.DataFormat.text ? buf.toString('utf8') : buf));
+                            rows.push(msg.columns.map((buf, i) => this._columnFormat[i] === Protocol.DataFormat.text
+                                ? buf.toString('utf8')
+                                : buf));
                         }
                         else if (this._columnFormat === Protocol.DataFormat.binary)
                             rows.push(msg.columns);

package/esm/data-types/bytea-type.js

@@ -1,3 +1,4 @@
+// @ts-ignore -- no type definitions for decodeBytea
 import decodeBytea from 'postgres-bytea';
 import { DataTypeOIDs } from '../constants.js';
 export const ByteaType = {

package/esm/protocol/frontend.js

@@ -97,13 +97,17 @@ export class Frontend {
             io.writeUInt16BE(params.length);
             for (let i = 0; i < params?.length; i++) {
                 let v = params[i];
-                if (v == null) {
+                if (v === null || v === undefined) {
                     io.writeInt32BE(-1);
                     continue;
                 }
                 const dataTypeOid = paramTypes ? paramTypes[i] : undefined;
                 const dt = dataTypeOid ? args.typeMap.get(dataTypeOid) : undefined;
                 if (dt) {
+                    if (typeof dt.encodeAsNull === 'function' && dt.encodeAsNull(v, queryOptions)) {
+                        io.writeInt32BE(-1);
+                        continue;
+                    }
                     if (typeof dt.encodeBinary === 'function') {
                         // Set param format to binary
                         io.buffer.writeInt16BE(Protocol.DataFormat.binary, formatOffset + i * 2);

package/esm/protocol/pg-socket.js

@@ -41,7 +41,7 @@ export class PgSocket extends SafeEventEmitter {
         this._state = ConnectionState.CONNECTING;
         const options = this.options;
         const socket = (this._socket = new net.Socket());
-        const errorHandler = err => {
+        const errorHandler = (err) => {
             this._state = ConnectionState.CLOSED;
             this._removeListeners();
             this._reset();

package/esm/protocol/sasl.js

@@ -82,7 +82,7 @@ export var SASL;
     const hi = function (text, salt, iterations) {
         return crypto.pbkdf2Sync(text, Buffer.from(salt, 'base64'), iterations, 32, 'sha256');
     };
-    const encode64 = str => Buffer.from(str).toString('base64');
+    const encode64 = (str) => Buffer.from(str).toString('base64');
     const hmac = function (key, msg) {
         return crypto.createHmac('sha256', key).update(msg).digest();
     };

package/esm/tsconfig-build-esm.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../src/constants.ts","../../src/data-type-map.ts","../../src/index.ts","../../src/safe-event-emitter.ts","../../src/types.ts","../../src/connection/bind-param.ts","../../src/connection/connection.ts","../../src/connection/cursor.ts","../../src/connection/intl-connection.ts","../../src/connection/pool.ts","../../src/connection/portal.ts","../../src/connection/prepared-statement.ts","../../src/data-types/bool-type.ts","../../src/data-types/box-type.ts","../../src/data-types/bytea-type.ts","../../src/data-types/char-type.ts","../../src/data-types/circle-type.ts","../../src/data-types/date-type.ts","../../src/data-types/float4-type.ts","../../src/data-types/float8-type.ts","../../src/data-types/int2-type.ts","../../src/data-types/int2-vector-type.ts","../../src/data-types/int4-type.ts","../../src/data-types/int8-type.ts","../../src/data-types/json-type.ts","../../src/data-types/jsonb-type.ts","../../src/data-types/lseg-type.ts","../../src/data-types/numeric-type.ts","../../src/data-types/oid-type.ts","../../src/data-types/point-type.ts","../../src/data-types/time-type.ts","../../src/data-types/timestamp-type.ts","../../src/data-types/timestamptz-type.ts","../../src/data-types/uuid-type.ts","../../src/data-types/varchar-type.ts","../../src/interfaces/command-result.ts","../../src/interfaces/data-mapping-options.ts","../../src/interfaces/data-type.ts","../../src/interfaces/database-connection-params.ts","../../src/interfaces/field-info.ts","../../src/interfaces/query-options.ts","../../src/interfaces/query-result.ts","../../src/interfaces/script-execute-options.ts","../../src/interfaces/script-result.ts","../../src/interfaces/statement-prepare-options.ts","../../src/protocol/backend.ts","../../src/protocol/buffer-reader.ts","../../src/protocol/database-error.ts","../../src/protocol/frontend.ts","../../src/protocol/pg-socket.ts","../../src/protocol/protocol.ts","../../src/protocol/sasl.ts","../../src/protocol/smart-buffer.ts","../../src/util/array-calculatedim.ts","../../src/util/bigint-methods.ts","../../src/util/config-from-env.ts","../../src/util/connection-config.ts","../../src/util/convert-row-to-object.ts","../../src/util/decode-binaryarray.ts","../../src/util/encode-binaryarray.ts","../../src/util/escape-literal.ts","../../src/util/fast-parseint.ts","../../src/util/get-parsers.ts","../../src/util/parse-array.ts","../../src/util/parse-datetime.ts","../../src/util/parse-row.ts","../../src/util/parse-time.ts","../../src/util/stringify-arrayliteral.ts","../../src/util/stringify-for-sql.ts","../../src/util/wrap-row-description.ts"],"version":"5.6.2"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "postgrejs",
   "description": "Professional PostgreSQL client NodeJS",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {
@@ -12,7 +12,7 @@
     "putil-merge": "^3.13.0",
     "putil-promisify": "^1.10.1",
     "putil-varhelpers": "^1.6.5",
-    "tslib": "^2.6.3"
+    "tslib": "^2.7.0"
   },
   "type": "module",
   "exports": {

package/types/connection/intl-connection.d.ts

@@ -1,12 +1,12 @@
 import { TaskQueue } from 'power-tasks';
 import { ConnectionState } from '../constants.js';
-import { ConnectionConfiguration } from '../interfaces/database-connection-params.js';
-import { ScriptExecuteOptions } from '../interfaces/script-execute-options.js';
-import { ScriptResult } from '../interfaces/script-result.js';
+import type { ConnectionConfiguration } from '../interfaces/database-connection-params.js';
+import type { ScriptExecuteOptions } from '../interfaces/script-execute-options.js';
+import type { ScriptResult } from '../interfaces/script-result.js';
 import { PgSocket } from '../protocol/pg-socket.js';
 import { SafeEventEmitter } from '../safe-event-emitter.js';
-import { Maybe } from '../types.js';
-import { Connection } from './connection.js';
+import type { Maybe } from '../types.js';
+import type { Connection } from './connection.js';
 export declare class IntlConnection extends SafeEventEmitter {
     protected _refCount: number;
     protected _config: ConnectionConfiguration;

package/types/constants.d.ts

@@ -125,6 +125,4 @@ export declare const DataTypeOIDs: {
     _uuid: number;
     _jsonb: number;
 };
-export declare const DataTypeNames: {
-    [x: number]: string;
-};
+export declare const DataTypeNames: Record<string, string>;

package/types/interfaces/data-type.d.ts

@@ -1,4 +1,4 @@
-import type { DecodeBinaryFunction, EncodeBinaryFunction, EncodeTextFunction, OID, ParseTextFunction } from '../types.js';
+import type { DecodeBinaryFunction, EncodeAsNullFunction, EncodeBinaryFunction, EncodeTextFunction, OID, ParseTextFunction } from '../types.js';
 import { EncodeCalculateDimFunction } from '../types.js';
 export interface DataType {
     oid: OID;
@@ -10,6 +10,7 @@ export interface DataType {
     isType: (v: any) => boolean;
     parseBinary: DecodeBinaryFunction;
     parseText: ParseTextFunction;
+    encodeAsNull?: EncodeAsNullFunction;
     encodeBinary?: EncodeBinaryFunction;
     encodeText?: EncodeTextFunction;
     encodeCalculateDim?: EncodeCalculateDimFunction;

package/types/types.d.ts

@@ -8,6 +8,7 @@ export type Callback = (err?: Error, value?: any) => void;
 export type DecodeBinaryFunction = (buf: Buffer, options: DataMappingOptions & Record<string, any>) => any;
 export type EncodeBinaryFunction = (buf: SmartBuffer, v: any, options: DataMappingOptions) => void;
 export type EncodeCalculateDimFunction = (v: any[]) => number[];
+export type EncodeAsNullFunction = (v: any, options: DataMappingOptions) => boolean;
 export type ParseTextFunction = (v: any, options: DataMappingOptions) => any;
 export type EncodeTextFunction = (v: any, options: DataMappingOptions) => string;
 export type AnyParseFunction = ParseTextFunction | DecodeBinaryFunction;