@devmoods/express-extras 0.23.0 → 0.24.0

package/README.md

@@ -44,12 +44,7 @@ FORCE_EXIT_TIMEOUT=
 
 APP_JWT_SECRET=123456
 
-PGHOST=localhost
-PGUSER=my_database
-PGPASSWORD=
-PGDATABASE=my_database_dev
-PGPORT=5432
-
+POSTGRES_URL=postgresql://user:pass@localhost:5432/my_database
 REDIS_URL=
 
 SLACK_WEBHOOK_URL=

package/dist/auth.d.ts

@@ -12,14 +12,14 @@ export interface AuthOptions<UserModel extends Record<string, any>> {
     tokenExpiry?: number;
     onPasswordResetRequest?(user: UserModel, temporaryToken: string): void | Promise<void>;
     onPasswordChanged?(user: UserModel, newPassword: string): Promise<void>;
-    onEmailVerificationRequest?(user: UserModel, verificationToken: string): Promise<void>;
+    onEmailVerificationRequest?(user: UserModel, temporaryToken: string): Promise<void>;
     onEmailVerified?(user: UserModel): Promise<void>;
 }
 export interface CreateAuth<UserModel extends Record<string, any>> {
     createRouter: () => Router;
     useCurrentUser: () => UserModel | undefined;
     middleware: (authorize?: boolean) => RequestHandler;
-    createVerificationToken(user: UserModel): Promise<string>;
+    createTemporaryToken(user: UserModel): Promise<string>;
 }
 export declare function createAuth<UserModel extends Record<string, any>>({ getUserByToken, methods: { emailAndPassword }, filterUser, redis, tokenExpiry, onPasswordResetRequest, onPasswordChanged, onEmailVerified, onEmailVerificationRequest, }: AuthOptions<UserModel>): CreateAuth<UserModel>;
 /**

package/dist/auth.js

@@ -8,10 +8,12 @@ import { BadRequest, NotFound, Unauthorized } from './errors.js';
 import { getLogger } from './logger.js';
 import { route } from './middleware.js';
 import { validateBody, validateParams, } from './validate.js';
+import { readEnv } from './utils.js';
 const logger = getLogger('auth');
-const TOKEN_EXPIRES_IN = 3600 * 48;
-const TEMP_TOKEN_EXIRES_IN = 3600;
-export function createAuthToken(payload, secret = process.env.APP_JWT_SECRET) {
+const TOKEN_EXPIRES_IN = readEnv.number('AUTH_TOKEN_EXPIRES', 3600 * 48);
+const TEMP_TOKEN_EXIRES_IN = readEnv.number('AUTH_TEMP_TOKEN_EXPIRES', 3600);
+const AUTH_SECRET = readEnv('AUTH_JWT_SECRET', '');
+export function createAuthToken(payload, secret = AUTH_SECRET) {
     return jwt.sign(payload, secret, { expiresIn: TOKEN_EXPIRES_IN });
 }
 export function createAuth({ getUserByToken, methods: { emailAndPassword }, filterUser = (x) => x, redis, tokenExpiry = TOKEN_EXPIRES_IN, onPasswordResetRequest, onPasswordChanged, onEmailVerified, onEmailVerificationRequest, }) {
@@ -92,11 +94,8 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     throw new Error('Not applicable for login method');
                 }
                 const user = await emailAndPassword(email, skipPasswordCheck);
-                const verificationToken = crypto.randomBytes(32).toString('hex');
-                await redis.set(verificationToken, user.email, {
-                    EX: TEMP_TOKEN_EXIRES_IN,
-                });
-                await onEmailVerificationRequest?.(user, verificationToken);
+                const temporaryToken = await createTemporaryToken(user);
+                await onEmailVerificationRequest?.(user, temporaryToken);
                 return 202;
             }));
             router.post('/verify-email', validateBody({
@@ -155,10 +154,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             }
             try {
                 const user = await emailAndPassword(email, skipPasswordCheck);
-                const temporaryToken = crypto.randomBytes(32).toString('hex');
-                await redis.set(temporaryToken, user.email, {
-                    EX: TEMP_TOKEN_EXIRES_IN,
-                });
+                const temporaryToken = await createTemporaryToken(user);
                 await onPasswordResetRequest?.(user, temporaryToken);
                 logger.info('password reset request', { email });
             }
@@ -199,7 +195,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     }
                     throw new InvalidToken('token expired');
                 }
-                const decoded = jwt.verify(token.trim(), process.env.APP_JWT_SECRET);
+                const decoded = jwt.verify(token.trim(), AUTH_SECRET);
                 if (typeof decoded === 'string') {
                     throw new Error('Failed to decode token');
                 }
@@ -214,7 +210,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             }
         };
     }
-    async function createVerificationToken(user) {
+    async function createTemporaryToken(user) {
         try {
             const temporaryToken = crypto.randomBytes(32).toString('hex');
             await redis.set(temporaryToken, user.email, {
@@ -231,7 +227,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
         createRouter,
         useCurrentUser,
         middleware,
-        createVerificationToken,
+        createTemporaryToken,
     };
 }
 /**

package/dist/faktory.d.ts

@@ -11,7 +11,7 @@ export declare function createJobs({ queueName }: JobsOptions): {
     };
     queueName: string;
 };
-export type Task = ReturnType<ReturnType<typeof createJobs>['job']>;
+export type Job = ReturnType<ReturnType<typeof createJobs>['job']>;
 export interface FaktoryWorkerOptions {
     jobs: unknown[];
     queueName: string;

package/dist/index.d.ts

@@ -11,5 +11,5 @@ export * from './redis.js';
 export * from './routes.js';
 export * from './sentry.js';
 export * from './slack.js';
+export * from './utils.js';
 export * from './validate.js';
-export declare const envPort: (defaultPort?: number) => number;

package/dist/index.js

@@ -11,5 +11,5 @@ export * from './redis.js';
 export * from './routes.js';
 export * from './sentry.js';
 export * from './slack.js';
+export * from './utils.js';
 export * from './validate.js';
-export const envPort = (defaultPort = 3000) => parseInt(process.env.PORT, 10) || defaultPort;

package/dist/listen.js

@@ -1,8 +1,9 @@
 import { createTerminus } from '@godaddy/terminus';
 import { getLogger } from './logger.js';
+import { readEnv } from './utils.js';
 const logger = getLogger('http');
-const READINESS_PERIOD_MS = parseInt(process.env.READINESS_PERIOD_MS || '', 10) || 0;
-const FORCE_EXIT_TIMEOUT = parseInt(process.env.FORCE_EXIT_TIMEOUT || '', 10) || 1000;
+const READINESS_PERIOD_MS = readEnv.number('READINESS_PERIOD_MS', 0);
+const FORCE_EXIT_TIMEOUT = readEnv.number('FORCE_EXIT_TIMEOUT', 5000);
 /**
  * Listen on the given port and setup proper signal
  * handlers for terminating the process properly.

package/dist/postgres.d.ts

@@ -2,6 +2,7 @@ import pg, { type PoolClient, type QueryResult, type QueryResultRow } from 'pg';
 import { SQL, type SQLStatement } from 'sql-template-strings';
 export interface PostgresOptions extends pg.PoolConfig {
     onError?: (error: Error, client: any) => void;
+    url?: pg.PoolConfig['connectionString'];
 }
 export declare class DoesNotExistError extends Error {
     constructor(message: string);
@@ -31,7 +32,7 @@ export declare class Transaction extends Connection {
  *
  * @param config
  */
