pg-mvc-service 2.1.0 → 2.1.1

package/src/models/Type.ts

@@ -1,62 +0,0 @@
-import { TableModel } from "./TableModel";
-
-// column type
-export type TColumnAttribute = "primary" | "nullable" | "hasDefault" | "noDefault";
-export type TColumnType = "integer" | "real" | "string" | "uuid" |  "date" | "time" | "timestamp" | "bool" | "json" | "jsonb";
-export type TColumnArrayType = "integer[]" | "real[]" | "string[]" | "uuid[]" |  "date[]" | "time[]" | "timestamp[]" | "bool[]" | "json[]" | "jsonb[]";
-type TColumnBase = {
-    alias?: string,
-    type: TColumnType | TColumnArrayType,
-    attribute: TColumnAttribute,
-    default?: string,
-    comment?: string
-};
-
-type TStringColumn = TColumnBase & {
-    type: "string",
-    length: number,
-};
-
-type TJsonColumn = TColumnBase & {
-    type: "json" | "jsonb"
-    length?: undefined,
-    attribute: Exclude<TColumnAttribute, "primary">
-};
-
-type TBasicColumn = TColumnBase & {
-    type: Exclude<TColumnType, "string">,
-    length?: undefined,
-};
-
-type TStringArrayColumn = TColumnBase & {
-    type: "string[]",
-    length: number,
-    attribute: Exclude<TColumnAttribute, "primary">
-};
-
-type TArrayColumn = TColumnBase & {
-    type:  Exclude<TColumnArrayType, "string[]">,
-    length?: undefined,
-    attribute: Exclude<TColumnAttribute, "primary">
-};
-
-export type TColumn = TStringColumn | TJsonColumn | TBasicColumn | TStringArrayColumn | TArrayColumn;
-export type TColumnDetail = TColumn & {
-    columnName: string,
-    tableName: string,
-    expression: string
-}
-
-export type TOperator = "=" | "!=" | ">" | ">=" | "<" | "<=" | "like" | "ilike" | "h2f_like" | "h2f_ilike" | "in" | "not in" | "any" | "@>" | "&&";
-export type TColumnInfo = { model: TableModel, name: string }
-export type TQuery = {expression: string, vars?: Array<any>};
-export type TSelectExpression = { expression: string, alias: string }
-export type TAggregateFuncType = 'sum' | 'avg' | 'max' | 'min' | 'count';
-export type TCondition = string | {
-    l: string | TColumnInfo, 
-    o: TOperator, 
-    r: any | TColumnInfo
-};
-export type TNestedCondition = TCondition | ['AND' | 'OR', ...TNestedCondition[]] | TNestedCondition[];
-export type TSortKeyword = 'desc' | 'asc';
-export type TKeyFormat = 'snake' | 'lowerCamel';

package/src/models/Utils/MessageUtil.ts

