pg-mvc-service 2.0.112 → 2.0.114

package/dist/Service.js

@@ -34,6 +34,13 @@ class Service {
     get Response() { return this.response; }
     ; // swaggerで必要なので、ここだけ宣言
     get Tags() { return this.tags; }
+    get ErrorList() {
+        return [...this.errorList, {
+                status: 500,
+                code: '',
+                description: 'サーバー内部エラー（予期せぬエラー）'
+            }];
+    }
     constructor(request, response) {
         this.method = 'GET';
         this.endpoint = '';
@@ -44,6 +51,7 @@ class Service {
         this.response = new ResponseType_1.ResponseType();
         this.isTest = process.env.NODE_ENV === 'test';
         this.tags = [];
+        this.errorList = [];
         this.dbUser = process.env.DB_USER;
         this.dbHost = process.env.DB_HOST;
         this.dbName = process.env.DB_DATABASE;

package/dist/documents/Swagger.js

@@ -59,7 +59,8 @@ const createSwagger = (services, name, url, params = []) => {
             }
         }
         yml += service.Request.createSwagger(service.Method);
-        yml += service.Response.createSwagger(service.Request.getInputErrorLost(service.Method, service.ApiCode));
+        const errorList = [...service.ErrorList, ...service.Request.getInputErrorList(service.Method, service.ApiCode)];
+        yml += service.Response.createSwagger(errorList);
         endpontSwaggerYml[service.Endpoint][service.Method] = yml;
     }
     let swaggerInfo = `openapi: 3.0.0

package/dist/reqestResponse/RequestType.js

@@ -118,15 +118,7 @@ class RequestType extends ReqResType_1.default {
         this.headers = (_b = request.headers) !== null && _b !== void 0 ? _b : {};
         this.remoteAddress = (_c = request.socket) === null || _c === void 0 ? void 0 : _c.remoteAddress;
     }
-    /**
-     * Generates an error message based on the provided code, keys, and value.
-     * 指定されたコード、キー、および値に基づいてエラーメッセージを生成します。
-     * @param {string} code - The error code. エラーコード
-     * @param {Array<string | number>} keys - The keys indicating the property path. プロパティパスを示すキー
-     * @param {any} value - The value that caused the error. エラーを引き起こした値
-     * @returns {string} The generated error message. 生成されたエラーメッセージ
-     */
-    throwInputError(code, keys, value) {
+    createErrorMessage(code, keys, value) {
         var _a, _b, _c, _d, _e;
         const list = {
             "REQUIRE_00": this.ERROR_MESSAGE.REQUIRED,
@@ -214,8 +206,25 @@ class RequestType extends ReqResType_1.default {
                 errorMessage = errorMessage.replace('{min}', ((_e = property.min) !== null && _e !== void 0 ? _e : '[未指定]').toString());
                 break;
         }
-        errorMessage = errorMessage.replace("{property}", keys.join('.')).replace("{value}", value);
-        throw new Exception_1.InputErrorException(code, errorMessage);
+        errorMessage = errorMessage.replace("{property}", keys.join('.'));
+        if (value === undefined) {
+            errorMessage = errorMessage.replace("{value}", value);
+        }
+        else {
+            errorMessage = errorMessage.replace("{value}", "");
+        }
+        return errorMessage;
+    }
+    /**
+     * Generates an error message based on the provided code, keys, and value.
+     * 指定されたコード、キー、および値に基づいてエラーメッセージを生成します。
+     * @param {string} code - The error code. エラーコード
+     * @param {Array<string | number>} keys - The keys indicating the property path. プロパティパスを示すキー
+     * @param {any} value - The value that caused the error. エラーを引き起こした値
+     * @returns {string} The generated error message. 生成されたエラーメッセージ
+     */
+    throwInputError(code, keys, value) {
+        throw new Exception_1.InputErrorException(code, this.createErrorMessage(code, keys, value));
     }
     /**
      * Sets the values of the request body to the class properties.
@@ -239,8 +248,7 @@ class RequestType extends ReqResType_1.default {
             this.data = request.body;
         }
         if (this.data === undefined) {
-            // ここは基本通ることはないと思いますが...
-            throw new Error(`リクエストBodyがundefinedです。`);
+            this.data = {};
         }
         for (const key of Object.keys(this.properties)) {
             // NULLチェック
@@ -1013,44 +1021,86 @@ class RequestType extends ReqResType_1.default {
         }
         return ymlString;
     }
-    getInputErrorLost(method, code) {
+    getInputErrorList(method, code) {
         const errorList = [];
-        if (method === 'GET' || method === 'DELETE') {
-            const tabCount = 4;
-            const space = '  '.repeat(tabCount);
-            let ymlString = '';
-            for (const [key, property] of Object.entries(this.properties)) {
-                if (property.type.endsWith('?') === false) {
+        for (const [key, property] of Object.entries(this.properties)) {
+            if (property.type.endsWith('?') === false) {
+                const errorCode = property.type === 'array' && ['GET', 'DELETE'].includes(method) ? 'REQUIRE_00' : 'REQUIRE_01';
+                errorList.push({
+                    status: 400,
+                    code: code + '-' + errorCode,
+                    description: this.createErrorMessage(errorCode, [key])
+                });
+            }
+            switch (property.type) {
+                case 'object':
+                case 'object?':
                     errorList.push({
                         status: 400,
-                        code: code + '',
-                        description: `${key}：未入力エラー（未指定、null、空文字の場合にエラー）`
+                        code: code + '-OBJECT_01',
+                        description: this.createErrorMessage('OBJECT_01', [key])
                     });
-                }
-                // ymlString += `${space}- name: ${key}\n`;
-                // ymlString += `${space}  in: query\n`;
-                // const descJoin = `\n${space}    `;
-                // if (property.type === 'enum' || property.type === 'enum?') {
-                //     ymlString += `${space}  description: |${property.description === undefined ? '' : `${descJoin}${property.description.replaceAll("\n", descJoin)}`}`;
-                //     ymlString += `${descJoin}enum list`;
-                //     ymlString += `${Object.entries(property.enums).map(([key, value]) => `${descJoin}- ${key}: ${value}`)}\n`;
-                // } else if (property.description !== undefined) {
-                //     ymlString += `${space}  description: |\n${space}    ${property.description.replaceAll("\n", descJoin)}\n`;
-                // }
-                // ymlString += `${space}  required: ${property.type.endsWith('?') ? 'false' : 'true'}\n`;
-                // ymlString += `${space}  schema:\n`;
-                // ymlString += `${space}    type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
-                // if (property.type === 'enum' || property.type === 'enum?') {
-                //     ymlString += `${space}  nullable: ${property.enumType.endsWith('?')}\n`;
-                //     ymlString += `${space}  enum:\n`;
-                //     for (const type of Object.keys(property.enumType)) {
-                //         ymlString += `${space}    - ${type}\n`;
-                //     }
-                //     if (property.enumType.endsWith('?')) {
-                //         ymlString += `${space}    - null\n`;
-                //     }
-                // }
+                    break;
+                case 'array':
+                case 'array?':
+                    errorList.push({
+                        status: 400,
+                        code: code + '-ARRAY_01',
+                        description: this.createErrorMessage('ARRAY_01', [key])
+                    });
+                    break;
+                case 'map':
+                case 'map?':
+                    switch (property.mapType) {
+                        case 'number':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_01',
+                                description: this.createErrorMessage('MAP_01', [key])
+                            });
+                            break;
+                        case 'string':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_02',
+                                description: this.createErrorMessage('MAP_02', [key])
+                            });
+                            break;
+                        case 'bool':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_03',
+                                description: this.createErrorMessage('MAP_03', [key])
+                            });
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_04',
+                                description: this.createErrorMessage('MAP_04', [key])
+                            });
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_05',
+                                description: this.createErrorMessage('MAP_05', [key])
+                            });
+                            break;
+                    }
+                    break;
+                case 'enum':
+                case 'enum?':
+                    break;
+                default:
+                    break;
             }
