@warlock.js/cascade 1.0.5 → 1.0.7

package/cjs/aggregate/WhereExpression.js

@@ -0,0 +1,149 @@
+'use strict';var supportiveIs=require('@mongez/supportive-is'),timeWizard=require('@mongez/time-wizard'),expressions=require('./expressions.js');function escapeString(value) {
+    return String(value).replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+}
+function escapeRegex(value, escapeOnly = false) {
+    if (value instanceof RegExp === false) {
+        // escape the value special characters
+        value = escapeString(value);
+        if (escapeOnly === false) {
+            value = new RegExp(value, "gi");
+        }
+    }
+    return value;
+}
+function parseValuesInObject(valuesObject) {
+    for (const key in valuesObject) {
+        const value = valuesObject[key];
+        if (value instanceof Date) {
+            valuesObject[key] = timeWizard.toUTC(value);
+        }
+    }
+    return valuesObject;
+}
+class WhereExpression {
+    /**
+     * Operators list
+     */
+    static operators = {
+        "=": "$eq",
+        "!=": "$ne",
+        not: "$not",
+        ">": "$gt",
+        ">=": "$gte",
+        "<": "$lt",
+        "<=": "$lte",
+        in: "$in",
+        nin: "$nin",
+        notIn: "$nin",
+        all: "$all",
+        exists: "$exists",
+        type: "$type",
+        mod: "$mod",
+        regex: "$regex",
+        between: "$between",
+        notBetween: "$between",
+        geoIntersects: "$geoIntersects",
+        geoWithin: "$geoWithin",
+        near: "$near",
+        nearSphere: "$nearSphere",
+        elemMatch: "$elemMatch",
+        size: "$size",
+        like: "$regex",
+        notLike: "$regex",
+        startsWith: "$regex",
+        endsWith: "$regex",
+        notStartsWith: "$regex",
+        notEndsWith: "$regex",
+    };
+    static parse(...args) {
+        if (args.length === 1 && supportiveIs.isPlainObject(args[0]))
+            return parseValuesInObject(args[0]);
+        const column = args[0];
+        let operator = args[1];
+        let value = args[2];
+        // if the length is two, then the operator will be =
+        if (args.length === 2) {
+            value = operator;
+            operator = "=";
+        }
+        if (operator === "like") {
+            value = new RegExp(escapeRegex(value), "gi");
+        }
+        else if (operator === "notLike") {
+            value = new RegExp(escapeRegex(value), "gi");
+            operator = "not";
+            value = {
+                $regex: value,
+            };
+        }
+        else if (operator === "startsWith") {
+            value = escapeRegex(value, true);
+            value = new RegExp(`^${value}`);
+        }
+        else if (operator === "endsWith") {
+            value = escapeRegex(value, true);
+            value = new RegExp(`${value}$`);
+        }
+        else if (operator === "notStartsWith") {
+            value = escapeRegex(value, true);
+            value = {
+                $regex: new RegExp(`^${value}`),
+            };
+            operator = "not";
+        }
+        else if (operator === "notEndsWith") {
+            value = escapeRegex(value, true);
+            value = {
+                $regex: new RegExp(`${value}$`),
+            };
+            operator = "not";
+        }
+        if (value instanceof Date) {
+            value = timeWizard.toUTC(value);
+        }
+        else if (Array.isArray(value)) {
+            value = value.map(item => {
+                if (item instanceof Date) {
+                    return timeWizard.toUTC(item);
+                }
+                return item;
+            });
+        }
+        let expression = {
+            [WhereExpression.operators[operator]]: value,
+        };
+        if (operator === "in" && typeof value === "string") {
+            expression = {
+                $in: expressions.$agg.columnName(value),
+            };
+        }
+        else if (operator === "notIn" && typeof value === "string") {
+            expression = {
+                $not: {
+                    $in: expressions.$agg.columnName(value),
+                },
+            };
+        }
+        else if (operator === "between") {
+            expression = {
+                $gte: value[0],
+                $lte: value[1],
+            };
+        }
+        else if (operator === "notBetween") {
+            expression = {
+                $not: {
+                    $gte: value[0],
+                    $lte: value[1],
+                },
+            };
+        }
+        // now add the data
+        return {
+            [column]: expression,
+        };
+    }
+}
+const toOperator = (operator) => {
+    return WhereExpression.operators[operator];
+};exports.WhereExpression=WhereExpression;exports.parseValuesInObject=parseValuesInObject;exports.toOperator=toOperator;//# sourceMappingURL=WhereExpression.js.map

