react-native-sherpa-onnx 0.3.7 → 0.3.8

package/src/download/background-downloader-types.ts

@@ -0,0 +1,73 @@
+/**
+ * Compile-time shim for @kesha-antonov/react-native-background-downloader.
+ *
+ * The package currently ships TS sources without distributable .d.ts files.
+ * We route TS path resolution to this shim so the SDK can typecheck strictly
+ * without checking third-party TS internals.
+ */
+
+export interface BackgroundDownloaderNotificationTexts {
+  downloadTitle?: string;
+  downloadStarting?: string;
+  downloadProgress?: string;
+  downloadPaused?: string;
+  downloadFinished?: string;
+  groupTitle?: string;
+  groupText?: string | ((count: number) => string);
+}
+
+export type BackgroundDownloaderSetConfigOptions = {
+  showNotificationsEnabled?: boolean;
+  notificationsGrouping?: {
+    enabled?: boolean;
+    mode?: 'individual' | 'summaryOnly';
+    texts?: BackgroundDownloaderNotificationTexts;
+  };
+  headers?: Record<string, string>;
+  progressInterval?: number;
+  progressMinBytes?: number;
+  isLogsEnabled?: boolean;
+  maxParallelDownloads?: number;
+  allowsCellularAccess?: boolean;
+};
+
+export interface DownloadTask {
+  id: string;
+  start(): void;
+  stop(): void;
+  pause(): Promise<void>;
+  resume(): Promise<void>;
+  begin(
+    cb: (data: {
+      expectedBytes?: number;
+      headers?: Record<string, string>;
+    }) => void
+  ): DownloadTask;
+  progress(
+    cb: (data: { bytesDownloaded: number; bytesTotal: number }) => void
+  ): DownloadTask;
+  done(
+    cb: (data: {
+      location?: string;
+      bytesDownloaded: number;
+      bytesTotal: number;
+    }) => void
+  ): DownloadTask;
+  error(
+    cb: (data: { error?: string; errorCode?: number }) => void
+  ): DownloadTask;
+}
+
+export declare function setConfig(
+  options: BackgroundDownloaderSetConfigOptions
+): void;
+
+export declare function createDownloadTask(options: {
+  id: string;
+  url: string;
+  destination: string;
+  metadata?: Record<string, unknown>;
+}): DownloadTask;
+
+export declare function completeHandler(taskId: string): void;
+export declare function getExistingDownloadTasks(): Promise<DownloadTask[]>;

package/src/download/downloadTask.ts

