stabilize-orm 1.3.8 → 2.1.0

package/dist/repository.d.ts

@@ -0,0 +1,165 @@
+/**
+ * @file repository.ts
+ * @description Provides a data access layer for a specific model, handling all CRUD operations.
+ * @author ElectronSz
+ */
+import { DBClient } from "./client";
+import { type Logger } from "./logger";
+import { QueryBuilder } from "./query-builder";
+import { type CacheConfig } from "./types";
+export declare class Repository<T> {
+    private client;
+    private cache;
+    private table;
+    private columns;
+    private validators;
+    private relations;
+    private softDeleteField;
+    private logger;
+    private versioned;
+    private historyTable;
+    private model;
+    private optimisticLockField;
+    private timestampsConfig;
+    constructor(client: DBClient, model: new (...args: any[]) => T, cacheConfig?: CacheConfig, logger?: Logger);
+    private getOptimisticLockField;
+    private getDBType;
+    private validate;
+    private runHooks;
+    find(): QueryBuilder<T>;
+    scope(name: string, ...args: any[]): QueryBuilder<T>;
+    findOne(id: number | string, options?: {
+        relations?: string[];
+    }, _client?: DBClient): Promise<T | null>;
+    asOf(id: number | string, asOfDate: Date, _client?: DBClient): Promise<T | null>;
+    history(id: number | string, _client?: DBClient): Promise<T[]>;
+    rollback(id: number | string, version: number, _client?: DBClient): Promise<T>;
+    private writeHistory;
+    create(entity: Partial<T>, options?: {
+        relations?: string[];
+    }): Promise<T>;
+    private _create;
+    bulkCreate(entities: Partial<T>[], options?: {
+        relations?: string[];
+        batchSize?: number;
+    }): Promise<T[]>;
+    private _bulkCreate;
+    update(id: number | string, entity: Partial<T>): Promise<T>;
+    private _update;
+    bulkUpdate(updates: {
+        where: {
+            condition: string;
+            params: any[];
+        };
+        set: Partial<T>;
+    }[], options?: {
+        batchSize?: number;
+    }): Promise<void>;
+    private _bulkUpdate;
+    upsert(entity: Partial<T>, keys: string[]): Promise<T>;
+    private _upsert;
+    delete(id: number | string): Promise<void>;
+    private _delete;
+    bulkDelete(ids: (number | string)[], options?: {
+        batchSize?: number;
+    }): Promise<void>;
+    private _bulkDelete;
+    recover(id: number | string): Promise<T>;
+    private _recover;
+    rawQuery<R = T>(query: string, params?: any[]): Promise<R[]>;
+    private loadRelation;
+    private loadNestedRelations;
+    paginate(page: number, pageSize: number, options?: any): Promise<{
+        data: T[];
+        total: number;
+        page: number;
+        pageSize: number;
+    }>;
+    private processForSave;
+    private processForLoad;
+    findAndCount(options?: {
+        relations?: string[];
+    }): Promise<{
+        data: T[];
+        total: number;
+    }>;
+    findOneBy(conditions: Partial<T>, options?: {
+        relations?: string[];
+    }, _client?: DBClient): Promise<T | null>;
+    findBy(conditions: Partial<T>, options?: {
+        relations?: string[];
+        limit?: number;
+        orderBy?: string;
+    }): Promise<T[]>;
+    count(conditions?: Partial<T>): Promise<number>;
+    findAndCountAll(options?: {
+        page?: number;
+        pageSize?: number;
+        conditions?: Partial<T>;
+    }): Promise<{
+        data: T[];
+        total: number;
+    }>;
+    toJSON(entity: T): Record<string, any>;
+    aggregate(options: {
+        count?: string | string[];
+        sum?: string[];
+        avg?: string[];
+        min?: string[];
+        max?: string[];
+    }): Promise<Record<string, any>>;
+    findMany(options?: {
+        where?: Partial<T>;
+        cursor?: {
+            field: string;
+            value: any;
+            direction?: "forward" | "backward";
+        };
+        take?: number;
+        skip?: number;
+        orderBy?: {
+            field: string;
+            direction: "ASC" | "DESC";
+        };
+        relations?: string[];
+    }): Promise<T[]>;
+    bulkUpsert(entities: Partial<T>[], keys: string[]): Promise<T[]>;
+    exists(conditions?: Partial<T>): Promise<boolean>;
+    recoverAll(): Promise<number>;
+    truncate(): Promise<void>;
+    seed(data: Partial<T>[], options?: {
+        ignoreDuplicates?: boolean;
+    }): Promise<T[]>;
+    healthCheck(): Promise<{
+        status: string;
+        table: string;
+        rows: number;
+        latencyMs: number;
+    }>;
+    countDistinct(column: string): Promise<number>;
+    increment(id: number | string, field: string, amount?: number): Promise<T>;
+    decrement(id: number | string, field: string, amount?: number): Promise<T>;
+    pluck<K extends keyof T>(column: K): Promise<any[]>;
+    selectColumns(...columns: (keyof T)[]): Promise<Partial<T>[]>;
+    toggle(id: number | string, field: string): Promise<T>;
+    updateBy(conditions: Partial<T>, updates: Partial<T>): Promise<number>;
+    deleteBy(conditions: Partial<T>): Promise<number>;
+    restoreBy(conditions: Partial<T>): Promise<number>;
+    findDeleted(): QueryBuilder<T>;
+    withTrashed(): QueryBuilder<T>;
+    upsertMany(entities: Partial<T>[], keys: string[], batchSize?: number): Promise<T[]>;
+    map<R>(query: QueryBuilder<T>, transform: (item: T) => R): Promise<R[]>;
+    each(query: QueryBuilder<T>, callback: (item: T, index: number) => void | Promise<void>, pageSize?: number): Promise<void>;
+    eachBatch(query: QueryBuilder<T>, callback: (batch: T[]) => void | Promise<void>, batchSize?: number): Promise<void>;
+    lockForUpdate(id: number | string, _client?: DBClient): Promise<T | null>;
+    firstOrCreate(conditions: Partial<T>, defaults?: Partial<T>): Promise<T>;
+    updateOrCreate(conditions: Partial<T>, updates: Partial<T>): Promise<T>;
+    first(conditions?: Partial<T>): Promise<T | null>;
+    last(field?: string): Promise<T | null>;
+    random(): Promise<T | null>;
+    hasColumn(field: string): boolean;
+    getTableName(): string;
+    getSoftDeleteField(): string | null;
+    getIsVersioned(): boolean;
+}
+//# sourceMappingURL=repository.d.ts.map

