greip.js 2.3.4 → 2.4.0

package/README.md

@@ -16,11 +16,11 @@ The official Javascript package of Greip API
 
 [![npm version](https://badge.fury.io/js/greip.js.svg)](https://badge.fury.io/js/greip.js)
   
-![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/gre-dev/javascript?color=green&label=Minified%20size&logo=github)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Greipio/javascript?color=green&label=Minified%20size&logo=github)
   
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/license/apache-2-0)
   
-![API Status](https://img.shields.io/website?down_color=orange&down_message=down&label=API%20status&up_color=green&up_message=up&url=https%3A%2F%2Fgregeoip.com)
+![API Status](https://img.shields.io/website?down_color=orange&down_message=down&label=API%20status&up_color=green&up_message=up&url=https%3A%2F%greipapi.com)
 
 ---
 
@@ -104,7 +104,24 @@ await GeoIP({
   });
 ```
 
-### 2. IP Lookup Method
+### 2. IP Threats Method
+
+Use this method to retrieve threat intelligence information associated with a given IP address.
+
+```javascript
+await Threats({
+  key: 'your-api-key',
+  ip: '1.1.1.1',
+})
+  .then((res: any) => {
+    console.log(res.data); // Log Response
+  })
+  .catch((error: any) => {
+    console.log(error);
+  });
+```
+
+### 3. IP Lookup Method
 
 Use this method to retrieve the information of a given IP address.
 
@@ -121,7 +138,7 @@ await Lookup({
   });
 ```
 
-### 3. Bulk IP Lookup Method
+### 4. Bulk IP Lookup Method
 
 You can use this method to retrieve the information of multiple IP addresses (no need to use the `Lookup` method inside a loop).
 
@@ -138,7 +155,7 @@ await BulkLookup({
   });
 ```
 
-### 4. ASN Lookup Method
+### 5. ASN Lookup Method
 
 In this method, Greip will help you lookup any given AS Number and returning all data related to it, like: name, org (the organization name), country, domain, email, phone, totalIPs, list of all routes (v4 & v6) related the given AS Number, etc.
 
@@ -155,7 +172,7 @@ await ASN({
   });
 ```
 
-### 5. Profanity Detection Method
+### 6. Profanity Detection Method
 
 This method can be used to detect abuse of your website/app. It’s a great way to know more about your user inputs and whether they contain profanity (bad words) or not before releasing them to the public.
 
@@ -172,7 +189,7 @@ await BadWord({
   });
 ```
 
-### 6. Country Lookup Method
+### 7. Country Lookup Method
 
 This method can help you retrieve information of the given country.
 
@@ -189,7 +206,7 @@ await Country({
   });
 ```
 
-### 7. Email Validation Method
+### 8. Email Validation Method
 
 This method provides an additional layer of validation for your system. While validating email syntax is important, it is not sufficient.
 
@@ -208,7 +225,7 @@ await EmailValidation({
   });
 ```
 
-### 8. Phone Validation Method
+### 9. Phone Validation Method
 
 This method can be used as an extra-layer of your system for validating phone numbers. It validates phone number syntax and valid-possibility.
 
@@ -226,7 +243,7 @@ await PhoneValidation({
   });
 ```
 
-### 9. Payment Fraud Prevention Method
+### 10. Payment Fraud Prevention Method
 
 Prevent financial losses by deploying AI-Powered modules.
 
@@ -303,7 +320,7 @@ await PaymentFraud({
   });
 ```
 
-### 10. IBAN Validation Method
+### 11. IBAN Validation Method
 
 This method allows you to validate International Bank Account Numbers (IBANs) and retrieve additional information about the country associated with the IBAN.
 

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { Options } from './types';
 export declare const GeoIP: (options: Options) => Promise<unknown>;
 export declare const Lookup: (options: Options) => Promise<unknown>;
+export declare const Threats: (options: Options) => Promise<unknown>;
 export declare const BulkLookup: (options: Options) => Promise<unknown>;
 export declare const Country: (options: Options) => Promise<unknown>;
 export declare const BadWord: (options: Options) => Promise<unknown>;

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IBANValidation = exports.PhoneValidation = exports.PaymentFraud = exports.EmailValidation = exports.ASN = exports.BadWord = exports.Country = exports.BulkLookup = exports.Lookup = exports.GeoIP = void 0;
+exports.IBANValidation = exports.PhoneValidation = exports.PaymentFraud = exports.EmailValidation = exports.ASN = exports.BadWord = exports.Country = exports.BulkLookup = exports.Threats = exports.Lookup = exports.GeoIP = void 0;
 var util_1 = require("./util");
 var GeoIP = function (options) {
     if (typeof options !== 'object')
@@ -116,6 +116,45 @@ var Lookup = function (options) {
     });
 };
 exports.Lookup = Lookup;
+var Threats = function (options) {
+    if (typeof options !== 'object')
+        options = {};
+    if (!options.key || options.key.length < 1) {
+        throw new Error('You should pass the API Key.');
+    }
+    return new Promise(function (resolve, reject) {
+        var ip1 = options.ip || '';
+        var format1 = options.format || 'JSON';
+        var mode1 = options.mode || 'live';
+        // Validate the ip variable
+        if (ip1.length < 7) {
+            reject(new Error('You should pass the `ip` parameter.'));
+        }
+        // Validate the format variable
+        if (!util_1.availableFormats.includes(format1)) {
+            reject(new Error('The `format` option value "' +
+                format1 +
+                '" you specified is unknown.\nYou can use: `JSON`, `XML`, `CSV` or `Newline`.\nRead more at: https://docs.greip.io/api-reference/endpoint/ip-geolocation/ip-lookup'));
+        }
+        // Validate the mode variable
+        if (mode1 !== 'live' && mode1 !== 'test') {
+            reject(new Error('The `mode` option value "' +
+                mode1 +
+                '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/ip-geolocation/ip-lookup'));
+        }
+        (0, util_1.makeHttpRquest)('threats', {
+            ip: ip1,
+            key: options.key,
+            format: format1,
+            mode: mode1,
+        }, function (res) {
+            if (typeof res !== 'object')
+                res = JSON.parse(res);
+            resolve(res);
+        });
+    });
+};
+exports.Threats = Threats;
 var BulkLookup = function (options) {
     if (typeof options !== 'object')
         options = {};

package/lib/util.d.ts

@@ -1,4 +1,4 @@
-export declare const baseURL = "https://gregeoip.com/";
+export declare const baseURL = "https://greipapi.com/";
 export declare const availableGeoIPParams: string[];
 export declare const availableLanguages: string[];
 export declare const availableFormats: string[];

package/lib/util.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makePostRquest = exports.makeHttpRquest = exports.serialize = exports.availableCountryParams = exports.availableFormats = exports.availableLanguages = exports.availableGeoIPParams = exports.baseURL = void 0;
 var axios_1 = require("axios");
-exports.baseURL = 'https://gregeoip.com/';
+exports.baseURL = 'https://greipapi.com/';
 exports.availableGeoIPParams = ['location', 'security', 'timezone', 'currency', 'device'];
 exports.availableLanguages = ['EN', 'AR', 'DE', 'FR', 'ES', 'JA', 'ZH', 'RU'];
 exports.availableFormats = ['JSON', 'XML', 'CSV', 'Newline'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "greip.js",
-  "version": "2.3.4",
+  "version": "2.4.0",
   "description": "The official Javascript library of Greip.",
   "author": {
     "name": "Greip",