@ewb/mongoose-query-express 1.1.1 → 1.2.0

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,24 +1,24 @@
1
- ## Mongoose Query Express
2
-
3
- ### Info
4
- Library to for Express to create simple reusable queries and logic for mongoose.\
5
- Never write the simple get, post, patch and delete function over and over again.\
6
-
7
- Used in combination with [mongoose-query](https://github.com/EmilsWebbod/mongoose-query) to create the model logic.\
8
-
9
- ### Usage
10
- ```
11
- import { QueryExpress, QueryModel, QueryOptions } from 'mongoose-query-express';
12
-
13
- const options = new QueryOptions({ .... });
14
- const userQueryModel = new QueryModel<User>(User, options);
15
- const userQuery = new QueryExpress('user', userQueryModel, {...});
16
-
17
- const user = express();
18
-
19
- user.param('id', userQuery.param);
20
- user.get('/', userQuery.get);
21
- user.post('/', userQuery.post);
22
- user.patch('/:id', userQuery.patch);
23
- user.delete('/:id', userQuery.delete); // Can also use userQuery.archive if archive option set.
24
- ```
1
+ ## Mongoose Query Express
2
+
3
+ ### Info
4
+ Library to for Express to create simple reusable queries and logic for mongoose.\
5
+ Never write the simple get, post, patch and delete function over and over again.\
6
+
7
+ Used in combination with [mongoose-query](https://github.com/EmilsWebbod/mongoose-query) to create the model logic.\
8
+
9
+ ### Usage
10
+ ```
11
+ import { QueryExpress, QueryModel, QueryOptions } from 'mongoose-query-express';
12
+
13
+ const options = new QueryOptions({ .... });
14
+ const userQueryModel = new QueryModel<User>(User, options);
15
+ const userQuery = new QueryExpress('user', userQueryModel, {...});
16
+
17
+ const user = express();
18
+
19
+ user.param('id', userQuery.param);
20
+ user.get('/', userQuery.get);
21
+ user.post('/', userQuery.post);
22
+ user.patch('/:id', userQuery.patch);
23
+ user.delete('/:id', userQuery.delete); // Can also use userQuery.archive if archive option set.
24
+ ```
@@ -1,31 +1,3 @@
1
- /// <reference types="mongoose/types/document.js" />
2
- /// <reference types="mongoose/types/types.js" />
3
- /// <reference types="mongoose/types/query.js" />
4
- /// <reference types="mongoose/types/aggregate.js" />
5
- /// <reference types="mongoose/types/callback.js" />
6
- /// <reference types="mongoose/types/collection.js" />
7
- /// <reference types="mongoose/types/connection.js" />
8
- /// <reference types="mongoose/types/cursor.js" />
9
- /// <reference types="mongoose/types/document.js" />
10
- /// <reference types="mongoose/types/error.js" />
11
- /// <reference types="mongoose/types/expressions.js" />
12
- /// <reference types="mongoose/types/helpers.js" />
13
- /// <reference types="mongoose/types/middlewares.js" />
14
- /// <reference types="mongoose/types/indexes.js" />
15
- /// <reference types="mongoose/types/models.js" />
16
- /// <reference types="mongoose/types/mongooseoptions.js" />
17
- /// <reference types="mongoose/types/pipelinestage.js" />
18
- /// <reference types="mongoose/types/populate.js" />
19
- /// <reference types="mongoose/types/query.js" />
20
- /// <reference types="mongoose/types/schemaoptions.js" />
21
- /// <reference types="mongoose/types/schematypes.js" />
22
- /// <reference types="mongoose/types/session.js" />
23
- /// <reference types="mongoose/types/types.js" />
24
- /// <reference types="mongoose/types/utility.js" />
25
- /// <reference types="mongoose/types/validation.js" />
26
- /// <reference types="mongoose/types/virtuals.js" />
27
- /// <reference types="mongoose/types/inferrawdoctype.js" />
28
- /// <reference types="mongoose/types/inferschematype.js" />
29
1
  import { ISearchPaginate, Query, QueryModel } from '@ewb/mongoose-query';
30
2
  import { NextFunction, Request, Response } from 'express';
31
3
  import mongoose from 'mongoose';
@@ -45,11 +17,13 @@ export interface IQueryExpressHandlerOptions<R extends Request, T extends object
45
17
  interface BulkProps {
46
18
  runNext?: boolean;
47
19
  }
48
- export declare class QueryExpress<R extends Request, T extends mongoose.Document<mongoose.Types.ObjectId>> {
20
+ export declare class QueryExpress<R extends Request, DocType extends object, T extends mongoose.HydratedDocument<DocType, {
21
+ _id: mongoose.Types.ObjectId;
22
+ }>> {
49
23
  private param;
50
24
  private handler;
51
25
  readonly options: IQueryExpressHandlerOptions<R, T>;
52
- constructor(param: keyof R, handler: QueryModel<T>, options?: IQueryExpressHandlerOptions<R, T>);
26
+ constructor(param: keyof R, handler: QueryModel<DocType>, options?: IQueryExpressHandlerOptions<R, T>);
53
27
  post(req: R, res: Response, next: NextFunction): Promise<void>;
54
28
  findOne(req: R, _res: Response, next: NextFunction): Promise<void>;
55
29
  search(req: R, res: Response, next: NextFunction): Promise<void | Response<any, Record<string, any>>>;
@@ -65,7 +39,7 @@ export declare class QueryExpress<R extends Request, T extends mongoose.Document
65
39
  bulkArchive({ runNext }: BulkProps): (req: R, res: Response, next: NextFunction) => Promise<void>;
66
40
  addToNextQuery(fn: (req: R) => mongoose.FilterQuery<T> | null): (req: R, _: Response, next: NextFunction) => void;
67
41
  subRoute(req: R, _res: Response, next: NextFunction): void;
68
- subDoc<R2 extends keyof R, P extends keyof T>(reqKey: R2, subArrayKey: P): QueryExpressSub<R, T, P>;
42
+ subDoc<R2 extends keyof R, P extends keyof DocType>(reqKey: R2, subArrayKey: P): QueryExpressSub<R, DocType, P, T>;
69
43
  addRootRequest(req: R): void;
70
44
  getRootQuery(req: R): mongoose.FilterQuery<T>;
71
45
  removeRootRequest(req: R, slugKey?: string): void;
@@ -75,7 +49,7 @@ export declare class QueryExpress<R extends Request, T extends mongoose.Document
75
49
  preHistory(req: R): void;
76
50
  postHistory(req: R, fetchNew?: boolean): Promise<void>;
77
51
  init(req: R): void;
78
- query(req: R): Query<T, object, import("@ewb/mongoose-query").IMongooseQueryOptions>;
52
+ query(req: R): Query<DocType>;
79
53
  pageLinkHeader(req: R, data: ISearchPaginate<any>): string;
80
54
  private getDoc;
81
55
  private getFindOpts;
@@ -1,5 +1,5 @@
1
1
  import { getPageLinkHeader, QueryError, } from '@ewb/mongoose-query';
2
- import httpStatus from 'http-status';
2
+ import status from 'http-status';
3
3
  import mongoose from 'mongoose';
4
4
  import { QueryExpressSub } from './QueryExpressSub.js';
5
5
  export class QueryExpress {
@@ -279,7 +279,7 @@ export class QueryExpress {
279
279
  if (this.options.slugKey) {
280
280
  return { [this.options.slugKey]: param };
281
281
  }
282
- throw new QueryError(httpStatus.BAD_REQUEST, `Param is not valid`, {
282
+ throw new QueryError(status.BAD_REQUEST, `Param is not valid`, {
283
283
  detail: 'Need to be of type MongoDB ObjectID',
284
284
  });
285
285
  }
@@ -315,7 +315,7 @@ export class QueryExpress {
315
315
  return this.getDoc(req, param)._id.toHexString();
316
316
  }
317
317
  if (!req.params[param]) {
318
- throw new QueryError(httpStatus.BAD_REQUEST, String(param), {
318
+ throw new QueryError(status.BAD_REQUEST, String(param), {
319
319
  detail: 'Param is not valid',
320
320
  });
321
321
  }
@@ -354,7 +354,7 @@ export class QueryExpress {
354
354
  return req[this.options.queryKey];
355
355
  }
356
356
  if (!req.ewb.query) {
357
- throw new QueryError(httpStatus.INTERNAL_SERVER_ERROR, 'Query not init', {
357
+ throw new QueryError(status.INTERNAL_SERVER_ERROR, 'Query not init', {
358
358
  detail: `ewb.query missing or queryKey option missing in QueryExpress ${String(this.param)}`,
359
359
  });
360
360
  }
@@ -375,14 +375,14 @@ export class QueryExpress {
375
375
  }
376
376
  validateReq(req) {
377
377
  if (!req[this.param]) {
378
- throw new QueryError(httpStatus.BAD_REQUEST, String(this.param), {
378
+ throw new QueryError(status.NOT_FOUND, String(this.param), {
379
379
  detail: 'Param is not valid',
380
380
  });
381
381
  }
382
382
  }
383
383
  validateIdsInBody(req) {
384
384
  if (!req.body.ids) {
385
- throw new QueryError(httpStatus.BAD_REQUEST, 'ids', {
385
+ throw new QueryError(status.BAD_REQUEST, 'ids', {
386
386
  detail: 'ids is required',
387
387
  });
388
388
  }
@@ -1,40 +1,15 @@
1
- /// <reference types="mongoose/types/document.js" />
2
- /// <reference types="mongoose/types/types.js" />
3
- /// <reference types="mongoose/types/aggregate.js" />
4
- /// <reference types="mongoose/types/callback.js" />
5
- /// <reference types="mongoose/types/collection.js" />
6
- /// <reference types="mongoose/types/connection.js" />
7
- /// <reference types="mongoose/types/cursor.js" />
8
- /// <reference types="mongoose/types/document.js" />
9
- /// <reference types="mongoose/types/error.js" />
10
- /// <reference types="mongoose/types/expressions.js" />
11
- /// <reference types="mongoose/types/helpers.js" />
12
- /// <reference types="mongoose/types/middlewares.js" />
13
- /// <reference types="mongoose/types/indexes.js" />
14
- /// <reference types="mongoose/types/models.js" />
15
- /// <reference types="mongoose/types/mongooseoptions.js" />
16
- /// <reference types="mongoose/types/pipelinestage.js" />
17
- /// <reference types="mongoose/types/populate.js" />
18
- /// <reference types="mongoose/types/query.js" />
19
- /// <reference types="mongoose/types/schemaoptions.js" />
20
- /// <reference types="mongoose/types/schematypes.js" />
21
- /// <reference types="mongoose/types/session.js" />
22
- /// <reference types="mongoose/types/types.js" />
23
- /// <reference types="mongoose/types/utility.js" />
24
- /// <reference types="mongoose/types/validation.js" />
25
- /// <reference types="mongoose/types/virtuals.js" />
26
- /// <reference types="mongoose/types/inferrawdoctype.js" />
27
- /// <reference types="mongoose/types/inferschematype.js" />
28
1
  import { QueryModel } from '@ewb/mongoose-query';
29
2
  import { NextFunction, Request, Response } from 'express';
30
3
  import mongoose from 'mongoose';
31
4
  import { QueryExpress } from './QueryExpress.js';
32
- export declare class QueryExpressSub<R extends Request, T extends mongoose.Document<mongoose.Types.ObjectId>, K extends keyof T> {
5
+ export declare class QueryExpressSub<R extends Request, DocType extends object, K extends keyof DocType, T extends mongoose.HydratedDocument<DocType, {
6
+ _id: mongoose.Types.ObjectId;
7
+ }>> {
33
8
  private handler;
34
9
  private express;
35
10
  private param;
36
11
  private subKey;
37
- constructor(handler: QueryModel<T>, express: QueryExpress<R, T>, param: keyof R, subKey: K);
12
+ constructor(handler: QueryModel<DocType>, express: QueryExpress<R, DocType, T>, param: keyof R, subKey: K);
38
13
  post(req: R, _res: Response, next: NextFunction): Promise<void>;
39
14
  search(req: R, res: Response, next: NextFunction): Promise<Response<any, Record<string, any>>>;
40
15
  findOne(req: R, _res: Response, next: NextFunction): Promise<void>;
@@ -1,5 +1,5 @@
1
1
  import { QueryError } from '@ewb/mongoose-query';
2
- import httpStatus from 'http-status';
2
+ import status from 'http-status';
3
3
  import mongoose from 'mongoose';
4
4
  export class QueryExpressSub {
5
5
  constructor(handler, express, param, subKey) {
@@ -97,7 +97,7 @@ export class QueryExpressSub {
97
97
  }
98
98
  validateReq(req) {
99
99
  if (!req[this.param]) {
100
- throw new QueryError(httpStatus.NOT_FOUND, 'Document not found', {
100
+ throw new QueryError(status.NOT_FOUND, 'Document not found', {
101
101
  detail: `Param ${String(this.param)} not found`,
102
102
  });
103
103
  }
package/lib/types.d.ts CHANGED
@@ -1,29 +1,3 @@
1
- /// <reference types="mongoose/types/types.js" />
2
- /// <reference types="mongoose/types/aggregate.js" />
3
- /// <reference types="mongoose/types/callback.js" />
4
- /// <reference types="mongoose/types/collection.js" />
5
- /// <reference types="mongoose/types/connection.js" />
6
- /// <reference types="mongoose/types/cursor.js" />
7
- /// <reference types="mongoose/types/document.js" />
8
- /// <reference types="mongoose/types/error.js" />
9
- /// <reference types="mongoose/types/expressions.js" />
10
- /// <reference types="mongoose/types/helpers.js" />
11
- /// <reference types="mongoose/types/middlewares.js" />
12
- /// <reference types="mongoose/types/indexes.js" />
13
- /// <reference types="mongoose/types/models.js" />
14
- /// <reference types="mongoose/types/mongooseoptions.js" />
15
- /// <reference types="mongoose/types/pipelinestage.js" />
16
- /// <reference types="mongoose/types/populate.js" />
17
- /// <reference types="mongoose/types/query.js" />
18
- /// <reference types="mongoose/types/schemaoptions.js" />
19
- /// <reference types="mongoose/types/schematypes.js" />
20
- /// <reference types="mongoose/types/session.js" />
21
- /// <reference types="mongoose/types/types.js" />
22
- /// <reference types="mongoose/types/utility.js" />
23
- /// <reference types="mongoose/types/validation.js" />
24
- /// <reference types="mongoose/types/virtuals.js" />
25
- /// <reference types="mongoose/types/inferrawdoctype.js" />
26
- /// <reference types="mongoose/types/inferschematype.js" />
27
1
  import type { ISearchPaginate, Query, QueryHistory } from '@ewb/mongoose-query';
28
2
  import mongoose from 'mongoose';
29
3
  import type { IQueryExpressOptions } from './QueryExpress.js';
package/package.json CHANGED
@@ -1,63 +1,62 @@
1
- {
2
- "name": "@ewb/mongoose-query-express",
3
- "version": "1.1.1",
4
- "type": "module",
5
- "description": "Routes and controllers for express to handle mongoose queries",
6
- "main": "./lib/index.js",
7
- "types": "./lib/index.d.ts",
8
- "scripts": {
9
- "dev": "yarn build:watch",
10
- "build": "tsc",
11
- "build:watch": "tsc --watch --incremental",
12
- "lint": "tslint --project \"./tsconfig.json\"",
13
- "test": "vitest run",
14
- "test:ui": "vitest --ui",
15
- "postversion": "git push && git push --tags",
16
- "prepublish": "yarn test && yarn build",
17
- "preversion": "yarn build"
18
- },
19
- "dependencies": {
20
- "http-status": "^1.6.2"
21
- },
22
- "devDependencies": {
23
- "@ewb/mongoose-query": "*",
24
- "@types/express": "^4.17.17",
25
- "@vitest/ui": "^0.31.1",
26
- "express": "^4.18.2",
27
- "husky": "^8.0.3",
28
- "lint-staged": "^13.2.2",
29
- "mongoose": "^8.4.1",
30
- "prettier": "^2.8.8",
31
- "tslint": "^6.1.3",
32
- "typescript": "^5.4.5",
33
- "vitest": "^0.31.1"
34
- },
35
- "peerDependencies": {
36
- "@ewb/mongoose-query": "*"
37
- },
38
- "repository": {
39
- "type": "git",
40
- "url": "git+https://github.com/emilswebbod/mongoose-query-express.git"
41
- },
42
- "keywords": [
43
- "typescript",
44
- "npm",
45
- "translate"
46
- ],
47
- "author": "Emils Webbod",
48
- "license": "MIT",
49
- "bugs": {
50
- "url": "https://github.com/emilswebbod/mongoose-query-express/issues"
51
- },
52
- "homepage": "https://github.com/emilswebbod/mongoose-query-express#readme",
53
- "files": [
54
- "lib"
55
- ],
56
- "husky": {
57
- "hooks": {
58
- "pre-commit": "pretty-quick --staged"
59
- }
60
- },
61
- "resolutions": {},
62
- "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
63
- }
1
+ {
2
+ "name": "@ewb/mongoose-query-express",
3
+ "version": "1.2.0",
4
+ "type": "module",
5
+ "description": "Routes and controllers for express to handle mongoose queries",
6
+ "main": "./lib/index.js",
7
+ "types": "./lib/index.d.ts",
8
+ "dependencies": {
9
+ "http-status": "^2.1.0"
10
+ },
11
+ "devDependencies": {
12
+ "@ewb/mongoose-query": "*",
13
+ "@types/express": "^4.17.25",
14
+ "@vitest/ui": "^4.1.0",
15
+ "express": "^4.22.1",
16
+ "husky": "^9.1.7",
17
+ "lint-staged": "^13.2.2",
18
+ "mongoose": "^8.6.4",
19
+ "prettier": "^3.8.1",
20
+ "typescript": "^5.9.3",
21
+ "vite": "^8.0.0",
22
+ "vitest": "^4.1.0"
23
+ },
24
+ "peerDependencies": {
25
+ "@ewb/mongoose-query": "*"
26
+ },
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "git+https://github.com/emilswebbod/mongoose-query-express.git"
30
+ },
31
+ "keywords": [
32
+ "typescript",
33
+ "npm",
34
+ "translate"
35
+ ],
36
+ "author": "Emils Webbod",
37
+ "license": "MIT",
38
+ "bugs": {
39
+ "url": "https://github.com/emilswebbod/mongoose-query-express/issues"
40
+ },
41
+ "homepage": "https://github.com/emilswebbod/mongoose-query-express#readme",
42
+ "files": [
43
+ "lib"
44
+ ],
45
+ "husky": {
46
+ "hooks": {
47
+ "pre-commit": "pretty-quick --staged"
48
+ }
49
+ },
50
+ "resolutions": {},
51
+ "scripts": {
52
+ "dev": "pnpm build:watch",
53
+ "build": "tsc",
54
+ "build:watch": "tsc --watch --incremental",
55
+ "lint": "tslint --project \"./tsconfig.json\"",
56
+ "test": "vitest run",
57
+ "test:ui": "vitest --ui",
58
+ "postversion": "git push && git push --tags",
59
+ "prepublish": "pnpm test && pnpm build",
60
+ "preversion": "pnpm build"
61
+ }
62
+ }