ip-finder-client 1.0.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # ip-finder-client
 
-A lightweight, zero-dependency Node.js client for the IP Finder API. Get IP geolocation, ASN information, and network details with ease.
+A lightweight, zero-dependency Node.js SDK for IP geolocation, ASN lookup, and network information.
 
 ## Installation
 
@@ -19,9 +19,9 @@ pnpm add ip-finder-client
 ## Quick Start
 
 ```typescript
-import { IPFinder } from 'ip-finder-client';
+import { IPInsight } from 'ip-finder-client';
 
-const client = new IPFinder({
+const client = new IPInsight({
   apiKey: 'your-api-key',
   baseUrl: 'https://api.your-domain.com' // Your API endpoint
 });
@@ -37,7 +37,7 @@ console.log(result.asn?.organization); // "Google LLC"
 ## Configuration
 
 ```typescript
-const client = new IPFinder({
+const client = new IPInsight({
   // Required: Your API key
   apiKey: 'your-api-key',
 
@@ -101,7 +101,7 @@ Look up multiple IP addresses in parallel.
 const results = await client.lookupBatch(['8.8.8.8', '1.1.1.1', '9.9.9.9']);
 
 results.forEach(result => {
-  if (result instanceof IPFinderError) {
+  if (result instanceof IPInsightError) {
     console.error(`Error: ${result.message}`);
   } else {
     console.log(`${result.ip}: ${result.geo?.country}`);
@@ -132,12 +132,12 @@ console.log(client.rateLimit);
 ## Error Handling
 
 ```typescript
-import { IPFinder, IPFinderError } from 'ip-finder-client';
+import { IPInsight, IPInsightError } from 'ip-finder-client';
 
 try {
   const result = await client.lookup('invalid-ip');
 } catch (error) {
-  if (error instanceof IPFinderError) {
+  if (error instanceof IPInsightError) {
     console.error(`API Error: ${error.message}`);
     console.error(`Status Code: ${error.statusCode}`);
     console.error(`Error Code: ${error.code}`);
@@ -166,9 +166,9 @@ try {
 ## CommonJS Usage
 
 ```javascript
-const { IPFinder } = require('ip-finder-client');
+const { IPInsight } = require('ip-finder-client');
 
-const client = new IPFinder({ apiKey: 'your-api-key' });
+const client = new IPInsight({ apiKey: 'your-api-key' });
 ```
 
 ## Factory Function

package/dist/index.d.ts

@@ -1,26 +1,26 @@
 import type { IPFinderConfig, IPLookupResult, APIError, RateLimitInfo, GeoLocation, ASNInfo, NetworkInfo } from './types';
 export type { IPFinderConfig, IPLookupResult, APIError, RateLimitInfo, GeoLocation, ASNInfo, NetworkInfo, };
 /**
- * Custom error class for IP Finder API errors
+ * Custom error class for IPInsight API errors
  */
-export declare class IPFinderError extends Error {
+export declare class IPInsightError extends Error {
     readonly statusCode: number;
     readonly code?: string;
     constructor(message: string, statusCode: number, code?: string);
 }
 /**
- * IP Finder client for looking up IP address information
+ * IPInsight client for looking up IP address information
  *
  * @example
  * ```ts
- * import { IPFinder } from 'ip-finder-client';
+ * import { IPInsight } from 'ip-finder-client';
  *
- * const client = new IPFinder({ apiKey: 'your-api-key' });
+ * const client = new IPInsight({ apiKey: 'your-api-key' });
  * const result = await client.lookup('8.8.8.8');
  * console.log(result.geo?.country); // "United States"
  * ```
  */
-export declare class IPFinder {
+export declare class IPInsight {
     private readonly apiKey;
     private readonly baseUrl;
     private readonly timeout;
@@ -62,7 +62,7 @@ export declare class IPFinder {
      * results.forEach(r => console.log(r.ip, r.geo?.country));
      * ```
      */
-    lookupBatch(ips: string[]): Promise<(IPLookupResult | IPFinderError)[]>;
+    lookupBatch(ips: string[]): Promise<(IPLookupResult | IPInsightError)[]>;
     /**
      * Check if the API is healthy and reachable
      *
@@ -74,10 +74,10 @@ export declare class IPFinder {
     private sleep;
 }
 /**
- * Create a new IP Finder client instance
+ * Create a new IPInsight client instance
  *
  * @param config - Client configuration
- * @returns New IPFinder instance
+ * @returns New IPInsight instance
  *
  * @example
  * ```ts
@@ -91,6 +91,6 @@ export declare class IPFinder {
  * const result = await client.lookup('8.8.8.8');
  * ```
  */
-export declare function createClient(config: IPFinderConfig): IPFinder;
-export default IPFinder;
+export declare function createClient(config: IPFinderConfig): IPInsight;
+export default IPInsight;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,QAAQ,EACR,aAAa,EACb,WAAW,EACX,OAAO,EACP,WAAW,EACZ,MAAM,SAAS,CAAC;AAGjB,YAAY,EACV,cAAc,EACd,cAAc,EACd,QAAQ,EACR,aAAa,EACb,WAAW,EACX,OAAO,EACP,WAAW,GACZ,CAAC;AAMF;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAElB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAO/D;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC,4CAA4C;IACrC,SAAS,CAAC,EAAE,aAAa,CAAC;gBAErB,MAAM,EAAE,cAAc;IAWlC;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IA+BjD;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,cAAc,CAAC;IAO3C;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,cAAc,GAAG,aAAa,CAAC,EAAE,CAAC;IAqB7E;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;YAgBvB,KAAK;IAuDnB,OAAO,CAAC,qBAAqB;IAc7B,OAAO,CAAC,KAAK;CAGd;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,QAAQ,CAE7D;AAGD,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,QAAQ,EACR,aAAa,EACb,WAAW,EACX,OAAO,EACP,WAAW,EACZ,MAAM,SAAS,CAAC;AAGjB,YAAY,EACV,cAAc,EACd,cAAc,EACd,QAAQ,EACR,aAAa,EACb,WAAW,EACX,OAAO,EACP,WAAW,GACZ,CAAC;AAMF;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAElB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAO/D;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC,4CAA4C;IACrC,SAAS,CAAC,EAAE,aAAa,CAAC;gBAErB,MAAM,EAAE,cAAc;IAWlC;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IA+BjD;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,cAAc,CAAC;IAO3C;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,cAAc,GAAG,cAAc,CAAC,EAAE,CAAC;IAqB9E;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;YAgBvB,KAAK;IAuDnB,OAAO,CAAC,qBAAqB;IAc7B,OAAO,CAAC,KAAK;CAGd;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS,CAE9D;AAGD,eAAe,SAAS,CAAC"}

package/dist/index.js

@@ -20,8 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  IPFinder: () => IPFinder,
-  IPFinderError: () => IPFinderError,
+  IPInsight: () => IPInsight,
+  IPInsightError: () => IPInsightError,
   createClient: () => createClient,
   default: () => src_default
 });
@@ -29,18 +29,18 @@ module.exports = __toCommonJS(src_exports);
 var DEFAULT_BASE_URL = "https://your-api-domain.com";
 var DEFAULT_TIMEOUT = 1e4;
 var DEFAULT_RETRIES = 2;
-var IPFinderError = class _IPFinderError extends Error {
+var IPInsightError = class _IPInsightError extends Error {
   statusCode;
   code;
   constructor(message, statusCode, code) {
     super(message);
-    this.name = "IPFinderError";
+    this.name = "IPInsightError";
     this.statusCode = statusCode;
     this.code = code;
-    Object.setPrototypeOf(this, _IPFinderError.prototype);
+    Object.setPrototypeOf(this, _IPInsightError.prototype);
   }
 };
-var IPFinder = class {
+var IPInsight = class {
   apiKey;
   baseUrl;
   timeout;
@@ -82,7 +82,7 @@ var IPFinder = class {
         return response;
       } catch (err) {
         lastError = err;
-        if (err instanceof IPFinderError && err.statusCode >= 400 && err.statusCode < 500) {
+        if (err instanceof IPInsightError && err.statusCode >= 400 && err.statusCode < 500) {
           throw err;
         }
         if (attempt < this.retries) {
@@ -124,10 +124,10 @@ var IPFinder = class {
         return result.value;
       }
       const err = result.reason;
-      if (err instanceof IPFinderError) {
+      if (err instanceof IPInsightError) {
         return err;
       }
-      return new IPFinderError(
+      return new IPInsightError(
         err?.message || "Unknown error",
         0,
         "BATCH_ERROR"
@@ -173,7 +173,7 @@ var IPFinder = class {
           errorBody = await response.json();
         } catch {
         }
-        throw new IPFinderError(
+        throw new IPInsightError(
           errorBody?.error || `HTTP ${response.status}`,
           response.status,
           errorBody?.code
@@ -183,16 +183,16 @@ var IPFinder = class {
       return data;
     } catch (err) {
       clearTimeout(timeoutId);
-      if (err instanceof IPFinderError) {
+      if (err instanceof IPInsightError) {
         throw err;
       }
       if (err instanceof Error) {
         if (err.name === "AbortError") {
-          throw new IPFinderError("Request timeout", 408, "TIMEOUT");
+          throw new IPInsightError("Request timeout", 408, "TIMEOUT");
         }
-        throw new IPFinderError(err.message, 0, "NETWORK_ERROR");
+        throw new IPInsightError(err.message, 0, "NETWORK_ERROR");
       }
-      throw new IPFinderError("Unknown error", 0, "UNKNOWN");
+      throw new IPInsightError("Unknown error", 0, "UNKNOWN");
     }
   }
   parseRateLimitHeaders(headers) {
@@ -212,12 +212,12 @@ var IPFinder = class {
   }
 };
 function createClient(config) {
-  return new IPFinder(config);
+  return new IPInsight(config);
 }
-var src_default = IPFinder;
+var src_default = IPInsight;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  IPFinder,
-  IPFinderError,
+  IPInsight,
+  IPInsightError,
   createClient
 });

package/dist/index.mjs

@@ -2,18 +2,18 @@
 var DEFAULT_BASE_URL = "https://your-api-domain.com";
 var DEFAULT_TIMEOUT = 1e4;
 var DEFAULT_RETRIES = 2;
-var IPFinderError = class _IPFinderError extends Error {
+var IPInsightError = class _IPInsightError extends Error {
   statusCode;
   code;
   constructor(message, statusCode, code) {
     super(message);
-    this.name = "IPFinderError";
+    this.name = "IPInsightError";
     this.statusCode = statusCode;
     this.code = code;
-    Object.setPrototypeOf(this, _IPFinderError.prototype);
+    Object.setPrototypeOf(this, _IPInsightError.prototype);
   }
 };
-var IPFinder = class {
+var IPInsight = class {
   apiKey;
   baseUrl;
   timeout;
@@ -55,7 +55,7 @@ var IPFinder = class {
         return response;
       } catch (err) {
         lastError = err;
-        if (err instanceof IPFinderError && err.statusCode >= 400 && err.statusCode < 500) {
+        if (err instanceof IPInsightError && err.statusCode >= 400 && err.statusCode < 500) {
           throw err;
         }
         if (attempt < this.retries) {
@@ -97,10 +97,10 @@ var IPFinder = class {
         return result.value;
       }
       const err = result.reason;
-      if (err instanceof IPFinderError) {
+      if (err instanceof IPInsightError) {
         return err;
       }
-      return new IPFinderError(
+      return new IPInsightError(
         err?.message || "Unknown error",
         0,
         "BATCH_ERROR"
@@ -146,7 +146,7 @@ var IPFinder = class {
           errorBody = await response.json();
         } catch {
         }
-        throw new IPFinderError(
+        throw new IPInsightError(
           errorBody?.error || `HTTP ${response.status}`,
           response.status,
           errorBody?.code
@@ -156,16 +156,16 @@ var IPFinder = class {
       return data;
     } catch (err) {
       clearTimeout(timeoutId);
-      if (err instanceof IPFinderError) {
+      if (err instanceof IPInsightError) {
         throw err;
       }
       if (err instanceof Error) {
         if (err.name === "AbortError") {
-          throw new IPFinderError("Request timeout", 408, "TIMEOUT");
+          throw new IPInsightError("Request timeout", 408, "TIMEOUT");
         }
-        throw new IPFinderError(err.message, 0, "NETWORK_ERROR");
+        throw new IPInsightError(err.message, 0, "NETWORK_ERROR");
       }
-      throw new IPFinderError("Unknown error", 0, "UNKNOWN");
+      throw new IPInsightError("Unknown error", 0, "UNKNOWN");
     }
   }
   parseRateLimitHeaders(headers) {
@@ -185,12 +185,12 @@ var IPFinder = class {
   }
 };
 function createClient(config) {
-  return new IPFinder(config);
+  return new IPInsight(config);
 }
-var src_default = IPFinder;
+var src_default = IPInsight;
 export {
-  IPFinder,
-  IPFinderError,
+  IPInsight,
+  IPInsightError,
   createClient,
   src_default as default
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ip-finder-client",
-  "version": "1.0.0",
-  "description": "Lightweight client SDK for IP Finder API - Get IP geolocation, ASN, and network information",
+  "version": "1.0.1",
+  "description": "Lightweight SDK for IP geolocation, ASN lookup, and network information",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",