@nathapp/nestjs-captcha 2.0.0 → 3.3.0

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.
Files changed (46) hide show
  1. package/.eslintrc.js +4 -20
  2. package/.turbo/turbo-build.log +4 -0
  3. package/CHANGELOG.md +9 -0
  4. package/LICENSE +1 -1
  5. package/dist/enum/captcha-type.enum.js +1 -0
  6. package/dist/enum/captcha-type.enum.js.map +1 -0
  7. package/dist/enum/index.js +1 -0
  8. package/dist/enum/index.js.map +1 -0
  9. package/dist/extractor/extractor.js +1 -0
  10. package/dist/extractor/extractor.js.map +1 -0
  11. package/dist/extractor/index.js +1 -0
  12. package/dist/extractor/index.js.map +1 -0
  13. package/dist/guard/captcha.guard.js +4 -3
  14. package/dist/guard/captcha.guard.js.map +1 -0
  15. package/dist/guard/index.js +1 -0
  16. package/dist/guard/index.js.map +1 -0
  17. package/dist/index.js +1 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/module/captcha-module.factory.js +1 -0
  20. package/dist/module/captcha-module.factory.js.map +1 -0
  21. package/dist/module/captcha-module.interface.d.ts +1 -0
  22. package/dist/module/captcha-module.interface.js +1 -0
  23. package/dist/module/captcha-module.interface.js.map +1 -0
  24. package/dist/module/captcha-module.validator.d.ts +2 -0
  25. package/dist/module/captcha-module.validator.js +19 -0
  26. package/dist/module/captcha-module.validator.js.map +1 -0
  27. package/dist/module/captcha.module.js +1 -0
  28. package/dist/module/captcha.module.js.map +1 -0
  29. package/dist/module/captcha.provider.js +7 -2
  30. package/dist/module/captcha.provider.js.map +1 -0
  31. package/dist/module/index.d.ts +1 -0
  32. package/dist/module/index.js +2 -0
  33. package/dist/module/index.js.map +1 -0
  34. package/dist/provider/index.js +1 -0
  35. package/dist/provider/index.js.map +1 -0
  36. package/dist/provider/provider.d.ts +1 -0
  37. package/dist/provider/provider.factory.js +5 -0
  38. package/dist/provider/provider.factory.js.map +1 -0
  39. package/dist/provider/provider.interface.js +1 -0
  40. package/dist/provider/provider.interface.js.map +1 -0
  41. package/dist/provider/provider.js +49 -24
  42. package/dist/provider/provider.js.map +1 -0
  43. package/package.json +15 -11
  44. package/bun.lock +0 -1319
  45. package/index.d.ts +0 -1
  46. package/index.js +0 -6
package/.eslintrc.js CHANGED
@@ -1,24 +1,8 @@
1
1
  module.exports = {
2
- parser: '@typescript-eslint/parser',
3
- parserOptions: {
4
- project: 'tsconfig.json',
5
- sourceType: 'module',
6
- },
7
- plugins: ['@typescript-eslint/eslint-plugin'],
8
- extends: [
9
- 'plugin:@typescript-eslint/recommended',
10
- 'plugin:prettier/recommended',
11
- ],
12
2
  root: true,
13
- env: {
14
- node: true,
15
- jest: true,
16
- },
17
- ignorePatterns: ['.eslintrc.js'],
18
- rules: {
19
- '@typescript-eslint/interface-name-prefix': 'off',
20
- '@typescript-eslint/explicit-function-return-type': 'off',
21
- '@typescript-eslint/explicit-module-boundary-types': 'off',
22
- '@typescript-eslint/no-explicit-any': 'off',
3
+ extends: ["@nathapp/eslint-config/library.js"],
4
+ parser: "@typescript-eslint/parser",
5
+ parserOptions: {
6
+ project: true,
23
7
  },
24
8
  };
@@ -0,0 +1,4 @@
1
+
2
+ > @nathapp/nestjs-captcha@3.3.0 build
3
+ > rimraf dist && tsc -p tsconfig.build.json
4
+
package/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ # @nathapp/nestjs-captcha
2
+
3
+ ## 3.3.0
4
+
5
+ ## 3.2.1
6
+
7
+ ### Patch Changes
8
+
9
+ - 50fb234: Fold standalone nestjs-redis and nestjs-captcha repos into the monorepo: shared tooling, NestJS 11 peers, node >=22, lockSettings crash fix, new redis test suite.
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2018 KnowYourself
3
+ Copyright (c) 2026 William Khoo (nathapp)
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -6,3 +6,4 @@ var CaptchaType;
6
6
  CaptchaType["Turnstile"] = "turnstile";
7
7
  CaptchaType["Recaptcha"] = "recaptcha";
8
8
  })(CaptchaType || (exports.CaptchaType = CaptchaType = {}));
