@gmessier/nitro-speech 0.0.1

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

@@ -0,0 +1,65 @@
+///
+/// HybridNitroSpeechSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `HybridRecognizerSpec` to properly resolve imports.
+namespace margelo::nitro::nitrospeech { class HybridRecognizerSpec; }
+
+#include <memory>
+#include "HybridRecognizerSpec.hpp"
+
+namespace margelo::nitro::nitrospeech {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `NitroSpeech`
+   * Inherit this class to create instances of `HybridNitroSpeechSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridNitroSpeech: public HybridNitroSpeechSpec {
+   * public:
+   *   HybridNitroSpeech(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridNitroSpeechSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridNitroSpeechSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridNitroSpeechSpec() override = default;
+
+    public:
+      // Properties
+      virtual std::shared_ptr<HybridRecognizerSpec> getRecognizer() = 0;
+      virtual void setRecognizer(const std::shared_ptr<HybridRecognizerSpec>& recognizer) = 0;
+
+    public:
+      // Methods
+      
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "NitroSpeech";
+  };
+
+} // namespace margelo::nitro::nitrospeech

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

@@ -0,0 +1,34 @@
+///
+/// HybridRecognizerSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 Marc Rousavy @ Margelo
+///
+
+#include "HybridRecognizerSpec.hpp"
+
+namespace margelo::nitro::nitrospeech {
+
+  void HybridRecognizerSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("onReadyForSpeech", &HybridRecognizerSpec::getOnReadyForSpeech);
+      prototype.registerHybridSetter("onReadyForSpeech", &HybridRecognizerSpec::setOnReadyForSpeech);
+      prototype.registerHybridGetter("onRecordingStopped", &HybridRecognizerSpec::getOnRecordingStopped);
+      prototype.registerHybridSetter("onRecordingStopped", &HybridRecognizerSpec::setOnRecordingStopped);
+      prototype.registerHybridGetter("onResult", &HybridRecognizerSpec::getOnResult);
+      prototype.registerHybridSetter("onResult", &HybridRecognizerSpec::setOnResult);
+      prototype.registerHybridGetter("onAutoFinishProgress", &HybridRecognizerSpec::getOnAutoFinishProgress);
+      prototype.registerHybridSetter("onAutoFinishProgress", &HybridRecognizerSpec::setOnAutoFinishProgress);
+      prototype.registerHybridGetter("onError", &HybridRecognizerSpec::getOnError);
+      prototype.registerHybridSetter("onError", &HybridRecognizerSpec::setOnError);
+      prototype.registerHybridGetter("onPermissionDenied", &HybridRecognizerSpec::getOnPermissionDenied);
+      prototype.registerHybridSetter("onPermissionDenied", &HybridRecognizerSpec::setOnPermissionDenied);
+      prototype.registerHybridMethod("startListening", &HybridRecognizerSpec::startListening);
+      prototype.registerHybridMethod("stopListening", &HybridRecognizerSpec::stopListening);
+    });
+  }
+
+} // namespace margelo::nitro::nitrospeech

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

@@ -0,0 +1,79 @@
+///
+/// HybridRecognizerSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `SpeechToTextParams` to properly resolve imports.
+namespace margelo::nitro::nitrospeech { struct SpeechToTextParams; }
+
+#include <functional>
+#include <optional>
+#include <string>
+#include <vector>
+#include "SpeechToTextParams.hpp"
+
+namespace margelo::nitro::nitrospeech {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `Recognizer`
+   * Inherit this class to create instances of `HybridRecognizerSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridRecognizer: public HybridRecognizerSpec {
+   * public:
+   *   HybridRecognizer(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridRecognizerSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridRecognizerSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridRecognizerSpec() override = default;
+
+    public:
+      // Properties
+      virtual std::optional<std::function<void()>> getOnReadyForSpeech() = 0;
+      virtual void setOnReadyForSpeech(const std::optional<std::function<void()>>& onReadyForSpeech) = 0;
+      virtual std::optional<std::function<void()>> getOnRecordingStopped() = 0;
+      virtual void setOnRecordingStopped(const std::optional<std::function<void()>>& onRecordingStopped) = 0;
+      virtual std::optional<std::function<void(const std::vector<std::string>& /* resultBatches */)>> getOnResult() = 0;
+      virtual void setOnResult(const std::optional<std::function<void(const std::vector<std::string>& /* resultBatches */)>>& onResult) = 0;
+      virtual std::optional<std::function<void(double /* timeLeftMs */)>> getOnAutoFinishProgress() = 0;
+      virtual void setOnAutoFinishProgress(const std::optional<std::function<void(double /* timeLeftMs */)>>& onAutoFinishProgress) = 0;
+      virtual std::optional<std::function<void(const std::string& /* message */)>> getOnError() = 0;
+      virtual void setOnError(const std::optional<std::function<void(const std::string& /* message */)>>& onError) = 0;
+      virtual std::optional<std::function<void()>> getOnPermissionDenied() = 0;
+      virtual void setOnPermissionDenied(const std::optional<std::function<void()>>& onPermissionDenied) = 0;
+
+    public:
+      // Methods
+      virtual void startListening(const SpeechToTextParams& params) = 0;
+      virtual void stopListening() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "Recognizer";
+  };
+
+} // namespace margelo::nitro::nitrospeech

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

@@ -0,0 +1,109 @@
+///
+/// SpeechToTextParams.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 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
+
+
+
+#include <string>
+#include <optional>
+#include <vector>
+
+namespace margelo::nitro::nitrospeech {
+
+  /**
+   * A struct which can be represented as a JavaScript object (SpeechToTextParams).
+   */
+  struct SpeechToTextParams {
+  public:
+    std::optional<std::string> locale     SWIFT_PRIVATE;
+    std::optional<double> autoFinishRecognitionMs     SWIFT_PRIVATE;
+    std::optional<bool> disableRepeatingFilter     SWIFT_PRIVATE;
+    std::optional<std::vector<std::string>> contextualStrings     SWIFT_PRIVATE;
+    std::optional<bool> androidMaskOffensiveWords     SWIFT_PRIVATE;
+    std::optional<bool> androidFormattingPreferQuality     SWIFT_PRIVATE;
+    std::optional<bool> androidUseWebSearchModel     SWIFT_PRIVATE;
+    std::optional<bool> androidDisableBatchHandling     SWIFT_PRIVATE;
+    std::optional<bool> iosAddPunctuation     SWIFT_PRIVATE;
+
+  public:
+    SpeechToTextParams() = default;
+    explicit SpeechToTextParams(std::optional<std::string> locale, std::optional<double> autoFinishRecognitionMs, std::optional<bool> disableRepeatingFilter, std::optional<std::vector<std::string>> contextualStrings, std::optional<bool> androidMaskOffensiveWords, std::optional<bool> androidFormattingPreferQuality, std::optional<bool> androidUseWebSearchModel, std::optional<bool> androidDisableBatchHandling, std::optional<bool> iosAddPunctuation): locale(locale), autoFinishRecognitionMs(autoFinishRecognitionMs), disableRepeatingFilter(disableRepeatingFilter), contextualStrings(contextualStrings), androidMaskOffensiveWords(androidMaskOffensiveWords), androidFormattingPreferQuality(androidFormattingPreferQuality), androidUseWebSearchModel(androidUseWebSearchModel), androidDisableBatchHandling(androidDisableBatchHandling), iosAddPunctuation(iosAddPunctuation) {}
+  };
+
+} // namespace margelo::nitro::nitrospeech
+
+namespace margelo::nitro {
+
+  // C++ SpeechToTextParams <> JS SpeechToTextParams (object)
+  template <>
+  struct JSIConverter<margelo::nitro::nitrospeech::SpeechToTextParams> final {
+    static inline margelo::nitro::nitrospeech::SpeechToTextParams fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::nitrospeech::SpeechToTextParams(
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "locale")),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, "autoFinishRecognitionMs")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "disableRepeatingFilter")),
+        JSIConverter<std::optional<std::vector<std::string>>>::fromJSI(runtime, obj.getProperty(runtime, "contextualStrings")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "androidMaskOffensiveWords")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "androidFormattingPreferQuality")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "androidUseWebSearchModel")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "androidDisableBatchHandling")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "iosAddPunctuation"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::nitrospeech::SpeechToTextParams& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "locale", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.locale));
+      obj.setProperty(runtime, "autoFinishRecognitionMs", JSIConverter<std::optional<double>>::toJSI(runtime, arg.autoFinishRecognitionMs));
+      obj.setProperty(runtime, "disableRepeatingFilter", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.disableRepeatingFilter));
+      obj.setProperty(runtime, "contextualStrings", JSIConverter<std::optional<std::vector<std::string>>>::toJSI(runtime, arg.contextualStrings));
+      obj.setProperty(runtime, "androidMaskOffensiveWords", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.androidMaskOffensiveWords));
+      obj.setProperty(runtime, "androidFormattingPreferQuality", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.androidFormattingPreferQuality));
+      obj.setProperty(runtime, "androidUseWebSearchModel", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.androidUseWebSearchModel));
+      obj.setProperty(runtime, "androidDisableBatchHandling", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.androidDisableBatchHandling));
+      obj.setProperty(runtime, "iosAddPunctuation", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.iosAddPunctuation));
+      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<std::string>>::canConvert(runtime, obj.getProperty(runtime, "locale"))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, "autoFinishRecognitionMs"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "disableRepeatingFilter"))) return false;
+      if (!JSIConverter<std::optional<std::vector<std::string>>>::canConvert(runtime, obj.getProperty(runtime, "contextualStrings"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "androidMaskOffensiveWords"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "androidFormattingPreferQuality"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "androidUseWebSearchModel"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "androidDisableBatchHandling"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "iosAddPunctuation"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,123 @@
+{
+  "name": "@gmessier/nitro-speech",
+  "version": "0.0.1",
+  "description": "nitro-speech",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "types": "./lib/typescript/index.d.ts",
+  "react-native": "./lib/module/index.js",
+  "source": "src/index.ts",
+  "files": [
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
+    "android/build.gradle",
+    "android/gradle.properties",
+    "android/fix-prefab.gradle",
+    "android/CMakeLists.txt",
+    "android/src",
+    "ios/**/*.h",
+    "ios/**/*.m",
+    "ios/**/*.mm",
+    "ios/**/*.cpp",
+    "ios/**/*.swift",
+    "app.plugin.js",
+    "nitro.json",
+    "*.podspec",
+    "README.md"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf android/build node_modules/**/android/build lib",
+    "lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "lint-ci": "eslint \"**/*.{js,ts,tsx}\" -f @jamesacarr/github-actions",
+    "typescript": "tsc",
+    "build": "rm -rf lib && npm run typecheck && bob build",
+    "specs": "tsc --noEmit false && nitrogen --logLevel=\"debug\""
+  },
+  "keywords": [
+    "react-native",
+    "nitro"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mrousavy/nitro.git"
+  },
+  "author": "Marc Rousavy <me@mrousavy.com> (https://github.com/mrousavy)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mrousavy/nitro/issues"
+  },
+  "homepage": "https://github.com/mrousavy/nitro#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@react-native/eslint-config": "0.82.0",
+    "@types/react": "^19.1.03",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "nitrogen": "*",
+    "prettier": "^3.3.3",
+    "react": "19.1.1",
+    "react-native": "0.82.0",
+    "react-native-nitro-modules": "*",
+    "react-native-builder-bob": "^0.37.0",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "*"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "warn",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false,
+    "semi": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.json"
+        }
+      ]
+    ]
+  }
+}

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {},
+    },
+  },
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { NitroModules } from 'react-native-nitro-modules'
+import type { NitroSpeech as NitroSpeechSpec } from './specs/NitroSpeech.nitro'
+
+const NitroSpeech =
+  NitroModules.createHybridObject<NitroSpeechSpec>('NitroSpeech')
+
+export const Recognizer = NitroSpeech.recognizer
+export type { SpeechToTextParams } from './specs/NitroSpeech.nitro'

