@extk/expressive 0.5.2 → 0.5.4

package/dist/index.d.mts

@@ -232,6 +232,7 @@ declare class SwaggerBuilder {
     withDefaultSecurity(globalAuthMethods: AuthMethod[]): this;
     get(): SwaggerConfig;
 }
+declare function formDataSchema(schema: Schema): Content;
 declare function jsonSchema(schema: Schema): Content;
 declare function jsonSchemaRef(name: string): Content;
 declare function param(inP: Param['in'], id: string, schema: Schema, required?: boolean, description?: string, name?: string): Param;
@@ -243,6 +244,7 @@ declare const SWG: {
     pathParam: typeof pathParam;
     queryParam: typeof queryParam;
     headerParam: typeof headerParam;
+    formDataSchema: typeof formDataSchema;
     jsonSchema: typeof jsonSchema;
     jsonSchemaRef: typeof jsonSchemaRef;
     security: (name: string) => AuthMethod;
@@ -286,6 +288,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

@@ -232,6 +232,7 @@ declare class SwaggerBuilder {
     withDefaultSecurity(globalAuthMethods: AuthMethod[]): this;
     get(): SwaggerConfig;
 }
+declare function formDataSchema(schema: Schema): Content;
 declare function jsonSchema(schema: Schema): Content;
 declare function jsonSchemaRef(name: string): Content;
 declare function param(inP: Param['in'], id: string, schema: Schema, required?: boolean, description?: string, name?: string): Param;
@@ -243,6 +244,7 @@ declare const SWG: {
     pathParam: typeof pathParam;
     queryParam: typeof queryParam;
     headerParam: typeof headerParam;
+    formDataSchema: typeof formDataSchema;
     jsonSchema: typeof jsonSchema;
     jsonSchemaRef: typeof jsonSchemaRef;
     security: (name: string) => AuthMethod;
@@ -286,6 +288,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

@@ -131,6 +131,15 @@ var security = (name) => {
   }
   return securityRegistry[name];
 };
+function formDataSchema(schema) {
+  return {
+    content: {
+      "multipart/form-data": {
+        schema
+      }
+    }
+  };
+}
 function jsonSchema(schema) {
   return {
     content: {
@@ -176,6 +185,7 @@ var SWG = {
   pathParam,
   queryParam,
   headerParam,
+  formDataSchema,
   jsonSchema,
   jsonSchemaRef,
   security,
@@ -422,6 +432,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

@@ -70,6 +70,15 @@ var security = (name) => {
   }
   return securityRegistry[name];
 };
+function formDataSchema(schema) {
+  return {
+    content: {
+      "multipart/form-data": {
+        schema
+      }
+    }
+  };
+}
 function jsonSchema(schema) {
   return {
     content: {
@@ -115,6 +124,7 @@ var SWG = {
   pathParam,
   queryParam,
   headerParam,
+  formDataSchema,
   jsonSchema,
   jsonSchemaRef,
   security,
@@ -361,6 +371,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.2",
+    "version": "0.5.4",
     "type": "commonjs",
     "publishConfig": {
         "access": "public"