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

package/src/constants/tts/voices.ts

@@ -1,8 +1,8 @@
 import { KokoroVoiceExtras, VoiceConfig } from '../../types/tts';
-import { URL_PREFIX, NEXT_VERSION_TAG } from '../versions';
+import { URL_PREFIX, VERSION_TAG } from '../versions';
 
 // Kokoro voices - phonemizers
-const KOKORO_PHONEMIZER_PREFIX = `${URL_PREFIX}-kokoro/${NEXT_VERSION_TAG}/phonemizer`;
+const KOKORO_PHONEMIZER_PREFIX = `${URL_PREFIX}-kokoro/${VERSION_TAG}/phonemizer`;
 const KOKORO_PHONEMIZER_TAGGER_DATA = `${KOKORO_PHONEMIZER_PREFIX}/tags.json`;
 const KOKORO_PHONEMIZER_LEXICON_EN_US_DATA = `${KOKORO_PHONEMIZER_PREFIX}/us_merged.json`;
 const KOKORO_PHONEMIZER_LEXICON_EN_GB_DATA = `${KOKORO_PHONEMIZER_PREFIX}/gb_merged.json`;
@@ -17,42 +17,66 @@ const EN_GB_RESOURCES = {
 } as KokoroVoiceExtras;
 
 // Kokoro voices
-const KOKORO_VOICE_PREFIX = `${URL_PREFIX}-kokoro/${NEXT_VERSION_TAG}/voices`;
+const KOKORO_VOICE_PREFIX = `${URL_PREFIX}-kokoro/${VERSION_TAG}/voices`;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AF_HEART = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/af_heart.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AF_RIVER = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/af_river.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AF_SARAH = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/af_sarah.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AM_ADAM = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/am_adam.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AM_MICHAEL = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/am_michael.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_AM_SANTA = {
   lang: 'en-us' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/am_santa.bin`,
   extra: EN_US_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_BF_EMMA = {
   lang: 'en-gb' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/bf_emma.bin`,
   extra: EN_GB_RESOURCES,
 } as VoiceConfig;
+/**
+ * @category TTS Supported Voices
+ */
 export const KOKORO_VOICE_BM_DANIEL = {
   lang: 'en-gb' as const,
   voiceSource: `${KOKORO_VOICE_PREFIX}/bm_daniel.bin`,

package/src/constants/versions.ts

@@ -1,4 +1,4 @@
 export const URL_PREFIX =
   'https://huggingface.co/software-mansion/react-native-executorch';
-export const VERSION_TAG = 'resolve/v0.6.0';
-export const NEXT_VERSION_TAG = 'resolve/v0.7.0';
+export const VERSION_TAG = 'resolve/v0.7.0';
+export const NEXT_VERSION_TAG = 'resolve/v0.8.0';

package/src/controllers/LLMController.ts

@@ -203,6 +203,7 @@ export class LLMController {
         'You cannot delete the model now. You need ot interrupt it first.'
       );
     }
