@hcaptcha/react-hcaptcha 1.3.0 → 1.4.1

package/dist/esm/index.js

@@ -0,0 +1,332 @@
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
+import _inheritsLoose from "@babel/runtime/helpers/inheritsLoose";
+import * as React from 'react';
+import { generateQuery } from "./utils.js"; // Create script to init hCaptcha
+
+var onLoadListeners = [];
+var apiScriptRequested = false; // Generate hCaptcha API Script
+
+var mountCaptchaScript = function mountCaptchaScript(params) {
+  if (params === void 0) {
+    params = {};
+  }
+
+  apiScriptRequested = true; // Create global onload callback
+
+  window.hcaptchaOnLoad = function () {
+    // Iterate over onload listeners, call each listener
+    onLoadListeners = onLoadListeners.filter(function (listener) {
+      listener();
+      return false;
+    });
+  };
+
+  var domain = params.apihost || "https://js.hcaptcha.com";
+  delete params.apihost;
+  var script = document.createElement("script");
+  script.src = domain + "/1/api.js?render=explicit&onload=hcaptchaOnLoad";
+  script.async = true;
+  var query = generateQuery(params);
+  script.src += query !== "" ? "&" + query : "";
+  document.head.appendChild(script);
+};
+
+var HCaptcha = /*#__PURE__*/function (_React$Component) {
+  _inheritsLoose(HCaptcha, _React$Component);
+
+  function HCaptcha(props) {
+    var _this;
+
+    _this = _React$Component.call(this, props) || this; // API Methods
+
+    _this.renderCaptcha = _this.renderCaptcha.bind(_assertThisInitialized(_this));
+    _this.resetCaptcha = _this.resetCaptcha.bind(_assertThisInitialized(_this));
+    _this.removeCaptcha = _this.removeCaptcha.bind(_assertThisInitialized(_this));
+    _this.isReady = _this.isReady.bind(_assertThisInitialized(_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.handleOpen = _this.handleOpen.bind(_assertThisInitialized(_this));
+    _this.handleClose = _this.handleClose.bind(_assertThisInitialized(_this));
+    _this.handleChallengeExpired = _this.handleChallengeExpired.bind(_assertThisInitialized(_this));
+    var isApiReady = typeof hcaptcha !== 'undefined';
+    _this.ref = /*#__PURE__*/React.createRef();
+    _this.state = {
+      isApiReady: isApiReady,
+      isRemoved: false,
+      elementId: props.id,
+      captchaId: ''
+    };
+    return _this;
+  }
+
+  var _proto = HCaptcha.prototype;
+
+  _proto.componentDidMount = function componentDidMount() {
+    //Once captcha is mounted intialize hCaptcha - hCaptcha
+    var _this$props = this.props,
+        apihost = _this$props.apihost,
+        assethost = _this$props.assethost,
+        endpoint = _this$props.endpoint,
+        host = _this$props.host,
+        imghost = _this$props.imghost,
+        hl = _this$props.languageOverride,
+        reCaptchaCompat = _this$props.reCaptchaCompat,
+        reportapi = _this$props.reportapi,
+        sentry = _this$props.sentry,
+        custom = _this$props.custom;
+    var isApiReady = this.state.isApiReady;
+
+    if (!isApiReady) {
+      //Check if hCaptcha has already been loaded, if not create script tag and wait to render captcha
+      if (apiScriptRequested) {
+        return;
+      } // Only create the script tag once, use a global variable to track
+
+
+      mountCaptchaScript({
+        apihost: apihost,
+        assethost: assethost,
+        endpoint: endpoint,
+        hl: hl,
+        host: host,
+        imghost: imghost,
+        recaptchacompat: reCaptchaCompat === false ? "off" : null,
+        reportapi: reportapi,
+        sentry: sentry,
+        custom: custom
+      }); // Add onload callback to global onload listeners
+
+      onLoadListeners.push(this.handleOnLoad);
+    } else {
+      this.renderCaptcha();
+    }
+  };
+
+  _proto.componentWillUnmount = function componentWillUnmount() {
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    } // Reset any stored variables / timers when unmounting
+
+
+    hcaptcha.reset(captchaId);
+    hcaptcha.remove(captchaId);
+  };
+
+  _proto.shouldComponentUpdate = function shouldComponentUpdate(nextProps, nextState) {
+    // Prevent component re-rendering when these internal state variables are updated
+    if (this.state.isApiReady !== nextState.isApiReady || this.state.isRemoved !== nextState.isRemoved) {
+      return false;
+    }
+
+    return true;
+  };
+
+  _proto.componentDidUpdate = function componentDidUpdate(prevProps) {
+    var _this2 = this;
+
+    // Prop Keys that could change
+    var keys = ['sitekey', 'size', 'theme', 'tabindex', 'languageOverride', 'endpoint']; // See if any props changed during component update
+
+    var match = keys.every(function (key) {
+      return prevProps[key] === _this2.props[key];
+    }); // If they have changed, remove current captcha and render a new one
+
+    if (!match) {
+      this.removeCaptcha(function () {
+        _this2.renderCaptcha();
+      });
+    }
+  };
+
+  _proto.renderCaptcha = function renderCaptcha(onReady) {
+    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, {
+      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();
+    });
+  };
+
+  _proto.resetCaptcha = function resetCaptcha() {
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    } // Reset captcha state, removes stored token and unticks checkbox
+
+
+    hcaptcha.reset(captchaId);
+  };
+
+  _proto.removeCaptcha = function removeCaptcha(callback) {
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    }
+
+    this.setState({
+      isRemoved: true
+    }, function () {
+      hcaptcha.remove(captchaId);
+      callback && callback();
+    });
+  };
+
+  _proto.handleOnLoad = function handleOnLoad() {
+    var _this3 = this;
+
+    this.setState({
+      isApiReady: true
+    }, function () {
+      // render captcha and wait for captcha id
+      _this3.renderCaptcha(function () {
+        // trigger onLoad if it exists
+        var onLoad = _this3.props.onLoad;
+        if (onLoad) onLoad();
+      });
+    });
+  };
+
+  _proto.handleSubmit = function handleSubmit(event) {
+    var onVerify = this.props.onVerify;
+    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
+
+    var ekey = hcaptcha.getRespKey(captchaId); //Get current challenge session id from hCaptcha widget
+
+    onVerify(token, ekey); //Dispatch event to verify user response
+  };
+
+  _proto.handleExpire = function handleExpire() {
+    var onExpire = this.props.onExpire;
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    }
+
+    hcaptcha.reset(captchaId); // If hCaptcha runs into error, reset captcha - hCaptcha
+
+    if (onExpire) onExpire();
+  };
+
+  _proto.handleError = function handleError(event) {
+    var onError = this.props.onError;
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    }
+
+    hcaptcha.reset(captchaId); // If hCaptcha runs into error, reset captcha - hCaptcha
+
+    if (onError) onError(event);
+  };
+
+  _proto.isReady = function isReady() {
+    var _this$state2 = this.state,
+        isApiReady = _this$state2.isApiReady,
+        isRemoved = _this$state2.isRemoved;
+    return isApiReady && !isRemoved;
+  };
+
+  _proto.handleOpen = function handleOpen() {
+    if (!this.isReady() || !this.props.onOpen) {
+      return;
+    }
+
+    this.props.onOpen();
+  };
+
+  _proto.handleClose = function handleClose() {
+    if (!this.isReady() || !this.props.onClose) {
+      return;
+    }
+
+    this.props.onClose();
+  };
+
+  _proto.handleChallengeExpired = function handleChallengeExpired() {
+    if (!this.isReady() || !this.props.onChalExpired) {
+      return;
+    }
+
+    this.props.onChalExpired();
+  };
+
+  _proto.execute = function execute(opts) {
+    if (opts === void 0) {
+      opts = null;
+    }
+
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    }
+
+    if (opts && typeof opts !== "object") {
+      opts = null;
+    }
+
+    return hcaptcha.execute(captchaId, opts);
+  };
+
+  _proto.setData = function setData(data) {
+    var captchaId = this.state.captchaId;
+
+    if (!this.isReady()) {
+      return;
+    }
+
+    if (data && typeof data !== "object") {
+      data = null;
+    }
+
+    hcaptcha.setData(captchaId, data);
+  };
+
+  _proto.getResponse = function getResponse() {
+    return hcaptcha.getResponse(this.state.captchaId);
+  };
+
+  _proto.getRespKey = function getRespKey() {
+    return hcaptcha.getRespKey(this.state.captchaId);
+  };
+
+  _proto.render = function render() {
+    var elementId = this.state.elementId;
+    return /*#__PURE__*/React.createElement("div", {
+      ref: this.ref,
+      id: elementId
+    });
+  };
+
+  return HCaptcha;
+}(React.Component);
+
+export default HCaptcha;

