hysteria-orm 10.7.4 → 10.7.5

package/lib/index.d.ts

@@ -10,8 +10,8 @@ import { PoolConfig, PoolClient, QueryResult as QueryResult$1 } from 'pg';
 import * as mysql2_promise from 'mysql2/promise';
 import { PoolOptions, PoolConnection, QueryResult } from 'mysql2/promise';
 import { RedisOptions, Redis } from 'ioredis';
-import express from 'express';
 import { FormatOptionsWithLanguage } from 'sql-formatter';
+import express from 'express';
 import { PassThrough } from 'node:stream';
 
 type CaseConvention = "camel" | "snake" | "preserve" | RegExp | ((column: string) => string);
@@ -949,6 +949,262 @@ type OpenApiModelPropertyType = {
     nullable?: boolean;
 };
 
+interface CacheAdapter {
+    /**
+     * @description Gets a value from the cache
+     * @param key The key to get the value from
+     * @returns The value from the cache
+     */
+    get<T = void>(key: string): Promise<T>;
+    /**
+     * @description Sets a value in the cache
+     * @param key The key to set the value to
+     * @param data The value to set in the cache
+     * @param ttl The time to live for the value in milliseconds
+     */
+    set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * @description Invalidates a value from the cache
+     * @param key The key to invalidate the value from
+     */
+    invalidate(key: string): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAll(key: string): Promise<void>;
+    /**
+     * @description Disconnects from the cache adapter if needed when the data source disconnects
+     */
+    disconnect?(): Promise<void>;
+}
+
+type CacheKeys = Record<string, (...args: any[]) => Promise<any> | any>;
+type UseCacheReturnType<C extends CacheKeys, K extends keyof C> = K extends never ? never : Awaited<ReturnType<C[K]>>;
+
+type Sqlite3ConnectionOptions = {
+    mode: number;
+};
+type SqlDriverSpecificOptions<T extends DataSourceType> = Omit<DriverSpecificOptions<T>, "mongoOptions" | "redisOptions">;
+type MysqlConnectionInstance = Awaited<ReturnType<Mysql2Import["createPool"]>>;
+type PgPoolClientInstance = InstanceType<PgImport["Pool"]>;
+type SqliteConnectionInstance = InstanceType<Sqlite3Import["Database"]>;
+type OracleDBPoolInstance = Pool;
+type MssqlPoolInstance = InstanceType<MssqlImport["ConnectionPool"]>;
+type MssqlConnectionInstance = Awaited<ReturnType<MssqlPoolInstance["connect"]>>;
+type SqlPoolType = OracleDBPoolInstance | MysqlConnectionInstance | PgPoolClientInstance | SqliteConnectionInstance | MssqlPoolInstance;
+/**
+ * @description The connection policies for the sql data source
+ * @default the connection policies are not set, so no query will be retried
+ */
+type ConnectionPolicies = {
+    /**
+     * @description The retry policy for the sql data source, it allows to retry a query if it fails
+     */
+    retry?: {
+        maxRetries?: number;
+        delay?: number;
+    };
+};
+/**
+ * Accepts both decorator-based model classes (`typeof Model` subclasses)
+ * and programmatic models created via `defineModel`.
+ */
+type SqlDataSourceModel = AnyModelConstructor;
+/**
+ * @description Base migration configuration options available for all databases
+ */
+type MigrationConfigBase = {
+    /**
+     * @description The path to the migrations folder, can be overridden in the cli command
+     * @default "database/migrations"
+     */
+    path?: string;
+    /**
+     * @description Path to the tsconfig.json file for TypeScript migration files, can be overridden in the cli command
+     * @default "./tsconfig.json"
+     */
+    tsconfig?: string;
+    /**
+     * @description Acquire advisory lock before running migrations to prevent concurrent execution, can be overridden in the cli command
+     * @default true
+     */
+    lock?: boolean;
+    /**
+     * @description Lock timeout in milliseconds for migration advisory lock acquisition, can be overridden in the cli command
+     * @default 30000
+     */
+    lockTimeout?: number;
+};
+/**
+ * @description Migration configuration with transactional support for PostgreSQL and CockroachDB
+ */
+type MigrationConfigWithTransactional = MigrationConfigBase & {
+    /**
+     * @description Runs all pending migrations in a single transaction, can be overridden in the cli command
+     * @default true
+     * @note Only available for PostgreSQL and CockroachDB
+     */
+    transactional?: boolean;
+};
+/**
+ * @description Migration configuration type based on database type
+ * @description Adds transactional option only for PostgreSQL and CockroachDB
+ */
+type MigrationConfig<D extends SqlDataSourceType = SqlDataSourceType> = D extends "postgres" | "cockroachdb" ? MigrationConfigWithTransactional : MigrationConfigBase;
+/**
+ * @description Seeder configuration options
+ */
+type SeederConfig = {
+    /**
+     * @description The path to the seeders folder
+     * @default "database/seeders"
+     */
+    path?: string;
+    /**
+     * @description Path to the tsconfig.json file for TypeScript seeder files
+     * @default "./tsconfig.json"
+     */
+    tsconfig?: string;
+};
+/**
+ * @description Common input properties shared across all SqlDataSource types
+ */
+type SqlDataSourceInputBase<T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}, D extends SqlDataSourceType = SqlDataSourceType> = {
+    /**
+     * @description Whether to log the sql queries and other debug information. Can be a boolean or a LoggerConfig object for granular control.
+     * @warning Logs are synchronous by default and add overhead — do not use in production unless you override with an async custom logger.
+     * @default false
+     */
+    readonly logs?: boolean | LoggerConfig;
+    /**
+     * @description The connection policies to use for the sql data source that are not configured in the driverOptions
+     */
+    connectionPolicies?: ConnectionPolicies;
+    /**
+     * @description The query format options to use for the sql data source, it tells how the sql queries should be formatted before being executed and logged
+     */
+    queryFormatOptions?: FormatOptionsWithLanguage;
+    /**
+     * @description The models to use for the sql data source, if used models will be registered in the sql data source instance and will be available for the models to use
+     * @description Models can still be used as standalone entities, but they won't be available for the sql data source instance
+     */
+    models?: T;
+    /**
+     * @description Migration configuration for the sql data source
+     */
+    migrations?: MigrationConfig<D>;
+    /**
+     * @description Seeder configuration for the sql data source
+     */
+    seeders?: SeederConfig;
+    /**
+     * @description The cache strategy to use for the sql data source, it's used to configure the cache strategy for the sql data source
+     */
+    cacheStrategy?: {
+        cacheAdapter?: CacheAdapter;
+        keys: C;
+    };
+    /**
+     * @description AdminJS configuration for the admin panel
+     * @description To use AdminJS, install: `npm install adminjs`
+     */
+    adminJs?: AdminJsOptions;
+};
+/**
+ * @description Maps a SqlDataSourceType to its corresponding input interface
+ */
+type MapSqlDataSourceTypeToInput<D extends SqlDataSourceType> = D extends "mysql" | "mariadb" ? MysqlSqlDataSourceInput : D extends "postgres" | "cockroachdb" ? PostgresSqlDataSourceInput : D extends "sqlite" ? SqliteDataSourceInput : D extends "mssql" ? MssqlDataSourceInput : D extends "oracledb" ? OracleDBDataSourceInput : never;
+type SlaveContext = {
+    type: SqlDataSourceType;
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+    database: string;
+};
+/**
+ * @description The input type for the SqlDataSource constructor
+ * @description The connectionPolicies object is used to configure the connection policies for the sql data source
+ */
+type SqlDataSourceInput<D extends SqlDataSourceType = SqlDataSourceType, T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}> = SqlDataSourceInputBase<T, C, D> & {
+    /**
+     * @description The type of the database to connect to
+     */
+    readonly type: D;
+    /**
+     * @description The driver specific options to use for the sql data source, it's used to configure the driver specific options for the sql data source
+     * @warning For usage with types, you must have driver types installed if the driver handles types in a type package like e.g. `@types/pg`
+     */
+    driverOptions?: SqlDriverSpecificOptions<D>;
+    /**
+     * @description The replication configuration for the sql data source, it's used to configure the replication for the sql data source
+     */
+    replication?: {
+        /**
+         * @description The function to call when a slave server fails, if not provided an error will be thrown
+         */
+        onSlaveServerFailure?: (error: Error, context: SlaveContext) => void | Promise<void>;
+        /**
+         * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
+         */
+        slaves?: Omit<UseConnectionInput<D, T, C>, "slaves" | "models" | "cacheStrategy" | "adminJs" | "logs" | "queryFormatOptions" | "migrations">[];
+        /**
+         * @description The algorithm to use for selecting the slave for read operations
+         * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
+         * @option "random" - Randomly selects a slave for each request
+         */
+        slaveAlgorithm?: SlaveAlgorithm;
+    };
+} & Omit<MapSqlDataSourceTypeToInput<D>, "type">;
+/**
+ * @description Maps a SqlDataSourceType to its corresponding non-nullable input interface
+ */
+type MapSqlDataSourceTypeToNotNullableInput<D extends SqlDataSourceType> = D extends "mysql" | "mariadb" ? NotNullableMysqlSqlDataSourceInput : D extends "postgres" | "cockroachdb" ? NotNullablePostgresSqlDataSourceInput : D extends "sqlite" ? NotNullableSqliteDataSourceInput : D extends "mssql" ? NotNullableOracleMssqlDataSourceInput : D extends "oracledb" ? NotNullableOracleDBDataSourceInput : never;
+type UseConnectionInput<D extends SqlDataSourceType = SqlDataSourceType, T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}> = {
+    /**
+     * @description The type of the database to connect to
+     */
+    readonly type: D;
+    readonly logs?: boolean | LoggerConfig;
+    readonly models?: T;
+    readonly driverOptions?: SqlDriverSpecificOptions<D>;
+    connectionPolicies?: ConnectionPolicies;
+    queryFormatOptions?: FormatOptionsWithLanguage;
+    cacheStrategy?: {
+        cacheAdapter: CacheAdapter;
+        keys: C;
+    };
+    /**
+     * @description AdminJS configuration for the admin panel
+     * @description AdminJS is completely optional - dependencies are loaded at runtime via dynamic import()
+     */
+    adminJs?: AdminJsOptions;
+} & Omit<MapSqlDataSourceTypeToNotNullableInput<D>, "type">;
+type SqlDataSourceType = Exclude<DataSourceType, "mongo">;
+type SqlCloneOptions = {
+    /**
+     * @description Whether to recreate the pool of connections for the given driver, by default it's false
+     * @warning If false, the pool of connections will be reused from the caller instance
+     */
+    shouldRecreatePool?: boolean;
+};
+type getPoolReturnType<T = SqlDataSourceType> = T extends "mysql" ? MysqlConnectionInstance : T extends "mariadb" ? MysqlConnectionInstance : T extends "postgres" ? PgPoolClientInstance : T extends "cockroachdb" ? PgPoolClientInstance : T extends "sqlite" ? SqliteConnectionInstance : T extends "mssql" ? MssqlPoolInstance : T extends "oracledb" ? OracleDBPoolInstance : never;
+type GetConnectionReturnType<T = SqlDataSourceType> = T extends "mysql" ? PoolConnection : T extends "mariadb" ? PoolConnection : T extends "postgres" ? PoolClient : T extends "cockroachdb" ? PoolClient : T extends "sqlite" ? InstanceType<Sqlite3Import["Database"]> : T extends "mssql" ? Transaction$1 : T extends "oracledb" ? Connection : never;
+/** Only accepts formats `string` e `string as string` */
+type NoSpace<S extends string> = S extends `${infer _} ${infer _}` ? never : S;
+type TableFormat<S extends string> = NoSpace<S> | (S extends `${infer L} as ${infer R}` ? `${NoSpace<L>} as ${NoSpace<R>}` : never);
+type ReplicationType = "master" | "slave";
+/**
+ * @description Algorithm for selecting a slave database for read operations
+ * @option "roundRobin" - Distributes requests evenly across all slaves in sequence
+ * @option "random" - Randomly selects a slave for each request
+ */
+type SlaveAlgorithm = "roundRobin" | "random";
+type RawQueryOptions = {
+    replicationMode?: ReplicationType;
+};
+
 /**
  * @description AdminJS plugin types - All AdminJS imports are done at runtime via dynamic import()
  * @description This ensures the plugin is completely optional
@@ -976,7 +1232,7 @@ type AdminJsOptions = {
      * @description Models to expose in the AdminJS panel
      * @description If not provided, all models registered in the SqlDataSource will be used
      */
