@ghom/orm 1.1.0 → 1.2.0

package/dist/cjs/app/table.js

@@ -0,0 +1,95 @@
+"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 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;
+    }
+    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);
+            this.logger?.log(`created table ${chalk_1.default.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);
+                throw error;
+            }
+            else {
+                this.logger?.log(`loaded table ${chalk_1.default.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)}`);
+            }
+        }
+        catch (error) {
+            this.logger?.error(error, this.filepath);
+        }
+        await this.options.then?.bind(this)(this);
+        return this;
+    }
+    async migrate() {
+        if (!this.options.migrations)
+            return false;
+        const migrations = new Map(Object.entries(this.options.migrations)
+            .sort((a, b) => Number(a[0]) - Number(b[0]))
+            .map((entry) => [Number(entry[0]), entry[1]]));
+        const fromDatabase = await this.db("migration")
+            .where("table", this.options.name)
+            .first();
+        const data = fromDatabase || {
+            table: this.options.name,
+            version: -Infinity,
+        };
+        const baseVersion = data.version;
+        await this.db.schema.alterTable(this.options.name, (builder) => {
+            migrations.forEach((migration, version) => {
+                if (version <= data.version)
+                    return;
+                migration(builder);
+                data.version = version;
+            });
+        });
+        await this.db("migration")
+            .insert(data)
+            .onConflict("table")
+            .merge();
+        return baseVersion === data.version ? false : data.version;
+    }
+}
+exports.Table = Table;

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/dist/esm/app/orm.js

@@ -0,0 +1,49 @@
+import { Handler } from "@ghom/handler";
+import { default as knex } from "knex";
+import { Table } from "./table";
+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);
+    }
+    async init() {
+        this.once("finish", async (pathList) => {
+            const tables = await Promise.all(pathList.map(async (filepath) => {
+                return import(filepath).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();
+            }
+        });
+        try {
+            await this.db.raw("PRAGMA foreign_keys = ON;");
+        }
+        catch (error) { }
+        await this.load();
+    }
+}

package/dist/{app → esm/app}/table.js

@@ -1,14 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = void 0;
-class Table {
+import path from "path";
+import chalk from "chalk";
+export class Table {
+    options;
+    orm;
     constructor(options) {
         this.options = options;
     }
-    get verbose() {
+    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"));
+    }
+    get logger() {
+        if (!this.orm)
+            throw new Error("missing ORM");
+        return this.orm.ormConfig.logger;
     }
     get db() {
         if (!this.orm)
@@ -30,30 +36,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 ${chalk.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.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)}`);
             }
         }
         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.blueBright(this.options.name)} to version ${chalk.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;
@@ -87,4 +88,3 @@ class Table {
         return baseVersion === data.version ? false : data.version;
     }
 }
-exports.Table = Table;

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/{app → typings/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 → typings/app}/table.d.ts

@@ -17,7 +17,8 @@ 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;

package/dist/typings/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./app/orm";
+export * from "./app/table";

package/fixup.sh

@@ -0,0 +1,11 @@
+cat >dist/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+cat >dist/esm/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@ghom/orm",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/typings/index.d.ts",
   "description": "TypeScript KnexJS ORM & handler",
   "prettier": {
     "semi": false
   },
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
+  },
   "scripts": {
     "format": "prettier --write src tsconfig.*",
-    "build": "tsc",
+    "build": "rm -fr dist/* && tsc -p tsconfig-esm.json && tsc -p tsconfig-cjs.json && fixup.sh",
     "test": "npm run build && jest tests/test.js --detectOpenHandles",
     "prepublishOnly": "npm run format && npm test"
   },
@@ -24,6 +29,7 @@
   },
   "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
 }
 

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"
 
@@ -19,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() {
@@ -47,17 +57,19 @@ 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 ${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)}`)
       }
     }
 
@@ -65,13 +77,14 @@ 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)

package/tests/tables/a.js

@@ -1,4 +1,4 @@
-const { Table } = require("../../dist/index")
+const { Table } = require("../..")
 
 module.exports = new Table({
   name: "a",

package/tests/tables/b.js

@@ -1,4 +1,4 @@
-const { Table } = require("../../dist/index")
+const { Table } = require("../..")
 
 module.exports = new Table({
   name: "b",

package/tests/tables/c.js

@@ -1,4 +1,4 @@
-const { Table } = require("../../dist/index")
+const { Table } = require("../..")
 
 module.exports = new Table({
   name: "c",

package/tests/test.js

@@ -1,13 +1,13 @@
 require("dotenv").config({ path: "./.env" })
 const path = require("path")
-const { ORM } = require("../dist/index")
+const { ORM } = require("..")
 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 () => {

package/tsconfig-cjs.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/cjs",
+    "module": "CommonJS",
+    "target": "es2020",
+    "declaration": true,
+    "declarationDir": "dist/typings"
+  }
+}

package/tsconfig-esm.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "module": "esnext",
+    "target": "esnext",
+  }
+}

package/tsconfig.json

@@ -1,13 +1,10 @@
 {
   "compilerOptions": {
     "strict": true,
-    "outDir": "dist",
     "rootDir": "src",
-    "module": "CommonJS",
     "target": "es2020",
     "lib": ["es2020", "dom"],
     "moduleResolution": "Node",
-    "esModuleInterop": true,
-    "declaration": true
+    "esModuleInterop": true
   }
 }