@hcaptcha/react-hcaptcha 0.3.6 → 0.3.10

package/README.md

@@ -47,12 +47,71 @@ import { default as RenamedCaptcha } from '../utils/captcha';
 </FormComponent>
 ```
 
+#### Programmatic Usage
+In the event you want to call the hCaptcha client API directly, you can do so by using the hook `useRef` and waiting for `onLoad` to be called. By waiting for `onLoad` the hCaptcha API will be ready and the hCaptcha client will have been setup. See the following example:
+
+```js
+import { useEffect, useRef, useState } from "react";
+import HCaptcha from "@hcaptcha/react-hcaptcha";
+
+export default function Form() {
+  const [token, setToken] = useState(null);
+  const captchaRef = useRef(null);
+
+  const onLoad = () => {
+    // this reaches out to the hCaptcha JS API and runs the
+    // execute function on it. you can use other functions as
+    // documented here:
+    // https://docs.hcaptcha.com/configuration#jsapi
+    captchaRef.current.execute();
+  };
+
+  useEffect(() => {
+
+    if (token)
+      console.log(`hCaptcha Token: ${token}`);
+
+  }, [token]);
+
+  return (
+    <form>
+      <HCaptcha
+        sitekey="your-sitekey"
+        onLoad={onLoad}
+        onVerify={setToken}
+        ref={captchaRef}
+      />
+    </form>
+  );
+}
+```
+
 #### Advanced usage
 
 In most real-world implementations, you'll probably be using a form library such as [Formik](https://github.com/jaredpalmer/formik) or [React Hook Form](https://github.com/react-hook-form/react-hook-form).
 
 In these instances, you'll most likely want to use `ref` to handle the callbacks as well as handle field-level validation of a `captcha` field. For an example of this, you can view this [CodeSandbox](https://codesandbox.io/s/react-hcaptchaform-example-forked-ngxge?file=/src/Form.jsx).  This `ref` will point to an instance of the [hCaptcha API](https://docs.hcaptcha.com/configuration#jsapi) where can you interact directly with it.
 
+#### Passing in fields like `rqdata` to `execute()`
+
+Passing an object into the `execute(yourObj)` call will send it through to the underlying JS API. This enables support for Enterprise features like `rqdata`. A simple example is below:
+
+```
+const {sitekey, rqdata} = props;
+const captchaRef = React.useRef<HCaptcha>(null);
+
+const onLoad = () => {
+  const executePayload = {};
+  if (rqdata) {
+    executePayload['rqdata'] = rqdata;
+  }
+  captchaRef.current?.execute(executePayload);
+};
+
+return <HCaptcha ref={captchaRef} onLoad={onLoad} sitekey={sitekey} {...props} />;
+```
+
+
 ### Props
 
 |Name|Values/Type|Required|Default|Description|
@@ -71,6 +130,7 @@ In these instances, you'll most likely want to use `ref` to handle the callbacks
 |`imghost`|String|No|`-`|See enterprise docs.|
 |`reportapi`|String|No|`-`|See enterprise docs.|
 |`sentry`|String|No|`-`|See enterprise docs.|
+|`custom`|Boolean|No|`-`|See enterprise docs.|
 
 ### Events
 
@@ -85,7 +145,7 @@ In these instances, you'll most likely want to use `ref` to handle the callbacks
 
 |Method|Description|
 |---|---|
-|`execute()`|Programmatically trigger a challenge request|
+|`execute()`|Programmatically trigger a challenge request. Additionally, this method can be run asynchronously and returns a promise with the `token` and `eKey` when the challenge is completed.|
 |`resetCaptcha()`|Reset the current challenge|
 
 

package/dist/index.js

@@ -1,33 +1,25 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2["default"])(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2["default"])(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2["default"])(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
 var React = require('react');
 
 var _require = require("./utils.js"),
@@ -60,25 +52,24 @@ var mountCaptchaScript = function mountCaptchaScript() {
 };
 
 var HCaptcha = /*#__PURE__*/function (_React$Component) {
-  _inherits(HCaptcha, _React$Component);
+  (0, _inherits2["default"])(HCaptcha, _React$Component);
 
   var _super = _createSuper(HCaptcha);
 
   function HCaptcha(props) {
     var _this;
 
-    _classCallCheck(this, HCaptcha);
-
+    (0, _classCallCheck2["default"])(this, HCaptcha);
     _this = _super.call(this, props); // API Methods
 
-    _this.renderCaptcha = _this.renderCaptcha.bind(_assertThisInitialized(_this));
-    _this.resetCaptcha = _this.resetCaptcha.bind(_assertThisInitialized(_this));
-    _this.removeCaptcha = _this.removeCaptcha.bind(_assertThisInitialized(_this)); // Event Handlers
+    _this.renderCaptcha = _this.renderCaptcha.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.resetCaptcha = _this.resetCaptcha.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.removeCaptcha = _this.removeCaptcha.bind((0, _assertThisInitialized2["default"])(_this)); // Event Handlers
 
-    _this.handleOnLoad = _this.handleOnLoad.bind(_assertThisInitialized(_this));
-    _this.handleSubmit = _this.handleSubmit.bind(_assertThisInitialized(_this));
-    _this.handleExpire = _this.handleExpire.bind(_assertThisInitialized(_this));
-    _this.handleError = _this.handleError.bind(_assertThisInitialized(_this));
+    _this.handleOnLoad = _this.handleOnLoad.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.handleSubmit = _this.handleSubmit.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.handleExpire = _this.handleExpire.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.handleError = _this.handleError.bind((0, _assertThisInitialized2["default"])(_this));
     var isApiReady = typeof hcaptcha !== 'undefined';
     _this.ref = React.createRef();
     _this.state = {
@@ -90,7 +81,7 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     return _this;
   }
 
-  _createClass(HCaptcha, [{
+  (0, _createClass2["default"])(HCaptcha, [{
     key: "componentDidMount",
     value: function componentDidMount() {
       //Once captcha is mounted intialize hCaptcha - hCaptcha
@@ -103,7 +94,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
           hl = _this$props.languageOverride,
           reCaptchaCompat = _this$props.reCaptchaCompat,
           reportapi = _this$props.reportapi,
-          sentry = _this$props.sentry;
+          sentry = _this$props.sentry,
+          custom = _this$props.custom;
       var isApiReady = this.state.isApiReady;
 
       if (!isApiReady) {
@@ -119,7 +111,8 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
             imghost: imghost,
             recaptchacompat: reCaptchaCompat === false ? "off" : null,
             reportapi: reportapi,
-            sentry: sentry
+            sentry: sentry,
+            custom: custom
           });
         } // Add onload callback to global onload listeners
 
@@ -171,18 +164,24 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     }
   }, {
     key: "renderCaptcha",
-    value: function renderCaptcha() {
+    value: function renderCaptcha(onReady) {
       var isApiReady = this.state.isApiReady;
-      if (!isApiReady) return; //Render hCaptcha widget and provide necessary callbacks - hCaptcha
-
-      var captchaId = hcaptcha.render(this.ref.current, _objectSpread(_objectSpread({}, this.props), {}, {
+      if (!isApiReady) return;
+      var renderParams = Object.assign({
         "error-callback": this.handleError,
         "expired-callback": this.handleExpire,
         "callback": this.handleSubmit
-      }));
+      }, this.props, {
+        hl: this.props.hl || this.props.languageOverride,
+        languageOverride: undefined
+      }); //Render hCaptcha widget and provide necessary callbacks - hCaptcha
+
+      var captchaId = hcaptcha.render(this.ref.current, renderParams);
       this.setState({
         isRemoved: false,
         captchaId: captchaId
+      }, function () {
+        onReady && onReady();
       });
     }
   }, {
@@ -219,11 +218,12 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       this.setState({
         isApiReady: true
       }, function () {
-        // trigger onLoad if it exists
-        var onLoad = _this3.props.onLoad;
-        if (onLoad) onLoad(); // render captcha
-
-        _this3.renderCaptcha();
+        // render captcha and wait for captcha id
+        _this3.renderCaptcha(function () {
+          // trigger onLoad if it exists
+          var onLoad = _this3.props.onLoad;
+          if (onLoad) onLoad();
+        });
       });
     }
   }, {
@@ -269,12 +269,18 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
   }, {
     key: "execute",
     value: function execute() {
+      var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
       var _this$state7 = this.state,
           isApiReady = _this$state7.isApiReady,
           isRemoved = _this$state7.isRemoved,
           captchaId = _this$state7.captchaId;
       if (!isApiReady || isRemoved) return;
-      hcaptcha.execute(captchaId);
+
+      if (opts && (0, _typeof2["default"])(opts) !== "object") {
+        opts = null;
+      }
+
+      return hcaptcha.execute(captchaId, opts);
     }
   }, {
     key: "render",
@@ -286,7 +292,6 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       });
     }
   }]);
-
   return HCaptcha;
 }(React.Component);
 

package/dist/utils.js

@@ -1,26 +1,18 @@
 "use strict";
 
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
 function generateQuery(params) {
   return Object.entries(params).filter(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
+    var _ref2 = (0, _slicedToArray2["default"])(_ref, 2),
         key = _ref2[0],
         value = _ref2[1];
 
     return value || value === false;
   }).map(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
+    var _ref4 = (0, _slicedToArray2["default"])(_ref3, 2),
         key = _ref4[0],
         value = _ref4[1];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hcaptcha/react-hcaptcha",
-  "version": "0.3.6",
+  "version": "0.3.10",
   "types": "types/index.d.ts",
   "main": "dist/index.js",
   "files": [
@@ -12,6 +12,7 @@
   "scripts": {
     "start": "webpack-dev-server --config ./webpack.config.js --mode development",
     "test": "jest",
+    "watch": "babel src -d dist --copy-files --watch",
     "transpile": "babel src -d dist --copy-files",
     "build": "npm run transpile",
     "prepublishOnly": "npm run transpile"
@@ -31,6 +32,7 @@
   "devDependencies": {
     "@babel/cli": "^7.12.10",
     "@babel/core": "^7.12.10",
+    "@babel/plugin-transform-runtime": "^7.14.5",
     "@babel/preset-env": "^7.12.11",
     "@babel/preset-react": "^7.12.10",
     "babel-loader": "^8.2.2",

package/src/index.js

@@ -59,7 +59,7 @@ class HCaptcha extends React.Component {
     }
 
     componentDidMount () { //Once captcha is mounted intialize hCaptcha - hCaptcha
-      const { apihost, assethost, endpoint, host, imghost, languageOverride:hl, reCaptchaCompat, reportapi, sentry } = this.props;
+      const { apihost, assethost, endpoint, host, imghost, languageOverride:hl, reCaptchaCompat, reportapi, sentry, custom } = this.props;
       const { isApiReady } = this.state;
 
       if (!isApiReady) {  //Check if hCaptcha has already been loaded, if not create script tag and wait to render captcha
@@ -75,7 +75,8 @@ class HCaptcha extends React.Component {
               imghost,
               recaptchacompat: reCaptchaCompat === false? "off" : null,
               reportapi,
-              sentry
+              sentry,
+              custom
             });
         }
 
@@ -118,20 +119,25 @@ class HCaptcha extends React.Component {
       }
     }
 
-    renderCaptcha() {
+    renderCaptcha(onReady) {
       const { isApiReady } = this.state;
       if (!isApiReady) return;
 
+      const renderParams = Object.assign({
+        "error-callback"      : this.handleError,
+        "expired-callback"    : this.handleExpire,
+        "callback"            : this.handleSubmit,
+      }, this.props, {
+        hl: this.props.hl || this.props.languageOverride,
+        languageOverride: undefined
+      });
+
       //Render hCaptcha widget and provide necessary callbacks - hCaptcha
-      const captchaId = hcaptcha.render(this.ref.current,
-        {
-          ...this.props,
-          "error-callback"  : this.handleError,
-          "expired-callback": this.handleExpire,
-          "callback"        : this.handleSubmit
-        });
+      const captchaId = hcaptcha.render(this.ref.current, renderParams);
 
-      this.setState({ isRemoved: false, captchaId });
+      this.setState({ isRemoved: false, captchaId }, () => {
+        onReady && onReady();
+      });
     }
 
     resetCaptcha() {
@@ -155,12 +161,13 @@ class HCaptcha extends React.Component {
 
     handleOnLoad () {
       this.setState({ isApiReady: true }, () => {
-        // trigger onLoad if it exists
-        const { onLoad } = this.props;
-        if (onLoad) onLoad();
 
-        // render captcha
-        this.renderCaptcha();
+        // render captcha and wait for captcha id
+        this.renderCaptcha(() => {
+            // trigger onLoad if it exists
+            const { onLoad } = this.props;
+            if (onLoad) onLoad();
+        });
       });
     }
 
@@ -195,12 +202,16 @@ class HCaptcha extends React.Component {
       if (onError) onError(event);
     }
 
-    execute () {
+    execute (opts = null) {
       const { isApiReady, isRemoved, captchaId } = this.state;
 
-      if (!isApiReady || isRemoved) return
+      if (!isApiReady || isRemoved) return;
+
+      if (opts && typeof opts !== "object") {
+        opts = null;
+      }
 
-      hcaptcha.execute(captchaId)
+      return hcaptcha.execute(captchaId, opts);
     }
 
     render () {

package/types/index.d.ts

@@ -27,11 +27,18 @@ interface HCaptchaProps {
   reCaptchaCompat?: boolean;
 }
 
+interface ExecuteResponse {
+  response: string;
+  key: string;
+}
+
 declare class HCaptcha extends React.Component<HCaptchaProps, HCaptchaState> {
   resetCaptcha(): void;
   renderCaptcha(): void;
   removeCaptcha(): void;
-  execute(): void;
+  execute(opts: { async: true }): Promise<ExecuteResponse>
+  execute(opts?: { async: false }): void;
+  execute(opts?: { async: boolean }): Promise<ExecuteResponse> | void;
 }
 
 export = HCaptcha;