@apiverve/asnlookup 1.1.9 → 1.1.10

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 CHANGED
@@ -1,5 +1,4 @@
1
- ASN Lookup API
2
- ============
1
+ # ASN Lookup API
3
2
 
4
3
  ASN Lookup is a simple tool for getting information on Autonomous System Numbers (ASNs). It returns information on various ASNs.
5
4
 
@@ -7,54 +6,62 @@ ASN Lookup is a simple tool for getting information on Autonomous System Numbers
7
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
8
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
9
8
 
10
- This is a Javascript Wrapper for the [ASN Lookup API](https://apiverve.com/marketplace/api/asnlookup)
9
+ This is a Javascript Wrapper for the [ASN Lookup API](https://apiverve.com/marketplace/asnlookup)
11
10
 
12
11
  ---
13
12
 
14
13
  ## Installation
15
- npm install @apiverve/asnlookup --save
14
+
15
+ Using npm:
16
+ ```shell
17
+ npm install @apiverve/asnlookup
18
+ ```
19
+
20
+ Using yarn:
21
+ ```shell
22
+ yarn add @apiverve/asnlookup
23
+ ```
16
24
 
17
25
  ---
18
26
 
19
27
  ## Configuration
20
28
 
21
- Before using the asnlookup API client, you have to setup your account and obtain your API Key.
29
+ Before using the ASN Lookup API client, you have to setup your account and obtain your API Key.
22
30
  You can get it by signing up at [https://apiverve.com](https://apiverve.com)
23
31
 
24
32
  ---
25
33
 
26
- ## Usage
34
+ ## Quick Start
27
35
 
28
- The ASN Lookup API documentation is found here: [https://docs.apiverve.com/api/asnlookup](https://docs.apiverve.com/api/asnlookup).
36
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+
38
+ The ASN Lookup API documentation is found here: [https://docs.apiverve.com/ref/asnlookup](https://docs.apiverve.com/ref/asnlookup).
29
39
  You can find parameters, example responses, and status codes documented here.
30
40
 
31
41
  ### Setup
32
42
 
33
- ```
34
- var asnlookupAPI = require('@apiverve/asnlookup');
35
- var api = new asnlookupAPI({
36
- api_key: [YOUR_API_KEY],
37
- secure: true //(Optional, defaults to true)
43
+ ```javascript
44
+ const asnlookupAPI = require('@apiverve/asnlookup');
45
+ const api = new asnlookupAPI({
46
+ api_key: '[YOUR_API_KEY]'
38
47
  });
39
48
  ```
40
49
 
41
50
  ---
42
51
 
52
+ ## Usage
53
+
54
+ ---
43
55
 
44
56
  ### Perform Request
45
- Using the API client, you can perform requests to the API.
46
57
 
47
- ###### Define Query
58
+ Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
48
59
 
49
- ```
60
+ ```javascript
50
61
  var query = {
51
62
  asn: "AS15169"
52
63
  };
53
- ```
54
-
55
- ###### Simple Request (using Callback)
56
64
 
57
- ```
58
65
  api.execute(query, function (error, data) {
59
66
  if (error) {
60
67
  return console.error(error);
@@ -64,19 +71,61 @@ api.execute(query, function (error, data) {
64
71
  });
65
72
  ```
66
73
 
67
- ###### Example Response
74
+ ---
75
+
76
+ ### Using Promises
77
+
78
+ You can also use promises to make requests. The API returns a promise that you can use to handle the response.
79
+
80
+ ```javascript
81
+ var query = {
82
+ asn: "AS15169"
83
+ };
84
+
85
+ api.execute(query)
86
+ .then(data => {
87
+ console.log(data);
88
+ })
89
+ .catch(error => {
90
+ console.error(error);
91
+ });
92
+ ```
93
+
94
+ ---
95
+
96
+ ### Using Async/Await
68
97
 
98
+ You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
99
+
100
+ ```javascript
101
+ async function makeRequest() {
102
+ var query = {
103
+ asn: "AS15169"
104
+ };
105
+
106
+ try {
107
+ const data = await api.execute(query);
108
+ console.log(data);
109
+ } catch (error) {
110
+ console.error(error);
111
+ }
112
+ }
69
113
  ```
70
- {
71
- "status": "ok",
72
- "error": null,
73
- "data": {
74
- "asn": "AS15169",
75
- "simple": "15169",
76
- "handle": "GOOGLE",
77
- "description": "Google LLC"
78
- },
79
- "code": 200
114
+
115
+ ---
116
+
117
+ ## Example Response
118
+
119
+ ```json
120
+ {
121
+ "status": "ok",
122
+ "error": null,
123
+ "data": {
124
+ "asn": "AS15169",
125
+ "simple": "15169",
126
+ "handle": "GOOGLE",
127
+ "description": "Google LLC"
128
+ }
80
129
  }
81
130
  ```
82
131
 
@@ -89,6 +138,7 @@ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/c
89
138
  ---
90
139
 
91
140
  ## Updates
141
+
92
142
  Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
93
143
 
94
144
  ---
@@ -102,10 +152,10 @@ All usage of the APIVerve website, API, and services is subject to the [APIVerve
102
152
  ## License
103
153
  Licensed under the The MIT License (MIT)
104
154
 
105
- Copyright (©) 2025 APIVerve, and EvlarSoft LLC
155
+ Copyright (©) 2025 APIVerve, and Evlar LLC
106
156
 
107
157
  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:
108
158
 
109
159
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
110
160
 
111
- 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.
161
+ 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.
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Basic Example - ASN Lookup API
3
+ *
4
+ * This example demonstrates how to use the ASN Lookup API.
5
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
6
+ */
7
+
8
+ require('dotenv').config();
9
+ const asnlookupAPI = require('../index.js');
10
+
11
+ // Initialize the API client
12
+ const api = new asnlookupAPI({
13
+ api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
+ });
15
+
16
+ // Example query
17
+ var query = {
18
+ asn: "AS15169"
19
+ };
20
+
21
+ // Make the API request using callback
22
+ console.log('Making request to ASN Lookup API...\n');
23
+
24
+ api.execute(query, function (error, data) {
25
+ if (error) {
26
+ console.error('Error occurred:');
27
+ if (error.error) {
28
+ console.error('Message:', error.error);
29
+ console.error('Status:', error.status);
30
+ } else {
31
+ console.error(JSON.stringify(error, null, 2));
32
+ }
33
+ return;
34
+ }
35
+
36
+ console.log('Response:');
37
+ console.log(JSON.stringify(data, null, 2));
38
+ });
package/index.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ declare module '@apiverve/asnlookup' {
2
+ export interface asnlookupOptions {
3
+ api_key: string;
4
+ secure?: boolean;
5
+ }
6
+
7
+ export interface asnlookupResponse {
8
+ status: string;
9
+ error: string | null;
10
+ data: any;
11
+ code?: number;
12
+ }
13
+
14
+ export default class asnlookupWrapper {
15
+ constructor(options: asnlookupOptions);
16
+
17
+ execute(callback: (error: any, data: asnlookupResponse | null) => void): Promise<asnlookupResponse>;
18
+ execute(query: Record<string, any>, callback: (error: any, data: asnlookupResponse | null) => void): Promise<asnlookupResponse>;
19
+ execute(query?: Record<string, any>): Promise<asnlookupResponse>;
20
+ }
21
+ }
package/index.js CHANGED
@@ -4,14 +4,27 @@ class asnlookupWrapper {
4
4
 
5
5
  constructor(options) {
6
6
  if (!options || typeof options !== 'object') {
7
- throw new Error('Options object must be provided.');
7
+ throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/asnlookup');
8
8
  }
9
9
 
10
10
  const { api_key, secure = true } = options;
11
11
 
12
12
  if (!api_key || typeof api_key !== 'string') {
13
- throw new Error('API key must be provided as a non-empty string.');
13
+ throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
14
  }
15
+
16
+ // Validate API key format (GUID or alphanumeric with hyphens)
17
+ const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
18
+ if (!apiKeyPattern.test(api_key)) {
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
20
+ }
21
+
22
+ // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
23
+ const trimmedKey = api_key.replace(/-/g, '');
24
+ if (trimmedKey.length < 32) {
25
+ throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
26
+ }
27
+
15
28
  if (typeof secure !== 'boolean') {
16
29
  throw new Error('Secure parameter must be a boolean value.');
17
30
  }
@@ -24,20 +37,32 @@ class asnlookupWrapper {
24
37
  }
25
38
 
26
39
  async execute(query, callback) {
27
- if(arguments.length > 1) {
40
+ // Handle different argument patterns
41
+ if(arguments.length === 0) {
42
+ // execute() - no args
43
+ query = {};
44
+ callback = null;
45
+ } else if(arguments.length === 1) {
46
+ if (typeof query === 'function') {
47
+ // execute(callback)
48
+ callback = query;
49
+ query = {};
50
+ } else {
51
+ // execute(query)
52
+ callback = null;
53
+ }
54
+ } else {
55
+ // execute(query, callback)
28
56
  if (!query || typeof query !== 'object') {
29
57
  throw new Error('Query parameters must be provided as an object.');
30
58
  }
31
- } else {
32
- callback = query;
33
- query = {};
34
59
  }
35
60
 
36
61
  var requiredParams = ["asn"];
37
62
  if (requiredParams.length > 0) {
38
63
  for (var i = 0; i < requiredParams.length; i++) {
39
64
  if (!query[requiredParams[i]]) {
40
- throw new Error(`Required parameter [${requiredParams[i]}] is missing.`);
65
+ throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/asnlookup`);
41
66
  }
42
67
  }
43
68
  }
@@ -58,16 +83,25 @@ class asnlookupWrapper {
58
83
  });
59
84
 
60
85
  const data = response.data;
61
- callback(null, data);
86
+ if (callback) callback(null, data);
62
87
  return data;
63
88
  } catch (error) {
64
- if (error.response.data) {
65
- callback(error.response.data, null);
66
- throw error.response.data;
89
+ let apiError;
90
+
91
+ if (error.response && error.response.data) {
92
+ apiError = error.response.data;
93
+ } else if (error.message) {
94
+ apiError = { error: error.message, status: 'error' };
67
95
  } else {
68
- callback(error, null);
69
- throw error;
70
- }
96
+ apiError = { error: 'An unknown error occurred', status: 'error' };
97
+ }
98
+
99
+ if (callback) {
100
+ callback(apiError, null);
101
+ return; // Don't throw if callback is provided
102
+ }
103
+
104
+ throw apiError;
71
105
  }
72
106
  }
73
107
 
package/package.json CHANGED
@@ -1,24 +1,26 @@
1
1
  {
2
2
  "name": "@apiverve/asnlookup",
3
- "version": "1.1.9",
3
+ "version": "1.1.10",
4
4
  "description": "ASN Lookup is a simple tool for getting information on Autonomous System Numbers (ASNs). It returns information on various ASNs.",
5
5
  "main": "index.js",
6
+ "types": "index.d.ts",
6
7
  "scripts": {
7
- "test": "mocha"
8
+ "test": "mocha",
9
+ "example": "node examples/basic.js"
8
10
  },
9
11
  "repository": {
10
12
  "type": "git",
11
13
  "url": "git+https://github.com/apiverve/asnlookup-API.git"
12
14
  },
13
15
  "keywords": [
14
- "asn lookup","asn information","asn api","asn tool","asn software"
16
+ "asn lookup", "asn information", "asn api", "asn tool", "asn software"
15
17
  ],
16
18
  "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
17
19
  "license": "MIT",
18
20
  "bugs": {
19
21
  "url": "https://github.com/apiverve/asnlookup-API/issues"
20
22
  },
21
- "homepage": "https://apiverve.com/marketplace/api/asnlookup?utm_source=npm",
23
+ "homepage": "https://apiverve.com/marketplace/asnlookup?utm_source=npm",
22
24
  "devDependencies": {
23
25
  "mocha": "^11.0.1",
24
26
  "chai": "^5.1.2",
@@ -27,6 +29,6 @@
27
29
  "dependencies": {
28
30
  "node-fetch": "^3.3.2",
29
31
  "promise": "^8.3.0",
30
- "axios": "1.7.9"
32
+ "axios": "1.8.4"
31
33
  }
32
34
  }