@ghom/orm 1.5.2 → 1.6.0

package/dist/cjs/app/orm.js

@@ -50,9 +50,23 @@ class ORM {
             pattern: /\.js$/,
         });
     }
+    get cachedTables() {
+        return [...this.handler.elements.values()];
+    }
+    get cachedTableNames() {
+        return this.cachedTables.map((table) => table.options.name);
+    }
+    hasCachedTable(name) {
+        return this.cachedTables.some((table) => table.options.name);
+    }
+    async hasTable(name) {
+        return this.database.schema.hasTable(name);
+    }
+    /**
+     * Handle the table files and create the tables in the database.
+     */
     async init() {
         await this.handler.init();
-        const tables = [...this.handler.elements.values()];
         try {
             await this.database.raw("PRAGMA foreign_keys = ON;");
         }
@@ -67,11 +81,14 @@ class ORM {
         });
         migration.orm = this;
         await migration.make();
-        for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
+        for (const table of this.cachedTables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
             table.orm = this;
             await table.make();
         }
     }
+    async raw(sql) {
+        return this.database.raw(sql);
+    }
     /**
      * Extract the database to a CSV file.
      */

package/dist/cjs/app/table.js

@@ -17,9 +17,18 @@ class Table {
     get query() {
         return this.db(this.options.name);
     }
+    async count(where) {
+        return this.query
+            .select(this.db.raw("count(*) as total"))
+            .whereRaw(where ?? "1=1")
+            .then((rows) => rows[0].total);
+    }
     async hasColumn(name) {
         return this.db.schema.hasColumn(this.options.name, name);
     }
+    async getColumn(name) {
+        return this.db(this.options.name).columnInfo(name);
+    }
     async getColumns() {
         return this.db(this.options.name).columnInfo();
     }
@@ -27,10 +36,7 @@ class Table {
         return this.getColumns().then(Object.keys);
     }
     async isEmpty() {
-        return this.query
-            .select()
-            .limit(1)
-            .then((rows) => rows.length === 0);
+        return this.count().then((count) => count === 0);
     }
     async make() {
         if (!this.orm)
@@ -56,8 +62,10 @@ class Table {
         }
         catch (error) {
             this.orm.config.logger?.error(error);
+            throw error;
         }
-        await this.options.then?.bind(this)(this);
+        if ((await this.count()) === 0)
+            await this.options.then?.bind(this)(this);
         return this;
     }
     async migrate() {

package/dist/esm/app/orm.js

@@ -24,9 +24,23 @@ export class ORM {
             pattern: /\.js$/,
         });
     }
+    get cachedTables() {
+        return [...this.handler.elements.values()];
+    }
+    get cachedTableNames() {
+        return this.cachedTables.map((table) => table.options.name);
+    }
+    hasCachedTable(name) {
+        return this.cachedTables.some((table) => table.options.name);
+    }
+    async hasTable(name) {
+        return this.database.schema.hasTable(name);
+    }
+    /**
+     * Handle the table files and create the tables in the database.
+     */
     async init() {
         await this.handler.init();
-        const tables = [...this.handler.elements.values()];
         try {
             await this.database.raw("PRAGMA foreign_keys = ON;");
         }
@@ -41,11 +55,14 @@ export class ORM {
         });
         migration.orm = this;
         await migration.make();
-        for (const table of tables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
+        for (const table of this.cachedTables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
             table.orm = this;
             await table.make();
         }
     }
+    async raw(sql) {
+        return this.database.raw(sql);
+    }
     /**
      * Extract the database to a CSV file.
      */

package/dist/esm/app/table.js

