hysteria-orm 10.1.9 → 10.2.0

package/lib/index.d.cts

@@ -1237,11 +1237,11 @@ declare class AlterTableBuilder extends BaseBuilder {
      */
     dropDefault(columnName: string): void;
     /**
-     * @description Adds a primary key to a column
+     * @description Adds a primary key constraint to a column
+     * @param columnName is the column name to add the primary key to
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private addPrimaryKey;
+    addPrimaryKey(columnName: string): void;
     /**
      * @description Raw non type safe way builder to add a constraint
      * @sqlite not supported and will throw error
@@ -1249,23 +1249,21 @@ declare class AlterTableBuilder extends BaseBuilder {
     addConstraint(...options: ConstructorParameters<typeof ConstraintNode>): void;
     /**
      * @description Adds a foreign key constraint to a column
+     * @param columnName is the column name in the current table
+     * @param foreignTable is the referenced table name
+     * @param foreignColumn is the referenced column name
+     * @param options optional foreign key options (constraintName, onDelete, onUpdate)
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private addForeignKey;
+    foreignKey(columnName: string, foreignTable: string, foreignColumn: string, options?: ForeignKeyOptions): void;
     /**
      * @description Adds a unique constraint to a column
      * @description By default generates a constraint name using standard pattern: uq_${table}_${column}
+     * @param columnName is the column name in the current table
+     * @param options optional constraint options (constraintName)
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private unique;
-    /**
-     * @description Sets a default value for a column
-     * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
-     */
-    private setDefault;
+    unique(columnName: string, options?: CommonConstraintOptions): void;
     /**
      * @description Drops a foreign key by column name and referenced column, generates constraint name using standard pattern: fk_${table}_${leftColumn}_${rightColumn}
      * @description If a custom constraint name was used to generate the foreign key, use `dropConstraint` instead
@@ -1818,6 +1816,10 @@ type ManyToManyOptions<T extends typeof Model, TM extends ThroughModel<T>> = {
      */
     rightForeignKey?: TM extends ThroughModelString ? string : ModelKey<InstanceType<ExtractModelFromTM<TM>>>;
 };
