ai 3.0.14 → 3.0.16

package/dist/index.mjs

@@ -1,7 +1,7 @@
 // core/generate-object/generate-object.ts
 import zodToJsonSchema from "zod-to-json-schema";
 
-// ai-model-specification/errors/api-call-error.ts
+// spec/errors/api-call-error.ts
 var APICallError = class extends Error {
   constructor({
     message,
@@ -45,7 +45,7 @@ var APICallError = class extends Error {
   }
 };
 
-// ai-model-specification/errors/invalid-argument-error.ts
+// spec/errors/invalid-argument-error.ts
 var InvalidArgumentError = class extends Error {
   constructor({
     parameter,
@@ -71,7 +71,7 @@ var InvalidArgumentError = class extends Error {
   }
 };
 
-// ai-model-specification/errors/invalid-data-content-error.ts
+// spec/errors/invalid-data-content-error.ts
 var InvalidDataContentError = class extends Error {
   constructor({
     content,
@@ -94,7 +94,27 @@ var InvalidDataContentError = class extends Error {
   }
 };
 
-// ai-model-specification/util/get-error-message.ts
+// spec/errors/invalid-prompt-error.ts
+var InvalidPromptError = class extends Error {
+  constructor({ prompt: prompt2, message }) {
+    super(`Invalid prompt: ${message}`);
+    this.name = "AI_InvalidPromptError";
+    this.prompt = prompt2;
+  }
+  static isInvalidPromptError(error) {
+    return error instanceof Error && error.name === "AI_InvalidPromptError" && prompt != null;
+  }
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      stack: this.stack,
+      prompt: this.prompt
+    };
+  }
+};
+
+// spec/util/get-error-message.ts
 function getErrorMessage(error) {
   if (error == null) {
     return "unknown error";
@@ -108,10 +128,10 @@ function getErrorMessage(error) {
   return JSON.stringify(error);
 }
 
-// ai-model-specification/util/parse-json.ts
+// spec/util/parse-json.ts
 import SecureJSON from "secure-json-parse";
 
-// ai-model-specification/errors/json-parse-error.ts
+// spec/errors/json-parse-error.ts
 var JSONParseError = class extends Error {
   constructor({ text, cause }) {
     super(
@@ -136,7 +156,7 @@ Error message: ${getErrorMessage(cause)}`
   }
 };
 
-// ai-model-specification/errors/type-validation-error.ts
+// spec/errors/type-validation-error.ts
 var TypeValidationError = class extends Error {
   constructor({ value, cause }) {
     super(
@@ -161,7 +181,7 @@ Error message: ${getErrorMessage(cause)}`
   }
 };
 
-// ai-model-specification/util/validate-types.ts
+// spec/util/validate-types.ts
 function safeValidateTypes({
   value,
   schema
@@ -189,7 +209,7 @@ function safeValidateTypes({
   }
 }
 
-// ai-model-specification/util/parse-json.ts
+// spec/util/parse-json.ts
 function safeParseJSON({
   text,
   schema
@@ -211,7 +231,7 @@ function safeParseJSON({
   }
 }
 
-// ai-model-specification/util/uint8-utils.ts
+// spec/util/uint8-utils.ts
 function convertBase64ToUint8Array(base64String) {
   const base64Url = base64String.replace(/-/g, "+").replace(/_/g, "/");
   const latin1string = globalThis.atob(base64Url);
@@ -225,7 +245,7 @@ function convertUint8ArrayToBase64(array) {
   return globalThis.btoa(latin1string);
 }
 
-// ai-model-specification/errors/invalid-tool-arguments-error.ts
+// spec/errors/invalid-tool-arguments-error.ts
 var InvalidToolArgumentsError = class extends Error {
   constructor({
     toolArgs,
@@ -256,7 +276,7 @@ var InvalidToolArgumentsError = class extends Error {
   }
 };
 
-// ai-model-specification/errors/no-object-generated-error.ts
+// spec/errors/no-object-generated-error.ts
 var NoTextGeneratedError = class extends Error {
   constructor() {
     super(`No text generated.`);
@@ -275,7 +295,7 @@ var NoTextGeneratedError = class extends Error {
   }
 };
 
-// ai-model-specification/errors/no-such-tool-error.ts
+// spec/errors/no-such-tool-error.ts
 var NoSuchToolError = class extends Error {
   constructor({ message, toolName }) {
     super(message);
@@ -295,7 +315,7 @@ var NoSuchToolError = class extends Error {
   }
 };
 
-// ai-model-specification/errors/retry-error.ts
+// spec/errors/retry-error.ts
 var RetryError = class extends Error {
   constructor({
     message,
@@ -355,89 +375,101 @@ function convertDataContentToUint8Array(content) {
 }
 
 // core/prompt/convert-to-language-model-prompt.ts
-function convertToLanguageModelPrompt({
-  system,
-  prompt,
-  messages
-}) {
-  if (prompt == null && messages == null) {
-    throw new Error("prompt or messages must be defined");
-  }
-  if (prompt != null && messages != null) {
-    throw new Error("prompt and messages cannot be defined at the same time");
-  }
+function convertToLanguageModelPrompt(prompt2) {
   const languageModelMessages = [];
-  if (system != null) {
-    languageModelMessages.push({ role: "system", content: system });
-  }
-  if (typeof prompt === "string") {
-    languageModelMessages.push({
-      role: "user",
-      content: [{ type: "text", text: prompt }]
-    });
-  } else {
-    messages = messages;
-    languageModelMessages.push(
-      ...messages.map((message) => {
-        switch (message.role) {
-          case "user": {
-            if (typeof message.content === "string") {
+  if (prompt2.system != null) {
+    languageModelMessages.push({ role: "system", content: prompt2.system });
+  }
+  switch (prompt2.type) {
+    case "prompt": {
+      languageModelMessages.push({
+        role: "user",
+        content: [{ type: "text", text: prompt2.prompt }]
+      });
+      break;
+    }
+    case "messages": {
+      languageModelMessages.push(
+        ...prompt2.messages.map((message) => {
+          switch (message.role) {
+            case "user": {
+              if (typeof message.content === "string") {
+                return {
+                  role: "user",
+                  content: [{ type: "text", text: message.content }]
+                };
+              }
               return {
                 role: "user",
-                content: [{ type: "text", text: message.content }]
-              };
-            }
-            return {
-              role: "user",
-              content: message.content.map(
-                (part) => {
-                  switch (part.type) {
-                    case "text": {
-                      return part;
-                    }
-                    case "image": {
-                      return {
-                        type: "image",
-                        image: part.image instanceof URL ? part.image : convertDataContentToUint8Array(part.image),
-                        mimeType: part.mimeType
-                      };
+                content: message.content.map(
+                  (part) => {
+                    switch (part.type) {
+                      case "text": {
+                        return part;
+                      }
+                      case "image": {
+                        return {
+                          type: "image",
+                          image: part.image instanceof URL ? part.image : convertDataContentToUint8Array(part.image),
+                          mimeType: part.mimeType
+                        };
+                      }
                     }
                   }
-                }
-              )
-            };
-          }
-          case "assistant": {
-            if (typeof message.content === "string") {
-              return {
-                role: "assistant",
-                content: [{ type: "text", text: message.content }]
+                )
               };
             }
-            return { role: "assistant", content: message.content };
-          }
-          case "tool": {
-            return message;
+            case "assistant": {
+              if (typeof message.content === "string") {
+                return {
+                  role: "assistant",
+                  content: [{ type: "text", text: message.content }]
+                };
+              }
+              return { role: "assistant", content: message.content };
+            }
+            case "tool": {
+              return message;
+            }
           }
-        }
-      })
-    );
+        })
+      );
+      break;
+    }
+    default: {
+      const _exhaustiveCheck = prompt2;
+      throw new Error(`Unsupported prompt type: ${_exhaustiveCheck}`);
+    }
   }
   return languageModelMessages;
 }
 
-// core/prompt/get-input-format.ts
-function getInputFormat({
-  prompt,
-  messages
-}) {
-  if (prompt == null && messages == null) {
-    throw new Error("prompt or messages must be defined");
+// core/prompt/get-validated-prompt.ts
+function getValidatedPrompt(prompt2) {
+  if (prompt2.prompt == null && prompt2.messages == null) {
+    throw new InvalidPromptError({
+      prompt: prompt2,
+      message: "prompt or messages must be defined"
+    });
   }
-  if (prompt != null && messages != null) {
-    throw new Error("prompt and messages cannot be defined at the same time");
+  if (prompt2.prompt != null && prompt2.messages != null) {
+    throw new InvalidPromptError({
+      prompt: prompt2,
+      message: "prompt and messages cannot be defined at the same time"
+    });
   }
-  return prompt != null ? "prompt" : "messages";
+  return prompt2.prompt != null ? {
+    type: "prompt",
+    prompt: prompt2.prompt,
+    messages: void 0,
+    system: prompt2.system
+  } : {
+    type: "messages",
+    prompt: void 0,
+    messages: prompt2.messages,
+    // only possible case bc of checks above
+    system: prompt2.system
+  };
 }
 
 // core/prompt/prepare-call-settings.ts
@@ -649,7 +681,7 @@ async function experimental_generateObject({
   schema,
   mode,
   system,
-  prompt,
+  prompt: prompt2,
   messages,
   maxRetries,
   abortSignal,
@@ -667,19 +699,20 @@ async function experimental_generateObject({
   let warnings;
   switch (mode) {
     case "json": {
-      const generateResult = await retry(
-        () => model.doGenerate({
+      const validatedPrompt = getValidatedPrompt({
+        system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
+        prompt: prompt2,
+        messages
+      });
+      const generateResult = await retry(() => {
+        return model.doGenerate({
           mode: { type: "object-json" },
           ...prepareCallSettings(settings),
-          inputFormat: getInputFormat({ prompt, messages }),
-          prompt: convertToLanguageModelPrompt({
-            system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
-            prompt,
-            messages
-          }),
+          inputFormat: validatedPrompt.type,
+          prompt: convertToLanguageModelPrompt(validatedPrompt),
           abortSignal
-        })
-      );
+        });
+      });
       if (generateResult.text === void 0) {
         throw new NoTextGeneratedError();
       }
@@ -690,16 +723,17 @@ async function experimental_generateObject({
       break;
     }
     case "grammar": {
+      const validatedPrompt = getValidatedPrompt({
+        system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
+        prompt: prompt2,
+        messages
+      });
       const generateResult = await retry(
         () => model.doGenerate({
           mode: { type: "object-grammar", schema: jsonSchema },
           ...settings,
-          inputFormat: getInputFormat({ prompt, messages }),
-          prompt: convertToLanguageModelPrompt({
-            system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
-            prompt,
-            messages
-          }),
+          inputFormat: validatedPrompt.type,
+          prompt: convertToLanguageModelPrompt(validatedPrompt),
           abortSignal
         })
       );
@@ -713,6 +747,11 @@ async function experimental_generateObject({
       break;
     }
     case "tool": {
+      const validatedPrompt = getValidatedPrompt({
+        system,
+        prompt: prompt2,
+        messages
+      });
       const generateResult = await retry(
         () => model.doGenerate({
           mode: {
@@ -725,8 +764,8 @@ async function experimental_generateObject({
             }
           },
           ...settings,
-          inputFormat: getInputFormat({ prompt, messages }),
-          prompt: convertToLanguageModelPrompt({ system, prompt, messages }),
+          inputFormat: validatedPrompt.type,
+          prompt: convertToLanguageModelPrompt(validatedPrompt),
           abortSignal
         })
       );
@@ -1166,7 +1205,7 @@ async function experimental_streamObject({
   schema,
   mode,
   system,
-  prompt,
+  prompt: prompt2,
   messages,
   maxRetries,
   abortSignal,
@@ -1181,15 +1220,16 @@ async function experimental_streamObject({
   let transformer;
   switch (mode) {
     case "json": {
+      const validatedPrompt = getValidatedPrompt({
+        system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
+        prompt: prompt2,
+        messages
+      });
       callOptions = {
         mode: { type: "object-json" },
         ...prepareCallSettings(settings),
-        inputFormat: getInputFormat({ prompt, messages }),
-        prompt: convertToLanguageModelPrompt({
-          system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
-          prompt,
-          messages
-        }),
+        inputFormat: validatedPrompt.type,
+        prompt: convertToLanguageModelPrompt(validatedPrompt),
         abortSignal
       };
       transformer = {
@@ -1207,15 +1247,16 @@ async function experimental_streamObject({
       break;
     }
     case "grammar": {
+      const validatedPrompt = getValidatedPrompt({
+        system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
+        prompt: prompt2,
+        messages
+      });
       callOptions = {
         mode: { type: "object-grammar", schema: jsonSchema },
         ...settings,
-        inputFormat: getInputFormat({ prompt, messages }),
-        prompt: convertToLanguageModelPrompt({
-          system: injectJsonSchemaIntoSystem({ system, schema: jsonSchema }),
-          prompt,
-          messages
-        }),
+        inputFormat: validatedPrompt.type,
+        prompt: convertToLanguageModelPrompt(validatedPrompt),
         abortSignal
       };
       transformer = {
@@ -1233,6 +1274,11 @@ async function experimental_streamObject({
       break;
     }
     case "tool": {
+      const validatedPrompt = getValidatedPrompt({
+        system,
+        prompt: prompt2,
+        messages
+      });
       callOptions = {
         mode: {
           type: "object-tool",
@@ -1244,8 +1290,8 @@ async function experimental_streamObject({
           }
         },
         ...settings,
-        inputFormat: getInputFormat({ prompt, messages }),
-        prompt: convertToLanguageModelPrompt({ system, prompt, messages }),
+        inputFormat: validatedPrompt.type,
+        prompt: convertToLanguageModelPrompt(validatedPrompt),
         abortSignal
       };
       transformer = {
@@ -1352,7 +1398,7 @@ async function experimental_generateText({
   model,
   tools,
   system,
-  prompt,
+  prompt: prompt2,
   messages,
   maxRetries,
   abortSignal,
@@ -1360,8 +1406,9 @@ async function experimental_generateText({
 }) {
   var _a, _b;
   const retry = retryWithExponentialBackoff({ maxRetries });
-  const modelResponse = await retry(
-    () => model.doGenerate({
+  const validatedPrompt = getValidatedPrompt({ system, prompt: prompt2, messages });
+  const modelResponse = await retry(() => {
+    return model.doGenerate({
       mode: {
         type: "regular",
         tools: tools == null ? void 0 : Object.entries(tools).map(([name, tool2]) => ({
@@ -1372,15 +1419,11 @@ async function experimental_generateText({
         }))
       },
       ...prepareCallSettings(settings),
-      inputFormat: getInputFormat({ prompt, messages }),
-      prompt: convertToLanguageModelPrompt({
-        system,
-        prompt,
-        messages
-      }),
+      inputFormat: validatedPrompt.type,
+      prompt: convertToLanguageModelPrompt(validatedPrompt),
       abortSignal
-    })
-  );
+    });
+  });
   const toolCalls = [];
   for (const modelToolCall of (_a = modelResponse.toolCalls) != null ? _a : []) {
     toolCalls.push(parseToolCall({ toolCall: modelToolCall, tools }));
@@ -1589,13 +1632,14 @@ async function experimental_streamText({
   model,
   tools,
   system,
-  prompt,
+  prompt: prompt2,
   messages,
   maxRetries,
   abortSignal,
   ...settings
 }) {
   const retry = retryWithExponentialBackoff({ maxRetries });
+  const validatedPrompt = getValidatedPrompt({ system, prompt: prompt2, messages });
   const { stream, warnings } = await retry(
     () => model.doStream({
       mode: {
@@ -1608,12 +1652,8 @@ async function experimental_streamText({
         }))
       },
       ...prepareCallSettings(settings),
-      inputFormat: getInputFormat({ prompt, messages }),
-      prompt: convertToLanguageModelPrompt({
-        system,
-        prompt,
-        messages
-      }),
+      inputFormat: validatedPrompt.type,
+      prompt: convertToLanguageModelPrompt(validatedPrompt),
       abortSignal
     })
   );
@@ -1633,6 +1673,11 @@ var StreamTextResult = class {
     this.originalStream = stream;
     this.warnings = warnings;
   }
+  /**
+  A text stream that returns only the generated text deltas. You can use it
+  as either an AsyncIterable or a ReadableStream. When an error occurs, the
+  stream will throw the error.
+     */
   get textStream() {
     return createAsyncIterableStream(this.originalStream, {
       transform(chunk, controller) {
@@ -1646,6 +1691,12 @@ var StreamTextResult = class {
       }
     });
   }
+  /**
+  A stream with all events, including text deltas, tool calls, tool results, and
+  errors.
+  You can use it as either an AsyncIterable or a ReadableStream. When an error occurs, the
+  stream will throw the error.
+     */
   get fullStream() {
     return createAsyncIterableStream(this.originalStream, {
       transform(chunk, controller) {
@@ -1659,6 +1710,15 @@ var StreamTextResult = class {
       }
     });
   }
+  /**
+  Converts the result to an `AIStream` object that is compatible with `StreamingTextResponse`.
+  It can be used with the `useChat` and `useCompletion` hooks.
+  
+  @param callbacks 
+  Stream callbacks that will be called when the stream emits events.
+  
+  @returns an `AIStream` object.
+     */
   toAIStream(callbacks) {
     return readableFromAsyncIterable(this.textStream).pipeThrough(createCallbacksTransformer(callbacks)).pipeThrough(
       createStreamDataTransformer(callbacks == null ? void 0 : callbacks.experimental_streamData)