@devmoods/express-extras 0.40.1 → 0.41.0

package/dist/postgres.d.ts

@@ -1,7 +1,8 @@
 import pg, { type PoolClient, type PoolConfig, type QueryResult, type QueryResultRow } from 'pg';
 export declare const escapePostgresIdentifier: typeof pg.escapeIdentifier;
 export declare const escapePostgresLiteral: typeof pg.escapeLiteral;
-export interface PostgresOptions extends PoolConfig {
+export declare const formatSql: (statement: SqlStatement | string) => string;
+export interface PostgresOptions extends PoolConfig, ConnectionOptions {
     onError?: (error: Error, client: any) => void;
     url?: PoolConfig['connectionString'];
 }
@@ -15,14 +16,18 @@ export declare class IntegrityError extends Error {
     constructor(message: string);
 }
 type Value = null | string | number | Date;
+export interface ConnectionOptions {
+    onLogStatement?: (statement: SqlStatement | string, values?: unknown[]) => void;
+}
 export declare class Connection {
+    private options;
     client: PoolClient;
-    constructor(client: PoolClient);
-    query<T extends QueryResultRow>(text: string | SQLStatement, values?: Value[]): Promise<QueryResult<T>>;
-    all<T>(text: string | SQLStatement, values?: Value[]): Promise<T[]>;
-    insert<T extends QueryResultRow>(text: string | SQLStatement, values?: Value[]): Promise<QueryResult<T>>;
-    first<T>(text: string | SQLStatement, values?: Value[]): Promise<T | null>;
-    get<T>(text: string | SQLStatement, values?: Value[]): Promise<T>;
+    constructor(client: PoolClient, options: ConnectionOptions);
+    query<T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]): Promise<QueryResult<T>>;
+    all<T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]): Promise<T[]>;
+    insert<T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]): Promise<QueryResult<T>>;
+    first<T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]): Promise<T | null>;
+    get<T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]): Promise<T>;
 }
 export declare class Transaction extends Connection {
 }
@@ -34,27 +39,27 @@ export declare class Transaction extends Connection {
  * @param config
  */
 export declare function createPostgres({ onError, url, ...config }?: PostgresOptions): {
-    insert: <T extends QueryResultRow>(text: string | SQLStatement, values?: Value[]) => Promise<QueryResult<T>>;
-    query: <T extends QueryResultRow>(text: string | SQLStatement, values?: Value[]) => Promise<QueryResult<T>>;
-    first: <T>(text: string | SQLStatement, values?: Value[]) => Promise<T | null>;
-    all: <T>(text: string | SQLStatement, values?: Value[]) => Promise<T[]>;
-    get: <T>(text: string | SQLStatement, values?: Value[]) => Promise<T>;
+    insert: <T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]) => Promise<QueryResult<T>>;
+    query: <T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]) => Promise<QueryResult<T>>;
+    first: <T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]) => Promise<T | null>;
+    all: <T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]) => Promise<T[]>;
+    get: <T extends QueryResultRow>(text: string | SqlStatement, values?: Value[]) => Promise<T>;
     withConnection: <T>(callback: (connection: Connection) => Promise<T>) => Promise<T>;
     transaction: <T>(callback: (connection: Transaction) => Promise<T> | T) => Promise<T>;
     instance: pg.Pool;
     clear: (force?: boolean) => Promise<void>;
     end(): Promise<void>;
 };
