@nmshd/typescript-rest 3.2.0 → 3.2.2

package/.ci/runChecks.sh

@@ -4,4 +4,4 @@ npm ci
 npm run build
 npm run lint
 npx license-check
-npx better-npm-audit audit --exclude=1106509,1096727,1097682
+npx better-npm-audit audit --exclude=1109540,1096727,1097682

package/.github/workflows/publish.yml

@@ -8,8 +8,8 @@ jobs:
   run-checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v6
         with:
           node-version: current
       - run: bash .ci/runChecks.sh
@@ -28,6 +28,4 @@ jobs:
       - run: npm ci
       - run: npm run build
       - run: npx enhanced-publish --if-possible --use-preid-as-tag
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
     needs: ['run-checks']

package/.github/workflows/test.yml

@@ -13,8 +13,8 @@ jobs:
   run-checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v6
         with:
           node-version: current
       - run: bash .ci/runChecks.sh

package/dist/middlewares/routeRequiresAuthorization.js

@@ -13,11 +13,11 @@ function routeRequiresAuthorization(authenticator, ...permittedRoles) {
         throw new Error(`Invalid permitted role(s) specified: ${nonMatchingRoles.join(', ')}. Roles must match the pattern: ${roleRegex}.`);
     }
     return (req, res, next) => {
-        const requestRoles = authenticator.getRoles(req, res);
+        const rawUserRoles = authenticator.getRoles(req, res);
         if (debuggerInstance.enabled)
-            debuggerInstance('Validating authentication roles: <%j>.', requestRoles);
-        const transformedRoles = requestRoles.map(transformUserRole);
-        const isAuthorized = permittedRoles.some((permittedRole) => isRoleMatched(permittedRole, transformedRoles));
+            debuggerInstance('Validating authentication roles: <%j>.', rawUserRoles);
+        const userRoles = rawUserRoles.map(Role.from);
+        const isAuthorized = permittedRoles.some((r) => isRoleMatched(r, userRoles));
         if (!isAuthorized) {
             next(new Errors.ForbiddenError('You are not allowed to access this endpoint.'));
             return;
@@ -26,19 +26,25 @@ function routeRequiresAuthorization(authenticator, ...permittedRoles) {
     };
 }
 function isRoleMatched(permittedRole, userRoles) {
-    for (const userRole of userRoles) {
-        const isMatch = userRole.test(permittedRole);
-        if (isMatch)
-            return true;
-    }
-    return false;
+    return userRoles.some((userRole) => userRole.matches(permittedRole));
 }
-function transformUserRole(userRole) {
-    if (!userRole.includes('*'))
-        return new RegExp(`^${userRole}$`);
-    const regexString = userRole
-        .replaceAll('**', '[a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+){0,}')
-        .replaceAll('*', '[a-zA-Z0-9_-]+');
-    return new RegExp(`^${regexString}$`);
+class Role {
+    constructor(role) {
+        this.roleRegex = this.transformUserRole(role);
+    }
+    static from(role) {
+        return new Role(role);
+    }
+    transformUserRole(userRole) {
+        if (!userRole.includes('*'))
+            return new RegExp(`^${userRole}$`);
+        const regexString = userRole
+            .replaceAll('**', '[a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+){0,}')
+            .replaceAll('*', '[a-zA-Z0-9_-]+');
+        return new RegExp(`^${regexString}$`);
+    }
+    matches(permittedRole) {
+        return this.roleRegex.test(permittedRole);
+    }
 }
 //# sourceMappingURL=routeRequiresAuthorization.js.map

package/dist/middlewares/routeRequiresAuthorization.js.map

@@ -1 +1 @@
-{"version":3,"file":"routeRequiresAuthorization.js","sourceRoot":"","sources":["../../src/middlewares/routeRequiresAuthorization.ts"],"names":[],"mappings":";;AAMA,gEA2BC;AAjCD,+BAA+B;AAE/B,iDAAiD;AAEjD,MAAM,gBAAgB,GAAG,KAAK,CAAC,wDAAwD,CAAC,CAAC;AAEzF,SAAgB,0BAA0B,CACtC,aAA2E,EAC3E,GAAG,cAA0C;IAE7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IAEnG,MAAM,SAAS,GAAG,uCAAuC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CACX,wCAAwC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,SAAS,GAAG,CACrH,CAAC;IACN,CAAC;IAED,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;QACvD,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,gBAAgB,CAAC,OAAO;YAAE,gBAAgB,CAAC,wCAAwC,EAAE,YAAY,CAAC,CAAC;QAEvG,MAAM,gBAAgB,GAAG,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;QAC5G,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,8CAA8C,CAAC,CAAC,CAAC;YAChF,OAAO;QACX,CAAC;QAED,IAAI,EAAE,CAAC;IACX,CAAC,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,aAAqB,EAAE,SAAwB;IAClE,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,OAAO;YAAE,OAAO,IAAI,CAAC;IAC7B,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB;IACvC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,MAAM,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEhE,MAAM,WAAW,GAAG,QAAQ;SACvB,UAAU,CAAC,IAAI,EAAE,qCAAqC,CAAC;SACvD,UAAU,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;IACvC,OAAO,IAAI,MAAM,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"routeRequiresAuthorization.js","sourceRoot":"","sources":["../../src/middlewares/routeRequiresAuthorization.ts"],"names":[],"mappings":";;AAMA,gEA2BC;AAjCD,+BAA+B;AAE/B,iDAAiD;AAEjD,MAAM,gBAAgB,GAAG,KAAK,CAAC,wDAAwD,CAAC,CAAC;AAEzF,SAAgB,0BAA0B,CACtC,aAA2E,EAC3E,GAAG,cAA0C;IAE7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IAEnG,MAAM,SAAS,GAAG,uCAAuC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CACX,wCAAwC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,SAAS,GAAG,CACrH,CAAC;IACN,CAAC;IAED,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;QACvD,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,gBAAgB,CAAC,OAAO;YAAE,gBAAgB,CAAC,wCAAwC,EAAE,YAAY,CAAC,CAAC;QAEvG,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,8CAA8C,CAAC,CAAC,CAAC;YAChF,OAAO;QACX,CAAC;QAED,IAAI,EAAE,CAAC;IACX,CAAC,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,aAAqB,EAAE,SAAsB;IAChE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,IAAI;IAGN,YAAoB,IAAY;QAC5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY;QAC3B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAEO,iBAAiB,CAAC,QAAgB;QACtC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,MAAM,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC;QAEhE,MAAM,WAAW,GAAG,QAAQ;aACvB,UAAU,CAAC,IAAI,EAAE,qCAAqC,CAAC;aACvD,UAAU,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC;IAC1C,CAAC;IAEM,OAAO,CAAC,aAAqB;QAChC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nmshd/typescript-rest",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "A Library to create RESTFul APIs with Typescript",
   "keywords": [
     "API",
@@ -60,44 +60,44 @@
     "sourceMap": true
   },
   "dependencies": {
-    "@types/body-parser": "1.19.5",
-    "@types/cookie-parser": "^1.4.8",
-    "@types/express": "^5.0.2",
-    "@types/multer": "^1.4.13",
-    "body-parser": "^2.2.0",
+    "@types/body-parser": "1.19.6",
+    "@types/cookie-parser": "^1.4.9",
+    "@types/express": "^5.0.3",
+    "@types/multer": "^2.0.0",
+    "body-parser": "^2.2.1",
     "cookie-parser": "^1.4.7",
     "express": "^5.1.0",
-    "fs-extra": "^11.3.0",
+    "fs-extra": "^11.3.2",
     "lodash": "^4.17.21",
-    "multer": "^2.0.1",
+    "multer": "^2.0.2",
     "reflect-metadata": "^0.2.2",
     "require-glob": "^4.1.0",
     "swagger-ui-express": "^5.0.1",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
-    "@js-soft/license-check": "^1.0.9",
-    "@nmshd/typescript-ioc": "^3.2.4",
+    "@js-soft/license-check": "^1.0.10",
+    "@nmshd/typescript-ioc": "^3.2.5",
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
-    "@types/jest": "^29.5.14",
-    "@types/lodash": "^4.17.16",
-    "@types/node": "^22.15.19",
-    "@types/request": "^2.48.12",
+    "@types/jest": "^30.0.0",
+    "@types/lodash": "^4.17.20",
+    "@types/node": "^24.7.2",
+    "@types/request": "^2.48.13",
     "@types/yamljs": "^0.2.34",
     "@typescript-eslint/eslint-plugin": "^6.20.0",
     "@typescript-eslint/parser": "^6.20.0",
-    "cross-env": "^7.0.3",
+    "cross-env": "^10.1.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jsdoc": "^48.0.4",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "jest": "^29.7.0",
-    "prettier": "^3.5.3",
+    "jest": "^30.2.0",
+    "prettier": "^3.6.2",
     "request": "^2.88.2",
     "rimraf": "^6.0.1",
-    "ts-jest": "^29.3.4",
-    "typescript": "^5.8.3"
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=6.0.0"

package/src/middlewares/routeRequiresAuthorization.ts

@@ -19,11 +19,11 @@ export function routeRequiresAuthorization(
     }
 
     return (req: Request, res: Response, next: NextFunction) => {
-        const requestRoles = authenticator.getRoles(req, res);
-        if (debuggerInstance.enabled) debuggerInstance('Validating authentication roles: <%j>.', requestRoles);
+        const rawUserRoles = authenticator.getRoles(req, res);
+        if (debuggerInstance.enabled) debuggerInstance('Validating authentication roles: <%j>.', rawUserRoles);
 
-        const transformedRoles = requestRoles.map(transformUserRole);
-        const isAuthorized = permittedRoles.some((permittedRole) => isRoleMatched(permittedRole, transformedRoles));
+        const userRoles = rawUserRoles.map(Role.from);
+        const isAuthorized = permittedRoles.some((r) => isRoleMatched(r, userRoles));
         if (!isAuthorized) {
             next(new Errors.ForbiddenError('You are not allowed to access this endpoint.'));
             return;
@@ -33,20 +33,31 @@ export function routeRequiresAuthorization(
     };
 }
 
-function isRoleMatched(permittedRole: string, userRoles: Array<RegExp>): boolean {
-    for (const userRole of userRoles) {
-        const isMatch = userRole.test(permittedRole);
-        if (isMatch) return true;
+function isRoleMatched(permittedRole: string, userRoles: Array<Role>): boolean {
+    return userRoles.some((userRole) => userRole.matches(permittedRole));
+}
+
+class Role {
+    private roleRegex: RegExp;
+
+    private constructor(role: string) {
+        this.roleRegex = this.transformUserRole(role);
     }
 
-    return false;
-}
+    public static from(role: string): Role {
+        return new Role(role);
+    }
+
+    private transformUserRole(userRole: string): RegExp {
+        if (!userRole.includes('*')) return new RegExp(`^${userRole}$`);
 
-function transformUserRole(userRole: string): RegExp {
-    if (!userRole.includes('*')) return new RegExp(`^${userRole}$`);
+        const regexString = userRole
+            .replaceAll('**', '[a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+){0,}')
+            .replaceAll('*', '[a-zA-Z0-9_-]+');
+        return new RegExp(`^${regexString}$`);
+    }
 
-    const regexString = userRole
-        .replaceAll('**', '[a-zA-Z0-9_-]+(:[a-zA-Z0-9_-]+){0,}')
-        .replaceAll('*', '[a-zA-Z0-9_-]+');
-    return new RegExp(`^${regexString}$`);
+    public matches(permittedRole: string): unknown {
+        return this.roleRegex.test(permittedRole);
+    }
 }