-    resources?: (typeof Model)[];
+    resources?: SqlDataSourceModel[];
     /**
      * @description Custom resource options for specific models
      */
@@ -1179,382 +1435,130 @@ type AdminJsActionOptions = {
     /**
      * @description Custom component for the action
      */
-    component?: string | false;
-    /**
-     * @description Container width for the action
-     */
-    containerWidth?: number | string;
-    /**
-     * @description Layout configuration
-     */
-    layout?: unknown[];
-};
-type AdminJsLocale = {
-    /**
-     * @description Language code
-     */
-    language?: string;
-    /**
-     * @description Available languages
-     */
-    availableLanguages?: string[];
-    /**
-     * @description Custom translations
-     */
-    translations?: Record<string, Record<string, unknown>>;
-    /**
-     * @description Whether to show the language selector
-     */
-    withBackend?: boolean;
-};
-type AdminJsAssets = {
-    /**
-     * @description Custom styles to include
-     */
-    styles?: string[];
-    /**
-     * @description Custom scripts to include
-     */
-    scripts?: string[];
-};
-type AdminJsSettings = {
-    /**
-     * @description Default number of items per page
-     */
-    defaultPerPage?: number;
-};
-type AdminJsPage = {
-    /**
-     * @description Page component path
-     */
-    component?: string;
-    /**
-     * @description Page icon
-     */
-    icon?: string;
-    /**
-     * @description Handler for the page
-     */
-    handler?: (request: unknown, response: unknown, context: unknown) => Promise<unknown>;
-};
-type AdminJsAdminInstance = {
-    options: {
-        rootPath: string;
-        [key: string]: unknown;
-    };
-    watch: () => Promise<void>;
-    initialize: () => Promise<void>;
-    resources: unknown[];
-    findResource: (resourceId: string) => unknown;
-};
-/**
- * @description Return type for getAdminJs method
- */
-type AdminJsInstance = {
-    /**
-     * @description The AdminJS instance
-     */
-    admin: AdminJsAdminInstance;
-    /**
-     * @description Express router for AdminJS (if using express adapter)
-     */
-    router?: ReturnType<typeof express.Router>;
-};
-
-interface CacheAdapter {
-    /**
-     * @description Gets a value from the cache
-     * @param key The key to get the value from
-     * @returns The value from the cache
-     */
-    get<T = void>(key: string): Promise<T>;
-    /**
-     * @description Sets a value in the cache
-     * @param key The key to set the value to
-     * @param data The value to set in the cache
-     * @param ttl The time to live for the value in milliseconds
-     */
-    set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
-    /**
-     * @description Invalidates a value from the cache
-     * @param key The key to invalidate the value from
-     */
-    invalidate(key: string): Promise<void>;
-    /**
-     * @description Invalidates all values from the cache starting with the given key
-     * @param key The key to invalidate the values from
-     */
-    invalidateAll(key: string): Promise<void>;
-    /**
-     * @description Disconnects from the cache adapter if needed when the data source disconnects
-     */
-    disconnect?(): Promise<void>;
-}
-
-type CacheKeys = Record<string, (...args: any[]) => Promise<any> | any>;
-type UseCacheReturnType<C extends CacheKeys, K extends keyof C> = K extends never ? never : Awaited<ReturnType<C[K]>>;
-
-declare abstract class QueryNode {
-    /**
-     * Sql keyword to use for the query e.g. "select"
-     */
-    keyword: string;
-    /**
-     * The current parameter index to use for the query
-     */
-    currParamIndex: number;
-    /**
-     * Whether the query node is a raw value and should not be parsed by the interpreter
-     */
-    isRawValue: boolean;
-    /**
-     * Whether the keyword can be seen multiple times in the query, e.g. "join" can be seen multiple times in a query
-     */
-    abstract canKeywordBeSeenMultipleTimes: boolean;
-    /**
-     * The string to use to chain the keyword with the next keyword
-     */
-    abstract chainsWith: string;
-    /**
-     * The folder to use for the query node, e.g. "select" is in the "select" folder inside the interpreter map
-     */
-    abstract folder: string;
-    /**
-     * The file to use for the query node, e.g. "select" is in the "select" file inside the interpreter map
-     */
-    abstract file: string;
-    constructor(keyword: string, isRawValue?: boolean);
-}
-
-declare class RawNode extends QueryNode {
-    rawValue: string;
-    canKeywordBeSeenMultipleTimes: boolean;
-    chainsWith: string;
-    currParamIndex: number;
-    isRawValue: boolean;
-    folder: string;
-    file: string;
-    constructor(value: string);
-}
-
-type Sqlite3ConnectionOptions = {
-    mode: number;
-};
-type SqlDriverSpecificOptions<T extends DataSourceType> = Omit<DriverSpecificOptions<T>, "mongoOptions" | "redisOptions">;
-type MysqlConnectionInstance = Awaited<ReturnType<Mysql2Import["createPool"]>>;
-type PgPoolClientInstance = InstanceType<PgImport["Pool"]>;
-type SqliteConnectionInstance = InstanceType<Sqlite3Import["Database"]>;
-type OracleDBPoolInstance = Pool;
-type MssqlPoolInstance = InstanceType<MssqlImport["ConnectionPool"]>;
-type MssqlConnectionInstance = Awaited<ReturnType<MssqlPoolInstance["connect"]>>;
-type SqlPoolType = OracleDBPoolInstance | MysqlConnectionInstance | PgPoolClientInstance | SqliteConnectionInstance | MssqlPoolInstance;
-/**
- * @description The connection policies for the sql data source
- * @default the connection policies are not set, so no query will be retried
- */
-type ConnectionPolicies = {
-    /**
-     * @description The retry policy for the sql data source, it allows to retry a query if it fails
-     */
-    retry?: {
-        maxRetries?: number;
-        delay?: number;
-    };
-};
-type SqlDataSourceModel = typeof Model;
-/**
- * @description Base migration configuration options available for all databases
- */
-type MigrationConfigBase = {
-    /**
-     * @description The path to the migrations folder, can be overridden in the cli command
-     * @default "database/migrations"
-     */
-    path?: string;
-    /**
-     * @description Path to the tsconfig.json file for TypeScript migration files, can be overridden in the cli command
-     * @default "./tsconfig.json"
-     */
-    tsconfig?: string;
-    /**
-     * @description Acquire advisory lock before running migrations to prevent concurrent execution, can be overridden in the cli command
-     * @default true
-     */
-    lock?: boolean;
-    /**
-     * @description Lock timeout in milliseconds for migration advisory lock acquisition, can be overridden in the cli command
-     * @default 30000
-     */
-    lockTimeout?: number;
-};
-/**
- * @description Migration configuration with transactional support for PostgreSQL and CockroachDB
- */
-type MigrationConfigWithTransactional = MigrationConfigBase & {
-    /**
-     * @description Runs all pending migrations in a single transaction, can be overridden in the cli command
-     * @default true
-     * @note Only available for PostgreSQL and CockroachDB
-     */
-    transactional?: boolean;
-};
-/**
- * @description Migration configuration type based on database type
- * @description Adds transactional option only for PostgreSQL and CockroachDB
- */
-type MigrationConfig<D extends SqlDataSourceType = SqlDataSourceType> = D extends "postgres" | "cockroachdb" ? MigrationConfigWithTransactional : MigrationConfigBase;
-/**
- * @description Seeder configuration options
- */
-type SeederConfig = {
+    component?: string | false;
     /**
-     * @description The path to the seeders folder
-     * @default "database/seeders"
+     * @description Container width for the action
      */
-    path?: string;
+    containerWidth?: number | string;
     /**
-     * @description Path to the tsconfig.json file for TypeScript seeder files
-     * @default "./tsconfig.json"
+     * @description Layout configuration
      */
-    tsconfig?: string;
+    layout?: unknown[];
 };
