@browser-ai/web-llm 2.0.4 → 2.1.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult } from '@ai-sdk/provider';
-import { AppConfig, InitProgressReport, MLCEngineConfig, MLCEngineInterface } from '@mlc-ai/web-llm';
+import { AppConfig, InitProgressReport, MLCEngineConfig } from '@mlc-ai/web-llm';
 export { InitProgressReport as WebLLMProgress, WebWorkerMLCEngineHandler } from '@mlc-ai/web-llm';
 import { UIMessage } from 'ai';
 
@@ -64,6 +64,12 @@ type Availability =
   | "downloading"
   | "available";
 
+/**
+ * Callback type for receiving model download/initialization progress updates.
+ * @param progress - A value between 0 and 1 indicating completion.
+ */
+type DownloadProgressCallback = (progress: number) => void;
+
 declare global {
     interface Navigator {
         gpu?: GPU;
@@ -134,18 +140,18 @@ declare class WebLLMLanguageModel implements LanguageModelV3 {
      *
      * @example
      * ```typescript
-     * const engine = await model.createSessionWithProgress(
+     * const model = await model.createSessionWithProgress(
      *   (progress) => {
-     *     console.log(`Download progress: ${Math.round(progress.loaded * 100)}%`);
+     *     console.log(`Download progress: ${Math.round(progress * 100)}%`);
      *   }
      * );
      * ```
      *
-     * @param onInitProgress Optional callback receiving progress reports during model download
-     * @returns Promise resolving to a configured WebLLM engine
+     * @param onDownloadProgress Optional callback receiving progress values from 0 to 1
+     * @returns Promise resolving to the model instance
      * @throws {LoadSettingError} When WebLLM is not available or model is unavailable
      */
-    createSessionWithProgress(onInitProgress?: (progress: InitProgressReport) => void): Promise<MLCEngineInterface>;
+    createSessionWithProgress(onDownloadProgress?: DownloadProgressCallback): Promise<WebLLMLanguageModel>;
     /**
      * Generates a streaming text response using WebLLM
      * @param options

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult } from '@ai-sdk/provider';
-import { AppConfig, InitProgressReport, MLCEngineConfig, MLCEngineInterface } from '@mlc-ai/web-llm';
+import { AppConfig, InitProgressReport, MLCEngineConfig } from '@mlc-ai/web-llm';
 export { InitProgressReport as WebLLMProgress, WebWorkerMLCEngineHandler } from '@mlc-ai/web-llm';
 import { UIMessage } from 'ai';
 
@@ -64,6 +64,12 @@ type Availability =
   | "downloading"
   | "available";
 
+/**
+ * Callback type for receiving model download/initialization progress updates.
+ * @param progress - A value between 0 and 1 indicating completion.
+ */
+type DownloadProgressCallback = (progress: number) => void;
+
 declare global {
     interface Navigator {
         gpu?: GPU;
@@ -134,18 +140,18 @@ declare class WebLLMLanguageModel implements LanguageModelV3 {
      *
      * @example
      * ```typescript
-     * const engine = await model.createSessionWithProgress(
+     * const model = await model.createSessionWithProgress(
      *   (progress) => {
-     *     console.log(`Download progress: ${Math.round(progress.loaded * 100)}%`);
+     *     console.log(`Download progress: ${Math.round(progress * 100)}%`);
      *   }
      * );
      * ```
      *
-     * @param onInitProgress Optional callback receiving progress reports during model download
-     * @returns Promise resolving to a configured WebLLM engine
+     * @param onDownloadProgress Optional callback receiving progress values from 0 to 1
+     * @returns Promise resolving to the model instance
      * @throws {LoadSettingError} When WebLLM is not available or model is unavailable
      */
-    createSessionWithProgress(onInitProgress?: (progress: InitProgressReport) => void): Promise<MLCEngineInterface>;
+    createSessionWithProgress(onDownloadProgress?: DownloadProgressCallback): Promise<WebLLMLanguageModel>;
     /**
      * Generates a streaming text response using WebLLM
      * @param options

package/dist/index.js

@@ -1372,19 +1372,23 @@ var WebLLMLanguageModel = class {
    *
    * @example
    * ```typescript
-   * const engine = await model.createSessionWithProgress(
+   * const model = await model.createSessionWithProgress(
    *   (progress) => {
-   *     console.log(`Download progress: ${Math.round(progress.loaded * 100)}%`);
+   *     console.log(`Download progress: ${Math.round(progress * 100)}%`);
    *   }
    * );
    * ```
    *
-   * @param onInitProgress Optional callback receiving progress reports during model download
-   * @returns Promise resolving to a configured WebLLM engine
+   * @param onDownloadProgress Optional callback receiving progress values from 0 to 1
+   * @returns Promise resolving to the model instance
    * @throws {LoadSettingError} When WebLLM is not available or model is unavailable
    */
-  async createSessionWithProgress(onInitProgress) {
-    return this.getEngine(void 0, onInitProgress);
+  async createSessionWithProgress(onDownloadProgress) {
+    const adaptedCallback = onDownloadProgress ? (report) => {
+      onDownloadProgress(report.progress);
+    } : void 0;
+    await this.getEngine(void 0, adaptedCallback);
+    return this;
   }
   /**
    * Generates a streaming text response using WebLLM