apeframework 0.0.0-dev.30 → 0.0.0-dev.32

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Matthieu Symoens
+Copyright (c) 2025 Matthieu Symoens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,10 +4,56 @@
 
 NPM package: [apeframework](https://www.npmjs.com/package/apeframework).
 
-GitHub repository: [ApeFramework/apeframework](https://github.com/ApeFramework/apeframework).
+GitHub repository: [MattSyms/apeframework](https://github.com/MattSyms/apeframework).
 
 ## Installation
 
 ```
 yarn add apeframework
 ```
+
+## Development
+
+Install dependencies:
+
+```
+yarn
+```
+
+Update dependencies:
+
+```
+yarn update
+```
+
+Compile:
+
+```
+yarn compile
+```
+
+Lint:
+
+```
+yarn lint
+```
+
+## Release:
+
+Tag stable release:
+
+```
+git tag v<major>.<minor>.<patch>
+```
+
+Tag dev release:
+
+```
+git tag v0.0.0-dev.<number>
+```
+
+Push tags:
+
+```
+git push --tags
+```

package/dist/cipher/Cipher.js

@@ -1,4 +1,4 @@
-import { createCipheriv, createDecipheriv, randomBytes } from 'crypto';
+import { createCipheriv, createDecipheriv, randomBytes } from 'node:crypto';
 import { DecryptError } from './errors/DecryptError.js';
 import { validateSecretLength } from './validateSecretLength.js';
 class Cipher {

package/dist/cli/utils/formatList.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 const formatList = (list) => {
     return list
         .map((item) => { return `  ${item}`; })

package/dist/cli/utils/formatTable.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 const formatTable = (table) => {
     const colLength = [];
     table.forEach((row) => {

package/dist/cli/utils/formatText.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 const formatText = (text) => {
     return text.join(EOL);
 };

package/dist/cli/utils/printLn.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 const printLn = (s) => {
     process.stdout.write(`${s}${EOL}`);
 };

package/dist/db/DataType.d.ts

@@ -0,0 +1,2 @@
+import { DataTypes } from 'sequelize';
+export { DataTypes as DataType, };

package/dist/db/DataType.js

@@ -0,0 +1,2 @@
+import { DataTypes } from 'sequelize';
+export { DataTypes as DataType, };

package/dist/db/Db.d.ts

@@ -0,0 +1,3 @@
+import type { Sequelize } from 'sequelize';
+type Db = Sequelize;
+export type { Db, };

package/dist/db/Db.js

@@ -0,0 +1 @@
+export {};

package/dist/db/IndexType.d.ts

@@ -0,0 +1,6 @@
+declare enum IndexType {
+    FULLTEXT = "FULLTEXT",
+    SPATIAL = "SPATIAL",
+    UNIQUE = "UNIQUE"
+}
+export { IndexType, };

package/dist/db/IndexType.js

@@ -0,0 +1,7 @@
+var IndexType;
+(function (IndexType) {
+    IndexType["FULLTEXT"] = "FULLTEXT";
+    IndexType["SPATIAL"] = "SPATIAL";
+    IndexType["UNIQUE"] = "UNIQUE";
+})(IndexType || (IndexType = {}));
+export { IndexType, };

package/dist/db/Initializer.d.ts

@@ -0,0 +1,3 @@
+import type { Sequelize } from 'sequelize';
+type Initializer = (db: Sequelize) => void;
+export { type Initializer, };

package/dist/db/Initializer.js

@@ -0,0 +1 @@
+export {};

package/dist/db/Migration.d.ts

@@ -0,0 +1,6 @@
+import type { QueryInterface } from 'sequelize';
+interface Migration {
+    up: (db: QueryInterface) => Promise<void>;
+    down: (db: QueryInterface) => Promise<void>;
+}
+export { type Migration, };

package/dist/db/Migration.js

@@ -0,0 +1 @@
+export {};

package/dist/db/MigrationStatus.d.ts

@@ -0,0 +1,5 @@
+declare enum MigrationStatus {
+    APPLIED = "APPLIED",
+    PENDING = "PENDING"
+}
+export { MigrationStatus, };

package/dist/db/MigrationStatus.js

@@ -0,0 +1,6 @@
+var MigrationStatus;
+(function (MigrationStatus) {
+    MigrationStatus["APPLIED"] = "APPLIED";
+    MigrationStatus["PENDING"] = "PENDING";
+})(MigrationStatus || (MigrationStatus = {}));
+export { MigrationStatus, };

package/dist/db/Migrator.d.ts

@@ -0,0 +1,20 @@
+import { MigrationStatus } from './MigrationStatus.js';
+import type { Db } from './Db.js';
+declare class Migrator {
+    private readonly umzug;
+    constructor(params: {
+        db: Db;
+        modelName: string;
+        directory: string;
+        extension: string;
+        onApply?: (name: string) => void;
+        onRevert?: (name: string) => void;
+    });
+    list(status?: MigrationStatus): Promise<{
+        name: string;
+        status: MigrationStatus;
+    }[]>;
+    apply(count?: number): Promise<string[]>;
+    revert(count?: number): Promise<string[]>;
+}
+export { Migrator, };

package/dist/db/Migrator.js

@@ -0,0 +1,69 @@
+import { basename, extname } from 'node:path';
+import { SequelizeStorage, Umzug } from 'umzug';
+import { MigrationStatus } from './MigrationStatus.js';
+class Migrator {
+    umzug;
+    constructor(params) {
+        const glob = `${params.directory}/*.${params.extension}`;
+        const resolve = ({ name: filename, context }) => {
+            const name = basename(filename, extname(filename));
+            const up = async ({ path: file }) => {
+                const module = await import(String(file));
+                await module.migration.up(context);
+            };
+            const down = async ({ path: file }) => {
+                const module = await import(String(file));
+                await module.migration.down(context);
+            };
+            return { name, up, down };
+        };
+        this.umzug = new Umzug({
+            storage: new SequelizeStorage({
+                sequelize: params.db,
+                modelName: params.modelName,
+            }),
+            migrations: { glob, resolve },
+            context: params.db.getQueryInterface(),
+            logger: undefined,
+        });
+        this.umzug.on('migrating', (e) => {
+            params.onApply?.(e.name);
+        });
+        this.umzug.on('reverting', (e) => {
+            params.onRevert?.(e.name);
+        });
+    }
+    async list(status) {
+        return [
+            ...status === MigrationStatus.PENDING
+                ? []
+                : (await this.umzug.executed()).map((migration) => {
+                    return {
+                        name: migration.name,
+                        status: MigrationStatus.APPLIED,
+                    };
+                }),
+            ...status === MigrationStatus.APPLIED
+                ? []
+                : (await this.umzug.pending()).map((migration) => {
+                    return {
+                        name: migration.name,
+                        status: MigrationStatus.PENDING,
+                    };
+                }),
+        ];
+    }
+    async apply(count) {
+        return (await this.umzug.up(count ? { step: count } : undefined))
+            .map((migration) => {
+            return migration.name;
+        });
+    }
+    async revert(count) {
+        return (await this.umzug.down(count ? { step: count } : { to: 0 }))
+            .map((migration) => {
+            return migration.name;
+        });
+    }
+}
+export { Migrator, };

package/dist/db/Operator.d.ts

@@ -0,0 +1,2 @@
+import { Op } from 'sequelize';
+export { Op as Operator, };

package/dist/db/Operator.js

@@ -0,0 +1,2 @@
+import { Op } from 'sequelize';
+export { Op as Operator, };

package/dist/db/Order.d.ts

@@ -0,0 +1,2 @@
+import type { Order } from 'sequelize';
+export { type Order, };

package/dist/db/Order.js

@@ -0,0 +1 @@
+export {};

package/dist/db/ReferentialAction.d.ts

@@ -0,0 +1,7 @@
+declare const ReferentialAction: {
+    CASCADE: string;
+    RESTRICT: string;
+    SET_DEFAULT: string;
+    SET_NULL: string;
+};
+export { ReferentialAction, };

package/dist/db/ReferentialAction.js

@@ -0,0 +1,7 @@
+const ReferentialAction = {
+    CASCADE: 'CASCADE',
+    RESTRICT: 'RESTRICT',
+    SET_DEFAULT: 'SET DEFAULT',
+    SET_NULL: 'SET NULL',
+};
+export { ReferentialAction, };

package/dist/db/Seed.d.ts

@@ -0,0 +1,3 @@
+import type { Sequelize } from 'sequelize';
+type Seed = (db: Sequelize) => Promise<void>;
+export { type Seed, };

package/dist/db/Seed.js

@@ -0,0 +1 @@
+export {};

package/dist/db/Seeder.d.ts

@@ -0,0 +1,16 @@
+import type { Db } from './Db.js';
+declare class Seeder {
+    private readonly db;
+    private readonly directory;
+    private readonly extension;
+    private readonly onApply?;
+    constructor(params: {
+        db: Db;
+        directory: string;
+        extension: string;
+        onApply?: (name: string) => void;
+    });
+    list(): string[];
+    apply(name: string): Promise<void>;
+}
+export { Seeder, };

package/dist/db/Seeder.js

@@ -0,0 +1,26 @@
+import { basename, extname, resolve } from 'node:path';
+import fs from 'fs-extra';
+class Seeder {
+    db;
+    directory;
+    extension;
+    onApply;
+    constructor(params) {
+        this.db = params.db;
+        this.directory = params.directory;
+        this.extension = params.extension;
+        this.onApply = params.onApply;
+    }
+    list() {
+        return fs.readdirSync(this.directory).map((filename) => {
+            return basename(filename, extname(filename));
+        });
+    }
+    async apply(name) {
+        this.onApply?.(name);
+        const file = resolve(this.directory, `${name}.${this.extension}`);
+        const { seed } = await import(file);
+        await seed(this.db);
+    }
+}
+export { Seeder, };

package/dist/db/Transaction.d.ts

@@ -0,0 +1,2 @@
+import type { Transaction } from 'sequelize';
+export { type Transaction, };

package/dist/db/Transaction.js

@@ -0,0 +1 @@
+export {};

package/dist/db/adapters/mysql/MysqlDb.d.ts

@@ -0,0 +1,16 @@
+import { Sequelize } from 'sequelize';
+import type { Db } from '../../Db.js';
+import type { Initializer } from '../../Initializer.js';
+declare class MysqlDb extends Sequelize implements Db {
+    constructor(params: {
+        host: string;
+        port?: number;
+        user: string;
+        password: string;
+        database: string;
+        maxConnections?: number;
+        initializers?: Initializer[];
+        onLog?: (message: string) => void;
+    });
+}
+export { MysqlDb, };

package/dist/db/adapters/mysql/MysqlDb.js

@@ -0,0 +1,22 @@
+import { Sequelize } from 'sequelize';
+class MysqlDb extends Sequelize {
+    constructor(params) {
+        super(params.database, params.user, params.password, {
+            dialect: 'mysql',
+            host: params.host,
+            port: params.port ?? 3306,
+            pool: {
+                max: params.maxConnections ?? 5,
+            },
+            define: {
+                freezeTableName: true,
+                timestamps: false,
+            },
+            logging: params.onLog,
+        });
+        params.initializers?.forEach((initialize) => {
+            initialize(this);
+        });
+    }
+}
+export { MysqlDb, };

package/dist/db/relationships.d.ts

@@ -0,0 +1,28 @@
+import type { Model, ModelStatic } from 'sequelize';
+declare const oneToOne: (fk: string, a: {
+    model: ModelStatic<Model>;
+    asOne: string;
+}, b: {
+    model: ModelStatic<Model>;
+    asOne: string;
+}) => void;
+declare const oneToMany: (fk: string, a: {
+    model: ModelStatic<Model>;
+    asOne: string;
+}, b: {
+    model: ModelStatic<Model>;
+    asMany: string;
+}) => void;
+declare const manyToMany: (fkA: string, fkB: string, a: {
+    model: ModelStatic<Model>;
+    asOne: string;
+    asMany: string;
+}, b: {
+    model: ModelStatic<Model>;
+    asOne: string;
+    asMany: string;
+}, through: {
+    model: ModelStatic<Model>;
+    asMany: string;
+}) => void;
+export { manyToMany, oneToMany, oneToOne, };

package/dist/db/relationships.js

@@ -0,0 +1,15 @@
+const oneToOne = (fk, a, b) => {
+    a.model.hasOne(b.model, { foreignKey: fk, as: b.asOne });
+    b.model.belongsTo(a.model, { foreignKey: fk, as: a.asOne });
+};
+const oneToMany = (fk, a, b) => {
+    a.model.hasMany(b.model, { foreignKey: fk, as: b.asMany });
+    b.model.belongsTo(a.model, { foreignKey: fk, as: a.asOne });
+};
+const manyToMany = (fkA, fkB, a, b, through) => {
+    a.model.belongsToMany(b.model, { through: through.model, foreignKey: fkA, otherKey: fkB, as: b.asMany });
+    b.model.belongsToMany(a.model, { through: through.model, foreignKey: fkB, otherKey: fkA, as: a.asMany });
+    oneToMany(fkA, a, through);
+    oneToMany(fkB, b, through);
+};
+export { manyToMany, oneToMany, oneToOne, };

package/dist/logger/adapters/file/FileLogger.js

@@ -1,4 +1,4 @@
-import { pino } from 'pino';
+import { destination, pino } from 'pino';
 import { Level } from '../../Level.js';
 import { Logger } from '../../Logger.js';
 import { initFile } from './initFile.js';
@@ -8,7 +8,7 @@ class FileLogger extends Logger {
     constructor(params) {
         super();
         initFile(params.path);
-        const stream = pino.destination(params.path);
+        const stream = destination(params.path);
         this.logger = pino({
             enabled: params.level !== Level.OFF,
             level: params.level ?? Level.INFO,

package/dist/logger/adapters/stdio/StdioLogger.js

@@ -1,4 +1,4 @@
-import { pino } from 'pino';
+import { destination, pino } from 'pino';
 import pretty from 'pino-pretty';
 import { Level } from '../../Level.js';
 import { Logger } from '../../Logger.js';
@@ -9,7 +9,7 @@ class StdioLogger extends Logger {
         super();
         const stream = params?.pretty
             ? pretty()
-            : pino.destination(process.stdout.fd);
+            : destination(process.stdout.fd);
         this.logger = pino({
             enabled: params?.level !== Level.OFF,
             level: params?.level ?? Level.INFO,

package/dist/mailer/Attachment.d.ts

@@ -1,4 +1,4 @@
-import type { Readable } from 'stream';
+import type { Readable } from 'node:stream';
 interface Attachment {
     fileName: string;
     contentType?: string;

package/dist/mailer/adapters/noop/NoopMailer.js

@@ -1,4 +1,4 @@
-import { randomUUID } from 'crypto';
+import { randomUUID } from 'node:crypto';
 import { Mailer } from '../../Mailer.js';
 class NoopMailer extends Mailer {
     async sendMail(mail) {

package/dist/mailer/adapters/smtp/getAttachments.d.ts

@@ -1,5 +1,5 @@
 import type { Attachment } from '../../Attachment.js';
-import type { Readable } from 'stream';
+import type { Readable } from 'node:stream';
 interface NodemailerAttachment {
     filename: string;
     cid: string;

package/dist/server/ErrorHandler.d.ts

@@ -1,3 +1,5 @@
-import type { FastifyError, FastifyReply, FastifyRequest } from 'fastify';
-type ErrorHandler = (error: FastifyError, request: FastifyRequest, response: FastifyReply) => Promise<void>;
+import type { Request } from './Request.js';
+import type { Response } from './Response.js';
+import type { FastifyError } from 'fastify';
+type ErrorHandler = (error: FastifyError, request: Request, response: Response) => Promise<void>;
 export { type ErrorHandler, };

package/dist/server/Handler.d.ts

@@ -1,3 +1,4 @@
-import type { FastifyReply, FastifyRequest } from 'fastify';
-type Handler = (request: FastifyRequest, response: FastifyReply) => Promise<void>;
+import type { Request } from './Request.js';
+import type { Response } from './Response.js';
+type Handler = (request: Request, response: Response) => Promise<void>;
 export { type Handler, };

package/dist/server/Request.d.ts

@@ -0,0 +1,5 @@
+import type { FastifyRequest } from 'fastify';
+interface Request extends FastifyRequest {
+    cookies: Record<string, string | undefined>;
+}
+export { type Request, };

package/dist/server/Request.js

@@ -0,0 +1 @@
+export {};

package/dist/server/Response.d.ts

@@ -0,0 +1,8 @@
+import type { CookieSerializeOptions } from '@fastify/cookie';
+import type { FastifyReply } from 'fastify';
+interface Response extends FastifyReply {
+    cookies: Record<string, string | undefined>;
+    setCookie: (name: string, value: string, options?: CookieSerializeOptions) => this;
+    clearCookie: (name: string, options?: CookieSerializeOptions) => this;
+}
+export { type Response, };

package/dist/server/Response.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/getRandomHexString.js

@@ -1,4 +1,4 @@
-import { randomBytes } from 'crypto';
+import { randomBytes } from 'node:crypto';
 const getRandomHexString = (length) => {
     return randomBytes(length / 2 + 1).toString('hex').substring(0, length);
 };

package/dist/utils/getRandomIntString.js

@@ -1,4 +1,4 @@
-import { randomInt } from 'crypto';
+import { randomInt } from 'node:crypto';
 const getRandomIntString = (length) => {
     let string = '';
     for (let i = 0; i < length; i += 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apeframework",
-  "version": "0.0.0-dev.30",
+  "version": "0.0.0-dev.32",
   "publishConfig": {
     "access": "public"
   },
@@ -14,40 +14,43 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ApeFramework/apeframework.git"
+    "url": "git+https://github.com/MattSyms/apeframework.git"
   },
   "type": "module",
   "engines": {
     "node": ">=22"
   },
   "dependencies": {
-    "@fastify/compress": "^8.0",
+    "@fastify/compress": "^8.1",
     "@fastify/cookie": "^11.0",
-    "@fastify/cors": "^11.0",
+    "@fastify/cors": "^11.1",
     "@fastify/response-validation": "^3.0",
     "@fastify/swagger": "^9.5",
     "@types/fs-extra": "^11.0",
-    "@types/nodemailer": "^6.4",
+    "@types/nodemailer": "^7.0",
     "@types/yargs-parser": "^21.0",
     "ajv": "^8.17",
-    "argon2": "^0.41",
-    "bullmq": "^5.49",
-    "dotenv": "^16.5",
-    "fast-uri": "^3.0",
-    "fastify": "^5.3",
+    "argon2": "^0.44",
+    "bullmq": "^5.63",
+    "dotenv": "^17.2",
+    "fast-uri": "^3.1",
+    "fastify": "^5.6",
     "fs-extra": "^11.3",
-    "ical-generator": "^8.1",
-    "ioredis": "^5.6",
-    "jose": "^6.0",
-    "nodemailer": "^6.10",
+    "ical-generator": "^10.0",
+    "ioredis": "^5.8",
+    "jose": "^6.1",
+    "mysql2": "^3.15",
+    "nodemailer": "^7.0",
     "openapi-types": "^12.1",
-    "pino": "^9.6",
-    "pino-pretty": "^13.0",
-    "yargs-parser": "^21.1"
+    "pino": "^10.1",
+    "pino-pretty": "^13.1",
+    "sequelize": "^6.37",
+    "umzug": "^3.8",
+    "yargs-parser": "^22.0"
   },
   "peerDependencies": {
-    "@types/node": "^22.14",
-    "typescript": "^5.8"
+    "@types/node": "^24.10",
+    "typescript": "^5.9"
   },
   "exports": {
     "./cipher/Algorithm": {
@@ -200,6 +203,96 @@
         "default": "./dist/config/validatePropertyName.js"
       }
     },
+    "./db/DataType": {
+      "import": {
+        "types": "./dist/db/DataType.d.ts",
+        "default": "./dist/db/DataType.js"
+      }
+    },
+    "./db/Db": {
+      "import": {
+        "types": "./dist/db/Db.d.ts",
+        "default": "./dist/db/Db.js"
+      }
+    },
+    "./db/IndexType": {
+      "import": {
+        "types": "./dist/db/IndexType.d.ts",
+        "default": "./dist/db/IndexType.js"
+      }
+    },
+    "./db/Initializer": {
+      "import": {
+        "types": "./dist/db/Initializer.d.ts",
+        "default": "./dist/db/Initializer.js"
+      }
+    },
+    "./db/Migration": {
+      "import": {
+        "types": "./dist/db/Migration.d.ts",
+        "default": "./dist/db/Migration.js"
+      }
+    },
+    "./db/MigrationStatus": {
+      "import": {
+        "types": "./dist/db/MigrationStatus.d.ts",
+        "default": "./dist/db/MigrationStatus.js"
+      }
+    },
+    "./db/Migrator": {
+      "import": {
+        "types": "./dist/db/Migrator.d.ts",
+        "default": "./dist/db/Migrator.js"
+      }
+    },
+    "./db/Operator": {
+      "import": {
+        "types": "./dist/db/Operator.d.ts",
+        "default": "./dist/db/Operator.js"
+      }
+    },
+    "./db/Order": {
+      "import": {
+        "types": "./dist/db/Order.d.ts",
+        "default": "./dist/db/Order.js"
+      }
+    },
+    "./db/ReferentialAction": {
+      "import": {
+        "types": "./dist/db/ReferentialAction.d.ts",
+        "default": "./dist/db/ReferentialAction.js"
+      }
+    },
+    "./db/Seed": {
+      "import": {
+        "types": "./dist/db/Seed.d.ts",
+        "default": "./dist/db/Seed.js"
+      }
+    },
+    "./db/Seeder": {
+      "import": {
+        "types": "./dist/db/Seeder.d.ts",
+        "default": "./dist/db/Seeder.js"
+      }
+    },
+    "./db/Transaction": {
+      "import": {
+        "types": "./dist/db/Transaction.d.ts",
+        "default": "./dist/db/Transaction.js"
+      }
+    },
+    "./db/adapters/mysql/MysqlDb": {
+      "import": {
+        "types": "./dist/db/adapters/mysql/MysqlDb.d.ts",
+        "default": "./dist/db/adapters/mysql/MysqlDb.js"
+      }
+    },
+    "./db/relationships": {
+      "import": {
+        "types": "./dist/db/relationships.d.ts",
+        "default": "./dist/db/relationships.js"
+      }
+    },
     "./env/Env": {
       "import": {
         "types": "./dist/env/Env.d.ts",
@@ -608,6 +701,18 @@
         "default": "./dist/server/OpenApiFormat.js"
       }
     },
+    "./server/Request": {
+      "import": {
+        "types": "./dist/server/Request.d.ts",
+        "default": "./dist/server/Request.js"
+      }
+    },
+    "./server/Response": {
+      "import": {
+        "types": "./dist/server/Response.d.ts",
+        "default": "./dist/server/Response.js"
+      }
+    },
     "./server/Route": {
       "import": {
         "types": "./dist/server/Route.d.ts",