pg-mvc-service 2.0.51 → 2.0.52

package/dist/reqestResponse/ReqResType.js

@@ -125,6 +125,9 @@ class ReqResType {
         if (property.type === 'enum' || property.type === 'enum?') {
             propertyType = property.enumType;
         }
+        else if (property.type === 'dictionary' || property.type === 'dictionary?') {
+            propertyType = property.dictionaryType;
+        }
         propertyType = propertyType.replace('?', '');
         propertyType = propertyType.replace('number', 'integer');
         propertyType = propertyType.replace(/datetime|date|time|uuid|mail|https|base64/g, 'string');

package/dist/reqestResponse/RequestType.js

@@ -32,7 +32,8 @@ class RequestType extends ReqResType_1.default {
             INVALID_TIME: '{property} must be a string in "hh:mi" format and a valid time. ({value})',
             INVALID_DATETIME: '{property} must be a string in "YYYY-MM-DD hh:mi:ss" or "YYYY-MM-DDThh:mi:ss" format and a valid date and time. ({value})',
             INVALID_BASE64: '{property} must be in Base64 format. ({value})',
-            INVALID_ENUM: '{property} must be in {enums}. ({value})'
+            INVALID_ENUM: '{property} must be in {enums}. ({value})',
+            INVALID_DICTIONAY: '{property} must be a valid dictionary key. ({value})',
         };
         this.ERROR_MESSAGE_JAPAN = {
             REQUIRED: '{property}は必須項目です。',
@@ -49,10 +50,32 @@ class RequestType extends ReqResType_1.default {
             INVALID_TIME: '{property}は"hh:mi"形式のstring型で入力してください。（{value}）',
             INVALID_DATETIME: '{property}は"YYYY-MM-DD hh:mi:ss"または"YYYY-MM-DDThh:mi:ss"形式のstring型で入力してください。（{value}）',
             INVALID_BASE64: '{property}はBase64形式のstring型で入力してください。（{value}）',
-            INVALID_ENUM: '{property}は{enums}のいずれかの値で入力してください。（{value}）'
+            INVALID_ENUM: '{property}は{enums}のいずれかの値で入力してください。（{value}）',
+            INVALID_DICTIONAY: '{property}は有効なKey-Value形式で入力してください。（{value}）'
         };
         this.ERROR_MESSAGE = process.env.TZ === 'Asia/Tokyo' ? this.ERROR_MESSAGE_JAPAN : this.ERROR_MESSAGE_ENGLISH;
         this.paramProperties = [];
+        // private makeSwaggerPropertyFromDictionary(keys: Array<string | number>, tabCount: number): string {
+        //     const property = this.getProperty(keys).properties;
+        //     const space = '  '.repeat(tabCount);
+        //     let ymlString = `${space}items:\n`;
+        //     ymlString += `${space}  type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
+        //     if ((property.description ?? '') !== '') {
+        //         const descJoin = `\n${space}    `;
+        //         ymlString += `${space}  description: |${descJoin}${property.description.replaceAll('\n', descJoin)}\n`;
+        //     }
+        //     switch (property.type) {
+        //         case 'object':
+        //         case 'object?':
+        //             ymlString += this.makeSwaggerProperyFromObject([...keys, 0], tabCount + 1);
+        //             break;
+        //         case 'array':
+        //         case 'array?':
+        //             ymlString += this.makeSwaggerPropertyFromArray([...keys, 0], tabCount + 1);
+        //             break;
+        //     }
+        //     return ymlString;
+        // }
     }
     get paramPath() {
         return this.paramProperties.map(property => `/{${property.key}}`).join("");
@@ -142,6 +165,7 @@ class RequestType extends ReqResType_1.default {
             "STRING_41": this.ERROR_MESSAGE.INVALID_STRING,
             "ENUM_41": this.ERROR_MESSAGE.INVALID_ENUM,
             "ENUM_42": this.ERROR_MESSAGE.INVALID_ENUM,
+            "DICTIONARY_51": this.ERROR_MESSAGE.INVALID_DICTIONAY,
             "NUMBER_91": this.ERROR_MESSAGE.INVALID_NUMBER,
             "BOOL_91": this.ERROR_MESSAGE.INVALID_BOOL,
             "BOOL_92": this.ERROR_MESSAGE.INVALID_BOOL,
@@ -252,6 +276,9 @@ class RequestType extends ReqResType_1.default {
                         }
                     }
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    break;
                 case 'enum':
                 case 'enum?':
                     this.setEnum([key], value);
@@ -363,6 +390,39 @@ class RequestType extends ReqResType_1.default {
             }
         }
     }
