@nathapp/nestjs-throttler 1.0.1 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/module.d.ts CHANGED
@@ -2,6 +2,7 @@ import { DynamicModule } from '@nestjs/common';
2
2
  import { ThrottlerAsyncOptions } from '@nestjs/throttler';
3
3
  import { ThrottlerModuleOptions } from './interface';
4
4
  export declare class ThrottlerModule {
5
+ private static readonly logger;
5
6
  static forRoot(options: ThrottlerModuleOptions): DynamicModule;
6
7
  static forRootAsync(options: ThrottlerAsyncOptions & {
7
8
  trustProxy?: any;
package/dist/module.js CHANGED
@@ -15,7 +15,17 @@ const throttler_guard_1 = require("./throttler.guard");
15
15
  let ThrottlerModule = ThrottlerModule_1 = class ThrottlerModule {
16
16
  static forRoot(options) {
17
17
  if (options.trustProxy) {
18
- (0, nestjs_common_1.configureTrustProxy)(options.trustProxy);
18
+ if ((0, nestjs_common_1.isTrustProxyConfigured)()) {
19
+ ThrottlerModule_1.logger.warn(`Trust proxy was already configured by "${(0, nestjs_common_1.getTrustProxySource)()}". ` +
20
+ `ThrottlerModule.forRoot() is overriding it. ` +
21
+ `Consider configuring trust proxy only in app.configureTrustProxy() during bootstrap.`);
22
+ }
23
+ (0, nestjs_common_1.configureTrustProxy)(options.trustProxy, 'ThrottlerModule');
24
+ }
25
+ else if (!(0, nestjs_common_1.isTrustProxyConfigured)()) {
26
+ ThrottlerModule_1.logger.warn('ThrottlerModule registered without trust proxy configuration. ' +
27
+ 'IP-based rate limiting may not work correctly behind a proxy. ' +
28
+ 'Configure trust proxy via app.configureTrustProxy() in main.ts or pass trustProxy to ThrottlerModule.forRoot().');
19
29
  }
20
30
  const { trustProxy, ...throttlerOptions } = options;
21
31
  return {
@@ -30,14 +40,24 @@ let ThrottlerModule = ThrottlerModule_1 = class ThrottlerModule {
30
40
  provide: 'TRUST_PROXY_CONFIG',
31
41
  useFactory: async (...args) => {
32
42
  if (options.trustProxy) {
43
+ if ((0, nestjs_common_1.isTrustProxyConfigured)()) {
44
+ ThrottlerModule_1.logger.warn(`Trust proxy was already configured by "${(0, nestjs_common_1.getTrustProxySource)()}". ` +
45
+ `ThrottlerModule.forRootAsync() is overriding it. ` +
46
+ `Consider configuring trust proxy only in app.configureTrustProxy() during bootstrap.`);
47
+ }
33
48
  if (typeof options.trustProxy === 'function') {
34
49
  const config = await options.trustProxy(...args);
35
- (0, nestjs_common_1.configureTrustProxy)(config);
50
+ (0, nestjs_common_1.configureTrustProxy)(config, 'ThrottlerModule');
36
51
  }
37
52
  else {
38
- (0, nestjs_common_1.configureTrustProxy)(options.trustProxy);
53
+ (0, nestjs_common_1.configureTrustProxy)(options.trustProxy, 'ThrottlerModule');
39
54
  }
40
55
  }
56
+ else if (!(0, nestjs_common_1.isTrustProxyConfigured)()) {
57
+ ThrottlerModule_1.logger.warn('ThrottlerModule registered without trust proxy configuration. ' +
58
+ 'IP-based rate limiting may not work correctly behind a proxy. ' +
59
+ 'Configure trust proxy via app.configureTrustProxy() in main.ts or pass trustProxy to ThrottlerModule.forRootAsync().');
60
+ }
41
61
  return null;
42
62
  },
43
63
  inject: options.inject || [],
@@ -52,6 +72,7 @@ let ThrottlerModule = ThrottlerModule_1 = class ThrottlerModule {
52
72
  }
53
73
  };
54
74
  exports.ThrottlerModule = ThrottlerModule;
75
+ ThrottlerModule.logger = new common_1.Logger('ThrottlerModule');
55
76
  exports.ThrottlerModule = ThrottlerModule = ThrottlerModule_1 = __decorate([
56
77
  (0, common_1.Module)({})
57
78
  ], ThrottlerModule);
@@ -1 +1 @@
1
- {"version":3,"file":"module.js","sourceRoot":"","sources":["../lib/module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAiE;AACjE,iDAAkG;AAClG,0DAA6D;AAE7D,uDAA0D;AAGnD,IAAM,eAAe,uBAArB,MAAM,eAAe;IAK1B,MAAM,CAAC,OAAO,CAAC,OAA+B;QAE5C,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAA,mCAAmB,EAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;QAGD,MAAM,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAEpD,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,CAAC,2BAAmB,CAAC,OAAO,CAAC,gBAAuB,CAAC,CAAC;YAC/D,SAAS,EAAE,CAAC,uCAAqB,CAAC;YAClC,OAAO,EAAE,CAAC,uCAAqB,EAAE,2BAAmB,CAAC;SACtD,CAAC;IACJ,CAAC;IAMD,MAAM,CAAC,YAAY,CAAC,OAAqD;QACvE,MAAM,kBAAkB,GAAa;YACnC,OAAO,EAAE,oBAAoB;YAC7B,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACnC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;oBAEvB,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;wBAC7C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;wBACjD,IAAA,mCAAmB,EAAC,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBAEN,IAAA,mCAAmB,EAAC,OAAO,CAAC,UAAU,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;QAGF,MAAM,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAEpD,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,CAAC,2BAAmB,CAAC,YAAY,CAAC,gBAAuB,CAAC,CAAC;YACpE,SAAS,EAAE,CAAC,kBAAkB,EAAE,uCAAqB,CAAC;YACtD,OAAO,EAAE,CAAC,uCAAqB,EAAE,2BAAmB,CAAC;SACtD,CAAC;IACJ,CAAC;CACF,CAAA;AAvDY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,eAAe,CAuD3B"}
1
+ {"version":3,"file":"module.js","sourceRoot":"","sources":["../lib/module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,iDAAkG;AAClG,0DAA0G;AAE1G,uDAA0D;AAGnD,IAAM,eAAe,uBAArB,MAAM,eAAe;IAO1B,MAAM,CAAC,OAAO,CAAC,OAA+B;QAE5C,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,IAAA,sCAAsB,GAAE,EAAE,CAAC;gBAC7B,iBAAe,CAAC,MAAM,CAAC,IAAI,CACzB,0CAA0C,IAAA,mCAAmB,GAAE,KAAK;oBACpE,8CAA8C;oBAC9C,sFAAsF,CACvF,CAAC;YACJ,CAAC;YACD,IAAA,mCAAmB,EAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAC7D,CAAC;aAAM,IAAI,CAAC,IAAA,sCAAsB,GAAE,EAAE,CAAC;YACrC,iBAAe,CAAC,MAAM,CAAC,IAAI,CACzB,gEAAgE;gBAChE,gEAAgE;gBAChE,iHAAiH,CAClH,CAAC;QACJ,CAAC;QAGD,MAAM,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAEpD,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,CAAC,2BAAmB,CAAC,OAAO,CAAC,gBAAuB,CAAC,CAAC;YAC/D,SAAS,EAAE,CAAC,uCAAqB,CAAC;YAClC,OAAO,EAAE,CAAC,uCAAqB,EAAE,2BAAmB,CAAC;SACtD,CAAC;IACJ,CAAC;IAMD,MAAM,CAAC,YAAY,CAAC,OAAqD;QACvE,MAAM,kBAAkB,GAAa;YACnC,OAAO,EAAE,oBAAoB;YAC7B,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACnC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;oBACvB,IAAI,IAAA,sCAAsB,GAAE,EAAE,CAAC;wBAC7B,iBAAe,CAAC,MAAM,CAAC,IAAI,CACzB,0CAA0C,IAAA,mCAAmB,GAAE,KAAK;4BACpE,mDAAmD;4BACnD,sFAAsF,CACvF,CAAC;oBACJ,CAAC;oBAED,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;wBAC7C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;wBACjD,IAAA,mCAAmB,EAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBAEN,IAAA,mCAAmB,EAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;oBAC7D,CAAC;gBACH,CAAC;qBAAM,IAAI,CAAC,IAAA,sCAAsB,GAAE,EAAE,CAAC;oBACrC,iBAAe,CAAC,MAAM,CAAC,IAAI,CACzB,gEAAgE;wBAChE,gEAAgE;wBAChE,sHAAsH,CACvH,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;QAGF,MAAM,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAEpD,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,CAAC,2BAAmB,CAAC,YAAY,CAAC,gBAAuB,CAAC,CAAC;YACpE,SAAS,EAAE,CAAC,kBAAkB,EAAE,uCAAqB,CAAC;YACtD,OAAO,EAAE,CAAC,uCAAqB,EAAE,2BAAmB,CAAC;SACtD,CAAC;IACJ,CAAC;;AAlFU,0CAAe;AACF,sBAAM,GAAG,IAAI,eAAM,CAAC,iBAAiB,CAAC,AAAhC,CAAiC;0BADpD,eAAe;IAD3B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,eAAe,CAmF3B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nathapp/nestjs-throttler",
3
- "version": "1.0.1",
3
+ "version": "2.1.5",
4
4
  "description": "NestJS Throttler with trusted proxy-aware IP resolution",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -19,14 +19,14 @@
19
19
  "node": ">=16"
20
20
  },
21
21
  "peerDependencies": {
22
- "@nathapp/nestjs-common": "^2.1.2",
22
+ "@nathapp/nestjs-common": "^2.1.5",
23
23
  "@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
24
24
  "@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
25
25
  "@nestjs/throttler": "^6.0.0 || ^7.0.0"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@nathapp/eslint-config": "1.0.1",
29
- "@nathapp/nestjs-common": "^2.1.2",
29
+ "@nathapp/nestjs-common": "^2.1.5",
30
30
  "@nathapp/typescript-config": "1.0.1",
31
31
  "@nestjs/common": "^11.0.0",
32
32
  "@nestjs/core": "^11.0.0",