@simonbackx/simple-database 1.33.0 → 1.35.0

package/dist/esm/src/classes/Model.d.ts

@@ -0,0 +1,159 @@
+import { Column } from './Column.js';
+import { type DatabaseStoredValue } from './DatabaseStoredValue.js';
+import { type ManyToManyRelation } from './ManyToManyRelation.js';
+import { type ManyToOneRelation } from './ManyToOneRelation.js';
+import { type OneToManyRelation } from './OneToManyRelation.js';
+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
+ */
+export 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[]>;
+}
+export type ModelEventType = 'created' | 'updated' | 'deleted';
+export 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;
+};
+export 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>;
+}
+export {};
+//# sourceMappingURL=Model.d.ts.map

package/dist/esm/src/classes/Model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../../../src/classes/Model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,KAAK,QAAQ,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC9H,KAAK,aAAa,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;CAAE,CAAC;AAE9F,KAAK,QAAQ,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE9D;;GAEG;AACH,qBAAa,aAAa,CAAC,KAAK;IAC5B,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;KAAE,EAAE,CAAC,CAAa;IAE3E,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC;IAUjD,cAAc,CAAC,KAAK,EAAE,GAAG;IAInB,SAAS,CAAC,KAAK,EAAE,KAAK;CAY/B;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AAE/D,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,CAAC;CACZ,GAAG;IACA,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,CAAC;IACT,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACnD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAEpD;;OAEG;IACH,WAAW,IAAI,CAAC,CAAC;CACpB,GAAG;IACA,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF,qBAAa,KAAK;IACd,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,aAAa,mCAAmC;IAEvD;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,KAAK,UAAS;IACrB,MAAM,CAAC,YAAY,UAAS;IAC5B,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;IAErD,gBAAgB,UAAS;IAEzB,eAAe;YACP,MAAM,mBAAmB;cACvB,MAAM,OAAO;OACjB;IAEN;;;OAGG;IACH,mBAAmB,cAAqB;;IAaxC;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM;IASzB;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAI7B;;OAEG;IACH,cAAc;IAId;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,SAAS,GAAE,MAAmB,GAAG,MAAM;IAI/D,MAAM,CAAC,oBAAoB,CAAC,SAAS,GAAE,MAAmB,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM;IAUzF;;;OAGG;IACH,cAAc,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EACrD,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,EAC/B,QAAQ,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,GACtC,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC;IAOhC;;;OAGG;IACH,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EACpD,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,EAC/B,QAAQ,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,GACtC,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC;IAK3B,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EAC1D,QAAQ,EAAE,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,EACvC,KAAK,EAAE,KAAK,GAAG,IAAI,GACpB,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,CAAC;IAYnC,WAAW,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EAAE,CAAC,SAAS,KAAK,EAAE,QAAQ,EAAE,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAUlJ;;OAEG;IACH,eAAe,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EACtD,QAAQ,EAAE,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EACvF,KAAK,EAAE,KAAK,EAAE,GACf,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;IAW9B;;OAEG;IACH,eAAe,CAAC,GAAG,SAAS,MAAM,GAAG,EAAE,KAAK,SAAS,KAAK,EACtD,QAAQ,EAAE,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GACxF,KAAK,EAAE,GAAG,IAAI;IAKjB;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAqBtH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE;IAUnJ,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE;IAuDzF,QAAQ,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;IAiB1C,IAAI,MAAM,IAAI,OAAO,KAAK,CAEzB;IAED,aAAa,IAAI,MAAM,GAAG,MAAM,GAAG,IAAI;IAIvC;;;OAGG;WACU,OAAO,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAYhH;;;OAGG;WACU,QAAQ,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAa/G,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;IAoGxE,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;IAkC7D;;;OAGG;WACU,KAAK,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE;QAC9E,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG;YAAE,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;YAAC,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAC,EAAE,CAAC;QACnF,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IA0C9B;;OAEG;WACU,GAAG,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAa7F;;OAEG;IACH,4BAA4B,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE;IAiCnG,UAAU;IASV;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAe5C,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAgIxB,MAAM;CA0Bf"}