Merge pull request #14 from chvarkov/develop

Pass request object to skipIf callback for per-reuqest skip checking
chvarkov · Oct 30, 2020 · fd91053 · fd91053
2 parents f7d8df8 + 4ab6f86
commit fd91053
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ $ npm i @nestlab/google-recaptcha
         GoogleRecaptchaModule.forRoot({
             secretKey: process.env.GOOGLE_RECAPTCHA_SECRET_KEY,
             response: req => req.headers.recaptcha,
-            skipIf: () => process.env.NODE_ENV !== 'production',
+            skipIf: async req => process.env.NODE_ENV !== 'production',
             useRecaptchaNet: false,
             agent: null
         })
@@ -36,13 +36,13 @@ export class AppModule {
 
 **Configuration options**
 
-| Property          |   | Type                       | Description |
-|-------------------|---|----------------------------|-------------|
-| `secretKey`       | ✔ | string                     | Google recaptcha secret key |
-| `response`        | ✔ | (request) => string        | Function that returns response (recaptcha token) by request |
-| `skipIf`          | ✖ | () => boolean              | Function that returns true if you need skip check for development or testing |
-| `useRecaptchaNet` | ✖ | boolean                    | If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
-| `agent`           | ✖ | https.Agent                | If you need to use an agent |
+| Property          |   | Type                                        | Description |
+|-------------------|---|---------------------------------------------|-------------|
+| `secretKey`       | ✔ | string                                      | Google recaptcha secret key |
+| `response`        | ✔ | (request) => string                         | Function that returns response (recaptcha token) by request |
+| `skipIf`          | ✖ | (request) => boolean \| Promise\<boolean\>  | 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 |
+| `useRecaptchaNet` | ✖ | boolean                                     | If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
+| `agent`           | ✖ | https.Agent                                 | If you need to use an agent |
 
 
 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.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestlab/google-recaptcha",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Google recaptcha module for NestJS.",
   "keywords": [
     "nest",

diff --git a/src/guards/google-recaptcha.guard.ts b/src/guards/google-recaptcha.guard.ts
@@ -15,7 +15,7 @@ export class GoogleRecaptchaGuard implements CanActivate {
     async canActivate(context: ExecutionContext): Promise<true | never> {
         const request = context.switchToHttp().getRequest();
 
-        const skip = this.options.skipIf ? await this.options.skipIf() : false;
+        const skip = this.options.skipIf ? await this.options.skipIf(request) : false;
 
         if (skip) {
             return true;

diff --git a/src/interfaces/google-recaptcha-guard-options.ts b/src/interfaces/google-recaptcha-guard-options.ts
@@ -2,5 +2,5 @@ import { RecaptchaResponseProvider } from '../types';
 
 export interface GoogleRecaptchaGuardOptions {
     response: RecaptchaResponseProvider;
-    skipIf?: () => boolean | Promise<boolean>;
+    skipIf?: (request: any) => boolean | Promise<boolean>;
 }