@@ -1,7 +1,10 @@
+import { Platform } from 'react-native';
+import type { BackgroundDownloaderSetConfigOptions } from './background-downloader-types';
 import {
   createDownloadTask,
   completeHandler,
   getExistingDownloadTasks,
+  setConfig,
 } from '@kesha-antonov/react-native-background-downloader';
 import {
   exists,
@@ -41,6 +44,68 @@ function makeDownloadTaskId(category: ModelCategory, id: string): string {
 
 const activeDownloadTasks = new Map<string, { stop: () => void }>();
 
+let androidDownloaderNotificationConfigApplied = false;
+let didWarnConfigFailure = false;
+
+function warnBackgroundDownloaderConfigFailure(
+  context: string,
+  error: unknown
+) {
+  if (didWarnConfigFailure) return;
+  didWarnConfigFailure = true;
+  const reason = error instanceof Error ? error.message : String(error);
+  console.warn(
+    `[Download] Background downloader config failed (${context}): ${reason}`
+  );
+}
+
+export type { BackgroundDownloaderSetConfigOptions };
+
+/**
+ * Apply your own `@kesha-antonov/react-native-background-downloader` `setConfig` **before** the first
+ * model download. When called, the SDK will **not** overwrite it with built-in defaults on first download.
+ *
+ * Safe to call at app startup (e.g. `App.tsx`). Other `setConfig` options (e.g. headers) are forwarded
+ * where the native module supports them on each platform.
+ */
+export function configureModelDownloadBackgroundDownloader(
+  options: BackgroundDownloaderSetConfigOptions
+): void {
+  try {
+    setConfig(options);
+    androidDownloaderNotificationConfigApplied = true;
+  } catch (error) {
+    // Keep fallback default config enabled if custom config fails.
+    warnBackgroundDownloaderConfigFailure('custom', error);
+  }
+}
+
+/**
+ * Library default is showNotificationsEnabled: false (silent empty FGS notification).
+ * Enable visible notifications unless the host app already called `configureModelDownloadBackgroundDownloader`.
+ */
+function ensureAndroidBackgroundDownloaderNotifications() {
+  if (androidDownloaderNotificationConfigApplied) return;
+  if (Platform.OS !== 'android') return;
+  try {
+    setConfig({
+      showNotificationsEnabled: true,
+      notificationsGrouping: {
+        enabled: false,
+        mode: 'individual',
+        texts: {
+          downloadTitle: 'Model download',
+          downloadStarting: 'Starting download…',
+          downloadProgress: 'Downloading… {progress}%',
+        },
+      },
+    });
+    androidDownloaderNotificationConfigApplied = true;
+  } catch (error) {
+    warnBackgroundDownloaderConfigFailure('default', error);
+  }
+}
+
 export async function downloadModelByCategory<T extends ModelMetaBase>(
   category: ModelCategory,
   id: string,
@@ -103,6 +168,8 @@ export async function downloadModelByCategory<T extends ModelMetaBase>(
     throw new Error(`Insufficient disk space: ${diskSpaceCheck.message}`);
   }
 
+  ensureAndroidBackgroundDownloaderNotifications();
+
   const statePath = getDownloadStatePath(category, id);
 
   if (opts?.overwrite) {
@@ -339,6 +406,7 @@ export async function resumeDownload<T extends ModelMetaBase>(
     deleteArchiveAfterExtract?: boolean;
   }
 ): Promise<DownloadResult> {
+  ensureAndroidBackgroundDownloaderNotifications();
   const taskId = makeDownloadTaskId(category, id);
   const existingTasks = await getExistingDownloadTasks();
   const existing = existingTasks.find((t) => t.id === taskId);

package/src/download/index.ts

@@ -30,8 +30,10 @@ export {
   ModelCategory,
   getProtectedModelKeysForBulkDelete,
   purgeDownloadedModelArtifacts,
+  configureModelDownloadBackgroundDownloader,
 } from './ModelDownloadManager';
 export type {
+  BackgroundDownloaderSetConfigOptions,
   ModelMetaBase,
   TtsModelMeta,
   TtsModelType,

package/src/download/registry.ts

@@ -96,6 +96,7 @@ function deriveType(id: string): TtsModelType {
   if (lower.includes('kitten')) return 'kitten';
   if (lower.includes('pocket')) return 'pocket';
   if (lower.includes('zipvoice')) return 'zipvoice';
+  if (lower.includes('supertonic')) return 'supertonic';
   return 'unknown';
 }
 

package/src/tts/index.ts

@@ -49,6 +49,8 @@ function flattenTtsModelOptionsForNative(
       ? modelOptions.kitten
       : modelType === 'pocket'
       ? modelOptions.pocket
+      : modelType === 'supertonic'
+      ? modelOptions.supertonic
       : undefined;
   if (!block)
     return {
@@ -446,6 +448,7 @@ export type {
   TtsKokoroModelOptions,
   TtsKittenModelOptions,
   TtsPocketModelOptions,
+  TtsSupertonicModelOptions,
   TtsUpdateOptions,
   TtsGenerationOptions,
   GeneratedAudio,

package/src/tts/streaming.ts

@@ -52,6 +52,8 @@ function flattenTtsModelOptionsForNative(
       ? modelOptions.kitten
       : modelType === 'pocket'
       ? modelOptions.pocket
+      : modelType === 'supertonic'
+      ? modelOptions.supertonic
       : undefined;
   if (!block)
     return {

package/src/tts/types.ts

@@ -9,6 +9,7 @@ import type { ModelPathConfig } from '../types';
  * - 'kitten': KittenTTS models (lightweight, multi-speaker)
  * - 'pocket': Pocket TTS models
  * - 'zipvoice': Zipvoice models (voice cloning capable)
+ * - 'supertonic': Supertonic models
  * - 'auto': Auto-detect model type based on files present (default)
  */
 export type TTSModelType =
@@ -18,6 +19,7 @@ export type TTSModelType =
   | 'kitten'
   | 'pocket'
   | 'zipvoice'
+  | 'supertonic'
   | 'auto';
 
 /** Runtime list of supported TTS model types. */
@@ -28,6 +30,7 @@ export const TTS_MODEL_TYPES: readonly TTSModelType[] = [
   'kitten',
   'pocket',
   'zipvoice',
+  'supertonic',
   'auto',
 ] as const;
 
@@ -68,6 +71,11 @@ export interface TtsPocketModelOptions {
   // No init-time options in Kotlin OfflineTtsPocketModelConfig; voice cloning is via GenerationConfig at generate time.
 }
 
+/** Options for Supertonic models. Applied only when modelType is 'supertonic'. */
+export interface TtsSupertonicModelOptions {
+  // No init-time model options exposed by sherpa-onnx currently.
+}
+
 /**
  * Model-specific TTS options. Only the block for the actually loaded model type is applied;
  * others are ignored (e.g. vits options have no effect when a kokoro model is loaded).
@@ -78,6 +86,7 @@ export interface TtsModelOptions {
   kokoro?: TtsKokoroModelOptions;
   kitten?: TtsKittenModelOptions;
   pocket?: TtsPocketModelOptions;
+  supertonic?: TtsSupertonicModelOptions;
 }
 
 /**

package/lib/module/download/background-downloader.d.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=background-downloader.d.js.map

package/lib/module/download/background-downloader.d.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sourceRoot":"../../../src","sources":["download/background-downloader.d.ts"],"mappings":"","ignoreList":[]}

package/src/download/background-downloader.d.ts

@@ -1,43 +0,0 @@
-/**
- * Type declarations for @kesha-antonov/react-native-background-downloader
- * when the package is not installed (e.g. SDK build). The real package provides full types.
- */
-declare module '@kesha-antonov/react-native-background-downloader' {
-  export interface DownloadTask {
-    id: string;
-    start(): void;
-    stop(): void;
-    pause(): Promise<void>;
-    resume(): Promise<void>;
-    begin(
-      cb: (data: {
-        expectedBytes?: number;
-        headers?: Record<string, string>;
-      }) => void
-    ): DownloadTask;
-    progress(
-      cb: (data: { bytesDownloaded: number; bytesTotal: number }) => void
-    ): DownloadTask;
-    done(
-      cb: (data: {
-        location?: string;
-        bytesDownloaded: number;
-        bytesTotal: number;
-      }) => void
-    ): DownloadTask;
-    error(
-      cb: (data: { error?: string; errorCode?: number }) => void
-    ): DownloadTask;
-  }
-
-  export function createDownloadTask(options: {
-    id: string;
-    url: string;
-    destination: string;
-    metadata?: Record<string, unknown>;
-  }): DownloadTask;
-
-  export function completeHandler(taskId: string): void;
-
-  export function getExistingDownloadTasks(): Promise<DownloadTask[]>;
-}