reaptcha - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

CHANGELOG.md

@@ -6,2 +6,17 @@ # Change Log
 
+<a name="1.7.0"></a>
+
+# [1.7.0](https://github.com/sarneeh/reaptcha/compare/v1.6.0...v1.7.0) (2019-10-20)
+
+### Bug Fixes
+
+- add missing render prop ([2137d81](https://github.com/sarneeh/reaptcha/commit/2137d81))
+- cant call this.props.children cause getResponse missing ([77ee190](https://github.com/sarneeh/reaptcha/commit/77ee190))
+- resolve and reject not defined ([eac3a13](https://github.com/sarneeh/reaptcha/commit/eac3a13))
+
+### Features
+
+- added getResponse to types ([33d6d16](https://github.com/sarneeh/reaptcha/commit/33d6d16))
+- exposed getResponse ([c0793aa](https://github.com/sarneeh/reaptcha/commit/c0793aa))
+
 <a name="1.5.1"></a>
@@ -8,0 +23,0 @@

dist/index.js

@@ -140,2 +140,4 @@ (function webpackUniversalModuleDefinition(root, factory) {
 
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
 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); }
@@ -145,4 +147,2 @@
 
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
 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; }
@@ -168,9 +168,9 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "container", null);
+    _defineProperty(_assertThisInitialized(_this), "container", null);
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_isAvailable", function () {
+    _defineProperty(_assertThisInitialized(_this), "_isAvailable", function () {
       return Boolean(window && window.grecaptcha && window.grecaptcha.ready);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_inject", function () {
+    _defineProperty(_assertThisInitialized(_this), "_inject", function () {
       if (_this.props.inject && !isAnyScriptPresent(RECAPTCHA_SCRIPT_REGEX)) {
@@ -183,3 +183,3 @@ var hlParam = _this.props.hl ? "&hl=".concat(_this.props.hl) : '';
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_prepare", function () {
+    _defineProperty(_assertThisInitialized(_this), "_prepare", function () {
       var _this$props = _this.props,
@@ -203,15 +203,19 @@ explicit = _this$props.explicit,
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_renderRecaptcha", function (container, config) {
+    _defineProperty(_assertThisInitialized(_this), "_renderRecaptcha", function (container, config) {
       return window.grecaptcha.render(container, config);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_resetRecaptcha", function () {
+    _defineProperty(_assertThisInitialized(_this), "_resetRecaptcha", function () {
       return window.grecaptcha.reset(_this.state.instanceId);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_executeRecaptcha", function () {
+    _defineProperty(_assertThisInitialized(_this), "_executeRecaptcha", function () {
       return window.grecaptcha.execute(_this.state.instanceId);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_stopTimer", function () {
+    _defineProperty(_assertThisInitialized(_this), "_getResponseRecaptcha", function () {
+      return window.grecaptcha.getResponse(_this.state.instanceId);
+    });
+
+    _defineProperty(_assertThisInitialized(_this), "_stopTimer", function () {
       if (_this.state.timer) {
@@ -222,3 +226,3 @@ clearInterval(_this.state.timer);
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "componentDidMount", function () {
+    _defineProperty(_assertThisInitialized(_this), "componentDidMount", function () {
       _this._inject();
@@ -243,7 +247,7 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "shouldComponentUpdate", function () {
+    _defineProperty(_assertThisInitialized(_this), "shouldComponentUpdate", function () {
       return !_this.state.rendered;
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "componentWillUnmount", function () {
+    _defineProperty(_assertThisInitialized(_this), "componentWillUnmount", function () {
       _this._stopTimer();
@@ -256,3 +260,3 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "renderExplicitly", function () {
+    _defineProperty(_assertThisInitialized(_this), "renderExplicitly", function () {
       return new Promise(function (resolve, reject) {
@@ -293,3 +297,3 @@ if (_this.state.rendered) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "reset", function () {
+    _defineProperty(_assertThisInitialized(_this), "reset", function () {
       return new Promise(function (resolve, reject) {
@@ -306,3 +310,3 @@ if (_this.state.rendered) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "execute", function () {
+    _defineProperty(_assertThisInitialized(_this), "execute", function () {
       return new Promise(function (resolve, reject) {
@@ -323,4 +327,16 @@ if (!_this.state.invisible) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "render", function () {
-      return external_amd_react_commonjs_react_commonjs2_react_root_React_default.a.createElement("div", {
+    _defineProperty(_assertThisInitialized(_this), "getResponse", function () {
+      return new Promise(function (resolve, reject) {
+        if (_this.state.rendered) {
+          var _response = _this._getResponseRecaptcha();
+
+          return resolve(_response);
+        }
+
+        reject(new Error('This recaptcha instance did not render yet.'));
+      });
+    });
+
+    _defineProperty(_assertThisInitialized(_this), "render", function () {
+      var container = external_amd_react_commonjs_react_commonjs2_react_root_React_default.a.createElement("div", {
         id: _this.props.id,
@@ -332,2 +348,9 @@ className: _this.props.className,
       });
+      return _this.props.children ? _this.props.children({
+        renderExplicitly: _this.renderExplicitly,
+        reset: _this.reset,
+        execute: _this.execute,
+        getResponse: _this.getResponse,
+        recaptchaComponent: container
+      }) : container;
     });
@@ -334,0 +357,0 @@

dist/index.min.js

@@ -140,2 +140,4 @@ (function webpackUniversalModuleDefinition(root, factory) {
 
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
 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); }
@@ -145,4 +147,2 @@
 
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
 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; }
@@ -168,9 +168,9 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "container", null);
+    _defineProperty(_assertThisInitialized(_this), "container", null);
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_isAvailable", function () {
+    _defineProperty(_assertThisInitialized(_this), "_isAvailable", function () {
       return Boolean(window && window.grecaptcha && window.grecaptcha.ready);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_inject", function () {
+    _defineProperty(_assertThisInitialized(_this), "_inject", function () {
       if (_this.props.inject && !isAnyScriptPresent(RECAPTCHA_SCRIPT_REGEX)) {
@@ -183,3 +183,3 @@ var hlParam = _this.props.hl ? "&hl=".concat(_this.props.hl) : '';
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_prepare", function () {
+    _defineProperty(_assertThisInitialized(_this), "_prepare", function () {
       var _this$props = _this.props,
@@ -203,15 +203,19 @@ explicit = _this$props.explicit,
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_renderRecaptcha", function (container, config) {
+    _defineProperty(_assertThisInitialized(_this), "_renderRecaptcha", function (container, config) {
       return window.grecaptcha.render(container, config);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_resetRecaptcha", function () {
+    _defineProperty(_assertThisInitialized(_this), "_resetRecaptcha", function () {
       return window.grecaptcha.reset(_this.state.instanceId);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_executeRecaptcha", function () {
+    _defineProperty(_assertThisInitialized(_this), "_executeRecaptcha", function () {
       return window.grecaptcha.execute(_this.state.instanceId);
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "_stopTimer", function () {
+    _defineProperty(_assertThisInitialized(_this), "_getResponseRecaptcha", function () {
+      return window.grecaptcha.getResponse(_this.state.instanceId);
+    });
+
+    _defineProperty(_assertThisInitialized(_this), "_stopTimer", function () {
       if (_this.state.timer) {
@@ -222,3 +226,3 @@ clearInterval(_this.state.timer);
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "componentDidMount", function () {
+    _defineProperty(_assertThisInitialized(_this), "componentDidMount", function () {
       _this._inject();
@@ -243,7 +247,7 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "shouldComponentUpdate", function () {
+    _defineProperty(_assertThisInitialized(_this), "shouldComponentUpdate", function () {
       return !_this.state.rendered;
     });
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "componentWillUnmount", function () {
+    _defineProperty(_assertThisInitialized(_this), "componentWillUnmount", function () {
       _this._stopTimer();
@@ -256,3 +260,3 @@
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "renderExplicitly", function () {
+    _defineProperty(_assertThisInitialized(_this), "renderExplicitly", function () {
       return new Promise(function (resolve, reject) {
@@ -293,3 +297,3 @@ if (_this.state.rendered) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "reset", function () {
+    _defineProperty(_assertThisInitialized(_this), "reset", function () {
       return new Promise(function (resolve, reject) {
@@ -306,3 +310,3 @@ if (_this.state.rendered) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "execute", function () {
+    _defineProperty(_assertThisInitialized(_this), "execute", function () {
       return new Promise(function (resolve, reject) {
@@ -323,4 +327,16 @@ if (!_this.state.invisible) {
 
-    _defineProperty(_assertThisInitialized(_assertThisInitialized(_this)), "render", function () {
-      return external_amd_react_commonjs_react_commonjs2_react_root_React_default.a.createElement("div", {
+    _defineProperty(_assertThisInitialized(_this), "getResponse", function () {
+      return new Promise(function (resolve, reject) {
+        if (_this.state.rendered) {
+          var _response = _this._getResponseRecaptcha();
+
+          return resolve(_response);
+        }
+
+        reject(new Error('This recaptcha instance did not render yet.'));
+      });
+    });
+
+    _defineProperty(_assertThisInitialized(_this), "render", function () {
+      var container = external_amd_react_commonjs_react_commonjs2_react_root_React_default.a.createElement("div", {
         id: _this.props.id,
@@ -332,2 +348,9 @@ className: _this.props.className,
       });
+      return _this.props.children ? _this.props.children({
+        renderExplicitly: _this.renderExplicitly,
+        reset: _this.reset,
+        execute: _this.execute,
+        getResponse: _this.getResponse,
+        recaptchaComponent: container
+      }) : container;
     });
@@ -334,0 +357,0 @@

index.d.ts

@@ -7,2 +7,3 @@ import * as React from 'react';
   execute: () => Promise<void>;
+  getResponse: () => Promise<string>;
   recaptchaComponent: React.ReactNode;
@@ -9,0 +10,0 @@ };

package.json

 {
   "name": "reaptcha",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Google reCAPTCHA for React",
@@ -25,4 +25,3 @@ "repository": {
     "webpack": "^4.17.1"
-  },
-  "gitHead": "94ad7e0481d43a9c919a86cdc80cb3be249d932a"
+  }
 }

README.md

 ![Reaptcha](https://i.imgur.com/44zEjD5.png)
 
 [![Latest npm version](https://img.shields.io/npm/v/reaptcha/latest.svg)]()
-[![Next npm version](https://img.shields.io/npm/v/reaptcha/next.svg)]()
 [![GitHub license](https://img.shields.io/github/license/sarneeh/reaptcha.svg)](https://github.com/sarneeh/reaptcha)
 [![TravisCI badge](https://travis-ci.com/sarneeh/reaptcha.svg?branch=master)](https://travis-ci.com/)
 [![Coverage Status](https://coveralls.io/repos/github/sarneeh/reaptcha/badge.svg?branch=master)](https://coveralls.io/github/sarneeh/reaptcha?branch=master)
-[![Greenkeeper badge](https://badges.greenkeeper.io/sarneeh/reaptcha.svg)](https://greenkeeper.io/)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
@@ -78,3 +76,3 @@ [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-  onVerify = () => {
+  onVerify = recaptchaResponse => {
     this.setState({
@@ -125,3 +123,3 @@ verified: true
 
-  onVerify = () => {
+  onVerify = recaptchaResponse => {
     // Do something
@@ -170,3 +168,3 @@ };
 
-  onVerify = () => {
+  onVerify = recaptchaResponse => {
     // Do something
@@ -206,3 +204,3 @@ };
     sitekey="YOUR_API_KEY"
-    onVerify={() => {
+    onVerify={recaptchaResponse => {
       // Do something
@@ -262,24 +260,28 @@ }}
 
-| Name      | Required           | Type                                        | Default         | Description                                                                                                                                   |
-| --------- | ------------------ | ------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| id        | :heavy_minus_sign: | `string`                                    | -               | Id for the container element                                                                                                                  |
-| className | :heavy_minus_sign: | `string`                                    | `'g-recaptcha'` | Classname for the container element                                                                                                           |
-| sitekey   | :heavy_plus_sign:  | `string`                                    | -               | Your reCAPTCHA API key                                                                                                                        |
-| theme     | :heavy_minus_sign: | `'light' \| 'dark'`                         | `'light'`       | reCAPTCHA color theme                                                                                                                         |
-| size      | :heavy_minus_sign: | `'compact' \| 'normal' \| 'invisible'`      | `'normal'`      | reCAPTCHA size                                                                                                                                |
-| badge     | :heavy_minus_sign: | `'bottomright' \| 'bottomleft' \| 'inline'` | `'bottomright'` | Position of the reCAPTCHA badge                                                                                                               |
-| tabindex  | :heavy_minus_sign: | `number`                                    | 0               | Tabindex of the challenge                                                                                                                     |
-| explicit  | :heavy_minus_sign: | `boolean`                                   | false           | Allows to explicitly render reCAPTCHA                                                                                                         |
-| inject    | :heavy_minus_sign: | `boolean`                                   | true            | Handle reCAPTCHA script DOM injection automatically                                                                                           |
-| isolated  | :heavy_minus_sign: | `boolean`                                   | false           | For plugin owners to not interfere with existing reCAPTCHA installations on a page                                                            |
-| hl        | :heavy_minus_sign: | `string`                                    | -               | [Language code](https://developers.google.com/recaptcha/docs/language) for reCAPTCHA                                                          |  |
-| onLoad    | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA script sucessfully loads                                                                        |
-| onRender  | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA successfuly renders                                                                             |
-| onVerify  | :heavy_plus_sign:  | `Function`                                  | -               | Callback function executed on user's captcha verification. Returns [user response token](https://developers.google.com/recaptcha/docs/verify) |
-| onExpire  | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA response expires and the user needs to re-verify                                                |
-| onError   | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when reCAPTCHA fails with an error                                                                                 |
-| children  | :heavy_minus_sign: | `Function`                                  | -               | Render function that can be used to get access to instance methods without the need to explicitly use refs                                    |
+| Name      | Required           | Type                                        | Default         | Description                                                                                                                                                      |
+| --------- | ------------------ | ------------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| id        | :heavy_minus_sign: | `string`                                    | -               | Id for the container element                                                                                                                                     |
+| className | :heavy_minus_sign: | `string`                                    | `'g-recaptcha'` | Classname for the container element                                                                                                                              |
+| sitekey   | :heavy_plus_sign:  | `string`                                    | -               | Your reCAPTCHA API key                                                                                                                                           |
+| theme     | :heavy_minus_sign: | `'light' \| 'dark'`                         | `'light'`       | reCAPTCHA color theme                                                                                                                                            |
+| size      | :heavy_minus_sign: | `'compact' \| 'normal' \| 'invisible'`      | `'normal'`      | reCAPTCHA size                                                                                                                                                   |
+| badge     | :heavy_minus_sign: | `'bottomright' \| 'bottomleft' \| 'inline'` | `'bottomright'` | Position of the reCAPTCHA badge                                                                                                                                  |
+| tabindex  | :heavy_minus_sign: | `number`                                    | 0               | Tabindex of the challenge                                                                                                                                        |
+| explicit  | :heavy_minus_sign: | `boolean`                                   | false           | Allows to explicitly render reCAPTCHA                                                                                                                            |
+| inject    | :heavy_minus_sign: | `boolean`                                   | true            | Handle reCAPTCHA script DOM injection automatically                                                                                                              |
+| isolated  | :heavy_minus_sign: | `boolean`                                   | false           | For plugin owners to not interfere with existing reCAPTCHA installations on a page                                                                               |
+| hl        | :heavy_minus_sign: | `string`                                    | -               | [Language code](https://developers.google.com/recaptcha/docs/language) for reCAPTCHA                                                                             |  |
+| onLoad    | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA script sucessfully loads                                                                                           |
+| onRender  | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA successfuly renders                                                                                                |
+| onVerify  | :heavy_plus_sign:  | `Function`                                  | -               | Callback function executed on user's captcha verification. It's being called with the [user response token](https://developers.google.com/recaptcha/docs/verify) |
+| onExpire  | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when the reCAPTCHA response expires and the user needs to re-verify                                                                   |
+| onError   | :heavy_minus_sign: | `Function`                                  | -               | Callback function executed when reCAPTCHA fails with an error                                                                                                    |
+| children  | :heavy_minus_sign: | `Function`                                  | -               | Render function that can be used to get access to instance methods without the need to explicitly use refs                                                       |
 
 ## Caveats
 
+### Array.from
+
+This library is using `Array.from` which is [not supported by few browsers](https://developer.mozilla.org/pl/docs/Web/JavaScript/Referencje/Obiekty/Array/from) i.e. Internet Explorer or Opera. If you want to use `reaptcha` and keep supporting these browsers, you need to use a polyfill for it.
+
 ### Size-specific props
@@ -286,0 +288,0 @@

No alert changes

Improved metrics

Total package byte prevSize

47793

2.15%

Lines of code

670

6.18%

Number of lines in readme file

298

0.68%

Worsened metrics

Number of package files

6

-14.29%

No dependency changes