@@ -13,9 +13,18 @@ export class Table {
     get query() {
         return this.db(this.options.name);
     }
+    async count(where) {
+        return this.query
+            .select(this.db.raw("count(*) as total"))
+            .whereRaw(where ?? "1=1")
+            .then((rows) => rows[0].total);
+    }
     async hasColumn(name) {
         return this.db.schema.hasColumn(this.options.name, name);
     }
+    async getColumn(name) {
+        return this.db(this.options.name).columnInfo(name);
+    }
     async getColumns() {
         return this.db(this.options.name).columnInfo();
     }
@@ -23,10 +32,7 @@ export class Table {
         return this.getColumns().then(Object.keys);
     }
     async isEmpty() {
-        return this.query
-            .select()
-            .limit(1)
-            .then((rows) => rows.length === 0);
+        return this.count().then((count) => count === 0);
     }
     async make() {
         if (!this.orm)
@@ -52,8 +58,10 @@ export class Table {
         }
         catch (error) {
             this.orm.config.logger?.error(error);
+            throw error;
         }
-        await this.options.then?.bind(this)(this);
+        if ((await this.count()) === 0)
+            await this.options.then?.bind(this)(this);
         return this;
     }
     async migrate() {

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

@@ -33,7 +33,15 @@ export declare class ORM {
     database: Knex;
     handler: Handler<Table<any>>;
     constructor(config: ORMConfig);
+    get cachedTables(): Table<any>[];
+    get cachedTableNames(): string[];
+    hasCachedTable(name: string): boolean;
+    hasTable(name: string): Promise<boolean>;
+    /**
+     * Handle the table files and create the tables in the database.
+     */
     init(): Promise<void>;
+    raw(sql: Knex.Value): Promise<Knex.Raw>;
     /**
      * Extract the database to a CSV file.
      */

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

@@ -4,7 +4,7 @@ export interface MigrationData {
     table: string;
     version: number;
 }
-export interface TableOptions<Type extends {}> {
+export interface TableOptions<Type extends object = object> {
     name: string;
     priority?: number;
     migrations?: {
@@ -13,7 +13,7 @@ export interface TableOptions<Type extends {}> {
     then?: (this: Table<Type>, table: Table<Type>) => unknown;
     setup: (table: Knex.CreateTableBuilder) => void;
 }
-export declare class Table<Type extends {}> {
+export declare class Table<Type extends object = object> {
     readonly options: TableOptions<Type>;
     orm?: ORM;
     constructor(options: TableOptions<Type>);
@@ -27,9 +27,11 @@ export declare class Table<Type extends {}> {
         _intersectProps: {};
         _unionProps: never;
     }[]>;
+    count(where?: string): Promise<number>;
     hasColumn(name: keyof Type): Promise<boolean>;
-    getColumns(): Promise<Record<string | number | symbol, Knex.ColumnInfo>>;
-    getColumnNames(): Promise<string[]>;
+    getColumn(name: keyof Type): Promise<Knex.ColumnInfo>;
+    getColumns(): Promise<Record<keyof Type, Knex.ColumnInfo>>;
+    getColumnNames(): Promise<Array<keyof Type>>;
     isEmpty(): Promise<boolean>;
     make(): Promise<this>;
     private migrate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "license": "MIT",
   "type": "module",
   "main": "dist/esm/index.js",

package/src/app/orm.ts

@@ -43,8 +43,8 @@ export interface ORMConfig {
 }
 
 export class ORM {
-  database: Knex
-  handler: Handler<Table<any>>
+  public database: Knex
+  public handler: Handler<Table<any>>
 
   constructor(public config: ORMConfig) {
     this.database = knex(
@@ -56,6 +56,7 @@ export class ORM {
         },
       }
     )
+
     this.handler = new Handler(config.location, {
       loader: (filepath) =>
         import(isCJS ? filepath : url.pathToFileURL(filepath).href).then(
@@ -65,11 +66,28 @@ export class ORM {
     })
   }
 
+  get cachedTables() {
+    return [...this.handler.elements.values()]
+  }
+
+  get cachedTableNames() {
+    return this.cachedTables.map((table) => table.options.name)
+  }
+
+  hasCachedTable(name: string) {
+    return this.cachedTables.some((table) => table.options.name)
+  }
+
+  async hasTable(name: string): Promise<boolean> {
+    return this.database.schema.hasTable(name)
+  }
+
+  /**
+   * Handle the table files and create the tables in the database.
+   */
   async init() {
     await this.handler.init()
 
-    const tables = [...this.handler.elements.values()]
-
     try {
       await this.database.raw("PRAGMA foreign_keys = ON;")
     } catch (error) {}
@@ -86,7 +104,7 @@ export class ORM {
     migration.orm = this
     await migration.make()
 
-    for (const table of tables.sort(
+    for (const table of this.cachedTables.sort(
       (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
     )) {
       table.orm = this
@@ -94,6 +112,10 @@ export class ORM {
     }
   }
 
+  async raw(sql: Knex.Value): Promise<Knex.Raw> {
+    return this.database.raw(sql)
+  }
+
   /**
    * Extract the database to a CSV file.
    */

package/src/app/table.ts

@@ -7,7 +7,7 @@ export interface MigrationData {
   version: number
 }
 
-export interface TableOptions<Type extends {}> {
+export interface TableOptions<Type extends object = object> {
   name: string
   priority?: number
   migrations?: { [version: number]: (table: Knex.CreateTableBuilder) => void }
@@ -15,7 +15,7 @@ export interface TableOptions<Type extends {}> {
   setup: (table: Knex.CreateTableBuilder) => void
 }
 
-export class Table<Type extends {}> {
+export class Table<Type extends object = object> {
   orm?: ORM
 
   constructor(public readonly options: TableOptions<Type>) {}
@@ -29,23 +29,31 @@ export class Table<Type extends {}> {
     return this.db<Type>(this.options.name)
   }
 
+  async count(where?: string): Promise<number> {
+    return this.query
+      .select(this.db.raw("count(*) as total"))
+      .whereRaw(where ?? "1=1")
+      .then((rows) => (rows[0] as unknown as { total: number }).total)
+  }
+
   async hasColumn(name: keyof Type): Promise<boolean> {
     return this.db.schema.hasColumn(this.options.name, name as string)
   }
 
-  async getColumns() {
+  async getColumn(name: keyof Type): Promise<Knex.ColumnInfo> {
+    return this.db(this.options.name).columnInfo(name)
+  }
+
+  async getColumns(): Promise<Record<keyof Type, Knex.ColumnInfo>> {
     return this.db(this.options.name).columnInfo()
   }
 
-  async getColumnNames() {
-    return this.getColumns().then(Object.keys)
+  async getColumnNames(): Promise<Array<keyof Type>> {
+    return this.getColumns().then(Object.keys) as Promise<Array<keyof Type>>
   }
 
   async isEmpty(): Promise<boolean> {
-    return this.query
-      .select()
-      .limit(1)
-      .then((rows) => rows.length === 0)
+    return this.count().then((count) => count === 0)
   }
 
   async make(): Promise<this> {
@@ -91,9 +99,11 @@ export class Table<Type extends {}> {
       }
     } catch (error: any) {
       this.orm.config.logger?.error(error)
+
+      throw error
     }
 
-    await this.options.then?.bind(this)(this)
+    if ((await this.count()) === 0) await this.options.then?.bind(this)(this)
 
     return this
   }

package/tests/test.js

@@ -20,18 +20,23 @@ beforeAll(async () => {
 
 describe("table management", () => {
   test("tables created", async () => {
-    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()
+    expect(await orm.hasTable("migration")).toBeTruthy()
+    expect(await orm.hasTable("a")).toBeTruthy()
+    expect(await orm.hasTable("b")).toBeTruthy()
+    expect(await orm.hasTable("c")).toBeTruthy()
+
+    expect(orm.hasCachedTable("migration")).toBeTruthy()
+    expect(orm.hasCachedTable("a")).toBeTruthy()
+    expect(orm.hasCachedTable("b")).toBeTruthy()
+    expect(orm.hasCachedTable("c")).toBeTruthy()
   })
 
   test("migrations ran", async () => {
-    expect(await orm.database.schema.hasColumn("b", "c_id")).toBeTruthy()
+    expect(await b.hasColumn("c_id")).toBeTruthy()
   })
 
   test("then ran", async () => {
-    const rows = await orm.database("a").select()
+    const rows = await a.query.select()
 
     expect(rows.length).toBe(1)
   })
@@ -103,6 +108,24 @@ describe("database migration", () => {
   })
 })
 
+describe("table getters", () => {
+  test("table info", async () => {
+    expect(await a.getColumnNames()).toContain("id")
+    expect(await a.getColumnNames()).toContain("b_id")
+
+    expect(await b.getColumnNames()).toContain("id")
+    expect(await b.getColumnNames()).toContain("c_id")
+
+    expect(await c.getColumnNames()).toContain("id")
+  })
+
+  test("table names", async () => {
+    expect(orm.cachedTableNames).toContain("a")
+    expect(orm.cachedTableNames).toContain("b")
+    expect(orm.cachedTableNames).toContain("c")
+  })
+})
+
 afterAll(async () => {
   await orm.database.destroy()
   fs.unlinkSync("a.csv")