postgrejs 2.22.9 → 2.23.0

package/cjs/protocol/backend.js

@@ -1,262 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Backend = void 0;
-const buffer_reader_js_1 = require("./buffer-reader.js");
-const protocol_js_1 = require("./protocol.js");
-// 1 byte message type, 4 byte frame length
-const HEADER_LENGTH = 5;
-const ErrorFieldTypes = {
-    M: 'message',
-    S: 'severity',
-    V: 'severity',
-    C: 'code',
-    D: 'detail',
-    H: 'hint',
-    P: 'position',
-    p: 'internalPosition',
-    q: 'internalQuery',
-    W: 'where',
-    s: 'schema',
-    t: 'table',
-    c: 'column',
-    d: 'dataType',
-    n: 'constraint',
-    F: 'file',
-    L: 'line',
-    R: 'routine',
-};
-class Backend {
-    reset() {
-        this._buf = undefined;
-    }
-    parse(data, callback) {
-        if (this._buf) {
-            data = Buffer.concat([this._buf, data]);
-            this._buf = undefined;
-        }
-        const io = new buffer_reader_js_1.BufferReader(data);
-        let offsetBookmark;
-        while (io.length - io.offset >= HEADER_LENGTH) {
-            offsetBookmark = io.offset;
-            const code = io.readUInt8();
-            const len = io.readUInt32BE();
-            // Check if frame data not received yet
-            if (io.length - io.offset < len - 4) {
-                io.offset = offsetBookmark;
-                this._buf = io.readBuffer();
-                return;
-            }
-            const parser = MessageParsers[code];
-            const v = parser && parser(io, code, len);
-            callback(code, v);
-            // Set offset to next message
-            io.offset = offsetBookmark + len + 1;
-        }
-        if (io.offset < io.length)
-            this._buf = io.readBuffer(io.length - io.offset);
-    }
-}
-exports.Backend = Backend;
-const MessageParsers = {
-    [protocol_js_1.Protocol.BackendMessageCode.Authentication]: parseAuthentication,
-    [protocol_js_1.Protocol.BackendMessageCode.BackendKeyData]: parseBackendKeyData,
-    [protocol_js_1.Protocol.BackendMessageCode.CommandComplete]: parseCommandComplete,
-    [protocol_js_1.Protocol.BackendMessageCode.CopyData]: parseCopyData,
-    [protocol_js_1.Protocol.BackendMessageCode.CopyInResponse]: parseCopyResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.CopyOutResponse]: parseCopyResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.CopyBothResponse]: parseCopyResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.DataRow]: parseDataRow,
-    [protocol_js_1.Protocol.BackendMessageCode.ErrorResponse]: parseErrorResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.NoticeResponse]: parseErrorResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.NotificationResponse]: parseNotificationResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.FunctionCallResponse]: parseFunctionCallResponse,
-    [protocol_js_1.Protocol.BackendMessageCode.NegotiateProtocolVersion]: parseNegotiateProtocolVersion,
-    [protocol_js_1.Protocol.BackendMessageCode.ParameterDescription]: parseParameterDescription,
-    [protocol_js_1.Protocol.BackendMessageCode.ParameterStatus]: parseParameterStatus,
-    [protocol_js_1.Protocol.BackendMessageCode.ReadyForQuery]: parseReadyForQuery,
-    [protocol_js_1.Protocol.BackendMessageCode.RowDescription]: parseRowDescription,
-};
-function parseAuthentication(io, code, len) {
-    const kind = io.readUInt32BE();
-    switch (kind) {
-        case 0:
-            return; // AuthenticationOk
-        case 2:
-            return {
-                kind: 'KerberosV5',
-            };
-        case 3:
-            return {
-                kind: 'CleartextPassword',
-            };
-        case 5:
-            return {
-                kind: 'MD5Password',
-                salt: io.readBuffer(len - 8),
-            };
-        case 6:
-            return {
-                kind: 'SCMCredential',
-            };
-        case 7:
-            return {
-                kind: 'GSS',
-            };
-        case 9:
-            return {
-                kind: 'SSPI',
-            };
-        case 8:
-            return {
-                kind: 'GSSContinue',
-                data: io.readBuffer(len - 8),
-            };
-        case 10: {
-            const out = {
-                kind: 'SASL',
-                mechanisms: [],
-            };
-            let mechanism;
-            while ((mechanism = io.readCString())) {
-                out.mechanisms.push(mechanism);
-            }
-            return out;
-        }
-        case 11:
-            return {
-                kind: 'SASLContinue',
-                data: io.readLString(len - 8, 'utf8'),
-            };
-        case 12:
-            return {
-                kind: 'SASLFinal',
-                data: io.readLString(len - 8, 'utf8'),
-            };
-        default:
-            throw new Error(`Unknown authentication kind (${kind})`);
-    }
-}
-function parseBackendKeyData(io) {
-    return {
-        processID: io.readUInt32BE(),
-        secretKey: io.readUInt32BE(),
-    };
-}
-function parseCommandComplete(io) {
-    return {
-        command: io.readCString('utf8'),
-    };
-}
-function parseCopyData(io, code, len) {
-    return {
-        data: io.readBuffer(len - 4),
-    };
-}
-function parseCopyResponse(io) {
-    const out = {
-        overallFormat: io.readUInt8() === 0
-            ? protocol_js_1.Protocol.DataFormat.text
-            : protocol_js_1.Protocol.DataFormat.binary,
-        columnCount: io.readUInt16BE(),
-    };
-    if (out.columnCount) {
-        out.columnFormats = [];
-        for (let i = 0; i < out.columnCount; i++) {
-            out.columnFormats.push(io.readUInt16BE() === 0
-                ? protocol_js_1.Protocol.DataFormat.text
-                : protocol_js_1.Protocol.DataFormat.binary);
-        }
-    }
-    return out;
-}
-function parseDataRow(io) {
-    const out = {
-        columnCount: io.readUInt16BE(),
-    };
-    if (out.columnCount) {
-        out.columns = [];
-        for (let i = 0; i < out.columnCount; i++) {
-            // The length of the column value, in bytes (this count does not include itself).
-            // Can be zero. As a special case, -1 indicates a NULL column value.
-            // No value bytes follow in the NULL case.
-            const l = io.readInt32BE();
-            if (l < 0)
-                out.columns.push(null);
-            else
-                out.columns.push(io.readBuffer(l));
-        }
-    }
-    return out;
-}
-function parseErrorResponse(io) {
-    const out = {};
-    let fieldType;
-    while ((fieldType = io.readLString(1)) !== '\0') {
-        const value = io.readCString('utf8');
-        const key = ErrorFieldTypes[fieldType];
-        if (key)
-            out[key] = value;
-    }
-    return out;
-}
-function parseNotificationResponse(io) {
-    return {
-        processId: io.readUInt32BE(),
-        channel: io.readCString(),
-        payload: io.readCString(),
-    };
-}
-function parseFunctionCallResponse(io, code, len) {
-    return {
-        result: io.readBuffer(len - 4),
-    };
-}
-function parseNegotiateProtocolVersion(io) {
-    return {
-        supportedVersionMinor: io.readUInt32BE(),
-        numberOfNotSupportedVersions: io.readUInt32BE(),
-        option: io.readCString('utf8'),
-    };
-}
-function parseParameterDescription(io) {
-    const out = {
-        parameterCount: io.readUInt32BE(),
-        parameterIds: [],
-    };
-    for (let i = 0; i < out.parameterCount; i++) {
-        out.parameterIds.push(io.readUInt32BE());
-    }
-    return out;
-}
-function parseParameterStatus(io) {
-    return {
-        name: io.readCString('utf8'),
-        value: io.readCString('utf8'),
-    };
-}
-function parseReadyForQuery(io) {
-    return {
-        status: io.readLString(1),
-    };
-}
-function parseRowDescription(io) {
-    const fieldCount = io.readUInt16BE();
-    const out = {
-        fields: [],
-    };
-    for (let i = 0; i < fieldCount; i++) {
-        const field = {
-            fieldName: io.readCString('utf8'),
-            tableId: io.readInt32BE(),
-            columnId: io.readInt16BE(),
-            dataTypeId: io.readInt32BE(),
-            fixedSize: io.readInt16BE(),
-            modifier: io.readInt32BE(),
-            format: io.readInt16BE() === 0
-                ? protocol_js_1.Protocol.DataFormat.text
-                : protocol_js_1.Protocol.DataFormat.binary,
-        };
-        out.fields.push(field);
-    }
-    return out;
-}

