@nestlab/google-recaptcha 3.0.1 → 3.1.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 (64) hide show
  1. package/README.md +62 -2
  2. package/enums/classification-reason.d.ts +8 -0
  3. package/enums/classification-reason.js +13 -0
  4. package/enums/classification-reason.js.map +1 -0
  5. package/enums/error-code.d.ts +3 -1
  6. package/enums/error-code.js +3 -0
  7. package/enums/error-code.js.map +1 -1
  8. package/enums/google-recaptcha-context.d.ts +4 -0
  9. package/enums/google-recaptcha-context.js +9 -0
  10. package/enums/google-recaptcha-context.js.map +1 -0
  11. package/enums/google-recaptcha-enterprise-reason.d.ts +10 -0
  12. package/enums/google-recaptcha-enterprise-reason.js +15 -0
  13. package/enums/google-recaptcha-enterprise-reason.js.map +1 -0
  14. package/exceptions/google-recaptcha.exception.js +4 -0
  15. package/exceptions/google-recaptcha.exception.js.map +1 -1
  16. package/google-recaptcha.module.d.ts +1 -0
  17. package/google-recaptcha.module.js +31 -1
  18. package/google-recaptcha.module.js.map +1 -1
  19. package/guards/google-recaptcha.guard.d.ts +7 -5
  20. package/guards/google-recaptcha.guard.js +23 -8
  21. package/guards/google-recaptcha.guard.js.map +1 -1
  22. package/helpers/xor.d.ts +1 -0
  23. package/helpers/xor.js +8 -0
  24. package/helpers/xor.js.map +1 -0
  25. package/index.d.ts +4 -1
  26. package/index.js +9 -3
  27. package/index.js.map +1 -1
  28. package/interfaces/google-recaptcha-enterprise-options.d.ts +5 -0
  29. package/interfaces/google-recaptcha-enterprise-options.js +3 -0
  30. package/interfaces/google-recaptcha-enterprise-options.js.map +1 -0
  31. package/interfaces/google-recaptcha-module-options.d.ts +3 -0
  32. package/interfaces/google-recaptcha-validator-options.d.ts +3 -1
  33. package/interfaces/verify-response-enterprise.d.ts +29 -0
  34. package/interfaces/{google-recaptcha-validation-result.js → verify-response-enterprise.js} +1 -1
  35. package/interfaces/verify-response-enterprise.js.map +1 -0
  36. package/models/recaptcha-verification-result.d.ts +20 -5
  37. package/models/recaptcha-verification-result.js +17 -4
  38. package/models/recaptcha-verification-result.js.map +1 -1
  39. package/package.json +1 -1
  40. package/provider.declarations.d.ts +1 -0
  41. package/provider.declarations.js +2 -1
  42. package/provider.declarations.js.map +1 -1
  43. package/services/enterprise-reason.transformer.d.ts +5 -0
  44. package/services/enterprise-reason.transformer.js +40 -0
  45. package/services/enterprise-reason.transformer.js.map +1 -0
  46. package/services/recaptcha-validator.resolver.d.ts +11 -0
  47. package/services/recaptcha-validator.resolver.js +44 -0
  48. package/services/recaptcha-validator.resolver.js.map +1 -0
  49. package/services/validators/abstract-google-recaptcha-validator.d.ts +11 -0
  50. package/services/validators/abstract-google-recaptcha-validator.js +28 -0
  51. package/services/validators/abstract-google-recaptcha-validator.js.map +1 -0
  52. package/services/validators/google-recaptcha-enterprise.validator.d.ts +16 -0
  53. package/services/validators/google-recaptcha-enterprise.validator.js +114 -0
  54. package/services/validators/google-recaptcha-enterprise.validator.js.map +1 -0
  55. package/services/validators/google-recaptcha.validator.d.ts +21 -0
  56. package/services/{google-recaptcha.validator.js → validators/google-recaptcha.validator.js} +39 -30
  57. package/services/validators/google-recaptcha.validator.js.map +1 -0
  58. package/enums/application-type.d.ts +0 -4
  59. package/enums/application-type.js +0 -9
  60. package/enums/application-type.js.map +0 -1
  61. package/interfaces/google-recaptcha-validation-result.d.ts +0 -9
  62. package/interfaces/google-recaptcha-validation-result.js.map +0 -1
  63. package/services/google-recaptcha.validator.d.ts +0 -20
  64. package/services/google-recaptcha.validator.js.map +0 -1
