@ghom/orm 1.7.0 → 1.7.2

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/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

@@ -27,6 +27,7 @@ export interface ORMConfig {
     loggerColors?: {
         highlight: typeof Color;
         rawValue: typeof Color;
+        description: typeof Color;
     };
 }
 export declare class ORM {

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;

package/package.json

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

package/readme.md

@@ -22,9 +22,12 @@ const orm = new ORM({
   logger: console,
   loggerColors: { ... }
 })
+
+// start handling of tables
+await orm.init()
 ```
 
-## Tables
+## Add tables
 
 The tables are automatically loaded from the `location` directory.
 
@@ -33,7 +36,12 @@ The tables are automatically loaded from the `location` directory.
 
 import { Table } from "@ghom/orm"
 
-export default new Table({
+interface User {
+  username: string
+  password: string
+}
+
+export default new Table<User>({
   name: "user",
   
   // the higher the priority, the earlier the table is compiled
@@ -59,20 +67,30 @@ export default new Table({
 })
 ```
 
-## Query
+## Launch a query
 
-For more information about the query builder, see [knexjs.org](https://knexjs.org/).
+For more information about the query builder, see [knexjs.org](https://knexjs.org/).  
+You can launch a SQL query on a table like that
 
-## Import/extract
+```typescript
+import user from "./tables/user"
 
-You can transfer the data from one instance of the ORM to another (between two database clients, for example between "pg" and "mysql2").
+export async function compareHash(username, hash): Promise<boolean> {
+  const user = await user.query
+    .select()
+    .where("username", username)
+    .first()
 
-```typescript
-await orm1.extract()
+  return user && user.password === hash
+}
 ```
 
-```typescript
-await orm2.import()
-```
+## Future features
 
-The SQL structure isn't transferred, only the data. You must copy the table files to the other project.
+- [ ] Take full control of the table creation
+- [ ] Add backup option
+- [ ] Add admin panel
+- [ ] Add shortcuts for advanced relative queries
+- [ ] Add timed caching system
+- [ ] Make possible to switch the data between all possible clients (pg, mysql, sqlite3)
+- [ ] Add a way to set up timezone directly in the ORM constructor

package/src/app/orm.ts

@@ -42,6 +42,7 @@ export interface ORMConfig {
   loggerColors?: {
     highlight: typeof Color
     rawValue: typeof Color
+    description: typeof Color
   }
 }
 

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
@@ -67,7 +68,13 @@ 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")) {
@@ -82,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,
+                )}`
+              : ""
+          }`,
         )
       }
     }