@ghom/orm 1.6.1 → 1.7.1

package/dist/cjs/app/orm.js

@@ -33,6 +33,7 @@ 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 defaultBackupDir = path_1.default.join(process.cwd(), "backup");
 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 {
@@ -89,52 +90,5 @@ class ORM {
     raw(sql) {
         return this.database.raw(sql);
     }
-    /**
-     * Extract the database to a CSV file.
-     */
-    async extract(dir = process.cwd()) {
-        const tables = [...this.handler.elements.values()];
-        for (const table of tables) {
-            await this.database
-                .select()
-                .from(table.options.name)
-                .then((rows) => {
-                const csv = rows.map((row) => Object.values(row).join(",")).join("\n");
-                fs_1.default.writeFileSync(path_1.default.join(dir, `${table.options.name}.csv`), csv, "utf8");
-            });
-        }
-    }
-    /**
-     * Import a CSV file to the database.
-     */
-    async import(dir = process.cwd()) {
-        const tables = [...this.handler.elements.values()].sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0));
-        for (const table of tables) {
-            const columnInfo = await table.getColumns();
-            let csv;
-            try {
-                csv = fs_1.default.readFileSync(path_1.default.join(dir, `${table.options.name}.csv`), "utf8");
-            }
-            catch (error) {
-                continue;
-            }
-            if (csv.trim().length === 0)
-                continue;
-            const rows = csv
-                .split("\n")
-                .map((row) => row.split(","))
-                .map((row) => {
-                const data = {};
-                let index = 0;
-                for (const [name, info] of Object.entries(columnInfo)) {
-                    data[name] =
-                        info.type === "integer" ? Number(row[index]) : row[index];
-                    index++;
-                }
-                return data;
-            });
-            await this.database(table.options.name).insert(rows);
-        }
-    }
 }
 exports.ORM = ORM;

package/dist/cjs/app/table.js

@@ -43,7 +43,9 @@ class Table {
             throw new Error("missing ORM");
         try {
             await this.db.schema.createTable(this.options.name, this.options.setup);
-            this.orm.config.logger?.log(`created table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
+            this.orm.config.logger?.log(`created table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}${this.options.description
+                ? ` ${chalk_1.default[this.orm.config.loggerColors?.description ?? "grey"](this.options.description)}`
+                : ""}`);
         }
         catch (error) {
             if (error.toString().includes("syntax error")) {
@@ -51,7 +53,9 @@ class Table {
                 throw error;
             }
             else {
-                this.orm.config.logger?.log(`loaded table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
+                this.orm.config.logger?.log(`loaded table ${chalk_1.default[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}${this.options.description
+                    ? ` ${chalk_1.default[this.orm.config.loggerColors?.description ?? "grey"](this.options.description)}`
+                    : ""}`);
             }
         }
         try {

package/dist/esm/app/orm.js

@@ -4,6 +4,7 @@ import path from "path";
 import { Handler } from "@ghom/handler";
 import { default as knex } from "knex";
 import { Table } from "./table.js";
+const defaultBackupDir = path.join(process.cwd(), "backup");
 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 {
@@ -63,51 +64,4 @@ export class ORM {
     raw(sql) {
         return this.database.raw(sql);
     }
-    /**
-     * Extract the database to a CSV file.
-     */
-    async extract(dir = process.cwd()) {
-        const tables = [...this.handler.elements.values()];
-        for (const table of tables) {
-            await this.database
-                .select()
-                .from(table.options.name)
-                .then((rows) => {
-                const csv = rows.map((row) => Object.values(row).join(",")).join("\n");
-                fs.writeFileSync(path.join(dir, `${table.options.name}.csv`), csv, "utf8");
-            });
-        }
-    }
-    /**
-     * Import a CSV file to the database.
-     */
-    async import(dir = process.cwd()) {
-        const tables = [...this.handler.elements.values()].sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0));
-        for (const table of tables) {
-            const columnInfo = await table.getColumns();
-            let csv;
-            try {
-                csv = fs.readFileSync(path.join(dir, `${table.options.name}.csv`), "utf8");
-            }
-            catch (error) {
-                continue;
-            }
-            if (csv.trim().length === 0)
-                continue;
-            const rows = csv
-                .split("\n")
-                .map((row) => row.split(","))
-                .map((row) => {
-                const data = {};
-                let index = 0;
-                for (const [name, info] of Object.entries(columnInfo)) {
-                    data[name] =
-                        info.type === "integer" ? Number(row[index]) : row[index];
-                    index++;
-                }
-                return data;
-            });
-            await this.database(table.options.name).insert(rows);
-        }
-    }
 }