-/**
- * @description Common input properties shared across all SqlDataSource types
- */
-type SqlDataSourceInputBase<T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}, D extends SqlDataSourceType = SqlDataSourceType> = {
+type AdminJsLocale = {
     /**
-     * @description Whether to log the sql queries and other debug information. Can be a boolean or a LoggerConfig object for granular control.
-     * @warning Logs are synchronous by default and add overhead — do not use in production unless you override with an async custom logger.
-     * @default false
+     * @description Language code
      */
-    readonly logs?: boolean | LoggerConfig;
+    language?: string;
     /**
-     * @description The connection policies to use for the sql data source that are not configured in the driverOptions
+     * @description Available languages
      */
-    connectionPolicies?: ConnectionPolicies;
+    availableLanguages?: string[];
     /**
-     * @description The query format options to use for the sql data source, it tells how the sql queries should be formatted before being executed and logged
+     * @description Custom translations
      */
-    queryFormatOptions?: FormatOptionsWithLanguage;
+    translations?: Record<string, Record<string, unknown>>;
     /**
-     * @description The models to use for the sql data source, if used models will be registered in the sql data source instance and will be available for the models to use
-     * @description Models can still be used as standalone entities, but they won't be available for the sql data source instance
+     * @description Whether to show the language selector
      */
-    models?: T;
+    withBackend?: boolean;
+};
+type AdminJsAssets = {
     /**
-     * @description Migration configuration for the sql data source
+     * @description Custom styles to include
      */
-    migrations?: MigrationConfig<D>;
+    styles?: string[];
     /**
-     * @description Seeder configuration for the sql data source
+     * @description Custom scripts to include
      */
-    seeders?: SeederConfig;
+    scripts?: string[];
+};
+type AdminJsSettings = {
     /**
-     * @description The cache strategy to use for the sql data source, it's used to configure the cache strategy for the sql data source
+     * @description Default number of items per page
      */
-    cacheStrategy?: {
-        cacheAdapter?: CacheAdapter;
-        keys: C;
-    };
+    defaultPerPage?: number;
+};
+type AdminJsPage = {
     /**
-     * @description AdminJS configuration for the admin panel
-     * @description To use AdminJS, install: `npm install adminjs`
+     * @description Page component path
      */
-    adminJs?: AdminJsOptions;
+    component?: string;
+    /**
+     * @description Page icon
+     */
+    icon?: string;
+    /**
+     * @description Handler for the page
+     */
+    handler?: (request: unknown, response: unknown, context: unknown) => Promise<unknown>;
 };
-/**
- * @description Maps a SqlDataSourceType to its corresponding input interface
- */
-type MapSqlDataSourceTypeToInput<D extends SqlDataSourceType> = D extends "mysql" | "mariadb" ? MysqlSqlDataSourceInput : D extends "postgres" | "cockroachdb" ? PostgresSqlDataSourceInput : D extends "sqlite" ? SqliteDataSourceInput : D extends "mssql" ? MssqlDataSourceInput : D extends "oracledb" ? OracleDBDataSourceInput : never;
-type SlaveContext = {
-    type: SqlDataSourceType;
-    host: string;
-    port: number;
-    username: string;
-    password: string;
-    database: string;
+type AdminJsAdminInstance = {
+    options: {
+        rootPath: string;
+        [key: string]: unknown;
+    };
+    watch: () => Promise<void>;
+    initialize: () => Promise<void>;
+    resources: unknown[];
+    findResource: (resourceId: string) => unknown;
 };
 /**
- * @description The input type for the SqlDataSource constructor
- * @description The connectionPolicies object is used to configure the connection policies for the sql data source
+ * @description Return type for getAdminJs method
  */
-type SqlDataSourceInput<D extends SqlDataSourceType = SqlDataSourceType, T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}> = SqlDataSourceInputBase<T, C, D> & {
+type AdminJsInstance = {
     /**
-     * @description The type of the database to connect to
+     * @description The AdminJS instance
      */
-    readonly type: D;
+    admin: AdminJsAdminInstance;
     /**
-     * @description The driver specific options to use for the sql data source, it's used to configure the driver specific options for the sql data source
-     * @warning For usage with types, you must have driver types installed if the driver handles types in a type package like e.g. `@types/pg`
+     * @description Express router for AdminJS (if using express adapter)
      */
-    driverOptions?: SqlDriverSpecificOptions<D>;
+    router?: ReturnType<typeof express.Router>;
+};
+
+declare abstract class QueryNode {
     /**
-     * @description The replication configuration for the sql data source, it's used to configure the replication for the sql data source
+     * Sql keyword to use for the query e.g. "select"
      */
-    replication?: {
-        /**
-         * @description The function to call when a slave server fails, if not provided an error will be thrown
-         */
-        onSlaveServerFailure?: (error: Error, context: SlaveContext) => void | Promise<void>;
-        /**
-         * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
-         */
-        slaves?: Omit<UseConnectionInput<D, T, C>, "slaves" | "models" | "cacheStrategy" | "adminJs" | "logs" | "queryFormatOptions" | "migrations">[];
-        /**
-         * @description The algorithm to use for selecting the slave for read operations
-         * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
-         * @option "random" - Randomly selects a slave for each request
-         */
-        slaveAlgorithm?: SlaveAlgorithm;
-    };
-} & Omit<MapSqlDataSourceTypeToInput<D>, "type">;
-/**
- * @description Maps a SqlDataSourceType to its corresponding non-nullable input interface
- */
-type MapSqlDataSourceTypeToNotNullableInput<D extends SqlDataSourceType> = D extends "mysql" | "mariadb" ? NotNullableMysqlSqlDataSourceInput : D extends "postgres" | "cockroachdb" ? NotNullablePostgresSqlDataSourceInput : D extends "sqlite" ? NotNullableSqliteDataSourceInput : D extends "mssql" ? NotNullableOracleMssqlDataSourceInput : D extends "oracledb" ? NotNullableOracleDBDataSourceInput : never;
-type UseConnectionInput<D extends SqlDataSourceType = SqlDataSourceType, T extends Record<string, SqlDataSourceModel> = {}, C extends CacheKeys = {}> = {
+    keyword: string;
     /**
-     * @description The type of the database to connect to
+     * The current parameter index to use for the query
      */
-    readonly type: D;
-    readonly logs?: boolean | LoggerConfig;
-    readonly models?: T;
-    readonly driverOptions?: SqlDriverSpecificOptions<D>;
-    connectionPolicies?: ConnectionPolicies;
-    queryFormatOptions?: FormatOptionsWithLanguage;
-    cacheStrategy?: {
-        cacheAdapter: CacheAdapter;
-        keys: C;
-    };
+    currParamIndex: number;
     /**
-     * @description AdminJS configuration for the admin panel
-     * @description AdminJS is completely optional - dependencies are loaded at runtime via dynamic import()
+     * Whether the query node is a raw value and should not be parsed by the interpreter
      */
-    adminJs?: AdminJsOptions;
-} & Omit<MapSqlDataSourceTypeToNotNullableInput<D>, "type">;
-type SqlDataSourceType = Exclude<DataSourceType, "mongo">;
-type SqlCloneOptions = {
+    isRawValue: boolean;
     /**
-     * @description Whether to recreate the pool of connections for the given driver, by default it's false
-     * @warning If false, the pool of connections will be reused from the caller instance
+     * Whether the keyword can be seen multiple times in the query, e.g. "join" can be seen multiple times in a query
      */
-    shouldRecreatePool?: boolean;
-};
-type getPoolReturnType<T = SqlDataSourceType> = T extends "mysql" ? MysqlConnectionInstance : T extends "mariadb" ? MysqlConnectionInstance : T extends "postgres" ? PgPoolClientInstance : T extends "cockroachdb" ? PgPoolClientInstance : T extends "sqlite" ? SqliteConnectionInstance : T extends "mssql" ? MssqlPoolInstance : T extends "oracledb" ? OracleDBPoolInstance : never;
-type GetConnectionReturnType<T = SqlDataSourceType> = T extends "mysql" ? PoolConnection : T extends "mariadb" ? PoolConnection : T extends "postgres" ? PoolClient : T extends "cockroachdb" ? PoolClient : T extends "sqlite" ? InstanceType<Sqlite3Import["Database"]> : T extends "mssql" ? Transaction$1 : T extends "oracledb" ? Connection : never;
-/** Only accepts formats `string` e `string as string` */
-type NoSpace<S extends string> = S extends `${infer _} ${infer _}` ? never : S;
-type TableFormat<S extends string> = NoSpace<S> | (S extends `${infer L} as ${infer R}` ? `${NoSpace<L>} as ${NoSpace<R>}` : never);
-type ReplicationType = "master" | "slave";
-/**
- * @description Algorithm for selecting a slave database for read operations
- * @option "roundRobin" - Distributes requests evenly across all slaves in sequence
- * @option "random" - Randomly selects a slave for each request
- */
-type SlaveAlgorithm = "roundRobin" | "random";
-type RawQueryOptions = {
-    replicationMode?: ReplicationType;
-};
+    abstract canKeywordBeSeenMultipleTimes: boolean;
+    /**
+     * The string to use to chain the keyword with the next keyword
+     */
+    abstract chainsWith: string;
+    /**
+     * The folder to use for the query node, e.g. "select" is in the "select" folder inside the interpreter map
+     */
+    abstract folder: string;
+    /**
+     * The file to use for the query node, e.g. "select" is in the "select" file inside the interpreter map
+     */
+    abstract file: string;
+    constructor(keyword: string, isRawValue?: boolean);
+}
+
+declare class RawNode extends QueryNode {
+    rawValue: string;
+    canKeywordBeSeenMultipleTimes: boolean;
+    chainsWith: string;
+    currParamIndex: number;
+    isRawValue: boolean;
+    folder: string;
+    file: string;
+    constructor(value: string);
+}
 
 declare abstract class BaseBuilder {
     protected nodes: QueryNode[];
@@ -3163,7 +3167,7 @@ type ColumnDataTypeOption = ColumnDataTypeOptionWithLength | ColumnDataTypeOptio
 type LazyRelationType = {
     type?: RelationEnum;
     columnName: string;
-    model: () => typeof Model;
+    model: () => AnyModelConstructor;
     foreignKey: string | (() => string);
     constraintName: string | (() => string);
     onDelete?: OnUpdateOrDelete;
@@ -3309,11 +3313,11 @@ type ColumnType = {
         default?: string | number | null | boolean;
     };
 };
-type ThroughModelCallback<T extends typeof Model> = () => T;
+type ThroughModelCallback<T extends AnyModelConstructor> = () => T;
 type ThroughModelString = string;
-type ThroughModel<T extends typeof Model> = ThroughModelCallback<T> | ThroughModelString;
+type ThroughModel<T extends AnyModelConstructor> = ThroughModelCallback<T> | ThroughModelString;
 type ExtractModelFromTM<TM extends ThroughModel<any>> = TM extends ThroughModelCallback<infer T> ? T : never;
-type ManyToManyOptions<T extends typeof Model, TM extends ThroughModel<T>> = {
+type ManyToManyOptions<T extends AnyModelConstructor, TM extends ThroughModel<T>> = {
     /**
      * @description The foreign key of current model on the Pivot table
      * @example If the current model is User and the through model is UserAddress, the leftForeignKey will be "userId"
@@ -3659,12 +3663,12 @@ declare abstract class JoinQueryBuilder<T extends Model, S extends Record<string
      */
     innerJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator?: BinaryOperatorType): this;
     innerJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn?: JoinableColumn, operator?: BinaryOperatorType): this;
-    innerJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
-    innerJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
+    innerJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
+    innerJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
     innerJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator: BinaryOperatorType, callback: JoinOnCallback): this;
     innerJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, callback: JoinOnCallback): this;
