@r5v/mongoose-paginate 1.0.10 → 1.0.12

package/README.md

@@ -89,9 +89,11 @@ PagingQuery(Express.Request, mongoose.Model, options )
 | Key                         | Value                | Description                                                                                                                                                              | Class Availability                  | Required | Default |
 |:----------------------------|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:---------|:--------|
 | disablePaging               | boolean              | disables paging and $paging param use                                                                                                                                    | PagingQuery, AggregationPagingQuery |          | false   |
-| enableFilter                | boolean              | disables the $filter param on req.                                                                                                                                       | PagingQuery, AggregationPagingQuery |          | false   |
-| single                      | boolean              | disables paging on the query. converts from .find query to .findOne()                                                                                                    | PagingQuery, AggregationPagingQuery |          | true    |
-| enablePostFilter            | boolean              | disables the ability to create a dynamic filter per request                                                                                                              | AggregationPagingQuery              |          | false   |
+| disableFilter               | boolean              | disables the $filter param on req.                                                                                                                                       | PagingQuery                         |          | false   |
+| enableFilter                | boolean              | enables the $filter param on req for aggregation queries.                                                                                                                | AggregationPagingQuery              |          | false   |
+| enablePreSort               | boolean              | enables the $preSort param on req for aggregation queries.                                                                                                               | AggregationPagingQuery              |          | false   |
+| single                      | boolean              | disables paging on the query. converts from .find query to .findOne()                                                                                                    | PagingQuery                         |          | false   |
+| enablePostFilter            | boolean              | enables the ability to create a dynamic filter per request using the $postFilter parameter                                                                               | AggregationPagingQuery              |          | false   |
 | staticPostFilter            | Mongo Filter Object  | create a filter on the pipeline that is added after all the pipeline stages. this cannot be overwritten by params                                                        | AggregationPagingQuery              |          | {}      |
 | staticFilter                | Mongo Filter Object  | create a filter on the pipeline that is added before all the pipeline stages. on find requests, this is added to the filter object. this cannot be overwritten by params | AggregationPagingQuery              |          | {}      |
 | pipeline                    | MongoPipelineStage[] | pipeline request object. if the first item in pipeline stage is a $match or another required first stage operator. it will be placed before all other modifiers          | AggregationPagingQuery              | true     | []      |
@@ -134,7 +136,12 @@ $ yarn run start
 ## NOTES
 1. removeProtected removed from aggregation query due to inconsistent results after publication
 
-### 1.0.10
+### 1.0.12
+  - Fix issue with AggregationPagingQuery where static post filter would not be applied if $postFilter param was not supplied
+  - updated typings on AggregationPagingQuery to include enablePostFilter, enableFilter, and enablePreSort
+  - flipped PagingQuery back to `disableFilter` instead of `enableFilter` option \# this was set incorrectly in 1.0.11 but still defaults to false
+
+### 1.0.11
 Fix Issue with Typescript build
 
 ### 1.0.9

package/dist/aggregationPagingQuery.js

