fix: add support for generate-image-stream endpoint and stream mode, better bot detection evasion

Author: k3scat

LICENSE

@@ -18,20 +18,23 @@
 >
 > Built with modern JavaScript/TypeScript features for both browser and Node.js environments, it provides full access to NovelAI's latest models (V3, V4, V4.5) and Director tools while maintaining a clean interface. This project is based on the [NekoAI-API](https://github.com/Nya-Foundation/NekoAI-API) Python package.
 
+### 📄 License Change Notice
+
+> **Important**: This project has transitioned from MIT to **AGPL-3.0** license to ensure better compliance and alignment with our inspiration source. As this work builds significantly upon concepts and approaches from NekoAI-API, we've adopted a more appropriate license that better reflects the collaborative nature of open-source development and provides stronger copyleft protections for the community.
+
 ## 🌟 Core Capabilities
 
 | Feature                     | Description                                                                                            |
 | --------------------------- | ------------------------------------------------------------------------------------------------------ |
 | 🚀 **Lightweight**          | Focuses on image generation and Director tools, providing a simple and easy-to-use interface.          |
 | ⚙️ **Parameterized**        | Provides strongly typed interfaces to easily set up generation parameters with validation.             |
 | 🔑 **Token Authentication** | Supports direct token authentication for API access.                                                   |
+| 🎬 **Real-time Streaming**  | Stream V4/V4.5 generation progress in real-time, watching each denoising step as it happens.           |
 | 🌐 **Cross-Platform**       | Works in both browser and Node.js environments.                                                        |
 | ✨ **Latest Models**        | Full support for V3, V4, and V4.5 models including multi-character generation.                         |
 | 🛠️ **Director Tools**       | Complete support for all NovelAI Director tools like line art, background removal, and emotion change. |
 | 🔄 **TypeScript Support**   | Full TypeScript definitions for all API parameters and responses.                                      |
-| 🖼️ **Flexible Image Input** | Accepts various image input formats (paths, URLs, Blob, File, ArrayBuffer) for cross-platform use.     |
 | 🔁 **Automatic Retries**    | Built-in retry mechanism for handling rate limits and temporary API failures.                          |
-| 📦 **Modular Structure**    | Well-organized, domain-specific modules for better maintainability and code organization.              |
 
 ## 📦 Installation
 
@@ -97,7 +100,7 @@ const images = await client.generateImage({
   prompt: "1girl, cute, anime style, detailed",
   model: Model.V4_5_CUR,
   resPreset: Resolution.NORMAL_PORTRAIT,
-  nSamples: 1,
+  n_samples: 1,
   seed: 1234567890, // Fixed seed for reproducibility
 });
 

README.md

@@ -1,41 +1,31 @@
-const {
-  NovelAI,
-  Model,
-  Resolution,
-  Sampler,
-  createCustomHost,
-} = require("nekoai-js");
+const { NovelAI, Model, Resolution, Sampler } = require("nekoai-js");
 
 // Test function for custom host
 async function testCustomHost() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    host: "https://image.novelai.net", // Official API endpoint
+    // host: "https://your-custom-host.com", // Uncomment to use a custom host
+    verbose: true,
   });
 
