@runware/sdk-js 1.0.27 → 1.0.28

package/dist/index.d.mts

@@ -16,6 +16,8 @@ interface IImage {
     imageUUID: string;
     taskUUID: string;
     bNSFWContent: boolean;
+    cost: number;
+    imageBase64Data?: string;
 }
 interface ILora {
     modelId: string | number;
@@ -34,16 +36,19 @@ type IControlNetGeneral = {
     guideImage: string | File;
     guideImageUnprocessed: string | File;
     controlMode: EControlMode;
+    returnBase64Image?: boolean;
 };
 type IControlNetA = RequireOnlyOne<IControlNetGeneral, "guideImage" | "guideImageUnprocessed">;
 type IControlNetCanny = IControlNetA & {
     preprocessor: "canny";
     lowThresholdCanny: Number;
     highThresholdCanny: Number;
+    returnBase64Image?: boolean;
 };
 type IControlNetHandsAndFace = IControlNetA & {
     preprocessor: keyof typeof EOpenPosePreProcessor;
     includeHandsAndFaceOpenPose: boolean;
+    returnBase64Image?: boolean;
 };
 type IControlNet = IControlNetCanny | IControlNetA | IControlNetHandsAndFace;
 type IControlNetWithUUID = Omit<IControlNet, "guideImage"> & {
@@ -70,6 +75,8 @@ interface IRequestImage {
     seed?: number;
     gScale?: number;
     checkNsfw?: boolean;
+    returnBase64Image?: boolean;
+    scheduler?: string;
 }
 interface IRequestImageToText {
     imageInitiator?: File | string;
@@ -92,6 +99,7 @@ interface IUpscaleGan {
     imageInitiator: File | string;
     upscaleFactor: number;
     isImageUUID?: boolean;
+    returnBase64Image?: boolean;
 }
 type ReconnectingWebsocketProps = {
     addEventListener: (type: string, listener: EventListener, options: any) => void;
@@ -212,7 +220,7 @@ declare class RunwareBase {
     }): {
         destroy: () => void;
     };
-    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, }: IRequestImage): Promise<IImage[] | undefined>;
+    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, returnBase64Image, scheduler, }: IRequestImage): Promise<IImage[] | undefined>;
     handleIncompleteImages({ taskUUIDs, error, }: {
         taskUUIDs: string[];
         error: any;

package/dist/index.d.ts

@@ -16,6 +16,8 @@ interface IImage {
     imageUUID: string;
     taskUUID: string;
     bNSFWContent: boolean;
+    cost: number;
+    imageBase64Data?: string;
 }
 interface ILora {
     modelId: string | number;
@@ -34,16 +36,19 @@ type IControlNetGeneral = {
     guideImage: string | File;
     guideImageUnprocessed: string | File;
     controlMode: EControlMode;
+    returnBase64Image?: boolean;
 };
 type IControlNetA = RequireOnlyOne<IControlNetGeneral, "guideImage" | "guideImageUnprocessed">;
 type IControlNetCanny = IControlNetA & {
     preprocessor: "canny";
     lowThresholdCanny: Number;
     highThresholdCanny: Number;
+    returnBase64Image?: boolean;
 };
 type IControlNetHandsAndFace = IControlNetA & {
     preprocessor: keyof typeof EOpenPosePreProcessor;
     includeHandsAndFaceOpenPose: boolean;
+    returnBase64Image?: boolean;
 };
 type IControlNet = IControlNetCanny | IControlNetA | IControlNetHandsAndFace;
 type IControlNetWithUUID = Omit<IControlNet, "guideImage"> & {
@@ -70,6 +75,8 @@ interface IRequestImage {
     seed?: number;
     gScale?: number;
     checkNsfw?: boolean;
+    returnBase64Image?: boolean;
+    scheduler?: string;
 }
 interface IRequestImageToText {
     imageInitiator?: File | string;
@@ -92,6 +99,7 @@ interface IUpscaleGan {
     imageInitiator: File | string;
     upscaleFactor: number;
     isImageUUID?: boolean;
+    returnBase64Image?: boolean;
 }
 type ReconnectingWebsocketProps = {
     addEventListener: (type: string, listener: EventListener, options: any) => void;
@@ -212,7 +220,7 @@ declare class RunwareBase {
     }): {
         destroy: () => void;
     };
-    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, }: IRequestImage): Promise<IImage[] | undefined>;
+    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, returnBase64Image, scheduler, }: IRequestImage): Promise<IImage[] | undefined>;
     handleIncompleteImages({ taskUUIDs, error, }: {
         taskUUIDs: string[];
         error: any;

package/dist/index.js

@@ -562,7 +562,8 @@ var RunwareBase = class {
       height,
       lowThresholdCanny,
       highThresholdCanny,
-      includeHandsAndFaceOpenPose = true
+      includeHandsAndFaceOpenPose = true,
+      returnBase64Image
     }) => {
       try {
         const image = await this.uploadImage(file);
@@ -570,12 +571,12 @@ var RunwareBase = class {
           return null;
         const taskUUID = getUUID();
         this.send({
-          newPreProcessControlNet: __spreadValues(__spreadValues({
+          newPreProcessControlNet: __spreadValues(__spreadValues(__spreadValues({
             taskUUID,
             preProcessorType,
             guideImageUUID: image.newImageUUID,
             includeHandsAndFaceOpenPose
-          }, compact(lowThresholdCanny, { lowThresholdCanny })), compact(highThresholdCanny, { highThresholdCanny }))
+          }, returnBase64Image ? { returnBase64Image } : {}), compact(lowThresholdCanny, { lowThresholdCanny })), compact(highThresholdCanny, { highThresholdCanny }))
         });
         const lis = this.globalListener({
           responseKey: "newPreProcessControlNet",
@@ -966,7 +967,9 @@ var RunwareBase = class {
     lora,
     seed,
     gScale,
-    checkNsfw
+    checkNsfw,
+    returnBase64Image,
+    scheduler
   }) {
     let lis = void 0;
     let requestObject = void 0;
@@ -1002,7 +1005,8 @@ var RunwareBase = class {
             weight,
             guideImage,
             guideImageUnprocessed,
-            controlMode
+            controlMode,
+            returnBase64Image: returnBase64Image2
           } = controlData;
           const getCannyObject = () => {
             if (controlData.preprocessor === "canny") {
@@ -1013,13 +1017,15 @@ var RunwareBase = class {
             } else
               return {};
           };
-          const imageUploaded = await (guideImageUnprocessed ? this.uploadUnprocessedImage(__spreadValues({
+          const imageUploaded = await (guideImageUnprocessed ? this.uploadUnprocessedImage(__spreadProps(__spreadValues({
             file: guideImageUnprocessed,
             preProcessorType: getPreprocessorType(
               preprocessor
             ),
             includeHandsAndFaceOpenPose: anyControlData.includeHandsAndFaceOpenPose
-          }, getCannyObject())) : this.uploadImage(guideImage));
+          }, getCannyObject()), {
+            returnBase64Image: returnBase64Image2
+          })) : this.uploadImage(guideImage));
           if (!imageUploaded)
             return [];
           controlNetData.push(__spreadValues({
@@ -1034,7 +1040,7 @@ var RunwareBase = class {
       }
       const prompt = `${positivePrompt} ${negativePrompt ? `-no ${negativePrompt}` : ""}`.trim();
       gScale = gScale != null ? gScale : 7;
-      requestObject = __spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
+      requestObject = __spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
         offset: 0,
         modelId,
         promptText: prompt,
@@ -1046,9 +1052,8 @@ var RunwareBase = class {
           imageInitiator,
           imageMaskInitiator
         }),
-        useCache,
-        schedulerId: 22
-      }, evaluateNonTrue({ key: "checkNsfw", value: checkNsfw })), evaluateNonTrue({ key: "gScale", value: gScale })), evaluateNonTrue({ key: "steps", value: steps })), imageInitiatorUUID ? { imageInitiatorUUID } : {}), imageMaskInitiatorUUID ? { imageMaskInitiatorUUID } : {}), controlNetData.length ? { controlNet: controlNetData } : {}), (lora == null ? void 0 : lora.length) ? { lora } : {}), seed ? { seed } : {});
+        useCache
+      }, scheduler ? { scheduler } : {}), returnBase64Image ? { returnBase64Image } : {}), evaluateNonTrue({ key: "checkNsfw", value: checkNsfw })), evaluateNonTrue({ key: "gScale", value: gScale })), evaluateNonTrue({ key: "steps", value: steps })), imageInitiatorUUID ? { imageInitiatorUUID } : {}), imageMaskInitiatorUUID ? { imageMaskInitiatorUUID } : {}), controlNetData.length ? { controlNet: controlNetData } : {}), (lora == null ? void 0 : lora.length) ? { lora } : {}), seed ? { seed } : {});
       return await asyncRetry(
         async () => {
           retryCount++;

package/dist/index.mjs

@@ -542,7 +542,8 @@ var RunwareBase = class {
       height,
       lowThresholdCanny,
       highThresholdCanny,
-      includeHandsAndFaceOpenPose = true
+      includeHandsAndFaceOpenPose = true,
+      returnBase64Image
     }) => {
       try {
         const image = await this.uploadImage(file);
@@ -550,12 +551,12 @@ var RunwareBase = class {
           return null;
         const taskUUID = getUUID();
         this.send({
-          newPreProcessControlNet: __spreadValues(__spreadValues({
+          newPreProcessControlNet: __spreadValues(__spreadValues(__spreadValues({
             taskUUID,
             preProcessorType,
             guideImageUUID: image.newImageUUID,
             includeHandsAndFaceOpenPose
-          }, compact(lowThresholdCanny, { lowThresholdCanny })), compact(highThresholdCanny, { highThresholdCanny }))
+          }, returnBase64Image ? { returnBase64Image } : {}), compact(lowThresholdCanny, { lowThresholdCanny })), compact(highThresholdCanny, { highThresholdCanny }))
         });
         const lis = this.globalListener({
           responseKey: "newPreProcessControlNet",
@@ -946,7 +947,9 @@ var RunwareBase = class {
     lora,
     seed,
     gScale,
-    checkNsfw
+    checkNsfw,
+    returnBase64Image,
+    scheduler
   }) {
     let lis = void 0;
     let requestObject = void 0;
@@ -982,7 +985,8 @@ var RunwareBase = class {
             weight,
             guideImage,
             guideImageUnprocessed,
-            controlMode
+            controlMode,
+            returnBase64Image: returnBase64Image2
           } = controlData;
           const getCannyObject = () => {
             if (controlData.preprocessor === "canny") {
@@ -993,13 +997,15 @@ var RunwareBase = class {
             } else
               return {};
           };
-          const imageUploaded = await (guideImageUnprocessed ? this.uploadUnprocessedImage(__spreadValues({
+          const imageUploaded = await (guideImageUnprocessed ? this.uploadUnprocessedImage(__spreadProps(__spreadValues({
             file: guideImageUnprocessed,
             preProcessorType: getPreprocessorType(
               preprocessor
             ),
             includeHandsAndFaceOpenPose: anyControlData.includeHandsAndFaceOpenPose
-          }, getCannyObject())) : this.uploadImage(guideImage));
+          }, getCannyObject()), {
+            returnBase64Image: returnBase64Image2
+          })) : this.uploadImage(guideImage));
           if (!imageUploaded)
             return [];
           controlNetData.push(__spreadValues({
@@ -1014,7 +1020,7 @@ var RunwareBase = class {
       }
       const prompt = `${positivePrompt} ${negativePrompt ? `-no ${negativePrompt}` : ""}`.trim();
       gScale = gScale != null ? gScale : 7;
-      requestObject = __spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
+      requestObject = __spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
         offset: 0,
         modelId,
         promptText: prompt,
@@ -1026,9 +1032,8 @@ var RunwareBase = class {
           imageInitiator,
           imageMaskInitiator
         }),
-        useCache,
-        schedulerId: 22
-      }, evaluateNonTrue({ key: "checkNsfw", value: checkNsfw })), evaluateNonTrue({ key: "gScale", value: gScale })), evaluateNonTrue({ key: "steps", value: steps })), imageInitiatorUUID ? { imageInitiatorUUID } : {}), imageMaskInitiatorUUID ? { imageMaskInitiatorUUID } : {}), controlNetData.length ? { controlNet: controlNetData } : {}), (lora == null ? void 0 : lora.length) ? { lora } : {}), seed ? { seed } : {});
+        useCache
+      }, scheduler ? { scheduler } : {}), returnBase64Image ? { returnBase64Image } : {}), evaluateNonTrue({ key: "checkNsfw", value: checkNsfw })), evaluateNonTrue({ key: "gScale", value: gScale })), evaluateNonTrue({ key: "steps", value: steps })), imageInitiatorUUID ? { imageInitiatorUUID } : {}), imageMaskInitiatorUUID ? { imageMaskInitiatorUUID } : {}), controlNetData.length ? { controlNet: controlNetData } : {}), (lora == null ? void 0 : lora.length) ? { lora } : {}), seed ? { seed } : {});
       return await asyncRetry(
         async () => {
           retryCount++;

package/package.json

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

@@ -57,6 +57,7 @@ const images = await runware.requestImages({
 	imageInitiator?: File | string;
 	imageMaskInitiator?: File | string;
 	steps?: number;
+	returnBase64Image?: boolean;
 	onPartialImages?: (images: IImage[], error: IError) =>  void;
 })
 console.log(images)
@@ -66,6 +67,7 @@ return interface IImage {
 	imageUUID: string;
 	taskUUID: string;
 	bNSFWContent: boolean;
+	cost: string;
 }[]
 ```
 
@@ -116,7 +118,7 @@ return interface IImage {
 | controlNet         | IControlNet[]: `(Optional)`        | If provided, should be an array of objects. Each object must have five attributes:                                                                             |
 | imageInitiator     | string or File: `(Optional)`       | The image to be used as the seed image. It can be the UUID of previously generated image, or an image from a file.                                             |
 | imageMaskInitiator | string or File: `(Optional)`       | The image to be used as the mask image. It can be the UUID of previously generated image, or an image from a file.                                             |
-| steps              | number: `(Optional)`               | The steps required to generate the image.                                                                                                                      |
+| returnBase64Image  | boolean: `(Optional)`              | Returns base64 image.                                                                                                                                          |
 | onPartialImages    | function: `(Optional)`             | If you want to receive the images as they are generated instead of waiting for the async request, you get the images as they are generated from this function. |
 
 ##### ControlNet Params
@@ -240,6 +242,13 @@ return interface IEnhancedPrompt {
 
 ## Changelog
 
+### - v1.0.28
+
+**Added or Changed**
+
+- Added cost to response.
+- Added returnBase64Image as part of request object.
+
 ### - v1.0.27
 
 **Added or Changed**