@runware/sdk-js 1.0.27

package/dist/index.d.mts

@@ -0,0 +1,251 @@
+declare enum Environment {
+    PRODUCTION = "PRODUCTION",
+    DEVELOPMENT = "DEVELOPMENT",
+    TEST = "TEST"
+}
+declare enum SdkType {
+    CLIENT = "CLIENT",
+    SERVER = "SERVER"
+}
+type RunwareBaseType = {
+    apiKey: string;
+    url?: string;
+};
+interface IImage {
+    imageSrc: string;
+    imageUUID: string;
+    taskUUID: string;
+    bNSFWContent: boolean;
+}
+interface ILora {
+    modelId: string | number;
+    weight: number;
+}
+declare enum EControlMode {
+    BALANCED = "balanced",
+    PROMPT = "prompt",
+    CONTROL_NET = "controlnet"
+}
+type IControlNetGeneral = {
+    preprocessor: keyof typeof EPreProcessor;
+    weight: number;
+    startStep: number;
+    endStep: number;
+    guideImage: string | File;
+    guideImageUnprocessed: string | File;
+    controlMode: EControlMode;
+};
+type IControlNetA = RequireOnlyOne<IControlNetGeneral, "guideImage" | "guideImageUnprocessed">;
+type IControlNetCanny = IControlNetA & {
+    preprocessor: "canny";
+    lowThresholdCanny: Number;
+    highThresholdCanny: Number;
+};
+type IControlNetHandsAndFace = IControlNetA & {
+    preprocessor: keyof typeof EOpenPosePreProcessor;
+    includeHandsAndFaceOpenPose: boolean;
+};
+type IControlNet = IControlNetCanny | IControlNetA | IControlNetHandsAndFace;
+type IControlNetWithUUID = Omit<IControlNet, "guideImage"> & {
+    guideImageUUID: string;
+};
+interface IError {
+    error: boolean;
+    errorMessage: string;
+    taskUUID: string;
+}
+interface IRequestImage {
+    positivePrompt: string;
+    imageSize: number;
+    modelId: number | string;
+    numberOfImages?: number;
+    negativePrompt?: string;
+    useCache?: boolean;
+    lora?: ILora[];
+    controlNet?: IControlNet[];
+    imageInitiator?: File | string;
+    imageMaskInitiator?: File | string;
+    steps?: number;
+    onPartialImages?: (images: IImage[], error?: IError) => void;
+    seed?: number;
+    gScale?: number;
+    checkNsfw?: boolean;
+}
+interface IRequestImageToText {
+    imageInitiator?: File | string;
+}
+interface IImageToText {
+    taskUUID: string;
+    text: string;
+}
+interface IRemoveImageBackground extends IRequestImageToText {
+}
+interface IPromptEnhancer {
+    promptMaxLength?: number;
+    promptLanguageId?: number;
+    promptVersions?: number;
+    prompt: string;
+}
+interface IEnhancedPrompt extends IImageToText {
+}
+interface IUpscaleGan {
+    imageInitiator: File | string;
+    upscaleFactor: number;
+    isImageUUID?: boolean;
+}
+type ReconnectingWebsocketProps = {
+    addEventListener: (type: string, listener: EventListener, options: any) => void;
+    send: (data: any) => void;
+} & WebSocket;
+type UploadImageType = {
+    newImageUUID: string;
+    newImageSrc: string;
+    taskUUID: string;
+};
+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;
+};
+
+declare enum LISTEN_TO_IMAGES_KEY {
+    REQUEST_IMAGES = "REQUEST_IMAGES"
+}
+
+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;
+    constructor({ apiKey, url }: RunwareBaseType);
+    protected isWebsocketReadyState: () => boolean;
+    protected addListener({ lis, check, groupKey, }: {
+        lis: (v: any) => any;
+        check: (v: any) => any;
+        groupKey?: string;
+    }): {
+        destroy: () => void;
+    };
+    protected connect(): void;
+    protected send: (msg: Object) => any;
+    private destroy;
+    private uploadImage;
+    private uploadUnprocessedImage;
+    listenToImages({ onPartialImages, taskUUID, groupKey, }: {
+        taskUUID: string;
+        onPartialImages?: (images: IImage[], error?: any) => void;
+        groupKey: LISTEN_TO_IMAGES_KEY;
+    }): {
+        destroy: () => void;
+    };
+    globalListener({ responseKey, taskKey, taskUUID, }: {
+        responseKey: string;
+        taskKey: string;
+        taskUUID: string;
+    }): {
+        destroy: () => void;
+    };
+    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, }: IRequestImage): Promise<IImage[] | undefined>;
+    handleIncompleteImages({ taskUUIDs, error, }: {
+        taskUUIDs: string[];
+        error: any;
+    }): IImage[];
+    requestImageToText: ({ imageInitiator, }: IRequestImageToText) => Promise<IImageToText>;
+    removeImageBackground: ({ imageInitiator, }: IRemoveImageBackground) => Promise<IImage[]>;
+    upscaleGan: ({ imageInitiator, upscaleFactor, }: IUpscaleGan) => Promise<IImage[]>;
+    enhancePrompt: ({ prompt, promptMaxLength, promptLanguageId, promptVersions, }: IPromptEnhancer) => Promise<IEnhancedPrompt>;
+    ensureConnection(): Promise<void>;
+    getSimililarImage({ taskUUID, numberOfImages, shouldThrowError, lis, }: {
+        taskUUID: string | string[];
+        numberOfImages: number;
+        shouldThrowError?: boolean;
+        lis: any;
+    }): Promise<IImage[] | IError>;
+    connected: () => boolean;
+}
+
+declare class Runware extends RunwareBase {
+    constructor({ apiKey, url }: RunwareBaseType);
+}
+
+declare class RunwareServer extends RunwareBase {
+    _instantiated: boolean;
+    _listeners: any[];
+    _reconnectingIntervalId: null | any;
+    _pingTimeout: any;
+    _pongListener: any;
+    constructor({ apiKey, url }: RunwareBaseType);
+    protected connect(): Promise<void>;
+    protected send: (msg: Object) => void;
+    protected handleClose(): void;
+    protected heartBeat(): void;
+}
+
+export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetA, IControlNetCanny, IControlNetGeneral, IControlNetHandsAndFace, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IPromptEnhancer, IRemoveImageBackground, IRequestImage, IRequestImageToText, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };

