stabilize-orm 1.3.8 → 2.1.0

package/tests/migrations.test.ts

@@ -1,141 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { generateMigration, runMigrations } from '../migrations';
-import { DBType } from '../types';
-// We must mock the imports that provide the metadata keys and the client implementation
-import { ModelKey, ColumnKey, ValidatorKey, SoftDeleteKey } from '../decorators';
-import { DBClient } from '../client'; 
-
-// --- MOCKING SETUP ---
-
-// Mocking Reflect.getMetadata behavior to simulate data set by the @Model, @Column, etc. decorators
-const mockMetadata = new Map();
-
-// Helper to set mock data for tests
-const setMockMetadata = (tableName: string, columns: any, validators: any, softDeleteField?: string) => {
-  mockMetadata.set(ModelKey, tableName);
-  mockMetadata.set(ColumnKey, columns);
-  mockMetadata.set(ValidatorKey, validators);
-  if (softDeleteField) {
-    mockMetadata.set(SoftDeleteKey, softDeleteField);
-  } else {
-    mockMetadata.delete(SoftDeleteKey);
-  }
-};
-
-// Spy on the global Reflect.getMetadata used by the functions to return our mock data
-const getMetadataSpy = vi.spyOn(Reflect, 'getMetadata');
-getMetadataSpy.mockImplementation((key, target) => mockMetadata.get(key));
-
-
-// Mock Model Placeholder
-class MockModel {} 
-
-// Mock DBClient for runMigrations test: this prevents hitting a real database
-vi.mock('./client', () => {
-    const mockQuery = vi.fn(async (query: string) => {
-        // Simulate no existing migration found when selecting from 'migrations'
-        if (query.includes('SELECT id FROM migrations')) {
-            return [];
-        }
-        return [];
-    });
-    return {
-        DBClient: vi.fn(() => ({
-            query: mockQuery,
-            close: vi.fn(async () => {}),
-            // Provide a mock config for runMigrations to safely access DBType
-            config: {
-                type: DBType.SQLite 
-            }
-        }))
-    };
-});
-
-// --- TESTS START HERE ---
-
-describe('generateMigration', () => {
-  const commonColumns = {
-    id: { name: 'id', type: 'INTEGER' },
-    username: { name: 'user_name', type: 'TEXT' },
-    createdAt: { name: 'created_at', type: 'TEXT' }
-  };
-  const commonValidators = {
-    username: ['required', 'unique']
-  };
-
-  it('should generate SQLite-specific primary key (AUTOINCREMENT)', async () => {
-    setMockMetadata('users', commonColumns, commonValidators);
-
-    const migration = await generateMigration(MockModel, DBType.SQLite);
-
-    expect(migration.up[0]).toBe(
-      'CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, user_name TEXT NOT NULL UNIQUE, created_at TEXT)'
-    );
-  });
-
-  it('should generate PostgreSQL-specific primary key (SERIAL)', async () => {
-    setMockMetadata('products', commonColumns, commonValidators);
-
-    const migration = await generateMigration(MockModel, DBType.Postgres);
-
-    expect(migration.up[0]).toBe(
-      'CREATE TABLE IF NOT EXISTS products (id SERIAL PRIMARY KEY, user_name TEXT NOT NULL UNIQUE, created_at TEXT)'
-    );
-  });
-
-  it('should generate MySQL-specific primary key (AUTO_INCREMENT)', async () => {
-    setMockMetadata('posts', commonColumns, commonValidators);
-
-    const migration = await generateMigration(MockModel, DBType.MySQL);
-
-    expect(migration.up[0]).toBe(
-      'CREATE TABLE IF NOT EXISTS posts (id INTEGER PRIMARY KEY AUTO_INCREMENT, user_name TEXT NOT NULL UNIQUE, created_at TEXT)'
-    );
-  });
-
-  it('should include soft delete field if present on the model', async () => {
-    const softDeleteColumns = {
-      ...commonColumns,
-      deletedAt: { name: 'deleted_at', type: 'TEXT' }
-    };
-    setMockMetadata('orders', softDeleteColumns, commonValidators, 'deletedAt');
-
-    const migration = await generateMigration(MockModel, DBType.SQLite);
-
-    expect(migration.up[0]).toContain(', deleted_at TEXT)');
-  });
-
-  it('should throw an error if the model is missing the @Model decorator', async () => {
-    mockMetadata.delete(ModelKey);
-    await expect(generateMigration(MockModel, DBType.SQLite)).rejects.toThrow('Model not decorated with @Model');
-  });
-});
-
-describe('runMigrations', () => {
-    it('should create the migrations table and run the UP script for new migrations', async () => {
-        const mockMigrations = [
-            { up: ['CREATE TABLE test_table (id INT)'], down: ['DROP TABLE test_table'] }
-        ];
-
-        // Run migrations using the mocked DBClient (defaulted to SQLite type)
-        await runMigrations({ type: DBType.SQLite,connectionString:"" }, mockMigrations);
-
-        // Access the mock instance
-        const mockClient = (DBClient as any).mock.results[0].value;
-        
-        // 1. Verify CREATE TABLE IF NOT EXISTS migrations was called
-        expect(mockClient.query).toHaveBeenCalledWith(expect.stringContaining('CREATE TABLE IF NOT EXISTS migrations ('));
-        
-        // 2. Verify the actual UP query was executed
-        expect(mockClient.query).toHaveBeenCalledWith('CREATE TABLE test_table (id INT)', []);
-
-        // 3. Verify the migration log record was inserted
-        expect(mockClient.query).toHaveBeenCalledWith(
-            expect.stringContaining('INSERT INTO migrations (name, applied_at) VALUES (?, ?)'),
-            expect.arrayContaining([expect.stringContaining('migration_0_'), expect.any(String)])
-        );
-
-        // 4. Verify the client was closed in the finally block
-        expect(mockClient.close).toHaveBeenCalled();
-    });
-});

