@basementstudio/sanity-ai-image-plugin 0.0.0 → 0.1.0

package/package.json

@@ -1,28 +1,30 @@
-{
+{
   "name": "@basementstudio/sanity-ai-image-plugin",
   "private": false,
-  "version": "0.0.0",
+  "version": "0.1.0",
   "packageManager": "bun@1.3.7",
   "description": "Portable Sanity Studio plugin and server helper for AI image generation.",
-  "type": "module",
-  "sideEffects": false,
-  "files": [
-    "src",
-    "README.md"
-  ],
-  "exports": {
-    ".": {
-      "types": "./src/index.ts",
-      "import": "./src/index.ts",
-      "default": "./src/index.ts"
-    },
-    "./server": {
-      "types": "./src/server.ts",
-      "import": "./src/server.ts",
-      "default": "./src/server.ts"
-    },
-    "./package.json": "./package.json"
-  },
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "default": "./dist/server.js"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "check": "tsc -p tsconfig.json --noEmit",
@@ -33,35 +35,39 @@
     "version-canary": "changeset version --snapshot canary",
     "release-canary": "changeset publish --tag canary --no-git-tag"
   },
-  "keywords": [
-    "sanity",
-    "sanity-plugin",
-    "gemini",
-    "image-generation",
-    "ai-image-plugin"
-  ],
-  "peerDependencies": {
-    "@sanity/ui": "^2.0.0 || ^3.0.0",
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0",
-    "sanity": "^3.0.0 || ^4.0.0 || ^5.0.0"
-  },
-  "dependencies": {
-    "@ai-sdk/google": "^3",
-    "@ai-sdk/openai": "^3",
-    "ai": "^6"
-  },
-  "devDependencies": {
+  "keywords": [
+    "sanity",
+    "sanity-plugin",
+    "gemini",
+    "image-generation",
+    "ai-image-plugin"
+  ],
+  "peerDependencies": {
+    "@sanity/ui": "^3.1.13",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "sanity": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=20.19 <22 || >=22.12"
+  },
+  "dependencies": {
+    "@ai-sdk/google": "^3",
+    "@ai-sdk/openai": "^3",
+    "@sanity/studio-secrets": "^4.0.2",
+    "ai": "^6"
+  },
+  "devDependencies": {
     "@sanity/ui": "^3.1.14",
     "@changesets/changelog-github": "^0.5.2",
     "@changesets/cli": "^2.29.8",
     "@types/bun": "^1.3.6",
     "@types/node": "^20.19.30",
     "@types/react": "^19.2.9",
-    "@types/react-dom": "^19.2.3",
-    "react": "^19.2.4",
-    "react-dom": "^19.2.4",
-    "sanity": "^5.6.0",
-    "typescript": "^5.9.3"
-  }
-}
+    "@types/react-dom": "^19.2.3",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "sanity": "^5.6.0",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -1,23 +0,0 @@
-export {
-  DEFAULT_API_ENDPOINT,
-  DEFAULT_ASSET_SOURCE_TARGET_ID,
-  MAX_REFERENCE_IMAGES,
-  SETTINGS_DOCUMENT_ID,
-  SETTINGS_SCHEMA_TYPE,
-  SETTINGS_TOOL_NAME,
-  SETTINGS_TOOL_TITLE,
-  SOURCE_NAME,
-  SOURCE_TITLE,
-  type AssetSourceTarget,
-  type GenerateButtonTarget,
-  type PluginOptions,
-  type SettingsTargetConfigValue,
-  type SettingsValue,
-  type StoredImage,
-} from "./utils/shared";
-export {
-  SUPPORTED_AI_IMAGE_MODELS,
-  type SupportedAiImageModelId,
-} from "./utils/models";
-export { createArticleFeaturedImageTarget } from "./presets/article-featured-image";
-export { aiImagePlugin } from "./studio/plugin";

package/src/presets/article-featured-image.ts

@@ -1,23 +0,0 @@
-import type { GenerateButtonTarget } from "../utils/shared"
-
-export function createArticleFeaturedImageTarget(
-  options: Partial<Omit<GenerateButtonTarget, "type">> = {}
-): GenerateButtonTarget {
-  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"],
-  }
-}

package/src/server/handle-request.ts

@@ -1,207 +0,0 @@
-import {
-  isSupportedAiImageModelId,
-  resolveAllowedAiImageModel,
-  SUPPORTED_AI_IMAGE_MODELS,
-} from "../utils/models";
-import {
-  generateImageWithModel,
-  getErrorMessage,
-  getErrorStatusCode,
-  getFormRequestPayload,
-  getMissingApiKeyErrorMessage,
-  getProviderApiKey,
-  getProviderDisplayName,
-  getReferenceImageValidationError,
-  getSameOriginValidationError,
-  isMultipartFormData,
-  jsonResponse,
-  parseHeaderByteLength,
-  resolveRequestOptions,
-} from "./utils";
-import type { RequestOptions, SuccessResponse } 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 async function handleAiImageRequest(
-  request: Request,
-  options: RequestOptions = {},
-): Promise<Response> {
-  let requestOptions: ReturnType<typeof resolveRequestOptions>;
-
-  // 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,
-    );
-  }
-
-  // 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: 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,
-    } satisfies SuccessResponse);
-  } catch (error) {
-    return jsonResponse(
-      {
-        error:
-          getErrorMessage(error) ||
-          `AI Image Plugin could not reach ${getProviderDisplayName(selectedModel)}.`,
-      },
-      getErrorStatusCode(error) || 502,
-    );
-  }
-}

package/src/server/types.ts

@@ -1,30 +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;
-};