package/dist/esm/app/table.js

@@ -39,7 +39,9 @@ export class Table {
             throw new Error("missing ORM");
         try {
             await this.db.schema.createTable(this.options.name, this.options.setup);
-            this.orm.config.logger?.log(`created table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
+            this.orm.config.logger?.log(`created table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}${this.options.description
+                ? ` ${chalk[this.orm.config.loggerColors?.description ?? "grey"](this.options.description)}`
+                : ""}`);
         }
         catch (error) {
             if (error.toString().includes("syntax error")) {
@@ -47,7 +49,9 @@ export class Table {
                 throw error;
             }
             else {
-                this.orm.config.logger?.log(`loaded table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}`);
+                this.orm.config.logger?.log(`loaded table ${chalk[this.orm.config.loggerColors?.highlight ?? "blueBright"](this.options.name)}${this.options.description
+                    ? ` ${chalk[this.orm.config.loggerColors?.description ?? "grey"](this.options.description)}`
+                    : ""}`);
             }
         }
         try {

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

@@ -3,8 +3,9 @@ import { Knex } from "knex";
 import { Table } from "./table.js";
 import { Color } from "chalk";
 export interface ILogger {
-    log: (...message: string[]) => void;
-    error: (error: Error | string) => void;
+    log: (message: string) => void;
+    error: (error: string | Error) => void;
+    warn: (warning: string) => void;
 }
 export interface ORMConfig {
     /**
@@ -26,6 +27,7 @@ export interface ORMConfig {
     loggerColors?: {
         highlight: typeof Color;
         rawValue: typeof Color;
+        description: typeof Color;
     };
 }
 export declare class ORM {
@@ -42,12 +44,4 @@ export declare class ORM {
      */
     init(): Promise<void>;
     raw(sql: Knex.Value): Knex.Raw;
-    /**
-     * Extract the database to a CSV file.
-     */
-    extract(dir?: string): Promise<void>;
-    /**
-     * Import a CSV file to the database.
-     */
-    import(dir?: string): Promise<void>;
 }

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

@@ -6,6 +6,7 @@ export interface MigrationData {
 }
 export interface TableOptions<Type extends object = object> {
     name: string;
+    description?: string;
     priority?: number;
     migrations?: {
         [version: number]: (table: Knex.CreateTableBuilder) => void;
@@ -28,10 +29,10 @@ export declare class Table<Type extends object = object> {
         _unionProps: never;
     }[]>;
     count(where?: string): Promise<number>;
-    hasColumn(name: keyof Type): Promise<boolean>;
-    getColumn(name: keyof Type): Promise<Knex.ColumnInfo>;
-    getColumns(): Promise<Record<keyof Type, Knex.ColumnInfo>>;
-    getColumnNames(): Promise<Array<keyof Type>>;
+    hasColumn(name: keyof Type & string): Promise<boolean>;
+    getColumn(name: keyof Type & string): Promise<Knex.ColumnInfo>;
+    getColumns(): Promise<Record<keyof Type & string, Knex.ColumnInfo>>;
+    getColumnNames(): Promise<Array<keyof Type & string>>;
     isEmpty(): Promise<boolean>;
     make(): Promise<this>;
     private migrate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "license": "MIT",
   "type": "module",
   "main": "dist/esm/index.js",
@@ -20,20 +20,20 @@
     "prepublishOnly": "npm run format && npm test"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.1",
-    "@types/node": "^18.16.3",
-    "dotenv": "^16.0.3",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.8",
-    "typescript": "^5.0.4"
+    "@types/jest": "^29.5.6",
+    "@types/node": "^20.8.9",
+    "dotenv": "^16.3.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2"
   },
   "optionalDependencies": {
-    "mysql2": "^3.2.4",
-    "pg": "^8.10.0",
+    "mysql2": "^3.6.2",
+    "pg": "^8.11.3",
     "sqlite3": "^5.1.6"
   },
   "dependencies": {
     "@ghom/handler": "^2.0.0",
-    "knex": "^2.4.2"
+    "knex": "^3.0.1"
   }
 }

package/src/app/orm.ts

@@ -4,16 +4,19 @@ 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"
+import chalk, { Color } from "chalk"
+
+const defaultBackupDir = path.join(process.cwd(), "backup")
 
 const pack = JSON.parse(
-  fs.readFileSync(path.join(process.cwd(), "package.json"), "utf8")
+  fs.readFileSync(path.join(process.cwd(), "package.json"), "utf8"),
 )
 const isCJS = pack.type === "commonjs" || pack.type == void 0
 
 export interface ILogger {
-  log: (...message: string[]) => void
-  error: (error: Error | string) => void
+  log: (message: string) => void
+  error: (error: string | Error) => void
+  warn: (warning: string) => void
 }
 
 export interface ORMConfig {
@@ -39,6 +42,7 @@ export interface ORMConfig {
   loggerColors?: {
     highlight: typeof Color
     rawValue: typeof Color
+    description: typeof Color
   }
 }
 
@@ -54,13 +58,13 @@ export class ORM {
         connection: {
           filename: ":memory:",
         },
-      }
+      },
     )
 
     this.handler = new Handler(config.location, {
       loader: (filepath) =>
         import(isCJS ? filepath : url.pathToFileURL(filepath).href).then(
-          (file) => file.default
+          (file) => file.default,
         ),
       pattern: /\.js$/,
     })
@@ -105,7 +109,7 @@ export class ORM {
     await migration.make()
 
     for (const table of this.cachedTables.sort(
-      (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
+      (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0),
     )) {
       table.orm = this
       await table.make()
@@ -116,70 +120,76 @@ export class ORM {
     return this.database.raw(sql)
   }
 
-  /**
-   * Extract the database to a CSV file.
-   */
-  async extract(dir = process.cwd()) {
-    const tables = [...this.handler.elements.values()]
-
-    for (const table of tables) {
-      await this.database
-        .select()
-        .from(table.options.name)
-        .then((rows) => {
-          const csv = rows.map((row) => Object.values(row).join(",")).join("\n")
-
-          fs.writeFileSync(
-            path.join(dir, `${table.options.name}.csv`),
-            csv,
-            "utf8"
-          )
-        })
-    }
-  }
-
-  /**
-   * Import a CSV file to the database.
-   */
-  async import(dir = process.cwd()) {
-    const tables = [...this.handler.elements.values()].sort(
-      (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0)
-    )
-
-    for (const table of tables) {
-      const columnInfo = await table.getColumns()
-
-      let csv: string
-
-      try {
-        csv = fs.readFileSync(
-          path.join(dir, `${table.options.name}.csv`),
-          "utf8"
-        )
-      } catch (error) {
-        continue
-      }
-
-      if (csv.trim().length === 0) continue
-
-      const rows = csv
-        .split("\n")
-        .map((row) => row.split(","))
-        .map((row) => {
-          const data: any = {}
-
-          let index = 0
-
-          for (const [name, info] of Object.entries(columnInfo)) {
-            data[name] =
-              info.type === "integer" ? Number(row[index]) : row[index]
-            index++
-          }
-
-          return data
-        })
-
-      await this.database(table.options.name).insert(rows)
-    }
-  }
+  // /**
+  //  * Extract the database to a CSV file for each table.
+  //  */
+  // async createBackup(dir = defaultBackupDir) {
+  //   const tables = [...this.handler.elements.values()]
+  //
+  //   for (const table of tables) {
+  //     await this.database
+  //       .select()
+  //       .from(table.options.name)
+  //       .then(async (rows) => {
+  //         const csv = rows.map((row) => Object.values(row).join(",")).join("\n")
+  //
+  //         return fs.promises.writeFile(
+  //           path.join(dir, `${table.options.name}.csv`),
+  //           csv,
+  //           "utf8",
+  //         )
+  //       })
+  //   }
+  // }
+  //
+  // /**
+  //  * Import a CSV file for each table to the database.
+  //  */
+  // async restoreBackup(dir = defaultBackupDir) {
+  //   const tables = [...this.handler.elements.values()].sort(
+  //     (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0),
+  //   )
+  //
+  //   for (const table of tables) {
+  //     const columnInfo = await table.getColumns()
+  //
+  //     let csv: string
+  //
+  //     try {
+  //       csv = await fs.promises.readFile(
+  //         path.join(dir, `${table.options.name}.csv`),
+  //         "utf8",
+  //       )
+  //     } catch (error) {
+  //       this.config.logger?.warn(
+  //         `missing backup file for table ${chalk[
+  //           this.config.loggerColors?.highlight ?? "blueBright"
+  //         ](table.options.name)}`,
+  //       )
+  //
+  //       continue
+  //     }
+  //
+  //     if (csv.trim().length === 0) continue
+  //
+  //     const rows = csv
+  //       .split("\n")
+  //       .map((row) => row.split(","))
+  //       .map((row) => {
+  //         const data: any = {}
+  //
+  //         let index = 0
+  //
+  //         for (const [name, info] of Object.entries(columnInfo)) {
+  //           data[name] =
+  //             info.type === "integer" ? Number(row[index]) : row[index]
+  //           index++
+  //         }
+  //
+  //         return data
+  //       })
+  //
+  //     await this.database(table.options.name).insert(rows)
+  //   }
+  // }
 }

package/src/app/table.ts

@@ -9,6 +9,7 @@ export interface MigrationData {
 
 export interface TableOptions<Type extends object = object> {
   name: string
+  description?: string
   priority?: number
   migrations?: { [version: number]: (table: Knex.CreateTableBuilder) => void }
   then?: (this: Table<Type>, table: Table<Type>) => unknown
@@ -36,20 +37,22 @@ export class Table<Type extends object = object> {
       .then((rows) => (rows[0] as unknown as { total: number }).total)
   }
 
-  async hasColumn(name: keyof Type): Promise<boolean> {
+  async hasColumn(name: keyof Type & string): Promise<boolean> {
     return this.db.schema.hasColumn(this.options.name, name as string)
   }
 
-  async getColumn(name: keyof Type): Promise<Knex.ColumnInfo> {
+  async getColumn(name: keyof Type & string): Promise<Knex.ColumnInfo> {
     return this.db(this.options.name).columnInfo(name)
   }
 
-  async getColumns(): Promise<Record<keyof Type, Knex.ColumnInfo>> {
+  async getColumns(): Promise<Record<keyof Type & string, Knex.ColumnInfo>> {
     return this.db(this.options.name).columnInfo()
   }
 
-  async getColumnNames(): Promise<Array<keyof Type>> {
-    return this.getColumns().then(Object.keys) as Promise<Array<keyof Type>>
+  async getColumnNames(): Promise<Array<keyof Type & string>> {
+    return this.getColumns().then(Object.keys) as Promise<
+      Array<keyof Type & string>
+    >
   }
 
   async isEmpty(): Promise<boolean> {
@@ -65,14 +68,20 @@ export class Table<Type extends object = object> {
       this.orm.config.logger?.log(
         `created table ${chalk[
           this.orm.config.loggerColors?.highlight ?? "blueBright"
-        ](this.options.name)}`
+        ](this.options.name)}${
+          this.options.description
+            ? ` ${chalk[this.orm.config.loggerColors?.description ?? "grey"](
+                this.options.description,
+              )}`
+            : ""
+        }`,
       )
     } catch (error: any) {
       if (error.toString().includes("syntax error")) {
         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!`
+          ](this.options.name)} table!`,
         )
 
         throw error
@@ -80,7 +89,13 @@ export class Table<Type extends object = object> {
         this.orm.config.logger?.log(
           `loaded table ${chalk[
             this.orm.config.loggerColors?.highlight ?? "blueBright"
-          ](this.options.name)}`
+          ](this.options.name)}${
+            this.options.description
+              ? ` ${chalk[this.orm.config.loggerColors?.description ?? "grey"](
+                  this.options.description,
+                )}`
+              : ""
+          }`,
         )
       }
     }
@@ -94,7 +109,7 @@ export class Table<Type extends object = object> {
             this.orm.config.loggerColors?.highlight ?? "blueBright"
           ](this.options.name)} to version ${chalk[
             this.orm.config.loggerColors?.rawValue ?? "magentaBright"
-          ](migrated)}`
+          ](migrated)}`,
         )
       }
     } catch (error: any) {
@@ -117,7 +132,7 @@ export class Table<Type extends object = object> {
     >(
       Object.entries(this.options.migrations)
         .sort((a, b) => Number(a[0]) - Number(b[0]))
-        .map((entry) => [Number(entry[0]), entry[1]])
+        .map((entry) => [Number(entry[0]), entry[1]]),
     )
 
     const fromDatabase = await this.db<MigrationData>("migration")

package/tests/test.js

@@ -54,7 +54,7 @@ describe("table column types", () => {
       await orm
         .database("a")
         .columnInfo("id")
-        .then((info) => info.type)
+        .then((info) => info.type),
     ).toBe("integer")
   })
 
@@ -63,50 +63,50 @@ describe("table column types", () => {
       await orm
         .database("a")
         .columnInfo("b_id")
-        .then((info) => info.type)
+        .then((info) => info.type),
     ).toBe("integer")
   })
 })
 
