@braze/sanity-plugin-ai-translation 0.3.1 → 0.3.2

package/README.md

@@ -248,9 +248,16 @@ aiTranslationPlugin({
 The plugin exposes a server-only entry at `@braze/sanity-plugin-ai-translation/server` for running the OpenAI call outside the browser (for example in a Sanity function). It does not load React or Studio, it is not part of the Studio bundle, and it does not read the API key from the environment, so the caller passes it in.
 
 ```typescript
-import { requestOpenAICompletion } from "@braze/sanity-plugin-ai-translation/server";
+import {
+  isOpenAIModel,
+  OPENAI_MODELS,
+  requestOpenAICompletion,
+} from "@braze/sanity-plugin-ai-translation/server";
 
 // payload: { model, messages, reasoningEffort?, temperature? } assembled in Studio
+if (!isOpenAIModel(payload.model)) {
+  throw new Error(`model must be one of ${OPENAI_MODELS.join(", ")}`);
+}
 const { content, tokensUsed } = await requestOpenAICompletion(payload, {
   apiKey: process.env.OPENAI_API_KEY!,
 });
@@ -262,7 +269,7 @@ The first argument is the client-supplied request and is validated at runtime. T
 - Only `role` and `content` are sent for each message. Any other fields in the payload are dropped.
 - Logs never include prompt or document text, even with plugin logging turned on. They include only the model, message roles, and content lengths.
 
-Serialization, prompt assembly, structure validation, and the Content Release write stay in Studio. The entry does not allowlist models. Do that in the caller before invoking it.
+Serialization, prompt assembly, structure validation, and the Content Release write stay in Studio. The entry does not allowlist models on its own. Do that in the caller before invoking it, with `isOpenAIModel` (or `OPENAI_MODELS`): it is the same list the `openai.model` plugin option accepts, so Studio and the function never disagree about which models are allowed.
 
 ---
 

package/dist/index.d.ts

@@ -265,6 +265,26 @@ export declare type InferOriginalType<T> =
 export declare type InferTranslatableType<T> =
   T extends FieldTransform<unknown, infer R> ? R : never;
 
+/**
+ * OpenAI models the plugin supports.
+ *
+ * This is the single source of truth: Studio's `PluginConfig['openai']['model']` is derived from
+ * it, and the translation function allowlists against it before calling `requestOpenAICompletion`,
+ * so the two can never drift apart.
+ *
+ * @public
+ */
+declare const OPENAI_MODELS: readonly [
+  "gpt-5.1",
+  "gpt-5",
+  "gpt-5-mini",
+  "gpt-5-nano",
+  "gpt-5-pro",
+  "gpt-4o",
+  "gpt-4-turbo",
+  "gpt-4",
+];
+
 /**
  * Event emitted when an OpenAI API call is made
  * @public
@@ -284,6 +304,13 @@ declare interface OpenAIApiCallEvent extends TelemetryEventBase {
   };
 }
 
+/**
+ * An OpenAI model id from {@link OPENAI_MODELS}
+ *
+ * @public
+ */
+export declare type OpenAIModel = (typeof OPENAI_MODELS)[number];
+
 /**
  *
  * Configuration for the Sanity AI Translation plugin.
@@ -313,15 +340,11 @@ export declare interface PluginConfig {
      * @defaultValue 'ai-translation'
      */
     functionName?: string;
-    model?:
-      | "gpt-5.1"
-      | "gpt-5"
-      | "gpt-5-mini"
-      | "gpt-5-nano"
-      | "gpt-5-pro"
-      | "gpt-4o"
-      | "gpt-4-turbo"
-      | "gpt-4";
+    /**
+     * OpenAI model id. Must be one of `OPENAI_MODELS` from the server entry.
+     * @defaultValue 'gpt-5'
+     */
+    model?: OpenAIModel;
     reasoningEffort?: "low" | "medium" | "high";
     enabled?: boolean;
     defaultMode?: TranslationMode;