stabilize-orm 1.3.3 → 1.3.9

package/README.md

@@ -1,8 +1,23 @@
 # Stabilize ORM
 
 _A Modern, Type-Safe, and Expressive ORM for Bun_
+<p align="left">
+  <img src="./public/logo_both-transparent.png" alt="Stabilize ORM Logo" width="280" />
+</p>
+
+<p align="left">
+  <a href="https://www.npmjs.com/package/stabilize-orm"><img src="https://img.shields.io/npm/v/stabilize-orm.svg?label=version&color=blue" alt="NPM Version"></a>
+  <a href="https://github.com/ElectronSz/stabilize-cli/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/stabilize-orm.svg?color=green" alt="License"></a>
+  <a href="https://github.com/ElectronSz/stabilize-cli"><img src="https://img.shields.io/badge/Cli-Stabilize%201.2.0-blue.svg" alt="Stabilize CLI"></a>
+  <a href="#"><img src="https://img.shields.io/badge/PostgreSQL-supported-blue" alt="PostgreSQL"></a>
+  <a href="#"><img src="https://img.shields.io/badge/MySQL-supported-blue" alt="MySQL"></a>
+  <a href="#"><img src="https://img.shields.io/badge/SQLite-supported-blue" alt="SQLite"></a>
+<a href="https://github.com/ElectronSz/stabilize-orm/actions/workflows/ci-cd.yml">
+  <img src="https://github.com/ElectronSz/stabilize-orm/actions/workflows/ci-cd.yml/badge.svg" alt="Build Status">
+</a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="MIT License"></a>
+</p>
 
----
 
 **Stabilize** is a lightweight, feature-rich ORM designed for performance and developer experience. It provides a unified, database-agnostic API for **PostgreSQL**, **MySQL**, and **SQLite**. Powered by a robust query builder, programmatic model definitions, automatic versioning, and a full-featured command-line interface, Stabilize is built to scale with your app.
 

package/bun.lock

@@ -92,17 +92,17 @@
 
     "@eslint-community/regexpp": ["@eslint-community/regexpp@4.12.1", "", {}, "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ=="],
 
-    "@eslint/config-array": ["@eslint/config-array@0.21.0", "", { "dependencies": { "@eslint/object-schema": "^2.1.6", "debug": "^4.3.1", "minimatch": "^3.1.2" } }, "sha512-ENIdc4iLu0d93HeYirvKmrzshzofPw6VkZRKQGe9Nv46ZnWUzcF1xV01dcvEg/1wXUR61OmmlSfyeyO7EvjLxQ=="],
+    "@eslint/config-array": ["@eslint/config-array@0.21.1", "", { "dependencies": { "@eslint/object-schema": "^2.1.7", "debug": "^4.3.1", "minimatch": "^3.1.2" } }, "sha512-aw1gNayWpdI/jSYVgzN5pL0cfzU02GT3NBpeT/DXbx1/1x7ZKxFPd9bwrzygx/qiwIQiJ1sw/zD8qY/kRvlGHA=="],
 
-    "@eslint/config-helpers": ["@eslint/config-helpers@0.4.0", "", { "dependencies": { "@eslint/core": "^0.16.0" } }, "sha512-WUFvV4WoIwW8Bv0KeKCIIEgdSiFOsulyN0xrMu+7z43q/hkOLXjvb5u7UC9jDxvRzcrbEmuZBX5yJZz1741jog=="],
+    "@eslint/config-helpers": ["@eslint/config-helpers@0.4.1", "", { "dependencies": { "@eslint/core": "^0.16.0" } }, "sha512-csZAzkNhsgwb0I/UAV6/RGFTbiakPCf0ZrGmrIxQpYvGZ00PhTkSnyKNolphgIvmnJeGw6rcGVEXfTzUnFuEvw=="],
 
     "@eslint/core": ["@eslint/core@0.16.0", "", { "dependencies": { "@types/json-schema": "^7.0.15" } }, "sha512-nmC8/totwobIiFcGkDza3GIKfAw1+hLiYVrh3I1nIomQ8PEr5cxg34jnkmGawul/ep52wGRAcyeDCNtWKSOj4Q=="],
 
     "@eslint/eslintrc": ["@eslint/eslintrc@3.3.1", "", { "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", "espree": "^10.0.1", "globals": "^14.0.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", "js-yaml": "^4.1.0", "minimatch": "^3.1.2", "strip-json-comments": "^3.1.1" } }, "sha512-gtF186CXhIl1p4pJNGZw8Yc6RlshoePRvE0X91oPGb3vZ8pM3qOS9W9NGPat9LziaBV7XrJWGylNQXkGcnM3IQ=="],
 
