next-recaptcha-v3 2.0.0-beta.1 → 2.0.0-beta.2

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2023 Roman Zhuravlov
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Roman Zhuravlov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/useReCaptcha.d.ts

@@ -1,22 +1,30 @@
 import type { ReCaptchaContextProps } from "./ReCaptchaProvider.js";
 import type { IReCaptcha } from "./recaptcha.types.js";
+export type ExecuteRecaptchaResult = readonly [token: string, error: null] | readonly [token: null, error: Error];
 export interface useReCaptchaProps extends ReCaptchaContextProps {
     /** reCAPTCHA instance */
     grecaptcha: IReCaptcha | null;
     /**
      * Executes the reCAPTCHA verification process for a given action.
      * Actions may only contain alphanumeric characters and slashes, and must not be user-specific.
+     * @throws Will throw an error if the reCAPTCHA site key is not defined or if reCAPTCHA has not been loaded.
      */
     executeRecaptcha: (action: string) => Promise<string>;
+    /**
+     * Safely executes the reCAPTCHA verification process for a given action.
+     * Returns a tuple containing the token or an error.
+     * @returns A tuple where the first element is the token (or null if there was an error) and the second element is an Error object (or null if successful).
+     */
+    executeRecaptchaSafe: (action: string) => Promise<ExecuteRecaptchaResult>;
 }
 /**
  * Custom hook to use Google reCAPTCHA v3.
  *
  * @param [reCaptchaKey] - Optional reCAPTCHA site key. If not provided, it will use the key from the context.
- * @returns An object containing the reCAPTCHA context, grecaptcha instance, reCaptchaKey, and executeRecaptcha function.
+ * @returns An object containing the reCAPTCHA context, grecaptcha instance, reCaptchaKey, executeRecaptcha, and executeRecaptchaSafe functions.
  *
  * @example
- * const { executeRecaptcha } = useReCaptcha();
+ * const { executeRecaptcha, executeRecaptchaSafe } = useReCaptcha();
  *
  * const handleSubmit = async () => {
  *   try {

package/lib/useReCaptcha.js

@@ -7,10 +7,10 @@ import { useGrecaptcha, getGrecaptcha } from './utils.js';
  * Custom hook to use Google reCAPTCHA v3.
  *
  * @param [reCaptchaKey] - Optional reCAPTCHA site key. If not provided, it will use the key from the context.
- * @returns An object containing the reCAPTCHA context, grecaptcha instance, reCaptchaKey, and executeRecaptcha function.
+ * @returns An object containing the reCAPTCHA context, grecaptcha instance, reCaptchaKey, executeRecaptcha, and executeRecaptchaSafe functions.
  *
  * @example
- * const { executeRecaptcha } = useReCaptcha();
+ * const { executeRecaptcha, executeRecaptchaSafe } = useReCaptcha();
  *
  * const handleSubmit = async () => {
  *   try {
@@ -42,11 +42,34 @@ const useReCaptcha = (reCaptchaKey) => {
         const result = await grecaptcha.execute(siteKey, { action });
         return result;
     }, [useEnterprise, siteKey]);
+    const executeRecaptchaSafe = useCallback(async (action) => {
+        try {
+            if (!siteKey) {
+                return [null, new Error("ReCaptcha sitekey is not defined")];
+            }
+            const grecaptcha = getGrecaptcha(useEnterprise);
+            if (typeof grecaptcha?.execute !== "function") {
+                return [null, new Error("Recaptcha has not been loaded")];
+            }
+            if (typeof grecaptcha.ready === "function") {
+                await new Promise((resolve) => {
+                    grecaptcha.ready(resolve);
+                });
+            }
+            const result = await grecaptcha.execute(siteKey, { action });
+            return [result, null];
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            return [null, error];
+        }
+    }, [useEnterprise, siteKey]);
     return {
         ...context,
         grecaptcha,
         reCaptchaKey: siteKey,
         executeRecaptcha,
+        executeRecaptchaSafe,
     };
 };
 

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "next-recaptcha-v3",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "🤖 Next.js hook to add Google ReCaptcha to your application",
   "license": "MIT",
   "author": "Roman Zhuravlov",
-  "repository": "https://github.com/snelsi/next-recaptcha-v3",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/snelsi/next-recaptcha-v3.git"
+  },
   "homepage": "https://github.com/snelsi/next-recaptcha-v3",
   "keywords": [
     "recaptcha",
@@ -31,38 +34,37 @@
     "prepublishOnly": "npm run rollup"
   },
   "peerDependencies": {
-    "next": "^13 || ^14 || ^15",
+    "next": "^13 || ^14 || ^15 || ^16",
     "react": "^18 || ^19"
   },
   "engines": {
     "node": ">=18"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.20.0",
-    "@next/eslint-plugin-next": "^15.1.7",
-    "@rollup/plugin-node-resolve": "^16.0.0",
-    "@rollup/plugin-typescript": "^12.1.2",
-    "@types/node": "^22.13.4",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
-    "eslint": "^9.20.1",
-    "eslint-config-next": "^15.1.7",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-hooks": "^5.1.0",
+    "@eslint/js": "^9.39.2",
+    "@next/eslint-plugin-next": "^16.1.3",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^25.0.9",
+    "@types/react": "^19.2.8",
+    "@types/react-dom": "^19.2.3",
+    "eslint": "^9.39.2",
+    "eslint-config-next": "^16.1.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "next": "^15.1.7",
-    "prettier": "3.5.1",
-    "pretty-quick": "^4.0.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "rollup": "^4.34.8",
-    "rollup-plugin-node-externals": "^8.0.0",
+    "lint-staged": "^16.2.7",
+    "next": "^16.1.3",
+    "prettier": "3.8.0",
+    "pretty-quick": "^4.2.2",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "rollup": "^4.55.1",
+    "rollup-plugin-node-externals": "^8.1.2",
     "rollup-plugin-preserve-directives": "^0.4.0",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.24.1"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.0"
   },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx}": [