# Voyant APIs SDK

Official Node.js & Browser SDK for Voyant APIs - NSFW detection, text analysis, and email services.

---

## 🔁 Usage Mode

### 🟢 Node.js

Use secure server-side integration (recommended)

### 🌐 Browser

Use via CDN (testing / trusted environments only)

---

## 🔑 Get API Keys

https://console.voyantnetworks.com

---

## 📦 Installation (Node.js)

```bash
npm install @voyantnetworks/voyant-apis
```

---

## 🚀 Node.js Usage

```js
import { VoyantAccountCredentials, NsfwApiClient, TextAnalyzeApiClient, EmailApiClient, IpIntelApiClient } from "@voyantnetworks/voyant-apis";

const credentials = new VoyantAccountCredentials({
  apiKey: "YOUR_API_KEY",
  accountId: "YOUR_ACCOUNT_ID",
  apiSecret: "YOUR_API_SECRET",
  testMode: true,
});

// NSFW
const nsfw = new NsfwApiClient({
  credentials,
  projectId: "YOUR_PROJECT_ID",
});

// Text
const text = new TextAnalyzeApiClient({
  credentials,
  projectId: "YOUR_PROJECT_ID",
});

// Email
const email = new EmailApiClient({
  credentials,
  projectId: "YOUR_PROJECT_ID",
});

// IP Intel
const ipIntel = new IpIntelApiClient({
  credentials,
  projectId: "YOUR_PROJECT_ID",
});
```

---

### IP Intel

```
// Single
await ipIntel.lookup("8.8.8.8");

// Batch
await ipIntel.lookupBatch(["8.8.8.8", "1.1.1.1"]);
```

### 🧠 NSFW

```js
await nsfw.analyze("file.jpg");

await nsfw.analyzeBatch(["file1.jpg", "file2.jpg"]);
```

---

### 📝 Text

```js
await text.analyze("hello world");

await text.analyzeBatch(["hello", "world"]);
```

---

### ✉️ Email

```js
final response = await email.sendVerificationEmail({
  to: "user@example.com",
  fromType: "verify",
  templateData: { username: "Abhay" },
});
// Method 1

await response.verifyOTP("123456");

// Method 2

await email.verifyOTP("123456", response.otpHash);
```

---

## 🌐 Browser Usage (CDN)

```html
<script src="https://cdn.jsdelivr.net/npm/@voyantnetworks/voyant-apis@4.0.2/dist/voyant.js"></script>
```

---

### 🚀 Initialize

```html
<script>
  const credentials = {
    apiKey: "YOUR_API_KEY",
    accountId: "YOUR_ACCOUNT_ID",
    apiSecret: "YOUR_API_SECRET",
    testMode: true,
  };

  const nsfw = new VoyantClient.NsfwApiClient({
    credentials,
    projectId: "YOUR_PROJECT_ID",
  });

  const text = new VoyantClient.TextAnalyzeApiClient({
    credentials,
    projectId: "YOUR_PROJECT_ID",
  });

  const email = new VoyantClient.EmailApiClient({
    credentials,
    projectId: "YOUR_PROJECT_ID",
  });

  const ipIntel = new VoyantClient.IpIntelApiClient({
    credentials,
    projectId: "YOUR_PROJECT_ID",
  });
</script>
```

---

### IP Intel (Browser)

```
// Single
await ipIntel.lookup("8.8.8.8");

// Batch
await ipIntel.lookupBatch(["8.8.8.8", "1.1.1.1"]);
```

### 🧠 NSFW (Browser)

```js
await nsfw.analyze(file);
```

---

### 📝 Text (Browser)

```js
await text.analyze("hello world");
```

---

### ✉️ Email (Browser)

```js
final response = await email.sendVerificationEmail({
  to: "user@example.com",
  fromType: "verify",
  templateData: { username: "John" },
});
// Method 1

await response.verifyOTP("123456");

// Method 2

await email.verifyOTP("123456", response.otpHash);
```

---

## ⚙️ Config

- apiKey → API key
- accountId → Account ID
- apiSecret → Signing secret
- projectId → API instance
- testMode → localhost / production

---

## ⚠️ Security

Do NOT expose apiSecret in production browser apps ❌  
Use backend signing ✔

---

## 📄 License

MIT License

Copyright (c) 2026 Voyant Networks

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:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.