fix: fixed the params type of the group method

atayahmet · Oct 12, 2024 · d5248dc · d5248dc
1 parent 52d754f
commit d5248dc
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 18 deletions.
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "start": "tsdx watch",
-    "build": "tsdx build",
+    "build": "tsdx build && cp src/types.d.ts dist/types.d.ts",
     "test": "tsdx test --coverage",
     "lint": "tsdx lint",
     "prepare": "tsdx build",
@@ -78,4 +78,4 @@
     "lodash.camelcase": "^4.3.0",
     "pluralize": "^8.0.0"
   }
-}
+}
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,10 +1,7 @@
 import {
   NextFunction,
   IRouter as IExpressRouter,
-  Request,
   RequestHandler,
-  Response,
-  Express
 } from 'express';
 
 import RouteGroup from './index';
@@ -14,12 +11,9 @@ export type EndpointNames = keyof typeof RESOURCES;
 export type RequestMethods = 'get' | 'post' | 'put' | 'patch' | 'delete';
 export type RegisterCb = (g: IRouter) => void;
 
-export type GroupArgs =
-  | [path: string, RegisterCb]
-  | [path: string, ...NextFunction[], RegisterCb]
-  | [...NextFunction[], RegisterCb]
+export type GroupArgs = [...unknown[], RegisterCb];
 
-export interface IResource  {
+export interface IResource {
   index?: RequestHandler;
   show?: RequestHandler;
   store?: RequestHandler;
@@ -38,16 +32,16 @@ export type ResourceType = {
     update?: NextFunction[];
     patch?: NextFunction[];
     destroy?: NextFunction[];
-  },
+  };
   parameters?: {
     [prop: string]: string;
-  }
+  };
 };
 
 export type IRouter = IExpressRouter & {
-  get path(): string;
+  getPath(): string;
   getRouter: () => IExpressRouter;
-  listRoutes: () => ({ method: string; path: string; })[];
+  listRoutes: () => { method: string; path: string }[];
   group: (...args: GroupArgs) => IRouter;
   resource: (ins: IResource | ResourceType) => IRouter;
 };
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -24,10 +24,13 @@ describe('express-route-grouping', () => {
       // Assert
       sandbox.assert.calledOnceWithExactly(
         registerSpy,
-        sinon.match.instanceOf(RouteGroup).and(sinon.match.has('path', 'b'))
+        sinon.match.instanceOf(RouteGroup)
       );
 
       expect(result).toBeInstanceOf(RouteGroup);
+
+      const { firstArg: ins } = registerSpy.getCall(0);
+      expect(ins.getPath()).toEqual('b');
     });
 
     it('should be register nested route groups', () => {
@@ -46,10 +49,13 @@ describe('express-route-grouping', () => {
       // Assert
       sandbox.assert.calledOnceWithMatch(
         registerSpy,
-        sinon.match.instanceOf(RouteGroup).and(sinon.match.has('path', 'a/b/c'))
+        sinon.match.instanceOf(RouteGroup)
       );
 
       expect(result).toBeInstanceOf(RouteGroup);
+
+      const { firstArg: ins } = registerSpy.getCall(0);
+      expect(ins.getPath()).toEqual('a/b/c');
     });
 
     it('should be register the group without additional path', () => {
@@ -63,10 +69,13 @@ describe('express-route-grouping', () => {
       // Assert
       sandbox.assert.calledOnceWithExactly(
         registerSpy,
-        sinon.match.instanceOf(RouteGroup).and(sinon.match.has('path', ''))
+        sinon.match.instanceOf(RouteGroup)
       );
 
       expect(result).toBeInstanceOf(RouteGroup);
+
+      const { firstArg: ins } = registerSpy.getCall(0);
+      expect(ins.getPath()).toEqual('');
     });
 
     it('should be register the nested groups without additional path', () => {
@@ -97,10 +106,13 @@ describe('express-route-grouping', () => {
       // Assert
       sandbox.assert.calledOnceWithExactly(
         registerSpy,
-        sinon.match.instanceOf(RouteGroup).and(sinon.match.has('path', 'c/d'))
+        sinon.match.instanceOf(RouteGroup)
       );
 
       expect(result).toBeInstanceOf(RouteGroup);
+
+      const { firstArg: ins } = registerSpy.getCall(0);
+      expect(ins.getPath()).toEqual('c/d');
     });
   });