9
+ //# sourceMappingURL=captcha-type.enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha-type.enum.js","sourceRoot":"","sources":["../../lib/enum/captcha-type.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;AACzB,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB"}
@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./captcha-type.enum"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}
@@ -30,3 +30,4 @@ exports.Extract = {
30
30
  };
31
31
  }
32
32
  };
33
+ //# sourceMappingURL=extractor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractor.js","sourceRoot":"","sources":["../../lib/extractor/extractor.ts"],"names":[],"mappings":";;;AASa,QAAA,OAAO,GAAG;IAErB,UAAU,EAAE,CAAC,WAAmB,EAAwB,EAAE;QACxD,OAAO,CAAC,OAAY,EAAE,EAAE;YACtB,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACjC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACvC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAA;IACH,CAAC;IAED,aAAa,EAAE,CAAC,UAAkB,EAAwB,EAAE;QAC1D,OAAO,CAAC,OAAY,EAAE,EAAE;YACtB,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAA;IACH,CAAC;IAED,qBAAqB,EAAE,CAAC,UAAkB,EAAwB,EAAE;QAClE,OAAO,CAAC,OAAY,EAAE,EAAE;YACtB,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/C,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACpC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAA;IACH,CAAC;CAEF,CAAA"}
@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./extractor"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/extractor/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B"}
@@ -18,7 +18,7 @@ const module_1 = require("../module");
18
18
  const provider_1 = require("../provider/provider");
19
19
  const nestjs_common_1 = require("@nathapp/nestjs-common");
20
20
  const extractor_1 = require("../extractor");
21
- const captcha_exception_1 = require("@nathapp/nestjs-common/dist/exception/captcha.exception");
21
+ const nestjs_common_2 = require("@nathapp/nestjs-common");
22
22
  const common_2 = require("@nathapp/common");
