@ghom/orm 1.7.2 → 1.8.1

package/dist/cjs/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./app/orm.js"), exports);
-__exportStar(require("./app/table.js"), exports);

package/dist/esm/app/orm.js

@@ -1,67 +0,0 @@
-import fs from "fs";
-import url from "url";
-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 {
-    config;
-    database;
-    handler;
-    constructor(config) {
-        this.config = config;
-        this.database = knex(config.database ?? {
-            client: "sqlite3",
-            useNullAsDefault: true,
-            connection: {
-                filename: ":memory:",
-            },
-        });
-        this.handler = new Handler(config.location, {
-            loader: (filepath) => import(isCJS ? filepath : url.pathToFileURL(filepath).href).then((file) => file.default),
-            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();
-        try {
-            await this.database.raw("PRAGMA foreign_keys = ON;");
-        }
-        catch (error) { }
-        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 this.cachedTables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
-            table.orm = this;
-            await table.make();
-        }
-    }
-    raw(sql) {
-        return this.database.raw(sql);
-    }
-}

package/dist/esm/index.js

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

package/dist/typings/index.d.ts

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

package/fixup.sh

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

package/src/app/orm.ts

@@ -1,195 +0,0 @@
-import fs from "fs"
-import url from "url"
-import path from "path"
-import { Handler } from "@ghom/handler"
-import { Knex, default as knex } from "knex"
-import { MigrationData, Table } from "./table.js"
-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"),
-)
-const isCJS = pack.type === "commonjs" || pack.type == void 0
-
-export interface ILogger {
-  log: (message: string) => void
-  error: (error: string | Error) => void
-  warn: (warning: string) => void
-}
-
-export interface ORMConfig {
-  /**
-   * path to the directory that contains js files of tables
-   */
-  location: string
-
-  /**
-   * database configuration
-   */
-  database?: Knex.Config
-
-  /**
-   * Logger used to log the table files loaded or created.
-   */
-  logger?: ILogger
-
-  /**
-   * Pattern used on logs when the table files are loaded or created. <br>
-   * Based on Chalk color-method names.
-   */
-  loggerColors?: {
-    highlight: typeof Color
-    rawValue: typeof Color
-    description: typeof Color
-  }
-}
-
-export class ORM {
-  public database: Knex
-  public handler: Handler<Table<any>>
-
-  constructor(public config: ORMConfig) {
-    this.database = knex(
-      config.database ?? {
-        client: "sqlite3",
-        useNullAsDefault: true,
-        connection: {
-          filename: ":memory:",
-        },
-      },
-    )
-
-    this.handler = new Handler(config.location, {
-      loader: (filepath) =>
-        import(isCJS ? filepath : url.pathToFileURL(filepath).href).then(
-          (file) => file.default,
-        ),
-      pattern: /\.js$/,
-    })
-  }
-
-  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()
-
-    try {
-      await this.database.raw("PRAGMA foreign_keys = ON;")
-    } catch (error) {}
-
-    const migration = new Table<MigrationData>({
-      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 this.cachedTables.sort(
-      (a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0),
-    )) {
-      table.orm = this
-      await table.make()
-    }
-  }
-
-  raw(sql: Knex.Value): Knex.Raw {
-    return this.database.raw(sql)
-  }
-
-  // /**
-  //  * 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

@@ -1,164 +0,0 @@
-import chalk from "chalk"
-import { Knex } from "knex"
-import { ORM } from "./orm.js"
-
-export interface MigrationData {
-  table: string
-  version: number
-}
-
-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
-  setup: (table: Knex.CreateTableBuilder) => void
-}
-
-export class Table<Type extends object = object> {
-  orm?: ORM
-
-  constructor(public readonly options: TableOptions<Type>) {}
-
-  get db() {
-    if (!this.orm) throw new Error("missing ORM")
-    return this.orm.database
-  }
-
-  get query() {
-    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 & string): Promise<boolean> {
-    return this.db.schema.hasColumn(this.options.name, name as string)
-  }
-
-  async getColumn(name: keyof Type & string): Promise<Knex.ColumnInfo> {
-    return this.db(this.options.name).columnInfo(name)
-  }
-
-  async getColumns(): Promise<Record<keyof Type & string, Knex.ColumnInfo>> {
-    return this.db(this.options.name).columnInfo()
-  }
-
-  async getColumnNames(): Promise<Array<keyof Type & string>> {
-    return this.getColumns().then(Object.keys) as Promise<
-      Array<keyof Type & string>
-    >
-  }
-
-  async isEmpty(): Promise<boolean> {
-    return this.count().then((count) => count === 0)
-  }
-
-  async make(): Promise<this> {
-    if (!this.orm) 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.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!`,
-        )
-
-        throw error
-      } else {
-        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 {
-      const migrated = await this.migrate()
-
-      if (migrated !== false) {
-        this.orm.config.logger?.log(
-          `migrated table ${chalk[
-            this.orm.config.loggerColors?.highlight ?? "blueBright"
-          ](this.options.name)} to version ${chalk[
-            this.orm.config.loggerColors?.rawValue ?? "magentaBright"
-          ](migrated)}`,
-        )
-      }
-    } catch (error: any) {
-      this.orm.config.logger?.error(error)
-
-      throw error
-    }
-
-    if ((await this.count()) === 0) await this.options.then?.bind(this)(this)
-
-    return this
-  }
-
-  private async migrate(): Promise<false | number> {
-    if (!this.options.migrations) return false
-
-    const migrations = new Map<
-      number,
-      (table: Knex.CreateTableBuilder) => void
-    >(
-      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<MigrationData>("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<MigrationData>("migration")
-      .insert(data)
-      .onConflict("table")
-      .merge()
-
-    return baseVersion === data.version ? false : data.version
-  }
-}

package/src/index.ts

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

package/tsconfig-cjs.json

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

package/tsconfig-esm.json

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