Merge pull request #129 from chvarkov/develop

Develop

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.5.0
+- Added `global?: boolean` module option
+
 ## v3.4.1
 - Fixed import LiteralObject for NestJS 10
 

README.md

@@ -1,4 +1,4 @@
-# @nestlab/google-recaptcha
+# Google recaptcha module
 
 This package provides protection for endpoints using [reCAPTCHA](https://www.google.com/recaptcha/about/) for [NestJS](https://docs.nestjs.com/) REST and GraphQL applications. By integrating with reCAPTCHA, this package helps to prevent automated abuse such as spam and bots, improving the security and reliability of your application.
 
@@ -62,6 +62,7 @@ The list of changes made in the project can be found in the [CHANGELOG.md](./CHA
 | `score`           | Optional.<br> Type: `number` \| `(score: number) => boolean`<br> Score validator for reCAPTCHA v3 or enterprise. <br> `number` - minimum available score. <br> `(score: number) => boolean` - function with custom validation rules. |
 | `actions`         | Optional.<br> Type: `string[]`<br> Available action list for reCAPTCHA v3 or enterprise. <br> You can make this check stricter by passing the action property parameter to `@Recaptcha(...)` decorator. |
 | `axiosConfig`     | Optional.<br> Type: `AxiosRequestConfig`<br> Allows to setup proxy, response timeout, https agent etc... |
+| `global`     		| Optional.<br> Type: `boolean` <br> Default: `false` Defines a module in the [global scope](https://docs.nestjs.com/modules#global-modules). |
 
 **GoogleRecaptchaEnterpriseOptions**
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nestlab/google-recaptcha",
-	"version": "3.4.1",
+	"version": "3.5.0",
 	"description": "Google recaptcha module for NestJS.",
 	"keywords": [
 		"nestjs",

src/google-recaptcha.module.ts

@@ -57,7 +57,7 @@ export class GoogleRecaptchaModule {
 		];
 
 		return {
-			global: true,
+			global: options.global != null ? options.global : true,
 			module: GoogleRecaptchaModule,
 			providers: providers.concat(internalProviders),
 			exports: providers,
@@ -99,7 +99,7 @@ export class GoogleRecaptchaModule {
 		];
 
 		return {
-			global: true,
+			global: options.global != null ? options.global : true,
 			module: GoogleRecaptchaModule,
 			imports: options.imports,
 			providers: providers.concat(internalProviders),

src/interfaces/google-recaptcha-module-options.ts

@@ -8,6 +8,7 @@ import { OptionalFactoryDependency } from '@nestjs/common/interfaces/modules/opt
 export interface GoogleRecaptchaModuleOptions extends GoogleRecaptchaValidatorOptions, GoogleRecaptchaGuardOptions {
 	debug?: boolean;
 	logger?: Logger;
+	global?: boolean;
 }
 
 export interface GoogleRecaptchaOptionsFactory {
@@ -19,5 +20,6 @@ export interface GoogleRecaptchaModuleAsyncOptions extends Pick<ModuleMetadata,
 	useClass?: Type<GoogleRecaptchaOptionsFactory>;
 	useExisting?: Type<GoogleRecaptchaOptionsFactory>;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	useFactory?: (...args: any[]) => Promise<GoogleRecaptchaModuleOptions> | GoogleRecaptchaModuleOptions;
+	useFactory?: (...args: any[]) => Promise<Omit<GoogleRecaptchaModuleOptions, 'global'>> | Omit<GoogleRecaptchaModuleOptions, 'global'>;
+	global?: boolean;
 }

test/google-recaptcha-async-module.spec.ts

@@ -47,6 +47,7 @@ describe('Google recaptcha async module', () => {
 						axiosConfig: { ...http.axiosRef.defaults, headers: {} },
 					}),
 					inject: [TestConfigService, HttpService],
+					global: false,
 				}),
 			],
 		}).compile();

test/google-recaptcha-module.spec.ts

@@ -23,6 +23,7 @@ describe('Google recaptcha module', () => {
 			response: (req) => req.headers.authorization,
 			skipIf: () => process.env.NODE_ENV !== 'production',
 			network: customNetwork,
+			global: false,
 		});
 	});