@ghom/orm 1.1.0 → 1.1.1

package/dist/app/orm.d.ts

@@ -1,11 +1,15 @@
 import { Handler } from "@ghom/handler";
 import { Knex } from "knex";
+export interface ORMLogger {
+    log: (message: string | number, ...parts: (string | number)[]) => unknown;
+    error: (err: Error | string | number, ...parts: (string | number)[]) => unknown;
+}
 /**
  * @property tablePath - path to directory that contains js files of tables
  * @property verbose - show console logs or not
  */
 export interface ORMConfig {
-    verbose?: boolean;
+    logger?: ORMLogger;
     tablePath: string;
 }
 export declare class ORM extends Handler {

package/dist/app/table.d.ts

@@ -18,6 +18,7 @@ export declare class Table<Type> {
     orm?: ORM;
     constructor(options: TableOptions<Type>);
     private get verbose();
+    private get logger();
     get db(): Knex<any, Record<string, any>[]>;
     get query(): Knex.QueryBuilder<Type, {
         _base: Type;

package/dist/app/table.js

@@ -8,7 +8,12 @@ class Table {
     get verbose() {
         if (!this.orm)
             throw new Error("missing ORM");
-        return this.orm.ormConfig.verbose;
+        return !!this.orm.ormConfig.logger;
+    }
+    get logger() {
+        if (!this.orm)
+            throw new Error("missing ORM");
+        return this.orm.ormConfig.logger;
     }
     get db() {
         if (!this.orm)
@@ -30,30 +35,25 @@ class Table {
     async make() {
         try {
             await this.db.schema.createTable(this.options.name, this.options.setup);
-            if (this.verbose)
-                console.log(`created table ${this.options.name}`);
+            this.logger?.log(`created table ${this.options.name}`);
         }
         catch (error) {
             if (error.toString().includes("syntax error")) {
-                if (this.verbose)
-                    console.error(`you need to implement the "setup" method in options of your ${this.options.name} table!`);
+                this.logger?.error(`you need to implement the "setup" method in options of your ${this.options.name} table!`);
                 throw error;
             }
             else {
-                if (this.verbose)
-                    console.log(`loaded table ${this.options.name}`);
+                this.logger?.log("loaded table", this.options.name);
             }
         }
         try {
             const migrated = await this.migrate();
             if (migrated !== false) {
-                if (this.verbose)
-                    console.log(`migrated table ${this.options.name} to version ${migrated}`);
+                this.logger?.log("migrated table", this.options.name, "to version", migrated);
             }
         }
         catch (error) {
-            if (this.verbose)
-                console.error(error);
+            this.logger?.error(error);
         }
         await this.options.then?.bind(this)(this);
         return this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/app/orm.ts

@@ -2,12 +2,20 @@ import { Handler } from "@ghom/handler"
 import { Knex, default as knex } from "knex"
 import { MigrationData, Table } from "./table"
 
+export interface ORMLogger {
+  log: (message: string | number, ...parts: (string | number)[]) => unknown
+  error: (
+    err: Error | string | number,
+    ...parts: (string | number)[]
+  ) => unknown
+}
+
 /**
  * @property tablePath - path to directory that contains js files of tables
  * @property verbose - show console logs or not
  */
 export interface ORMConfig {
-  verbose?: boolean
+  logger?: ORMLogger
   tablePath: string
 }
 

package/src/app/table.ts

@@ -21,7 +21,12 @@ export class Table<Type> {
 
   private get verbose() {
     if (!this.orm) throw new Error("missing ORM")
-    return this.orm.ormConfig.verbose
+    return !!this.orm.ormConfig.logger
+  }
+
+  private get logger() {
+    if (!this.orm) throw new Error("missing ORM")
+    return this.orm.ormConfig.logger
   }
 
   get db() {
@@ -47,17 +52,16 @@ export class Table<Type> {
   async make(): Promise<this> {
     try {
       await this.db.schema.createTable(this.options.name, this.options.setup)
-      if (this.verbose) console.log(`created table ${this.options.name}`)
+      this.logger?.log(`created table ${this.options.name}`)
     } catch (error: any) {
       if (error.toString().includes("syntax error")) {
-        if (this.verbose)
-          console.error(
-            `you need to implement the "setup" method in options of your ${this.options.name} table!`
-          )
+        this.logger?.error(
+          `you need to implement the "setup" method in options of your ${this.options.name} table!`
+        )
 
         throw error
       } else {
-        if (this.verbose) console.log(`loaded table ${this.options.name}`)
+        this.logger?.log("loaded table", this.options.name)
       }
     }
 
@@ -65,13 +69,15 @@ export class Table<Type> {
       const migrated = await this.migrate()
 
       if (migrated !== false) {
-        if (this.verbose)
-          console.log(
-            `migrated table ${this.options.name} to version ${migrated}`
-          )
+        this.logger?.log(
+          "migrated table",
+          this.options.name,
+          "to version",
+          migrated
+        )
       }
     } catch (error: any) {
-      if (this.verbose) console.error(error)
+      this.logger?.error(error)
     }
 
     await this.options.then?.bind(this)(this)

package/tests/test.js

@@ -7,7 +7,7 @@ const c = require("./tables/c")
 
 const orm = new ORM({
   tablePath: path.join(__dirname, "tables"),
-  verbose: false,
+  logger: console,
 })
 
 beforeAll(async () => {