@devmoods/express-extras 0.20.0 → 0.21.0

package/dist/auth.d.ts

@@ -24,6 +24,14 @@ export declare function createAuth<UserModel extends Record<string, any>>({ getU
  * of `req`.
  */
 export declare function parseAuthorizationHeader(req: Request): string | null;
+/**
+ * Extract an access token from the `Request`-object.
+ *
+ * Checks multiple places and uses the first match. Priority:
+ *   1. Request header `Authorization: `
+ *   2. Cookie named `access_token`
+ */
+export declare function extractAccessTokenFromRequest(req: Request): string | null;
 export declare function setAccessTokenCookie(res: Response, token: string | null): void;
 export declare function checkIfPasswordsMatch(realPassword: string, attemptedPassword: string): Promise<boolean>;
 export declare function hashPassword(password: string): Promise<string>;

package/dist/auth.js

@@ -16,6 +16,7 @@ export function createAuthToken(payload, secret = process.env.APP_JWT_SECRET) {
 }
 export function createAuth({ getUserByToken, methods: { emailAndPassword }, filterUser = (x) => x, redis, tokenExpiry = TOKEN_EXPIRES_IN, onResetRequested, onPasswordChanged, }) {
     const useCurrentUser = () => useContext('currentUser');
+    const setCurrentUser = (user) => setContext('currentUser', user);
     const createRouter = () => {
         const router = Router();
         router.get('/me', middleware(), route(() => {
@@ -36,6 +37,8 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     const token = createAuthToken(filterUser(user));
                     await redis.set(token, '1', { EX: tokenExpiry });
                     setAccessTokenCookie(res, token);
+                    setCurrentUser(user);
+                    logger.info('access token created');
                     return [201, { token }];
                 }
                 catch (error) {
@@ -75,12 +78,14 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                 const { token } = req.params;
                 const email = await redis.get(token);
                 if (!email) {
+                    logger.info('invalid reset token', { token });
                     throw BadRequest('invalid reset token');
                 }
                 const user = await emailAndPassword(email, skipPasswordCheck);
+                setCurrentUser(user);
                 await onPasswordChanged?.(user, await hashPassword(password));
                 await redis.del(token);
-                logger.info('user changed password', { email });
+                logger.info('user changed password');
                 return 200;
             }));
         }
@@ -88,6 +93,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             const token = req.params.token;
             const email = await redis.get(token);
             if (!email) {
+                logger.info('invalid reset token', { token });
                 throw NotFound();
             }
             return 200;
@@ -110,6 +116,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     EX: TEMP_TOKEN_EXIRES_IN,
                 });
                 await onResetRequested?.(user, temporaryToken);
+                logger.info('password reset request', { email });
             }
             catch (error) {
                 logger.error(error, 'auth reset failed');
@@ -118,7 +125,6 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
         }));
         router.get('/token/refresh', middleware(false), route(async (req, res) => {
             const user = useCurrentUser();
-            logger.info('refreshed token', { user });
             if (!user) {
                 throw Unauthorized();
             }
@@ -126,6 +132,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
             const token = createAuthToken(rest);
             await redis.set(token, '1', { EX: tokenExpiry });
             setAccessTokenCookie(res, token);
+            logger.info('refreshed token', { user });
             return { token };
         }));
         return router;
@@ -143,6 +150,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                 const valid = await redis.get(token);
                 if (!valid) {
                     if (!authorize) {
+                        logger.warn('request with invalid access token');
                         return next();
                     }
                     throw new InvalidToken('token expired');
@@ -152,7 +160,7 @@ export function createAuth({ getUserByToken, methods: { emailAndPassword }, filt
                     throw new Error('Failed to decode token');
                 }
                 const user = await getUserByToken({ ...decoded });
-                setContext('currentUser', user);
+                setCurrentUser(user);
                 next();
             }
             catch (error) {
@@ -191,7 +199,14 @@ export function parseAuthorizationHeader(req) {
     }
     return token;
 }
-function extractAccessTokenFromRequest(req) {
+/**
+ * Extract an access token from the `Request`-object.
+ *
+ * Checks multiple places and uses the first match. Priority:
+ *   1. Request header `Authorization: `
+ *   2. Cookie named `access_token`
+ */
+export function extractAccessTokenFromRequest(req) {
     const authorizationHeader = parseAuthorizationHeader(req);
     if (authorizationHeader) {
         return authorizationHeader;
@@ -227,7 +242,7 @@ export async function checkIfPasswordsMatch(realPassword, attemptedPassword) {
     }
     const validPassword = await bcrypt.compare(attemptedPassword, realPassword);
     if (!validPassword) {
-        throw new Error(`Passwords does not match`);
+        throw new Error(`Passwords do not match`);
     }
     return true;
 }

package/dist/email.js

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

package/dist/listen.d.ts

@@ -9,5 +9,5 @@ import type * as http from 'node:http';
 export declare function listen(server: http.Server, options: {
     port: number;
     onShutdown?: () => void | Promise<void>;
-    healthCheck?: () => Promise<void>;
+    healthCheck?: () => Promise<unknown>;
 }): void;

package/dist/listen.js

@@ -34,13 +34,18 @@ export function listen(server, options) {
                     return false;
                 }
                 try {
-                    await options?.healthCheck?.();
+                    const meta = await options?.healthCheck?.();
+                    return {
+                        meta,
+                        timestamp: new Date().toISOString(),
+                    };
                 }
                 catch (error) {
                     logger.error(error, 'health check failed');
                     throw error;
                 }
             },
+            verbatim: true,
         },
     });
     const port = options.port;

