chapybara 0.2.1 → 0.4.0

package/README.md

@@ -28,6 +28,21 @@ const chapybara = new ChapybaraClient({
 });
 ```
 
+### Get Your IP Address
+
+```javascript
+async function getUserIP() {
+  try {
+    const data = await chapybara.getUserIP();
+    console.log(data.ip);
+  } catch (error) {
+    console.error(`Error fetching user IP: ${error.message}`);
+  }
+}
+
+getUserIP();
+```
+
 ### Get Domain Intelligence
 
 ```javascript
@@ -76,6 +91,24 @@ async function getWebTechInfo() {
 getWebTechInfo();
 ```
 
+### Get Website Screenshot
+
+```javascript
+import fs from "fs/promises";
+
+async function getWebsiteScreenshot() {
+  try {
+    const imageBuffer = await chapybara.screenshot.get("apple.com");
+    await fs.writeFile("screenshot.png", imageBuffer);
+    console.log("Screenshot saved to screenshot.png");
+  } catch (error) {
+    console.error(`Error fetching screenshot: ${error.message}`);
+  }
+}
+
+getWebsiteScreenshot();
+```
+
 ### Get Account Information
 
 ```javascript
@@ -83,6 +116,7 @@ async function getAccountDetails() {
   try {
     const data = await chapybara.account.getInfo();
     console.log("Domain quota remaining:", data.quotas.domain.remaining);
+    console.log("Screenshot quota remaining:", data.quotas.screenshot.remaining);
   } catch (error) {
     console.error(`Error fetching account info: ${error.message}`);
   }
@@ -100,7 +134,7 @@ const chapybara = new ChapybaraClient({
   apiKey: "ck_your_api_key_here",
   baseUrl: "https://api.chapyapi.com/api/v1", // Optional: override base URL
   retries: 2, // Optional: number of retries on server errors (default: 2)
-  timeout: 15000, // Optional: request timeout in ms (default: 20000)
+  timeout: 30000, // Optional: request timeout in ms (default: 30000)
   cacheOptions: {
     // Optional: LRU cache options
     max: 500, // Max number of items in cache

package/index.d.ts

@@ -1,4 +1,5 @@
 import type { LRUCache } from "lru-cache";
+import type { Buffer } from "node:buffer";
 
 declare module "chapybara" {
   interface ChapybaraClientOptions {
@@ -240,6 +241,7 @@ declare module "chapybara" {
       domain: { limit: number; used: number; remaining: number };
       ip: { limit: number; used: number; remaining: number };
       webtech: { limit: number; used: number; remaining: number };
+      screenshot: { limit: number; used: number; remaining: number };
       reset_date: string;
     };
     api_key: {
@@ -280,8 +282,14 @@ declare module "chapybara" {
       getScanner: (domain: string) => Promise<WebTechResponse>;
     };
 
+    screenshot: {
+      get: (domain: string) => Promise<Buffer>;
+    };
+
     account: {
       getInfo: () => Promise<AccountInfoResponse>;
     };
+
+    getUserIP: () => Promise<{ ip: string }>;
   }
 }

package/index.js

@@ -3,9 +3,9 @@ import { APIError, AuthenticationError, BadRequestError, NotFoundError, RateLimi
 
 const DEFAULT_BASE_URL = "https://api.chapyapi.com/api/v1";
 const DEFAULT_RETRIES = 2;
-const DEFAULT_TIMEOUT = 20000;
+const DEFAULT_TIMEOUT = 30000;
 
-const SDK_VERSION = "0.2.1";
+const SDK_VERSION = "0.4.0";
 
 export class ChapybaraClient {
   constructor(options) {
@@ -34,14 +34,21 @@ export class ChapybaraClient {
       getScanner: (domain) => this._request(`/webtech/${domain}`),
     };
 
+    this.screenshot = {
+      get: (domain) => this._request(`/screenshot/${domain}`),
+    };
+
     this.account = {
       getInfo: () => this._request("/account"),
     };
+
+    this.getUserIP = () => this._request("/ip");
   }
 
   async _request(endpoint, attempt = 1) {
     const url = `${this.baseUrl}${endpoint}`;
     const cacheKey = endpoint;
+    const isScreenshotRequest = endpoint.startsWith("/screenshot");
 
     if (this.cache?.has(cacheKey)) {
       return this.cache.get(cacheKey);
@@ -72,7 +79,13 @@ export class ChapybaraClient {
         await this._handleError(response);
       }
 
-      const data = await response.json();
+      let data;
+      if (isScreenshotRequest) {
+        const arrayBuffer = await response.arrayBuffer();
+        data = Buffer.from(arrayBuffer);
+      } else {
+        data = await response.json();
+      }
 
       if (this.cache) {
         this.cache.set(cacheKey, data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chapybara",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Official NodeJS SDK for the Chapybara Domain & IP Intelligence API.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -15,12 +15,13 @@
     "domain",
     "ip",
     "intelligence",
-    "security"
+    "security",
+    "screenshot"
   ],
   "author": "Alpha System",
   "license": "MIT",
   "dependencies": {
-    "lru-cache": "^11.2.1"
+    "lru-cache": "^11.2.2"
   },
   "engines": {
     "node": ">=18.0.0"