pg-mvc-service 2.0.42 → 2.0.43

package/src/documents/Swagger.ts

@@ -1,105 +0,0 @@
-import { Service } from '../Service';
-
-
-export interface IParams {
-    in: 'header' | 'path',
-    name: string,
-    require?: boolean,
-    description?: string,
-    example?: string
-}
-
-export const createSwagger = (services: Service[], name: string, url: string, params: Array<IParams> = []): string => {
-    // *****************************************
-    // Internal method definitions
-    // *****************************************
-    function setYmlByMethod(method: string, swaggerYmlObj: {[key: string]: string}) {
-        if (method in swaggerYmlObj) {
-            swaggerInfo += `    ${method.toLowerCase()}:\n`;
-            swaggerInfo += swaggerYmlObj[method];    
-        }
-    }
-    // *****************************************
-    // Execution part
-    // *****************************************
-    const endpontSwaggerYml: {[keyEndpoint: string]: {[keyMethod: string]: string}} = {};
-    let tags: Array<string> = [];
-
-    for (const service of services) {
-        if (service.Endpoint in endpontSwaggerYml === false) {
-            endpontSwaggerYml[service.Endpoint] = {};
-        }
-        let yml = "";
-    
-        const apiTags = service.Tags;
-        if (apiTags.length > 0) {
-            tags = [ ...tags, ...apiTags];
-            yml += `      tags:\n`;
-            for (const tag of apiTags) {
-                yml += `        - ${tag}\n`;
-            }
-        }
-        yml += `      summary: ${service.Summary}\n`;
-
-        const croneParams = [...params];
-        for (const path of service.Endpoint.split('/')) {
-            if (path.startsWith('{') && path.endsWith('}')) {
-                const key = path.replace('{', '').replace('}', '');
-                croneParams.push({
-                    in: 'path',
-                    name: key,
-                    require: true,
-                    description: key,
-                });
-            }
-        }
-
-        if (croneParams.length > 0) {
-            yml += `      parameters:\n`;
-            for (const param of croneParams) {
-                yml += `        - in: ${param.in}\n`;
-                yml += `          name: ${param.name}\n`;
-                yml += `          required: ${param.require === true ? 'true' : 'false'}\n`;
-                if (param.description !== undefined) {
-                    yml += `          description: |\n            ${param.description}\n`;
-                }
-                if (param.example !== undefined) {
-                    yml += `          example: ${param.example}\n`;
-                }
-                yml += `          schema:\n`;
-                yml += `            type: string\n`;
-            }
-        }
-
-        yml += service.Request.createSwagger(service.Method);
-        yml += service.Response.createSwagger();
-    
-        endpontSwaggerYml[service.Endpoint][service.Method] = yml;
-    }
-
-    let swaggerInfo = `openapi: 3.0.0
-info:
-  title: Your API Documentation
-  version: 1.0.0
-  description: API documentation for your service
-servers:
-  - url: ${url}
-    description: ${name} API IF定義書
-tags:\n`;
-    for (const tag of tags) {
-        swaggerInfo += `  - name: ${tag}\n`;
-    }
-    swaggerInfo += 'paths:\n'
-
-    for (const keyEndpoint in endpontSwaggerYml) {
-        swaggerInfo += `  ${keyEndpoint}:\n`;
-
-        setYmlByMethod('GET', endpontSwaggerYml[keyEndpoint]);
-        setYmlByMethod('POST', endpontSwaggerYml[keyEndpoint]);
-        setYmlByMethod('PUT', endpontSwaggerYml[keyEndpoint]);
-        setYmlByMethod('PATCH', endpontSwaggerYml[keyEndpoint]);
-        setYmlByMethod('DELETE', endpontSwaggerYml[keyEndpoint]);
-    }
-
-    return swaggerInfo;
-}

package/src/exceptions/Exception.ts

