@xsai/image 0.0.0-stage → 1.0.0-beta.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Moeru AI
+
+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

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @xsai/image
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<!-- automd:file src="/docs/snippets/image.md" -->
+
+```sh
+pnpm add @xsai/image
+```
+
+```ts
+import { writeFile } from 'node:fs/promises'
+
+import { generateImage, generations } from '@xsai/image'
+
+const model = generations({
+  apiKey: process.env.OPENAI_API_KEY,
+  baseURL: 'https://api.openai.com/v1/',
+  model: 'YOUR_IMAGE_MODEL_ID',
+})
+
+const { image } = await generateImage(model, { input: 'A small cabin in a quiet forest.' })
+await writeFile('cabin.png', new Uint8Array(await image.arrayBuffer()))
+```
+
+<!-- /automd -->
+
+Read the [documentation](https://xsai.js.org/image).

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { Promisable, HttpOptions } from '@xsai/shared';
+
+type ImageModel = (options: ImageModelOptions) => Promisable<ImageModelResult>;
+interface ImageModelOptions {
+    input: string;
+    n?: number;
+    providerOptions?: ImageModelProviderOptions;
+    signal?: AbortSignal;
+    size?: `${number}x${number}`;
+}
+interface ImageModelProviderOptions {
+}
+interface ImageModelResult {
+    images: Blob[];
+    providerMetadata?: ImageModelResultProviderMetadata;
+}
+interface ImageModelResultProviderMetadata {
+}
+
+interface GenerateImageResult extends ImageModelResult {
+    image: Blob;
+}
+declare const generateImage: (model: ImageModel, options: ImageModelOptions) => Promise<GenerateImageResult>;
+
+declare module '@xsai/image' {
+    interface ImageModelProviderOptions {
+        generations?: {
+            background?: 'auto' | 'opaque' | 'transparent';
+            outputCompression?: number;
+            outputFormat?: 'jpeg' | 'png' | 'webp';
+            quality?: 'auto' | 'high' | 'low' | 'max' | 'medium' | 'xhigh';
+        };
+    }
+    interface ImageModelResultProviderMetadata {
+        generations?: {
+            images?: {
+                revisedPrompt?: string;
+            }[];
+        };
+    }
+}
+declare const generations: (options: HttpOptions) => ImageModel;
+
+export { generateImage, generations };
+export type { GenerateImageResult, ImageModel, ImageModelOptions, ImageModelProviderOptions, ImageModelResult, ImageModelResultProviderMetadata };

package/dist/index.js

@@ -0,0 +1,69 @@
+import { XSAIError, sendRequest } from '@xsai/shared';
+
+const generateImage = async (model, options) => {
+  const result = await model(options);
+  if (result.images.length === 0)
+    throw new XSAIError("invalid-response", "Image model returned no images");
+  return { ...result, image: result.images[0] };
+};
+
+const imageBlob = (base64) => {
+  const bytes = Uint8Array.fromBase64(base64);
+  const matches = (pattern, offset = 0) => {
+    for (let index = 0; index < pattern.length; index++) {
+      if (bytes[offset + index] !== pattern.charCodeAt(index))
+        return false;
+    }
+    return true;
+  };
+  let type;
+  if (matches("\x89PNG\r\n\n")) {
+    type = "image/png";
+  } else if (matches("\xFF\xD8\xFF")) {
+    type = "image/jpeg";
+  } else if (matches("GIF87a") || matches("GIF89a")) {
+    type = "image/gif";
+  } else if (matches("RIFF") && matches("WEBPVP", 8)) {
+    type = "image/webp";
+  } else if (matches("ftyp", 4)) {
+    const end = Math.min(bytes.length, new DataView(bytes.buffer).getUint32(0));
+    for (let offset = 8; offset + 4 <= end; offset += 4) {
+      if (offset !== 12 && (matches("avif", offset) || matches("avis", offset))) {
+        type = "image/avif";
+        break;
+      }
+    }
+  }
+  if (type == null)
+    throw new XSAIError("invalid-response", "Unrecognized image format");
+  return new Blob([bytes], { type });
+};
+const generations = (options) => async (modelOptions) => {
+  const wireOptions = modelOptions.providerOptions?.generations;
+  const response = await sendRequest({
+    body: {
+      background: wireOptions?.background,
+      model: options.model,
+      n: modelOptions.n,
+      output_compression: wireOptions?.outputCompression,
+      output_format: wireOptions?.outputFormat,
+      prompt: modelOptions.input,
+      quality: wireOptions?.quality,
+      size: modelOptions.size
+    },
+    path: "images/generations",
+    signal: modelOptions.signal
+  }, options);
+  const json = await response.json();
+  const result = { images: json.data.map((image) => imageBlob(image.b64_json)) };
+  if (json.data.some((image) => image.revised_prompt != null)) {
+    result.providerMetadata = {
+      generations: {
+        images: json.data.map((image) => image.revised_prompt == null ? {} : { revisedPrompt: image.revised_prompt })
+      }
+    };
+  }
+  return result;
+};
+
+export { generateImage, generations };

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@xsai/image",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "1.0.0-beta.1",
+  "description": "extra-small AI SDK: image generation.",
+  "author": "Moeru AI",
+  "license": "MIT",
+  "homepage": "https://xsai.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moeru-ai/xsai.git",
+    "directory": "packages/image"
+  },
+  "bugs": "https://github.com/moeru-ai/xsai/issues",
+  "keywords": [
+    "xsai",
+    "ai",
+    "openai",
+    "image",
+    "image-generation"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@xsai/shared": "1.0.0-beta.1"
+  },
+  "scripts": {
+    "build": "pkgroll --clean-dist",
+    "test": "vitest run --exclude e2e/**",
+    "test:watch": "vitest"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
 }