+
     this.onToken = () => {};
     if (this.nativeModule) {
       this.nativeModule.unload();
@@ -255,6 +256,20 @@ export class LLMController {
     return this.nativeModule.getGeneratedTokenCount();
   }
 
+  public getPromptTokenCount(): number {
+    if (!this.nativeModule) {
+      throw new RnExecutorchError(
+        RnExecutorchErrorCode.ModuleNotLoaded,
+        "Cannot get prompt token count for a model that's not loaded."
+      );
+    }
+    return this.nativeModule.getPromptTokenCount();
+  }
+
+  public getTotalTokenCount(): number {
+    return this.getGeneratedTokenCount() + this.getPromptTokenCount();
+  }
+
   public async generate(
     messages: Message[],
     tools?: LLMTool[]

package/src/errors/ErrorCodes.ts

@@ -102,22 +102,76 @@ export enum RnExecutorchErrorCode {
    * Thrown when required URI information is missing for a download operation.
    */
   ResourceFetcherMissingUri = 185,
+  /**
+   * Status indicating a successful operation.
+   */
   Ok = 0,
+  /**
+   * An internal error occurred.
+   */
   Internal = 1,
+  /**
+   * Status indicating the executor is in an invalid state for a targeted operation.
+   */
   InvalidState = 2,
+  /**
+   * Status indicating there are no more steps of execution to run
+   */
   EndOfMethod = 3,
+  /**
+   * Operation is not supported in the current context.
+   */
   NotSupported = 16,
+  /**
+   * Operation is not yet implemented.
+   */
   NotImplemented = 17,
+  /**
+   * User provided an invalid argument.
+   */
   InvalidArgument = 18,
+  /**
+   * Object is an invalid type for the operation.
+   */
   InvalidType = 19,
+  /**
+   * Operator(s) missing in the operator registry.
+   */
   OperatorMissing = 20,
+  /**
+   * Requested resource could not be found.
+   */
   NotFound = 32,
+  /**
+   * Could not allocate the requested memory.
+   */
   MemoryAllocationFailed = 33,
+  /**
+   * Could not access a resource.
+   */
   AccessFailed = 34,
+  /**
+   * Error caused by the contents of a program.
+   */
   InvalidProgram = 35,
+  /**
+   * Error caused by the contents of external data.
+   */
   InvalidExternalData = 36,
+  /**
+   * Does not have enough resources to perform the requested operation.
+   */
   OutOfResources = 37,
+  /**
+   * Init stage: Backend receives an incompatible delegate version.
+   */
   DelegateInvalidCompatibility = 48,
+  /**
+   * Init stage: Backend fails to allocate memory.
+   */
   DelegateMemoryAllocationFailed = 49,
+  /**
+   * Execute stage: The handle is invalid.
+   */
   DelegateInvalidHandle = 50,
 }

package/src/errors/errorUtils.ts

@@ -1,38 +1,58 @@
 import { RnExecutorchErrorCode } from './ErrorCodes';
 
-function isRnExecutorchError(
-  e: unknown
-): e is { code: number; message: string } {
-  return (
-    typeof e === 'object' &&
-    e !== null &&
-    'code' in e &&
-    'message' in e &&
-    typeof (e as RnExecutorchError).code === 'number' &&
-    typeof (e as RnExecutorchError).message === 'string'
-  );
-}
-
+/**
+ * Custom error class for React Native ExecuTorch errors.
+ */
 export class RnExecutorchError extends Error {
+  /**
+   * The error code representing the type of error.
+   */
   public code: RnExecutorchErrorCode;
+
+  /**
+   * The original cause of the error, if any.
+   */
   public cause?: unknown;
 
   constructor(code: number, message: string, cause?: unknown) {
     super(message);
+    /**
+     * The error code representing the type of error.
+     */
     this.code = code;
+
+    /**
+     * The message describing the error.
+     */
     this.message = message;
+
+    /**
+     * The original cause of the error, if any.
+     */
     this.cause = cause;
   }
 }
 
-export function parseUnknownError(e: unknown): RnExecutorchError {
-  if (isRnExecutorchError(e)) {
-    return new RnExecutorchError(e.code, e.message);
-  }
+function isRnExecutorchErrorLike(
+  e: unknown
+): e is { code: number; message: string } {
+  const candidate = e as Record<string, unknown>;
+
+  return (
+    typeof e === 'object' &&
+    e !== null &&
+    typeof candidate.code === 'number' &&
+    typeof candidate.message === 'string'
+  );
+}
 
+export function parseUnknownError(e: unknown): RnExecutorchError {
   if (e instanceof RnExecutorchError) {
     return e;
   }
+  if (isRnExecutorchErrorLike(e)) {
+    return new RnExecutorchError(e.code, e.message);
+  }
 
   if (e instanceof Error) {
     return new RnExecutorchError(RnExecutorchErrorCode.Internal, e.message, e);

package/src/hooks/computer_vision/useClassification.ts

@@ -1,13 +1,21 @@
-import { ResourceSource } from '../../types/common';
 import { useModule } from '../useModule';
 import { ClassificationModule } from '../../modules/computer_vision/ClassificationModule';
+import {
+  ClassificationProps,
+  ClassificationType,
+} from '../../types/classification';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useClassification = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing a Classification model instance.
+ *
+ * @category Hooks
+ * @param ClassificationProps - Configuration object containing `model` source and optional `preventLoad` flag.
+ * @returns Ready to use Classification model.
+ */
+export const useClassification = ({
+  model,
+  preventLoad = false,
+}: ClassificationProps): ClassificationType =>
   useModule({
     module: ClassificationModule,
     model,

package/src/hooks/computer_vision/useImageEmbeddings.ts

@@ -1,13 +1,21 @@
 import { ImageEmbeddingsModule } from '../../modules/computer_vision/ImageEmbeddingsModule';
-import { ResourceSource } from '../../types/common';
+import {
+  ImageEmbeddingsProps,
+  ImageEmbeddingsType,
+} from '../../types/imageEmbeddings';
 import { useModule } from '../useModule';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useImageEmbeddings = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing an Image Embeddings model instance.
+ *
+ * @category Hooks
+ * @param ImageEmbeddingsProps - Configuration object containing `model` source and optional `preventLoad` flag.
+ * @returns Ready to use Image Embeddings model.
+ */
+export const useImageEmbeddings = ({
+  model,
+  preventLoad = false,
+}: ImageEmbeddingsProps): ImageEmbeddingsType =>
   useModule({
     module: ImageEmbeddingsModule,
     model,

package/src/hooks/computer_vision/useImageSegmentation.ts

@@ -1,13 +1,21 @@
 import { useModule } from '../useModule';
 import { ImageSegmentationModule } from '../../modules/computer_vision/ImageSegmentationModule';
-import { ResourceSource } from '../../types/common';
+import {
+  ImageSegmentationProps,
+  ImageSegmentationType,
+} from '../../types/imageSegmentation';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useImageSegmentation = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing an Image Segmentation model instance.
+ *
+ * @category Hooks
+ * @param ImageSegmentationProps - Configuration object containing `model` source and optional `preventLoad` flag.
+ * @returns Ready to use Image Segmentation model.
+ */
+export const useImageSegmentation = ({
+  model,
+  preventLoad = false,
+}: ImageSegmentationProps): ImageSegmentationType =>
   useModule({
     module: ImageSegmentationModule,
     model,

package/src/hooks/computer_vision/useOCR.ts

@@ -1,28 +1,16 @@
 import { useEffect, useState } from 'react';
-import { ResourceSource } from '../../types/common';
-import { OCRDetection, OCRLanguage } from '../../types/ocr';
+import { OCRProps, OCRType } from '../../types/ocr';
 import { OCRController } from '../../controllers/OCRController';
 import { RnExecutorchError } from '../../errors/errorUtils';
 
-interface OCRModule {
-  error: RnExecutorchError | null;
-  isReady: boolean;
-  isGenerating: boolean;
-  forward: (imageSource: string) => Promise<OCRDetection[]>;
-  downloadProgress: number;
-}
-
-export const useOCR = ({
-  model,
-  preventLoad = false,
-}: {
-  model: {
-    detectorSource: ResourceSource;
-    recognizerSource: ResourceSource;
-    language: OCRLanguage;
-  };
-  preventLoad?: boolean;
-}): OCRModule => {
+/**
+ * React hook for managing an OCR instance.
+ *
+ * @category Hooks
+ * @param OCRProps - Configuration object containing `model` sources and optional `preventLoad` flag.
+ * @returns Ready to use OCR model.
+ */
+export const useOCR = ({ model, preventLoad = false }: OCRProps): OCRType => {
   const [error, setError] = useState<RnExecutorchError | null>(null);
   const [isReady, setIsReady] = useState(false);
   const [isGenerating, setIsGenerating] = useState(false);

package/src/hooks/computer_vision/useObjectDetection.ts

@@ -1,13 +1,21 @@
-import { ResourceSource } from '../../types/common';
 import { useModule } from '../useModule';
 import { ObjectDetectionModule } from '../../modules/computer_vision/ObjectDetectionModule';
+import {
+  ObjectDetectionProps,
+  ObjectDetectionType,
+} from '../../types/objectDetection';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useObjectDetection = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing an Object Detection model instance.
+ *
+ * @category Hooks
+ * @param ObjectDetectionProps - Configuration object containing `model` source and optional `preventLoad` flag.
+ * @returns Ready to use Object Detection model.
+ */
+export const useObjectDetection = ({
+  model,
+  preventLoad = false,
+}: ObjectDetectionProps): ObjectDetectionType =>
   useModule({
     module: ObjectDetectionModule,
     model,

package/src/hooks/computer_vision/useStyleTransfer.ts

@@ -1,13 +1,21 @@
-import { ResourceSource } from '../../types/common';
 import { useModule } from '../useModule';
 import { StyleTransferModule } from '../../modules/computer_vision/StyleTransferModule';
+import {
+  StyleTransferProps,
+  StyleTransferType,
+} from '../../types/styleTransfer';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useStyleTransfer = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing a Style Transfer model instance.
+ *
+ * @category Hooks
+ * @param StyleTransferProps - Configuration object containing `model` source and optional `preventLoad` flag.
+ * @returns Ready to use Style Transfer model.
+ */
+export const useStyleTransfer = ({
+  model,
+  preventLoad = false,
+}: StyleTransferProps): StyleTransferType =>
   useModule({
     module: StyleTransferModule,
     model,

package/src/hooks/computer_vision/useTextToImage.ts

@@ -1,38 +1,21 @@
 import { useCallback, useEffect, useState } from 'react';
 import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils';
 import { RnExecutorchErrorCode } from '../../errors/ErrorCodes';
-import { ResourceSource } from '../../types/common';
 import { TextToImageModule } from '../../modules/computer_vision/TextToImageModule';
+import { TextToImageProps, TextToImageType } from '../../types/tti';
 
-interface TextToImageType {
-  isReady: boolean;
-  isGenerating: boolean;
-  downloadProgress: number;
-  error: RnExecutorchError | null;
-  generate: (
-    input: string,
-    imageSize?: number,
-    numSteps?: number,
-    seed?: number
-  ) => Promise<string>;
-  interrupt: () => void;
-}
-
+/**
+ * React hook for managing a Text to Image instance.
+ *
+ * @category Hooks
+ * @param TextToImageProps - Configuration object containing `model` source, `inferenceCallback`, and optional `preventLoad` flag.
+ * @returns Ready to use Text to Image model.
+ */
 export const useTextToImage = ({
   model,
   inferenceCallback,
   preventLoad = false,
-}: {
-  model: {
-    tokenizerSource: ResourceSource;
-    schedulerSource: ResourceSource;
-    encoderSource: ResourceSource;
-    unetSource: ResourceSource;
-    decoderSource: ResourceSource;
-  };
-  inferenceCallback?: (stepIdx: number) => void;
-  preventLoad?: boolean;
-}): TextToImageType => {
+}: TextToImageProps): TextToImageType => {
   const [isReady, setIsReady] = useState(false);
   const [isGenerating, setIsGenerating] = useState(false);
   const [downloadProgress, setDownloadProgress] = useState(0);

package/src/hooks/computer_vision/useVerticalOCR.ts

@@ -1,30 +1,20 @@
 import { useEffect, useState } from 'react';
-import { ResourceSource } from '../../types/common';
-import { OCRDetection, OCRLanguage } from '../../types/ocr';
+import { OCRType, VerticalOCRProps } from '../../types/ocr';
 import { VerticalOCRController } from '../../controllers/VerticalOCRController';
 import { RnExecutorchError } from '../../errors/errorUtils';
 
-interface OCRModule {
-  error: RnExecutorchError | null;
-  isReady: boolean;
-  isGenerating: boolean;
-  forward: (imageSource: string) => Promise<OCRDetection[]>;
-  downloadProgress: number;
-}
-
+/**
+ * React hook for managing a Vertical OCR instance.
+ *
+ * @category Hooks
+ * @param VerticalOCRProps - Configuration object containing `model` sources, optional `independentCharacters` and `preventLoad` flag.
+ * @returns Ready to use Vertical OCR model.
+ */
 export const useVerticalOCR = ({
   model,
   independentCharacters = false,
   preventLoad = false,
-}: {
-  model: {
-    detectorSource: ResourceSource;
-    recognizerSource: ResourceSource;
-    language: OCRLanguage;
-  };
-  independentCharacters?: boolean;
-  preventLoad?: boolean;
-}): OCRModule => {
+}: VerticalOCRProps): OCRType => {
   const [error, setError] = useState<RnExecutorchError | null>(null);
   const [isReady, setIsReady] = useState(false);
   const [isGenerating, setIsGenerating] = useState(false);

package/src/hooks/general/useExecutorchModule.ts

@@ -1,16 +1,21 @@
 import { ExecutorchModule } from '../../modules/general/ExecutorchModule';
-import { ResourceSource } from '../../types/common';
+import {
+  ExecutorchModuleProps,
+  ExecutorchModuleType,
+} from '../../types/executorchModule';
 import { useModule } from '../useModule';
 
-interface Props {
-  modelSource: ResourceSource;
-  preventLoad?: boolean;
-}
-
+/**
+ * React hook for managing an arbitrary Executorch module instance.
+ *
+ * @category Hooks
+ * @param executorchModuleProps - Configuration object containing `modelSource` and optional `preventLoad` flag.
+ * @returns Ready to use Executorch module.
+ */
 export const useExecutorchModule = ({
   modelSource,
   preventLoad = false,
-}: Props) =>
+}: ExecutorchModuleProps): ExecutorchModuleType =>
   useModule({
     module: ExecutorchModule,
     model: modelSource,

package/src/hooks/natural_language_processing/useLLM.ts

@@ -1,30 +1,22 @@
 import { useCallback, useEffect, useState } from 'react';
-import { ResourceSource } from '../../types/common';
 import {
-  ChatConfig,
-  GenerationConfig,
+  LLMConfig,
+  LLMProps,
   LLMTool,
   LLMType,
   Message,
-  ToolsConfig,
 } from '../../types/llm';
 import { LLMController } from '../../controllers/LLMController';
 import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils';
 
-/*
-Hook version of LLMModule
-*/
-export const useLLM = ({
-  model,
-  preventLoad = false,
-}: {
-  model: {
-    modelSource: ResourceSource;
-    tokenizerSource: ResourceSource;
-    tokenizerConfigSource: ResourceSource;
-  };
-  preventLoad?: boolean;
-}): LLMType => {
+/**
+ * React hook for managing a Large Language Model (LLM) instance.
+ *
+ * @category Hooks
+ * @param model - Object containing model, tokenizer, and tokenizer config sources.
+ * @returns An object implementing the `LLMType` interface for interacting with the LLM.
+ */
+export const useLLM = ({ model, preventLoad = false }: LLMProps): LLMType => {
   const [token, setToken] = useState<string>('');
   const [response, setResponse] = useState<string>('');
   const [messageHistory, setMessageHistory] = useState<Message[]>([]);
@@ -59,7 +51,7 @@ export const useLLM = ({
         await controllerInstance.load({
           modelSource: model.modelSource,
           tokenizerSource: model.tokenizerSource,
-          tokenizerConfigSource: model.tokenizerConfigSource,
+          tokenizerConfigSource: model.tokenizerConfigSource!,
           onDownloadProgressCallback: setDownloadProgress,
         });
       } catch (e) {
@@ -82,15 +74,7 @@ export const useLLM = ({
 
   // memoization of returned functions
   const configure = useCallback(
-    ({
-      chatConfig,
-      toolsConfig,
-      generationConfig,
-    }: {
-      chatConfig?: Partial<ChatConfig>;
-      toolsConfig?: ToolsConfig;
-      generationConfig?: GenerationConfig;
-    }) =>
+    ({ chatConfig, toolsConfig, generationConfig }: LLMConfig) =>
       controllerInstance.configure({
         chatConfig,
         toolsConfig,
@@ -130,6 +114,16 @@ export const useLLM = ({
     [controllerInstance]
   );
 
+  const getPromptTokenCount = useCallback(
+    () => controllerInstance.getPromptTokenCount(),
+    [controllerInstance]
+  );
+
+  const getTotalTokenCount = useCallback(
+    () => controllerInstance.getTotalTokenCount(),
+    [controllerInstance]
+  );
+
   return {
     messageHistory,
     response,
@@ -139,6 +133,8 @@ export const useLLM = ({
     downloadProgress,
     error,
     getGeneratedTokenCount: getGeneratedTokenCount,
+    getPromptTokenCount: getPromptTokenCount,
+    getTotalTokenCount: getTotalTokenCount,
     configure: configure,
     generate: generate,
     sendMessage: sendMessage,