23
23
  let CaptchaGuard = class CaptchaGuard {
24
24
  constructor(options, captchaProvider) {
@@ -33,14 +33,14 @@ let CaptchaGuard = class CaptchaGuard {
33
33
  const ip = (0, nestjs_common_1.getClientIp)(request);
34
34
  const token = this.extractToken(request);
35
35
  if ((0, common_2.isUndefinedOrNullOrEmpty)(token)) {
36
- throw new captcha_exception_1.CaptchaException();
36
+ throw new nestjs_common_2.CaptchaException();
37
37
  }
38
38
  const tokenResult = await this.captchaProvider.verify({
39
39
  token,
40
40
  ip,
41
41
  });
42
42
  if (!tokenResult.success) {
43
- throw new captcha_exception_1.CaptchaException();
43
+ throw new nestjs_common_2.CaptchaException();
44
44
  }
45
45
  return true;
46
46
  }
@@ -69,3 +69,4 @@ exports.CaptchaGuard = CaptchaGuard = __decorate([
69
69
  __param(0, (0, common_1.Inject)(module_1.CAPTCHA_MODULE_OPTIONS)),
70
70
  __metadata("design:paramtypes", [Object, provider_1.CaptchaProvider])
71
71
  ], CaptchaGuard);
72
+ //# sourceMappingURL=captcha.guard.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha.guard.js","sourceRoot":"","sources":["../../lib/guard/captcha.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmF;AACnF,sCAA2F;AAC3F,mDAAuD;AACvD,0DAAqD;AACrD,4CAAuC;AACvC,0DAA0D;AAC1D,4CAA2D;AAGpD,IAAM,YAAY,GAAlB,MAAM,YAAY;IACvB,YACkD,OAA6B,EAC5D,eAAgC;QADD,YAAO,GAAP,OAAO,CAAsB;QAC5D,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAEvD,KAAK,CAAC,WAAW,CAAC,OAAyB;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,IAAG,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,EAAE,GAAG,IAAA,2BAAW,EAAC,OAAO,CAAC,CAAC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEzC,IAAG,IAAA,iCAAwB,EAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;YACpD,KAAK;YACL,EAAE;SACH,CAAC,CAAC;QAEH,IAAG,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,YAAY,CAAC,OAAY;QAC/B,IAAG,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;aAAK,CAAC;YACL,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAE3C,QAAO,IAAI,EAAE,CAAC;gBACZ,KAAK,QAAQ;oBACX,OAAO,mBAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1C,KAAK,MAAM;oBACT,OAAO,mBAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC7C,KAAK,OAAO;oBACV,OAAO,mBAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBACrD;oBACE,OAAO,IAAI,CAAC;YAChB,CAAC;QACJ,CAAC;IACF,CAAC;CACF,CAAA;AAlDY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,eAAM,EAAC,+BAAsB,CAAC,CAAA;6CACG,0BAAe;GAHxC,YAAY,CAkDxB"}
@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./captcha.guard"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/guard/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}
package/dist/index.js CHANGED
@@ -19,3 +19,4 @@ __exportStar(require("./extractor"), exports);
19
19
  __exportStar(require("./module"), exports);
20
20
  __exportStar(require("./provider"), exports);
21
21
  __exportStar(require("./guard"), exports);
22
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,8CAA4B;AAC5B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB"}
@@ -45,3 +45,4 @@ exports.DefaultCaptchaModuleFactory = DefaultCaptchaModuleFactory = __decorate([
45
45
  (0, common_1.Injectable)(),
46
46
  __metadata("design:paramtypes", [config_1.ConfigService])
47
47
  ], DefaultCaptchaModuleFactory);
48
+ //# sourceMappingURL=captcha-module.factory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha-module.factory.js","sourceRoot":"","sources":["../../lib/module/captcha-module.factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,2CAA+C;AAC/C,4CAA2D;AAIpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAItC,YAA6B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QACvD,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,IAAI,CAAC;YAClD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,GAAG,EAAE,iBAAiB;aACvB;YACD,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAc,cAAc,CAAC;YACzD,OAAO,EAAE;gBACP,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,gBAAgB,CAAC;gBACxD,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,kBAAkB,CAAC;aAC7D;SACF,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,GAAW,EAAE,YAAqB;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,GAAG,CAAC,CAAC;QAChD,IAAI,IAAA,iCAAwB,EAAC,GAAG,CAAC,EAAE,CAAC;YAClC,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,GAAG,CAAC,WAAW,EAAE,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC;IACnD,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CAEF,CAAA;AA/BY,kEAA2B;sCAA3B,2BAA2B;IADvC,IAAA,mBAAU,GAAE;qCAKiC,sBAAa;GAJ9C,2BAA2B,CA+BvC"}
@@ -19,6 +19,7 @@ export interface TurnstileOptions {
19
19
  export interface CaptchaCommonOptions {
20
20
  secret: string;
21
21
  endpoint?: string;
22
+ timeoutMs?: number;
22
23
  }
23
24
  export type CaptchaModuleOptions = {
24
25
  enabled: boolean;
@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.CAPTCHA_PROVIDER = exports.CAPTCHA_MODULE_OPTIONS = void 0;
4
4
  exports.CAPTCHA_MODULE_OPTIONS = 'CAPTCHA_MODULE_OPTIONS';
5
5
  exports.CAPTCHA_PROVIDER = 'CAPTCHA_PROVIDER';
6
+ //# sourceMappingURL=captcha-module.interface.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha-module.interface.js","sourceRoot":"","sources":["../../lib/module/captcha-module.interface.ts"],"names":[],"mappings":";;;AAIa,QAAA,sBAAsB,GAAG,wBAAwB,CAAA;AAEjD,QAAA,gBAAgB,GAAG,kBAAkB,CAAA"}
@@ -0,0 +1,2 @@
1
+ import { CaptchaModuleOptions } from "./captcha-module.interface";
2
+ export declare function validateCaptchaModuleOptions(options: CaptchaModuleOptions): void;
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateCaptchaModuleOptions = validateCaptchaModuleOptions;
4
+ const enum_1 = require("../enum");
5
+ function validateCaptchaModuleOptions(options) {
6
+ var _a;
7
+ if (!(options === null || options === void 0 ? void 0 : options.enabled)) {
8
+ return;
9
+ }
10
+ const supportedTypes = Object.values(enum_1.CaptchaType);
11
+ if (!options.type || !supportedTypes.includes(options.type)) {
12
+ throw new Error(`Invalid CAPTCHA_TYPE: "${options === null || options === void 0 ? void 0 : options.type}". Must be one of: ${supportedTypes.join(', ')}. ` +
13
+ `Set a valid CAPTCHA_TYPE, or disable captcha verification (CAPTCHA_ENABLED=false).`);
14
+ }
15
+ if (!((_a = options.options) === null || _a === void 0 ? void 0 : _a.secret)) {
16
+ throw new Error(`Missing CAPTCHA_SECRET. A secret is required when captcha verification is enabled (CAPTCHA_TYPE="${options.type}").`);
17
+ }
18
+ }
19
+ //# sourceMappingURL=captcha-module.validator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha-module.validator.js","sourceRoot":"","sources":["../../lib/module/captcha-module.validator.ts"],"names":[],"mappings":";;AAWA,oEAmBC;AA9BD,kCAAsC;AAWtC,SAAgB,4BAA4B,CAAC,OAA6B;;IACxE,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAA,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC;IAElD,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CACb,0BAA0B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,sBAAsB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;YAC1F,oFAAoF,CACrF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,MAAM,CAAA,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,oGAAoG,OAAO,CAAC,IAAI,KAAK,CACtH,CAAC;IACJ,CAAC;AACH,CAAC"}
@@ -29,3 +29,4 @@ exports.CaptchaModule = CaptchaModule = __decorate([
29
29
  exports: [captcha_guard_1.CaptchaGuard, provider_1.CaptchaProvider, captcha_module_interface_1.CAPTCHA_PROVIDER, captcha_module_interface_1.CAPTCHA_MODULE_OPTIONS],
30
30
  })
31
31
  ], CaptchaModule);
32
+ //# sourceMappingURL=captcha.module.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha.module.js","sourceRoot":"","sources":["../../lib/module/captcha.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,yEAA4G;AAC5G,0DAAiE;AACjE,yDAA2D;AAC3D,mDAAuD;AACvD,0DAAsD;AAc/C,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,IAAA,uCAAuB,EAAuB,iDAAsB,CAAC;CAEvG,CAAA;AAFY,sCAAa;wBAAb,aAAa;IAZzB,IAAA,eAAM,EAAC;QACN,SAAS,EACT;YACE,IAAA,wCAAqB,GAAE;YACvB;gBACA,OAAO,EAAE,0BAAe;gBACxB,WAAW,EAAE,2CAAgB;aAC5B;YACD,4BAAY;SACb;QACD,OAAO,EAAE,CAAC,4BAAY,EAAE,0BAAe,EAAE,2CAAgB,EAAE,iDAAsB,CAAC;KACnF,CAAC;GACW,aAAa,CAEzB"}
@@ -3,14 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.createCaptchaProvider = void 0;
4
4
  const provider_factory_1 = require("../provider/provider.factory");
5
5
  const captcha_module_interface_1 = require("./captcha-module.interface");
6
+ const captcha_module_validator_1 = require("./captcha-module.validator");
6
7
  const createCaptchaProvider = () => {
7
8
  return {
8
9
  provide: captcha_module_interface_1.CAPTCHA_PROVIDER,
9
10
  useFactory: async (options) => {
10
- const provider = provider_factory_1.CaptchaProviderFactory.createProvider(options);
11
- return provider;
11
+ (0, captcha_module_validator_1.validateCaptchaModuleOptions)(options);
12
+ if (!(options === null || options === void 0 ? void 0 : options.enabled)) {
13
+ return undefined;
14
+ }
15
+ return provider_factory_1.CaptchaProviderFactory.createProvider(options);
12
16
  },
13
17
  inject: [captcha_module_interface_1.CAPTCHA_MODULE_OPTIONS],
14
18
  };
15
19
  };
16
20
  exports.createCaptchaProvider = createCaptchaProvider;
21
+ //# sourceMappingURL=captcha.provider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"captcha.provider.js","sourceRoot":"","sources":["../../lib/module/captcha.provider.ts"],"names":[],"mappings":";;;AACA,mEAAsE;AACtE,yEAIoC;AACpC,yEAA0E;AAEnE,MAAM,qBAAqB,GAAG,GAAa,EAAE;IAClD,OAAO;QACL,OAAO,EAAE,2CAAgB;QACzB,UAAU,EAAE,KAAK,EAAE,OAA6B,EAAE,EAAE;YAGlD,IAAA,uDAA4B,EAAC,OAAO,CAAC,CAAC;YAEtC,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAA,EAAE,CAAC;gBACtB,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,OAAO,yCAAsB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,EAAE,CAAC,iDAAsB,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,qBAAqB,yBAgBhC"}
@@ -1,3 +1,4 @@
1
1
  export * from './captcha-module.interface';
2
2
  export * from './captcha.module';
3
3
  export * from './captcha-module.factory';
4
+ export * from './captcha-module.validator';
@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./captcha-module.interface"), exports);
18
18
  __exportStar(require("./captcha.module"), exports);
19
19
  __exportStar(require("./captcha-module.factory"), exports);
20
+ __exportStar(require("./captcha-module.validator"), exports);
21
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/module/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,mDAAiC;AACjC,2DAA0C;AAC1C,6DAA2C"}
@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./provider.interface"), exports);
18
18
  __exportStar(require("./provider"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/provider/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,6CAA2B"}
@@ -1,5 +1,6 @@
1
1
  import { RecaptchaOptions, TurnstileOptions } from "../module";
2
2
  import { CaptchaVerifyResult, CaptchaVerifyToken } from "./provider.interface";
3
+ export declare const DEFAULT_CAPTCHA_VERIFY_TIMEOUT_MS = 5000;
3
4
  export interface ICaptchaProvider {
4
5
  verify(token: CaptchaVerifyToken): Promise<CaptchaVerifyResult>;
5
6
  }
@@ -10,7 +10,12 @@ class CaptchaProviderFactory {
10
10
  return new provider_1.TurnstileCaptchaProvider(options['options']);
11
11
  case enum_1.CaptchaType.Recaptcha:
12
12
  return new provider_1.RecaptchaCaptchaProvider(options['options']);
13
+ default: {
14
+ const unsupportedType = options === null || options === void 0 ? void 0 : options.type;
15
+ throw new Error(`Unsupported CAPTCHA_TYPE: "${unsupportedType}". Supported types are: ${Object.values(enum_1.CaptchaType).join(', ')}.`);
16
+ }
13
17
  }
14
18
  }
15
19
  }
16
20
  exports.CaptchaProviderFactory = CaptchaProviderFactory;
21
+ //# sourceMappingURL=provider.factory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provider.factory.js","sourceRoot":"","sources":["../../lib/provider/provider.factory.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AAEtC,yCAAiG;AAEjG,MAAa,sBAAsB;IAEjC,MAAM,CAAC,cAAc,CAAC,OAAuB;QAC3C,QAAO,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,kBAAW,CAAC,SAAS;gBACxB,OAAO,IAAI,mCAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1D,KAAK,kBAAW,CAAC,SAAS;gBACxB,OAAO,IAAI,mCAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1D,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,eAAe,GAAI,OAA8B,aAA9B,OAAO,uBAAP,OAAO,CAAyB,IAAI,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,8BAA8B,eAAe,2BAA2B,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CAEF;AAjBD,wDAiBC"}
@@ -1,2 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=provider.interface.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provider.interface.js","sourceRoot":"","sources":["../../lib/provider/provider.interface.ts"],"names":[],"mappings":""}
@@ -1,7 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RecaptchaCaptchaProvider = exports.TurnstileCaptchaProvider = exports.CaptchaProvider = void 0;
3
+ exports.RecaptchaCaptchaProvider = exports.TurnstileCaptchaProvider = exports.CaptchaProvider = exports.DEFAULT_CAPTCHA_VERIFY_TIMEOUT_MS = void 0;
4
4
  const crypto = require("crypto");
5
+ exports.DEFAULT_CAPTCHA_VERIFY_TIMEOUT_MS = 5000;
6
+ const TIMED_OUT_RESULT = {
7
+ success: false,
8
+ hostname: undefined,
9
+ errorCodes: ["timeout-or-network-error"],
10
+ };
5
11
  class CaptchaProvider {
6
12
  }
7
13
  exports.CaptchaProvider = CaptchaProvider;
@@ -23,18 +29,27 @@ class TurnstileCaptchaProvider extends CaptchaProvider {
23
29
  return this.siteVerify(url, tokenPayload, idempotencyKey);
24
30
  }
25
31
  async siteVerify(url, tokenPayload, idempotencyKey) {
26
- const response = await fetch(url, {
27
- body: JSON.stringify({
28
- secret: this.options.secret,
29
- response: tokenPayload.token,
30
- remoteip: tokenPayload.ip,
31
- idempotency_key: idempotencyKey,
32
- }),
33
- method: "POST",
34
- headers: {
35
- "Content-Type": "application/json",
36
- },
37
- });
32
+ var _a;
33
+ const timeoutMs = (_a = this.options.timeoutMs) !== null && _a !== void 0 ? _a : exports.DEFAULT_CAPTCHA_VERIFY_TIMEOUT_MS;
34
+ let response;
35
+ try {
36
+ response = await fetch(url, {
37
+ body: JSON.stringify({
38
+ secret: this.options.secret,
39
+ response: tokenPayload.token,
40
+ remoteip: tokenPayload.ip,
41
+ idempotency_key: idempotencyKey,
42
+ }),
43
+ method: "POST",
44
+ headers: {
45
+ "Content-Type": "application/json",
46
+ },
47
+ signal: AbortSignal.timeout(timeoutMs),
48
+ });
49
+ }
50
+ catch (error) {
51
+ return TIMED_OUT_RESULT;
52
+ }
38
53
  const result = await response.json();
39
54
  return {
40
55
  success: result.success,
@@ -50,19 +65,28 @@ class RecaptchaCaptchaProvider {
50
65
  this.options = options;
51
66
  }
52
67
  async verify(tokenPayload) {
68
+ var _a;
53
69
  const url = this.options.endpoint ||
54
70
  "https://www.google.com/recaptcha/api/siteverify";
55
- const response = await fetch(url, {
56
- body: JSON.stringify({
57
- secret: this.options.secret,
58
- response: tokenPayload.token,
59
- remoteip: tokenPayload.ip,
60
- }),
61
- method: "POST",
62
- headers: {
63
- "Content-Type": "application/json",
64
- },
65
- });
71
+ const timeoutMs = (_a = this.options.timeoutMs) !== null && _a !== void 0 ? _a : exports.DEFAULT_CAPTCHA_VERIFY_TIMEOUT_MS;
72
+ let response;
73
+ try {
74
+ response = await fetch(url, {
75
+ body: JSON.stringify({
76
+ secret: this.options.secret,
77
+ response: tokenPayload.token,
78
+ remoteip: tokenPayload.ip,
79
+ }),
80
+ method: "POST",
81
+ headers: {
82
+ "Content-Type": "application/json",
83
+ },
84
+ signal: AbortSignal.timeout(timeoutMs),
85
+ });
86
+ }
87
+ catch (error) {
88
+ return TIMED_OUT_RESULT;
89
+ }
66
90
  const result = await response.json();
67
91
  return {
68
92
  success: result.success,
@@ -75,3 +99,4 @@ class RecaptchaCaptchaProvider {
75
99
  }
76
100
  }
77
101
  exports.RecaptchaCaptchaProvider = RecaptchaCaptchaProvider;
102
+ //# sourceMappingURL=provider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provider.js","sourceRoot":"","sources":["../../lib/provider/provider.ts"],"names":[],"mappings":";;;AAEA,iCAAiC;AAEpB,QAAA,iCAAiC,GAAG,IAAI,CAAC;AAUtD,MAAM,gBAAgB,GAAwB;IAC5C,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,SAAS;IACnB,UAAU,EAAE,CAAC,0BAA0B,CAAC;CACzC,CAAC;AAEF,MAAsB,eAAe;CAEpC;AAFD,0CAEC;AAED,MAAa,wBAAyB,SAAQ,eAAe;IAG3D,YAAY,OAAoC;QAC9C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAgC;QAC3C,MAAM,GAAG,GACP,IAAI,CAAC,OAAO,CAAC,QAAQ;YACrB,2DAA2D,CAAC;QAE9D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW;YAC7C,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;YACrB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAExE,IAAI,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACrE,OAAO,MAAM,CAAC;QAChB,CAAC;QAGD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,GAAW,EACX,YAAgC,EAChC,cAAuB;;QAEvB,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,yCAAiC,CAAC;QAE9E,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,QAAQ,EAAE,YAAY,CAAC,EAAE;oBACzB,eAAe,EAAE,cAAc;iBAChC,CAAC;gBACF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAEf,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,YAAY;YAChC,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC;SAClC,CAAC;IACJ,CAAC;CACF;AA/DD,4DA+DC;AAED,MAAa,wBAAwB;IAGnC,YAAY,OAAoC;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAgC;;QAC3C,MAAM,GAAG,GACP,IAAI,CAAC,OAAO,CAAC,QAAQ;YACrB,iDAAiD,CAAC;QAEpD,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,yCAAiC,CAAC;QAE9E,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,QAAQ,EAAE,YAAY,CAAC,EAAE;iBAC1B,CAAC;gBACF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAEf,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,YAAY;YAChC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC;SAClC,CAAC;IACJ,CAAC;CACF;AA5CD,4DA4CC"}
package/package.json CHANGED
@@ -1,22 +1,29 @@
1
1
  {
2
2
  "name": "@nathapp/nestjs-captcha",
3
- "version": "2.0.0",
3
+ "version": "3.3.0",
4
4
  "description": "nestjs-captcha",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
5
7
  "scripts": {
6
- "build": "rimraf dist && tsc -p tsconfig.json",
7
- "precommit": "lint-staged",
8
+ "clean": "rimraf dist/ .turbo/",
9
+ "build": "rimraf dist && tsc -p tsconfig.build.json",
8
10
  "test": "jest --config ./test/jest-test.json",
9
11
  "test:cov": "jest --config ./test/jest-test.json --coverage",
10
12
  "test:watch": "jest --config ./test/jest-test.json --watch",
11
- "lint": "eslint -c .eslintrc.js"
13
+ "lint": "eslint -c .eslintrc.js",
14
+ "type-check": "tsc --noEmit -p tsconfig.json",
15
+ "lint:fix": "eslint -c .eslintrc.js --fix"
12
16
  },
13
17
  "author": "William Khoo",
14
- "license": "ISC",
18
+ "license": "MIT",
15
19
  "engines": {
16
20
  "node": ">=22"
17
21
  },
18
22
  "devDependencies": {
19
23
  "@golevelup/ts-jest": "^0.6.2",
24
+ "@nathapp/eslint-config": "1.0.1",
25
+ "@nathapp/nestjs-common": "^3.3.0",
26
+ "@nathapp/typescript-config": "1.0.1",
20
27
  "@nestjs/platform-express": "^11.0.0",
21
28
  "@nestjs/platform-fastify": "^11.0.0",
22
29
  "@nestjs/testing": "^11.0.0",
@@ -26,22 +33,19 @@
26
33
  "@typescript-eslint/eslint-plugin": "^7.1.0",
27
34
  "@typescript-eslint/parser": "^7.1.0",
28
35
  "eslint": "^8.57.1",
29
- "eslint-config-prettier": "^6",
30
- "eslint-plugin-prettier": "^3",
31
36
  "jest": "^29.5.0",
32
- "prettier": "^2",
37
+ "prettier": "^3.2.5",
38
+ "rimraf": "^5.0.0",
33
39
  "supertest": "^6.3.3",
34
40
  "ts-jest": "^29.1.0",
35
41
  "typescript": "^5"
36
42
  },
37
- "types": "./index.d.ts",
38
- "main": "index.js",
39
43
  "directories": {
40
44
  "lib": "lib"
41
45
  },
42
46
  "dependencies": {},
43
47
  "peerDependencies": {
44
- "@nathapp/nestjs-common": "^1.0.2 || ^2.0.0-rc.0",
48
+ "@nathapp/nestjs-common": "^3.0.0",
45
49
  "@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
46
50
  "@nestjs/config": "^1.0.0 || ^2.0.0 || ^3.0.0 || ^4.0.0",
47
51
  "@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",