@apiverve/whoislookup 1.1.12 → 1.1.14

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
@@ -5,8 +5,9 @@ Whois Lookup is a simple tool for checking the registration of a domain name. It
5
5
  ![Build Status](https://img.shields.io/badge/build-passing-green)
6
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
7
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
8
+ [![npm version](https://img.shields.io/npm/v/@apiverve/whoislookup.svg)](https://www.npmjs.com/package/@apiverve/whoislookup)
8
9
 
9
- This is a Javascript Wrapper for the [WHOIS Lookup API](https://apiverve.com/marketplace/whoislookup)
10
+ This is a Javascript Wrapper for the [WHOIS Lookup API](https://whoislookup.apiverve.com?utm_source=npm&utm_medium=readme)
10
11
 
11
12
  ---
12
13
 
@@ -27,15 +28,15 @@ yarn add @apiverve/whoislookup
27
28
  ## Configuration
28
29
 
29
30
  Before using the WHOIS Lookup API client, you have to setup your account and obtain your API Key.
30
- You can get it by signing up at [https://apiverve.com](https://apiverve.com)
31
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)
31
32
 
32
33
  ---
33
34
 
34
35
  ## Quick Start
35
36
 
36
- [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)
37
38
 
38
- The WHOIS Lookup API documentation is found here: [https://docs.apiverve.com/ref/whoislookup](https://docs.apiverve.com/ref/whoislookup).
39
+ The WHOIS Lookup API documentation is found here: [https://docs.apiverve.com/ref/whoislookup](https://docs.apiverve.com/ref/whoislookup?utm_source=npm&utm_medium=readme).
39
40
  You can find parameters, example responses, and status codes documented here.
40
41
 
41
42
  ### Setup
@@ -147,7 +148,7 @@ async function makeRequest() {
147
148
 
148
149
  ## Customer Support
149
150
 
150
- Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
151
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).
151
152
 
152
153
  ---
153
154
 
@@ -159,14 +160,14 @@ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Tw
159
160
 
160
161
  ## Legal
161
162
 
162
- All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
163
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).
163
164
 
164
165
  ---
165
166
 
166
167
  ## License
167
168
  Licensed under the The MIT License (MIT)
168
169
 
169
- Copyright (©) 2025 APIVerve, and EvlarSoft LLC
170
+ Copyright (©) 2026 APIVerve, and EvlarSoft LLC
170
171
 
171
172
  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:
172
173
 
package/index.js CHANGED
@@ -13,16 +13,10 @@ class whoislookupWrapper {
13
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
15
 
16
- // Validate API key format (GUID or alphanumeric with hyphens)
17
- const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
16
+ // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
+ const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
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');
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
26
20
  }
27
21
 
28
22
  if (typeof secure !== 'boolean') {
@@ -34,6 +28,102 @@ class whoislookupWrapper {
34
28
 
35
29
  // secure is deprecated, all requests must be made over HTTPS
36
30
  this.baseURL = 'https://api.apiverve.com/v1/whoislookup';
31
+
32
+ // Validation rules for parameters (generated from schema)
33
+ this.validationRules = {"domain":{"type":"string","required":true}};
34
+ }
35
+
36
+ /**
37
+ * Validate query parameters against schema rules
38
+ * @param {Object} query - The query parameters to validate
39
+ * @throws {Error} - If validation fails
40
+ */
41
+ validateParams(query) {
42
+ const errors = [];
43
+
44
+ for (const [paramName, rules] of Object.entries(this.validationRules)) {
45
+ const value = query[paramName];
46
+
47
+ // Check required
48
+ if (rules.required && (value === undefined || value === null || value === '')) {
49
+ errors.push(`Required parameter [${paramName}] is missing.`);
50
+ continue;
51
+ }
52
+
53
+ // Skip validation if value is not provided and not required
54
+ if (value === undefined || value === null) {
55
+ continue;
56
+ }
57
+
58
+ // Type validation
59
+ if (rules.type === 'integer' || rules.type === 'number') {
60
+ const numValue = Number(value);
61
+ if (isNaN(numValue)) {
62
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
63
+ continue;
64
+ }
65
+
66
+ if (rules.type === 'integer' && !Number.isInteger(numValue)) {
67
+ errors.push(`Parameter [${paramName}] must be an integer.`);
68
+ continue;
69
+ }
70
+
71
+ // Min/max validation for numbers
72
+ if (rules.min !== undefined && numValue < rules.min) {
73
+ errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
74
+ }
75
+ if (rules.max !== undefined && numValue > rules.max) {
76
+ errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
77
+ }
78
+ } else if (rules.type === 'string') {
79
+ if (typeof value !== 'string') {
80
+ errors.push(`Parameter [${paramName}] must be a string.`);
81
+ continue;
82
+ }
83
+
84
+ // Length validation for strings
85
+ if (rules.minLength !== undefined && value.length < rules.minLength) {
86
+ errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
87
+ }
88
+ if (rules.maxLength !== undefined && value.length > rules.maxLength) {
89
+ errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
90
+ }
91
+
92
+ // Format validation
93
+ if (rules.format) {
94
+ const formatPatterns = {
95
+ 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
96
+ 'url': /^https?:\/\/.+/i,
97
+ 'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
98
+ 'date': /^\d{4}-\d{2}-\d{2}$/,
99
+ 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
100
+ };
101
+
102
+ if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
103
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
104
+ }
105
+ }
106
+ } else if (rules.type === 'boolean') {
107
+ if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
108
+ errors.push(`Parameter [${paramName}] must be a boolean.`);
109
+ }
110
+ } else if (rules.type === 'array') {
111
+ if (!Array.isArray(value)) {
112
+ errors.push(`Parameter [${paramName}] must be an array.`);
113
+ }
114
+ }
115
+
116
+ // Enum validation
117
+ if (rules.enum && Array.isArray(rules.enum)) {
118
+ if (!rules.enum.includes(value)) {
119
+ errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
120
+ }
121
+ }
122
+ }
123
+
124
+ if (errors.length > 0) {
125
+ throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/whoislookup`);
126
+ }
37
127
  }
38
128
 
39
129
  async execute(query, callback) {
@@ -58,14 +148,8 @@ class whoislookupWrapper {
58
148
  }
59
149
  }
60
150
 
61
- var requiredParams = ["domain"];
62
- if (requiredParams.length > 0) {
63
- for (var i = 0; i < requiredParams.length; i++) {
64
- if (!query[requiredParams[i]]) {
65
- throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/whoislookup`);
66
- }
67
- }
68
- }
151
+ // Validate parameters against schema rules
152
+ this.validateParams(query);
69
153
 
70
154
  const method = 'GET';
71
155
  const url = method === 'POST' ? this.baseURL : this.constructURL(query);
@@ -108,7 +192,7 @@ class whoislookupWrapper {
108
192
  constructURL(query) {
109
193
  let url = this.baseURL;
110
194
 
111
- if(query && typeof query === 'object')
195
+ if(query && typeof query === 'object')
112
196
  {
113
197
  if (Object.keys(query).length > 0) {
114
198
  const queryString = Object.keys(query)
@@ -119,6 +203,7 @@ class whoislookupWrapper {
119
203
  }
120
204
  return url;
121
205
  }
206
+
122
207
  }
123
208
 
124
209
  module.exports = whoislookupWrapper;
package/package.json CHANGED
@@ -1,9 +1,18 @@
1
1
  {
2
2
  "name": "@apiverve/whoislookup",
3
- "version": "1.1.12",
3
+ "version": "1.1.14",
4
4
  "description": "Whois Lookup is a simple tool for checking the registration of a domain name. It returns the name and contact information of the domain owner, the domain registrar, and more.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
+ "sideEffects": false,
8
+ "engines": {
9
+ "node": ">=14.0.0"
10
+ },
11
+ "files": [
12
+ "index.js",
13
+ "index.d.ts",
14
+ "LICENSE"
15
+ ],
7
16
  "scripts": {
8
17
  "test": "mocha",
9
18
  "example": "node examples/basic.js"
@@ -14,14 +23,18 @@
14
23
  "directory": "npm"
15
24
  },
16
25
  "keywords": [
17
- "whois lookup", "whois lookup api", "whois lookup tool", "whois lookup software", "whois lookup service"
26
+ ""
18
27
  ],
19
- "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
28
+ "author": {
29
+ "name": "APIVerve",
30
+ "email": "hello@apiverve.com",
31
+ "url": "https://apiverve.com"
32
+ },
20
33
  "license": "MIT",
21
34
  "bugs": {
22
35
  "url": "https://github.com/apiverve/whoislookup-api/issues"
23
36
  },
24
- "homepage": "https://apiverve.com/marketplace/whoislookup?utm_source=npm",
37
+ "homepage": "https://whoislookup.apiverve.com?utm_source=npm&utm_medium=homepage",
25
38
  "devDependencies": {
26
39
  "mocha": "^11.0.1",
27
40
  "chai": "^5.1.2",
package/examples/basic.js DELETED
@@ -1,38 +0,0 @@
1
- /**
2
- * Basic Example - WHOIS Lookup API
3
- *
4
- * This example demonstrates how to use the WHOIS 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 whoislookupAPI = require('../index.js');
10
-
11
- // Initialize the API client
12
- const api = new whoislookupAPI({
13
- api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
- });
15
-
16
- // Example query
17
- var query = {
18
- domain: "myspace.com"
19
- };
20
-
21
- // Make the API request using callback
22
- console.log('Making request to WHOIS 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/tmp/build.dat DELETED
@@ -1 +0,0 @@
1
- #