@runware/sdk-js 1.1.11 → 1.1.13

package/dist/esm/tests/Runware/upscale-gan.test.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const test_utils_1 = require("../test-utils");
+const mockServer_1 = require("../mockServer");
+const Runware_1 = require("../../Runware");
+vitest_1.vi.mock("../../Runware/utils", async () => {
+    const actual = await vitest_1.vi.importActual("../../Runware/utils");
+    return Object.assign(Object.assign({}, actual), { fileToBase64: vitest_1.vi.fn().mockReturnValue("FILE_TO_BASE_64"), getIntervalWithPromise: vitest_1.vi.fn(), getUUID: vitest_1.vi.fn().mockImplementation(() => "UNIQUE_UID") });
+});
+(0, vitest_1.describe)("When user request to upscale gan", async () => {
+    const { mockServer, runware } = await (0, mockServer_1.startMockServer)();
+    (0, vitest_1.afterEach)(() => {
+        vitest_1.vi.clearAllMocks();
+    });
+    (0, vitest_1.beforeEach)(() => {
+        mockServer.stop();
+    });
+    (0, vitest_1.beforeAll)(async () => {
+        vitest_1.vi.spyOn(runware, "uploadImage").mockReturnValue(test_utils_1.testExamples.imageUploadRes);
+    });
+    (0, vitest_1.test)("it should upscale gan", async () => {
+        const imageUploadSpy = vitest_1.vi.spyOn(runware, "uploadImage");
+        const globalListenerSpy = vitest_1.vi.spyOn(runware, "globalListener");
+        const sendSpy = vitest_1.vi.spyOn(runware, "send");
+        await runware.upscaleGan({
+            inputImage: test_utils_1.mockUploadFile,
+            upscaleFactor: 2,
+        });
+        (0, vitest_1.expect)(imageUploadSpy).toHaveBeenCalled();
+        (0, vitest_1.expect)(sendSpy).toHaveBeenCalledWith({
+            inputImage: test_utils_1.testExamples.imageUploadRes.imageUUID,
+            taskUUID: test_utils_1.mockTaskUUID,
+            upscaleFactor: 2,
+            taskType: Runware_1.ETaskType.IMAGE_UPSCALE,
+        });
+        (0, vitest_1.expect)(globalListenerSpy).toHaveBeenCalledWith({
+            taskUUID: test_utils_1.mockTaskUUID,
+        });
+    });
+});

package/dist/esm/tests/mockServer.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="ws" />
+/// <reference types="node" />
+import { Server } from "mock-socket";
+import { RunwareServer } from "../Runware";
+export declare const startMockServer: () => Promise<{
+    runware: import("../Runware").RunwareClient | RunwareServer;
+    mockServer: Server;
+}>;
+export declare const startMockBackendServer: () => Promise<{
+    runwareServer: RunwareServer;
+    mockServer: import("ws").Server<typeof import("ws"), typeof import("http").IncomingMessage>;
+}>;

package/dist/esm/tests/mockServer.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startMockBackendServer = exports.startMockServer = void 0;
+const mock_socket_1 = require("mock-socket");
+const Runware_1 = require("../Runware");
+const utils_1 = require("../Runware/utils");
+const ws_1 = require("ws");
+const startMockServer = async () => {
+    const mockServer = new mock_socket_1.Server("ws://localhost:8080");
+    mockServer.on("connection", (socket) => {
+        socket.on("message", (data) => {
+            //   socket.send("test message from mock server");
+        });
+    });
+    const runware = new Runware_1.Runware({
+        apiKey: "API_KEY",
+        url: utils_1.BASE_RUNWARE_URLS.TEST,
+    });
+    await (0, utils_1.delay)(1);
+    return { runware, mockServer };
+};
+exports.startMockServer = startMockServer;
+const startMockBackendServer = async () => {
+    const mockServer = new ws_1.WebSocketServer({ port: 8080 });
+    mockServer.on("connection", (socket) => {
+        socket.on("message", (data, isBinary) => {
+            const message = !isBinary ? data === null || data === void 0 ? void 0 : data.toString() : data;
+            //   socket.send("test message from mock server");
+        });
+    });
+    const runwareServer = new Runware_1.RunwareServer({
+        apiKey: "API_KEY",
+        url: utils_1.BASE_RUNWARE_URLS.TEST,
+    });
+    await (0, utils_1.delay)(1);
+    return { runwareServer, mockServer };
+};
+exports.startMockBackendServer = startMockBackendServer;

package/dist/esm/tests/test-utils.d.ts