@@ -91,7 +91,7 @@ class AggregationPagingQuery {
             if (Object.keys(typeCastFilter).length !== 0) {
                 this.query.match(typeCastFilter);
             }
-            if (this.options.enablePresort && Object.keys($preSort).length) {
+            if (this.options.enablePreSort && Object.keys($preSort).length) {
                 this.query.sort($preSort);
             }
             if (!firstObj) {
@@ -104,7 +104,7 @@ class AggregationPagingQuery {
             if ($count.length) {
                 this.createCounts();
             }
-            if (Object.keys($postFilter).length !== 0) {
+            if ((Object.keys($postFilter).length !== 0 && enablePostFilter) || staticPostFilter !== undefined) {
                 this.query.match(typeCastPostFilter);
             }
             if (Object.keys($sort).length) {

package/dist/pagingQuery.js

@@ -43,8 +43,8 @@ class PagingQuery {
         this.isJsonString = isJsonString_1.isJsonString;
         this.initQuery = () => {
             const { $filter, $sort, $select, $skip, $limit, $populate, $lean } = this.params;
-            const _a = this.options, { single, staticFilter, disablePaging, enableFilter } = _a, options = __rest(_a, ["single", "staticFilter", "disablePaging", "enableFilter"]);
-            const filter = enableFilter ? Object.assign({}, staticFilter) : Object.assign(Object.assign({}, $filter), staticFilter);
+            const _a = this.options, { single, staticFilter, disablePaging, disableFilter } = _a, options = __rest(_a, ["single", "staticFilter", "disablePaging", "disableFilter"]);
+            const filter = disableFilter ? Object.assign({}, staticFilter) : Object.assign(Object.assign({}, $filter), staticFilter);
             this.query = single ? this.model.findOne(filter) : this.model.find(filter);
             this.query.setOptions(options);
             if (disablePaging || single) {

package/dist/types/aggregationPagingQuery.d.ts

@@ -1,13 +1,13 @@
 import { Model, Aggregate } from "mongoose";
 import type { Request } from "express";
-import type { AggregateQueryOptions, ExpressQuery, AggregateQueryParsedRequestParams } from './types';
+import type { AggregateQueryOptions, QueryParameters, AggregateQueryParsedRequestParams } from './types';
 export declare class AggregationPagingQuery {
     params: AggregateQueryParsedRequestParams;
     options: AggregateQueryOptions;
     query: Aggregate<Array<any>> | undefined;
     protectedPaths: string[];
     model: Model<any>;
-    constructor(req: Request<{}, any, any, Partial<ExpressQuery>>, model: Model<any>, options: AggregateQueryOptions);
+    constructor(req: Request<{}, any, any, Partial<QueryParameters>>, model: Model<any>, options: AggregateQueryOptions);
     findProtectedPaths: (model: Model<any>) => string[];
     parseParams: (defaultParams: import("./types").PagingQueryParsedRequestParams | AggregateQueryParsedRequestParams, params: import("qs").ParsedQs, isAggregate?: boolean) => import("./types").PagingQueryParsedRequestParams | AggregateQueryParsedRequestParams;
     isValidDateString: (value: string) => boolean;

package/dist/types/aggregationPagingQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aggregationPagingQuery.d.ts","sourceRoot":"","sources":["../../src/aggregationPagingQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,EACL,SAAS,EAKZ,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAC,qBAAqB,EAAE,YAAY,EAAE,iCAAiC,EAAC,MAAM,SAAS,CAAA;AAQnG,qBAAa,sBAAsB;IAC/B,MAAM,EAAG,iCAAiC,CAazC;IACD,OAAO,EAAE,qBAAqB,CAK7B;IACD,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;IACxC,cAAc,EAAE,MAAM,EAAE,CAAK;IAC7B,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;gBACL,GAAG,EAAE,OAAO,CAAC,EAAE,EAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,qBAAqB;IAQ/G,kBAAkB,kCAAqB;IACvC,WAAW,sPAAc;IACzB,iBAAiB,6BAAoB;IACrC,YAAY,2BAAe;IAC3B,eAAe,mEAAkB;IACjC,wBAAwB;;MAA2B;IACnD,YAAY,aAOX;IACD,SAAS,sBAkDR;IACD,cAAc,GAAI,UAAU,GAAG,KAAG,GAAG,CAmCpC;IAED,OAAO,CAAC,qBAAqB,CAS5B;IACD,IAAI,qBAgCH;CAEJ"}
+{"version":3,"file":"aggregationPagingQuery.d.ts","sourceRoot":"","sources":["../../src/aggregationPagingQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,EACL,SAAS,EAKZ,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAC,qBAAqB,EAAE,eAAe,EAAE,iCAAiC,EAAC,MAAM,SAAS,CAAA;AAQtG,qBAAa,sBAAsB;IAC/B,MAAM,EAAG,iCAAiC,CAazC;IACD,OAAO,EAAE,qBAAqB,CAK7B;IACD,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;IACxC,cAAc,EAAE,MAAM,EAAE,CAAK;IAC7B,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;gBACL,GAAG,EAAE,OAAO,CAAC,EAAE,EAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,qBAAqB;IAQlH,kBAAkB,kCAAqB;IACvC,WAAW,sPAAc;IACzB,iBAAiB,6BAAoB;IACrC,YAAY,2BAAe;IAC3B,eAAe,mEAAkB;IACjC,wBAAwB;;MAA2B;IACnD,YAAY,aAOX;IACD,SAAS,sBAkDR;IACD,cAAc,GAAI,UAAU,GAAG,KAAG,GAAG,CAmCpC;IAED,OAAO,CAAC,qBAAqB,CAS5B;IACD,IAAI,qBAgCH;CAEJ"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/types/index.d.ts

@@ -0,0 +1,59 @@
+import mongoose, { QueryOptions, SortOrder, AggregateOptions } from "mongoose";
+import { ParsedQs } from "qs";
+export interface QueryParameters extends ParsedQs {
+    $filter: string;
+    $limit: string;
+    $skip: string;
+    $sort: string;
+    $paging: "yes" | "no" | "0" | "false";
+    $populate: string;
+    $includes: string;
+    $select: string;
+    $count: string;
+}
+export interface StandardParsedRequestParams {
+    $filter?: {
+        [key: string]: any;
+    };
+    $limit: number;
+    $skip: number;
+    $paging?: boolean;
+    $populate?: string[];
+    $includes?: string[];
+    $select?: string;
+}
+export interface PagingQueryParsedRequestParams extends StandardParsedRequestParams {
+    $lean?: boolean;
+    $sort?: [string, SortOrder][];
+}
+export interface AggregateQueryParsedRequestParams extends StandardParsedRequestParams {
+    $preSort: {
+        [key: string]: SortOrder;
+    };
+    $sort: {
+        [key: string]: SortOrder;
+    };
+    $count: string[];
+    $postFilter: {
+        [key: string]: any;
+    };
+}
+export interface StandardQueryOptions extends QueryOptions {
+    disablePaging?: boolean;
+    disableFilter?: boolean;
+}
+export interface PagingQueryOptions extends StandardQueryOptions {
+    staticFilter?: {
+        [key: string]: any;
+    };
+    single?: boolean;
+}
+export interface AggregateQueryOptions extends StandardQueryOptions, Omit<AggregateOptions, 'comment'> {
+    disablePostFilter?: boolean;
+    disablePreSort?: boolean;
+    staticPostFilter?: {
+        [key: string]: any;
+    };
+    pipeline: mongoose.PipelineStage[];
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,EAAE,EAAC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAC7E,OAAO,EAAC,QAAQ,EAAC,MAAM,IAAI,CAAC;AAE5B,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,GAAG,GAAG,OAAO,CAAA;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IACxC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,8BAA+B,SAAQ,2BAA2B;IAC/E,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;CAEhC;AACD,MAAM,WAAW,iCAAkC,SAAQ,2BAA2B;IAClF,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;IACtC,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;IACnC,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,EAAE;QAAC,CAAC,GAAG,EAAC,MAAM,GAAE,GAAG,CAAA;KAAC,CAAA;CAClC;AACD,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC5D,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;CAGpB;AACD,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAAC,SAAS,CAAC;IAEjG,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;IACxC,QAAQ,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAA;CACrC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@r5v/mongoose-paginate",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",
   "scripts": {