package/dist/index.d.ts

@@ -0,0 +1,251 @@
+declare enum Environment {
+    PRODUCTION = "PRODUCTION",
+    DEVELOPMENT = "DEVELOPMENT",
+    TEST = "TEST"
+}
+declare enum SdkType {
+    CLIENT = "CLIENT",
+    SERVER = "SERVER"
+}
+type RunwareBaseType = {
+    apiKey: string;
+    url?: string;
+};
+interface IImage {
+    imageSrc: string;
+    imageUUID: string;
+    taskUUID: string;
+    bNSFWContent: boolean;
+}
+interface ILora {
+    modelId: string | number;
+    weight: number;
+}
+declare enum EControlMode {
+    BALANCED = "balanced",
+    PROMPT = "prompt",
+    CONTROL_NET = "controlnet"
+}
+type IControlNetGeneral = {
+    preprocessor: keyof typeof EPreProcessor;
+    weight: number;
+    startStep: number;
+    endStep: number;
+    guideImage: string | File;
+    guideImageUnprocessed: string | File;
+    controlMode: EControlMode;
+};
+type IControlNetA = RequireOnlyOne<IControlNetGeneral, "guideImage" | "guideImageUnprocessed">;
+type IControlNetCanny = IControlNetA & {
+    preprocessor: "canny";
+    lowThresholdCanny: Number;
+    highThresholdCanny: Number;
+};
+type IControlNetHandsAndFace = IControlNetA & {
+    preprocessor: keyof typeof EOpenPosePreProcessor;
+    includeHandsAndFaceOpenPose: boolean;
+};
+type IControlNet = IControlNetCanny | IControlNetA | IControlNetHandsAndFace;
+type IControlNetWithUUID = Omit<IControlNet, "guideImage"> & {
+    guideImageUUID: string;
+};
+interface IError {
+    error: boolean;
+    errorMessage: string;
+    taskUUID: string;
+}
+interface IRequestImage {
+    positivePrompt: string;
+    imageSize: number;
+    modelId: number | string;
+    numberOfImages?: number;
+    negativePrompt?: string;
+    useCache?: boolean;
+    lora?: ILora[];
+    controlNet?: IControlNet[];
+    imageInitiator?: File | string;
+    imageMaskInitiator?: File | string;
+    steps?: number;
+    onPartialImages?: (images: IImage[], error?: IError) => void;
+    seed?: number;
+    gScale?: number;
+    checkNsfw?: boolean;
+}
+interface IRequestImageToText {
+    imageInitiator?: File | string;
+}
+interface IImageToText {
+    taskUUID: string;
+    text: string;
+}
+interface IRemoveImageBackground extends IRequestImageToText {
+}
+interface IPromptEnhancer {
+    promptMaxLength?: number;
+    promptLanguageId?: number;
+    promptVersions?: number;
+    prompt: string;
+}
+interface IEnhancedPrompt extends IImageToText {
+}
+interface IUpscaleGan {
+    imageInitiator: File | string;
+    upscaleFactor: number;
+    isImageUUID?: boolean;
+}
+type ReconnectingWebsocketProps = {
+    addEventListener: (type: string, listener: EventListener, options: any) => void;
+    send: (data: any) => void;
+} & WebSocket;
+type UploadImageType = {
+    newImageUUID: string;
+    newImageSrc: string;
+    taskUUID: string;
+};
+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;
+};
+
+declare enum LISTEN_TO_IMAGES_KEY {
+    REQUEST_IMAGES = "REQUEST_IMAGES"
+}
+
+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;
+    constructor({ apiKey, url }: RunwareBaseType);
+    protected isWebsocketReadyState: () => boolean;
+    protected addListener({ lis, check, groupKey, }: {
+        lis: (v: any) => any;
+        check: (v: any) => any;
+        groupKey?: string;
+    }): {
+        destroy: () => void;
+    };
+    protected connect(): void;
+    protected send: (msg: Object) => any;
+    private destroy;
+    private uploadImage;
+    private uploadUnprocessedImage;
+    listenToImages({ onPartialImages, taskUUID, groupKey, }: {
+        taskUUID: string;
+        onPartialImages?: (images: IImage[], error?: any) => void;
+        groupKey: LISTEN_TO_IMAGES_KEY;
+    }): {
+        destroy: () => void;
+    };
+    globalListener({ responseKey, taskKey, taskUUID, }: {
+        responseKey: string;
+        taskKey: string;
+        taskUUID: string;
+    }): {
+        destroy: () => void;
+    };
+    requestImages({ modelId, positivePrompt, imageSize, negativePrompt, numberOfImages, useCache, imageInitiator, controlNet, imageMaskInitiator, steps, onPartialImages, lora, seed, gScale, checkNsfw, }: IRequestImage): Promise<IImage[] | undefined>;
+    handleIncompleteImages({ taskUUIDs, error, }: {
+        taskUUIDs: string[];
+        error: any;
+    }): IImage[];
+    requestImageToText: ({ imageInitiator, }: IRequestImageToText) => Promise<IImageToText>;
+    removeImageBackground: ({ imageInitiator, }: IRemoveImageBackground) => Promise<IImage[]>;
+    upscaleGan: ({ imageInitiator, upscaleFactor, }: IUpscaleGan) => Promise<IImage[]>;
+    enhancePrompt: ({ prompt, promptMaxLength, promptLanguageId, promptVersions, }: IPromptEnhancer) => Promise<IEnhancedPrompt>;
+    ensureConnection(): Promise<void>;
+    getSimililarImage({ taskUUID, numberOfImages, shouldThrowError, lis, }: {
+        taskUUID: string | string[];
+        numberOfImages: number;
+        shouldThrowError?: boolean;
+        lis: any;
+    }): Promise<IImage[] | IError>;
+    connected: () => boolean;
+}
+
+declare class Runware extends RunwareBase {
+    constructor({ apiKey, url }: RunwareBaseType);
+}
+
+declare class RunwareServer extends RunwareBase {
+    _instantiated: boolean;
+    _listeners: any[];
+    _reconnectingIntervalId: null | any;
+    _pingTimeout: any;
+    _pongListener: any;
+    constructor({ apiKey, url }: RunwareBaseType);
+    protected connect(): Promise<void>;
+    protected send: (msg: Object) => void;
+    protected handleClose(): void;
+    protected heartBeat(): void;
+}
+
+export { EControlMode, EOpenPosePreProcessor, EPreProcessor, EPreProcessorGroup, Environment, GetWithPromiseCallBackType, IControlNet, IControlNetA, IControlNetCanny, IControlNetGeneral, IControlNetHandsAndFace, IControlNetWithUUID, IEnhancedPrompt, IError, IImage, IImageToText, IPromptEnhancer, IRemoveImageBackground, IRequestImage, IRequestImageToText, IUpscaleGan, ListenerType, ReconnectingWebsocketProps, RequireAtLeastOne, RequireOnlyOne, Runware, RunwareBaseType, RunwareServer, SdkType, UploadImageType };