@@ -1,60 +0,0 @@
-import { TColumnArrayType, TColumnType } from "../Type"
-
-export type TOptionErrorMessage = Record<TColumnType | TColumnArrayType | 'length' | 'null' | 'notInput' | 'fk' | 'find', string>;
-
-export default class MessageUtil {
-    public static readonly optionErrorMessageEnglish: TOptionErrorMessage = {
-        'string': '{name} should be entered as a string or number type.',
-        'string[]': '{name} should be entered as an array of string or number types.',
-        'uuid': '{name} should be entered as a UUID.',
-        'uuid[]': '{name} should be entered as an array of UUIDs.',
-        'integer': '{name} should be entered as a number.',
-        'integer[]': '{name} should be entered as an array of numbers.',
-        'real': '{name} should be entered as a number.',
-        'real[]': '{name} should be entered as an array of numbers.',
-        'bool': '{name} should be entered as a bool type, "true", "false", 0, or 1.',
-        'bool[]': '{name} should be entered as an array of bool types, "true", "false", 0, or 1.',
-        'date': '{name} should be entered in "YYYY-MM-DD" or "YYYY-MM-DD hh:mi:ss" format or as a Date type.',
-        'date[]': '{name} should be entered as an array of dates in "YYYY-MM-DD" or "YYYY-MM-DD hh:mi:ss" format or as Date types.',
-        'time': '{name} should be entered in "hh:mi" format or "hh:mi:ss" format.',
-        'time[]': '{name} should be entered as an array of times in "hh:mi" format or "hh:mi:ss" format.',
-        'timestamp': '{name} should be entered in "YYYY-MM-DD" format, "YYYY-MM-DD hh:mi:ss" format, "YYYY-MM-DDThh:mi:ss" format, or as a Date type.',
-        'timestamp[]': '{name} should be entered as an array of timestamps in "YYYY-MM-DD" format, "YYYY-MM-DD hh:mi:ss" format, "YYYY-MM-DDThh:mi:ss" format, or as Date types.',
-        'json': '{name} should be entered as an Object or JSON string.',
-        'json[]': '{name} should be entered as an array of Objects or JSON strings.',
-        'jsonb': '{name} should be entered as an Object or JSON string.',
-        'jsonb[]': '{name} should be entered as an array of Objects or JSON strings.',
-        'length': '{name} should be entered within {length} characters.',
-        'null': '{name} is not allowed to be null.',
-        'notInput': 'Please enter {name}.',
-        'fk': 'The value of {name} does not exist in the table.',
-        'find': 'The specified data does not exist in the table. ({pks})'
-    }
-    public static readonly optionErrorMessageJapan: TOptionErrorMessage = {
-        'string': '{name}はstringかnumberで入力してください。',
-        'string[]': '{name}はstringかnumberの配列で入力してください。',
-        'uuid': '{name}はuuidで入力してください。',
-        'uuid[]': '{name}はuuidの配列で入力してください。',
-        'integer': '{name}はnumberか半角数字のstring型で入力してください。',
-        'integer[]': '{name}はnumberか半角数字のstring型の配列で入力してください。',
-        'real': '{name}はnumberか半角数字のstring型で入力してください。',
-        'real[]': '{name}はnumberか半角数字のstring型の配列で入力してください。',
-        'bool': '{name}はbool型、"true"、"false"、0、または1で入力してください。',
-        'bool[]': '{name}はbool型、"true"、"false"、0、または1の配列で入力してください。',
-        'date': '{name}は"YYYY-MM-DD"形式、"YYYY-MM-DD hh:mi:ss"形式、またはDate型で入力してください。',
-        'date[]': '{name}は"YYYY-MM-DD"形式、"YYYY-MM-DD hh:mi:ss"形式、またはDate型の配列で入力してください。',
-        'time': '{name}は"hh:mi"形式または"hh:mi:ss"形式で入力してください。',
-        'time[]': '{name}は"hh:mi"形式または"hh:mi:ss"形式の配列で入力してください。',
-        'timestamp': '{name}は"YYYY-MM-DD"形式、"YYYY-MM-DD hh:mi:ss"形式、"YYYY-MM-DDThh:mi:ss"形式、またはDate型で入力してください。',
-        'timestamp[]': '{name}は"YYYY-MM-DD"形式、"YYYY-MM-DD hh:mi:ss"形式、"YYYY-MM-DDThh:mi:ss"形式、またはDate型の配列で入力してください。',
-        'json': '{name}はObject形またはJSON文字列で入力してください。',
-        'json[]': '{name}はObject形またはJSON文字列の配列で入力してください。',
-        'jsonb': '{name}はObject形またはJSON文字列で入力してください。',
-        'jsonb[]': '{name}はObject形またはJSON文字列の配列で入力してください。',
-        'length': '{name}は{length}文字以内で入力してください。',
-        'null': '{name}はnullを許可されていません。',
-        'notInput': '{name}を入力してください。',
-        'fk': '{name}の値がテーブルに存在しません。',
-        'find': '指定されたデータはテーブルに存在しません。({pks})'
-    }
-}

package/src/models/ValidateClient.ts

