vpndetection 5.9.0 → 5.10.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/README.md +8 -7
- package/dist/bogon.d.ts +2 -1
- package/dist/bogon.js +15 -1
- package/dist/bogon.js.map +1 -1
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/sdk.gen.d.ts +5 -5
- package/dist/generated/sdk.gen.js +5 -5
- package/dist/generated/types.gen.d.ts +115 -28
- package/dist/index.d.ts +1 -1
- package/dist/shapes.d.ts +2 -2
- package/dist/shapes.js +2 -2
- package/dist/shapes.js.map +1 -1
- package/dist/types.d.ts +9 -2
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ Requires Node.js 22 or newer. TypeScript types are included.
|
|
|
17
17
|
|
|
18
18
|
## Usage
|
|
19
19
|
|
|
20
|
-
**No API key needed to start.**
|
|
20
|
+
**No API key needed to start.** Without a key, a lookup answers `ip` and `is_vpn`, up to 1000 a day per source address.
|
|
21
21
|
|
|
22
22
|
```js
|
|
23
23
|
import { VPNDetection } from 'vpndetection';
|
|
@@ -30,16 +30,17 @@ console.log(result.isVpn); // true
|
|
|
30
30
|
|
|
31
31
|
### With an API key
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
A free key adds Tor and relay detection, where the address is and the AS that announces it. Every paid plan answers every field, the same on each, and the plans differ only in how many lookups they include. Create a key in the [console](https://app.vpndetection.io), then pass it in:
|
|
34
34
|
|
|
35
35
|
```js
|
|
36
36
|
const client = new VPNDetection({ apiKey: process.env.VPNDETECTION_API_KEY });
|
|
37
37
|
|
|
38
38
|
const result = await client.lookup('45.83.91.1');
|
|
39
|
-
console.log(result.isVpn);
|
|
40
|
-
console.log(result.
|
|
41
|
-
console.log(result.
|
|
42
|
-
console.log(result.
|
|
39
|
+
console.log(result.isVpn); // true
|
|
40
|
+
console.log(result.location?.country); // the ISO 3166 country code
|
|
41
|
+
console.log(result.asn?.name); // who runs the announcing network
|
|
42
|
+
console.log(result.vpn?.provider); // on a paid plan
|
|
43
|
+
console.log(result.isHosting); // on a paid plan
|
|
43
44
|
```
|
|
44
45
|
|
|
45
46
|
### Your own address
|
|
@@ -246,7 +247,7 @@ Each redirect URI must be https on a public host name, or http on a loopback add
|
|
|
246
247
|
|
|
247
248
|
### Absent is not false
|
|
248
249
|
|
|
249
|
-
|
|
250
|
+
Without a key only `ip` and `isVpn` come back, and a free key adds Tor, relay, `location` and `asn`. A field your key does not include is `undefined`, which means "not in your plan" rather than "checked, and no".
|
|
250
251
|
|
|
251
252
|
```js
|
|
252
253
|
result.isHosting ?? false // when you only want the flag
|
package/dist/bogon.d.ts
CHANGED
|
@@ -18,7 +18,8 @@ export declare function isBogon(ip: string): boolean;
|
|
|
18
18
|
export declare function unmapped(ip: string): string;
|
|
19
19
|
/**
|
|
20
20
|
* The answer a bogon gets, in the full shape the API serves at its widest plan:
|
|
21
|
-
* every flag present and false, every detail object present and empty
|
|
21
|
+
* every flag present and false, every detail object present and empty, and
|
|
22
|
+
* `location` and `asn` with every key empty, as the API answers a bogon.
|
|
22
23
|
*
|
|
23
24
|
* `isBogon` is set so a caller can always tell a locally computed answer from a
|
|
24
25
|
* served one. Note this is deliberately the WIDEST shape regardless of your
|
package/dist/bogon.js
CHANGED
|
@@ -36,7 +36,8 @@ export function unmapped(ip) {
|
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
38
|
* The answer a bogon gets, in the full shape the API serves at its widest plan:
|
|
39
|
-
* every flag present and false, every detail object present and empty
|
|
39
|
+
* every flag present and false, every detail object present and empty, and
|
|
40
|
+
* `location` and `asn` with every key empty, as the API answers a bogon.
|
|
40
41
|
*
|
|
41
42
|
* `isBogon` is set so a caller can always tell a locally computed answer from a
|
|
42
43
|
* served one. Note this is deliberately the WIDEST shape regardless of your
|
|
@@ -64,6 +65,19 @@ export function bogonResult(ip) {
|
|
|
64
65
|
dcproxy: {},
|
|
65
66
|
mobproxy: {},
|
|
66
67
|
pubproxy: {},
|
|
68
|
+
location: {
|
|
69
|
+
continent: '',
|
|
70
|
+
continent_name: '',
|
|
71
|
+
country: '',
|
|
72
|
+
country_name: '',
|
|
73
|
+
timezone: '',
|
|
74
|
+
currency_code: '',
|
|
75
|
+
currency_name: '',
|
|
76
|
+
currency_symbol: '',
|
|
77
|
+
flag_emoji: '',
|
|
78
|
+
flag_unicode: '',
|
|
79
|
+
},
|
|
80
|
+
asn: { asn: 0, name: '', domain: '', type: '', prefix: '' },
|
|
67
81
|
raw: {},
|
|
68
82
|
};
|
|
69
83
|
}
|
package/dist/bogon.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bogon.js","sourceRoot":"","sources":["../src/bogon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAIrD;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,EAAU;IAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAU;IAC/B,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QACrC,OAAO,EAAE,CAAC;IACd,CAAC;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC;IAClC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"bogon.js","sourceRoot":"","sources":["../src/bogon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAIrD;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,EAAU;IAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAU;IAC/B,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QACrC,OAAO,EAAE,CAAC;IACd,CAAC;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC;IAClC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,EAAU;IAClC,OAAO;QACH,EAAE,EAAE,EAAE;QACN,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,KAAK;QACjB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,KAAK;QACjB,UAAU,EAAE,KAAK;QACjB,GAAG,EAAE,EAAE;QACP,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;QACP,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE;YACN,SAAS,EAAE,EAAE;YACb,cAAc,EAAE,EAAE;YAClB,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,EAAE;YACjB,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;YACnB,UAAU,EAAE,EAAE;YACd,YAAY,EAAE,EAAE;SACnB;QACD,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QAC3D,GAAG,EAAE,EAAoB;KAC5B,CAAC;AACN,CAAC;AAED,8EAA8E;AAC9E,4EAA4E;AAC5E,uCAAuC;AACvC,IAAI,OAAO,GAA2C,IAAI,CAAC;AAC3D,IAAI,OAAO,GAA2C,IAAI,CAAC;AAE3D,SAAS,EAAE;IACP,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACzB,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAClE,OAAO,EAAE,GAAG,EAAE,CAAE,OAAO,CAAC,GAAG,CAAY,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACxE,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,SAAS,EAAE;IACP,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACzB,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YAC9E,OAAO,EAAE,GAAG,EAAG,OAAO,CAAC,GAAG,CAAY,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AAEjC,SAAS,OAAO,CAAC,EAAU;IACvB,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE,CAAC;QACnB,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,CAAC,CAAC;AACb,CAAC;AAED,2EAA2E;AAC3E,uCAAuC;AACvC,SAAS,OAAO,CAAC,EAAU;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;IACX,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAChD,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACpD,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;IACjD,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,MAAgB,CAAC;IACrB,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;QACb,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAChE,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3C,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACX,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,CAAC,CAAC;AACb,CAAC"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { accountCreateApikey, accountIdentity, accountListApikeys, accountOrg, accountOrgMembers, accountRevealApikey, accountRevokeApikey, accountRotateApikey, databaseChecksum, databaseMetadata, downloadDatabase, listDatabases, listDownloads, lookupBatch, lookupIp, lookupMyIp, myEntitlement, oauthAuthorize, oauthDeviceAuthorization, oauthMetadata, oauthRegister, oauthRevoke, oauthToken, type Options } from './sdk.gen.js';
|
|
2
|
-
export type { AccountCreateApikeyData, AccountCreateApikeyError, AccountCreateApikeyErrors, AccountCreateApikeyRequest, AccountCreateApikeyResponse, AccountCreateApikeyResponses, AccountCreatedApikey, AccountIdentityData, AccountIdentityError, AccountIdentityErrors, AccountIdentityResponse, AccountIdentityResponses, AccountListApikeysData, AccountListApikeysError, AccountListApikeysErrors, AccountListApikeysResponse, AccountListApikeysResponses, AccountOrg, AccountOrgData, AccountOrgError, AccountOrgErrors, AccountOrgMembersData, AccountOrgMembersError, AccountOrgMembersErrors, AccountOrgMembersResponse, AccountOrgMembersResponses, AccountOrgRef, AccountOrgResponse, AccountOrgResponses, AccountOrgWrap, AccountRc, AccountRevealApikeyData, AccountRevealApikeyError, AccountRevealApikeyErrors, AccountRevealApikeyResponse, AccountRevealApikeyResponses, AccountRevealedApikey, AccountRevokeApikeyData, AccountRevokeApikeyError, AccountRevokeApikeyErrors, AccountRevokeApikeyResponse, AccountRevokeApikeyResponses, AccountRotateApikeyData, AccountRotateApikeyError, AccountRotateApikeyErrors, AccountRotateApikeyResponse, AccountRotateApikeyResponses, AccountUser, ApikeyDetail, ApikeyIdParam, ApikeyList, BatchLookupError, BatchLookupRequest, BatchLookupResponse, ClassDetail, ClientOptions, ClientRegistration, ClientRegistrationRequest, Database, DatabaseChecksumData, DatabaseChecksumError, DatabaseChecksumErrors, DatabaseChecksumResponse, DatabaseChecksumResponses, DatabaseFormat, DatabaseFormatSize, DatabaseMetadata, DatabaseMetadataColumn, DatabaseMetadataData, DatabaseMetadataError, DatabaseMetadataErrors, DatabaseMetadataResponse, DatabaseMetadataResponses, DatabaseVersion, DbChecksums, DeviceAuthorization, DeviceAuthorizationRequest, Download, DownloadDatabaseData, DownloadDatabaseError, DownloadDatabaseErrors, Entitlement, EntitlementApikey, EntitlementError, EntitlementPlan, EntitlementUsage, Error, Identity, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListDownloadsData, ListDownloadsError, ListDownloadsErrors, ListDownloadsResponse, ListDownloadsResponses, LookupBatchData, LookupBatchError, LookupBatchErrors, LookupBatchResponse, LookupBatchResponses, LookupError, LookupIpData, LookupIpError, LookupIpErrors, LookupIpResponse, LookupIpResponses, LookupMyIpData, LookupMyIpError, LookupMyIpErrors, LookupMyIpResponse, LookupMyIpResponses, LookupResponse, MyEntitlementData, MyEntitlementError, MyEntitlementErrors, MyEntitlementResponse, MyEntitlementResponses, OauthAuthorizeData, OauthAuthorizeErrors, OauthDeviceAuthorizationData, OauthDeviceAuthorizationError, OauthDeviceAuthorizationErrors, OauthDeviceAuthorizationResponse, OauthDeviceAuthorizationResponses, OauthError, OauthMetadata, OauthMetadataData, OauthMetadataResponse, OauthMetadataResponses, OauthRegisterData, OauthRegisterError, OauthRegisterErrors, OauthRegisterResponse, OauthRegisterResponses, OauthRevokeData, OauthRevokeResponse, OauthRevokeResponses, OauthTokenData, OauthTokenError, OauthTokenErrors, OauthTokenResponse, OauthTokenResponses, ProxyDetail, PubproxyDetail, RevokeRequest, Standing, TokenRequest, TokenResponse, VpnDetail } from './types.gen.js';
|
|
2
|
+
export type { AccountCreateApikeyData, AccountCreateApikeyError, AccountCreateApikeyErrors, AccountCreateApikeyRequest, AccountCreateApikeyResponse, AccountCreateApikeyResponses, AccountCreatedApikey, AccountIdentityData, AccountIdentityError, AccountIdentityErrors, AccountIdentityResponse, AccountIdentityResponses, AccountListApikeysData, AccountListApikeysError, AccountListApikeysErrors, AccountListApikeysResponse, AccountListApikeysResponses, AccountOrg, AccountOrgData, AccountOrgError, AccountOrgErrors, AccountOrgMembersData, AccountOrgMembersError, AccountOrgMembersErrors, AccountOrgMembersResponse, AccountOrgMembersResponses, AccountOrgRef, AccountOrgResponse, AccountOrgResponses, AccountOrgWrap, AccountRc, AccountRevealApikeyData, AccountRevealApikeyError, AccountRevealApikeyErrors, AccountRevealApikeyResponse, AccountRevealApikeyResponses, AccountRevealedApikey, AccountRevokeApikeyData, AccountRevokeApikeyError, AccountRevokeApikeyErrors, AccountRevokeApikeyResponse, AccountRevokeApikeyResponses, AccountRotateApikeyData, AccountRotateApikeyError, AccountRotateApikeyErrors, AccountRotateApikeyResponse, AccountRotateApikeyResponses, AccountUser, ApikeyDetail, ApikeyIdParam, ApikeyList, Asn, BatchLookupError, BatchLookupRequest, BatchLookupResponse, ClassDetail, ClientOptions, ClientRegistration, ClientRegistrationRequest, Database, DatabaseChecksumData, DatabaseChecksumError, DatabaseChecksumErrors, DatabaseChecksumResponse, DatabaseChecksumResponses, DatabaseFormat, DatabaseFormatSize, DatabaseMetadata, DatabaseMetadataColumn, DatabaseMetadataData, DatabaseMetadataError, DatabaseMetadataErrors, DatabaseMetadataResponse, DatabaseMetadataResponses, DatabaseVersion, DbChecksums, DeviceAuthorization, DeviceAuthorizationRequest, Download, DownloadDatabaseData, DownloadDatabaseError, DownloadDatabaseErrors, Entitlement, EntitlementApikey, EntitlementError, EntitlementPlan, EntitlementUsage, Error, Identity, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListDownloadsData, ListDownloadsError, ListDownloadsErrors, ListDownloadsResponse, ListDownloadsResponses, Location, LookupBatchData, LookupBatchError, LookupBatchErrors, LookupBatchResponse, LookupBatchResponses, LookupError, LookupIpData, LookupIpError, LookupIpErrors, LookupIpResponse, LookupIpResponses, LookupMyIpData, LookupMyIpError, LookupMyIpErrors, LookupMyIpResponse, LookupMyIpResponses, LookupResponse, MyEntitlementData, MyEntitlementError, MyEntitlementErrors, MyEntitlementResponse, MyEntitlementResponses, OauthAuthorizeData, OauthAuthorizeErrors, OauthDeviceAuthorizationData, OauthDeviceAuthorizationError, OauthDeviceAuthorizationErrors, OauthDeviceAuthorizationResponse, OauthDeviceAuthorizationResponses, OauthError, OauthMetadata, OauthMetadataData, OauthMetadataResponse, OauthMetadataResponses, OauthRegisterData, OauthRegisterError, OauthRegisterErrors, OauthRegisterResponse, OauthRegisterResponses, OauthRevokeData, OauthRevokeResponse, OauthRevokeResponses, OauthTokenData, OauthTokenError, OauthTokenErrors, OauthTokenResponse, OauthTokenResponses, ProxyDetail, PubproxyDetail, RevokeRequest, Standing, TokenRequest, TokenResponse, VpnDetail } from './types.gen.js';
|
|
@@ -17,8 +17,8 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
17
17
|
* Lookup
|
|
18
18
|
*
|
|
19
19
|
* Answers what is known about a single IPv4 or IPv6 address. Which fields
|
|
20
|
-
* come back is decided by the
|
|
21
|
-
*
|
|
20
|
+
* come back is decided by the presented key; with no key the answer is
|
|
21
|
+
* `ip` and `is_vpn`.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
24
|
export declare const lookupIp: <ThrowOnError extends boolean = false>(options: Options<LookupIpData, ThrowOnError>) => RequestResult<LookupIpResponses, LookupIpErrors, ThrowOnError>;
|
|
@@ -26,9 +26,9 @@ export declare const lookupIp: <ThrowOnError extends boolean = false>(options: O
|
|
|
26
26
|
* My IP
|
|
27
27
|
*
|
|
28
28
|
* Answers what is known about the address this request came from, which is
|
|
29
|
-
* the same answer `GET /{ip}` gives for that address: the
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* the same answer `GET /{ip}` gives for that address: the presented key
|
|
30
|
+
* decides which fields come back, and the request counts against the same
|
|
31
|
+
* allowance.
|
|
32
32
|
*
|
|
33
33
|
* The address is the one our edge observed, so a request through a proxy
|
|
34
34
|
* or a VPN reports the exit it left through rather than the machine that
|
|
@@ -5,8 +5,8 @@ import { urlSearchParamsBodySerializer } from './client/index.js';
|
|
|
5
5
|
* Lookup
|
|
6
6
|
*
|
|
7
7
|
* Answers what is known about a single IPv4 or IPv6 address. Which fields
|
|
8
|
-
* come back is decided by the
|
|
9
|
-
*
|
|
8
|
+
* come back is decided by the presented key; with no key the answer is
|
|
9
|
+
* `ip` and `is_vpn`.
|
|
10
10
|
*
|
|
11
11
|
*/
|
|
12
12
|
export const lookupIp = (options) => (options.client ?? client).get({
|
|
@@ -26,9 +26,9 @@ export const lookupIp = (options) => (options.client ?? client).get({
|
|
|
26
26
|
* My IP
|
|
27
27
|
*
|
|
28
28
|
* Answers what is known about the address this request came from, which is
|
|
29
|
-
* the same answer `GET /{ip}` gives for that address: the
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* the same answer `GET /{ip}` gives for that address: the presented key
|
|
30
|
+
* decides which fields come back, and the request counts against the same
|
|
31
|
+
* allowance.
|
|
32
32
|
*
|
|
33
33
|
* The address is the one our edge observed, so a request through a proxy
|
|
34
34
|
* or a VPN reports the exit it left through rather than the machine that
|
|
@@ -21,76 +21,78 @@ export type LookupResponse = {
|
|
|
21
21
|
*/
|
|
22
22
|
is_vpn: boolean;
|
|
23
23
|
/**
|
|
24
|
-
* Whether the address belongs to a hosting or cloud provider.
|
|
24
|
+
* Whether the address belongs to a hosting or cloud provider. Paid plans.
|
|
25
25
|
*/
|
|
26
26
|
is_hosting?: boolean;
|
|
27
27
|
/**
|
|
28
|
-
* Whether the address is privacy relay or enterprise web gateway egress, such as iCloud Private Relay or Zscaler.
|
|
28
|
+
* Whether the address is privacy relay or enterprise web gateway egress, such as iCloud Private Relay or Zscaler. Free and paid plans.
|
|
29
29
|
*/
|
|
30
30
|
is_relay?: boolean;
|
|
31
31
|
/**
|
|
32
|
-
* Whether the address is a Tor node.
|
|
32
|
+
* Whether the address is a Tor node. Free and paid plans.
|
|
33
33
|
*/
|
|
34
34
|
is_tor?: boolean;
|
|
35
35
|
/**
|
|
36
|
-
* Whether the address belongs to a CDN.
|
|
36
|
+
* Whether the address belongs to a CDN. Paid plans.
|
|
37
37
|
*/
|
|
38
38
|
is_cdn?: boolean;
|
|
39
39
|
/**
|
|
40
|
-
* Whether the address was seen in a residential proxy pool.
|
|
40
|
+
* Whether the address was seen in a residential proxy pool. Paid plans.
|
|
41
41
|
*/
|
|
42
42
|
is_resproxy?: boolean;
|
|
43
43
|
/**
|
|
44
|
-
* Whether the address was seen in a datacenter proxy pool.
|
|
44
|
+
* Whether the address was seen in a datacenter proxy pool. Paid plans.
|
|
45
45
|
*/
|
|
46
46
|
is_dcproxy?: boolean;
|
|
47
47
|
/**
|
|
48
|
-
* Whether the address was seen in a mobile proxy pool.
|
|
48
|
+
* Whether the address was seen in a mobile proxy pool. Paid plans.
|
|
49
49
|
*/
|
|
50
50
|
is_mobproxy?: boolean;
|
|
51
51
|
/**
|
|
52
|
-
* Whether a public proxy, one anyone can connect through, listens on the address or sends its traffic out from it.
|
|
52
|
+
* Whether a public proxy, one anyone can connect through, listens on the address or sends its traffic out from it. Paid plans.
|
|
53
53
|
*/
|
|
54
54
|
is_pubproxy?: boolean;
|
|
55
55
|
/**
|
|
56
|
-
* Detail for `is_vpn`. Empty when `is_vpn` is false.
|
|
56
|
+
* Detail for `is_vpn`. Empty when `is_vpn` is false. Paid plans.
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
vpn?: VpnDetail;
|
|
60
60
|
/**
|
|
61
|
-
* Detail for `is_hosting`. Empty when false.
|
|
61
|
+
* Detail for `is_hosting`. Empty when false. Paid plans.
|
|
62
62
|
*/
|
|
63
63
|
hosting?: ClassDetail;
|
|
64
64
|
/**
|
|
65
|
-
* Detail for `is_relay`. Empty when false.
|
|
65
|
+
* Detail for `is_relay`. Empty when false. Free and paid plans.
|
|
66
66
|
*/
|
|
67
67
|
relay?: ClassDetail;
|
|
68
68
|
/**
|
|
69
|
-
* Detail for `is_tor`. Empty when false.
|
|
69
|
+
* Detail for `is_tor`. Empty when false. Free and paid plans. The tor
|
|
70
70
|
* dataset carries no provider, so `provider` is always an empty string.
|
|
71
71
|
*
|
|
72
72
|
*/
|
|
73
73
|
tor?: ClassDetail;
|
|
74
74
|
/**
|
|
75
|
-
* Detail for `is_cdn`. Empty when false.
|
|
75
|
+
* Detail for `is_cdn`. Empty when false. Paid plans.
|
|
76
76
|
*/
|
|
77
77
|
cdn?: ClassDetail;
|
|
78
78
|
/**
|
|
79
|
-
* Detail for `is_resproxy`. Empty when false.
|
|
79
|
+
* Detail for `is_resproxy`. Empty when false. Paid plans.
|
|
80
80
|
*/
|
|
81
81
|
resproxy?: ProxyDetail;
|
|
82
82
|
/**
|
|
83
|
-
* Detail for `is_dcproxy`. Empty when false.
|
|
83
|
+
* Detail for `is_dcproxy`. Empty when false. Paid plans.
|
|
84
84
|
*/
|
|
85
85
|
dcproxy?: ProxyDetail;
|
|
86
86
|
/**
|
|
87
|
-
* Detail for `is_mobproxy`. Empty when false.
|
|
87
|
+
* Detail for `is_mobproxy`. Empty when false. Paid plans.
|
|
88
88
|
*/
|
|
89
89
|
mobproxy?: ProxyDetail;
|
|
90
90
|
/**
|
|
91
|
-
* Detail for `is_pubproxy`. Empty when false.
|
|
91
|
+
* Detail for `is_pubproxy`. Empty when false. Paid plans.
|
|
92
92
|
*/
|
|
93
93
|
pubproxy?: PubproxyDetail;
|
|
94
|
+
location?: Location;
|
|
95
|
+
asn?: Asn;
|
|
94
96
|
};
|
|
95
97
|
export type BatchLookupRequest = {
|
|
96
98
|
/**
|
|
@@ -139,8 +141,7 @@ export type BatchLookupError = {
|
|
|
139
141
|
/**
|
|
140
142
|
* What is known about the VPN attribution. Every key is present when the
|
|
141
143
|
* object is populated, empty values included; the object is `{}` when
|
|
142
|
-
* `is_vpn` is false.
|
|
143
|
-
* plan they are absent from a populated object rather than empty.
|
|
144
|
+
* `is_vpn` is false.
|
|
144
145
|
*
|
|
145
146
|
*/
|
|
146
147
|
export type VpnDetail = {
|
|
@@ -153,20 +154,16 @@ export type VpnDetail = {
|
|
|
153
154
|
*/
|
|
154
155
|
last_seen?: string;
|
|
155
156
|
/**
|
|
156
|
-
* How strongly the attribution is supported.
|
|
157
|
+
* How strongly the attribution is supported.
|
|
157
158
|
*/
|
|
158
159
|
confidence?: string;
|
|
159
160
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
161
|
+
* Never returned since 2026-10-20: no plan is answered with the class of
|
|
162
|
+
* evidence an attribution rests on. Declared so that a client typed
|
|
163
|
+
* against it keeps compiling; read `confidence` instead.
|
|
162
164
|
*
|
|
163
|
-
* `scan` - we spoke the VPN protocol to the address ourselves and got a
|
|
164
|
-
* valid server response. `scrape` - the operator published the address
|
|
165
|
-
* through its own API, client or configuration. `registry` - public
|
|
166
|
-
* registration or naming records attribute it to the operator.
|
|
167
|
-
* `infer` - the address was extrapolated from confirmed neighbors in
|
|
168
|
-
* the same block.
|
|
169
165
|
*
|
|
166
|
+
* @deprecated
|
|
170
167
|
*/
|
|
171
168
|
method?: string;
|
|
172
169
|
};
|
|
@@ -273,6 +270,83 @@ export type PubproxyDetail = {
|
|
|
273
270
|
*/
|
|
274
271
|
last_usable?: string;
|
|
275
272
|
};
|
|
273
|
+
/**
|
|
274
|
+
* Where the address is, to the country: the fields of our IP Country
|
|
275
|
+
* database. Free and paid plans. Each field is present whenever the
|
|
276
|
+
* object is, so an address in no country, or a private one, answers
|
|
277
|
+
* empty strings.
|
|
278
|
+
*
|
|
279
|
+
*/
|
|
280
|
+
export type Location = {
|
|
281
|
+
/**
|
|
282
|
+
* Continent code: AF, AN (Antarctica), AS, EU, NA, OC or SA.
|
|
283
|
+
*/
|
|
284
|
+
continent: string;
|
|
285
|
+
/**
|
|
286
|
+
* Continent name.
|
|
287
|
+
*/
|
|
288
|
+
continent_name: string;
|
|
289
|
+
/**
|
|
290
|
+
* ISO 3166-1 alpha-2 country code.
|
|
291
|
+
*/
|
|
292
|
+
country: string;
|
|
293
|
+
/**
|
|
294
|
+
* Country name.
|
|
295
|
+
*/
|
|
296
|
+
country_name: string;
|
|
297
|
+
/**
|
|
298
|
+
* IANA timezone of the address.
|
|
299
|
+
*/
|
|
300
|
+
timezone: string;
|
|
301
|
+
/**
|
|
302
|
+
* ISO 4217 code of the country's currency, where there is one.
|
|
303
|
+
*/
|
|
304
|
+
currency_code: string;
|
|
305
|
+
/**
|
|
306
|
+
* Name of the country's currency, where there is one.
|
|
307
|
+
*/
|
|
308
|
+
currency_name: string;
|
|
309
|
+
/**
|
|
310
|
+
* Symbol of the country's currency, where known.
|
|
311
|
+
*/
|
|
312
|
+
currency_symbol: string;
|
|
313
|
+
/**
|
|
314
|
+
* The country's flag, as an emoji.
|
|
315
|
+
*/
|
|
316
|
+
flag_emoji: string;
|
|
317
|
+
/**
|
|
318
|
+
* The Unicode code points of the flag emoji.
|
|
319
|
+
*/
|
|
320
|
+
flag_unicode: string;
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* The autonomous system that announces the address. Free and paid plans.
|
|
324
|
+
* Each field is present whenever the object is: `asn` is 0 and the rest
|
|
325
|
+
* empty where no announcement covers the address.
|
|
326
|
+
*
|
|
327
|
+
*/
|
|
328
|
+
export type Asn = {
|
|
329
|
+
/**
|
|
330
|
+
* The AS number, 0 when no announcement covers the address.
|
|
331
|
+
*/
|
|
332
|
+
asn: number;
|
|
333
|
+
/**
|
|
334
|
+
* Name of the organization that operates the AS.
|
|
335
|
+
*/
|
|
336
|
+
name: string;
|
|
337
|
+
/**
|
|
338
|
+
* The AS operator's own registrable domain.
|
|
339
|
+
*/
|
|
340
|
+
domain: string;
|
|
341
|
+
/**
|
|
342
|
+
* The kind of network the AS runs: isp, hosting, education, government or business.
|
|
343
|
+
*/
|
|
344
|
+
type: string;
|
|
345
|
+
/**
|
|
346
|
+
* The announced BGP prefix that covers the address, the most specific when several do.
|
|
347
|
+
*/
|
|
348
|
+
prefix: string;
|
|
349
|
+
};
|
|
276
350
|
/**
|
|
277
351
|
* Every non-2xx response carries this shape.
|
|
278
352
|
*/
|
|
@@ -345,6 +419,15 @@ export type Database = {
|
|
|
345
419
|
*/
|
|
346
420
|
in_term: boolean;
|
|
347
421
|
standing: Standing;
|
|
422
|
+
/**
|
|
423
|
+
* An Open database: free under CC BY-SA 4.0 (credit VPNDetection,
|
|
424
|
+
* https://vpndetection.io, and share what you build from it under the
|
|
425
|
+
* same license). Every organization holds a `standard` license to it
|
|
426
|
+
* from the start, which `standing` and `license_type` report like any
|
|
427
|
+
* other.
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
open: boolean;
|
|
348
431
|
/**
|
|
349
432
|
* Every published version of this family. The `id` here is what the
|
|
350
433
|
* download and checksum endpoints take.
|
|
@@ -378,6 +461,10 @@ export type Download = {
|
|
|
378
461
|
* The evaluation sample rather than the database itself.
|
|
379
462
|
*/
|
|
380
463
|
sample: boolean;
|
|
464
|
+
/**
|
|
465
|
+
* A download of an Open database.
|
|
466
|
+
*/
|
|
467
|
+
open: boolean;
|
|
381
468
|
/**
|
|
382
469
|
* Object size at redirect time, NOT bytes delivered: the transfer is a
|
|
383
470
|
* presigned redirect straight to object storage, so we never observe it.
|
package/dist/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export type { OauthOptions, DeviceAuthorizationOptions, PollDeviceTokenOptions,
|
|
|
5
5
|
export { isBogon } from './bogon.js';
|
|
6
6
|
export { VPNDetectionError, OauthError, OauthAccessDeniedError, OauthExpiredTokenError, } from './errors.js';
|
|
7
7
|
export type { ErrorKind } from './errors.js';
|
|
8
|
-
export type { Result, VpnDetail, ClassDetail, ProxyDetail, PubproxyDetail, LookupResponse, } from './types.js';
|
|
8
|
+
export type { Result, VpnDetail, ClassDetail, ProxyDetail, PubproxyDetail, Location, Asn, LookupResponse, } from './types.js';
|
|
9
9
|
export { DATABASE_FORMATS, STANDINGS, LICENSE_TYPES } from './types.js';
|
|
10
10
|
export type { Database, DatabaseFormat, DatabaseFormatSize, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DbChecksums, Download, Standing, } from './generated/types.gen.js';
|
|
11
11
|
export type LicenseType = NonNullable<import('./generated/types.gen.js').Database['license_type']>;
|
package/dist/shapes.d.ts
CHANGED
|
@@ -5,12 +5,12 @@ export declare const ENTITLEMENT_MEMBERS: readonly ["org_id", "apikey", "plan",
|
|
|
5
5
|
export declare const ENTITLEMENT_APIKEY_MEMBERS: readonly ["id", "allowed_cidrs"];
|
|
6
6
|
export declare const ENTITLEMENT_PLAN_MEMBERS: readonly ["key", "tier"];
|
|
7
7
|
export declare const ENTITLEMENT_USAGE_MEMBERS: readonly ["requests", "quota", "window_start", "window_end"];
|
|
8
|
-
export declare const DATABASE_MEMBERS: readonly ["base", "name", "summary", "in_term", "standing", "versions"];
|
|
8
|
+
export declare const DATABASE_MEMBERS: readonly ["base", "name", "summary", "in_term", "standing", "open", "versions"];
|
|
9
9
|
export declare const DATABASE_VERSION_MEMBERS: readonly ["id", "version", "formats"];
|
|
10
10
|
export declare const DATABASE_FORMAT_SIZE_MEMBERS: readonly ["format"];
|
|
11
11
|
export declare const DATABASE_METADATA_MEMBERS: readonly ["id", "updated", "entries", "schema"];
|
|
12
12
|
export declare const DB_CHECKSUMS_MEMBERS: readonly ["md5", "sha1", "sha256", "sha512"];
|
|
13
|
-
export declare const DOWNLOAD_MEMBERS: readonly ["dataset_id", "format", "outcome", "sample", "created"];
|
|
13
|
+
export declare const DOWNLOAD_MEMBERS: readonly ["dataset_id", "format", "outcome", "sample", "open", "created"];
|
|
14
14
|
export declare function isLookup(data: unknown): boolean;
|
|
15
15
|
/** Both maps present. An entry in either is judged on its own, as that address's answer. */
|
|
16
16
|
export declare function isBatch(data: unknown): boolean;
|
package/dist/shapes.js
CHANGED
|
@@ -10,12 +10,12 @@ export const ENTITLEMENT_MEMBERS = ['org_id', 'apikey', 'plan', 'usage'];
|
|
|
10
10
|
export const ENTITLEMENT_APIKEY_MEMBERS = ['id', 'allowed_cidrs'];
|
|
11
11
|
export const ENTITLEMENT_PLAN_MEMBERS = ['key', 'tier'];
|
|
12
12
|
export const ENTITLEMENT_USAGE_MEMBERS = ['requests', 'quota', 'window_start', 'window_end'];
|
|
13
|
-
export const DATABASE_MEMBERS = ['base', 'name', 'summary', 'in_term', 'standing', 'versions'];
|
|
13
|
+
export const DATABASE_MEMBERS = ['base', 'name', 'summary', 'in_term', 'standing', 'open', 'versions'];
|
|
14
14
|
export const DATABASE_VERSION_MEMBERS = ['id', 'version', 'formats'];
|
|
15
15
|
export const DATABASE_FORMAT_SIZE_MEMBERS = ['format'];
|
|
16
16
|
export const DATABASE_METADATA_MEMBERS = ['id', 'updated', 'entries', 'schema'];
|
|
17
17
|
export const DB_CHECKSUMS_MEMBERS = ['md5', 'sha1', 'sha256', 'sha512'];
|
|
18
|
-
export const DOWNLOAD_MEMBERS = ['dataset_id', 'format', 'outcome', 'sample', 'created'];
|
|
18
|
+
export const DOWNLOAD_MEMBERS = ['dataset_id', 'format', 'outcome', 'sample', 'open', 'created'];
|
|
19
19
|
function isObject(value) {
|
|
20
20
|
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
21
21
|
}
|
package/dist/shapes.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shapes.js","sourceRoot":"","sources":["../src/shapes.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,+EAA+E;AAC/E,+EAA+E;AAC/E,8BAA8B;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAU,CAAC;AACxD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAC;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAU,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AAClF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,eAAe,CAAU,CAAC;AAC3E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AACjE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,CAAU,CAAC;AACtG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"shapes.js","sourceRoot":"","sources":["../src/shapes.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,+EAA+E;AAC/E,+EAA+E;AAC/E,8BAA8B;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAU,CAAC;AACxD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAC;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAU,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AAClF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,eAAe,CAAU,CAAC;AAC3E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAU,CAAC;AACjE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,CAAU,CAAC;AACtG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,CAAU,CAAC;AAChH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAU,CAAC;AAC9E,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,QAAQ,CAAU,CAAC;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AACzF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AACjF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAU,CAAC;AAE1G,SAAS,QAAQ,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,KAAK,CAAC,KAAc,EAAE,KAAkC;IAC7D,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAa;IAClC,OAAO,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;AACrH,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,OAAO,CAAC,IAAa;IACjC,OAAO,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;AACpG,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,OAAO,UAAU,CAAC,KAAK,EAAE,mBAAmB,CAAC,IAAI,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAa;IACvC,OAAO,UAAU,CAAC,IAAI,EAAE,mBAAmB,CAAC;WACrC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;WACtD,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,wBAAwB,CAAC;WAClD,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,yBAAyB,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAC9B,OAAO,UAAU,CAAC,KAAK,EAAE,gBAAgB,CAAC;WACnC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC;eAC/E,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa;IACxC,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAa;IAC5C,OAAO,UAAU,CAAC,IAAI,EAAE,yBAAyB,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ;WAC7E,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAa;IAC7C,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC,CAAC;AAClG,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa;IACxC,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACvH,CAAC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ClassDetail, Database, DatabaseFormat, LookupResponse, ProxyDetail, PubproxyDetail, Standing, VpnDetail } from './generated/types.gen.js';
|
|
2
|
-
export type { ClassDetail, ProxyDetail, PubproxyDetail, VpnDetail, LookupResponse };
|
|
1
|
+
import type { Asn, ClassDetail, Database, DatabaseFormat, Location, LookupResponse, ProxyDetail, PubproxyDetail, Standing, VpnDetail } from './generated/types.gen.js';
|
|
2
|
+
export type { Asn, ClassDetail, Location, ProxyDetail, PubproxyDetail, VpnDetail, LookupResponse };
|
|
3
3
|
export declare const DATABASE_FORMATS: readonly DatabaseFormat[];
|
|
4
4
|
export declare const STANDINGS: readonly Standing[];
|
|
5
5
|
export declare const LICENSE_TYPES: readonly NonNullable<Database['license_type']>[];
|
|
@@ -38,6 +38,13 @@ export interface Result {
|
|
|
38
38
|
dcproxy?: ProxyDetail;
|
|
39
39
|
mobproxy?: ProxyDetail;
|
|
40
40
|
pubproxy?: PubproxyDetail;
|
|
41
|
+
/**
|
|
42
|
+
* Where the address is, on every keyed answer: every key present, empty strings where it is
|
|
43
|
+
* not known.
|
|
44
|
+
*/
|
|
45
|
+
location?: Location;
|
|
46
|
+
/** The AS announcing the address, on every keyed answer: `asn` is 0 where none does. */
|
|
47
|
+
asn?: Asn;
|
|
41
48
|
/** The response exactly as it came off the wire, with its original names. */
|
|
42
49
|
raw: LookupResponse;
|
|
43
50
|
}
|
package/dist/types.js
CHANGED
|
@@ -40,6 +40,8 @@ export function toResult(body) {
|
|
|
40
40
|
copyDetail(body, r, 'dcproxy', 'dcproxy');
|
|
41
41
|
copyDetail(body, r, 'mobproxy', 'mobproxy');
|
|
42
42
|
copyDetail(body, r, 'pubproxy', 'pubproxy');
|
|
43
|
+
copyDetail(body, r, 'location', 'location');
|
|
44
|
+
copyDetail(body, r, 'asn', 'asn');
|
|
43
45
|
return r;
|
|
44
46
|
}
|
|
45
47
|
function copyFlag(body, out, from, to) {
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAOA,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAC/E,gFAAgF;AAChF,8BAA8B;AAC9B,EAAE;AACF,4EAA4E;AAC5E,gFAAgF;AAChF,oEAAoE;AACpE,MAAM,CAAC,MAAM,gBAAgB,GAA8B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;AAEpF,MAAM,CAAC,MAAM,aAAa,GAAqD;IAC3E,YAAY,EAAE,UAAU,EAAE,cAAc;CAC3C,CAAC;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAOA,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAC/E,gFAAgF;AAChF,8BAA8B;AAC9B,EAAE;AACF,4EAA4E;AAC5E,gFAAgF;AAChF,oEAAoE;AACpE,MAAM,CAAC,MAAM,gBAAgB,GAA8B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;AAEpF,MAAM,CAAC,MAAM,aAAa,GAAqD;IAC3E,YAAY,EAAE,UAAU,EAAE,cAAc;CAC3C,CAAC;AAoDF,yEAAyE;AACzE,8EAA8E;AAC9E,gFAAgF;AAChF,kCAAkC;AAClC,MAAM,UAAU,QAAQ,CAAC,IAAoB;IACzC,MAAM,CAAC,GAAW;QACd,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,MAAM;QAClB,OAAO,EAAE,KAAK;QACd,GAAG,EAAE,IAAI;KACZ,CAAC;IACF,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC7C,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IACzC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC7C,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;IAC/C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACtC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClC,OAAO,CAAC,CAAC;AACb,CAAC;AAED,SAAS,QAAQ,CACb,IAAoB,EAAE,GAAW,EACjC,IAA0B,EAAE,EACkC;IAE9D,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;QAC3C,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAY,CAAC;IACpC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CACf,IAAoB,EAAE,GAAW,EACjC,IAA0B,EAC1B,EACqC;IAErC,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;QAC3C,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAU,CAAC;IAClC,CAAC;AACL,CAAC"}
|