feat: add support for Uint8Array

Author: wellwelwel

src/index.ts

@@ -388,6 +388,8 @@ export const escape = (
       if (isDate(value)) return dateToString(value, timezone || 'local');
       if (Array.isArray(value)) return arrayToList(value, timezone);
       if (Buffer.isBuffer(value)) return bufferToString(value);
+      if (value instanceof Uint8Array)
+        return bufferToString(Buffer.from(value));
       if (hasSqlString(value)) return String(value.toSqlString());
       if (!(stringifyObjects === undefined || stringifyObjects === null))
         return escapeString(String(value));
@@ -453,6 +455,7 @@ export const format = (
         !hasSqlString(currentValue) &&
         !Array.isArray(currentValue) &&
         !Buffer.isBuffer(currentValue) &&
+        !(currentValue instanceof Uint8Array) &&
         !isDate(currentValue) &&
         isRecord(currentValue)
       ) {

src/types.ts

@@ -8,6 +8,7 @@ export type SqlValue =
   | boolean
   | Date
   | Buffer
+  | Uint8Array
   | Raw
   | Record<string, unknown>
   | SqlValue[]

test/stringify-objects-as-false.test.ts

@@ -209,6 +209,42 @@ describe('Object placeholder after SET but outside SET clause', () => {
   });
 });
 
+describe('Uint8Array parameter', () => {
+  it('should format Uint8Array as hex string', () => {
+    const data = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]); // "Hello" in hex
+    const query = format('SELECT * FROM files WHERE data = ?', [data]);
+
+    assert.strictEqual(query, "SELECT * FROM files WHERE data = X'48656c6c6f'");
+  });
+
+  it('should format Uint8Array in INSERT statements', () => {
+    const data = new Uint8Array([0xde, 0xad, 0xbe, 0xef]);
+    const query = format('INSERT INTO files (name, data) VALUES (?, ?)', [
+      'test',
+      data,
+    ]);
+
+    assert.strictEqual(
+      query,
+      "INSERT INTO files (name, data) VALUES ('test', X'deadbeef')"
+    );
+  });
+
+  it('should format empty Uint8Array', () => {
+    const data = new Uint8Array([]);
+    const query = format('SELECT * FROM files WHERE data = ?', [data]);
+
+    assert.strictEqual(query, "SELECT * FROM files WHERE data = X''");
+  });
+
+  it('should not expand Uint8Array in SET clause', () => {
+    const data = new Uint8Array([0x01, 0x02]);
+    const query = format('UPDATE files SET ?', [data]);
+
+    assert.strictEqual(query, "UPDATE files SET X'0102'");
+  });
+});
+
 describe('SET as a column name', () => {
   it('should not expand object when SET is a column name in WHERE', () => {
     const query = format('SELECT * FROM t WHERE SET = ? AND id = ?', [

test/stringify-objects-as-true.test.ts

@@ -203,6 +203,42 @@ describe('Object placeholder after SET but outside SET clause', () => {
   });
 });
 
+describe('Uint8Array parameter', () => {
+  it('should format Uint8Array as hex string', () => {
+    const data = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]); // "Hello" in hex
+    const query = format('SELECT * FROM files WHERE data = ?', [data]);
+
+    assert.strictEqual(query, "SELECT * FROM files WHERE data = X'48656c6c6f'");
+  });
+
+  it('should format Uint8Array in INSERT statements', () => {
+    const data = new Uint8Array([0xde, 0xad, 0xbe, 0xef]);
+    const query = format('INSERT INTO files (name, data) VALUES (?, ?)', [
+      'test',
+      data,
+    ]);
+
+    assert.strictEqual(
+      query,
+      "INSERT INTO files (name, data) VALUES ('test', X'deadbeef')"
+    );
+  });
+
+  it('should format empty Uint8Array', () => {
+    const data = new Uint8Array([]);
+    const query = format('SELECT * FROM files WHERE data = ?', [data]);
+
+    assert.strictEqual(query, "SELECT * FROM files WHERE data = X''");
+  });
+
+  it('should not expand Uint8Array in SET clause', () => {
+    const data = new Uint8Array([0x01, 0x02]);
+    const query = format('UPDATE files SET ?', [data]);
+
+    assert.strictEqual(query, "UPDATE files SET X'0102'");
+  });
+});
+
 describe('SET as a column name', () => {
   it('should stringify object when SET is a column name in WHERE', () => {
     const query = format('SELECT * FROM t WHERE SET = ? AND id = ?', [