-export declare function createPostgres({ onError, ...config }?: PostgresOptions): {
+export declare function createPostgres({ onError, url, ...config }?: PostgresOptions): {
     insert: <T extends pg.QueryResultRow>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<pg.QueryResult<T>>;
     query: <T_1 extends pg.QueryResultRow>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<pg.QueryResult<T_1>>;
     first: <T_2>(text: string | SQLStatement, values?: Value[] | undefined) => Promise<T_2 | null>;

package/dist/postgres.js

@@ -1,5 +1,6 @@
 import pg from 'pg';
 import { SQL } from 'sql-template-strings';
+import { readEnv } from './utils.js';
 export class DoesNotExistError extends Error {
     constructor(message) {
         super(message);
@@ -67,8 +68,8 @@ export class Transaction extends Connection {
  *
  * @param config
  */
-export function createPostgres({ onError = () => { }, ...config } = {}) {
-    const pool = new pg.Pool(config);
+export function createPostgres({ onError = () => { }, url = readEnv('POSTGRES_URL'), ...config } = {}) {
+    const pool = new pg.Pool({ connectionString: url, ...config });
     pool.on('error', onError);
     async function withConnection(callback) {
         const client = await pool.connect();

package/dist/redis.js

@@ -1,5 +1,6 @@
 import { createClient } from 'redis';
-export function createRedis({ url = process.env.REDIS_URL, onError, }) {
+import { readEnv } from './utils.js';
+export function createRedis({ url = readEnv('REDIS_URL', ''), onError, }) {
     const client = createClient({ url });
     client.on('error', onError);
     return client;

package/dist/sentry.js

@@ -1,11 +1,15 @@
 import * as Sentry from '@sentry/node';
+import { attachSentryClientToLoggers } from './logger.js';
+import { readEnv } from './utils.js';
 /**
  * Create a pre-configured Sentry client
  */
 export function createSentry(options = {}) {
+    const client = Sentry;
     return {
-        client: Sentry,
+        client,
         init(app, getOptions = (defaultOptions) => defaultOptions) {
+            attachSentryClientToLoggers(client);
             Sentry.init(getOptions(createSentryOptions(app, options)));
         },
     };
@@ -15,7 +19,7 @@ export function createSentry(options = {}) {
  */
 export function createSentryOptions(app, options = {}) {
     return {
-        dsn: process.env.SENTRY_DSN,
+        dsn: readEnv('SENTRY_DSN'),
         integrations: [
             new Sentry.Integrations.Http({ tracing: true }),
             app && new Sentry.Integrations.Express({ app }),

package/dist/setupTests.d.ts

@@ -0,0 +1 @@
+import 'dotenv/config';

package/dist/setupTests.js

@@ -0,0 +1,9 @@
+import 'dotenv/config';
+import * as crypto from 'node:crypto';
+// @ts-ignore
+import createFetchMock from 'vitest-fetch-mock';
+import { vi } from 'vitest';
+const fetchMocker = createFetchMock(vi);
+fetchMocker.enableMocks();
+// @ts-ignore
+globalThis.crypto = crypto;

package/dist/slack.js

@@ -1,5 +1,6 @@
 import { createFetch } from '@devmoods/fetch';
 import { getLogger } from './logger.js';
+import { readEnv } from './utils.js';
 const logger = getLogger('slack');
 /**
  * Send messages to Slack using Incoming Webhooks
@@ -14,7 +15,7 @@ const logger = getLogger('slack');
  *
  * See https://api.slack.com/messaging/webhooks
  */
-export function createSlack({ webhookUrl = process.env.SLACK_WEBHOOK_URL, dryRun = process.env.NODE_ENV !== 'production', } = {}) {
+export function createSlack({ webhookUrl = readEnv('SLACK_WEBHOOK_URL', ''), dryRun = process.env.NODE_ENV !== 'production', } = {}) {
     const fetch = createFetch();
     /**
      * Post a message to Slack

package/dist/utils.d.ts

@@ -5,3 +5,13 @@
 export declare function startTimer(): {
     getDuration(): number;
 };
+export declare function readEnv(key: string): string | undefined;
+export declare function readEnv(key: string, defaultValue: string): string;
+export declare namespace readEnv {
+    var number: typeof readEnvNumber;
+    var boolean: typeof readEnvBoolean;
+}
+declare function readEnvNumber(key: string, defaultValue: number): number;
+declare function readEnvBoolean(key: string, defaultValue: boolean): boolean;
+export declare const envPort: (defaultPort?: number) => number;
+export {};

package/dist/utils.js

@@ -11,3 +11,17 @@ export function startTimer() {
         },
     };
 }
+export function readEnv(key, defaultValue) {
+    const value = process.env[key];
+    return value ?? defaultValue;
+}
+readEnv.number = readEnvNumber;
+readEnv.boolean = readEnvBoolean;
+function readEnvNumber(key, defaultValue) {
+    const str = readEnv(key, `${defaultValue}`);
+    return parseFloat(str);
+}
+function readEnvBoolean(key, defaultValue) {
+    return ['true', '1', 't'].includes(readEnv(key, `${defaultValue}`).toLowerCase());
+}
+export const envPort = (defaultPort = 3000) => readEnv.number('PORT', defaultPort);

package/dist/validate.d.ts

@@ -44,7 +44,7 @@ export declare function compileValidateSchema(schema: ValidationSchema, options?
     errors: null;
 } | {
     isValid: boolean;
-    errors: never[] | {
+    errors: {
         [key: string]: any[];
     };
 };

package/dist/validate.js

@@ -45,7 +45,7 @@ export function compileValidateSchema(schema, options = {}) {
                 errors: null,
             };
         }
-        const errors = transformAjvErrors(validate.errors) || {};
+        const errors = transformAjvErrors(validate.errors);
         validate.errors = null;
         return {
             isValid: false,
@@ -65,7 +65,7 @@ export function validateSchema(data, schema, options = {}) {
             errors: null,
         };
     }
-    const errors = transformAjvErrors(ajv.errors) || {};
+    const errors = transformAjvErrors(ajv.errors);
     ajv.errors = null;
     return {
         isValid: false,
@@ -73,8 +73,9 @@ export function validateSchema(data, schema, options = {}) {
     };
 }
 function transformAjvErrors(errors) {
+    /* c8 ignore next 3 */
     if (errors == null) {
-        return [];
+        return {};
     }
     return errors
         .map((error) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -26,10 +26,11 @@
     "@devmoods/eslint-config": "^1.2.0",
     "@sentry/types": "^7.61.1",
     "@types/express-serve-static-core": "^4.17.35",
-    "@types/node": "20.4.7",
+    "@types/node": "20.4.8",
     "@types/supertest": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
+    "@vitest/coverage-v8": "^0.34.1",
     "@vitest/expect": "^0.34.1",
     "chalk": "^5.3.0",
     "eslint": "^8.46.0",
@@ -44,7 +45,8 @@
     "supertest": "6.3.3",
     "ts-node": "10.9.1",
     "typescript": "5.1.6",
-    "vitest": "^0.34.1"
+    "vitest": "^0.34.1",
+    "vitest-fetch-mock": "^0.2.2"
   },
   "dependencies": {
     "@devmoods/fetch": "^3.3.0",
@@ -101,7 +103,7 @@
     "start:worker": "ts-node --esm example/worker.ts",
     "clean": "rm -rf dist",
     "lint": "eslint src",
-    "test": "NODE_ENV=test vitest",
+    "test": "NODE_ENV=test DOTENV_CONFIG_PATH=.env.test vitest",
     "build": "pnpm run clean && tsc --project tsconfig.build.json",
     "prettier": "prettier --write '**/*.{js,css,md,ts,tsx}'",
     "import-sort": "import-sort --write '**/*.{js,jsx,ts,tsx}'",