@hcaptcha/react-hcaptcha 1.0.0 → 1.2.0

package/README.md

@@ -140,13 +140,19 @@ 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.|
+|`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.|
 
 ### Methods
 
 |Method|Description|
 |---|---|
 |`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.|
+|`getRespKey()`|Get the current challenge reference ID|
+|`getResponse()`|Get the current challenge response token from completed challenge|
 |`resetCaptcha()`|Reset the current challenge|
+|`setData()`|See enterprise docs.|
 
 
 **NOTE**: Make sure to reset the hCaptcha state when you submit your form by calling the method `.resetCaptcha` on your hCaptcha React Component! Passcodes are one-time use, so if your user submits the same passcode twice then it will be rejected by the server the second time.

package/dist/index.js

@@ -64,12 +64,16 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
 
     _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.removeCaptcha = _this.removeCaptcha.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.isReady = _this.isReady.bind((0, _assertThisInitialized2["default"])(_this)); // Event Handlers
 
     _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));
+    _this.handleOpen = _this.handleOpen.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.handleClose = _this.handleClose.bind((0, _assertThisInitialized2["default"])(_this));
+    _this.handleChallengeExpired = _this.handleChallengeExpired.bind((0, _assertThisInitialized2["default"])(_this));
     var isApiReady = typeof hcaptcha !== 'undefined';
     _this.ref = React.createRef();
     _this.state = {
@@ -125,11 +129,12 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
   }, {
     key: "componentWillUnmount",
     value: function componentWillUnmount() {
-      var _this$state = this.state,
-          isApiReady = _this$state.isApiReady,
-          isRemoved = _this$state.isRemoved,
-          captchaId = _this$state.captchaId;
-      if (!isApiReady || isRemoved) return; // Reset any stored variables / timers when unmounting
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      } // Reset any stored variables / timers when unmounting
+
 
       hcaptcha.reset(captchaId);
       hcaptcha.remove(captchaId);
@@ -168,7 +173,10 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
       var isApiReady = this.state.isApiReady;
       if (!isApiReady) return;
       var renderParams = Object.assign({
+        "open-callback": this.handleOpen,
+        "close-callback": this.handleClose,
         "error-callback": this.handleError,
+        "chalexpired-callback": this.handleChallengeExpired,
         "expired-callback": this.handleExpire,
         "callback": this.handleSubmit
       }, this.props, {
@@ -187,22 +195,24 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
   }, {
     key: "resetCaptcha",
     value: function resetCaptcha() {
-      var _this$state2 = this.state,
-          isApiReady = _this$state2.isApiReady,
-          isRemoved = _this$state2.isRemoved,
-          captchaId = _this$state2.captchaId;
-      if (!isApiReady || isRemoved) return; // Reset captcha state, removes stored token and unticks checkbox
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      } // Reset captcha state, removes stored token and unticks checkbox
+
 
       hcaptcha.reset(captchaId);
     }
   }, {
     key: "removeCaptcha",
     value: function removeCaptcha(callback) {
-      var _this$state3 = this.state,
-          isApiReady = _this$state3.isApiReady,
-          isRemoved = _this$state3.isRemoved,
-          captchaId = _this$state3.captchaId;
-      if (!isApiReady || isRemoved) return;
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      }
+
       this.setState({
         isRemoved: true
       }, function () {
@@ -230,9 +240,9 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     key: "handleSubmit",
     value: function handleSubmit(event) {
       var onVerify = this.props.onVerify;
-      var _this$state4 = this.state,
-          isRemoved = _this$state4.isRemoved,
-          captchaId = _this$state4.captchaId;
+      var _this$state = this.state,
+          isRemoved = _this$state.isRemoved,
+          captchaId = _this$state.captchaId;
       if (typeof hcaptcha === 'undefined' || isRemoved) return;
       var token = hcaptcha.getResponse(captchaId); //Get response token from hCaptcha widget
 
@@ -244,11 +254,12 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     key: "handleExpire",
     value: function handleExpire() {
       var onExpire = this.props.onExpire;
-      var _this$state5 = this.state,
-          isApiReady = _this$state5.isApiReady,
-          isRemoved = _this$state5.isRemoved,
-          captchaId = _this$state5.captchaId;
-      if (!isApiReady || isRemoved) return;
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      }
+
       hcaptcha.reset(captchaId); // If hCaptcha runs into error, reset captcha - hCaptcha
 
       if (onExpire) onExpire();
@@ -257,24 +268,60 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     key: "handleError",
     value: function handleError(event) {
       var onError = this.props.onError;
-      var _this$state6 = this.state,
-          isApiReady = _this$state6.isApiReady,
-          isRemoved = _this$state6.isRemoved,
-          captchaId = _this$state6.captchaId;
-      if (!isApiReady || isRemoved) return;
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      }
+
       hcaptcha.reset(captchaId); // If hCaptcha runs into error, reset captcha - hCaptcha
 
       if (onError) onError(event);
     }
+  }, {
+    key: "isReady",
+    value: function isReady() {
+      var _this$state2 = this.state,
+          isApiReady = _this$state2.isApiReady,
+          isRemoved = _this$state2.isRemoved;
+      return isApiReady && !isRemoved;
+    }
+  }, {
+    key: "handleOpen",
+    value: function handleOpen() {
+      if (!this.isReady() || !this.props.onOpen) {
+        return;
+      }
+
+      this.props.onOpen();
+    }
+  }, {
+    key: "handleClose",
+    value: function handleClose() {
+      if (!this.isReady() || !this.props.onClose) {
+        return;
+      }
+
+      this.props.onClose();
+    }
+  }, {
+    key: "handleChallengeExpired",
+    value: function handleChallengeExpired() {
+      if (!this.isReady() || !this.props.onChalExpired) {
+        return;
+      }
+
+      this.props.onChalExpired();
+    }
   }, {
     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;
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      }
 
       if (opts && (0, _typeof2["default"])(opts) !== "object") {
         opts = null;
@@ -282,6 +329,31 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
 
       return hcaptcha.execute(captchaId, opts);
     }
+  }, {
+    key: "setData",
+    value: function setData(data) {
+      var captchaId = this.state.captchaId;
+
+      if (!this.isReady()) {
+        return;
+      }
+
+      if (data && (0, _typeof2["default"])(data) !== "object") {
+        data = null;
+      }
+
+      hcaptcha.setData(captchaId, data);
+    }
+  }, {
+    key: "getResponse",
+    value: function getResponse() {
+      return hcaptcha.getResponse(this.state.captchaId);
+    }
+  }, {
+    key: "getRespKey",
+    value: function getRespKey() {
+      return hcaptcha.getRespKey(this.state.captchaId);
+    }
   }, {
     key: "render",
     value: function render() {

package/package.json

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

package/src/index.js

@@ -39,12 +39,16 @@ class HCaptcha extends React.Component {
       this.renderCaptcha = this.renderCaptcha.bind(this);
       this.resetCaptcha  = this.resetCaptcha.bind(this);
       this.removeCaptcha = this.removeCaptcha.bind(this);
+      this.isReady = this.isReady.bind(this);
 
       // Event Handlers
       this.handleOnLoad = this.handleOnLoad.bind(this);
       this.handleSubmit = this.handleSubmit.bind(this);
       this.handleExpire = this.handleExpire.bind(this);
       this.handleError  = this.handleError.bind(this);
+      this.handleOpen = this.handleOpen.bind(this);
+      this.handleClose = this.handleClose.bind(this);
+      this.handleChallengeExpired = this.handleChallengeExpired.bind(this);
 
       const isApiReady = typeof hcaptcha !== 'undefined';
 
@@ -88,8 +92,11 @@ class HCaptcha extends React.Component {
     }
 
     componentWillUnmount() {
-        const { isApiReady, isRemoved, captchaId } = this.state;
-        if(!isApiReady || isRemoved) return
+        const { captchaId } = this.state;
+
+        if (!this.isReady()) {
+          return;
+        }
 
         // Reset any stored variables / timers when unmounting
         hcaptcha.reset(captchaId);
@@ -124,7 +131,10 @@ class HCaptcha extends React.Component {
       if (!isApiReady) return;
 
       const renderParams = Object.assign({
+        "open-callback"       : this.handleOpen,
+        "close-callback"      : this.handleClose,
         "error-callback"      : this.handleError,
+        "chalexpired-callback": this.handleChallengeExpired,
         "expired-callback"    : this.handleExpire,
         "callback"            : this.handleSubmit,
       }, this.props, {
@@ -141,17 +151,21 @@ class HCaptcha extends React.Component {
     }
 
     resetCaptcha() {
-      const { isApiReady, isRemoved, captchaId } = this.state;
+      const { captchaId } = this.state;
 
-      if (!isApiReady || isRemoved) return
+      if (!this.isReady()) {
+        return;
+      }
       // Reset captcha state, removes stored token and unticks checkbox
       hcaptcha.reset(captchaId)
     }
 
     removeCaptcha(callback) {
-      const { isApiReady, isRemoved, captchaId } = this.state;
+      const { captchaId } = this.state;
 
-      if (!isApiReady || isRemoved) return
+      if (!this.isReady()) {
+        return;
+      }
 
       this.setState({ isRemoved: true }, () => {
         hcaptcha.remove(captchaId);
@@ -184,9 +198,12 @@ class HCaptcha extends React.Component {
 
     handleExpire () {
       const { onExpire } = this.props;
-      const { isApiReady, isRemoved, captchaId } = this.state;
+      const { captchaId } = this.state;
+
+      if (!this.isReady()) {
+        return;
+      }
 
-      if (!isApiReady || isRemoved) return
       hcaptcha.reset(captchaId) // If hCaptcha runs into error, reset captcha - hCaptcha
 
       if (onExpire) onExpire();
@@ -194,18 +211,52 @@ class HCaptcha extends React.Component {
 
     handleError (event) {
       const { onError } = this.props;
-      const { isApiReady, isRemoved, captchaId } = this.state;
+      const { captchaId } = this.state;
 
-      if (!isApiReady || isRemoved) return
+      if (!this.isReady()) {
+        return;
+      }
 
       hcaptcha.reset(captchaId) // If hCaptcha runs into error, reset captcha - hCaptcha
       if (onError) onError(event);
     }
 
+    isReady () {
+      const { isApiReady, isRemoved } = this.state;
+
+      return isApiReady && !isRemoved;
+    }
+
+    handleOpen () {
+      if (!this.isReady() || !this.props.onOpen) {
+        return;
+      }
+
+      this.props.onOpen();
+    }
+
+    handleClose () {
+      if (!this.isReady() || !this.props.onClose) {
+        return;
+      }
+
+      this.props.onClose();
+    }
+
+    handleChallengeExpired () {
+      if (!this.isReady() || !this.props.onChalExpired) {
+        return;
+      }
+
+      this.props.onChalExpired();
+    }
+
     execute (opts = null) {
-      const { isApiReady, isRemoved, captchaId } = this.state;
+      const { captchaId } = this.state;
 
-      if (!isApiReady || isRemoved) return;
+      if (!this.isReady()) {
+        return;
+      }
 
       if (opts && typeof opts !== "object") {
         opts = null;
@@ -214,6 +265,28 @@ class HCaptcha extends React.Component {
       return hcaptcha.execute(captchaId, opts);
     }
 
+    setData (data) {
+      const { captchaId } = this.state;
+
+      if (!this.isReady()) {
+        return;
+      }
+
+      if (data && typeof data !== "object") {
+        data = null;
+      }
+
+      hcaptcha.setData(captchaId, data);
+    }
+
+    getResponse() {
+      return hcaptcha.getResponse(this.state.captchaId);
+    }
+
+    getRespKey() {
+      return hcaptcha.getRespKey(this.state.captchaId)
+    }
+
     render () {
       const { elementId } = this.state;
       return <div ref={this.ref} id={elementId}></div>

package/types/index.d.ts

@@ -15,8 +15,11 @@ interface HCaptchaState {
 
 interface HCaptchaProps {
   onExpire?: () => any;
+  onOpen?: () => any;
+  onClose?: () => any;
+  onChalExpired?: () => any;
   onError?: (event: string) => any;
-  onVerify?: (token: string) => any;
+  onVerify?: (token: string, ekey: string) => any;
   onLoad?: () => any;
   languageOverride?: string;
   sitekey: string;
@@ -36,7 +39,10 @@ declare class HCaptcha extends React.Component<HCaptchaProps, HCaptchaState> {
   resetCaptcha(): void;
   renderCaptcha(): void;
   removeCaptcha(): void;
-  execute(opts: { async: true }): Promise<ExecuteResponse>
+  getRespKey(): string;
+  getResponse(): string;
+  setData(data: object): void;
+  execute(opts: { async: true }): Promise<ExecuteResponse>;
   execute(opts?: { async: false }): void;
   execute(opts?: { async: boolean }): Promise<ExecuteResponse> | void;
 }