hysteria-orm 10.7.5 → 10.7.6

package/lib/index.d.ts

@@ -3196,11 +3196,13 @@ type DateColumnOptions = {
     timezone?: Timezone;
     /**
      * @description Whether to automatically update the timestamp on record updates, uses timezone and format from the dateColumn options
+     * @warning This is a code wise implementation it does not generate a trigger in the database, works with bulk updates too
      * @default false
      */
     autoUpdate?: boolean;
     /**
      * @description Whether to automatically set the timestamp on record creation, uses timezone and format from the dateColumn options
+     * @warning This is a code wise implementation it does not generate a trigger in the database, works with bulk creations too
      * @default false
      */
     autoCreate?: boolean;
@@ -6526,11 +6528,13 @@ declare abstract class Model<T extends Model<T> = any> extends Entity {
     private static dispatchModelManager;
 }
 
+declare const __selfBrand: unique symbol;
+
 /**
  * Phantom-typed descriptor for a model column.
  * `T` carries the TypeScript type the column resolves to at the instance level.
  */
-interface ColumnDef<T = any> {
+interface ColumnDef<T = unknown> {
     readonly _phantom: T;
     readonly _apply: (target: Object, propertyKey: string) => void;
 }
@@ -6542,114 +6546,437 @@ interface RelationDef<T = any> {
     readonly _phantom: T;
     readonly _apply: (target: Object, propertyKey: string) => void;
 }
-type ColPrimaryOptions = Omit<ColumnOptions, "primaryKey">;
-type ColStringOptions = Omit<ColumnOptions, "type"> & {
+type ColOptions = Omit<ColumnOptions, "primaryKey" | "serialize" | "prepare">;
+type ColPrimaryOptions = Omit<ColumnOptions, "primaryKey" | "serialize" | "prepare">;
+type ColStringOptions = Omit<ColumnOptions, "type" | "serialize" | "prepare"> & {
     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"> & {
+type ColTextOptions = Omit<ColumnOptions, "type" | "serialize" | "prepare">;
+type ColIntegerOptions = Omit<ColumnOptions, "serialize" | "prepare">;
+type ColBigIntegerOptions = Omit<ColumnOptions, "serialize" | "prepare">;
+type ColFloatOptions = Omit<ColumnOptions, "serialize" | "prepare">;
+type ColDecimalOptions = Omit<ColumnOptions, "serialize" | "prepare"> & {
     precision?: number;
     scale?: number;
 };
-type ColIncrementOptions = Omit<ColumnOptions, "serialize" | "primaryKey" | "nullable">;
-type ColBigIncrementOptions = Omit<ColumnOptions, "serialize" | "primaryKey" | "nullable">;
+type ColIncrementOptions = Omit<ColumnOptions, "serialize" | "prepare" | "primaryKey" | "nullable">;
+type ColBigIncrementOptions = Omit<ColumnOptions, "serialize" | "prepare" | "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 ColDateOptions = Omit<DateColumnOptions, "format" | "serialize" | "prepare">;
+type ColDatetimeOptions = Omit<DatetimeColumnOptions, "serialize" | "prepare">;
+type ColTimestampOptions = Omit<DatetimeColumnOptions, "serialize" | "prepare">;
+type ColTimeOptions = Omit<DateColumnOptions, "format" | "serialize" | "prepare">;
 type ColJsonOptions = Omit<ColumnOptions, "prepare" | "serialize">;
-type ColUuidOptions = Omit<ColumnOptions, "prepare">;
-type ColUlidOptions = Omit<ColumnOptions, "prepare">;
-type ColBinaryOptions = Omit<ColumnOptions, "type">;
+type ColUuidOptions = Omit<ColumnOptions, "prepare" | "serialize">;
+type ColUlidOptions = Omit<ColumnOptions, "prepare" | "serialize">;
+type ColBinaryOptions = Omit<ColumnOptions, "type" | "serialize" | "prepare">;
+type ColEnumOptions = Omit<ColumnOptions, "type" | "serialize" | "prepare">;
 type ColSymmetricOptions = Omit<SymmetricEncryptionOptions, "prepare" | "serialize">;
 type ColAsymmetricOptions = Omit<AsymmetricEncryptionOptions, "prepare" | "serialize">;
 type RelationConstraintOptions = {
+    /**
+     * Useful for auto generated migrations to specify the on delete action, it does not affect the code wise implementation
+     */
     onDelete?: OnUpdateOrDelete;
+    /**
+     * Useful for auto generated migrations to specify the on update action, it does not affect the code wise implementation
+     */
     onUpdate?: OnUpdateOrDelete;
+    /**
+     * Useful for auto generated migrations to specify the constraint name, it does not affect the code wise implementation
+     */
     constraintName?: string;
 };
+type RelationNullableOption = {
+    nullable?: boolean;
+};
+/**
+ * Resolves to `Base` when `Opts` has `{ nullable: false }`, otherwise
+ * `Base | null | undefined`. This powers nullable-aware type inference
+ * for `col.*()` methods.
+ */
+type NullableColumn<Base, Opts> = Opts extends {
+    nullable: false;
+} ? Base : Base | null | undefined;
+type TypedSerialize<T> = {
+    serialize?: (value: any) => T;
+};
+type TypedPrepare<T> = {
+    prepare?: (value: T) => any;
+};
 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>;
+    /**
+     * Generic column — you control the TypeScript type via `col<T>()`.
+     * Use for columns whose type doesn't match any built-in helper.
+     *
+     * Supports typed `serialize` and `prepare` callbacks.
+     *
+     * ```ts
+     * col<string>({ nullable: false })
+     * col<MyCustomType>({ serialize: (raw) => parse(raw), prepare: (v) => stringify(v) })
+     * ```
+     */
+    <T = unknown>(options?: ColOptions & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    /**
+     * Generic primary key column. Defaults to `string | number`.
+     * Override the generic when you know the exact type.
+     *
+     * ```ts
+     * col.primary<number>({ nullable: false })
+     * ```
+     */
+    primary<T = string | number>(options?: ColPrimaryOptions & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    /**
+     * VARCHAR column. Accepts an optional `length` option.
+     * Type: `string` (nullable-aware).
+     *
+     * ```ts
+     * col.string({ length: 255, nullable: false }) // string
+     * col.string()                                  // string | null | undefined
+     * ```
+     */
+    string<O extends ColStringOptions = ColStringOptions>(options?: O & TypedSerialize<NullableColumn<string, O>> & TypedPrepare<NullableColumn<string, O>>): ColumnDef<NullableColumn<string, O>>;
+    /**
+     * LONGTEXT column for large text content.
+     * Type: `string` (nullable-aware).
+     */
+    text<O extends ColTextOptions = ColTextOptions>(options?: O & TypedSerialize<NullableColumn<string, O>> & TypedPrepare<NullableColumn<string, O>>): ColumnDef<NullableColumn<string, O>>;
+    /**
+     * Integer column.
+     * Type: `number` (nullable-aware). Only `prepare` is exposed (no `serialize`).
+     */
+    integer<O extends ColIntegerOptions = ColIntegerOptions>(options?: O & TypedPrepare<NullableColumn<number, O>>): ColumnDef<NullableColumn<number, O>>;
+    /**
+     * Big integer column for values exceeding 32-bit range.
+     * Type: `number | bigint` (nullable-aware). Only `prepare` is exposed.
+     */
+    bigInteger<O extends ColBigIntegerOptions = ColBigIntegerOptions>(options?: O & TypedPrepare<NullableColumn<number | bigint, O>>): ColumnDef<NullableColumn<number | bigint, O>>;
+    /**
+     * Floating-point column.
+     * Type: `number` (nullable-aware). Only `prepare` is exposed.
+     */
+    float<O extends ColFloatOptions = ColFloatOptions>(options?: O & TypedPrepare<NullableColumn<number, O>>): ColumnDef<NullableColumn<number, O>>;
+    /**
+     * Decimal column with optional `precision` and `scale`.
+     * Type: `number` (nullable-aware). Only `prepare` is exposed.
+     *
+     * ```ts
+     * col.decimal({ precision: 10, scale: 2, nullable: false }) // number
+     * ```
+     */
+    decimal<O extends ColDecimalOptions = ColDecimalOptions>(options?: O & TypedPrepare<NullableColumn<number, O>>): ColumnDef<NullableColumn<number, O>>;
+    /**
+     * Auto-incrementing integer primary key. Always non-nullable.
+     * Type: `number`. Only `prepare` is exposed.
+     */
+    increment(options?: ColIncrementOptions & TypedPrepare<number>): ColumnDef<number>;
+    /**
+     * Auto-incrementing bigint primary key. Always non-nullable.
+     * Type: `number`. Only `prepare` is exposed.
+     */
+    bigIncrement(options?: ColBigIncrementOptions & TypedPrepare<number>): ColumnDef<number>;
+    /**
+     * Boolean column.
+     * Type: `boolean` (nullable-aware). No `serialize` or `prepare` exposed.
+     */
+    boolean<O extends ColBooleanOptions = ColBooleanOptions>(options?: O): ColumnDef<NullableColumn<boolean, O>>;
+    /**
+     * DATE column (YYYY-MM-DD). Defaults to `Date` because database drivers
+     * return `Date` objects.
+     *
+     * To type as `string`, use `col.date<string>()` and provide a `serialize`
+     * function that converts the driver `Date` into a string:
+     *
+     * ```ts
+     * col.date<string>({ serialize: (raw) => raw.toISOString().split("T")[0] })
+     * ```
+     */
+    date<T extends Date | string = Date>(options: ColDateOptions & {
+        nullable: false;
+    } & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    date<T extends Date | string = Date>(options?: ColDateOptions & TypedSerialize<T | null | undefined> & TypedPrepare<T | null | undefined>): ColumnDef<T | null | undefined>;
+    /**
+     * DATETIME column. Defaults to `Date` because database drivers return
+     * `Date` objects.
+     *
+     * To type as `string`, use `col.datetime<string>()` and provide a
+     * `serialize` function that converts the driver `Date` into a string:
+     *
+     * ```ts
+     * col.datetime<string>({ serialize: (raw) => new Date(raw).toISOString() })
+     * ```
+     */
+    datetime<T extends Date | string = Date>(options: ColDatetimeOptions & {
+        nullable: false;
+    } & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    datetime<T extends Date | string = Date>(options?: ColDatetimeOptions & TypedSerialize<T | null | undefined> & TypedPrepare<T | null | undefined>): ColumnDef<T | null | undefined>;
+    /**
+     * TIMESTAMP column. Defaults to `Date` because database drivers return
+     * `Date` objects.
+     *
+     * To type as `string`, use `col.timestamp<string>()` and provide a
+     * `serialize` function that converts the driver `Date` into a string:
+     *
+     * ```ts
+     * col.timestamp<string>({ serialize: (raw) => new Date(raw).toISOString() })
+     * ```
+     */
+    timestamp<T extends Date | string = Date>(options: ColTimestampOptions & {
+        nullable: false;
+    } & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    timestamp<T extends Date | string = Date>(options?: ColTimestampOptions & TypedSerialize<T | null | undefined> & TypedPrepare<T | null | undefined>): ColumnDef<T | null | undefined>;
+    /**
+     * TIME column. Defaults to `Date` because database drivers return
+     * `Date` objects.
+     *
+     * To type as `string`, use `col.time<string>()` and provide a
+     * `serialize` function that converts the driver `Date` into a string:
+     *
+     * ```ts
+     * col.time<string>({ serialize: (raw) => new Date(raw).toTimeString() })
+     * ```
+     */
+    time<T extends Date | string = Date>(options: ColTimeOptions & {
+        nullable: false;
+    } & TypedSerialize<T> & TypedPrepare<T>): ColumnDef<T>;
+    time<T extends Date | string = Date>(options?: ColTimeOptions & TypedSerialize<T | null | undefined> & TypedPrepare<T | null | undefined>): ColumnDef<T | null | undefined>;
+    /**
+     * JSON/JSONB column. Defaults to `unknown`.
+     * Pass a concrete type for structured JSON data: `col.json<MyType>()`.
+     *
+     * No `serialize` or `prepare` exposed — serialization is handled internally.
+     *
+     * ```ts
+     * col.json<{ theme: string }>({ nullable: false }) // { theme: string }
+     * col.json()                                        // unknown | null | undefined
+     * ```
+     */
+    json<T = unknown>(options: ColJsonOptions & {
+        nullable: false;
+    }): ColumnDef<T>;
+    json<T = unknown>(options?: ColJsonOptions): ColumnDef<T | null | undefined>;
+    /**
+     * UUID column. Auto-generates a UUID if no value is provided on insert.
+     * Type: `string` (nullable-aware). Only `serialize` is exposed.
+     */
+    uuid<O extends ColUuidOptions = ColUuidOptions>(options?: O & TypedSerialize<NullableColumn<string, O>>): ColumnDef<NullableColumn<string, O>>;
+    /**
+     * ULID column. Auto-generates a ULID if no value is provided on insert.
+     * Type: `string` (nullable-aware). Only `serialize` is exposed.
+     */
+    ulid<O extends ColUlidOptions = ColUlidOptions>(options?: O & TypedSerialize<NullableColumn<string, O>>): ColumnDef<NullableColumn<string, O>>;
+    /**
+     * Binary/blob column.
+     * Type: `Buffer | Uint8Array | string` (nullable-aware).
+     * Supports typed `serialize` and `prepare`.
+     */
+    binary<T extends Buffer | Uint8Array | string = Buffer | Uint8Array | string, O extends ColBinaryOptions = ColBinaryOptions>(options?: O & TypedSerialize<NullableColumn<T, O>> & TypedPrepare<NullableColumn<T, O>>): ColumnDef<NullableColumn<T, O>>;
+    /**
+     * Enum column constrained to the given values array.
+     * Type: `values[number]` (nullable-aware).
+     *
+     * ```ts
+     * col.enum(["active", "inactive"] as const)               // "active" | "inactive" | null | undefined
+     * col.enum(["active", "inactive"] as const, { nullable: false }) // "active" | "inactive"
+     * ```
+     */
+    enum<const V extends readonly string[], O extends ColEnumOptions = ColEnumOptions>(values: V, options?: O & TypedSerialize<NullableColumn<V[number], O>> & TypedPrepare<NullableColumn<V[number], O>>): ColumnDef<NullableColumn<V[number], O>>;
+    /** Encryption column helpers. */
     encryption: {
-        symmetric(options: ColSymmetricOptions): ColumnDef<string | null | undefined>;
-        asymmetric(options: ColAsymmetricOptions): ColumnDef<string | null | undefined>;
+        /**
+         * Symmetric encryption column (AES). Requires `key` in options.
+         * Type: `string` (nullable-aware). No `serialize` or `prepare` exposed.
+         */
+        symmetric<O extends ColSymmetricOptions = ColSymmetricOptions>(options: O): ColumnDef<NullableColumn<string, O>>;
+        /**
+         * Asymmetric encryption column (RSA). Requires `publicKey` and
+         * `privateKey` in options.
+         * Type: `string` (nullable-aware). No `serialize` or `prepare` exposed.
+         */
+        asymmetric<O extends ColAsymmetricOptions = ColAsymmetricOptions>(options: O): ColumnDef<NullableColumn<string, O>>;
     };
 }
 type AnyModelClass = abstract new (...args: any[]) => Model;
+type SelfModelInstance = Model & {
+    readonly [__selfBrand]: true;
+};
+type SelfToken = abstract new (...args: any[]) => SelfModelInstance;
+/**
+ * Model callback type for relation definitions.
+ * Accepts either `() => OtherModel` or `(self) => self` for self-referencing
+ * relations (tree structures, parent/child, etc.).
+ */
+type RelModelCallback<M extends AnyModelClass> = (self: SelfToken) => M;
+/**
+ * Provides autocomplete for column keys of the related model while still accepting any string
+ */
+type ForeignKeyOf<M extends AnyModelClass> = ModelKey<InstanceType<M> & Model> | (string & {});
+/**
+ * Extracts the Model instance type from a through-model callback.
+ */
+type InferThroughModelInstance<TM> = TM extends () => infer T ? T extends AnyModelClass ? InstanceType<T> & Model : Model : 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>;
+    /**
+     * One-to-one relation where the foreign key lives on the **related** model.
+     * The `foreignKey` parameter autocompletes with column keys of `M`.
+     *
+     * Pass `{ nullable: false }` to type the relation as non-nullable.
+     *
+     * ```ts
+     * rel.hasOne(() => Profile, "userId", { nullable: false }) // Profile
+     * rel.hasOne(() => Profile, "userId")                      // Profile | null | undefined
+     * ```
+     *
+     * @param model     Callback returning the related model class (or `(self) => self` for self-referencing).
+     * @param foreignKey Column on the related model that references the current model's primary key.
+     * @param options   `{ nullable: false }` to mark the relation as always present.
+     */
+    hasOne<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey: ForeignKeyOf<M> | undefined, options: {
+        nullable: false;
+    }): RelationDef<InstanceType<M>>;
+    hasOne<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey?: ForeignKeyOf<M>, options?: RelationNullableOption): RelationDef<InstanceType<M> | null | undefined>;
+    /**
+     * One-to-many relation where the foreign key lives on the **related** model.
+     * The `foreignKey` parameter autocompletes with column keys of `M`.
+     *
+     * Pass `{ nullable: false }` to type the relation as non-nullable (always
+     * returns an array, never `null | undefined`).
+     *
+     * ```ts
+     * rel.hasMany(() => Post, "authorId", { nullable: false }) // Post[]
+     * rel.hasMany(() => Post, "authorId")                      // Post[] | null | undefined
+     * ```
+     *
+     * @param model     Callback returning the related model class (or `(self) => self` for self-referencing).
+     * @param foreignKey Column on the related model that references the current model's primary key.
+     * @param options   `{ nullable: false }` to mark the relation as always present.
+     */
+    hasMany<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey: ForeignKeyOf<M> | undefined, options: {
+        nullable: false;
+    }): RelationDef<InstanceType<M>[]>;
+    hasMany<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey?: ForeignKeyOf<M>, options?: RelationNullableOption): RelationDef<InstanceType<M>[] | null | undefined>;
+    /**
+     * Inverse one-to-one / many-to-one relation where the foreign key lives
+     * on the **current** model.
+     *
+     * The `foreignKey` parameter autocompletes with column keys of the related
+     * model `M` as a naming hint; any string is still accepted since the
+     * actual column is on the current model.
+     *
+     * Pass `{ nullable: false }` (inside the constraint options) to type the
+     * relation as non-nullable.
+     *
+     * ```ts
+     * rel.belongsTo(() => User, "userId", { nullable: false }) // User
+     * rel.belongsTo(() => User, "userId")                      // User | null | undefined
+     * rel.belongsTo((self) => self, "parentId")                // self-referencing
+     * ```
+     *
+     * @param model     Callback returning the related model class (or `(self) => self` for self-referencing).
+     * @param foreignKey Column on the **current** model that references the related model's primary key.
+     * @param options   Constraint options (`onDelete`, `onUpdate`, `constraintName`) and `{ nullable: false }`.
+     */
+    belongsTo<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey: ForeignKeyOf<M> | undefined, options: RelationConstraintOptions & {
+        nullable: false;
+    }): RelationDef<InstanceType<M>>;
+    belongsTo<M extends AnyModelClass>(model: RelModelCallback<M>, foreignKey?: ForeignKeyOf<M>, options?: RelationConstraintOptions & RelationNullableOption): RelationDef<InstanceType<M> | null | undefined>;
+    /**
+     * Many-to-many relation through a pivot (join) table.
+     *
+     * - `throughModel`: either a string (pivot table name) or a callback
+     *   returning a Model class (`() => PivotModel`).
+     * - When a Model callback is provided:
+     *   - `leftForeignKey` autocompletes with the **through model**'s column
+     *     keys (the FK on the pivot table referencing the current model).
+     *   - `rightForeignKey` autocompletes with the **related model** `M`'s
+     *     column keys (the FK on the pivot table referencing the related model).
+     * - When a plain string is provided, both keys accept any string.
+     *
+     * Pass `{ nullable: false }` to type the relation as non-nullable.
+     *
+     * ```ts
+     * // Through model as callback — typed FK autocomplete
+     * rel.manyToMany(() => Tag, () => PostTag, {
+     *   leftForeignKey: "postId",  // autocompletes with PostTag keys
+     *   rightForeignKey: "tagId",  // autocompletes with Tag keys
+     * })
+     *
+     * // Through model as string — plain string FKs
+     * rel.manyToMany(() => Tag, "post_tags", {
+     *   leftForeignKey: "post_id",
+     *   rightForeignKey: "tag_id",
+     * })
+     * ```
+     *
+     * @param model            Callback returning the related model class.
+     * @param throughModel      Pivot model callback or table name string.
+     * @param throughModelKeys  Foreign key mapping on the pivot table.
+     * @param options          Constraint options and `{ nullable: false }`.
+     */
+    manyToMany<M extends AnyModelClass, T extends AnyModelConstructor = AnyModelConstructor, TM extends ThroughModel<T> = ThroughModel<T>>(model: RelModelCallback<M>, throughModel: TM, throughModelKeys: TM extends string ? ManyToManyStringOptions : {
+        leftForeignKey?: ModelKey<InferThroughModelInstance<TM>> | (string & {});
+        rightForeignKey?: ForeignKeyOf<M>;
+    }, options: RelationConstraintOptions & {
+        nullable: false;
+    }): RelationDef<InstanceType<M>[]>;
+    manyToMany<M extends AnyModelClass, T extends AnyModelConstructor = AnyModelConstructor, TM extends ThroughModel<T> = ThroughModel<T>>(model: RelModelCallback<M>, throughModel: TM, throughModelKeys?: TM extends string ? ManyToManyStringOptions : {
+        leftForeignKey?: ModelKey<InferThroughModelInstance<TM>> | (string & {});
+        rightForeignKey?: ForeignKeyOf<M>;
+    }, options?: RelationConstraintOptions & RelationNullableOption): RelationDef<InstanceType<M>[] | null | undefined>;
 }
-type IndexDefinition = string[] | {
-    columns: string[];
+type IndexDefinition<K extends string = string> = K[] | {
+    columns: K[];
     name?: string;
 };
-type UniqueDefinition = string[] | {
-    columns: string[];
+type UniqueDefinition<K extends string = string> = K[] | {
+    columns: K[];
     name?: string;
 };
 type CheckDefinition = string | {
     expression: string;
     name?: string;
 };
-type HooksDefinition = {
+type HooksDefinition<T = any> = {
     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;
+    afterFetch?: (data: T[]) => Promise<T[]> | T[];
+    beforeInsert?: (data: Partial<T>) => Promise<void> | void;
+    beforeInsertMany?: (data: Partial<T>[]) => Promise<void> | void;
     beforeUpdate?: (queryBuilder: ModelQueryBuilder<any>) => Promise<void> | void;
     beforeDelete?: (queryBuilder: ModelQueryBuilder<any>) => Promise<void> | void;
 };
-type DefineModelOptions = {
+type DefineModelOptions<K extends string = string> = {
     modelCaseConvention?: CaseConvention;
     databaseCaseConvention?: CaseConvention;
-    softDeleteColumn?: string;
+    softDeleteColumn?: K;
     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;
+/**
+ * Detects self-referencing relations (branded with `SelfModelInstance`) and
+ * replaces them with the actual column types of the defining model.
+ * Non-self relations pass through unchanged.
+ */
+type ResolveSelfRef<T, SelfType> = [T] extends [
+    SelfModelInstance[] | null | undefined
+] ? SelfType[] | Extract<T, null | undefined> : [T] extends [SelfModelInstance | null | undefined] ? SelfType | Extract<T, null | undefined> : T;
+type InferRelations<C extends Record<string, ColumnDef>, R extends Record<string, RelationDef>> = {
+    [K in keyof R]: R[K] extends RelationDef<infer T> ? ResolveSelfRef<T, InferColumns<C> & Model> : 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>;
+type InferModel<C extends Record<string, ColumnDef>, R extends Record<string, RelationDef>> = InferColumns<C> & InferRelations<C, R>;
+type ModelDefinition<C extends Record<string, ColumnDef> = Record<string, ColumnDef>, R extends Record<string, RelationDef> = Record<string, RelationDef>> = {
+    columns: C;
+    relations?: R;
+    indexes?: IndexDefinition<keyof C & string>[];
+    uniques?: UniqueDefinition<keyof C & string>[];
+    checks?: CheckDefinition[];
+    hooks?: HooksDefinition<InferColumns<C>>;
+    options?: DefineModelOptions<keyof C & string>;
+};
 /**
  * Public statics of `typeof Model` without the abstract constructor flag.
  */
@@ -8171,4 +8498,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 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 };
+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 NullableColumn, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, type RawQueryOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelModelCallback, type RelatedInstance, type RelationDef, type RelationNullableOption, 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 TypedPrepare, type TypedPropertyDecorator, type TypedSerialize, 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 };