+type ManyToManyStringOptions = {
+    leftForeignKey?: string;
+    rightForeignKey?: string;
+};
 type IndexType = {
     columns: string[];
     name: string;
@@ -3944,7 +3946,7 @@ type AnnotatedModel<T extends Model, A extends object = {}, R extends object = {
     $annotations: A;
 } & R;
 type CommonSqlMethodReturnType<T extends SqlMethod> = T extends "count" | "sum" | "avg" | "min" | "max" ? number : T extends "upper" | "lower" | "trim" ? string : T extends "length" ? number : T extends "cast" | "convert" ? any : T extends "abs" | "round" | "floor" | "ceil" ? number : any;
-type RelatedInstance<M extends Model, K extends ModelRelation<M>> = M[K] extends (infer R)[] ? R extends Model ? R : never : M[K] extends Model ? M[K] : never;
+type RelatedInstance<M extends Model, K extends ModelRelation<M>> = NonNullable<M[K]> extends (infer R)[] ? R extends Model ? R : never : NonNullable<M[K]> extends Model ? NonNullable<M[K]> : never;
 
 type NullableAndUndefinable<T> = T | (T | null) | (T | undefined) | (T | null | undefined);
 type UpsertOptions<T extends Model> = {
@@ -4280,6 +4282,10 @@ declare abstract class Model extends Entity {
      * @description Gives the correct model manager with the correct connection based on the options provided
      */
     private static dispatchModelManager;
+    /**
+     * @description Merges the provided data with the model instance
+     */
+    mergeProps<T extends Model = this>(this: T, data: Partial<ModelWithoutRelations<T>>): void;
     /**
      * @description inserts or updates the model to the database, must have a primary key in order to work
      * @throws {HysteriaError} If the model has no primary key
@@ -4441,18 +4447,21 @@ declare function getModelColumns(target: typeof Model): ColumnType[];
  * ```
  */
 declare function belongsTo<M extends typeof Model = any, R extends typeof Model = any>(model: () => R, foreignKey?: ModelKey<InstanceType<M>>, options?: BaseModelRelationType): PropertyDecorator;
+declare function belongsTo<R extends typeof Model = any>(model: () => R, foreignKey?: string, options?: BaseModelRelationType): PropertyDecorator;
 /**
  * @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>>): PropertyDecorator;
+declare function hasOne<T extends typeof Model>(model: () => T, foreignKey?: string): PropertyDecorator;
 /**
  * @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>>): PropertyDecorator;
+declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: string): PropertyDecorator;
 /**
  * @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"
@@ -4464,6 +4473,7 @@ declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: Mo
  * @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): PropertyDecorator;
+declare function manyToMany<R extends typeof Model>(model: () => R, throughModel: string | (() => typeof Model), throughModelKeys?: ManyToManyStringOptions, options?: BaseModelRelationType): PropertyDecorator;
 declare function getRelationsMetadata(target: typeof Model): LazyRelationType[];
 /**
  * @description Returns the relations of the model
@@ -5378,4 +5388,4 @@ declare const generateOpenApiModelWithMetadata: <T extends new () => Model>(mode
     $id?: string;
 }>;
 
-export { type AnnotatedModel, type AsymmetricEncryptionOptions, type AugmentedSqlDataSource, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, 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 CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDataSourceWithoutTransaction, type SqlDriverSpecificOptions, type SqlPoolType, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, MongoDataSource as mongo, property, RedisDataSource as redis, SqlDataSource as sql, unique, view, withPerformance };
+export { type AnnotatedModel, type AsymmetricEncryptionOptions, type AugmentedSqlDataSource, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, 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 CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDataSourceWithoutTransaction, type SqlDriverSpecificOptions, type SqlPoolType, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, MongoDataSource as mongo, property, RedisDataSource as redis, SqlDataSource as sql, unique, view, withPerformance };

package/lib/index.d.ts

@@ -1237,11 +1237,11 @@ declare class AlterTableBuilder extends BaseBuilder {
      */
     dropDefault(columnName: string): void;
     /**
-     * @description Adds a primary key to a column
+     * @description Adds a primary key constraint to a column
+     * @param columnName is the column name to add the primary key to
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private addPrimaryKey;
+    addPrimaryKey(columnName: string): void;
     /**
      * @description Raw non type safe way builder to add a constraint
      * @sqlite not supported and will throw error
@@ -1249,23 +1249,21 @@ declare class AlterTableBuilder extends BaseBuilder {
     addConstraint(...options: ConstructorParameters<typeof ConstraintNode>): void;
     /**
      * @description Adds a foreign key constraint to a column
+     * @param columnName is the column name in the current table
+     * @param foreignTable is the referenced table name
+     * @param foreignColumn is the referenced column name
+     * @param options optional foreign key options (constraintName, onDelete, onUpdate)
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private addForeignKey;
+    foreignKey(columnName: string, foreignTable: string, foreignColumn: string, options?: ForeignKeyOptions): void;
     /**
      * @description Adds a unique constraint to a column
      * @description By default generates a constraint name using standard pattern: uq_${table}_${column}
+     * @param columnName is the column name in the current table
+     * @param options optional constraint options (constraintName)
      * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
      */
-    private unique;
-    /**
-     * @description Sets a default value for a column
-     * @sqlite not supported and will throw error
-     * @private Used internally by alterColumn
-     */
-    private setDefault;
+    unique(columnName: string, options?: CommonConstraintOptions): void;
     /**
      * @description Drops a foreign key by column name and referenced column, generates constraint name using standard pattern: fk_${table}_${leftColumn}_${rightColumn}
      * @description If a custom constraint name was used to generate the foreign key, use `dropConstraint` instead
@@ -1818,6 +1816,10 @@ type ManyToManyOptions<T extends typeof Model, TM extends ThroughModel<T>> = {
      */
     rightForeignKey?: TM extends ThroughModelString ? string : ModelKey<InstanceType<ExtractModelFromTM<TM>>>;
 };
+type ManyToManyStringOptions = {
+    leftForeignKey?: string;
+    rightForeignKey?: string;
+};
 type IndexType = {
     columns: string[];
     name: string;
@@ -3944,7 +3946,7 @@ type AnnotatedModel<T extends Model, A extends object = {}, R extends object = {
     $annotations: A;
 } & R;
 type CommonSqlMethodReturnType<T extends SqlMethod> = T extends "count" | "sum" | "avg" | "min" | "max" ? number : T extends "upper" | "lower" | "trim" ? string : T extends "length" ? number : T extends "cast" | "convert" ? any : T extends "abs" | "round" | "floor" | "ceil" ? number : any;
-type RelatedInstance<M extends Model, K extends ModelRelation<M>> = M[K] extends (infer R)[] ? R extends Model ? R : never : M[K] extends Model ? M[K] : never;
+type RelatedInstance<M extends Model, K extends ModelRelation<M>> = NonNullable<M[K]> extends (infer R)[] ? R extends Model ? R : never : NonNullable<M[K]> extends Model ? NonNullable<M[K]> : never;
 
 type NullableAndUndefinable<T> = T | (T | null) | (T | undefined) | (T | null | undefined);
 type UpsertOptions<T extends Model> = {
@@ -4280,6 +4282,10 @@ declare abstract class Model extends Entity {
      * @description Gives the correct model manager with the correct connection based on the options provided
      */
     private static dispatchModelManager;
+    /**
+     * @description Merges the provided data with the model instance
+     */
+    mergeProps<T extends Model = this>(this: T, data: Partial<ModelWithoutRelations<T>>): void;
     /**
      * @description inserts or updates the model to the database, must have a primary key in order to work
      * @throws {HysteriaError} If the model has no primary key
@@ -4441,18 +4447,21 @@ declare function getModelColumns(target: typeof Model): ColumnType[];
  * ```
  */
 declare function belongsTo<M extends typeof Model = any, R extends typeof Model = any>(model: () => R, foreignKey?: ModelKey<InstanceType<M>>, options?: BaseModelRelationType): PropertyDecorator;
+declare function belongsTo<R extends typeof Model = any>(model: () => R, foreignKey?: string, options?: BaseModelRelationType): PropertyDecorator;
 /**
  * @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>>): PropertyDecorator;
+declare function hasOne<T extends typeof Model>(model: () => T, foreignKey?: string): PropertyDecorator;
 /**
  * @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>>): PropertyDecorator;
+declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: string): PropertyDecorator;
 /**
  * @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"
@@ -4464,6 +4473,7 @@ declare function hasMany<T extends typeof Model>(model: () => T, foreignKey?: Mo
  * @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): PropertyDecorator;
+declare function manyToMany<R extends typeof Model>(model: () => R, throughModel: string | (() => typeof Model), throughModelKeys?: ManyToManyStringOptions, options?: BaseModelRelationType): PropertyDecorator;
 declare function getRelationsMetadata(target: typeof Model): LazyRelationType[];
 /**
  * @description Returns the relations of the model
@@ -5378,4 +5388,4 @@ declare const generateOpenApiModelWithMetadata: <T extends new () => Model>(mode
     $id?: string;
 }>;
 
-export { type AnnotatedModel, type AsymmetricEncryptionOptions, type AugmentedSqlDataSource, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, 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 CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDataSourceWithoutTransaction, type SqlDriverSpecificOptions, type SqlPoolType, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, MongoDataSource as mongo, property, RedisDataSource as redis, SqlDataSource as sql, unique, view, withPerformance };
+export { type AnnotatedModel, type AsymmetricEncryptionOptions, type AugmentedSqlDataSource, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, 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 CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDataSourceWithoutTransaction, type SqlDriverSpecificOptions, type SqlPoolType, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, MongoDataSource as mongo, property, RedisDataSource as redis, SqlDataSource as sql, unique, view, withPerformance };