v0.1.0

Author: randoum

.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    "@babel/preset-env"
+  ],
+  "plugins": [
+    ["@babel/plugin-proposal-class-properties"],
+    ["@babel/plugin-transform-async-to-generator"]
+  ]
+}

.github/workflows/unittest.yml

@@ -0,0 +1,27 @@
+name: Unit test
+
+on: [push, pull_request]
+
+jobs:
+  unit_test:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-18.04, windows-2016 ]
+        node-version: [10.x, 12.x, 14.x, 15.x]
+
+    env:
+      EMAIL_VALIDATION_API_KEY: ${{ secrets.API_KEY }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Run test
+      run: |
+        npm install
+        npm run test

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Abstract
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,121 @@
+# AbstractAPI javascript-phone-validation library
+
+Integrate the powerful [Phone Validation API from Abstract](https://www.abstractapi.com/phone-validation-api) in your Javascript or NodeJS project in a few lines of code.
+
+Abstract's Phone Number Validation and Verification API is a fast, lightweight, modern, and RESTful JSON API for determining the validity and other details of phone numbers from over 190 countries.
+
+It's very simple to use: you only need to submit your API key and a phone number, and the API will respond as assessment of its validity, as well as additional details like the carrier details, line type, region and city details, and more.
+
+Validating and verifying phone numbers is a critical step to reducing the chances of low quality data and fraudulent or risky users in your website or application.
+
+# Documentation
+
+## Installation
+
+You can install **javascript-phone-validation** via npm, from our CDN, or download the source into your project.
+
+### ES6
+
+Download and install the library from npm:
+
+```
+npm install javascript-phone-validation --save
+```
+
+In your project, import it and configure your `API_KEY`:
+
+```js
+import {AbstractPhoneValidation} from 'javascript-phone-validation'
+
+AbstractPhoneValidation.configure('API_KEY')
+```
+
+### Browser, from the built file
+
+You can build the library yourself, or get the already built file from the `dist` directory and load it:
+
+```js
+<script src="dist/javascript-phone-validation.js"></script>
+<script>
+    AbstractPhoneValidation.configure('API_KEY');
+
+    // use the library
+</script>
+```
+
+## API key
+
+Get your API key for free and without hassle from the [Abstact website](https://app.abstractapi.com/users/signup?target=/api/phone-validation/pricing/select).
+
+## Quickstart
+
+AbstractAPI **javascript-phone-validation** library returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) so you can use one of the following approaches:
+
+### Async/Await
+
+```js
+async function validatePhone(number) {
+  let response = await AbstractPhoneValidation.verify(number);
+  console.log(response);
+}
+```
+
+### Using .then()
+
+```js
+function validatePhone(number) {
+  AbstractPhoneValidation.verify(number)
+    .then(response => {
+      console.log(response);
+    })
+}
+```
+
+## API response
+
+The API response is returned in a `IpGeolocationData` object.
+
+| PARAMETER | TYPE | DETAILS |
+| - | - | - |
+| number | String | The phone number submitted for validation and verification. |
+| valid | Boolean | Is true if the phone number submitted is valid. |
+| local_format | String | The local or national format of the submitted phone number. For example, it removes any international formatting, such as "+1" in the case of the US. |
+| international_format | String | The international format of the submitted phone number. This means appending the phone number's country code and a "+" at the beginning. |
+| country_name | String | The name of the country in which the phone number is registered. |
+| country_code | String | The country's two letter ISO 3166-1 alpha-2 code. |
+| country_prefix | The country's calling code prefix. |
+| registered_location | String | As much location details as are available from our data. This can include the region, state / province, and in some cases down to the city. |
+| carrier | String | The carrier that the number is registered with. |
+| line_type | String | The type of phone number. The possible values are: Landline, Mobile, Satellite, Premium, Paging, Special, Toll_Free, and Unknown. |
+
+## Detailed documentation
+
+You will find additional information and request examples in the [Abstract help page](https://app.abstractapi.com/api/phone-validation/documentation).
+
+## Getting help
+
+If you need help installing or using the library, please contact [Abstract's Support](https://app.abstractapi.com/api/phone-validation/support).
+
+For bug report and feature suggestion, please use [this repository issues page](https://github.com/abstractapi/javascript-phone-validation/issues).
+
+# Contribution
+
+Contributions are always welcome, as they improve the quality of the libraries we provide to the community.
+
+Please provide your changes covered by the appropriate unit tests, and post them in the [pull requests page](https://github.com/abstractapi/javascript-phone-validation/pulls).
+
+## NPM
+
+### Installation
+
+Run `npm install` in the command line to install the dependencies. To update those dependencies you need to run `npm update`.
+
+### Building
+
+To build the library and generate the minified file in the *dist* directory, you need to run `npm run build`.
+
+To build the lib, you need to run `npm run build:lib`.
+
+### Test
+
+To run the test suite, you need to run: `npm run test`.

dist/javascript-phone-validation.js

@@ -0,0 +1 @@
+module.exports = require('./lib/index');

index.js

@@ -0,0 +1,38 @@
+"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); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AbstractPhoneValidation = void 0;
+
+var core = _interopRequireWildcard(require("javascript-core"));
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+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 AbstractPhoneValidation = function AbstractPhoneValidation() {
+  _classCallCheck(this, AbstractPhoneValidation);
+};
+
+exports.AbstractPhoneValidation = AbstractPhoneValidation;
+
+_defineProperty(AbstractPhoneValidation, "apiKey", void 0);
+
+_defineProperty(AbstractPhoneValidation, "configure", function (apiKey) {
+  AbstractPhoneValidation.apiKey = apiKey;
+});
+
+_defineProperty(AbstractPhoneValidation, "verify", function (phone) {
+  if (!phone) {
+    throw new Error('Phone is not provided.');
+  }
+
+  return core.makeApiCall('phonevalidation', AbstractPhoneValidation.apiKey, "phone=".concat(phone));
+});