package/dist/esm/utils.js

@@ -0,0 +1,14 @@
+function generateQuery(params) {
+  return Object.entries(params).filter(function (_ref) {
+    var key = _ref[0],
+        value = _ref[1];
+    return value || value === false;
+  }).map(function (_ref2) {
+    var key = _ref2[0],
+        value = _ref2[1];
+    return encodeURIComponent(key) + "=" + encodeURIComponent(value);
+  }).join("&");
+}
+
+;
+export { generateQuery };

package/dist/index.js

@@ -1,7 +1,14 @@
 "use strict";
 
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -16,16 +23,15 @@ var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime
 
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 
-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; } }
+var React = _interopRequireWildcard(require("react"));
 
-var React = require('react');
+var _utils = require("./utils.js");
 
-var _require = require("./utils.js"),
-    generateQuery = _require.generateQuery; // Create script to init hCaptcha
+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; } }
 
+// Create script to init hCaptcha
 var onLoadListeners = [];
 var apiScriptRequested = false; // Generate hCaptcha API Script
 
@@ -46,7 +52,7 @@ var mountCaptchaScript = function mountCaptchaScript() {
   var script = document.createElement("script");
   script.src = "".concat(domain, "/1/api.js?render=explicit&onload=hcaptchaOnLoad");
   script.async = true;
-  var query = generateQuery(params);
+  var query = (0, _utils.generateQuery)(params);
   script.src += query !== "" ? "&".concat(query) : "";
   document.head.appendChild(script);
 };
