hysteria-orm 10.5.2 → 10.5.4

package/lib/index.d.cts

@@ -5491,7 +5491,7 @@ type ModelInstanceMethods<T extends Model> = {
      * Refreshes the model from the database, updating all properties with current values.
      * @throws {HysteriaError} If the model has no primary key or primary key value
      */
-    refresh: (options?: Omit<BaseModelMethodOptions, "ignoreHooks">) => Promise<any>;
+    refresh: (options?: Omit<BaseModelMethodOptions, "ignoreHooks">) => Promise<void>;
 };
 /**
  * Model data without relation properties.
@@ -5946,7 +5946,7 @@ type FindReturnType<T extends Model, S extends ModelKey<T>[] = any[], R extends
 /**
  * @description Represents a Table in the Database
  */
-declare abstract class Model extends Entity {
+declare abstract class Model<T extends Model<T> = any> extends Entity {
     private "*";
     /**
      * @description The column used to soft delete a record, default is deletedAt
@@ -5973,7 +5973,26 @@ declare abstract class Model extends Entity {
      * @description Getter for the primary key of the model
      */
     static get primaryKey(): string | undefined;
-    constructor();
+    /**
+     * @description Creates a new instance of the model
+     * @description Use `${Model.from(...)}` to pass initial data to the model or pass initial data to the constructor
+     * @warning For typescript limitations, in order to pass initial data to the constructor directly, you must use generic type inference to pass the model type
+     * @example
+     * ```typescript
+     * class User extends Model<User> {
+     *   @column.string()
+     *   declare name: string;
+     * }
+     *
+     * const user = new User({ name: "John Doe" }); // now the constructor is typed as User
+     * ```
+     */
+    constructor(initialData?: Partial<ModelWithoutRelations<T>>);
+    /**
+     * @description Returns a model query result from the given initial data
+     * @warning This method does not persist the data to the database, it only creates a new instance of the model with the given data
+     */
+    static from<T extends Model>(this: new () => T | typeof Model, data: Partial<ModelWithoutRelations<T>>): ModelQueryResult<T>;
     /**
      * @description Returns all the records for the given model
      */
@@ -6021,7 +6040,7 @@ declare abstract class Model extends Entity {
     /**
      * @description Refreshes a model from the database, the model must have a primary key defined
      */
-    static refresh<T extends Model>(this: new () => T | typeof Model, model: T, options?: Omit<BaseModelMethodOptions, "ignoreHooks">): Promise<ModelQueryResult<T> | null>;
+    static refresh<T extends Model>(this: new () => T | typeof Model, model: T, options?: Omit<BaseModelMethodOptions, "ignoreHooks">): Promise<void>;
     /**
      * @description Saves a new record to the database
      * @warning If not using postgres and the model has no primary key, the model will be saved, but it won't be possible to retrieve it so at that point it will be returned as null, this is not typed as Model | null for type safety reasons
@@ -6361,23 +6380,30 @@ declare function view(statement: (query: ModelQueryBuilder<any>) => void): Class
  */
 declare function column(options?: ColumnOptions): PropertyDecorator;
 declare namespace column {
-    var primary: typeof primaryKeyColumn;
-    var date: typeof dateOnlyColumn;
-    var datetime: typeof datetimeColumn;
-    var timestamp: typeof timestampColumn;
-    var time: typeof timeOnlyColumn;
-    var boolean: typeof booleanColumn;
-    var json: typeof jsonColumn;
-    var uuid: typeof uuidColumn;
-    var ulid: typeof ulidColumn;
-    var integer: typeof integerColumn;
-    var float: typeof floatColumn;
-    var increment: typeof incrementColumn;
-    var bigIncrement: typeof bigIncrementColumn;
-    var encryption: {
+    export var primary: typeof primaryKeyColumn;
+    export var date: typeof dateOnlyColumn;
+    export var datetime: typeof datetimeColumn;
+    export var timestamp: typeof timestampColumn;
+    export var time: typeof timeOnlyColumn;
+    export var boolean: typeof booleanColumn;
+    export var json: typeof jsonColumn;
+    export var uuid: typeof uuidColumn;
+    export var ulid: typeof ulidColumn;
+    export var integer: typeof integerColumn;
+    export var bigint: typeof bigintColumn;
+    export var float: typeof floatColumn;
+    export var decimal: typeof decimalColumn;
+    export var increment: typeof incrementColumn;
+    export var bigIncrement: typeof bigIncrementColumn;
+    export var string: typeof stringColumn;
+    export var text: typeof textColumn;
+    export var binary: typeof binaryColumn;
+    var _a: typeof enumColumn;
+    export var encryption: {
         symmetric: typeof symmetric;
         asymmetric: typeof asymmetric;
     };
+    export { _a as enum };
 }
 declare function primaryKeyColumn(options?: Omit<ColumnOptions, "primaryKey">): PropertyDecorator;
 declare function floatColumn(options?: Omit<ColumnOptions, "serialize">): PropertyDecorator;
@@ -6415,6 +6441,47 @@ declare function uuidColumn(options?: Omit<ColumnOptions, "prepare">): PropertyD
  * @description Defaults type to ulid for migration generation
  */
 declare function ulidColumn(options?: Omit<ColumnOptions, "prepare">): PropertyDecorator;
+/**
+ * @description Decorator to define a string (varchar) column in the model
+ * @description Defaults type to string for migration generation
+ */
+declare function stringColumn(options?: Omit<ColumnOptions, "type"> & {
+    length?: number;
+}): PropertyDecorator;
+/**
+ * @description Decorator to define a text column in the model for longer text content
+ * @description Defaults type to longtext for migration generation
+ */
+declare function textColumn(options?: Omit<ColumnOptions, "type">): PropertyDecorator;
+/**
+ * @description Decorator to define a bigint column in the model
+ * @description Useful in databases like postgres where the bigint is returned as a string by the driver
+ * @description Defaults type to bigint for migration generation
+ */
+declare function bigintColumn(options?: Omit<ColumnOptions, "serialize">): PropertyDecorator;
+/**
+ * @description Decorator to define a decimal column in the model for precise numeric values
+ * @description Useful for financial data and other precise calculations
+ * @description Defaults type to decimal for migration generation
+ * @param options.precision The total number of digits (default: 10)
+ * @param options.scale The number of digits after the decimal point (default: 2)
+ */
+declare function decimalColumn(options?: Omit<ColumnOptions, "serialize"> & {
+    precision?: number;
+    scale?: number;
+}): PropertyDecorator;
+/**
+ * @description Decorator to define a binary/blob column in the model
+ * @description Defaults type to binary for migration generation
+ */
+declare function binaryColumn(options?: Omit<ColumnOptions, "type">): PropertyDecorator;
+/**
+ * @description Decorator to define an enum column in the model
+ * @description Defaults type to enum for migration generation
+ * @param values The allowed enum values
+ * @param options Additional column options
+ */
+declare function enumColumn(values: readonly string[], options?: Omit<ColumnOptions, "type">): PropertyDecorator;
 /**
  * @description Decorator to define a symmetric encrypted column in the model with a key
  * @description This will automatically encrypt the value before it is inserted or updated in the database and decrypt it when it is retrieved from the database

package/lib/index.d.ts

@@ -5491,7 +5491,7 @@ type ModelInstanceMethods<T extends Model> = {
      * Refreshes the model from the database, updating all properties with current values.
      * @throws {HysteriaError} If the model has no primary key or primary key value
      */
-    refresh: (options?: Omit<BaseModelMethodOptions, "ignoreHooks">) => Promise<any>;
+    refresh: (options?: Omit<BaseModelMethodOptions, "ignoreHooks">) => Promise<void>;
 };
 /**
  * Model data without relation properties.
@@ -5946,7 +5946,7 @@ type FindReturnType<T extends Model, S extends ModelKey<T>[] = any[], R extends
 /**
  * @description Represents a Table in the Database
  */
-declare abstract class Model extends Entity {
+declare abstract class Model<T extends Model<T> = any> extends Entity {
     private "*";
     /**
      * @description The column used to soft delete a record, default is deletedAt
@@ -5973,7 +5973,26 @@ declare abstract class Model extends Entity {
      * @description Getter for the primary key of the model
      */
     static get primaryKey(): string | undefined;
-    constructor();
+    /**
+     * @description Creates a new instance of the model
+     * @description Use `${Model.from(...)}` to pass initial data to the model or pass initial data to the constructor
+     * @warning For typescript limitations, in order to pass initial data to the constructor directly, you must use generic type inference to pass the model type
+     * @example
+     * ```typescript
+     * class User extends Model<User> {
+     *   @column.string()
+     *   declare name: string;
+     * }
+     *
+     * const user = new User({ name: "John Doe" }); // now the constructor is typed as User
+     * ```
+     */
+    constructor(initialData?: Partial<ModelWithoutRelations<T>>);
+    /**
+     * @description Returns a model query result from the given initial data
+     * @warning This method does not persist the data to the database, it only creates a new instance of the model with the given data
+     */
+    static from<T extends Model>(this: new () => T | typeof Model, data: Partial<ModelWithoutRelations<T>>): ModelQueryResult<T>;
     /**
      * @description Returns all the records for the given model
      */
@@ -6021,7 +6040,7 @@ declare abstract class Model extends Entity {
     /**
      * @description Refreshes a model from the database, the model must have a primary key defined
      */
-    static refresh<T extends Model>(this: new () => T | typeof Model, model: T, options?: Omit<BaseModelMethodOptions, "ignoreHooks">): Promise<ModelQueryResult<T> | null>;
+    static refresh<T extends Model>(this: new () => T | typeof Model, model: T, options?: Omit<BaseModelMethodOptions, "ignoreHooks">): Promise<void>;
     /**
      * @description Saves a new record to the database
      * @warning If not using postgres and the model has no primary key, the model will be saved, but it won't be possible to retrieve it so at that point it will be returned as null, this is not typed as Model | null for type safety reasons
@@ -6361,23 +6380,30 @@ declare function view(statement: (query: ModelQueryBuilder<any>) => void): Class
  */
 declare function column(options?: ColumnOptions): PropertyDecorator;
 declare namespace column {
-    var primary: typeof primaryKeyColumn;
-    var date: typeof dateOnlyColumn;
-    var datetime: typeof datetimeColumn;
-    var timestamp: typeof timestampColumn;
-    var time: typeof timeOnlyColumn;
-    var boolean: typeof booleanColumn;
-    var json: typeof jsonColumn;
-    var uuid: typeof uuidColumn;
-    var ulid: typeof ulidColumn;
-    var integer: typeof integerColumn;
-    var float: typeof floatColumn;
-    var increment: typeof incrementColumn;
-    var bigIncrement: typeof bigIncrementColumn;
-    var encryption: {
+    export var primary: typeof primaryKeyColumn;
+    export var date: typeof dateOnlyColumn;
+    export var datetime: typeof datetimeColumn;
+    export var timestamp: typeof timestampColumn;
+    export var time: typeof timeOnlyColumn;
+    export var boolean: typeof booleanColumn;
+    export var json: typeof jsonColumn;
+    export var uuid: typeof uuidColumn;
+    export var ulid: typeof ulidColumn;
+    export var integer: typeof integerColumn;
+    export var bigint: typeof bigintColumn;
+    export var float: typeof floatColumn;
+    export var decimal: typeof decimalColumn;
+    export var increment: typeof incrementColumn;
+    export var bigIncrement: typeof bigIncrementColumn;
+    export var string: typeof stringColumn;
+    export var text: typeof textColumn;
+    export var binary: typeof binaryColumn;
+    var _a: typeof enumColumn;
+    export var encryption: {
         symmetric: typeof symmetric;
         asymmetric: typeof asymmetric;
     };
+    export { _a as enum };
 }
 declare function primaryKeyColumn(options?: Omit<ColumnOptions, "primaryKey">): PropertyDecorator;
 declare function floatColumn(options?: Omit<ColumnOptions, "serialize">): PropertyDecorator;
@@ -6415,6 +6441,47 @@ declare function uuidColumn(options?: Omit<ColumnOptions, "prepare">): PropertyD
  * @description Defaults type to ulid for migration generation
  */
 declare function ulidColumn(options?: Omit<ColumnOptions, "prepare">): PropertyDecorator;
+/**
+ * @description Decorator to define a string (varchar) column in the model
+ * @description Defaults type to string for migration generation
+ */
+declare function stringColumn(options?: Omit<ColumnOptions, "type"> & {
+    length?: number;
+}): PropertyDecorator;
+/**
+ * @description Decorator to define a text column in the model for longer text content
+ * @description Defaults type to longtext for migration generation
+ */
+declare function textColumn(options?: Omit<ColumnOptions, "type">): PropertyDecorator;
+/**
+ * @description Decorator to define a bigint column in the model
+ * @description Useful in databases like postgres where the bigint is returned as a string by the driver
+ * @description Defaults type to bigint for migration generation
+ */
+declare function bigintColumn(options?: Omit<ColumnOptions, "serialize">): PropertyDecorator;
+/**
+ * @description Decorator to define a decimal column in the model for precise numeric values
+ * @description Useful for financial data and other precise calculations
+ * @description Defaults type to decimal for migration generation
+ * @param options.precision The total number of digits (default: 10)
+ * @param options.scale The number of digits after the decimal point (default: 2)
+ */
+declare function decimalColumn(options?: Omit<ColumnOptions, "serialize"> & {
+    precision?: number;
+    scale?: number;
+}): PropertyDecorator;
+/**
+ * @description Decorator to define a binary/blob column in the model
+ * @description Defaults type to binary for migration generation
+ */
+declare function binaryColumn(options?: Omit<ColumnOptions, "type">): PropertyDecorator;
+/**
+ * @description Decorator to define an enum column in the model
+ * @description Defaults type to enum for migration generation
+ * @param values The allowed enum values
+ * @param options Additional column options
+ */
+declare function enumColumn(values: readonly string[], options?: Omit<ColumnOptions, "type">): PropertyDecorator;
 /**
  * @description Decorator to define a symmetric encrypted column in the model with a key
  * @description This will automatically encrypt the value before it is inserted or updated in the database and decrypt it when it is retrieved from the database