@basementstudio/sanity-ai-image-plugin 0.1.1 → 0.1.3

package/README.md

@@ -4,115 +4,171 @@ Portable Sanity Studio plugin and server helper for generating images with
 Gemini, OpenAI, and other package-supported image models and dropping the
 result straight into Sanity image fields.
 
-This package is intentionally self-contained so it can be copied into a new repo
-or published later without dragging along an app-specific schema layout.
-
-This repo is source-first while it is being developed here:
-
-- package exports point at `src/*`
-
-## What It Owns
-
-- a Studio plugin via `aiImagePlugin(...)`
-- a plugin-owned settings document and settings tool
-- a generic image asset source
-- optional generate-button targets for specific image fields
-- a server helper export for the app-owned API route
-
-## Install Shape
-
-The package exposes two entrypoints:
-
-- `sanity-ai-image-plugin`
-- `sanity-ai-image-plugin/server`
-
-## Consumer Setup
+## Setup
 
 ### 1. Add the Studio plugin
 
+1. Import `aiImagePlugin` in your `sanity.config.ts`.
+2. Add it to the `plugins` array.
+3. Set `apiVersion`.
+4. Add a `generateButton` target for each image field that should show a
+  `Generate` button.
+
 ```ts
-import { defineConfig } from "sanity";
-import {
-  SUPPORTED_AI_IMAGE_MODELS,
-  createArticleFeaturedImageTarget,
-  aiImagePlugin,
-} from "sanity-ai-image-plugin";
-
-const allowedModels = [
-  SUPPORTED_AI_IMAGE_MODELS[0],
-  SUPPORTED_AI_IMAGE_MODELS[2],
-] as const;
+import { aiImagePlugin } from "@basementstudio/sanity-ai-image-plugin"
+import { defineConfig } from "sanity"
 
 export default defineConfig({
   // ...your existing config
   plugins: [
     aiImagePlugin({
       apiVersion: "2025-02-19",
-      allowedModels: [...allowedModels],
-      assetSource: true,
-      frontendRateLimit: {
-        maxRequests: 3,
-        windowSecs: 60,
-      },
       targets: [
-        createArticleFeaturedImageTarget(),
         {
-          id: "home-page-featured-image",
+          id: "article-featured-image",
           type: "generateButton",
-          title: "Home Page Featured Image",
-          documentType: "homePage",
+          documentType: "article",
           fieldPath: "featuredImage",
-          suggestedContextFieldPaths: ["title", "description"],
         },
       ],
     }),
   ],
-});
+})
 ```
 
-### 2. Add the thin app-owned route.
+With that config:
 