-    innerJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
-    innerJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
+    innerJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
+    innerJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
     /**
      * @description Join a table with the current model
      * @param relationTable - The table to join
@@ -3674,12 +3678,12 @@ declare abstract class JoinQueryBuilder<T extends Model, S extends Record<string
      */
     join(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator?: BinaryOperatorType): this;
     join(relationTable: string, referencingColumn: JoinableColumn, primaryColumn?: JoinableColumn, operator?: BinaryOperatorType): this;
-    join<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
-    join<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
+    join<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
+    join<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
     join(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator: BinaryOperatorType, callback: JoinOnCallback): this;
     join(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, callback: JoinOnCallback): this;
-    join<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
-    join<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
+    join<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
+    join<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
     /**
      * @description Join a table with the current model
      * @param relationTable - The table to join
@@ -3689,12 +3693,12 @@ declare abstract class JoinQueryBuilder<T extends Model, S extends Record<string
      */
     leftJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator?: BinaryOperatorType): this;
     leftJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn?: JoinableColumn, operator?: BinaryOperatorType): this;
-    leftJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
-    leftJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
+    leftJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator?: BinaryOperatorType): this;
+    leftJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn?: ModelKey<T>, operator?: BinaryOperatorType): this;
     leftJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, operator: BinaryOperatorType, callback: JoinOnCallback): this;
     leftJoin(relationTable: string, referencingColumn: JoinableColumn, primaryColumn: JoinableColumn, callback: JoinOnCallback): this;
