@warlock.js/core 1.0.11 → 1.0.12

package/cjs/repositories/repository-list-manager.d.ts

@@ -0,0 +1,347 @@
+import type { GenericObject } from "@mongez/reinforcements";
+import type { CacheDriver } from "@warlock.js/cache";
+import type { ModelAggregate, PaginationListing } from "@warlock.js/cascade";
+import { Model } from "@warlock.js/cascade";
+import { BaseRepositoryManager } from "./base-repository-manager";
+import { RepositoryListing } from "./repository-listing";
+import type { RepositoryManager } from "./repository-manager";
+import type { AllRepositoryOptions, CachedRepositoryOptions, FilterByOptions, RepositoryOptions } from "./types";
+export declare abstract class RepositoryListManager<T extends Model, M extends typeof Model = typeof Model> extends BaseRepositoryManager<T, M> {
+    /**
+     * List default options
+     */
+    protected defaultOptions: RepositoryOptions;
+    /**
+     * Simple selected columns
+     */
+    protected simpleSelectColumns: string[];
+    /**
+     * Default filters list
+     */
+    protected defaultFilters: FilterByOptions;
+    /**
+     * Filter By options
+     */
+    protected filterBy: FilterByOptions;
+    /**
+     * List of repositories that should clear its cache when this repository is created, updated or deleted
+     */
+    protected clearCacheOnUpdate: RepositoryManager<any>[];
+    /**
+     * Whether to enable caching
+     */
+    isCacheable: boolean;
+    /**
+     * Cache driver
+     */
+    protected cacheDriver: CacheDriver<any, any>;
+    /**
+     * Set the cache driver name
+     * If set, then it will be used instead of the default value in this.cacheDriver
+     */
+    protected cacheDriverName: string;
+    /**
+     * Define the `isActive` column
+     *
+     * @default isActive
+     */
+    protected isActiveColumn: string;
+    /**
+     * Define the value of the `isActive` column when the record is active
+     *
+     * @default true
+     */
+    protected isActiveValue: any;
+    /**
+     * Constructor
+     */
+    constructor();
+    /**
+     * Get active column and its value
+     */
+    protected getIsActiveFilter(): {
+        [x: string]: any;
+    };
+    /**
+     * Set cache driver
+     */
+    setCacheDriver(driver: CacheDriver<any, any>): this;
+    /**
+     * Get cache driver
+     */
+    getCacheDriver(): CacheDriver<any, any>;
+    /**
+     * List All records
+     */
+    all(options?: AllRepositoryOptions): Promise<any>;
+    /**
+     * Get all cached data
+     */
+    allCached(options?: AllRepositoryOptions): Promise<any>;
+    /**
+     * List All Active records
+     */
+    allActive(options?: AllRepositoryOptions): Promise<any>;
+    /**
+     * List all active cached records
+     */
+    allActiveCached(options?: AllRepositoryOptions): Promise<any>;
+    /**
+     * Prepare  cache
+     */
+    prepareCache(): Promise<void>;
+    /**
+     * Cache the given model
+     */
+    cacheModel(model: T): Promise<void>;
+    /**
+     * Clear the entire cache
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Before listing
+     * Called before listing records
+     */
+    beforeListing(_query: ModelAggregate<T>, _options: RepositoryOptions): Promise<void>;
+    /**
+     * On list
+     * Called after listing records
+     */
+    onList(records: T[]): Promise<T[]>;
+    /**
+     * Merge default options with the given options
+     */
+    protected withDefaultOptions(options: RepositoryOptions): {
+        [x: string]: any;
+        defaultLimit?: number;
+        limit?: number;
+        select?: string[];
+        deselect?: string[];
+        purgeCache?: boolean;
+        orderBy?: string | [string, "asc" | "desc"] | {
+            [key: string]: "asc" | "desc";
+        };
+        perform?: (query: ModelAggregate<any>, options: RepositoryOptions) => void;
+        paginate?: boolean;
+        page?: number;
+    };
+    /**
+     * Add default filters along side with the given filters
+     */
+    withDefaultFilters(filters?: FilterByOptions): {
+        [x: string]: any;
+    };
+    /**
+     * Get new query
+     */
+    newQuery(): ModelAggregate<T>;
+    /**
+     * An alias to newQuery
+     */
+    get query(): ModelAggregate<T>;
+    /**
+     * Get cached model
+     */
+    getCachedModel(id: number): Promise<any>;
+    /**
+     * Get cached model by the given column
+     */
+    getCachedModelBy(column: string, value: any, cacheKeyOptions?: GenericObject): Promise<any>;
+    /**
+     * Get cached model data
+     */
+    getCached(id: string | number): Promise<T>;
+    /**
+     * Get active cached model
+     */
+    getActiveCached(id: string | number): Promise<T>;
+    /**
+     * Generate cache key
+     */
+    cacheKey(key: string, moreOptions?: GenericObject): string;
+    /**
+     * Get cached data by the given column
+     */
+    getCachedBy(column: string, value: any, cacheKeyOptions?: GenericObject): Promise<T>;
+    /**
+     * Get and cached value by id then purge it from cache
+     */
+    getCachedPurge(id: number): Promise<T>;
+    /**
+     * Get and cached by the given column then purge it from cache
+     */
+    getCachedByPurge(column: string, value: any): Promise<T>;
+    /**
+     * List records
+     */
+    list(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * Find latest records
+     */
+    latest(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * Get latest and active records
+     */
+    latestActive(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * Get oldest records
+     */
+    oldest(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * Get oldest and active records
+     */
+    oldestActive(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * List cached records
+     */
+    listCached(options?: CachedRepositoryOptions): Promise<any>;
+    /**
+     * Fetch cached records or cache new ones
+     */
+    cacheList({ key, options, purge, expiresAfter, }: {
+        key?: string;
+        purge?: boolean;
+        expiresAfter?: number;
+        options?: CachedRepositoryOptions;
+    }): Promise<any>;
+    /**
+     * Fetch cached records or cache new ones
+     */
+    cacheAll({ key, options, expiresAfter, purge, }: {
+        key?: string;
+        purge?: boolean;
+        expiresAfter?: number;
+        options?: CachedRepositoryOptions;
+    }): Promise<any>;
+    /**
+     * Get new repository listing instance
+     */
+    newList(options?: RepositoryOptions): RepositoryListing<T, M>;
+    /**
+     * Map the given documents into models
+     */
+    mapModels(documents: any[]): T[];
+    /**
+     * Count total records based on the given options
+     */
+    count(options?: RepositoryOptions): Promise<any>;
+    /**
+     * Count total active records
+     */
+    countActive(options?: RepositoryOptions): Promise<any>;
+    /**
+     * Get total records based on the given options and cache it
+     */
+    countCached(options?: RepositoryOptions): Promise<any>;
+    /**
+     * Count active records and cache it
+     */
+    countActiveCached(options?: RepositoryOptions): Promise<any>;
+    /**
+     * Cache the given key and value
+     */
+    protected cache(key: string, value: any): Promise<any>;
+    /**
+     * List active cached records
+     */
+    listActiveCached(options?: CachedRepositoryOptions): Promise<any>;
+    /**
+     * List active records
+     */
+    listActive(options?: RepositoryOptions): Promise<PaginationListing<T>>;
+    /**
+     * Chunk records
+     */
+    chunk(options: RepositoryOptions, callback: (documents: T[], paginationInfo: PaginationListing<T>["paginationInfo"]) => Promise<false | any>): Promise<any>;
+    /**
+     * Chunk active records
+     */
+    chunkActive(options: RepositoryOptions, callback: (documents: T[], paginationInfo: PaginationListing<T>["paginationInfo"]) => Promise<false | any>): Promise<any>;
+    /**
+     * Get active record
+     */
+    getActive(id: number | string, options?: RepositoryOptions): Promise<T>;
+    /**
+     * Get single record by id
+     */
+    get(id: number, options?: RepositoryOptions): Promise<T>;
+    /**
+     * Get owned record
+     */
+    getOwned(userId: number, id: number, column?: string): Promise<T>;
+    /**
+     * Get owned records
+     */
+    listOwned(userId: number, options?: RepositoryOptions, column?: string): Promise<PaginationListing<T>>;
+    /**
+     * Get owned active records
+     */
+    listOwnedActive(userId: number, options?: RepositoryOptions, column?: string): Promise<PaginationListing<T>>;
+    /**
+     * Get first record
+     */
+    first(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get first cached record
+     */
+    firstCached(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get first active record
+     */
+    firstActive(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get first active cached record
+     */
+    firstActiveCached(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get last record
+     */
+    last(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get last cached record
+     */
+    lastCached(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get last active record
+     */
+    lastActive(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Get last active cached record
+     */
+    lastActiveCached(options?: RepositoryOptions): Promise<T | null>;
+    /**
+     * Make filter
+     */
+    filter(_query: ModelAggregate<T>, _options: RepositoryOptions): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    orderBy(_options: RepositoryOptions): any;
+    /**
+     * Find By id
+     */
+    find(id: string | number | T): Promise<T>;
+    /**
+     * Find active document
+     */
+    findActive(id: string | number | T): Promise<T>;
+    /**
+     * Find by the given column
+     */
+    findBy(column: string, value: any): Promise<T>;
+    /**
+     * Find by the given column and make sure it is active
+     */
+    findByActive(column: string, value: any): Promise<T>;
+    /**
+     * Find by the given column and cache it
+     * @alias getCached
+     */
+    findCached(id: number | string | T): Promise<string | number | T>;
+    /**
+     * Find by the given column and cache it
+     * @alias getCachedBy
+     */
+    findByCached(column: string, value: any): Promise<T>;
+}
+//# sourceMappingURL=repository-list-manager.d.ts.map

package/cjs/repositories/repository-list-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository-list-manager.d.ts","sourceRoot":"","sources":["../../src/repositories/repository-list-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,8BAAsB,qBAAqB,CACzC,CAAC,SAAS,KAAK,EACf,CAAC,SAAS,OAAO,KAAK,GAAG,OAAO,KAAK,CACrC,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,iBAAiB,CAAM;IAEjD;;OAEG;IACH,SAAS,CAAC,mBAAmB,EAAE,MAAM,EAAE,CAAU;IAEjD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,eAAe,CAevC;IAEF;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAM;IAEzC;;OAEG;IACH,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAM;IAE5D;;OAEG;IACI,WAAW,UAAQ;IAE1B;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAS;IAErD;;;OAGG;IACH,SAAS,CAAC,eAAe,SAAM;IAE/B;;;;OAIG;IACH,SAAS,CAAC,cAAc,SAAc;IAEtC;;;;OAIG;IACH,SAAS,CAAC,aAAa,EAAE,GAAG,CAAQ;IAEpC;;OAEG;;IAMH;;OAEG;IACH,SAAS,CAAC,iBAAiB;;;IAM3B;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC;IAMnD;;OAEG;IACI,cAAc;IAIrB;;OAEG;IACU,GAAG,CAAC,OAAO,GAAE,oBAAyB;IAInD;;OAEG;IACU,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAIrD;;OAEG;IACU,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAIrD;;OAEG;IACU,eAAe,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAO3D;;OAEG;IACU,YAAY;IA4BzB;;OAEG;IACU,UAAU,CAAC,KAAK,EAAE,CAAC;IAMhC;;OAEG;IACU,UAAU;IAIvB;;;OAGG;IACU,aAAa,CACxB,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,EACzB,QAAQ,EAAE,iBAAiB;IAK7B;;;OAGG;IACU,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAI/C;;OAEG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,iBAAiB;;;;;;;;;;;;;;IAIvD;;OAEG;IACI,kBAAkB,CAAC,OAAO,GAAE,eAAoB;;;IAIvD;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACH,IAAW,KAAK,sBAEf;IAED;;OAEG;IACU,cAAc,CAAC,EAAE,EAAE,MAAM;IAItC;;OAEG;IACU,gBAAgB,CAC3B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,EACV,eAAe,CAAC,EAAE,aAAa;IAsBjC;;OAEG;IACU,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAI1C;;OAEG;IACU,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAUhD;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAcxD;;OAEG;IACU,WAAW,CACtB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,EACV,eAAe,CAAC,EAAE,aAAa;IA0BjC;;OAEG;IACU,cAAc,CAAC,EAAE,EAAE,MAAM;IAItC;;OAEG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAUxD;;OAEG;IACU,IAAI,CACf,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAWhC;;OAEG;IACU,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAO/C;;OAEG;IACU,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAQrD;;OAEG;IACU,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAO/C;;OAEG;IACU,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAQrD;;OAEG;IACU,UAAU,CAAC,OAAO,GAAE,uBAA4B;IAmB7D;;OAEG;IACU,SAAS,CAAC,EACrB,GAAY,EACZ,OAAO,EACP,KAAK,EACL,YAAY,GACb,EAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,uBAAuB,CAAC;KACnC;IA6CD;;OAEG;IACU,QAAQ,CAAC,EACpB,GAAW,EACX,OAAO,EACP,YAAY,EACZ,KAAK,GACN,EAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,uBAAuB,CAAC;KACnC;IA4BD;;OAEG;IACI,OAAO,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAqB1C;;OAEG;IACI,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE;IAIjC;;OAEG;IACU,KAAK,CAAC,OAAO,GAAE,iBAAsB;IAMlD;;OAEG;IACU,WAAW,CAAC,OAAO,GAAE,iBAAsB;IAOxD;;OAEG;IACU,WAAW,CAAC,OAAO,GAAE,iBAAsB;IAgCxD;;OAEG;IACU,iBAAiB,CAAC,OAAO,GAAE,iBAAsB;IAO9D;;OAEG;cACa,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAI7C;;OAEG;IACU,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IAOnE;;OAEG;IACU,UAAU,CAAC,OAAO,GAAE,iBAAsB;IAOvD;;OAEG;IACU,KAAK,CAChB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,CACR,SAAS,EAAE,CAAC,EAAE,EACd,cAAc,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,KACnD,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC;IAkB3B;;OAEG;IACU,WAAW,CACtB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,CACR,SAAS,EAAE,CAAC,EAAE,EACd,cAAc,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,KACnD,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC;IAW3B;;OAEG;IACU,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,GAAE,iBAAsB;IAU3E;;OAEG;IACU,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB;IAS5D;;OAEG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,SAAc;IAWtE;;OAEG;IACU,SAAS,CACpB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,EAC/B,MAAM,SAAc;IAUtB;;OAEG;IACU,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,EAC/B,MAAM,SAAc;IAWtB;;OAEG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUlE;;OAEG;IACU,WAAW,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUxE;;OAEG;IACU,WAAW,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUxE;;OAEG;IACU,iBAAiB,CAC5B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUpB;;OAEG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUjE;;OAEG;IACU,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUvE;;OAEG;IACU,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAWvE;;OAEG;IACU,gBAAgB,CAC3B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAWpB;;OAEG;IACU,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,iBAAiB;IAI1E;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,iBAAiB,GAAG,GAAG;IAIhD;;OAEG;IACU,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC;IAMzC;;OAEG;IACU,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC;IAM/C;;OAEG;IACU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAQ9C;;OAEG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAapD;;;OAGG;IACU,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC;IAM/C;;;OAGG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;CAGrD"}