@gmessier/nitro-speech 0.4.2 → 0.4.4

package/nitrogen/generated/ios/swift/SpeechRecognitionPrewarm.swift

@@ -0,0 +1,42 @@
+///
+/// SpeechRecognitionPrewarm.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `SpeechRecognitionPrewarm`, backed by a C++ struct.
+ */
+public typealias SpeechRecognitionPrewarm = margelo.nitro.nitrospeech.SpeechRecognitionPrewarm
+
+public extension SpeechRecognitionPrewarm {
+  private typealias bridge = margelo.nitro.nitrospeech.bridge.swift
+
+  /**
+   * Create a new instance of `SpeechRecognitionPrewarm`.
+   */
+  init(requestPermission: Bool?) {
+    self.init({ () -> bridge.std__optional_bool_ in
+      if let __unwrappedValue = requestPermission {
+        return bridge.create_std__optional_bool_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var requestPermission: Bool? {
+    return { () -> Bool? in
+      if bridge.has_value_std__optional_bool_(self.__requestPermission) {
+        let __unwrapped = bridge.get_std__optional_bool_(self.__requestPermission)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+}

package/nitrogen/generated/shared/c++/HybridRecognizerSpec.hpp

@@ -17,6 +17,8 @@
 namespace margelo::nitro::nitrospeech { struct VolumeChangeEvent; }
 // Forward declaration of `SpeechRecognitionConfig` to properly resolve imports.
 namespace margelo::nitro::nitrospeech { struct SpeechRecognitionConfig; }
+// Forward declaration of `SpeechRecognitionPrewarm` to properly resolve imports.
+namespace margelo::nitro::nitrospeech { struct SpeechRecognitionPrewarm; }
 // Forward declaration of `MutableSpeechRecognitionConfig` to properly resolve imports.
 namespace margelo::nitro::nitrospeech { struct MutableSpeechRecognitionConfig; }
 
@@ -27,6 +29,7 @@ namespace margelo::nitro::nitrospeech { struct MutableSpeechRecognitionConfig; }
 #include "VolumeChangeEvent.hpp"
 #include <NitroModules/Promise.hpp>
 #include "SpeechRecognitionConfig.hpp"
+#include "SpeechRecognitionPrewarm.hpp"
 #include "MutableSpeechRecognitionConfig.hpp"
 
 namespace margelo::nitro::nitrospeech {
@@ -73,7 +76,7 @@ namespace margelo::nitro::nitrospeech {
 
     public:
       // Methods
-      virtual std::shared_ptr<Promise<void>> prewarm(const std::optional<SpeechRecognitionConfig>& defaultParams) = 0;
+      virtual std::shared_ptr<Promise<void>> prewarm(const std::optional<SpeechRecognitionConfig>& defaultParams, const std::optional<SpeechRecognitionPrewarm>& options) = 0;
       virtual void startListening(const std::optional<SpeechRecognitionConfig>& params) = 0;
       virtual void stopListening() = 0;
       virtual void resetAutoFinishTime() = 0;

package/nitrogen/generated/shared/c++/IosPreset.hpp

@@ -31,6 +31,7 @@ namespace margelo::nitro::nitrospeech {
   enum class IosPreset {
     SHORTFORM      SWIFT_NAME(shortform) = 0,
     GENERAL      SWIFT_NAME(general) = 1,
+    SPEED      SWIFT_NAME(speed) = 2,
   } CLOSED_ENUM;
 
 } // namespace margelo::nitro::nitrospeech
@@ -45,6 +46,7 @@ namespace margelo::nitro {
       switch (hashString(unionValue.c_str(), unionValue.size())) {
         case hashString("shortform"): return margelo::nitro::nitrospeech::IosPreset::SHORTFORM;
         case hashString("general"): return margelo::nitro::nitrospeech::IosPreset::GENERAL;
+        case hashString("speed"): return margelo::nitro::nitrospeech::IosPreset::SPEED;
         default: [[unlikely]]
           throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum IosPreset - invalid value!");
       }
@@ -53,6 +55,7 @@ namespace margelo::nitro {
       switch (arg) {
         case margelo::nitro::nitrospeech::IosPreset::SHORTFORM: return JSIConverter<std::string>::toJSI(runtime, "shortform");
         case margelo::nitro::nitrospeech::IosPreset::GENERAL: return JSIConverter<std::string>::toJSI(runtime, "general");
+        case margelo::nitro::nitrospeech::IosPreset::SPEED: return JSIConverter<std::string>::toJSI(runtime, "speed");
         default: [[unlikely]]
           throw std::invalid_argument("Cannot convert IosPreset to JS - invalid value: "
                                     + std::to_string(static_cast<int>(arg)) + "!");
@@ -66,6 +69,7 @@ namespace margelo::nitro {
       switch (hashString(unionValue.c_str(), unionValue.size())) {
         case hashString("shortform"):
         case hashString("general"):
+        case hashString("speed"):
           return true;
         default:
           return false;

package/nitrogen/generated/shared/c++/SpeechRecognitionPrewarm.hpp

@@ -0,0 +1,83 @@
+///
+/// SpeechRecognitionPrewarm.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <optional>
+
+namespace margelo::nitro::nitrospeech {
+
+  /**
+   * A struct which can be represented as a JavaScript object (SpeechRecognitionPrewarm).
+   */
+  struct SpeechRecognitionPrewarm final {
+  public:
+    std::optional<bool> requestPermission     SWIFT_PRIVATE;
+
+  public:
+    SpeechRecognitionPrewarm() = default;
+    explicit SpeechRecognitionPrewarm(std::optional<bool> requestPermission): requestPermission(requestPermission) {}
+
+  public:
+    friend bool operator==(const SpeechRecognitionPrewarm& lhs, const SpeechRecognitionPrewarm& rhs) = default;
+  };
+
+} // namespace margelo::nitro::nitrospeech
+
+namespace margelo::nitro {
+
+  // C++ SpeechRecognitionPrewarm <> JS SpeechRecognitionPrewarm (object)
+  template <>
+  struct JSIConverter<margelo::nitro::nitrospeech::SpeechRecognitionPrewarm> final {
+    static inline margelo::nitro::nitrospeech::SpeechRecognitionPrewarm fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::nitrospeech::SpeechRecognitionPrewarm(
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "requestPermission")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::nitrospeech::SpeechRecognitionPrewarm& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "requestPermission"), JSIConverter<std::optional<bool>>::toJSI(runtime, arg.requestPermission));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "requestPermission")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gmessier/nitro-speech",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "React Native Real-time Speech Recognition Library powered by Nitro Modules",
   "main": "./lib/index.js",
   "module": "./lib/index.js",

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

@@ -23,7 +23,7 @@ interface ParamsAndroid {
   androidDisableBatchHandling?: boolean
 }
 
-type IosPreset = 'shortform' | 'general'
+type IosPreset = 'shortform' | 'general' | 'speed'
 
 interface ParamsIOS {
   /**
@@ -35,9 +35,13 @@ interface ParamsIOS {
    */
   iosAddPunctuation?: boolean
   /**
-   * `"shortForm"` - for a short phrase or sentence, also disables punctuation
+   * `"shortForm"` - For a short phrase or sentence, also disables punctuation
    *
-   * `"general"` - for longer speeches, more accurate but delayed response
+   * `"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
+}