@extk/expressive 0.5.3 → 0.5.5

package/README.md

@@ -60,9 +60,13 @@ const swaggerDoc = swaggerBuilder()
   .withServers([{ url: 'http://localhost:3000' }])
   .get();
 
-// 3. Build the Express app with sensible defaults (helmet, morgan, swagger UI)
+// 3. Build the Express app
 const app = expressiveServer()
-  .withDefaults({ path: '/api-docs', doc: swaggerDoc });
+  .withHelmet()
+  .withQs()
+  .withMorgan()
+  .withSwagger({ path: '/api-docs', doc: swaggerDoc })
+  .get();
 
 // 4. Define routes — they auto-register in the OpenAPI spec
 const { router, addRoute } = expressiveRouter({
@@ -203,7 +207,10 @@ export const loginSchema = z.object({
 import z from 'zod';
 
 const app = expressiveServer()
-  .withDefaults({
+  .withHelmet()
+  .withQs()
+  .withMorgan()
+  .withSwagger({
     doc: swaggerBuilder()
       .withInfo({ title: 'My API' })
       .withServers([{ url: 'http://localhost:3000/api' }])
@@ -211,7 +218,8 @@ const app = expressiveServer()
       .withSecuritySchemes({ auth: SWG.securitySchemes.BearerAuth() })
       .withDefaultSecurity([SWG.security('auth')])
       .get(),
-  });
+  })
+  .get();
 ```
 
 **3. Reference them in routes with `SWG.jsonSchemaRef`:**

package/dist/index.d.mts

@@ -175,7 +175,6 @@ declare class ServerBuilder {
     withMorgan(format?: string, // TODO: FormatFn
     options?: Parameters<typeof morgan>[1]): this;
     withSwagger(swagger: SwaggerOptions, ...handlers: ExpressHandler[]): this;
-    withDefaults(swagger: SwaggerOptions): express__default.Express;
 }
 
 declare class ApiError extends Error {
@@ -288,6 +287,7 @@ declare function bootstrap(container: Container): {
     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>;
+    getBasicAuthMiddleware: (basicAuthBase64: string, basicRealm?: string) => (req: express.Request, res: express.Response, next: express.NextFunction) => void;
     expressiveServer: (configs?: {
         app?: express.Express;
     }) => ServerBuilder;

package/dist/index.d.ts

@@ -175,7 +175,6 @@ declare class ServerBuilder {
     withMorgan(format?: string, // TODO: FormatFn
     options?: Parameters<typeof morgan>[1]): this;
     withSwagger(swagger: SwaggerOptions, ...handlers: ExpressHandler[]): this;
-    withDefaults(swagger: SwaggerOptions): express__default.Express;
 }
 
 declare class ApiError extends Error {
@@ -288,6 +287,7 @@ declare function bootstrap(container: Container): {
     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>;
+    getBasicAuthMiddleware: (basicAuthBase64: string, basicRealm?: string) => (req: express.Request, res: express.Response, next: express.NextFunction) => void;
     expressiveServer: (configs?: {
         app?: express.Express;
     }) => ServerBuilder;

package/dist/index.js

@@ -228,9 +228,6 @@ var ServerBuilder = class {
     }));
     return this;
   }
-  withDefaults(swagger) {
-    return this.withHelmet().withQs().withMorgan().withSwagger(swagger).get();
-  }
 };
 function buildExpressive(container, swaggerDoc) {
   return {
@@ -432,6 +429,30 @@ var buildMiddleware = (container) => {
         }
         res.status(finalError.httpStatusCode).json(new ApiErrorResponse(finalError.message, finalError.code, finalError.data));
       };
+    },
+    getBasicAuthMiddleware: (basicAuthBase64, basicRealm) => {
+      return (req, res, next) => {
+        try {
+          const token = req.header("authorization");
+          if (!token || token.indexOf("Basic ") === -1) {
+            throw new UserUnauthorizedError("Missing Authorization Header");
+          }
+          const credentials = token.split(" ")[1];
+          if (basicAuthBase64 !== credentials) {
+            throw new UserUnauthorizedError("Invalid Authentication Credentials");
+          }
+          next();
+        } catch (error) {
+          if (basicRealm) {
+            res.set("WWW-Authenticate", `Basic realm="${basicRealm}"`);
+          }
+          if (error instanceof ApiError) {
+            return next(error);
+          }
+          logger.error(error);
+          return next(new UserUnauthorizedError());
+        }
+      };
     }
   };
 };

package/dist/index.mjs

@@ -167,9 +167,6 @@ var ServerBuilder = class {
     }));
     return this;
   }
-  withDefaults(swagger) {
-    return this.withHelmet().withQs().withMorgan().withSwagger(swagger).get();
-  }
 };
 function buildExpressive(container, swaggerDoc) {
   return {
@@ -371,6 +368,30 @@ var buildMiddleware = (container) => {
         }
         res.status(finalError.httpStatusCode).json(new ApiErrorResponse(finalError.message, finalError.code, finalError.data));
       };
+    },
+    getBasicAuthMiddleware: (basicAuthBase64, basicRealm) => {
+      return (req, res, next) => {
+        try {
+          const token = req.header("authorization");
+          if (!token || token.indexOf("Basic ") === -1) {
+            throw new UserUnauthorizedError("Missing Authorization Header");
+          }
+          const credentials = token.split(" ")[1];
+          if (basicAuthBase64 !== credentials) {
+            throw new UserUnauthorizedError("Invalid Authentication Credentials");
+          }
+          next();
+        } catch (error) {
+          if (basicRealm) {
+            res.set("WWW-Authenticate", `Basic realm="${basicRealm}"`);
+          }
+          if (error instanceof ApiError) {
+            return next(error);
+          }
+          logger.error(error);
+          return next(new UserUnauthorizedError());
+        }
+      };
     }
   };
 };

package/package.json

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