@quvel-kit/core 1.3.21 → 1.3.22

package/dist/index.d.ts

@@ -43,6 +43,7 @@ export * from './utils/scripts.js';
 export * from './utils/assets.js';
 export * from './utils/pagination.js';
 export * from './orm/index.js';
+export { Model } from './orm/Model.js';
 export { defineQuvelBoot } from './boot/quvel.js';
 export { serviceContainerPlugin } from './stores/plugins/serviceContainer.js';
 export { defineQuvelModule } from './module.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAUH,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AAGjC,YAAY,EACV,OAAO,IAAI,QAAQ,EACnB,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG1D,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAG7D,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AAGtC,cAAc,gBAAgB,CAAC;AAG/B,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAGlD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAG9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC9E,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAUH,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AAGjC,YAAY,EACV,OAAO,IAAI,QAAQ,EACnB,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG1D,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAG7D,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AAGtC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAGvC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAGlD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAG9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC9E,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -55,6 +55,7 @@ export * from './utils/assets.js';
 export * from './utils/pagination.js';
 // ORM - Active Record pattern for models
 export * from './orm/index.js';
+export { Model } from './orm/Model.js';
 // Boot
 export { defineQuvelBoot } from './boot/quvel.js';
 // Stores

package/dist/orm/Model.d.ts

