@warlock.js/cascade 1.0.3 → 1.0.5

package/cjs/aggregate/aggregate.d.ts

@@ -1,358 +0,0 @@
-import type { GenericObject } from "@mongez/reinforcements";
-import type { ChunkCallback, Filter, PaginationListing } from "../model";
-import { ModelEvents } from "../model/model-events";
-import { GroupByPipeline } from "./GroupByPipeline";
-import type { LookupPipelineOptions } from "./LookupPipeline";
-import type { UnwindOptions } from "./UnwindPipeline";
-import type { Pipeline } from "./pipeline";
-import type { WhereOperator } from "./types";
-export declare class Aggregate {
-    readonly collection: string;
-    /**
-     * Collection pipelines
-     */
-    pipelines: (Pipeline | GenericObject)[];
-    /**
-     * Aggregate events
-     */
-    static _events: ModelEvents;
-    /**
-     * Query manager
-     */
-    query: import("../query").Query;
-    /**
-     * Constructor
-     */
-    constructor(collection: string);
-    /**
-     * Get the events instance
-     */
-    static events(): ModelEvents;
-    /**
-     * Sort by the given column
-     */
-    sort(column: string, direction?: "asc" | "desc"): this;
-    /**
-     * @alias sort
-     */
-    orderBy(column: string, direction?: "asc" | "desc"): this;
-    /**
-     * Order by descending
-     */
-    sortByDesc(column: string): this;
-    /**
-     * Order by descending
-     */
-    orderByDesc(column: string): this;
-    /**
-     * Sort by multiple columns
-     */
-    sortBy(columns: Record<string, "desc" | "asc">): this;
-    /**
-     * Sort randomly
-     */
-    random(limit?: number): this;
-    /**
-     * Order by latest created records
-     */
-    latest(column?: string): this;
-    /**
-     * Order by oldest created records
-     */
-    oldest(column?: string): this;
-    /**
-     * Group by aggregate
-     */
-    groupBy(GroupByPipeline: GroupByPipeline): this;
-    groupBy(GroupByPipeline: GenericObject, groupByData?: GenericObject): this;
-    groupBy(groupByColumns: string[], groupByData?: GenericObject): this;
-    groupBy(groupBy_id: string | null): this;
-    groupBy(groupBy_id: string | null, groupByData: GenericObject): this;
-    /**
-     * Group by year
-     */
-    groupByYear(column: string, groupByData?: GenericObject): this;
-    /**
-     * Group by month and year
-     */
-    groupByMonthAndYear(column: string, groupByData?: GenericObject): this;
-    /**
-     * Group by month only
-     */
-    groupByMonth(column: string, groupByData?: GenericObject): this;
-    /**
-     * Group by day, month and year
-     */
-    groupByDate(column: string, groupByData?: GenericObject): this;
-    /**
-     * Group by week and year
-     */
-    groupByWeek(column: string, groupByData?: GenericObject): this;
-    /**
-     * Group by day only
-     */
-    groupByDayOfMonth(column: string, groupByData?: GenericObject): this;
-    /**
-     * Pluck only the given column
-     */
-    pluck(column: string): Promise<any[]>;
-    /**
-     * Get average of the given column
-     */
-    avg(column: string): Promise<any>;
-    /**
-     * {@alias} avg
-     */
-    average(column: string): Promise<any>;
-    /**
-     * Sum values of the given column
-     */
-    sum(column: string): Promise<any>;
-    /**
-     * Get minimum value of the given column
-     */
-    min(column: string): Promise<any>;
-    /**
-     * Get maximum value of the given column
-     */
-    max(column: string): Promise<any>;
-    /**
-     * Get distinct value for the given column using aggregation
-     */
-    distinct<T = any>(column: string): Promise<T[]>;
-    /**
-     * {@alias} distinct
-     */
-    unique<T = any>(column: string): Promise<T[]>;
-    /**
-     * Get distinct values that are not empty
-     */
-    distinctHeavy<T = any>(column: string): Promise<T[]>;
-    /**
-     * {@alias} distinctHeavy
-     */
-    uniqueHeavy<T = any>(column: string): Promise<T[]>;
-    /**
-     * Get values list of the given column
-     */
-    values<T = any>(column: string): Promise<T>;
-    /**
-     * Limit the number of results
-     */
-    limit(limit: number): this;
-    /**
-     * Skip the given number of results
-     */
-    skip(skip: number): this;
-    /**
-     * Select the given columns
-     */
-    select(...columns: string[]): this;
-    select(columns: string[] | Record<string, 0 | 1 | boolean>): this;
-    /**
-     * Deselect the given columns
-     */
-    deselect(columns: string[]): this;
-    /**
-     * Unwind/Extract the given column
-     */
-    unwind(column: string, options?: UnwindOptions): this;
-    /**
-     * Add where stage
-     */
-    where(column: string, value: any): this;
-    where(column: string, operator: WhereOperator, value: any): this;
-    where(column: GenericObject): this;
-    /**
-     * Add comparison between two or more columns
-     */
-    whereColumns(column1: string, operator: WhereOperator, ...otherColumns: string[]): this;
-    /**
-     * Or Where stage
-     */
-    orWhere(...operations: GenericObject[]): this;
-    orWhere(...operations: [column: string, value: any][]): this;
-    /**
-     * Perform a text search
-     * Please note that this method will add the `match` stage to the beginning of the pipeline
-     * Also it will add `score` field to the result automatically
-     *
-     * @warning This method will not work if the collection is not indexed for text search
-     */
-    textSearch(query: string, moreFilters?: GenericObject): this;
-    /**
-     * Where null
-     */
-    whereNull(column: string): this;
-    /**
-     * Where not null
-     */
-    whereNotNull(column: string): this;
-    /**
-     * Where like operator
-     */
-    whereLike(column: string, value: string): this;
-    /**
-     * Where not like operator
-     */
-    whereNotLike(column: string, value: string): this;
-    /**
-     * Where column starts with the given value
-     */
-    whereStartsWith(column: string, value: string | number): this;
-    /**
-     * Where column not starts with the given value
-     */
-    whereNotStartsWith(column: string, value: string | number): this;
-    /**
-     * Where column ends with the given value
-     */
-    whereEndsWith(column: string, value: string | number): this;
-    /**
-     * Where column not ends with the given value
-     */
-    whereNotEndsWith(column: string, value: string | number): this;
-    /**
-     * Where between operator
-     */
-    whereBetween(column: string, value: [any, any]): this;
-    /**
-     * Where date between operator
-     */
-    whereDateBetween(column: string, value: [Date, Date]): this;
-    /**
-     * Where date not between operator
-     */
-    whereDateNotBetween(column: string, value: [Date, Date]): this;
-    /**
-     * Where not between operator
-     */
-    whereNotBetween(column: string, value: [any, any]): this;
-    /**
-     * Where exists operator
-     */
-    whereExists(column: string): this;
-    /**
-     * Where not exists operator
-     */
-    whereNotExists(column: string): this;
-    /**
-     * Where size operator
-     */
-    whereSize(column: string, size: number): this;
-    whereSize(column: string, operator: ">" | ">=" | "=" | "<" | "<=", size: number): this;
-    /**
-     * Add project pipeline
-     *
-     */
-    project(data: Record<string, any>): this;
-    /**
-     * Where in operator
-     * If value is a string, it will be treated as a column name
-     */
-    whereIn(column: string, values: string | any[]): this;
-    /**
-     * Where not in operator
-     * If value is a string, it will be treated as a column name
-     */
-    whereNotIn(column: string, values: string | any[]): this;
-    /**
-     * // TODO: Make a proper implementation
-     * Where location near
-     */
-    whereNear(column: string, value: [number, number], _distance: number): this;
-    /**
-     * // TODO: Make a proper implementation
-     * Get nearby location between the given min and max distance
-     */
-    whereNearByIn(column: string, value: [number, number], _minDistance: number, _maxDistance: number): Promise<this>;
-    /**
-     * Lookup the given collection
-     */
-    lookup(options: LookupPipelineOptions): this;
-    /**
-     * Add field to the pipeline
-     */
-    addField(field: string, value: any): this;
-    /**
-     * Add fields to the pipeline
-     */
-    addFields(fields: GenericObject): this;
-    /**
-     * Get new pipeline instance
-     */
-    pipeline(...pipelines: Pipeline[]): this;
-    /**
-     * Unshift pipeline to the beginning of the pipelines
-     */
-    unshiftPipelines(pipelines: Pipeline[]): this;
-    /**
-     * Add mongodb plain stage
-     */
-    addPipeline(pipeline: any): this;
-    /**
-     * Add mongodb plain stages
-     */
-    addPipelines(pipelines: any[]): this;
-    /**
-     * Get pipelines
-     */
-    getPipelines(): (Pipeline | GenericObject)[];
-    /**
-     * Get only first result
-     */
-    first(mapData?: (data: any) => any): Promise<any>;
-    /**
-     * Get last result
-     */
-    last(filters?: Filter): Promise<any>;
-    /**
-     * Delete records
-     */
-    delete(): Promise<number>;
-    /**
-     * Get the data
-     */
-    get(mapData?: (data: any) => any): Promise<any[]>;
-    /**
-     * Chunk documents based on the given limit
-     */
-    chunk<T = any>(limit: number, callback: ChunkCallback<T>, mapData?: (data: any) => any): Promise<void>;
-    /**
-     * Paginate records based on the given filter
-     */
-    paginate<T = any>(page?: number, limit?: number, mapData?: (data: any) => T): Promise<PaginationListing<T>>;
-    /**
-     * Explain the query
-     */
-    explain(): Promise<any>;
-    /**
-     * Update the given data
-     */
-    update(data: any): Promise<any>;
-    /**
-     * Unset the given columns
-     */
-    unset(...columns: string[]): Promise<any>;
-    /**
-     * Execute the query
-     */
-    execute(): Promise<any>;
-    /**
-     * Count the results
-     */
-    count(): Promise<number>;
-    /**
-     * Parse pipelines
-     */
-    parse(): any[];
-    /**
-     * Reset the pipeline
-     */
-    reset(): this;
-    /**
-     * Clone the aggregate class
-     */
-    clone(): this;
-}
-//# sourceMappingURL=aggregate.d.ts.map

