@devmoods/express-extras 0.16.0 → 0.17.0

package/dist/__tests__/__migrations__/1_a.d.ts

@@ -0,0 +1,3 @@
+import { type Connection } from '../../postgres.js';
+export declare function up(query: Connection['query']): Promise<void>;
+export declare function down(query: Connection['query']): Promise<void>;

package/dist/__tests__/__migrations__/1_a.js

@@ -0,0 +1,8 @@
+export async function up(query) {
+    await query('CREATE TABLE baz (id serial primary key)');
+    await query('CREATE TABLE foo (id serial primary key)');
+}
+export async function down(query) {
+    await query('DROP TABLE foo');
+    await query('DROP TABLE baz');
+}

package/dist/email.d.ts

@@ -12,4 +12,5 @@ export interface SendEmailOptions extends nodemailer.SendMailOptions {
 }
 export declare function createEmail({ host, port, user, pass, senderName, senderAddress, }: EmailOptions): {
     send: ({ to, subject, message, ...rest }: SendEmailOptions) => Promise<void>;
+    transporter: nodemailer.Transporter<import("nodemailer/lib/smtp-transport/index.js").SentMessageInfo>;
 };

package/dist/email.js

@@ -17,5 +17,5 @@ export function createEmail({ host, port, user, pass, senderName, senderAddress,
         });
         getLogger('core').info('email-sent', { email: result });
     };
-    return { send };
+    return { send, transporter };
 }

package/dist/migrate.d.ts

