@yamato-daiwa/express-extensions 0.2.0 → 0.3.0

package/Distributable/RequestBody/parseAndValidateJSON_RequestBody.d.ts

@@ -1,5 +1,6 @@
 import { RawObjectDataProcessor, type ReadonlyParsedJSON } from "@yamato-daiwa/es-extensions";
-export declare function parseAndValidateJSON_RequestBody<RequestData extends ReadonlyParsedJSON>(settings: Readonly<{
+export declare function parseAndValidateJSON_RequestBody<RequestData extends ReadonlyParsedJSON>({ requestBodySizeLimit__bytesPackageFormat, validationAndProcessing, mustLogDataAfterParsing }: Readonly<{
     requestBodySizeLimit__bytesPackageFormat: string | number;
     validationAndProcessing: RawObjectDataProcessor.ObjectDataSpecification;
+    mustLogDataAfterParsing?: boolean;
 }>): (request: unknown, response: unknown, toNextMiddleware: (error?: unknown) => void) => void;

package/Distributable/RequestBody/parseAndValidateJSON_RequestBody.js

@@ -6,16 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseAndValidateJSON_RequestBody = parseAndValidateJSON_RequestBody;
 const body_parser_1 = __importDefault(require("body-parser"));
 const es_extensions_1 = require("@yamato-daiwa/es-extensions");
-function parseAndValidateJSON_RequestBody(settings) {
+function parseAndValidateJSON_RequestBody({ requestBodySizeLimit__bytesPackageFormat, validationAndProcessing, mustLogDataAfterParsing = false }) {
     return (_request, _response, toNextMiddleware) => {
         const request = _request;
         const response = _response;
-        body_parser_1.default.json({ limit: settings.requestBodySizeLimit__bytesPackageFormat })(request, response, (error) => {
+        body_parser_1.default.json({ limit: requestBodySizeLimit__bytesPackageFormat })(request, response, (error) => {
             if ((0, es_extensions_1.isNeitherUndefinedNorNull)(error)) {
                 toNextMiddleware(error);
                 return;
             }
-            const requestBodyValidationAndProcessingResult = es_extensions_1.RawObjectDataProcessor.process(request.body, settings.validationAndProcessing);
+            es_extensions_1.Logger.logInfo({
+                title: `${request.method.toUpperCase()}::${request.url}`,
+                description: "Parsed request body:",
+                additionalData: request.body,
+                mustOutputIf: mustLogDataAfterParsing
+            });
+            const requestBodyValidationAndProcessingResult = es_extensions_1.RawObjectDataProcessor.process(request.body, validationAndProcessing);
             if (requestBodyValidationAndProcessingResult.rawDataIsInvalid) {
                 response.
                     status(es_extensions_1.HTTP_StatusCodes.badRequest).

package/Distributable/RequestBody/validateAndProcessJSON_RequestBody.d.ts

@@ -1,3 +1,4 @@
-import { RawObjectDataProcessor } from "@yamato-daiwa/es-extensions";
-import type { ReadonlyParsedJSON } from "@yamato-daiwa/es-extensions";
-export declare function validateAndProcessJSON_RequestBody<RequestData extends ReadonlyParsedJSON>(validRequestBodySpecification: RawObjectDataProcessor.ObjectDataSpecification): (request: unknown, response: unknown, toNextMiddleware: () => void) => void;
+import { RawObjectDataProcessor, type ReadonlyParsedJSON } from "@yamato-daiwa/es-extensions";
+export declare function validateAndProcessJSON_RequestBody<RequestData extends ReadonlyParsedJSON>(validationAndProcessing: RawObjectDataProcessor.ObjectDataSpecification, { mustLogDataAfterParsing }?: Readonly<{
+    mustLogDataAfterParsing?: boolean;
+}>): (request: unknown, response: unknown, toNextMiddleware: () => void) => void;

package/Distributable/RequestBody/validateAndProcessJSON_RequestBody.js

@@ -2,24 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateAndProcessJSON_RequestBody = validateAndProcessJSON_RequestBody;
 const es_extensions_1 = require("@yamato-daiwa/es-extensions");
-function validateAndProcessJSON_RequestBody(validRequestBodySpecification) {
-    return (request, response, toNextMiddleware) => {
-        if (!(0, es_extensions_1.isArbitraryObject)(request)) {
-            response.status(es_extensions_1.HTTP_StatusCodes.internalServerError);
-            es_extensions_1.Logger.logError({
-                errorType: es_extensions_1.InvalidParameterValueError.NAME,
-                title: es_extensions_1.InvalidParameterValueError.localization.defaultTitle,
-                description: es_extensions_1.InvalidParameterValueError.localization.generateDescription({
-                    parameterName: "request",
-                    parameterNumber: 1,
-                    messageSpecificPart: `The "request" is not object and has type "${typeof request}"`
-                }),
-                occurrenceLocation: "validateAndProcessRequestBody -> innerFunction(request, response, toNextMiddleware)"
-            });
-            return;
-        }
+function validateAndProcessJSON_RequestBody(validationAndProcessing, { mustLogDataAfterParsing = false } = { mustLogDataAfterParsing: false }) {
+    return (_request, _response, toNextMiddleware) => {
+        const request = _request;
+        const response = _response;
+        es_extensions_1.Logger.logInfo({
+            title: `${request.method.toUpperCase()}::${request.url}`,
+            description: "Parsed request body:",
+            additionalData: request.body,
+            mustOutputIf: mustLogDataAfterParsing
+        });
         const requestBodyProcessingResult = es_extensions_1.RawObjectDataProcessor.
-            process(request.body, validRequestBodySpecification);
+            process(request.body, validationAndProcessing);
         if (requestBodyProcessingResult.rawDataIsInvalid) {
             response.
                 status(es_extensions_1.HTTP_StatusCodes.badRequest).

package/Distributable/Route.d.ts

@@ -1,2 +1,2 @@
 import { HTTP_Methods } from "fundamental-constants";
-export default function Route(HTTP_Method: HTTP_Methods, pathTemplate: string): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare function Route(HTTP_Method: HTTP_Methods, pathTemplate: string): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/Distributable/Route.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = Route;
+exports.Route = Route;
 const routing_controllers_1 = require("routing-controllers");
 const fundamental_constants_1 = require("fundamental-constants");
 const es_extensions_1 = require("@yamato-daiwa/es-extensions");

package/Distributable/index.d.ts

@@ -1,4 +1,5 @@
 export { ExpressMiddleware } from "./ExpressMiddleware";
+export { Route } from "./Route";
 export { parseAndValidateJSON_RequestBody } from "./RequestBody/parseAndValidateJSON_RequestBody";
 export { validateAndProcessJSON_RequestBody } from "./RequestBody/validateAndProcessJSON_RequestBody";
 export { saveExpressSession } from "./Session/saveExpressSession";

package/Distributable/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.disposeExpressSession = exports.saveExpressSession = exports.validateAndProcessJSON_RequestBody = exports.parseAndValidateJSON_RequestBody = exports.ExpressMiddleware = void 0;
+exports.disposeExpressSession = exports.saveExpressSession = exports.validateAndProcessJSON_RequestBody = exports.parseAndValidateJSON_RequestBody = exports.Route = exports.ExpressMiddleware = void 0;
 var ExpressMiddleware_1 = require("./ExpressMiddleware");
 Object.defineProperty(exports, "ExpressMiddleware", { enumerable: true, get: function () { return ExpressMiddleware_1.ExpressMiddleware; } });
+var Route_1 = require("./Route");
+Object.defineProperty(exports, "Route", { enumerable: true, get: function () { return Route_1.Route; } });
 var parseAndValidateJSON_RequestBody_1 = require("./RequestBody/parseAndValidateJSON_RequestBody");
 Object.defineProperty(exports, "parseAndValidateJSON_RequestBody", { enumerable: true, get: function () { return parseAndValidateJSON_RequestBody_1.parseAndValidateJSON_RequestBody; } });
 var validateAndProcessJSON_RequestBody_1 = require("./RequestBody/validateAndProcessJSON_RequestBody");

package/README.md

@@ -139,6 +139,7 @@ The wrapper for [`session.destroy(callback)`](https://www.npmjs.com/package/expr
   settings: Readonly<{
     requestBodySizeLimit__bytesPackageFormat: string | number;
     validationAndProcessing: RawObjectDataProcessor.ObjectDataSpecification;
+    mustLogDataAfterParsing?: boolean;
   }>
 ): ExpressMiddleware
 ```
@@ -161,7 +162,8 @@ The *alternative* to [class-transformer](https://github.com/typestack/class-tran
 
 ```
 <RequestData extends ReadonlyParsedJSON>(
-  validRequestBodySpecification: RawObjectDataProcessor.ObjectDataSpecification
+  validationAndProcessing: RawObjectDataProcessor.ObjectDataSpecification,
+  { mustLogDataAfterParsing = false }: Readonly<{ mustLogDataAfterParsing?: boolean; }> = { mustLogDataAfterParsing: false }
 ): ExpressMiddleware
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yamato-daiwa/express-extensions",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Additional functionality for Express.js and also \"routing-controllers\" aimed to reduce the routine code.",
   "keywords": [
     "nodejs",
@@ -34,6 +34,10 @@
     "express-session": "~1.18.0",
     "routing-controllers": "~0.11.0"
   },
+  "dependencies": {
+    "@yamato-daiwa/es-extensions": "1.7.2",
+    "fundamental-constants": "0.7.0"
+  },
   "devDependencies": {
     "@types/express-session": "1.18.1",
     "@yamato-daiwa/style_guides": "0.6.3",
@@ -49,9 +53,5 @@
     "Rebuild Distributable": "rimraf Distributable && tsc",
     "Rebuild Distributable and Realize Alpha": "npm run \"Rebuild Distributable\" && npm publish --tag alpha",
     "Rebuild Distributable and Realize RC": "npm run \"Rebuild Distributable\" && npm publish --tag rc"
-  },
-  "dependencies": {
-    "@yamato-daiwa/es-extensions": "1.7.2",
-    "fundamental-constants": "0.7.0"
   }
 }