package/README.md CHANGED
@@ -8,6 +8,7 @@ Supported for HTTP and GraphQL [NestJS](https://docs.nestjs.com/) applications.
8
8
  - [Configuration](#configuration)
9
9
  - [Usage](#usage)
10
10
  - [Validate in service](#validate-in-service)
11
+ - [Validate in service (enterprise)](#validate-in-service-enterprise)
11
12
  - [Guard](#guard)
12
13
  - [GraphQL guard](#graphql-guard)
13
14
  - [Error handling](#error-handling)
@@ -58,22 +59,55 @@ export class AppModule {
58
59
  }
59
60
  ```
60
61
 
62
+ **Configuration for reCAPTCHA Enterprise**
63
+
64
+ ```typescript
65
+ @Module({
66
+ imports: [
67
+ GoogleRecaptchaModule.forRoot({
68
+ response: (req: IncomingMessage) => (req.headers.recaptcha || '').toString(),
69
+ skipIf: process.env.NODE_ENV !== 'production',
70
+ actions: ['SignUp', 'SignIn'],
71
+ score: 0.8,
72
+ enterprise: {
73
+ projectId: process.env.RECAPTCHA_ENTERPRISE_PROJECT_ID,
74
+ siteKey: process.env.RECAPTCHA_ENTERPRISE_SITE_KEY,
75
+ apiKey: process.env.RECAPTCHA_ENTERPRISE_API_KEY,
76
+ },
77
+ })
78
+ ],
79
+ })
80
+ export class AppModule {
81
+ }
82
+ ```
83
+
61
84
  **Tip: header names transforming to lower case.**
62
85
 
63
86
  **For example:** If you send 'Recaptcha' header then use `(req) => req.headers.recaptcha`
64
87
 
65
- **Configuration options**
88
+ #### Configuration options
66
89
 
67
90
  | Property | Description |
68
91
  |-------------------|-------------|
69
- | `secretKey` | **Required.**<br> Type: `string`<br> Google recaptcha secret key |
70
92
  | `response` | **Required.**<br> Type: `(request) => string`<br> Function that returns response (recaptcha token) by request |
93
+ | `secretKey` | Optional.<br> Type: `string`<br> Google recaptcha secret key. Must be set if you don't use reCAPTCHA Enterprise |
94
+ | `debug` | Optional.<br> Type: `boolean` <br> Default: `false` <br> Enables logging requests, responses, errors and transformed results |
95
+ | `logger` | Optional.<br> Type: `Logger` <br> Default: `new Logger()` <br> Instance of custom logger that extended from Logger (@nestjs/common) |
71
96
  | `skipIf` | Optional.<br> Type: `boolean` \| `(request) => boolean \| Promise<boolean>` <br> Function that returns true if you allow the request to skip the recaptcha verification. Useful for involing other check methods (e.g. custom privileged API key) or for development or testing |
97
+ | `enterprise` | Optional.<br> Type: [`GoogleRecaptchaEnterpriseOptions`](#GoogleRecaptchaEnterpriseOptions) <br> Options for using recCAPTCHA Enterprise API. Cannot using with `secretKey` option. |
72
98
  | `network` | Optional.<br> Type: `GoogleRecaptchaNetwork` \| `string`<br> Default: `GoogleRecaptchaNetwork.Google` <br> If your server has trouble connecting to https://google.com then you can set networks:<br> `GoogleRecaptchaNetwork.Google` = 'https://www.google.com/recaptcha/api/siteverify'<br>`GoogleRecaptchaNetwork.Recaptcha` = 'https://recaptcha.net/recaptcha/api/siteverify'<br> or set any api url |
73
99
  | `score` | Optional.<br> Type: `number` \| `(score: number) => boolean`<br> Score validator for reCAPTCHA v3. <br> `number` - minimum available score. <br> `(score: number) => boolean` - function with custom validation rules. |
74
100
  | `actions` | Optional.<br> Type: `string[]`<br> Available action list for reCAPTCHA v3. <br> You can make this check stricter by passing the action property parameter to `@Recaptcha(...)` decorator. |
75
101
  | `axiosConfig` | Optional.<br> Type: `AxiosRequestConfig`<br> Allows to setup proxy, response timeout, https agent etc... |
76
102
 
103
+ #### GoogleRecaptchaEnterpriseOptions
104
+
105
+ | Property | Description |
106
+ |-----------------|-------------|
107
+ | `projectId` | **Required.**<br> Type: `string`<br> Google Cloud project ID |
108
+ | `siteKey` | **Required.**<br> Type: `string`<br> [reCAPTCHA key](https://cloud.google.com/recaptcha-enterprise/docs/keys) associated with the site/app. |
109
+ | `apiKey` | **Required.**<br> Type: `string`<br> API key associated with the current project. <br>Must have permission `reCAPTCHA Enterprise API`. <br> You can manage credentials [here](https://console.cloud.google.com/apis/credentials). |
110
+
77
111
  If you want import configs from your [ConfigService](https://docs.nestjs.com/techniques/configuration#getting-started) via [custom getter function](https://docs.nestjs.com/techniques/configuration#custom-getter-functions) that will return `GoogleRecaptchaModuleOptions` object.
78
112
 
79
113
  ```typescript
@@ -115,6 +149,32 @@ export class SomeService {
115
149
  }
116
150
  ```
117
151
 
152
+ ### Validate in service (Enterprise)
153
+
154
+ ```typescript
155
+ @Injectable()
156
+ export class SomeService {
157
+ constructor(private readonly recaptchaEnterpriseValidator: GoogleRecaptchaEnterpriseValidator) {
158
+ }
159
+
160
+ async someAction(recaptchaToken: string): Promise<void> {
161
+ const result = await this.recaptchaEnterpriseValidator.validate({
162
+ response: recaptchaToken,
163
+ score: 0.8,
164
+ action: 'SomeAction',
165
+ });
166
+
167
+ if (!result.success) {
168
+ throw new GoogleRecaptchaException(result.errors);
169
+ }
170
+
171
+ const riskAnalytics = result.getEnterpriseRiskAnalytics();
172
+
173
+ // TODO: Your implemetation
174
+ }
175
+ }
176
+ ```
177
+
118
178
  ### Guard
119
179
 
120
180
  Use `@Recaptcha` decorator to protect your endpoints.
@@ -0,0 +1,8 @@
1
+ export declare enum ClassificationReason {
2
+ CLASSIFICATION_REASON_UNSPECIFIED = "CLASSIFICATION_REASON_UNSPECIFIED",
3
+ AUTOMATION = "AUTOMATION",
4
+ UNEXPECTED_ENVIRONMENT = "UNEXPECTED_ENVIRONMENT",
5
+ TOO_MUCH_TRAFFIC = "TOO_MUCH_TRAFFIC",
6
+ UNEXPECTED_USAGE_PATTERNS = "UNEXPECTED_USAGE_PATTERNS",
7
+ LOW_CONFIDENCE_SCORE = "LOW_CONFIDENCE_SCORE"
8
+ }
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ClassificationReason = void 0;
4
+ var ClassificationReason;
5
+ (function (ClassificationReason) {
6
+ ClassificationReason["CLASSIFICATION_REASON_UNSPECIFIED"] = "CLASSIFICATION_REASON_UNSPECIFIED";
7
+ ClassificationReason["AUTOMATION"] = "AUTOMATION";
8
+ ClassificationReason["UNEXPECTED_ENVIRONMENT"] = "UNEXPECTED_ENVIRONMENT";
9
+ ClassificationReason["TOO_MUCH_TRAFFIC"] = "TOO_MUCH_TRAFFIC";
10
+ ClassificationReason["UNEXPECTED_USAGE_PATTERNS"] = "UNEXPECTED_USAGE_PATTERNS";
11
+ ClassificationReason["LOW_CONFIDENCE_SCORE"] = "LOW_CONFIDENCE_SCORE";
12
+ })(ClassificationReason = exports.ClassificationReason || (exports.ClassificationReason = {}));
13
+ //# sourceMappingURL=classification-reason.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"classification-reason.js","sourceRoot":"","sources":["../../src/enums/classification-reason.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC5B,+FAAuE,CAAA;IACvE,iDAAyB,CAAA;IACzB,yEAAiD,CAAA;IACjD,6DAAqC,CAAA;IACrC,+EAAuD,CAAA;IACvD,qEAA6C,CAAA;AACjD,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B"}
@@ -9,5 +9,7 @@ export declare enum ErrorCode {
9
9
  ForbiddenAction = "forbidden-action",
10
10
  LowScore = "low-score",
11
11
  InvalidKeys = "invalid-keys",
12
- NetworkError = "network-error"
12
+ NetworkError = "network-error",
13
+ SiteMismatch = "site-mismatch",
14
+ BrowserError = "browser-error"
13
15
  }
@@ -14,5 +14,8 @@ var ErrorCode;
14
14
  ErrorCode["LowScore"] = "low-score";
15
15
  ErrorCode["InvalidKeys"] = "invalid-keys";
16
16
  ErrorCode["NetworkError"] = "network-error";
17
+ // enterprise
18
+ ErrorCode["SiteMismatch"] = "site-mismatch";
19
+ ErrorCode["BrowserError"] = "browser-error";
17
20
  })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
18
21
  //# sourceMappingURL=error-code.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"error-code.js","sourceRoot":"","sources":["../../src/enums/error-code.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAYX;AAZD,WAAY,SAAS;IACpB,wDAA2C,CAAA;IAC3C,wDAA2C,CAAA;IAC3C,4DAA+C,CAAA;IAC/C,4DAA+C,CAAA;IAC/C,uCAA0B,CAAA;IAC1B,wDAA2C,CAAA;IAC3C,2CAA8B,CAAA;IAC9B,iDAAoC,CAAA;IACpC,mCAAsB,CAAA;IACtB,yCAA4B,CAAA;IACzB,2CAA8B,CAAA;AAClC,CAAC,EAZW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAYpB"}
1
+ {"version":3,"file":"error-code.js","sourceRoot":"","sources":["../../src/enums/error-code.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB,wDAA2C,CAAA;IAC3C,wDAA2C,CAAA;IAC3C,4DAA+C,CAAA;IAC/C,4DAA+C,CAAA;IAC/C,uCAA0B,CAAA;IAC1B,wDAA2C,CAAA;IAC3C,2CAA8B,CAAA;IAC9B,iDAAoC,CAAA;IACpC,mCAAsB,CAAA;IACtB,yCAA4B,CAAA;IACzB,2CAA8B,CAAA;IACjC,aAAa;IACb,2CAA8B,CAAA;IAC9B,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAepB"}
@@ -0,0 +1,4 @@
1
+ export declare enum GoogleRecaptchaContext {
2
+ GoogleRecaptcha = "GoogleRecaptcha",
3
+ GoogleRecaptchaEnterprise = "GoogleRecaptchaEnterprise"
4
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.GoogleRecaptchaContext = void 0;
4
+ var GoogleRecaptchaContext;
5
+ (function (GoogleRecaptchaContext) {
6
+ GoogleRecaptchaContext["GoogleRecaptcha"] = "GoogleRecaptcha";
7
+ GoogleRecaptchaContext["GoogleRecaptchaEnterprise"] = "GoogleRecaptchaEnterprise";
8
+ })(GoogleRecaptchaContext = exports.GoogleRecaptchaContext || (exports.GoogleRecaptchaContext = {}));
9
+ //# sourceMappingURL=google-recaptcha-context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"google-recaptcha-context.js","sourceRoot":"","sources":["../../src/enums/google-recaptcha-context.ts"],"names":[],"mappings":";;;AAAA,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,6DAAmC,CAAA;IACnC,iFAAuD,CAAA;AAC3D,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC"}
@@ -0,0 +1,10 @@
1
+ export declare enum GoogleRecaptchaEnterpriseReason {
2
+ InvalidReasonUnspecified = "INVALID_REASON_UNSPECIFIED",
3
+ UnknownInvalidReason = "UNKNOWN_INVALID_REASON",
4
+ Malformed = "MALFORMED",
5
+ Expired = "EXPIRED",
6
+ Dupe = "DUPE",
7
+ SiteMismatch = "SITE_MISMATCH",
8
+ Missing = "MISSING",
9
+ BrowserError = "BROWSER_ERROR"
10
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.GoogleRecaptchaEnterpriseReason = void 0;
4
+ var GoogleRecaptchaEnterpriseReason;
5
+ (function (GoogleRecaptchaEnterpriseReason) {
6
+ GoogleRecaptchaEnterpriseReason["InvalidReasonUnspecified"] = "INVALID_REASON_UNSPECIFIED";
7
+ GoogleRecaptchaEnterpriseReason["UnknownInvalidReason"] = "UNKNOWN_INVALID_REASON";
8
+ GoogleRecaptchaEnterpriseReason["Malformed"] = "MALFORMED";
9
+ GoogleRecaptchaEnterpriseReason["Expired"] = "EXPIRED";
10
+ GoogleRecaptchaEnterpriseReason["Dupe"] = "DUPE";
11
+ GoogleRecaptchaEnterpriseReason["SiteMismatch"] = "SITE_MISMATCH";
12
+ GoogleRecaptchaEnterpriseReason["Missing"] = "MISSING";
13
+ GoogleRecaptchaEnterpriseReason["BrowserError"] = "BROWSER_ERROR";
14
+ })(GoogleRecaptchaEnterpriseReason = exports.GoogleRecaptchaEnterpriseReason || (exports.GoogleRecaptchaEnterpriseReason = {}));
15
+ //# sourceMappingURL=google-recaptcha-enterprise-reason.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"google-recaptcha-enterprise-reason.js","sourceRoot":"","sources":["../../src/enums/google-recaptcha-enterprise-reason.ts"],"names":[],"mappings":";;;AAAA,IAAY,+BASX;AATD,WAAY,+BAA+B;IACvC,0FAAuD,CAAA;IACvD,kFAA+C,CAAA;IAC/C,0DAAuB,CAAA;IACvB,sDAAmB,CAAA;IACnB,gDAAa,CAAA;IACb,iEAA8B,CAAA;IAC9B,sDAAmB,CAAA;IACnB,iEAA8B,CAAA;AAClC,CAAC,EATW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAS1C"}
@@ -25,6 +25,10 @@ class GoogleRecaptchaException extends common_1.HttpException {
25
25
  return 'Low recaptcha score.';
26
26
  case error_code_1.ErrorCode.ForbiddenAction:
27
27
  return 'Forbidden recaptcha action.';
28
+ case error_code_1.ErrorCode.SiteMismatch:
29
+ return 'The user verification token did not match the provided site key.';
30
+ case error_code_1.ErrorCode.BrowserError:
31
+ return 'Retriable error (such as network failure) occurred on the browser.';
28
32
  case error_code_1.ErrorCode.UnknownError:
29
33
  case error_code_1.ErrorCode.BadRequest:
30
34
  default:
@@ -1 +1 @@
1
- {"version":3,"file":"google-recaptcha.exception.js","sourceRoot":"","sources":["../../src/exceptions/google-recaptcha.exception.ts"],"names":[],"mappings":";;;AAAA,2CAAyD;AACzD,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAa;IAC1D,YAA4B,UAAuB,EACpC,YAAqB;QAC7B,KAAK,CACD,YAAY,IAAI,wBAAwB,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACvE,wBAAwB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CACzD,CAAC;QALmB,eAAU,GAAV,UAAU,CAAa;IAMnD,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,SAAoB;QAClD,QAAQ,SAAS,EAAE;YAClB,KAAK,sBAAS,CAAC,oBAAoB;gBAClC,OAAO,iDAAiD,CAAC;YAE1D,KAAK,sBAAS,CAAC,oBAAoB;gBAClC,OAAO,oCAAoC,CAAC;YAC7C,KAAK,sBAAS,CAAC,kBAAkB;gBAChC,OAAO,iFAAiF,CAAC;YAE1F,KAAK,sBAAS,CAAC,kBAAkB,CAAC;YAClC,KAAK,sBAAS,CAAC,kBAAkB;gBAChC,OAAO,gEAAgE,CAAC;YAEzE,KAAK,sBAAS,CAAC,WAAW;gBACzB,OAAO,gDAAgD,CAAC;YAEzD,KAAK,sBAAS,CAAC,QAAQ;gBACtB,OAAO,sBAAsB,CAAA;YAE9B,KAAK,sBAAS,CAAC,eAAe;gBAC7B,OAAO,6BAA6B,CAAA;YAE5B,KAAK,sBAAS,CAAC,YAAY,CAAC;YACrC,KAAK,sBAAS,CAAC,UAAU,CAAC;YAC1B;gBACC,OAAO,qEAAqE,CAAC;SAC9E;IACF,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,SAAoB;QACjD,OAAO,SAAS,KAAK,sBAAS,CAAC,oBAAoB;YAClD,SAAS,KAAK,sBAAS,CAAC,oBAAoB;YAC5C,SAAS,KAAK,sBAAS,CAAC,kBAAkB;YAC1C,SAAS,KAAK,sBAAS,CAAC,eAAe;YACvC,SAAS,KAAK,sBAAS,CAAC,QAAQ;YAChC,SAAS,KAAK,sBAAS,CAAC,WAAW;YACpC,CAAC,CAAC,mBAAU,CAAC,WAAW;YACxB,CAAC,CAAC,mBAAU,CAAC,qBAAqB,CAAC;IACpC,CAAC;CACD;AAjDD,4DAiDC"}
1
+ {"version":3,"file":"google-recaptcha.exception.js","sourceRoot":"","sources":["../../src/exceptions/google-recaptcha.exception.ts"],"names":[],"mappings":";;;AAAA,2CAAyD;AACzD,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAa;IAC1D,YAA4B,UAAuB,EACpC,YAAqB;QAC7B,KAAK,CACD,YAAY,IAAI,wBAAwB,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACvE,wBAAwB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CACzD,CAAC;QALmB,eAAU,GAAV,UAAU,CAAa;IAMnD,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,SAAoB;QAClD,QAAQ,SAAS,EAAE;YAClB,KAAK,sBAAS,CAAC,oBAAoB;gBAClC,OAAO,iDAAiD,CAAC;YAE1D,KAAK,sBAAS,CAAC,oBAAoB;gBAClC,OAAO,oCAAoC,CAAC;YAC7C,KAAK,sBAAS,CAAC,kBAAkB;gBAChC,OAAO,iFAAiF,CAAC;YAE1F,KAAK,sBAAS,CAAC,kBAAkB,CAAC;YAClC,KAAK,sBAAS,CAAC,kBAAkB;gBAChC,OAAO,gEAAgE,CAAC;YAEzE,KAAK,sBAAS,CAAC,WAAW;gBACzB,OAAO,gDAAgD,CAAC;YAEzD,KAAK,sBAAS,CAAC,QAAQ;gBACtB,OAAO,sBAAsB,CAAA;YAE9B,KAAK,sBAAS,CAAC,eAAe;gBAC7B,OAAO,6BAA6B,CAAA;YAErC,KAAK,sBAAS,CAAC,YAAY;gBAC1B,OAAO,kEAAkE,CAAC;YAE3E,KAAK,sBAAS,CAAC,YAAY;gBAC1B,OAAO,oEAAoE,CAAC;YAE7E,KAAK,sBAAS,CAAC,YAAY,CAAC;YAC5B,KAAK,sBAAS,CAAC,UAAU,CAAC;YAC1B;gBACC,OAAO,qEAAqE,CAAC;SAC9E;IACF,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,SAAoB;QACjD,OAAO,SAAS,KAAK,sBAAS,CAAC,oBAAoB;YAClD,SAAS,KAAK,sBAAS,CAAC,oBAAoB;YAC5C,SAAS,KAAK,sBAAS,CAAC,kBAAkB;YAC1C,SAAS,KAAK,sBAAS,CAAC,eAAe;YACvC,SAAS,KAAK,sBAAS,CAAC,QAAQ;YAChC,SAAS,KAAK,sBAAS,CAAC,WAAW;YACpC,CAAC,CAAC,mBAAU,CAAC,WAAW;YACxB,CAAC,CAAC,mBAAU,CAAC,qBAAqB,CAAC;IACpC,CAAC;CACD;AAvDD,4DAuDC"}
@@ -8,5 +8,6 @@ export declare class GoogleRecaptchaModule {
8
8
  private static transformAxiosConfig;
9
9
  private static createAsyncProviders;
10
10
  private static createAsyncOptionsProvider;
11
+ private static validateOptions;
11
12
  private static isGoogleRecaptchaFactory;
12
13
  }
@@ -12,26 +12,39 @@ var __rest = (this && this.__rest) || function (s, e) {
12
12
  };
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
14
  exports.GoogleRecaptchaModule = void 0;
15
+ const common_1 = require("@nestjs/common");
15
16
  const google_recaptcha_guard_1 = require("./guards/google-recaptcha.guard");
16
- const google_recaptcha_validator_1 = require("./services/google-recaptcha.validator");
17
+ const google_recaptcha_validator_1 = require("./services/validators/google-recaptcha.validator");
18
+ const google_recaptcha_enterprise_validator_1 = require("./services/validators/google-recaptcha-enterprise.validator");
17
19
  const provider_declarations_1 = require("./provider.declarations");
18
20
  const recaptcha_request_resolver_1 = require("./services/recaptcha-request.resolver");
19
21
  const load_module_1 = require("./helpers/load-module");
20
22
  const core_1 = require("@nestjs/core");
21
23
  const axios = require("axios");
22
24
  const https_1 = require("https");
25
+ const recaptcha_validator_resolver_1 = require("./services/recaptcha-validator.resolver");
26
+ const enterprise_reason_transformer_1 = require("./services/enterprise-reason.transformer");
27
+ const xor_1 = require("./helpers/xor");
23
28
  class GoogleRecaptchaModule {
24
29
  static forRoot(options) {
25
30
  const providers = [
26
31
  core_1.Reflector,
27
32
  google_recaptcha_guard_1.GoogleRecaptchaGuard,
28
33
  google_recaptcha_validator_1.GoogleRecaptchaValidator,
34
+ google_recaptcha_enterprise_validator_1.GoogleRecaptchaEnterpriseValidator,
29
35
  recaptcha_request_resolver_1.RecaptchaRequestResolver,
36
+ recaptcha_validator_resolver_1.RecaptchaValidatorResolver,
37
+ enterprise_reason_transformer_1.EnterpriseReasonTransformer,
30
38
  {
31
39
  provide: provider_declarations_1.RECAPTCHA_OPTIONS,
32
40
  useValue: options,
33
41
  },
42
+ {
43
+ provide: provider_declarations_1.RECAPTCHA_LOGGER,
44
+ useFactory: () => options.logger || new common_1.Logger(),
45
+ },
34
46
  ];
47
+ this.validateOptions(options);
35
48
  const httpModule = this.resolveHttpModule();
36
49
  const internalProviders = [
37
50
  {
@@ -59,9 +72,19 @@ class GoogleRecaptchaModule {
59
72
  static forRootAsync(options) {
60
73
  const providers = [
61
74
  core_1.Reflector,
75
+ {
76
+ provide: provider_declarations_1.RECAPTCHA_LOGGER,
77
+ useFactory: (options) => options.logger || new common_1.Logger(),
78
+ inject: [
79
+ provider_declarations_1.RECAPTCHA_OPTIONS,
80
+ ],
81
+ },
62
82
  google_recaptcha_guard_1.GoogleRecaptchaGuard,
63
83
  google_recaptcha_validator_1.GoogleRecaptchaValidator,
84
+ google_recaptcha_enterprise_validator_1.GoogleRecaptchaEnterpriseValidator,
64
85
  recaptcha_request_resolver_1.RecaptchaRequestResolver,
86
+ recaptcha_validator_resolver_1.RecaptchaValidatorResolver,
87
+ enterprise_reason_transformer_1.EnterpriseReasonTransformer,
65
88
  ...this.createAsyncProviders(options)
66
89
  ];
67
90
  const httpModule = this.resolveHttpModule();
@@ -76,6 +99,7 @@ class GoogleRecaptchaModule {
76
99
  {
77
100
  provide: provider_declarations_1.RECAPTCHA_AXIOS_INSTANCE,
78
101
  useFactory: (options) => {
102
+ this.validateOptions(options);
79
103
  const transformedAxiosConfig = this.transformAxiosConfig(Object.assign(Object.assign(Object.assign({}, this.axiosDefaultConfig), options.axiosConfig), { headers: null }));
80
104
  return axios.default.create(transformedAxiosConfig);
81
105
  },
@@ -136,6 +160,12 @@ class GoogleRecaptchaModule {
136
160
  inject: [options.useExisting || options.useClass],
137
161
  };
138
162
  }
163
+ static validateOptions(options) {
164
+ const hasEnterpriseOptions = !!Object.keys(options.enterprise || {}).length;
165
+ if (!(0, xor_1.xor)(!!options.secretKey, hasEnterpriseOptions)) {
166
+ throw new Error('Google recaptcha options must be contains "secretKey" xor "enterprise".');
167
+ }
168
+ }
139
169
  static isGoogleRecaptchaFactory(object) {
140
170
  return !!object && typeof object.createGoogleRecaptchaOptions === 'function';
141
171
  }
@@ -1 +1 @@
1
- {"version":3,"file":"google-recaptcha.module.js","sourceRoot":"","sources":["../src/google-recaptcha.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,4EAAuE;AACvE,sFAAiF;AAKjF,mEAA8G;AAC9G,sFAAiF;AACjF,uDAAmD;AACnD,uCAAyC;AACzC,+BAA+B;AAC/B,iCAA8B;AAE9B,MAAa,qBAAqB;IAM9B,MAAM,CAAC,OAAO,CAAC,OAAqC;QAChD,MAAM,SAAS,GAAe;YAC1B,gBAAS;YACT,6CAAoB;YACpB,qDAAwB;YACxB,qDAAwB;YACxB;gBACI,OAAO,EAAE,yCAAiB;gBAC1B,QAAQ,EAAE,OAAO;aACpB;SACJ,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE5C,MAAM,iBAAiB,GAAe;YAClC;gBACI,OAAO,EAAE,8CAAsB;gBAC/B,UAAU,EAAE,CAAC,aAAkC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC;gBAC7F,MAAM,EAAE;oBACJ,gDAAwB;iBAC3B;aACJ;YACD;gBACI,OAAO,EAAE,gDAAwB;gBACjC,UAAU,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,+CACzD,IAAI,CAAC,kBAAkB,GACvB,OAAO,CAAC,WAAW,KACtB,OAAO,EAAE,IAAI,IACf,CAAC;aACN;SACJ,CAAC;QAEF,OAAO;YACH,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE;gBACL,UAAU,CAAC,UAAU;aACxB;YACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC9C,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAA0C;QAC1D,MAAM,SAAS,GAAe;YAC1B,gBAAS;YACT,6CAAoB;YACpB,qDAAwB;YACxB,qDAAwB;YACxB,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;SACxC,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE5C,MAAM,iBAAiB,GAAe;YAClC;gBACI,OAAO,EAAE,8CAAsB;gBAC/B,UAAU,EAAE,CAAC,aAAkC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC;gBAC7F,MAAM,EAAE;oBACJ,gDAAwB;iBAC3B;aACJ;YACD;gBACI,OAAO,EAAE,gDAAwB;gBACjC,UAAU,EAAE,CAAC,OAAqC,EAAE,EAAE;oBAClD,MAAM,sBAAsB,GAAG,IAAI,CAAC,oBAAoB,+CACjD,IAAI,CAAC,kBAAkB,GACvB,OAAO,CAAC,WAAW,KACtB,OAAO,EAAE,IAAI,IACf,CAAC;oBACH,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;gBACxD,CAAC;gBACD,MAAM,EAAE;oBACJ,yCAAiB;iBACpB;aACJ;SACJ,CAAC;QAEF,OAAO;YACN,MAAM,EAAE,IAAI;YACT,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE;gBACL,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE;gBACxB,UAAU,CAAC,UAAU;aACxB;YACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC9C,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,iBAAiB;QAC5B,IAAI;YACA,OAAO,IAAA,wBAAU,EAAC,eAAe,CAAC,CAAC;SACtC;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,IAAA,wBAAU,EAAC,gBAAgB,CAAC,CAAC;SACvC;IACL,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,WAAsC;QACtE,MAAM,KAYF,WAAW,IAAI,EAAE,EAZf,EACF,OAAO,EACP,GAAG,EACH,YAAY,EACZ,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,IAAI,EACJ,OAAO,OAEU,EADd,MAAM,cAXP,8IAYL,CAAoB,CAAC;QAEtB,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,OAA0C;QAC1E,MAAM,SAAS,GAAe,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzE,IAAI,OAAO,CAAC,QAAQ,EAAE;YAClB,SAAS,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,OAAO,CAAC,QAAQ;gBACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC7B,CAAC,CAAC;SACN;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAA0C;QAChF,IAAI,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO;gBACH,OAAO,EAAE,yCAAiB;gBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC/B,CAAC;SACL;QAED,OAAO;YACH,OAAO,EAAE,yCAAiB;YAC1B,UAAU,EAAE,CAAC,cAA6C,EAAE,EAAE;gBAC1D,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE;oBAChD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAA;iBAC5F;gBACD,OAAO,cAAc,CAAC,4BAA4B,EAAE,CAAC;YACzD,CAAC;YACD,MAAM,EAAE,CAAC,OAAO,CAAC,WAAY,IAAI,OAAO,CAAC,QAAS,CAAC;SACtD,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,MAAW;QAC/C,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,CAAC,4BAA4B,KAAK,UAAU,CAAC;IACjF,CAAC;;AA9JL,sDA+JC;AA9JkB,wCAAkB,GAA6B;IAC1D,OAAO,EAAE,KAAM;IACf,UAAU,EAAE,IAAI,aAAK,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC;CAC3C,CAAC"}
1
+ {"version":3,"file":"google-recaptcha.module.js","sourceRoot":"","sources":["../src/google-recaptcha.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,2CAAiE;AACjE,4EAAuE;AACvE,iGAA4F;AAC5F,uHAAiH;AAKjH,mEAKiC;AACjC,sFAAiF;AACjF,uDAAmD;AACnD,uCAAyC;AACzC,+BAA+B;AAC/B,iCAA8B;AAC9B,0FAAqF;AACrF,4FAAuF;AACvF,uCAAoC;AAEpC,MAAa,qBAAqB;IAM9B,MAAM,CAAC,OAAO,CAAC,OAAqC;QAChD,MAAM,SAAS,GAAe;YAC1B,gBAAS;YACT,6CAAoB;YACpB,qDAAwB;YACxB,0EAAkC;YAClC,qDAAwB;YACxB,yDAA0B;YAC1B,2DAA2B;YAC3B;gBACI,OAAO,EAAE,yCAAiB;gBAC1B,QAAQ,EAAE,OAAO;aACpB;YACD;gBACI,OAAO,EAAE,wCAAgB;gBACzB,UAAU,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,eAAM,EAAE;aACnD;SACJ,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE5C,MAAM,iBAAiB,GAAe;YAClC;gBACI,OAAO,EAAE,8CAAsB;gBAC/B,UAAU,EAAE,CAAC,aAAkC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC;gBAC7F,MAAM,EAAE;oBACJ,gDAAwB;iBAC3B;aACJ;YACD;gBACI,OAAO,EAAE,gDAAwB;gBACjC,UAAU,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,+CACzD,IAAI,CAAC,kBAAkB,GACvB,OAAO,CAAC,WAAW,KACtB,OAAO,EAAE,IAAI,IACf,CAAC;aACN;SACJ,CAAC;QAEF,OAAO;YACH,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE;gBACL,UAAU,CAAC,UAAU;aACxB;YACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC9C,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAA0C;QAC1D,MAAM,SAAS,GAAe;YAC1B,gBAAS;YACT;gBACI,OAAO,EAAE,wCAAgB;gBACzB,UAAU,EAAE,CAAC,OAAqC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,eAAM,EAAE;gBACrF,MAAM,EAAE;oBACJ,yCAAiB;iBACpB;aACJ;YACD,6CAAoB;YACpB,qDAAwB;YACxB,0EAAkC;YAClC,qDAAwB;YACxB,yDAA0B;YAC1B,2DAA2B;YAC3B,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;SACxC,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE5C,MAAM,iBAAiB,GAAe;YAClC;gBACI,OAAO,EAAE,8CAAsB;gBAC/B,UAAU,EAAE,CAAC,aAAkC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC;gBAC7F,MAAM,EAAE;oBACJ,gDAAwB;iBAC3B;aACJ;YACD;gBACI,OAAO,EAAE,gDAAwB;gBACjC,UAAU,EAAE,CAAC,OAAqC,EAAE,EAAE;oBAClD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;oBAE9B,MAAM,sBAAsB,GAAG,IAAI,CAAC,oBAAoB,+CACjD,IAAI,CAAC,kBAAkB,GACvB,OAAO,CAAC,WAAW,KACtB,OAAO,EAAE,IAAI,IACf,CAAC;oBACH,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;gBACxD,CAAC;gBACD,MAAM,EAAE;oBACJ,yCAAiB;iBACpB;aACJ;SACJ,CAAC;QAEF,OAAO;YACN,MAAM,EAAE,IAAI;YACT,MAAM,EAAE,qBAAqB;YAC7B,OAAO,EAAE;gBACL,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE;gBACxB,UAAU,CAAC,UAAU;aACxB;YACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC9C,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,iBAAiB;QAC5B,IAAI;YACA,OAAO,IAAA,wBAAU,EAAC,eAAe,CAAC,CAAC;SACtC;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,IAAA,wBAAU,EAAC,gBAAgB,CAAC,CAAC;SACvC;IACL,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,WAAsC;QACtE,MAAM,KAYF,WAAW,IAAI,EAAE,EAZf,EACF,OAAO,EACP,GAAG,EACH,YAAY,EACZ,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,IAAI,EACJ,OAAO,OAEU,EADd,MAAM,cAXP,8IAYL,CAAoB,CAAC;QAEtB,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,OAA0C;QAC1E,MAAM,SAAS,GAAe,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzE,IAAI,OAAO,CAAC,QAAQ,EAAE;YAClB,SAAS,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,OAAO,CAAC,QAAQ;gBACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC7B,CAAC,CAAC;SACN;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAA0C;QAChF,IAAI,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO;gBACH,OAAO,EAAE,yCAAiB;gBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC/B,CAAC;SACL;QAED,OAAO;YACH,OAAO,EAAE,yCAAiB;YAC1B,UAAU,EAAE,CAAC,cAA6C,EAAE,EAAE;gBAC1D,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE;oBAChD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAA;iBAC5F;gBACD,OAAO,cAAc,CAAC,4BAA4B,EAAE,CAAC;YACzD,CAAC;YACD,MAAM,EAAE,CAAC,OAAO,CAAC,WAAY,IAAI,OAAO,CAAC,QAAS,CAAC;SACtD,CAAC;IACN,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,OAAqC;QAChE,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAC5E,IAAI,CAAC,IAAA,SAAG,EAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,oBAAoB,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;SAC9F;IACL,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,MAAW;QAC/C,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,CAAC,4BAA4B,KAAK,UAAU,CAAC;IACjF,CAAC;;AA1LL,sDA2LC;AA1LkB,wCAAkB,GAA6B;IAC1D,OAAO,EAAE,KAAM;IACf,UAAU,EAAE,IAAI,aAAK,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC;CAC3C,CAAC"}
@@ -1,13 +1,15 @@
1
- import { CanActivate, ExecutionContext } from '@nestjs/common';
2
- import { GoogleRecaptchaValidator } from '../services/google-recaptcha.validator';
3
- import { GoogleRecaptchaGuardOptions } from '../interfaces/google-recaptcha-guard-options';
1
+ import { CanActivate, ExecutionContext, Logger } from '@nestjs/common';
4
2
  import { Reflector } from '@nestjs/core';
5
3
  import { RecaptchaRequestResolver } from '../services/recaptcha-request.resolver';
4
+ import { GoogleRecaptchaModuleOptions } from '../interfaces/google-recaptcha-module-options';
5
+ import { RecaptchaValidatorResolver } from '../services/recaptcha-validator.resolver';
6
6
  export declare class GoogleRecaptchaGuard implements CanActivate {
7
- private readonly validator;
8
7
  private readonly reflector;
9
8
  private readonly requestResolver;
9
+ private readonly validatorResolver;
10
+ private readonly logger;
10
11
  private readonly options;
11
- constructor(validator: GoogleRecaptchaValidator, reflector: Reflector, requestResolver: RecaptchaRequestResolver, options: GoogleRecaptchaGuardOptions);
12
+ constructor(reflector: Reflector, requestResolver: RecaptchaRequestResolver, validatorResolver: RecaptchaValidatorResolver, logger: Logger, options: GoogleRecaptchaModuleOptions);
12
13
  canActivate(context: ExecutionContext): Promise<true | never>;
14
+ private resolveLogContext;
13
15
  }
@@ -14,16 +14,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.GoogleRecaptchaGuard = void 0;
16
16
  const common_1 = require("@nestjs/common");
17
- const google_recaptcha_validator_1 = require("../services/google-recaptcha.validator");
18
17
  const provider_declarations_1 = require("../provider.declarations");
19
18
  const google_recaptcha_exception_1 = require("../exceptions/google-recaptcha.exception");
20
19
  const core_1 = require("@nestjs/core");
21
20
  const recaptcha_request_resolver_1 = require("../services/recaptcha-request.resolver");
21
+ const recaptcha_validator_resolver_1 = require("../services/recaptcha-validator.resolver");
22
+ const google_recaptcha_context_1 = require("../enums/google-recaptcha-context");
23
+ const google_recaptcha_enterprise_validator_1 = require("../services/validators/google-recaptcha-enterprise.validator");
22
24
  let GoogleRecaptchaGuard = class GoogleRecaptchaGuard {
23
- constructor(validator, reflector, requestResolver, options) {
24
- this.validator = validator;
25
+ constructor(reflector, requestResolver, validatorResolver, logger, options) {
25
26
  this.reflector = reflector;
26
27
  this.requestResolver = requestResolver;
28
+ this.validatorResolver = validatorResolver;
29
+ this.logger = logger;
27
30
  this.options = options;
28
31
  }
29
32
  async canActivate(context) {
@@ -40,19 +43,31 @@ let GoogleRecaptchaGuard = class GoogleRecaptchaGuard {
40
43
  : await this.options.response(request);
41
44
  const score = (options === null || options === void 0 ? void 0 : options.score) || this.options.score;
42
45
  const action = options === null || options === void 0 ? void 0 : options.action;
43
- request.recaptchaValidationResult = await this.validator.validate({ response, score, action });
46
+ const validator = this.validatorResolver.resolve();
47
+ request.recaptchaValidationResult = await validator.validate({ response, score, action });
48
+ if (this.options.debug) {
49
+ const loggerCtx = this.resolveLogContext(validator);
50
+ this.logger.debug(request.recaptchaValidationResult, `${loggerCtx}.result`);
51
+ }
44
52
  if (request.recaptchaValidationResult.success) {
45
53
  return true;
46
54
  }
47
55
  throw new google_recaptcha_exception_1.GoogleRecaptchaException(request.recaptchaValidationResult.errors);
48
56
  }
57
+ resolveLogContext(validator) {
58
+ return validator instanceof google_recaptcha_enterprise_validator_1.GoogleRecaptchaEnterpriseValidator
59
+ ? google_recaptcha_context_1.GoogleRecaptchaContext.GoogleRecaptchaEnterprise
60
+ : google_recaptcha_context_1.GoogleRecaptchaContext.GoogleRecaptcha;
61
+ }
49
62
  };
50
63
  GoogleRecaptchaGuard = __decorate([
51
64
  (0, common_1.Injectable)(),
52
- __param(3, (0, common_1.Inject)(provider_declarations_1.RECAPTCHA_OPTIONS)),
53
- __metadata("design:paramtypes", [google_recaptcha_validator_1.GoogleRecaptchaValidator,
54
- core_1.Reflector,
55
- recaptcha_request_resolver_1.RecaptchaRequestResolver, Object])
65
+ __param(3, (0, common_1.Inject)(provider_declarations_1.RECAPTCHA_LOGGER)),
66
+ __param(4, (0, common_1.Inject)(provider_declarations_1.RECAPTCHA_OPTIONS)),
67
+ __metadata("design:paramtypes", [core_1.Reflector,
68
+ recaptcha_request_resolver_1.RecaptchaRequestResolver,
69
+ recaptcha_validator_resolver_1.RecaptchaValidatorResolver,
70
+ common_1.Logger, Object])
56
71
  ], GoogleRecaptchaGuard);
57
72
  exports.GoogleRecaptchaGuard = GoogleRecaptchaGuard;
58
73
  //# sourceMappingURL=google-recaptcha.guard.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"google-recaptcha.guard.js","sourceRoot":"","sources":["../../src/guards/google-recaptcha.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmF;AACnF,uFAAkF;AAElF,oEAA2F;AAC3F,yFAAoF;AACpF,uCAAyC;AACzC,uFAAkF;AAIlF,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAC7B,YAA6B,SAAmC,EACnC,SAAoB,EACpB,eAAyC,EACd,OAAoC;QAH/D,cAAS,GAAT,SAAS,CAA0B;QACnC,cAAS,GAAT,SAAS,CAAW;QACpB,oBAAe,GAAf,eAAe,CAA0B;QACd,YAAO,GAAP,OAAO,CAA6B;IAC5F,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAyB;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU;YAClD,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;YACpC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAE5B,IAAI,IAAI,EAAE;YACN,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAmC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,oDAA4B,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAEvH,MAAM,QAAQ,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;YAC9B,CAAC,CAAC,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;YAClC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAE3C,MAAM,KAAK,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QACnD,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;QAE/B,OAAO,CAAC,yBAAyB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC,CAAC;QAE7F,IAAI,OAAO,CAAC,yBAAyB,CAAC,OAAO,EAAE;YAC3C,OAAO,IAAI,CAAC;SACf;QAED,MAAM,IAAI,qDAAwB,CAAC,OAAO,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;CACJ,CAAA;AAnCY,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IAKI,WAAA,IAAA,eAAM,EAAC,yCAAiB,CAAC,CAAA;qCAHE,qDAAwB;QACxB,gBAAS;QACH,qDAAwB;GAH7D,oBAAoB,CAmChC;AAnCY,oDAAoB"}
1
+ {"version":3,"file":"google-recaptcha.guard.js","sourceRoot":"","sources":["../../src/guards/google-recaptcha.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA2F;AAC3F,oEAA6G;AAC7G,yFAAoF;AACpF,uCAAyC;AACzC,uFAAkF;AAGlF,2FAAsF;AACtF,gFAA2E;AAE3E,wHAAkH;AAGlH,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAC7B,YAA6B,SAAoB,EACpB,eAAyC,EACzC,iBAA6C,EACnB,MAAc,EACb,OAAqC;QAJhE,cAAS,GAAT,SAAS,CAAW;QACpB,oBAAe,GAAf,eAAe,CAA0B;QACzC,sBAAiB,GAAjB,iBAAiB,CAA4B;QACnB,WAAM,GAAN,MAAM,CAAQ;QACb,YAAO,GAAP,OAAO,CAA8B;IAC7F,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAyB;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU;YAClD,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;YACpC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAE5B,IAAI,IAAI,EAAE;YACN,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAmC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,oDAA4B,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAEvH,MAAM,QAAQ,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;YAC9B,CAAC,CAAC,MAAM,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;YAClC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAE3C,MAAM,KAAK,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QACnD,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;QAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAEnD,OAAO,CAAC,yBAAyB,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC,CAAC;QAExF,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;YACpB,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,yBAAyB,EAAE,GAAG,SAAS,SAAS,CAAC,CAAC;SAC/E;QAED,IAAI,OAAO,CAAC,yBAAyB,CAAC,OAAO,EAAE;YAC3C,OAAO,IAAI,CAAC;SACf;QAED,MAAM,IAAI,qDAAwB,CAAC,OAAO,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAEO,iBAAiB,CAAC,SAA2C;QACjE,OAAO,SAAS,YAAY,0EAAkC;YAC1D,CAAC,CAAC,iDAAsB,CAAC,yBAAyB;YAClD,CAAC,CAAC,iDAAsB,CAAC,eAAe,CAAC;IACjD,CAAC;CACJ,CAAA;AAjDY,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IAKI,WAAA,IAAA,eAAM,EAAC,wCAAgB,CAAC,CAAA;IACxB,WAAA,IAAA,eAAM,EAAC,yCAAiB,CAAC,CAAA;qCAJE,gBAAS;QACH,qDAAwB;QACtB,yDAA0B;QACX,eAAM;GAJ5D,oBAAoB,CAiDhC;AAjDY,oDAAoB"}
@@ -0,0 +1 @@
1
+ export declare function xor(a: boolean, b: boolean): boolean;
package/helpers/xor.js ADDED
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.xor = void 0;
4
+ function xor(a, b) {
5
+ return !!a !== !!b;
6
+ }
7
+ exports.xor = xor;
8
+ //# sourceMappingURL=xor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xor.js","sourceRoot":"","sources":["../../src/helpers/xor.ts"],"names":[],"mappings":";;;AAAA,SAAgB,GAAG,CAAC,CAAU,EAAE,CAAU;IACtC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAFD,kBAEC"}
package/index.d.ts CHANGED
@@ -5,7 +5,10 @@ export { GoogleRecaptchaGuard } from './guards/google-recaptcha.guard';
5
5
  export { GoogleRecaptchaModule } from './google-recaptcha.module';
6
6
  export { GoogleRecaptchaModuleOptions } from './interfaces/google-recaptcha-module-options';
7
7
  export { ErrorCode } from './enums/error-code';
8
- export { ApplicationType } from './enums/application-type';
9
8
  export { GoogleRecaptchaNetwork } from './enums/google-recaptcha-network';
10
9
  export { GoogleRecaptchaException } from './exceptions/google-recaptcha.exception';
11
10
  export { GoogleRecaptchaNetworkException } from './exceptions/google-recaptcha-network.exception';
11
+ export { GoogleRecaptchaValidator } from './services/validators/google-recaptcha.validator';
12
+ export { GoogleRecaptchaEnterpriseValidator } from './services/validators/google-recaptcha-enterprise.validator';
13
+ export { RecaptchaVerificationResult } from './models/recaptcha-verification-result';
14
+ export { ClassificationReason } from './enums/classification-reason';
package/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.GoogleRecaptchaNetworkException = exports.GoogleRecaptchaException = exports.GoogleRecaptchaNetwork = exports.ApplicationType = exports.ErrorCode = exports.GoogleRecaptchaModule = exports.GoogleRecaptchaGuard = exports.RecaptchaResult = exports.SetRecaptchaOptions = exports.Recaptcha = void 0;
3
+ exports.ClassificationReason = exports.RecaptchaVerificationResult = exports.GoogleRecaptchaEnterpriseValidator = exports.GoogleRecaptchaValidator = exports.GoogleRecaptchaNetworkException = exports.GoogleRecaptchaException = exports.GoogleRecaptchaNetwork = exports.ErrorCode = exports.GoogleRecaptchaModule = exports.GoogleRecaptchaGuard = exports.RecaptchaResult = exports.SetRecaptchaOptions = exports.Recaptcha = void 0;
4
4
  var recaptcha_1 = require("./decorators/recaptcha");
5
5
  Object.defineProperty(exports, "Recaptcha", { enumerable: true, get: function () { return recaptcha_1.Recaptcha; } });
6
6
  var set_recaptcha_options_1 = require("./decorators/set-recaptcha-options");
@@ -13,12 +13,18 @@ var google_recaptcha_module_1 = require("./google-recaptcha.module");
13
13
  Object.defineProperty(exports, "GoogleRecaptchaModule", { enumerable: true, get: function () { return google_recaptcha_module_1.GoogleRecaptchaModule; } });
14
14
  var error_code_1 = require("./enums/error-code");
15
15
  Object.defineProperty(exports, "ErrorCode", { enumerable: true, get: function () { return error_code_1.ErrorCode; } });
16
- var application_type_1 = require("./enums/application-type");
17
- Object.defineProperty(exports, "ApplicationType", { enumerable: true, get: function () { return application_type_1.ApplicationType; } });
18
16
  var google_recaptcha_network_1 = require("./enums/google-recaptcha-network");
19
17
  Object.defineProperty(exports, "GoogleRecaptchaNetwork", { enumerable: true, get: function () { return google_recaptcha_network_1.GoogleRecaptchaNetwork; } });
20
18
  var google_recaptcha_exception_1 = require("./exceptions/google-recaptcha.exception");
21
19
  Object.defineProperty(exports, "GoogleRecaptchaException", { enumerable: true, get: function () { return google_recaptcha_exception_1.GoogleRecaptchaException; } });
22
20
  var google_recaptcha_network_exception_1 = require("./exceptions/google-recaptcha-network.exception");
23
21
  Object.defineProperty(exports, "GoogleRecaptchaNetworkException", { enumerable: true, get: function () { return google_recaptcha_network_exception_1.GoogleRecaptchaNetworkException; } });
22
+ var google_recaptcha_validator_1 = require("./services/validators/google-recaptcha.validator");
23
+ Object.defineProperty(exports, "GoogleRecaptchaValidator", { enumerable: true, get: function () { return google_recaptcha_validator_1.GoogleRecaptchaValidator; } });
24
+ var google_recaptcha_enterprise_validator_1 = require("./services/validators/google-recaptcha-enterprise.validator");
25
+ Object.defineProperty(exports, "GoogleRecaptchaEnterpriseValidator", { enumerable: true, get: function () { return google_recaptcha_enterprise_validator_1.GoogleRecaptchaEnterpriseValidator; } });
26
+ var recaptcha_verification_result_1 = require("./models/recaptcha-verification-result");
27
+ Object.defineProperty(exports, "RecaptchaVerificationResult", { enumerable: true, get: function () { return recaptcha_verification_result_1.RecaptchaVerificationResult; } });
28
+ var classification_reason_1 = require("./enums/classification-reason");
29
+ Object.defineProperty(exports, "ClassificationReason", { enumerable: true, get: function () { return classification_reason_1.ClassificationReason; } });
24
30
  //# sourceMappingURL=index.js.map
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAmD;AAA1C,sGAAA,SAAS,OAAA;AAClB,4EAAyE;AAAhE,4HAAA,mBAAmB,OAAA;AAC5B,kEAAgE;AAAvD,mHAAA,eAAe,OAAA;AACxB,0EAAuE;AAA9D,8HAAA,oBAAoB,OAAA;AAC7B,qEAAkE;AAAzD,gIAAA,qBAAqB,OAAA;AAE9B,iDAA+C;AAAtC,uGAAA,SAAS,OAAA;AAClB,6DAA2D;AAAlD,mHAAA,eAAe,OAAA;AACxB,6EAAyE;AAAhE,kIAAA,sBAAsB,OAAA;AAC/B,sFAAmF;AAA1E,sIAAA,wBAAwB,OAAA;AACjC,sGAAkG;AAAzF,qJAAA,+BAA+B,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAmD;AAA1C,sGAAA,SAAS,OAAA;AAClB,4EAAyE;AAAhE,4HAAA,mBAAmB,OAAA;AAC5B,kEAAgE;AAAvD,mHAAA,eAAe,OAAA;AACxB,0EAAuE;AAA9D,8HAAA,oBAAoB,OAAA;AAC7B,qEAAkE;AAAzD,gIAAA,qBAAqB,OAAA;AAE9B,iDAA+C;AAAtC,uGAAA,SAAS,OAAA;AAClB,6EAAyE;AAAhE,kIAAA,sBAAsB,OAAA;AAC/B,sFAAmF;AAA1E,sIAAA,wBAAwB,OAAA;AACjC,sGAAkG;AAAzF,qJAAA,+BAA+B,OAAA;AACxC,+FAA2F;AAAlF,sIAAA,wBAAwB,OAAA;AACjC,qHAAgH;AAAvG,2JAAA,kCAAkC,OAAA;AAC3C,wFAAqF;AAA5E,4IAAA,2BAA2B,OAAA;AACpC,uEAAqE;AAA5D,6HAAA,oBAAoB,OAAA"}
@@ -0,0 +1,5 @@
1
+ export interface GoogleRecaptchaEnterpriseOptions {
2
+ projectId: string;
3
+ siteKey: string;
4
+ apiKey: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=google-recaptcha-enterprise-options.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"google-recaptcha-enterprise-options.js","sourceRoot":"","sources":["../../src/interfaces/google-recaptcha-enterprise-options.ts"],"names":[],"mappings":""}
@@ -1,7 +1,10 @@
1
1
  import { GoogleRecaptchaGuardOptions } from './google-recaptcha-guard-options';
2
2
  import { GoogleRecaptchaValidatorOptions } from './google-recaptcha-validator-options';
3
3
  import { ModuleMetadata, Type } from '@nestjs/common/interfaces';
4
+ import { Logger } from '@nestjs/common';
4
5
  export interface GoogleRecaptchaModuleOptions extends GoogleRecaptchaValidatorOptions, GoogleRecaptchaGuardOptions {
6
+ debug?: boolean;
7
+ logger?: Logger;
5
8
  }
6
9
  export interface GoogleRecaptchaOptionsFactory {
7
10
  createGoogleRecaptchaOptions(): Promise<GoogleRecaptchaModuleOptions> | GoogleRecaptchaModuleOptions;
@@ -1,8 +1,9 @@
1
1
  import { GoogleRecaptchaNetwork } from '../enums/google-recaptcha-network';
2
2
  import { ScoreValidator } from '../types';
3
3
  import { AxiosRequestConfig } from 'axios';
4
+ import { GoogleRecaptchaEnterpriseOptions } from './google-recaptcha-enterprise-options';
4
5
  export interface GoogleRecaptchaValidatorOptions {
5
- secretKey: string;
6
+ secretKey?: string;
6
7
  actions?: string[];
7
8
  score?: ScoreValidator;
8
9
  /**
@@ -13,4 +14,5 @@ export interface GoogleRecaptchaValidatorOptions {
13
14
  */
14
15
  network?: GoogleRecaptchaNetwork | string;
15
16
  axiosConfig?: AxiosRequestConfig;
17
+ enterprise?: GoogleRecaptchaEnterpriseOptions;
16
18
  }
@@ -0,0 +1,29 @@
1
+ import { GoogleRecaptchaEnterpriseReason } from '../enums/google-recaptcha-enterprise-reason';
2
+ import { ClassificationReason } from '../enums/classification-reason';
3
+ export interface VerifyResponseEnterprise {
4
+ tokenProperties: VerifyResponseEnterpriseTokenProperties;
5
+ riskAnalysis: VerifyResponseEnterpriseRiskAnalysis;
6
+ event: VerifyTokenEnterpriseResponseEvent;
7
+ name: string;
8
+ }
9
+ export interface VerifyTokenEnterpriseEvent {
10
+ token: string;
11
+ siteKey: string;
12
+ expectedAction: string;
13
+ }
14
+ export interface VerifyTokenEnterpriseResponseEvent extends VerifyTokenEnterpriseEvent {
15
+ userAgent: string;
16
+ userIpAddress: string;
17
+ hashedAccountId: string;
18
+ }
19
+ export interface VerifyResponseEnterpriseTokenProperties {
20
+ valid: boolean;
21
+ invalidReason?: GoogleRecaptchaEnterpriseReason;
22
+ hostname: string;
23
+ action: string;
24
+ createTime: string;
25
+ }
26
+ export interface VerifyResponseEnterpriseRiskAnalysis {
27
+ score: number;
28
+ reasons: ClassificationReason[];
29
+ }
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=google-recaptcha-validation-result.js.map
3
+ //# sourceMappingURL=verify-response-enterprise.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"verify-response-enterprise.js","sourceRoot":"","sources":["../../src/interfaces/verify-response-enterprise.ts"],"names":[],"mappings":""}
@@ -1,7 +1,22 @@
1
- import { GoogleRecaptchaValidationResult } from '../interfaces/google-recaptcha-validation-result';
2
- export declare class RecaptchaVerificationResult {
3
- readonly action: string;
4
- readonly score: number;
1
+ import { ErrorCode } from '../enums/error-code';
2
+ import { VerifyResponseEnterprise } from '../interfaces/verify-response-enterprise';
3
+ export interface RecaptchaVerificationResultOptions<Res = any> {
4
+ success: boolean;
5
+ nativeResponse: Res;
6
+ hostname: string;
7
+ action?: string;
8
+ score?: number;
9
+ errors: ErrorCode[];
10
+ }
11
+ export declare class RecaptchaVerificationResult<Res = any> {
12
+ private readonly options;
13
+ readonly success: boolean;
5
14
  readonly hostname: string;
6
- constructor(result: GoogleRecaptchaValidationResult);
15
+ readonly action: string | undefined;
16
+ readonly score: number | undefined;
17
+ readonly nativeResponse: Res;
18
+ readonly errors: ErrorCode[];
19
+ constructor(options: RecaptchaVerificationResultOptions);
20
+ getResponse(): Res;
21
+ getEnterpriseRiskAnalytics(): VerifyResponseEnterprise | null;
7
22
  }