package/dist/logger.d.ts

@@ -18,29 +18,17 @@ export declare function attachSentryClientToLoggers(sentryClient: CreateSentry['
 export declare function setGlobalLoggerContext(getContext: () => LoggerContext): void;
 export type Logger = ReturnType<typeof createLogger>;
 export declare function createLogger({ name, getContext, silent, }: LoggerOptions): {
-    debug(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    info(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    warn(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    error(error: Error | null, message?: string): void;
-    fatal(error: Error | null, message?: string): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
+    error(error: Error | null, message?: string, context?: LoggerContext): void;
+    fatal(error: Error | null, message?: string, context?: LoggerContext): void;
 };
 export declare function getLogger(name?: string): Logger;
 export declare function getLoggers(): Map<string, {
-    debug(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    info(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    warn(message: string, context?: {
-        [key: string]: any;
-    }): void;
-    error(error: Error | null, message?: string | undefined): void;
-    fatal(error: Error | null, message?: string | undefined): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
+    error(error: Error | null, message?: string | undefined, context?: LoggerContext): void;
+    fatal(error: Error | null, message?: string | undefined, context?: LoggerContext): void;
 }>;

package/dist/logger.js

@@ -1,5 +1,14 @@
-import bunyan from 'bunyan';
+import * as os from 'node:os';
 import { useRequestId } from './context.js';
+const LEVELS = {
+    TRACE: 10,
+    DEBUG: 20,
+    INFO: 30,
+    WARN: 40,
+    ERROR: 50,
+    FATAL: 60,
+};
+const LEVELS_TO_NAME = Object.fromEntries(Object.entries(LEVELS).map(([name, level]) => [level, name.toLowerCase()]));
 const _loggers = new Map();
 let _sentryClient;
 export function attachSentryClientToLoggers(sentryClient) {
@@ -19,14 +28,9 @@ export function createLogger({ name, getContext, silent = () => process.env.NODE
     if (_loggers.has(name)) {
         throw new Error(`A logger named ${name} already exists`);
     }
-    const logger = bunyan.createLogger({
-        name,
-        serializers: bunyan.stdSerializers,
-    });
-    _loggers.set(name, logger);
-    if (silent()) {
-        logger.level(bunyan.FATAL + 1);
-    }
+    const hostname = os.hostname();
+    const pid = process.pid;
+    const logLevel = silent() ? LEVELS.FATAL + 1 : LEVELS.INFO;
     function getFinalContext(context) {
         return {
             ...defaultGetContext(),
@@ -34,35 +38,57 @@ export function createLogger({ name, getContext, silent = () => process.env.NODE
             ...context,
         };
     }
-    return {
+    function log(level, message, context) {
+        const payload = JSON.stringify({
+            level: LEVELS_TO_NAME[level],
+            hostname,
+            pid,
+            message,
+            ...context,
+            time: new Date().toISOString(),
+            v: 1,
+        });
+        if (level >= logLevel) {
+            console.log(payload);
+        }
+    }
+    const api = {
         debug(message, context = {}) {
-            return logger.debug(getFinalContext(context), message);
+            return log(LEVELS.DEBUG, message, getFinalContext(context));
         },
         info(message, context = {}) {
-            return logger.info(getFinalContext(context), message);
+            return log(LEVELS.INFO, message, getFinalContext(context));
         },
         warn(message, context = {}) {
-            return logger.warn(getFinalContext(context), message);
+            return log(LEVELS.WARN, message, getFinalContext(context));
         },
-        error(error, message) {
-            const context = getFinalContext({ err: error });
+        error(error, message, context = {}) {
+            const finalContext = getFinalContext(context);
             if (_sentryClient != null) {
                 _sentryClient.captureException(error, {
-                    tags: context,
+                    tags: finalContext,
                 });
             }
-            return logger.error(context, message || error?.message);
+            return log(LEVELS.ERROR, message || error?.message || '', {
+                ...finalContext,
+                err: error?.stack,
+            });
         },
-        fatal(error, message) {
-            const context = getFinalContext({ err: error });
+        fatal(error, message, context = {}) {
+            const finalContext = getFinalContext(context);
             if (_sentryClient != null) {
                 _sentryClient.captureException(error, {
-                    tags: context,
+                    tags: finalContext,
                 });
             }
-            return logger.fatal(context, message);
+            return log(LEVELS.FATAL, message || error?.message || '', {
+                ...finalContext,
+                err: error?.stack,
+            });
         },
     };
+    _loggers.set(name, api);
+    return api;
 }
 export function getLogger(name = 'default') {
     const logger = _loggers.get(name);

package/dist/routes.d.ts

@@ -1,2 +1,2 @@
-import type { Application } from 'express';
-export declare function listRoutes(app: Application): string[];
+import type { RequestHandler, Express } from 'express';
+export declare function createDocsRouter(app: Express, extras?: Record<string, any>): RequestHandler;

package/dist/routes.js

@@ -1,41 +1,10 @@
-function split(value) {
-    if (typeof value === 'string') {
-        return value;
-    }
-    else if (value.fast_slash) {
-        return '';
-    }
-    else {
-        const match = value
-            .toString()
-            .replace('/?', '')
-            .replace('(?=/|$)', '$')
-            .match(/^\/\^((?:\\[.*+?^${}()|[\]\\/]|[^.*+?^${}()|[\]\\/])*)\$\//);
-        return match
-            ? match[1].replace(/\\(.)/g, '$1')
-            : '<complex:' + value.toString() + '>';
-    }
-}
-function getRoutesOfLayer(path, layer) {
-    if (layer.method) {
-        return [{ method: layer.method.toUpperCase(), path }];
-    }
-    else if (layer.route) {
-        return getRoutesOfLayer(path + split(layer.route.path), layer.route.stack[0]);
-    }
-    else if (layer.name === 'router' && layer.handle.stack) {
-        let routes = [];
-        layer.handle.stack.forEach(function (stackItem) {
-            routes = routes.concat(getRoutesOfLayer(path + split(layer.regexp), stackItem));
-        });
-        return routes;
-    }
-    return [];
-}
-export function listRoutes(app) {
-    const routes = [];
-    for (const layer of app._router.stack) {
-        routes.push(...getRoutesOfLayer('', layer));
-    }
-    return routes;
+import { parseExpressApp } from 'express-route-parser';
+import { route } from './middleware.js';
+export function createDocsRouter(app, extras = {}) {
+    return route(() => {
+        return {
+            ...extras,
+            routes: parseExpressApp(app),
+        };
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devmoods/express-extras",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Kubernetes-ready utilities for rapid Node.js application development",
   "type": "module",
   "main": "./dist/index.js",
@@ -8,6 +8,17 @@
   "bin": {
     "migrate": "bin/migrate"
   },
+  "scripts": {
+    "start": "ts-node --esm example/index.ts",
+    "clean": "rm -rf dist",
+    "lint": "eslint src",
+    "test": "NODE_ENV=test vitest",
+    "build": "pnpm run clean && tsc --project tsconfig.build.json",
+    "prepublishOnly": "pnpm run clean && pnpm run build",
+    "prettier": "prettier --write '**/*.{js,css,md,ts,tsx}'",
+    "import-sort": "import-sort --write '**/*.{js,jsx,ts,tsx}'",
+    "format": "pnpm run import-sort && pnpm run prettier"
+  },
   "author": {
     "name": "hanse",
     "email": "hanse@koren.im"
@@ -51,7 +62,6 @@
     "@sentry/node": "^7.60.1",
     "@types/bcrypt": "^5.0.0",
     "@types/body-parser": "^1.19.2",
-    "@types/bunyan": "^1.8.8",
     "@types/cookie-parser": "^1.4.3",
     "@types/express": "^4.17.17",
     "@types/jsonwebtoken": "^9.0.2",
@@ -61,11 +71,11 @@
     "ajv": "^8.12.0",
     "bcrypt": "^5.1.0",
     "body-parser": "^1.20.2",
-    "bunyan": "^1.8.15",
     "compose-middleware": "^5.0.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
     "express": "^4.18.2",
+    "express-route-parser": "^1.0.5",
     "helmet": "^7.0.0",
     "jsonwebtoken": "^9.0.1",
     "meow": "^12.0.1",
@@ -90,15 +100,5 @@
       "@typescript-eslint/no-shadow": "off",
       "react-hooks/rules-of-hooks": "off"
     }
-  },
-  "scripts": {
-    "start": "ts-node --esm example/index.ts",
-    "clean": "rm -rf dist",
-    "lint": "eslint src",
-    "test": "NODE_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}'",
-    "format": "pnpm run import-sort && pnpm run prettier"
   }
-}
+}