@warlock.js/cascade 4.0.48 → 4.0.59

package/cjs/model/model.js

@@ -0,0 +1,1463 @@
+'use strict';var reinforcements=require('@mongez/reinforcements'),dataSourceRegistry=require('../data-source/data-source-registry.js'),databaseDirtyTracker=require('../database-dirty-tracker.js'),modelEvents=require('../events/model-events.js'),databaseRemover=require('../remover/database-remover.js'),databaseRestorer=require('../restorer/database-restorer.js'),modelSync=require('../sync/model-sync.js'),databaseWriter=require('../writer/database-writer.js'),registerModel=require('./register-model.js');/**
+ * Sentinel value used to distinguish between undefined and missing fields.
+ */
+const MISSING_VALUE = Symbol("missing");
+/**
+ * WeakMap registry that associates each model constructor with its own event emitter.
+ */
+const modelEventsRegistry = new WeakMap();
+/**
+ * Base class that powers all Cascade models.
+ *
+ * Provides:
+ * - Type-safe value accessors with dot-notation support (get, set, has, unset, merge)
+ * - Automatic dirty tracking for efficient partial updates
+ * - Lifecycle event hooks (saving, created, deleting, etc.)
+ * - Integration with the data-source registry for multi-database support
+ * - Support for both per-model and global event listeners
+ *
+ * @template TSchema - The shape of the model's underlying data
+ *
+ * @example
+ * ```typescript
+ * interface UserSchema {
+ *   id: number;
+ *   name: string;
+ *   email: string;
+ * }
+ *
+ * class User extends Model<UserSchema> {
+ *   public static table = "users";
+ * }
+ *
+ * const user = new User({ name: "Alice" });
+ * user.set("email", "alice@example.com");
+ * console.log(user.hasChanges()); // true
+ * ```
+ */
+class Model {
+    /**
+     * The database table or collection name associated with this model.
+     *
+     * Must be defined by each concrete model subclass.
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static table = "users";
+     * }
+     * ```
+     */
+    static table;
+    /**
+     * Resource for this model.
+     * It is a class that holds a toJSON function
+     * Called when the model is being converted to JSON (by calling toJSON or JSON.stringify(model))
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static resource = UserResource;
+     * }
+     * ```
+     */
+    static resource;
+    /**
+     * Resource columns
+     * Define what columns should be sent to the resource (if any) when converting to JSON
+     */
+    static resourceColumns;
+    /**
+     * JSON keys for this model.
+     * This could be used if resource is not passed
+     * It will select only these keys from the model
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static toJsonColumns = ["id", "name"];
+     * }
+     * ```
+     */
+    static toJsonColumns;
+    /**
+     * Data source reference for this model.
+     *
+     * Can be:
+     * - A string name registered in the data-source registry
+     * - A DataSource instance
+     * - Undefined (falls back to the default data source)
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static dataSource = "primary";
+     * }
+     * ```
+     */
+    static dataSource;
+    /**
+     * Query builder class
+     */
+    static builder;
+    /**
+     * Primary key field name used to identify records.
+     *
+     * @default "id"
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static primaryKey = "_id"; // MongoDB
+     * }
+     *
+     * class Product extends Model {
+     *   public static primaryKey = "id"; // SQL
+     * }
+     * ```
+     */
+    static primaryKey = "id";
+    /**
+     * Embeded fields when document is Being embeded
+     */
+    static embed;
+    /**
+     * Validation and casting schema using @warlock.js/seal.
+     *
+     * Defines validation rules and data transformations for the model.
+     * Used automatically during save operations.
+     *
+     * @example
+     * ```typescript
+     * import { v } from "@warlock.js/seal";
+     *
+     * class User extends Model {
+     *   public static schema = v.object({
+     *     name: v.string().required().trim(),
+     *     age: v.number().min(0).max(120),
+     *     email: v.string().email().required().toLowerCase(),
+     *     createdAt: v.date().default(() => new Date()),
+     *   });
+     * }
+     * ```
+     */
+    static schema;
+    /**
+     * Strict mode behavior for unknown fields.
+     *
+     * - `"strip"`: Remove unknown fields silently (default, recommended for APIs)
+     * - `"fail"`: Throw validation error on unknown fields (strict validation)
+     * - `"allow"`: Allow unknown fields to pass through (permissive)
+     *
+     * @default "strip"
+     *
+     * @example
+     * ```typescript
+     * import { Model, type StrictMode } from "@warlock.js/cascade";
+     *
+     * class User extends Model {
+     *   public static strictMode: StrictMode = "fail"; // Throw on unknown fields
+     * }
+     *
+     * const user = new User({ name: "Alice", unknownField: "value" });
+     * await user.save(); // DatabaseWriterValidationError: unknown field
+     * ```
+     */
+    static strictMode = "strip";
+    /**
+     * Auto-generate incremental `id` field on insert (NoSQL only).
+     *
+     * When enabled, the ID generator creates a sequential integer ID
+     * separate from the database's native ID (_id for MongoDB).
+     *
+     * **Note:** SQL databases use native AUTO_INCREMENT and don't need this.
+     *
+     * @default true
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static autoGenerateId = true;
+     * }
+     *
+     * const user = new User({ name: "Alice" });
+     * await user.save();
+     * console.log(user.get("_id")); // ObjectId("...") - MongoDB
+     * console.log(user.get("id")); // 1 - Generated
+     * ```
+     */
+    static autoGenerateId = true;
+    /**
+     * Initial ID value for the first record.
+     *
+     * If not set, defaults to 1 or uses `randomInitialId`.
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static initialId = 1000; // Start from 1000
+     * }
+     * ```
+     */
+    static initialId;
+    /**
+     * Randomly generate the initial ID.
+     *
+     * Can be:
+     * - `true`: Generate random ID between 10000-499999
+     * - Function: Custom random ID generator
+     * - `false`: Use `initialId` or default to 1
+     *
+     * @default false
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static randomInitialId = true; // Random 10000-499999
+     * }
+     *
+     * class Product extends Model {
+     *   public static randomInitialId = () => Math.floor(Math.random() * 1000000);
+     * }
+     * ```
+     */
+    static randomInitialId;
+    /**
+     * Amount to increment ID by for each new record.
+     *
+     * If not set, defaults to 1 or uses `randomIncrement`.
+     *
+     * @default 1
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static incrementIdBy = 5; // Increment by 5
+     * }
+     * ```
+     */
+    static incrementIdBy = 1;
+    /**
+     * Randomly generate the increment amount.
+     *
+     * Can be:
+     * - `true`: Generate random increment between 1-10
+     * - Function: Custom random increment generator
+     * - `false`: Use `incrementIdBy` or default to 1
+     *
+     * @default false
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static randomIncrement = true; // Random 1-10
+     * }
+     *
+     * class Product extends Model {
+     *   public static randomIncrement = () => Math.floor(Math.random() * 100);
+     * }
+     * ```
+     */
+    static randomIncrement;
+    /**
+     * Created at column name.
+     */
+    static createdAtColumn = "createdAt";
+    /**
+     * Updated at column name.
+     */
+    static updatedAtColumn = "updatedAt";
+    /**
+     * Delete strategy for this model.
+     *
+     * Controls how models are deleted:
+     * - `"trash"` - Moves to trash collection, then deletes
+     * - `"permanent"` - Direct deletion (hard delete)
+     * - `"soft"` - Sets deletedAt timestamp (soft delete)
+     *
+     * Can be overridden by destroy() options.
+     * Falls back to data source default if not set.
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static deleteStrategy: DeleteStrategy = "soft";
+     * }
+     * ```
+     */
+    static deleteStrategy;
+    /**
+     * Column name for soft delete timestamp.
+     *
+     * Used when delete strategy is "soft".
+     *
+     * @default "deletedAt"
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static deletedAtColumn = "archivedAt";
+     * }
+     * ```
+     */
+    static deletedAtColumn = "deletedAt";
+    /**
+     * Trash table/collection name override.
+     *
+     * If not set, defaults to `{table}Trash` or data source default.
+     * Used when delete strategy is "trash".
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static trashTable = "userRecycleBin";
+     * }
+     * ```
+     */
+    static trashTable;
+    /**
+     * Global scopes that are automatically applied to all queries.
+     * These scopes are inherited by child models.
+     */
+    static globalScopes = new Map();
+    /**
+     * Local scopes that can be manually applied to queries.
+     * These are reusable query snippets that developers opt into.
+     */
+    static localScopes = new Map();
+    /**
+     * Flag indicating whether this model instance represents a new (unsaved) record.
+     *
+     * - `true`: The model has not been persisted to the database yet
+     * - `false`: The model represents an existing database record
+     *
+     * This flag is used by the writer to determine whether to perform an insert or update.
+     */
+    isNew = true;
+    /**
+     * The raw mutable data backing this model instance.
+     *
+     * All field accessors (get, set, merge, etc.) operate on this object.
+     */
+    data;
+    /**
+     * Dirty tracker that monitors changes to the model's data.
+     *
+     * Tracks:
+     * - Which fields have been modified (dirty columns)
+     * - Which fields have been removed
+     * - Original vs. current values for each dirty field
+     *
+     * Used by the writer to generate efficient partial update payloads.
+     */
+    dirtyTracker;
+    /**
+     * Constructs a new model instance with optional initial data.
+     *
+     * Initializes the dirty tracker with a snapshot of the provided data.
+     *
+     * @param initialData - Partial data to populate the model
+     *
+     * @example
+     * ```typescript
+     * const user = new User({ name: "Alice", email: "alice@example.com" });
+     * ```
+     */
+    constructor(initialData = {}) {
+        this.data = initialData;
+        this.dirtyTracker = new databaseDirtyTracker.DatabaseDirtyTracker(this.data);
+    }
+    /**
+     * Get a model class by its name from the global registry.
+     *
+     * Models must be decorated with @RegisterModel() to be available in the registry.
+     *
+     * @param name - The model class name
+     * @returns The model class or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const UserModel = Model.getModel("User");
+     * if (UserModel) {
+     *   const user = await UserModel.find(1);
+     * }
+     * ```
+     */
+    static getModel(name) {
+        return registerModel.getModelFromRegistry(name);
+    }
+    /**
+     * Get all registered models from the global registry.
+     *
+     * Only models decorated with @RegisterModel() will appear here.
+     *
+     * @returns A Map of all registered model classes by name
+     *
+     * @example
+     * ```typescript
+     * const allModels = Model.getAllModels();
+     * for (const [name, ModelClass] of allModels) {
+     *   console.log(`Found model: ${name} with table: ${ModelClass.table}`);
+     * }
+     * ```
+     */
+    static getAllModels() {
+        return registerModel.getAllModelsFromRegistry();
+    }
+    // ============================================================================
+    // STATIC SYNC METHODS
+    // ============================================================================
+    /**
+     * Create a sync operation for a single embedded document.
+     *
+     * When this model is updated, the target model's field
+     * will be updated with the embedded data.
+     *
+     * @param TargetModel - Target model class that receives data
+     * @param targetField - Field path in target model
+     * @returns Sync operation for chaining configuration
+     *
+     * @example
+     * ```typescript
+     * // When Category updates, update Product.category
+     * Category.sync(Product, "category");
+     * ```
+     */
+    static sync(TargetModel, targetField) {
+        return modelSync.modelSync.sync(this, TargetModel, targetField);
+    }
+    /**
+     * Create a sync operation for an array of embedded documents.
+     *
+     * When this model is updated, the corresponding element
+     * in the target model's array field will be updated.
+     *
+     * @param TargetModel - Target model class that receives data
+     * @param targetField - Array field path in target model
+     * @returns Sync operation for chaining configuration
+     *
+     * @example
+     * ```typescript
+     * // When Tag updates, update Post.tags[i] where tags[i].id matches
+     * Tag.syncMany(Post, "tags").identifyBy("id");
+     * ```
+     */
+    static syncMany(TargetModel, targetField) {
+        return modelSync.modelSync.syncMany(this, TargetModel, targetField);
+    }
+    /**
+     * Get model id
+     */
+    get id() {
+        return this.get("id");
+    }
+    get(field, defaultValue) {
+        return reinforcements.get(this.data, field, defaultValue);
+    }
+    only(fields) {
+        return reinforcements.only(this.data, fields);
+    }
+    /**
+     * Get a string value
+     */
+    string(key, defaultValue) {
+        return this.get(key, defaultValue);
+    }
+    /**
+     * Get a number value
+     */
+    number(key, defaultValue) {
+        return this.get(key, defaultValue);
+    }
+    /**
+     * Get a boolean value
+     */
+    boolean(key, defaultValue) {
+        return this.get(key, defaultValue);
+    }
+    set(field, value) {
+        const path = String(field);
+        reinforcements.set(this.data, path, value);
+        const partial = {};
+        reinforcements.set(partial, path, value);
+        this.dirtyTracker.mergeChanges(partial);
+        return this;
+    }
+    has(field) {
+        return reinforcements.get(this.data, field, MISSING_VALUE) !== MISSING_VALUE;
+    }
+    increment(field, amount) {
+        const value = this.get(field, 0);
+        const incrementedValue = value + amount;
+        return this.set(field, incrementedValue);
+    }
+    decrement(field, amount) {
+        const value = this.get(field, 0);
+        const decrementedValue = value - amount;
+        return this.set(field, decrementedValue);
+    }
+    unset(...fields) {
+        this.data = reinforcements.unset(this.data, fields);
+        this.dirtyTracker.unset(fields);
+        return this;
+    }
+    merge(values) {
+        this.data = reinforcements.merge(this.data, values);
+        this.dirtyTracker.mergeChanges(values);
+        return this;
+    }
+    /**
+     * Checks whether the model's data has changed since instantiation or last reset.
+     *
+     * @returns `true` if any fields have been modified or removed, `false` otherwise
+     *
+     * @example
+     * ```typescript
+     * const user = new User({ name: "Alice" });
+     * user.hasChanges(); // false
+     * user.set("name", "Bob");
+     * user.hasChanges(); // true
+     * ```
+     */
+    hasChanges() {
+        return this.dirtyTracker.hasChanges();
+    }
+    /**
+     * Check if the given column has been modified.
+     *
+     * @param column - The column name to check
+     * @returns `true` if the column has been modified, `false` otherwise
+     *
+     * @example
+     * ```typescript
+     * user.set("name", "Bob");
+     * user.isDirty("name"); // true
+     * ```
+     */
+    isDirty(column) {
+        return this.dirtyTracker.isDirty(column);
+    }
+    /**
+     * Retrieves all dirty columns with their old and new values.
+     *
+     * @returns A record mapping each dirty column to its previous and current value
+     *
+     * @example
+     * ```typescript
+     * user.set("name", "Bob");
+     * user.getDirtyColumnsWithValues();
+     * // { name: { oldValue: "Alice", newValue: "Bob" } }
+     * ```
+     */
+    getDirtyColumnsWithValues() {
+        return this.dirtyTracker.getDirtyColumnsWithValues();
+    }
+    /**
+     * Lists all columns that have been removed from the model's data.
+     *
+     * @returns An array of field names that were present initially but have been unset
+     *
+     * @example
+     * ```typescript
+     * user.unset("tempField");
+     * user.getRemovedColumns(); // ["tempField"]
+     * ```
+     */
+    getRemovedColumns() {
+        return this.dirtyTracker.getRemovedColumns();
+    }
+    /**
+     * Lists all columns that have been modified since instantiation or last reset.
+     *
+     * @returns An array of field names that have changed
+     *
+     * @example
+     * ```typescript
+     * user.set("name", "Bob");
+     * user.getDirtyColumns(); // ["name"]
+     * ```
+     */
+    getDirtyColumns() {
+        return this.dirtyTracker.getDirtyColumns();
+    }
+    /**
+     * Emits a lifecycle event to both per-model and global listeners.
+     *
+     * This method is public so that external services (like the writer) can trigger
+     * lifecycle events when appropriate.
+     *
+     * @param event - The event name (e.g., "saving", "created", "deleting")
+     * @param context - Optional context data to pass to listeners
+     *
+     * @example
+     * ```typescript
+     * await user.emitEvent("saving");
+     * await user.emitEvent("validated", { errors: [] });
+     * ```
+     */
+    async emitEvent(event, context) {
+        const ctor = this.constructor;
+        await ctor.events().emit(event, this, context);
+        await modelEvents.globalModelEvents.emit(event, this, context);
+    }
+    /**
+     * Resolves the data source associated with this model.
+     *
+     * Resolution order:
+     * 1. If `dataSource` is a string, looks it up in the data-source registry
+     * 2. If `dataSource` is a DataSource instance, returns it directly
+     * 3. Otherwise, returns the default data source from the registry
+     *
+     * @returns The resolved DataSource instance
+     * @throws Error if no data source is found
+     *
+     * @example
+     * ```typescript
+     * class User extends Model {
+     *   public static dataSource = "primary";
+     * }
+     *
+     * const ds = User.getDataSource();
+     * ```
+     */
+    static getDataSource() {
+        const ref = this.dataSource;
+        let dataSource;
+        if (typeof ref === "string") {
+            dataSource = dataSourceRegistry.dataSourceRegistry.get(ref);
+        }
+        else if (ref) {
+            dataSource = ref;
+        }
+        else {
+            dataSource = dataSourceRegistry.dataSourceRegistry.get();
+        }
+        // Apply model defaults from data source (only once per model class)
+        if (!this.hasOwnProperty("_defaultsApplied") && dataSource.modelDefaults) {
+            this.applyModelDefaults(dataSource.modelDefaults);
+            this._defaultsApplied = true;
+        }
+        return dataSource;
+    }
+    /**
+     * Apply model defaults from data source configuration.
+     *
+     * This is called automatically by getDataSource() the first time
+     * a model accesses its data source. Defaults are only applied if
+     * the model doesn't already have its own value set.
+     *
+     * @param defaults - Model default configuration from data source
+     * @private
+     */
+    static applyModelDefaults(defaults) {
+        // Only apply defaults if model doesn't have its own value
+        // Note: autoGenerateId is not applied here as it's a driver-level setting
+        if (defaults.initialId !== undefined && this.initialId === undefined) {
+            this.initialId = defaults.initialId;
+        }
+        if (defaults.randomInitialId !== undefined && this.randomInitialId === undefined) {
+            this.randomInitialId = defaults.randomInitialId;
+        }
+        if (defaults.incrementIdBy !== undefined && this.incrementIdBy === undefined) {
+            this.incrementIdBy = defaults.incrementIdBy;
+        }
+        if (defaults.randomIncrement !== undefined && this.randomIncrement === undefined) {
+            this.randomIncrement = defaults.randomIncrement;
+        }
+        if (defaults.deleteStrategy !== undefined && this.deleteStrategy === undefined) {
+            this.deleteStrategy = defaults.deleteStrategy;
+        }
+        if (defaults.strictMode !== undefined && this.strictMode === undefined) {
+            this.strictMode = defaults.strictMode;
+        }
+    }
+    /**
+     * Add a global scope that is automatically applied to all queries.
+     *
+     * Global scopes are inherited by child models and applied before query execution.
+     * Use for security filters, multi-tenancy, soft deletes, etc.
+     *
+     * @param name - Unique name for the scope
+     * @param callback - Function that modifies the query
+     * @param options - Scope options (timing: 'before' | 'after')
+     *
+     * @example
+     * ```typescript
+     * // Multi-tenancy scope
+     * Model.addGlobalScope('tenant', (query) => {
+     *   query.where('tenantId', getCurrentTenant());
+     * }, { timing: 'before' });
+     *
+     * // Soft delete scope
+     * User.addGlobalScope('notDeleted', (query) => {
+     *   query.whereNull('deletedAt');
+     * });
+     * ```
+     */
+    static addGlobalScope(name, callback, options = {}) {
+        this.globalScopes.set(name, {
+            callback,
+            timing: options.timing || "before",
+        });
+    }
+    /**
+     * Remove a global scope by name.
+     *
+     * @param name - Name of the scope to remove
+     *
+     * @example
+     * ```typescript
+     * Model.removeGlobalScope('tenant');
+     * ```
+     */
+    static removeGlobalScope(name) {
+        this.globalScopes.delete(name);
+    }
+    /**
+     * Add a local scope that can be manually applied to queries.
+     *
+     * Local scopes are reusable query snippets that developers opt into.
+     * They are not automatically applied.
+     *
+     * @param name - Unique name for the scope
+     * @param callback - Function that modifies the query
+     *
+     * @example
+     * ```typescript
+     * // Define reusable scopes
+     * User.addScope('active', (query) => {
+     *   query.where('isActive', true);
+     * });
+     *
+     * User.addScope('admins', (query) => {
+     *   query.where('role', 'admin');
+     * });
+     *
+     * // Use explicitly
+     * await User.query().scope('active').get();
+     * await User.query().scope('admins').get();
+     * ```
+     */
+    static addScope(name, callback) {
+        this.localScopes.set(name, callback);
+    }
+    /**
+     * Remove a local scope by name.
+     *
+     * @param name - Name of the scope to remove
+     *
+     * @example
+     * ```typescript
+     * User.removeScope('active');
+     * ```
+     */
+    static removeScope(name) {
+        this.localScopes.delete(name);
+    }
+    /**
+     * Create a new query builder for this model
+     */
+    static query() {
+        // Call newQueryBuilder as a static method (may be overridden in child classes)
+        const queryBuilder = this.newQueryBuilder();
+        const ModelClass = this;
+        // Collect global scopes from base Model and child model
+        const allGlobalScopes = new Map([
+            ...Model.globalScopes,
+            ...this.globalScopes,
+        ]);
+        // Pass scopes to query builder
+        queryBuilder.pendingGlobalScopes = allGlobalScopes;
+        queryBuilder.availableLocalScopes = this.localScopes;
+        queryBuilder.disabledGlobalScopes = new Set();
+        // Emit fetching event
+        this.events().emitFetching(queryBuilder, { table: this.table, modelClass: this });
+        queryBuilder.hydrate((data) => {
+            const model = new ModelClass(data);
+            model.isNew = false;
+            return model;
+        });
+        // Wire up onFetched callback to emit model-level event
+        queryBuilder.onFetched(async (models, context) => {
+            await this.events().emit("fetched", models, context);
+        });
+        return queryBuilder;
+    }
+    /**
+     * Create new query builder.
+     *
+     * If the model has a static `builder` property set to a query builder class,
+     * it will be instantiated instead of the default driver query builder.
+     *
+     * @example
+     * ```typescript
+     * class UserQueryBuilder<T = User> extends MongoQueryBuilder<T> {
+     *   active() { return this.where("isActive", true); }
+     * }
+     *
+     * class User extends Model {
+     *   static builder = UserQueryBuilder;  // That's it! ✨
+     * }
+     *
+     * // Now User.query() returns UserQueryBuilder<User> with autocomplete!
+     * ```
+     */
+    static newQueryBuilder() {
+        const dataSource = this.getDataSource();
+        // Check if model has a custom builder class
+        if (this.builder) {
+            const BuilderClass = this.builder;
+            return new BuilderClass(this.table, dataSource);
+        }
+        // Use default driver query builder
+        const queryBuilder = dataSource.driver.queryBuilder(this.table);
+        return queryBuilder;
+    }
+    /**
+     * Get First matched record for the given filter
+     */
+    static async first(filter) {
+        const query = this.query();
+        if (filter) {
+            query.where(filter);
+        }
+        return query.first();
+    }
+    /**
+     * Get last matched record for the given filter
+     */
+    static async last(filter) {
+        const query = this.query();
+        if (filter) {
+            query.where(filter);
+        }
+        return query.last();
+    }
+    static where(...args) {
+        return this.query().where(...args);
+    }
+    /**
+     * Count the number of records in the table
+     * @param filter - The filter to apply to the query
+     */
+    static count(filter) {
+        const query = this.query();
+        if (filter) {
+            query.where(filter);
+        }
+        return query.count();
+    }
+    /**
+     * Find record by id
+     */
+    static async find(id) {
+        const query = this.query();
+        return query.where(this.primaryKey, id).first();
+    }
+    /**
+     * Get all records from the table
+     *
+     * @param filter - The filter to apply to the query
+     * @returns All records from the table
+     */
+    static async all(filter) {
+        const query = this.query();
+        if (filter) {
+            query.where(filter);
+        }
+        return query.get();
+    }
+    /**
+     * Get latest records from the table
+     *
+     * @param filter - The filter to apply to the query
+     */
+    static async latest(filter) {
+        const query = this.query();
+        if (filter) {
+            query.where(filter);
+        }
+        return (await query.latest());
+    }
+    /**
+     * Increment the given field by the given amount
+     *
+     * @example ```typescript
+     * // Increase age by 1 for user id 1
+     * User.increment({id: 1}, "age", 1);
+     * // Increase age by 1 and views by 2 for user id 1
+     * User.increment({id: 1}, {age: 1, views: 2});
+     * ```
+     */
+    static increase(filter, field, amount) {
+        const query = this.query().where(filter);
+        return query.increment(field, amount);
+    }
+    /**
+     * Decrement the given field by the given amount
+     * @example ```typescript
+     * // Decrease age by 1 for user id 1
+     * User.decrement({id: 1}, "age", 1);
+     * // Decrease age by 1 and views by 2 for user id 1
+     * User.decrement({id: 1}, {age: 1, views: 2});
+     * ```
+     */
+    static decrease(filter, field, amount) {
+        const query = this.query().where(filter);
+        return query.decrement(field, amount);
+    }
+    /**
+     * Perform atomic operation
+     */
+    static async atomic(filter, operations) {
+        const dataSource = this.getDataSource();
+        const result = await dataSource.driver.atomic(this.table, filter, operations);
+        return result.modifiedCount;
+    }
+    /**
+     * Destroy (delete) the current model instance from the database.
+     *
+     * Emits lifecycle events:
+     * - `deleting` - Before deletion
+     * - `deleted` - After successful deletion
+     *
+     * @param options - Destroy options (strategy override, skipEvents)
+     * @throws {Error} If the model is new (not saved) or if deletion fails
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find(1);
+     * await user.destroy(); // Uses default strategy
+     * await user.destroy({ strategy: "permanent" }); // Override strategy
+     * await user.destroy({ skipEvents: true }); // Silent delete
+     * ```
+     */
+    async destroy(options) {
+        const remover = new databaseRemover.DatabaseRemover(this);
+        return await remover.destroy(options);
+    }
+    /**
+     * Get the class constructor from an instance.
+     *
+     * This helper method allows instance methods to access static properties
+     * and methods of the model class in a type-safe way.
+     *
+     * @returns The model class constructor
+     *
+     * @example
+     * ```typescript
+     * const constructor = this.self();
+     * const table = constructor.table;
+     * await constructor.deleteOne({ id: 1 });
+     * ```
+     */
+    self() {
+        return this.constructor;
+    }
+    /**
+     * Creates an immutable clone of the model with its current state.
+     *
+     * The cloned model:
+     * - Contains a deep copy of all current data
+     * - Has frozen (immutable) data that cannot be modified
+     * - Preserves the `isNew` flag from the original
+     * - Has no dirty changes (clean state)
+     * - Cannot be saved or modified
+     *
+     * This is useful for:
+     * - Creating snapshots of model state
+     * - Passing read-only model data to other parts of the application
+     * - Preventing accidental mutations
+     * - Maintaining historical records
+     *
+     * @returns A new immutable model instance with the current state
+     *
+     * @example
+     * ```typescript
+     * const user = new User({ name: "Alice", email: "alice@example.com" });
+     * await user.save();
+     *
+     * // Create an immutable snapshot
+     * const snapshot = user.clone();
+     *
+     * // This will throw an error because the clone is immutable
+     * snapshot.set("name", "Bob"); // TypeError: Cannot assign to read only property
+     *
+     * // Original can still be modified
+     * user.set("name", "Bob");
+     * await user.save();
+     * ```
+     */
+    clone() {
+        // Deep copy the current data using JSON serialization
+        // This ensures nested objects are also copied
+        const clonedData = JSON.parse(JSON.stringify(this.data));
+        // Create a new instance of the same model class
+        const ModelClass = this.self();
+        const clonedModel = new ModelClass(clonedData);
+        // Preserve the isNew state
+        clonedModel.isNew = this.isNew;
+        // Freeze the data to make it immutable
+        // This recursively freezes all nested objects
+        this.deepFreeze(clonedModel.data);
+        // Reset the dirty tracker to have no changes
+        // The clone represents a clean snapshot
+        clonedModel.dirtyTracker.reset();
+        return clonedModel;
+    }
+    /**
+     * Recursively freezes an object and all its nested properties.
+     *
+     * @param obj - The object to freeze
+     * @returns The frozen object
+     * @private
+     */
+    deepFreeze(obj) {
+        // Freeze the object itself
+        Object.freeze(obj);
+        // Recursively freeze all properties
+        Object.getOwnPropertyNames(obj).forEach((prop) => {
+            const value = obj[prop];
+            // Only freeze objects and arrays, skip primitives and null
+            if (value !== null &&
+                (typeof value === "object" || typeof value === "function") &&
+                !Object.isFrozen(value)) {
+                this.deepFreeze(value);
+            }
+        });
+        return obj;
+    }
+    /**
+     * Get table name
+     */
+    getTableName() {
+        return this.self().table;
+    }
+    /**
+     * Get primary key name
+     */
+    getPrimaryKey() {
+        return this.self().primaryKey;
+    }
+    /**
+     * Get model schema
+     */
+    getSchema() {
+        return this.self().schema;
+    }
+    /**
+     * Check if schema has the given key
+     */
+    schemaHas(key) {
+        return this.self().schema?.schema[key] !== undefined;
+    }
+    /**
+     * Get strict mode
+     */
+    getStrictMode() {
+        return this.self().strictMode;
+    }
+    /**
+     * Get data source (Connection)
+     */
+    getConnection() {
+        return this.self().getDataSource();
+    }
+    /**
+     * Delete all matching documents from the table.
+     */
+    static async delete(filter) {
+        return await this.getDataSource().driver.deleteMany(this.table, filter);
+    }
+    /**
+     * Delete a single matching document from the table.
+     */
+    static async deleteOne(filter) {
+        return await this.getDataSource().driver.delete(this.table, filter);
+    }
+    /**
+     * Restore a single deleted record by its ID.
+     *
+     * Automatically detects whether the record was deleted via "trash" or "soft" strategy.
+     * Handles ID conflicts based on options.
+     *
+     * @param id - The primary key value of the record to restore
+     * @param options - Restorer options (onIdConflict, skipEvents)
+     * @returns The restored model instance
+     *
+     * @throws {Error} If record not found in trash or soft-deleted records
+     * @throws {Error} If ID conflict and onIdConflict is "fail"
+     *
+     * @example
+     * ```typescript
+     * // Restore with default options (assign new ID if conflict)
+     * const user = await User.restore(123);
+     *
+     * // Restore and fail if ID conflict
+     * const user = await User.restore(123, { onIdConflict: "fail" });
+     *
+     * // Silent restore (skip events)
+     * const user = await User.restore(123, { skipEvents: true });
+     * ```
+     */
+    static async restore(id, options) {
+        const restorer = new databaseRestorer.DatabaseRestorer(this);
+        const result = await restorer.restore(id, options);
+        if (!result.restoredRecord) {
+            throw new Error(`Failed to restore ${this.name} with ${this.primaryKey} ${id}: no record returned.`);
+        }
+        return result.restoredRecord;
+    }
+    /**
+     * Restore all deleted records for the model's table.
+     *
+     * Restores all records from the trash table (if using trash strategy)
+     * or all soft-deleted records (if using soft strategy).
+     *
+     * @param options - Restorer options (onIdConflict, skipEvents)
+     * @returns Array of restored model instances
+     *
+     * @example
+     * ```typescript
+     * // Restore all with default options
+     * const users = await User.restoreAll();
+     *
+     * // Restore all and fail on any ID conflict
+     * const users = await User.restoreAll({ onIdConflict: "fail" });
+     * ```
+     */
+    static async restoreAll(options) {
+        const restorer = new databaseRestorer.DatabaseRestorer(this);
+        const result = await restorer.restoreAll(options);
+        if (result.restoredCount === 0) {
+            return [];
+        }
+        return result.restoredRecords;
+    }
+    /**
+     * Create a new record in database and return the model instance.
+     *
+     * The data type is automatically inferred from the model's schema type.
+     *
+     * @param data - Partial data matching the model's schema type
+     * @returns The created model instance
+     *
+     * @example
+     * ```typescript
+     * // TypeScript automatically infers UserSchema from User model
+     * const user = await User.create({
+     *   name: "Alice",
+     *   email: "alice@example.com",
+     *   age: 30
+     * });
+     * // Type: User (with UserSchema inferred)
+     * ```
+     */
+    static async create(data) {
+        const model = new this(data);
+        await model.save();
+        return model;
+    }
+    /**
+     * Create many documents and return an array of created models
+     */
+    static async createMany(data) {
+        return await Promise.all(data.map((data) => this.create(data)));
+    }
+    /**
+     * Find a record or create it if not found.
+     *
+     * Does NOT update existing records - returns them as-is.
+     * Useful when you want to ensure a record exists without modifying it.
+     *
+     * @param filter - Conditions to find by
+     * @param data - Data to create if not found (merged with filter)
+     * @returns Promise resolving to found or created model
+     *
+     * @example
+     * ```typescript
+     * // Ensure default admin exists (don't modify if exists)
+     * const admin = await User.findOrCreate(
+     *   { email: "admin@example.com" },
+     *   { email: "admin@example.com", name: "Admin", role: "admin" }
+     * );
+     * // If admin exists, returns existing (password unchanged)
+     * // If not found, creates new admin
+     * ```
+     */
+    static async findOrCreate(filter, data) {
+        // Try to find existing record
+        const existing = await this.first(filter);
+        if (existing) {
+            return existing; // Return as-is, no update
+        }
+        // Create new record with merged data
+        return await this.create({ ...filter, ...data });
+    }
+    /**
+     * Update a record or create it if not found (upsert).
+     *
+     * DOES update existing records with new data.
+     * Useful when you want to ensure a record exists with the latest data.
+     *
+     * Includes full Model features:
+     * - ID generation (if creating)
+     * - createdAt timestamp (if creating)
+     * - updatedAt timestamp (always)
+     * - Validation & casting
+     * - Lifecycle events
+     * - Sync operations
+     *
+     * @param filter - Conditions to find by
+     * @param data - Data to update or create (merged with filter)
+     * @returns Promise resolving to updated or created model
+     *
+     * @example
+     * ```typescript
+     * // Sync user from external API (update if exists, create if not)
+     * const user = await User.updateOrCreate(
+     *   { externalId: "ext-123" },
+     *   {
+     *     externalId: "ext-123",
+     *     name: "John Updated",
+     *     email: "john.new@example.com",
+     *     lastSyncedAt: new Date()
+     *   }
+     * );
+     * // User always has latest data from API
+     * ```
+     */
+    static async updateOrCreate(filter, data) {
+        // Try to find existing record
+        const existing = await this.first(filter);
+        if (existing) {
+            // Update existing record
+            await existing.save({ merge: data });
+            return existing;
+        }
+        // Create new record with merged data
+        return await this.create({ ...filter, ...data });
+    }
+    /**
+     * Returns embedded data for sync operations.
+     * Excludes internal MongoDB fields and ensures proper date serialization.
+     *
+     * @returns Embedded data object suitable for syncing
+     *
+     * @example
+     * ```typescript
+     * const user = await User.find(1);
+     * const embedData = user.embedData;
+     * // Returns: { id: 1, name: "Alice", email: "alice@example.com", ... }
+     * // Excludes: _id
+     * ```
+     */
+    get embedData() {
+        return this.self().embed ? this.only(this.self().embed) : this.data;
+    }
+    /**
+     * Accesses the event emitter dedicated to this model constructor.
+     *
+     * Each model subclass gets its own isolated event emitter, allowing you to
+     * register lifecycle hooks that only apply to that specific model.
+     *
+     * @returns The ModelEvents instance for this model constructor
+     *
+     * @example
+     * ```typescript
+     * User.events().onSaving((user) => {
+     *   console.log("User is being saved:", user);
+     * });
+     * ```
+     */
+    static events() {
+        let events = modelEventsRegistry.get(this);
+        if (!events) {
+            events = new modelEvents.ModelEvents();
+            modelEventsRegistry.set(this, events);
+        }
+        return events;
+    }
+    /**
+     * Cleanup model events
+     */
+    static $cleanup() {
+        modelEventsRegistry.delete(this);
+        registerModel.removeModelFromRegistery(this.name);
+    }
+    /**
+     * Registers an event listener for this model constructor.
+     *
+     * Convenience shorthand for `Model.events().on(...)`.
+     *
+     * @param event - The event name (e.g., "saving", "created")
+     * @param listener - The callback to invoke when the event fires
+     * @returns An unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = User.on("saving", (user) => {
+     *   console.log("Saving user:", user);
+     * });
+     * ```
+     */
+    static on(event, listener) {
+        return this.events().on(event, listener);
+    }
+    /**
+     * Registers a one-time event listener for this model constructor.
+     *
+     * The listener will automatically unsubscribe after its first invocation.
+     * Convenience shorthand for `Model.events().once(...)`.
+     *
+     * @param event - The event name (e.g., "saving", "created")
+     * @param listener - The callback to invoke when the event fires
+     * @returns An unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * User.once("created", (user) => {
+     *   console.log("First user created:", user);
+     * });
+     * ```
+     */
+    static once(event, listener) {
+        return this.events().once(event, listener);
+    }
+    /**
+     * Removes an event listener from this model constructor.
+     *
+     * Convenience shorthand for `Model.events().off(...)`.
+     *
+     * @param event - The event name
+     * @param listener - The callback to remove
+     *
+     * @example
+     * ```typescript
+     * const listener = (user) => console.log(user);
+     * User.on("saving", listener);
+     * User.off("saving", listener);
+     * ```
+     */
+    static off(event, listener) {
+        this.events().off(event, listener);
+    }
+    /**
+     * Accesses the global event emitter shared by all model instances.
+     *
+     * Use this for cross-cutting concerns like auditing, logging, or injecting
+     * common fields (e.g., `createdBy`, `updatedBy`) across all models.
+     *
+     * @returns The global ModelEvents instance
+     *
+     * @example
+     * ```typescript
+     * Model.globalEvents().onSaving((model) => {
+     *   model.set("updatedAt", new Date());
+     * });
+     * ```
+     */
+    static globalEvents() {
+        return modelEvents.globalModelEvents;
+    }
+    /**
+     * Replace the model's data entirely.
+     *
+     * Used internally by the writer after validation to update the model
+     * with validated/casted data.
+     *
+     * **Warning:** This replaces all data and updates the dirty tracker.
+     * Use with caution in application code.
+     *
+     * @param data - New data to replace current data
+     *
+     * @example
+     * ```typescript
+     * // Internal usage by writer
+     * model.replaceData(validatedData);
+     * ```
+     */
+    replaceData(data) {
+        this.data = data;
+        this.dirtyTracker.replaceCurrentData(data);
+    }
+    /**
+     * Save the model to the database.
+     *
+     * Performs insert if `isNew === true`, otherwise performs update.
+     * Automatically validates, casts, generates IDs, and emits lifecycle events.
+     *
+     * **Features:**
+     * - Validation via @warlock.js/seal schema
+     * - Data casting (string → number, etc.)
+     * - ID generation (NoSQL only)
+     * - Partial updates (only changed fields)
+     * - Lifecycle events (validating, saving, created/updated, saved)
+     *
+     * @param data - Optional data to merge before saving
+     * @param options - Save options
+     * @returns The model instance for method chaining
+     *
+     * @throws {ValidationError} If validation fails
+     * @throws {Error} If database operation fails
+     *
+     * @example
+     * ```typescript
+     * // Simple save
+     * const user = new User({ name: "Alice" });
+     * await user.save();
+     *
+     * // Merge data before saving
+     * await user.save({ age: 31, email: "alice@example.com" });
+     *
+     * // Silent save (no events)
+     * await user.save(null, { skipEvents: true });
+     *
+     * // Skip validation
+     * await user.save(null, { skipValidation: true });
+     *
+     * // Method chaining
+     * await user.set("name", "Bob").save();
+     * ```
+     */
+    async save(options) {
+        if (options?.merge) {
+            this.merge(options.merge);
+        }
+        const writer = new databaseWriter.DatabaseWriter(this);
+        await writer.save(options);
+        return this;
+    }
+    /**
+     * Serialize the model data for storage in database
+     */
+    serialize() {
+        return this.self().getDataSource().driver.serialize(this.data);
+    }
+    /**
+     * Deseriaze the given data
+     */
+    static deserialize(data) {
+        const deserializedData = this.getDataSource().driver.deserialize(data);
+        const model = new this(deserializedData);
+        model.isNew = false;
+        return model;
+    }
+    /**
+     * Convert the model into JSON
+     */
+    toJSON() {
+        const resource = this.self().resource;
+        if (!resource) {
+            const toJsonColumns = this.self().toJsonColumns;
+            if (toJsonColumns && toJsonColumns.length > 0) {
+                return this.only(toJsonColumns);
+            }
+            return this.data;
+        }
+        const resourceColumns = this.self().resourceColumns;
+        const data = resourceColumns !== undefined && resourceColumns.length > 0
+            ? this.only(resourceColumns)
+            : this.data;
+        return new resource(data).toJSON();
+    }
+}exports.Model=Model;//# sourceMappingURL=model.js.map