@@ -75,7 +81,7 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
     _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.ref = /*#__PURE__*/React.createRef();
     _this.state = {
       isApiReady: isApiReady,
       isRemoved: false,
@@ -104,22 +110,23 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
 
       if (!isApiReady) {
         //Check if hCaptcha has already been loaded, if not create script tag and wait to render captcha
-        if (!apiScriptRequested) {
-          // Only create the script tag once, use a global variable to track
-          mountCaptchaScript({
-            apihost: apihost,
-            assethost: assethost,
-            endpoint: endpoint,
-            hl: hl,
-            host: host,
-            imghost: imghost,
-            recaptchacompat: reCaptchaCompat === false ? "off" : null,
-            reportapi: reportapi,
-            sentry: sentry,
-            custom: custom
-          });
-        } // Add onload callback to global onload listeners
-
+        if (apiScriptRequested) {
+          return;
+        } // Only create the script tag once, use a global variable to track
+
+
+        mountCaptchaScript({
+          apihost: apihost,
+          assethost: assethost,
+          endpoint: endpoint,
+          hl: hl,
+          host: host,
+          imghost: imghost,
+          recaptchacompat: reCaptchaCompat === false ? "off" : null,
+          reportapi: reportapi,
+          sentry: sentry,
+          custom: custom
+        }); // Add onload callback to global onload listeners
 
         onLoadListeners.push(this.handleOnLoad);
       } else {
@@ -367,4 +374,6 @@ var HCaptcha = /*#__PURE__*/function (_React$Component) {
   return HCaptcha;
 }(React.Component);
 
-module.exports = HCaptcha;
+var _default = HCaptcha;
+exports["default"] = _default;
+module.exports = exports.default;

package/dist/utils.js

@@ -2,6 +2,11 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateQuery = generateQuery;
+
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
 function generateQuery(params) {
@@ -20,7 +25,4 @@ function generateQuery(params) {
   }).join("&");
 }
 
-;
-module.exports = {
-  generateQuery: generateQuery
-};
+;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@hcaptcha/react-hcaptcha",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "types": "types/index.d.ts",
   "main": "dist/index.js",
+  "module": "dist/esm/index.js",
   "files": [
     "src",
     "dist",
-    "types/index.d.ts"
+    "types"
   ],
   "description": "A React library for hCaptcha",
   "scripts": {
@@ -14,8 +15,10 @@
     "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"
+    "prebuild": "rimraf dist",
+    "build": "npm run transpile && npm run build:esm",
+    "build:esm": "cross-env BABEL_ENV=esm babel src -d dist/esm --copy-files",
+    "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
     "react": ">= 16.3.0",
@@ -36,15 +39,19 @@
     "@babel/preset-env": "^7.12.11",
     "@babel/preset-react": "^7.12.10",
     "babel-loader": "^8.2.2",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "cross-env": "^7.0.3",
     "html-webpack-plugin": "^3.2.0",
     "jest": "^26.6.3",
     "react": "^16.14.0",
     "react-dom": "^16.14.0",
+    "rimraf": "^3.0.2",
     "webpack": "^4.44.2",
     "webpack-cli": "^3.3.12",
     "webpack-dev-server": "^3.11.0"
   },
   "dependencies": {
-    "@babel/runtime": "^7.17.9"
+    "@babel/runtime": "^7.17.9",
+    "@types/react": "^18.0.0"
   }
 }