@@ -0,0 +1,39 @@
+import { EControlMode, ETaskType } from "../Runware";
+export declare const mockTaskUUID = "UNIQUE_UID";
+export declare const mockTextImageUpload = "IMAGE_UPLOAD";
+export declare const mockFileToBase64 = "FILE_TO_BASE_64";
+export declare const mockNewImageUID = "NEW_IMAGE_UID";
+export declare const mockUploadFile: any;
+export declare const testExamples: {
+    imageReq: {
+        numberResults: number;
+        positivePrompt: string;
+        model: number;
+        steps: number;
+        width: number;
+        height: number;
+    };
+    imageRes: {
+        model: number;
+        numberResults: number;
+        positivePrompt: string;
+        steps: number;
+        taskType: ETaskType;
+        taskUUID: string;
+        width: number;
+        height: number;
+    };
+    imageUploadRes: {
+        imageUUID: string;
+        imageURL: string;
+        taskUUID: string;
+    };
+    controlNet: {
+        endStep: number;
+        startStep: number;
+        guideImage: string;
+        preprocessor: any;
+        weight: number;
+        controlMode: EControlMode;
+    };
+};

package/dist/esm/tests/test-utils.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testExamples = exports.mockUploadFile = exports.mockNewImageUID = exports.mockFileToBase64 = exports.mockTextImageUpload = exports.mockTaskUUID = void 0;
+const Runware_1 = require("../Runware");
+const utils_1 = require("../Runware/utils");
+const promptText = "A beautiful runware";
+exports.mockTaskUUID = "UNIQUE_UID";
+exports.mockTextImageUpload = "IMAGE_UPLOAD";
+exports.mockFileToBase64 = "FILE_TO_BASE_64";
+exports.mockNewImageUID = "NEW_IMAGE_UID";
+exports.mockUploadFile = new utils_1.MockFile().create("pic.jpg", 1024 * 1024 * 2, "image/jpeg");
+exports.testExamples = {
+    imageReq: {
+        numberResults: 8,
+        positivePrompt: promptText,
+        model: 13,
+        steps: 30,
+        width: 512,
+        height: 512,
+    },
+    imageRes: {
+        model: 13,
+        numberResults: 8,
+        positivePrompt: promptText,
+        steps: 30,
+        taskType: Runware_1.ETaskType.IMAGE_INFERENCE,
+        taskUUID: exports.mockTaskUUID,
+        width: 512,
+        height: 512,
+    },
+    imageUploadRes: {
+        imageUUID: exports.mockNewImageUID,
+        imageURL: "data:image/png;base64,iVBORw0KGgoAAAA...",
+        taskUUID: "50836053-a0ee-4cf5-b9d6-ae7c5d140ada",
+    },
+    controlNet: {
+        endStep: 20,
+        startStep: 0,
+        guideImage: exports.mockTextImageUpload,
+        preprocessor: "canny",
+        weight: 1,
+        controlMode: Runware_1.EControlMode.CONTROL_NET,
+    },
+};

package/dist/index.d.mts

@@ -299,6 +299,6 @@ declare class RunwareServer extends RunwareBase {
     protected heartBeat(): void;
 }
 
-declare let Runware: any;
+declare let Runware: typeof RunwareClient | typeof RunwareServer;
 
 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, RunwareClient, RunwareServer, SdkType, UploadImageType };

package/dist/index.d.ts

@@ -299,6 +299,6 @@ declare class RunwareServer extends RunwareBase {
     protected heartBeat(): void;
 }
 
-declare let Runware: any;
+declare let Runware: typeof RunwareClient | typeof RunwareServer;
 
 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, RunwareClient, RunwareServer, SdkType, UploadImageType };

package/dist/index.js

@@ -462,35 +462,12 @@ var RunwareBase = class {
             };
           }
           const imageBase64 = typeof file === "string" ? file : await fileToBase64(file);
-          this.send({
-            taskType: "imageUpload" /* IMAGE_UPLOAD */,
-            image: imageBase64,
-            taskUUID
-          });
-          const lis = this.globalListener({
-            taskUUID
-          });
-          const image = await getIntervalWithPromise(
-            ({ resolve, reject }) => {
-              const uploadedImage = this.getSingleMessage({
-                taskUUID
-              });
-              if (!uploadedImage)
-                return;
-              if (uploadedImage == null ? void 0 : uploadedImage.error) {
-                reject(uploadedImage);
-                return true;
-              }
-              if (uploadedImage) {
-                delete this._globalMessages[taskUUID];
-                resolve(uploadedImage);
-                return true;
-              }
-            },
-            { debugKey: "upload-image" }
-          );
-          lis.destroy();
-          return image;
+          return {
+            imageURL: imageBase64,
+            imageUUID: imageBase64,
+            taskUUID,
+            taskType: "imageUpload" /* IMAGE_UPLOAD */
+          };
         });
       } catch (e) {
         throw e;
@@ -650,7 +627,7 @@ var RunwareBase = class {
               }
               if (newRemoveBackground) {
                 delete this._globalMessages[taskUUID];
-                resolve([newRemoveBackground]);
+                resolve(newRemoveBackground);
                 return true;
               }
             },
