react-native-nitro-mlx 0.3.0 → 0.4.0

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

@@ -0,0 +1,78 @@
+///
+/// HybridTTSSpec.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 `TTSLoadOptions` to properly resolve imports.
+namespace margelo::nitro::mlxreactnative { struct TTSLoadOptions; }
+// Forward declaration of `TTSGenerateOptions` to properly resolve imports.
+namespace margelo::nitro::mlxreactnative { struct TTSGenerateOptions; }
+
+#include <string>
+#include <NitroModules/Promise.hpp>
+#include "TTSLoadOptions.hpp"
+#include <optional>
+#include <NitroModules/ArrayBuffer.hpp>
+#include "TTSGenerateOptions.hpp"
+#include <functional>
+
+namespace margelo::nitro::mlxreactnative {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `TTS`
+   * Inherit this class to create instances of `HybridTTSSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridTTS: public HybridTTSSpec {
+   * public:
+   *   HybridTTS(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridTTSSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridTTSSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridTTSSpec() override = default;
+
+    public:
+      // Properties
+      virtual bool getIsLoaded() = 0;
+      virtual bool getIsGenerating() = 0;
+      virtual std::string getModelId() = 0;
+      virtual double getSampleRate() = 0;
+
+    public:
+      // Methods
+      virtual std::shared_ptr<Promise<void>> load(const std::string& modelId, const std::optional<TTSLoadOptions>& options) = 0;
+      virtual std::shared_ptr<Promise<std::shared_ptr<ArrayBuffer>>> generate(const std::string& text, const std::optional<TTSGenerateOptions>& options) = 0;
+      virtual std::shared_ptr<Promise<void>> stream(const std::string& text, const std::function<void(const std::shared_ptr<ArrayBuffer>& /* audio */)>& onAudioChunk, const std::optional<TTSGenerateOptions>& options) = 0;
+      virtual void stop() = 0;
+      virtual void unload() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "TTS";
+  };
+
+} // namespace margelo::nitro::mlxreactnative

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

@@ -0,0 +1,76 @@
+///
+/// STTLoadOptions.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 <functional>
+#include <optional>
+
+namespace margelo::nitro::mlxreactnative {
+
+  /**
+   * A struct which can be represented as a JavaScript object (STTLoadOptions).
+   */
+  struct STTLoadOptions {
+  public:
+    std::optional<std::function<void(double /* progress */)>> onProgress     SWIFT_PRIVATE;
+
+  public:
+    STTLoadOptions() = default;
+    explicit STTLoadOptions(std::optional<std::function<void(double /* progress */)>> onProgress): onProgress(onProgress) {}
+  };
+
+} // namespace margelo::nitro::mlxreactnative
+
+namespace margelo::nitro {
+
+  // C++ STTLoadOptions <> JS STTLoadOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlxreactnative::STTLoadOptions> final {
+    static inline margelo::nitro::mlxreactnative::STTLoadOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlxreactnative::STTLoadOptions(
+        JSIConverter<std::optional<std::function<void(double)>>>::fromJSI(runtime, obj.getProperty(runtime, "onProgress"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlxreactnative::STTLoadOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "onProgress", JSIConverter<std::optional<std::function<void(double)>>>::toJSI(runtime, arg.onProgress));
+      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::function<void(double)>>>::canConvert(runtime, obj.getProperty(runtime, "onProgress"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,80 @@
+///
+/// TTSGenerateOptions.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>
+
+namespace margelo::nitro::mlxreactnative {
+
+  /**
+   * A struct which can be represented as a JavaScript object (TTSGenerateOptions).
+   */
+  struct TTSGenerateOptions {
+  public:
+    std::optional<std::string> voice     SWIFT_PRIVATE;
+    std::optional<double> speed     SWIFT_PRIVATE;
+
+  public:
+    TTSGenerateOptions() = default;
+    explicit TTSGenerateOptions(std::optional<std::string> voice, std::optional<double> speed): voice(voice), speed(speed) {}
+  };
+
+} // namespace margelo::nitro::mlxreactnative
+
+namespace margelo::nitro {
+
+  // C++ TTSGenerateOptions <> JS TTSGenerateOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlxreactnative::TTSGenerateOptions> final {
+    static inline margelo::nitro::mlxreactnative::TTSGenerateOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlxreactnative::TTSGenerateOptions(
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "voice")),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, "speed"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlxreactnative::TTSGenerateOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "voice", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.voice));
+      obj.setProperty(runtime, "speed", JSIConverter<std::optional<double>>::toJSI(runtime, arg.speed));
+      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, "voice"))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, "speed"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,76 @@
+///
+/// TTSLoadOptions.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 <functional>
+#include <optional>
+
+namespace margelo::nitro::mlxreactnative {
+
+  /**
+   * A struct which can be represented as a JavaScript object (TTSLoadOptions).
+   */
+  struct TTSLoadOptions {
+  public:
+    std::optional<std::function<void(double /* progress */)>> onProgress     SWIFT_PRIVATE;
+
+  public:
+    TTSLoadOptions() = default;
+    explicit TTSLoadOptions(std::optional<std::function<void(double /* progress */)>> onProgress): onProgress(onProgress) {}
+  };
+
+} // namespace margelo::nitro::mlxreactnative
+
+namespace margelo::nitro {
+
+  // C++ TTSLoadOptions <> JS TTSLoadOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlxreactnative::TTSLoadOptions> final {
+    static inline margelo::nitro::mlxreactnative::TTSLoadOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlxreactnative::TTSLoadOptions(
+        JSIConverter<std::optional<std::function<void(double)>>>::fromJSI(runtime, obj.getProperty(runtime, "onProgress"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlxreactnative::TTSLoadOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "onProgress", JSIConverter<std::optional<std::function<void(double)>>>::toJSI(runtime, arg.onProgress));
+      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::function<void(double)>>>::canConvert(runtime, obj.getProperty(runtime, "onProgress"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-mlx",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Nitro module package",
   "main": "./lib/module/index.js",
   "module": "./lib/module/index.js",
@@ -11,14 +11,14 @@
     "build": "rm -rf lib && bun typecheck && bob build",
     "typecheck": "tsc --noEmit",
     "clean": "rm -rf android/build node_modules/**/android/build lib android/.cxx node_modules/**/android/.cxx",
-    "release": "release-it && npm publish",
+    "release": "release-it",
     "specs": "bun typecheck && nitrogen --logLevel=\\\"debug\\\" && bun run build",
     "specs:pod": "bun specs && bun --cwd ../example pod"
   },
   "keywords": [
     "react-native",
     "nitro",
-    "nitro-modile",
+    "nitro-module",
     "expo",
     "llm",
     "mlx",
@@ -82,7 +82,8 @@
     },
     "hooks": {
       "after:bump": "bun specs",
-      "before:release": "bun run build"
+      "before:release": "bun run build",
+      "after:release": "npm publish --ignore-scripts"
     },
     "git": {
       "commitMessage": "chore: release ${version}",
@@ -90,6 +91,9 @@
       "requireCleanWorkingDir": false
     },
     "plugins": {
+      "@release-it/bumper": {
+        "out": "package.json"
+      },
       "@release-it/conventional-changelog": {
         "preset": {
           "name": "conventionalcommits",

package/src/index.ts

@@ -1,4 +1,10 @@
-export { LLM, type Message, type ToolCallInfo, type ToolCallUpdate } from './llm'
+export {
+  LLM,
+  type EventCallback,
+  type Message,
+  type ToolCallInfo,
+  type ToolCallUpdate,
+} from './llm'
 export { ModelManager } from './modelManager'
 export {
   MLXModel,
@@ -7,14 +13,38 @@ export {
   type ModelInfo,
   ModelProvider,
   type ModelQuantization,
+  type ModelType,
 } from './models'
 export type {
   GenerationStats,
   LLM as LLMSpec,
   LLMLoadOptions,
+  StreamEvent,
+  GenerationStartEvent,
+  TokenEvent,
+  ThinkingStartEvent,
+  ThinkingChunkEvent,
+  ThinkingEndEvent,
+  ToolCallStartEvent,
+  ToolCallExecutingEvent,
+  ToolCallCompletedEvent,
+  ToolCallFailedEvent,
+  GenerationEndEvent,
   ToolDefinition,
   ToolParameter,
   ToolParameterType,
 } from './specs/LLM.nitro'
 export type { ModelManager as ModelManagerSpec } from './specs/ModelManager.nitro'
 export { createTool, type TypeSafeToolDefinition } from './tool-utils'
+export { TTS } from './tts'
+export type {
+  TTS as TTSSpec,
+  TTSLoadOptions,
+  TTSGenerateOptions,
+} from './specs/TTS.nitro'
+export { STT } from './stt'
+export type {
+  STT as STTSpec,
+  STTLoadOptions,
+  STTTranscriptionInfo,
+} from './specs/STT.nitro'

package/src/llm.ts

@@ -1,5 +1,12 @@
 import { NitroModules } from 'react-native-nitro-modules'
-import type { GenerationStats, LLMLoadOptions, LLM as LLMSpec } from './specs/LLM.nitro'
+import type {
+  GenerationStats,
+  LLMLoadOptions,
+  LLM as LLMSpec,
+  StreamEvent,
+} from './specs/LLM.nitro'
+
+export type EventCallback = (event: StreamEvent) => void
 
 let instance: LLMSpec | null = null
 
@@ -106,6 +113,45 @@ export const LLM = {
     })
   },
 
+  /**
+   * Stream with typed events for thinking blocks and tool calls.
+   * Provides granular lifecycle events for UI updates.
+   *
+   * @param prompt - The input text
+   * @param onEvent - Callback receiving typed StreamEvent objects
+   * @returns Promise resolving to final content string (thinking content stripped)
+   *
+   * @example
+   * ```ts
+   * await LLM.streamWithEvents(prompt, (event) => {
+   *   switch (event.type) {
+   *     case 'token':
+   *       appendToContent(event.token)
+   *       break
+   *     case 'thinking_start':
+   *       showThinkingIndicator()
+   *       break
+   *     case 'thinking_chunk':
+   *       appendToThinking(event.chunk)
+   *       break
+   *     case 'tool_call_start':
+   *       showToolCallCard(event.name, event.arguments)
+   *       break
+   *   }
+   * })
+   * ```
+   */
+  streamWithEvents(prompt: string, onEvent: EventCallback): Promise<string> {
+    return getInstance().streamWithEvents(prompt, (eventJson: string) => {
+      try {
+        const event = JSON.parse(eventJson) as StreamEvent
+        onEvent(event)
+      } catch {
+        // Silently ignore malformed events
+      }
+    })
+  },
+
   /**
    * Stop the current generation. Safe to call even if not generating.
    */
@@ -123,7 +169,7 @@ export const LLM = {
 
   /**
    * Get statistics from the last generation.
-   * @returns Statistics including token count, tokens/sec, TTFT, and total time
+   * @returns Statistics including token count, tokens/sec (excluding tool execution), TTFT, total time, and tool execution time
    */
   getLastGenerationStats(): GenerationStats {
     return getInstance().getLastGenerationStats()