@@ -1,72 +0,0 @@
-export class AuthException extends Error {
-    private id: string = "";
-    get Id(): string {
-        return this.id;
-    }
-
-    constructor(id: string, message: string = "") {
-        super(message);
-        this.id = id;
-    }
-}
-
-export class ForbiddenException extends Error {
-}
-
-export class InputErrorException extends Error {
-    private errorId: string = "";
-    get ErrorId(): string {
-        return this.errorId;
-    }
-
-    constructor(errorId: string, message: string = "") {
-        super(message);
-        this.errorId = errorId;
-    }
-}
-
-export class MaintenanceException extends Error {
-
-    constructor(message: string = "") {
-        super(message);
-    }
-}
-
-export class NotFoundException extends Error {
-    // for 404 Not Found
-    private errorId: string = "";
-    get ErrorId(): string {
-        return this.errorId;
-    }
-
-    constructor(errorId: string, message: string = "") {
-        super(message);
-        this.errorId = errorId;
-    }
-}
-
-export class DbConflictException extends Error {
-    // for 409 Conflict
-    private errorId: string = "";
-    get ErrorId(): string {
-        return this.errorId;
-    }
-
-    constructor(errorId: string, message: string = "") {
-        super(message);
-        this.errorId = errorId;
-    }
-}
-
-export class UnprocessableException extends Error {
-    // for 422 Unprocessable Entity
-    private errorId: string = "";
-    get ErrorId(): string {
-        return this.errorId;
-    }
-
-    constructor(errorId: string, message: string = "") {
-        super(message);
-        this.errorId = errorId;
-    }
-}

package/src/index.ts

@@ -1,23 +0,0 @@
-export { Service } from './Service';
-export { MaintenanceException, AuthException, InputErrorException, ForbiddenException, DbConflictException, UnprocessableException, NotFoundException } from './exceptions/Exception';
-export { createSwagger } from './documents/Swagger';
-export { AwsS3Client } from './clients/AwsS3Client';
-export { Base64Client } from './clients/Base64Client';
-export { StringClient } from './clients/StringClient';
-export { EncryptClient } from './clients/EncryptClient';
-
-export { RequestType } from './reqestResponse/RequestType';
-export { ResponseType } from './reqestResponse/ResponseType';
-export { PropertyType } from './reqestResponse/ReqResType';
-
-// models
-export { TableModel } from './models/TableModel';
-export { createTableDoc } from './models/TableDoc';
-export { MigrateTable } from './models/MigrateTable';
-export { MigrateDatabase } from './models/MigrateDatabase';
-export { migrate, rollback } from './models/MigrateRollback';
-
-// cron
-export { DayType, MonthType, DateType, HourType, MinuteSecondType } from './cron/CronType';
-export { BaseCron } from './cron/BaseCron';
-export { runCron } from './cron/CronExecuter';

package/src/models/ExpressionClient.ts

@@ -1,72 +0,0 @@
-import { TableModel } from "./TableModel";
-import { TColumnInfo } from "./Type";
-
-export default class ExpressionClient {
-    private model: TableModel;
-    constructor(model: TableModel) {
-        this.model = model;
-    }
-
-    public toSqlStringValue(value: any): string {
-        if (typeof value === 'string' || typeof value === 'number') {
-            return `'${value}'`;
-        }
-
-        throw new Error('Please enter a value of type string or number.');
-    }
-
-    public toSqlNumberValue(value: any): string {
-        if (typeof value === 'number') {
-            return value.toString();
-        } else if (typeof value === 'string') {
-            if (value.trim() !== "" || isNaN(Number(value)) === false) {
-                return value;
-            }
-        }
-
-        throw new Error('Please enter a value of type number or a string of half-width digits.');
-    }
-
-    public createCaseFromObject(column: string | TColumnInfo, obj: {[key: string | number]: string | number | boolean | null}, elseValue: string | number | boolean | null): string {
-        const columnInfo = typeof column === 'string' ? this.model.getColumn(column) : column.model.getColumn(column.name);
-        if (columnInfo.type !== 'string' && columnInfo.type !== 'integer') {
-            throw new Error('This method cannot be used for columns other than integer, real, or string.');
-        }
-
-        const whenExpression = Object.entries(obj).map(([key, value]) => {
-            let expression = `WHEN ${columnInfo.expression} = `;
-            // 今は文字列と数値だけだが、他のも対応しないといけないかも
-            if (columnInfo.type === 'string') {
-                expression += this.toSqlStringValue(key);
-            } else {
-                expression += this.toSqlNumberValue(key);
-            }
-            expression += ` THEN `;
-
-            if (value === null) {
-                expression += 'null';
-            } else if (typeof value === 'string') {
-                expression += this.toSqlStringValue(value);
-            } else if (typeof value === 'boolean') {
-                expression += `${value}`;                
-            } else {
-                expression += `${value}`;
-            }
-
-            return expression;
-        });
-
-        let elseExpression = `ELSE `;
-        if (elseValue === null) {
-            elseExpression += 'null';
-        } else if (typeof elseValue === 'string') {
-            elseExpression += this.toSqlStringValue(elseValue);
-        } else if (typeof elseValue === 'boolean') {
-            elseExpression += `${elseValue}`;                
-        } else {
-            elseExpression += `${elseValue}`;
-        }
-
-        return `CASE ${whenExpression.join(' ')} ${elseExpression} END`;
-    }
-}

