express-toolkit 1.0.6 → 1.0.8

package/index.d.ts

@@ -0,0 +1,62 @@
+declare module 'express-toolkit' {
+  import { NextFunction, Request, Response, Router } from 'express';
+  import { Document, Model } from 'mongoose';
+
+  export function buildRouter(config: {
+    controller: Controller;
+    endpoints?: { [key: string]: boolean };
+    id?: string;
+    options?: object;
+  }): Router;
+
+  export class Controller {
+    constructor(config: {
+      name: string;
+      model: Model<Document>;
+      id?: string;
+      defaultSkipValue?: number;
+      defaultLimitValue?: number;
+      useUpdateOne?: boolean;
+    });
+
+    find(query: object): Promise<any[]>;
+    findOne(query: object): Promise<any>;
+    findById(id: string | number, query?: object): Promise<any>;
+    create(data: object | object[]): Promise<any>;
+    bulkCreate(data: object[]): Promise<any[]>;
+    bulkUpdate(documents: object[]): Promise<any>;
+    updateByQuery(query: object, update: object): Promise<any>;
+    updateById(id: string | number, update: object, query?: object): Promise<any>;
+    replaceById(id: string | number, replacement: object, query?: object): Promise<any>;
+    deleteByQuery(query: object): Promise<any>;
+    deleteById(id: string | number, query?: object): Promise<any>;
+    count(query: object): Promise<number>;
+    patchById(id: string | number, operations: object[], query?: object): Promise<any>;
+    registerHook(eventName: string, handler: (req: Request, res: Response, next: NextFunction) => void): void;
+    getHooks(eventName: string): ((req: Request, res: Response, next: NextFunction) => void)[];
+  }
+
+  export class Resource {
+    constructor(config: {
+      name: string;
+      model: Model<Document>;
+      endpoints?: { [key: string]: boolean };
+      id?: string;
+      defaultSkipValue?: number;
+      defaultLimitValue?: number;
+    });
+
+    getRouter(): Router;
+    rebuildRouter(): Router;
+    mount(path: string, app: any): void;
+    registerHook(eventName: string, handler: (req: Request, res: Response, next: NextFunction) => void): void;
+    readonly router: Router;
+  }
+
+  export const utils: {
+    asyncMiddleware(fn: (req: Request, res: Response, next: NextFunction) => Promise<void>): (req: Request, res: Response, next: NextFunction) => void;
+    isJSON(str: string): boolean;
+    getSorting(query: object): object;
+    getProjection(query: object): object | null;
+  };
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "express-toolkit",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "files": [
     "index.js",
     "src/",
-    "types/"
+    "types/",
+    "index.d.ts"
   ],
   "description": "Handy tools for building expressjs based http microservices",
   "main": "index.js",

package/src/router.js

@@ -90,7 +90,7 @@ function buildRouter (config) {
   })
 
   const deleteByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    await config.controller.deleteById(req.params[config.id])
+    await config.controller.deleteById(req.params[config.id], req.query)
     req.toSend = null
     return next()
   })
@@ -116,13 +116,13 @@ function buildRouter (config) {
   })
 
   const patchByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.patchById(req.params[config.id], req.body)
+    const resource = await config.controller.patchById(req.params[config.id], req.body, req.query)
     req.toSend = resource
     return next()
   })
 
   const replaceByIdMiddleware = asyncMiddleware(async (req, res, next) => {
-    const resource = await config.controller.replaceById(req.params[config.id], req.body)
+    const resource = await config.controller.replaceById(req.params[config.id], req.body, req.query)
     req.toSend = resource
     return next()
   })
@@ -181,7 +181,7 @@ function buildRouter (config) {
 
   }
 
-  for (let endpointName in endpoints) {
+  for (const endpointName in endpoints) {
     /**
      * This is for reto-compatibility reasons, some hooks (due to a bug or a bad design decision)
      * did not match the middleware name, for example the pre:update hook is run before the updateByQuery