-    leftJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
-    leftJoin<R extends typeof Model>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
+    leftJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, operator: BinaryOperatorType, callback: JoinOnCallback): this;
+    leftJoin<R extends AnyModelConstructor>(relationModel: R, referencingColumn: ModelKey<InstanceType<R>>, primaryColumn: ModelKey<T>, callback: JoinOnCallback): this;
     /**
      * @description Join a table with the current model
      * @param relationTable - The table to join
@@ -3704,7 +3708,7 @@ declare abstract class JoinQueryBuilder<T extends Model, S extends Record<string
      */
     rightJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, operator?: BinaryOperatorType): this;
     rightJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn?: JoinableColumn, operator?: BinaryOperatorType): this;
-    rightJoin<R extends typeof Model>(relationTable: string | R, referencingColumnOrPrimaryColumn: ModelKey<InstanceType<R>> | JoinableColumn | ModelKey<T>, primaryColumn?: JoinableColumn | ModelKey<T>, operator?: BinaryOperatorType): this;
+    rightJoin<R extends AnyModelConstructor>(relationTable: string | R, referencingColumnOrPrimaryColumn: ModelKey<InstanceType<R>> | JoinableColumn | ModelKey<T>, primaryColumn?: JoinableColumn | ModelKey<T>, operator?: BinaryOperatorType): this;
     rightJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, operator: BinaryOperatorType, callback: JoinOnCallback): this;
     rightJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, callback: JoinOnCallback): this;
     /**
@@ -3716,7 +3720,7 @@ declare abstract class JoinQueryBuilder<T extends Model, S extends Record<string
      */
     fullJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, operator?: BinaryOperatorType): this;
     fullJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn?: JoinableColumn, operator?: BinaryOperatorType): this;
-    fullJoin<R extends typeof Model>(relationTable: string | R, referencingColumnOrPrimaryColumn: ModelKey<InstanceType<R>> | JoinableColumn | ModelKey<T>, primaryColumn?: JoinableColumn | ModelKey<T>, operator?: BinaryOperatorType): this;
+    fullJoin<R extends AnyModelConstructor>(relationTable: string | R, referencingColumnOrPrimaryColumn: ModelKey<InstanceType<R>> | JoinableColumn | ModelKey<T>, primaryColumn?: JoinableColumn | ModelKey<T>, operator?: BinaryOperatorType): this;
     fullJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, operator: BinaryOperatorType, callback: JoinOnCallback): this;
     fullJoin(relationTable: string, referencingColumnOrPrimaryColumn: JoinableColumn, primaryColumn: JoinableColumn, callback: JoinOnCallback): this;
 }
@@ -4623,7 +4627,7 @@ declare class ModelQueryBuilder<T extends Model, S extends Record<string, any> =
     finally(onfinally?: (() => void) | null | undefined): Promise<SelectedModel<T, S, R>[]>;
     chunk(chunkSize: number, options?: ManyOptions): AsyncGenerator<SelectedModel<T, S, R>[] | T[]>;
     stream(options?: ManyOptions & StreamOptions): Promise<PassThrough & AsyncGenerator<SelectedModel<T, S, R> | T>>;