-describe("database migration", () => {
-  beforeAll(async () => {
-    await c.query.insert({ id: 0 })
-    await b.query.insert({
-      id: 0,
-      c_id: 0,
-    })
-    await a.query.insert({
-      id: 0,
-      b_id: 0,
-    })
-  })
-
-  test("extract CSV", async () => {
-    await orm.extract()
-
-    expect(fs.existsSync("a.csv")).toBeTruthy()
-    expect(fs.existsSync("b.csv")).toBeTruthy()
-    expect(fs.existsSync("c.csv")).toBeTruthy()
-  })
-
-  test("empty tables", async () => {
-    await a.query.del()
-    await b.query.del()
-    await c.query.del()
-
-    expect(await a.isEmpty()).toBeTruthy()
-    expect(await b.isEmpty()).toBeTruthy()
-    expect(await c.isEmpty()).toBeTruthy()
-  })
-
-  test("import CSV", async () => {
-    await orm.import()
-
-    expect(await a.isEmpty()).toBeFalsy()
-    expect(await b.isEmpty()).toBeFalsy()
-    expect(await c.isEmpty()).toBeFalsy()
-  })
-})
+// describe("database extraction", () => {
+//   beforeAll(async () => {
+//     await c.query.insert({ id: 0 })
+//     await b.query.insert({
+//       id: 0,
+//       c_id: 0,
+//     })
+//     await a.query.insert({
+//       id: 0,
+//       b_id: 0,
+//     })
+//   })
+//
+//   test("extract CSV", async () => {
+//     await orm.extract()
+//
+//     expect(fs.existsSync("a.csv")).toBeTruthy()
+//     expect(fs.existsSync("b.csv")).toBeTruthy()
+//     expect(fs.existsSync("c.csv")).toBeTruthy()
+//   })
+//
+//   test("empty tables", async () => {
+//     await a.query.del()
+//     await b.query.del()
+//     await c.query.del()
+//
+//     expect(await a.isEmpty()).toBeTruthy()
+//     expect(await b.isEmpty()).toBeTruthy()
+//     expect(await c.isEmpty()).toBeTruthy()
+//   })
+//
+//   test("import CSV", async () => {
+//     await orm.import()
+//
+//     expect(await a.isEmpty()).toBeFalsy()
+//     expect(await b.isEmpty()).toBeFalsy()
+//     expect(await c.isEmpty()).toBeFalsy()
+//   })
+// })
 
 describe("table getters", () => {
   test("table info", async () => {
@@ -128,7 +128,7 @@ describe("table getters", () => {
 
 afterAll(async () => {
   await orm.database.destroy()
-  fs.unlinkSync("a.csv")
-  fs.unlinkSync("b.csv")
-  fs.unlinkSync("c.csv")
+  // fs.unlinkSync("a.csv")
+  // fs.unlinkSync("b.csv")
+  // fs.unlinkSync("c.csv")
 })