-  console.log("Testing custom host...");
-
-  // Create a custom host (this example uses the official API endpoint, but you can use any compatible server)
-  const customHost = createCustomHost(
-    "https://image.novelai.net", // Custom host URL
-  );
-
   try {
     const images = await client.generateImage(
       {
         prompt: "1girl, blue hair, cute, anime style",
         model: Model.V3,
         resPreset: Resolution.NORMAL_PORTRAIT,
-        nSamples: 1,
+        n_samples: 1,
         steps: 28,
         scale: 6.0,
         sampler: Sampler.EULER,
         seed: Math.floor(Math.random() * 4294967288),
         ucPreset: 0,
         qualityToggle: true,
-        negativePrompt:
+        negative_prompt:
           "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit",
       },
-      customHost,
+      false,
       true,
     ); // Use our custom host
 

examples/custom-host-test.js

@@ -42,7 +42,7 @@ async function browserExample() {
     const positivePrompt = metadata.entries.find(
       (e) => e.keyword === "Positive prompt",
     );
-    const negativePrompt = metadata.entries.find(
+    const negative_prompt = metadata.entries.find(
       (e) => e.keyword === "Negative prompt",
     );
     const parameters = metadata.entries.find(
@@ -52,7 +52,7 @@ async function browserExample() {
     document.getElementById("positive").textContent =
       positivePrompt?.text || "";
     document.getElementById("negative").textContent =
-      negativePrompt?.text || "";
+      negative_prompt?.text || "";
     document.getElementById("parameters").textContent = parameters?.text || "";
   }
 
@@ -106,9 +106,9 @@ async function nodeExample() {
           );
         }
 
-        if (summary.negativePrompt) {
+        if (summary.negative_prompt) {
           console.log(
-            `- Negative prompt: ${summary.negativePrompt.substring(0, 100)}...`,
+            `- Negative prompt: ${summary.negative_prompt.substring(0, 100)}...`,
           );
         }
 

examples/extract-metadata.js

@@ -6,6 +6,7 @@ require("dotenv").config();
 async function testImg2Img() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   console.log("Testing img2img generation...");
@@ -36,13 +37,13 @@ async function testImg2Img() {
         action: Action.IMG2IMG,
         width: dimensions.width,
         height: dimensions.height,
-        nSamples: 1,
+        n_samples: 1,
         steps: 28,
         scale: 7.0,
         sampler: Sampler.DPM2S_ANC,
-        dynamicThresholding: false,
-        cfgRescale: 0,
-        noiseSchedule: Noise.KARRAS,
+        dynamic_thresholding: false,
+        cfg_rescale: 0,
+        noise_schedule: Noise.KARRAS,
         seed: Math.floor(Math.random() * 4294967288),
         ucPreset: 0,
         qualityToggle: true,
@@ -52,7 +53,7 @@ async function testImg2Img() {
         strength: 0.7, // How much to change the image (0.01-0.99)
         noise: 0.2, // How much noise to add
 
-        negativePrompt:
+        negative_prompt:
           "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit",
       },
       undefined,

examples/img2img-test.js

@@ -6,6 +6,7 @@ require("dotenv").config();
 async function testImg2Img45Full() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   console.log("Testing img2img V4.5 generation...");
@@ -36,15 +37,15 @@ async function testImg2Img45Full() {
         action: Action.IMG2IMG,
         width: dimensions.width,
         height: dimensions.height,
-        nSamples: 1,
+        n_samples: 1,
         steps: 28,
         scale: 5.5,
         sampler: Sampler.DPM2S_ANC,
-        dynamicThresholding: false,
-        cfgRescale: 0,
-        noiseSchedule: Noise.KARRAS,
+        dynamic_thresholding: false,
+        cfg_rescale: 0,
+        noise_schedule: Noise.KARRAS,
         seed: Math.floor(Math.random() * 4294967288),
-        extraNoiseSeed: Math.floor(Math.random() * 4294967288),
+        extra_noise_seed: Math.floor(Math.random() * 4294967288),
         ucPreset: 0,
         qualityToggle: true,
 
@@ -53,7 +54,7 @@ async function testImg2Img45Full() {
         strength: 0.7, // How much to change the image (0.01-0.99)
         noise: 0.2, // How much noise to add
 
-        negativePrompt:
+        negative_prompt:
           "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit",
       },
       undefined,

examples/img2img-v4.5-test.js

@@ -6,6 +6,7 @@ require("dotenv").config();
 async function testInpaint() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   return; // Disable inpainting test for now
@@ -42,24 +43,24 @@ async function testInpaint() {
         action: Action.INPAINT,
         width: dimensions.width,
         height: dimensions.height,
-        nSamples: 1,
+        n_samples: 1,
         steps: 28,
         scale: 7.0,
         sampler: Sampler.EULER,
-        dynamicThresholding: false,
-        cfgRescale: 0,
-        noiseSchedule: Noise.KARRAS,
+        dynamic_thresholding: false,
+        cfg_rescale: 0,
+        noise_schedule: Noise.KARRAS,
         seed: Math.floor(Math.random() * 4294967288),
-        extraNoiseSeed: Math.floor(Math.random() * 4294967288),
+        extra_noise_seed: Math.floor(Math.random() * 4294967288),
         ucPreset: 0,
         qualityToggle: true,
 
         // inpaint specific parameters
         image: base64Image,
         mask: base64Mask,
-        addOriginalImage: true, // Overlay the original image
+        add_original_image: true, // Overlay the original image
 
-        negativePrompt:
+        negative_prompt:
           "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit",
       },
       undefined,

examples/inpaint-test.js

@@ -5,6 +5,7 @@ require("dotenv").config(); // Load environment variables from .env file
 async function testModelV3() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   console.log("Testing Model V3 generation...");
@@ -15,13 +16,13 @@ async function testModelV3() {
         prompt: "1girl, blue hair, cute, anime style",
         model: Model.V3,
         resPreset: Resolution.NORMAL_PORTRAIT,
-        nSamples: 1,
+        n_samples: 1,
         steps: 28,
         scale: 6.3,
         sampler: Sampler.DPM2S_ANC,
         sm: true,
-        smDyn: true,
-        negativePrompt:
+        sm_dyn: true,
+        negative_prompt:
           "nsfw, lowres, {bad}, error, fewer, extra, missing, worst quality, jpeg artifacts, bad quality",
       },
       undefined,

examples/model-v3-test.js

@@ -1,28 +1,30 @@
-const { NovelAI, Model, Resolution, Sampler, Noise } = require("nekoai-js");
+const { NovelAI, Model, Resolution, Sampler } = require("nekoai-js");
+const Stream = require("stream");
 require("dotenv").config();
 
 // Test function for V4 model generation
 async function testModelV45Full() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   console.log("Testing Model V4.5 generation...");
 
   try {
     const images = await client.generateImage(
       {
-        prompt: "1girl, blue hair, cute, anime style",
+        prompt: "1girl, cute",
+        negative_prompt: "1234",
         model: Model.V4_5,
         resPreset: Resolution.NORMAL_PORTRAIT,
-        nSamples: 1,
-        steps: 28,
-        scale: 5.5,
+        seed: 3417044607,
+        steps: 30,
+        scale: 5,
         sampler: Sampler.EULER_ANC,
-        noiseSchedule: Noise.KARRAS,
-        ucPreset: 0,
+        ucPreset: 3,
       },
-      undefined,
+      false,
       true,
     ); // Set verbose to true to see Anlas cost
 

examples/model-v4-5-full-test.js

@@ -5,6 +5,7 @@ require("dotenv").config();
 async function testModelV45MultiChar() {
   const client = new NovelAI({
     token: process.env.NOVELAI_TOKEN,
+    verbose: true,
   });
 
   console.log("Testing Model V4.5 with multiple characters...");
@@ -18,8 +19,8 @@ async function testModelV45MultiChar() {
         steps: 28,
         scale: 5.5,
         sampler: "k_euler_ancestral",
-        noiseSchedule: "karras",
-        negativePrompt:
+        noise_schedule: "karras",
+        negative_prompt:
           "nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers, extra digit",
         // Character prompts for multiple characters
         characterPrompts: [