@@ -1,4 +1,4 @@
-import { createPostgres } from './postgres.js';
+import { type Connection, createPostgres } from './postgres.js';
 interface Migration {
     name: string;
     filename: string;
@@ -23,9 +23,9 @@ export declare class Migrator {
     runMigrations(direction: 'up' | 'down'): Promise<number>;
     log(...args: any[]): void;
     executeMigration(migrations: Migration[], currentVersion: number, direction: 'up' | 'down'): Promise<number>;
-    queryWithLog(sql: string): Promise<import("pg").QueryResult<import("pg").QueryResultRow>>;
-    migrate(migration: Migration, direction: 'up' | 'down'): Promise<any>;
-    updateCurrentVersion(version: number): Promise<import("pg").QueryResult<import("pg").QueryResultRow>>;
+    readMigrationFile(filename: string): Promise<any>;
+    migrate(tx: Connection, migration: Migration, direction: 'up' | 'down'): Promise<void>;
+    updateCurrentVersion(connection: Connection, version: number): Promise<import("pg").QueryResult<import("pg").QueryResultRow>>;
     getCurrentVersion(): Promise<number>;
     getMigrations(): Promise<{
         filename: string;

package/dist/migrate.js

@@ -54,7 +54,7 @@ Usage
 }
 export class Migrator {
     constructor({ postgres = createPostgres(), pathToMigrations = path.resolve(process.cwd(), 'db', 'migrations'), migrationTableName = 'migrations', verbose = true, } = {}) {
-        this.filenameRegExp = /(\d+)_(.*)\.(js|ts|mjs|mts)/;
+        this.filenameRegExp = /(\d+)_(.*)\.(js|ts|mjs|mts|sql)/;
         this.postgres = postgres;
         this.pathToMigrations = pathToMigrations;
         this.migrationTableName = migrationTableName;
@@ -104,8 +104,10 @@ export class Migrator {
             }
             for (const migration of pendingMigrations) {
                 this.log('Running migration', migration.filename);
-                await this.migrate(migration, direction);
-                await this.updateCurrentVersion(migration.version);
+                await this.postgres.transaction(async (tx) => {
+                    await this.migrate(tx, migration, direction);
+                    await this.updateCurrentVersion(tx, migration.version);
+                });
             }
             this.log(chalk.green('Done!'));
             return await this.getCurrentVersion();
@@ -120,29 +122,55 @@ export class Migrator {
                 return currentVersion;
             }
             this.log('Rolling back migration', migrationToRollback.filename);
-            await this.migrate(migrationToRollback, 'down');
-            await this.updateCurrentVersion(updatedVersion);
+            await this.postgres.transaction(async (tx) => {
+                await this.migrate(tx, migrationToRollback, 'down');
+                await this.updateCurrentVersion(tx, updatedVersion);
+            });
             return await this.getCurrentVersion();
         }
         throw new Error(`Invalid direction ${direction}`);
     }
-    queryWithLog(sql) {
-        this.log(chalk.yellow(sql.toString()));
-        return this.postgres.query(sql);
+    async readMigrationFile(filename) {
+        if (!filename.endsWith('.sql')) {
+            return import(filename);
+        }
+        const content = await fs.readFile(filename, 'utf-8');
+        const [up, down] = content.split('-- ROLLBACK --');
+        return {
+            up() {
+                return up.trim();
+            },
+            down() {
+                return (down || '').trim();
+            },
+        };
     }
-    async migrate(migration, direction) {
-        const migrator = await import(migration.filename);
+    async migrate(tx, migration, direction) {
+        const migrator = await this.readMigrationFile(migration.filename);
         if (!migrator.up || !migrator.down) {
             throw new Error('Migrations must export both an up() and a down() function.');
         }
-        const returnValue = migrator[direction](this.queryWithLog.bind(this));
-        if (typeof returnValue === 'string') {
-            return this.queryWithLog(returnValue);
+        try {
+            const queryWithLog = (sql) => {
+                this.log(chalk.yellow(sql.toString()));
+                return tx.query(sql);
+            };
+            const returnValue = await migrator[direction](queryWithLog.bind(tx));
+            if (typeof returnValue === 'string') {
+                if (returnValue !== '') {
+                    await queryWithLog(returnValue);
+                }
+            }
+            else {
+                await returnValue;
+            }
+        }
+        catch (error) {
+            throw new Error(`Migration failed: ${error.message}`);
         }
-        return returnValue;
     }
-    updateCurrentVersion(version) {
-        return this.postgres.query(`INSERT INTO ${this.migrationTableName} (version, run_at) VALUES ($1, $2)`, [version, new Date()]);
+    updateCurrentVersion(connection, version) {
+        return connection.query(`INSERT INTO ${this.migrationTableName} (version, run_at) VALUES ($1, $2)`, [version, new Date()]);
     }
     async getCurrentVersion() {
         const result = await this.postgres.first(`SELECT version FROM ${this.migrationTableName} ORDER BY run_at DESC LIMIT 1`);

package/dist/postgres.d.ts

@@ -10,7 +10,7 @@ export declare class MultipleRowsReturnedError extends Error {
     constructor(message: string);
 }
 type Value = null | string | number | Date;
-declare class API {
+export declare class Connection {
     client: PoolClient;
     constructor(client: PoolClient);
     query<T extends QueryResultRow>(text: string | SQLStatement, values?: Value[]): Promise<QueryResult<T>>;
@@ -19,6 +19,8 @@ declare class API {
     first<T>(text: string | SQLStatement, values?: Value[]): Promise<T | null>;
     get<T>(text: string | SQLStatement, values?: Value[]): Promise<T>;
 }
+export declare class Transaction extends Connection {
+}
 /**
  * Create a new Postgres connection pool with
  * conveience methods for executing queries using
@@ -32,8 +34,8 @@ export declare function createPostgres({ onError, ...config }?: PostgresOptions)
     first: <T_2>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<T_2 | null>;
     all: <T_3>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<T_3[]>;
     get: <T_4>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<T_4>;
-    withConnection: <T_5>(callback: (connection: API) => Promise<T_5>) => Promise<T_5>;
-    transaction: <T_6>(callback: (connection: API) => T_6 | Promise<T_6>) => Promise<T_6>;
+    withConnection: <T_5>(callback: (connection: Connection) => Promise<T_5>) => Promise<T_5>;
+    transaction: <T_6>(callback: (connection: Transaction) => T_6 | Promise<T_6>) => Promise<T_6>;
     instance: pg.Pool;
     clear: (force?: boolean) => Promise<void>;
     end(): Promise<void>;

package/dist/postgres.js

@@ -12,7 +12,7 @@ export class MultipleRowsReturnedError extends Error {
         this.name = 'MultipleRowsReturnedError';
     }
 }
-class API {
+export class Connection {
     constructor(client) {
         this.client = client;
     }
@@ -44,6 +44,8 @@ class API {
         return result.rows[0];
     }
 }
+export class Transaction extends Connection {
+}
 /**
  * Create a new Postgres connection pool with
  * conveience methods for executing queries using
@@ -57,7 +59,7 @@ export function createPostgres({ onError = () => { }, ...config } = {}) {
     async function withConnection(callback) {
         const client = await pool.connect();
         try {
-            const result = await callback(new API(client));
+            const result = await callback(new Connection(client));
             return result;
         }
         finally {
@@ -82,7 +84,7 @@ export function createPostgres({ onError = () => { }, ...config } = {}) {
         const client = await pool.connect();
         try {
             await client.query('BEGIN');
-            const result = await callback(new API(client));
+            const result = await callback(new Transaction(client));
             await client.query('COMMIT');
             return result;
         }

package/dist/sentry.d.ts

@@ -22,9 +22,9 @@ export declare function createSentryOptions(app: Application | null, options?: S
     release?: string | undefined;
     environment?: string | undefined;
     debug?: boolean | undefined;
-    dsn: string | undefined;
     instrumenter?: import("@sentry/types").Instrumenter | undefined;
     sampleRate?: number | undefined;
+    dsn: string | undefined;
     enabled?: boolean | undefined;
     attachStacktrace?: boolean | undefined;
     autoSessionTracking?: boolean | undefined;
@@ -32,6 +32,7 @@ export declare function createSentryOptions(app: Application | null, options?: S
     dist?: string | undefined;
     transportOptions?: Partial<import("@sentry/node/types/transports/http.js").NodeTransportOptions> | undefined;
     tracesSampleRate: number;
+    enableTracing?: boolean | undefined;
     initialScope?: import("@sentry/types").CaptureContext | undefined;
     maxBreadcrumbs?: number | undefined;
     maxValueLength?: number | undefined;
@@ -39,6 +40,7 @@ export declare function createSentryOptions(app: Application | null, options?: S
     normalizeMaxBreadth?: number | undefined;
     shutdownTimeout?: number | undefined;
     ignoreErrors?: (string | RegExp)[] | undefined;
+    ignoreTransactions?: (string | RegExp)[] | undefined;
     tunnel?: string | undefined;
     sendDefaultPii?: boolean | undefined;
     _metadata?: import("@sentry/types").SdkMetadata | undefined;
@@ -52,6 +54,7 @@ export declare function createSentryOptions(app: Application | null, options?: S
     beforeSendTransaction?: ((event: import("@sentry/types").TransactionEvent, hint: Sentry.EventHint) => Sentry.Event | PromiseLike<Sentry.Event | null> | null) | undefined;
     beforeBreadcrumb?: ((breadcrumb: Sentry.Breadcrumb, hint?: Sentry.BreadcrumbHint | undefined) => Sentry.Breadcrumb | null) | undefined;
     profilesSampleRate?: number | undefined;
+    profilesSampler?: ((samplingContext: import("@sentry/types").SamplingContext) => number | boolean) | undefined;
     serverName?: string | undefined;
     includeLocalVariables?: boolean | undefined;
     tracePropagationTargets?: import("@sentry/types").TracePropagationTargets | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -34,13 +34,13 @@
   ],
   "license": "ISC",
   "devDependencies": {
-    "@devmoods/eslint-config": "^1.0.0",
-    "@types/node": "18.11.18",
+    "@devmoods/eslint-config": "^1.1.0",
+    "@types/node": "20.2.5",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
     "chalk": "^5.2.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.41.0",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.32.2",
@@ -48,26 +48,26 @@
     "import-sort-cli": "6.0.0",
     "import-sort-style-module": "6.0.0",
     "isomorphic-fetch": "3.0.0",
-    "prettier": "2.8.3",
+    "prettier": "2.8.8",
     "supertest": "6.3.3",
     "ts-node": "10.9.1",
-    "typescript": "4.9.5",
-    "vitest": "^0.28.3"
+    "typescript": "5.0.4",
+    "vitest": "^0.31.1"
   },
   "dependencies": {
     "@devmoods/fetch": "^3.3.0",
-    "@godaddy/terminus": "^4.11.2",
-    "@sentry/node": "^7.36.0",
-    "@sentry/tracing": "^7.36.0",
+    "@godaddy/terminus": "^4.12.0",
+    "@sentry/node": "^7.53.1",
+    "@sentry/tracing": "^7.53.1",
     "@types/bcrypt": "^5.0.0",
     "@types/bunyan": "^1.8.8",
     "@types/cls-hooked": "^4.3.3",
     "@types/cookie-parser": "^1.4.3",
-    "@types/express": "^4.17.16",
-    "@types/jsonwebtoken": "^9.0.1",
-    "@types/nodemailer": "^6.4.7",
-    "@types/pg": "^8.6.6",
-    "@types/uuid": "^9.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jsonwebtoken": "^9.0.2",
+    "@types/nodemailer": "^6.4.8",
+    "@types/pg": "^8.10.1",
+    "@types/uuid": "^9.0.1",
     "ajv": "^8.12.0",
     "bcrypt": "^5.1.0",
     "bunyan": "^1.8.15",
@@ -76,12 +76,12 @@
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
-    "helmet": "^6.0.1",
+    "helmet": "^7.0.0",
     "jsonwebtoken": "^9.0.0",
-    "meow": "^11.0.0",
-    "nodemailer": "^6.9.1",
-    "pg": "^8.9.0",
-    "redis": "^4.6.4",
+    "meow": "^12.0.1",
+    "nodemailer": "^6.9.3",
+    "pg": "^8.11.0",
+    "redis": "^4.6.6",
     "sql-template-strings": "^2.2.2",
     "uuid": "^9.0.0"
   },

package/dist/__tests__/__migrations__/1_test.d.ts

@@ -1,2 +0,0 @@
-export declare function up(query: any): Promise<void>;
-export declare function down(query: any): Promise<void>;

package/dist/__tests__/__migrations__/1_test.js

@@ -1,7 +0,0 @@
-// Generated Fri Feb 03 2023 07:32:26 GMT+0100 (Central European Standard Time)
-export async function up(query) {
-    await query('SELECT 1');
-}
-export async function down(query) {
-    await query('SELECT 1');
-}