@hcaptcha/react-hcaptcha 1.12.0 → 1.13.0

package/README.md

@@ -137,7 +137,8 @@ return <HCaptcha ref={captchaRef} onLoad={onLoad} sitekey={sitekey} {...props} /
 |`host`|String|No|`-`|See enterprise docs.|
 |`imghost`|String|No|`-`|See enterprise docs.|
 |`reportapi`|String|No|`-`|See enterprise docs.|
-|`sentry`|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.|
@@ -204,6 +205,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

@@ -1,5 +1,7 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/objectWithoutPropertiesLoose";
 import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
 import _inheritsLoose from "@babel/runtime/helpers/inheritsLoose";
+var _excluded = ["userJourneys"];
 import * as React from 'react';
 import { hCaptchaLoader } from '@hcaptcha/loader';
 import { getFrame, getMountElement } from './utils.js';
@@ -122,7 +124,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 +142,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       scriptLocation: scriptLocation,
       scriptSource: scriptSource,
       secureApi: secureApi,
-      cleanup: cleanup
+      cleanup: cleanup,
+      userJourneys: userJourneys
     };
     hCaptchaLoader(mountParams).then(this.handleOnLoad, this.handleError)["catch"](this.handleError);
     this.apiScriptRequested = true;
@@ -154,6 +158,13 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     // • API is not ready
     // • Component has already been mounted
     if (!isApiReady || captchaId) return;
+
+    // It is needed to pass only the props that hCaptcha supports
+    // React are able to receive userJourneys as prop but hCaptcha not
+    // hcaptcha expects to have only "uj" parameter to enable user journeys
+    var _this$props2 = this.props,
+      userJourneys = _this$props2.userJourneys,
+      basicProps = _objectWithoutPropertiesLoose(_this$props2, _excluded);
     var renderParams = Object.assign({
       "open-callback": this.handleOpen,
       "close-callback": this.handleClose,
@@ -161,9 +172,10 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       "chalexpired-callback": this.handleChallengeExpired,
       "expired-callback": this.handleExpire,
       "callback": this.handleSubmit
-    }, this.props, {
+    }, basicProps, {
       hl: this.props.hl || this.props.languageOverride,
-      languageOverride: undefined
+      languageOverride: undefined,
+      uj: userJourneys !== undefined ? userJourneys : false
     });
     var hcaptcha = this._hcaptcha;
     //Render hCaptcha widget and provide necessary callbacks - hCaptcha

package/dist/index.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
@@ -16,6 +17,7 @@ var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits
 var React = _interopRequireWildcard(require("react"));
 var _loader = require("@hcaptcha/loader");
 var _utils = require("./utils.js");
+var _excluded = ["userJourneys"];
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof3(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2["default"])(o), (0, _possibleConstructorReturn2["default"])(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2["default"])(t).constructor) : o.apply(t, e)); }
@@ -149,7 +151,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 +169,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
         scriptLocation: scriptLocation,
         scriptSource: scriptSource,
         secureApi: secureApi,
-        cleanup: cleanup
+        cleanup: cleanup,
+        userJourneys: userJourneys
       };
       (0, _loader.hCaptchaLoader)(mountParams).then(this.handleOnLoad, this.handleError)["catch"](this.handleError);
       this.apiScriptRequested = true;
@@ -183,6 +187,13 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       // • API is not ready
       // • Component has already been mounted
       if (!isApiReady || captchaId) return;
+
+      // It is needed to pass only the props that hCaptcha supports
+      // React are able to receive userJourneys as prop but hCaptcha not
+      // hcaptcha expects to have only "uj" parameter to enable user journeys
+      var _this$props2 = this.props,
+        userJourneys = _this$props2.userJourneys,
+        basicProps = (0, _objectWithoutProperties2["default"])(_this$props2, _excluded);
       var renderParams = Object.assign({
         "open-callback": this.handleOpen,
         "close-callback": this.handleClose,
@@ -190,9 +201,10 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
         "chalexpired-callback": this.handleChallengeExpired,
         "expired-callback": this.handleExpire,
         "callback": this.handleSubmit
-      }, this.props, {
+      }, basicProps, {
         hl: this.props.hl || this.props.languageOverride,
-        languageOverride: undefined
+        languageOverride: undefined,
+        uj: userJourneys !== undefined ? userJourneys : false
       });
       var hcaptcha = this._hcaptcha;
       //Render hCaptcha widget and provide necessary callbacks - hCaptcha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hcaptcha/react-hcaptcha",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "types": "types/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -56,10 +56,10 @@
     "wait-for-expect": "^3.0.2",
     "webpack": "^5.76.3",
     "webpack-cli": "^5.0.1",
-    "webpack-dev-server": "^4.13.1"
+    "webpack-dev-server": "^5.2.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.17.9",
-    "@hcaptcha/loader": "^2.0.0"
+    "@hcaptcha/loader": "^2.0.1"
   }
 }

package/src/index.js

@@ -130,6 +130,7 @@ class HCaptcha extends React.Component {
         scriptSource,
         secureApi,
         cleanup = true,
+        userJourneys,
       } = this.props;
       const mountParams = {
         render: 'explicit',
@@ -147,7 +148,8 @@ class HCaptcha extends React.Component {
         scriptLocation,
         scriptSource,
         secureApi,
-        cleanup
+        cleanup,
+        userJourneys
       };
 
       hCaptchaLoader(mountParams)
@@ -167,6 +169,11 @@ class HCaptcha extends React.Component {
       // • Component has already been mounted
       if (!isApiReady || captchaId) return;
 
+      // It is needed to pass only the props that hCaptcha supports
+      // React are able to receive userJourneys as prop but hCaptcha not
+      // hcaptcha expects to have only "uj" parameter to enable user journeys
+      const { userJourneys, ...basicProps } = this.props;
+      
       const renderParams = Object.assign({
         "open-callback"       : this.handleOpen,
         "close-callback"      : this.handleClose,
@@ -174,9 +181,10 @@ class HCaptcha extends React.Component {
         "chalexpired-callback": this.handleChallengeExpired,
         "expired-callback"    : this.handleExpire,
         "callback"            : this.handleSubmit,
-      }, this.props, {
+      }, basicProps, {
         hl: this.props.hl || this.props.languageOverride,
-        languageOverride: undefined
+        languageOverride: undefined,
+        uj: userJourneys !== undefined ? userJourneys : false,
       });
 
       const hcaptcha = this._hcaptcha;

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;