@@ -0,0 +1,469 @@
+import type { ServiceContainer, ApiService } from '@quvel-kit/core';
+import type { ModelConfig, RelationshipDefinition } from '@quvel-kit/core/orm';
+import type { QueryBuilder } from '@quvel-kit/core/orm';
+/**
+ * Abstract Base Model Class
+ *
+ * Provides Active Record pattern for front-end models with:
+ * - Instance methods: save(), delete(), refresh(), isDirty()
+ * - Static query builder: User.query().where(...).get()
+ * - Relationship definitions: hasMany(), belongsTo(), hasOne()
+ * - Integration with ServiceContainer for API access
+ * - Full TypeScript type safety
+ * - SSR compatibility
+ *
+ * @template T - The model class itself (for proper return types)
+ * @template A - The API response interface (IUser, IPost, etc.)
+ *
+ * @example
+ * ```typescript
+ * export interface IUser {
+ *   id: string;
+ *   name: string;
+ *   email: string;
+ * }
+ *
+ * export class User extends Model<User, IUser> implements IUser {
+ *   static config: ModelConfig = {
+ *     endpoint: '/api/v1/users',
+ *     dates: ['created_at', 'updated_at']
+ *   };
+ *
+ *   id!: string;
+ *   name!: string;
+ *   email!: string;
+ *
+ *   // Relationship definitions
+ *   posts() {
+ *     return this.hasMany(Post, 'user_id');
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class Model<T extends Model<T, A>, A = any> {
+    /**
+     * Model configuration - MUST be overridden by subclasses
+     *
+     * @example
+     * ```typescript
+     * static config: ModelConfig = {
+     *   endpoint: '/api/v1/users',
+     *   primaryKey: 'id',
+     *   dates: ['created_at', 'updated_at']
+     * };
+     * ```
+     */
+    static config: ModelConfig;
+    /**
+     * Global service container for all models
+     * Set once in boot file via Model.setContainer($quvel)
+     * @private
+     */
+    private static _globalContainer?;
+    /**
+     * Set global service container for all models
+     *
+     * Should be called once in your boot file to enable automatic container injection.
+     *
+     * @param container - ServiceContainer instance
+     *
+     * @example
+     * ```typescript
+     * // In boot file
+     * import { Model } from '@quvel-kit/core/orm';
+     *
+     * export default boot(({ app }) => {
+     *   const container = app.config.globalProperties.$quvel;
+     *   Model.setContainer(container);
+     * });
+     * ```
+     */
+    static setContainer(container: ServiceContainer): void;
+    /**
+     * Get the global service container
+     * @returns ServiceContainer or undefined if not set
+     */
+    static getContainer(): ServiceContainer | undefined;
+    /**
+     * Service container instance
+     * Provides access to ApiService and other services
+     */
+    protected $quvel: ServiceContainer;
+    /**
+     * Metadata for internal state tracking
+     * @private
+     */
+    private $meta;
+    /**
+     * Constructor - accepts raw API data and optional container
+     *
+     * @param attributes - Raw attributes from API response
+     * @param container - ServiceContainer instance (auto-injected in most cases)
+     *
+     * @example
+     * ```typescript
+     * // From API response
+     * const user = new User({ id: '1', name: 'John', email: 'john@example.com' });
+     *
+     * // With container (in stores)
+     * const user = new User(apiData, this.$quvel);
+     *
+     * // New unsaved record
+     * const user = new User({ name: 'Jane', email: 'jane@example.com' }, $quvel);
+     * await user.save(); // POST /api/v1/users
+     * ```
+     */
+    constructor(attributes?: Partial<A>, container?: ServiceContainer);
+    /**
+     * Fill model with attributes
+     * Handles property assignment and date parsing
+     *
+     * @param attributes - Attributes to assign to the model
+     */
+    protected fill(attributes: Partial<A> | Record<string, any>): void;
+    /**
+     * Get the API service instance
+     * @throws Error if model not initialized with ServiceContainer
+     */
+    protected get api(): ApiService;
+    /**
+     * Get model configuration
+     */
+    protected get config(): ModelConfig;
+    /**
+     * Get primary key value from object or current instance
+     *
+     * @param obj - Object to get primary key from (defaults to this)
+     * @returns Primary key value or undefined
+     */
+    protected getPrimaryKeyValue(obj?: any): any;
+    /**
+     * Get the resource URL for this model instance
+     * @example '/api/v1/users/123'
+     * @throws Error if model is unsaved (no primary key)
+     */
+    protected getResourceUrl(): string;
+    /**
+     * Create a new query builder for this model
+     *
+     * @param container - Optional ServiceContainer (uses global if available)
+     * @returns QueryBuilder instance for fluent API
+     *
+     * @example
+     * ```typescript
+     * const users = await User.query()
+     *   .where('status', 'active')
+     *   .with('posts', 'profile')
+     *   .get();
+     * ```
+     */
+    static query<T extends Model<T, A>, A = any>(this: new (attrs: Partial<A>) => T): QueryBuilder<T, A>;
+    /**
+     * Find a model by primary key
+     *
+     * @param id - Primary key value
+     * @param container - Optional ServiceContainer
+     * @returns Model instance or null if not found
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * if (user) {
+     *   console.log(user.name);
+     * }
+     * ```
+     */
+    static find<T extends Model<T, A>, A = any>(this: new (attrs: Partial<A>, container?: ServiceContainer) => T, id: string | number, container?: ServiceContainer): Promise<T | null>;
+    /**
+     * Find a model by primary key or throw an error
+     *
+     * @param id - Primary key value
+     * @param container - Optional ServiceContainer
+     * @returns Model instance
+     * @throws Error if not found
+     *
+     * @example
+     * ```typescript
+     * const user = await User.findOrFail('123');
+     * // Throws if user doesn't exist
+     * ```
+     */
+    static findOrFail<T extends Model<T, A>, A = any>(this: new (attrs: Partial<A>, container?: ServiceContainer) => T, id: string | number, container?: ServiceContainer): Promise<T>;
+    /**
+     * Save the model (create or update)
+     *
+     * - New models (no primary key): POST to endpoint
+     * - Existing models: PUT to resource URL
+     *
+     * @returns The saved model instance
+     * @throws Error if already saving or if API request fails
+     *
+     * @example
+     * ```typescript
+     * // Create new
+     * const user = new User({ name: 'John', email: 'john@example.com' }, $quvel);
+     * await user.save(); // POST /api/v1/users
+     *
+     * // Update existing
+     * user.name = 'Jane';
+     * await user.save(); // PUT /api/v1/users/123
+     * ```
+     */
+    save(): Promise<T>;
+    /**
+     * Delete the model from the server
+     *
+     * @throws Error if model is unsaved or already being deleted
+     *
+     * @example
+     * ```typescript
+     * await user.delete(); // DELETE /api/v1/users/123
+     * ```
+     */
+    delete(): Promise<void>;
+    /**
+     * Refresh the model from the API
+     * Re-fetches the current state from the server
+     *
+     * @returns The refreshed model instance
+     * @throws Error if model is unsaved
+     *
+     * @example
+     * ```typescript
+     * await user.refresh(); // GET /api/v1/users/123
+     * console.log(user.name); // Updated from server
+     * ```
+     */
+    refresh(): Promise<T>;
+    /**
+     * Check if model has unsaved changes (dirty checking)
+     *
+     * Compares current attributes with original attributes from API
+     *
+     * @returns true if there are unsaved changes
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * user.name = 'Changed';
+     * console.log(user.isDirty()); // true
+     * await user.save();
+     * console.log(user.isDirty()); // false
+     * ```
+     */
+    isDirty(): boolean;
+    /**
+     * Check if a specific attribute has changed
+     *
+     * @param key - Attribute name to check
+     * @returns true if the attribute has changed
+     *
+     * @example
+     * ```typescript
+     * user.name = 'New Name';
+     * console.log(user.isDirtyAttribute('name')); // true
+     * console.log(user.isDirtyAttribute('email')); // false
+     * ```
+     */
+    isDirtyAttribute(key: keyof A): boolean;
+    /**
+     * Get model attributes as plain object
+     * Excludes metadata, methods, and internal properties
+     *
+     * @returns Plain object of model attributes
+     *
+     * @example
+     * ```typescript
+     * const attrs = user.getAttributes();
+     * console.log(attrs); // { id: '123', name: 'John', email: 'john@example.com' }
+     * ```
+     */
+    getAttributes(): Record<string, any>;
+    /**
+     * Get original attribute value (before changes)
+     *
+     * @param key - Attribute name
+     * @returns Original value from API
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * console.log(user.name); // 'John'
+     * user.name = 'Jane';
+     * console.log(user.getOriginal('name')); // 'John'
+     * ```
+     */
+    getOriginal<K extends keyof A>(key: K): A[K] | undefined;
+    /**
+     * Reset model to original state (undo changes)
+     *
+     * @example
+     * ```typescript
+     * user.name = 'Changed';
+     * user.reset();
+     * console.log(user.name); // Back to original value
+     * ```
+     */
+    reset(): void;
+    /**
+     * Get a loaded relationship
+     *
+     * @param name - Relationship name (method name on model)
+     * @returns Related model(s) or undefined if not loaded
+     *
+     * @example
+     * ```typescript
+     * const users = await User.query().with('posts').get();
+     * const posts = users[0].getRelation<Post[]>('posts');
+     * ```
+     */
+    getRelation<R = any>(name: string): R | undefined;
+    /**
+     * Set a loaded relationship
+     * Used internally by QueryBuilder when hydrating relationships
+     *
+     * @param name - Relationship name
+     * @param value - Related model(s)
+     */
+    setRelation<R = any>(name: string, value: R): void;
+    /**
+     * Check if a relationship is loaded
+     *
+     * @param name - Relationship name
+     * @returns true if relationship is loaded
+     *
+     * @example
+     * ```typescript
+     * if (user.hasRelation('posts')) {
+     *   const posts = user.getRelation<Post[]>('posts');
+     * }
+     * ```
+     */
+    hasRelation(name: string): boolean;
+    /**
+     * Define a hasMany relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on related model
+     * @param localKey - Local key on this model (default: primary key)
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class User extends Model<User, IUser> {
+     *   posts() {
+     *     return this.hasMany(Post, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const users = await User.query().with('posts').get();
+     * const posts = users[0].getRelation<Post[]>('posts');
+     * ```
+     */
+    protected hasMany<R extends Model<R, any>>(related: new (...args: any[]) => R, foreignKey: string, localKey?: string): RelationshipDefinition<R[]>;
+    /**
+     * Define a belongsTo relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on this model
+     * @param ownerKey - Owner key on related model (default: 'id')
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class Post extends Model<Post, IPost> {
+     *   user() {
+     *     return this.belongsTo(User, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const posts = await Post.query().with('user').get();
+     * const user = posts[0].getRelation<User>('user');
+     * ```
+     */
+    protected belongsTo<R extends Model<R, any>>(related: new (...args: any[]) => R, foreignKey: string, ownerKey?: string): RelationshipDefinition<R | null>;
+    /**
+     * Define a hasOne relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on related model
+     * @param localKey - Local key on this model (default: primary key)
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class User extends Model<User, IUser> {
+     *   profile() {
+     *     return this.hasOne(Profile, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const users = await User.query().with('profile').get();
+     * const profile = users[0].getRelation<Profile>('profile');
+     * ```
+     */
+    protected hasOne<R extends Model<R, any>>(related: new (...args: any[]) => R, foreignKey: string, localKey?: string): RelationshipDefinition<R | null>;
+    /**
+     * Factory method - creates instance from API data
+     * Provides backward compatibility with existing `fromApi` pattern
+     *
+     * @param data - API response data
+     * @param container - Optional ServiceContainer
+     * @returns Model instance
+     *
+     * @example
+     * ```typescript
+     * // Old pattern (still works)
+     * const user = User.fromApi(apiData);
+     *
+     * // New pattern
+     * const user = new User(apiData, $quvel);
+     * ```
+     */
+    static fromApi<T extends Model<T, A>, A = any>(this: new (attrs: Partial<A>, container?: ServiceContainer) => T, data: A, container?: ServiceContainer): T;
+    /**
+     * Serialize model to JSON
+     * Useful for API responses, logging, etc.
+     *
+     * @returns Plain object representation
+     *
+     * @example
+     * ```typescript
+     * console.log(JSON.stringify(user.toJSON()));
+     * ```
+     */
+    toJSON(): Record<string, any>;
+    /**
+     * Check if this is a new (unsaved) model
+     *
+     * @returns true if model has not been saved to the server
+     *
+     * @example
+     * ```typescript
+     * const user = new User({ name: 'John' });
+     * console.log(user.isNew()); // true
+     * await user.save();
+     * console.log(user.isNew()); // false
+     * ```
+     */
+    isNew(): boolean;
+    /**
+     * Check if this model exists on the server
+     *
+     * @returns true if model has been saved
+     */
+    exists(): boolean;
+}
+//# sourceMappingURL=Model.d.ts.map

