node-firebird 2.3.3 → 2.4.0

package/{poc/node_modules/node-firebird/lib/wire/xsqlvar.js → src/wire/xsqlvar.ts}

@@ -1,4 +1,5 @@
-const Const= require('./const');
+import Const from './const';
+import type { XdrReader, XdrWriter, BlrWriter } from './serialize';
 
 /***************************************
  *
@@ -13,17 +14,105 @@ const
     TimeCoeff = 86400000,
     MsPerMinute = 60000;
 
-//------------------------------------------------------
+/**
+ * Maps Firebird character-set names (upper-case) to the Node.js Buffer
+ * encoding string used by Buffer.toString() / Buffer.from().
+ *
+ * Firebird stores CHAR/VARCHAR data in the on-wire character set of the
+ * column (or the connection character set for NONE/unspecified columns).
+ * We must decode raw bytes with the matching Node.js encoding so that
+ * characters outside ASCII are reproduced correctly.
+ *
+ * Commonly used Firebird charsets not listed here fall back to the
+ * connection-level DEFAULT_ENCODING (typically 'utf8').
+ */
+const FirebirdToNodeEncoding = Object.freeze({
+    UTF8:        'utf8',
+    UNICODE_FSS: 'utf8',
+    WIN1252:     'latin1',
+    ISO8859_1:   'latin1',
+    LATIN1:      'latin1',
+    ASCII:       'ascii',
+    NONE:        'latin1',   // unspecified charset – treat as binary-safe latin1
+});
+
+const FirebirdCharsetWidths = {
+    'UTF8': 4,
+    'UNICODE_FSS': 3,
+    'SJIS': 2,
+    'EUCJ': 2
+};
+
+function getFirebirdCharsetWidth(charset?: string): number {
+    if (!charset) return 4;
+    const upper = charset.toUpperCase();
+    return FirebirdCharsetWidths[upper] || 1;
+}
 
