@workglow/ai 0.0.71 → 0.0.73

package/dist/task/BackgroundRemovalTask.d.ts

@@ -0,0 +1,351 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { CreateWorkflow, JobQueueTaskConfig } from "@workglow/task-graph";
+import { DataPortSchema, FromSchema } from "@workglow/util";
+import { DeReplicateFromSchema } from "./base/AiTaskSchemas";
+import { AiVisionTask } from "./base/AiVisionTask";
+export declare const BackgroundRemovalInputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly image: {
+            readonly "x-replicate": true;
+            readonly format?: string | undefined;
+            readonly oneOf: readonly [{
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                    readonly title: "Image Data";
+                    readonly description: "Image as data-uri";
+                }, {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly properties: {
+                        readonly data: {
+                            readonly oneOf: readonly [{
+                                readonly type: "object";
+                                readonly format: "image:ImageBitmap";
+                                readonly title: "ImageBitmap";
+                            }, {
+                                readonly type: "object";
+                                readonly format: "image:OffscreenCanvas";
+                                readonly title: "OffscreenCanvas";
+                            }, {
+                                readonly type: "object";
+                                readonly format: "image:VideoFrame";
+                                readonly title: "VideoFrame";
+                            }, {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly data: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "number";
+                                            readonly format: "Uint8Clamped";
+                                        };
+                                        readonly format: "Uint8ClampedArray";
+                                        readonly title: "Data";
+                                        readonly description: "Data of the image";
+                                    };
+                                    readonly width: {
+                                        readonly type: "number";
+                                        readonly title: "Width";
+                                        readonly description: "Width of the image";
+                                    };
+                                    readonly height: {
+                                        readonly type: "number";
+                                        readonly title: "Height";
+                                        readonly description: "Height of the image";
+                                    };
+                                    readonly channels: {
+                                        readonly type: "number";
+                                        readonly title: "Channels";
+                                        readonly description: "Channels of the image";
+                                    };
+                                    readonly rawChannels: {
+                                        readonly type: "number";
+                                        readonly title: "Raw Channels";
+                                        readonly description: "Raw channels of the image";
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["data", "width", "height", "channels"];
+                                readonly format: "image:ImageBinary";
+                                readonly title: "ImageBinary";
+                            }];
+                        };
+                        readonly width: {
+                            readonly type: "number";
+                            readonly title: "Width";
+                            readonly description: "Width of the image";
+                        };
+                        readonly height: {
+                            readonly type: "number";
+                            readonly title: "Height";
+                            readonly description: "Height of the image";
+                        };
+                        readonly channels: {
+                            readonly type: "number";
+                            readonly title: "Channels";
+                            readonly description: "Channels of the image";
+                            readonly minimum: 1;
+                            readonly maximum: 4;
+                        };
+                    };
+                    readonly required: readonly ["data", "width", "height", "channels"];
+                }];
+                readonly title: "Image";
+                readonly description: "Image as URL or base64-encoded data";
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly type: "string";
+                        readonly title: "Image Data";
+                        readonly description: "Image as data-uri";
+                    }, {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly data: {
+                                readonly oneOf: readonly [{
+                                    readonly type: "object";
+                                    readonly format: "image:ImageBitmap";
+                                    readonly title: "ImageBitmap";
+                                }, {
+                                    readonly type: "object";
+                                    readonly format: "image:OffscreenCanvas";
+                                    readonly title: "OffscreenCanvas";
+                                }, {
+                                    readonly type: "object";
+                                    readonly format: "image:VideoFrame";
+                                    readonly title: "VideoFrame";
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly data: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "number";
+                                                readonly format: "Uint8Clamped";
+                                            };
+                                            readonly format: "Uint8ClampedArray";
+                                            readonly title: "Data";
+                                            readonly description: "Data of the image";
+                                        };
+                                        readonly width: {
+                                            readonly type: "number";
+                                            readonly title: "Width";
+                                            readonly description: "Width of the image";
+                                        };
+                                        readonly height: {
+                                            readonly type: "number";
+                                            readonly title: "Height";
+                                            readonly description: "Height of the image";
+                                        };
+                                        readonly channels: {
+                                            readonly type: "number";
+                                            readonly title: "Channels";
+                                            readonly description: "Channels of the image";
+                                        };
+                                        readonly rawChannels: {
+                                            readonly type: "number";
+                                            readonly title: "Raw Channels";
+                                            readonly description: "Raw channels of the image";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                    readonly required: readonly ["data", "width", "height", "channels"];
+                                    readonly format: "image:ImageBinary";
+                                    readonly title: "ImageBinary";
+                                }];
+                            };
+                            readonly width: {
+                                readonly type: "number";
+                                readonly title: "Width";
+                                readonly description: "Width of the image";
+                            };
+                            readonly height: {
+                                readonly type: "number";
+                                readonly title: "Height";
+                                readonly description: "Height of the image";
+                            };
+                            readonly channels: {
+                                readonly type: "number";
+                                readonly title: "Channels";
+                                readonly description: "Channels of the image";
+                                readonly minimum: 1;
+                                readonly maximum: 4;
+                            };
+                        };
+                        readonly required: readonly ["data", "width", "height", "channels"];
+                    }];
+                    readonly title: "Image";
+                    readonly description: "Image as URL or base64-encoded data";
+                };
+            }];
+            readonly title: string | undefined;
+            readonly description: string | undefined;
+        };
+        readonly model: {
+            readonly "x-replicate": true;
+            readonly format?: string | undefined;
+            readonly oneOf: readonly [{
+                readonly oneOf: readonly [{
+                    readonly title: "Model";
+                    readonly description: `The model ${string}`;
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                    readonly type: "string";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly model_id: {
+                            readonly type: "string";
+                        };
+                        readonly tasks: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                        };
+                        readonly provider: {
+                            readonly type: "string";
+                        };
+                        readonly providerConfig: {
+                            readonly type: "object";
+                            readonly default: {};
+                        };
+                        readonly metadata: {
+                            readonly type: "object";
+                            readonly default: {};
+                        };
+                    };
+                    readonly required: readonly ["model_id", "tasks", "provider", "title", "description", "providerConfig", "metadata"];
+                    readonly format: "model";
+                    readonly additionalProperties: false;
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                }];
+            } & {
+                readonly format: import(".").TypeModelSemantic;
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly title: "Model";
+                        readonly description: `The model ${string}`;
+                    } & {
+                        readonly format: import(".").TypeModelSemantic;
+                        readonly type: "string";
+                    }, {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly model_id: {
+                                readonly type: "string";
+                            };
+                            readonly tasks: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly title: {
+                                readonly type: "string";
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                            };
+                            readonly provider: {
+                                readonly type: "string";
+                            };
+                            readonly providerConfig: {
+                                readonly type: "object";
+                                readonly default: {};
+                            };
+                            readonly metadata: {
+                                readonly type: "object";
+                                readonly default: {};
+                            };
+                        };
+                        readonly required: readonly ["model_id", "tasks", "provider", "title", "description", "providerConfig", "metadata"];
+                        readonly format: "model";
+                        readonly additionalProperties: false;
+                    } & {
+                        readonly format: import(".").TypeModelSemantic;
+                    }];
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                };
+            }];
+            readonly title: string | undefined;
+            readonly description: string | undefined;
+        };
+    };
+    readonly required: readonly ["image", "model"];
+    readonly additionalProperties: false;
+};
+export declare const BackgroundRemovalOutputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly image: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+                readonly contentEncoding: "base64";
+                readonly contentMediaType: "image/png";
+                readonly title: "Image";
+                readonly description: "Base64-encoded PNG image with transparent background";
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly contentEncoding: "base64";
+                    readonly contentMediaType: "image/png";
+                    readonly title: "Image";
+                    readonly description: "Base64-encoded PNG image with transparent background";
+                };
+            }];
+            readonly title: "Image";
+            readonly description: "Base64-encoded PNG image with transparent background";
+        };
+    };
+    readonly required: readonly ["image"];
+    readonly additionalProperties: false;
+};
+export type BackgroundRemovalTaskInput = FromSchema<typeof BackgroundRemovalInputSchema>;
+export type BackgroundRemovalTaskOutput = FromSchema<typeof BackgroundRemovalOutputSchema>;
+export type BackgroundRemovalTaskExecuteInput = DeReplicateFromSchema<typeof BackgroundRemovalInputSchema>;
+export type BackgroundRemovalTaskExecuteOutput = DeReplicateFromSchema<typeof BackgroundRemovalOutputSchema>;
+/**
+ * Removes backgrounds from images using computer vision models
+ */
+export declare class BackgroundRemovalTask extends AiVisionTask<BackgroundRemovalTaskInput, BackgroundRemovalTaskOutput> {
+    static type: string;
+    static category: string;
+    static title: string;
+    static description: string;
+    static inputSchema(): DataPortSchema;
+    static outputSchema(): DataPortSchema;
+}
+/**
+ * Convenience function to run background removal tasks.
+ * Creates and executes a BackgroundRemovalTask with the provided input.
+ * @param input The input parameters for background removal (image and model)
+ * @returns Promise resolving to the image with transparent background
+ */
+export declare const BackgroundRemoval: (input: BackgroundRemovalTaskInput, config?: JobQueueTaskConfig) => Promise<{
+    image: string | string[];
+}>;
+declare module "@workglow/task-graph" {
+    interface Workflow {
+        BackgroundRemoval: CreateWorkflow<BackgroundRemovalTaskInput, BackgroundRemovalTaskOutput, JobQueueTaskConfig>;
+    }
+}
+//# sourceMappingURL=BackgroundRemovalTask.d.ts.map

