@gmessier/nitro-speech 0.1.0 → 0.1.2

package/README.md

@@ -4,11 +4,30 @@
 [![license](https://img.shields.io/npm/l/@gmessier/nitro-speech.svg)](https://github.com/NotGeorgeMessier/nitro-speech/blob/main/LICENSE)
 [![npm downloads](https://img.shields.io/npm/dm/@gmessier/nitro-speech.svg)](https://www.npmjs.com/package/@gmessier/nitro-speech)
 
-> **⚠️ Work in Progress**
-> 
-> This library is under active development. (Last version is stable)
-
-Speech recognition for React Native, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
+ 
+> If you hit an issue, please open a GitHub issue or reach out to me on Discord / Twitter (X) — response is guaranteed.
+>
+> - GitHub Issues: [NotGeorgeMessier/nitro-speech/issues](https://github.com/NotGeorgeMessier/nitro-speech/issues)
+> - Discord: `gmessier`
+> - Twitter (X): `SufferingGeorge`
+
+React Native Real-Time Speech Recognition Library, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
+
+#### Key Features:
+
+- Built on Nitro Modules for low-overhead native bridging
+- Configurable Timer for silence (default: 8 sec)
+  - Callback `onAutoFinishProgress` for progress bars, etc...
+  - Method `addAutoFinishTime` for single timer update
+  - Method `updateAutoFinishTime` for constant timer update
+- Optional Haptic Feedback on start and finish
+- Speech-quality configurations:
+  - Result is grouped by speech segments into Batches.
+  - Param `disableRepeatingFilter` for consecutive duplicate-word filtering.
+  - Param `androidDisableBatchHandling` for removing empty recognition result.
+- Embedded Permission handling
+  - Callback `onPermissionDenied` - if user denied the request
+- Everything else that could be found in Expo or other libraries
 
 ## Table of Contents
 
@@ -17,7 +36,9 @@ Speech recognition for React Native, powered by [Nitro Modules](https://github.c
 - [Features](#features)
 - [Usage](#usage)
   - [Recommended: useRecognizer Hook](#recommended-userecognizer-hook)
-  - [Alternative: Static Recognizer](#alternative-static-recognizer-not-safe)
+  - [With React Navigation (important)](#with-react-navigation-important)
+  - [Cross-component control: RecognizerRef](#cross-component-control-recognizerref)
+  - [Unsafe: RecognizerSession](#unsafe-recognizersession)
 - [API Reference](#api-reference)
 - [Requirements](#requirements)
 - [Troubleshooting](#troubleshooting)
@@ -60,6 +81,7 @@ The library declares the required permission in its `AndroidManifest.xml` (merge
 
 ```xml
 <uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.VIBRATE" />
 ```
 
 ### iOS
@@ -81,12 +103,13 @@ Both permissions are required for speech recognition to work on iOS.
 |---------|-------------|-----|---------|
 | **Real-time transcription** | Get partial results as the user speaks, enabling live UI updates | ✅ | ✅ |
 | **Auto-stop on silence** | Automatically stops recognition after configurable inactivity period (default: 8s) | ✅ | ✅ |
-| **Auto-finish progress** | Progress callbacks showing countdown until auto-stop | ✅ | ❌ *(TODO)* |
-| **Locale support** | Configure speech recognizer for different languages | ✅ | ✅ |
+| **Auto-finish progress** | Progress callbacks showing countdown until auto-stop | ✅ | *(TODO)* |
+| **Haptic feedback** | Optional haptics on recording start/stop | ✅ | ✅ |
 | **Background handling** | Auto-stop when app loses focus/goes to background | ✅ | Not Safe *(TODO)* |
-| **Contextual strings** | Domain-specific vocabulary for improved accuracy | ✅ | ✅ |
-| **Repeating word filter** | Removes consecutive duplicate words from artifacts | ✅ | ✅ |
 | **Permission handling** | Dedicated `onPermissionDenied` callback | ✅ | ✅ |
+| **Repeating word filter** | Removes consecutive duplicate words from artifacts | ✅ | ✅ |
+| **Locale support** | Configure speech recognizer for different languages | ✅ | ✅ |
+| **Contextual strings** | Domain-specific vocabulary for improved accuracy | ✅ | ✅ |
 | **Automatic punctuation** | Adds punctuation to transcription (iOS 16+) | ✅ | Auto |
 | **Language model selection** | Choose between web search vs free-form models | Auto | ✅ |
 | **Offensive word masking** | Control whether offensive words are masked | Auto | ✅ |
@@ -96,6 +119,9 @@ Both permissions are required for speech recognition to work on iOS.
 
 ### Recommended: useRecognizer Hook
 
+`useRecognizer` is lifecycle-aware. It calls `stopListening()` during cleanup (unmount or `destroyDeps` change).  
+Because of that, treat it as a **single session owner** setup hook: use it once per recognition session/screen, where you define callbacks.
+
 ```typescript
 import { useRecognizer } from '@gmessier/nitro-speech';
 
@@ -130,14 +156,20 @@ function MyComponent() {
     <View>
       <TouchableOpacity onPress={() => startListening({ 
         locale: 'en-US',
+        disableRepeatingFilter: false,
         autoFinishRecognitionMs: 8000,
+        
         contextualStrings: ['custom', 'words'],
+        // Haptics (both platforms)
+        startHapticFeedbackStyle: 'medium',
+        stopHapticFeedbackStyle: 'light',
         // iOS specific
         iosAddPunctuation: true,
         // Android specific
         androidMaskOffensiveWords: false,
         androidFormattingPreferQuality: false,
         androidUseWebSearchModel: false,
+        androidDisableBatchHandling: false,
       })}>
         <Text>Start Listening</Text>
       </TouchableOpacity>
@@ -155,64 +187,106 @@ function MyComponent() {
 }
 ```
 
-### Alternative: Static Recognizer (Not Safe)
+Use the handlers returned by this single hook instance inside that owner component.  
+For other components, avoid creating another `useRecognizer` instance for the same session.
+
+### With React Navigation (important)
+
+React Navigation **doesn’t unmount screens** when you navigate — the screen can stay mounted in the background and come back without remounting. See: [Navigation lifecycle (React Navigation)](https://reactnavigation.org/docs/8.x/navigation-lifecycle/#summary).
+
+Because of that, prefer tying recognition cleanup to **focus state**, not just component unmount. A simple approach is `useIsFocused()` and passing it into `useRecognizer`’s `destroyDeps` so recognition stops when the screen blurs. See: `[useIsFocused` (React Navigation)](https://reactnavigation.org/docs/8.x/use-is-focused).
+
+```typescript
+const isFocused = useIsFocused();
+const { 
+  // ...
+} = useRecognizer(
+  {
+    // ...
+  },
+  [isFocused]
+);
+```
+
+### Cross-component control: RecognizerRef
+
+If you need to call recognizer methods from other components without prop drilling, use `RecognizerRef`.
+
+```typescript
+import { RecognizerRef } from '@gmessier/nitro-speech';
+
+RecognizerRef.startListening({ locale: 'en-US' });
+RecognizerRef.addAutoFinishTime(5000);
+RecognizerRef.updateAutoFinishTime(10000, true);
+RecognizerRef.stopListening();
+```
+
+`RecognizerRef` exposes only method handlers and is safe for cross-component method access.
+
+### Unsafe: RecognizerSession
+
+`RecognizerSession` is the hybrid object. It gives direct access to callbacks and control methods, but it is unsafe to orchestrate the full session directly from it.
 
 ```typescript
-import { Recognizer } from '@gmessier/nitro-speech';
+import { RecognizerSession } from '@gmessier/nitro-speech';
 
 // Set up callbacks
-Recognizer.onReadyForSpeech = () => {
+RecognizerSession.onReadyForSpeech = () => {
   console.log('Listening...');
 };
 
-Recognizer.onResult = (textBatches) => {
+RecognizerSession.onResult = (textBatches) => {
   console.log('Result:', textBatches.join('\n'));
 };
 
-Recognizer.onRecordingStopped = () => {
+RecognizerSession.onRecordingStopped = () => {
   console.log('Stopped');
 };
 
-Recognizer.onAutoFinishProgress = (timeLeftMs) => {
+RecognizerSession.onAutoFinishProgress = (timeLeftMs) => {
   console.log('Auto-stop in:', timeLeftMs, 'ms');
 };
 
-Recognizer.onError = (error) => {
+RecognizerSession.onError = (error) => {
   console.log('Error:', error);
 };
 
-Recognizer.onPermissionDenied = () => {
+RecognizerSession.onPermissionDenied = () => {
   console.log('Permission denied');
 };
 
 // Start listening
-Recognizer.startListening({
+RecognizerSession.startListening({
   locale: 'en-US',
 });
 
 // Stop listening
-Recognizer.stopListening();
+RecognizerSession.stopListening();
 
 // Manually add time to auto finish timer
-Recognizer.addAutoFinishTime(5000); // Add 5 seconds
-Recognizer.addAutoFinishTime(); // Reset to original time
+RecognizerSession.addAutoFinishTime(5000); // Add 5 seconds
+RecognizerSession.addAutoFinishTime(); // Reset to original time
 
 // Update auto finish time
-Recognizer.updateAutoFinishTime(10000); // Set to 10 seconds
-Recognizer.updateAutoFinishTime(10000, true); // Set to 10 seconds and refresh progress
+RecognizerSession.updateAutoFinishTime(10000); // Set to 10 seconds
+RecognizerSession.updateAutoFinishTime(10000, true); // Set to 10 seconds and refresh progress
 ```
 
 ### ⚠️ About dispose()
 
-The `Recognizer.dispose()` method is **NOT SAFE** and should rarely be used. Hybrid Objects in Nitro are typically managed by the JS garbage collector automatically. Only call `dispose()` in performance-critical scenarios where you need to eagerly destroy objects.
+The `RecognizerSession.dispose()` method is **NOT SAFE** and should rarely be used. Hybrid Objects in Nitro are typically managed by the JS garbage collector automatically. Only call `dispose()` in performance-critical scenarios where you need to eagerly destroy objects.
 
 **See:** [Nitro dispose() documentation](https://nitro.margelo.com/docs/hybrid-objects#dispose)
 
 ## API Reference
 
-### `useRecognizer(callbacks)`
+### `useRecognizer(callbacks, destroyDeps?)`
 
-A React hook that provides lifecycle-aware access to the speech recognizer.
+#### Usage notes
+
+- Use `useRecognizer` once per session/screen as the session setup owner.
+- Cleanup stops recognition, so mounting multiple instances can unexpectedly end an active session.
+- For method access in non-owner components, use `RecognizerRef`.
 
 #### Parameters
 
@@ -223,6 +297,7 @@ A React hook that provides lifecycle-aware access to the speech recognizer.
   - `onAutoFinishProgress?: (timeLeftMs: number) => void` - Called each second during auto-finish countdown
   - `onError?: (message: string) => void` - Called when an error occurs
   - `onPermissionDenied?: () => void` - Called if microphone permission is denied
+- `destroyDeps` (array, optional) - Additional dependencies for the cleanup effect. When any of these change (or the component unmounts), recognition is stopped.
 
 #### Returns
 
@@ -231,6 +306,18 @@ A React hook that provides lifecycle-aware access to the speech recognizer.
 - `addAutoFinishTime(additionalTimeMs?: number)` - Add time to the auto-finish timer (or reset to original if no parameter)
 - `updateAutoFinishTime(newTimeMs: number, withRefresh?: boolean)` - Update the auto-finish timer
 
+### `RecognizerRef`
+
+- `startListening(params: SpeechToTextParams)`
+- `stopListening()`
+- `addAutoFinishTime(additionalTimeMs?: number)`
+- `updateAutoFinishTime(newTimeMs: number, withRefresh?: boolean)`
+
+### `RecognizerSession`
+
+- Exposes callbacks (`onReadyForSpeech`, `onResult`, etc.) and control methods.
+- Prefer `useRecognizer` (single owner) + `RecognizerRef` for app-level usage.
+
 ### `SpeechToTextParams`
 
 Configuration object for speech recognition.
@@ -241,6 +328,8 @@ Configuration object for speech recognition.
 - `autoFinishRecognitionMs?: number` - Auto-stop timeout in milliseconds (default: `8000`)
 - `contextualStrings?: string[]` - Array of domain-specific words for better recognition
 - `disableRepeatingFilter?: boolean` - Disable filter that removes consecutive duplicate words (default: `false`)
+- `startHapticFeedbackStyle?: 'light' | 'medium' | 'heavy'` - Haptic feedback style when microphone starts recording (default: `null` / disabled)
+- `stopHapticFeedbackStyle?: 'light' | 'medium' | 'heavy'` - Haptic feedback style when microphone stops recording (default: `null` / disabled)
 
 #### iOS-Specific Parameters
 

package/android/src/main/AndroidManifest.xml

@@ -1,3 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
   <uses-permission android:name="android.permission.RECORD_AUDIO" />
+  <uses-permission android:name="android.permission.VIBRATE" />
 </manifest>

package/android/src/main/java/com/margelo/nitro/nitrospeech/recognizer/HapticImpact.kt

@@ -0,0 +1,66 @@
+package com.margelo.nitro.nitrospeech.recognizer
+
+import android.content.Context
+import android.os.Build
+import android.os.VibrationEffect
+import android.os.Vibrator
+import android.os.VibratorManager
+import com.margelo.nitro.nitrospeech.HapticFeedbackStyle
+
+class HapticImpact(
+  private val style: HapticFeedbackStyle = HapticFeedbackStyle.MEDIUM,
+) {
+  private data class LegacyOneShot(
+    val durationMs: Long,
+    val amplitude: Int,
+  )
+
+  fun trigger(context: Context) {
+    val vibrator = getVibrator(context) ?: return
+    if (!vibrator.hasVibrator()) return
+
+    try {
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+        val effect = when (style) {
+          HapticFeedbackStyle.LIGHT -> VibrationEffect.EFFECT_TICK
+          HapticFeedbackStyle.MEDIUM -> VibrationEffect.EFFECT_CLICK
+          HapticFeedbackStyle.HEAVY -> VibrationEffect.EFFECT_HEAVY_CLICK
+        }
+        vibrator.vibrate(VibrationEffect.createPredefined(effect))
+        return
+      }
+
+      val legacyOneShot = when (style) {
+        HapticFeedbackStyle.LIGHT -> LegacyOneShot(durationMs = 12L, amplitude = 50)
+        HapticFeedbackStyle.MEDIUM -> LegacyOneShot(durationMs = 18L, amplitude = 100)
+        HapticFeedbackStyle.HEAVY -> LegacyOneShot(durationMs = 28L, amplitude = 180)
+      }
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+        vibrator.vibrate(
+          VibrationEffect.createOneShot(
+            legacyOneShot.durationMs,
+            legacyOneShot.amplitude
+          )
+        )
+      } else {
+        @Suppress("DEPRECATION")
+        vibrator.vibrate(legacyOneShot.durationMs)
+      }
+    } catch (_: SecurityException) {
+      // Missing android.permission.VIBRATE or disallowed by device policy.
+    } catch (_: Throwable) {
+      // Never crash the recognition flow because of haptics.
+    }
+  }
+
+  private fun getVibrator(context: Context): Vibrator? {
+    return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+      val manager =
+        context.getSystemService(Context.VIBRATOR_MANAGER_SERVICE) as? VibratorManager
+      manager?.defaultVibrator
+    } else {
+      @Suppress("DEPRECATION")
+      context.getSystemService(Context.VIBRATOR_SERVICE) as? Vibrator
+    }
+  }
+}

package/android/src/main/java/com/margelo/nitro/nitrospeech/recognizer/HybridRecognizer.kt

@@ -84,6 +84,11 @@ class HybridRecognizer: HybridRecognizerSpec() {
     if (!isActive) return
     onFinishRecognition(null, null, true)
     mainHandler.postDelayed({
+      val context = NitroModules.applicationContext
+      val hapticImpact = config?.stopHapticFeedbackStyle
+      if (hapticImpact != null && context != null) {
+        HapticImpact(hapticImpact).trigger(context)
+      }
       cleanup()
     }, POST_RECOGNITION_DELAY)
   }
@@ -156,6 +161,12 @@ class HybridRecognizer: HybridRecognizerSpec() {
 
         speechRecognizer?.startListening(intent)
         isActive = true
+        
+        val hapticImpact = config?.startHapticFeedbackStyle
+        if (hapticImpact != null) {
+          HapticImpact(hapticImpact).trigger(context)
+        }
+
         mainHandler.postDelayed({
           if (isActive) {
             onReadyForSpeech?.invoke()

package/ios/HapticImpact.swift

@@ -0,0 +1,23 @@
+import Foundation
+import UIKit
+
+class HapticImpact {
+    private let impactGenerator: UIImpactFeedbackGenerator
+
+    init(style: HapticFeedbackStyle) {
+        let hapticStyle = switch style {
+            case .light:
+                UIImpactFeedbackGenerator.FeedbackStyle.light
+            case .medium:
+                UIImpactFeedbackGenerator.FeedbackStyle.medium
+            case .heavy:
+                UIImpactFeedbackGenerator.FeedbackStyle.heavy
+        }
+        self.impactGenerator = UIImpactFeedbackGenerator(style: hapticStyle)
+    }
+
+    func trigger() {
+        impactGenerator.prepare()
+        impactGenerator.impactOccurred()
+    }
+}

package/ios/HybridRecognizer.swift

@@ -1,8 +1,10 @@
 import Foundation
 import Speech
 import NitroModules
+import os.log
 
 class HybridRecognizer: HybridRecognizerSpec {
+    private let logger = Logger(subsystem: "com.margelo.nitro.nitrospeech", category: "AutoStopper")
     private static let defaultAutoFinishRecognitionMs = 8000.0
     
     var onReadyForSpeech: (() -> Void)?
@@ -19,10 +21,11 @@ class HybridRecognizer: HybridRecognizerSpec {
     private var appStateObserver: AppStateObserver?
     private var isActive: Bool = false
     private var isStopping: Bool = false
+    private var config: SpeechToTextParams?
     
     func startListening(params: SpeechToTextParams) {
         if isActive {
-            onError?("Previous recognition session is still active")
+//          Previous recognition session is still active
             return
         }
         
@@ -30,9 +33,11 @@ class HybridRecognizer: HybridRecognizerSpec {
             DispatchQueue.main.async {
                 guard let self = self else { return }
                 
+                self.config = params
+                
                 switch authStatus {
                 case .authorized:
-                    self.requestMicrophonePermission(params: params)
+                    self.requestMicrophonePermission()
                 case .denied, .restricted:
                     self.onPermissionDenied?()
                 case .notDetermined:
@@ -48,6 +53,10 @@ class HybridRecognizer: HybridRecognizerSpec {
         guard isActive, !isStopping else { return }
         isStopping = true
         
+        if let hapticStyle = config?.stopHapticFeedbackStyle {
+            HapticImpact(style: hapticStyle).trigger()
+        }
+        
         // Signal end of audio and request graceful finish
         recognitionRequest?.endAudio()
         recognitionTask?.finish()
@@ -79,13 +88,13 @@ class HybridRecognizer: HybridRecognizerSpec {
         stopListening()
     }
 
-    private func requestMicrophonePermission(params: SpeechToTextParams) {
+    private func requestMicrophonePermission() {
         AVAudioSession.sharedInstance().requestRecordPermission { [weak self] granted in
             DispatchQueue.main.async {
                 guard let self = self else { return }
                 
                 if granted {
-                    self.startRecognition(params: params)
+                    self.startRecognition()
                 } else {
                     self.onPermissionDenied?()
                 }
@@ -93,17 +102,17 @@ class HybridRecognizer: HybridRecognizerSpec {
         }
     }
     
-    private func startRecognition(params: SpeechToTextParams) {
+    private func startRecognition() {
         isStopping = false
         
-        let locale = Locale(identifier: params.locale ?? "en-US")
+        let locale = Locale(identifier: config?.locale ?? "en-US")
         guard let speechRecognizer = SFSpeechRecognizer(locale: locale), speechRecognizer.isAvailable else {
             onError?("Speech recognizer not available")
             return
         }
         
         autoStopper = AutoStopper(
-            silenceThresholdMs: params.autoFinishRecognitionMs ?? Self.defaultAutoFinishRecognitionMs,
+            silenceThresholdMs: config?.autoFinishRecognitionMs ?? Self.defaultAutoFinishRecognitionMs,
             onProgress: { [weak self] timeLeftMs in
                 self?.onAutoFinishProgress?(timeLeftMs)
             },
@@ -115,6 +124,10 @@ class HybridRecognizer: HybridRecognizerSpec {
         do {
             let audioSession = AVAudioSession.sharedInstance()
             try audioSession.setCategory(.record, mode: .measurement, options: .duckOthers)
+            if #available(iOS 13.0, *) {
+                // Without this, iOS may suppress haptics while recording.
+                try audioSession.setAllowHapticsAndSystemSoundsDuringRecording(true)
+            }
             try audioSession.setActive(true, options: .notifyOthersOnDeactivation)
         } catch {
             onError?("Failed to set up audio session: \(error.localizedDescription)")
@@ -131,19 +144,19 @@ class HybridRecognizer: HybridRecognizerSpec {
         
         recognitionRequest.shouldReportPartialResults = true
         
-        if let contextualStrings = params.contextualStrings, !contextualStrings.isEmpty {
+        if let contextualStrings = config?.contextualStrings, !contextualStrings.isEmpty {
             recognitionRequest.contextualStrings = contextualStrings
         }
         
         if #available(iOS 16, *) {
-            if let addPunctiation = params.iosAddPunctuation, addPunctiation == false {
+            if let addPunctiation = config?.iosAddPunctuation, addPunctiation == false {
                 recognitionRequest.addsPunctuation = false
             } else {
                 recognitionRequest.addsPunctuation = true
             }
         }
         
-        let disableRepeatingFilter = params.disableRepeatingFilter ?? false
+        let disableRepeatingFilter = config?.disableRepeatingFilter ?? false
         
         recognitionTask = speechRecognizer.recognitionTask(with: recognitionRequest) { [weak self] result, error in
             guard let self = self else { return }
@@ -197,6 +210,11 @@ class HybridRecognizer: HybridRecognizerSpec {
             audioEngine.prepare()
             try audioEngine.start()
             isActive = true
+
+            if let hapticStyle = config?.startHapticFeedbackStyle {
+                HapticImpact(style: hapticStyle).trigger()
+            }
+            
             autoStopper?.indicateRecordingActivity(
                 from: "startListening",
                 addMsToThreshold: nil

package/lib/commonjs/index.js

@@ -3,66 +3,78 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useRecognizer = exports.Recognizer = void 0;
+exports.useRecognizer = exports.RecognizerSession = exports.RecognizerRef = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _reactNativeNitroModules = require("react-native-nitro-modules");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* eslint-disable react-hooks/exhaustive-deps */
+
 const NitroSpeech = _reactNativeNitroModules.NitroModules.createHybridObject('NitroSpeech');
 
 /**
- * Unsafe access to the recognizer object for the NitroSpeech module.
+ * Unsafe access to the Recognizer Session.
  */
-const Recognizer = exports.Recognizer = NitroSpeech.recognizer;
+const RecognizerSession = exports.RecognizerSession = NitroSpeech.recognizer;
 const recognizerStartListening = params => {
-  Recognizer.startListening(params);
+  RecognizerSession.startListening(params);
 };
 const recognizerStopListening = () => {
-  Recognizer.stopListening();
+  RecognizerSession.stopListening();
 };
 const recognizerAddAutoFinishTime = additionalTimeMs => {
-  Recognizer.addAutoFinishTime(additionalTimeMs);
+  RecognizerSession.addAutoFinishTime(additionalTimeMs);
 };
 const recognizerUpdateAutoFinishTime = (newTimeMs, withRefresh) => {
-  Recognizer.updateAutoFinishTime(newTimeMs, withRefresh);
+  RecognizerSession.updateAutoFinishTime(newTimeMs, withRefresh);
 };
 
 /**
  * Safe, lifecycle-aware hook to use the recognizer.
+ *
+ * @param callbacks - The callbacks to use for the recognizer.
+ * @param destroyDeps - The additional dependencies to use for the cleanup effect.
+ *
+ * Example: To cleanup when the screen is unfocused.
+ *
+ * ```typescript
+ * const isFocused = useIsFocused()
+ * useRecognizer({ ... }, [isFocused])
+ * ```
  */
-const useRecognizer = callbacks => {
+const useRecognizer = (callbacks, destroyDeps = []) => {
   _react.default.useEffect(() => {
-    Recognizer.onReadyForSpeech = () => {
+    RecognizerSession.onReadyForSpeech = () => {
       callbacks.onReadyForSpeech?.();
     };
-    Recognizer.onRecordingStopped = () => {
+    RecognizerSession.onRecordingStopped = () => {
       callbacks.onRecordingStopped?.();
     };
-    Recognizer.onResult = resultBatches => {
+    RecognizerSession.onResult = resultBatches => {
       callbacks.onResult?.(resultBatches);
     };
-    Recognizer.onAutoFinishProgress = timeLeftMs => {
+    RecognizerSession.onAutoFinishProgress = timeLeftMs => {
       callbacks.onAutoFinishProgress?.(timeLeftMs);
     };
-    Recognizer.onError = message => {
+    RecognizerSession.onError = message => {
       callbacks.onError?.(message);
     };
-    Recognizer.onPermissionDenied = () => {
+    RecognizerSession.onPermissionDenied = () => {
       callbacks.onPermissionDenied?.();
     };
     return () => {
-      Recognizer.onReadyForSpeech = undefined;
-      Recognizer.onRecordingStopped = undefined;
-      Recognizer.onResult = undefined;
-      Recognizer.onAutoFinishProgress = undefined;
-      Recognizer.onError = undefined;
-      Recognizer.onPermissionDenied = undefined;
+      RecognizerSession.onReadyForSpeech = undefined;
+      RecognizerSession.onRecordingStopped = undefined;
+      RecognizerSession.onResult = undefined;
+      RecognizerSession.onAutoFinishProgress = undefined;
+      RecognizerSession.onError = undefined;
+      RecognizerSession.onPermissionDenied = undefined;
     };
   }, [callbacks]);
   _react.default.useEffect(() => {
     return () => {
-      Recognizer.stopListening();
+      RecognizerSession.stopListening();
     };
-  }, []);
+  }, [...destroyDeps]);
   return {
     startListening: recognizerStartListening,
     stopListening: recognizerStopListening,
@@ -70,5 +82,15 @@ const useRecognizer = callbacks => {
     updateAutoFinishTime: recognizerUpdateAutoFinishTime
   };
 };
+
+/**
+ * Safe reference to the Recognizer methods.
+ */
 exports.useRecognizer = useRecognizer;
+const RecognizerRef = exports.RecognizerRef = {
+  startListening: recognizerStartListening,
+  stopListening: recognizerStopListening,
+  addAutoFinishTime: recognizerAddAutoFinishTime,
+  updateAutoFinishTime: recognizerUpdateAutoFinishTime
+};
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_react","_interopRequireDefault","require","_reactNativeNitroModules","e","__esModule","default","NitroSpeech","NitroModules","createHybridObject","Recognizer","exports","recognizer","recognizerStartListening","params","startListening","recognizerStopListening","stopListening","recognizerAddAutoFinishTime","additionalTimeMs","addAutoFinishTime","recognizerUpdateAutoFinishTime","newTimeMs","withRefresh","updateAutoFinishTime","useRecognizer","callbacks","React","useEffect","onReadyForSpeech","onRecordingStopped","onResult","resultBatches","onAutoFinishProgress","timeLeftMs","onError","message","onPermissionDenied","undefined"],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,wBAAA,GAAAD,OAAA;AAAyD,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAOzD,MAAMG,WAAW,GACfC,qCAAY,CAACC,kBAAkB,CAAkB,aAAa,CAAC;;AAEjE;AACA;AACA;AACO,MAAMC,UAAU,GAAAC,OAAA,CAAAD,UAAA,GAAGH,WAAW,CAACK,UAAU;AAoBhD,MAAMC,wBAAwB,GAAIC,MAA0B,IAAK;EAC/DJ,UAAU,CAACK,cAAc,CAACD,MAAM,CAAC;AACnC,CAAC;AAED,MAAME,uBAAuB,GAAGA,CAAA,KAAM;EACpCN,UAAU,CAACO,aAAa,CAAC,CAAC;AAC5B,CAAC;AAED,MAAMC,2BAA2B,GAAIC,gBAAyB,IAAK;EACjET,UAAU,CAACU,iBAAiB,CAACD,gBAAgB,CAAC;AAChD,CAAC;AAED,MAAME,8BAA8B,GAAGA,CACrCC,SAAiB,EACjBC,WAAqB,KAClB;EACHb,UAAU,CAACc,oBAAoB,CAACF,SAAS,EAAEC,WAAW,CAAC;AACzD,CAAC;;AAED;AACA;AACA;AACO,MAAME,aAAa,GACxBC,SAA8B,IACP;EACvBC,cAAK,CAACC,SAAS,CAAC,MAAM;IACpBlB,UAAU,CAACmB,gBAAgB,GAAG,MAAM;MAClCH,SAAS,CAACG,gBAAgB,GAAG,CAAC;IAChC,CAAC;IACDnB,UAAU,CAACoB,kBAAkB,GAAG,MAAM;MACpCJ,SAAS,CAACI,kBAAkB,GAAG,CAAC;IAClC,CAAC;IACDpB,UAAU,CAACqB,QAAQ,GAAIC,aAAuB,IAAK;MACjDN,SAAS,CAACK,QAAQ,GAAGC,aAAa,CAAC;IACrC,CAAC;IACDtB,UAAU,CAACuB,oBAAoB,GAAIC,UAAkB,IAAK;MACxDR,SAAS,CAACO,oBAAoB,GAAGC,UAAU,CAAC;IAC9C,CAAC;IACDxB,UAAU,CAACyB,OAAO,GAAIC,OAAe,IAAK;MACxCV,SAAS,CAACS,OAAO,GAAGC,OAAO,CAAC;IAC9B,CAAC;IACD1B,UAAU,CAAC2B,kBAAkB,GAAG,MAAM;MACpCX,SAAS,CAACW,kBAAkB,GAAG,CAAC;IAClC,CAAC;IACD,OAAO,MAAM;MACX3B,UAAU,CAACmB,gBAAgB,GAAGS,SAAS;MACvC5B,UAAU,CAACoB,kBAAkB,GAAGQ,SAAS;MACzC5B,UAAU,CAACqB,QAAQ,GAAGO,SAAS;MAC/B5B,UAAU,CAACuB,oBAAoB,GAAGK,SAAS;MAC3C5B,UAAU,CAACyB,OAAO,GAAGG,SAAS;MAC9B5B,UAAU,CAAC2B,kBAAkB,GAAGC,SAAS;IAC3C,CAAC;EACH,CAAC,EAAE,CAACZ,SAAS,CAAC,CAAC;EAEfC,cAAK,CAACC,SAAS,CAAC,MAAM;IACpB,OAAO,MAAM;MACXlB,UAAU,CAACO,aAAa,CAAC,CAAC;IAC5B,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,OAAO;IACLF,cAAc,EAAEF,wBAAwB;IACxCI,aAAa,EAAED,uBAAuB;IACtCI,iBAAiB,EAAEF,2BAA2B;IAC9CM,oBAAoB,EAAEH;EACxB,CAAC;AACH,CAAC;AAAAV,OAAA,CAAAc,aAAA,GAAAA,aAAA","ignoreList":[]}
+{"version":3,"names":["_react","_interopRequireDefault","require","_reactNativeNitroModules","e","__esModule","default","NitroSpeech","NitroModules","createHybridObject","RecognizerSession","exports","recognizer","recognizerStartListening","params","startListening","recognizerStopListening","stopListening","recognizerAddAutoFinishTime","additionalTimeMs","addAutoFinishTime","recognizerUpdateAutoFinishTime","newTimeMs","withRefresh","updateAutoFinishTime","useRecognizer","callbacks","destroyDeps","React","useEffect","onReadyForSpeech","onRecordingStopped","onResult","resultBatches","onAutoFinishProgress","timeLeftMs","onError","message","onPermissionDenied","undefined","RecognizerRef"],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;;;;;AACA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,wBAAA,GAAAD,OAAA;AAAyD,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAFzD;;AASA,MAAMG,WAAW,GACfC,qCAAY,CAACC,kBAAkB,CAAkB,aAAa,CAAC;;AAEjE;AACA;AACA;AACO,MAAMC,iBAAiB,GAAAC,OAAA,CAAAD,iBAAA,GAAGH,WAAW,CAACK,UAAU;AAoBvD,MAAMC,wBAAwB,GAAIC,MAA0B,IAAK;EAC/DJ,iBAAiB,CAACK,cAAc,CAACD,MAAM,CAAC;AAC1C,CAAC;AAED,MAAME,uBAAuB,GAAGA,CAAA,KAAM;EACpCN,iBAAiB,CAACO,aAAa,CAAC,CAAC;AACnC,CAAC;AAED,MAAMC,2BAA2B,GAAIC,gBAAyB,IAAK;EACjET,iBAAiB,CAACU,iBAAiB,CAACD,gBAAgB,CAAC;AACvD,CAAC;AAED,MAAME,8BAA8B,GAAGA,CACrCC,SAAiB,EACjBC,WAAqB,KAClB;EACHb,iBAAiB,CAACc,oBAAoB,CAACF,SAAS,EAAEC,WAAW,CAAC;AAChE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,aAAa,GAAGA,CAC3BC,SAA8B,EAC9BC,WAAiC,GAAG,EAAE,KACf;EACvBC,cAAK,CAACC,SAAS,CAAC,MAAM;IACpBnB,iBAAiB,CAACoB,gBAAgB,GAAG,MAAM;MACzCJ,SAAS,CAACI,gBAAgB,GAAG,CAAC;IAChC,CAAC;IACDpB,iBAAiB,CAACqB,kBAAkB,GAAG,MAAM;MAC3CL,SAAS,CAACK,kBAAkB,GAAG,CAAC;IAClC,CAAC;IACDrB,iBAAiB,CAACsB,QAAQ,GAAIC,aAAuB,IAAK;MACxDP,SAAS,CAACM,QAAQ,GAAGC,aAAa,CAAC;IACrC,CAAC;IACDvB,iBAAiB,CAACwB,oBAAoB,GAAIC,UAAkB,IAAK;MAC/DT,SAAS,CAACQ,oBAAoB,GAAGC,UAAU,CAAC;IAC9C,CAAC;IACDzB,iBAAiB,CAAC0B,OAAO,GAAIC,OAAe,IAAK;MAC/CX,SAAS,CAACU,OAAO,GAAGC,OAAO,CAAC;IAC9B,CAAC;IACD3B,iBAAiB,CAAC4B,kBAAkB,GAAG,MAAM;MAC3CZ,SAAS,CAACY,kBAAkB,GAAG,CAAC;IAClC,CAAC;IACD,OAAO,MAAM;MACX5B,iBAAiB,CAACoB,gBAAgB,GAAGS,SAAS;MAC9C7B,iBAAiB,CAACqB,kBAAkB,GAAGQ,SAAS;MAChD7B,iBAAiB,CAACsB,QAAQ,GAAGO,SAAS;MACtC7B,iBAAiB,CAACwB,oBAAoB,GAAGK,SAAS;MAClD7B,iBAAiB,CAAC0B,OAAO,GAAGG,SAAS;MACrC7B,iBAAiB,CAAC4B,kBAAkB,GAAGC,SAAS;IAClD,CAAC;EACH,CAAC,EAAE,CAACb,SAAS,CAAC,CAAC;EAEfE,cAAK,CAACC,SAAS,CAAC,MAAM;IACpB,OAAO,MAAM;MACXnB,iBAAiB,CAACO,aAAa,CAAC,CAAC;IACnC,CAAC;EACH,CAAC,EAAE,CAAC,GAAGU,WAAW,CAAC,CAAC;EAEpB,OAAO;IACLZ,cAAc,EAAEF,wBAAwB;IACxCI,aAAa,EAAED,uBAAuB;IACtCI,iBAAiB,EAAEF,2BAA2B;IAC9CM,oBAAoB,EAAEH;EACxB,CAAC;AACH,CAAC;;AAED;AACA;AACA;AAFAV,OAAA,CAAAc,aAAA,GAAAA,aAAA;AAGO,MAAMe,aAAa,GAAA7B,OAAA,CAAA6B,aAAA,GAAG;EAC3BzB,cAAc,EAAEF,wBAAwB;EACxCI,aAAa,EAAED,uBAAuB;EACtCI,iBAAiB,EAAEF,2BAA2B;EAC9CM,oBAAoB,EAAEH;AACxB,CAAC","ignoreList":[]}