-    paginateWithCursor<K extends ModelKey<T>>(page: number, options?: PaginateWithCursorOptions<T, K>, cursor?: Cursor<T, K>): Promise<[CursorPaginatedData<T, S, R>, Cursor<T, K>]>;
+    paginateWithCursor<K extends ModelKey<T>>(limit: number, options?: PaginateWithCursorOptions<T, K>, cursor?: Cursor<T, K>): Promise<[CursorPaginatedData<T, S, R>, Cursor<T, K>]>;
     /**
      * @description Inserts a new record into the database, it is not advised to use this method directly from the query builder if using a ModelQueryBuilder (`Model.query()`), use the `Model.insert` method instead.
      */
@@ -5466,7 +5470,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      * @description Returns a ModelQueryBuilder instance for the given model
      * @param Model The model to create the query builder from
      */
-    from<T extends typeof Model>(Model: T): ModelQueryBuilder<InstanceType<T>>;
+    from<T extends AnyModelConstructor>(model: T): ModelQueryBuilder<InstanceType<T>>;
     /**
      * @description Returns a SchemaBuilder instance for DDL operations
      * @description The builder will execute queries when awaited or when .execute() is called
@@ -5768,7 +5772,7 @@ type RawModelOptions = {
  * @example
  * type UserInstance = ModelInstanceType<typeof User>; // User
  */