package/cjs/protocol/buffer-reader.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BufferReader = void 0;
-class BufferReader {
-    constructor(buffer) {
-        this.offset = 0;
-        this.buffer = buffer;
-    }
-    get length() {
-        return this.buffer.length;
-    }
-    readUInt8() {
-        this._checkReadable(1);
-        const v = this.buffer.readUInt8(this.offset);
-        this.offset++;
-        return v;
-    }
-    readUInt16BE() {
-        this._checkReadable(2);
-        const v = this.buffer.readUInt16BE(this.offset);
-        this.offset += 2;
-        return v;
-    }
-    readInt16BE() {
-        this._checkReadable(2);
-        const v = this.buffer.readInt16BE(this.offset);
-        this.offset += 2;
-        return v;
-    }
-    readUInt32BE() {
-        this._checkReadable(4);
-        const v = this.buffer.readUInt32BE(this.offset);
-        this.offset += 4;
-        return v;
-    }
-    readInt32BE() {
-        this._checkReadable(4);
-        const v = this.buffer.readInt32BE(this.offset);
-        this.offset += 4;
-        return v;
-    }
-    readCString(encoding) {
-        const idx = this.buffer.indexOf(0, this.offset);
-        const v = this.buffer.toString(encoding, this.offset, idx);
-        this.offset = idx + 1;
-        return v;
-    }
-    readLString(len, encoding) {
-        if (len < 0)
-            return null;
-        this._checkReadable(len);
-        const v = this.buffer.toString(encoding, this.offset, this.offset + len);
-        this.offset += len;
-        return v;
-    }
-    readBuffer(len) {
-        if (len)
-            this._checkReadable(len);
-        const end = len !== undefined ? this.offset + len : this.length;
-        const buf = this.buffer.slice(this.offset, end);
-        this.offset = end;
-        return buf;
-    }
-    moveBy(n) {
-        return this.moveTo(this.offset + n);
-    }
-    moveTo(pos) {
-        if (pos >= this.length)
-            throw new Error('Eof in buffer detected');
-        this.offset = pos;
-        return this;
-    }
-    _checkReadable(size) {
-        if (this.offset + size - 1 >= this.length)
-            throw new Error('Eof in buffer detected');
-    }
-}
-exports.BufferReader = BufferReader;

