@shadow-dev/orm 2.0.0 → 2.0.2

package/README.md

@@ -1,118 +1,118 @@
-# ShadowORM
-
-> 🧩 Lightweight, type-safe MySQL ORM for ShadowCore projects.  
-> ShadowORM is built for **modularity**, **security**, and **runtime schema sync** ΓÇö perfect for bots, services, or web apps using ShadowCore.
-
-![npm version](https://img.shields.io/npm/v/@shadow-dev/orm?style=flat-square)
-![license](https://img.shields.io/github/license/Shadows-Development/ShadowORM?style=flat-square)
-
----
-
-## 🔍 Overview
-
-ShadowORM is a minimalist ORM that offers:
-
-- ✅ **Type-safe models** using generics
-- ✅ **Automatic schema synchronization** (no migration needed)
-- ✅ **JSON + Date normalization**
-- ✅ **Relational support** with foreign keys
-- ✅ **No decorators, no reflection, no magic**
-
-ItΓÇÖs designed to work cleanly alongside ShadowCore but can also be used standalone in any Node.js TypeScript project.
-
----
-
-## 📦 Installation
-
-```bash
-npm install @shadow-dev/orm mysql2
-```
-
----
-
-## 🛠 Usage Example
-
-```ts
-import { Model, Repository, initDatabase, registerModel } from "@shadow-dev/orm";
-
-const Ticket = new Model<{
-  id: string;
-  type: "support" | "report";
-  data: { message: string };
-  createdAt: Date;
-}>("tickets", {
-  id: "string",
-  type: "string",
-  data: "json",
-  createdAt: "datetime"
-});
-
-initDatabase({
-  host: "localhost",
-  user: "root",
-  password: "password",
-  database: "mydb"
-});
-
-registerModel(Ticket);
-
-// Auto-create table on startup
-await syncSchema();
-
-const tickets = new Repository(Ticket);
-
-
-// Use it
-await tickets.create({
-  id: "ticket-001",
-  type: "support",
-  data: { message: "Help me!" },
-  createdAt: new Date()
-});
-```
-
----
-
-## 🧠 Schema Types
-
-ShadowORM supports:
-
-| Type                      | SQL Equivalent    |
-|---------------------------|-------------------|
-| `string`                  | `VARCHAR(255)`    |
-| `number`                  | `INT`             |
-| `boolean`                 | `BOOLEAN`         |
-| `json`                    | `LONGTEXT`        |
-| `datetime`                | `DATETIME`        |
-| `FOREIGN_KEY:<tbl.col>`   | Foreign key ref   |
-
----
-
-## 🧱 Roadmap
-
-- [x] CRUD repository
-- [x] Relational schema support
-- [x] Automatic schema sync
-- [ ] CLI (optional)
-- [ ] Migrations (optional)
-- [ ] Postgres support (maybe)
-
----
-
-## 📖 Documentation
-
-📚 Docs are coming soon and will be available on the ShadowCore documentation site:  
-➡️ [docs.shadowdevelopment.net](https://docs.shadowdevelopment.net)
-
----
-
-## 🏢 Project Ownership
-
-ShadowORM is officially developed and maintained under [Shadow Development LLC](https://shadowdevelopment.net).
-
----
-
-## 📜 License
-
-Licensed under the **GNU General Public License v3.0**  
-See the [LICENSE](LICENSE) file for details.
+# ShadowORM
+
+> 🧩 Lightweight, type-safe MySQL ORM for ShadowCore projects.  
+> ShadowORM is built for **modularity**, **security**, and **runtime schema sync** ΓÇö perfect for bots, services, or web apps using ShadowCore.
+
+![npm version](https://img.shields.io/npm/v/@shadow-dev/orm?style=flat-square)
+![license](https://img.shields.io/github/license/Shadows-Development/ShadowORM?style=flat-square)
+
+---
+
+## 🔍 Overview
+
+ShadowORM is a minimalist ORM that offers:
+
+- ✅ **Type-safe models** using generics
+- ✅ **Automatic schema synchronization** (no migration needed)
+- ✅ **JSON + Date normalization**
+- ✅ **Relational support** with foreign keys
+- ✅ **No decorators, no reflection, no magic**
+
+ItΓÇÖs designed to work cleanly alongside ShadowCore but can also be used standalone in any Node.js TypeScript project.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @shadow-dev/orm mysql2
+```
+
+---
+
+## 🛠 Usage Example
+
+```ts
+import { Model, Repository, initDatabase, registerModel } from "@shadow-dev/orm";
+
+const Ticket = new Model<{
+  id: string;
+  type: "support" | "report";
+  data: { message: string };
+  createdAt: Date;
+}>("tickets", {
+  id: "string",
+  type: "string",
+  data: "json",
+  createdAt: "datetime"
+});
+
+initDatabase({
+  host: "localhost",
+  user: "root",
+  password: "password",
+  database: "mydb"
+});
+
+registerModel(Ticket);
+
+// Auto-create table on startup
+await syncSchema();
+
+const tickets = new Repository(Ticket);
+
+
+// Use it
+await tickets.create({
+  id: "ticket-001",
+  type: "support",
+  data: { message: "Help me!" },
+  createdAt: new Date()
+});
+```
+
+---
+
+## 🧠 Schema Types
+
+ShadowORM supports:
+
+| Type                      | SQL Equivalent    |
+|---------------------------|-------------------|
+| `string`                  | `VARCHAR(255)`    |
+| `number`                  | `INT`             |
+| `boolean`                 | `BOOLEAN`         |
+| `json`                    | `LONGTEXT`        |
+| `datetime`                | `DATETIME`        |
+| `FOREIGN_KEY:<tbl.col>`   | Foreign key ref   |
+
+---
+
+## 🧱 Roadmap
+
+- [x] CRUD repository
+- [x] Relational schema support
+- [x] Automatic schema sync
+- [ ] CLI (optional)
+- [ ] Migrations (optional)
+- [ ] Postgres support (maybe)
+
+---
+
+## 📖 Documentation
+
+📚 Docs are coming soon and will be available on the ShadowCore documentation site:  
+➡️ [docs.shadowdevelopment.net](https://docs.shadowdevelopment.net)
+
+---
+
+## 🏢 Project Ownership
+
+ShadowORM is officially developed and maintained under [Shadow Development LLC](https://shadowdevelopment.net).
+
+---
+
+## 📜 License
+
+Licensed under the **GNU General Public License v3.0**  
+See the [LICENSE](LICENSE) file for details.

package/dist/core/Database.js

@@ -66,12 +66,12 @@ export async function transaction(fn) {
 /* Migrations                          */
 /* ---------------------------------- */
 async function ensureMigrationTable() {
-    await exec(`
-    CREATE TABLE IF NOT EXISTS shadoworm_migrations (
-      id VARCHAR(255) PRIMARY KEY,
-      name VARCHAR(255) NOT NULL,
-      executed_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
-    );
+    await exec(`
+    CREATE TABLE IF NOT EXISTS shadoworm_migrations (
+      id VARCHAR(255) PRIMARY KEY,
+      name VARCHAR(255) NOT NULL,
+      executed_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+    );
   `);
 }
 async function loadMigrations(dir) {

package/dist/core/Model.d.ts

@@ -3,7 +3,7 @@ export interface BaseSchema {
     data?: any;
     createdAt?: Date;
 }
-export type SimpleFieldType = "string" | "int" | "float" | "boolean" | "json" | "datetime";
+export type SimpleFieldType = "string" | "text" | "mediumtext" | "longtext" | "int" | "bigint" | "float" | "double" | "decimal" | "boolean" | "date" | "time" | "datetime" | "timestamp" | "json" | "binary" | "varbinary" | "uuid";
 export interface FieldOptions {
     type: SimpleFieldType;
     pk?: boolean;

package/dist/core/Repository.js

@@ -16,10 +16,10 @@ export class Repository {
         const keys = this.getInsertableKeys(data);
         if (keys.length === 0)
             throw new Error("create(): empty data");
-        const sql = `
-            INSERT INTO \`${this.model.name}\`
-            (${keys.map(k => `\`${k}\``).join(",")})
-            VALUES (${keys.map(() => "?").join(",")})
+        const sql = `
+            INSERT INTO \`${this.model.name}\`
+            (${keys.map(k => `\`${k}\``).join(",")})
+            VALUES (${keys.map(() => "?").join(",")})
         `;
         const values = keys.map(k => this.normalizeWriteValue(k, data[k]));
         const [res] = await getPool().execute(sql, values);
@@ -39,10 +39,10 @@ export class Repository {
             .map(() => `(${keys.map(() => "?").join(",")})`)
             .join(",");
         const values = rows.flatMap(row => keys.map(k => this.normalizeWriteValue(k, row[k])));
-        const sql = `
-            INSERT INTO \`${this.model.name}\`
-            (${keys.map(k => `\`${k}\``).join(",")})
-            VALUES ${placeholders}
+        const sql = `
+            INSERT INTO \`${this.model.name}\`
+            (${keys.map(k => `\`${k}\``).join(",")})
+            VALUES ${placeholders}
         `;
         const [res] = await getPool().execute(sql, values);
         const pk = this.getPrimaryKeyField();
@@ -59,10 +59,10 @@ export class Repository {
             .map(() => `(${keys.map(() => "?").join(",")})`)
             .join(",");
         const values = rows.flatMap(row => keys.map(k => this.normalizeWriteValue(k, row[k])));
-        const sql = `
-            INSERT INTO \`${this.model.name}\`
-            (${keys.map(k => `\`${k}\``).join(",")})
-            VALUES ${placeholders}
+        const sql = `
+            INSERT INTO \`${this.model.name}\`
+            (${keys.map(k => `\`${k}\``).join(",")})
+            VALUES ${placeholders}
         `;
         const [res] = await getPool().execute(sql, values);
         return res.affectedRows;
@@ -100,9 +100,9 @@ export class Repository {
             return [];
         const pk = this.getPrimaryKeyField();
         const placeholders = ids.map(() => "?").join(",");
-        const query = `
-            SELECT * FROM \`${this.model.name}\`
-            WHERE \`${String(pk)}\` IN (${placeholders})
+        const query = `
+            SELECT * FROM \`${this.model.name}\`
+            WHERE \`${String(pk)}\` IN (${placeholders})
         `;
         const [rows] = await getPool().execute(query, ids);
         return rows;