@@ -1,182 +0,0 @@
-import { UnprocessableException } from "../exceptions/Exception";
-import { TableModel } from "./TableModel";
-
-type TError = {code?: string; message?: string;};
-
-export default class ValidateClient {
-    private model: TableModel;
-    constructor(model: TableModel) {
-        this.model = model;
-    }
-    
-    public tryDate(value: any, isExcludeTime: boolean = false): Date | false {
-        if (value instanceof Date) {
-            return value;
-        } else if (typeof value !== 'string') {
-            return false;
-        }
-
-        try {
-            const [datePart, timePart] = value.split(' ');
-            const [year, month, day] = datePart.split('-').map(Number);
-            let [hours, minutes, seconds] = [0, 0, 0];
-            if (timePart !== undefined && isExcludeTime === false) {
-                [hours, minutes, seconds] = timePart.split(':').map(Number);
-            }
-
-            // 日付の整合性チェック
-            const date = new Date(year, month - 1, day, hours, minutes, seconds);
-            if (date.getFullYear() !== year || 
-                date.getMonth() + 1 !== month || 
-                date.getDate() !== day ||
-                date.getHours() !== hours ||
-                date.getMinutes() !== minutes ||
-                date.getSeconds() !== seconds
-            ) {
-                return false;
-            }
-            
-            return date;
-        } catch (ex) {
-            return false;
-        }
-    }
-
-    public validateInList(options: {[key: string]: any}, key: string, list: Array<number | string | boolean>, error?: TError) {
-        const column = this.model.getColumn(key);
-        const value = options[key];
-        if (value === undefined || value === null || value === "") {
-            return;
-        }
-        
-        if (list.includes(value) === false) {
-            const code = error?.code ?? "000";
-            let message = error?.message;
-            if (message === undefined) {
-                message = `{column} must be one of the items in the {list}. ({value})`;
-            }
-            message = message.replace('{column}', column.alias ?? column.columnName);
-            message = message.replace('{value}', value.toString());
-            message = message.replace('{list}', list.join(', '));
-            throw new UnprocessableException(code, message);
-        }
-    }
-
-    public validateUnderNow(options: {[key: string]: any}, key: string, error?: TError) {
-        const column = this.model.getColumn(key);
-        const value = options[key];
-        if (value === undefined || value === null || value === "") {
-            return;
-        }
-
-        const date = this.tryDate(value);
-        if (date === false) {
-            throw new Error("The value must be a Date or a valid date string  when using validateUnderNow.");
-        }
-
-        const now = new Date();
-        if (date > now) {
-            const code = error?.code ?? "000";
-            let message = error?.message;
-            if (message === undefined) {
-                message = `{column} should be entered on or before now. ({value})`;
-            }
-            message = message.replace('{column}', column.alias ?? column.columnName);
-            message = message.replace('{value}', value.toString());
-            throw new UnprocessableException(code, message);
-        }
-    }
-
-    public validateUnderToday(options: {[key: string]: any}, key: string, isErrorToday: boolean, error?: TError): void {
-        const column = this.model.getColumn(key);
-        const value = options[key];
-        if (value === undefined || value === null || value === "") {
-            return;
-        }
-
-        const date = this.tryDate(value);
-        if (date === false) {
-            throw new Error("The value must be a Date or a valid date string when using validateUnderToday.");
-        }
-
-        date.setHours(0);
-        date.setMinutes(0);
-        date.setSeconds(0);
-        date.setMilliseconds(0);
-
-        const today = new Date();
-        today.setHours(0);
-        today.setMinutes(0);
-        today.setSeconds(0);
-        today.setMilliseconds(isErrorToday ? 0 : 1);
-
-        if (date >= today) {
-            const code = error?.code ?? "000";
-            let message = error?.message;
-            if (message === undefined) {
-                if (isErrorToday) {
-                    message = `{column} should be entered before today. ({value})`;
-                } else {
-                    message = `{column} should be entered on or before today. ({value})`;
-                }
-            }
-            message = message.replace('{column}', column.alias ?? column.columnName);
-            message = message.replace('{value}', value.toString());
-            throw new UnprocessableException(code, message);
-        }
-    }
-
-    public validateRegExp(options: {[key: string]: any}, key: string, regExp: RegExp | string, error?: TError): void {
-        const column = this.model.getColumn(key);
-        const value = options[key];
-        if (value === undefined || value === null || value === "") {
-            return;
-        }
-
-        if (typeof value !== 'string') {
-            throw new Error("The value must be a string when using validateStringRegExp.");
-        }
-
-        if (typeof regExp === 'string') {
-            regExp = new RegExp(regExp);
-        }
-
-        if (regExp.test(value) === false) {
-            const code = error?.code ?? "000";
-            let message = error?.message;
-            if (message === undefined) {
-                message = `{column} is invalid. ({value})`;
-            }
-            message = message.replace('{column}', column.alias ?? column.columnName);
-            message = message.replace('{value}', value.toString());
-            throw new UnprocessableException(code, message);
-        }
-    }
-
-    public validatePositiveNumber(options: {[key: string]: any}, key: string, error?: TError) {
-        const column = this.model.getColumn(key);
-        const value = options[key];
-        if (value === undefined || value === null || value === "") {
-            return;
-        }
-
-        if (typeof value !== 'number' && typeof value !== 'string') {
-            throw new Error("The value must be a valid number string or number when using validatePositiveNumber.");
-        }
-
-        if (isNaN(Number(value))) {
-            throw new Error("The value must be a valid number string or number when using validatePositiveNumber.");
-        }
-
-        if (Number(value) <= 0) {
-            const code = error?.code ?? "000";
-            let message = error?.message;
-            if (message === undefined) {
-                message = `Please enter a value greater than 0 for {column}. ({value})`;
-            }
-            message = message.replace('{column}', column.alias ?? column.columnName);
-            message = message.replace('{value}', value.toString());
-            throw new UnprocessableException(code, message);
-        }
-    }
-}