+    setDictionary(keys, values) {
+        // const property = this.getProperty(keys);
+        // for (let i = 0;i < values.length; i++) {
+        //     // NULL Check
+        //     if (values[i] === undefined || values[i] === null || (property.properties.type.replace("?", "") !== "string" && values[i] === "")) {
+        //         if (property.properties.type.endsWith('?')) {
+        //             this.changeBody([...keys, i], values[i] === undefined ? undefined : null);
+        //             continue;
+        //         } else {
+        //             this.throwInputError("DICTIONARY_51", [...keys, i], "");
+        //         }
+        //     }
+        //     switch (property.properties.type) {
+        //         case 'object':
+        //         case 'object?':
+        //             this.setObject([...keys, i], values[i]);
+        //             break;
+        //         case 'array':
+        //         case 'array?':
+        //             this.setArray([...keys, i], values[i]);
+        //             break;
+        //         case 'enum':
+        //         case 'enum?':
+        //             for (const value of values) {
+        //                 this.setEnum([...keys, i], value);
+        //             }
+        //             break;
+        //         default:
+        //             this.convertInput([...keys, i], values[i]);
+        //             break;
+        //     }
+        // }
+    }
     /**
      * Retrieve the property definition corresponding to the specified key path.
      * 指定されたキーパスに対応するプロパティ定義を取得します。

package/dist/reqestResponse/ResponseType.js

@@ -269,6 +269,12 @@ class ResponseType extends ReqResType_1.default {
                     return value;
                 }
                 return undefined;
+            case 'dictionary':
+            case 'dictionary?':
+                // if (Object.keys(property.enums).includes(value)) {
+                //     return value;
+                // }
+                return undefined;
             default:
                 return undefined;
         }
@@ -314,6 +320,10 @@ class ResponseType extends ReqResType_1.default {
                 case 'array?':
                     ymlString += this.makeSwaggerPropertyFromArray([key], tabCount + 1);
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    ymlString += this.makeSwaggerPropertyFromDictionary([key], tabCount + 1);
+                    break;
             }
         }
         return ymlString;
@@ -347,6 +357,10 @@ class ResponseType extends ReqResType_1.default {
                 case 'array?':
                     ymlString += this.makeSwaggerPropertyFromArray([...keys, key], tabCount + 2);
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    ymlString += this.makeSwaggerPropertyFromDictionary([...keys, key], tabCount + 2);
+                    break;
             }
         }
         return ymlString;
@@ -375,8 +389,26 @@ class ResponseType extends ReqResType_1.default {
             case 'array?':
                 ymlString += this.makeSwaggerPropertyFromArray([...keys, 0], tabCount + 1);
                 break;
+            case 'dictionary':
+            case 'dictionary?':
+                ymlString += this.makeSwaggerPropertyFromDictionary([...keys, 0], tabCount + 1);
+                break;
         }
         return ymlString;
     }
+    /**
+ * Generates Swagger properties from array type properties
+ * 配列型のプロパティからSwaggerのプロパティを生成
+ * @param {Array.<string|number>} keys - Path to the properties, プロパティへのパス
+ * @returns {string} Swagger format property definition, Swagger形式のプロパティ定義
+ */
+    makeSwaggerPropertyFromDictionary(keys, tabCount) {
+        const property = this.getProperty(keys);
+        const space = '  '.repeat(tabCount);
+        let ymlString = `${space}properties:\n`;
+        ymlString += `${space}  key:\n`;
+        ymlString += `${space}    type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
+        return ymlString;
+    }
 }
 exports.ResponseType = ResponseType;

package/package.json

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

package/src/reqestResponse/ReqResType.ts

@@ -1,7 +1,9 @@
+type PrimitiveKeyType = 
+'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'time' | 'uuid' | 'mail' | 'https' | 'base64' |
+'string?' | 'number?' | 'boolean?' | 'date?' | 'datetime?' | 'time?' | 'uuid?' | 'mail?' | 'https?' | 'base64?';
+
 export type PrimitiveType = {
-    type: 
-        'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'time' | 'uuid' | 'mail' | 'https' | 'base64' |
-        'string?' | 'number?' | 'boolean?' | 'date?' | 'datetime?' | 'time?' | 'uuid?' | 'mail?' | 'https?' | 'base64?';
+    type: PrimitiveKeyType;
     description?: string;
 };
 export type ObjectType = {
@@ -16,6 +18,11 @@ export type ArrayType = {
     description?: string;
     properties: PropertyType;
 };
+export type DictionaryType = {
+    type: 'dictionary' | 'dictionary?';
+    description?: string;
+    dictionaryType: 'string' | 'number' | 'string?' | 'number?';
+};
 export type EnumType = {
     type: 'enum' | 'enum?';
     description?: string;
@@ -23,7 +30,7 @@ export type EnumType = {
     enums: {[key: string | number]: string};
 };
 
-export type PropertyType = PrimitiveType | ObjectType | ArrayType | EnumType;
+export type PropertyType = PrimitiveType | ObjectType | ArrayType | EnumType | DictionaryType;
 
 export default class ReqResType {
 
@@ -161,6 +168,8 @@ export default class ReqResType {
         let propertyType: string = property.type;
         if (property.type === 'enum' || property.type === 'enum?') {
             propertyType = property.enumType;
+        } else if (property.type === 'dictionary' || property.type === 'dictionary?') {
+            propertyType = property.dictionaryType;
         }
         propertyType = propertyType.replace('?', '');
         propertyType = propertyType.replace('number', 'integer');

package/src/reqestResponse/RequestType.ts

@@ -1,5 +1,5 @@
 import { Request } from 'express';
-import ReqResType, { EnumType, PrimitiveType, PropertyType } from "./ReqResType";
+import ReqResType, { ArrayType, EnumType, PrimitiveType, PropertyType } from "./ReqResType";
 import { InputErrorException } from '../exceptions/Exception';
 import StringUtil from '../Utils/StringUtil';
 import { ValidateStringUtil } from 'type-utils-n-daira';
@@ -21,6 +21,7 @@ export interface ErrorMessageType {
     INVALID_DATETIME: string;
     INVALID_BASE64: string;
     INVALID_ENUM: string;
+    INVALID_DICTIONAY: string;
 }
 
 export class RequestType extends ReqResType {
@@ -46,7 +47,8 @@ export class RequestType extends ReqResType {
         INVALID_TIME: '{property} must be a string in "hh:mi" format and a valid time. ({value})',
         INVALID_DATETIME: '{property} must be a string in "YYYY-MM-DD hh:mi:ss" or "YYYY-MM-DDThh:mi:ss" format and a valid date and time. ({value})',
         INVALID_BASE64: '{property} must be in Base64 format. ({value})',
-        INVALID_ENUM: '{property} must be in {enums}. ({value})'
+        INVALID_ENUM: '{property} must be in {enums}. ({value})',
+        INVALID_DICTIONAY: '{property} must be a valid dictionary key. ({value})',
     }
     private readonly ERROR_MESSAGE_JAPAN: ErrorMessageType = {
         REQUIRED: '{property}は必須項目です。',
@@ -63,7 +65,8 @@ export class RequestType extends ReqResType {
         INVALID_TIME: '{property}は"hh:mi"形式のstring型で入力してください。（{value}）',
         INVALID_DATETIME: '{property}は"YYYY-MM-DD hh:mi:ss"または"YYYY-MM-DDThh:mi:ss"形式のstring型で入力してください。（{value}）',
         INVALID_BASE64: '{property}はBase64形式のstring型で入力してください。（{value}）',
-        INVALID_ENUM: '{property}は{enums}のいずれかの値で入力してください。（{value}）'
+        INVALID_ENUM: '{property}は{enums}のいずれかの値で入力してください。（{value}）',
+        INVALID_DICTIONAY: '{property}は有効なKey-Value形式で入力してください。（{value}）'
     }
     protected readonly ERROR_MESSAGE: ErrorMessageType = process.env.TZ === 'Asia/Tokyo' ? this.ERROR_MESSAGE_JAPAN : this.ERROR_MESSAGE_ENGLISH;
 
@@ -138,6 +141,7 @@ export class RequestType extends ReqResType {
         "TIME_21" | "DATETIME_21" | "DATETIME_22" | "HTTPS_21" | "BASE64_21" | 
         "REQUIRE_31" | 
         "ENUM_41" | "ENUM_42" | "NUMBER_41" | "STRING_41" |
+        "DICTIONARY_51" |
         "NUMBER_91" | "BOOL_91" | "BOOL_92" | "BOOL_93" | "STRING_91" | "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 {
@@ -170,6 +174,7 @@ export class RequestType extends ReqResType {
             "STRING_41": this.ERROR_MESSAGE.INVALID_STRING,
             "ENUM_41": this.ERROR_MESSAGE.INVALID_ENUM,
             "ENUM_42": this.ERROR_MESSAGE.INVALID_ENUM,
+            "DICTIONARY_51": this.ERROR_MESSAGE.INVALID_DICTIONAY,
             "NUMBER_91": this.ERROR_MESSAGE.INVALID_NUMBER,
             "BOOL_91": this.ERROR_MESSAGE.INVALID_BOOL,
             "BOOL_92": this.ERROR_MESSAGE.INVALID_BOOL,
@@ -280,6 +285,9 @@ export class RequestType extends ReqResType {
                         }
                     }
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    break;
                 case 'enum':
                 case 'enum?':
                     this.setEnum([key], value);
@@ -399,6 +407,42 @@ export class RequestType extends ReqResType {
         }
     }
 
+    private setDictionary(keys: Array<string | number>, values: any) {
+        // const property = this.getProperty(keys);
+        // for (let i = 0;i < values.length; i++) {
+
+        //     // NULL Check
+        //     if (values[i] === undefined || values[i] === null || (property.properties.type.replace("?", "") !== "string" && values[i] === "")) {
+        //         if (property.properties.type.endsWith('?')) {
+        //             this.changeBody([...keys, i], values[i] === undefined ? undefined : null);
+        //             continue;
+        //         } else {
+        //             this.throwInputError("DICTIONARY_51", [...keys, i], "");
+        //         }
+        //     }
+
+        //     switch (property.properties.type) {
+        //         case 'object':
+        //         case 'object?':
+        //             this.setObject([...keys, i], values[i]);
+        //             break;
+        //         case 'array':
+        //         case 'array?':
+        //             this.setArray([...keys, i], values[i]);
+        //             break;
+        //         case 'enum':
+        //         case 'enum?':
+        //             for (const value of values) {
+        //                 this.setEnum([...keys, i], value);
+        //             }
+        //             break;
+        //         default:
+        //             this.convertInput([...keys, i], values[i]);
+        //             break;
+        //     }
+        // }
+    }
+
     /**
      * Retrieve the property definition corresponding to the specified key path.
      * 指定されたキーパスに対応するプロパティ定義を取得します。
@@ -848,6 +892,33 @@ export class RequestType extends ReqResType {
 
         return ymlString;
     }
+
+    // private makeSwaggerPropertyFromDictionary(keys: Array<string | number>, tabCount: number): string {
+
+    //     const property = this.getProperty(keys).properties;
+
+    //     const space = '  '.repeat(tabCount);
+
+    //     let ymlString = `${space}items:\n`;
+    //     ymlString += `${space}  type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
+    //     if ((property.description ?? '') !== '') {
+    //         const descJoin = `\n${space}    `;
+    //         ymlString += `${space}  description: |${descJoin}${property.description.replaceAll('\n', descJoin)}\n`;
+    //     }
+
+    //     switch (property.type) {
+    //         case 'object':
+    //         case 'object?':
+    //             ymlString += this.makeSwaggerProperyFromObject([...keys, 0], tabCount + 1);
+    //             break;
+    //         case 'array':
+    //         case 'array?':
+    //             ymlString += this.makeSwaggerPropertyFromArray([...keys, 0], tabCount + 1);
+    //             break;
+    //     }
+
+    //     return ymlString;
+    // }
 }
 
 // Requestのheaderで定義されているIFをそのまま拝借