package/dist/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../repository.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAmB,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAKL,KAAK,WAAW,EACjB,MAAM,SAAS,CAAC;AAOjB,qBAAa,UAAU,CAAC,CAAC;IACvB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAWb;IACF,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,SAAS,CASf;IACF,OAAO,CAAC,eAAe,CAAgB;IACvC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,KAAK,CAA4B;IACzC,OAAO,CAAC,mBAAmB,CAAgB;IAC3C,OAAO,CAAC,gBAAgB,CAAoD;gBAG1E,MAAM,EAAE,QAAQ,EAChB,KAAK,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAChC,WAAW,GAAE,WAAyC,EACtD,MAAM,GAAE,MAA8B;IAoCxC,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,QAAQ;YAwDF,QAAQ;IAMtB,IAAI,IAAI,YAAY,CAAC,CAAC,CAAC;IAQvB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;IAK9C,OAAO,CACX,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,EACtC,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAyBd,IAAI,CACR,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,QAAQ,EAAE,IAAI,EACd,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAWd,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAU9D,QAAQ,CACZ,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,CAAC;YAgCC,YAAY;IAoEpB,MAAM,CACV,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAClB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GACrC,OAAO,CAAC,CAAC,CAAC;YAkBC,OAAO;IA8Ef,UAAU,CACd,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EACtB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACzD,OAAO,CAAC,CAAC,EAAE,CAAC;YA0BD,WAAW;IAoFnB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YA4BnD,OAAO;IA8Ef,UAAU,CACd,OAAO,EAAE;QAAE,KAAK,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,GAAG,EAAE,CAAA;SAAE,CAAC;QAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KAAE,EAAE,EAC3E,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACnC,OAAO,CAAC,IAAI,CAAC;YAMF,WAAW;IA4EnB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;YAM9C,OAAO;IAkIf,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAalC,OAAO;IAsBf,UAAU,CACd,GAAG,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EACxB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACnC,OAAO,CAAC,IAAI,CAAC;YAMF,WAAW;IA0CnB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;YAIhC,QAAQ;IAmChB,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;YAUxD,YAAY;YAoCZ,mBAAmB;IAoD3B,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,GAAQ,GAChB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAgBxE,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,cAAc;IAgBhB,YAAY,CAChB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GACrC,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAclC,SAAS,CACb,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,EACtC,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAqBd,MAAM,CACV,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GACvE,OAAO,CAAC,CAAC,EAAE,CAAC;IAqBT,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAiB/C,eAAe,CAAC,OAAO,CAAC,EAAE;QAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;KACzB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IA2BzC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAWhC,SAAS,CAAC,OAAO,EAAE;QACvB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;KAChB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAwD1B,QAAQ,CACZ,OAAO,GAAE;QACP,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,GAAG,CAAC;YACX,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;SACpC,CAAC;QACF,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAC;QACvD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,GACL,OAAO,CAAC,CAAC,EAAE,CAAC;IA6CT,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAYhE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBjD,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAe7B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IASzB,IAAI,CACR,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAClB,OAAO,GAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAO,GAC3C,OAAO,CAAC,CAAC,EAAE,CAAC;IAWT,WAAW,IAAI,OAAO,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAsBI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa9C,SAAS,CACb,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAU,GACjB,OAAO,CAAC,CAAC,CAAC;IAQP,SAAS,CACb,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAU,GACjB,OAAO,CAAC,CAAC,CAAC;IAUP,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAanD,aAAa,CAAC,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAe7D,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBtD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA0CtE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAsCjD,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBxD,WAAW,IAAI,YAAY,CAAC,CAAC,CAAC;IAW9B,WAAW,IAAI,YAAY,CAAC,CAAC,CAAC;IAMxB,UAAU,CACd,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EACtB,IAAI,EAAE,MAAM,EAAE,EACd,SAAS,GAAE,MAAY,GACtB,OAAO,CAAC,CAAC,EAAE,CAAC;IAYT,GAAG,CAAC,CAAC,EACT,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GACxB,OAAO,CAAC,CAAC,EAAE,CAAC;IAOT,IAAI,CACR,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC1D,QAAQ,GAAE,MAAY,GACrB,OAAO,CAAC,IAAI,CAAC;IAmBV,SAAS,CACb,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC9C,SAAS,GAAE,MAAY,GACtB,OAAO,CAAC,IAAI,CAAC;IAiBV,aAAa,CACjB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,OAAO,CAAC,EAAE,QAAQ,GACjB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAad,aAAa,CACjB,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,QAAQ,GAAE,OAAO,CAAC,CAAC,CAAM,GACxB,OAAO,CAAC,CAAC,CAAC;IAQP,cAAc,CAClB,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC;IAUP,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAkBjD,IAAI,CAAC,KAAK,GAAE,MAAa,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAS7C,MAAM,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAiBjC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAMjC,YAAY,IAAI,MAAM;IAItB,kBAAkB,IAAI,MAAM,GAAG,IAAI;IAInC,cAAc,IAAI,OAAO;CAG1B"}