@hcaptcha/react-hcaptcha 0.3.9 → 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|

package/dist/index.js

@@ -4,8 +4,6 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -18,10 +16,6 @@ var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime
 
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 
-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; }
-
-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) { (0, _defineProperty2["default"])(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; }
-
 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; } }
@@ -172,13 +166,17 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     key: "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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hcaptcha/react-hcaptcha",
-  "version": "0.3.9",
+  "version": "0.3.10",
   "types": "types/index.d.ts",
   "main": "dist/index.js",
   "files": [

package/src/index.js

@@ -123,14 +123,17 @@ class HCaptcha extends React.Component {
       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 }, () => {
         onReady && onReady();