package/src/reqestResponse/ResponseType.ts

@@ -1,6 +1,6 @@
 import { ValidateStringUtil } from "type-utils-n-daira";
 import StringUtil from "../Utils/StringUtil";
-import ReqResType from "./ReqResType";
+import ReqResType, { ArrayType } from "./ReqResType";
 
 export class ResponseType extends ReqResType {
 
@@ -291,6 +291,12 @@ export class ResponseType extends ReqResType {
                     return value;
                 }
                 return undefined;
+            case 'dictionary':
+            case 'dictionary?':
+                // if (Object.keys(property.enums).includes(value)) {
+                //     return value;
+                // }
+                return undefined;
             default:
                 return undefined;
         }
@@ -343,6 +349,10 @@ export class ResponseType extends ReqResType {
                 case 'array?':
                     ymlString += this.makeSwaggerPropertyFromArray([key], tabCount + 1);
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    ymlString += this.makeSwaggerPropertyFromDictionary([key], tabCount + 1);
+                    break;
             }
         }
 
@@ -381,6 +391,10 @@ export class ResponseType extends ReqResType {
                 case 'array?':
                     ymlString += this.makeSwaggerPropertyFromArray([...keys, key], tabCount + 2);
                     break;
+                case 'dictionary':
+                case 'dictionary?':
+                    ymlString += this.makeSwaggerPropertyFromDictionary([...keys, key], tabCount + 2);
+                    break;
             }
         }
 
@@ -413,8 +427,29 @@ export class ResponseType extends ReqResType {
             case 'array?':
                 ymlString += this.makeSwaggerPropertyFromArray([...keys, 0], tabCount + 1);
                 break;
+            case 'dictionary':
+            case 'dictionary?':
+                ymlString += this.makeSwaggerPropertyFromDictionary([...keys, 0], tabCount + 1);
+                break;
         }
 
+        return ymlString;
+    }
+
+        /**
+     * Generates Swagger properties from array type properties
+     * 配列型のプロパティからSwaggerのプロパティを生成
+     * @param {Array.<string|number>} keys - Path to the properties, プロパティへのパス
+     * @returns {string} Swagger format property definition, Swagger形式のプロパティ定義
+     */
+    private makeSwaggerPropertyFromDictionary(keys: Array<string | number>, tabCount: number): string {
+
+        const property = this.getProperty(keys);
+        const space = '  '.repeat(tabCount);
+        let ymlString = `${space}properties:\n`;
+        ymlString += `${space}  key:\n`;
+        ymlString += `${space}    type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
+
         return ymlString;
     }
 }