package/cjs/aggregate/WhereExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WhereExpression.js","sources":["../../src/aggregate/WhereExpression.ts"],"sourcesContent":[null],"names":["toUTC","isPlainObject","$agg"],"mappings":"iJAMA,SAAS,YAAY,CAAC,KAAa,EAAA;IACjC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,WAAW,CAAC,KAAsB,EAAE,UAAU,GAAG,KAAK,EAAA;AAC7D,IAAA,IAAI,KAAK,YAAY,MAAM,KAAK,KAAK,EAAE;;AAErC,QAAA,KAAK,GAAG,YAAY,CAAC,KAAe,CAAC,CAAC;QAEtC,IAAI,UAAU,KAAK,KAAK,EAAE;YACxB,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACjC,SAAA;AACF,KAAA;AAED,IAAA,OAAO,KAAK,CAAC;AACf,CAAC;AAEK,SAAU,mBAAmB,CAAC,YAAiB,EAAA;AACnD,IAAA,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;AAC9B,QAAA,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,YAAY,CAAC,GAAG,CAAC,GAAGA,gBAAK,CAAC,KAAK,CAAC,CAAC;AAClC,SAAA;AACF,KAAA;AAED,IAAA,OAAO,YAAY,CAAC;AACtB,CAAC;MAEY,eAAe,CAAA;AAC1B;;AAEG;IACI,OAAgB,SAAS,GAA2C;AACzE,QAAA,GAAG,EAAE,KAAK;AACV,QAAA,IAAI,EAAE,KAAK;AACX,QAAA,GAAG,EAAE,MAAM;AACX,QAAA,GAAG,EAAE,KAAK;AACV,QAAA,IAAI,EAAE,MAAM;AACZ,QAAA,GAAG,EAAE,KAAK;AACV,QAAA,IAAI,EAAE,MAAM;AACZ,QAAA,EAAE,EAAE,KAAK;AACT,QAAA,GAAG,EAAE,MAAM;AACX,QAAA,KAAK,EAAE,MAAM;AACb,QAAA,GAAG,EAAE,MAAM;AACX,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,GAAG,EAAE,MAAM;AACX,QAAA,KAAK,EAAE,QAAQ;AACf,QAAA,OAAO,EAAE,UAAU;AACnB,QAAA,UAAU,EAAE,UAAU;AACtB,QAAA,aAAa,EAAE,gBAAgB;AAC/B,QAAA,SAAS,EAAE,YAAY;AACvB,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,UAAU,EAAE,aAAa;AACzB,QAAA,SAAS,EAAE,YAAY;AACvB,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,OAAO,EAAE,QAAQ;AACjB,QAAA,UAAU,EAAE,QAAQ;AACpB,QAAA,QAAQ,EAAE,QAAQ;AAClB,QAAA,aAAa,EAAE,QAAQ;AACvB,QAAA,WAAW,EAAE,QAAQ;KACtB,CAAC;AAYK,IAAA,OAAO,KAAK,CAAC,GAAG,IAAW,EAAA;AAChC,QAAA,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAIC,0BAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7C,YAAA,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtC,QAAA,MAAM,MAAM,GAAW,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/B,QAAA,IAAI,QAAQ,GAAkB,IAAI,CAAC,CAAC,CAAC,CAAC;AACtC,QAAA,IAAI,KAAK,GAAQ,IAAI,CAAC,CAAC,CAAC,CAAC;;AAGzB,QAAA,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,KAAK,GAAG,QAAQ,CAAC;YACjB,QAAQ,GAAG,GAAG,CAAC;AAChB,SAAA;QAED,IAAI,QAAQ,KAAK,MAAM,EAAE;YACvB,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;AAC9C,SAAA;aAAM,IAAI,QAAQ,KAAK,SAAS,EAAE;YACjC,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;YAC7C,QAAQ,GAAG,KAAK,CAAC;AACjB,YAAA,KAAK,GAAG;AACN,gBAAA,MAAM,EAAE,KAAK;aACd,CAAC;AACH,SAAA;aAAM,IAAI,QAAQ,KAAK,YAAY,EAAE;AACpC,YAAA,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACjC,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,KAAK,CAAA,CAAE,CAAC,CAAC;AACjC,SAAA;aAAM,IAAI,QAAQ,KAAK,UAAU,EAAE;AAClC,YAAA,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACjC,KAAK,GAAG,IAAI,MAAM,CAAC,GAAG,KAAK,CAAA,CAAA,CAAG,CAAC,CAAC;AACjC,SAAA;aAAM,IAAI,QAAQ,KAAK,eAAe,EAAE;AACvC,YAAA,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACjC,YAAA,KAAK,GAAG;AACN,gBAAA,MAAM,EAAE,IAAI,MAAM,CAAC,CAAI,CAAA,EAAA,KAAK,EAAE,CAAC;aAChC,CAAC;YAEF,QAAQ,GAAG,KAAK,CAAC;AAClB,SAAA;aAAM,IAAI,QAAQ,KAAK,aAAa,EAAE;AACrC,YAAA,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAEjC,YAAA,KAAK,GAAG;AACN,gBAAA,MAAM,EAAE,IAAI,MAAM,CAAC,CAAG,EAAA,KAAK,GAAG,CAAC;aAChC,CAAC;YAEF,QAAQ,GAAG,KAAK,CAAC;AAClB,SAAA;QAED,IAAI,KAAK,YAAY,IAAI,EAAE;AACzB,YAAA,KAAK,GAAGD,gBAAK,CAAC,KAAK,CAAC,CAAC;AACtB,SAAA;AAAM,aAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC/B,YAAA,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,IAAG;gBACvB,IAAI,IAAI,YAAY,IAAI,EAAE;AACxB,oBAAA,OAAOA,gBAAK,CAAC,IAAI,CAAC,CAAC;AACpB,iBAAA;AAED,gBAAA,OAAO,IAAI,CAAC;AACd,aAAC,CAAC,CAAC;AACJ,SAAA;AAED,QAAA,IAAI,UAAU,GAAG;YACf,CAAC,eAAe,CAAC,SAAS,CAAC,QAAyB,CAAC,GAAG,KAAK;SAC9D,CAAC;QAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAClD,YAAA,UAAU,GAAG;AACX,gBAAA,GAAG,EAAEE,gBAAI,CAAC,UAAU,CAAC,KAAK,CAAC;aAC5B,CAAC;AACH,SAAA;aAAM,IAAI,QAAQ,KAAK,OAAO,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAC5D,YAAA,UAAU,GAAG;AACX,gBAAA,IAAI,EAAE;AACJ,oBAAA,GAAG,EAAEA,gBAAI,CAAC,UAAU,CAAC,KAAK,CAAC;AAC5B,iBAAA;aACF,CAAC;AACH,SAAA;aAAM,IAAI,QAAQ,KAAK,SAAS,EAAE;AACjC,YAAA,UAAU,GAAG;AACX,gBAAA,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AACd,gBAAA,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;AACH,SAAA;aAAM,IAAI,QAAQ,KAAK,YAAY,EAAE;AACpC,YAAA,UAAU,GAAG;AACX,gBAAA,IAAI,EAAE;AACJ,oBAAA,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AACd,oBAAA,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AACf,iBAAA;aACF,CAAC;AACH,SAAA;;QAED,OAAO;YACL,CAAC,MAAM,GAAG,UAAU;SACrB,CAAC;KACH;;AAGU,MAAA,UAAU,GAAG,CAAC,QAAuB,KAAI;AACpD,IAAA,OAAO,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC7C"}