package/cjs/protocol/database-error.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseError = void 0;
-class DatabaseError extends Error {
-    constructor(msg) {
-        super(msg.message);
-        Object.assign(this, {
-            ...msg,
-            line: undefined,
-            file: undefined,
-            routine: undefined,
-        });
-        if (msg.position)
-            this.position = parseInt(msg.position, 10) || undefined;
-    }
-}
-exports.DatabaseError = DatabaseError;

package/cjs/protocol/frontend.js

@@ -1,255 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Frontend = void 0;
-const constants_js_1 = require("../constants.js");
-const encode_binaryarray_js_1 = require("../util/encode-binaryarray.js");
-const stringify_arrayliteral_js_1 = require("../util/stringify-arrayliteral.js");
-const protocol_js_1 = require("./protocol.js");
-const smart_buffer_js_1 = require("./smart-buffer.js");
-const DataFormat = protocol_js_1.Protocol.DataFormat;
-const StaticFlushBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Flush,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-const StaticTerminateBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Terminate,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-const StaticSyncBuffer = Buffer.from([
-    protocol_js_1.Protocol.FrontendMessageCode.Sync,
-    0x00,
-    0x00,
-    0x00,
-    0x04,
-]);
-class Frontend {
-    constructor(options) {
-        this._io = new smart_buffer_js_1.SmartBuffer(options?.buffer);
-    }
-    getSSLRequestMessage() {
-        return this._io
-            .start()
-            .writeUInt32BE(8) // Length of message contents in bytes, including self.
-            .writeUInt16BE(1234)
-            .writeUInt16BE(5679)
-            .flush();
-    }
-    getStartupMessage(args) {
-        const io = this._io
-            .start()
-            .writeInt32BE(0) // Preserve length
-            .writeInt16BE(protocol_js_1.Protocol.VERSION_MAJOR)
-            .writeInt16BE(protocol_js_1.Protocol.VERSION_MINOR);
-        for (const [k, v] of Object.entries(args)) {
-            if (k !== 'client_encoding')
-                io.writeCString(k, 'utf8').writeCString(v, 'utf8');
-        }
-        io.writeCString('client_encoding', 'utf8')
-            .writeCString('UTF8', 'utf8')
-            .writeUInt8(0);
-        return setLengthAndFlush(io, 0);
-    }
-    getPasswordMessage(password) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(password, 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getSASLMessage(sasl) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(sasl.mechanism, 'utf8')
-            .writeLString(sasl.clientFirstMessage);
-        return setLengthAndFlush(io, 1);
-    }
-    getSASLFinalMessage(session) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.PasswordMessage)
-            .writeInt32BE(0) // Preserve header
-            .writeString(session.clientFinalMessage);
-        return setLengthAndFlush(io, 1);
-    }
-    getParseMessage(args) {
-        if (args.statement && args.statement.length > 63)
-            throw new Error('Query name length must be lower than 63');
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Parse)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.statement || '', 'utf8')
-            .writeCString(args.sql, 'utf8')
-            .writeUInt16BE(args.paramTypes ? args.paramTypes.length : 0);
-        if (args.paramTypes) {
-            for (const t of args.paramTypes) {
-                io.writeUInt32BE(t || 0);
-            }
-        }
-        return setLengthAndFlush(io, 1);
-    }
-    getBindMessage(args) {
-        if (args.portal && args.portal.length > 63)
-            throw new Error('Portal name length must be lower than 63');
-        if (args.statement && args.statement.length > 63)
-            throw new Error('Query name length must be lower than 63');
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Bind)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.portal || '', 'utf8')
-            .writeCString(args.statement || '', 'utf8');
-        const { params, paramTypes, queryOptions } = args;
-        const columnFormat = queryOptions.columnFormat != null
-            ? queryOptions.columnFormat
-            : constants_js_1.DEFAULT_COLUMN_FORMAT;
-        if (params && params.length) {
-            io.writeInt16BE(params.length);
-            const formatOffset = io.offset;
-            for (let i = 0; i < params.length; i++) {
-                io.writeInt16BE(0); // Preserve
-            }
-            // Write parameter values
-            io.writeUInt16BE(params.length);
-            for (let i = 0; i < params?.length; i++) {
-                let v = params[i];
-                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);
-                        // Preserve data length
-                        io.writeInt32BE(0);
-                        const dataOffset = io.offset;
-                        if (dt.elementsOID) {
-                            // If data type is array
-                            v = Array.isArray(v) ? v : [v];
-                            (0, encode_binaryarray_js_1.encodeBinaryArray)(io, v, dt.elementsOID, queryOptions, dt.encodeBinary, dt.encodeCalculateDim);
-                        }
-                        else {
-                            dt.encodeBinary(io, v, queryOptions);
-                        }
-                        io.buffer.writeInt32BE(io.length - dataOffset, dataOffset - 4); // Update length
-                    }
-                    else if (typeof dt.encodeText === 'function') {
-                        v = dt.elementsOID
-                            ? (0, stringify_arrayliteral_js_1.stringifyArrayLiteral)(v, queryOptions, dt.encodeText)
-                            : dt.encodeText(v, queryOptions);
-                        io.writeLString(v, 'utf8');
-                    }
-                }
-                else if (Buffer.isBuffer(v)) {
-                    // Set param format to binary
-                    io.buffer.writeInt16BE(protocol_js_1.Protocol.DataFormat.binary, formatOffset + i * 2);
-                    // Preserve data length
-                    io.writeInt32BE(0);
-                    const dataOffset = io.offset;
-                    io.writeBuffer(v);
-                    io.buffer.writeInt32BE(io.length - dataOffset, dataOffset - 4); // Update length
-                }
-                else {
-                    io.writeLString('' + v, 'utf8');
-                }
-            }
-        }
-        else {
-            io.writeUInt16BE(0);
-            io.writeUInt16BE(0);
-        }
-        if (Array.isArray(columnFormat)) {
-            io.writeUInt16BE(columnFormat.length);
-            for (let i = 0; i < columnFormat.length; i++) {
-                io.writeUInt16BE(columnFormat[i]);
-            }
-        }
-        else if (columnFormat === DataFormat.binary) {
-            io.writeUInt16BE(1);
-            io.writeUInt16BE(DataFormat.binary);
-        }
-        else
-            io.writeUInt16BE(0);
-        return setLengthAndFlush(io, 1);
-    }
-    getDescribeMessage(args) {
-        if (args.name && args.name.length > 63) {
-            throw new Error(args.type === 'P'
-                ? 'Portal'
-                : 'Statement name length must be lower than 63');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Describe)
-            .writeInt32BE(0) // Preserve header
-            .writeUInt8(args.type.charCodeAt(0))
-            .writeCString(args.name || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getExecuteMessage(args) {
-        if (args.fetchCount &&
-            (args.fetchCount < 0 || args.fetchCount > 4294967295)) {
-            throw new Error('fetchCount can be between 0 and 4294967295');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Execute)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(args.portal || '', 'utf8')
-            .writeUInt32BE(args.fetchCount || 0);
-        return setLengthAndFlush(io, 1);
-    }
-    getCloseMessage(args) {
-        if (args.name && args.name.length > 63) {
-            throw new Error(args.type === 'P'
-                ? 'Portal'
-                : 'Statement name length must be lower than 63');
-        }
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Close)
-            .writeInt32BE(0) // Preserve header
-            .writeUInt8(args.type.charCodeAt(0))
-            .writeCString(args.name || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getQueryMessage(sql) {
-        const io = this._io
-            .start()
-            .writeInt8(protocol_js_1.Protocol.FrontendMessageCode.Query)
-            .writeInt32BE(0) // Preserve header
-            .writeCString(sql || '', 'utf8');
-        return setLengthAndFlush(io, 1);
-    }
-    getFlushMessage() {
-        return StaticFlushBuffer;
-    }
-    getTerminateMessage() {
-        return StaticTerminateBuffer;
-    }
-    getSyncMessage() {
-        return StaticSyncBuffer;
-    }
-}
-exports.Frontend = Frontend;
-function setLengthAndFlush(io, lengthOffset) {
-    io.buffer.writeUInt32BE(io.length - lengthOffset, lengthOffset);
-    return io.flush();
-}