greip.js 2.4.5 → 2.4.7

package/README.md

@@ -41,7 +41,7 @@ yarn add greip.js
 ### 2. For CDN Integration
 
 ```html
-<script src="https://cdn.jsdelivr.net/gh/Greipio/javascript/greip.bundle.js" type="text/javascript" />
+<script src="https://cdn.jsdelivr.net/gh/Greipio/javascript/greip.bundle.js" type="text/javascript"></script>
 ```
 
 ### 3. For Node.js
@@ -346,3 +346,7 @@ You can find the full guide of this package by visiting our [documentation page]
 
 - [Greip Developers](https://greip.io)
 - [All Contributors](https://github.com/Greipio/javascript/graphs/contributors)
+
+## Repo Activity
+
+![Alt](https://repobeats.axiom.co/api/embed/db51cf11f87d8fdca78afb81e7711761affa247f.svg "Repobeats analytics image")

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+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>;
+export declare const ASN: (options: Options) => Promise<unknown>;
+export declare const EmailValidation: (options: Options) => Promise<unknown>;
+export declare const PaymentFraud: (options: Options) => Promise<unknown>;
+export declare const PhoneValidation: (options: Options) => Promise<unknown>;
+export declare const IBANValidation: (options: Options) => Promise<unknown>;

package/lib/index.js

@@ -14,6 +14,8 @@ var GeoIP = function (options) {
         var lang1 = options.lang || 'EN';
         var mode1 = options.mode || 'live';
         lang1 = lang1.toUpperCase();
+        // GFP data
+        var gfpData = (0, util_1.getGFP)();
         // Validate the params variable items
         params.forEach(function (perParam) {
             if (perParam.length > 0) {
@@ -42,7 +44,7 @@ var GeoIP = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/ip-geolocation/geoip'));
         }
-        (0, util_1.makeHttpRquest)('GeoIP', {
+        (0, util_1.makeHttpRquest)('/geoip', {
             key: options.key,
             params: params.join(','),
             format: format1,
@@ -52,6 +54,8 @@ var GeoIP = function (options) {
             if (typeof res !== 'object')
                 res = JSON.parse(res);
             resolve(res);
+        }, {
+            gfp: gfpData,
         });
     });
 };
@@ -101,7 +105,7 @@ var Lookup = function (options) {
                 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)('IPLookup', {
+        (0, util_1.makeHttpRquest)('/lookup/ip', {
             ip: ip1,
             key: options.key,
             params: params.join(','),
@@ -142,7 +146,7 @@ var Threats = function (options) {
                 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', {
+        (0, util_1.makeHttpRquest)('/lookup/ip/threats', {
             ip: ip1,
             key: options.key,
             format: format1,
@@ -207,7 +211,7 @@ var BulkLookup = function (options) {
                 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)('BulkLookup', {
+        (0, util_1.makeHttpRquest)('/lookup/ip/bulk', {
             ips: ips1,
             key: options.key,
             params: params.join(','),
@@ -268,7 +272,7 @@ var Country = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/other-services/country-data'));
         }
-        (0, util_1.makeHttpRquest)('Country', {
+        (0, util_1.makeHttpRquest)('/lookup/country', {
             CountryCode: countryCode,
             key: options.key,
             params: params.join(','),
@@ -318,7 +322,7 @@ var BadWord = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/other-services/profanity-detection'));
         }
-        (0, util_1.makeHttpRquest)('badWords', {
+        (0, util_1.makeHttpRquest)('/scoring/profanity', {
             text: text1,
             key: options.key,
             params: params.join(','),
@@ -352,7 +356,7 @@ var ASN = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/ip-geolocation/asn-lookup'));
         }
-        (0, util_1.makeHttpRquest)('ASNLookup', {
+        (0, util_1.makeHttpRquest)('/lookup/asn', {
             asn: asn1,
             key: options.key,
             mode: mode1,
@@ -383,7 +387,7 @@ var EmailValidation = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/data-validation/email-lookup'));
         }
-        (0, util_1.makeHttpRquest)('validateEmail', {
+        (0, util_1.makeHttpRquest)('/scoring/email', {
             email: email1,
             key: options.key,
             mode: mode1,
@@ -446,7 +450,7 @@ var PhoneValidation = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/data-validation/phone-lookup'));
         }
-        (0, util_1.makeHttpRquest)('validatePhone', {
+        (0, util_1.makeHttpRquest)('/scoring/phone', {
             phone: phone1,
             countryCode: countryCode1,
             key: options.key,
@@ -478,7 +482,7 @@ var IBANValidation = function (options) {
                 mode1 +
                 '" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/payment-fraud/iban-validation'));
         }
-        (0, util_1.makeHttpRquest)('validateIBAN', {
+        (0, util_1.makeHttpRquest)('/lookup/iban', {
             iban: iban1,
             key: options.key,
             mode: mode1,

package/lib/types.d.ts

@@ -0,0 +1,19 @@
+export interface Options {
+    ips?: string[];
+    ip?: string;
+    source?: string;
+    key?: string;
+    params?: string[];
+    format?: string;
+    lang?: string;
+    mode?: string;
+    countryCode?: string;
+    text?: string;
+    asn?: string;
+    email?: string;
+    phone?: string;
+    iban?: string;
+    data?: {
+        [key: string]: string | number | string[] | object | boolean;
+    };
+}

package/lib/util.d.ts

@@ -0,0 +1,9 @@
+export declare const baseURL = "https://greipapi.com";
+export declare const availableGeoIPParams: string[];
+export declare const availableLanguages: string[];
+export declare const availableFormats: string[];
+export declare const availableCountryParams: string[];
+export declare const serialize: (obj: any) => string;
+export declare const makeHttpRquest: (endpoint: string, options: any, callback: (data: object) => void, headers?: any) => void;
+export declare const makePostRquest: (endpoint: string, options: any, callback: (data: object) => void) => void;
+export declare const getGFP: () => string | null;

package/lib/util.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePostRquest = exports.makeHttpRquest = exports.serialize = exports.availableCountryParams = exports.availableFormats = exports.availableLanguages = exports.availableGeoIPParams = exports.baseURL = void 0;
+exports.getGFP = 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://greipapi.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'];
@@ -16,10 +16,12 @@ var serialize = function (obj) {
     return str.join('&');
 };
 exports.serialize = serialize;
-var makeHttpRquest = function (endpoint, options, callback) {
+var makeHttpRquest = function (endpoint, options, callback, headers) {
     options.source = 'JS-Package';
     axios_1.default
-        .get(exports.baseURL + '/' + endpoint + '?' + (0, exports.serialize)(options))
+        .get(exports.baseURL + endpoint + '?' + (0, exports.serialize)(options), {
+        headers: headers,
+    })
         .then(function (response) {
         if (response.status === 200) {
             callback(response.data);
@@ -50,3 +52,26 @@ var makePostRquest = function (endpoint, options, callback) {
     });
 };
 exports.makePostRquest = makePostRquest;
+var getGFP = function () {
+    try {
+        var timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        var primaryLanguage = navigator.language;
+        var preferredLanguages = navigator.languages;
+        var screenWidth = window.screen.width;
+        var screenHeight = window.screen.height;
+        var plugins = typeof navigator.plugins !== 'undefined' ? Array.from(navigator.plugins).map(function (plugin) { return plugin.name; }) : null;
+        var gfpData = JSON.stringify({
+            timezone: timezone,
+            primary_language: primaryLanguage,
+            preferred_languages: preferredLanguages,
+            screen_width: screenWidth,
+            screen_height: screenHeight,
+            plugins: plugins,
+        });
+        return gfpData;
+    }
+    catch (error) {
+        return null;
+    }
+};
+exports.getGFP = getGFP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "greip.js",
-  "version": "2.4.5",
+  "version": "2.4.7",
   "description": "The official Javascript library of Greip.",
   "author": {
     "name": "Greip",
@@ -35,7 +35,7 @@
   },
   "scripts": {
     "test": "jest --config jestconfig.json",
-    "build": "tsc --declaration false && webpack",
+    "build": "tsc && webpack",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json",
     "prepare": "npm run build",