package/cjs/aggregate/WhereExpressionPipeline.d.ts

@@ -0,0 +1,10 @@
+import { Pipeline } from "./pipeline";
+export declare class WhereExpressionPipeline extends Pipeline {
+    protected readonly column: string;
+    protected readonly expression: any;
+    /**
+     * Constructor
+     */
+    constructor(column: string, expression: any);
+}
+//# sourceMappingURL=WhereExpressionPipeline.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WhereExpressionPipeline.d.ts","sourceRoot":"","sources":["../../src/aggregate/WhereExpressionPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,qBAAa,uBAAwB,SAAQ,QAAQ;IAKjD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACjC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG;IALpC;;OAEG;gBAEkB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,GAAG;CAOrC"}

package/cjs/aggregate/WhereExpressionPipeline.js

@@ -0,0 +1,15 @@
+'use strict';var pipeline=require('./pipeline.js');class WhereExpressionPipeline extends pipeline.Pipeline {
+    column;
+    expression;
+    /**
+     * Constructor
+     */
+    constructor(column, expression) {
+        super("match");
+        this.column = column;
+        this.expression = expression;
+        this.data({
+            [column]: expression,
+        });
+    }
+}exports.WhereExpressionPipeline=WhereExpressionPipeline;//# sourceMappingURL=WhereExpressionPipeline.js.map

