@teamflojo/floimg-stability 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Brett Cooke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,154 @@
+# @teamflojo/floimg-stability
+
+Stability AI integration for floimg, providing Stable Diffusion image generation and AI-powered transforms.
+
+## Installation
+
+```bash
+npm install @teamflojo/floimg-stability
+# or
+pnpm add @teamflojo/floimg-stability
+```
+
+## Configuration
+
+Set your Stability AI API key:
+
+```bash
+export STABILITY_API_KEY=your_key_here
+```
+
+Or pass it directly:
+
+```typescript
+import stability from "@teamflojo/floimg-stability";
+
+const generator = stability({ apiKey: "your_key_here" });
+```
+
+## Features
+
+### Image Generation (SDXL / SD3)
+
+Generate images using Stable Diffusion models:
+
+```typescript
+import { createClient } from "@teamflojo/floimg";
+import stability from "@teamflojo/floimg-stability";
+
+const floimg = createClient();
+floimg.registerGenerator(stability());
+
+const image = await floimg.generate({
+  generator: "stability",
+  params: {
+    prompt: "A majestic lion in the savanna",
+    negativePrompt: "blurry, low quality",
+    model: "sd3-large",
+    size: "1024x1024",
+    stylePreset: "photographic",
+  },
+});
+```
+
+**Parameters:**
+
+| Parameter      | Type   | Default     | Description                              |
+| -------------- | ------ | ----------- | ---------------------------------------- |
+| prompt         | string | (required)  | Image description                        |
+| negativePrompt | string | -           | What to avoid                            |
+| model          | string | "sd3-large" | Model variant                            |
+| size           | string | "1024x1024" | Image dimensions                         |
+| stylePreset    | string | -           | Style preset (photographic, anime, etc.) |
+| cfgScale       | number | 7           | Prompt adherence (1-35)                  |
+| steps          | number | 30          | Inference steps                          |
+| seed           | number | -           | Reproducibility seed                     |
+
+### Image Transforms
+
+AI-powered image transformations:
+
+```typescript
+import { stabilityTransform } from "@teamflojo/floimg-stability";
+
+floimg.registerTransformProvider(stabilityTransform());
+```
+
+**Available Transforms:**
+
+#### Remove Background
+
+Remove the background from an image:
+
+```typescript
+const result = await floimg.transform({
+  blob: inputImage,
+  op: "removeBackground",
+  provider: "stability-transform",
+});
+```
+
+#### Upscale (Creative Upscale)
+
+AI-powered 4x upscaling:
+
+```typescript
+const result = await floimg.transform({
+  blob: inputImage,
+  op: "upscale",
+  provider: "stability-transform",
+  params: {
+    prompt: "high quality, detailed", // Optional guidance
+    creativity: 0.3, // 0-0.35
+  },
+});
+```
+
+#### Search and Replace
+
+Find and replace objects in an image:
+
+```typescript
+const result = await floimg.transform({
+  blob: inputImage,
+  op: "searchAndReplace",
+  provider: "stability-transform",
+  params: {
+    prompt: "a golden retriever",
+    searchPrompt: "the dog",
+  },
+});
+```
+
+#### Outpaint
+
+Extend image boundaries:
+
+```typescript
+const result = await floimg.transform({
+  blob: inputImage,
+  op: "outpaint",
+  provider: "stability-transform",
+  params: {
+    prompt: "continue the landscape",
+    left: 100,
+    right: 100,
+    up: 0,
+    down: 50,
+    creativity: 0.5,
+  },
+});
+```
+
+## Transform Summary
+
+| Operation        | Description              | Required Params      |
+| ---------------- | ------------------------ | -------------------- |
+| removeBackground | Remove image background  | -                    |
+| upscale          | 4x AI upscaling          | -                    |
+| searchAndReplace | Find and replace objects | prompt, searchPrompt |
+| outpaint         | Extend image boundaries  | prompt               |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamflojo/floimg-stability",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Stability AI image generation plugin for floimg (SDXL, SD3)",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,14 +16,6 @@
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "prepublishOnly": "npm run build",
-    "test": "vitest --run"
-  },
   "keywords": [
     "floimg",
     "stability-ai",
@@ -45,11 +37,18 @@
   },
   "devDependencies": {
     "@types/node": "^22.10.2",
-    "@teamflojo/floimg": "workspace:*",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "@teamflojo/floimg": "0.4.0"
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "vitest --run"
   }
-}
+}