Merge pull request #333 from axa-group/ntk/bump

Bump dependencies

Author: nulltoken

.eslintignore

@@ -0,0 +1,85 @@
+import eslint from '@eslint/js';
+import jsdoc from 'eslint-plugin-jsdoc';
+import tseslint from 'typescript-eslint';
+import prettierConfig from 'eslint-config-prettier';
+import eslintPluginPrettierRecommendedConfig from 'eslint-plugin-prettier/recommended';
+import importPlugin from 'eslint-plugin-import';
+import vitest from '@vitest/eslint-plugin';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.strictTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  prettierConfig,
+  eslintPluginPrettierRecommendedConfig,
+  importPlugin.flatConfigs.recommended,
+  importPlugin.flatConfigs.typescript,
+  jsdoc.configs['flat/recommended-typescript'],
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    ignores: ['node_modules/*', 'dist/*', 'coverage/*', '.vscode/*'],
+  },
+  {
+    rules: {
+      curly: 'warn',
+      eqeqeq: 'warn',
+      semi: 'warn',
+      '@typescript-eslint/consistent-type-imports': 'warn',
+      'jsdoc/require-jsdoc': [
+        'warn',
+        {
+          publicOnly: true,
+        },
+      ],
+      "import/order": [
+        "error",
+        {
+          "groups": [
+            "builtin",
+            "external",
+            "internal",
+            "parent",
+            "sibling",
+            "index"
+          ],
+          "newlines-between": "always"
+        }
+      ],
+    },
+  },
+  {
+    files: ['test/**/*.test.ts'],
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+    settings: {
+      vitest: {
+        typecheck: true,
+      },
+    },
+    languageOptions: {
+      globals: {
+        ...vitest.environments.env.globals,
+      },
+    },
+  },
+  {
+    files: ['test/**/*.ts'],
+    rules: {
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      'jsdoc/require-jsdoc': 'off',
+    },
+  },
+);

.eslintrc.json