-    "@eslint/js": ["@eslint/js@9.37.0", "", {}, "sha512-jaS+NJ+hximswBG6pjNX0uEJZkrT0zwpVi3BA3vX22aFGjJjmgSTSmPpZCRKmoBL5VY/M6p0xsSJx7rk7sy5gg=="],
+    "@eslint/js": ["@eslint/js@9.38.0", "", {}, "sha512-UZ1VpFvXf9J06YG9xQBdnzU+kthors6KjhMAl6f4gH4usHyh31rUf2DLGInT8RFYIReYXNSydgPY0V2LuWgl7A=="],
 
-    "@eslint/object-schema": ["@eslint/object-schema@2.1.6", "", {}, "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA=="],
+    "@eslint/object-schema": ["@eslint/object-schema@2.1.7", "", {}, "sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA=="],
 
     "@eslint/plugin-kit": ["@eslint/plugin-kit@0.4.0", "", { "dependencies": { "@eslint/core": "^0.16.0", "levn": "^0.4.1" } }, "sha512-sB5uyeq+dwCWyPi31B2gQlVlo+j5brPlWx4yZBrEaRo/nhdDE8Xke1gsGgtiBdaBTxuTkceLVuVt/pclrasb0A=="],
 
@@ -316,7 +316,7 @@
 
     "escape-string-regexp": ["escape-string-regexp@4.0.0", "", {}, "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA=="],
 
-    "eslint": ["eslint@9.37.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.0", "@eslint/config-helpers": "^0.4.0", "@eslint/core": "^0.16.0", "@eslint/eslintrc": "^3.3.1", "@eslint/js": "9.37.0", "@eslint/plugin-kit": "^0.4.0", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", "@types/json-schema": "^7.0.15", "ajv": "^6.12.4", "chalk": "^4.0.0", "cross-spawn": "^7.0.6", "debug": "^4.3.2", "escape-string-regexp": "^4.0.0", "eslint-scope": "^8.4.0", "eslint-visitor-keys": "^4.2.1", "espree": "^10.4.0", "esquery": "^1.5.0", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", "file-entry-cache": "^8.0.0", "find-up": "^5.0.0", "glob-parent": "^6.0.2", "ignore": "^5.2.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", "json-stable-stringify-without-jsonify": "^1.0.1", "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", "optionator": "^0.9.3" }, "peerDependencies": { "jiti": "*" }, "optionalPeers": ["jiti"], "bin": { "eslint": "bin/eslint.js" } }, "sha512-XyLmROnACWqSxiGYArdef1fItQd47weqB7iwtfr9JHwRrqIXZdcFMvvEcL9xHCmL0SNsOvF0c42lWyM1U5dgig=="],
+    "eslint": ["eslint@9.38.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.1", "@eslint/config-helpers": "^0.4.1", "@eslint/core": "^0.16.0", "@eslint/eslintrc": "^3.3.1", "@eslint/js": "9.38.0", "@eslint/plugin-kit": "^0.4.0", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", "ajv": "^6.12.4", "chalk": "^4.0.0", "cross-spawn": "^7.0.6", "debug": "^4.3.2", "escape-string-regexp": "^4.0.0", "eslint-scope": "^8.4.0", "eslint-visitor-keys": "^4.2.1", "espree": "^10.4.0", "esquery": "^1.5.0", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", "file-entry-cache": "^8.0.0", "find-up": "^5.0.0", "glob-parent": "^6.0.2", "ignore": "^5.2.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", "json-stable-stringify-without-jsonify": "^1.0.1", "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", "optionator": "^0.9.3" }, "peerDependencies": { "jiti": "*" }, "optionalPeers": ["jiti"], "bin": { "eslint": "bin/eslint.js" } }, "sha512-t5aPOpmtJcZcz5UJyY2GbvpDlsK5E8JqRqoKtfiKE3cNh437KIqfJr3A3AKf5k64NPx6d0G3dno6XDY05PqPtw=="],
 
     "eslint-scope": ["eslint-scope@8.4.0", "", { "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" } }, "sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg=="],
 