+            //         this.changeBody([key], mapData);
+            //         break;
+            //     case 'enum':
+            //     case 'enum?':
+            //         this.setEnum([key], value);
+            //         break;
+            //     default:
+            //         this.convertInput([key], value);
+            //         break;
+            // }
         }
         return errorList;
     }

package/dist/reqestResponse/ResponseType.js

@@ -10,7 +10,6 @@ const ReqResType_1 = __importDefault(require("./ReqResType"));
 class ResponseType extends ReqResType_1.default {
     constructor() {
         super(...arguments);
-        this.errorList = [];
         /**
          * Property to store response data
          * レスポンスデータを格納するためのプロパティ
@@ -338,7 +337,7 @@ class ResponseType extends ReqResType_1.default {
      * @returns {string} Swagger format response definition
      * Swagger形式のレスポンス定義
      */
-    createSwagger(requestErrorList) {
+    createSwagger(errorList) {
         let ymlString = `      responses:
         '200':
           description: 成功事レスポンス
@@ -376,19 +375,13 @@ class ResponseType extends ReqResType_1.default {
                     break;
             }
         }
-        const errorList = [...this.errorList, ...requestErrorList];
-        errorList.push({
-            status: 500,
-            code: '',
-            description: 'サーバー内部エラー（予期せぬエラー）'
-        });
         // statusごとにグルーピング
         const grouped = {};
-        for (const e of errorList) {
-            if (grouped[e.status] === undefined) {
-                grouped[e.status] = [];
+        for (const error of errorList) {
+            if (grouped[error.status] === undefined) {
+                grouped[error.status] = [];
             }
-            grouped[e.status].push(e);
+            grouped[error.status].push(error);
         }
         // 出力順（存在するものだけ出す）
         const statusOrder = [400, 401, 404, 409, 422, 500];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-mvc-service",
-  "version": "2.0.112",
+  "version": "2.0.114",
   "description": "",
   "homepage": "https://github.com/n-daira/npm-pack_mvc-service#readme",
   "bugs": {

package/src/Service.ts

@@ -11,6 +11,11 @@ import { EncryptClient } from './clients/EncryptClient';
 import PoolManager from './PoolManager';
 
 export type MethodType = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export interface IError {
+    status: 400 | 401 | 404 | 409 | 422 | 500, 
+    code: string;
+    description: string; 
+}
 
 export class Service {
     protected readonly method: MethodType = 'GET';
@@ -31,6 +36,14 @@ export class Service {
     protected readonly isTest: boolean = process.env.NODE_ENV === 'test';
     protected readonly tags: Array<string> = [];
     get Tags(): Array<string> { return this.tags; }
+    protected readonly errorList: Array<IError> = [];
+    get ErrorList(): Array<IError> {
+        return [...this.errorList, {
+            status: 500,
+            code: '',
+            description: 'サーバー内部エラー（予期せぬエラー）'
+        }];
+    }
 
     protected readonly req: Request;
     protected readonly res: Response;

package/src/documents/Swagger.ts

@@ -72,7 +72,8 @@ export const createSwagger = (services: Service[], name: string, url: string, pa
         }
 
         yml += service.Request.createSwagger(service.Method);
-        yml += service.Response.createSwagger(service.Request.getInputErrorLost(service.Method, service.ApiCode));
+        const errorList = [...service.ErrorList, ...service.Request.getInputErrorList(service.Method, service.ApiCode)]
+        yml += service.Response.createSwagger(errorList);
     
         endpontSwaggerYml[service.Endpoint][service.Method] = yml;
     }

package/src/reqestResponse/RequestType.ts

@@ -3,7 +3,7 @@ import ReqResType, { EnumType, NumberType, PrimitiveType, PropertyType, StringTy
 import { InputErrorException } from '../exceptions/Exception';
 import StringUtil from '../Utils/StringUtil';
 import { ValidateStringUtil } from 'type-utils-n-daira';
-import { IError } from './ResponseType';
+import { IError } from '../Service';
 
 // エラーメッセージの型定義
 export interface ErrorMessageType {
@@ -145,15 +145,7 @@ export class RequestType extends ReqResType {
         this.remoteAddress = request.socket?.remoteAddress;
     }
 
-    /**
-     * Generates an error message based on the provided code, keys, and value.
-     * 指定されたコード、キー、および値に基づいてエラーメッセージを生成します。
-     * @param {string} code - The error code. エラーコード
-     * @param {Array<string | number>} keys - The keys indicating the property path. プロパティパスを示すキー
-     * @param {any} value - The value that caused the error. エラーを引き起こした値
-     * @returns {string} The generated error message. 生成されたエラーメッセージ
-     */ 
-    private throwInputError(code: 
+    private createErrorMessage(code: 
         "REQUIRE_00" | "REQUIRE_01" | "OBJECT_01" | "ARRAY_01" | "UNNECESSARY_01" | 
         "REQUIRE_11" | "OBJECT_11" | "ARRAY_11" | "UNNECESSARY_11" |
         "NUMBER_21" | "NUMBER_22" | "NUMBER_23" | "BOOL_21" | "BOOL_22" | "BOOL_23" | "STRING_21" | "STRING_22" | "STRING_23" | "UUID_21" | "MAIL_21" | "DATE_21" | "DATE_22" |
@@ -163,8 +155,10 @@ export class RequestType extends ReqResType {
         "MAP_01" | "MAP_02" | "MAP_03" | "MAP_04" | "MAP_05" | "MAP_11" | "MAP_12" | "MAP_13" | "MAP_14" | "MAP_15" |
         "MAP_31" | "MAP_32" | "MAP_33" | "MAP_34" | "MAP_35" |
         "NUMBER_91" | "NUMBER_92" | "NUMBER_93" | "BOOL_91" | "BOOL_92" | "BOOL_93" | "STRING_91" | "STRING_92" | "STRING_93" | "UUID_91" | "MAIL_91" | "DATE_91" | "DATE_92" |
-        "TIME_91" | "DATETIME_91" | "DATETIME_92" | "HTTPS_91" | "BASE64_91"
-        , keys: Array<string | number>, value: any): never {
+        "TIME_91" | "DATETIME_91" | "DATETIME_92" | "HTTPS_91" | "BASE64_91", 
+        keys: Array<string | number>,
+        value?: any
+    ) {
         const list = {
             "REQUIRE_00": this.ERROR_MESSAGE.REQUIRED,
             "REQUIRE_01": this.ERROR_MESSAGE.REQUIRED,
@@ -253,9 +247,38 @@ export class RequestType extends ReqResType {
                 break;
         }
 
-        errorMessage = errorMessage.replace("{property}", keys.join('.')).replace("{value}", value);
+        errorMessage = errorMessage.replace("{property}", keys.join('.'));
+        if (value === undefined) {
+            errorMessage = errorMessage.replace("{value}", value);
+        } else {
+            errorMessage = errorMessage.replace("{value}", "");
+        }
+        
+        return errorMessage;
+    }
 
-        throw new InputErrorException(code, errorMessage);
+    /**
+     * Generates an error message based on the provided code, keys, and value.
+     * 指定されたコード、キー、および値に基づいてエラーメッセージを生成します。
+     * @param {string} code - The error code. エラーコード
+     * @param {Array<string | number>} keys - The keys indicating the property path. プロパティパスを示すキー
+     * @param {any} value - The value that caused the error. エラーを引き起こした値
+     * @returns {string} The generated error message. 生成されたエラーメッセージ
+     */ 
+    private throwInputError(code: 
+        "REQUIRE_00" | "REQUIRE_01" | "OBJECT_01" | "ARRAY_01" | "UNNECESSARY_01" | 
+        "REQUIRE_11" | "OBJECT_11" | "ARRAY_11" | "UNNECESSARY_11" |
+        "NUMBER_21" | "NUMBER_22" | "NUMBER_23" | "BOOL_21" | "BOOL_22" | "BOOL_23" | "STRING_21" | "STRING_22" | "STRING_23" | "UUID_21" | "MAIL_21" | "DATE_21" | "DATE_22" |
+        "TIME_21" | "DATETIME_21" | "DATETIME_22" | "HTTPS_21" | "BASE64_21" | 
+        "REQUIRE_31" | 
+        "ENUM_32" | "ENUM_41" | "ENUM_42" | "NUMBER_41" | "STRING_41" |
+        "MAP_01" | "MAP_02" | "MAP_03" | "MAP_04" | "MAP_05" | "MAP_11" | "MAP_12" | "MAP_13" | "MAP_14" | "MAP_15" |
+        "MAP_31" | "MAP_32" | "MAP_33" | "MAP_34" | "MAP_35" |
+        "NUMBER_91" | "NUMBER_92" | "NUMBER_93" | "BOOL_91" | "BOOL_92" | "BOOL_93" | "STRING_91" | "STRING_92" | "STRING_93" | "UUID_91" | "MAIL_91" | "DATE_91" | "DATE_92" |
+        "TIME_91" | "DATETIME_91" | "DATETIME_92" | "HTTPS_91" | "BASE64_91"
+        , keys: Array<string | number>, value: any): never {
+
+        throw new InputErrorException(code, this.createErrorMessage(code, keys, value));
     }
 
     /**
@@ -280,8 +303,7 @@ export class RequestType extends ReqResType {
         }
 
         if (this.data === undefined) {
-            // ここは基本通ることはないと思いますが...
-            throw new Error(`リクエストBodyがundefinedです。`);
+            this.data = {};
         }
 
         for (const key of Object.keys(this.properties)) {
@@ -1100,48 +1122,88 @@ export class RequestType extends ReqResType {
         return ymlString;
     }
 
-    public getInputErrorLost(method: string, code: string): Array<IError> {
+    public getInputErrorList(method: string, code: string): Array<IError> {
         const errorList: Array<IError> = [];
+        for (const [key, property] of Object.entries(this.properties)) {
+            if (property.type.endsWith('?') === false) {
+                const errorCode = property.type === 'array' && ['GET', 'DELETE'].includes(method) ? 'REQUIRE_00' : 'REQUIRE_01';
+                errorList.push({
+                    status: 400,
+                    code: code + '-' + errorCode,
+                    description: this.createErrorMessage(errorCode, [key])
+                });
+            }
 
-        if (method === 'GET' || method === 'DELETE') {
-
-            const tabCount = 4;
-            const space = '  '.repeat(tabCount);
-
-            let ymlString = '';
-            for (const [key, property] of Object.entries(this.properties)) {
-                if (property.type.endsWith('?') === false) {
+            switch (property.type) {
+                case 'object':
+                case 'object?':
                     errorList.push({
                         status: 400,
-                        code: code + '',
-                        description: `${key}：未入力エラー（未指定、null、空文字の場合にエラー）`
+                        code: code + '-OBJECT_01',
+                        description: this.createErrorMessage('OBJECT_01', [key])
                     });
-                }
-                // ymlString += `${space}- name: ${key}\n`;
-                // ymlString += `${space}  in: query\n`;
-
-                // const descJoin = `\n${space}    `;
-                // if (property.type === 'enum' || property.type === 'enum?') {
-                //     ymlString += `${space}  description: |${property.description === undefined ? '' : `${descJoin}${property.description.replaceAll("\n", descJoin)}`}`;
-                //     ymlString += `${descJoin}enum list`;
-                //     ymlString += `${Object.entries(property.enums).map(([key, value]) => `${descJoin}- ${key}: ${value}`)}\n`;
-                // } else if (property.description !== undefined) {
-                //     ymlString += `${space}  description: |\n${space}    ${property.description.replaceAll("\n", descJoin)}\n`;
-                // }
-                // ymlString += `${space}  required: ${property.type.endsWith('?') ? 'false' : 'true'}\n`;
-                // ymlString += `${space}  schema:\n`;
-                // ymlString += `${space}    type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
-                // if (property.type === 'enum' || property.type === 'enum?') {
-                //     ymlString += `${space}  nullable: ${property.enumType.endsWith('?')}\n`;
-                //     ymlString += `${space}  enum:\n`;
-                //     for (const type of Object.keys(property.enumType)) {
-                //         ymlString += `${space}    - ${type}\n`;
-                //     }
-                //     if (property.enumType.endsWith('?')) {
-                //         ymlString += `${space}    - null\n`;
-                //     }
-                // }
+                    break;
+                case 'array':
+                case 'array?':
+                    errorList.push({
+                        status: 400,
+                        code: code + '-ARRAY_01',
+                        description: this.createErrorMessage('ARRAY_01', [key])
+                    });
+                    break;
+                case 'map':
+                case 'map?':
+                    switch (property.mapType) {
+                        case 'number':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_01',
+                                description: this.createErrorMessage('MAP_01', [key])
+                            });
+                            break;
+                        case 'string':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_02',
+                                description: this.createErrorMessage('MAP_02', [key])
+                            });
+                            break;
+                        case 'bool':
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_03',
+                                description: this.createErrorMessage('MAP_03', [key])
+                            });
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_04',
+                                description: this.createErrorMessage('MAP_04', [key])
+                            });
+                            errorList.push({
+                                status: 400,
+                                code: code + '-MAP_05',
+                                description: this.createErrorMessage('MAP_05', [key])
+                            });
+                            break;
+                    }
+                    break;
+                case 'enum':
+                case 'enum?':
+                    break;
+                default:
+                    break;
             }
