@gmessier/nitro-speech 0.4.3 → 0.4.4

package/src/Recognizer/methods.ts

@@ -1,53 +1,60 @@
 import { SpeechRecognizer } from './SpeechRecognizer'
-import type {
-  MutableSpeechRecognitionConfig,
-  SpeechRecognitionConfig,
-} from './types'
+import type { RecognizerMethods } from './types'
 
-export const recognizerPrewarm = (params?: SpeechRecognitionConfig) => {
+export const recognizerPrewarm: RecognizerMethods['prewarm'] = (
+  params,
+  options
+) => {
   'worklet'
-  return SpeechRecognizer.prewarm(params)
+  return SpeechRecognizer.prewarm(params, options)
 }
 
-export const recognizerStartListening = (params?: SpeechRecognitionConfig) => {
+export const recognizerStartListening: RecognizerMethods['startListening'] = (
+  params
+) => {
   'worklet'
   SpeechRecognizer.startListening(params)
 }
 
-export const recognizerStopListening = () => {
-  'worklet'
-  SpeechRecognizer.stopListening()
-}
+export const recognizerStopListening: RecognizerMethods['stopListening'] =
+  () => {
+    'worklet'
+    SpeechRecognizer.stopListening()
+  }
 
-export const recognizerResetAutoFinishTime = () => {
-  'worklet'
-  SpeechRecognizer.resetAutoFinishTime()
-}
+export const recognizerResetAutoFinishTime: RecognizerMethods['resetAutoFinishTime'] =
+  () => {
+    'worklet'
+    SpeechRecognizer.resetAutoFinishTime()
+  }
 
-export const recognizerAddAutoFinishTime = (additionalTimeMs?: number) => {
-  'worklet'
-  SpeechRecognizer.addAutoFinishTime(additionalTimeMs)
-}
+export const recognizerAddAutoFinishTime: RecognizerMethods['addAutoFinishTime'] =
+  (additionalTimeMs) => {
+    'worklet'
+    SpeechRecognizer.addAutoFinishTime(additionalTimeMs)
+  }
 
-export const recognizerUpdateConfig = (
-  newConfig?: MutableSpeechRecognitionConfig,
-  resetAutoFinishTime?: boolean
+export const recognizerUpdateConfig: RecognizerMethods['updateConfig'] = (
+  newConfig,
+  resetAutoFinishTime
 ) => {
   'worklet'
   SpeechRecognizer.updateConfig(newConfig, resetAutoFinishTime)
 }
 
-export const recognizerGetIsActive = () => {
+export const recognizerGetIsActive: RecognizerMethods['getIsActive'] = () => {
   'worklet'
   return SpeechRecognizer.getIsActive()
 }
 
-export const recognizerGetVoiceInputVolume = () => {
-  'worklet'
-  return SpeechRecognizer.getVoiceInputVolume()
-}
+export const recognizerGetVoiceInputVolume: RecognizerMethods['getVoiceInputVolume'] =
+  () => {
+    'worklet'
+    return SpeechRecognizer.getVoiceInputVolume()
+  }
 
-export const recognizerGetSupportedLocalesIOS = () => {
-  'worklet'
-  return SpeechRecognizer.getSupportedLocalesIOS().sort()
-}
+export const recognizerGetSupportedLocalesIOS: RecognizerMethods['getSupportedLocalesIOS'] =
+  () => {
+    'worklet'
+    return SpeechRecognizer.getSupportedLocalesIOS().sort()
+  }

package/src/Recognizer/types.ts

@@ -4,6 +4,7 @@ import type {
   SpeechRecognitionConfig,
 } from '../specs/SpeechRecognitionConfig'
 import type { VolumeChangeEvent } from '../specs/VolumeChangeEvent'
+import type { SpeechRecognitionPrewarm } from '../specs/SpeechRecognitionPrewarm'
 
 type RecognizerCallbacks = Pick<
   RecognizerSpec,
@@ -32,6 +33,7 @@ type RecognizerMethods = Pick<
 export type {
   RecognizerSpec,
   SpeechRecognitionConfig,
+  SpeechRecognitionPrewarm,
   MutableSpeechRecognitionConfig,
   VolumeChangeEvent,
   RecognizerCallbacks,

package/src/index.ts

@@ -13,6 +13,7 @@ export { NitroSpeech } from './NitroSpeech'
 export {
   type RecognizerSpec,
   type SpeechRecognitionConfig,
+  type SpeechRecognitionPrewarm,
   type MutableSpeechRecognitionConfig,
   type VolumeChangeEvent,
   type RecognizerCallbacks,

package/src/specs/Recognizer.nitro.ts

@@ -4,6 +4,7 @@ import type {
   SpeechRecognitionConfig,
 } from './SpeechRecognitionConfig'
 import type { VolumeChangeEvent } from './VolumeChangeEvent'
+import type { SpeechRecognitionPrewarm } from './SpeechRecognitionPrewarm'
 
 export interface Recognizer extends HybridObject<{
   ios: 'swift'
@@ -31,7 +32,10 @@ export interface Recognizer extends HybridObject<{
    *  });
    * ```
    */
-  prewarm(defaultParams?: SpeechRecognitionConfig): Promise<void>
+  prewarm(
+    defaultParams?: SpeechRecognitionConfig,
+    options?: SpeechRecognitionPrewarm
+  ): Promise<void>
 
   /**
    * Try to start the speech recognition.

package/src/specs/SpeechRecognitionConfig.ts

@@ -40,6 +40,8 @@ interface ParamsIOS {
    * `"speed"` - Gives priority to speed over accuracy
    *
    * `"general"` - For longer speeches, more accurate but delayed response
+   * 
+   * @note preset may be overridden by other properties
    *
    * @since iOS 26.0+
    *

package/src/specs/SpeechRecognitionPrewarm.ts

@@ -0,0 +1,10 @@
+export interface SpeechRecognitionPrewarm {
+  /**
+   * If permission is not granted, will request it.
+   *
+   * if permission is set, does nothing.
+   *
+   * @default true
+   */
+  requestPermission?: boolean
+}