package/dist/orm/Model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/orm/Model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAiB,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC9F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,8BAAsB,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG;IACxD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAmB;IAEnD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI;IAItD;;;OAGG;IACH,MAAM,CAAC,YAAY,IAAI,gBAAgB,GAAG,SAAS;IAInD;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAG,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAgB;IAE7B;;;;;;;;;;;;;;;;;;OAkBG;gBACS,UAAU,GAAE,OAAO,CAAC,CAAC,CAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB;IAmBrE;;;;;OAKG;IACH,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAclE;;;OAGG;IACH,SAAS,KAAK,GAAG,IAAI,UAAU,CAQ9B;IAED;;OAEG;IACH,SAAS,KAAK,MAAM,IAAI,WAAW,CAElC;IAED;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG;IAM5C;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAQlC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACzC,IAAI,EAAE,KAAK,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GACjC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;IAMrB;;;;;;;;;;;;;;OAcG;WACU,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EAC9C,IAAI,EAAE,KAAK,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,gBAAgB,KAAK,CAAC,EAChE,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAOpB;;;;;;;;;;;;;OAaG;WACU,UAAU,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpD,IAAI,EAAE,KAAK,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,gBAAgB,KAAK,CAAC,EAChE,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO,CAAC,CAAC,CAAC;IAQb;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IA2CxB;;;;;;;;;OASG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB7B;;;;;;;;;;;;OAYG;IACG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IAe3B;;;;;;;;;;;;;;;OAeG;IACH,OAAO,IAAI,OAAO;IAalB;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,OAAO;IAMvC;;;;;;;;;;;OAWG;IACH,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAkBpC;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;IAIxD;;;;;;;;;OASG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIjD;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAIlD;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIlC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EACvC,OAAO,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GAChB,sBAAsB,CAAC,CAAC,EAAE,CAAC;IAS9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EACzC,OAAO,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GAChB,sBAAsB,CAAC,CAAC,GAAG,IAAI,CAAC;IASnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,SAAS,CAAC,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EACtC,OAAO,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,GAChB,sBAAsB,CAAC,CAAC,GAAG,IAAI,CAAC;IASnC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EAC3C,IAAI,EAAE,KAAK,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,gBAAgB,KAAK,CAAC,EAChE,IAAI,EAAE,CAAC,EACP,SAAS,CAAC,EAAE,gBAAgB,GAC3B,CAAC;IAIJ;;;;;;;;;;OAUG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAI7B;;;;;;;;;;;;OAYG;IACH,KAAK,IAAI,OAAO;IAIhB;;;;OAIG;IACH,MAAM,IAAI,OAAO;CAGlB"}