package/src/reqestResponse/ReqResType.ts

@@ -1,241 +0,0 @@
-type PrimitiveKeyType = 
-'boolean' | 'date' | 'datetime' | 'time' | 'uuid' | 'mail' | 'https' | 'base64' |
-'boolean?' | 'date?' | 'datetime?' | 'time?' | 'uuid?' | 'mail?' | 'https?' | 'base64?';
-
-export type PrimitiveType = {
-    type: PrimitiveKeyType;
-    description?: string;
-};
-export type StringType = {
-    type: 'string' | 'string?';
-    description?: string;
-    maxLength?: number;
-    regExp?: RegExp;
-};
-export type NumberType = {
-    type: 'number' | 'number?';
-    description?: string;
-    max?: number;
-    min?: number;
-};
-export type ObjectType = {
-    type: 'object' | 'object?';
-    description?: string;
-    properties: {
-        [key: string]: PropertyType;
-    };
-};
-export type ArrayType = {
-    type: 'array' | 'array?';
-    description?: string;
-    item: PropertyType;
-};
-export type MapType = {
-    type: 'map' | 'map?';
-    description?: string;
-    mapType: 'string' | 'number' | 'bool';
-};
-export type EnumType = {
-    type: 'enum' | 'enum?';
-    description?: string;
-    enumType: 'string' | 'number' | 'string?' | 'number?';
-    enums: {[key: string | number]: string};
-};
-
-export type PropertyType = PrimitiveType | StringType | NumberType | ObjectType | ArrayType | EnumType | MapType;
-
-export default class ReqResType {
-
-    protected properties: { [key: string]: PropertyType; } = {};
-
-    /**
-     * Retrieve property type data
-     * プロパティ型のデータを取得
-     * @param {Array.<string|number>} keys - Path to the property, プロパティへのパス
-     * @returns {any} Retrieved property data, 取得されたプロパティデータ
-     */
-    protected getProperty(keys: Array<string | number>) {
-        if (keys.length === 0) {
-            throw new Error(`getPropertyメソッドでは1以上のkeysからしか入力を受け付けない。`);
-        }
-
-        const firstKey = keys[0];
-        let property = this.properties[firstKey];
-
-        for (let i = 1;i < keys.length;i++) {
-            const key = keys[i];
-            if (typeof key === 'number') {
-                if (property.type === 'array' || property.type === 'array?') {
-                    property = property.item;
-                    continue;
-                } else {
-                    throw new Error(`getPropertyでnumber型のINPUTにも関わらず、array以外のtypeの場合のエラー\nキー一覧：${keys.join(',')} エラーキー：${key}`);
-                }
-            }
-
-            switch (property.type) {
-                case 'array':
-                case 'array?':
-                    if (typeof key !== 'number') {
-                        throw new Error(`getPropertyでnumber型のINPUTで、array以外の場合はエラー\nキー一覧：${keys.join(',')} エラーキー：${key}`);
-                    }
-                    property = property.item;
-                    continue;
-                case 'object':
-                case 'object?':
-                    if (typeof key !== 'string') {
-                        throw new Error(`getPropertyでnumber型のINPUTで、arrayの場合はエラー\nキー一覧：${keys.join(',')} エラーキー：${key}`);
-                    }
-                    property = property.properties[key];
-                    continue;
-                default:
-                    throw new Error(`getPropertyでarray,object以外のtypeを読み込もうとしている。\nキー一覧：${keys.join(',')} エラーキー：${key}`);
-                    // property = property[key];
-                    // continue;
-            }
-        }
-
-        return property;
-    }
-    
-    /**
-     * Checks if the value is a valid date-time format
-     * 値が有効な日付時間形式かどうかを確認します
-     * @param value - 検証する値, The value to be validated
-     * @returns {boolean} - 値が有効な日付時間形式であるかどうか, Whether the value is a valid date-time format
-     */
-    protected isErrorDateTime(value: string): boolean {
-        try {
-            const [datePart, timePart] = value.split(/[ T]/);
-            const [year, month, day] = datePart.split('-').map(Number);
-            let [hour, minute, sec] = [0, 0, 0];
-            if (timePart !== undefined) {
-                [hour, minute, sec] = timePart.split(':').map(Number);
-            }
-            
-            const date = new Date(year, month - 1, day, hour, minute, sec);
-            return year !== date.getFullYear() || 
-                   month !== date.getMonth() + 1 || 
-                   day !== date.getDate() ||
-                   hour !== date.getHours() ||
-                   minute !== date.getMinutes() ||
-                   sec !== date.getSeconds()
-        } catch (error) {
-            return true;
-        }
-    }
-
-    /**
-     * Validates if the given value is in the format YYYY-MM-DD
-     * 与えられた値がYYYY-MM-DD形式であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is in the format YYYY-MM-DD, 値がYYYY-MM-DD形式であるかどうか
-     */
-    protected isYYYYMMDD(value: any) {
-        if (typeof value !== 'string') {
-            return false;
-        }
-
-        const pattern = new RegExp('^\\d{4}-\\d{2}-\\d{2}$');
-        return pattern.test(value);
-    }
-
-    /**
-     * Validates if the given value is in the format YYYY-MM-DD hh:mm:ss
-     * 与えられた値がYYYY-MM-DD hh:mm:ss形式であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is in the format YYYY-MM-DD hh:mm:ss, 値がYYYY-MM-DD hh:mm:ss形式であるかどうか
-     */
-    protected isYYYYMMDDhhmiss(value: any) {
-        if (typeof value !== 'string') {
-            return false;
-        }
-
-        const pattern = new RegExp('^\\d{4}-\\d{2}-\\d{2}[ T]\\d{2}:\\d{2}:\\d{2}$');
-        return pattern.test(value);
-    }
-
-    /**
-     * Validates if the given value is in the format YYYY-MM-DD hh:mm
-     * 与えられた値がYYYY-MM-DD hh:mm形式であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is in the format YYYY-MM-DD hh:mm, 値がYYYY-MM-DD hh:mm形式であるかどうか
-     */
-    protected isYYYYMMDDhhmi(value: any) {
-        if (typeof value !== 'string') {
-            return false;
-        }
-
-        const pattern = new RegExp('^\\d{4}-\\d{2}-\\d{2}[ T]\\d{2}:\\d{2}$');
-        return pattern.test(value);
-    }
-
-    /**
-     * Validates if the given value is in the format YYYY-MM-DD hh:mm:ss
-     * 与えられた値がYYYY-MM-DD hh:mm:ss形式であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is in the format YYYY-MM-DD hh:mm:ss, 値がYYYY-MM-DD hh:mm:ss形式であるかどうか
-     */
-    protected isHHMM(value: any) {
-        if (typeof value !== 'string') {
-            return false;
-        }
-
-        const pattern = new RegExp('^(?:[01]\\d|2[0-3]):[0-5]\\d$');
-        return pattern.test(value);
-    }
-
-    /**
-     * Validates if the given value is in the format HH:MM:SS
-     * 与えられた値がHH:MM:SS形式であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is in the format HH:MM:SS, 値がHH:MM:SS形式であるかどうか
-     */
-    protected isHHMMSS(value: any) {
-        if (typeof value !== 'string') {
-            return false;
-        }
-
-        const pattern = new RegExp('^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$');
-        return pattern.test(value);
-    }
-
-    /**
-     * Validates if the given value is a number
-     * 与えられた値が数値であるかどうかを検証します
-     * @param value - The value to be validated, 検証する値
-     * @returns {boolean} - Whether the value is a number, 値が数値であるかどうか
-     */
-    protected isNumber(value: any) {
-        switch (typeof value) {
-            case 'string':
-                if (value == "") {
-                    return false;
-                }
-                return isNaN(Number(value)) == false;
-            case 'number':
-                return true;
-            default:
-                return false;
-        }
-    }
-
-    /**
-     * プロパティの型をSwagger形式に変換します
-     * Converts the property type to Swagger format
-     * @param {string} value - 変換する値, The value to be converted
-     * @returns {string} - Swagger形式の値, The value in Swagger format
-     */
-    protected replaceFromPropertyTypeToSwagger(property: PropertyType): string {
-        let propertyType: string = property.type;
-        if (property.type === 'enum' || property.type === 'enum?') {
-            propertyType = property.enumType;
-        } else if (property.type === 'map' || property.type === 'map?') {
-            propertyType = property.mapType;
-        }
-        propertyType = propertyType.replace('?', '');
-        propertyType = propertyType.replace('number', 'integer');
-        propertyType = propertyType.replace(/datetime|date|time|uuid|mail|https|base64/g, 'string');
-        return propertyType;
-    }
-}