package/cjs/aggregate/aggregate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"aggregate.d.ts","sourceRoot":"","sources":["../../src/aggregate/aggregate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAI5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAQ9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAkBtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,qBAAa,SAAS;aAmBe,UAAU,EAAE,MAAM;IAlBrD;;OAEG;IACI,SAAS,EAAE,CAAC,QAAQ,GAAG,aAAa,CAAC,EAAE,CAAM;IAEpD;;OAEG;IACH,OAAc,OAAO,cAAqB;IAE1C;;OAEG;IACI,KAAK,2BAAS;IAErB;;OAEG;gBACgC,UAAU,EAAE,MAAM;IASrD;;OAEG;WACW,MAAM;IAIpB;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,KAAK,GAAG,MAAc;IAI7D;;OAEG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,KAAK,GAAG,MAAc;IAIhE;;OAEG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM;IAIhC;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM;IAIjC;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAIrD;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM;IAsB5B;;OAEG;IACI,MAAM,CAAC,MAAM,SAAc;IAIlC;;OAEG;IACI,MAAM,CAAC,MAAM,SAAc;IAIlC;;OAEG;IACI,OAAO,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAC/C,OAAO,CACZ,eAAe,EAAE,aAAa,EAC9B,WAAW,CAAC,EAAE,aAAa,GAC1B,IAAI;IACA,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,aAAa,GAAG,IAAI;IACpE,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IACxC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,EAAE,WAAW,EAAE,aAAa,GAAG,IAAI;IAW3E;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAS9D;;OAEG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAWtE;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAU/D;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAY9D;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAW9D;;OAEG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAUpE;;OAEG;IACU,KAAK,CAAC,MAAM,EAAE,MAAM;IAIjC;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM;IAQ/B;;OAEG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM;IAI7B;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM;IAQ/B;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM;IAQ/B;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM;IAQ/B;;OAEG;IACU,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM;IAS7C;;OAEG;IACI,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM;IAIrC;;OAEG;IACU,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM;IAIlD;;OAEG;IACU,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM;IAIhD;;OAEG;IACU,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM;IAQ3C;;OAEG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM;IAI1B;;OAEG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM;IAIxB;;OAEG;IACI,MAAM,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAClC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,IAAI;IASxE;;OAEG;IACI,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;IAIjC;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAIrD;;OAEG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IACvC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAChE,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAOzC;;OAEG;IACI,YAAY,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,EACvB,GAAG,YAAY,EAAE,MAAM,EAAE;IAa3B;;OAEG;IACI,OAAO,CAAC,GAAG,UAAU,EAAE,aAAa,EAAE,GAAG,IAAI;IAC7C,OAAO,CAAC,GAAG,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,IAAI;IAKnE;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa;IAa5D;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM;IAI/B;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM;IAIlC;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAI9C;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIjD;;OAEG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAI7D;;OAEG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAIhE;;OAEG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAI3D;;OAEG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAI9D;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IAIrD;;OAEG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IAI3D;;OAEG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IAI9D;;OAEG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IAIxD;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM;IAIjC;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,MAAM;IAIpC;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAC7C,SAAS,CACd,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,EACvC,IAAI,EAAE,MAAM,GACX,IAAI;IAqBP;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAMxC;;;OAGG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAIrD;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAIxD;;;OAGG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM;IAI3E;;;OAGG;IACU,aAAa,CACxB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EACvB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM;IAKtB;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,qBAAqB;IAW5C;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAQzC;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,aAAa;IAMtC;;OAEG;IACI,QAAQ,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE;IAMxC;;OAEG;IACI,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE;IAM7C;;OAEG;IACI,WAAW,CAAC,QAAQ,EAAE,GAAG;IAMhC;;OAEG;IACI,YAAY,CAAC,SAAS,EAAE,GAAG,EAAE;IAMpC;;OAEG;IACI,YAAY;IAInB;;OAEG;IACU,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAM9D;;OAEG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAUjD;;OAEG;IACU,MAAM;IAWnB;;OAEG;IACU,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAM9D;;OAEG;IACU,KAAK,CAAC,CAAC,GAAG,GAAG,EACxB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAC1B,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG;IAiB9B;;OAEG;IACU,QAAQ,CAAC,CAAC,GAAG,GAAG,EAC3B,IAAI,SAAI,EACR,KAAK,SAAK,EACV,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GACzB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAyBhC;;OAEG;IACU,OAAO;IAQpB;;OAEG;IACU,MAAM,CAAC,IAAI,EAAE,GAAG;IA8B7B;;OAEG;IACU,KAAK,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE;IA+BvC;;OAEG;IACU,OAAO;IAQpB;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAUrC;;OAEG;IACI,KAAK;IAIZ;;OAEG;IACI,KAAK;IAMZ;;OAEG;IACI,KAAK;CAOb"}