package/dist/task/BackgroundRemovalTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackgroundRemovalTask.d.ts","sourceRoot":"","sources":["../../src/task/BackgroundRemovalTask.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAA0B,MAAM,sBAAsB,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EACL,qBAAqB,EAItB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAYnD,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQN,CAAC;AAEpC,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;CAWP,CAAC;AAEpC,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAAC;AACzF,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC3F,MAAM,MAAM,iCAAiC,GAAG,qBAAqB,CACnE,OAAO,4BAA4B,CACpC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAAG,qBAAqB,CACpE,OAAO,6BAA6B,CACrC,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY,CACrD,0BAA0B,EAC1B,2BAA2B,CAC5B;IACC,OAAc,IAAI,SAA2B;IAC7C,OAAc,QAAQ,SAAqB;IAC3C,OAAc,KAAK,SAAwB;IAC3C,OAAc,WAAW,SAC0D;WACrE,WAAW,IAAI,cAAc;WAG7B,YAAY,IAAI,cAAc;CAG7C;AAID;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,0BAA0B,EACjC,SAAS,kBAAkB;;EAG5B,CAAC;AAEF,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAU,QAAQ;QAChB,iBAAiB,EAAE,cAAc,CAC/B,0BAA0B,EAC1B,2BAA2B,EAC3B,kBAAkB,CACnB,CAAC;KACH;CACF"}