pg-mvc-service 2.0.129 → 2.1.1

package/dist/reqestResponse/RequestType.d.ts

@@ -0,0 +1,247 @@
+import { Request } from 'express';
+import ReqResType, { EnumType, NumberType, PrimitiveType, StringType } from "./ReqResType";
+import { IError } from '../Service';
+import { Context } from 'hono';
+export interface ErrorMessageType {
+    REQUIRED: string;
+    UNNECESSARY: string;
+    INVALID_OBJECT: string;
+    INVALID_ARRAY: string;
+    INVALID_NUMBER: string;
+    INVALID_NUMBER_MIN: string;
+    INVALID_NUMBER_MAX: string;
+    INVALID_BOOL: string;
+    INVALID_STRING: string;
+    INVALID_STRING_MAX_LENGTH: string;
+    INVALID_STRING_REG_EXP: string;
+    INVALID_UUID: string;
+    INVALID_MAIL: string;
+    INVALID_HTTPS: string;
+    INVALID_DATE: string;
+    INVALID_TIME: string;
+    INVALID_DATETIME: string;
+    INVALID_BASE64: string;
+    INVALID_ENUM: string;
+    INVALID_MAP_NUMBER: string;
+    INVALID_MAP_STRING: string;
+    INVALID_MAP_BOOL: string;
+}
+export declare class RequestType extends ReqResType {
+    private readonly ERROR_MESSAGE_ENGLISH;
+    private readonly ERROR_MESSAGE_JAPAN;
+    protected readonly ERROR_MESSAGE: ErrorMessageType;
+    protected paramProperties: Array<(PrimitiveType | StringType | NumberType | EnumType) & {
+        key: string;
+    }>;
+    get paramPath(): string;
+    private params?;
+    get Params(): {
+        [key: string]: any;
+    };
+    private data?;
+    get Data(): {
+        [key: string]: any;
+    };
+    private headers?;
+    get Headers(): IncomingHttpHeaders;
+    get Authorization(): string | null;
+    setRequest(module: 'express' | 'hono', request: Request | Context): Promise<void>;
+    private createErrorMessage;
+    /**
+     * 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;
+    /**
+     * Sets the values of the request body to the class properties.
+     * リクエストボディの値をクラスのプロパティにセットします。
+     *
+     * Note: This method is implemented as a separate method rather than in the constructor.
+     * This is because if executed in the constructor, the properties of the inheriting class
+     * are not yet initialized, and the values cannot be set correctly.
+     * 注意: このメソッドはコンストラクタではなく別メソッドとして実装されています。
+     * これは、コンストラクタ内で実行すると継承先のクラスのプロパティが
+     * まだ初期化されていないため、正しく値をセットできないためです。
+     *
+     * @param {Object} body - Request body object, リクエストボディオブジェクト
+     * @throws {InputErrorException} Thrown when the input value is invalid, 入力値が不正な場合にスローされます
+     */
+    private createBody;
+    /**
+     * Sets the value for an enum type based on the specified keys.
+     * 指定されたキーに基づいて列挙型の値を設定します。
+     * @param {Array<string | number>} keys - Path to the target (array of strings or index numbers)
+     * 処理対象のパス（文字列またはインデックス番号の配列）
+     * @param {any} value - Value to be set
+     * 設定する値
+     * @throws {InputErrorException} Thrown when the type does not match
+     * 型が一致しない場合にスローされます
+     */
+    private setEnum;
+    /**
+     * Recursively processes array type values.
+     * Validates each element of the array and converts it to the appropriate type.
+     * 配列型の値を再帰的に処理します。
+     * 配列の各要素を検証し、適切な型に変換します。
+     *
+     * @param {Array<string | number>} keys - Current processing path (array of strings or index numbers)
+     * 現在の処理パス（文字列またはインデックス番号の配列）
+     * @param {any[]} values - Array to be processed
+     * 処理対象の配列
+     * @throws {InputErrorException} Thrown when the type of an array element is invalid
+     * 配列要素の型が不正な場合にスローされます
+     */
+    private setArray;
+    /**
+     * Set the value of the request body to the specified path.
+     * Automatically create intermediate objects or arrays as needed.
+     * リクエストボディの値を指定されたパスに設定します。
+     * 必要に応じて中間のオブジェクトや配列を自動的に作成します。
+     * @param {Array<string | number>} keys - Path to the destination (array of strings or index numbers)
+     * 設定先へのパス（文字列またはインデックス番号の配列）
+     * @param {any} value - Value to be set
+     * 設定する値
+     */
+    private changeBody;
+    /**
+     * Process object type values recursively.
+     * Validate object properties and convert them to appropriate types.
+     * オブジェクト型の値を再帰的に処理します。
+     * オブジェクトのプロパティを検証し、適切な型に変換します。
+     * @param {Array<string | number>} keys - Current processing path (array of strings or index numbers)
+     * 現在の処理パス（文字列またはインデックス番号の配列）
+     * @param {object} values - Object to be processed
+     * 処理対象のオブジェクト
+     * @throws {InputErrorException} Thrown when the property type is invalid
+     * プロパティの型が不正な場合にスローされます
+     */
+    private setObject;
+    /**
+     * Convert the input value based on the specified type.
+     * Throws an exception if type conversion fails.
+     * 指定された型に基づいて入力値を変換します。
+     * 型変換に失敗した場合は例外をスローします。
+     *
+     * @param {string} property - The type to convert to (e.g., 'number', 'boolean', 'string', 'date', 'time', 'datetime')
+     *                        変換する型（例: 'number', 'boolean', 'string', 'date', 'time', 'datetime'）
+     * @param {any} value - The value to convert
+     *                      変換する値
+     * @param {Array<string | number>} keys - The path to the target (array of strings or index numbers)
+     *                                        処理対象のパス（文字列またはインデックス番号の配列）
+     * @returns {any} The converted value, 変換された値
+     * @throws {InputErrorException} Thrown if type conversion fails, 型変換に失敗した場合にスローされます
+     */
+    private convertValue;
+    /**
+     * Convert the input value to the specified type.
+     * Throws an exception if type conversion fails.
+     * 入力値を指定された型に変換します。
+     * 型変換に失敗した場合は例外をスローします。
+     * @param {Array<string | number>} keys - Path to the target (array of strings or index numbers)
+     * 処理対象のパス（文字列またはインデックス番号の配列）
+     * @param {any} value - Value to be converted
+     * 変換する値
+     * @throws {InputErrorException} Thrown when type conversion fails
+     * 型変換に失敗した場合にスローされます
+     */
+    private convertInput;
+    /**
+     * Generates a Swagger YAML definition from the request body.
+     * リクエストボディからSwaggerのYAML定義を生成します。
+     * @returns {string} Swagger format YAML definition
+     * Swagger形式のYAML定義
+     */
+    createSwagger(method: string): string;
+    /**
+     * 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;
+    /**
+     * 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;
+    getInputErrorList(method: string): Array<IError>;
+    private getErrorObject;
+    private getErrorArray;
+    private getError;
+}
+export interface IncomingHttpHeaders extends NodeJS.Dict<string | string[]> {
+    accept?: string | undefined;
+    "accept-language"?: string | undefined;
+    "accept-patch"?: string | undefined;
+    "accept-ranges"?: string | undefined;
+    "access-control-allow-credentials"?: string | undefined;
+    "access-control-allow-headers"?: string | undefined;
+    "access-control-allow-methods"?: string | undefined;
+    "access-control-allow-origin"?: string | undefined;
+    "access-control-expose-headers"?: string | undefined;
+    "access-control-max-age"?: string | undefined;
+    "access-control-request-headers"?: string | undefined;
+    "access-control-request-method"?: string | undefined;
+    age?: string | undefined;
+    allow?: string | undefined;
+    "alt-svc"?: string | undefined;
+    authorization?: string | undefined;
+    "cache-control"?: string | undefined;
+    connection?: string | undefined;
+    "content-disposition"?: string | undefined;
+    "content-encoding"?: string | undefined;
+    "content-language"?: string | undefined;
+    "content-length"?: string | undefined;
+    "content-location"?: string | undefined;
+    "content-range"?: string | undefined;
+    "content-type"?: string | undefined;
+    cookie?: string | undefined;
+    date?: string | undefined;
+    etag?: string | undefined;
+    expect?: string | undefined;
+    expires?: string | undefined;
+    forwarded?: string | undefined;
+    from?: string | undefined;
+    host?: string | undefined;
+    "if-match"?: string | undefined;
+    "if-modified-since"?: string | undefined;
+    "if-none-match"?: string | undefined;
+    "if-unmodified-since"?: string | undefined;
+    "last-modified"?: string | undefined;
+    location?: string | undefined;
+    origin?: string | undefined;
+    pragma?: string | undefined;
+    "proxy-authenticate"?: string | undefined;
+    "proxy-authorization"?: string | undefined;
+    "public-key-pins"?: string | undefined;
+    range?: string | undefined;
+    referer?: string | undefined;
+    "retry-after"?: string | undefined;
+    "sec-websocket-accept"?: string | undefined;
+    "sec-websocket-extensions"?: string | undefined;
+    "sec-websocket-key"?: string | undefined;
+    "sec-websocket-protocol"?: string | undefined;
+    "sec-websocket-version"?: string | undefined;
+    "set-cookie"?: string[] | undefined;
+    "strict-transport-security"?: string | undefined;
+    tk?: string | undefined;
+    trailer?: string | undefined;
+    "transfer-encoding"?: string | undefined;
+    upgrade?: string | undefined;
+    "user-agent"?: string | undefined;
+    vary?: string | undefined;
+    via?: string | undefined;
+    warning?: string | undefined;
+    "www-authenticate"?: string | undefined;
+}
+//# sourceMappingURL=RequestType.d.ts.map

package/dist/reqestResponse/RequestType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestType.d.ts","sourceRoot":"","sources":["../../src/reqestResponse/RequestType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAgB,UAAU,EAAE,MAAM,cAAc,CAAC;AAIzG,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,qBAAa,WAAY,SAAQ,UAAU;IAQvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAuBrC;IACD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAuBnC;IACD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAA2F;IAE7I,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAK;IAC7G,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,OAAO,CAAC,MAAM,CAAC,CAAuB;IACtC,IAAI,MAAM,IAAK;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAKlC;IACD,OAAO,CAAC,IAAI,CAAC,CAAuB;IACpC,IAAI,IAAI,IAAI;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAK/B;IACD,OAAO,CAAC,OAAO,CAAC,CAAsB;IACtC,IAAI,OAAO,IAAI,mBAAmB,CAKjC;IAED,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAMjC;IAEY,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC9F,OAAO,CAAC,kBAAkB;IAiH1B;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAgBvB;;;;;;;;;;;;;OAaG;YACW,UAAU;IA4LxB;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO;IA6Cf;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,QAAQ;IAuFhB;;;;;;;;;OASG;IACH,OAAO,CAAC,UAAU;IAiBlB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,SAAS;IAuGjB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,YAAY;IAqHpB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,YAAY;IAWpB;;;;;OAKG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAqGnC;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;IAiDpC;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;IA+B7B,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IA+EvD,OAAO,CAAC,cAAc;IAmFtB,OAAO,CAAC,aAAa;IAmErB,OAAO,CAAC,QAAQ;CAsKnB;AAGD,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;IACvE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,kCAAkC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxD,8BAA8B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpD,8BAA8B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpD,6BAA6B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnD,+BAA+B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrD,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,gCAAgC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtD,+BAA+B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,sBAAsB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,0BAA0B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChD,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,uBAAuB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC,2BAA2B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjD,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C"}