package/src/models/MigrateDatabase.ts

@@ -1,135 +0,0 @@
-import { Pool } from "pg";
-
-export class MigrateDatabase {
-
-    private dbName: string;
-    get DbName(): string { return this.dbName; }
-    private userName: string;
-    get UserName(): string { return this.userName; }
-    private password: string | null = null;
-    get Password(): string | null {
-        return this.password;
-    }
-    private pool: Pool;
-
-    constructor (dbName: string, userName: string, pool: Pool) {
-        this.dbName = dbName;
-        this.userName = userName;
-        this.pool = pool;
-    }
-
-    public async IsExistUser(): Promise<boolean> {
-        const sql = `
-            SELECT count(*) > 0 as is_exist
-            FROM pg_roles
-            WHERE rolname = '${this.UserName}';
-        `;
-        const datas = await this.pool.query(sql);
-        return datas.rows[0].is_exist;
-    }
-
-    public async CreateUser(password: string = ''): Promise<void> {
-        if (password.trim() === '') {
-            password = '';
-
-            const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@$%^&*_+|;:.<>?';
-            for (let i = 0; i < 36; i++) {
-                const randomIndex = Math.floor(Math.random() * characters.length);
-                password += characters[randomIndex];
-            }
-        }
-        this.password = password;
-
-        const sql = `
-            DO $$
-            BEGIN
-                IF NOT EXISTS (
-                    SELECT FROM pg_catalog.pg_roles WHERE rolname = '${this.UserName}'
-                ) THEN
-                    CREATE USER ${this.UserName} WITH PASSWORD '${password}';
-                END IF;
-            END
-            $$;
-
-            GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO ${this.UserName};
-
-            ALTER DEFAULT PRIVILEGES IN SCHEMA public
-            GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO ${this.UserName};
-        `;
-        await this.pool.query(sql);
-    }
-
-    public async IsExistDb(): Promise<boolean> {
-        const sql = `
-            SELECT count(*) > 0 as is_exist
-            FROM pg_database
-            WHERE datname = '${this.DbName}';
-        `;
-        const datas = await this.pool.query(sql);
-        return datas.rows[0].is_exist;
-    }
-
-    public async CreateDb(collateType: string = 'C'): Promise<void> {
-        const sql = `
-            CREATE DATABASE ${this.DbName}
-                WITH OWNER = ${this.UserName}
-                ENCODING = 'UTF8'
-                LC_COLLATE = '${collateType}'
-                LC_CTYPE = '${collateType}'
-                CONNECTION LIMIT = -1;
-        `;
-        await this.pool.query(sql);
-    }
-
-    public RollbackDbSql(): string {
-        const sql = `
-            -- ${this.DbName}データベースに接続しているすべてのセッションを強制終了
-            SELECT pg_terminate_backend(pid)
-            FROM pg_stat_activity
-            WHERE datname = '${this.DbName}';
-
-            -- DB削除
-            DROP DATABASE IF EXISTS ${this.DbName};`;
-        return this.trimSpaceLineSql(sql);
-    }
-
-    public RollbackUserSql(otherUserName: string): string {
-        const sql = `
-            -- 1. すべてのセッションを強制終了
-            SELECT pg_terminate_backend(pg_stat_activity.pid)
-            FROM pg_stat_activity
-            WHERE usename = '${this.UserName}';
-
-            -- 2. 所有オブジェクトを ${otherUserName} に移行
-            REASSIGN OWNED BY ${this.UserName} TO ${otherUserName};
-
-            -- 2. すべての権限を削除
-            DROP OWNED BY ${this.UserName} CASCADE;
-
-            -- 3. ロールを削除
-            DROP ROLE IF EXISTS ${this.UserName};`;
-        return this.trimSpaceLineSql(sql);
-    }
-
-    private trimSpaceLineSql(str: string) {
-        const splitLines = str.split('\n');
-        let sql = '';
-        for (let line of splitLines) {
-            line = line.replace(/\s+/g, ' ').trim(); // 複数のスペースを一つに置き換え
-
-            if (line.startsWith('--') && sql[sql.length - 1] != '\n') {
-                line = '\n' + line;
-            }
-
-            if (line.length > 0) {
-                if (line.includes('--') === false) {
-                    sql += line + ' ';
-                } else {
-                    sql += line + '\n';
-                }
-            }
-        }
-
-        return sql;
-    }
-}

