@m2k-5f/pgtx 2.1.0 → 2.3.0

package/dist/protocol/socket-authorization.js

@@ -1,85 +1,86 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAuthorizedSocket = void 0;
-const node_net_1 = require("node:net");
-const sasl_1 = require("../security/sasl");
-const socket_connector_1 = require("./socket-connector");
-const constants_1 = require("./constants");
-const md5_1 = require("../security/md5");
-const createAuthorizedSocket = (writer, params) => {
-    return new Promise((resolve, reject) => {
-        const nonce = (0, sasl_1.generateNonce)();
+import { createConnection } from "node:net";
+import { calculateScramAuth, generateNonce } from "../security/sasl";
+import { SocketConnector } from "./socket-connector";
+import { AuthenticationCodes, ResponseTypes } from "./constants";
+import { encryptMd5 } from "../security/md5";
+import { PostgresError } from "../error";
+import { Future } from "fluent-future";
+export const ErrNonceMismatch = new PostgresError("Protocol violation: server nonce doesn't match client nonce");
+export const ErrPasswordRequired = new PostgresError('The authorization method requires a password.');
+export const createAuthorizedSocket = (writer, params) => {
+    return Future.of(new Promise((resolve, reject) => {
+        const nonce = generateNonce();
         let clientMessage = '';
         let serverMessage = '';
-        const socket = (0, node_net_1.createConnection)({ host: params.host, port: params.port });
-        const connector = new socket_connector_1.SocketConnector(socket, (type, reader) => {
+        const socket = createConnection({ host: params.host, port: params.port });
+        const connector = new SocketConnector(socket, (type, reader) => {
             writer.clear();
             switch (type) {
-                case constants_1.ResponseTypes.Authentication: {
+                case ResponseTypes.Authentication: {
                     switch (reader.readAuthentication()) {
-                        case constants_1.AuthenticationCodes.Ok: break;
-                        case constants_1.AuthenticationCodes.CleartextPassword: {
+                        case AuthenticationCodes.Ok: break;
+                        case AuthenticationCodes.CleartextPassword: {
                             if (!params.password)
-                                throw new Error('The authorization method requires a password.');
+                                throw ErrPasswordRequired;
                             connector.write(writer.writePassword(params.password));
                             break;
                         }
-                        case constants_1.AuthenticationCodes.MD5Password: {
+                        case AuthenticationCodes.MD5Password: {
                             const salt = reader.readMD5Salt();
                             if (!params.password)
-                                throw new Error('The authorization method requires a password.');
-                            const password = (0, md5_1.encryptMd5)(params.password, params.user, salt);
+                                throw ErrPasswordRequired;
+                            const password = encryptMd5(params.password, params.user, salt);
                             connector.write(writer.writePassword(password));
                             break;
                         }
-                        case constants_1.AuthenticationCodes.SASL: {
+                        case AuthenticationCodes.SASL: {
                             reader.readSaslMechanisms();
                             if (!params.password)
-                                throw new Error('The authorization method requires a password.');
+                                throw ErrPasswordRequired;
                             clientMessage = `n=${params.user},r=${nonce}`;
                             connector.write(writer.writeSaslInitial('SCRAM-SHA-256', `n,,${clientMessage}`));
                             break;
                         }
-                        case constants_1.AuthenticationCodes.SASLContinue: {
+                        case AuthenticationCodes.SASLContinue: {
                             serverMessage = reader.readSaslMessage();
                             if (!params.password)
-                                throw new Error('The authorization method requires a password.');
+                                throw ErrPasswordRequired;
                             const parts = Object.fromEntries(serverMessage.split(',').map(x => x.split('=')));
                             const serverNonce = parts.r;
                             const saltBase64 = parts.s;
                             const iterations = parseInt(parts.i, 10);
                             if (!serverNonce.startsWith(nonce)) {
                                 connector.destroy();
-                                return reject("Protocol violation: server nonce doesn't match client nonce");
+                                return reject(ErrNonceMismatch);
                             }
                             const clientFinalMessageWithoutProof = `c=biws,r=${serverNonce}`;
                             const authMessage = `${clientMessage},${serverMessage},${clientFinalMessageWithoutProof}`;
-                            const { clientProof } = (0, sasl_1.calculateScramAuth)(params.password, saltBase64, iterations, authMessage);
+                            const { clientProof } = calculateScramAuth(params.password, saltBase64, iterations, authMessage);
                             const clientFinalMessage = `${clientFinalMessageWithoutProof},p=${clientProof}`;
                             connector.write(writer.writeSaslResponse(clientFinalMessage));
                             break;
                         }
-                        case constants_1.AuthenticationCodes.SASLFinal: {
+                        case AuthenticationCodes.SASLFinal: {
                             reader.readSaslMessage();
                             break;
                         }
                     }
                     break;
                 }
-                case constants_1.ResponseTypes.ParamaterStatus: {
+                case ResponseTypes.ParamaterStatus: {
                     reader.readParameterStatus();
                     break;
                 }
-                case constants_1.ResponseTypes.ErrorResponse: {
-                    const message = reader.readErrorResponse();
+                case ResponseTypes.ErrorResponse: {
+                    const error = reader.readErrorResponse();
                     connector.destroy();
-                    reject(message);
+                    reject(error);
                     return;
                 }
-                case constants_1.ResponseTypes.BackendKeyData: {
+                case ResponseTypes.BackendKeyData: {
                     reader.readBackendKeyData();
                 }
-                case constants_1.ResponseTypes.ReadyForQuery: {
+                case ResponseTypes.ReadyForQuery: {
                     reader.readReadyForQuery();
                     resolve(connector.unwrapSocket());
                     return;
@@ -90,6 +91,9 @@ const createAuthorizedSocket = (writer, params) => {
         });
         connector.write(writer.writeStartup(params.user, params.database));
         writer.clear();
+    }), error => {
+        if (error instanceof PostgresError)
+            return error;
+        return new PostgresError(error.message);
     });
 };
-exports.createAuthorizedSocket = createAuthorizedSocket;

package/dist/protocol/socket-connector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"socket-connector.d.ts","sourceRoot":"","sources":["../../src/protocol/socket-connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA;AAE/E,qBAAa,eAAe;IAKpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,QAAQ;IANpB,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,YAAY,CAAQ;gBAGhB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,EACvE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IA4B5C,KAAK,CAAC,MAAM,EAAE,uBAAuB;IAOrC,YAAY;IAQZ,OAAO;IAMP,IAAI,WAAW,YAA6B;CAC/C"}
+{"version":3,"file":"socket-connector.d.ts","sourceRoot":"","sources":["../../src/protocol/socket-connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA;AAE/E,qBAAa,eAAe;IAKpB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,QAAQ;IANpB,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,YAAY,CAAQ;gBAGhB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,EACvE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IA6B5C,KAAK,CAAC,MAAM,EAAE,uBAAuB;IAOrC,YAAY;IAQZ,OAAO;IAMP,IAAI,WAAW,YAA6B;CAC/C"}

package/dist/protocol/socket-connector.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketConnector = void 0;
-const connection_response_reader_1 = require("../protocol/connection-response-reader");
-class SocketConnector {
+import { ConnectionResponseReader } from '../protocol/connection-response-reader';
+export class SocketConnector {
     constructor(_socket, _onData, _onError) {
         this._socket = _socket;
         this._onData = _onData;
         this._onError = _onError;
         this.residualBuffer = null;
         this._isDestroyed = false;
+        _socket.setKeepAlive(true, 10000);
         _socket.on('data', buffer => {
             const currentBuffer = this.residualBuffer
                 ? Buffer.concat([this.residualBuffer, buffer])
                 : buffer;
             this.residualBuffer = null;
-            const reader = connection_response_reader_1.ConnectionResponseReader.from(currentBuffer);
+            const reader = ConnectionResponseReader.from(currentBuffer);
             while (reader.hasMore()) {
                 if (!reader.hasFullPacket()) {
                     this.residualBuffer = reader.getResidualBuffer();
@@ -45,4 +43,3 @@ class SocketConnector {
     }
     get isDestroyed() { return this._isDestroyed; }
 }
-exports.SocketConnector = SocketConnector;

package/dist/query.js

@@ -1,14 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Query = exports.QueryState = void 0;
-exports.QueryState = {
+export const QueryState = {
     Parsing: 0,
     Describing: 1,
     Executing: 2,
     Completed: 3,
     Failed: 4
 };
-class Query {
+export class Query {
     constructor(text, args, state, statementName, columns) {
         this.text = text;
         this.args = args;
@@ -25,4 +22,3 @@ class Query {
         this.state = state;
     }
 }
-exports.Query = Query;

package/dist/queue.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Queue = void 0;
-class Queue {
+export class Queue {
     constructor() {
         this._queue = new Array();
         this._pointer = 0;
@@ -36,4 +33,3 @@ class Queue {
     }
     get isFree() { return this._pointer >= this._queue.length; }
 }
-exports.Queue = Queue;

package/dist/security/md5.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encryptMd5 = void 0;
-const crypto_1 = require("crypto");
-const encryptMd5 = (password, user, salt) => {
-    const stage1 = (0, crypto_1.createHash)('md5').update(password + user).digest('hex');
-    const stage2 = (0, crypto_1.createHash)('md5')
+import { createHash } from "crypto";
+export const encryptMd5 = (password, user, salt) => {
+    const stage1 = createHash('md5').update(password + user).digest('hex');
+    const stage2 = createHash('md5')
         .update(Buffer.concat([Buffer.from(stage1), salt]))
         .digest('hex');
     return 'md5' + stage2;
 };
-exports.encryptMd5 = encryptMd5;

package/dist/security/sasl.js

@@ -1,22 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateNonce = generateNonce;
-exports.calculateScramAuth = calculateScramAuth;
-const crypto_1 = require("crypto");
-function generateNonce() {
-    return (0, crypto_1.randomBytes)(18).toString('base64').replace(/[^a-zA-Z0-9]/g, '').substring(0, 24);
+import { randomBytes, createHmac, pbkdf2Sync, createHash } from 'crypto';
+export function generateNonce() {
+    return randomBytes(18).toString('base64').replace(/[^a-zA-Z0-9]/g, '').substring(0, 24);
 }
 function hmac(key, data) {
-    return (0, crypto_1.createHmac)('sha256', key).update(data).digest();
+    return createHmac('sha256', key).update(data).digest();
 }
 function hi(password, salt, iterations) {
-    return (0, crypto_1.pbkdf2Sync)(password, salt, iterations, 32, 'sha256');
+    return pbkdf2Sync(password, salt, iterations, 32, 'sha256');
 }
-function calculateScramAuth(password, saltBase64, iterations, authMessage) {
+export function calculateScramAuth(password, saltBase64, iterations, authMessage) {
     const salt = Buffer.from(saltBase64, 'base64');
     const saltedPassword = hi(password, salt, iterations);
     const clientKey = hmac(saltedPassword, 'Client Key');
-    const storedKey = (0, crypto_1.createHash)('sha256').update(clientKey).digest();
+    const storedKey = createHash('sha256').update(clientKey).digest();
     const clientSignature = hmac(storedKey, authMessage);
     const clientProofBuf = Buffer.alloc(32);
     for (let i = 0; i < 32; i++) {

package/dist/transaction.d.ts

@@ -1,4 +1,6 @@
+import { Future } from "fluent-future";
 import { Connection } from "./connection";
+import { PostgresError } from "./error";
 /**
  * Represents an active SQL transaction.
  * All queries are executed on a single dedicated connection.
@@ -15,15 +17,15 @@ export declare class Transaction {
     /**
      * Commits the current transaction.
      */
-    commit(): Promise<void>;
+    commit(): Future<[], PostgresError>;
     /**
      * Rolls back the current transaction.
      */
-    rollback(): Promise<void>;
+    rollback(): Future<[], PostgresError>;
     /**
      * Executes a query within the current transaction.
      */
-    query<T extends Record<string, any>>(strings: TemplateStringsArray, ...values: any[]): Promise<T[]>;
+    query<T extends Record<string, any>>(strings: TemplateStringsArray, ...values: any[]): Future<T[], PostgresError>;
     /**
      * Creates a sub-transaction using PostgreSQL SAVEPOINT.
      * If the callback throws, only the actions within this savepoint are rolled back.
@@ -31,9 +33,9 @@ export declare class Transaction {
      * @example
      * await tx.savepoint('my_point', async (stx) => {
      *   await stx.query`INSERT ...`;
-     *   if (error) throw new Error(); // Only this insert rolls back
+     *   if (error) throw new Error() // Only this insert rolls back
      * });
      */
-    savepoint(name: string, callback: (tx: Transaction) => Promise<void>): Promise<Error | null>;
+    savepoint<T>(name: string, callback: (tx: Transaction) => Promise<T>): Future<T, Error>;
 }
 //# sourceMappingURL=transaction.d.ts.map

package/dist/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;GAGG;AACH,qBAAa,WAAW;IAIhB,QAAQ,CAAC,IAAI,EAAE,UAAU;IAH7B,OAAO,CAAC,UAAU,CAAiB;gBAGtB,IAAI,EAAE,UAAU;IAG7B;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAOpC;;OAEG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtC;;OAEG;IACU,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAKhH;;;;;;;;;OASG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;CAe5G"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,MAAM,EAAE,MAAM,eAAe,CAAA;AAE7C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC;;;GAGG;AACH,qBAAa,WAAW;IAIhB,QAAQ,CAAC,IAAI,EAAE,UAAU;IAH7B,OAAO,CAAC,UAAU,CAAiB;gBAGtB,IAAI,EAAE,UAAU;IAG7B;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACI,MAAM,IAIiC,MAAM,CAAC,EAAE,EAAE,aAAa,CAAC;IAGvE;;OAEG;IACI,QAAQ,IAI+B,MAAM,CAAC,EAAE,EAAE,aAAa,CAAC;IAGvE;;OAEG;IACI,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAK3F;;;;;;;;;OASG;IACI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC;CAWjG"}

package/dist/transaction.js

@@ -1,12 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transaction = void 0;
-const clauses_1 = require("./clauses");
+import { Begin, Future } from "fluent-future";
+import { IdentifierClause } from "./clauses";
 /**
  * Represents an active SQL transaction.
  * All queries are executed on a single dedicated connection.
  */
-class Transaction {
+export class Transaction {
     constructor(conn) {
         this.conn = conn;
         this.isFinished = false;
@@ -25,25 +23,25 @@ class Transaction {
     /**
      * Commits the current transaction.
      */
-    async commit() {
+    commit() {
         this.checkActive();
-        await this.conn.query `COMMIT`;
-        this.isFinished = true;
+        return this.conn.query `COMMIT`
+            .tap(() => this.isFinished = true);
     }
     /**
      * Rolls back the current transaction.
      */
-    async rollback() {
+    rollback() {
         this.checkActive();
-        await this.conn.query `ROLLBACK`;
-        this.isFinished = true;
+        return this.conn.query `ROLLBACK`
+            .tap(() => this.isFinished = true);
     }
     /**
      * Executes a query within the current transaction.
      */
-    async query(strings, ...values) {
+    query(strings, ...values) {
         this.checkActive();
-        return await this.conn.query(strings, ...values);
+        return this.conn.query(strings, ...values);
     }
     /**
      * Creates a sub-transaction using PostgreSQL SAVEPOINT.
@@ -52,21 +50,15 @@ class Transaction {
      * @example
      * await tx.savepoint('my_point', async (stx) => {
      *   await stx.query`INSERT ...`;
-     *   if (error) throw new Error(); // Only this insert rolls back
+     *   if (error) throw new Error() // Only this insert rolls back
      * });
      */
-    async savepoint(name, callback) {
+    savepoint(name, callback) {
         this.checkActive();
-        await this.conn.query `SAVEPOINT ${clauses_1.IdentifierClause.create(name)}`;
-        try {
-            await callback(this);
-            await this.conn.query `RELEASE SAVEPOINT ${clauses_1.IdentifierClause.create(name)}`;
-            return null;
-        }
-        catch (err) {
-            await this.conn.query `ROLLBACK TO SAVEPOINT ${clauses_1.IdentifierClause.create(name)}`;
-            return err instanceof Error ? err : new Error(String(err));
-        }
+        return Begin()
+            .andThen(() => this.conn.query `SAVEPOINT ${IdentifierClause.create(name)}`)
+            .andThen(() => Future.of(callback(this))
+            .tap(() => this.conn.query `RELEASE SAVEPOINT ${IdentifierClause.create(name)}`)
+            .tapErr(() => this.conn.query `ROLLBACK TO SAVEPOINT ${IdentifierClause.create(name)}`));
     }
 }
-exports.Transaction = Transaction;

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/template-compiler.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileSqlTemplate = compileSqlTemplate;
-const abstract_clause_1 = require("../clauses/abstract.clause");
-function compileSqlTemplate(params, argOffset = 0) {
+import { Clause } from "../clauses/abstract.clause";
+export function compileSqlTemplate(params, argOffset = 0) {
     const templateLength = params.templates.length;
     const query = {
         text: [],
@@ -13,7 +10,7 @@ function compileSqlTemplate(params, argOffset = 0) {
         if (index === templateLength - 1)
             return;
         const value = params.args[index];
-        if (value instanceof abstract_clause_1.Clause) {
+        if (value instanceof Clause) {
             value.mapIntoQuery(query);
         }
         else {

package/dist/utils/value-parser.js

@@ -1,7 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setTypeParser = void 0;
-exports.parseRowValues = parseRowValues;
 const parsePostgresArray = (v) => {
     if (v === '{}')
         return [];
@@ -70,7 +66,7 @@ const Parsers = {
     3807: (v) => parsePostgresArray(v).map(el => JSON.parse(el)), // jsonb[]
 };
 const defaultParser = (v) => v;
-function parseRowValues(columns, rows) {
+export function parseRowValues(columns, rows) {
     const result = [];
     const columnsLength = columns.length;
     const columnParsers = columns.map(col => Parsers[col.typeOID] || defaultParser);
@@ -95,7 +91,6 @@ function parseRowValues(columns, rows) {
     }
     return result;
 }
-const setTypeParser = (typeOID, parser) => {
+export const setTypeParser = (typeOID, parser) => {
     Parsers[typeOID] = parser;
 };
-exports.setTypeParser = setTypeParser;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m2k-5f/pgtx",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Blazing-fast PostgreSQL driver with pipeline support.",
   "files": [
     "dist",
@@ -9,7 +9,7 @@
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build",
-    "testGitHub": "node --import tsx --test $(find tests -name '*.test.ts')",
+    "testGitHub": "node --import tsx --test 0 $(find tests -name '*.test.ts')",
     "test": "node --import tsx --test ./tests/*.test.ts"
   },
   "repository": {
@@ -44,5 +44,8 @@
     "pg": "^8.22.0",
     "tsx": "^4.21.0",
     "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "fluent-future": "^1.3.2"
   }
 }