react-native-executorch 0.7.0-nightly-b4770df-20260205 → 0.7.0

package/src/types/vad.ts

@@ -1,4 +1,62 @@
+import { ResourceSource } from '../types/common';
+import { RnExecutorchError } from '../errors/errorUtils';
+
+/**
+ * Props for the useVAD hook.
+ *
+ * @category Types
+ * @property {Object} model - An object containing the model source.
+ * @property {ResourceSource} model.modelSource - The source of the VAD model binary.
+ * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
+ */
+export interface VADProps {
+  model: { modelSource: ResourceSource };
+  preventLoad?: boolean;
+}
+
+/**
+ * Represents a detected audio segment with start and end timestamps.
+ *
+ * @category Types
+ * @property {number} start - Start time of the segment in seconds.
+ * @property {number} end - End time of the segment in seconds.
+ */
 export interface Segment {
   start: number;
   end: number;
 }
+
+/**
+ * React hook state and methods for managing a Voice Activity Detection (VAD) model instance.
+ *
+ * @category Types
+ */
+export interface VADType {
+  /**
+   * Contains the error message if the VAD model failed to load or during processing.
+   */
+  error: null | RnExecutorchError;
+
+  /**
+   * Indicates whether the VAD model has successfully loaded and is ready for inference.
+   */
+  isReady: boolean;
+
+  /**
+   * Indicates whether the model is currently processing an inference.
+   */
+  isGenerating: boolean;
+
+  /**
+   * Represents the download progress as a value between 0 and 1.
+   */
+  downloadProgress: number;
+
+  /**
+   * Runs the Voice Activity Detection model on the provided audio waveform.
+   * @param waveform - The input audio waveform array.
+   * @returns A promise resolving to an array of detected audio segments (e.g., timestamps for speech).
+   * @throws {RnExecutorchError} If the model is not loaded or is currently processing another request.
+   */
+  forward(waveform: Float32Array): Promise<Segment[]>;
+}

package/src/utils/ResourceFetcher.ts

@@ -54,9 +54,23 @@ import {
 import { RnExecutorchErrorCode } from '../errors/ErrorCodes';
 import { RnExecutorchError } from '../errors/errorUtils';
 
+/**
+ * This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory.
+ * These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed.
+ *
+ * @category Utilities - General
+ */
 export class ResourceFetcher {
   static downloads = new Map<ResourceSource, DownloadResource>(); //map of currently downloading (or paused) files, if the download was started by .fetch() method.
 
+  /**
+   * Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch.
+   *
+   * @param callback - Optional callback to track progress of all downloads, reported between 0 and 1.
+   * @param sources - Multiple resources that can be strings, asset references, or objects.
+   * @returns If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix).
+   * If the fetch was interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`.
+   */
   static async fetch(
     callback: (downloadProgress: number) => void = () => {},
     ...sources: ResourceSource[]
@@ -238,16 +252,35 @@ export class ResourceFetcher {
     this.downloads.delete(source);
   }
 
+  /**
+   * Pauses an ongoing download of files.
+   *
+   * @param sources - The resource identifiers used when calling `fetch`.
+   * @returns A promise that resolves once the download is paused.
+   */
   static async pauseFetching(...sources: ResourceSource[]) {
     const source = this.findActive(sources);
     await this.pause(source);
   }
 
+  /**
+   * Resumes a paused download of files.
+   *
+   * @param sources - The resource identifiers used when calling fetch.
+   * @returns If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded resources (without file:// prefix).
+   * If the fetch was again interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`.
+   */
   static async resumeFetching(...sources: ResourceSource[]) {
     const source = this.findActive(sources);
     await this.resume(source);
   }
 
+  /**
+   * Cancels an ongoing/paused download of files.
+   *
+   * @param sources - The resource identifiers used when calling `fetch()`.
+   * @returns A promise that resolves once the download is canceled.
+   */
   static async cancelFetching(...sources: ResourceSource[]) {
     const source = this.findActive(sources);
     await this.cancel(source);
@@ -265,16 +298,32 @@ export class ResourceFetcher {
     );
   }
 
+  /**
+   * Lists all the downloaded files used by React Native ExecuTorch.
+   *
+   * @returns A promise, which resolves to an array of URIs for all the downloaded files.
+   */
   static async listDownloadedFiles() {
     const files = await readDirectoryAsync(RNEDirectory);
     return files.map((file) => `${RNEDirectory}${file}`);
   }
 
+  /**
+   * Lists all the downloaded models used by React Native ExecuTorch.
+   *
+   * @returns A promise, which resolves to an array of URIs for all the downloaded models.
+   */
   static async listDownloadedModels() {
     const files = await this.listDownloadedFiles();
     return files.filter((file) => file.endsWith('.pte'));
   }
 
+  /**
+   * Deletes downloaded resources from the local filesystem.
+   *
+   * @param sources - The resource identifiers used when calling `fetch`.
+   * @returns A promise that resolves once all specified resources have been removed.
+   */
   static async deleteResources(...sources: ResourceSource[]) {
     for (const source of sources) {
       const filename = ResourceFetcherUtils.getFilenameFromUri(
@@ -287,6 +336,12 @@ export class ResourceFetcher {
     }
   }
 
+  /**
+   * Fetches the info about files size. Works only for remote files.
+   *
+   * @param sources - The resource identifiers (URLs).
+   * @returns A promise that resolves to combined size of files in bytes.
+   */
   static async getFilesTotalSize(...sources: ResourceSource[]) {
     return (await ResourceFetcherUtils.getFilesSizes(sources)).totalLength;
   }

package/src/utils/llm.ts

@@ -6,6 +6,13 @@ import { DEFAULT_STRUCTURED_OUTPUT_PROMPT } from '../constants/llmDefaults';
 import * as zCore from 'zod/v4/core';
 import { Logger } from '../common/Logger';
 
+/**
+ * Parses tool calls from a given message string.
+ *
+ * @category Utilities - LLM
+ * @param message - The message string containing tool calls in JSON format.
+ * @returns An array of `ToolCall` objects extracted from the message.
+ */
 export const parseToolCall: (message: string) => ToolCall[] = (
   message: string
 ) => {
@@ -47,6 +54,13 @@ const filterObjectKeys = (obj: object, keysToRemove: string[]) => {
   return Object.fromEntries(filteredEntries);
 };
 
+/**
+ * Generates a structured output prompt based on the provided schema.
+ *
+ * @category Utilities - LLM
+ * @param responseSchema - The schema (Zod or JSON Schema) defining the desired output format.
+ * @returns A prompt string instructing the model to format its output according to the given schema.
+ */
 export const getStructuredOutputPrompt = <T extends zCore.$ZodType>(
   responseSchema: T | Schema
 ) => {
@@ -77,7 +91,14 @@ const extractBetweenBrackets = (text: string): string => {
   );
 };
 
-// this is a bit hacky typing
+/**
+ * Fixes and validates structured output from LLMs against a provided schema.
+ *
+ * @category Utilities - LLM
+ * @param output - The raw output string from the LLM.
+ * @param responseSchema - The schema (Zod or JSON Schema) to validate the output against.
+ * @returns The validated and parsed output.
+ */
 export const fixAndValidateStructuredOutput = <T extends zCore.$ZodType>(
   output: string,
   responseSchema: T | Schema