@ghom/orm 1.0.0 → 1.1.2

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, section?: string) => void;
+    error: (text: string | Error, _path: string, full?: boolean) => void;
+}
 /**
  * @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/orm.js

@@ -48,21 +48,25 @@ class ORM extends handler_1.Handler {
             const tables = await Promise.all(pathList.map(async (filepath) => {
                 return Promise.resolve().then(() => __importStar(require(filepath))).then((file) => file.default);
             }));
-            tables.unshift(new table_1.Table({
+            const migration = new table_1.Table({
                 name: "migration",
                 priority: Infinity,
                 setup: (table) => {
                     table.string("table").unique().notNullable();
                     table.integer("version").notNullable();
                 },
-            }));
-            tables.forEach((table) => (table.orm = this));
-            return Promise.all(tables
-                .sort((a, b) => {
-                return (b.options.priority ?? 0) - (a.options.priority ?? 0);
-            })
-                .map((table) => table.make()));
+            });
+            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();
+            }
         });
+        try {
+            await this.db.raw("PRAGMA foreign_keys = ON;");
+        }
+        catch (error) { }
         await this.load();
     }
 }

package/dist/app/table.d.ts

@@ -10,13 +10,15 @@ export interface TableOptions<Type> {
     migrations?: {
         [version: number]: (table: Knex.CreateTableBuilder) => void;
     };
+    then?: (this: Table<Type>, table: Table<Type>) => unknown;
     setup: (table: Knex.CreateTableBuilder) => void;
 }
 export declare class Table<Type> {
     readonly options: TableOptions<Type>;
     orm?: ORM;
     constructor(options: TableOptions<Type>);
-    private get verbose();
+    private get filepath();
+    private get logger();
     get db(): Knex<any, Record<string, any>[]>;
     get query(): Knex.QueryBuilder<Type, {
         _base: Type;
@@ -27,6 +29,8 @@ export declare class Table<Type> {
         _intersectProps: {};
         _unionProps: never;
     }[]>;
+    hasColumn(name: keyof Type): Promise<boolean>;
+    isEmpty(): Promise<boolean>;
     make(): Promise<this>;
     private migrate;
 }

package/dist/app/table.js

@@ -1,14 +1,24 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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 verbose() {
+    get filepath() {
         if (!this.orm)
             throw new Error("missing ORM");
-        return this.orm.ormConfig.verbose;
+        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)
@@ -18,34 +28,39 @@ class Table {
     get query() {
         return this.db(this.options.name);
     }
+    async hasColumn(name) {
+        return this.db.schema.hasColumn(this.options.name, name);
+    }
+    async isEmpty() {
+        return this.query
+            .select()
+            .limit(1)
+            .then((rows) => rows.length === 0);
+    }
     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 ${chalk_1.default.blueBright(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 ${chalk_1.default.blueBright(this.options.name)} table!`, this.filepath);
                 throw error;
             }
             else {
-                if (this.verbose)
-                    console.log(`loaded table ${this.options.name}`);
+                this.logger?.log(`loaded table ${chalk_1.default.blueBright(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 ${chalk_1.default.blueBright(this.options.name)} to version ${chalk_1.default.magentaBright(migrated)}`);
             }
         }
         catch (error) {
-            if (this.verbose)
-                console.error(error);
+            this.logger?.error(error, this.filepath);
         }
+        await this.options.then?.bind(this)(this);
         return this;
     }
     async migrate() {
@@ -59,7 +74,7 @@ class Table {
             .first();
         const data = fromDatabase || {
             table: this.options.name,
-            version: -1,
+            version: -Infinity,
         };
         const baseVersion = data.version;
         await this.db.schema.alterTable(this.options.name, (builder) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,12 +17,14 @@
   "devDependencies": {
     "@vscode/sqlite3": "^5.0.7",
     "better-sqlite3": "^7.5.0",
+    "dotenv": "^16.0.0",
     "jest": "^27.5.1",
     "prettier": "^2.5.1",
     "typescript": "^4.5.5"
   },
   "dependencies": {
     "@ghom/handler": "^1.1.0",
+    "chalk": "^4.1.2",
     "knex": "^1.0.3"
   }
 }

package/src/app/orm.ts

@@ -2,12 +2,17 @@ import { Handler } from "@ghom/handler"
 import { Knex, default as knex } from "knex"
 import { MigrationData, Table } from "./table"
 
+export interface ORMLogger {
+  log: (message: string, section?: string) => void
+  error: (text: string | Error, _path: string, full?: boolean) => void
+}
+
 /**
  * @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
 }
 
@@ -43,28 +48,30 @@ export class ORM extends Handler {
         })
       )
 
-      tables.unshift(
-        new Table<MigrationData>({
-          name: "migration",
-          priority: Infinity,
-          setup: (table) => {
-            table.string("table").unique().notNullable()
-            table.integer("version").notNullable()
-          },
-        })
-      )
+      const migration = new Table<MigrationData>({
+        name: "migration",
+        priority: Infinity,
+        setup: (table) => {
+          table.string("table").unique().notNullable()
+          table.integer("version").notNullable()
+        },
+      })
 
-      tables.forEach((table) => (table.orm = this))
+      migration.orm = this
+      await migration.make()
 
-      return Promise.all(
-        tables
-          .sort((a, b) => {
-            return (b.options.priority ?? 0) - (a.options.priority ?? 0)
-          })
-          .map((table) => table.make())
-      )
+      for (const table of tables.sort(
+        (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
+      )) {
+        table.orm = this
+        await table.make()
+      }
     })
 
+    try {
+      await this.db.raw("PRAGMA foreign_keys = ON;")
+    } catch (error) {}
+
     await this.load()
   }
 }

package/src/app/table.ts

@@ -1,3 +1,5 @@
+import path from "path"
+import chalk from "chalk"
 import { Knex } from "knex"
 import { ORM } from "./orm.js"
 
@@ -10,6 +12,7 @@ export interface TableOptions<Type> {
   name: string
   priority?: number
   migrations?: { [version: number]: (table: Knex.CreateTableBuilder) => void }
+  then?: (this: Table<Type>, table: Table<Type>) => unknown
   setup: (table: Knex.CreateTableBuilder) => void
 }
 
@@ -18,9 +21,17 @@ export class Table<Type> {
 
   constructor(public readonly options: TableOptions<Type>) {}
 
-  private get verbose() {
+  private get filepath() {
     if (!this.orm) throw new Error("missing ORM")
-    return this.orm.ormConfig.verbose
+    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() {
@@ -32,20 +43,33 @@ export class Table<Type> {
     return this.db<Type>(this.options.name)
   }
 
+  async hasColumn(name: keyof Type): Promise<boolean> {
+    return this.db.schema.hasColumn(this.options.name, name as string)
+  }
+
+  async isEmpty(): Promise<boolean> {
+    return this.query
+      .select()
+      .limit(1)
+      .then((rows) => rows.length === 0)
+  }
+
   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 ${chalk.blueBright(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 ${chalk.blueBright(
+            this.options.name
+          )} table!`,
+          this.filepath
+        )
 
         throw error
       } else {
-        if (this.verbose) console.log(`loaded table ${this.options.name}`)
+        this.logger?.log(`loaded table ${chalk.blueBright(this.options.name)}`)
       }
     }
 
@@ -53,15 +77,18 @@ 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 ${chalk.blueBright(
+            this.options.name
+          )} to version ${chalk.magentaBright(migrated)}`
+        )
       }
     } catch (error: any) {
-      if (this.verbose) console.error(error)
+      this.logger?.error(error, this.filepath)
     }
 
+    await this.options.then?.bind(this)(this)
+
     return this
   }
 
@@ -83,7 +110,7 @@ export class Table<Type> {
 
     const data = fromDatabase || {
       table: this.options.name,
-      version: -1,
+      version: -Infinity,
     }
 
     const baseVersion = data.version

package/tests/.env

@@ -0,0 +1 @@
+DEBUG=knex*

package/tests/tables/a.js

@@ -3,8 +3,19 @@ const { Table } = require("../../dist/index")
 module.exports = new Table({
   name: "a",
   priority: 0,
-  setup: (table) => {
-    table.increments("id").primary()
-    table.integer("b_id").references("id").inTable("b").notNullable()
+  setup(table) {
+    table.increments("id").primary().notNullable()
+    table
+      .integer("b_id")
+      .references("id")
+      .inTable("b")
+      .onDelete("cascade")
+      .notNullable()
+  },
+  async then({ query }) {
+    await query.insert({
+      id: 0,
+      b_id: 0,
+    })
   },
 })

package/tests/tables/b.js

@@ -4,10 +4,21 @@ module.exports = new Table({
   name: "b",
   migrations: {
     0: (table) =>
-      table.integer("c_id").references("id").inTable("c").notNullable(),
+      table
+        .integer("c_id")
+        .references("id")
+        .inTable("c")
+        .onDelete("cascade")
+        .notNullable(),
   },
   priority: 1,
-  setup: (table) => {
-    table.increments("id").primary()
+  setup(table) {
+    table.increments("id").primary().notNullable()
+  },
+  async then({ query }) {
+    await query.insert({
+      id: 0,
+      c_id: 0,
+    })
   },
 })

package/tests/tables/c.js

@@ -3,7 +3,10 @@ const { Table } = require("../../dist/index")
 module.exports = new Table({
   name: "c",
   priority: 2,
-  setup: (table) => {
-    table.increments("id").primary()
+  setup(table) {
+    table.increments("id").primary().notNullable()
+  },
+  async then({ query }) {
+    await query.insert({ id: 0 })
   },
 })

package/tests/test.js

@@ -1,9 +1,13 @@
+require("dotenv").config({ path: "./.env" })
 const path = require("path")
 const { ORM } = require("../dist/index")
+const a = require("./tables/a")
+const b = require("./tables/b")
+const c = require("./tables/c")
 
 const orm = new ORM({
   tablePath: path.join(__dirname, "tables"),
-  verbose: false,
+  logger: console,
 })
 
 beforeAll(async () => {
@@ -21,6 +25,16 @@ test("migrations ran", async () => {
   expect(await orm.db.schema.hasColumn("b", "c_id")).toBeTruthy()
 })
 
+test("then ran", async () => {
+  const rows = await orm.db("a").select()
+  expect(rows.length).toBe(1)
+})
+
+test("cascade delete", async () => {
+  await c.query.del()
+  expect(await a.isEmpty()).toBeTruthy()
+})
+
 afterAll(async () => {
   await orm.db.destroy()
 })