greip.js 2.3.2 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -21
- package/README.md +99 -35
- package/lib/index.d.ts +1 -0
- package/lib/index.js +40 -1
- package/lib/util.d.ts +1 -1
- package/lib/util.js +5 -5
- package/package.json +9 -5
package/LICENSE
CHANGED
|
@@ -1,21 +1,201 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -12,20 +12,21 @@ The official Javascript package of Greip API
|
|
|
12
12
|
|
|
13
13
|
[](https://www.npmjs.com/package/greip.js)
|
|
14
14
|
[](https://github.com/Greipio/javascript)
|
|
15
|
+
[](https://cdn.jsdelivr.net/gh/Greipio/javascript/greip.bundle.js)
|
|
15
16
|
|
|
16
17
|
[](https://badge.fury.io/js/greip.js)
|
|
17
18
|
|
|
18
|
-

|
|
19
20
|
|
|
20
|
-
[](https://opensource.org/license/apache-2-0)
|
|
21
22
|
|
|
22
|
-

|
|
23
24
|
|
|
24
25
|
---
|
|
25
26
|
|
|
26
27
|
## Installation
|
|
27
28
|
|
|
28
|
-
|
|
29
|
+
### 1. For React.js, React Native, etc:
|
|
29
30
|
|
|
30
31
|
```
|
|
31
32
|
npm i greip.js --save
|
|
@@ -37,15 +38,61 @@ or
|
|
|
37
38
|
yarn add greip.js
|
|
38
39
|
```
|
|
39
40
|
|
|
41
|
+
### 2. For CDN Integration
|
|
42
|
+
|
|
43
|
+
```html
|
|
44
|
+
<script src="https://cdn.jsdelivr.net/gh/Greipio/javascript/greip.bundle.js" type="text/javascript" />
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 3. For Node.js
|
|
48
|
+
|
|
49
|
+
Please use our [Node.js library](https://github.com/Greipio/node) instead.
|
|
50
|
+
|
|
51
|
+
## Initializing the Greip object
|
|
52
|
+
|
|
53
|
+
There're two different ways to initialize the Greip object, let's dive into this:
|
|
54
|
+
|
|
55
|
+
### 1. For React.js, React Native, etc:
|
|
56
|
+
|
|
57
|
+
```javascript
|
|
58
|
+
import {
|
|
59
|
+
Lookup,
|
|
60
|
+
GeoIP,
|
|
61
|
+
BulkLookup,
|
|
62
|
+
ASN,
|
|
63
|
+
BadWord,
|
|
64
|
+
Country,
|
|
65
|
+
EmailValidation,
|
|
66
|
+
PhoneValidation,
|
|
67
|
+
PaymentFraud,
|
|
68
|
+
IBANValidation,
|
|
69
|
+
} from 'greip.js';
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 2. CDN Integration
|
|
73
|
+
|
|
74
|
+
In CDN integration, you already have `Greip` as a global variable initialized automatically when the page loads.
|
|
75
|
+
|
|
76
|
+
You can start using it directly as follows:
|
|
77
|
+
|
|
78
|
+
```javascript
|
|
79
|
+
Greip.GeoIP({
|
|
80
|
+
key: 'your-api-key',
|
|
81
|
+
// other options here
|
|
82
|
+
}).then((response) => {
|
|
83
|
+
console.log(response);
|
|
84
|
+
});
|
|
85
|
+
```
|
|
86
|
+
|
|
40
87
|
## Usage
|
|
41
88
|
|
|
42
89
|
Here's how you use the API Methods:
|
|
43
90
|
|
|
44
91
|
### 1. IP Geolocation Method
|
|
45
92
|
|
|
46
|
-
|
|
47
|
-
import { GeoIP } from 'greip.js';
|
|
93
|
+
Use this method to retrieve the IP address of the visitor/user with its full information.
|
|
48
94
|
|
|
95
|
+
```javascript
|
|
49
96
|
await GeoIP({
|
|
50
97
|
key: 'your-api-key',
|
|
51
98
|
})
|
|
@@ -57,11 +104,28 @@ await GeoIP({
|
|
|
57
104
|
});
|
|
58
105
|
```
|
|
59
106
|
|
|
60
|
-
### 2. IP
|
|
107
|
+
### 2. IP Threats Method
|
|
108
|
+
|
|
109
|
+
Use this method to retrieve threat intelligence information associated with a given IP address.
|
|
61
110
|
|
|
62
111
|
```javascript
|
|
63
|
-
|
|
112
|
+
await Threats({
|
|
113
|
+
key: 'your-api-key',
|
|
114
|
+
ip: '1.1.1.1',
|
|
115
|
+
})
|
|
116
|
+
.then((res: any) => {
|
|
117
|
+
console.log(res.data); // Log Response
|
|
118
|
+
})
|
|
119
|
+
.catch((error: any) => {
|
|
120
|
+
console.log(error);
|
|
121
|
+
});
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 3. IP Lookup Method
|
|
125
|
+
|
|
126
|
+
Use this method to retrieve the information of a given IP address.
|
|
64
127
|
|
|
128
|
+
```javascript
|
|
65
129
|
await Lookup({
|
|
66
130
|
key: 'your-api-key',
|
|
67
131
|
ip: '1.1.1.1',
|
|
@@ -74,11 +138,11 @@ await Lookup({
|
|
|
74
138
|
});
|
|
75
139
|
```
|
|
76
140
|
|
|
77
|
-
###
|
|
141
|
+
### 4. Bulk IP Lookup Method
|
|
78
142
|
|
|
79
|
-
|
|
80
|
-
import { BulkLookup } from 'greip.js';
|
|
143
|
+
You can use this method to retrieve the information of multiple IP addresses (no need to use the `Lookup` method inside a loop).
|
|
81
144
|
|
|
145
|
+
```javascript
|
|
82
146
|
await BulkLookup({
|
|
83
147
|
key: 'your-api-key',
|
|
84
148
|
ips: ['1.1.1.1', '2.2.2.2'],
|
|
@@ -91,11 +155,11 @@ await BulkLookup({
|
|
|
91
155
|
});
|
|
92
156
|
```
|
|
93
157
|
|
|
94
|
-
###
|
|
158
|
+
### 5. ASN Lookup Method
|
|
95
159
|
|
|
96
|
-
|
|
97
|
-
import { ASN } from 'greip.js';
|
|
160
|
+
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.
|
|
98
161
|
|
|
162
|
+
```javascript
|
|
99
163
|
await ASN({
|
|
100
164
|
key: 'your-api-key',
|
|
101
165
|
asn: 'AS01',
|
|
@@ -108,11 +172,11 @@ await ASN({
|
|
|
108
172
|
});
|
|
109
173
|
```
|
|
110
174
|
|
|
111
|
-
###
|
|
175
|
+
### 6. Profanity Detection Method
|
|
112
176
|
|
|
113
|
-
|
|
114
|
-
import { BadWord } from 'greip.js';
|
|
177
|
+
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.
|
|
115
178
|
|
|
179
|
+
```javascript
|
|
116
180
|
await BadWord({
|
|
117
181
|
key: 'your-api-key',
|
|
118
182
|
text: 'This is just normal sample text.',
|
|
@@ -125,11 +189,11 @@ await BadWord({
|
|
|
125
189
|
});
|
|
126
190
|
```
|
|
127
191
|
|
|
128
|
-
###
|
|
192
|
+
### 7. Country Lookup Method
|
|
129
193
|
|
|
130
|
-
|
|
131
|
-
import { Country } from 'greip.js';
|
|
194
|
+
This method can help you retrieve information of the given country.
|
|
132
195
|
|
|
196
|
+
```javascript
|
|
133
197
|
await Country({
|
|
134
198
|
key: 'your-api-key',
|
|
135
199
|
countryCode: 'SA',
|
|
@@ -142,11 +206,13 @@ await Country({
|
|
|
142
206
|
});
|
|
143
207
|
```
|
|
144
208
|
|
|
145
|
-
###
|
|
209
|
+
### 8. Email Validation Method
|
|
146
210
|
|
|
147
|
-
|
|
148
|
-
import { EmailValidation } from 'greip.js';
|
|
211
|
+
This method provides an additional layer of validation for your system. While validating email syntax is important, it is not sufficient.
|
|
149
212
|
|
|
213
|
+
This method goes beyond syntax validation by checking the domain’s validity, the availability of the Mail Service, detecting Disposable Email (Temporary Emails), etc. By utilising this method, you can ensure a more thorough validation process for email addresses.
|
|
214
|
+
|
|
215
|
+
```javascript
|
|
150
216
|
await EmailValidation({
|
|
151
217
|
key: 'your-api-key',
|
|
152
218
|
email: 'name@domain.com',
|
|
@@ -159,11 +225,11 @@ await EmailValidation({
|
|
|
159
225
|
});
|
|
160
226
|
```
|
|
161
227
|
|
|
162
|
-
###
|
|
228
|
+
### 9. Phone Validation Method
|
|
163
229
|
|
|
164
|
-
|
|
165
|
-
import { PhoneValidation } from 'greip.js';
|
|
230
|
+
This method can be used as an extra-layer of your system for validating phone numbers. It validates phone number syntax and valid-possibility.
|
|
166
231
|
|
|
232
|
+
```javascript
|
|
167
233
|
await PhoneValidation({
|
|
168
234
|
key: 'your-api-key',
|
|
169
235
|
phone: '123123123',
|
|
@@ -177,11 +243,11 @@ await PhoneValidation({
|
|
|
177
243
|
});
|
|
178
244
|
```
|
|
179
245
|
|
|
180
|
-
###
|
|
246
|
+
### 10. Payment Fraud Prevention Method
|
|
181
247
|
|
|
182
|
-
|
|
183
|
-
import { PaymentFraud } from 'greip.js';
|
|
248
|
+
Prevent financial losses by deploying AI-Powered modules.
|
|
184
249
|
|
|
250
|
+
```javascript
|
|
185
251
|
await PaymentFraud({
|
|
186
252
|
key: 'your-api-key',
|
|
187
253
|
data: {
|
|
@@ -254,7 +320,9 @@ await PaymentFraud({
|
|
|
254
320
|
});
|
|
255
321
|
```
|
|
256
322
|
|
|
257
|
-
###
|
|
323
|
+
### 11. IBAN Validation Method
|
|
324
|
+
|
|
325
|
+
This method allows you to validate International Bank Account Numbers (IBANs) and retrieve additional information about the country associated with the IBAN.
|
|
258
326
|
|
|
259
327
|
```javascript
|
|
260
328
|
await IBANValidation({
|
|
@@ -271,13 +339,9 @@ await IBANValidation({
|
|
|
271
339
|
|
|
272
340
|
## Options, Methods and More
|
|
273
341
|
|
|
274
|
-
You can find the full guide of this package by visiting our [
|
|
342
|
+
You can find the full guide of this package by visiting our [documentation page](https://docs.greip.io/).
|
|
275
343
|
|
|
276
344
|
## Credits
|
|
277
345
|
|
|
278
346
|
- [Greip Developers](https://greip.io)
|
|
279
347
|
- [All Contributors](https://github.com/Greipio/javascript/graphs/contributors)
|
|
280
|
-
|
|
281
|
-
## License
|
|
282
|
-
|
|
283
|
-
The MIT License (MIT). Please see [License](https://github.com/Greipio/javascript/blob/main/LICENSE) File for more information.
|
package/lib/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Options } from './types';
|
|
2
2
|
export declare const GeoIP: (options: Options) => Promise<unknown>;
|
|
3
3
|
export declare const Lookup: (options: Options) => Promise<unknown>;
|
|
4
|
+
export declare const Threats: (options: Options) => Promise<unknown>;
|
|
4
5
|
export declare const BulkLookup: (options: Options) => Promise<unknown>;
|
|
5
6
|
export declare const Country: (options: Options) => Promise<unknown>;
|
|
6
7
|
export declare const BadWord: (options: Options) => Promise<unknown>;
|
package/lib/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.IBANValidation = exports.PhoneValidation = exports.PaymentFraud = exports.EmailValidation = exports.ASN = exports.BadWord = exports.Country = exports.BulkLookup = exports.Lookup = exports.GeoIP = void 0;
|
|
3
|
+
exports.IBANValidation = exports.PhoneValidation = exports.PaymentFraud = exports.EmailValidation = exports.ASN = exports.BadWord = exports.Country = exports.BulkLookup = exports.Threats = exports.Lookup = exports.GeoIP = void 0;
|
|
4
4
|
var util_1 = require("./util");
|
|
5
5
|
var GeoIP = function (options) {
|
|
6
6
|
if (typeof options !== 'object')
|
|
@@ -116,6 +116,45 @@ var Lookup = function (options) {
|
|
|
116
116
|
});
|
|
117
117
|
};
|
|
118
118
|
exports.Lookup = Lookup;
|
|
119
|
+
var Threats = function (options) {
|
|
120
|
+
if (typeof options !== 'object')
|
|
121
|
+
options = {};
|
|
122
|
+
if (!options.key || options.key.length < 1) {
|
|
123
|
+
throw new Error('You should pass the API Key.');
|
|
124
|
+
}
|
|
125
|
+
return new Promise(function (resolve, reject) {
|
|
126
|
+
var ip1 = options.ip || '';
|
|
127
|
+
var format1 = options.format || 'JSON';
|
|
128
|
+
var mode1 = options.mode || 'live';
|
|
129
|
+
// Validate the ip variable
|
|
130
|
+
if (ip1.length < 7) {
|
|
131
|
+
reject(new Error('You should pass the `ip` parameter.'));
|
|
132
|
+
}
|
|
133
|
+
// Validate the format variable
|
|
134
|
+
if (!util_1.availableFormats.includes(format1)) {
|
|
135
|
+
reject(new Error('The `format` option value "' +
|
|
136
|
+
format1 +
|
|
137
|
+
'" 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'));
|
|
138
|
+
}
|
|
139
|
+
// Validate the mode variable
|
|
140
|
+
if (mode1 !== 'live' && mode1 !== 'test') {
|
|
141
|
+
reject(new Error('The `mode` option value "' +
|
|
142
|
+
mode1 +
|
|
143
|
+
'" you specified is unknown.\nYou can use: `live` or `test`.\nRead more at: https://docs.greip.io/api-reference/endpoint/ip-geolocation/ip-lookup'));
|
|
144
|
+
}
|
|
145
|
+
(0, util_1.makeHttpRquest)('threats', {
|
|
146
|
+
ip: ip1,
|
|
147
|
+
key: options.key,
|
|
148
|
+
format: format1,
|
|
149
|
+
mode: mode1,
|
|
150
|
+
}, function (res) {
|
|
151
|
+
if (typeof res !== 'object')
|
|
152
|
+
res = JSON.parse(res);
|
|
153
|
+
resolve(res);
|
|
154
|
+
});
|
|
155
|
+
});
|
|
156
|
+
};
|
|
157
|
+
exports.Threats = Threats;
|
|
119
158
|
var BulkLookup = function (options) {
|
|
120
159
|
if (typeof options !== 'object')
|
|
121
160
|
options = {};
|
package/lib/util.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const baseURL = "https://
|
|
1
|
+
export declare const baseURL = "https://greipapi.com/";
|
|
2
2
|
export declare const availableGeoIPParams: string[];
|
|
3
3
|
export declare const availableLanguages: string[];
|
|
4
4
|
export declare const availableFormats: string[];
|
package/lib/util.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.makePostRquest = exports.makeHttpRquest = exports.serialize = exports.availableCountryParams = exports.availableFormats = exports.availableLanguages = exports.availableGeoIPParams = exports.baseURL = void 0;
|
|
4
4
|
var axios_1 = require("axios");
|
|
5
|
-
exports.baseURL = 'https://
|
|
5
|
+
exports.baseURL = 'https://greipapi.com/';
|
|
6
6
|
exports.availableGeoIPParams = ['location', 'security', 'timezone', 'currency', 'device'];
|
|
7
7
|
exports.availableLanguages = ['EN', 'AR', 'DE', 'FR', 'ES', 'JA', 'ZH', 'RU'];
|
|
8
8
|
exports.availableFormats = ['JSON', 'XML', 'CSV', 'Newline'];
|
|
@@ -25,11 +25,11 @@ var makeHttpRquest = function (endpoint, options, callback) {
|
|
|
25
25
|
callback(response.data);
|
|
26
26
|
}
|
|
27
27
|
else {
|
|
28
|
-
throw new Error('An unknown error occurred while sending the request to
|
|
28
|
+
throw new Error('An unknown error occurred while sending the request to Greip API.');
|
|
29
29
|
}
|
|
30
30
|
})
|
|
31
31
|
.catch(function (error) {
|
|
32
|
-
throw new Error('An unknown error occurred while sending the request to
|
|
32
|
+
throw new Error('An unknown error occurred while sending the request to Greip API.');
|
|
33
33
|
});
|
|
34
34
|
};
|
|
35
35
|
exports.makeHttpRquest = makeHttpRquest;
|
|
@@ -42,11 +42,11 @@ var makePostRquest = function (endpoint, options, callback) {
|
|
|
42
42
|
callback(response.data);
|
|
43
43
|
}
|
|
44
44
|
else {
|
|
45
|
-
throw new Error('An unknown error occurred while sending the request to
|
|
45
|
+
throw new Error('An unknown error occurred while sending the request to Greip API.');
|
|
46
46
|
}
|
|
47
47
|
})
|
|
48
48
|
.catch(function (error) {
|
|
49
|
-
throw new Error('An unknown error occurred while sending the request to
|
|
49
|
+
throw new Error('An unknown error occurred while sending the request to Greip API.');
|
|
50
50
|
});
|
|
51
51
|
};
|
|
52
52
|
exports.makePostRquest = makePostRquest;
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "greip.js",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.0",
|
|
4
4
|
"description": "The official Javascript library of Greip.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Greip",
|
|
7
7
|
"email": "info@greip.io",
|
|
8
8
|
"url": "https://greip.io"
|
|
9
9
|
},
|
|
10
|
-
"license": "
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
11
|
"main": "lib/index.d.ts",
|
|
12
12
|
"types": "lib/index.d.ts",
|
|
13
13
|
"keywords": [
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
},
|
|
36
36
|
"scripts": {
|
|
37
37
|
"test": "jest --config jestconfig.json",
|
|
38
|
-
"build": "tsc",
|
|
38
|
+
"build": "tsc && webpack",
|
|
39
39
|
"format": "prettier --write \"src/**/*.ts\"",
|
|
40
40
|
"lint": "tslint -p tsconfig.json",
|
|
41
41
|
"prepare": "npm run build",
|
|
@@ -49,15 +49,19 @@
|
|
|
49
49
|
"url": "https://github.com/Greipio/javascript.git"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"axios": "^
|
|
52
|
+
"axios": "^1.6.7"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@types/jest": "^29.2.4",
|
|
56
|
+
"@types/node": "^20.11.25",
|
|
56
57
|
"jest": "^29.3.1",
|
|
57
58
|
"prettier": "^2.8.1",
|
|
58
59
|
"ts-jest": "^29.0.3",
|
|
60
|
+
"ts-loader": "^9.5.1",
|
|
59
61
|
"tslint": "^6.1.3",
|
|
60
62
|
"tslint-config-prettier": "^1.18.0",
|
|
61
|
-
"typescript": "^4.9.
|
|
63
|
+
"typescript": "^4.9.5",
|
|
64
|
+
"webpack": "^5.90.3",
|
|
65
|
+
"webpack-cli": "^5.1.4"
|
|
62
66
|
}
|
|
63
67
|
}
|