-declare class SQLStatement {
+export declare class SqlStatement {
     stringsAndValues: [string, unknown | undefined][];
     constructor(strings: string[], values: unknown[]);
     _extract(strings: string[], values: unknown[]): void;
-    append(statement: SQLStatement | string): this;
+    append(statement: SqlStatement | string): this;
     get values(): ({} | null)[];
     get text(): string;
 }
 export declare const sql: {
-    (strings: TemplateStringsArray, ...values: unknown[]): SQLStatement;
+    (strings: TemplateStringsArray, ...values: unknown[]): SqlStatement;
     identifier(name: string): {
         name: string;
         raw: boolean;
@@ -63,14 +68,14 @@ export declare const sql: {
         name: string;
         raw: boolean;
     };
-    literal(name: string): {
+    literal(name: string | null): {
         name: string;
         raw: boolean;
     };
     spreadUpdate: typeof spreadUpdate;
     spreadInsert: typeof spreadInsert;
 };
-declare function spreadUpdate(data: Record<string, any>): SQLStatement;
-declare function spreadInsert<TData extends Record<string, any>>(data: TData | TData[]): SQLStatement;
-export declare function joinStatements(statements: SQLStatement[], separator: string): SQLStatement;
+declare function spreadUpdate(data: Record<string, any>): SqlStatement;
+declare function spreadInsert<TData extends Record<string, any>>(data: TData | TData[]): SqlStatement;
+export declare function joinStatements(statements: SqlStatement[], separator: string): SqlStatement;
 export {};

package/dist/postgres.js

@@ -1,7 +1,17 @@
 import pg, {} from 'pg';
+import { format } from 'sql-formatter';
 import { readEnv } from './utils.js';
 export const escapePostgresIdentifier = pg.escapeIdentifier;
 export const escapePostgresLiteral = pg.escapeLiteral;
+export const formatSql = (statement) => {
+    const value = statement instanceof SqlStatement ? statement.text : statement;
+    return format(value, {
+        language: 'postgresql',
+        keywordCase: 'upper',
+        tabWidth: 2,
+        useTabs: false,
+    });
+};
 export class DoesNotExistError extends Error {
     constructor(message) {
         super(message);
@@ -21,11 +31,13 @@ export class IntegrityError extends Error {
     }
 }
 export class Connection {
-    constructor(client) {
+    constructor(client, options) {
+        this.options = options;
         this.client = client;
     }
     async query(text, values) {
         try {
+            this.options.onLogStatement?.(text, values);
             return await this.client.query(text, values);
         }
         catch (error) {
@@ -36,7 +48,7 @@ export class Connection {
         }
     }
     async all(text, values) {
-        const result = await this.client.query(text, values);
+        const result = await this.query(text, values);
         if (result.rows) {
             return result.rows;
             /* c8 ignore next 2*/
@@ -47,11 +59,11 @@ export class Connection {
         return await this.query(text, values);
     }
     async first(text, values) {
-        const result = await this.client.query(text, values);
+        const result = await this.query(text, values);
         return result.rows && result.rows.length ? result.rows[0] : null;
     }
     async get(text, values) {
-        const result = await this.client.query(text, values);
+        const result = await this.query(text, values);
         if (result.rowCount === 0) {
             throw new DoesNotExistError('Row matching query not found');
         }
@@ -78,7 +90,7 @@ export function createPostgres({ onError, url = readEnv('POSTGRES_URL'), ...conf
     async function withConnection(callback) {
         const client = await pool.connect();
         try {
-            const result = await callback(new Connection(client));
+            const result = await callback(new Connection(client, { onLogStatement: config.onLogStatement }));
             return result;
         }
         finally {
@@ -104,7 +116,7 @@ export function createPostgres({ onError, url = readEnv('POSTGRES_URL'), ...conf
         const client = await pool.connect();
         try {
             await client.query('BEGIN');
-            const result = await callback(new Transaction(client));
+            const result = await callback(new Transaction(client, { onLogStatement: config.onLogStatement }));
             await client.query('COMMIT');
             return result;
         }
@@ -160,7 +172,7 @@ export function createPostgres({ onError, url = readEnv('POSTGRES_URL'), ...conf
 const isRaw = (value) => {
     return (typeof value === 'object' && value !== null && 'raw' in value && !!value.raw);
 };
-class SQLStatement {
+export class SqlStatement {
     constructor(strings, values) {
         this.stringsAndValues = [];
         this._extract(strings, values);
@@ -172,7 +184,7 @@ class SQLStatement {
             if (isRaw(value)) {
                 this.stringsAndValues.push([string + value.name, undefined]);
             }
-            else if (value instanceof SQLStatement) {
+            else if (value instanceof SqlStatement) {
                 this.stringsAndValues.push([string, undefined]);
                 this.stringsAndValues.push(...value.stringsAndValues);
             }
@@ -182,7 +194,7 @@ class SQLStatement {
         }
     }
     append(statement) {
-        if (statement instanceof SQLStatement) {
+        if (statement instanceof SqlStatement) {
             this.stringsAndValues.push(...statement.stringsAndValues);
         }
         else {
@@ -211,14 +223,16 @@ class SQLStatement {
     }
 }
 export const sql = (strings, ...values) => {
-    return new SQLStatement(Array.from(strings), values);
+    return new SqlStatement(Array.from(strings), values);
 };
 function spreadUpdate(data) {
     const entries = Object.entries(data);
     if (entries.length === 0) {
         return sql ``;
     }
-    return joinStatements(entries.map(([key, value]) => sql `${sql.identifier(key)} = ${value}`), ', ');
+    return joinStatements(entries
+        .filter(([, value]) => typeof value !== 'undefined')
+        .map(([key, value]) => sql `${sql.identifier(key)} = ${value == null ? sql.raw('NULL') : value}`), ', ');
 }
 function spreadInsert(data) {
     const rows = Array.isArray(data) ? data : [data];
@@ -257,6 +271,9 @@ sql.raw = (name) => {
  * Inject a literal value into the template string
  */
 sql.literal = (name) => {
+    if (name === null) {
+        return { name: 'NULL', raw: true };
+    }
     return { name: escapePostgresLiteral(name), raw: true };
 };
 sql.spreadUpdate = spreadUpdate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.40.1",
+  "version": "0.41.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,31 +20,31 @@
   "devDependencies": {
     "@devmoods/eslint-config": "^1.15.0",
     "@types/koa-compose": "^3.2.8",
-    "@types/node": "22.9.3",
+    "@types/node": "22.10.1",
     "@types/supertest": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
-    "@vitest/coverage-v8": "^2.1.5",
+    "@typescript-eslint/eslint-plugin": "^8.16.0",
+    "@typescript-eslint/parser": "^8.16.0",
+    "@vitest/coverage-v8": "^2.1.6",
     "cookiejar": "^2.1.4",
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-prettier": "^5.2.1",
     "faktory-worker": "^4.6.0",
-    "prettier": "3.3.3",
+    "prettier": "3.4.1",
     "supertest": "7.0.0",
     "ts-node": "10.9.2",
     "tsx": "^4.19.2",
     "typescript": "5.7.2",
-    "vitest": "^2.1.5",
+    "vitest": "^2.1.6",
     "vitest-fail-on-console": "^0.7.1"
   },
   "dependencies": {
     "@devmoods/fetch": "^4.0.1",
-    "@sentry/node": "^8.40.0",
-    "@sentry/profiling-node": "^8.40.0",
+    "@sentry/node": "^8.41.0",
+    "@sentry/profiling-node": "^8.41.0",
     "@types/bcrypt": "^5.0.2",
     "@types/body-parser": "^1.19.5",
-    "@types/cookie-parser": "^1.4.7",
+    "@types/cookie-parser": "^1.4.8",
     "@types/express": "^5.0.0",
     "@types/jsonwebtoken": "^9.0.7",
     "@types/nodemailer": "^6.4.17",
@@ -65,6 +65,7 @@
     "nodemailer": "^6.9.16",
     "pg": "^8.13.1",
     "redis": "^4.7.0",
+    "sql-formatter": "^15.4.6",
     "uuid": "^11.0.3"
   },
   "prettier": {