@gmessier/nitro-speech 0.1.0 → 0.1.2

package/src/index.ts

@@ -1,3 +1,4 @@
+/* eslint-disable react-hooks/exhaustive-deps */
 import React from 'react'
 import { NitroModules } from 'react-native-nitro-modules'
 import type {
@@ -10,9 +11,9 @@ const NitroSpeech =
   NitroModules.createHybridObject<NitroSpeechSpec>('NitroSpeech')
 
 /**
- * Unsafe access to the recognizer object for the NitroSpeech module.
+ * Unsafe access to the Recognizer Session.
  */
-export const Recognizer = NitroSpeech.recognizer
+export const RecognizerSession = NitroSpeech.recognizer
 
 type RecognizerCallbacks = Pick<
   RecognizerSpec,
@@ -33,64 +34,75 @@ type RecognizerHandlers = Pick<
 >
 
 const recognizerStartListening = (params: SpeechToTextParams) => {
-  Recognizer.startListening(params)
+  RecognizerSession.startListening(params)
 }
 
 const recognizerStopListening = () => {
-  Recognizer.stopListening()
+  RecognizerSession.stopListening()
 }
 
 const recognizerAddAutoFinishTime = (additionalTimeMs?: number) => {
-  Recognizer.addAutoFinishTime(additionalTimeMs)
+  RecognizerSession.addAutoFinishTime(additionalTimeMs)
 }
 
 const recognizerUpdateAutoFinishTime = (
   newTimeMs: number,
   withRefresh?: boolean
 ) => {
-  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])
+ * ```
  */
 export const useRecognizer = (
-  callbacks: RecognizerCallbacks
+  callbacks: RecognizerCallbacks,
+  destroyDeps: React.DependencyList = []
 ): RecognizerHandlers => {
   React.useEffect(() => {
-    Recognizer.onReadyForSpeech = () => {
+    RecognizerSession.onReadyForSpeech = () => {
       callbacks.onReadyForSpeech?.()
     }
-    Recognizer.onRecordingStopped = () => {
+    RecognizerSession.onRecordingStopped = () => {
       callbacks.onRecordingStopped?.()
     }
-    Recognizer.onResult = (resultBatches: string[]) => {
+    RecognizerSession.onResult = (resultBatches: string[]) => {
       callbacks.onResult?.(resultBatches)
     }
-    Recognizer.onAutoFinishProgress = (timeLeftMs: number) => {
+    RecognizerSession.onAutoFinishProgress = (timeLeftMs: number) => {
       callbacks.onAutoFinishProgress?.(timeLeftMs)
     }
-    Recognizer.onError = (message: string) => {
+    RecognizerSession.onError = (message: string) => {
       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.useEffect(() => {
     return () => {
-      Recognizer.stopListening()
+      RecognizerSession.stopListening()
     }
-  }, [])
+  }, [...destroyDeps])
 
   return {
     startListening: recognizerStartListening,
@@ -100,4 +112,14 @@ export const useRecognizer = (
   }
 }
 
+/**
+ * Safe reference to the Recognizer methods.
+ */
+export const RecognizerRef = {
+  startListening: recognizerStartListening,
+  stopListening: recognizerStopListening,
+  addAutoFinishTime: recognizerAddAutoFinishTime,
+  updateAutoFinishTime: recognizerUpdateAutoFinishTime,
+}
+
 export type { RecognizerCallbacks, RecognizerHandlers, SpeechToTextParams }

package/src/specs/NitroSpeech.nitro.ts

@@ -44,6 +44,8 @@ interface ParamsIOS {
   iosAddPunctuation?: boolean
 }
 
+type HapticFeedbackStyle = 'light' | 'medium' | 'heavy'
+
 export interface SpeechToTextParams extends ParamsAndroid, ParamsIOS {
   /**
    * Default - "en-US"
@@ -65,6 +67,18 @@ export interface SpeechToTextParams extends ParamsAndroid, ParamsIOS {
    * An array of strings that should be recognized, even if they are not in the system vocabulary.
    */
   contextualStrings?: string[]
+  /**
+   * Default - null
+   *
+   * Haptic feedback style when microphone starts recording.
+   */
+  startHapticFeedbackStyle?: HapticFeedbackStyle
+  /**
+   * Default - null
+   *
+   * Haptic feedback style when microphone stops recording.
+   */
+  stopHapticFeedbackStyle?: HapticFeedbackStyle
 }
 
 export interface Recognizer extends HybridObject<{