@browser-ai/core 2.1.5 → 2.1.6

package/dist/index.d.mts

@@ -18,7 +18,13 @@ interface BrowserAIChatSettings extends LanguageModelCreateOptions {
         languages?: string[];
     }>;
     /**
-     * Callback invoked when the model quota is exceeded.
+     * Callback invoked when the model context window is exceeded.
+     * Replaces the deprecated `onQuotaOverflow`.
+     * @see [Prompt API Context Overflow](https://github.com/webmachinelearning/prompt-api?tab=readme-ov-file#tokenization-context-window-length-limits-and-overflow)
+     */
+    onContextOverflow?: (event: Event) => void;
+    /**
+     * @deprecated Use `onContextOverflow` instead.
      * @see [Prompt API Quota Overflow](https://github.com/webmachinelearning/prompt-api?tab=readme-ov-file#tokenization-context-window-length-limits-and-overflow)
      * @param event
      */
@@ -53,13 +59,21 @@ declare class BrowserAIChatLanguageModel implements LanguageModelV3 {
      */
     doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
     /**
-     * Gets the input usage for the current session, if available
-     * @returns The input usage or undefined if not available
+     * Gets the current context usage (tokens consumed) for the current session, if available
+     * @returns The context usage or undefined if not available
+     */
+    getContextUsage(): number | undefined;
+    /**
+     * Gets the context window size (token limit) for the current session, if available
+     * @returns The context window size or undefined if not available
+     */
+    getContextWindow(): number | undefined;
+    /**
+     * @deprecated Use {@link getContextUsage} instead.
      */
     getInputUsage(): number | undefined;
     /**
-     * Gets the input quota for the current session, if available
-     * @returns The input quota or undefined if not available
+     * @deprecated Use {@link getContextWindow} instead.
      */
     getInputQuota(): number | undefined;
     /**

package/dist/index.d.ts

@@ -18,7 +18,13 @@ interface BrowserAIChatSettings extends LanguageModelCreateOptions {
         languages?: string[];
     }>;
     /**
-     * Callback invoked when the model quota is exceeded.
+     * Callback invoked when the model context window is exceeded.
+     * Replaces the deprecated `onQuotaOverflow`.
+     * @see [Prompt API Context Overflow](https://github.com/webmachinelearning/prompt-api?tab=readme-ov-file#tokenization-context-window-length-limits-and-overflow)
+     */
+    onContextOverflow?: (event: Event) => void;
+    /**
+     * @deprecated Use `onContextOverflow` instead.
      * @see [Prompt API Quota Overflow](https://github.com/webmachinelearning/prompt-api?tab=readme-ov-file#tokenization-context-window-length-limits-and-overflow)
      * @param event
      */
@@ -53,13 +59,21 @@ declare class BrowserAIChatLanguageModel implements LanguageModelV3 {
      */
     doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
     /**
-     * Gets the input usage for the current session, if available
-     * @returns The input usage or undefined if not available
+     * Gets the current context usage (tokens consumed) for the current session, if available
+     * @returns The context usage or undefined if not available
+     */
+    getContextUsage(): number | undefined;
+    /**
+     * Gets the context window size (token limit) for the current session, if available
+     * @returns The context window size or undefined if not available
+     */
+    getContextWindow(): number | undefined;
+    /**
+     * @deprecated Use {@link getContextUsage} instead.
      */
     getInputUsage(): number | undefined;
     /**
-     * Gets the input quota for the current session, if available
-     * @returns The input quota or undefined if not available
+     * @deprecated Use {@link getContextWindow} instead.
      */
     getInputQuota(): number | undefined;
     /**

package/dist/index.js

@@ -1084,15 +1084,17 @@ 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);
+    const onOverflow = options?.onContextOverflow || this.baseOptions.onContextOverflow || options?.onQuotaOverflow || this.baseOptions.onQuotaOverflow;
+    const overflowHandler = onOverflow ?? (() => {
+      console.warn(
+        "Model context window exceeded. Consider handling the 'contextoverflow' event."
+      );
+    });
+    const session = this.session;
+    if ("oncontextoverflow" in session) {
+      session.addEventListener("contextoverflow", overflowHandler);
     } else {
-      this.session.addEventListener("quotaoverflow", () => {
-        console.warn(
-          "Model quota exceeded. Consider handling 'quotaoverflow' event."
-        );
-      });
+      session.addEventListener("quotaoverflow", overflowHandler);
     }
     return this.session;
   }
@@ -1161,18 +1163,34 @@ var SessionManager = class {
     this.session = null;
   }
   /**
-   * Gets the input quota for the current session, if available
-   * @returns The input quota or undefined if not available
+   * Gets the context window size (token limit) for the current session, if available.
+   * @returns The context window size or undefined if not available
+   */
+  getContextWindow() {
+    const session = this.getCurrentSession();
+    if (!session) return void 0;
+    return session.contextWindow ?? session.inputQuota;
+  }
+  /**
+   * Gets the current context usage (tokens consumed) for the current session, if available.
+   * @returns The context usage or undefined if not available
+   */
+  getContextUsage() {
+    const session = this.getCurrentSession();
+    if (!session) return void 0;
+    return session.contextUsage ?? session.inputUsage;
+  }
+  /**
+   * @deprecated Use {@link getContextWindow} instead.
    */
   getInputQuota() {
-    return this.getCurrentSession()?.inputQuota;
+    return this.getContextWindow();
   }
   /**
-   * Gets the input usage for the current session, if available
-   * @returns The input usage or undefined if not available
+   * @deprecated Use {@link getContextUsage} instead.
    */
   getInputUsage() {
-    return this.getCurrentSession()?.inputUsage;
+    return this.getContextUsage();
   }
   /**
    * Prepares merged session options from base config and request options
@@ -1188,7 +1206,8 @@ var SessionManager = class {
         systemMessage,
         expectedInputs,
         onDownloadProgress,
-        onQuotaOverflow,
+        onContextOverflow: _onContextOverflow,
+        onQuotaOverflow: _onQuotaOverflow,
         ...createOptions
       } = options;
       Object.assign(mergedOptions, createOptions);
@@ -1402,18 +1421,30 @@ var BrowserAIChatLanguageModel = class {
     };
   }
   /**
-   * Gets the input usage for the current session, if available
-   * @returns The input usage or undefined if not available
+   * Gets the current context usage (tokens consumed) for the current session, if available
+   * @returns The context usage or undefined if not available
+   */
+  getContextUsage() {
+    return this.sessionManager.getContextUsage();
+  }
+  /**
+   * Gets the context window size (token limit) for the current session, if available
+   * @returns The context window size or undefined if not available
+   */
+  getContextWindow() {
+    return this.sessionManager.getContextWindow();
+  }
+  /**
+   * @deprecated Use {@link getContextUsage} instead.
    */
   getInputUsage() {
-    return this.sessionManager.getInputUsage();
+    return this.getContextUsage();
   }
   /**
-   * Gets the input quota for the current session, if available
-   * @returns The input quota or undefined if not available
+   * @deprecated Use {@link getContextWindow} instead.
    */
   getInputQuota() {
-    return this.sessionManager.getInputQuota();
+    return this.getContextWindow();
   }
   /**
    * Check the availability of the browser AI model
@@ -1522,7 +1553,7 @@ var BrowserAIChatLanguageModel = class {
             finishReason,
             usage: {
               inputTokens: {
-                total: session.inputUsage,
+                total: session.contextUsage ?? session.inputUsage,
                 noCache: void 0,
                 cacheRead: void 0,
                 cacheWrite: void 0