@browser-ai/core 1.0.0 → 2.0.1

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2StreamPart, EmbeddingModelV2, EmbeddingModelV2Embedding, ProviderV2 } from '@ai-sdk/provider';
+import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, EmbeddingModelV3CallOptions, EmbeddingModelV3Result, ProviderV3 } from '@ai-sdk/provider';
 import { TextEmbedder } from '@mediapipe/tasks-text';
 import { UIMessage } from 'ai';
 
-type BuiltInAIChatModelId = "text";
-interface BuiltInAIChatSettings extends LanguageModelCreateOptions {
+type BrowserAIChatModelId = "text";
+interface BrowserAIChatSettings extends LanguageModelCreateOptions {
     /**
      * Expected input types for the session, for multimodal inputs.
      */
@@ -11,25 +11,25 @@ interface BuiltInAIChatSettings extends LanguageModelCreateOptions {
         type: "text" | "image" | "audio";
         languages?: string[];
     }>;
+    /**
+     * Callback invoked when the model quota is exceeded.
+     * @see [Prompt API Quota Overflow](https://github.com/webmachinelearning/prompt-api?tab=readme-ov-file#tokenization-context-window-length-limits-and-overflow)
+     * @param event
+     */
+    onQuotaOverflow?: (event: Event) => void;
 }
 /**
- * Check if the browser supports the built-in AI API
- * @returns true if the browser supports the built-in AI API, false otherwise
- */
-declare function doesBrowserSupportBuiltInAI(): boolean;
-/**
- * Check if the Prompt API is available
- * @deprecated Use `doesBrowserSupportBuiltInAI()` instead for clearer naming
- * @returns true if the browser supports the built-in AI API, false otherwise
+ * Check if the browser supports the browser AI API
+ * @returns true if the browser supports the browser AI API, false otherwise
  */
-declare function isBuiltInAIModelAvailable(): boolean;
-declare class BuiltInAIChatLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion = "v2";
-    readonly modelId: BuiltInAIChatModelId;
+declare function doesBrowserSupportBrowserAI(): boolean;
+declare class BrowserAIChatLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion = "v3";
+    readonly modelId: BrowserAIChatModelId;
     readonly provider = "browser-ai";
     private readonly config;
     private readonly sessionManager;
-    constructor(modelId: BuiltInAIChatModelId, options?: BuiltInAIChatSettings);
+    constructor(modelId: BrowserAIChatModelId, options?: BrowserAIChatSettings);
     readonly supportedUrls: Record<string, RegExp[]>;
     /**
      * Gets a session with the specified options
@@ -45,24 +45,9 @@ declare class BuiltInAIChatLanguageModel implements LanguageModelV2 {
      * @throws {LoadSettingError} When the Prompt API is not available or model needs to be downloaded
      * @throws {UnsupportedFunctionalityError} When unsupported features like file input are used
      */
-    doGenerate(options: LanguageModelV2CallOptions): Promise<{
-        content: LanguageModelV2Content[];
-        finishReason: LanguageModelV2FinishReason;
-        usage: {
-            inputTokens: undefined;
-            outputTokens: undefined;
-            totalTokens: undefined;
-        };
-        request: {
-            body: {
-                messages: LanguageModelMessage[];
-                options: LanguageModelPromptOptions & LanguageModelCreateCoreOptions;
-            };
-        };
-        warnings: LanguageModelV2CallWarning[];
-    }>;
+    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
     /**
-     * Check the availability of the built-in AI model
+     * Check the availability of the browser AI model
      * @returns Promise resolving to "unavailable", "available", or "available-after-download"
      */
     availability(): Promise<Availability>;
@@ -90,18 +75,10 @@ declare class BuiltInAIChatLanguageModel implements LanguageModelV2 {
      * @throws {LoadSettingError} When the Prompt API is not available or model needs to be downloaded
      * @throws {UnsupportedFunctionalityError} When unsupported features like file input are used
      */
-    doStream(options: LanguageModelV2CallOptions): Promise<{
-        stream: ReadableStream<LanguageModelV2StreamPart>;
-        request: {
-            body: {
-                messages: LanguageModelMessage[];
-                options: LanguageModelPromptOptions & LanguageModelCreateCoreOptions;
-            };
-        };
-    }>;
+    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
 }
 
-interface BuiltInAIEmbeddingModelSettings {
+interface BrowserAIEmbeddingModelSettings {
     /**
      * An optional base path to specify the directory the Wasm files should be loaded from.
      * @default 'https://pub-ddcfe353995744e89b8002f16bf98575.r2.dev/text_wasm_internal.js'
@@ -139,8 +116,8 @@ interface BuiltInAIEmbeddingModelSettings {
      */
     delegate?: "CPU" | "GPU";
 }
-declare class BuiltInAIEmbeddingModel implements EmbeddingModelV2<string> {
-    readonly specificationVersion = "v2";
+declare class BrowserAIEmbeddingModel implements EmbeddingModelV3 {
+    readonly specificationVersion = "v3";
     readonly provider = "google-mediapipe";
     readonly modelId: string;
     readonly supportsParallelCalls = true;
@@ -148,57 +125,51 @@ declare class BuiltInAIEmbeddingModel implements EmbeddingModelV2<string> {
     private settings;
     private modelAssetBuffer;
     private textEmbedder;
-    constructor(settings?: BuiltInAIEmbeddingModelSettings);
+    constructor(settings?: BrowserAIEmbeddingModelSettings);
     protected getTextEmbedder: () => Promise<TextEmbedder>;
-    doEmbed: (options: {
-        values: string[];
-        abortSignal?: AbortSignal;
-    }) => Promise<{
-        embeddings: Array<EmbeddingModelV2Embedding>;
-        rawResponse?: Record<PropertyKey, any>;
-    }>;
+    doEmbed: (options: EmbeddingModelV3CallOptions) => Promise<EmbeddingModelV3Result>;
 }
 
-interface BuiltInAIProvider extends ProviderV2 {
-    (modelId?: BuiltInAIChatModelId, settings?: BuiltInAIChatSettings): BuiltInAIChatLanguageModel;
+interface BrowserAIProvider extends ProviderV3 {
+    (modelId?: BrowserAIChatModelId, settings?: BrowserAIChatSettings): BrowserAIChatLanguageModel;
     /**
      * Creates a model for text generation.
      */
-    languageModel(modelId: BuiltInAIChatModelId, settings?: BuiltInAIChatSettings): BuiltInAIChatLanguageModel;
+    languageModel(modelId: BrowserAIChatModelId, settings?: BrowserAIChatSettings): BrowserAIChatLanguageModel;
     /**
      * Creates a model for text generation.
      */
-    chat(modelId: BuiltInAIChatModelId, settings?: BuiltInAIChatSettings): BuiltInAIChatLanguageModel;
-    textEmbedding(modelId: "embedding", settings?: BuiltInAIEmbeddingModelSettings): EmbeddingModelV2<string>;
-    textEmbeddingModel: (modelId: "embedding", settings?: BuiltInAIEmbeddingModelSettings) => EmbeddingModelV2<string>;
+    chat(modelId: BrowserAIChatModelId, settings?: BrowserAIChatSettings): BrowserAIChatLanguageModel;
+    embedding(modelId: "embedding", settings?: BrowserAIEmbeddingModelSettings): EmbeddingModelV3;
+    embeddingModel: (modelId: "embedding", settings?: BrowserAIEmbeddingModelSettings) => EmbeddingModelV3;
     imageModel(modelId: string): never;
     speechModel(modelId: string): never;
     transcriptionModel(modelId: string): never;
 }
-interface BuiltInAIProviderSettings {
+interface BrowserAIProviderSettings {
 }
 /**
- * Create a BuiltInAI provider instance.
+ * Create a BrowserAI provider instance.
  */
-declare function createBuiltInAI(options?: BuiltInAIProviderSettings): BuiltInAIProvider;
+declare function createBrowserAI(options?: BrowserAIProviderSettings): BrowserAIProvider;
 /**
- * Default BuiltInAI provider instance.
+ * Default BrowserAI provider instance.
  */
-declare const builtInAI: BuiltInAIProvider;
+declare const browserAI: BrowserAIProvider;
 
 /**
- * UI message type for built-in AI features with custom data parts.
+ * UI message type for browser AI features with custom data parts.
  *
  * Extends base UIMessage to include specific data part schemas
- * for built-in AI functionality such as model download progress tracking
+ * for browser AI functionality such as model download progress tracking
  *
  * @example
  * // Import and use with useChat hook from @ai-sdk/react
  * ```typescript
  * import { useChat } from "@ai-sdk/react";
- * import { BuiltInAIUIMessage } from "@built-in-ai/core";
+ * import { BrowserAIUIMessage } from "@browser-ai/core";
  *
- * const { messages, sendMessage } = useChat<BuiltInAIUIMessage>({
+ * const { messages, sendMessage } = useChat<BrowserAIUIMessage>({
  *   onData: (dataPart) => {
  *     if (dataPart.type === 'data-modelDownloadProgress') {
  *       console.log(`Download: ${dataPart.data.progress}%`);
@@ -212,7 +183,7 @@ declare const builtInAI: BuiltInAIProvider;
  *
  * @see {@link https://v5.ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat | useChat hook documentation}
  */
-type BuiltInAIUIMessage = UIMessage<
+type BrowserAIUIMessage = UIMessage<
   never, // No custom metadata type
   {
     /**
@@ -240,4 +211,4 @@ type BuiltInAIUIMessage = UIMessage<
   }
 >;
 
-export { BuiltInAIChatLanguageModel, type BuiltInAIChatSettings, BuiltInAIEmbeddingModel, type BuiltInAIEmbeddingModelSettings, type BuiltInAIProvider, type BuiltInAIProviderSettings, type BuiltInAIUIMessage, builtInAI, createBuiltInAI, doesBrowserSupportBuiltInAI, isBuiltInAIModelAvailable };
+export { BrowserAIChatLanguageModel, type BrowserAIChatSettings, BrowserAIEmbeddingModel, type BrowserAIEmbeddingModelSettings, type BrowserAIProvider, type BrowserAIProviderSettings, type BrowserAIUIMessage, browserAI, createBrowserAI, doesBrowserSupportBrowserAI };

package/dist/index.js

@@ -20,16 +20,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  BuiltInAIChatLanguageModel: () => BuiltInAIChatLanguageModel,
-  BuiltInAIEmbeddingModel: () => BuiltInAIEmbeddingModel,
-  builtInAI: () => builtInAI,
-  createBuiltInAI: () => createBuiltInAI,
-  doesBrowserSupportBuiltInAI: () => doesBrowserSupportBuiltInAI,
-  isBuiltInAIModelAvailable: () => isBuiltInAIModelAvailable
+  BrowserAIChatLanguageModel: () => BrowserAIChatLanguageModel,
+  BrowserAIEmbeddingModel: () => BrowserAIEmbeddingModel,
+  browserAI: () => browserAI,
+  createBrowserAI: () => createBrowserAI,
+  doesBrowserSupportBrowserAI: () => doesBrowserSupportBrowserAI
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/convert-to-built-in-ai-messages.ts
+// src/convert-to-browser-ai-messages.ts
 var import_provider = require("@ai-sdk/provider");
 
 // src/tool-calling/format-tool-results.ts
@@ -56,7 +55,7 @@ ${payloads.join("\n")}
 \`\`\``;
 }
 
-// src/convert-to-built-in-ai-messages.ts
+// src/convert-to-browser-ai-messages.ts
 function convertBase64ToUint8Array(base64) {
   try {
     const binaryString = atob(base64);
@@ -125,6 +124,8 @@ function convertToolResultOutput(output) {
       return { value: output.value, isError: true };
     case "content":
       return { value: output.value, isError: false };
+    case "execution-denied":
+      return { value: output.reason, isError: true };
     default: {
       const exhaustiveCheck = output;
       return { value: exhaustiveCheck, isError: false };
@@ -140,7 +141,7 @@ function toToolResult(part) {
     isError
   };
 }
-function convertToBuiltInAIMessages(prompt) {
+function convertToBrowserAIMessages(prompt) {
   const normalizedPrompt = prompt.slice();
   let systemMessage;
   const messages = [];
@@ -376,17 +377,17 @@ function parseJsonFunctionCalls(response) {
 }
 
 // src/utils/warnings.ts
-function createUnsupportedSettingWarning(setting, details) {
+function createUnsupportedSettingWarning(feature, details) {
   return {
-    type: "unsupported-setting",
-    setting,
+    type: "unsupported",
+    feature,
     details
   };
 }
 function createUnsupportedToolWarning(tool, details) {
   return {
-    type: "unsupported-tool",
-    tool,
+    type: "unsupported",
+    feature: `tool:${tool.name}`,
     details
   };
 }
@@ -558,7 +559,7 @@ var SessionManager = class {
   async getSession(options) {
     if (typeof LanguageModel === "undefined") {
       throw new import_provider2.LoadSettingError({
-        message: "Prompt API is not available. This library requires Chrome or Edge browser with built-in AI capabilities."
+        message: "Prompt API is not available. This library requires Chrome or Edge browser with browser AI capabilities."
       });
     }
     if (this.session) {
@@ -572,6 +573,16 @@ var SessionManager = class {
     }
     const sessionOptions = this.prepareSessionOptions(options);
     this.session = await LanguageModel.create(sessionOptions);
+    const onQuotaOverflow = options?.onQuotaOverflow || this.baseOptions.onQuotaOverflow;
+    if (onQuotaOverflow) {
+      this.session.addEventListener("quotaoverflow", onQuotaOverflow);
+    } else {
+      this.session.addEventListener("quotaoverflow", () => {
+        console.warn(
+          "Model quota exceeded. Consider handling 'quotaoverflow' event."
+        );
+      });
+    }
     return this.session;
   }
   /**
@@ -596,7 +607,7 @@ var SessionManager = class {
     return this.getSession({ onDownloadProgress });
   }
   /**
-   * Checks the availability status of the built-in AI model
+   * Checks the availability status of the browser AI model
    *
    * @returns Promise resolving to availability status
    * - "unavailable": Model is not supported
@@ -652,6 +663,7 @@ var SessionManager = class {
         systemMessage,
         expectedInputs,
         onDownloadProgress,
+        onQuotaOverflow,
         ...createOptions
       } = options;
       Object.assign(mergedOptions, createOptions);
@@ -936,11 +948,8 @@ ${this.FENCE_END}`;
   }
 };
 
-// src/built-in-ai-language-model.ts
-function doesBrowserSupportBuiltInAI() {
-  return typeof LanguageModel !== "undefined";
-}
-function isBuiltInAIModelAvailable() {
+// src/browser-ai-language-model.ts
+function doesBrowserSupportBrowserAI() {
   return typeof LanguageModel !== "undefined";
 }
 function extractToolName(content) {
@@ -1000,9 +1009,9 @@ function extractArgumentsContent(content) {
   }
   return result;
 }
-var BuiltInAIChatLanguageModel = class {
+var BrowserAIChatLanguageModel = class {
   constructor(modelId, options = {}) {
-    this.specificationVersion = "v2";
+    this.specificationVersion = "v3";
     this.provider = "browser-ai";
     this.supportedUrls = {
       "image/*": [/^https?:\/\/.+$/],
@@ -1070,7 +1079,7 @@ var BuiltInAIChatLanguageModel = class {
       );
     }
     const hasMultiModalInput = hasMultimodalContent(prompt);
-    const { systemMessage, messages } = convertToBuiltInAIMessages(prompt);
+    const { systemMessage, messages } = convertToBrowserAIMessages(prompt);
     const promptOptions = {};
     if (responseFormat?.type === "json") {
       promptOptions.responseConstraint = responseFormat.schema;
@@ -1141,11 +1150,19 @@ var BuiltInAIChatLanguageModel = class {
       }
       return {
         content: parts,
-        finishReason: "tool-calls",
+        finishReason: { unified: "tool-calls", raw: "tool-calls" },
         usage: {
-          inputTokens: void 0,
-          outputTokens: void 0,
-          totalTokens: void 0
+          inputTokens: {
+            total: void 0,
+            noCache: void 0,
+            cacheRead: void 0,
+            cacheWrite: void 0
+          },
+          outputTokens: {
+            total: void 0,
+            text: void 0,
+            reasoning: void 0
+          }
         },
         request: { body: { messages: promptMessages, options: promptOptions } },
         warnings
@@ -1159,18 +1176,26 @@ var BuiltInAIChatLanguageModel = class {
     ];
     return {
       content,
-      finishReason: "stop",
+      finishReason: { unified: "stop", raw: "stop" },
       usage: {
-        inputTokens: void 0,
-        outputTokens: void 0,
-        totalTokens: void 0
+        inputTokens: {
+          total: void 0,
+          noCache: void 0,
+          cacheRead: void 0,
+          cacheWrite: void 0
+        },
+        outputTokens: {
+          total: void 0,
+          text: void 0,
+          reasoning: void 0
+        }
       },
       request: { body: { messages: promptMessages, options: promptOptions } },
       warnings
     };
   }
   /**
-   * Check the availability of the built-in AI model
+   * Check the availability of the browser AI model
    * @returns Promise resolving to "unavailable", "available", or "available-after-download"
    */
   async availability() {
@@ -1274,9 +1299,17 @@ var BuiltInAIChatLanguageModel = class {
             type: "finish",
             finishReason,
             usage: {
-              inputTokens: session.inputUsage,
-              outputTokens: void 0,
-              totalTokens: void 0
+              inputTokens: {
+                total: session.inputUsage,
+                noCache: void 0,
+                cacheRead: void 0,
+                cacheWrite: void 0
+              },
+              outputTokens: {
+                total: void 0,
+                text: void 0,
+                reasoning: void 0
+              }
             }
           });
           controller.close();
@@ -1289,7 +1322,7 @@ var BuiltInAIChatLanguageModel = class {
           if (currentReader) {
             currentReader.cancel().catch(() => void 0);
           }
-          finishStream("stop");
+          finishStream({ unified: "stop", raw: "aborted" });
         };
         if (options.abortSignal) {
           options.abortSignal.addEventListener("abort", abortHandler);
@@ -1502,17 +1535,17 @@ var BuiltInAIChatLanguageModel = class {
               fenceDetector.clearBuffer();
             }
             if (!toolBlockDetected || toolCalls.length === 0) {
-              finishStream("stop");
+              finishStream({ unified: "stop", raw: "stop" });
               return;
             }
             if (trailingTextAfterBlock) {
               emitTextDelta(trailingTextAfterBlock);
             }
-            finishStream("tool-calls");
+            finishStream({ unified: "tool-calls", raw: "tool-calls" });
             return;
           }
           if (!finished && !aborted) {
-            finishStream("other");
+            finishStream({ unified: "other", raw: "other" });
           }
         } catch (error) {
           controller.enqueue({ type: "error", error });
@@ -1531,11 +1564,11 @@ var BuiltInAIChatLanguageModel = class {
   }
 };
 
-// src/built-in-ai-embedding-model.ts
+// src/browser-ai-embedding-model.ts
 var import_tasks_text = require("@mediapipe/tasks-text");
-var BuiltInAIEmbeddingModel = class {
+var BrowserAIEmbeddingModel = class {
   constructor(settings = {}) {
-    this.specificationVersion = "v2";
+    this.specificationVersion = "v3";
     this.provider = "google-mediapipe";
     this.modelId = "embedding";
     this.supportsParallelCalls = true;
@@ -1575,11 +1608,14 @@ var BuiltInAIEmbeddingModel = class {
       });
       return {
         embeddings,
-        rawResponse: {
-          model: "universal_sentence_encoder",
-          provider: "google-mediapipe",
-          processed_texts: options.values.length
-        }
+        providerMetadata: {
+          mediapipe: {
+            model: "universal_sentence_encoder",
+            provider: "google-mediapipe",
+            processed_texts: options.values.length
+          }
+        },
+        warnings: []
       };
     };
     this.settings = { ...this.settings, ...settings };
@@ -1590,27 +1626,28 @@ var BuiltInAIEmbeddingModel = class {
   }
 };
 
-// src/built-in-ai-provider.ts
+// src/browser-ai-provider.ts
 var import_provider3 = require("@ai-sdk/provider");
-function createBuiltInAI(options = {}) {
+function createBrowserAI(options = {}) {
   const createChatModel = (modelId, settings) => {
-    return new BuiltInAIChatLanguageModel(modelId, settings);
+    return new BrowserAIChatLanguageModel(modelId, settings);
   };
   const createEmbeddingModel = (modelId, settings) => {
-    return new BuiltInAIEmbeddingModel(settings);
+    return new BrowserAIEmbeddingModel(settings);
   };
   const provider = function(modelId = "text", settings) {
     if (new.target) {
       throw new Error(
-        "The BuiltInAI model function cannot be called with the new keyword."
+        "The BrowserAI model function cannot be called with the new keyword."
       );
     }
     return createChatModel(modelId, settings);
   };
+  provider.specificationVersion = "v3";
   provider.languageModel = createChatModel;
   provider.chat = createChatModel;
-  provider.textEmbedding = createEmbeddingModel;
-  provider.textEmbeddingModel = createEmbeddingModel;
+  provider.embedding = createEmbeddingModel;
+  provider.embeddingModel = createEmbeddingModel;
   provider.imageModel = (modelId) => {
     throw new import_provider3.NoSuchModelError({ modelId, modelType: "imageModel" });
   };
@@ -1622,14 +1659,13 @@ function createBuiltInAI(options = {}) {
   };
   return provider;
 }
-var builtInAI = createBuiltInAI();
+var browserAI = createBrowserAI();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  BuiltInAIChatLanguageModel,
-  BuiltInAIEmbeddingModel,
-  builtInAI,
-  createBuiltInAI,
-  doesBrowserSupportBuiltInAI,
-  isBuiltInAIModelAvailable
+  BrowserAIChatLanguageModel,
+  BrowserAIEmbeddingModel,
+  browserAI,
+  createBrowserAI,
+  doesBrowserSupportBrowserAI
 });
 //# sourceMappingURL=index.js.map