pg-mvc-service 2.0.23 → 2.0.24

package/index.d.ts

@@ -22,6 +22,9 @@ export { TableModel } from "./src/models/TableModel";
 
 export { TColumnAttribute, TColumnType, TColumnArrayType, TColumn, TColumnDetail, TOperator, TColumnInfo, TQuery, TSelectExpression, TAggregateFuncType, TCondition, TNestedCondition, TSortKeyword, TKeyFormat } from './src/models/Type';
 
+export { BaseCron } from "./src/cron/BaseCron";
+export { runCron } from "./src/cron/CronExecuter";
+
 declare module 'pg-mvc-service' {
     export class Service {
         protected readonly method: MethodType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-mvc-service",
-  "version": "2.0.23",
+  "version": "2.0.24",
   "description": "",
   "homepage": "https://github.com/n-daira/npm-pack_mvc-service#readme",
   "bugs": {
@@ -30,6 +30,7 @@
     "@types/express": "5.0.1",
     "axios": "1.10.0",
     "crypto": "1.0.1",
+    "node-cron": "4.2.1",
     "pdf-lib": "1.17.1",
     "sharp": "0.34.1",
     "type-utils-n-daira": "1.0.11"

package/src/cron/BaseCron.ts

@@ -0,0 +1,37 @@
+import { DateType, DayType, HourType, MinuteSecondType, MonthType } from "./TimeType";
+
+export class BaseCron {
+
+    // **********************************************************************
+    // こちらのメソッド、プロパティを各サブクラスで設定してください
+    // **********************************************************************
+    protected cronCode: string = '';
+    protected minute: MinuteSecondType | '*' = '*';
+    protected hour: HourType | '*' = '*';
+    protected date: DateType | '*' = '*';
+    protected month: MonthType | '*' = '*';
+    protected day: DayType | '*' = '*';
+    public async run() { }
+
+    // **********************************************************************
+    // ベースクラスで設定
+    // **********************************************************************
+    get CronSchedule(): string {
+        let schedule = '';
+        schedule += this.minute.toString() + ' ';
+        schedule += this.hour.toString() + ' ';
+        schedule += this.date.toString() + ' ';
+        schedule += this.month.toString() + ' ';
+        schedule += this.day.toString();
+        return schedule;
+    }
+    get CronCode(): string { return this.cronCode; }
+
+    public async setUp() {
+
+    }
+
+    public async tearDown() {
+
+    }
+}

package/src/cron/CronExecuter.ts

@@ -0,0 +1,34 @@
+const cron = require('node-cron');
+import fs from 'fs';
+import path from 'path';
+import { BaseCron } from "./BaseCron";
+
+export const runCron = async (dir: string, logCallback?: (ex: Error) => Promise<void>) => {
+    const files = fs.readdirSync(dir);
+    for (let file of files) {
+        if (['BaseCron.ts'].includes(file)) {
+            continue;
+        }
+
+        const filePath = path.join(dir, file);
+        const module = await import(`./${filePath.replace('src/', '').replace('.ts', '')}`);
+        const cronClass = module.default;
+        const cronInstance: BaseCron = new cronClass();
+
+        cron.schedule(cronInstance.CronSchedule, async () => {
+            try {
+                await cronInstance.setUp();
+                await cronInstance.run();
+            } catch (ex: unknown) {
+                if (logCallback !== undefined && ex instanceof Error) {
+                    await logCallback(ex).
+                        catch(() => {
+                            // ログ送信時にエラーになっても握りつぶす
+                        });
+                }
+            } finally {
+                await cronInstance.tearDown();
+            }
+        });
+    }
+}

package/src/cron/TimeType.ts

@@ -0,0 +1,25 @@
+export type DayType = 
+         1 |  2 |  3 |  4 |  5 |  6 |  7
+
+export type MonthType = 
+         1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 
+   10 | 11 | 12
+
+export type DateType = 
+         1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 
+   10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |
+   20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 
+   30 | 31
+
+export type HourType = 
+     0 |  1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 
+    10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |
+    20 | 21 | 22 | 23
+
+export type MinuteSecondType = 
+    0 |  1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 
+   10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |
+   20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 
+   30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 |
+   40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 |
+   50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59

package/src/index.ts

@@ -15,4 +15,8 @@ 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';
+export { migrate, rollback } from './models/MigrateRollback';
+
+// cron
+export { BaseCron } from './cron/BaseCron';
+export { runCron } from './cron/CronExecuter';