pg-mvc-service 2.1.0 → 2.1.1

package/src/reqestResponse/ResponseType.ts

@@ -1,549 +0,0 @@
-import { ValidateStringUtil } from "type-utils-n-daira";
-import StringUtil from "../Utils/StringUtil";
-import ReqResType, { PropertyType } from "./ReqResType";
-import { IError } from "../Service";
-
-
-
-export class ResponseType extends ReqResType {
-
-    /**
-     * Property to store response data
-     * レスポンスデータを格納するためのプロパティ
-     */
-    public Data: {[key: string]: any} = {};
-
-    /**
-     * Convert and retrieve data according to the type definition
-     * 型定義に従ってデータを変換して取得
-     * @returns {Object.<string, any>} Converted data, 変換されたデータ
-     */
-    get ResponseData(): {[key: string]: any} {
-        let data: {[key: string]: any} = {};
-        for (const [key, property] of Object.entries(this.properties)) {
-            if (key in this.Data === false) {
-                continue;
-            }
-
-            if (this.Data[key] === undefined) {
-                continue;
-            }
-
-            if (this.Data[key] === null || (property.type.replace("?", "") !== "string" && this.Data[key] === "")) {
-                data[key] = property.type.endsWith('?') ? null : undefined;
-                continue;
-            }
-
-            switch (property.type) {
-                case 'object':
-                case 'object?':
-                    data[key] = this.getObject([key]);
-                    break;
-                case 'array':
-                case 'array?':
-                    data[key] = this.getArray([key]);
-                    break;
-                case 'map':
-                case 'map?':
-                    data[key] = this.getMap([key]);
-                    break;
-                default:
-                    data[key] = this.getValue([key]);
-                    break;
-            }
-        }
-
-        return data;
-    }
-
-    /**
-     * Retrieve object type data
-     * オブジェクト型のデータを取得
-     * @param {Array.<string|number>} keys - Path to the property, プロパティへのパス
-     * @returns {Object.<string, any>} Retrieved object data, 取得されたオブジェクトデータ
-     */
-    private getObject(keys: Array<string | number>) {
-
-        let resData: {[key: string]: any} = {};
-        const data = this.getData(keys);
-
-        const objectProperty = this.getProperty(keys);
-        if (objectProperty.type !== 'object' && objectProperty.type !== 'object?') {
-            throw new Error(`getObjectメソッドでObject型以外が入力された場合はエラー\n keys: ${keys.join(',')}`);
-        }
-
-        for (const key of Object.keys(objectProperty.properties)) {
-            if (key in data === false || data[key] === undefined) {
-                continue;
-            }
-
-            const property = objectProperty.properties[key];
-            if (data[key] === null || (property.type.replace("?", "") !== "string" && data[key] === "")) {
-                resData[key] = property.type.endsWith('?') ? null : undefined;
-                continue;
-            }
-
-            switch (property.type) {
-                case 'object':
-                case 'object?':
-                    resData[key] = this.getObject([...keys, key]);
-                    break;
-                case 'array':
-                case 'array?':
-                    resData[key] = this.getArray([...keys, key]);
-                    break;
-                case 'map':
-                case 'map?':
-                    resData[key] = this.getMap([...keys, key]);
-                    break;
-                default:
-                    resData[key] = this.getValue([...keys, key]);
-                    break;
-            }
-        }
-
-        return resData;
-    }
-
-    /**
-     * Retrieve array type data
-     * 配列型のデータを取得
-     * @param {Array.<string|number>} keys - Path to the property, プロパティへのパス
-     * @returns {Array<any> | undefined} Retrieved array data, 取得された配列データ
-     */
-    private getArray(keys: Array<string | number>) {
-
-        const data = this.getData(keys);
-        if (data === undefined || Array.isArray(data) === false) {
-            return undefined;
-        }
-
-        const arrayProperty = this.getProperty(keys);
-        if (arrayProperty.type !== 'array' && arrayProperty.type !== 'array?') {
-            throw new Error(`getArrayメソッドでArray型以外が入力された場合はエラー\n keys: ${keys.join(',')}`);
-        }
-
-        let resData: Array<any> = [];
-        for (let i = 0;i < data.length; i++) {
-            switch (arrayProperty.item.type) {
-                case 'object':
-                case 'object?':
-                    resData.push(this.getObject([...keys, i]));
-                    break;
-                case 'array':
-                case 'array?':
-                    resData.push(this.getArray([...keys, i]));
-                    break;
-                case 'map':
-                case 'map?':
-                    resData.push(this.getMap([...keys, i]));
-                    break;
-                default:
-                    resData.push(this.getValue([...keys, i]));
-                    break;
-            }
-        }
-
-        return resData;
-    }
-
-        /**
-     * Retrieve array type data
-     * 配列型のデータを取得
-     * @param {Array.<string|number>} keys - Path to the property, プロパティへのパス
-     * @returns {Array<any> | undefined} Retrieved array data, 取得された配列データ
-     */
-    private getMap(keys: Array<string | number>) {
-
-        const data = this.getData(keys);
-        if (data === undefined) {
-            return undefined;
-        }
-
-        const mapProperty = this.getProperty(keys);
-        if (mapProperty.type !== 'map' && mapProperty.type !== 'map?') {
-            throw new Error(`getMapメソッドでMap型以外が入力された場合はエラー\n keys: ${keys.join(',')}`);
-        }
-
-        const mapData: {[key: string]: string | number | boolean} = {};
-        for (const [key, value] of Object.entries(data)) {
-            switch (mapProperty.mapType) {
-                case 'number':
-                    if (this.isNumber(value) === false) {
-                        continue;
-                    }
-                    mapData[key] = Number(value);
-                    break;
-                case 'string':
-                    switch (typeof value) {
-                        case 'number':
-                            mapData[key] = value.toString();
-                            break;
-                        case 'string':
-                            mapData[key] = value;
-                            break;
-                        default:
-                            continue;
-                    }
-                    case 'bool':
-                        switch (typeof value) {
-                            case 'boolean':
-                                mapData[key] = value;
-                            case 'number':
-                                if (value === 0 || value === 1) {
-                                    mapData[key] = value === 1;
-                                }
-                                break;
-                            case 'string':
-                                if (value !== 'true' && value !== 'false') {
-                                    mapData[key] = value === 'true';
-                                }
-                                break;
-                        }
-            }
-        }
-
-        return mapData;
-    }
-
-    /**
-     * Retrieve data based on the provided keys
-     * 指定されたキーに基づいてデータを取得
-     * @param {Array.<string|number>} keys - Path to the data, データへのパス
-     * @returns {any} Retrieved data, 取得されたデータ
-     */
-    private getData(keys: Array<string | number>) {
-        let data: any = this.Data;
-        for (let i = 0;i < keys.length;i++) {
-            const key = keys[i];
-            if (typeof key === 'number') {
-                data = data[key];
-                continue;
-            }
-
-            data = data[key];
-        }
-
-        return data;
-    }
-
-    /**
-     * Retrieve value based on the provided keys
-     * 指定されたキーに基づいて値を取得
-     * @param {Array.<string|number>} keys - Path to the value, 値へのパス
-     * @returns {string | number | boolean | null | undefined} Retrieved value, 取得された値
-     */
-    private getValue(keys: Array<string | number>): string | number | boolean | null | undefined {
-        const property = this.getProperty(keys);
-        const value = this.getData(keys);
-
-        if (value === null) {
-            return property.type.endsWith('?') ? null : undefined;
-        }
-
-        switch (property.type) {
-            case 'number':
-            case 'number?':
-                if (this.isNumber(value) === false) {
-                    return undefined;
-                }
-                return Number(value);
-            case 'boolean':
-            case 'boolean?':
-                switch (typeof value) {
-                    case 'boolean':
-                        return value;
-                    case 'number':
-                        if (value !== 0 && value !== 1) {
-                            return undefined;
-                        }
-                        return value === 1 ? true : false;
-                    case 'string':
-                        if (value !== 'true' && value !== 'false') {
-                            return undefined;
-                        }
-                        return value === 'true' ? true : false;
-                    default:
-                        return undefined;
-                }
-            case 'string':
-            case 'string?':
-                switch (typeof value) {
-                    case 'number':
-                        return value.toString();
-                    case 'string':
-                        return value;
-                    default:
-                        return undefined;
-                }
-            case 'uuid':
-            case 'uuid?':
-                if (StringUtil.isUUID(value)) {
-                    return value;
-                }
-                return undefined;
-            case 'mail':
-            case 'mail?':
-                if (ValidateStringUtil.isMail(value)) {
-                    return value;
-                }
-                return undefined;
-            case 'date':
-            case 'date?':
-                if (value instanceof Date) {
-                    const year = value.getFullYear();
-                    const month = String(value.getMonth() + 1).padStart(2, '0');
-                    const day = String(value.getDate()).padStart(2, '0');
-                    return `${year}-${month}-${day}`;
-                }
-
-                if (this.isYYYYMMDD(value) && this.isErrorDateTime(value) === false) {
-                    return value;
-                }
-
-                return undefined;
-            case 'time':
-            case 'time?':
-                if (this.isHHMM(value)) {
-                    return `${value}`;
-                }
-
-                if (this.isHHMMSS(value)) {
-                    return (value as string).slice(0, 5);
-                }
-
-                return undefined;
-            case 'datetime':
-            case 'datetime?':
-                if (value instanceof Date) {
-                    const year = value.getFullYear();
-                    const month = String(value.getMonth() + 1).padStart(2, '0');
-                    const day = String(value.getDate()).padStart(2, '0');
-                    const hours = String(value.getHours()).padStart(2, '0');
-                    const minutes = String(value.getMinutes()).padStart(2, '0');
-                    const seconds = String(value.getSeconds()).padStart(2, '0');
-                    return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
-                }
-
-                if (this.isYYYYMMDDhhmiss(value) && this.isErrorDateTime(value) === false) {
-                    return value.replace('T', ' ');
-                }
-
-                return undefined;
-            case 'https':
-            case 'https?':
-                if (ValidateStringUtil.isHttps(value)) {
-                    return value;
-                }
-                return undefined;
-            case 'base64':
-            case 'base64?':
-                if (ValidateStringUtil.isBase64(value)) {
-                    return value;
-                }
-                return undefined;
-            case 'enum':
-            case 'enum?':
-                if (Object.keys(property.enums).includes(value)) {
-                    return value;
-                }
-                return undefined;
-            case 'map':
-            case 'map?':
-                // if (Object.keys(property.enums).includes(value)) {
-                //     return value;
-                // }
-                return undefined;
-            default:
-                return undefined;
-        }
-    }
-
-
-    // ****************************************************************************
-    // for create swagger
-    // ****************************************************************************
-
-    /**
-     * Generates Swagger response definition
-     * Swaggerのレスポンス定義を生成します
-     * @returns {string} Swagger format response definition
-     * Swagger形式のレスポンス定義
-     */
-    public createSwagger(errorList: Array<IError>, apiCode: string): string {
-        let ymlString = `      responses:
-        '200':
-          description: 成功事レスポンス
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:`;
-
-        if (Object.keys(this.properties).length === 0) {
-            ymlString += ' {}\n';
-        } else {
-            ymlString += `\n`;
-        }
-
-        let tabCount = 9;
-        const space = '  '.repeat(tabCount);
-        for (const [key, property] of Object.entries(this.properties)) {
-
-            ymlString += `${space}${key}:\n`;
-            ymlString += `${space}  type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
-            if (property.description !== undefined) {
-                const joinSpace = `\n${space}    `;
-                ymlString += `${space}  description: |${joinSpace}${property.description.replaceAll("\n", joinSpace)}\n`;
-            }
-            switch (property.type) {
-                case 'object':
-                case 'object?':
-                    ymlString += this.makeSwaggerProperyFromObject([key], tabCount + 1);
-                    break;
-                case 'array':
-                case 'array?':
-                    ymlString += this.makeSwaggerPropertyFromArray([key], tabCount + 1);
-                    break;
-                case 'map':
-                case 'map?':
-                    ymlString += this.makeSwaggerPropertyFromDictionary([key], tabCount + 1);
-                    break;
-            }
-        }
-
-        // statusごとにグルーピング
-        const grouped: { [status: number]: IError[] } = {};
-        for (const error of errorList) {
-            if (grouped[error.status] === undefined) {
-                grouped[error.status] = [];
-            }
-            grouped[error.status].push(error);
-        }
-
-        // 出力順（存在するものだけ出す）
-        const statusOrder: Array<IError['status']> = [400, 401, 404, 409, 422, 500];
-
-        for (const status of statusOrder) {
-            const list = grouped[status];
-            if (!list || list.length === 0) { continue; }
-
-            const descIndentJoin = '\n            ';
-
-            if (list.length === 1) {
-                // 単一エラーは1行説明
-                ymlString += `        '${status}':
-          description: ${list[0].description}${list[0].code !== '' ? ` > ${apiCode}-${list[0].code}` : ''}
-`;
-            } else {
-                // 複数エラーは箇条書き
-                const bullets = list.map(e => `- ${e.description}${e.code !== '' ? ` > ${apiCode}-${e.code}` : ''}`).join(descIndentJoin);
-                ymlString += `        '${status}':
-          description: |${descIndentJoin}${bullets}
-`;
-            }
-        }
-
-        return ymlString;
-    }
-
-    /**
-     * Generates Swagger properties from object type properties
-     * オブジェクト型のプロパティからSwaggerのプロパティを生成
-     * @param {Array.<string|number>} keys - Path to the properties
-     * プロパティへのパス
-     * @returns {string} Swagger format property definition
-     * Swagger形式のプロパティ定義
-     */
-    private makeSwaggerProperyFromObject(keys: Array<string | number>, tabCount: number): string {
-
-        const objectProperty = this.getProperty(keys);
-        if (objectProperty.type !== 'object' && objectProperty.type !== 'object?') {
-            throw new Error(`makeSwaggerProperyFromObjectメソッドでObject型以外が入力された場合はエラー\n keys: ${keys.join(',')}`);
-        }
-
-        const space = '  '.repeat(tabCount);
-        let ymlString = `${space}properties:\n`;
-        for (const key of Object.keys(objectProperty.properties)) {
-            const property = objectProperty.properties[key];
-
-            ymlString += `${space}  ${key}:\n`;
-            ymlString += `${space}    type: ${this.replaceFromPropertyTypeToSwagger(property)}\n`;
-            if (property.description !== undefined) {
-                const joinSpace = `\n${space}      `;
-                ymlString += `${space}    description: |${joinSpace}${property.description.replaceAll("\n", joinSpace)}\n`;
-            }
-            switch (property.type) {
-                case 'object':
-                case 'object?':
-                    ymlString += this.makeSwaggerProperyFromObject([...keys, key], tabCount + 2);
-                    break;
-                case 'array':
-                case 'array?':
-                    ymlString += this.makeSwaggerPropertyFromArray([...keys, key], tabCount + 2);
-                    break;
-                case 'map':
-                case 'map?':
-                    ymlString += this.makeSwaggerPropertyFromDictionary([...keys, key], tabCount + 2);
-                    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 makeSwaggerPropertyFromArray(keys: Array<string | number>, tabCount: number): string {
-
-        const arrayProperty = this.getProperty(keys);
-        if (arrayProperty.type !== 'array' && arrayProperty.type !== 'array?') {
-            throw new Error(`getArrayメソッドでArray型以外が入力された場合はエラー\n keys: ${keys.join(',')}`);
-        }
-
-        const space = '  '.repeat(tabCount);
-        let ymlString = `${space}items:\n`;
-        ymlString += `${space}  type: ${this.replaceFromPropertyTypeToSwagger(arrayProperty.item)}\n`;
-        if (arrayProperty.item.description !== undefined) {
-            const joinSpace = `\n${space}    `;
-            ymlString += `${space}  description: |${joinSpace}${arrayProperty.item.description.replaceAll("\n", joinSpace)}\n`;
-        }
-        switch (arrayProperty.item.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;
-            case 'map':
-            case 'map?':
-                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;
-    }
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "lib": ["ES2021", "DOM"],
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-
-    "outDir": "./dist",
-    "rootDir": "./src",
-  },
-  "include": ["src/**/*"]
-}