@simonbackx/simple-database 1.35.0 → 1.36.3

package/dist/src/classes/Model.cjs

@@ -0,0 +1,459 @@
+const require_Database = require("./Database.cjs");
+//#region src/classes/Model.ts
+/**
+* Controls the fetching and decrypting of members
+*/
+var ModelEventBus = class {
+	listeners = /* @__PURE__ */ new Map();
+	addListener(owner, listener) {
+		const existing = this.listeners.get(owner);
+		if (existing) existing.push({ listener });
+		else this.listeners.set(owner, [{ listener }]);
+	}
+	removeListener(owner) {
+		this.listeners.delete(owner);
+	}
+	async sendEvent(value) {
+		const values = [];
+		for (const owner of this.listeners.values()) for (const listener of owner) {
+			const v = listener.listener(value);
+			if (v) values.push(v);
+		}
+		return await Promise.all(values);
+	}
+};
+var Model = class Model {
+	static primary;
+	static modelEventBus = new ModelEventBus();
+	/**
+	* Properties that are stored in the table (including foreign keys, but without mapped relations!)
+	*/
+	static columns;
+	static debug = false;
+	static showWarnings = false;
+	static table;
+	static relations;
+	existsInDatabase = false;
+	savedProperties = /* @__PURE__ */ new Map();
+	/**
+	* Sometimes we have skipUpdate properties that still should get saved on specific occasions.
+	* E.g. update updatedAt field manually if is the only changed field.
+	*/
+	forceSaveProperties = /* @__PURE__ */ new Set();
+	constructor() {
+		if (!this.static.relations) this.static.relations = [];
+		if (!this.static.columns) this.static.columns = /* @__PURE__ */ new Map();
+	}
+	/**
+	* Delete the value of a key from memory
+	*/
+	eraseProperty(key) {
+		if (!this.static.columns.get(key)) throw new Error("Unknown property " + key);
+		delete this[key];
+		this.savedProperties.delete(key);
+	}
+	/**
+	* Make sure this key will get saved on the next save, even when it is not changed or when it is skipUpdate
+	*/
+	forceSaveProperty(key) {
+		this.forceSaveProperties.add(key);
+	}
+	/**
+	* Mark all properties as changed, so they will get updated on the next save
+	*/
+	markAllChanged() {
+		this.savedProperties.clear();
+	}
+	/**
+	* Returns the default select to select the needed properties of this table
+	* @param namespace: optional namespace of this select
+	*/
+	static getDefaultSelect(namespace = this.table) {
+		return "`" + namespace + "`.*";
+	}
+	static selectColumnsWithout(namespace = this.table, ...exclude) {
+		const properties = Array.from(this.columns.keys()).flatMap((name) => exclude.includes(name) ? [] : [name]);
+		if (properties.length === 0) throw new Error("Not implemented yet");
+		return "`" + namespace + "`.`" + properties.join("`, `" + namespace + "`.`") + "`";
+	}
+	/**
+	* Set a relation to undefined, marking it as not loaded (so it won't get saved in the next save)
+	* @param relation
+	*/
+	unloadRelation(relation) {
+		const t = this;
+		delete t[relation.modelKey];
+		return t;
+	}
+	/**
+	* Set a relation to null, deleting it on the next save (unless unloadRelation is called)
+	* @param relation
+	*/
+	unsetRelation(relation) {
+		return this.setOptionalRelation(relation, null);
+	}
+	setOptionalRelation(relation, value) {
+		if (value !== null && !value.existsInDatabase) throw new Error("You cannot set a relation to a model that are not yet saved in the database.");
+		const t = this;
+		t[relation.modelKey] = value;
+		t[relation.foreignKey] = value ? value.getPrimaryKey() : null;
+		return t;
+	}
+	setRelation(relation, value) {
+		if (!value.existsInDatabase) throw new Error("You cannot set a relation to a model that are not yet saved in the database.");
+		const t = this;
+		t[relation.modelKey] = value;
+		t[relation.foreignKey] = value.getPrimaryKey();
+		return t;
+	}
+	/**
+	* Set a many relation. Note that this doesn't save the relation! You'll need to use the methods of the relation instead
+	*/
+	setManyRelation(relation, value) {
+		value.forEach((v) => {
+			if (!v.existsInDatabase) throw new Error("You cannot set a relation to models that are not yet saved in the database.");
+		});
+		const t = this;
+		t[relation.modelKey] = value;
+		return t;
+	}
+	/**
+	* Set a many relation. Note that this doesn't save the relation! You'll need to use the methods of the relation instead
+	*/
+	getManyRelation(relation) {
+		return this[relation.modelKey] ?? null;
+	}
+	/**
+	* Load the returned properties from a DB response row into the model
+	* If the row's primary key is null, undefined is returned
+	*/
+	static fromRow(row) {
+		if (row === void 0 || this.primary && (row[this.primary.name] === null || row[this.primary.name] === void 0)) return;
+		const model = new this();
+		for (const column of this.columns.values()) if (row[column.name] !== void 0) {
+			const value = column.from(row[column.name]);
+			model[column.name] = value;
+		} else model[column.name] = void 0;
+		model.markSaved(row, { fromMySQL: true });
+		return model;
+	}
+	static fromRows(rows, namespace) {
+		return rows.flatMap((row) => {
+			const model = this.fromRow(row[namespace]);
+			if (model) return [model];
+			return [];
+		});
+	}
+	markSaved(fields, options) {
+		this.existsInDatabase = true;
+		this.forceSaveProperties.clear();
+		for (const column of this.static.columns.values()) if ((fields ? fields[column.name] : this[column.name]) !== void 0) this.savedProperties.set(column.name, fields ? column.type === "json" && options?.fromMySQL ? {
+			to() {
+				if (this._to) return this._to;
+				const value = this._from ?? column.from(fields[column.name]);
+				this._from = value;
+				const found = column.to(value);
+				this._to = found;
+				return found;
+			},
+			from() {
+				if (this._from) return this._from;
+				const from = column.from(fields[column.name]);
+				this._from = from;
+				return from;
+			}
+		} : fields[column.name] : column.to(this[column.name]));
+		for (const relation of this.static.relations) if (relation.isLoaded(this)) if (relation.isSet(this)) {
+			const model = this[relation.modelKey];
+			this[relation.foreignKey] = model.getPrimaryKey();
+		} else this[relation.foreignKey] = null;
+	}
+	copyFrom(from) {
+		for (const column of this.static.columns.values()) this[column.name] = from[column.name];
+		for (const relation of this.static.relations) if (relation.isLoaded(this)) this[relation.modelKey] = void 0;
+		this.savedProperties = from.savedProperties;
+		this.forceSaveProperties = from.forceSaveProperties;
+		this.existsInDatabase = from.existsInDatabase;
+	}
+	get static() {
+		return this.constructor;
+	}
+	getPrimaryKey() {
+		return this[this.static.primary.name];
+	}
+	/**
+	* Get a model by its primary key
+	* @param id primary key
+	*/
+	static async getByID(id) {
+		const [rows] = await require_Database.Database.select(`SELECT ${this.getDefaultSelect()} FROM \`${this.table}\` WHERE \`${this.primary.name}\` = ? LIMIT 1`, [id]);
+		if (rows.length === 0) return;
+		const row = rows[0][this.table];
+		return this.fromRow(row);
+	}
+	/**
+	* Get multiple models by their ID
+	* @param ids primary key of the models you want to fetch
+	*/
+	static async getByIDs(...ids) {
+		if (ids.length === 0) return [];
+		const [rows] = await require_Database.Database.select(`SELECT ${this.getDefaultSelect()} FROM \`${this.table}\` WHERE \`${this.primary.name}\` IN (?) LIMIT ?`, [ids, ids.length]);
+		return this.fromRows(rows, this.table);
+	}
+	static buildWhereOperator(key, value) {
+		let whereQuery;
+		const params = [];
+		switch (value.sign) {
+			case "MATCH": {
+				let suffix = "";
+				if (value.mode) switch (value.mode) {
+					case "BOOLEAN":
+						suffix = " IN BOOLEAN MODE";
+						break;
+					default: throw new Error("Unknown match mode " + value.mode);
+				}
+				whereQuery = `MATCH(\`${this.table}\`.\`${key}\`) AGAINST(?${suffix})`;
+				params.push(value.value);
+				break;
+			}
+			case "LIKE":
+				whereQuery = `\`${this.table}\`.\`${key}\` LIKE ?`;
+				params.push(value.value);
+				break;
+			case "!=":
+				if (value.value === null) whereQuery = `\`${this.table}\`.\`${key}\` IS NOT NULL`;
+				else {
+					whereQuery = `\`${this.table}\`.\`${key}\` != ?`;
+					params.push(value.value);
+				}
+				break;
+			case "<":
+				whereQuery = `\`${this.table}\`.\`${key}\` < ?`;
+				params.push(value.value);
+				break;
+			case ">":
+				whereQuery = `\`${this.table}\`.\`${key}\` > ?`;
+				params.push(value.value);
+				break;
+			case "<=":
+				whereQuery = `\`${this.table}\`.\`${key}\` <= ?`;
+				params.push(value.value);
+				break;
+			case ">=":
+				whereQuery = `\`${this.table}\`.\`${key}\` >= ?`;
+				params.push(value.value);
+				break;
+			case "=":
+				if (value.value === null) whereQuery = `\`${this.table}\`.\`${key}\` IS NULL`;
+				else {
+					whereQuery = `\`${this.table}\`.\`${key}\` = ?`;
+					params.push(value.value);
+				}
+				break;
+			case "IN":
+				if (!Array.isArray(value.value)) throw new Error("Expected an array for IN where query");
+				if (value.value.includes(null)) {
+					const filtered = value.value.filter((v) => v !== null);
+					if (filtered.length === 0) whereQuery = `\`${this.table}\`.\`${key}\` IS NULL`;
+					else if (filtered.length === 1) {
+						whereQuery = `(\`${this.table}\`.\`${key}\` = ? OR \`${this.table}\`.\`${key}\` IS NULL)`;
+						params.push(filtered[0]);
+					} else {
+						whereQuery = `(\`${this.table}\`.\`${key}\` IN (?) OR \`${this.table}\`.\`${key}\` IS NULL)`;
+						params.push(filtered);
+					}
+				} else {
+					whereQuery = `\`${this.table}\`.\`${key}\` IN (?)`;
+					params.push(value.value);
+				}
+				break;
+			default: throw new Error("Sign not supported.");
+		}
+		return [whereQuery, params];
+	}
+	static buildWhereQuery(where) {
+		const whereQuery = [];
+		const params = [];
+		for (const key in where) if (Object.hasOwnProperty.call(where, key)) {
+			const value = where[key];
+			if (Array.isArray(value)) for (const v of value) {
+				const [w, p] = this.buildWhereOperator(key, v);
+				whereQuery.push(w);
+				params.push(...p);
+			}
+			else if (typeof value === "object" && value !== null && !(value instanceof Date)) {
+				const [w, p] = this.buildWhereOperator(key, value);
+				whereQuery.push(w);
+				params.push(...p);
+			} else if (value === null) whereQuery.push(`\`${this.table}\`.\`${key}\` IS NULL`);
+			else {
+				whereQuery.push(`\`${this.table}\`.\`${key}\` = ?`);
+				params.push(value);
+			}
+		}
+		return [whereQuery.join(" AND "), params];
+	}
+	/**
+	* @deprecated Use the new SQL package instead
+	* Get multiple models by a simple where
+	*/
+	static async where(where, extra) {
+		const params = [];
+		let query = `SELECT ${extra?.select ?? this.getDefaultSelect()} FROM \`${this.table}\``;
+		if (Object.keys(where).length !== 0) {
+			const [whereQuery, p] = this.buildWhereQuery(where);
+			query += `WHERE ` + whereQuery;
+			params.push(...p);
+		}
+		if (extra && extra.sort !== void 0) {
+			const sortQuery = [];
+			for (const item of extra.sort) if (typeof item === "string") sortQuery.push(require_Database.Database.escapeId(item) + " ASC");
+			else if (typeof item.column === "string") sortQuery.push(require_Database.Database.escapeId(item.column) + " " + (item.direction ?? "ASC"));
+			else {
+				const [w, p] = this.buildWhereQuery(item.column);
+				sortQuery.push("(" + w + ") " + (item.direction ?? "ASC"));
+				params.push(...p);
+			}
+			query += ` ORDER BY ` + sortQuery.join(", ");
+		}
+		if (extra && extra.limit !== void 0) {
+			query += ` LIMIT ?`;
+			params.push(extra.limit);
+		}
+		const [rows] = await require_Database.Database.select(query, params);
+		return this.fromRows(rows, this.table);
+	}
+	/**
+	* Get multiple models by a simple where
+	*/
+	static async all(limit) {
+		const params = [];
+		let query = `SELECT ${this.getDefaultSelect()} FROM \`${this.table}\``;
+		if (limit) {
+			query += ` LIMIT ?`;
+			params.push(limit);
+		}
+		const [rows] = await require_Database.Database.select(query, params);
+		return this.fromRows(rows, this.table);
+	}
+	/**
+	* Return an object of all the properties that are changed and their database representation
+	*/
+	getChangedDatabaseProperties() {
+		const set = {};
+		let skipUpdate = 0;
+		for (const column of this.static.columns.values()) {
+			if (column.primary && column.type === "integer" && this.static.primary.name === "id") continue;
+			if (!this.existsInDatabase && this[column.name] === void 0) throw new Error("Tried to create model " + this.constructor.name + " with undefined property " + column.name);
+			if (this[column.name] !== void 0) {
+				const forceSave = this.forceSaveProperties.has(column.name);
+				const oldSavedValue = forceSave ? void 0 : this.savedProperties.get(column.name);
+				const saveValue = forceSave ? null : column.to(this[column.name]);
+				if (forceSave || oldSavedValue === void 0 || column.isChanged(typeof oldSavedValue === "object" && oldSavedValue !== null && "to" in oldSavedValue ? oldSavedValue.to() : oldSavedValue, saveValue)) {
+					set[column.name] = forceSave ? column.to(this[column.name]) : saveValue;
+					if (column.skipUpdate && !forceSave) skipUpdate++;
+				}
+			}
+		}
+		return {
+			fields: set,
+			skipUpdate
+		};
+	}
+	beforeSave() {
+		for (const column of this.static.columns.values()) if (column.beforeSave) this[column.name] = column.beforeSave.call(this, this[column.name]);
+	}
+	/**
+	* Return original value from the database or undefined if not known
+	*/
+	getOriginalValue(key) {
+		const column = this.static.columns.get(key);
+		if (!column) throw new Error("Unknown property " + key);
+		const c = this.savedProperties.get(key);
+		if (c === void 0) return;
+		if (typeof c === "object" && c !== null && "from" in c) return c.from();
+		return column.from(c);
+	}
+	async save() {
+		if (!this.static.table) throw new Error("Table name not set");
+		if (!this.static.primary) throw new Error("Primary key not set for model " + this.constructor.name + " " + this.static);
+		for (const relation of this.static.relations) if (relation.isLoaded(this)) {
+			if (relation.isSet(this)) {
+				const model = this[relation.modelKey];
+				if (!model.existsInDatabase) throw new Error("You cannot set a relation that is not yet saved in the database.");
+				if (this[relation.foreignKey] !== model.getPrimaryKey()) throw new Error("You cannot modify the value of a foreign key when the relation is loaded. Unload the relation first or modify the relation with setRelation");
+			} else if (this[relation.foreignKey] !== null) throw new Error("You cannot set a foreign key when the relation is loaded. Unload the relation first or modify the relation with setRelation");
+		}
+		const id = this.getPrimaryKey();
+		if (!id) {
+			if (this.existsInDatabase) throw new Error("Model " + this.constructor.name + " was loaded from the Database, but didn't select the ID. Saving not possible.");
+		} else if (!this.existsInDatabase && this.static.primary.type === "integer" && this.static.primary.name === "id") throw new Error(`PrimaryKey was set programmatically without fetching the model ${this.constructor.name} from the database. This is not allowed for integer primary keys.`);
+		this.beforeSave();
+		const { fields, skipUpdate } = this.getChangedDatabaseProperties();
+		if (Object.keys(fields).length === 0) {
+			if (Model.showWarnings) console.warn("Tried to update model without any properties modified");
+			return false;
+		}
+		if (this.existsInDatabase && skipUpdate === Object.keys(fields).length) {
+			if (Model.showWarnings) console.warn("Tried to update model without any properties modified");
+			return false;
+		}
+		if (Model.debug) console.log("Saving " + this.constructor.name + " to...", fields);
+		if (!this.existsInDatabase) {
+			if (Model.debug) console.log(`Creating new ${this.constructor.name}`);
+			const [result] = await require_Database.Database.insert("INSERT INTO `" + this.static.table + "` SET ?", [fields]);
+			if (this.static.primary.type === "integer" && this.static.primary.name === "id") {
+				this[this.static.primary.name] = result.insertId;
+				fields[this.static.primary.name] = result.insertId;
+				if (Model.debug) console.log(`New id = ${this[this.static.primary.name]}`);
+			}
+		} else {
+			if (Model.debug) console.log(`Updating ${this.constructor.name} where ${this.static.primary.name} = ${id}`);
+			const [result] = await require_Database.Database.update("UPDATE `" + this.static.table + "` SET ? WHERE `" + this.static.primary.name + "` = ?", [fields, id]);
+			if (result.changedRows !== 1 && Model.showWarnings) console.warn(`Updated ${this.constructor.name}, but it didn't change a row. Check if ID exists.`);
+		}
+		if (this.existsInDatabase) {
+			const originalProperties = Object.fromEntries(Array.from(this.savedProperties.entries()).map(([key, value]) => {
+				if (typeof value === "object" && value !== null && "to" in value) return [key, value.to()];
+				return [key, value];
+			}));
+			this.markSaved(fields);
+			await this.static.modelEventBus.sendEvent({
+				type: "updated",
+				model: this,
+				changedFields: fields,
+				originalFields: originalProperties,
+				getOldModel: () => {
+					const v = this.static.fromRow(originalProperties);
+					if (v === void 0) throw new Error("Failed to create old model: primary key might be missing");
+					return v;
+				}
+			});
+		} else {
+			this.markSaved(fields);
+			await this.static.modelEventBus.sendEvent({
+				type: "created",
+				model: this
+			});
+		}
+		return true;
+	}
+	async delete() {
+		const id = this.getPrimaryKey();
+		if (!id && this.existsInDatabase) throw new Error("Model " + this.constructor.name + " was loaded from the Database, but didn't select the ID. Deleting not possible.");
+		if (!id || !this.existsInDatabase) throw new Error("Model " + this.constructor.name + " can't be deleted if it doesn't exist in the database already");
+		if (Model.debug) console.log(`Deleting ${this.constructor.name} where ${this.static.primary.name} = ${id}`);
+		const [result] = await require_Database.Database.delete("DELETE FROM `" + this.static.table + "` WHERE `" + this.static.primary.name + "` = ?", [id]);
+		if (result.affectedRows !== 1 && Model.showWarnings) console.warn(`Deleted ${this.constructor.name}, but it didn't change a row. Check if ID exists.`);
+		this.existsInDatabase = false;
+		if (this.static.primary.type === "integer" && this.static.primary.name === "id") this.eraseProperty(this.static.primary.name);
+		this.savedProperties.clear();
+		await this.static.modelEventBus.sendEvent({
+			type: "deleted",
+			model: this
+		});
+	}
+};
+//#endregion
+exports.Model = Model;
+exports.ModelEventBus = ModelEventBus;