-class SQLVarText {
-    decode(data, lowerV13) {
+/**
+ * Resolve the Node.js Buffer encoding to use when decoding text from a
+ * Firebird response buffer.
+ *
+ * @param {object|null} options  Connection options object (may be falsy).
+ * @returns {string}             A Node.js-compatible encoding string.
+ */
+function resolveTextEncoding(options?: any): BufferEncoding {
+    const encoding = (options && options.encoding)
+        ? options.encoding.toUpperCase()
+        : Const.DEFAULT_ENCODING;
+    return (FirebirdToNodeEncoding[encoding] || Const.DEFAULT_ENCODING.toLowerCase()) as BufferEncoding;
+}
+
+//------------------------------------------------------
+
+/**
+ * Common shape of all SQLVar descriptor objects.  The metadata properties
+ * are populated externally (in connection.ts) from the op_prepare_statement
+ * describe response before decode()/calcBlr() are called.
+ */
+export abstract class SQLVarBase {
+    type: number;
+    subType: number;
+    scale: number;
+    length: number;
+    nullable: boolean;
+    field?: string;
+    relation?: string;
+    relationSchema?: string;
+    alias?: string;
+    relationAlias?: string;
+    owner?: string;
+    charSetId?: number;
+    collationId?: number;
+
+    abstract decode(data: XdrReader, lowerV13: boolean, options?: any): any;
+    abstract calcBlr(blr: BlrWriter): void;
+}
+
+//------------------------------------------------------
+
+export class SQLVarText extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean, options?: any) {
         let ret;
+        const textEncoding = resolveTextEncoding(options);
         if (this.subType > 1) {
             // ToDo: with column charset
-            ret = data.readText(this.length, Const.DEFAULT_ENCODING);
+            ret = data.readText(this.length, textEncoding);
+            const encoding = options && options.encoding ? options.encoding : 'UTF8';
+            const width = getFirebirdCharsetWidth(encoding);
+            const charLength = Math.floor(this.length / width);
+            if (ret.length > charLength) {
+                ret = ret.substring(0, charLength);
+            }
         } else if (this.subType === 0) {
             // without charset definition
-            ret = data.readText(this.length, Const.DEFAULT_ENCODING);
+            ret = data.readText(this.length, textEncoding);
+            const encoding = options && options.encoding ? options.encoding : 'UTF8';
+            const width = getFirebirdCharsetWidth(encoding);
+            const charLength = Math.floor(this.length / width);
+            if (ret.length > charLength) {
+                ret = ret.substring(0, charLength);
+            }
         } else {
             ret = data.readBuffer(this.length);
         }
@@ -35,7 +124,7 @@ class SQLVarText {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_text);
         blr.addWord(this.length);
     }
@@ -43,20 +132,21 @@ class SQLVarText {
 
 //------------------------------------------------------
 
-class SQLVarNull extends SQLVarText {
+export class SQLVarNull extends SQLVarText {
 }
 
 //------------------------------------------------------
 
-class SQLVarString {
-    decode(data, lowerV13) {
+export class SQLVarString extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean, options?: any) {
         let ret;
+        const textEncoding = resolveTextEncoding(options);
         if (this.subType > 1) {
             // ToDo: with column charset
-            ret = data.readString(Const.DEFAULT_ENCODING);
+            ret = data.readString(textEncoding);
         } else if (this.subType === 0) {
             // without charset definition
-            ret = data.readString(Const.DEFAULT_ENCODING);
+            ret = data.readString(textEncoding);
         } else {
             ret = data.readBuffer();
         }
@@ -68,7 +158,7 @@ class SQLVarString {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_varying);
         blr.addWord(this.length);
     }
@@ -76,8 +166,8 @@ class SQLVarString {
 
 //------------------------------------------------------
 
-class SQLVarQuad {
-    decode(data, lowerV13) {
+export class SQLVarQuad extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readQuad();
 
         if (!lowerV13 || !data.readInt()) {
@@ -86,7 +176,7 @@ class SQLVarQuad {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_quad);
         blr.addShort(this.scale);
     }
@@ -94,8 +184,8 @@ class SQLVarQuad {
 
 //------------------------------------------------------
 
-class SQLVarBlob extends SQLVarQuad {
-    calcBlr(blr) {
+export class SQLVarBlob extends SQLVarQuad {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_quad);
         blr.addShort(0);
     }
@@ -103,8 +193,8 @@ class SQLVarBlob extends SQLVarQuad {
 
 //------------------------------------------------------
 
-class SQLVarArray extends SQLVarQuad {
-    calcBlr(blr) {
+export class SQLVarArray extends SQLVarQuad {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_quad);
         blr.addShort(0);
     }
@@ -112,8 +202,8 @@ class SQLVarArray extends SQLVarQuad {
 
 //------------------------------------------------------
 
-class SQLVarInt {
-    decode(data, lowerV13) {
+export class SQLVarInt extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readInt();
 
         if (this.scale) {
@@ -127,7 +217,7 @@ class SQLVarInt {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_long);
         blr.addShort(this.scale);
     }
@@ -135,8 +225,8 @@ class SQLVarInt {
 
 //------------------------------------------------------
 
-class SQLVarShort extends SQLVarInt {
-    calcBlr(blr) {
+export class SQLVarShort extends SQLVarInt {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_short);
         blr.addShort(this.scale);
     }
@@ -144,8 +234,8 @@ class SQLVarShort extends SQLVarInt {
 
 //------------------------------------------------------
 
-class SQLVarInt64 {
-    decode(data, lowerV13) {
+export class SQLVarInt64 extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readInt64();
 
         if (this.scale) {
@@ -158,7 +248,7 @@ class SQLVarInt64 {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_int64);
         blr.addShort(this.scale);
     }
@@ -166,12 +256,13 @@ class SQLVarInt64 {
 
 //------------------------------------------------------
 
-class SQLVarInt128 {
-    decode(data, lowerV13) {
+export class SQLVarInt128 extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var retBigInt = BigInt(data.readInt128())
+        let ret: string | number;
 
         if (retBigInt > BigInt(Number.MAX_SAFE_INTEGER)) {
-            var ret = retBigInt.toString();
+            ret = retBigInt.toString();
 
             var integerPart = ret.slice(0, Math.abs(this.scale) * -1)
             var decimalPart = ret.slice(Math.abs(this.scale) * -1)
@@ -180,7 +271,7 @@ class SQLVarInt128 {
 
             ret = `${integerPart}.${decimalPart}`
         } else {
-            var ret = Number(retBigInt);
+            ret = Number(retBigInt);
             ret = ret / ScaleDivisor[Math.abs(this.scale)];
         }
 
@@ -191,7 +282,7 @@ class SQLVarInt128 {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_int128);
         blr.addShort(this.scale);
     }
@@ -199,8 +290,8 @@ class SQLVarInt128 {
 
 //------------------------------------------------------
 
-class SQLVarDecFloat16 {
-    decode(data, lowerV13) {
+export class SQLVarDecFloat16 extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readDecFloat16();
 
         if (!lowerV13 || !data.readInt()) {
@@ -210,7 +301,7 @@ class SQLVarDecFloat16 {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_dec64);
         blr.addShort(0);
     }
@@ -218,8 +309,8 @@ class SQLVarDecFloat16 {
 
 //------------------------------------------------------
 
-class SQLVarDecFloat34 {
-    decode(data, lowerV13) {
+export class SQLVarDecFloat34 extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readDecFloat34();
 
         if (!lowerV13 || !data.readInt()) {
@@ -229,7 +320,7 @@ class SQLVarDecFloat34 {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_dec128);
         blr.addShort(0);
     }
@@ -237,8 +328,8 @@ class SQLVarDecFloat34 {
 
 //------------------------------------------------------
 
-class SQLVarFloat {
-    decode(data, lowerV13) {
+export class SQLVarFloat extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readFloat();
 
         if (!lowerV13 || !data.readInt()) {
@@ -248,15 +339,15 @@ class SQLVarFloat {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_float);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarDouble {
-    decode(data, lowerV13) {
+export class SQLVarDouble extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readDouble();
 
         if (!lowerV13 || !data.readInt()) {
@@ -266,15 +357,15 @@ class SQLVarDouble {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_double);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarDate {
-    decode(data, lowerV13) {
+export class SQLVarDate extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readInt();
 
         if (!lowerV13 || !data.readInt()) {
@@ -286,15 +377,15 @@ class SQLVarDate {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_sql_date);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTime {
-    decode(data, lowerV13) {
+export class SQLVarTime extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readUInt();
 
         if (!lowerV13 || !data.readInt()) {
@@ -305,15 +396,15 @@ class SQLVarTime {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_sql_time);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTimeStamp {
-    decode(data, lowerV13) {
+export class SQLVarTimeStamp extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var date = data.readInt();
         var time = data.readUInt();
 
@@ -326,15 +417,15 @@ class SQLVarTimeStamp {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_timestamp);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTimeTz {
-    decode(data, lowerV13) {
+export class SQLVarTimeTz extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var time = data.readUInt();
         data.readInt(); // skip timezone info
 
@@ -346,15 +437,15 @@ class SQLVarTimeTz {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_sql_time_tz);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTimeTzEx extends SQLVarTimeTz {
-    decode(data, lowerV13) {
+export class SQLVarTimeTzEx extends SQLVarTimeTz {
+    decode(data: XdrReader, lowerV13: boolean) {
         var time = data.readUInt();
         data.readInt(); // skip timezone info
         data.readInt(); // skip ext_offset
@@ -367,15 +458,15 @@ class SQLVarTimeTzEx extends SQLVarTimeTz {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_ex_time_tz);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTimeStampTz {
-    decode(data, lowerV13) {
+export class SQLVarTimeStampTz extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var date = data.readInt();
         var time = data.readUInt();
         data.readInt(); // skip timezone info
@@ -389,15 +480,15 @@ class SQLVarTimeStampTz {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_timestamp_tz);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarTimeStampTzEx extends SQLVarTimeStampTz {
-    decode(data, lowerV13) {
+export class SQLVarTimeStampTzEx extends SQLVarTimeStampTz {
+    decode(data: XdrReader, lowerV13: boolean) {
         var date = data.readInt();
         var time = data.readUInt();
         data.readInt(); // skip timezone info
@@ -412,15 +503,15 @@ class SQLVarTimeStampTzEx extends SQLVarTimeStampTz {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_ex_timestamp_tz);
     }
 }
 
 //------------------------------------------------------
 
-class SQLVarBoolean {
-    decode(data, lowerV13) {
+export class SQLVarBoolean extends SQLVarBase {
+    decode(data: XdrReader, lowerV13: boolean) {
         var ret = data.readInt();
 
         if (!lowerV13 || !data.readInt()) {
@@ -429,24 +520,26 @@ class SQLVarBoolean {
         return null;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_bool);
     }
 }
 
 //------------------------------------------------------
 
-class SQLParamInt {
-    constructor(value) {
+export class SQLParamInt {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_long);
         blr.addShort(0);
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addInt(this.value);
         } else {
@@ -458,17 +551,19 @@ class SQLParamInt {
 
 //------------------------------------------------------
 
-class SQLParamInt64 {
-    constructor(value) {
+export class SQLParamInt64 {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_int64);
         blr.addShort(0);
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addInt64(this.value);
         } else {
@@ -480,17 +575,19 @@ class SQLParamInt64 {
 
 //------------------------------------------------------
 
-class SQLParamInt128 {
-    constructor(value) {
+export class SQLParamInt128 {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_int128);
         blr.addShort(0);
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addInt128(this.value);
         } else {
@@ -502,17 +599,19 @@ class SQLParamInt128 {
 
 //------------------------------------------------------
 
-class SQLParamDecFloat16 {
-    constructor(value) {
+export class SQLParamDecFloat16 {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_dec64);
         blr.addShort(0);
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addDecFloat16(this.value);
         } else {
@@ -524,17 +623,19 @@ class SQLParamDecFloat16 {
 
 //------------------------------------------------------
 
-class SQLParamDecFloat34 {
-    constructor(value) {
+export class SQLParamDecFloat34 {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_dec128);
         blr.addShort(0);
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addDecFloat34(this.value);
         } else {
@@ -546,12 +647,14 @@ class SQLParamDecFloat34 {
 
 //------------------------------------------------------
 
-class SQLParamDouble {
-    constructor(value) {
+export class SQLParamDouble {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addDouble(this.value);
         } else {
@@ -560,19 +663,21 @@ class SQLParamDouble {
         }
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_double);
     }
 }
 
 //------------------------------------------------------
 
-class SQLParamString {
-    constructor(value) {
+export class SQLParamString {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addText(this.value, Const.DEFAULT_ENCODING);
         } else {
@@ -580,7 +685,7 @@ class SQLParamString {
         }
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_text);
         var len = this.value ? Buffer.byteLength(this.value, Const.DEFAULT_ENCODING) : 0;
         blr.addWord(len);
@@ -589,12 +694,38 @@ class SQLParamString {
 
 //------------------------------------------------------
 
-class SQLParamQuad {
-    constructor(value) {
+export class SQLParamBuffer {
+    value: any;
+
+    constructor(value: any) {
+        this.value = value;
+    }
+
+    encode(data: XdrWriter): void {
+        if (this.value != null) {
+            data.addParamBuffer(this.value);
+        } else {
+            data.addInt(1);
+        }
+    }
+
+    calcBlr(blr: BlrWriter): void {
+        blr.addByte(Const.blr_text);
+        var len = this.value ? this.value.length : 0;
+        blr.addWord(len);
+    }
+}
+
+//------------------------------------------------------
+
+export class SQLParamQuad {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addInt(this.value.high);
             data.addInt(this.value.low);
@@ -605,7 +736,7 @@ class SQLParamQuad {
         }
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_quad);
         blr.addShort(0);
     }
@@ -613,12 +744,14 @@ class SQLParamQuad {
 
 //------------------------------------------------------
 
-class SQLParamDate {
-    constructor(value) {
+export class SQLParamDate {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
 
             var value = this.value.getTime() - this.value.getTimezoneOffset() * MsPerMinute;
@@ -641,19 +774,21 @@ class SQLParamDate {
         }
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_timestamp);
     }
 }
 
 //------------------------------------------------------
 
-class SQLParamBool {
-    constructor(value) {
+export class SQLParamBool {
+    value: any;
+
+    constructor(value: any) {
         this.value = value;
     }
 
-    encode(data) {
+    encode(data: XdrWriter): void {
         if (this.value != null) {
             data.addInt(this.value ? 1 : 0);
         } else {
@@ -662,42 +797,8 @@ class SQLParamBool {
         }
     }
 
-    calcBlr(blr) {
+    calcBlr(blr: BlrWriter): void {
         blr.addByte(Const.blr_short);
         blr.addShort(0);
     }
 }
-
-module.exports = {
-    SQLVarArray,
-    SQLVarDate,
-    SQLVarBlob,
-    SQLVarBoolean,
-    SQLVarDouble,
-    SQLVarInt,
-    SQLVarInt64,
-    SQLVarInt128,
-    SQLVarDecFloat16,
-    SQLVarDecFloat34,
-    SQLVarFloat,
-    SQLVarNull,
-    SQLVarShort,
-    SQLVarString,
-    SQLVarText,
-    SQLVarTime,
-    SQLVarTimeStamp,
-    SQLVarTimeTz,
-    SQLVarTimeTzEx,
-    SQLVarTimeStampTz,
-    SQLVarTimeStampTzEx,
-    SQLParamBool,
-    SQLParamDate,
-    SQLParamDouble,
-    SQLParamInt,
-    SQLParamInt64,
-    SQLParamInt128,
-    SQLParamDecFloat16,
-    SQLParamDecFloat34,
-    SQLParamQuad,
-    SQLParamString,
-};