package/src/specs/NitroSpeech.nitro.ts

@@ -0,0 +1,113 @@
+import { type HybridObject } from 'react-native-nitro-modules'
+
+interface ParamsAndroid {
+  /**
+   * Default - false
+   *
+   * Min Android 13
+   */
+  androidMaskOffensiveWords?: boolean
+  /**
+   * Default - false
+   *
+   * Prefer quality over latency (may break autofinish timing, depends on engine)
+   *
+   * Min Android 13
+   */
+  androidFormattingPreferQuality?: boolean
+  /**
+   * Default - false
+   *
+   * Language model based on web search terms. (may not work on some devices)
+   *
+   * Default - free form model
+   */
+  androidUseWebSearchModel?: boolean
+  /**
+   * Default - false.
+   *
+   * If required to handle batches non-default way.
+   *
+   * Will add lots of batches with empty or similar content to the result.
+   */
+  androidDisableBatchHandling?: boolean
+}
+
+interface ParamsIOS {
+  /**
+   * Default - true
+   *
+   * Adds punctuation to speech recognition results
+   *
+   * Min iOS 16
+   */
+  iosAddPunctuation?: boolean
+}
+
+export interface SpeechToTextParams extends ParamsAndroid, ParamsIOS {
+  /**
+   * Default - "en-US"
+   */
+  locale?: string
+  /**
+   * Default - 8s
+   */
+  autoFinishRecognitionMs?: number
+  /**
+   * Default - false
+   *
+   * Lots of repeating words in a row can be annoying
+   */
+  disableRepeatingFilter?: boolean
+  /**
+   * Default - empty array
+   *
+   * An array of strings that should be recognized, even if they are not in the system vocabulary.
+   */
+  contextualStrings?: string[]
+}
+
+export interface Recognizer extends HybridObject<{
+  ios: 'swift'
+  android: 'kotlin'
+}> {
+  // Speech-to-text methods
+  startListening(params: SpeechToTextParams): void
+  stopListening(): void
+
+  /**
+   * User's speech is ready to be recognized.
+   */
+  onReadyForSpeech?: () => void
+  /**
+   * Audio recording has stopped. (may be called multiple times for one recording)
+   */
+  onRecordingStopped?: () => void
+  /**
+   * Called each time either a new batch has been added or the last batch has been updated.
+   */
+  onResult?: (resultBatches: string[]) => void
+  /**
+   * Called each second while auto finish is in progress.
+   *
+   * Time left in milliseconds. Always more than 1000ms.
+   *
+   * TODO: Add for android
+   */
+  onAutoFinishProgress?: (timeLeftMs: number) => void
+  /**
+   * Error of the speech recognition.
+   */
+  onError?: (message: string) => void
+  /**
+   * Permission to record audio has been denied.
+   */
+  onPermissionDenied?: () => void
+}
+
+export interface NitroSpeech extends HybridObject<{
+  ios: 'swift'
+  android: 'kotlin'
+}> {
+  recognizer: Recognizer
+}