package/src/models/MigrateRollback.ts

@@ -1,151 +0,0 @@
-import { Pool } from "pg";
-import { MigrateTable } from "./MigrateTable";
-
-export const migrate = async (migrates: Array<MigrateTable>, poolParam: {
-    host: string, user: string, dbName: string, password: string, port?: number, isSsl?: boolean
-}): Promise<void> => {
-
-    const pool = new Pool({
-        user: poolParam.user,
-        password: poolParam.password,
-        host: poolParam.host,
-        database: poolParam.dbName,
-        port: poolParam.port ?? 5432,
-        ssl: poolParam.isSsl === true ? {
-            rejectUnauthorized: false
-        } : false
-    });
-
-    // create migration table
-    try {
-        if (await isExistMigrationTable(pool) == false) {
-            const sql = `
-                CREATE TABLE migrations (
-                    migration_number int,
-                    script_file VARCHAR(50),
-                    rollback_script VARCHAR(5000),
-                    create_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
-                );`;
-            await pool.query(sql);
-        }
-    } catch (ex) {
-        console.error('An error occurred related to the Migrate table:', ex);
-        await pool.end();
-        throw ex;
-    }
-
-    const client = await pool.connect();
-    try {
-        client.query('BEGIN');
-
-        const datas = await getMigrations(pool);
-        let maxNumber = datas.maxNumber;
-        for (const migrate of migrates) {
-            const className = migrate.constructor.name;
-            if (datas.datas.filter(data => data.script_file === className).length > 0) {
-                console.log(`Already executed: ${className}`);
-                continue;
-            }
-
-            await client.query(migrate.MigrateSql);
-
-            const grantSql = migrate.AddGrantSql;
-            if (grantSql !== null) {
-                await client.query(grantSql);
-            }
-    
-            const migrateInsertSql = `
-                INSERT INTO migrations
-                (migration_number, script_file, rollback_script)
-                VALUES (${maxNumber + 1}, '${className}', '${migrate.RollbackSql}');
-            `;
-            maxNumber++;
-    
-            await client.query(migrateInsertSql);
-    
-            console.log(`Execution completed: ${className}`);
-        }
-        
-        await client.query('COMMIT');
-        
-        console.log('Migration completed');
-    } catch (ex) {
-        await client.query('ROLLBACK');
-        console.log('Migration failed.', ex);
-    } finally {
-        client.release();
-        await pool.end();
-    }
-}
-
-export const rollback = async (toNumber: number, poolParam: {
-    host: string, user: string, dbName: string, password: string, port?: number, isSsl?: boolean
-}): Promise<void> => {
-
-    const pool = new Pool({
-        user: poolParam.user,
-        password: poolParam.password,
-        host: poolParam.host,
-        database: poolParam.dbName,
-        port: poolParam.port ?? 5432,
-        ssl: poolParam.isSsl === true ? {
-            rejectUnauthorized: false
-        } : false
-    });
-
-    try {
-        // If the migration table does not exist, there is no target for rollback, so do not perform it
-        if (await isExistMigrationTable(pool) == false) {
-          return;
-        }
-    } catch (ex) {
-        console.error('An error occurred related to the Migrate table:', ex);
-        await pool.end();
-        return;
-    }
-
-    const client = await pool.connect();
-    try {
-        await client.query('BEGIN');
-
-        const datas = await getMigrations(pool);
-        for (const data of datas.datas) {
-            if (data.migration_number < toNumber) {
-                break;
-            }
-            await client.query(data.rollback_script);
-            await client.query(`DELETE FROM migrations WHERE migration_number = ${data.migration_number}`);
-  
-            console.log(`Execution completed: ${data.script_file}`);
-        }
-  
-        await client.query('COMMIT');
-
-        console.log('Rollback completed');
-    } catch (ex) {
-        await client.query('ROLLBACK');
-        console.error('Rollback failed', ex);
-    } finally {
-        client.release();
-        await pool.end();
-    }
-}
-
-const isExistMigrationTable = async (pool: Pool) => {
-    const existMigrationTableSql = `
-        SELECT EXISTS (
-            SELECT FROM information_schema.tables 
-            WHERE table_name = 'migrations'
-        );
-    `;
-    const res = await pool.query(existMigrationTableSql);
-    return res.rows[0].exists;
-}
-
-const getMigrations = async (pool: Pool): Promise<{datas: Array<{migration_number: number, script_file: string, rollback_script: string}>, maxNumber: number}> => {
-    const datas = await pool.query("SELECT * FROM migrations ORDER BY migration_number DESC;");
-    return {
-        maxNumber: datas.rows.reduce((max, data) => data.migration_number > max ? data.migration_number : max, 0),
-        datas: datas.rows
-    }
-}

