@runware/sdk-js 1.1.5 → 1.1.7

package/dist/index.d.mts

@@ -34,6 +34,10 @@ interface IImage {
     NSFWContent?: boolean;
     cost?: number;
 }
+interface ITextToImage extends IImage {
+    positivePrompt?: string;
+    negativePrompt?: string;
+}
 interface IControlNetImage {
     taskUUID: string;
     inputImageUUID: string;
@@ -110,6 +114,7 @@ interface IRequestImage {
     customTaskUUID?: string;
     useCache?: boolean;
     onPartialImages?: (images: IImage[], error?: IError) => void;
+    retry?: number;
 }
 interface IRequestImageToText {
     inputImage?: File | string;
@@ -266,10 +271,12 @@ declare class RunwareBase {
     protected send: (msg: Object) => any;
     private destroy;
     private uploadImage;
-    listenToImages({ onPartialImages, taskUUID, groupKey, }: {
+    listenToImages({ onPartialImages, taskUUID, groupKey, positivePrompt, negativePrompt, }: {
         taskUUID: string;
         onPartialImages?: (images: IImage[], error?: any) => void;
         groupKey: LISTEN_TO_IMAGES_KEY;
+        positivePrompt?: string;
+        negativePrompt?: string;
     }): {
         destroy: () => void;
     };
@@ -278,7 +285,7 @@ declare class RunwareBase {
     }): {
         destroy: () => void;
     };
-    requestImages({ outputType, outputFormat, uploadEndpoint, checkNsfw, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, numberResults, controlNet, lora, useCache, onPartialImages, includeCost, customTaskUUID, }: IRequestImage): Promise<IImage[] | undefined>;
+    requestImages({ outputType, outputFormat, uploadEndpoint, checkNsfw, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, numberResults, controlNet, lora, useCache, onPartialImages, includeCost, customTaskUUID, retry, }: IRequestImage): Promise<ITextToImage[] | undefined>;
     controlNetPreProcess: ({ inputImage, preProcessor, height, width, outputType, outputFormat, highThresholdCanny, lowThresholdCanny, includeHandsAndFaceOpenPose, includeCost, customTaskUUID, }: IControlNetPreprocess) => Promise<IControlNetImage | null>;
     requestImageToText: ({ inputImage, includeCost, customTaskUUID, }: IRequestImageToText) => Promise<IImageToText>;
     removeImageBackground: ({ inputImage, outputType, outputFormat, rgba, postProcessMask, returnOnlyMask, alphaMatting, alphaMattingForegroundThreshold, alphaMattingBackgroundThreshold, alphaMattingErodeSize, includeCost, customTaskUUID, }: IRemoveImageBackground) => Promise<IRemoveImage[]>;
@@ -318,4 +325,4 @@ declare class RunwareServer extends RunwareBase {
     protected heartBeat(): void;
 }
 
-export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, ETaskType, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetGeneral, IControlNetImage, IControlNetPreprocess, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IOutputFormat, IOutputType, IPromptEnhancer, IRemoveImage, IRemoveImageBackground, IRequestImage, IRequestImageToText, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };
+export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, ETaskType, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetGeneral, IControlNetImage, IControlNetPreprocess, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IOutputFormat, IOutputType, IPromptEnhancer, IRemoveImage, IRemoveImageBackground, IRequestImage, IRequestImageToText, ITextToImage, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };

package/dist/index.d.ts

@@ -34,6 +34,10 @@ interface IImage {
     NSFWContent?: boolean;
     cost?: number;
 }
+interface ITextToImage extends IImage {
+    positivePrompt?: string;
+    negativePrompt?: string;
+}
 interface IControlNetImage {
     taskUUID: string;
     inputImageUUID: string;
@@ -110,6 +114,7 @@ interface IRequestImage {
     customTaskUUID?: string;
     useCache?: boolean;
     onPartialImages?: (images: IImage[], error?: IError) => void;
+    retry?: number;
 }
 interface IRequestImageToText {
     inputImage?: File | string;
@@ -266,10 +271,12 @@ declare class RunwareBase {
     protected send: (msg: Object) => any;
     private destroy;
     private uploadImage;
-    listenToImages({ onPartialImages, taskUUID, groupKey, }: {
+    listenToImages({ onPartialImages, taskUUID, groupKey, positivePrompt, negativePrompt, }: {
         taskUUID: string;
         onPartialImages?: (images: IImage[], error?: any) => void;
         groupKey: LISTEN_TO_IMAGES_KEY;
+        positivePrompt?: string;
+        negativePrompt?: string;
     }): {
         destroy: () => void;
     };
@@ -278,7 +285,7 @@ declare class RunwareBase {
     }): {
         destroy: () => void;
     };
-    requestImages({ outputType, outputFormat, uploadEndpoint, checkNsfw, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, numberResults, controlNet, lora, useCache, onPartialImages, includeCost, customTaskUUID, }: IRequestImage): Promise<IImage[] | undefined>;
+    requestImages({ outputType, outputFormat, uploadEndpoint, checkNsfw, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, numberResults, controlNet, lora, useCache, onPartialImages, includeCost, customTaskUUID, retry, }: IRequestImage): Promise<ITextToImage[] | undefined>;
     controlNetPreProcess: ({ inputImage, preProcessor, height, width, outputType, outputFormat, highThresholdCanny, lowThresholdCanny, includeHandsAndFaceOpenPose, includeCost, customTaskUUID, }: IControlNetPreprocess) => Promise<IControlNetImage | null>;
     requestImageToText: ({ inputImage, includeCost, customTaskUUID, }: IRequestImageToText) => Promise<IImageToText>;
     removeImageBackground: ({ inputImage, outputType, outputFormat, rgba, postProcessMask, returnOnlyMask, alphaMatting, alphaMattingForegroundThreshold, alphaMattingBackgroundThreshold, alphaMattingErodeSize, includeCost, customTaskUUID, }: IRemoveImageBackground) => Promise<IRemoveImage[]>;
@@ -318,4 +325,4 @@ declare class RunwareServer extends RunwareBase {
     protected heartBeat(): void;
 }
 
-export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, ETaskType, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetGeneral, IControlNetImage, IControlNetPreprocess, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IOutputFormat, IOutputType, IPromptEnhancer, IRemoveImage, IRemoveImageBackground, IRequestImage, IRequestImageToText, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };
+export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, ETaskType, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetGeneral, IControlNetImage, IControlNetPreprocess, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IOutputFormat, IOutputType, IPromptEnhancer, IRemoveImage, IRemoveImageBackground, IRequestImage, IRequestImageToText, ITextToImage, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };

package/dist/index.js

@@ -842,9 +842,7 @@ var RunwareBase = class {
         lis: (m) => {
           var _a, _b;
           if (m == null ? void 0 : m.error) {
-            if (m.errorId === 19) {
-              this._invalidAPIkey = "Invalid API key";
-            }
+            this._invalidAPIkey = "Invalid API key";
             return;
           }
           this._connectionSessionUUID = (_b = (_a = m == null ? void 0 : m["authentication" /* AUTHENTICATION */]) == null ? void 0 : _a[0]) == null ? void 0 : _b.connectionSessionUUID;
@@ -874,15 +872,21 @@ var RunwareBase = class {
   listenToImages({
     onPartialImages,
     taskUUID,
-    groupKey
+    groupKey,
+    positivePrompt,
+    negativePrompt
   }) {
     return this.addListener({
       taskUUID,
       lis: (m) => {
         var _a, _b;
-        const images = (_a = m == null ? void 0 : m[taskUUID]) == null ? void 0 : _a.filter(
+        let images = (_a = m == null ? void 0 : m[taskUUID]) == null ? void 0 : _a.filter(
           (img) => img.taskUUID === taskUUID
         );
+        images = images.map((image) => __spreadProps(__spreadValues({}, image), {
+          positivePrompt,
+          negativePrompt
+        }));
         onPartialImages == null ? void 0 : onPartialImages(images, (m == null ? void 0 : m.error) && m);
         if (m.error) {
           this._globalError = m;
@@ -890,7 +894,10 @@ var RunwareBase = class {
           if (this._sdkType === "CLIENT" /* CLIENT */) {
             this._globalImages = [
               ...this._globalImages,
-              ...(_b = m == null ? void 0 : m[taskUUID]) != null ? _b : []
+              ...((_b = m == null ? void 0 : m[taskUUID]) != null ? _b : []).map((image) => __spreadProps(__spreadValues({}, image), {
+                positivePrompt,
+                negativePrompt
+              }))
             ];
           } else {
             this._globalImages = [...this._globalImages, ...images];
@@ -961,8 +968,10 @@ var RunwareBase = class {
     useCache,
     onPartialImages,
     includeCost,
-    customTaskUUID
+    customTaskUUID,
+    retry = 2
   }) {
+    await this.ensureConnection();
     let lis = void 0;
     let requestObject = void 0;
     let taskUUIDs = [];
@@ -1049,7 +1058,9 @@ var RunwareBase = class {
           lis = this.listenToImages({
             onPartialImages,
             taskUUID,
-            groupKey: "REQUEST_IMAGES" /* REQUEST_IMAGES */
+            groupKey: "REQUEST_IMAGES" /* REQUEST_IMAGES */,
+            positivePrompt,
+            negativePrompt
           });
           const promise = await this.getSimilarImages({
             taskUUID: taskUUIDs,
@@ -1059,14 +1070,14 @@ var RunwareBase = class {
           return promise;
         },
         {
-          maxRetries: 2,
+          maxRetries: retry,
           callback: () => {
             lis == null ? void 0 : lis.destroy();
           }
         }
       );
     } catch (e) {
-      if (retryCount >= 2) {
+      if (retryCount >= retry) {
         return this.handleIncompleteImages({ taskUUIDs, error: e });
       }
     }
@@ -1076,31 +1087,52 @@ var RunwareBase = class {
     let isConnected = this.connected();
     if (isConnected || this._url === BASE_RUNWARE_URLS.TEST)
       return;
-    const interval = 200;
+    const retryInterval = 2e3;
+    const pollingInterval = 200;
     try {
       if (this._invalidAPIkey)
         throw this._invalidAPIkey;
       return new Promise((resolve, reject) => {
         let retry = 0;
-        const MAX_RETRY = 2;
-        const intervalId = setInterval(async () => {
-          try {
-            const hasConnected = this.connected();
-            if (hasConnected) {
-              clearInterval(intervalId);
-              resolve(true);
-            } else if (retry >= MAX_RETRY) {
-              clearInterval(intervalId);
-              reject(new Error("Polling timed out"));
-            } else {
-              this.connect();
-              retry++;
+        const MAX_RETRY = 10;
+        let retryIntervalId;
+        let pollingIntervalId;
+        const clearAllIntervals = () => {
+          clearInterval(retryIntervalId);
+          clearInterval(pollingIntervalId);
+        };
+        if (this._sdkType === "SERVER" /* SERVER */) {
+          retryIntervalId = setInterval(async () => {
+            try {
+              const hasConnected = this.connected();
+              if (hasConnected) {
+                clearAllIntervals();
+                resolve(true);
+              } else if (retry >= MAX_RETRY) {
+                clearAllIntervals();
+                reject(new Error("Retry timed out"));
+              } else {
+                this.connect();
+                retry++;
+              }
+            } catch (error) {
+              clearAllIntervals();
+              reject(error);
             }
-          } catch (error) {
-            clearInterval(intervalId);
-            reject(error);
+          }, retryInterval);
+        }
+        pollingIntervalId = setInterval(async () => {
+          const hasConnected = this.connected();
+          if (hasConnected) {
+            clearAllIntervals();
+            resolve(true);
+          }
+          if (!!this._invalidAPIkey) {
+            clearAllIntervals();
+            reject(new Error("Invalid API key"));
+            return;
           }
-        }, interval);
+        }, pollingInterval);
       });
       if (!isConnected) {
         this.connect();
@@ -1220,7 +1252,6 @@ var RunwareServer = class extends RunwareBase {
     this._ws = new import_ws.default(this._url, {
       perMessageDeflate: false
     });
-    delay(1);
     this._ws.on("error", () => {
     });
     this._ws.on("close", () => this.handleClose());
@@ -1247,9 +1278,7 @@ var RunwareServer = class extends RunwareBase {
         lis: (m) => {
           var _a, _b;
           if (m == null ? void 0 : m.error) {
-            if (m.errorId === 19) {
-              this._invalidAPIkey = "Invalid API key";
-            }
+            this._invalidAPIkey = "Invalid API key";
             return;
           }
           this._connectionSessionUUID = (_b = (_a = m == null ? void 0 : m["authentication" /* AUTHENTICATION */]) == null ? void 0 : _a[0]) == null ? void 0 : _b.connectionSessionUUID;

package/dist/index.mjs

@@ -821,9 +821,7 @@ var RunwareBase = class {
         lis: (m) => {
           var _a, _b;
           if (m == null ? void 0 : m.error) {
-            if (m.errorId === 19) {
-              this._invalidAPIkey = "Invalid API key";
-            }
+            this._invalidAPIkey = "Invalid API key";
             return;
           }
           this._connectionSessionUUID = (_b = (_a = m == null ? void 0 : m["authentication" /* AUTHENTICATION */]) == null ? void 0 : _a[0]) == null ? void 0 : _b.connectionSessionUUID;
@@ -853,15 +851,21 @@ var RunwareBase = class {
   listenToImages({
     onPartialImages,
     taskUUID,
-    groupKey
+    groupKey,
+    positivePrompt,
+    negativePrompt
   }) {
     return this.addListener({
       taskUUID,
       lis: (m) => {
         var _a, _b;
-        const images = (_a = m == null ? void 0 : m[taskUUID]) == null ? void 0 : _a.filter(
+        let images = (_a = m == null ? void 0 : m[taskUUID]) == null ? void 0 : _a.filter(
           (img) => img.taskUUID === taskUUID
         );
+        images = images.map((image) => __spreadProps(__spreadValues({}, image), {
+          positivePrompt,
+          negativePrompt
+        }));
         onPartialImages == null ? void 0 : onPartialImages(images, (m == null ? void 0 : m.error) && m);
         if (m.error) {
           this._globalError = m;
@@ -869,7 +873,10 @@ var RunwareBase = class {
           if (this._sdkType === "CLIENT" /* CLIENT */) {
             this._globalImages = [
               ...this._globalImages,
-              ...(_b = m == null ? void 0 : m[taskUUID]) != null ? _b : []
+              ...((_b = m == null ? void 0 : m[taskUUID]) != null ? _b : []).map((image) => __spreadProps(__spreadValues({}, image), {
+                positivePrompt,
+                negativePrompt
+              }))
             ];
           } else {
             this._globalImages = [...this._globalImages, ...images];
@@ -940,8 +947,10 @@ var RunwareBase = class {
     useCache,
     onPartialImages,
     includeCost,
-    customTaskUUID
+    customTaskUUID,
+    retry = 2
   }) {
+    await this.ensureConnection();
     let lis = void 0;
     let requestObject = void 0;
     let taskUUIDs = [];
@@ -1028,7 +1037,9 @@ var RunwareBase = class {
           lis = this.listenToImages({
             onPartialImages,
             taskUUID,
-            groupKey: "REQUEST_IMAGES" /* REQUEST_IMAGES */
+            groupKey: "REQUEST_IMAGES" /* REQUEST_IMAGES */,
+            positivePrompt,
+            negativePrompt
           });
           const promise = await this.getSimilarImages({
             taskUUID: taskUUIDs,
@@ -1038,14 +1049,14 @@ var RunwareBase = class {
           return promise;
         },
         {
-          maxRetries: 2,
+          maxRetries: retry,
           callback: () => {
             lis == null ? void 0 : lis.destroy();
           }
         }
       );
     } catch (e) {
-      if (retryCount >= 2) {
+      if (retryCount >= retry) {
         return this.handleIncompleteImages({ taskUUIDs, error: e });
       }
     }
@@ -1055,31 +1066,52 @@ var RunwareBase = class {
     let isConnected = this.connected();
     if (isConnected || this._url === BASE_RUNWARE_URLS.TEST)
       return;
-    const interval = 200;
+    const retryInterval = 2e3;
+    const pollingInterval = 200;
     try {
       if (this._invalidAPIkey)
         throw this._invalidAPIkey;
       return new Promise((resolve, reject) => {
         let retry = 0;
-        const MAX_RETRY = 2;
-        const intervalId = setInterval(async () => {
-          try {
-            const hasConnected = this.connected();
-            if (hasConnected) {
-              clearInterval(intervalId);
-              resolve(true);
-            } else if (retry >= MAX_RETRY) {
-              clearInterval(intervalId);
-              reject(new Error("Polling timed out"));
-            } else {
-              this.connect();
-              retry++;
+        const MAX_RETRY = 10;
+        let retryIntervalId;
+        let pollingIntervalId;
+        const clearAllIntervals = () => {
+          clearInterval(retryIntervalId);
+          clearInterval(pollingIntervalId);
+        };
+        if (this._sdkType === "SERVER" /* SERVER */) {
+          retryIntervalId = setInterval(async () => {
+            try {
+              const hasConnected = this.connected();
+              if (hasConnected) {
+                clearAllIntervals();
+                resolve(true);
+              } else if (retry >= MAX_RETRY) {
+                clearAllIntervals();
+                reject(new Error("Retry timed out"));
+              } else {
+                this.connect();
+                retry++;
+              }
+            } catch (error) {
+              clearAllIntervals();
+              reject(error);
             }
-          } catch (error) {
-            clearInterval(intervalId);
-            reject(error);
+          }, retryInterval);
+        }
+        pollingIntervalId = setInterval(async () => {
+          const hasConnected = this.connected();
+          if (hasConnected) {
+            clearAllIntervals();
+            resolve(true);
+          }
+          if (!!this._invalidAPIkey) {
+            clearAllIntervals();
+            reject(new Error("Invalid API key"));
+            return;
           }
-        }, interval);
+        }, pollingInterval);
       });
       if (!isConnected) {
         this.connect();
@@ -1199,7 +1231,6 @@ var RunwareServer = class extends RunwareBase {
     this._ws = new WebSocket2(this._url, {
       perMessageDeflate: false
     });
-    delay(1);
     this._ws.on("error", () => {
     });
     this._ws.on("close", () => this.handleClose());
@@ -1226,9 +1257,7 @@ var RunwareServer = class extends RunwareBase {
         lis: (m) => {
           var _a, _b;
           if (m == null ? void 0 : m.error) {
-            if (m.errorId === 19) {
-              this._invalidAPIkey = "Invalid API key";
-            }
+            this._invalidAPIkey = "Invalid API key";
             return;
           }
           this._connectionSessionUUID = (_b = (_a = m == null ? void 0 : m["authentication" /* AUTHENTICATION */]) == null ? void 0 : _a[0]) == null ? void 0 : _b.connectionSessionUUID;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runware/sdk-js",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "The SDK is used to run image inference with the Runware API, powered by the RunWare inference platform. It can be used to generate imaged with text-to-image and image-to-image. It also allows the use of an existing gallery of models or selecting any model or LoRA from the CivitAI gallery. The API also supports upscaling, background removal, inpainting and outpainting, and a series of other ControlNet models.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/readme.md

@@ -13,13 +13,13 @@ For an API Key and free trial credits, [create a free account](https://my.runwar
 To install and set up the library, run:
 
 ```sh
-$  npm  install  runware-sdk
+$  npm  install  @runware/sdk-js
 ```
 
 Or if you prefer using Yarn:
 
 ```sh
-$  yarn  add  runware-sdk
+$  yarn  add  @runware/sdk-js
 ```
 
 ## Instantiating the SDK
@@ -44,6 +44,8 @@ const  runware  =  new RunwareServer({ apiKey: "API_KEY" });
 NB: All errors can be caught in the catch block of each request
 
 ```js
+import { Runware } from "@runware/sdk-js";
+
 const  runware  =  new  Runware({ apiKey: "API_KEY" });
 const images = await runware.requestImages({
 	positivePrompt: string;
@@ -67,13 +69,15 @@ const images = await runware.requestImages({
 	usePromptWeighting?: number;
 	controlNet?: IControlNet[];
 	lora?: ILora[];
+  	retry?: number;
+
 
 	useCache?: boolean;
 	returnBase64Image?: boolean;
 	onPartialImages?: (images: IImage[], error: IError) =>  void;
 })
 
-return interface IImage {
+return interface ITextToImage {
 	taskType: ETaskType;
 	imageUUID: string;
 	inputImageUUID?: string;
@@ -83,6 +87,8 @@ return interface IImage {
 	imageDataURI?: string;
 	NSFWContent?: boolean;
 	cost: number;
+	positivePrompt?: string;
+  	negativePrompt?: string;
 }[]
 ```
 
@@ -113,7 +119,7 @@ const [firstImagesRequest, secondImagesRequest] = await Promise.all([
 
 console.log({firstImagesRequest, secondImagesRequest})
 
-return interface IImage {
+return interface ITextToImage {
 	taskType: ETaskType;
 	imageUUID: string;
 	inputImageUUID?: string;
@@ -123,6 +129,8 @@ return interface IImage {
 	imageDataURI?: string;
 	NSFWContent?: boolean;
 	cost: number;
+	positivePrompt?: string;
+  	negativePrompt?: string;
 }[]
 ```
 
@@ -356,6 +364,20 @@ return interface IControlNetImage {
 
 ## Changelog
 
+### - v1.1.6
+
+**Added or Changed**
+
+- Fix slow connection time
+- Fix invalid api key error message
+- Return prompt for images generated
+
+### - v1.1.6
+
+**Added or Changed**
+
+- Add connection retry to runware server
+
 ### - v1.1.5
 
 **Added or Changed**