package/dist/src/classes/Model.d.cts

@@ -0,0 +1,162 @@
+import { DatabaseStoredValue } from "./DatabaseStoredValue.cjs";
+import { Column } from "./Column.cjs";
+import { ManyToOneRelation } from "./ManyToOneRelation.cjs";
+import { OneToManyRelation } from "./OneToManyRelation.cjs";
+import { ManyToManyRelation } from "./ManyToManyRelation.cjs";
+
+//#region src/classes/Model.d.ts
+type SQLWhere = {
+  sign: string;
+  value: string | Date | number | null | (string | null)[] | (number | null)[];
+  mode?: string;
+};
+type SQLWhereQuery = {
+  [key: string]: string | Date | number | null | SQLWhere | SQLWhere[];
+};
+type Listener<Value> = (value: Value) => Promise<void> | void;
+/**
+ * Controls the fetching and decrypting of members
+ */
+declare class ModelEventBus<Value> {
+  protected listeners: Map<any, {
+    listener: Listener<Value>;
+  }[]>;
+  addListener(owner: any, listener: Listener<Value>): void;
+  removeListener(owner: any): void;
+  sendEvent(value: Value): Promise<void[]>;
+}
+type ModelEventType = 'created' | 'updated' | 'deleted';
+type ModelEvent<M extends Model = Model> = {
+  type: 'created';
+  model: M;
+} | {
+  type: 'updated';
+  model: M;
+  changedFields: Record<string, DatabaseStoredValue>;
+  originalFields: Record<string, DatabaseStoredValue>;
+  /**
+   * Use this method to compare changes
+   */
+  getOldModel(): M;
+} | {
+  type: 'deleted';
+  model: M;
+};
+declare class Model {
+  static primary: Column;
+  static modelEventBus: ModelEventBus<ModelEvent<Model>>;
+  /**
+   * Properties that are stored in the table (including foreign keys, but without mapped relations!)
+   */
+  static columns: Map<string, Column>;
+  static debug: boolean;
+  static showWarnings: boolean;
+  static table: string;
+  static relations: ManyToOneRelation<string, Model>[];
+  existsInDatabase: boolean;
+  savedProperties: Map<string, DatabaseStoredValue | {
+    to: () => DatabaseStoredValue;
+    from: () => unknown;
+  }>;
+  /**
+   * Sometimes we have skipUpdate properties that still should get saved on specific occasions.
+   * E.g. update updatedAt field manually if is the only changed field.
+   */
+  forceSaveProperties: Set<string>;
+  constructor();
+  /**
+   * Delete the value of a key from memory
+   */
+  eraseProperty(key: string): void;
+  /**
+   * Make sure this key will get saved on the next save, even when it is not changed or when it is skipUpdate
+   */
+  forceSaveProperty(key: string): void;
+  /**
+   * Mark all properties as changed, so they will get updated on the next save
+   */
+  markAllChanged(): void;
+  /**
+   * Returns the default select to select the needed properties of this table
+   * @param namespace: optional namespace of this select
+   */
+  static getDefaultSelect(namespace?: string): string;
+  static selectColumnsWithout(namespace?: string, ...exclude: string[]): string;
+  /**
+   * Set a relation to undefined, marking it as not loaded (so it won't get saved in the next save)
+   * @param relation
+   */
+  unloadRelation<Key extends keyof any, Value extends Model>(this: this & Record<Key, Value>, relation: ManyToOneRelation<Key, any>): this & Record<Key, undefined>;
+  /**
+   * Set a relation to null, deleting it on the next save (unless unloadRelation is called)
+   * @param relation
+   */
+  unsetRelation<Key extends keyof any, Value extends Model>(this: this & Record<Key, Value>, relation: ManyToOneRelation<Key, any>): this & Record<Key, null>;
+  setOptionalRelation<Key extends keyof any, Value extends Model>(relation: ManyToOneRelation<Key, Value>, value: Value | null): this & Record<Key, Value | null>;
+  setRelation<Key extends keyof any, Value extends Model, V extends Value>(relation: ManyToOneRelation<Key, Value>, value: V): this & Record<Key, V>;
+  /**
+   * Set a many relation. Note that this doesn't save the relation! You'll need to use the methods of the relation instead
+   */
+  setManyRelation<Key extends keyof any, Value extends Model>(relation: ManyToManyRelation<Key, any, Value, any> | OneToManyRelation<Key, any, Value>, value: Value[]): this & Record<Key, Value[]>;
+  /**
+   * Set a many relation. Note that this doesn't save the relation! You'll need to use the methods of the relation instead
+   */
+  getManyRelation<Key extends keyof any, Value extends Model>(relation: ManyToManyRelation<Key, any, Value, any> | OneToManyRelation<Key, any, Value>): Value[] | null;
+  /**
+   * Load the returned properties from a DB response row into the model
+   * If the row's primary key is null, undefined is returned
+   */
+  static fromRow<T extends typeof Model>(this: T, row: Record<string, DatabaseStoredValue>): InstanceType<T> | undefined;
+  static fromRows<T extends typeof Model>(this: T, rows: Record<string, Record<string, DatabaseStoredValue>>[], namespace: string): InstanceType<T>[];
+  markSaved(fields?: Record<string, DatabaseStoredValue>, options?: {
+    fromMySQL?: boolean;
+  }): void;
+  copyFrom<T extends Model>(this: T, from: T): void;
+  get static(): typeof Model;
+  getPrimaryKey(): number | string | null;
+  /**
+   * Get a model by its primary key
+   * @param id primary key
+   */
+  static getByID<T extends typeof Model>(this: T, id: number | string): Promise<InstanceType<T> | undefined>;
+  /**
+   * Get multiple models by their ID
+   * @param ids primary key of the models you want to fetch
+   */
+  static getByIDs<T extends typeof Model>(this: T, ...ids: (number | string)[]): Promise<InstanceType<T>[]>;
+  static buildWhereOperator(key: string, value: SQLWhere): [string, any[]];
+  static buildWhereQuery(where: SQLWhereQuery): [string, any[]];
+  /**
+   * @deprecated Use the new SQL package instead
+   * Get multiple models by a simple where
+   */
+  static where<T extends typeof Model>(this: T, where: SQLWhereQuery, extra?: {
+    limit?: number;
+    sort?: (string | {
+      column: string | SQLWhereQuery;
+      direction?: 'ASC' | 'DESC';
+    })[];
+    select?: string;
+  }): Promise<InstanceType<T>[]>;
+  /**
+   * Get multiple models by a simple where
+   */
+  static all<T extends typeof Model>(this: T, limit?: number): Promise<InstanceType<T>[]>;
+  /**
+   * Return an object of all the properties that are changed and their database representation
+   */
+  getChangedDatabaseProperties(): {
+    fields: Record<string, DatabaseStoredValue>;
+    skipUpdate: number;
+  };
+  beforeSave(): void;
+  /**
+   * Return original value from the database or undefined if not known
+   */
+  getOriginalValue(key: string): unknown | undefined;
+  save(): Promise<boolean>;
+  delete(): Promise<void>;
+}
+//#endregion
+export { Model, ModelEvent, ModelEventBus, ModelEventType };
+//# sourceMappingURL=Model.d.cts.map

