@extk/expressive 0.6.1 → 0.7.1

package/dist/index.d.mts

@@ -174,7 +174,7 @@ declare class ServerBuilder {
     withQs(): this;
     withMorgan(format?: string, // TODO: FormatFn
     options?: Parameters<typeof morgan>[1]): this;
-    withRoutes(routes: ExpressRoute): this;
+    withRoutes(routes: express__default.Router): this;
     /**
      * Helper function for fluent design
      */
@@ -279,6 +279,7 @@ declare class ApiErrorResponse<T = undefined> {
     readonly errorCode: string;
     readonly errors?: T;
     constructor(message: string, errorCode: string, errors?: T);
+    static fromApiError(err: ApiError): ApiErrorResponse<unknown>;
 }
 
 declare class ApiResponse<T = undefined> {
@@ -290,8 +291,10 @@ declare class ApiResponse<T = undefined> {
 declare function bootstrap(container: Container): {
     swaggerBuilder: () => SwaggerBuilder;
     silently: (fn: () => Promise<void> | void) => Promise<void>;
-    notFoundMiddleware: (_req: express.Request, res: express.Response, _next: express.NextFunction) => void;
-    getErrorHandlerMiddleware: (errorMapper?: (err: Error & Record<string, unknown>) => ApiError | null | undefined) => (err: Error & Record<string, unknown>, req: express.Request, res: express.Response, _next: express.NextFunction) => Promise<void>;
+    getGlobalNotFoundMiddleware: (content?: string) => (_req: express.Request, res: express.Response, _next: express.NextFunction) => void;
+    getApiNotFoundMiddleware: () => (req: express.Request, res: express.Response, _next: express.NextFunction) => void;
+    getApiErrorHandlerMiddleware: (errorMapper?: (err: Error & Record<string, unknown>) => ApiError | null | undefined) => (err: Error & Record<string, unknown>, req: express.Request, res: express.Response, _next: express.NextFunction) => Promise<void>;
+    getGlobalErrorHandlerMiddleware: () => (err: unknown, _req: express.Request, res: express.Response, _next: express.NextFunction) => void;
     getBasicAuthMiddleware: (basicAuthBase64: string, basicRealm?: string) => (req: express.Request, res: express.Response, next: express.NextFunction) => void;
     expressiveServer: (configs?: {
         app?: express.Express;

package/dist/index.d.ts

@@ -174,7 +174,7 @@ declare class ServerBuilder {
     withQs(): this;
     withMorgan(format?: string, // TODO: FormatFn
     options?: Parameters<typeof morgan>[1]): this;
-    withRoutes(routes: ExpressRoute): this;
+    withRoutes(routes: express__default.Router): this;
     /**
      * Helper function for fluent design
      */
@@ -279,6 +279,7 @@ declare class ApiErrorResponse<T = undefined> {
     readonly errorCode: string;
     readonly errors?: T;
     constructor(message: string, errorCode: string, errors?: T);
+    static fromApiError(err: ApiError): ApiErrorResponse<unknown>;
 }
 
 declare class ApiResponse<T = undefined> {
@@ -290,8 +291,10 @@ declare class ApiResponse<T = undefined> {
 declare function bootstrap(container: Container): {
     swaggerBuilder: () => SwaggerBuilder;
     silently: (fn: () => Promise<void> | void) => Promise<void>;
-    notFoundMiddleware: (_req: express.Request, res: express.Response, _next: express.NextFunction) => void;
-    getErrorHandlerMiddleware: (errorMapper?: (err: Error & Record<string, unknown>) => ApiError | null | undefined) => (err: Error & Record<string, unknown>, req: express.Request, res: express.Response, _next: express.NextFunction) => Promise<void>;
+    getGlobalNotFoundMiddleware: (content?: string) => (_req: express.Request, res: express.Response, _next: express.NextFunction) => void;
+    getApiNotFoundMiddleware: () => (req: express.Request, res: express.Response, _next: express.NextFunction) => void;
+    getApiErrorHandlerMiddleware: (errorMapper?: (err: Error & Record<string, unknown>) => ApiError | null | undefined) => (err: Error & Record<string, unknown>, req: express.Request, res: express.Response, _next: express.NextFunction) => Promise<void>;
+    getGlobalErrorHandlerMiddleware: () => (err: unknown, _req: express.Request, res: express.Response, _next: express.NextFunction) => void;
     getBasicAuthMiddleware: (basicAuthBase64: string, basicRealm?: string) => (req: express.Request, res: express.Response, next: express.NextFunction) => void;
     expressiveServer: (configs?: {
         app?: express.Express;

package/dist/index.js

@@ -403,16 +403,26 @@ var ApiErrorResponse = class {
     this.errorCode = errorCode;
     this.errors = errors;
   }
+  static fromApiError(err) {
+    return new this(err.message, err.code, err.data);
+  }
 };
 
 // src/middleware.ts
 var buildMiddleware = (container) => {
   const { logger, alertHandler } = container;
   return {
-    notFoundMiddleware: (_req, res, _next) => {
-      res.status(404).send("\xAF\\_(\u30C4)_/\xAF").end();
+    getGlobalNotFoundMiddleware: (content) => {
+      return (_req, res, _next) => {
+        res.status(404).send(content ?? "\xAF\\_(\u30C4)_/\xAF").end();
+      };
+    },
+    getApiNotFoundMiddleware: () => {
+      return (req, res, _next) => {
+        res.status(404).json(new ApiErrorResponse(`${req.method} ${req.path} not found`, "NOT_FOUND")).end();
+      };
     },
-    getErrorHandlerMiddleware: (errorMapper) => {
+    getApiErrorHandlerMiddleware: (errorMapper) => {
       return async (err, req, res, _next) => {
         let finalError;
         const customMappedError = errorMapper && errorMapper(err);
@@ -441,6 +451,16 @@ var buildMiddleware = (container) => {
         res.status(finalError.httpStatusCode).json(new ApiErrorResponse(finalError.message, finalError.code, finalError.data));
       };
     },
+    getGlobalErrorHandlerMiddleware: () => {
+      return (err, _req, res, _next) => {
+        logger.error(err);
+        if (err instanceof ApiError) {
+          res.status(err.httpStatusCode).send(err.message);
+        } else {
+          res.status(500).send("Something went wrong");
+        }
+      };
+    },
     getBasicAuthMiddleware: (basicAuthBase64, basicRealm) => {
       return (req, res, next) => {
         try {

package/dist/index.mjs

@@ -342,16 +342,26 @@ var ApiErrorResponse = class {
     this.errorCode = errorCode;
     this.errors = errors;
   }
+  static fromApiError(err) {
+    return new this(err.message, err.code, err.data);
+  }
 };
 
 // src/middleware.ts
 var buildMiddleware = (container) => {
   const { logger, alertHandler } = container;
   return {
-    notFoundMiddleware: (_req, res, _next) => {
-      res.status(404).send("\xAF\\_(\u30C4)_/\xAF").end();
+    getGlobalNotFoundMiddleware: (content) => {
+      return (_req, res, _next) => {
+        res.status(404).send(content ?? "\xAF\\_(\u30C4)_/\xAF").end();
+      };
+    },
+    getApiNotFoundMiddleware: () => {
+      return (req, res, _next) => {
+        res.status(404).json(new ApiErrorResponse(`${req.method} ${req.path} not found`, "NOT_FOUND")).end();
+      };
     },
-    getErrorHandlerMiddleware: (errorMapper) => {
+    getApiErrorHandlerMiddleware: (errorMapper) => {
       return async (err, req, res, _next) => {
         let finalError;
         const customMappedError = errorMapper && errorMapper(err);
@@ -380,6 +390,16 @@ var buildMiddleware = (container) => {
         res.status(finalError.httpStatusCode).json(new ApiErrorResponse(finalError.message, finalError.code, finalError.data));
       };
     },
+    getGlobalErrorHandlerMiddleware: () => {
+      return (err, _req, res, _next) => {
+        logger.error(err);
+        if (err instanceof ApiError) {
+          res.status(err.httpStatusCode).send(err.message);
+        } else {
+          res.status(500).send("Something went wrong");
+        }
+      };
+    },
     getBasicAuthMiddleware: (basicAuthBase64, basicRealm) => {
       return (req, res, next) => {
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@extk/expressive",
-    "version": "0.6.1",
+    "version": "0.7.1",
     "type": "commonjs",
     "publishConfig": {
         "access": "public"