@nestjs/throttler 1.2.1 → 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,115 @@
+# [2.0.0](https://github.com/nestjs/throttler/compare/v1.2.1...v2.0.0) (2021-07-09)
+
+## 3.0.0
+
+### Major Changes
+
+- c9fcd51: Upgrade nest version to v9. No breaking changes in direct code, but in nest v9 upgrade
+
+## 2.0.1
+
+### Patch Changes
+
+- cf50808: fix memory leak for timeoutIds array. Before this, the timeoutIds array would not be trimmed and would grow until out of memory. Now ids are properly removed on timeout.
+
+### Features
+
+- adding in a comment about version ([b13bf53](https://github.com/nestjs/throttler/commit/b13bf53542236ba6b05ac537b7a677e1644a0407))
+
+### BREAKING CHANGES
+
+- v2 and above is now being developed specificially for
+  nest v8 and could have some unforseen side effects with Nest v7. use with
+  v7 at your own risk.
+
+## [1.2.1](https://github.com/nestjs/throttler/compare/v1.2.0...v1.2.1) (2021-07-09)
+
+### Performance Improvements
+
+- upgrade to nest v8 ([cb5dd91](https://github.com/nestjs/throttler/commit/cb5dd913e9fcc482cd74f2d49085b98dac630215))
+
+# [0.3.0](https://github.com/jmcdo29/nestjs-throttler/compare/0.2.3...0.3.0) (2020-11-10)
+
+### Bug Fixes
+
+- **module:** async register is now `forRootAsync` ([a1c6ace](https://github.com/jmcdo29/nestjs-throttler/commit/a1c6acef472e9d2368f2139e6b789ef184a7d952))
+
+## [0.2.3](https://github.com/jmcdo29/nestjs-throttler/compare/0.2.2...0.2.3) (2020-08-06)
+
+### Features
+
+- **ws:** allows for optional use of @nestjs/websocket ([f437614](https://github.com/jmcdo29/nestjs-throttler/commit/f437614cab5aebfdfdb4d5884f45b58b16d5a140))
+
+## [0.2.2](https://github.com/jmcdo29/nestjs-throttler/compare/0.2.1...0.2.2) (2020-06-12)
+
+### Bug Fixes
+
+- moves userAgent check to http handler ([87183af](https://github.com/jmcdo29/nestjs-throttler/commit/87183af8fc189d7d5c8237832089138a0b40589b))
+
+### Features
+
+- **decorator:** add setThrottlerMetadata() function back ([ea31a9c](https://github.com/jmcdo29/nestjs-throttler/commit/ea31a9c86b82550e2d43f3433ec618785cf2b34a))
+- **graphql:** implements graphql limiter ([40eaff1](https://github.com/jmcdo29/nestjs-throttler/commit/40eaff16dae5c0279001e56ff64a2b540d82a3c7))
+- Add support for ws (websockets) ([a745295](https://github.com/jmcdo29/nestjs-throttler/commit/a74529517f989c43d77c9a63712e82244ebeefcd))
+- Add support for ws (websockets) ([8103a5a](https://github.com/jmcdo29/nestjs-throttler/commit/8103a5a11c1916f05f8c44e302ba93a98d7cb77d))
+- Make storage methods async ([92cd4eb](https://github.com/jmcdo29/nestjs-throttler/commit/92cd4ebf507b3bed4efbaeb7bb47bd1738a62dc3))
+- **exception:** Use const instead of duplicated string ([f95da2c](https://github.com/jmcdo29/nestjs-throttler/commit/f95da2c4fc787c7c5e525672d668745bc1f2301d))
+- **guard:** Add default case for context.getType() switch ([ff46d57](https://github.com/jmcdo29/nestjs-throttler/commit/ff46d57508c4b446918ccd75f704d0eed1ae352f))
+- Implement basic support for websocket ([3a0cf2e](https://github.com/jmcdo29/nestjs-throttler/commit/3a0cf2ed70c7abbe02e9d96f26ab2c81b3c7bb2f))
+
+## [0.2.1](https://github.com/jmcdo29/nestjs-throttler/compare/0.2.0...0.2.1) (2020-06-09)
+
+### Features
+
+- add support for ignoreUserAgents option ([1ab5e17](https://github.com/jmcdo29/nestjs-throttler/commit/1ab5e17a25a95ec14910e199726eac07f66f4475))
+
+# [0.2.0](https://github.com/jmcdo29/nestjs-throttler/compare/0.1.1...0.2.0) (2020-06-09)
+
+### Bug Fixes
+
+- make core module global and export core module inside ThrottlerModule ([1f4df42](https://github.com/jmcdo29/nestjs-throttler/commit/1f4df42a5fc9a6f75c398bbb6a3f9ebaec6bc80f))
+
+### Features
+
+- makes options required in forRoot and forRootAsync ([14e272a](https://github.com/jmcdo29/nestjs-throttler/commit/14e272a842a90db93dd9e8c60c936fbcf0bcd3b7))
+- remove global guard and require user to implement it manually ([840eae4](https://github.com/jmcdo29/nestjs-throttler/commit/840eae4643867390bc598937b20e132257e9b018))
+
+## [0.1.1](https://github.com/jmcdo29/nestjs-throttler/compare/0.1.0...0.1.1) (2020-06-07)
+
+### Bug Fixes
+
+- **interface:** fixes the storage interface to be async ([f7565d9](https://github.com/jmcdo29/nestjs-throttler/commit/f7565d9029baf4d7687f0913046f555d17cde44b))
+
+# 0.1.0 (2020-06-07)
+
+### Bug Fixes
+
+- adds back AppModule to allow for running server for tests ([5af229b](https://github.com/jmcdo29/nestjs-throttler/commit/5af229ba69527daf3662b1899ed985fa9404251b))
+- updates some types ([b26fc06](https://github.com/jmcdo29/nestjs-throttler/commit/b26fc06841a430e5728cde6276515130b89a7289))
+- updates storage interface to use number ([339f29c](https://github.com/jmcdo29/nestjs-throttler/commit/339f29c12b4720a7376ec042988f73460172b32e))
+- updates tests and resolves comments from pr ([ee87e05](https://github.com/jmcdo29/nestjs-throttler/commit/ee87e05e2f5eb61b00b423d6394be9a131f84f8a))
+- **.gitignore:** Ignore all dist and node_modules rather than root-level only ([d9609af](https://github.com/jmcdo29/nestjs-throttler/commit/d9609afb9cf3561b84082ac9a3e2e26ddcbb2117))
+- **guard:** Change RateLimit header prefix to X-RateLimit ([328c0a3](https://github.com/jmcdo29/nestjs-throttler/commit/328c0a3c1009fdc65820125c2145de65aebd3fee))
+- **guard:** Change RateLimit header prefix to X-RateLimit ([3903885](https://github.com/jmcdo29/nestjs-throttler/commit/3903885df9eaac0d966c5b8207fae26b62f337f3))
+- **guard:** guard now binds globally without the use of @UseGuards() ([4022447](https://github.com/jmcdo29/nestjs-throttler/commit/40224475d27f1ec0cf792225bbc18df33ab14cc2))
+- **guard:** guard now binds globally without the use of @UseGuards() ([3ca146d](https://github.com/jmcdo29/nestjs-throttler/commit/3ca146d41afa71e3c68b73d8706e7431f929a85a))
+- **guard:** Prevent RateLimit-Remaining from going below 0 ([25e33c8](https://github.com/jmcdo29/nestjs-throttler/commit/25e33c882007892a3285c92449aa5bc0840a8909))
+- **guard:** Prevent RateLimit-Remaining from going below 0 ([74b1668](https://github.com/jmcdo29/nestjs-throttler/commit/74b166888ab283281a964d6c64b94224e2f96ba4))
+- **guard:** Use the correct approach to check for excluded routes ([38eac3c](https://github.com/jmcdo29/nestjs-throttler/commit/38eac3ca3bdad0b4b266587bc4b0287f3f69f640))
+- **guard:** Use the correct approach to check for excluded routes ([912813f](https://github.com/jmcdo29/nestjs-throttler/commit/912813f49cc98e8fbd2643650d22ea8cc88c77ae))
+- req.method value in httpPromise ([b9ee26e](https://github.com/jmcdo29/nestjs-throttler/commit/b9ee26e5e888e4d4f220e91adc996ade764f7002))
+
+### Features
+
+- Swap excludeRoutes for @SkipThrottle() decorator ([16d6fac](https://github.com/jmcdo29/nestjs-throttler/commit/16d6facd5e8f648620fa47e372078db37472f619))
+- **fastify:** updates guard to work for fastify ([bc678a3](https://github.com/jmcdo29/nestjs-throttler/commit/bc678a363c367d132a90a2a4282e3f033f526e00))
+- Implement ignoreRoutes functionality ([7b8ab42](https://github.com/jmcdo29/nestjs-throttler/commit/7b8ab4273fffafc0dd0571393d8c0faf89afc42f))
+- **package.json:** Add --watch to start:dev script ([3c4c28a](https://github.com/jmcdo29/nestjs-throttler/commit/3c4c28abbb324e064f65b284f1a99683cd02030b))
+- Implement ignoreRoutes functionality ([75f870c](https://github.com/jmcdo29/nestjs-throttler/commit/75f870c5b49e4d22c70519d28f8efffc1da288eb))
+- **module:** implements start of limiter module ([35dbff5](https://github.com/jmcdo29/nestjs-throttler/commit/35dbff5d30e7a1385a4f4cf688992017eb7e0566))
+- **package.json:** Add --watch to start:dev script ([a6b441c](https://github.com/jmcdo29/nestjs-throttler/commit/a6b441cad221b7eee52be0ba81c66fca81853c4f))
+- Add global ThrottlerGuard ([9a84aff](https://github.com/jmcdo29/nestjs-throttler/commit/9a84afff5d57a16731d021cb47d60c2b4d02eb02))
+- adds httpromise for async/await http calls in tests ([70210c7](https://github.com/jmcdo29/nestjs-throttler/commit/70210c76173aabfd5f85f5a24e624e7c4c010ae2))
+- Rename certain variables to use the THROTTLER prefix ([6a21b21](https://github.com/jmcdo29/nestjs-throttler/commit/6a21b216a2738aa470e2138d44053ba8413ce117))
+- Setup example app ([df6b5f6](https://github.com/jmcdo29/nestjs-throttler/commit/df6b5f633ebbb4770d3eb9e72e8075cbe6b2f78a))
+- Setup example app ([30c7576](https://github.com/jmcdo29/nestjs-throttler/commit/30c75764fd20f3afe7a3f7533a3f4f08d275a741))

package/LICENSE

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright 2019 Jay McDoniel, contributors
+Copyright 2019-2022 Jay McDoniel, contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
 </p>
 
 [travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
@@ -31,9 +31,21 @@ For an overview of the community storage providers, see [Community Storage Provi
 
 This package comes with a couple of goodies that should be mentioned, first is the `ThrottlerModule`.
 
+
+## Installation
+
+```bash
+$ npm i --save @nestjs/throttler
+```
+
+## Versions
+
+`@nestjs/throttler@^1` is compatible with Nest v7 while `@nestjs/throttler@^2` is compatible with Nest v7 and Nest v8, but it is suggested to be used with only v8 in case of breaking changes against v7 that are unseen.
+
 ## Table of Contents
 
 - [Description](#description)
+- [Versions](#versions)
 - [Table of Contents](#table-of-contents)
 - [Usage](#usage)
   - [ThrottlerModule](#throttlermodule)
@@ -139,7 +151,7 @@ export class AppController {
 @Throttle(limit: number = 30, ttl: number = 60)
 ```
 
-This decorator will set THROTTLER_LIMIT and THROTTLER_TTL metadatas on the
+This decorator will set `THROTTLER_LIMIT` and `THROTTLER_TTL` metadatas on the
 route, for retrieval from the `Reflector` class. Can be applied to controllers
 and routes.
 
@@ -213,7 +225,24 @@ So long as the Storage service implements this interface, it should be usable by
 
 ### Proxies
 
-If you are working behind a proxy, check the specific HTTP adapter options ([express](http://expressjs.com/en/guide/behind-proxies.html) and [fastify](https://www.fastify.io/docs/latest/Server/#trustproxy)) for the `trust proxy` option and enable it. Doing so will allow you to get the original IP address from the `X-Forward-For` header, and you can override the `getTracker()` method to pull the value from the header rather than from `req.ip`
+If you are working behind a proxy, check the specific HTTP adapter options ([express](http://expressjs.com/en/guide/behind-proxies.html) and [fastify](https://www.fastify.io/docs/latest/Server/#trustproxy)) for the `trust proxy` option and enable it. Doing so will allow you to get the original IP address from the `X-Forward-For` header, and you can override the `getTracker()` method to pull the value from the header rather than from `req.ip`. The following example works with both express and fastify:
+
+```ts
+// throttler-behind-proxy.guard.ts
+import { ThrottlerGuard } from '@nestjs/throttler';
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class ThrottlerBehindProxyGuard extends ThrottlerGuard {
+  protected getTracker(req: Record<string, any>): string {
+    return req.ips.length ? req.ips[0] : req.ip; // individualize IP extraction to meet your own needs
+  }
+}
+
+// app.controller.ts
+import { ThrottlerBehindProxyGuard } from './throttler-behind-proxy.guard';
+@UseGuards(ThrottlerBehindProxyGuard)
+```
 
 ### Working with Websockets
 
@@ -264,7 +293,7 @@ export class GqlThrottlerGuard extends ThrottlerGuard {
   getRequestResponse(context: ExecutionContext) {
     const gqlCtx = GqlExecutionContext.create(context);
     const ctx = gqlCtx.getContext();
-    return { req, ctx.req, res: ctx.res }; // ctx.request and ctx.reply for fastify
+    return { req: ctx.req, res: ctx.res }; // ctx.request and ctx.reply for fastify
   }
 }
 ```
@@ -274,3 +303,7 @@ export class GqlThrottlerGuard extends ThrottlerGuard {
 - [Redis](https://github.com/kkoomen/nestjs-throttler-storage-redis)
 
 Feel free to submit a PR with your custom storage provider being added to this list.
+
+## License
+
+Nest is [MIT licensed](LICENSE).

package/dist/index.js

@@ -1,47 +1,28 @@
-'use strict';
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        Object.defineProperty(o, k2, {
-          enumerable: true,
-          get: function () {
-            return m[k];
-          },
-        });
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __exportStar =
-  (this && this.__exportStar) ||
-  function (m, exports) {
-    for (var p in m)
-      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
-        __createBinding(exports, m, p);
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorageToken = exports.getOptionsToken = void 0;
-__exportStar(require('./throttler-module-options.interface'), exports);
-__exportStar(require('./throttler-storage.interface'), exports);
-__exportStar(require('./throttler.decorator'), exports);
-__exportStar(require('./throttler.exception'), exports);
-__exportStar(require('./throttler.guard'), exports);
-__exportStar(require('./throttler.module'), exports);
-var throttler_providers_1 = require('./throttler.providers');
-Object.defineProperty(exports, 'getOptionsToken', {
-  enumerable: true,
-  get: function () {
-    return throttler_providers_1.getOptionsToken;
-  },
-});
-Object.defineProperty(exports, 'getStorageToken', {
-  enumerable: true,
-  get: function () {
-    return throttler_providers_1.getStorageToken;
-  },
-});
-__exportStar(require('./throttler.service'), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./throttler-module-options.interface"), exports);
+__exportStar(require("./throttler-storage.interface"), exports);
+__exportStar(require("./throttler.decorator"), exports);
+__exportStar(require("./throttler.exception"), exports);
+__exportStar(require("./throttler.guard"), exports);
+__exportStar(require("./throttler.module"), exports);
+var throttler_providers_1 = require("./throttler.providers");
+Object.defineProperty(exports, "getOptionsToken", { enumerable: true, get: function () { return throttler_providers_1.getOptionsToken; } });
+Object.defineProperty(exports, "getStorageToken", { enumerable: true, get: function () { return throttler_providers_1.getStorageToken; } });
+__exportStar(require("./throttler.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,uEAAqD;AACrD,gEAA8C;AAC9C,wDAAsC;AACtC,wDAAsC;AACtC,oDAAkC;AAClC,qDAAmC;AACnC,6DAAyE;AAAhE,sHAAA,eAAe,OAAA;AAAE,sHAAA,eAAe,OAAA;AACzC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uEAAqD;AACrD,gEAA8C;AAC9C,wDAAsC;AACtC,wDAAsC;AACtC,oDAAkC;AAClC,qDAAmC;AACnC,6DAAyE;AAAhE,sHAAA,eAAe,OAAA;AAAE,sHAAA,eAAe,OAAA;AACzC,sDAAoC"}

package/dist/throttler-module-options.interface.js

@@ -1,3 +1,3 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-//# sourceMappingURL=throttler-module-options.interface.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=throttler-module-options.interface.js.map

package/dist/throttler-storage.interface.js

@@ -1,5 +1,5 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThrottlerStorage = void 0;
 exports.ThrottlerStorage = Symbol('ThrottlerStorage');
-//# sourceMappingURL=throttler-storage.interface.js.map
+//# sourceMappingURL=throttler-storage.interface.js.map

package/dist/throttler.constants.js

@@ -1,12 +1,8 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.THROTTLER_SKIP =
-  exports.THROTTLER_OPTIONS =
-  exports.THROTTLER_TTL =
-  exports.THROTTLER_LIMIT =
-    void 0;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.THROTTLER_SKIP = exports.THROTTLER_OPTIONS = exports.THROTTLER_TTL = exports.THROTTLER_LIMIT = void 0;
 exports.THROTTLER_LIMIT = 'THROTTLER:LIMIT';
 exports.THROTTLER_TTL = 'THROTTLER:TTL';
 exports.THROTTLER_OPTIONS = 'THROTTLER:MODULE_OPTIONS';
 exports.THROTTLER_SKIP = 'THROTTLER:SKIP';
-//# sourceMappingURL=throttler.constants.js.map
+//# sourceMappingURL=throttler.constants.js.map

package/dist/throttler.decorator.js

@@ -1,41 +1,37 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.InjectThrottlerStorage =
-  exports.InjectThrottlerOptions =
-  exports.SkipThrottle =
-  exports.Throttle =
-    void 0;
-const common_1 = require('@nestjs/common');
-const throttler_constants_1 = require('./throttler.constants');
-const throttler_providers_1 = require('./throttler.providers');
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectThrottlerStorage = exports.InjectThrottlerOptions = exports.SkipThrottle = exports.Throttle = void 0;
+const common_1 = require("@nestjs/common");
+const throttler_constants_1 = require("./throttler.constants");
+const throttler_providers_1 = require("./throttler.providers");
 function setThrottlerMetadata(target, limit, ttl) {
-  Reflect.defineMetadata(throttler_constants_1.THROTTLER_TTL, ttl, target);
-  Reflect.defineMetadata(throttler_constants_1.THROTTLER_LIMIT, limit, target);
+    Reflect.defineMetadata(throttler_constants_1.THROTTLER_TTL, ttl, target);
+    Reflect.defineMetadata(throttler_constants_1.THROTTLER_LIMIT, limit, target);
 }
 const Throttle = (limit = 20, ttl = 60) => {
-  return (target, propertyKey, descriptor) => {
-    if (descriptor) {
-      setThrottlerMetadata(descriptor.value, limit, ttl);
-      return descriptor;
-    }
-    setThrottlerMetadata(target, limit, ttl);
-    return target;
-  };
+    return (target, propertyKey, descriptor) => {
+        if (descriptor) {
+            setThrottlerMetadata(descriptor.value, limit, ttl);
+            return descriptor;
+        }
+        setThrottlerMetadata(target, limit, ttl);
+        return target;
+    };
 };
 exports.Throttle = Throttle;
 const SkipThrottle = (skip = true) => {
-  return (target, propertyKey, descriptor) => {
-    if (descriptor) {
-      Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, descriptor.value);
-      return descriptor;
-    }
-    Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, target);
-    return target;
-  };
+    return (target, propertyKey, descriptor) => {
+        if (descriptor) {
+            Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, descriptor.value);
+            return descriptor;
+        }
+        Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, target);
+        return target;
+    };
 };
 exports.SkipThrottle = SkipThrottle;
-const InjectThrottlerOptions = () => common_1.Inject(throttler_providers_1.getOptionsToken());
+const InjectThrottlerOptions = () => (0, common_1.Inject)((0, throttler_providers_1.getOptionsToken)());
 exports.InjectThrottlerOptions = InjectThrottlerOptions;
-const InjectThrottlerStorage = () => common_1.Inject(throttler_providers_1.getStorageToken());
+const InjectThrottlerStorage = () => (0, common_1.Inject)((0, throttler_providers_1.getStorageToken)());
 exports.InjectThrottlerStorage = InjectThrottlerStorage;
-//# sourceMappingURL=throttler.decorator.js.map
+//# sourceMappingURL=throttler.decorator.js.map

package/dist/throttler.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.decorator.js","sourceRoot":"","sources":["../src/throttler.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,+DAAuF;AACvF,+DAAyE;AAEzE,SAAS,oBAAoB,CAAC,MAAW,EAAE,KAAa,EAAE,GAAW;IACnE,OAAO,CAAC,cAAc,CAAC,mCAAa,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,cAAc,CAAC,qCAAe,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAQM,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAoC,EAAE;IACjF,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YACnD,OAAO,UAAU,CAAC;SACnB;QACD,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,QAAQ,YAanB;AASK,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,IAAI,EAAoC,EAAE;IAC5E,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/D,OAAO,UAAU,CAAC;SACnB;QACD,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAOK,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,eAAM,CAAC,qCAAe,EAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC;AAO/D,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,eAAM,CAAC,qCAAe,EAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC"}
+{"version":3,"file":"throttler.decorator.js","sourceRoot":"","sources":["../src/throttler.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,+DAAuF;AACvF,+DAAyE;AAEzE,SAAS,oBAAoB,CAAC,MAAW,EAAE,KAAa,EAAE,GAAW;IACnE,OAAO,CAAC,cAAc,CAAC,mCAAa,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,cAAc,CAAC,qCAAe,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAQM,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAoC,EAAE;IACjF,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YACnD,OAAO,UAAU,CAAC;SACnB;QACD,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,QAAQ,YAanB;AASK,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,IAAI,EAAoC,EAAE;IAC5E,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/D,OAAO,UAAU,CAAC;SACnB;QACD,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAOK,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC;AAO/D,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC"}

package/dist/throttler.exception.js

@@ -1,12 +1,12 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThrottlerException = exports.throttlerMessage = void 0;
-const common_1 = require('@nestjs/common');
+const common_1 = require("@nestjs/common");
 exports.throttlerMessage = 'ThrottlerException: Too Many Requests';
 class ThrottlerException extends common_1.HttpException {
-  constructor(message) {
-    super(`${message || exports.throttlerMessage}`, common_1.HttpStatus.TOO_MANY_REQUESTS);
-  }
+    constructor(message) {
+        super(`${message || exports.throttlerMessage}`, common_1.HttpStatus.TOO_MANY_REQUESTS);
+    }
 }
 exports.ThrottlerException = ThrottlerException;
-//# sourceMappingURL=throttler.exception.js.map
+//# sourceMappingURL=throttler.exception.js.map

package/dist/throttler.guard.js

@@ -1,119 +1,94 @@
-'use strict';
-var __decorate =
-  (this && this.__decorate) ||
-  function (decorators, target, key, desc) {
-    var c = arguments.length,
-      r =
-        c < 3
-          ? target
-          : desc === null
-          ? (desc = Object.getOwnPropertyDescriptor(target, key))
-          : desc,
-      d;
-    if (typeof Reflect === 'object' && typeof Reflect.decorate === 'function')
-      r = Reflect.decorate(decorators, target, key, desc);
-    else
-      for (var i = decorators.length - 1; i >= 0; i--)
-        if ((d = decorators[i]))
-          r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
-  };
-var __metadata =
-  (this && this.__metadata) ||
-  function (k, v) {
-    if (typeof Reflect === 'object' && typeof Reflect.metadata === 'function')
-      return Reflect.metadata(k, v);
-  };
-var __param =
-  (this && this.__param) ||
-  function (paramIndex, decorator) {
-    return function (target, key) {
-      decorator(target, key, paramIndex);
-    };
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThrottlerGuard = void 0;
-const common_1 = require('@nestjs/common');
-const core_1 = require('@nestjs/core');
-const md5 = require('md5');
-const throttler_storage_interface_1 = require('./throttler-storage.interface');
-const throttler_constants_1 = require('./throttler.constants');
-const throttler_decorator_1 = require('./throttler.decorator');
-const throttler_exception_1 = require('./throttler.exception');
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const md5 = require("md5");
+const throttler_storage_interface_1 = require("./throttler-storage.interface");
+const throttler_constants_1 = require("./throttler.constants");
+const throttler_decorator_1 = require("./throttler.decorator");
+const throttler_exception_1 = require("./throttler.exception");
 let ThrottlerGuard = class ThrottlerGuard {
-  constructor(options, storageService, reflector) {
-    this.options = options;
-    this.storageService = storageService;
-    this.reflector = reflector;
-    this.headerPrefix = 'X-RateLimit';
-    this.errorMessage = throttler_exception_1.throttlerMessage;
-  }
-  async canActivate(context) {
-    const handler = context.getHandler();
-    const classRef = context.getClass();
-    if (
-      this.reflector.getAllAndOverride(throttler_constants_1.THROTTLER_SKIP, [handler, classRef])
-    ) {
-      return true;
+    constructor(options, storageService, reflector) {
+        this.options = options;
+        this.storageService = storageService;
+        this.reflector = reflector;
+        this.headerPrefix = 'X-RateLimit';
+        this.errorMessage = throttler_exception_1.throttlerMessage;
+    }
+    async canActivate(context) {
+        const handler = context.getHandler();
+        const classRef = context.getClass();
+        if (this.reflector.getAllAndOverride(throttler_constants_1.THROTTLER_SKIP, [handler, classRef])) {
+            return true;
+        }
+        const routeOrClassLimit = this.reflector.getAllAndOverride(throttler_constants_1.THROTTLER_LIMIT, [
+            handler,
+            classRef,
+        ]);
+        const routeOrClassTtl = this.reflector.getAllAndOverride(throttler_constants_1.THROTTLER_TTL, [
+            handler,
+            classRef,
+        ]);
+        const limit = routeOrClassLimit || this.options.limit;
+        const ttl = routeOrClassTtl || this.options.ttl;
+        return this.handleRequest(context, limit, ttl);
     }
-    const routeOrClassLimit = this.reflector.getAllAndOverride(
-      throttler_constants_1.THROTTLER_LIMIT,
-      [handler, classRef],
-    );
-    const routeOrClassTtl = this.reflector.getAllAndOverride(throttler_constants_1.THROTTLER_TTL, [
-      handler,
-      classRef,
-    ]);
-    const limit = routeOrClassLimit || this.options.limit;
-    const ttl = routeOrClassTtl || this.options.ttl;
-    return this.handleRequest(context, limit, ttl);
-  }
-  async handleRequest(context, limit, ttl) {
-    const { req, res } = this.getRequestResponse(context);
-    if (Array.isArray(this.options.ignoreUserAgents)) {
-      for (const pattern of this.options.ignoreUserAgents) {
-        if (pattern.test(req.headers['user-agent'])) {
-          return true;
+    async handleRequest(context, limit, ttl) {
+        const { req, res } = this.getRequestResponse(context);
+        if (Array.isArray(this.options.ignoreUserAgents)) {
+            for (const pattern of this.options.ignoreUserAgents) {
+                if (pattern.test(req.headers['user-agent'])) {
+                    return true;
+                }
+            }
         }
-      }
+        const tracker = this.getTracker(req);
+        const key = this.generateKey(context, tracker);
+        const ttls = await this.storageService.getRecord(key);
+        const nearestExpiryTime = ttls.length > 0 ? Math.ceil((ttls[0] - Date.now()) / 1000) : 0;
+        if (ttls.length >= limit) {
+            res.header('Retry-After', nearestExpiryTime);
+            this.throwThrottlingException(context);
+        }
+        res.header(`${this.headerPrefix}-Limit`, limit);
+        res.header(`${this.headerPrefix}-Remaining`, Math.max(0, limit - (ttls.length + 1)));
+        res.header(`${this.headerPrefix}-Reset`, nearestExpiryTime);
+        await this.storageService.addRecord(key, ttl);
+        return true;
+    }
+    getTracker(req) {
+        return req.ip;
+    }
+    getRequestResponse(context) {
+        const http = context.switchToHttp();
+        return { req: http.getRequest(), res: http.getResponse() };
+    }
+    generateKey(context, suffix) {
+        const prefix = `${context.getClass().name}-${context.getHandler().name}`;
+        return md5(`${prefix}-${suffix}`);
     }
-    const tracker = this.getTracker(req);
-    const key = this.generateKey(context, tracker);
-    const ttls = await this.storageService.getRecord(key);
-    const nearestExpiryTime = ttls.length > 0 ? Math.ceil((ttls[0] - Date.now()) / 1000) : 0;
-    if (ttls.length >= limit) {
-      res.header('Retry-After', nearestExpiryTime);
-      this.throwThrottlingException(context);
+    throwThrottlingException(context) {
+        throw new throttler_exception_1.ThrottlerException(this.errorMessage);
     }
-    res.header(`${this.headerPrefix}-Limit`, limit);
-    res.header(`${this.headerPrefix}-Remaining`, Math.max(0, limit - (ttls.length + 1)));
-    res.header(`${this.headerPrefix}-Reset`, nearestExpiryTime);
-    await this.storageService.addRecord(key, ttl);
-    return true;
-  }
-  getTracker(req) {
-    return req.ip;
-  }
-  getRequestResponse(context) {
-    const http = context.switchToHttp();
-    return { req: http.getRequest(), res: http.getResponse() };
-  }
-  generateKey(context, suffix) {
-    const prefix = `${context.getClass().name}-${context.getHandler().name}`;
-    return md5(`${prefix}-${suffix}`);
-  }
-  throwThrottlingException(context) {
-    throw new throttler_exception_1.ThrottlerException(this.errorMessage);
-  }
 };
-ThrottlerGuard = __decorate(
-  [
-    common_1.Injectable(),
-    __param(0, throttler_decorator_1.InjectThrottlerOptions()),
-    __param(1, throttler_decorator_1.InjectThrottlerStorage()),
-    __metadata('design:paramtypes', [Object, Object, core_1.Reflector]),
-  ],
-  ThrottlerGuard,
-);
+ThrottlerGuard = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, throttler_decorator_1.InjectThrottlerOptions)()),
+    __param(1, (0, throttler_decorator_1.InjectThrottlerStorage)()),
+    __metadata("design:paramtypes", [Object, Object, core_1.Reflector])
+], ThrottlerGuard);
 exports.ThrottlerGuard = ThrottlerGuard;
-//# sourceMappingURL=throttler.guard.js.map
+//# sourceMappingURL=throttler.guard.js.map