@buenojs/bueno 0.8.10 → 0.8.11

package/dist/database/orm/model.d.ts

@@ -0,0 +1,245 @@
+import { OrmQueryBuilder } from "./builder";
+import { type CastDefinition } from "./casts";
+import { type ModelHookCallback, type ModelHookName } from "./hooks";
+import { BelongsTo, BelongsToMany, HasMany, HasOne } from "./relationships";
+export declare class ModelNotFoundError extends Error {
+    constructor(message: string);
+}
+export declare class ModelOperationAbortedError extends Error {
+    constructor(message: string);
+}
+/**
+ * Base Model class
+ *
+ * Generic over TAttributes (the shape of model attributes)
+ */
+export declare abstract class Model<TAttributes extends Record<string, unknown> = Record<string, unknown>> {
+    static readonly table: string;
+    static readonly primaryKey: string;
+    static readonly timestamps: boolean;
+    static readonly createdAtColumn: string;
+    static readonly updatedAtColumn: string;
+    static readonly softDeletes: boolean;
+    static readonly deletedAtColumn: string;
+    static readonly fillable: string[];
+    static readonly guarded: string[];
+    static readonly casts: Record<string, CastDefinition>;
+    private static scopeRegistry;
+    private static hookRegistry;
+    protected _attributes: TAttributes;
+    protected _original: TAttributes;
+    protected _relations: Map<string, unknown>;
+    protected _exists: boolean;
+    protected _isDirty: boolean;
+    constructor(attributes?: Partial<TAttributes>);
+    /**
+     * Create a query builder for this model
+     */
+    static query<M extends Model>(this: {
+        new (): M;
+    } & typeof Model): ModelQueryBuilder<M>;
+    /**
+     * Find a model by ID
+     */
+    static find<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, id: unknown): Promise<M | null>;
+    /**
+     * Find a model by ID or throw
+     */
+    static findOrFail<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, id: unknown): Promise<M>;
+    /**
+     * Create a where clause
+     */
+    static where<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, column: string, operator: unknown, value?: unknown): ModelQueryBuilder<M>;
+    /**
+     * Get all records
+     */
+    static all<M extends Model>(this: {
+        new (): M;
+    } & typeof Model): Promise<M[]>;
+    /**
+     * Create and persist a new model
+     */
+    static create<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, data: Record<string, unknown>): Promise<M>;
+    /**
+     * First or create — get or create based on conditions
+     */
+    static firstOrCreate<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, conditions: Partial<TAttributes>, values?: Partial<TAttributes>): Promise<M>;
+    /**
+     * Update or create — update or create based on conditions
+     */
+    static updateOrCreate<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, conditions: Partial<TAttributes>, values: Partial<TAttributes>): Promise<M>;
+    /**
+     * Get an attribute value
+     */
+    getAttribute<K extends keyof TAttributes>(key: K): TAttributes[K];
+    /**
+     * Set an attribute value
+     */
+    setAttribute<K extends keyof TAttributes>(key: K, value: TAttributes[K]): void;
+    /**
+     * Fill attributes from data (respects fillable/guarded)
+     */
+    fill(data: Partial<TAttributes>): this;
+    /**
+     * Force fill (bypass fillable/guarded)
+     */
+    forceFill(data: Partial<TAttributes>): this;
+    /**
+     * Convert to JSON
+     */
+    toJSON(): TAttributes;
+    /**
+     * Convert to plain object
+     */
+    toObject(): TAttributes;
+    /**
+     * Check if model or specific attribute is dirty
+     */
+    isDirty(key?: string): boolean;
+    /**
+     * Check if model or specific attribute is clean
+     */
+    isClean(key?: string): boolean;
+    /**
+     * Get dirty attributes
+     */
+    getDirty(): Partial<TAttributes>;
+    /**
+     * Get original attribute values
+     */
+    getOriginal<K extends keyof TAttributes>(key?: K): TAttributes[K] | Partial<TAttributes>;
+    /**
+     * Save the model (create or update)
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the model (soft or hard)
+     */
+    delete(): Promise<void>;
+    /**
+     * Restore a soft-deleted model
+     */
+    restore(): Promise<void>;
+    /**
+     * Refresh the model from the database
+     */
+    refresh(): Promise<void>;
+    /**
+     * Get a fresh instance of this model
+     */
+    fresh(): Promise<this>;
+    /**
+     * Define a one-to-one relationship
+     */
+    hasOne<TRelated extends Model>(relatedClass: {
+        new (): TRelated;
+    } & typeof Model, foreignKey: string, localKey?: string): HasOne<TRelated>;
+    /**
+     * Define a one-to-many relationship
+     */
+    hasMany<TRelated extends Model>(relatedClass: {
+        new (): TRelated;
+    } & typeof Model, foreignKey: string, localKey?: string): HasMany<TRelated>;
+    /**
+     * Define the inverse of a one-to-one or one-to-many relationship
+     */
+    belongsTo<TRelated extends Model>(relatedClass: {
+        new (): TRelated;
+    } & typeof Model, foreignKey: string, ownerKey?: string): BelongsTo<TRelated>;
+    /**
+     * Define a many-to-many relationship
+     */
+    belongsToMany<TRelated extends Model>(relatedClass: {
+        new (): TRelated;
+    } & typeof Model, pivotTable: string, foreignPivotKey: string, relatedPivotKey: string, parentKey?: string, relatedKey?: string): BelongsToMany<TRelated>;
+    /**
+     * Create model instances from database rows
+     */
+    static hydrate<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, rows: Record<string, unknown>[]): M[];
+    /**
+     * Register a hook callback
+     */
+    static on<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, hookName: ModelHookName, callback: ModelHookCallback<M>): void;
+    /**
+     * Get all callbacks for a hook
+     */
+    static getHookCallbacks<M extends Model>(this: {
+        new (): M;
+    } & typeof Model, hookName: ModelHookName): ModelHookCallback<M>[];
+    /**
+     * Called when model class is first used (for static initialization)
+     */
+    static booting(): void;
+}
+/**
+ * ModelQueryBuilder — extended OrmQueryBuilder with Model-specific features
+ */
+export declare class ModelQueryBuilder<M extends Model> extends OrmQueryBuilder<any> {
+    private modelClass;
+    private eagerLoads;
+    constructor(modelClass: {
+        new (): M;
+    } & typeof Model);
+    /**
+     * Eager load a relationship
+     */
+    with(relation: string, callback?: (q: OrmQueryBuilder<any>) => void): this;
+    /**
+     * Override get() to hydrate Model instances
+     */
+    get(): Promise<M[]>;
+    /**
+     * Override first() to hydrate Model instance
+     * Note: We must fetch raw data directly to avoid double-hydration
+     * (since get() is overridden to already hydrate)
+     */
+    first(): Promise<M | null>;
+    /**
+     * Override paginate() to return hydrated Model instances
+     * Note: super.paginate() calls get() which already hydrates,
+     * so we just need to return the result as-is
+     */
+    paginate(page: number, limit: number): Promise<{
+        data: any[];
+        total: number;
+        page: number;
+        limit: number;
+        totalPages: number;
+    }>;
+    /**
+     * Find first or create — find by conditions or create with values
+     */
+    firstOrCreate(conditions: Record<string, unknown>, values?: Record<string, unknown>): Promise<M>;
+    /**
+     * Update or create — update if exists or create if not
+     */
+    updateOrCreate(conditions: Record<string, unknown>, values: Record<string, unknown>): Promise<M>;
+    /**
+     * Load eager relationships
+     * Supports nested dot-notation like "posts.comments"
+     */
+    private loadRelation;
+    /**
+     * Support local scopes via Proxy
+     */
+    static createScoped<M extends Model>(modelClass: {
+        new (): M;
+    } & typeof Model): ModelQueryBuilder<M>;
+}
+//# sourceMappingURL=model.d.ts.map

