@r5v/mongoose-paginate 1.0.10 → 1.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { Model, Aggregate } from "mongoose";
|
|
2
2
|
import type { Request } from "express";
|
|
3
|
-
import type { AggregateQueryOptions,
|
|
3
|
+
import type { AggregateQueryOptions, QueryParameters, AggregateQueryParsedRequestParams } from './types';
|
|
4
4
|
export declare class AggregationPagingQuery {
|
|
5
5
|
params: AggregateQueryParsedRequestParams;
|
|
6
6
|
options: AggregateQueryOptions;
|
|
7
7
|
query: Aggregate<Array<any>> | undefined;
|
|
8
8
|
protectedPaths: string[];
|
|
9
9
|
model: Model<any>;
|
|
10
|
-
constructor(req: Request<{}, any, any, Partial<
|
|
10
|
+
constructor(req: Request<{}, any, any, Partial<QueryParameters>>, model: Model<any>, options: AggregateQueryOptions);
|
|
11
11
|
findProtectedPaths: (model: Model<any>) => string[];
|
|
12
12
|
parseParams: (defaultParams: import("./types").PagingQueryParsedRequestParams | AggregateQueryParsedRequestParams, params: import("qs").ParsedQs, isAggregate?: boolean) => import("./types").PagingQueryParsedRequestParams | AggregateQueryParsedRequestParams;
|
|
13
13
|
isValidDateString: (value: string) => boolean;
|
|
@@ -1 +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,
|
|
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,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"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import mongoose, { QueryOptions, SortOrder, AggregateOptions } from "mongoose";
|
|
2
|
+
import { ParsedQs } from "qs";
|
|
3
|
+
export interface QueryParameters extends ParsedQs {
|
|
4
|
+
$filter: string;
|
|
5
|
+
$limit: string;
|
|
6
|
+
$skip: string;
|
|
7
|
+
$sort: string;
|
|
8
|
+
$paging: "yes" | "no" | "0" | "false";
|
|
9
|
+
$populate: string;
|
|
10
|
+
$includes: string;
|
|
11
|
+
$select: string;
|
|
12
|
+
$count: string;
|
|
13
|
+
}
|
|
14
|
+
export interface StandardParsedRequestParams {
|
|
15
|
+
$filter?: {
|
|
16
|
+
[key: string]: any;
|
|
17
|
+
};
|
|
18
|
+
$limit: number;
|
|
19
|
+
$skip: number;
|
|
20
|
+
$paging?: boolean;
|
|
21
|
+
$populate?: string[];
|
|
22
|
+
$includes?: string[];
|
|
23
|
+
$select?: string;
|
|
24
|
+
}
|
|
25
|
+
export interface PagingQueryParsedRequestParams extends StandardParsedRequestParams {
|
|
26
|
+
$lean?: boolean;
|
|
27
|
+
$sort?: [string, SortOrder][];
|
|
28
|
+
}
|
|
29
|
+
export interface AggregateQueryParsedRequestParams extends StandardParsedRequestParams {
|
|
30
|
+
$preSort: {
|
|
31
|
+
[key: string]: SortOrder;
|
|
32
|
+
};
|
|
33
|
+
$sort: {
|
|
34
|
+
[key: string]: SortOrder;
|
|
35
|
+
};
|
|
36
|
+
$count: string[];
|
|
37
|
+
$postFilter: {
|
|
38
|
+
[key: string]: any;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export interface StandardQueryOptions extends QueryOptions {
|
|
42
|
+
disablePaging?: boolean;
|
|
43
|
+
disableFilter?: boolean;
|
|
44
|
+
}
|
|
45
|
+
export interface PagingQueryOptions extends StandardQueryOptions {
|
|
46
|
+
staticFilter?: {
|
|
47
|
+
[key: string]: any;
|
|
48
|
+
};
|
|
49
|
+
single?: boolean;
|
|
50
|
+
}
|
|
51
|
+
export interface AggregateQueryOptions extends StandardQueryOptions, Omit<AggregateOptions, 'comment'> {
|
|
52
|
+
disablePostFilter?: boolean;
|
|
53
|
+
disablePreSort?: boolean;
|
|
54
|
+
staticPostFilter?: {
|
|
55
|
+
[key: string]: any;
|
|
56
|
+
};
|
|
57
|
+
pipeline: mongoose.PipelineStage[];
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|