@hedystia/db 2.0.0 → 2.0.2

package/readme.md

@@ -1,137 +1,119 @@
-## Installation
-
-```
-npm i @hedystia/db
-
-yarn add @hedystia/db
-```
-
-## Nodejs Version
-
-- `v18.0.0` or higher
-
-## Links
-
-- [Discord](https://discord.gg/aXvuUpvRQs) [Hedystia Discord]
-- [Discord_Bot](https://hedystia.com) [Hedystia Bot]
-- [Docs](https://docs.hedystia.com/db/start) [Hedystia Docs]
-
-## Example
-
-```js
-const { default: Database } = require("@hedystia/db");
-
-// Create a file named database.ht and enter the password
-const database = new Database("./database.ht", "password");
-
-// You can only use it once to create the table after that you can no longer use it.
-database.createTable("users", ["id", "name", "email"]);
-
-database.insert("users", { id: "1", name: "John Doe", email: "jdoe@example.com" });
+# @hedystia/db
 
-database.insert("users", { id: "2", name: "María", email: "maria@example.com" });
+Next-gen TypeScript ORM for building type-safe database layers at lightspeed.
 
-const users = database.select("users");
-
-console.log("----------------------------------");
-
-console.log(users);
-
-database.addColumn("users", "phone");
-
-database.addColumn("users", "lang", "en-US");
-
-const newUsersPhone = database.select("users");
+## Installation
 
-console.log("----------------------------------");
+```bash
+bun add @hedystia/db
+```
 
-console.log(newUsersPhone);
+### Database Drivers
 
-database.deleteColumn("users", "phone");
+Install the driver for your database. The ORM will automatically detect and use the most appropriate library available.
 
-const oldUsersPhone = database.select("users");
+#### SQLite Driver
+Supports multiple libraries in the following priority:
+1. `better-sqlite3`
+2. `sqlite3`
+3. `sql.js`
+4. `bun:sqlite`
 
-console.log("----------------------------------");
+```bash
+# You can install any of these
 
-console.log(oldUsersPhone);
+bun add better-sqlite3
+bun add sqlite3
+bun add sql.js
 
-const userJohn = database.select("users", { name: "John Doe" });
+# Or use bun:sqlite if you are using Bun
+```
 
-console.log("----------------------------------");
+#### MySQL & MariaDB Driver
+Supports both `mysql2` and `mysql` libraries.
+- **Naming**: Use `database: "mysql"` or `database: "mariadb"`.
+- **MariaDB**: Fully supported through the same drivers.
 
-console.log(userJohn);
+```bash
+bun add mysql2 # Preferred
+# or
+bun add mysql
+```
 
-database.delete("users", { name: "María" });
+# File-based (no extra install needed)
 
-const users2 = database.select("users");
+## Quick Start
 
-console.log("----------------------------------");
+### Define your schema
 
-console.log(users2);
+```ts
+import { table, integer, varchar, text } from "@hedystia/db";
 
-database.update("users", { id: "1" }, { name: "Jane Doe", lang: "es-ES" });
+export const users = table("users", {
+  id: integer().primaryKey().autoIncrement(),
+  name: varchar(255).notNull(),
+  email: varchar(255).unique(),
+  age: integer().default(0),
+});
 
-const users3 = database.select("users");
+export const posts = table("posts", {
+  id: integer().primaryKey().autoIncrement(),
+  userId: integer().references(() => users.id, { onDelete: "CASCADE" }),
+  title: varchar(255).notNull(),
+  content: text(),
+});
+```
 
-console.log("----------------------------------");
+> **Note:** The `d.xxx()` prefix style (e.g., `d.integer()`) is still supported for backward compatibility.
 
-console.log(users3);
+### Create the database
 
-database.dropAll();
+```ts
+import { database } from "@hedystia/db";
+import { users, posts } from "./schemas";
 
-const users4 = database.select("users");
+const db = database({
+  schemas: [users, posts],
+  database: "sqlite",
+  connection: { filename: "./data.db" },
+  syncSchemas: true,
+  cache: true,
+});
 
-console.log("----------------------------------");
+await db.initialize();
+```
 
-console.log(users4);
+### Query your data
 
-database.enableMigrations();
+```ts
+// Insert
+const user = await db.users.insert({ name: "Alice", email: "alice@example.com" });
 
-database.createMigration(
-	{
-		id: "cdaa5095-0c11-4878-8d89-c9be41215e57",
-		description: "Description",
-		timestamp: Date.now(),
-	},
-	() => {
-		database.createTableIfNotExists("test_migration", ["name"]);
-		database.insert("test_migration", { name: "John" });
-	},
-);
+// Find
+const allUsers = await db.users.find();
+const alice = await db.users.findFirst({ where: { name: "Alice" } });
 
-const migrations = database.select("migrations");
+// Update
+await db.users.update({ where: { id: 1 }, data: { age: 26 } });
 
-console.log("----------------------------------");
+// Delete
+await db.users.delete({ where: { id: 1 } });
 
-console.log(migrations);
+// Relations
+const usersWithPosts = await db.users.find({ with: { posts: true } });
+```
 
-const testMigration = database.select("test_migration");
+## Features
 
-console.log("----------------------------------");
+- **One schema, multiple databases** — MySQL, SQLite, and File drivers
+- **Type-safe queries** — Full TypeScript inference for all operations
+- **Smart caching** — Adaptive TTL cache with automatic invalidation
+- **Migrations** — CLI and programmatic migration support
+- **Schema sync** — Automatic table creation and column diffing
+- **Relations** — Foreign key references with eager loading
 
-console.log(testMigration);
-```
+## Links
 
-## Functions
-
-| Function                 | Description                                    |
-| ------------------------ | ---------------------------------------------- |
-| `dropAll`                | To drop all data from a table                  |
-| `readTables`             | To read the tables from the database           |
-| `enableMigrations`       | To enable migrations                           |
-| `createMigration`        | To create a migration                          |
-| `createTable`            | To create a table                              |
-| `deleteTable`            | To delete a table                              |
-| `createTableIfNotExists` | To create a table if it does not exist         |
-| `deleteTableIfExists`    | To delete a table if it exists                 |
-| `renameTable`            | To rename a table                              |
-| `addColumn`              | To add a column to an already created table    |
-| `deleteColumn`           | To remove a column to an already created table |
-| `renameColumn`           | To rename a column                             |
-| `insert`                 | To insert a data in the table                  |
-| `update`                 | To update a data in the table                  |
-| `select`                 | To search for information in a table           |
-| `delete`                 | To delete a data from the table                |
-| `getTableNames`          | To get the names of all tables                 |
-| `getColumnNames`         | To get the names of all columns                |
-| `getRecordCount`         | To get the number of records in a table        |
+- [Documentation](https://docs.hedystia.com/db/start)
+- [GitHub](https://github.com/Hedystia/Hedystia)
+- [Discord](https://hedystia.com/discord)

package/index.d.ts

@@ -1,65 +0,0 @@
-interface Records {
-    [key: string]: unknown;
-}
-interface Table {
-    columns: string[];
-    records: Records[];
-}
-interface Migration {
-    id: string;
-    description: string;
-    timestamp: number;
-    applied: boolean;
-}
-export default class DataBase {
-    private queue;
-    private password;
-    private filePath;
-    private tables;
-    private migrations;
-    private migrationsEnabled;
-    constructor(filePath: string, password: string);
-    enableMigrations(): void;
-    createMigration(migration: Omit<Migration, "applied">, migrationFn: () => Promise<void> | void): Promise<void>;
-    createTable(tableName: string, columns?: string[]): void;
-    createTableIfNotExists(tableName: string, columns: string[]): void;
-    deleteTable(tableName: string): void;
-    deleteTableIfExists(tableName: string): void;
-    addColumn(tableName: string, column: string, defaultValue?: unknown): void;
-    deleteColumn(tableName: string, column: string): void;
-    insert(tableName: string, record: {
-        [key: string]: unknown;
-    }): void;
-    update(tableName: string, query: {
-        [key: string]: unknown;
-    }, newData: {
-        [key: string]: unknown;
-    }): void;
-    select(tableName: string, query?: {
-        [key: string]: unknown;
-    }): Records[];
-    delete(tableName: string, query?: {
-        [key: string]: unknown;
-    }): void;
-    readTables(): {
-        [key: string]: Table;
-    };
-    dropAll(): void;
-    renameTable(oldTableName: string, newTableName: string): void;
-    renameColumn(tableName: string, oldColumnName: string, newColumnName: string): void;
-    getTableNames(): string[];
-    getColumnNames(tableName: string): string[];
-    getRecordCount(tableName: string): number;
-    private processQueue;
-    private markMigrationAsApplied;
-    private insertTable;
-    private updateTable;
-    private deleteFromTable;
-    private dropAllData;
-    private renameTableInDb;
-    private renameColumnInDb;
-    private saveToFile;
-    private readFromFile;
-    private evpBytesToKey;
-}
-export {};

package/index.js

@@ -1 +0,0 @@
-var m=Object.create;var{getPrototypeOf:y,defineProperty:l,getOwnPropertyNames:b,getOwnPropertyDescriptor:F}=Object,p=Object.prototype.hasOwnProperty;var g=(e,t,s)=>{s=e!=null?m(y(e)):{};let i=t||!e||!e.__esModule?l(s,"default",{value:e,enumerable:!0}):s;for(let r of b(e))if(!p.call(i,r))l(i,r,{get:()=>e[r],enumerable:!0});return i},f=new WeakMap,T=(e)=>{var t=f.get(e),s;if(t)return t;if(t=l({},"__esModule",{value:!0}),e&&typeof e==="object"||typeof e==="function")b(e).map((i)=>!p.call(t,i)&&l(t,i,{get:()=>e[i],enumerable:!(s=F(e,i))||s.enumerable}));return f.set(e,t),t};var k=(e,t)=>{for(var s in t)l(e,s,{get:t[s],enumerable:!0,configurable:!0,set:(i)=>t[s]=()=>i})};var q={};k(q,{default:()=>c});module.exports=T(q);var h=g(require("node:fs")),u=g(require("node:crypto"));class c{queue=[];password;filePath;tables={};migrations=[];migrationsEnabled=!1;constructor(e,t){this.tables={},this.filePath=e||"./database.ht",this.password=t,this.queue=[]}enableMigrations(){this.migrationsEnabled=!0,this.createTableIfNotExists("migrations",["id","description","timestamp","applied"])}async createMigration(e,t){if(!this.migrationsEnabled)throw new Error("Migrations are not enabled. Call enableMigrations() first.");this.readFromFile();let s=this.select("migrations",{id:e.id});if(!s[0]||!s[0].applied){if(this.migrations.push({...e,applied:!1}),this.insert("migrations",{...e,applied:!1}),this.queue.push({method:"migration",table:"migrations",record:{...e,applied:!1}}),this.queue.length===1)await this.processQueue(t)}}createTable(e,t=[]){if(this.readFromFile(),this.tables[e])throw new Error(`Table "${e}" already exists.`);this.tables[e]={columns:t,records:[]},this.saveToFile()}createTableIfNotExists(e,t){if(this.readFromFile(),!this.tables[e])this.tables[e]={columns:t,records:[]},this.saveToFile()}deleteTable(e){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);delete this.tables[e],this.saveToFile()}deleteTableIfExists(e){if(this.readFromFile(),this.tables[e])delete this.tables[e],this.saveToFile()}addColumn(e,t,s){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);if(this.tables[e].columns.includes(t))throw new Error(`Column "${t}" already exists in table "${e}".`);this.tables[e].columns.push(t);for(let i of this.tables[e].records)i[t]=s??null;this.saveToFile()}deleteColumn(e,t){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);if(!this.tables[e].columns.includes(t))throw new Error(`Column "${t}" does not exist in table "${e}".`);let s=this.tables[e].columns.indexOf(t);this.tables[e].columns.splice(s,1);for(let i of this.tables[e].records)delete i[t];this.saveToFile()}insert(e,t){if(this.queue.push({method:"insert",table:e,record:t}),this.queue.length===1)this.processQueue()}update(e,t,s){if(this.queue.push({method:"update",table:e,query:t,newData:s}),this.queue.length===1)this.processQueue()}select(e,t={}){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);return this.tables[e].records.filter((s)=>Object.entries(t).every(([i,r])=>s[i]===r))}delete(e,t={}){if(this.queue.push({method:"delete",table:e,query:t}),this.queue.length===1)this.processQueue()}readTables(){return this.readFromFile(),this.tables}dropAll(){if(this.queue.push({method:"dropAllData"}),this.queue.length===1)this.processQueue()}renameTable(e,t){if(this.queue.push({method:"renameTable",table:e,newTableName:t}),this.queue.length===1)this.processQueue()}renameColumn(e,t,s){if(this.queue.push({method:"renameColumn",table:e,column:t,newColumnName:s}),this.queue.length===1)this.processQueue()}getTableNames(){return this.readFromFile(),Object.keys(this.tables)}getColumnNames(e){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);return this.tables[e].columns}getRecordCount(e){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);return this.tables[e].records.length}async processQueue(e){let t=this.queue[0];switch(t.method){case"insert":if(!t.table)throw new Error("Table name is required.");this.insertTable(t.table,t.record);break;case"update":if(!t.table)throw new Error("Table name is required.");this.updateTable(t.table,t.query,t.newData);break;case"delete":if(!t.table)throw new Error("Table name is required.");this.deleteFromTable(t.table,t.query);break;case"dropAllData":this.dropAllData();break;case"migration":if(e)await e(),this.markMigrationAsApplied(t.record?.id);break;case"renameTable":if(!t.table||!t.newTableName)throw new Error("Old and new table names are required.");this.renameTableInDb(t.table,t.newTableName);break;case"renameColumn":if(!t.table||!t.column||!t.newColumnName)throw new Error("Table, old column, and new column names are required.");this.renameColumnInDb(t.table,t.column,t.newColumnName);break}}markMigrationAsApplied(e){this.readFromFile();let t=this.select("migrations",{id:e});if(t.length>0)this.updateTable("migrations",{id:e},{...t[0],applied:!0});if(this.queue.shift(),this.queue.length>0)this.processQueue()}insertTable(e,t){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);let s=this.tables[e],i={};for(let r of s.columns)i[r]=t[r]||null;if(s.records.push(i),this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}updateTable(e,t,s){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);let i=this.tables[e],r=i.records.map((n)=>{let a=Object.entries(s);for(let[o,d]of a)if(i.columns.includes(o)&&Object.entries(t).every(([w,v])=>n[w]===v))n[o]=d;return n});if(i.records=r,this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}deleteFromTable(e,t){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);if(this.tables[e].records=this.tables[e].records.filter((s)=>!Object.entries(t).every(([i,r])=>s[i]===r)),this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}dropAllData(){this.readFromFile();for(let e in this.tables)this.tables[e].records=[];if(this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}renameTableInDb(e,t){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);if(this.tables[t])throw new Error(`Table "${t}" already exists.`);if(this.tables[t]=this.tables[e],delete this.tables[e],this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}renameColumnInDb(e,t,s){if(this.readFromFile(),!this.tables[e])throw new Error(`Table "${e}" does not exist.`);if(!this.tables[e].columns.includes(t))throw new Error(`Column "${t}" does not exist in table "${e}".`);if(this.tables[e].columns.includes(s))throw new Error(`Column "${s}" already exists in table "${e}".`);let i=this.tables[e].columns.indexOf(t);this.tables[e].columns[i]=s;for(let r of this.tables[e].records)r[s]=r[t],delete r[t];if(this.saveToFile(),this.queue.shift(),this.queue.length>0)this.processQueue()}saveToFile(){if(!this.filePath.endsWith(".ht"))throw new Error(`File path must include '.ht': ${this.filePath}`);let e=JSON.stringify(this.tables),t=u.default.randomBytes(8),s=Buffer.from(this.password,"utf-8"),{key:i,iv:r}=this.evpBytesToKey(s,t,32,16),n=u.default.createCipheriv("aes-256-cbc",i,r),a=Buffer.concat([n.update(Buffer.from(e,"utf8")),n.final()]),o=Buffer.concat([Buffer.from("Salted__"),t,a]);h.default.writeFileSync(this.filePath,o.toString("base64"))}readFromFile(){if(!h.default.existsSync(this.filePath))return;try{let e=h.default.readFileSync(this.filePath,"utf8"),t=Buffer.from(e,"base64");if(t.length<16||t.subarray(0,8).toString()!=="Salted__")throw new Error("Invalid encrypted data format");let s=t.subarray(8,16),i=t.subarray(16),r=Buffer.from(this.password,"utf-8"),{key:n,iv:a}=this.evpBytesToKey(r,s,32,16),o=u.default.createDecipheriv("aes-256-cbc",n,a),d=Buffer.concat([o.update(i),o.final()]).toString("utf8");this.tables=JSON.parse(d)}catch(e){this.tables={}}}evpBytesToKey(e,t,s,i){let r=Buffer.alloc(0),n=Buffer.alloc(0),a=s+i;while(r.length<a){let o=u.default.createHash("md5");if(n.length>0)o.update(n);o.update(e),o.update(t),n=o.digest(),r=Buffer.concat([r,n])}return{key:r.subarray(0,s),iv:r.subarray(s,s+i)}}}