@@ -120,10 +120,10 @@ export class Repository {
         const setClause = setKeys.map(k => `\`${k}\` = ?`).join(", ");
         const setValues = setKeys.map(k => this.normalizeWriteValue(k, data[k]));
         const { sql: whereClause, params: whereValues } = this.buildWhereClause(where);
-        const query = `
-            UPDATE \`${this.model.name}\`
-            SET ${setClause}
-            ${whereClause}
+        const query = `
+            UPDATE \`${this.model.name}\`
+            SET ${setClause}
+            ${whereClause}
         `;
         await getPool().execute(query, [...setValues, ...whereValues]);
         return this.findOne(where);
@@ -138,10 +138,10 @@ export class Repository {
         const setClause = setKeys.map(k => `\`${k}\` = ?`).join(", ");
         const setValues = setKeys.map(k => this.normalizeWriteValue(k, data[k]));
         const { sql, params } = this.buildWhereClause(where);
-        const query = `
-            UPDATE \`${this.model.name}\`
-            SET ${setClause}
-            ${sql}
+        const query = `
+            UPDATE \`${this.model.name}\`
+            SET ${setClause}
+            ${sql}
         `;
         const [res] = await getPool().execute(query, [
             ...setValues,
@@ -180,11 +180,11 @@ export class Repository {
             .map(k => `\`${k}\` = VALUES(\`${k}\`)`)
             .join(",");
         const values = keys.map(k => this.normalizeWriteValue(k, data[k]));
-        const sql = `
-            INSERT INTO \`${this.model.name}\`
-            (${insertCols})
-            VALUES (${insertVals})
-            ON DUPLICATE KEY UPDATE ${updateCols}
+        const sql = `
+            INSERT INTO \`${this.model.name}\`
+            (${insertCols})
+            VALUES (${insertVals})
+            ON DUPLICATE KEY UPDATE ${updateCols}
         `;
         await getPool().execute(sql, values);
         return (await this.findOne({ [pk]: data[pk] }));

package/dist/utils/getNextId.js

@@ -2,18 +2,18 @@ import { getPool } from "../core/Database.js";
 export async function getNextId(prefix) {
     const pool = getPool();
     // Ensure table exists (safe to call multiple times)
-    await pool.execute(`
-        CREATE TABLE IF NOT EXISTS _id_counters (
-                                                    prefix VARCHAR(255) PRIMARY KEY,
-            count INT NOT NULL
-            )
+    await pool.execute(`
+        CREATE TABLE IF NOT EXISTS _id_counters (
+                                                    prefix VARCHAR(255) PRIMARY KEY,
+            count INT NOT NULL
+            )
     `);
     // Atomic upsert + increment
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const [result] = await pool.execute(`
-            INSERT INTO _id_counters (prefix, count)
-            VALUES (?, 1)
-                ON DUPLICATE KEY UPDATE count = count + 1
+    const [result] = await pool.execute(`
+            INSERT INTO _id_counters (prefix, count)
+            VALUES (?, 1)
+                ON DUPLICATE KEY UPDATE count = count + 1
         `, [prefix]);
     // Fetch the new value
     const [rows] = await pool.query(`SELECT count FROM _id_counters WHERE prefix = ?`, [prefix]);

package/dist/utils/syncSchema.js

@@ -6,14 +6,35 @@ import { getAllModels, getPool } from "../core/Database.js";
 /* Helpers                            */
 /* ---------------------------------- */
 function mapType(type) {
-    switch (type) {
+    switch (type.toLowerCase()) {
+        // strings
         case "string": return "VARCHAR(255)";
-        case "json": return "JSON";
-        case "datetime": return "DATETIME";
+        case "text": return "TEXT";
+        case "mediumtext": return "MEDIUMTEXT";
+        case "longtext": return "LONGTEXT";
+        // numbers
         case "int": return "INT";
+        case "bigint": return "BIGINT";
         case "float": return "FLOAT";
+        case "double": return "DOUBLE";
+        case "decimal": return "DECIMAL(10,2)";
+        // boolean
         case "boolean": return "BOOLEAN";
-        default: return type;
+        // dates
+        case "date": return "DATE";
+        case "time": return "TIME";
+        case "datetime": return "DATETIME";
+        case "timestamp": return "TIMESTAMP";
+        // json
+        case "json": return "JSON";
+        // binary
+        case "binary": return "BINARY(16)";
+        case "varbinary": return "VARBINARY(255)";
+        // uuid (convention)
+        case "uuid": return "CHAR(36)";
+        // passthrough (escape hatch)
+        default:
+            return type; // allows raw MySQL like "ENUM(...)", "VARCHAR(64)", etc.
     }
 }
 function formatDefault(value) {
@@ -85,10 +106,20 @@ function generateCreateTableSQL(model) {
             col += ` DEFAULT ${formatDefault(field.default)}`;
         columns.push(col);
     }
-    const fks = model.foreignKeys.map(fk => `FOREIGN KEY (\`${fk.column}\`) REFERENCES \`${fk.references.table}\`(\`${fk.references.column}\`)`);
-    return `
-CREATE TABLE \`${model.name}\` (
-  ${[...columns, ...fks].join(",\n  ")}
+    const fks = model.foreignKeys.map(fk => {
+        let sql = `FOREIGN KEY (\`${fk.column}\`) ` +
+            `REFERENCES \`${fk.references.table}\`(\`${fk.references.column}\`)`;
+        if (fk.onDelete) {
+            sql += ` ON DELETE ${fk.onDelete}`;
+        }
+        if (fk.onUpdate) {
+            sql += ` ON UPDATE ${fk.onUpdate}`;
+        }
+        return sql;
+    });
+    return `
+CREATE TABLE \`${model.name}\` (
+  ${[...columns, ...fks].join(",\n  ")}
 );`.trim();
 }
 function generateIndexSQL(model) {
@@ -114,19 +145,19 @@ function emitMigration(sql, dir) {
         .slice(0, 14);
     const filename = `${id}_auto_sync.ts`;
     const filePath = path.join(dir, filename);
-    const content = `
-import type { Migration } from "@shadow-dev/orm";
-
-export const migration: Migration = {
-  id: "${id}",
-  name: "auto_sync",
-
-  async up(db) {
+    const content = `
+import type { Migration } from "@shadow-dev/orm";
+
+export const migration: Migration = {
+  id: "${id}",
+  name: "auto_sync",
+
+  async up(db) {
 ${sql
         .map(s => `    await db.exec(\`${s.replace(/`/g, "\\`")}\`);`)
-        .join("\n")}
-  }
-};
+        .join("\n")}
+  }
+};
 `.trim();
     fs.writeFileSync(filePath, content, { encoding: "utf8" });
     console.log(`📝 Migration generated: ${filePath}`);

package/package.json

@@ -1,54 +1,55 @@
-{
-  "name": "@shadow-dev/orm",
-  "version": "2.0.0",
-  "description": "Lightweight dynamic MySQL ORM designed for ShadowCore and modular apps.",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": ["dist"],
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "scripts": {
-    "prepublishOnly": "npm run build",
-    "dev": "ts-node src/index.ts",
-    "build": "tsc",
-    "lint": "eslint . --ext .ts",
-    "type-check": "tsc --noEmit",
-    "setup": "node scripts/setup.js",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Shadows-Development/ShadowORM.git"
-  },
-  "author": "Shadow Development LLC",
-  "license": "LGPL-3.0-or-later",
-  "keywords": [
-    "orm",
-    "mysql",
-    "typescript",
-    "lightweight",
-    "shadowcore",
-    "shadow-dev"
-  ],
-  "devDependencies": {
-    "@eslint/json": "^0.13.1",
-    "@types/jest": "^30.0.0",
-    "@types/node": "^24.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.38.0",
-    "@typescript-eslint/parser": "^8.38.0",
-    "eslint": "^9.32.0",
-    "jest": "^30.0.5",
-    "ts-jest": "^29.4.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0"
-  },
-  "dependencies": {
-    "mysql2": "^3.14.3"
-  }
-}
+{
+  "name": "@shadow-dev/orm",
+  "version": "2.0.2",
+  "description": "Lightweight dynamic MySQL ORM designed for ShadowCore and modular apps.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist"],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "dev": "ts-node src/index.ts",
+    "build": "tsc",
+    "lint": "eslint . --ext .ts",
+    "type-check": "tsc --noEmit",
+    "setup": "node scripts/setup.js",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Shadows-Development/ShadowORM.git"
+  },
+  "author": "Shadow Development LLC",
+  "license": "LGPL-3.0-or-later",
+  "keywords": [
+    "orm",
+    "mysql",
+    "typescript",
+    "lightweight",
+    "shadowcore",
+    "shadow-dev"
+  ],
+  "devDependencies": {
+    "@eslint/json": "^0.13.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.38.0",
+    "eslint": "^9.32.0",
+    "jest": "^30.0.5",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  },
+  "dependencies": {
+    "mysql2": "^3.14.3"
+  }
+}
+