package/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false,
-
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}

package/types.ts

@@ -1,106 +0,0 @@
-/**
- * @file types.ts
- * @description Contains all shared type definitions and enums for the Stabilize ORM.
- * @author ElectronSz
- */
-
-export enum DBType {
-  Postgres = "postgres",
-  MySQL = "mysql",
-  SQLite = "sqlite",
-}
-
-export enum LogLevel {
-  Debug,
-  Info,
-  Warn,
-  Error,
-}
-
-export enum RelationType {
-  OneToOne,
-  OneToMany,
-  ManyToOne,
-  ManyToMany,
-}
-
-/**
- * An enumeration of abstract data types that are mapped to database-specific types.
- * This allows models to be defined in a database-agnostic way.
- */
-export enum DataTypes {
-  STRING,    // Maps to VARCHAR or TEXT
-  TEXT,      // Maps to TEXT
-  INTEGER,   // Maps to INTEGER or INT
-  BIGINT,    // Maps to BIGINT
-  FLOAT,     // Maps to REAL or FLOAT
-  DOUBLE,    // Maps to DOUBLE PRECISION
-  DECIMAL,   // Maps to DECIMAL or NUMERIC
-  BOOLEAN,   // Maps to BOOLEAN or TINYINT/INTEGER
-  DATE,      // Maps to DATE or TEXT
-  DATETIME,  // Maps to TIMESTAMP, DATETIME, or TEXT
-  JSON,      // Maps to JSON, JSONB, or TEXT
-  UUID,      // Maps to UUID or VARCHAR(36)
-  BLOB,      // Maps to BYTEA or BLOB
-  
-}
-
-export interface DBConfig {
-  type: DBType;
-  connectionString: string;
-  retryAttempts?: number;
-  retryDelay?: number;
-  maxJitter?: number;
-}
-
-export interface CacheConfig {
-  enabled: boolean;
-  ttl: number;
-  redisUrl?: string;
-  cachePrefix?: string;
-  strategy?: "cache-aside" | "write-through";
-}
-
-/**
- * Configuration for the logger.
- */
-export interface LoggerConfig {
-  level?: LogLevel;
-  filePath?: string;
-  maxFileSize?: number;
-  maxFiles?: number;
-}
-
-export interface PoolMetrics {
-  activeConnections: number;
-  idleConnections: number;
-  totalConnections: number;
-}
-
-export interface QueryHint {
-  type: string;
-  value: string;
-}
-
-export interface CacheStats {
-  hits: number;
-  misses: number;
-  keys: number;
-}
-
-export interface Migration {
-  name: string;
-  up: string[];
-  down: string[];
-}
-
-export class StabilizeError extends Error {
-  constructor(
-    message: string,
-    public code: string,
-    public originalError?: Error,
-  ) {
-    super(message);
-    this.name = "StabilizeError";
-  }
-}