@ghom/orm 1.3.4 → 1.4.0

package/dist/cjs/app/orm.js

@@ -29,53 +29,47 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ORM = void 0;
 const fs_1 = __importDefault(require("fs"));
 const url_1 = __importDefault(require("url"));
+const path_1 = __importDefault(require("path"));
 const handler_1 = require("@ghom/handler");
 const knex_1 = __importDefault(require("knex"));
 const table_js_1 = require("./table.js");
-const pack = JSON.parse(fs_1.default.readFileSync("./package.json", "utf8"));
+const pack = JSON.parse(fs_1.default.readFileSync(path_1.default.join(process.cwd(), "package.json"), "utf8"));
 const isCJS = pack.type === "commonjs" || pack.type == void 0;
-class ORM extends handler_1.Handler {
-    /**
-     * @param ormConfig configuration for table handler or just tablePath (path to directory that contains js files of tables)
-     * @param knexConfig configuration for connect to database
-     */
-    constructor(ormConfig, knexConfig = {
-        client: "sqlite3",
-        useNullAsDefault: true,
-        connection: {
-            filename: ":memory:",
-        },
-    }) {
-        super(typeof ormConfig === "string" ? ormConfig : ormConfig.tablePath);
-        this.ormConfig =
-            typeof ormConfig === "string" ? { tablePath: ormConfig } : ormConfig;
-        this.db = (0, knex_1.default)(knexConfig);
+class ORM {
+    constructor(config) {
+        this.config = config;
+        this.database = (0, knex_1.default)(config.database ?? {
+            client: "sqlite3",
+            useNullAsDefault: true,
+            connection: {
+                filename: ":memory:",
+            },
+        });
+        this.handler = new handler_1.Handler(config.location, {
+            loader: (filepath) => Promise.resolve(`${isCJS ? filepath : url_1.default.pathToFileURL(filepath).href}`).then(s => __importStar(require(s))).then((file) => file.default),
+        });
     }
     async init() {
-        this.once("finish", async (pathList) => {
-            const tables = await Promise.all(pathList.map(async (filepath) => {
-                return Promise.resolve(`${isCJS ? filepath : url_1.default.pathToFileURL(filepath).href}`).then(s => __importStar(require(s))).then((file) => file.default);
-            }));
-            const migration = new table_js_1.Table({
-                name: "migration",
-                priority: Infinity,
-                setup: (table) => {
-                    table.string("table").unique().notNullable();
-                    table.integer("version").notNullable();
-                },
-            });
-            migration.orm = this;
-            await migration.make();
-            for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
-                table.orm = this;
-                await table.make();
-            }
-        });
+        await this.handler.init();
+        const tables = [...this.handler.elements.values()];
         try {
-            await this.db.raw("PRAGMA foreign_keys = ON;");
+            await this.database.raw("PRAGMA foreign_keys = ON;");
         }
         catch (error) { }
-        await this.load();
+        const migration = new table_js_1.Table({
+            name: "migration",
+            priority: Infinity,
+            setup: (table) => {
+                table.string("table").unique().notNullable();
+                table.integer("version").notNullable();
+            },
+        });
+        migration.orm = this;
+        await migration.make();
+        for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
+            table.orm = this;
+            await table.make();
+        }
     }
 }
 exports.ORM = ORM;

package/dist/cjs/app/table.js

