@runware/sdk-js 1.1.49 → 1.2.0-beta.1

package/dist/esm/Runware/Runware-base.d.ts

@@ -0,0 +1,70 @@
+import { IEnhancedPrompt, IError, IImage, IImageToText, IPromptEnhancer, IRemoveImageBackground, IRequestImage, IRequestImageToText, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RunwareBaseType, SdkType, IControlNetPreprocess, IControlNetImage, IRemoveImage, ITextToImage, TAddModel, TPhotoMaker, TPhotoMakerResponse, TModelSearch, TImageMaskingResponse, TImageMasking, TModelSearchResponse, TServerError, TImageUpload, TImageUploadResponse, IRequestVideo, IAsyncResults, IVideoToImage, IRequestRemoveBackground, IMedia } from "./types";
+export declare class RunwareBase {
+    _ws: ReconnectingWebsocketProps | any;
+    _listeners: ListenerType[];
+    _apiKey: string;
+    _url?: string;
+    _globalMessages: Record<string, any>;
+    _globalImages: IImage[];
+    _globalError: IError | undefined;
+    _connectionSessionUUID: string | undefined;
+    _connectionError: TServerError | undefined;
+    _sdkType: SdkType;
+    _shouldReconnect: boolean;
+    _globalMaxRetries: number;
+    _timeoutDuration: number;
+    ensureConnectionUUID: string | null;
+    constructor({ apiKey, url, shouldReconnect, globalMaxRetries, timeoutDuration, }: RunwareBaseType);
+    /**
+     * Shared polling logic for async results.
+     * @param taskUUID - The task UUID to poll for.
+     * @param numberResults - Number of results expected.
+     * @param resultKey - Key to identify results (default is "mediaUUID" - "videoUUID" is legacy).
+     * @returns Promise resolving to array of results.
+     */
+    private pollForAsyncResults;
+    static initialize(props: RunwareBaseType): Promise<RunwareBase>;
+    protected isWebsocketReadyState: () => boolean;
+    protected isInvalidAPIKey: () => 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 listenToUpload;
+    private globalListener;
+    requestImages({ outputType, outputFormat, uploadEndpoint, checkNSFW, positivePrompt, negativePrompt, seedImage, maskImage, strength, height, width, model, steps, scheduler, seed, CFGScale, clipSkip, usePromptWeighting, promptWeighting, numberResults, onPartialImages, includeCost, customTaskUUID, retry, refiner, maskMargin, outputQuality, controlNet, lora, embeddings, ipAdapters, providerSettings, outpaint, acceleratorOptions, advancedFeatures, referenceImages, includeGenerationTime, includePayload, ...rest }: IRequestImage, moreOptions?: Record<string, any>): Promise<ITextToImage[] | undefined>;
+    controlNetPreProcess: ({ inputImage, preProcessorType, height, width, outputType, outputFormat, highThresholdCanny, lowThresholdCanny, includeHandsAndFaceOpenPose, includeCost, outputQuality, customTaskUUID, retry, includeGenerationTime, includePayload, }: IControlNetPreprocess) => Promise<IControlNetImage | null>;
+    requestImageToText: ({ inputImage, includeCost, customTaskUUID, retry, includePayload, includeGenerationTime, }: IRequestImageToText) => Promise<IImageToText>;
+    removeImageBackground: (payload: IRemoveImageBackground) => Promise<IRemoveImage>;
+    removeBackground: (payload: IRequestRemoveBackground) => Promise<IMedia[] | IMedia>;
+    videoInference: (payload: IRequestVideo) => Promise<IVideoToImage[] | IVideoToImage>;
+    getResponse: (payload: IAsyncResults) => Promise<IMedia[]>;
+    upscaleGan: ({ inputImage, upscaleFactor, outputType, outputFormat, includeCost, outputQuality, customTaskUUID, retry, includeGenerationTime, includePayload, }: IUpscaleGan) => Promise<IImage>;
+    enhancePrompt: ({ prompt, promptMaxLength, promptVersions, includeCost, customTaskUUID, retry, includeGenerationTime, includePayload, }: IPromptEnhancer) => Promise<IEnhancedPrompt[]>;
+    modelUpload: (payload: TAddModel) => Promise<any>;
+    photoMaker: (payload: TPhotoMaker, moreOptions?: Record<string, any>) => Promise<TPhotoMakerResponse[] | undefined>;
+    modelSearch: (payload: TModelSearch) => Promise<TModelSearchResponse>;
+    imageMasking: (payload: TImageMasking) => Promise<TImageMaskingResponse>;
+    imageUpload: (payload: TImageUpload) => Promise<TImageUploadResponse>;
+    protected baseSingleRequest: <T>({ payload, debugKey, isMultiple, }: {
+        payload: Record<string, any>;
+        debugKey: string;
+        isMultiple?: boolean | undefined;
+    }) => Promise<T>;
+    ensureConnection(): Promise<unknown>;
+    private getSimilarImages;
+    private getSingleMessage;
+    private getMultipleMessages;
+    private insertAdditionalResponse;
+    private handleIncompleteImages;
+    disconnect: () => Promise<void>;
+    private connected;
+}