stabilize-orm 1.1.2 → 1.1.4

package/types.ts

@@ -1,14 +1,52 @@
-// src/types.ts
+/**
+ * @file types.ts
+ * @description Contains all shared type definitions and enums for the Stabilize ORM.
+ * @author ElectronSz
+ */
+
 export enum DBType {
-  SQLite = "sqlite",
-  MySQL = "mysql",
   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;
-  poolSize?: number;
   retryAttempts?: number;
   retryDelay?: number;
   maxJitter?: number;
@@ -22,6 +60,9 @@ export interface CacheConfig {
   strategy?: "cache-aside" | "write-through";
 }
 
+/**
+ * Configuration for the logger.
+ */
 export interface LoggerConfig {
   level?: LogLevel;
   filePath?: string;
@@ -29,38 +70,25 @@ export interface LoggerConfig {
   maxFiles?: number;
 }
 
-export enum LogLevel {
-  ERROR = "error",
-  WARN = "warn",
-  INFO = "info",
-  DEBUG = "debug",
-}
-
-export interface CacheStats {
-  hits: number;
-  misses: number;
-  keys: number;
-}
-
-export enum RelationType {
-  OneToOne = "one-to-one",
-  OneToMany = "one-to-many",
-  ManyToOne = "many-to-one",
-  ManyToMany = "many-to-many",
+export interface PoolMetrics {
+  activeConnections: number;
+  idleConnections: number;
+  totalConnections: number;
 }
 
 export interface QueryHint {
-  type: "INDEX" | "FORCE_INDEX" | "USE_INDEX";
+  type: string;
   value: string;
 }
 
-export interface PoolMetrics {
-  activeConnections: number;
-  idleConnections: number;
-  totalConnections: number;
+export interface CacheStats {
+  hits: number;
+  misses: number;
+  keys: number;
 }
 
 export interface Migration {
+  name: string;
   up: string[];
   down: string[];
 }
@@ -68,9 +96,10 @@ export interface Migration {
 export class StabilizeError extends Error {
   constructor(
     message: string,
-    public readonly code?: string,
+    public code: string,
+    public originalError?: Error,
   ) {
     super(message);
     this.name = "StabilizeError";
   }
-}
+}