hysteria-orm 10.5.3 → 10.5.4

package/lib/index.d.cts

@@ -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
      */

package/lib/index.d.ts

@@ -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
      */