@@ -697,7 +674,7 @@ var RunwareBase = class {
               }
               if (newUpscaleGan) {
                 delete this._globalMessages[taskUUID];
-                resolve([newUpscaleGan]);
+                resolve(newUpscaleGan);
                 return true;
               }
             },
@@ -1092,6 +1069,7 @@ var RunwareBase = class {
       return new Promise((resolve, reject) => {
         let retry = 0;
         const MAX_RETRY = 30;
+        const SHOULD_RETRY = 30 / 2 === retry;
         let retryIntervalId;
         let pollingIntervalId;
         const clearAllIntervals = () => {
@@ -1109,7 +1087,9 @@ var RunwareBase = class {
                 clearAllIntervals();
                 reject(new Error("Retry timed out"));
               } else {
-                this.connect();
+                if (SHOULD_RETRY) {
+                  this.connect();
+                }
                 retry++;
               }
             } catch (error) {

package/dist/index.mjs

@@ -440,35 +440,12 @@ var RunwareBase = class {
             };
           }
           const imageBase64 = typeof file === "string" ? file : await fileToBase64(file);
-          this.send({
-            taskType: "imageUpload" /* IMAGE_UPLOAD */,
-            image: imageBase64,
-            taskUUID
-          });
-          const lis = this.globalListener({
-            taskUUID
-          });
-          const image = await getIntervalWithPromise(
-            ({ resolve, reject }) => {
-              const uploadedImage = this.getSingleMessage({
-                taskUUID
-              });
-              if (!uploadedImage)
-                return;
-              if (uploadedImage == null ? void 0 : uploadedImage.error) {
-                reject(uploadedImage);
-                return true;
-              }
-              if (uploadedImage) {
-                delete this._globalMessages[taskUUID];
-                resolve(uploadedImage);
-                return true;
-              }
-            },
-            { debugKey: "upload-image" }
-          );
-          lis.destroy();
-          return image;
+          return {
+            imageURL: imageBase64,
+            imageUUID: imageBase64,
+            taskUUID,
+            taskType: "imageUpload" /* IMAGE_UPLOAD */
+          };
         });
       } catch (e) {
         throw e;
@@ -628,7 +605,7 @@ var RunwareBase = class {
               }
               if (newRemoveBackground) {
                 delete this._globalMessages[taskUUID];
-                resolve([newRemoveBackground]);
+                resolve(newRemoveBackground);
                 return true;
               }
             },
@@ -675,7 +652,7 @@ var RunwareBase = class {
               }
               if (newUpscaleGan) {
                 delete this._globalMessages[taskUUID];
-                resolve([newUpscaleGan]);
+                resolve(newUpscaleGan);
                 return true;
               }
             },
@@ -1070,6 +1047,7 @@ var RunwareBase = class {
       return new Promise((resolve, reject) => {
         let retry = 0;
         const MAX_RETRY = 30;
+        const SHOULD_RETRY = 30 / 2 === retry;
         let retryIntervalId;
         let pollingIntervalId;
         const clearAllIntervals = () => {
@@ -1087,7 +1065,9 @@ var RunwareBase = class {
                 clearAllIntervals();
                 reject(new Error("Retry timed out"));
               } else {
-                this.connect();
+                if (SHOULD_RETRY) {
+                  this.connect();
+                }
                 retry++;
               }
             } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runware/sdk-js",
-  "version": "1.1.11",
+  "version": "1.1.13",
   "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

@@ -360,12 +360,24 @@ return interface IControlNetImage {
 
 ## Changelog
 
+### - v1.1.13
+
+**Added or Changed**
+
+- Fix image upload
+
+### - v1.1.12
+
+**Added or Changed**
+
+- Fix imageUpscale and backgroundRemoval wrong response
+
 ### - v1.1.11
 
 **Added or Changed**
 
-- Automatically detect environment with Runware
-- Fix invalid images not returning server errors
+- Automatically detect environment with Runware class
+- Fix invalid input image not returning server errors
 
 ### - v1.1.10