@r5v/mongoose-paginate 1.0.7 → 1.0.8

package/README.md

@@ -76,7 +76,7 @@ PagingQuery(Express.Request, mongoose.Model, options )
 | $limit      | number                                                                            | limit the number of returned objects                                                                                                                                                                           | PagingQuery, AggregationPagingQuery |
 | $skip       | number                                                                            | skip to the next object on the request                                                                                                                                                                         | PagingQuery, AggregationPagingQuery |
 | $paging     | 'false'\|0\|'no'                                                                  | turn off paging, on by default                                                                                                                                                                                 | PagingQuery, AggregationPagingQuery |
-| $populate   | comma separated dot notation string \n books,publishers                           | using refs and virtuals, a dot notation string will populate the model using .populate                                                                                                                         | PagingQuery                         |
+| $populate   | comma separated dot notation string \n books,publishers                           | using refs and virtuals, a dot notation string will populate the model using .populate. will deep populate and select using \"authors\[name\].books\[title\],publishers\[name\]" notation                      | PagingQuery                         |
 | $select     | comma separated dot notation string \n books,-_id \| -_id,-name,address.-address1 | using the select notation uses the mongoose name \| -name syntax to filter the output. use this in conjunction with the $populate query to filter keys \n ie books.title,books.publisher \| -name,books.-title | PagingQuery, AggregationPagingQuery |   
 | $lean       | no value needed, this will return a lean query result                             | returns a lean result. does not require a value                                                                                                                                                                | PagingQuery                         |   
 | $sort       | space separated mongoose sort string \n name -value                               | inserts sort into the query. In aggregation queries this will insert a sort after the existing pipeline                                                                                                        | PagingQuery, AggregationPagingQuery | 
@@ -127,4 +127,9 @@ $ yarn run start
 
 
 ## NOTES
-1. removeProtected removed from aggregation query due to inconsistent results after publication
+1. removeProtected removed from aggregation query due to inconsistent results after publication
+
+
+### 1.0.8
+
+Adds Deep Populate and Select Notation

package/dist/pagingQuery.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PagingQuery = void 0;
 const parseSortString_1 = require("./utils/parseSortString");
-const parsePopulateQuery_1 = require("./utils/parsePopulateQuery");
+const buildPopulateFromString_1 = require("./utils/buildPopulateFromString");
 const parseParams_1 = require("./utils/parseParams");
 const isJsonString_1 = require("./utils/isJsonString");
 class PagingQuery {
@@ -54,8 +54,7 @@ class PagingQuery {
                 this.query.sort($sort);
             }
             if ($populate) {
-                const selectArr = $select && $select.split(",").map((v) => v.trim()) || [];
-                const popArr = (0, parsePopulateQuery_1.parsePopulateArray)($populate, selectArr);
+                const popArr = (0, buildPopulateFromString_1.buildPopulate)($populate.join(","));
                 popArr.forEach(path => {
                     this.query.populate(path);
                 });
@@ -65,7 +64,7 @@ class PagingQuery {
                 if (!this.isJsonString($select)) {
                     selectStr = $select
                         .split(",")
-                        .filter(item => !($populate || []).some(p => item.trim().startsWith("p")))
+                        .filter(item => !($populate || []).some(p => item.trim().startsWith(p)))
                         .join(" ");
                 }
                 this.query.select(selectStr);

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

@@ -1 +1 @@
-{"version":3,"file":"pagingQuery.d.ts","sourceRoot":"","sources":["../../src/pagingQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,8BAA8B,EAAE,kBAAkB,EAAC,MAAM,SAAS,CAAA;AAC/E,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAA;AAQpC,qBAAa,WAAW;IACpB,MAAM,EAAE,8BAA8B,CAUrC;IACD,OAAO,EAAE,kBAAkB,CAAK;IAChC,KAAK,EAAE,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAO;IAC/C,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;gBAEL,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,GAAE,OAAO,CAAC,kBAAkB,CAAM;IAMtF,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,SAAS,CAqChB;IACD,eAAe,mEAAkB;IACjC,WAAW,sPAAc;IACzB,IAAI,qBAuBH;CACJ"}
+{"version":3,"file":"pagingQuery.d.ts","sourceRoot":"","sources":["../../src/pagingQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,8BAA8B,EAAE,kBAAkB,EAAC,MAAM,SAAS,CAAA;AAC/E,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAA;AASpC,qBAAa,WAAW;IACpB,MAAM,EAAE,8BAA8B,CAUrC;IACD,OAAO,EAAE,kBAAkB,CAAK;IAChC,KAAK,EAAE,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAO;IAC/C,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;gBAEL,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,GAAE,OAAO,CAAC,kBAAkB,CAAM;IAMtF,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,SAAS,CAqChB;IACD,eAAe,mEAAkB;IACjC,WAAW,sPAAc;IACzB,IAAI,qBAuBH;CACJ"}

package/dist/types/utils/buildPopulateFromString.d.ts

@@ -0,0 +1,8 @@
+interface PopulateItem {
+    path: string;
+    select?: string;
+    populate?: PopulateItem[];
+}
+export declare function buildPopulate(pathString: any): PopulateItem[];
+export {};
+//# sourceMappingURL=buildPopulateFromString.d.ts.map

package/dist/types/utils/buildPopulateFromString.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildPopulateFromString.d.ts","sourceRoot":"","sources":["../../../src/utils/buildPopulateFromString.ts"],"names":[],"mappings":"AACA,UAAU,YAAY;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC5B;AAED,wBAAgB,aAAa,CAAC,UAAU,KAAA,GAAE,YAAY,EAAE,CAsDvD"}

package/dist/utils/buildPopulateFromString.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPopulate = buildPopulate;
+function buildPopulate(pathString) {
+    if (!pathString)
+        return [];
+    const splitPaths = (str) => {
+        const paths = [];
+        let current = '';
+        let depth = 0;
+        for (const char of str) {
+            if (char === '[')
+                depth++;
+            else if (char === ']')
+                depth--;
+            if (char === ',' && depth === 0) {
+                paths.push(current.trim());
+                current = '';
+            }
+            else {
+                current += char;
+            }
+        }
+        if (current)
+            paths.push(current.trim());
+        return paths;
+    };
+    const parseSegment = (segment) => {
+        var _a;
+        const match = segment.match(/^([^\[]+)(?:\[([^\]]+)\])?$/);
+        if (!match)
+            return { name: segment };
+        return {
+            name: match[1],
+            select: (_a = match[2]) === null || _a === void 0 ? void 0 : _a.replace(/,/g, ' ')
+        };
+    };
+    const paths = splitPaths(pathString).map(p => p.split('.').map(parseSegment));
+    const processLevel = (paths) => {
+        const groups = {};
+        for (const [first, ...rest] of paths) {
+            const key = first.name;
+            if (!groups[key])
+                groups[key] = { select: first.select, children: [] };
+            if (rest.length)
+                groups[key].children.push(rest);
+        }
+        return Object.entries(groups).map(([key, { select, children }]) => {
+            const obj = { path: key };
+            if (select)
+                obj.select = select;
+            if (children.length)
+                obj.populate = processLevel(children);
+            return obj;
+        });
+    };
+    return processLevel(paths);
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@r5v/mongoose-paginate",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "main": "./dist/index.js",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "prebuild": "rimraf dist/",
     "build": "tsc",