@@ -4,26 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Table = void 0;
-const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 class Table {
     constructor(options) {
         this.options = options;
     }
-    get filepath() {
-        if (!this.orm)
-            throw new Error("missing ORM");
-        return path_1.default.relative(process.cwd(), path_1.default.join(this.orm.ormConfig.tablePath, this.options.name + ".ts"));
-    }
-    get logger() {
-        if (!this.orm)
-            throw new Error("missing ORM");
-        return this.orm.ormConfig.logger;
-    }
     get db() {
         if (!this.orm)
             throw new Error("missing ORM");
-        return this.orm.db;
+        return this.orm.database;
     }
     get query() {
         return this.db(this.options.name);
@@ -38,27 +27,29 @@ class Table {
             .then((rows) => rows.length === 0);
     }
     async make() {
+        if (!this.orm)
+            throw new Error("missing ORM");
         try {
             await this.db.schema.createTable(this.options.name, this.options.setup);
-            this.logger?.log(`created table ${chalk_1.default.blueBright(this.options.name)}`);
+            this.orm.config.logger?.log(`created table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
         }
         catch (error) {
             if (error.toString().includes("syntax error")) {
-                this.logger?.error(`you need to implement the "setup" method in options of your ${chalk_1.default.blueBright(this.options.name)} table!`, this.filepath);
+                this.orm.config.logger?.error(`you need to implement the "setup" method in options of your ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)} table!`);
                 throw error;
             }
             else {
-                this.logger?.log(`loaded table ${chalk_1.default.blueBright(this.options.name)}`);
+                this.orm.config.logger?.log(`loaded table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
             }
         }
         try {
             const migrated = await this.migrate();
             if (migrated !== false) {
-                this.logger?.log(`migrated table ${chalk_1.default.blueBright(this.options.name)} to version ${chalk_1.default.magentaBright(migrated)}`);
+                this.orm.config.logger?.log(`migrated table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)} to version ${chalk_1.default[this.orm.config.loggerColors?.rawValue ?? "magentaBright"](migrated)}`);
             }
         }
         catch (error) {
-            this.logger?.error(error, this.filepath);
+            this.orm.config.logger?.error(error);
         }
         await this.options.then?.bind(this)(this);
         return this;

package/dist/esm/app/orm.js

@@ -1,53 +1,48 @@
 import fs from "fs";
 import url from "url";
+import path from "path";
 import { Handler } from "@ghom/handler";
 import { default as knex } from "knex";
 import { Table } from "./table.js";
-const pack = JSON.parse(fs.readFileSync("./package.json", "utf8"));
+const pack = JSON.parse(fs.readFileSync(path.join(process.cwd(), "package.json"), "utf8"));
 const isCJS = pack.type === "commonjs" || pack.type == void 0;
-export class ORM extends Handler {
-    db;
-    ormConfig;
-    /**
-     * @param ormConfig configuration for table handler or just tablePath (path to directory that contains js files of tables)
-     * @param knexConfig configuration for connect to database
-     */
-    constructor(ormConfig, knexConfig = {
-        client: "sqlite3",
-        useNullAsDefault: true,
-        connection: {
-            filename: ":memory:",
-        },
-    }) {
-        super(typeof ormConfig === "string" ? ormConfig : ormConfig.tablePath);
-        this.ormConfig =
-            typeof ormConfig === "string" ? { tablePath: ormConfig } : ormConfig;
-        this.db = knex(knexConfig);
+export class ORM {
+    config;
+    database;
+    handler;
+    constructor(config) {
+        this.config = config;
+        this.database = knex(config.database ?? {
+            client: "sqlite3",
+            useNullAsDefault: true,
+            connection: {
+                filename: ":memory:",
+            },
+        });
+        this.handler = new Handler(config.location, {
+            loader: (filepath) => import(isCJS ? filepath : url.pathToFileURL(filepath).href).then((file) => file.default),
+        });
     }
     async init() {
-        this.once("finish", async (pathList) => {
-            const tables = await Promise.all(pathList.map(async (filepath) => {
-                return import(isCJS ? filepath : url.pathToFileURL(filepath).href).then((file) => file.default);
-            }));
-            const migration = new Table({
-                name: "migration",
-                priority: Infinity,
-                setup: (table) => {
-                    table.string("table").unique().notNullable();
-                    table.integer("version").notNullable();
-                },
-            });
-            migration.orm = this;
-            await migration.make();
-            for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
-                table.orm = this;
-                await table.make();
-            }
-        });
+        await this.handler.init();
+        const tables = [...this.handler.elements.values()];
         try {
-            await this.db.raw("PRAGMA foreign_keys = ON;");
+            await this.database.raw("PRAGMA foreign_keys = ON;");
         }
         catch (error) { }
-        await this.load();
+        const migration = new Table({
+            name: "migration",
+            priority: Infinity,
+            setup: (table) => {
+                table.string("table").unique().notNullable();
+                table.integer("version").notNullable();
+            },
+        });
+        migration.orm = this;
+        await migration.make();
+        for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
+            table.orm = this;
+            await table.make();
+        }
     }
 }

package/dist/esm/app/table.js

@@ -1,4 +1,3 @@
-import path from "path";
 import chalk from "chalk";
 export class Table {
     options;
@@ -6,20 +5,10 @@ export class Table {
     constructor(options) {
         this.options = options;
     }
-    get filepath() {
-        if (!this.orm)
-            throw new Error("missing ORM");
-        return path.relative(process.cwd(), path.join(this.orm.ormConfig.tablePath, this.options.name + ".ts"));
-    }
-    get logger() {
-        if (!this.orm)
-            throw new Error("missing ORM");
-        return this.orm.ormConfig.logger;
-    }
     get db() {
         if (!this.orm)
             throw new Error("missing ORM");
-        return this.orm.db;
+        return this.orm.database;
     }
     get query() {
         return this.db(this.options.name);
@@ -34,27 +23,29 @@ export class Table {
             .then((rows) => rows.length === 0);
     }
     async make() {
+        if (!this.orm)
+            throw new Error("missing ORM");
         try {
             await this.db.schema.createTable(this.options.name, this.options.setup);
-            this.logger?.log(`created table ${chalk.blueBright(this.options.name)}`);
+            this.orm.config.logger?.log(`created table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
         }
         catch (error) {
             if (error.toString().includes("syntax error")) {
-                this.logger?.error(`you need to implement the "setup" method in options of your ${chalk.blueBright(this.options.name)} table!`, this.filepath);
+                this.orm.config.logger?.error(`you need to implement the "setup" method in options of your ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)} table!`);
                 throw error;
             }
             else {
-                this.logger?.log(`loaded table ${chalk.blueBright(this.options.name)}`);
+                this.orm.config.logger?.log(`loaded table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
             }
         }
         try {
             const migrated = await this.migrate();
             if (migrated !== false) {
-                this.logger?.log(`migrated table ${chalk.blueBright(this.options.name)} to version ${chalk.magentaBright(migrated)}`);
+                this.orm.config.logger?.log(`migrated table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)} to version ${chalk[this.orm.config.loggerColors?.rawValue ?? "magentaBright"](migrated)}`);
             }
         }
         catch (error) {
-            this.logger?.error(error, this.filepath);
+            this.orm.config.logger?.error(error);
         }
         await this.options.then?.bind(this)(this);
         return this;

package/dist/typings/app/orm.d.ts

@@ -1,24 +1,37 @@
 import { Handler } from "@ghom/handler";
 import { Knex } from "knex";
-export interface ORMLogger {
-    log: (message: string, section?: string) => void;
-    error: (text: string | Error, _path: string, full?: boolean) => void;
+import { Table } from "./table.js";
+import { Color } from "chalk";
+export interface ILogger {
+    log: (...message: string[]) => void;
+    error: (error: Error | string, ...message: string[]) => void;
 }
-/**
- * @property tablePath - path to directory that contains js files of tables
- * @property verbose - show console logs or not
- */
 export interface ORMConfig {
-    logger?: ORMLogger;
-    tablePath: string;
-}
-export declare class ORM extends Handler {
-    db: Knex;
-    ormConfig: ORMConfig;
     /**
-     * @param ormConfig configuration for table handler or just tablePath (path to directory that contains js files of tables)
-     * @param knexConfig configuration for connect to database
+     * path to the directory that contains js files of tables
+     */
+    location: string;
+    /**
+     * database configuration
+     */
+    database?: Knex.Config;
+    /**
+     * Logger used to log the table files loaded or created.
+     */
+    logger?: ILogger;
+    /**
+     * Pattern used on logs when the table files are loaded or created. <br>
+     * Based on Chalk color-method names.
      */
-    constructor(ormConfig: ORMConfig | string, knexConfig?: Knex.Config);
+    loggerColors?: {
+        highlight: typeof Color;
+        rawValue: typeof Color;
+    };
+}
+export declare class ORM {
+    config: ORMConfig;
+    database: Knex;
+    handler: Handler<Table<any>>;
+    constructor(config: ORMConfig);
     init(): Promise<void>;
 }

package/dist/typings/app/table.d.ts

@@ -17,8 +17,6 @@ export declare class Table<Type extends {}> {
     readonly options: TableOptions<Type>;
     orm?: ORM;
     constructor(options: TableOptions<Type>);
-    private get filepath();
-    private get logger();
     get db(): Knex<any, any[]>;
     get query(): Knex.QueryBuilder<Type, {
         _base: Type;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "license": "MIT",
   "type": "module",
   "main": "dist/esm/index.js",
@@ -20,20 +20,20 @@
     "prepublishOnly": "npm run format && npm test"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^18.15.11",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.16.3",
     "dotenv": "^16.0.3",
     "jest": "^29.5.0",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "typescript": "^5.0.4"
   },
   "optionalDependencies": {
-    "mysql2": "^3.2.1",
+    "mysql2": "^3.2.4",
     "pg": "^8.10.0",
     "sqlite3": "^5.1.6"
   },
   "dependencies": {
-    "@ghom/handler": "^1.1.0",
+    "@ghom/handler": "^1.2.0",
     "knex": "^2.4.2"
   }
 }

package/src/app/orm.ts

@@ -1,84 +1,95 @@
 import fs from "fs"
 import url from "url"
+import path from "path"
 import { Handler } from "@ghom/handler"
 import { Knex, default as knex } from "knex"
 import { MigrationData, Table } from "./table.js"
+import { Color } from "chalk"
 
-const pack = JSON.parse(fs.readFileSync("./package.json", "utf8"))
+const pack = JSON.parse(
+  fs.readFileSync(path.join(process.cwd(), "package.json"), "utf8")
+)
 const isCJS = pack.type === "commonjs" || pack.type == void 0
 
-export interface ORMLogger {
-  log: (message: string, section?: string) => void
-  error: (text: string | Error, _path: string, full?: boolean) => void
+export interface ILogger {
+  log: (...message: string[]) => void
+  error: (error: Error | string, ...message: string[]) => void
 }
 
-/**
- * @property tablePath - path to directory that contains js files of tables
- * @property verbose - show console logs or not
- */
 export interface ORMConfig {
-  logger?: ORMLogger
-  tablePath: string
-}
+  /**
+   * path to the directory that contains js files of tables
+   */
+  location: string
 
-export class ORM extends Handler {
-  db: Knex
-  ormConfig: ORMConfig
+  /**
+   * database configuration
+   */
+  database?: Knex.Config
 
   /**
-   * @param ormConfig configuration for table handler or just tablePath (path to directory that contains js files of tables)
-   * @param knexConfig configuration for connect to database
+   * Logger used to log the table files loaded or created.
    */
-  constructor(
-    ormConfig: ORMConfig | string,
-    knexConfig: Knex.Config = {
-      client: "sqlite3",
-      useNullAsDefault: true,
-      connection: {
-        filename: ":memory:",
-      },
-    }
-  ) {
-    super(typeof ormConfig === "string" ? ormConfig : ormConfig.tablePath)
-    this.ormConfig =
-      typeof ormConfig === "string" ? { tablePath: ormConfig } : ormConfig
-    this.db = knex(knexConfig)
+  logger?: ILogger
+
+  /**
+   * Pattern used on logs when the table files are loaded or created. <br>
+   * Based on Chalk color-method names.
+   */
+  loggerColors?: {
+    highlight: typeof Color
+    rawValue: typeof Color
   }
+}
 
-  async init() {
-    this.once("finish", async (pathList) => {
-      const tables: Table<any>[] = await Promise.all(
-        pathList.map(async (filepath) => {
-          return import(
-            isCJS ? filepath : url.pathToFileURL(filepath).href
-          ).then((file) => file.default)
-        })
-      )
+export class ORM {
+  database: Knex
+  handler: Handler<Table<any>>
 
-      const migration = new Table<MigrationData>({
-        name: "migration",
-        priority: Infinity,
-        setup: (table) => {
-          table.string("table").unique().notNullable()
-          table.integer("version").notNullable()
+  constructor(public config: ORMConfig) {
+    this.database = knex(
+      config.database ?? {
+        client: "sqlite3",
+        useNullAsDefault: true,
+        connection: {
+          filename: ":memory:",
         },
-      })
-
-      migration.orm = this
-      await migration.make()
-
-      for (const table of tables.sort(
-        (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
-      )) {
-        table.orm = this
-        await table.make()
       }
+    )
+    this.handler = new Handler(config.location, {
+      loader: (filepath) =>
+        import(isCJS ? filepath : url.pathToFileURL(filepath).href).then(
+          (file) => file.default
+        ),
     })
+  }
+
+  async init() {
+    await this.handler.init()
+
+    const tables = [...this.handler.elements.values()]
 
     try {
-      await this.db.raw("PRAGMA foreign_keys = ON;")
+      await this.database.raw("PRAGMA foreign_keys = ON;")
     } catch (error) {}
 
-    await this.load()
+    const migration = new Table<MigrationData>({
+      name: "migration",
+      priority: Infinity,
+      setup: (table) => {
+        table.string("table").unique().notNullable()
+        table.integer("version").notNullable()
+      },
+    })
+
+    migration.orm = this
+    await migration.make()
+
+    for (const table of tables.sort(
+      (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
+    )) {
+      table.orm = this
+      await table.make()
+    }
   }
 }

package/src/app/table.ts

@@ -1,4 +1,3 @@
-import path from "path"
 import chalk from "chalk"
 import { Knex } from "knex"
 import { ORM } from "./orm.js"
@@ -21,22 +20,9 @@ export class Table<Type extends {}> {
 
   constructor(public readonly options: TableOptions<Type>) {}
 
-  private get filepath() {
-    if (!this.orm) throw new Error("missing ORM")
-    return path.relative(
-      process.cwd(),
-      path.join(this.orm.ormConfig.tablePath, this.options.name + ".ts")
-    )
-  }
-
-  private get logger() {
-    if (!this.orm) throw new Error("missing ORM")
-    return this.orm.ormConfig.logger
-  }
-
   get db() {
     if (!this.orm) throw new Error("missing ORM")
-    return this.orm.db
+    return this.orm.database
   }
 
   get query() {
@@ -55,21 +41,31 @@ export class Table<Type extends {}> {
   }
 
   async make(): Promise<this> {
+    if (!this.orm) throw new Error("missing ORM")
+
     try {
       await this.db.schema.createTable(this.options.name, this.options.setup)
-      this.logger?.log(`created table ${chalk.blueBright(this.options.name)}`)
+
+      this.orm.config.logger?.log(
+        `created table ${chalk[
+          this.orm.config.loggerColors?.highlight ?? "blueBright"
+        ](this.options.name)}`
+      )
     } catch (error: any) {
       if (error.toString().includes("syntax error")) {
-        this.logger?.error(
-          `you need to implement the "setup" method in options of your ${chalk.blueBright(
-            this.options.name
-          )} table!`,
-          this.filepath
+        this.orm.config.logger?.error(
+          `you need to implement the "setup" method in options of your ${chalk[
+            this.orm.config.loggerColors?.highlight ?? "blueBright"
+          ](this.options.name)} table!`
         )
 
         throw error
       } else {
-        this.logger?.log(`loaded table ${chalk.blueBright(this.options.name)}`)
+        this.orm.config.logger?.log(
+          `loaded table ${chalk[
+            this.orm.config.loggerColors?.highlight ?? "blueBright"
+          ](this.options.name)}`
+        )
       }
     }
 
@@ -77,14 +73,16 @@ export class Table<Type extends {}> {
       const migrated = await this.migrate()
 
       if (migrated !== false) {
-        this.logger?.log(
-          `migrated table ${chalk.blueBright(
-            this.options.name
-          )} to version ${chalk.magentaBright(migrated)}`
+        this.orm.config.logger?.log(
+          `migrated table ${chalk[
+            this.orm.config.loggerColors?.highlight ?? "blueBright"
+          ](this.options.name)} to version ${chalk[
+            this.orm.config.loggerColors?.rawValue ?? "magentaBright"
+          ](migrated)}`
         )
       }
     } catch (error: any) {
-      this.logger?.error(error, this.filepath)
+      this.orm.config.logger?.error(error)
     }
 
     await this.options.then?.bind(this)(this)

package/tests/test.js

@@ -10,8 +10,7 @@ import b from "./tables/b"
 import c from "./tables/c"
 
 const orm = new ORM({
-  tablePath: path.join("tests","tables"),
-  logger: console,
+  location: path.join("tests","tables")
 })
 
 beforeAll(async () => {
@@ -19,18 +18,18 @@ beforeAll(async () => {
 })
 
 test("tables created", async () => {
-  expect(await orm.db.schema.hasTable("migration")).toBeTruthy()
-  expect(await orm.db.schema.hasTable("a")).toBeTruthy()
-  expect(await orm.db.schema.hasTable("b")).toBeTruthy()
-  expect(await orm.db.schema.hasTable("c")).toBeTruthy()
+  expect(await orm.database.schema.hasTable("migration")).toBeTruthy()
+  expect(await orm.database.schema.hasTable("a")).toBeTruthy()
+  expect(await orm.database.schema.hasTable("b")).toBeTruthy()
+  expect(await orm.database.schema.hasTable("c")).toBeTruthy()
 })
 
 test("migrations ran", async () => {
-  expect(await orm.db.schema.hasColumn("b", "c_id")).toBeTruthy()
+  expect(await orm.database.schema.hasColumn("b", "c_id")).toBeTruthy()
 })
 
 test("then ran", async () => {
-  const rows = await orm.db("a").select()
+  const rows = await orm.database("a").select()
   expect(rows.length).toBe(1)
 })
 
@@ -40,5 +39,5 @@ test("cascade delete", async () => {
 })
 
 afterAll(async () => {
-  await orm.db.destroy()
+  await orm.database.destroy()
 })