ai 3.0.14 → 3.0.15

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,7 @@ var InvalidDataContentError = class extends Error {
   }
 };
 
-// ai-model-specification/util/get-error-message.ts
+// spec/util/get-error-message.ts
 function getErrorMessage(error) {
   if (error == null) {
     return "unknown error";
@@ -108,10 +108,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 +136,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 +161,7 @@ Error message: ${getErrorMessage(cause)}`
   }
 };
 
-// ai-model-specification/util/validate-types.ts
+// spec/util/validate-types.ts
 function safeValidateTypes({
   value,
   schema
@@ -189,7 +189,7 @@ function safeValidateTypes({
   }
 }
 
-// ai-model-specification/util/parse-json.ts
+// spec/util/parse-json.ts
 function safeParseJSON({
   text,
   schema
@@ -211,7 +211,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 +225,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 +256,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 +275,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 +295,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,
@@ -1633,6 +1633,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 +1651,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 +1670,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)