+
+            //         this.changeBody([key], mapData);
+            //         break;
+            //     case 'enum':
+            //     case 'enum?':
+            //         this.setEnum([key], value);
+            //         break;
+            //     default:
+            //         this.convertInput([key], value);
+            //         break;
+            // }
         }
 
         return errorList;

package/src/reqestResponse/ResponseType.ts

@@ -1,16 +1,11 @@
 import { ValidateStringUtil } from "type-utils-n-daira";
 import StringUtil from "../Utils/StringUtil";
 import ReqResType, { PropertyType } from "./ReqResType";
+import { IError } from "../Service";
 
-export interface IError {
-    status: 400 | 401 | 404 | 409 | 422 | 500, 
-    code: string;
-    description: string; 
-}
 
-export class ResponseType extends ReqResType {
 
-    protected readonly errorList: Array<IError> = [];
+export class ResponseType extends ReqResType {
 
     /**
      * Property to store response data
@@ -375,7 +370,7 @@ export class ResponseType extends ReqResType {
      * @returns {string} Swagger format response definition
      * Swagger形式のレスポンス定義
      */
-    public createSwagger(requestErrorList: Array<IError>): string {
+    public createSwagger(errorList: Array<IError>): string {
         let ymlString = `      responses:
         '200':
           description: 成功事レスポンス
@@ -418,20 +413,14 @@ export class ResponseType extends ReqResType {
             }
         }
 
-        const errorList: Array<IError> = [...this.errorList, ...requestErrorList];
-        errorList.push({
-            status: 500,
-            code: '',
-            description: 'サーバー内部エラー（予期せぬエラー）'
-        })
 
         // statusごとにグルーピング
         const grouped: { [status: number]: IError[] } = {};
-        for (const e of errorList) {
-            if (grouped[e.status] === undefined) {
-                grouped[e.status] = [];
+        for (const error of errorList) {
+            if (grouped[error.status] === undefined) {
+                grouped[error.status] = [];
             }
-            grouped[e.status].push(e);
+            grouped[error.status].push(error);
         }
 
         // 出力順（存在するものだけ出す）
@@ -455,7 +444,6 @@ export class ResponseType extends ReqResType {
           description: |${descIndentJoin}${bullets}
 `;
             }
-
         }
 
         return ymlString;