package/dist/src/classes/Model.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Model.d.cts","names":[],"sources":["../../../src/classes/Model.ts"],"mappings":";;;;;;;KAQK,QAAA;EAAa,IAAA;EAAc,KAAA,WAAgB,IAAA;EAA8D,IAAA;AAAA;AAAA,KACzG,aAAA;EAAA,CAAmB,GAAA,oBAAuB,IAAA,mBAAuB,QAAA,GAAW,QAAA;AAAA;AAAA,KAE5E,QAAA,WAAmB,KAAA,EAAO,KAAA,KAAU,OAAA;;;;cAK5B,aAAA;EAAA,UACC,SAAA,EAAW,GAAA;IAAW,QAAA,EAAU,QAAA,CAAS,KAAA;EAAA;EAEnD,WAAA,CAAY,KAAA,OAAY,QAAA,EAAU,QAAA,CAAS,KAAA;EAU3C,cAAA,CAAe,KAAA;EAIT,SAAA,CAAU,KAAA,EAAO,KAAA,GAAK,OAAA;AAAA;AAAA,KAcpB,cAAA;AAAA,KAEA,UAAA,WAAqB,KAAA,GAAQ,KAAA;EACrC,IAAA;EACA,KAAA,EAAO,CAAA;AAAA;EAEP,IAAA;EACA,KAAA,EAAO,CAAA;EACP,aAAA,EAAe,MAAA,SAAe,mBAAA;EAC9B,cAAA,EAAgB,MAAA,SAAe,mBAAA;EA7Ca;;;EAkD5C,WAAA,IAAe,CAAA;AAAA;EAEf,IAAA;EACA,KAAA,EAAO,CAAA;AAAA;AAAA,cAGE,KAAA;EAAA,OACF,OAAA,EAAS,MAAA;EAAA,OACT,aAAA,EAAa,aAAA,CAAA,UAAA,CAAA,KAAA;EApDsB;;;EAAA,OAyDnC,OAAA,EAAS,GAAA,SAAY,MAAA;EAAA,OACrB,KAAA;EAAA,OACA,YAAA;EAAA,OACA,KAAA;EAAA,OACA,SAAA,EAAW,iBAAA,SAA0B,KAAA;EAE5C,gBAAA;EAEA,eAAA,EAAe,GAAA,SAAA,mBAAA;cACD,mBAAA;;;EAlEqC;;;;EA0EnD,mBAAA,EAAmB,GAAA;;EA9DnB;;;EA8EA,aAAA,CAAc,GAAA;EA1EE;;;EAsFhB,iBAAA,CAAkB,GAAA;EAxEV;;;EA+ER,cAAA,CAAA;EA/EsB;AAE1B;;;EAF0B,OAuFf,gBAAA,CAAiB,SAAA;EAAA,OAIjB,oBAAA,CAAqB,SAAA,cAAmC,OAAA;EAvFxD;;;;EAqGP,cAAA,sCAAoD,KAAA,CAAA,CAChD,IAAA,SAAa,MAAA,CAAO,GAAA,EAAK,KAAA,GACzB,QAAA,EAAU,iBAAA,CAAkB,GAAA,gBACtB,MAAA,CAAO,GAAA;EAnGD;;;;EA8GhB,aAAA,sCAAmD,KAAA,CAAA,CAC/C,IAAA,SAAa,MAAA,CAAO,GAAA,EAAK,KAAA,GACzB,QAAA,EAAU,iBAAA,CAAkB,GAAA,gBACtB,MAAA,CAAO,GAAA;EAKjB,mBAAA,sCAAyD,KAAA,CAAA,CACrD,QAAA,EAAU,iBAAA,CAAkB,GAAA,EAAK,KAAA,GACjC,KAAA,EAAO,KAAA,iBACD,MAAA,CAAO,GAAA,EAAK,KAAA;EAYtB,WAAA,sCAAiD,KAAA,YAAiB,KAAA,CAAA,CAAO,QAAA,EAAU,iBAAA,CAAkB,GAAA,EAAK,KAAA,GAAQ,KAAA,EAAO,CAAA,UAAW,MAAA,CAAO,GAAA,EAAK,CAAA;EA5I3G;;;EAyJrC,eAAA,sCAAqD,KAAA,CAAA,CACjD,QAAA,EAAU,kBAAA,CAAmB,GAAA,OAAU,KAAA,SAAc,iBAAA,CAAkB,GAAA,OAAU,KAAA,GACjF,KAAA,EAAO,KAAA,YACD,MAAA,CAAO,GAAA,EAAK,KAAA;EAxJtB;;;EAsKA,eAAA,sCAAqD,KAAA,CAAA,CACjD,QAAA,EAAU,kBAAA,CAAmB,GAAA,OAAU,KAAA,SAAc,iBAAA,CAAkB,GAAA,OAAU,KAAA,IAClF,KAAA;EAtKY;;;;EAAA,OA+KR,OAAA,kBAAyB,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,GAAA,EAAK,MAAA,SAAe,mBAAA,IAAuB,YAAA,CAAa,CAAA;EAAA,OAqBjG,QAAA,kBAA0B,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,IAAA,EAAM,MAAA,SAAe,MAAA,SAAe,mBAAA,MAAyB,SAAA,WAAoB,YAAA,CAAa,CAAA;EAU/I,SAAA,CAAU,MAAA,GAAS,MAAA,SAAe,mBAAA,GAAsB,OAAA;IAAY,SAAA;EAAA;EAuDpE,QAAA,WAAmB,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,IAAA,EAAM,CAAA;EAAA,IAiBrC,MAAA,CAAA,UAAiB,KAAA;EAIrB,aAAA,CAAA;EA9QS;;;;EAAA,OAsRI,OAAA,kBAAyB,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,EAAA,oBAAsB,OAAA,CAAQ,YAAA,CAAa,CAAA;EApR7E;;;;EAAA,OAoSP,QAAA,kBAA0B,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,KAAM,GAAA,wBAA2B,OAAA,CAAQ,YAAA,CAAa,CAAA;EAAA,OAanG,kBAAA,CAAmB,GAAA,UAAa,KAAA,EAAO,QAAA;EAAA,OAoGvC,eAAA,CAAgB,KAAA,EAAO,aAAA;EAvYhB;;;;EAAA,OA6aD,KAAA,kBAAuB,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,KAAA,EAAO,aAAA,EAAe,KAAA;IACtE,KAAA;IACA,IAAA;MAAmB,MAAA,WAAiB,aAAA;MAAe,SAAA;IAAA;IACnD,MAAA;EAAA,IACA,OAAA,CAAQ,YAAA,CAAa,CAAA;EA7VD;;;EAAA,OA0YX,GAAA,kBAAqB,KAAA,CAAA,CAAO,IAAA,EAAM,CAAA,EAAG,KAAA,YAAiB,OAAA,CAAQ,YAAA,CAAa,CAAA;EAzY1E;;;EAyZd,4BAAA,CAAA;IAAkC,MAAA,EAAQ,MAAA,SAAe,mBAAA;IAAsB,UAAA;EAAA;EAiC/E,UAAA,CAAA;EAjbiB;;;EA6bjB,gBAAA,CAAiB,GAAA;EAeX,IAAA,CAAA,GAAQ,OAAA;EAgIR,MAAA,CAAA,GAAM,OAAA;AAAA"}