package/dist/database/orm/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../src/database/orm/model.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,KAAK,cAAc,EAAgB,MAAM,SAAS,CAAC;AAC5D,OAAO,EAEN,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAG5E,qBAAa,kBAAmB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI3B;AAED,qBAAa,0BAA2B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAI3B;AAED;;;;GAIG;AACH,8BAAsB,KAAK,CAC1B,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIrE,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAC9B,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAQ;IAC1C,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAQ;IAC3C,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAgB;IACvD,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAgB;IACvD,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAS;IAC7C,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAgB;IACvD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAM;IACxC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAM;IACvC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAM;IAE3D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAyC;IACrE,OAAO,CAAC,MAAM,CAAC,YAAY,CAGvB;IAIJ,SAAS,CAAC,WAAW,EAAE,WAAW,CAAqB;IACvD,SAAS,CAAC,SAAS,EAAE,WAAW,CAAqB;IACrD,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAa;IACvD,SAAS,CAAC,OAAO,UAAS;IAC1B,SAAS,CAAC,QAAQ,UAAS;gBAIf,UAAU,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAoD7C;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,EAC3B,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,GAChC,iBAAiB,CAAC,CAAC,CAAC;IAIvB;;OAEG;WACU,IAAI,CAAC,CAAC,SAAS,KAAK,EAChC,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,EAAE,EAAE,OAAO,GACT,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAIpB;;OAEG;WACU,UAAU,CAAC,CAAC,SAAS,KAAK,EACtC,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,EAAE,EAAE,OAAO,GACT,OAAO,CAAC,CAAC,CAAC;IAQb;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,EAC3B,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,EACjB,KAAK,CAAC,EAAE,OAAO,GACb,iBAAiB,CAAC,CAAC,CAAC;IAIvB;;OAEG;WACU,GAAG,CAAC,CAAC,SAAS,KAAK,EAC/B,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,GAChC,OAAO,CAAC,CAAC,EAAE,CAAC;IAIf;;OAEG;WACU,MAAM,CAAC,CAAC,SAAS,KAAK,EAClC,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,OAAO,CAAC,CAAC,CAAC;IAQb;;OAEG;WACU,aAAa,CAAC,CAAC,SAAS,KAAK,EACzC,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,EAChC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAC3B,OAAO,CAAC,CAAC,CAAC;IAYb;;OAEG;WACU,cAAc,CAAC,CAAC,SAAS,KAAK,EAC1C,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,EAChC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,GAC1B,OAAO,CAAC,CAAC,CAAC;IAiBb;;OAEG;IACH,YAAY,CAAC,CAAC,SAAS,MAAM,WAAW,EAAE,GAAG,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAIjE;;OAEG;IACH,YAAY,CAAC,CAAC,SAAS,MAAM,WAAW,EACvC,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GACnB,IAAI;IAKP;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI;IAkBtC;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI;IAU3C;;OAEG;IACH,MAAM,IAAI,WAAW;IAIrB;;OAEG;IACH,QAAQ,IAAI,WAAW;IAMvB;;OAEG;IACH,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO;IAU9B;;OAEG;IACH,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO;IAI9B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAWhC;;OAEG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,WAAW,EACtC,GAAG,CAAC,EAAE,CAAC,GACL,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;IASxC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD3B;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB7B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAa9B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAW9B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ5B;;OAEG;IACH,MAAM,CAAC,QAAQ,SAAS,KAAK,EAC5B,YAAY,EAAE;QAAE,QAAQ,QAAQ,CAAA;KAAE,GAAG,OAAO,KAAK,EACjD,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GACf,MAAM,CAAC,QAAQ,CAAC;IAInB;;OAEG;IACH,OAAO,CAAC,QAAQ,SAAS,KAAK,EAC7B,YAAY,EAAE;QAAE,QAAQ,QAAQ,CAAA;KAAE,GAAG,OAAO,KAAK,EACjD,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,QAAQ,CAAC;IAIpB;;OAEG;IACH,SAAS,CAAC,QAAQ,SAAS,KAAK,EAC/B,YAAY,EAAE;QAAE,QAAQ,QAAQ,CAAA;KAAE,GAAG,OAAO,KAAK,EACjD,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GACf,SAAS,CAAC,QAAQ,CAAC;IAStB;;OAEG;IACH,aAAa,CAAC,QAAQ,SAAS,KAAK,EACnC,YAAY,EAAE;QAAE,QAAQ,QAAQ,CAAA;KAAE,GAAG,OAAO,KAAK,EACjD,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,MAAM,EACvB,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,GACjB,aAAa,CAAC,QAAQ,CAAC;IAc1B;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,EAC7B,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAC7B,CAAC,EAAE;IAoBN;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,KAAK,EACxB,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,QAAQ,EAAE,aAAa,EACvB,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,IAAI;IAWP;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,CAAC,SAAS,KAAK,EACtC,IAAI,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,EAClC,QAAQ,EAAE,aAAa,GACrB,iBAAiB,CAAC,CAAC,CAAC,EAAE;IAKzB;;OAEG;IACH,MAAM,CAAC,OAAO,IAAI,IAAI;CAGtB;AAED;;GAEG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,KAAK,CAAE,SAAQ,eAAe,CAAC,GAAG,CAAC;IAC3E,OAAO,CAAC,UAAU,CAA+B;IACjD,OAAO,CAAC,UAAU,CACP;gBAEC,UAAU,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK;IAMpD;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,IAAI;IAK1E;;OAEG;IACY,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAYlC;;;;OAIG;IACY,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAgBzC;;;;OAIG;IACY,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;;;;;;;IAgBnD;;OAEG;IACG,aAAa,CAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,CAAC,CAAC;IAgBb;;OAEG;IACG,cAAc,CACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,CAAC,CAAC;IAqBb;;;OAGG;YACW,YAAY;IAoE1B;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,KAAK,EAClC,UAAU,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,KAAK,GACtC,iBAAiB,CAAC,CAAC,CAAC;CAoBvB"}