@hcaptcha/react-hcaptcha 1.12.1 → 1.13.1

package/README.md

@@ -138,6 +138,7 @@ return <HCaptcha ref={captchaRef} onLoad={onLoad} sitekey={sitekey} {...props} /
 |`imghost`|String|No|`-`|See enterprise docs.|
 |`reportapi`|String|No|`-`|See enterprise docs.|
 |`sentry`|Boolean|No|`true`|See enterprise docs.|
+|`userJourneys`|Boolean|No|`false`|See enterprise docs.|
 |`secureApi`|Boolean|No|`-`|See enterprise docs.|
 |`scriptSource`|String|No|`-`|See enterprise docs.|
 | `cleanup`         | Boolean     | No       | `true`          | Remove script tag after setup.|
@@ -153,6 +154,7 @@ return <HCaptcha ref={captchaRef} onLoad={onLoad} sitekey={sitekey} {...props} /
 |`onVerify`|`token, eKey`|When challenge is completed. The response `token` and an `eKey` (session id) are passed along.|
 |`onExpire`|-|When the current token expires.|
 |`onLoad`|-|When the hCaptcha API loads.|
+|`onReady`|-|When the hCaptcha is ready to be used.|
 |`onOpen`|-|When the user display of a challenge starts.|
 |`onClose`|-|When the user dismisses a challenge.|
 |`onChalExpired`|-|When the user display of a challenge times out with no answer.|
@@ -204,6 +206,12 @@ To resolve this, update the version of the Sentry client you are including on yo
 You can avoid this issue by setting the `sentry` prop to `false`.
 
 
+### Handling SDK Errors
+
+If the JS SDK fails to load, the `onError` callback will be invoked with `script-error` argument.
+
+This will be rare, but could happen in the event you are testing offline, or have enabled a firewall that does not allow outbound connections to the asset hosts hCaptcha uses.
+
 ---
 ### Contributing
 

package/dist/esm/index.js

@@ -122,7 +122,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       scriptSource = _this$props.scriptSource,
       secureApi = _this$props.secureApi,
       _this$props$cleanup = _this$props.cleanup,
-      cleanup = _this$props$cleanup === void 0 ? true : _this$props$cleanup;
+      cleanup = _this$props$cleanup === void 0 ? true : _this$props$cleanup,
+      userJourneys = _this$props.userJourneys;
     var mountParams = {
       render: 'explicit',
       apihost: apihost,
@@ -139,7 +140,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       scriptLocation: scriptLocation,
       scriptSource: scriptSource,
       secureApi: secureApi,
-      cleanup: cleanup
+      cleanup: cleanup,
+      uj: userJourneys !== undefined ? userJourneys : false
     };
     hCaptchaLoader(mountParams).then(this.handleOnLoad, this.handleError)["catch"](this.handleError);
     this.apiScriptRequested = true;

package/dist/index.js

@@ -149,7 +149,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
         scriptSource = _this$props.scriptSource,
         secureApi = _this$props.secureApi,
         _this$props$cleanup = _this$props.cleanup,
-        cleanup = _this$props$cleanup === void 0 ? true : _this$props$cleanup;
+        cleanup = _this$props$cleanup === void 0 ? true : _this$props$cleanup,
+        userJourneys = _this$props.userJourneys;
       var mountParams = {
         render: 'explicit',
         apihost: apihost,
@@ -166,7 +167,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
         scriptLocation: scriptLocation,
         scriptSource: scriptSource,
         secureApi: secureApi,
-        cleanup: cleanup
+        cleanup: cleanup,
+        uj: userJourneys !== undefined ? userJourneys : false
       };
       (0, _loader.hCaptchaLoader)(mountParams).then(this.handleOnLoad, this.handleError)["catch"](this.handleError);
       this.apiScriptRequested = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hcaptcha/react-hcaptcha",
-  "version": "1.12.1",
+  "version": "1.13.1",
   "types": "types/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -60,6 +60,6 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.17.9",
-    "@hcaptcha/loader": "^2.0.1"
+    "@hcaptcha/loader": "^2.2.0"
   }
 }

package/src/index.js

@@ -130,7 +130,9 @@ class HCaptcha extends React.Component {
         scriptSource,
         secureApi,
         cleanup = true,
+        userJourneys,
       } = this.props;
+      
       const mountParams = {
         render: 'explicit',
         apihost,
@@ -147,9 +149,10 @@ class HCaptcha extends React.Component {
         scriptLocation,
         scriptSource,
         secureApi,
-        cleanup
+        cleanup,
+        uj: userJourneys !== undefined ? userJourneys : false,
       };
-
+      
       hCaptchaLoader(mountParams)
           .then(this.handleOnLoad, this.handleError)
           .catch(this.handleError);
@@ -166,7 +169,7 @@ class HCaptcha extends React.Component {
       // • API is not ready
       // • Component has already been mounted
       if (!isApiReady || captchaId) return;
-
+      
       const renderParams = Object.assign({
         "open-callback"       : this.handleOpen,
         "close-callback"      : this.handleClose,

package/types/index.d.ts

@@ -31,6 +31,7 @@ interface HCaptchaProps {
   loadAsync?: boolean;
   scriptLocation?: HTMLElement | null;
   sentry?: boolean;
+  userJourneys?: boolean;
   cleanup?: boolean;
   custom?: boolean;
   secureApi?: boolean;