package/dist/orm/Model.js

@@ -0,0 +1,648 @@
+/**
+ * Abstract Base Model Class
+ *
+ * Provides Active Record pattern for front-end models with:
+ * - Instance methods: save(), delete(), refresh(), isDirty()
+ * - Static query builder: User.query().where(...).get()
+ * - Relationship definitions: hasMany(), belongsTo(), hasOne()
+ * - Integration with ServiceContainer for API access
+ * - Full TypeScript type safety
+ * - SSR compatibility
+ *
+ * @template T - The model class itself (for proper return types)
+ * @template A - The API response interface (IUser, IPost, etc.)
+ *
+ * @example
+ * ```typescript
+ * export interface IUser {
+ *   id: string;
+ *   name: string;
+ *   email: string;
+ * }
+ *
+ * export class User extends Model<User, IUser> implements IUser {
+ *   static config: ModelConfig = {
+ *     endpoint: '/api/v1/users',
+ *     dates: ['created_at', 'updated_at']
+ *   };
+ *
+ *   id!: string;
+ *   name!: string;
+ *   email!: string;
+ *
+ *   // Relationship definitions
+ *   posts() {
+ *     return this.hasMany(Post, 'user_id');
+ *   }
+ * }
+ * ```
+ */
+export class Model {
+    /**
+     * Model configuration - MUST be overridden by subclasses
+     *
+     * @example
+     * ```typescript
+     * static config: ModelConfig = {
+     *   endpoint: '/api/v1/users',
+     *   primaryKey: 'id',
+     *   dates: ['created_at', 'updated_at']
+     * };
+     * ```
+     */
+    static config;
+    /**
+     * Global service container for all models
+     * Set once in boot file via Model.setContainer($quvel)
+     * @private
+     */
+    static _globalContainer;
+    /**
+     * Set global service container for all models
+     *
+     * Should be called once in your boot file to enable automatic container injection.
+     *
+     * @param container - ServiceContainer instance
+     *
+     * @example
+     * ```typescript
+     * // In boot file
+     * import { Model } from '@quvel-kit/core/orm';
+     *
+     * export default boot(({ app }) => {
+     *   const container = app.config.globalProperties.$quvel;
+     *   Model.setContainer(container);
+     * });
+     * ```
+     */
+    static setContainer(container) {
+        Model._globalContainer = container;
+    }
+    /**
+     * Get the global service container
+     * @returns ServiceContainer or undefined if not set
+     */
+    static getContainer() {
+        return Model._globalContainer;
+    }
+    /**
+     * Service container instance
+     * Provides access to ApiService and other services
+     */
+    $quvel;
+    /**
+     * Metadata for internal state tracking
+     * @private
+     */
+    $meta;
+    /**
+     * Constructor - accepts raw API data and optional container
+     *
+     * @param attributes - Raw attributes from API response
+     * @param container - ServiceContainer instance (auto-injected in most cases)
+     *
+     * @example
+     * ```typescript
+     * // From API response
+     * const user = new User({ id: '1', name: 'John', email: 'john@example.com' });
+     *
+     * // With container (in stores)
+     * const user = new User(apiData, this.$quvel);
+     *
+     * // New unsaved record
+     * const user = new User({ name: 'Jane', email: 'jane@example.com' }, $quvel);
+     * await user.save(); // POST /api/v1/users
+     * ```
+     */
+    constructor(attributes = {}, container) {
+        // Initialize metadata
+        this.$meta = {
+            isNew: !this.getPrimaryKeyValue(attributes),
+            original: { ...attributes },
+            relations: new Map(),
+            isSaving: false,
+            isDeleting: false,
+        };
+        // Assign attributes to model
+        this.fill(attributes);
+        // Container will be injected later if not provided
+        if (container) {
+            this.$quvel = container;
+        }
+    }
+    /**
+     * Fill model with attributes
+     * Handles property assignment and date parsing
+     *
+     * @param attributes - Attributes to assign to the model
+     */
+    fill(attributes) {
+        Object.assign(this, attributes);
+        // Parse date fields
+        const config = this.constructor.config;
+        if (config.dates) {
+            for (const field of config.dates) {
+                if (field in attributes && typeof attributes[field] === 'string') {
+                    this[field] = new Date(attributes[field]);
+                }
+            }
+        }
+    }
+    /**
+     * Get the API service instance
+     * @throws Error if model not initialized with ServiceContainer
+     */
+    get api() {
+        if (!this.$quvel) {
+            throw new Error(`${this.constructor.name} not initialized with ServiceContainer. ` +
+                `Pass container to constructor: new ${this.constructor.name}(data, container)`);
+        }
+        return this.$quvel.api;
+    }
+    /**
+     * Get model configuration
+     */
+    get config() {
+        return this.constructor.config;
+    }
+    /**
+     * Get primary key value from object or current instance
+     *
+     * @param obj - Object to get primary key from (defaults to this)
+     * @returns Primary key value or undefined
+     */
+    getPrimaryKeyValue(obj) {
+        const target = obj ?? this;
+        const key = this.config.primaryKey ?? 'id';
+        return target[key];
+    }
+    /**
+     * Get the resource URL for this model instance
+     * @example '/api/v1/users/123'
+     * @throws Error if model is unsaved (no primary key)
+     */
+    getResourceUrl() {
+        const pk = this.getPrimaryKeyValue();
+        if (!pk) {
+            throw new Error(`Cannot get resource URL for unsaved ${this.constructor.name}`);
+        }
+        return `${this.config.endpoint}/${pk}`;
+    }
+    /**
+     * Create a new query builder for this model
+     *
+     * @param container - Optional ServiceContainer (uses global if available)
+     * @returns QueryBuilder instance for fluent API
+     *
+     * @example
+     * ```typescript
+     * const users = await User.query()
+     *   .where('status', 'active')
+     *   .with('posts', 'profile')
+     *   .get();
+     * ```
+     */
+    static query() {
+        // Dynamic import to avoid circular dependency
+        const { QueryBuilder } = require('@quvel-kit/core/orm');
+        return new QueryBuilder(this, Model._globalContainer);
+    }
+    /**
+     * Find a model by primary key
+     *
+     * @param id - Primary key value
+     * @param container - Optional ServiceContainer
+     * @returns Model instance or null if not found
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * if (user) {
+     *   console.log(user.name);
+     * }
+     * ```
+     */
+    static async find(id, container) {
+        const pkField = this.config.primaryKey ?? 'id';
+        return this.query(container)
+            .where(pkField, id)
+            .first();
+    }
+    /**
+     * Find a model by primary key or throw an error
+     *
+     * @param id - Primary key value
+     * @param container - Optional ServiceContainer
+     * @returns Model instance
+     * @throws Error if not found
+     *
+     * @example
+     * ```typescript
+     * const user = await User.findOrFail('123');
+     * // Throws if user doesn't exist
+     * ```
+     */
+    static async findOrFail(id, container) {
+        const model = await this.find(id, container);
+        if (!model) {
+            throw new Error(`${this.name} with id ${id} not found`);
+        }
+        return model;
+    }
+    /**
+     * Save the model (create or update)
+     *
+     * - New models (no primary key): POST to endpoint
+     * - Existing models: PUT to resource URL
+     *
+     * @returns The saved model instance
+     * @throws Error if already saving or if API request fails
+     *
+     * @example
+     * ```typescript
+     * // Create new
+     * const user = new User({ name: 'John', email: 'john@example.com' }, $quvel);
+     * await user.save(); // POST /api/v1/users
+     *
+     * // Update existing
+     * user.name = 'Jane';
+     * await user.save(); // PUT /api/v1/users/123
+     * ```
+     */
+    async save() {
+        if (this.$meta.isSaving) {
+            throw new Error(`${this.constructor.name} is already being saved`);
+        }
+        this.$meta.isSaving = true;
+        try {
+            const attributes = this.getAttributes();
+            if (this.$meta.isNew) {
+                // Create new record via POST
+                const response = await this.api.post(this.config.endpoint, attributes);
+                const data = (response && typeof response === 'object' && 'data' in response)
+                    ? response.data
+                    : response;
+                this.fill(data);
+                this.$meta.isNew = false;
+                this.$meta.original = { ...data };
+            }
+            else {
+                // Update existing record via PUT
+                const response = await this.api.put(this.getResourceUrl(), attributes);
+                const data = (response && typeof response === 'object' && 'data' in response)
+                    ? response.data
+                    : response;
+                this.fill(data);
+                this.$meta.original = { ...data };
+            }
+            return this;
+        }
+        finally {
+            this.$meta.isSaving = false;
+        }
+    }
+    /**
+     * Delete the model from the server
+     *
+     * @throws Error if model is unsaved or already being deleted
+     *
+     * @example
+     * ```typescript
+     * await user.delete(); // DELETE /api/v1/users/123
+     * ```
+     */
+    async delete() {
+        if (this.$meta.isNew) {
+            throw new Error(`Cannot delete unsaved ${this.constructor.name}`);
+        }
+        if (this.$meta.isDeleting) {
+            throw new Error(`${this.constructor.name} is already being deleted`);
+        }
+        this.$meta.isDeleting = true;
+        try {
+            await this.api.delete(this.getResourceUrl());
+        }
+        finally {
+            this.$meta.isDeleting = false;
+        }
+    }
+    /**
+     * Refresh the model from the API
+     * Re-fetches the current state from the server
+     *
+     * @returns The refreshed model instance
+     * @throws Error if model is unsaved
+     *
+     * @example
+     * ```typescript
+     * await user.refresh(); // GET /api/v1/users/123
+     * console.log(user.name); // Updated from server
+     * ```
+     */
+    async refresh() {
+        if (this.$meta.isNew) {
+            throw new Error(`Cannot refresh unsaved ${this.constructor.name}`);
+        }
+        const response = await this.api.get(this.getResourceUrl());
+        const data = (response && typeof response === 'object' && 'data' in response)
+            ? response.data
+            : response;
+        this.fill(data);
+        this.$meta.original = { ...data };
+        return this;
+    }
+    /**
+     * Check if model has unsaved changes (dirty checking)
+     *
+     * Compares current attributes with original attributes from API
+     *
+     * @returns true if there are unsaved changes
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * user.name = 'Changed';
+     * console.log(user.isDirty()); // true
+     * await user.save();
+     * console.log(user.isDirty()); // false
+     * ```
+     */
+    isDirty() {
+        const current = this.getAttributes();
+        const original = this.$meta.original;
+        for (const key in current) {
+            if (current[key] !== original[key]) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Check if a specific attribute has changed
+     *
+     * @param key - Attribute name to check
+     * @returns true if the attribute has changed
+     *
+     * @example
+     * ```typescript
+     * user.name = 'New Name';
+     * console.log(user.isDirtyAttribute('name')); // true
+     * console.log(user.isDirtyAttribute('email')); // false
+     * ```
+     */
+    isDirtyAttribute(key) {
+        const current = this.getAttributes();
+        const original = this.$meta.original;
+        return current[key] !== original[key];
+    }
+    /**
+     * Get model attributes as plain object
+     * Excludes metadata, methods, and internal properties
+     *
+     * @returns Plain object of model attributes
+     *
+     * @example
+     * ```typescript
+     * const attrs = user.getAttributes();
+     * console.log(attrs); // { id: '123', name: 'John', email: 'john@example.com' }
+     * ```
+     */
+    getAttributes() {
+        const attrs = {};
+        for (const key in this) {
+            // Skip internal properties, methods, and container
+            if (key !== '$quvel' &&
+                key !== '$meta' &&
+                typeof this[key] !== 'function' &&
+                !key.startsWith('$')) {
+                attrs[key] = this[key];
+            }
+        }
+        return attrs;
+    }
+    /**
+     * Get original attribute value (before changes)
+     *
+     * @param key - Attribute name
+     * @returns Original value from API
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find('123');
+     * console.log(user.name); // 'John'
+     * user.name = 'Jane';
+     * console.log(user.getOriginal('name')); // 'John'
+     * ```
+     */
+    getOriginal(key) {
+        return this.$meta.original[key];
+    }
+    /**
+     * Reset model to original state (undo changes)
+     *
+     * @example
+     * ```typescript
+     * user.name = 'Changed';
+     * user.reset();
+     * console.log(user.name); // Back to original value
+     * ```
+     */
+    reset() {
+        this.fill(this.$meta.original);
+    }
+    /**
+     * Get a loaded relationship
+     *
+     * @param name - Relationship name (method name on model)
+     * @returns Related model(s) or undefined if not loaded
+     *
+     * @example
+     * ```typescript
+     * const users = await User.query().with('posts').get();
+     * const posts = users[0].getRelation<Post[]>('posts');
+     * ```
+     */
+    getRelation(name) {
+        return this.$meta.relations.get(name);
+    }
+    /**
+     * Set a loaded relationship
+     * Used internally by QueryBuilder when hydrating relationships
+     *
+     * @param name - Relationship name
+     * @param value - Related model(s)
+     */
+    setRelation(name, value) {
+        this.$meta.relations.set(name, value);
+    }
+    /**
+     * Check if a relationship is loaded
+     *
+     * @param name - Relationship name
+     * @returns true if relationship is loaded
+     *
+     * @example
+     * ```typescript
+     * if (user.hasRelation('posts')) {
+     *   const posts = user.getRelation<Post[]>('posts');
+     * }
+     * ```
+     */
+    hasRelation(name) {
+        return this.$meta.relations.has(name);
+    }
+    /**
+     * Define a hasMany relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on related model
+     * @param localKey - Local key on this model (default: primary key)
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class User extends Model<User, IUser> {
+     *   posts() {
+     *     return this.hasMany(Post, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const users = await User.query().with('posts').get();
+     * const posts = users[0].getRelation<Post[]>('posts');
+     * ```
+     */
+    hasMany(related, foreignKey, localKey) {
+        return {
+            type: 'hasMany',
+            related,
+            foreignKey,
+            localKey: localKey ?? (this.config.primaryKey ?? 'id'),
+        };
+    }
+    /**
+     * Define a belongsTo relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on this model
+     * @param ownerKey - Owner key on related model (default: 'id')
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class Post extends Model<Post, IPost> {
+     *   user() {
+     *     return this.belongsTo(User, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const posts = await Post.query().with('user').get();
+     * const user = posts[0].getRelation<User>('user');
+     * ```
+     */
+    belongsTo(related, foreignKey, ownerKey) {
+        return {
+            type: 'belongsTo',
+            related,
+            foreignKey,
+            ownerKey: ownerKey ?? 'id',
+        };
+    }
+    /**
+     * Define a hasOne relationship
+     *
+     * **Note**: This only defines the relationship metadata.
+     * Actual loading must be done via query builder's `with()` method.
+     *
+     * @param related - Related model class
+     * @param foreignKey - Foreign key on related model
+     * @param localKey - Local key on this model (default: primary key)
+     * @returns Relationship definition
+     *
+     * @example
+     * ```typescript
+     * export class User extends Model<User, IUser> {
+     *   profile() {
+     *     return this.hasOne(Profile, 'user_id');
+     *   }
+     * }
+     *
+     * // Usage
+     * const users = await User.query().with('profile').get();
+     * const profile = users[0].getRelation<Profile>('profile');
+     * ```
+     */
+    hasOne(related, foreignKey, localKey) {
+        return {
+            type: 'hasOne',
+            related,
+            foreignKey,
+            localKey: localKey ?? (this.config.primaryKey ?? 'id'),
+        };
+    }
+    /**
+     * Factory method - creates instance from API data
+     * Provides backward compatibility with existing `fromApi` pattern
+     *
+     * @param data - API response data
+     * @param container - Optional ServiceContainer
+     * @returns Model instance
+     *
+     * @example
+     * ```typescript
+     * // Old pattern (still works)
+     * const user = User.fromApi(apiData);
+     *
+     * // New pattern
+     * const user = new User(apiData, $quvel);
+     * ```
+     */
+    static fromApi(data, container) {
+        return new this(data, container);
+    }
+    /**
+     * Serialize model to JSON
+     * Useful for API responses, logging, etc.
+     *
+     * @returns Plain object representation
+     *
+     * @example
+     * ```typescript
+     * console.log(JSON.stringify(user.toJSON()));
+     * ```
+     */
+    toJSON() {
+        return this.getAttributes();
+    }
+    /**
+     * Check if this is a new (unsaved) model
+     *
+     * @returns true if model has not been saved to the server
+     *
+     * @example
+     * ```typescript
+     * const user = new User({ name: 'John' });
+     * console.log(user.isNew()); // true
+     * await user.save();
+     * console.log(user.isNew()); // false
+     * ```
+     */
+    isNew() {
+        return this.$meta.isNew;
+    }
+    /**
+     * Check if this model exists on the server
+     *
+     * @returns true if model has been saved
+     */
+    exists() {
+        return !this.$meta.isNew;
+    }
+}

package/dist/orm/index.d.ts

@@ -1,19 +1,27 @@
 /**
  * ORM Module - Front-End Active Record Pattern for Spatie Query Builder
  *
- * Provides QueryBuilder and types for building Active Record models.
- * Apps should create their own base Model class - see app/src/models/BaseModel.ts
+ * Provides complete Active Record implementation with QueryBuilder.
+ * Advanced users can create intermediate base models or copy Model code into their project.
  *
  * @example
  * ```typescript
- * // In app/src/models/BaseModel.ts
- * import { QueryBuilder, type ModelConfig } from '@quvel-kit/core/orm';
+ * import { Model, type ModelConfig } from '@quvel-kit/core/orm';
  *
- * export abstract class Model<T, A> {
- *   // Your customizable base model
+ * // Direct usage (recommended for most projects)
+ * export class User extends Model<User, IUser> implements IUser {
+ *   static override config: ModelConfig = { endpoint: '/api/v1/users' };
+ *   id!: string;
+ *   name!: string;
+ * }
+ *
+ * // Optional: Intermediate base for app-wide customization
+ * export abstract class AppModel<T, A> extends Model<T, A> {
+ *   myCustomMethod() { /* ... *\/ }
  * }
  * ```
  */
+export { Model } from './Model.js';
 export { QueryBuilder } from './QueryBuilder.js';
 export type { ModelConfig, FilterOperator, ModelMetadata } from './types.js';
 export { type RelationshipType, type RelationshipDefinition, type RelationshipData, } from './relationships/types.js';

package/dist/orm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/orm/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG7E,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,GACtB,MAAM,0BAA0B,CAAC;AAGlC,YAAY,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/orm/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG7E,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,GACtB,MAAM,0BAA0B,CAAC;AAGlC,YAAY,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/orm/index.js

@@ -1,18 +1,26 @@
 /**
  * ORM Module - Front-End Active Record Pattern for Spatie Query Builder
  *
- * Provides QueryBuilder and types for building Active Record models.
- * Apps should create their own base Model class - see app/src/models/BaseModel.ts
+ * Provides complete Active Record implementation with QueryBuilder.
+ * Advanced users can create intermediate base models or copy Model code into their project.
  *
  * @example
  * ```typescript
- * // In app/src/models/BaseModel.ts
- * import { QueryBuilder, type ModelConfig } from '@quvel-kit/core/orm';
+ * import { Model, type ModelConfig } from '@quvel-kit/core/orm';
  *
- * export abstract class Model<T, A> {
- *   // Your customizable base model
+ * // Direct usage (recommended for most projects)
+ * export class User extends Model<User, IUser> implements IUser {
+ *   static override config: ModelConfig = { endpoint: '/api/v1/users' };
+ *   id!: string;
+ *   name!: string;
+ * }
+ *
+ * // Optional: Intermediate base for app-wide customization
+ * export abstract class AppModel<T, A> extends Model<T, A> {
+ *   myCustomMethod() { /* ... *\/ }
  * }
  * ```
  */
 // Core classes
+export { Model } from './Model.js';
 export { QueryBuilder } from './QueryBuilder.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quvel-kit/core",
-  "version": "1.3.21",
+  "version": "1.3.22",
   "description": "Core utilities for Quvel UI",
   "type": "module",
   "main": "./dist/index.js",