package/cache.ts

@@ -6,7 +6,7 @@
 
 import Redis from "ioredis";
 import { type CacheConfig, type CacheStats } from "./types";
-import { ConsoleLogger, type Logger } from "./logger";
+import { StabilizeLogger, type Logger } from "./logger";
 
 /**
  * A caching client that uses Redis to store and retrieve query results.
@@ -26,7 +26,7 @@ export class Cache {
    * @param config The configuration for the cache, including Redis URL and TTL.
    * @param logger A logger instance for logging messages.
    */
-  constructor(config: CacheConfig, logger: Logger = new ConsoleLogger()) {
+  constructor(config: CacheConfig, logger: Logger = new StabilizeLogger()) {
     this.config = config;
     this.logger = logger;
 

package/client.ts

@@ -117,8 +117,6 @@ export class DBClient {
       try {
         let result: any;
 
-        this.logger.logQuery(query, params);
-
         if (this.client instanceof Database) {
           let stmt = this.preparedStatements.get(query);
           if (!stmt) {
@@ -126,7 +124,7 @@ export class DBClient {
             this.preparedStatements.set(query, stmt);
           }
           result = stmt.all(...params);
-        } else if (this.config.type === DBType.MySQL && isMySQLPool(this.client)) {
+        } else if (this.config.type === DBType.MySQL) {
           const [rows] = await (this.client as mysql.Pool).query(query, params);
           result = rows;
         } else if (this.config.type === DBType.Postgres ) {
@@ -230,8 +228,6 @@ export class DBClient {
    */
   async migrationQuery(query: string, params: any[] = []): Promise<void> {
     const start = Date.now();
-    this.logger.logQuery(query, params);
-
     if (this.client instanceof Database) {
       let stmt = this.preparedStatements.get(query);
       if (!stmt) {

package/docker-compose.yml

@@ -0,0 +1,22 @@
+
+services:
+  db:
+    image: mariadb:latest
+    container_name: mariadb-container
+    restart: always
+    environment:
+      # Required: set a secure root password
+      MARIADB_ROOT_PASSWORD: P@ssw0rd
+      # Optional: set up a default database and user
+      MARIADB_DATABASE: db
+      MARIADB_USER: admin
+      MARIADB_PASSWORD: P@ssw0rd
+    ports:
+      # Map host port 3306 to container port 3306
+      - '3306:3306'
+    volumes:
+      # Create a named volume for persistent data storage
+      - mariadb_data:/var/lib/mysql
+
+volumes:
+  mariadb_data:

package/hooks.ts

@@ -26,7 +26,7 @@ export interface Hook {
 // Extend ModelConfig to include hooks
 declare module "./model" {
   interface ModelConfig {
-    hooks?: Record<HookType, HookCallback | HookCallback[]>;
+    hooks?:  Partial<Record<HookType, HookCallback | HookCallback[]>>;
   }
 }
 

package/index.ts

@@ -5,10 +5,10 @@
  */
 import { Cache } from "./cache";
 import { DBClient } from "./client";
-import { type Logger, ConsoleLogger } from "./logger";
+import { type Logger, StabilizeLogger } from "./logger";
 import { QueryBuilder } from "./query-builder";
 import { Repository } from "./repository";
-import { runMigrations, generateMigration, type Migration } from "./migrations";
+import { runMigrations, generateMigration, type Migration, mapDataTypeToSql} from "./migrations";
 import {
   type DBConfig,
   type CacheConfig,
@@ -22,7 +22,7 @@ import {
   type CacheStats,
   LogLevel,
 } from "./types";
-import { defineModel } from "./model";
+import { defineModel, MetadataStorage } from "./model";
 import type { Hook } from "./hooks";
 
 export class Stabilize {
@@ -42,7 +42,7 @@ export class Stabilize {
     loggerConfig: LoggerConfig = {},
     existingClient?: DBClient,
   ) {
-    this.logger = new ConsoleLogger(loggerConfig);
+    this.logger = new StabilizeLogger(loggerConfig);
     this.client = existingClient || new DBClient(config, this.logger);
     this.cache = existingClient ? null : (cacheConfig.enabled
       ? new Cache(cacheConfig, this.logger)
@@ -131,15 +131,18 @@ export {
   DBClient,
   QueryBuilder,
   Cache,
-  ConsoleLogger,
+  StabilizeLogger,
   DBType,
   DataTypes,
   LogLevel,
   RelationType,
+  MetadataStorage,
+  mapDataTypeToSql,
   StabilizeError,
   runMigrations,
   generateMigration,
   defineModel,
+  
 };
 
 export type {

package/migrations.ts

@@ -133,6 +133,7 @@ export async function generateMigration(
   const columns = MetadataStorage.getColumns(model);
   const validators = MetadataStorage.getValidators(model);
   const versioned = MetadataStorage.isVersioned(model);
+  const timestamps = MetadataStorage.getTimestamps(model);
 
   const columnDefs: string[] = [];
 
@@ -163,6 +164,28 @@ export async function generateMigration(
     columnDefs.push(defParts.join(" "));
   }
 
+  // Add timestamp columns if enabled
+  if (timestamps) {
+    for (const [field, colName] of Object.entries(timestamps)) {
+      // Use the field name defined in the timestamps config
+      let sqlType = dbType === DBType.Postgres ? "TIMESTAMP" : "DATETIME";
+      let def = `${colName} ${sqlType} NOT NULL`;
+
+      // Set default value for createdAt, and optionally for updatedAt
+      if (field === "createdAt") {
+        def += " DEFAULT CURRENT_TIMESTAMP";
+      } else if (field === "updatedAt") {
+        def += " DEFAULT CURRENT_TIMESTAMP";
+        // For MySQL, add ON UPDATE CURRENT_TIMESTAMP
+        if (dbType === DBType.MySQL) {
+          def += " ON UPDATE CURRENT_TIMESTAMP";
+        }
+      }
+
+      columnDefs.push(def);
+    }
+  }
+
   const up: string[] = [`CREATE TABLE IF NOT EXISTS ${tableName} (${columnDefs.join(", ")})`];
   const down: string[] = [`DROP TABLE IF EXISTS ${tableName}`];
 
@@ -194,8 +217,15 @@ function generateHistoryMigration(
   let modByType = dbType === DBType.MySQL ? "VARCHAR(255)" : "TEXT";
   let modAtType = tsType + (dbType === DBType.Postgres ? " DEFAULT CURRENT_TIMESTAMP" : "");
 
+  // Strip constraints for history columns
+  function cleanColumnDef(def: string): string {
+    return def
+      .replace(/\s+PRIMARY\s+KEY\b/gi, "")
+      .replace(/\s+UNIQUE\b/gi, "");
+  }
+
   const historyColumns = [
-    ...columnDefs,
+    ...columnDefs.map(cleanColumnDef),
     `operation ${opType}`,
     `version ${versionType}`,
     `valid_from ${tsType} NOT NULL`,
@@ -264,7 +294,13 @@ export async function runMigrations(config: DBConfig, migrations: Migration[]) {
           }
 
           const insertQuery = formatQuery(`INSERT INTO stabilize_migrations (name, applied_at) VALUES (?, ?)`, dbType);
-          await txClient.query(insertQuery, [name, new Date().toISOString()]);
+          let appliedAt: string;
+          if (dbType === DBType.MySQL) {
+            appliedAt = new Date().toISOString().slice(0, 19).replace("T", " ");
+          } else {
+            appliedAt = new Date().toISOString();
+          }
+          await txClient.query(insertQuery, [name, appliedAt]);
 
           console.log(`Migration ${name} applied successfully.`);
         });
@@ -279,3 +315,4 @@ export async function runMigrations(config: DBConfig, migrations: Migration[]) {
 }
 
 export type { Migration };
+export { mapDataTypeToSql };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stabilize-orm",
-  "version": "1.3.3",
+  "version": "1.3.9",
   "description": "A lightweight, type-safe ORM for Bun.js with support for SQLite, MySQL, PostgreSQL, and Redis caching",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,21 +26,21 @@
     "@types/uuid": "^11.0.0",
     "commander": "^12.1.0",
     "figlet": "^1.9.3",
-    "glob": "^11.0.0",
-    "ioredis": "^5.4.1",
+    "glob": "^11.0.3",
+    "ioredis": "^5.8.1",
     "mysql2": "^3.15.2",
     "pg": "^8.16.3",
     "reflect-metadata": "^0.2.2",
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.7.0",
-    "@typescript-eslint/parser": "^8.7.0",
-    "@vitest/coverage-v8": "^2.1.3",
-    "eslint": "^9.12.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.3"
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
+    "@vitest/coverage-v8": "^2.1.9",
+    "eslint": "^9.38.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.9"
   },
   "repository": {
     "type": "git",
@@ -54,6 +54,6 @@
     "bun": ">=1.0.0"
   },
   "peerDependencies": {
-    "bun": ">=1.0.0"
+    "bun": "^1.3.0"
   }
 }

package/repository.ts

@@ -46,6 +46,7 @@ export class Repository<T> {
   private logger: Logger;
   private versioned: boolean;
   private historyTable: string;
+  private model: new (...args: any[]) => T;
 
   /**
    * Creates an instance of Repository.
@@ -87,6 +88,7 @@ export class Repository<T> {
     this.logger = logger;
     this.versioned = MetadataStorage.isVersioned(model);
     this.historyTable = `${this.table}_history`;
+    this.model = model;
   }
 
   /**
@@ -287,15 +289,34 @@ export class Repository<T> {
       "modified_at"
     ];
 
-    const values = propertyKeys.map((k) => entity[k]);
+    // Helper to sanitize each value before inserting into SQLite/Postgres/MySQL
+    function sanitizeSqlValue(val: any, dbType: DBType): string | number | boolean | bigint | null {
+      if (val === undefined) return null;
+      if (val instanceof Date) {
+        if (dbType === DBType.MySQL) {
+          // MySQL DATETIME: 'YYYY-MM-DD HH:MM:SS'
+          return val.toISOString().slice(0, 19).replace('T', ' ');
+        }
+        return val.toISOString();
+      }
+      if (typeof val === "boolean") return val ? 1 : 0;
+      if (
+        typeof val === "string" ||
+        typeof val === "number" ||
+        typeof val === "bigint"
+      ) return val;
+      return null;
+    }
+    const dbType = client.config.type;
+    const values = propertyKeys.map((k) => sanitizeSqlValue(entity[k], dbType));
     const params = [
       ...values,
-      operation,
-      entity.version || 1,
-      new Date(),
-      null,
-      user || "system",
-      new Date()
+      sanitizeSqlValue(operation, dbType),
+      sanitizeSqlValue(entity.version || 1, dbType),
+      sanitizeSqlValue(new Date(), dbType),
+      sanitizeSqlValue(null, dbType),
+      sanitizeSqlValue(user || "system", dbType),
+      sanitizeSqlValue(new Date(), dbType)
     ];
 
     let placeholders: string;