@runware/sdk-js 1.1.20-beta.2 → 1.1.20-beta.4

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

@@ -1,41 +0,0 @@
-"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

@@ -1,12 +0,0 @@
-/// <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

@@ -1,38 +0,0 @@
-"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

@@ -1,39 +0,0 @@
-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

@@ -1,44 +0,0 @@
-"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

@@ -1,338 +0,0 @@
-declare enum Environment {
-    PRODUCTION = "PRODUCTION",
-    DEVELOPMENT = "DEVELOPMENT",
-    TEST = "TEST"
-}
-declare enum SdkType {
-    CLIENT = "CLIENT",
-    SERVER = "SERVER"
-}
-declare enum ETaskType {
-    IMAGE_INFERENCE = "imageInference",
-    IMAGE_UPLOAD = "imageUpload",
-    IMAGE_UPSCALE = "imageUpscale",
-    IMAGE_BACKGROUND_REMOVAL = "imageBackgroundRemoval",
-    IMAGE_CAPTION = "imageCaption",
-    IMAGE_CONTROL_NET_PRE_PROCESS = "imageControlNetPreProcess",
-    PROMPT_ENHANCE = "promptEnhance",
-    AUTHENTICATION = "authentication",
-    MODEL_UPLOAD = "modelUpload"
-}
-type RunwareBaseType = {
-    apiKey: string;
-    url?: string;
-    shouldReconnect?: boolean;
-    globalMaxRetries?: number;
-    timeoutDuration?: number;
-};
-type IOutputType = "base64Data" | "dataURI" | "URL";
-type IOutputFormat = "JPG" | "PNG" | "WEBP";
-interface IImage {
-    taskType: ETaskType;
-    imageUUID: string;
-    inputImageUUID?: string;
-    taskUUID: string;
-    imageURL?: string;
-    imageBase64Data?: string;
-    imageDataURI?: string;
-    NSFWContent?: boolean;
-    cost?: number;
-}
-interface ITextToImage extends IImage {
-    positivePrompt?: string;
-    negativePrompt?: string;
-}
-interface IControlNetImage {
-    taskUUID: string;
-    inputImageUUID: string;
-    guideImageUUID: string;
-    guideImageURL?: string;
-    guideImageBase64Data?: string;
-    guideImageDataURI?: string;
-    cost?: number;
-}
-interface ILora {
-    model: string | number;
-    weight: number;
-}
-declare enum EControlMode {
-    BALANCED = "balanced",
-    PROMPT = "prompt",
-    CONTROL_NET = "controlnet"
-}
-type IControlNetGeneral = {
-    model: string;
-    guideImage: string | File;
-    weight?: number;
-    startStep?: number;
-    startStepPercentage?: number;
-    endStep?: number;
-    endStepPercentage?: number;
-    controlMode: EControlMode;
-};
-type IControlNetPreprocess = {
-    inputImage: string | File;
-    preProcessorType: EPreProcessorGroup;
-    height?: number;
-    width?: number;
-    outputType?: IOutputType;
-    outputFormat?: IOutputFormat;
-    highThresholdCanny?: number;
-    lowThresholdCanny?: number;
-    includeHandsAndFaceOpenPose?: boolean;
-    includeCost?: boolean;
-    customTaskUUID?: string;
-    retry?: number;
-};
-type IControlNet = IControlNetGeneral;
-type IControlNetWithUUID = Omit<IControlNet, "guideImage"> & {
-    guideImage?: string;
-};
-interface IError {
-    error: boolean;
-    errorMessage: string;
-    taskUUID: string;
-}
-interface IRequestImage {
-    outputType?: IOutputType;
-    outputFormat?: IOutputFormat;
-    uploadEndpoint?: string;
-    checkNsfw?: boolean;
-    positivePrompt: string;
-    negativePrompt?: string;
-    seedImage?: File | string;
-    maskImage?: File | string;
-    strength?: number;
-    height?: number;
-    width?: number;
-    model: number | string;
-    steps?: number;
-    scheduler?: string;
-    seed?: number;
-    CFGScale?: number;
-    clipSkip?: number;
-    usePromptWeighting?: boolean;
-    numberResults?: number;
-    controlNet?: IControlNet[];
-    lora?: ILora[];
-    includeCost?: boolean;
-    customTaskUUID?: string;
-    onPartialImages?: (images: IImage[], error?: IError) => void;
-    retry?: number;
-}
-interface IRequestImageToText {
-    inputImage?: File | string;
-    includeCost?: boolean;
-    customTaskUUID?: string;
-    retry?: number;
-}
-interface IImageToText {
-    taskType: ETaskType;
-    taskUUID: string;
-    text: string;
-    cost?: number;
-}
-interface IRemoveImageBackground extends IRequestImageToText {
-    outputType?: IOutputType;
-    outputFormat?: IOutputFormat;
-    rgba?: number[];
-    postProcessMask?: boolean;
-    returnOnlyMask?: boolean;
-    alphaMatting?: boolean;
-    alphaMattingForegroundThreshold?: number;
-    alphaMattingBackgroundThreshold?: number;
-    alphaMattingErodeSize?: number;
-    includeCost?: boolean;
-    retry?: number;
-}
-interface IRemoveImage {
-    taskType: ETaskType;
-    taskUUID: string;
-    imageUUID: string;
-    inputImageUUID: string;
-    imageURL?: string;
-    imageBase64Data?: string;
-    imageDataURI?: string;
-    cost?: number;
-}
-interface IPromptEnhancer {
-    promptMaxLength?: number;
-    promptVersions?: number;
-    prompt: string;
-    includeCost?: boolean;
-    customTaskUUID?: string;
-    retry?: number;
-}
-interface IEnhancedPrompt extends IImageToText {
-}
-interface IUpscaleGan {
-    inputImage: File | string;
-    upscaleFactor: number;
-    outputType?: IOutputType;
-    outputFormat?: IOutputFormat;
-    includeCost?: boolean;
-    customTaskUUID?: string;
-    retry?: number;
-}
-type ReconnectingWebsocketProps = {
-    addEventListener: (type: string, listener: EventListener, options: any) => void;
-    send: (data: any) => void;
-} & WebSocket;
-type UploadImageType = {
-    imageURL: string;
-    imageUUID: string;
-    taskUUID: string;
-    taskType: ETaskType;
-};
-type GetWithPromiseCallBackType = ({ resolve, reject, intervalId, }: {
-    resolve: <T>(value: T) => void;
-    reject: <T>(value: T) => void;
-    intervalId: any;
-}) => boolean | undefined;
-declare enum EPreProcessorGroup {
-    "canny" = "canny",
-    "depth" = "depth",
-    "mlsd" = "mlsd",
-    "normalbae" = "normalbae",
-    "openpose" = "openpose",
-    "tile" = "tile",
-    "seg" = "seg",
-    "lineart" = "lineart",
-    "lineart_anime" = "lineart_anime",
-    "shuffle" = "shuffle",
-    "scribble" = "scribble",
-    "softedge" = "softedge"
-}
-declare enum EPreProcessor {
-    "canny" = "canny",
-    "depth_leres" = "depth_leres",
-    "depth_midas" = "depth_midas",
-    "depth_zoe" = "depth_zoe",
-    "inpaint_global_harmonious" = "inpaint_global_harmonious",
-    "lineart_anime" = "lineart_anime",
-    "lineart_coarse" = "lineart_coarse",
-    "lineart_realistic" = "lineart_realistic",
-    "lineart_standard" = "lineart_standard",
-    "mlsd" = "mlsd",
-    "normal_bae" = "normal_bae",
-    "scribble_hed" = "scribble_hed",
-    "scribble_pidinet" = "scribble_pidinet",
-    "seg_ofade20k" = "seg_ofade20k",
-    "seg_ofcoco" = "seg_ofcoco",
-    "seg_ufade20k" = "seg_ufade20k",
-    "shuffle" = "shuffle",
-    "softedge_hed" = "softedge_hed",
-    "softedge_hedsafe" = "softedge_hedsafe",
-    "softedge_pidinet" = "softedge_pidinet",
-    "softedge_pidisafe" = "softedge_pidisafe",
-    "tile_gaussian" = "tile_gaussian",
-    "openpose" = "openpose",
-    "openpose_face" = "openpose_face",
-    "openpose_faceonly" = "openpose_faceonly",
-    "openpose_full" = "openpose_full",
-    "openpose_hand" = "openpose_hand"
-}
-declare enum EOpenPosePreProcessor {
-    "openpose" = "openpose",
-    "openpose_face" = "openpose_face",
-    "openpose_faceonly" = "openpose_faceonly",
-    "openpose_full" = "openpose_full",
-    "openpose_hand" = "openpose_hand"
-}
-type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];
-type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
-}[Keys];
-type ListenerType = {
-    key: string;
-    listener: (msg: any) => void;
-    groupKey?: string;
-};
-type TAddModel = {
-    modelType: string;
-    modelAIR: string;
-    modelName: string;
-    modelHeroImageUrl: string;
-    modelDownloadUrl: string;
-    modelUniqueIdentifier: string;
-    modelVersion: string;
-    modelTags: string[];
-    modelTypeId: number;
-    modelDefaultWeight: number;
-    modelFormatId: number;
-    modelPositiveTriggerWords: string;
-    modelShortDescription: string;
-    privateModel: true;
-    modelComment: string;
-    retry?: number;
-    customTaskUUID?: string;
-};
-
-declare class RunwareBase {
-    _ws: ReconnectingWebsocketProps | any;
-    _listeners: ListenerType[];
-    _apiKey: string;
-    _url?: string;
-    _globalMessages: Record<string, any>;
-    _globalImages: IImage[];
-    _globalError: IError | undefined;
-    _connectionSessionUUID: string | undefined;
-    _invalidAPIkey: string | undefined;
-    _sdkType: SdkType;
-    _shouldReconnect: boolean;
-    _globalMaxRetries: number;
-    _timeoutDuration: number;
-    constructor({ apiKey, url, shouldReconnect, globalMaxRetries, timeoutDuration, }: RunwareBaseType);
-    static initialize(props: RunwareBaseType): Promise<RunwareBase>;
-    protected isWebsocketReadyState: () => boolean;
-    protected addListener({ lis, groupKey, taskUUID, }: {
-        lis: (v: any) => any;
-        groupKey?: string;
-        taskUUID: string;
-    }): {
-        destroy: () => void;
-    };
-    protected connect(): void;
-    protected send: (msg: Object) => void;
-    private destroy;
-    private uploadImage;
-    private listenToImages;
-    private globalListener;
-    requestImages({ outputType, outputFormat, uploadEndpoint, checkNsfw, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, numberResults, controlNet, lora, onPartialImages, includeCost, customTaskUUID, retry, }: IRequestImage): Promise<ITextToImage[] | undefined>;
-    controlNetPreProcess: ({ inputImage, preProcessorType, height, width, outputType, outputFormat, highThresholdCanny, lowThresholdCanny, includeHandsAndFaceOpenPose, includeCost, customTaskUUID, retry, }: IControlNetPreprocess) => Promise<IControlNetImage | null>;
-    requestImageToText: ({ inputImage, includeCost, customTaskUUID, retry, }: IRequestImageToText) => Promise<IImageToText>;
-    removeImageBackground: ({ inputImage, outputType, outputFormat, rgba, postProcessMask, returnOnlyMask, alphaMatting, alphaMattingForegroundThreshold, alphaMattingBackgroundThreshold, alphaMattingErodeSize, includeCost, customTaskUUID, retry, }: IRemoveImageBackground) => Promise<IRemoveImage>;
-    upscaleGan: ({ inputImage, upscaleFactor, outputType, outputFormat, includeCost, customTaskUUID, retry, }: IUpscaleGan) => Promise<IImage>;
-    enhancePrompt: ({ prompt, promptMaxLength, promptVersions, includeCost, customTaskUUID, retry, }: IPromptEnhancer) => Promise<IEnhancedPrompt[]>;
-    modelUpload: (payload: TAddModel) => Promise<any>;
-    ensureConnection(): Promise<unknown>;
-    private getSimilarImages;
-    private getSingleMessage;
-    private handleIncompleteImages;
-    disconnect: () => Promise<void>;
-    private connected;
-}
-
-declare class RunwareClient extends RunwareBase {
-    constructor(props: RunwareBaseType);
-}
-
-declare class RunwareServer extends RunwareBase {
-    _instantiated: boolean;
-    _listeners: any[];
-    _reconnectingIntervalId: null | any;
-    _pingTimeout: any;
-    _pongListener: any;
-    constructor(props: RunwareBaseType);
-    protected connect(): Promise<void>;
-    protected send: (msg: Object) => void;
-    protected handleClose(): void;
-    protected resetConnection: () => void;
-    protected heartBeat(): void;
-}
-
-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, TAddModel, UploadImageType };