-```ts
-import {
-  handleAiImageRequest,
-  SUPPORTED_AI_IMAGE_MODELS,
-} from "sanity-ai-image-plugin/server";
+- the AI Image Plugin settings tool is registered in Studio
+- the default asset source is enabled
+- `article.featuredImage` gets a `Generate` button
+
+#### `aiImagePlugin(...)` options
+
+
+| Option              | Required | Default                                                                                     | Notes                                                                                                                                          |
+| ------------------- | -------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `apiVersion`        | Yes      | none                                                                                        | Sanity API version used by the plugin's client calls.                                                                                          |
+| `targets`           | No       | `[]`                                                                                        | Generate-button targets. Each matching target adds a `Generate` button above a Sanity image input.                                             |
+| `allowedModels`     | No       | `["gemini-2.5-flash-image"]`                                                                | Non-empty subset of `SUPPORTED_AI_IMAGE_MODELS`. The first entry becomes the default model in Studio unless settings or the route override it. |
+| `apiEndpoint`       | No       | `"/api/ai-image-plugin"`                                                                    | Path the Studio calls when generating images. Change this if your route lives somewhere else.                                                  |
+| `assetSource`       | No       | enabled with built-in defaults                                                              | Adds the plugin to the Sanity image asset picker. Set `false` to disable it, or pass an object to customize labels and copy.                   |
+| `frontendRateLimit` | No       | `{ maxRequests: 3, windowSecs: 60 }`                                                        | Browser-side rolling window limiter shared across tabs via `localStorage`. Set `false` to disable it.                                          |
+| `settingsTool`      | No       | `{ name: "ai-image-plugin-settings", title: "AI Image Plugin", registerSchemaType: false }` | Lets you rename the settings tool or opt into registering the schema type automatically.                                                       |
+
+
+#### `targets[]` generate-button fields
+
+
+| Field                        | Required | Default                                                                    | Notes                                                                                                                                     |
+| ---------------------------- | -------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                         | Yes      | none                                                                       | Stable target ID. This is also how per-target settings are stored.                                                                        |
+| `type`                       | Yes      | none                                                                       | Must be `"generateButton"`.                                                                                                               |
+| `documentType`               | Yes      | none                                                                       | Sanity document type the target should match, like `"article"` or `"homePage"`.                                                           |
+| `fieldPath`                  | Yes      | none                                                                       | Dot path to the image field, like `"featuredImage"` or `"seo.ogImage"`.                                                                   |
+| `title`                      | No       | none                                                                       | Friendly name shown in the settings tool and used as a fallback label in parts of the UI.                                                 |
+| `description`                | No       | `"Generate an image with AI Image Plugin for this field."` in the field UI | Short helper copy shown above the button and in the settings tool.                                                                        |
+| `dialogTitle`                | No       | `"Generate Image"`                                                         | Title shown at the top of the generate dialog.                                                                                            |
+| `promptLabel`                | No       | `"Custom prompt"`                                                          | Label for the freeform editor prompt field in the dialog.                                                                                 |
+| `promptPlaceholder`          | No       | `"Optional custom instructions for this image."`                           | Placeholder text for the editor prompt field.                                                                                             |
+| `suggestedContextFieldPaths` | No       | `[]`                                                                       | Top-level document fields that should be preselected as context tags when the dialog opens. Editors can still toggle them per generation. |
+
+
+#### `assetSource` fields
+
+
+| Field               | Required | Default                                                                                         | Notes                                                                                 |
+| ------------------- | -------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `enabled`           | No       | `true`                                                                                          | Set `false` to disable the asset source while keeping the rest of the plugin enabled. |
+| `id`                | No       | `"ai-image-plugin-asset-source"`                                                                | Stable target ID used for asset-source-specific settings.                             |
+| `title`             | No       | `"Image Asset Source"`                                                                          | Label shown in the asset picker.                                                      |
+| `description`       | No       | `"Adds AI Image Plugin to the image asset picker."`                                             | Helper text shown in the settings UI.                                                 |
+| `promptLabel`       | No       | `"Prompt"`                                                                                      | Label for the asset source prompt field.                                              |
+| `promptPlaceholder` | No       | `"Turn these references into a clean homepage hero image with warm daylight and subtle depth."` | Placeholder text for the asset source prompt field.                                   |
+
+
+#### `frontendRateLimit` fields
+
+
+| Field         | Required | Default | Notes                                                             |
+| ------------- | -------- | ------- | ----------------------------------------------------------------- |
+| `maxRequests` | No       | `3`     | Maximum generation attempts allowed during the configured window. |
+| `windowSecs`  | No       | `60`    | Rolling window length in seconds.                                 |
+
+
+#### `settingsTool` fields
+
+
+| Field                | Required | Default                      | Notes                                                                                    |
+| -------------------- | -------- | ---------------------------- | ---------------------------------------------------------------------------------------- |
+| `name`               | No       | `"ai-image-plugin-settings"` | Internal tool name.                                                                      |
+| `title`              | No       | `"AI Image Plugin"`          | Title shown in the Studio tool menu.                                                     |
+| `registerSchemaType` | No       | `false`                      | Set `true` if you want the plugin to register its settings document schema type for you. |
 
-const allowedModels = [
-  SUPPORTED_AI_IMAGE_MODELS[0],
-  SUPPORTED_AI_IMAGE_MODELS[2],
-] as const;
+
+### 2. Add the API route
+
+1. Create a POST route at `/api/ai-image-plugin`.
+2. Import `handleAiImageRequest` from the server entrypoint.
+3. Pass the shared secret and the provider API key(s) for the models you allow.
+4. If you customize `allowedModels` in Studio, mirror that same list here.
+
+```ts
+import { handleAiImageRequest } from "@basementstudio/sanity-ai-image-plugin/server"
 
 export async function POST(request: Request) {
   return handleAiImageRequest(request, {
-    allowedModels: [...allowedModels],
-    apiKey: process.env.GEMINI_API_KEY,
-    openAiApiKey: process.env.OPENAI_API_KEY,
+    apiKey: process.env.GEMINI_API_KEY!,
     sharedSecret: process.env.AI_IMAGE_PLUGIN_SHARED_SECRET!,
-    // Shared-secret auth and same-origin protection are enabled by default.
-    // Optional overrides:
-    // model: process.env.AI_IMAGE_MODEL as (typeof allowedModels)[number],
-    // maxReferenceFileBytes: 8 * 1024 * 1024,
-    // maxTotalReferenceBytes: 5 * 8 * 1024 * 1024,
   })
 }
 ```
 
-### 3. Set env vars
+If your route lives somewhere else, set `apiEndpoint` in `aiImagePlugin(...)`
+to match it.
+
+#### `handleAiImageRequest(request, options)` fields
+
+
+| Field                    | Required      | Default                                                              | Notes                                                                                                                     |
+| ------------------------ | ------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| `sharedSecret`           | Yes           | none                                                                 | Must exactly match the secret saved in Studio.                                                                            |
+| `apiKey`                 | Conditionally | none                                                                 | Google API key. Use this for Google models, or use `googleApiKey` instead.                                                |
+| `googleApiKey`           | Conditionally | none                                                                 | Provider-specific alias for Google models. If both `googleApiKey` and `apiKey` are present, `googleApiKey` wins.          |
+| `openAiApiKey`           | Conditionally | none                                                                 | Required when you allow OpenAI models such as `gpt-image-1`.                                                              |
+| `allowedModels`          | No            | If `model` is set, `[model]`; otherwise `["gemini-2.5-flash-image"]` | Non-empty subset of the package-supported models. Keep this in sync with the Studio config if you expose multiple models. |
+| `model`                  | No            | First entry in resolved `allowedModels`                              | Route-level default model. It must also be present in `allowedModels`.                                                    |
+| `enforceSameOrigin`      | No            | `true`                                                               | Rejects browser requests whose `Origin` does not match the API route origin.                                              |
+| `geminiApiUrl`           | No            | Google Generative Language API default base URL                      | Optional override for Google requests.                                                                                    |
+| `maxReferenceFileBytes`  | No            | `8 * 1024 * 1024`                                                    | Maximum size for a single reference image upload.                                                                         |
+| `maxReferences`          | No            | `5`                                                                  | Maximum number of reference images accepted per request.                                                                  |
+| `maxTotalReferenceBytes` | No            | `maxReferences * maxReferenceFileBytes`                              | Maximum combined size of all reference images in one request.                                                             |
+
+
+### 3. Set the env vars your route uses
+
+Add the variables your server route reads. For the minimal example above, you
+only need the shared secret and a Google API key.
+
+
+| Variable                        | Required      | Default | Notes                                                                                                                                                                    |
+| ------------------------------- | ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `AI_IMAGE_PLUGIN_SHARED_SECRET` | Yes           | none    | Shared secret used by your app route. Use a long random string.                                                                                                          |
+| `GEMINI_API_KEY`                | Conditionally | none    | Required when the active model is a Google model such as `gemini-2.5-flash-image`.                                                                                       |
+| `OPENAI_API_KEY`                | Conditionally | none    | Required when the active model is an OpenAI model such as `gpt-image-1`.                                                                                                 |
+| `AI_IMAGE_MODEL`                | No            | none    | Optional project-level env var you can read in your own route if you want to choose the default model from the environment. The plugin does not read this automatically. |
 
-- `GEMINI_API_KEY` is required when you allow Google models
-- `OPENAI_API_KEY` is required when you allow OpenAI models
-- `AI_IMAGE_PLUGIN_SHARED_SECRET` is required for the app-owned route
-- `AI_IMAGE_MODEL` is optional and can still override the server default
 
 ### 4. Configure the shared secret in Studio
 
-Open the AI Image Plugin settings tool and configure the same shared secret
-value there.
+1. Start your Sanity Studio.
+2. Open the `AI Image Plugin` tool in the Studio navigation.
+3. Click `Configure shared secret`.
+4. Paste the same value you set in `AI_IMAGE_PLUGIN_SHARED_SECRET`.
+5. Save it.
 
-The plugin stores that Studio-side value with `@sanity/studio-secrets`, so it
-is fetched at runtime for logged-in Studio users instead of being bundled into
-the Studio source code.
+The Studio stores this secret separately from the normal plugin settings
+document and sends it as the `x-ai-image-plugin-secret` header when
+generating images. If you ever rotate the secret, update it in both places.
 
 ## Supported Models
 
@@ -128,26 +184,6 @@ ordered `allowedModels` config. The first allowed model becomes the fallback
 default for both the Studio UI and the server helper unless the settings
 document or route overrides it.
 
-## Settings Model
-
-The plugin owns one settings document:
-
-- `_id`: `aiImagePlugin.settings`
-- `_type`: `aiImagePluginSettings`
-
-It stores:
-
-- `globalModel`
-- `globalPrompt`
-- `globalReferenceImages`
-- `targetConfigs[]`
-
-Each target config can override:
-
-- `targetId`
-- `prompt`
-- `referenceImages`
-
 ## Behavior
 
 ### Server helper
@@ -175,7 +211,7 @@ By default it also enforces:
 - `8 MiB` maximum per reference image
 - a combined reference-image cap of `maxReferences * 8 MiB`
 - the requested `model` must be both package-supported and present in the
-  route's configured `allowedModels`
+route's configured `allowedModels`
 
 If your framework supports route-level body limits, keep those enabled too.
 
@@ -260,27 +296,6 @@ Selected document context is built as generic lines such as:
 
 - `The field called "title" has content "...".`
 
-## Optional Preset
-
-`createArticleFeaturedImageTarget(...)` is an optional preset for
-`article.featuredImage`.
-
-It feeds the model:
-
-- shared global settings
-- target-specific article settings
-- editor-selectable document-derived title + excerpt context suggestions
-- optional editor prompt
-
-If you do not use that preset, the package still works as a generic asset source
-and generic generate-button plugin.
-
-## Desk Structure
-
-The plugin does not require custom desk structure wiring. If a consuming app
-uses a custom structure and wants to hide `aiImagePluginSettings` from the normal
-document list, that is optional and app-owned.
-
 ## PNG Normalization
 
 All reference images are converted to PNG before they are sent to the server
@@ -290,11 +305,3 @@ helper. That includes:
 - stored settings images downloaded from Sanity
 - new images uploaded through the settings tool
 
-## Development
-
-```sh
-bun run check
-bun run build
-bun test
-```
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@basementstudio/sanity-ai-image-plugin",
   "private": false,
-  "version": "0.1.1",
+  "version": "0.1.3",
   "packageManager": "bun@1.3.7",
   "description": "Portable Sanity Studio plugin and server helper for AI image generation.",
   "type": "module",

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export { SUPPORTED_AI_IMAGE_MODELS } from "./utils/models";
-export { aiImagePlugin } from "./studio/plugin";
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,3 +0,0 @@
-export { SUPPORTED_AI_IMAGE_MODELS } from "./utils/models";
-export { aiImagePlugin } from "./studio/plugin";
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/presets/article-featured-image.d.ts

@@ -1,3 +0,0 @@
-import type { GenerateButtonTarget } from "../utils/shared";
-export declare function createArticleFeaturedImageTarget(options?: Partial<Omit<GenerateButtonTarget, "type">>): GenerateButtonTarget;
-//# sourceMappingURL=article-featured-image.d.ts.map

package/dist/presets/article-featured-image.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"article-featured-image.d.ts","sourceRoot":"","sources":["../../src/presets/article-featured-image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAE3D,wBAAgB,gCAAgC,CAC9C,OAAO,GAAE,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAM,GACxD,oBAAoB,CAkBtB"}

package/dist/presets/article-featured-image.js

@@ -1,17 +0,0 @@
-export function createArticleFeaturedImageTarget(options = {}) {
-    return {
-        id: options.id || "article-featured-image",
-        type: "generateButton",
-        title: options.title || "Article Featured Image",
-        description: options.description ||
-            "Adds a Generate button that combines shared art direction, article context, and an optional editor prompt.",
-        dialogTitle: options.dialogTitle || "Generate Featured Image",
-        documentType: options.documentType || "article",
-        fieldPath: options.fieldPath || "featuredImage",
-        promptLabel: options.promptLabel || "Custom prompt",
-        promptPlaceholder: options.promptPlaceholder ||
-            "Optional custom instructions for this article image.",
-        suggestedContextFieldPaths: options.suggestedContextFieldPaths || ["title", "excerpt"],
-    };
-}
-//# sourceMappingURL=article-featured-image.js.map

package/dist/presets/article-featured-image.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"article-featured-image.js","sourceRoot":"","sources":["../../src/presets/article-featured-image.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,gCAAgC,CAC9C,UAAuD,EAAE;IAEzD,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,wBAAwB;QAC1C,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,wBAAwB;QAChD,WAAW,EACT,OAAO,CAAC,WAAW;YACnB,4GAA4G;QAC9G,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,yBAAyB;QAC7D,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,SAAS;QAC/C,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,eAAe;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,eAAe;QACnD,iBAAiB,EACf,OAAO,CAAC,iBAAiB;YACzB,sDAAsD;QACxD,0BAA0B,EACxB,OAAO,CAAC,0BAA0B,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;KAC7D,CAAA;AACH,CAAC"}

package/dist/server/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const DEFAULT_MODEL: "gemini-2.5-flash-image" | "gemini-3.1-flash-image-preview" | "gpt-image-1";
-export declare const DEFAULT_PROVIDER_API_URL = "https://generativelanguage.googleapis.com/v1beta";
-export declare const DEFAULT_MAX_REFERENCE_FILE_BYTES: number;
-export declare const SUPPORTED_REFERENCE_IMAGE_TYPES: Set<string>;
-export declare const OPENAI_SUPPORTED_REFERENCE_IMAGE_TYPES: Set<string>;
-//# sourceMappingURL=constants.d.ts.map

package/dist/server/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/server/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,6EAAmC,CAAC;AAC9D,eAAO,MAAM,wBAAwB,qDACe,CAAC;AACrD,eAAO,MAAM,gCAAgC,QAAkB,CAAC;AAEhE,eAAO,MAAM,+BAA+B,aAM1C,CAAC;AAEH,eAAO,MAAM,sCAAsC,aAIjD,CAAC"}

package/dist/server/constants.js

@@ -1,17 +0,0 @@
-import { DEFAULT_SUPPORTED_AI_IMAGE_MODEL } from "../utils/models";
-export const DEFAULT_MODEL = DEFAULT_SUPPORTED_AI_IMAGE_MODEL;
-export const DEFAULT_PROVIDER_API_URL = "https://generativelanguage.googleapis.com/v1beta";
-export const DEFAULT_MAX_REFERENCE_FILE_BYTES = 8 * 1024 * 1024;
-export const SUPPORTED_REFERENCE_IMAGE_TYPES = new Set([
-    "image/heic",
-    "image/heif",
-    "image/jpeg",
-    "image/png",
-    "image/webp",
-]);
-export const OPENAI_SUPPORTED_REFERENCE_IMAGE_TYPES = new Set([
-    "image/jpeg",
-    "image/png",
-    "image/webp",
-]);
-//# sourceMappingURL=constants.js.map

package/dist/server/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/server/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,CAAC,MAAM,aAAa,GAAG,gCAAgC,CAAC;AAC9D,MAAM,CAAC,MAAM,wBAAwB,GACnC,kDAAkD,CAAC;AACrD,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhE,MAAM,CAAC,MAAM,+BAA+B,GAAG,IAAI,GAAG,CAAC;IACrD,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,YAAY;CACb,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sCAAsC,GAAG,IAAI,GAAG,CAAC;IAC5D,YAAY;IACZ,WAAW;IACX,YAAY;CACb,CAAC,CAAC"}

package/dist/server/handle-request.d.ts

@@ -1,5 +0,0 @@
-import type { RequestOptions } from "./types";
-export { DEFAULT_MAX_REFERENCE_FILE_BYTES, DEFAULT_MODEL, DEFAULT_PROVIDER_API_URL, SUPPORTED_REFERENCE_IMAGE_TYPES, } from "./constants";
-export type { RequestOptions, SuccessResponse } from "./types";
-export declare function handleAiImageRequest(request: Request, options: RequestOptions): Promise<Response>;
-//# sourceMappingURL=handle-request.d.ts.map

package/dist/server/handle-request.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"handle-request.d.ts","sourceRoot":"","sources":["../../src/server/handle-request.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAAE,cAAc,EAAmB,MAAM,SAAS,CAAC;AAC/D,OAAO,EACL,gCAAgC,EAChC,aAAa,EACb,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/D,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,QAAQ,CAAC,CA4LnB"}

package/dist/server/handle-request.js

@@ -1,122 +0,0 @@
-import { isSupportedAiImageModelId, resolveAllowedAiImageModel, SUPPORTED_AI_IMAGE_MODELS, } from "../utils/models";
-import { generateImageWithModel, getErrorMessage, getErrorStatusCode, getFormRequestPayload, getMissingApiKeyErrorMessage, getProviderApiKey, getProviderDisplayName, getReferenceImageValidationError, getSameOriginValidationError, getSharedSecretValidationError, isMultipartFormData, jsonResponse, parseHeaderByteLength, resolveRequestOptions, } from "./utils";
-export { DEFAULT_MAX_REFERENCE_FILE_BYTES, DEFAULT_MODEL, DEFAULT_PROVIDER_API_URL, SUPPORTED_REFERENCE_IMAGE_TYPES, } from "./constants";
-export async function handleAiImageRequest(request, options) {
-    let requestOptions;
-    // Normalize server config up front so the rest of the handler can assume a
-    // single, fully-resolved set of limits and model choices.
-    try {
-        requestOptions = resolveRequestOptions(options);
-    }
-    catch (error) {
-        return jsonResponse({
-            error: getErrorMessage(error) ||
-                "AI Image Plugin server configuration is invalid.",
-        }, 500);
-    }
-    const sharedSecretError = getSharedSecretValidationError(request, requestOptions.sharedSecret);
-    if (sharedSecretError) {
-        return jsonResponse({
-            error: sharedSecretError.error,
-        }, sharedSecretError.status);
-    }
-    // Reject browser requests that do not come from the same Sanity Studio
-    // origin when same-origin enforcement is enabled.
-    if (requestOptions.enforceSameOrigin) {
-        const sameOriginError = getSameOriginValidationError(request);
-        if (sameOriginError) {
-            return jsonResponse({
-                error: sameOriginError.error,
-            }, sameOriginError.status);
-        }
-    }
-    // The endpoint only accepts multipart form submissions because prompt/model
-    // metadata and uploaded reference images arrive together.
-    if (!isMultipartFormData(request.headers.get("content-type"))) {
-        return jsonResponse({
-            error: "AI Image Plugin requires a multipart/form-data request.",
-        }, 415);
-    }
-    // Fail early on obviously oversized requests before parsing the body.
-    const contentLength = parseHeaderByteLength(request.headers.get("content-length"));
-    if (contentLength !== null &&
-        contentLength > requestOptions.maxTotalReferenceBytes) {
-        return jsonResponse({
-            error: `AI Image Plugin requests cannot exceed ${requestOptions.maxTotalReferenceBytes} bytes.`,
-        }, 413);
-    }
-    let formData;
-    // Parse the multipart payload into the prompt, optional model override, and
-    // the capped list of uploaded reference images.
-    try {
-        formData = await request.formData();
-    }
-    catch {
-        return jsonResponse({
-            error: "AI Image Plugin could not read the upload payload.",
-        }, 400);
-    }
-    const { prompt, referenceImages, requestedModel } = getFormRequestPayload(formData, requestOptions.maxReferences);
-    if (!prompt) {
-        return jsonResponse({ error: "Prompt is required." }, 400);
-    }
-    // Resolve the effective model, then make sure it is both supported by the
-    // plugin and allowed by this installation's server config.
-    const modelId = requestedModel || requestOptions.defaultModel;
-    if (!isSupportedAiImageModelId(modelId)) {
-        return jsonResponse({
-            error: `AI Image Plugin does not support the model "${modelId}". Supported models are: ${SUPPORTED_AI_IMAGE_MODELS.join(", ")}.`,
-        }, 400);
-    }
-    if (!requestOptions.allowedModels.includes(modelId)) {
-        return jsonResponse({
-            error: `AI Image Plugin does not allow the model "${modelId}" for this installation.`,
-        }, 400);
-    }
-    const selectedModel = resolveAllowedAiImageModel(modelId, requestOptions.allowedModels);
-    const referenceImageError = getReferenceImageValidationError({
-        maxReferenceFileBytes: requestOptions.maxReferenceFileBytes,
-        maxTotalReferenceBytes: requestOptions.maxTotalReferenceBytes,
-        model: selectedModel,
-        referenceImages,
-    });
-    if (referenceImageError) {
-        return jsonResponse({
-            error: referenceImageError.error,
-        }, referenceImageError.status);
-    }
-    // Pick the provider credentials that match the selected model family.
-    const apiKey = getProviderApiKey(selectedModel, options);
-    if (!apiKey) {
-        return jsonResponse({
-            error: getMissingApiKeyErrorMessage(selectedModel),
-        }, 500);
-    }
-    // Delegate the actual image generation call and translate provider failures
-    // into a stable API response shape for the Studio client.
-    try {
-        const generatedImage = await generateImageWithModel({
-            apiKey,
-            model: selectedModel,
-            prompt,
-            referenceImages,
-            ...(options.geminiApiUrl ? { geminiApiUrl: options.geminiApiUrl } : {}),
-        });
-        if (!generatedImage) {
-            return jsonResponse({
-                error: "AI Image Plugin returned a response, but no generated image was found.",
-            }, 502);
-        }
-        return jsonResponse({
-            ...generatedImage,
-            model: selectedModel,
-        });
-    }
-    catch (error) {
-        return jsonResponse({
-            error: getErrorMessage(error) ||
-                `AI Image Plugin could not reach ${getProviderDisplayName(selectedModel)}.`,
-        }, getErrorStatusCode(error) || 502);
-    }
-}
-//# sourceMappingURL=handle-request.js.map

package/dist/server/handle-request.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"handle-request.js","sourceRoot":"","sources":["../../src/server/handle-request.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC5B,iBAAiB,EACjB,sBAAsB,EACtB,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC9B,mBAAmB,EACnB,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,gCAAgC,EAChC,aAAa,EACb,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,aAAa,CAAC;AAGrB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,OAAuB;IAEvB,IAAI,cAAwD,CAAC;IAE7D,2EAA2E;IAC3E,0DAA0D;IAC1D,IAAI,CAAC;QACH,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,YAAY,CACjB;YACE,KAAK,EACH,eAAe,CAAC,KAAK,CAAC;gBACtB,kDAAkD;SACrD,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,MAAM,iBAAiB,GAAG,8BAA8B,CACtD,OAAO,EACP,cAAc,CAAC,YAAY,CAC5B,CAAC;IAEF,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,iBAAiB,CAAC,KAAK;SAC/B,EACD,iBAAiB,CAAC,MAAM,CACzB,CAAC;IACJ,CAAC;IAED,uEAAuE;IACvE,kDAAkD;IAClD,IAAI,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;QAE9D,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,YAAY,CACjB;gBACE,KAAK,EAAE,eAAe,CAAC,KAAK;aAC7B,EACD,eAAe,CAAC,MAAM,CACvB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,0DAA0D;IAC1D,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QAC9D,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,yDAAyD;SACjE,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,MAAM,aAAa,GAAG,qBAAqB,CACzC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CACtC,CAAC;IAEF,IACE,aAAa,KAAK,IAAI;QACtB,aAAa,GAAG,cAAc,CAAC,sBAAsB,EACrD,CAAC;QACD,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,0CAA0C,cAAc,CAAC,sBAAsB,SAAS;SAChG,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,QAAkB,CAAC;IAEvB,4EAA4E;IAC5E,gDAAgD;IAChD,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,oDAAoD;SAC5D,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,EAAE,GAAG,qBAAqB,CACvE,QAAQ,EACR,cAAc,CAAC,aAAa,CAC7B,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,YAAY,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED,0EAA0E;IAC1E,2DAA2D;IAC3D,MAAM,OAAO,GAAG,cAAc,IAAI,cAAc,CAAC,YAAY,CAAC;IAE9D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,+CAA+C,OAAO,4BAA4B,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACjI,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,6CAA6C,OAAO,0BAA0B;SACtF,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,MAAM,aAAa,GAAG,0BAA0B,CAC9C,OAAO,EACP,cAAc,CAAC,aAAa,CAC7B,CAAC;IACF,MAAM,mBAAmB,GAAG,gCAAgC,CAAC;QAC3D,qBAAqB,EAAE,cAAc,CAAC,qBAAqB;QAC3D,sBAAsB,EAAE,cAAc,CAAC,sBAAsB;QAC7D,KAAK,EAAE,aAAa;QACpB,eAAe;KAChB,CAAC,CAAC;IAEH,IAAI,mBAAmB,EAAE,CAAC;QACxB,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,mBAAmB,CAAC,KAAK;SACjC,EACD,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAEzD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,YAAY,CACjB;YACE,KAAK,EAAE,4BAA4B,CAAC,aAAa,CAAC;SACnD,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,0DAA0D;IAC1D,IAAI,CAAC;QACH,MAAM,cAAc,GAAG,MAAM,sBAAsB,CAAC;YAClD,MAAM;YACN,KAAK,EAAE,aAAa;YACpB,MAAM;YACN,eAAe;YACf,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxE,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,YAAY,CACjB;gBACE,KAAK,EACH,wEAAwE;aAC3E,EACD,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,OAAO,YAAY,CAAC;YAClB,GAAG,cAAc;YACjB,KAAK,EAAE,aAAa;SACK,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,YAAY,CACjB;YACE,KAAK,EACH,eAAe,CAAC,KAAK,CAAC;gBACtB,mCAAmC,sBAAsB,CAAC,aAAa,CAAC,GAAG;SAC9E,EACD,kBAAkB,CAAC,KAAK,CAAC,IAAI,GAAG,CACjC,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/server/types.d.ts

@@ -1,28 +0,0 @@
-import type { SupportedAiImageModelId } from "../utils/models";
-export type GenerateImageFunction = (options: Record<string, unknown>) => Promise<{
-    image?: unknown;
-}>;
-export type GeneratedImagePayload = {
-    base64?: string;
-    mediaType?: string;
-    uint8Array?: Uint8Array;
-};
-export type SuccessResponse = {
-    data: string;
-    mimeType: string;
-    model: string;
-};
-export type RequestOptions = {
-    allowedModels?: SupportedAiImageModelId[];
-    apiKey?: string;
-    enforceSameOrigin?: boolean;
-    geminiApiUrl?: string;
-    googleApiKey?: string;
-    maxReferenceFileBytes?: number;
-    maxReferences?: number;
-    maxTotalReferenceBytes?: number;
-    model?: SupportedAiImageModelId;
-    openAiApiKey?: string;
-    sharedSecret: string;
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/server/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/server/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAE/D,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC;IAChF,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/server/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/server/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/server/types.ts"],"names":[],"mappings":""}