express-rate-limit 6.0.4 → 6.0.5

package/changelog.md

@@ -6,12 +6,32 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.0.5](https://github.com/nfriedly/express-rate-limit/releases/tag/v6.0.5)
+
+### Fixed
+
+- Use named imports for ExpressJS types so users do not need to enable the
+  `esModuleInterop` flag in their Typescript compiler configuration.
+
+## [6.0.4](https://github.com/nfriedly/express-rate-limit/releases/tag/v6.0.4)
+
+### Fixed
+
+- Upload the built package as a `.tgz` to GitHub releases.
+
+### Changed
+
+- Add ` main` and `module` fields to `package.json`. This helps tools such as
+  ESLint that do not yet support the `exports` field.
+- Bumped the minimum node.js version in `package-lock.json` to match
+  `package.json`
+
 ## [6.0.3](https://github.com/nfriedly/express-rate-limit/releases/tag/v6.0.3)
 
 ### Changed
 
-- Bumped minimum Node version from 12.9 to 14.5 because the transpiled output
-  uses the nullish coalescing operator (`??`), which
+- Bumped minimum Node version from 12.9 to 14.5 in `package.json` because the
+  transpiled output uses the nullish coalescing operator (`??`), which
   [isn't supported in node.js prior to 14.x](https://node.green/#ES2020-features--nullish-coalescing-operator-----).
 
 ## [6.0.2](https://github.com/nfriedly/express-rate-limit/releases/v6.0.2)

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-// Generated by dts-bundle-generator v6.2.0
+// Generated by dts-bundle-generator v6.3.0
 
-import Express from 'express';
+import { NextFunction, Request, RequestHandler, Response } from 'express';
 
 /**
  * Callback that fires when a client's hit counter is incremented.
@@ -14,32 +14,32 @@ export declare type IncrementCallback = (error: Error | undefined, totalHits: nu
  * Method (in the form of middleware) to generate/retrieve a value based on the
  * incoming request
  *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
+ * @param request {Request} - The Express request object
+ * @param response {Response} - The Express response object
  *
  * @returns {T} - The value needed
  */
-export declare type ValueDeterminingMiddleware<T> = (request: Express.Request, response: Express.Response) => T | Promise<T>;
+export declare type ValueDeterminingMiddleware<T> = (request: Request, response: Response) => T | Promise<T>;
 /**
  * Express request handler that sends back a response when a client is
  * rate-limited.
  *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
- * @param next {Express.NextFunction} - The Express `next` function, can be called to skip responding
+ * @param request {Request} - The Express request object
+ * @param response {Response} - The Express response object
+ * @param next {NextFunction} - The Express `next` function, can be called to skip responding
  * @param optionsUsed {Options} - The options used to set up the middleware
  */
-export declare type RateLimitExceededEventHandler = (request: Express.Request, response: Express.Response, next: Express.NextFunction, optionsUsed: Options) => void;
+export declare type RateLimitExceededEventHandler = (request: Request, response: Response, next: NextFunction, optionsUsed: Options) => void;
 /**
  * Event callback that is triggered on a client's first request that exceeds the limit
  * but not for subsequent requests. May be used for logging, etc. Should *not*
  * send a response.
  *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
+ * @param request {Request} - The Express request object
+ * @param response {Response} - The Express response object
  * @param optionsUsed {Options} - The options used to set up the middleware
  */
-export declare type RateLimitReachedEventHandler = (request: Express.Request, response: Express.Response, optionsUsed: Options) => void;
+export declare type RateLimitReachedEventHandler = (request: Request, response: Response, optionsUsed: Options) => void;
 /**
  * Data returned from the `Store` when a client's hit counter is incremented.
  *
@@ -53,7 +53,7 @@ export declare type IncrementResponse = {
 /**
  * A modified Express request handler with the rate limit functions.
  */
-export declare type RateLimitRequestHandler = Express.RequestHandler & {
+export declare type RateLimitRequestHandler = RequestHandler & {
 	/**
 	 * Method to reset a client's hit counter.
 	 *
@@ -227,7 +227,7 @@ export interface Options {
  * The extended request object that includes information about the client's
  * rate limit.
  */
-export declare type AugmentedRequest = Express.Request & {
+export declare type AugmentedRequest = Request & {
 	[key: string]: RateLimitInfo;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "6.0.4",
+	"version": "6.0.5",
 	"description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
 	"author": {
 		"name": "Nathan Friedly",
@@ -70,19 +70,19 @@
 		"express": "^4"
 	},
 	"devDependencies": {
-		"@jest/globals": "^27.4.2",
+		"@jest/globals": "^27.4.6",
 		"@types/express": "^4.17.13",
-		"@types/jest": "^27.0.3",
+		"@types/jest": "^27.4.0",
 		"@types/node": "^16.11.17",
 		"@types/supertest": "^2.0.11",
 		"cross-env": "^7.0.3",
 		"del-cli": "^4.0.1",
-		"dts-bundle-generator": "^6.2.0",
-		"esbuild": "^0.14.8",
+		"dts-bundle-generator": "^6.3.0",
+		"esbuild": "^0.14.10",
 		"express": "^4.17.1",
 		"husky": "^7.0.4",
-		"jest": "^27.4.3",
-		"lint-staged": "^12.1.2",
+		"jest": "^27.4.7",
+		"lint-staged": "^12.1.5",
 		"npm-run-all": "^4.1.5",
 		"supertest": "^6.1.6",
 		"ts-jest": "^27.1.1",

package/readme.md

@@ -58,57 +58,19 @@ Javascript and Typescript projects.
 
 **This package requires you to use Node 14 or above.**
 
-#### Javascript
-
-Import it in a CommonJS project as follows:
+Import it in a CommonJS project (`type: commonjs` or no `type` field in
+`package.json`) as follows:
 
 ```ts
 const rateLimit = require('express-rate-limit')
 ```
 
-Import it in a ESM project as follows:
-
-```ts
-import rateLimit from 'express-rate-limit'
-```
-
-#### Typescript
-
-If you are using this library in a Typescript project that outputs CommonJS (no
-`type: module` in `package.json` and `module: commonjs` in `tsconfig.json`), set
-`esModuleInterop` to `true` in the `compilerOptions` of your `tsconfig.json` and
-then import it as follows:
+Import it in a ESM project (`type: module` in `package.json`) as follows:
 
 ```ts
 import rateLimit from 'express-rate-limit'
 ```
 
-If you cannot set `esModuleInterop` to true, import it as follows instead:
-
-```ts
-const rateLimit = require('express-rate-limit')
-```
-
-And use the following to import any types if you need to:
-
-```ts
-import { Store, IncrementResponse, ... } from 'express-rate-limit'
-```
-
-If you are using this library in a Typescript project that outputs ESM
-(`type: module` in `package.json` and `module: esnext` in `tsconfig.json`),
-import it as follows:
-
-```ts
-import rateLimit from 'express-rate-limit'
-```
-
-And use the following to import any types if you need to:
-
-```ts
-import rateLimit, { Store, IncrementResponse, ... } from 'express-rate-limit'
-```
-
 ### Examples
 
 To use it in an API-only server where the rate-limiter should be applied to all

package/tsconfig.json

@@ -1,15 +1,13 @@
 {
+	"include": ["source/"],
+	"exclude": ["node_modules/"],
 	"compilerOptions": {
 		"declaration": true,
-
 		"strict": true,
 		"noUnusedLocals": true,
 		"noImplicitReturns": true,
 		"noFallthroughCasesInSwitch": true,
-
-		"moduleResolution": "node",
-		"esModuleInterop": true
-	},
-	"include": ["./source/**/*.ts"],
-	"exclude": ["./node_modules"]
+		"esModuleInterop": true,
+		"moduleResolution": "node"
+	}
 }