package/cjs/aggregate/WhereExpressionPipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WhereExpressionPipeline.js","sources":["../../src/aggregate/WhereExpressionPipeline.ts"],"sourcesContent":[null],"names":["Pipeline"],"mappings":"mDAEM,MAAO,uBAAwB,SAAQA,iBAAQ,CAAA;AAK9B,IAAA,MAAA,CAAA;AACA,IAAA,UAAA,CAAA;AALrB;;AAEG;IACH,WACqB,CAAA,MAAc,EACd,UAAe,EAAA;QAElC,KAAK,CAAC,OAAO,CAAC,CAAC;QAHI,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;QACd,IAAU,CAAA,UAAA,GAAV,UAAU,CAAK;QAGlC,IAAI,CAAC,IAAI,CAAC;YACR,CAAC,MAAM,GAAG,UAAU;AACrB,SAAA,CAAC,CAAC;KACJ;AACF"}

package/cjs/aggregate/WherePipeline.d.ts

@@ -0,0 +1,13 @@
+import type { GenericObject } from "@mongez/reinforcements";
+import { Pipeline } from "./pipeline";
+import type { WhereOperator } from "./types";
+export declare class WherePipeline extends Pipeline {
+    /**
+     * Constructor
+     */
+    constructor(expression: GenericObject);
+}
+export declare function wherePipeline(column: string, value: any): WherePipeline;
+export declare function wherePipeline(column: string, operator: WhereOperator, value: any): WherePipeline;
+export declare function wherePipeline(column: GenericObject): WherePipeline;
+//# sourceMappingURL=WherePipeline.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WherePipeline.d.ts","sourceRoot":"","sources":["../../src/aggregate/WherePipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE5D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,qBAAa,aAAc,SAAQ,QAAQ;IACzC;;OAEG;gBACgB,UAAU,EAAE,aAAa;CAK7C;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAC;AACzE,wBAAgB,aAAa,CAC3B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,GAAG,GACT,aAAa,CAAC;AACjB,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAC"}

package/cjs/aggregate/WherePipeline.js

@@ -0,0 +1,12 @@
+'use strict';var WhereExpression=require('./WhereExpression.js'),pipeline=require('./pipeline.js');class WherePipeline extends pipeline.Pipeline {
+    /**
+     * Constructor
+     */
+    constructor(expression) {
+        super("match");
+        this.data(expression);
+    }
+}
+function wherePipeline(...args) {
+    return new WherePipeline(WhereExpression.WhereExpression.parse.apply(null, args));
+}exports.WherePipeline=WherePipeline;exports.wherePipeline=wherePipeline;//# sourceMappingURL=WherePipeline.js.map

package/cjs/aggregate/WherePipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WherePipeline.js","sources":["../../src/aggregate/WherePipeline.ts"],"sourcesContent":[null],"names":["Pipeline","WhereExpression"],"mappings":"mGAKM,MAAO,aAAc,SAAQA,iBAAQ,CAAA;AACzC;;AAEG;AACH,IAAA,WAAA,CAAmB,UAAyB,EAAA;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;AAEf,QAAA,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACvB;AACF,CAAA;AASe,SAAA,aAAa,CAAC,GAAG,IAAW,EAAA;AAC1C,IAAA,OAAO,IAAI,aAAa,CAACC,+BAAe,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,IAAW,CAAC,CAAC,CAAC;AAC3E"}

package/cjs/aggregate/aggregate.d.ts

@@ -0,0 +1,358 @@
+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

@@ -0,0 +1 @@
+{"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"}