-type ModelInstanceType<O> = O extends typeof Model ? InstanceType<O> : never;
+type ModelInstanceType<O> = O extends AnyModelConstructor ? InstanceType<O> : never;
 /**
  * Available fetch hook combinations for query execution.
  * Hooks can be selectively ignored when fetching data.
@@ -6522,6 +6526,155 @@ declare abstract class Model<T extends Model<T> = any> extends Entity {
     private static dispatchModelManager;
 }
 
+/**
+ * Phantom-typed descriptor for a model column.
+ * `T` carries the TypeScript type the column resolves to at the instance level.
+ */
+interface ColumnDef<T = any> {
+    readonly _phantom: T;
+    readonly _apply: (target: Object, propertyKey: string) => void;
+}
+/**
+ * Phantom-typed descriptor for a model relation.
+ * `T` carries the TypeScript type the relation resolves to at the instance level.
+ */
+interface RelationDef<T = any> {
+    readonly _phantom: T;
+    readonly _apply: (target: Object, propertyKey: string) => void;
+}
+type ColPrimaryOptions = Omit<ColumnOptions, "primaryKey">;
+type ColStringOptions = Omit<ColumnOptions, "type"> & {
+    length?: number;
+};
+type ColTextOptions = Omit<ColumnOptions, "type">;
+type ColIntegerOptions = Omit<ColumnOptions, "serialize">;
+type ColBigIntegerOptions = Omit<ColumnOptions, "serialize">;
+type ColFloatOptions = Omit<ColumnOptions, "serialize">;
+type ColDecimalOptions = Omit<ColumnOptions, "serialize"> & {
+    precision?: number;
+    scale?: number;
+};
+type ColIncrementOptions = Omit<ColumnOptions, "serialize" | "primaryKey" | "nullable">;
+type ColBigIncrementOptions = Omit<ColumnOptions, "serialize" | "primaryKey" | "nullable">;
+type ColBooleanOptions = Omit<ColumnOptions, "prepare" | "serialize">;
+type ColDateOptions = Omit<DateColumnOptions, "format">;
+type ColDatetimeOptions = DatetimeColumnOptions;
+type ColTimestampOptions = DatetimeColumnOptions;
+type ColTimeOptions = Omit<DateColumnOptions, "format">;
+type ColJsonOptions = Omit<ColumnOptions, "prepare" | "serialize">;
+type ColUuidOptions = Omit<ColumnOptions, "prepare">;
+type ColUlidOptions = Omit<ColumnOptions, "prepare">;
+type ColBinaryOptions = Omit<ColumnOptions, "type">;
+type ColSymmetricOptions = Omit<SymmetricEncryptionOptions, "prepare" | "serialize">;
+type ColAsymmetricOptions = Omit<AsymmetricEncryptionOptions, "prepare" | "serialize">;
+type RelationConstraintOptions = {
+    onDelete?: OnUpdateOrDelete;
+    onUpdate?: OnUpdateOrDelete;
+    constraintName?: string;
+};
+interface ColNamespace {
+    (options?: ColumnOptions): ColumnDef<any>;
+    primary(options?: ColPrimaryOptions): ColumnDef<any>;
+    string(options?: ColStringOptions): ColumnDef<string | null | undefined>;
+    text(options?: ColTextOptions): ColumnDef<string | null | undefined>;
+    integer(options?: ColIntegerOptions): ColumnDef<number | null | undefined>;
+    bigInteger(options?: ColBigIntegerOptions): ColumnDef<number | bigint | null | undefined>;
+    float(options?: ColFloatOptions): ColumnDef<number | null | undefined>;
+    decimal(options?: ColDecimalOptions): ColumnDef<number | null | undefined>;
+    increment(options?: ColIncrementOptions): ColumnDef<number | null | undefined>;
+    bigIncrement(options?: ColBigIncrementOptions): ColumnDef<number | null | undefined>;
+    boolean(options?: ColBooleanOptions): ColumnDef<boolean | null | undefined>;
+    date(options?: ColDateOptions): ColumnDef<Date | string | null | undefined>;
+    datetime(options?: ColDatetimeOptions): ColumnDef<Date | string | null | undefined>;
+    timestamp(options?: ColTimestampOptions): ColumnDef<Date | string | null | undefined>;
+    time(options?: ColTimeOptions): ColumnDef<Date | string | null | undefined>;
+    json(options?: ColJsonOptions): ColumnDef<unknown>;
+    uuid(options?: ColUuidOptions): ColumnDef<string | null | undefined>;
+    ulid(options?: ColUlidOptions): ColumnDef<string | null | undefined>;
+    binary(options?: ColBinaryOptions): ColumnDef<Buffer | Uint8Array | string | null | undefined>;
+    enum<const V extends readonly string[]>(values: V, options?: Omit<ColumnOptions, "type">): ColumnDef<V[number] | null | undefined>;
+    encryption: {
+        symmetric(options: ColSymmetricOptions): ColumnDef<string | null | undefined>;
+        asymmetric(options: ColAsymmetricOptions): ColumnDef<string | null | undefined>;
+    };
+}
+type AnyModelClass = abstract new (...args: any[]) => Model;
+interface RelNamespace {
+    hasOne<M extends AnyModelClass>(model: () => M, foreignKey?: string): RelationDef<InstanceType<M> | null | undefined>;
+    hasMany<M extends AnyModelClass>(model: () => M, foreignKey?: string): RelationDef<InstanceType<M>[] | null | undefined>;
+    belongsTo<M extends AnyModelClass>(model: () => M, foreignKey?: string, options?: RelationConstraintOptions): RelationDef<InstanceType<M> | null | undefined>;
+    manyToMany<M extends AnyModelClass, T extends typeof Model = typeof Model, TM extends ThroughModel<T> = ThroughModel<T>>(model: () => M, throughModel: TM, throughModelKeys?: TM extends string ? ManyToManyStringOptions : ManyToManyOptions<T, TM>, options?: RelationConstraintOptions): RelationDef<InstanceType<M>[] | null | undefined>;
+}
+type IndexDefinition = string[] | {
+    columns: string[];
+    name?: string;
+};
+type UniqueDefinition = string[] | {
+    columns: string[];
+    name?: string;
+};
+type CheckDefinition = string | {
+    expression: string;
+    name?: string;
+};
+type HooksDefinition = {
+    beforeFetch?: (queryBuilder: ModelQueryBuilder<any>) => Promise<void> | void;
+    afterFetch?: (data: any[]) => Promise<any[]> | any[];
+    beforeInsert?: (data: any) => Promise<void> | void;
+    beforeInsertMany?: (data: any[]) => Promise<void> | void;
+    beforeUpdate?: (queryBuilder: ModelQueryBuilder<any>) => Promise<void> | void;
+    beforeDelete?: (queryBuilder: ModelQueryBuilder<any>) => Promise<void> | void;
+};
+type DefineModelOptions = {
+    modelCaseConvention?: CaseConvention;
+    databaseCaseConvention?: CaseConvention;
+    softDeleteColumn?: string;
+    softDeleteValue?: boolean | string;
+};
+type ModelDefinition<C extends Record<string, ColumnDef> = Record<string, ColumnDef>, R extends Record<string, RelationDef> = Record<string, RelationDef>> = {
+    columns: C;
+    relations?: R;
+    indexes?: IndexDefinition[];
+    uniques?: UniqueDefinition[];
+    checks?: CheckDefinition[];
+    hooks?: HooksDefinition;
+    options?: DefineModelOptions;
+};
+type InferColumns<C extends Record<string, ColumnDef>> = {
+    [K in keyof C]: C[K] extends ColumnDef<infer T> ? T : never;
+};
+type InferRelations<R extends Record<string, RelationDef>> = {
+    [K in keyof R]: R[K] extends RelationDef<infer T> ? T : never;
+};
+/**
+ * Infers the instance type of a model defined with `defineModel`.
+ */
+type InferModel<C extends Record<string, ColumnDef>, R extends Record<string, RelationDef>> = InferColumns<C> & InferRelations<R>;
+/**
+ * Public statics of `typeof Model` without the abstract constructor flag.
+ */
+type ConcreteModelStatics = {
+    [K in keyof typeof Model]: (typeof Model)[K];
+};
+/**
+ * Union type that accepts both decorator-based model classes (`typeof Model`
+ * subclasses) and programmatic models created via `defineModel`.
+ *
+ * Use this instead of `typeof Model` in any user-facing API that should
+ * accept either kind of model.
+ */
+type AnyModelConstructor = typeof Model | (ConcreteModelStatics & (new (...args: any[]) => Model));
+/**
+ * The return type of `defineModel` – a concrete Model constructor whose
+ * instances carry the inferred column + relation properties.
+ *
+ * Uses a mapped type over `typeof Model` so the abstract flag is stripped,
+ * making the result instantiable while keeping all public static members.
+ */
+type DefinedModel<C extends Record<string, ColumnDef>, R extends Record<string, RelationDef>> = ConcreteModelStatics & {
+    new (): InferModel<C, R> & Model;
+};
+
 type BaseModelRelationType = {
     onDelete?: OnUpdateOrDelete;
     onUpdate?: OnUpdateOrDelete;
@@ -6768,7 +6921,7 @@ declare function timeOnlyColumn(options?: Omit<DateColumnOptions, "format">): Ty
  * @description Defaults type to jsonb for migration generation
  */
 declare function jsonColumn(options?: Omit<ColumnOptions, "prepare" | "serialize">): TypedPropertyDecorator<unknown>;
-declare function getModelColumns(target: typeof Model): ColumnType[];
+declare function getModelColumns(target: AnyModelConstructor): ColumnType[];
 /**
  * relations
  */
@@ -6780,22 +6933,22 @@ declare function getModelColumns(target: typeof Model): ColumnType[];
  * belongsTo<typeof Post>(() => User, 'userId')
  * ```
  */
-declare function belongsTo<M extends typeof Model = any, R extends typeof Model = any>(model: () => R, foreignKey?: ModelKey<InstanceType<M>>, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R> | null | undefined>;
-declare function belongsTo<R extends typeof Model = any>(model: () => R, foreignKey?: string, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R> | null | undefined>;
+declare function belongsTo<M extends AnyModelConstructor = any, R extends AnyModelConstructor = any>(model: () => R, foreignKey?: ModelKey<InstanceType<M>>, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R> | null | undefined>;
+declare function belongsTo<R extends AnyModelConstructor = any>(model: () => R, foreignKey?: string, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R> | null | undefined>;
 /**
  * @description Establishes a has one relation with the given model
  * @default foreignKey by default will be the singular of the model name plus "_id"
  * @example User will have foreignKey "user_id" on the Post model
  */
-declare function hasOne<T extends typeof Model>(model: () => T, foreignKey?: ModelKey<InstanceType<T>>): TypedPropertyDecorator<InstanceType<T> | null | undefined>;
-declare function hasOne<T extends typeof Model>(model: () => T, foreignKey?: string): TypedPropertyDecorator<InstanceType<T> | null | undefined>;
+declare function hasOne<T extends AnyModelConstructor>(model: () => T, foreignKey?: ModelKey<InstanceType<T>>): TypedPropertyDecorator<InstanceType<T> | null | undefined>;
+declare function hasOne<T extends AnyModelConstructor>(model: () => T, foreignKey?: string): TypedPropertyDecorator<InstanceType<T> | null | undefined>;
 /**
  * @description Establishes a has many relation with the given model
  * @default foreignKey by default will be the singular of the model name plus "_id"
  * @example User will have foreignKey "user_id" on the Post model
  */
-declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: ModelKey<InstanceType<T>>): TypedPropertyDecorator<InstanceType<T>[] | null | undefined>;
-declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: string): TypedPropertyDecorator<InstanceType<T>[] | null | undefined>;
+declare function hasMany<T extends AnyModelConstructor>(model: () => T, foreignKey?: ModelKey<InstanceType<T>>): TypedPropertyDecorator<InstanceType<T>[] | null | undefined>;
+declare function hasMany<T extends AnyModelConstructor>(model: () => T, foreignKey?: string): TypedPropertyDecorator<InstanceType<T>[] | null | undefined>;
 /**
  * @description Establishes a many to many relation with the given model
  * @default foreignKey by default will be the singular of the model that establishes the relation name plus "_id"
@@ -6806,20 +6959,56 @@ declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: st
  * @param throughModelKeys.rightForeignKey The foreign key of the through model from the related model (the model you are joining to)
  * @example User will have foreignKey "user_id" on the Join table by default
  */
-declare function manyToMany<R extends typeof Model, T extends typeof Model, TM extends ThroughModel<T>>(model: () => R, throughModel: TM, throughModelKeys?: ManyToManyOptions<T, TM>, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R>[] | null | undefined>;
-declare function manyToMany<R extends typeof Model>(model: () => R, throughModel: string | (() => typeof Model), throughModelKeys?: ManyToManyStringOptions, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R>[] | null | undefined>;
-declare function getRelationsMetadata(target: typeof Model): LazyRelationType[];
+declare function manyToMany<R extends AnyModelConstructor, T extends AnyModelConstructor, TM extends ThroughModel<T>>(model: () => R, throughModel: TM, throughModelKeys?: ManyToManyOptions<T, TM>, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R>[] | null | undefined>;
+declare function manyToMany<R extends AnyModelConstructor>(model: () => R, throughModel: string | (() => AnyModelConstructor), throughModelKeys?: ManyToManyStringOptions, options?: BaseModelRelationType): TypedPropertyDecorator<InstanceType<R>[] | null | undefined>;
+declare function getRelationsMetadata(target: AnyModelConstructor): LazyRelationType[];
 /**
  * @description Returns the relations of the model
  */
-declare function getRelations(target: typeof Model): Relation[];
+declare function getRelations(target: AnyModelConstructor): Relation[];
 /**
  * @description Returns the primary key of the model
  */
-declare function getPrimaryKey(target: typeof Model): string | undefined;
-declare function getIndexes(target: typeof Model): IndexType[];
-declare function getUniques(target: typeof Model): UniqueType[];
-declare function getChecks(target: typeof Model): CheckType[];
+declare function getPrimaryKey(target: AnyModelConstructor): string | undefined;
+declare function getIndexes(target: AnyModelConstructor): IndexType[];
+declare function getUniques(target: AnyModelConstructor): UniqueType[];
+declare function getChecks(target: AnyModelConstructor): CheckType[];
+
+declare const col: ColNamespace;
+declare const rel: RelNamespace;
+/**
+ * Creates a fully-typed Model subclass programmatically without decorators.
+ *
+ * The returned class is a real `typeof Model` subclass that works with all
+ * existing infrastructure: `SqlDataSource`, `ModelManager`, `ModelQueryBuilder`,
+ * `SchemaDiff` (automatic migrations), hooks, etc.
+ *
+ * @example
+ * ```typescript
+ * import { defineModel, col, rel } from "hysteria-orm";
+ *
+ * const User = defineModel("users", {
+ *   columns: {
+ *     id: col.increment(),
+ *     name: col.string(),
+ *     email: col.string({ nullable: false }),
+ *     isActive: col.boolean(),
+ *     createdAt: col.datetime({ autoCreate: true }),
+ *     updatedAt: col.datetime({ autoCreate: true, autoUpdate: true }),
+ *   },
+ *   relations: {
+ *     posts: rel.hasMany(() => Post, "userId"),
+ *     profile: rel.hasOne(() => Profile),
+ *   },
+ *   indexes: [["email"]],
+ *   uniques: [["email"]],
+ *   hooks: {
+ *     beforeFetch(qb) { qb.whereNull("deleted_at"); },
+ *   },
+ * });
+ * ```
+ */
+declare function defineModel<C extends Record<string, ColumnDef>, R extends Record<string, RelationDef> = {}>(table: string, definition: ModelDefinition<C, R>): DefinedModel<C, R>;
 
 type FactoryReturnType<T extends number, O extends Model> = T extends 1 ? O : O[];
 
@@ -6829,7 +7018,7 @@ declare class ModelFactory<M extends Model> {
     /**
      * @description Constructor for the model factory
      */
-    constructor(typeofModel: typeof Model, modelData: Partial<M>);
+    constructor(typeofModel: AnyModelConstructor, modelData: Partial<M>);
     /**
      * @description Merges the provided data with the model data
      */
@@ -6841,7 +7030,7 @@ declare class ModelFactory<M extends Model> {
      */
     create<T extends number>(howMany: T): Promise<FactoryReturnType<T, M>>;
 }
-declare const createModelFactory: <M extends Model>(typeofModel: typeof Model, modelData: Partial<ModelWithoutRelations<M>>) => ModelFactory<M>;
+declare const createModelFactory: <M extends Model>(typeofModel: AnyModelConstructor, modelData: Partial<ModelWithoutRelations<M>>) => ModelFactory<M>;
 
 type Constructor<T = Model> = new (...args: any[]) => T;
 type AbstractConstructor<T = Model> = abstract new (...args: any[]) => T;
@@ -7982,4 +8171,4 @@ declare const generateOpenApiModelWithMetadata: <T extends new () => Model>(mode
     $id?: string;
 }>;
 
-export { type AbstractConstructor, type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnyConstructor, type AsymmetricEncryptionOptions, type BaseModelMethodOptions, type BaseModelRelationType, BaseSeeder, type BigIntFields, type BuildSelectType, type BuildSingleSelectType, type CacheAdapter, type CacheKeys, type CheckType, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type ComposeBuildSelect, type ComposeSelect, type ConnectionPolicies, type Constructor, type CustomLogger, type DataSourceInput, type DataSourceType, type DateColumnOptions, type DatetimeColumnOptions, type ExcludeMethods, type ExtractColumnName, type ExtractSourceColumn, type FetchHooks, type FindReturnType, type GetColumnType, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IncrementFields, type IndexType, type LazyRelationType, type LoggerConfig, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, type MigrationConfig, type MigrationConfigBase, type MixinColumns, MixinFactory, Model, type ModelDataProperties, type ModelInstanceType, type ModelKey, ModelQueryBuilder, type ModelQueryResult, type ModelRelation, type ModelSelectTuple, type ModelSelectableInput, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, type RawQueryOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type ReplicationType, type ReturningColumns, type ReturningKey, Schema, SchemaBuilder, type SeederConfig, type SelectBrand, type SelectableColumn, type SelectedModel, type SlaveAlgorithm, type SlaveContext, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, type TimestampFields, Transaction, type TransactionExecutionOptions, type TypedPropertyDecorator, type UlidFields, UlidMixin, type UniqueType, type UseCacheReturnType, type UseConnectionInput, type UuidFields, UuidMixin, WriteOperation, type WriteReturnType, belongsTo, bigIntMixin, check, column, createMixin, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getChecks, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, incrementMixin, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, timestampMixin, ulidMixin, unique, uuidMixin, view, withPerformance };
+export { type AbstractConstructor, type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnyConstructor, type AnyModelConstructor, type AsymmetricEncryptionOptions, type BaseModelMethodOptions, type BaseModelRelationType, BaseSeeder, type BigIntFields, type BuildSelectType, type BuildSingleSelectType, type CacheAdapter, type CacheKeys, type CheckType, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnDef, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type ComposeBuildSelect, type ComposeSelect, type ConnectionPolicies, type Constructor, type CustomLogger, type DataSourceInput, type DataSourceType, type DateColumnOptions, type DatetimeColumnOptions, type DefinedModel, type ExcludeMethods, type ExtractColumnName, type ExtractSourceColumn, type FetchHooks, type FindReturnType, type GetColumnType, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IncrementFields, type IndexType, type LazyRelationType, type LoggerConfig, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, type MigrationConfig, type MigrationConfigBase, type MixinColumns, MixinFactory, Model, type ModelDataProperties, type ModelInstanceType, type ModelKey, ModelQueryBuilder, type ModelQueryResult, type ModelRelation, type ModelSelectTuple, type ModelSelectableInput, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, type RawQueryOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationDef, type RelationQueryBuilderType, type ReplicationType, type ReturningColumns, type ReturningKey, Schema, SchemaBuilder, type SeederConfig, type SelectBrand, type SelectableColumn, type SelectedModel, type SlaveAlgorithm, type SlaveContext, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, type TimestampFields, Transaction, type TransactionExecutionOptions, type TypedPropertyDecorator, type UlidFields, UlidMixin, type UniqueType, type UseCacheReturnType, type UseConnectionInput, type UuidFields, UuidMixin, WriteOperation, type WriteReturnType, belongsTo, bigIntMixin, check, col, column, createMixin, createModelFactory, defineMigrator, defineModel, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getChecks, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, incrementMixin, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, rel, timestampMixin, ulidMixin, unique, uuidMixin, view, withPerformance };