@@ -55,30 +55,33 @@
   "dependencies": {
     "basic-auth": "^2.0.1",
     "cors": "^2.8.5",
-    "express": "^4.21.2",
+    "express": "^5.1.0",
     "is-plain-object": "^5.0.0",
     "jose": "^5.10.0"
   },
   "devDependencies": {
+    "@eslint/js": "^9.26.0",
     "@types/basic-auth": "^1.1.6",
     "@types/cors": "^2.8.17",
-    "@types/express": "^4.17.21",
-    "@types/node": "^18.19.87",
+    "@types/express": "^5.0.1",
+    "@types/node": "^18.19.97",
     "@types/supertest": "^6.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.31.1",
-    "@typescript-eslint/parser": "^8.31.1",
-    "@vitest/coverage-v8": "^3.1.2",
-    "@vitest/eslint-plugin": "^1.1.43",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
+    "@vitest/coverage-v8": "^3.1.3",
+    "@vitest/eslint-plugin": "^1.1.44",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.3",
+    "eslint-import-resolver-typescript": "^4.3.4",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsdoc": "^50.6.11",
-    "eslint-plugin-prettier": "^5.2.6",
+    "eslint-plugin-prettier": "^5.4.0",
     "prettier": "^3.5.3",
     "rimraf": "^5.0.10",
     "supertest": "^7.1.0",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.2"
+    "typescript-eslint": "^8.32.0",
+    "vitest": "^3.1.3"
   },
   "resolutions": {
     "@types/node": "^18"

eslint.config.mjs

@@ -90,7 +90,9 @@ export function assertIsValidTokenRequest(
   if ('aud' in body) {
     const aud = body['aud'];
     if (Array.isArray(aud)) {
-      aud.forEach((a) => assertIsString(a, "Invalid 'aud' type"));
+      aud.forEach((a) => {
+        assertIsString(a, "Invalid 'aud' type");
+      });
     } else {
       assertIsString(aud, "Invalid 'aud' type");
     }

package.json

@@ -37,13 +37,13 @@ export class HttpServer {
 
   /**
    * Creates a new instance of HttpServer.
-   * @param {RequestListener} requestListener The function that will handle the server's requests.
-   * @param {HttpServerOptions} options Optional HttpServerOptions to start the server with https.
+   * @param requestListener The function that will handle the server's requests.
+   * @param options Optional HttpServerOptions to start the server with https.
    */
   constructor(requestListener: RequestListener, options?: HttpServerOptions) {
     this.#isSecured = false;
 
-    if (options?.key && options?.cert) {
+    if (options?.key && options.cert) {
       this.#server = createHttpsServer(options, requestListener);
       this.#isSecured = true;
     } else {
@@ -53,7 +53,7 @@ export class HttpServer {
 
   /**
    * Returns a value indicating whether or not the server is listening for connections.
-   * @type {boolean}
+   * @returns A boolean value indicating whether the server is listening.
    */
   get listening(): boolean {
     return this.#server.listening;
@@ -62,7 +62,7 @@ export class HttpServer {
   /**
    * Returns the bound address, family name and port where the server is listening,
    * or null if the server has not been started.
-   * @returns {AddressInfo} The server bound address information.
+   * @returns The server bound address information.
    */
   address(): AddressInfo {
     if (!this.listening) {
@@ -78,9 +78,9 @@ export class HttpServer {
 
   /**
    * Starts the server.
-   * @param {number} [port] Port number. If omitted, it will be assigned by the operating system.
-   * @param {string} [host] Host name.
-   * @returns {Promise<void>} A promise that resolves when the server has been started.
+   * @param port Port number. If omitted, it will be assigned by the operating system.
+   * @param host Host name.
+   * @returns A promise that resolves when the server has been started.
    */
   async start(port?: number, host?: string): Promise<Server> {
     if (this.listening) {
@@ -97,7 +97,7 @@ export class HttpServer {
 
   /**
    * Stops the server.
-   * @returns {Promise} Resolves when the server has been stopped.
+   * @returns Resolves when the server has been stopped.
    */
   async stop(): Promise<void> {
     if (!this.listening) {
@@ -107,17 +107,18 @@ export class HttpServer {
     return new Promise((resolve, reject) => {
       this.#server.close((err) => {
         if (err) {
-          return reject(err);
+          reject(err);
+          return;
         }
 
-        return resolve();
+        resolve();
       });
     });
   }
 
   protected buildIssuerUrl(host: string | undefined, port: number): string {
     const url = new URL(
-      `${this.#isSecured ? 'https' : 'http'}://localhost:${port}`,
+      `${this.#isSecured ? 'https' : 'http'}://localhost:${port.toString()}`,
     );
 
     if (host && !coversLocalhost(host)) {

src/lib/helpers.ts

@@ -96,7 +96,7 @@ function normalizeKeyKid(
     return;
   }
 
-  if (opts !== undefined && opts.kid !== undefined) {
+  if (opts?.kid !== undefined) {
     jwk['kid'] = opts.kid;
   } else {
     jwk['kid'] = generateRandomKid();
@@ -118,18 +118,18 @@ export class JWKStore {
 
   /**
    * Generates a new random key and adds it into this keystore.
-   * @param {string} alg The selected algorithm.
-   * @param {object} [opts] The options.
-   * @param {string} [opts.kid] The key identifier to use.
-   * @param {string} [opts.crv] The OKP "crv" to be used for "EdDSA" algorithm.
-   * @returns {Promise<JWK>} The promise for the generated key.
+   * @param alg The selected algorithm.
+   * @param opts The options.
+   * @param opts.kid The key identifier to use.
+   * @param opts.crv The OKP "crv" to be used for "EdDSA" algorithm.
+   * @returns The promise for the generated key.
    */
   async generate(
     alg: string,
     opts?: { kid?: string; crv?: string },
   ): Promise<JWK> {
     const generateOpts: GenerateKeyPairOptions =
-      opts !== undefined && opts.crv !== undefined ? { crv: opts.crv } : {};
+      opts?.crv !== undefined ? { crv: opts.crv } : {};
 
     const pair = await generateKeyPair(alg, generateOpts);
     const joseJwk = await exportJWK(pair.privateKey);
@@ -144,15 +144,15 @@ export class JWKStore {
 
   /**
    * Adds a JWK key to this keystore.
-   * @param {object} maybeJwk The JWK key to add.
-   * @returns {Promise<JWK>} The promise for the added key.
+   * @param maybeJwk The JWK key to add.
+   * @returns The promise for the added key.
    */
   async add(maybeJwk: Record<string, unknown>): Promise<JWK> {
     const tempJwk = { ...maybeJwk };
 
     normalizeKeyKid(tempJwk);
 
-    if (tempJwk.alg === undefined) {
+    if (!('alg' in tempJwk)) {
       throw new Error('Unspecified JWK "alg" property');
     }
 
@@ -178,8 +178,8 @@ export class JWKStore {
   /**
    * Gets a key from the keystore in a round-robin fashion.
    * If a 'kid' is provided, only keys that match will be taken into account.
-   * @param {string} [kid] The optional key identifier to match keys against.
-   * @returns {JWK.Key | null} The retrieved key.
+   * @param kid The optional key identifier to match keys against.
+   * @returns The retrieved key.
    */
   get(kid?: string): JWK | undefined {
     return this.#keyRotator.next(kid);
@@ -188,9 +188,9 @@ export class JWKStore {
   /**
    * Generates a JSON representation of this keystore, which conforms
    * to a JWK Set from {I-D.ietf-jose-json-web-key}.
-   * @param {boolean} [includePrivateFields] `true` if the private fields
+   * @param [includePrivateFields] `true` if the private fields
    *        of stored keys are to be included.
-   * @returns {JWK[]} The JSON representation of this keystore.
+   * @returns The JSON representation of this keystore.
    */
   toJSON(includePrivateFields = false): JWK[] {
     return this.#keyRotator.toJSON(includePrivateFields);

src/lib/http-server.ts

@@ -33,7 +33,6 @@ import { InternalEvents } from './types-internals';
 export class OAuth2Issuer extends EventEmitter {
   /**
    * Sets or returns the issuer URL.
-   * @type {string}
    */
   url: string | undefined;
 
@@ -51,16 +50,16 @@ export class OAuth2Issuer extends EventEmitter {
 
   /**
    * Returns the key store.
-   * @type {JWKStore}
+   * @returns The key store.
    */
   get keys(): JWKStore {
     return this.#keys;
   }
 
   /**
    * Builds a JWT.
-   * @param {TokenBuildOptions} [opts] JWT token building overrides
-   * @returns {Promise<string>} The produced JWT.
+   * @param opts JWT token building overrides
+   * @returns The produced JWT.
    * @fires OAuth2Issuer#beforeSigning
    */
   async buildToken(opts?: TokenBuildOptions): Promise<string> {