package/src/index.js

@@ -1,5 +1,5 @@
-const React = require('react');
-const { generateQuery } = require("./utils.js");
+import * as React from 'react';
+import { generateQuery } from "./utils.js";
 
  // Create script to init hCaptcha
 let onLoadListeners = [];
@@ -67,23 +67,24 @@ class HCaptcha extends React.Component {
       const { isApiReady } = this.state;
 
       if (!isApiReady) {  //Check if hCaptcha has already been loaded, if not create script tag and wait to render captcha
-
-        if (!apiScriptRequested) {
-            // Only create the script tag once, use a global variable to track
-            mountCaptchaScript({
-              apihost,
-              assethost,
-              endpoint,
-              hl,
-              host,
-              imghost,
-              recaptchacompat: reCaptchaCompat === false? "off" : null,
-              reportapi,
-              sentry,
-              custom
-            });
+        if (apiScriptRequested) {
+          return;
         }
 
+        // Only create the script tag once, use a global variable to track
+        mountCaptchaScript({
+          apihost,
+          assethost,
+          endpoint,
+          hl,
+          host,
+          imghost,
+          recaptchacompat: reCaptchaCompat === false? "off" : null,
+          reportapi,
+          sentry,
+          custom
+        });
+
         // Add onload callback to global onload listeners
         onLoadListeners.push(this.handleOnLoad);
       } else {
@@ -293,4 +294,4 @@ class HCaptcha extends React.Component {
     }
   }
 
-module.exports = HCaptcha;
+export default HCaptcha;

package/src/utils.js

@@ -6,6 +6,4 @@ function generateQuery(params) {
         }).join("&");
 };
 
-module.exports = {
-    generateQuery
-};
+export { generateQuery };