package/src/models/MigrateTable.ts

@@ -1,56 +0,0 @@
-export class MigrateTable {
-
-    protected readonly migrateSql: string = '';
-    protected readonly rollbackSql: string = '';
-    protected readonly addGrantTables: Array<string> = [];
-    protected readonly user: string = '';
-
-    get MigrateSql(): string { return this.trimSpaceLineSql(this.migrateSql); }
-    get RollbackSql(): string { return this.trimSpaceLineSql(this.rollbackSql); }
-    get AddGrantSql(): string | null {
-        if ((this.user ?? "").trim() === "") {
-            return null;
-        }
-
-        const tables = this.addGrantTables.filter(table => table.trim() !== '');
-        if (tables.length === 0) {
-            return null;
-        }
-
-        let sql = "";
-        for (const table of tables) {
-            sql += `GRANT SELECT, INSERT, UPDATE, DELETE ON TABLE public.${table} TO ${this.user};`;
-        }
-        return sql;
-    }
-
-    constructor();
-    constructor(user: string);
-    constructor(user?: string) {
-        if (user !== undefined) {
-            this.user = user;
-        }
-    }
-
-    private trimSpaceLineSql(str: string) {
-        const splitLines = str.split('\n');
-        let sql = '';
-        for (let line of splitLines) {
-            line = line.replace(/\s+/g, ' ').trim(); // 複数のスペースを一つに置き換え
-
-            if (line.startsWith('--') && sql[sql.length - 1] != '\n') {
-                line = '\n' + line;
-            }
-
-            if (line.length > 0) {
-                if (line.includes('--') === false) {
-                    sql += line + ' ';
-                } else {
-                    sql += line + '\n';
-                }
-            }
-        }
-
-        return sql;
-    }
-}