react-native-nitro-mlx 0.2.2 → 0.4.0

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/nitrogen/generated/shared/c++/ToolDefinition.hpp

@@ -0,0 +1,93 @@
+///
+/// ToolDefinition.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
+
+// Forward declaration of `ToolParameter` to properly resolve imports.
+namespace margelo::nitro::mlxreactnative { struct ToolParameter; }
+
+#include <string>
+#include "ToolParameter.hpp"
+#include <vector>
+#include <NitroModules/AnyMap.hpp>
+#include <NitroModules/Promise.hpp>
+#include <functional>
+
+namespace margelo::nitro::mlxreactnative {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ToolDefinition).
+   */
+  struct ToolDefinition {
+  public:
+    std::string name     SWIFT_PRIVATE;
+    std::string description     SWIFT_PRIVATE;
+    std::vector<ToolParameter> parameters     SWIFT_PRIVATE;
+    std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::shared_ptr<AnyMap>>>>>(const std::shared_ptr<AnyMap>& /* args */)> handler     SWIFT_PRIVATE;
+
+  public:
+    ToolDefinition() = default;
+    explicit ToolDefinition(std::string name, std::string description, std::vector<ToolParameter> parameters, std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::shared_ptr<AnyMap>>>>>(const std::shared_ptr<AnyMap>& /* args */)> handler): name(name), description(description), parameters(parameters), handler(handler) {}
+  };
+
+} // namespace margelo::nitro::mlxreactnative
+
+namespace margelo::nitro {
+
+  // C++ ToolDefinition <> JS ToolDefinition (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlxreactnative::ToolDefinition> final {
+    static inline margelo::nitro::mlxreactnative::ToolDefinition fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlxreactnative::ToolDefinition(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, "name")),
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, "description")),
+        JSIConverter<std::vector<margelo::nitro::mlxreactnative::ToolParameter>>::fromJSI(runtime, obj.getProperty(runtime, "parameters")),
+        JSIConverter<std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::shared_ptr<AnyMap>>>>>(const std::shared_ptr<AnyMap>&)>>::fromJSI(runtime, obj.getProperty(runtime, "handler"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlxreactnative::ToolDefinition& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "name", JSIConverter<std::string>::toJSI(runtime, arg.name));
+      obj.setProperty(runtime, "description", JSIConverter<std::string>::toJSI(runtime, arg.description));
+      obj.setProperty(runtime, "parameters", JSIConverter<std::vector<margelo::nitro::mlxreactnative::ToolParameter>>::toJSI(runtime, arg.parameters));
+      obj.setProperty(runtime, "handler", JSIConverter<std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::shared_ptr<AnyMap>>>>>(const std::shared_ptr<AnyMap>&)>>::toJSI(runtime, arg.handler));
+      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::string>::canConvert(runtime, obj.getProperty(runtime, "name"))) return false;
+      if (!JSIConverter<std::string>::canConvert(runtime, obj.getProperty(runtime, "description"))) return false;
+      if (!JSIConverter<std::vector<margelo::nitro::mlxreactnative::ToolParameter>>::canConvert(runtime, obj.getProperty(runtime, "parameters"))) return false;
+      if (!JSIConverter<std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::shared_ptr<AnyMap>>>>>(const std::shared_ptr<AnyMap>&)>>::canConvert(runtime, obj.getProperty(runtime, "handler"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-mlx",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Nitro module package",
   "main": "./lib/module/index.js",
   "module": "./lib/module/index.js",
@@ -18,7 +18,7 @@
   "keywords": [
     "react-native",
     "nitro",
-    "nitro-modile",
+    "nitro-module",
     "expo",
     "llm",
     "mlx",
@@ -68,20 +68,22 @@
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
-    "react-native-nitro-modules": "*"
+    "react-native-nitro-modules": "*",
+    "zod": ">=4.0.0"
+  },
+  "dependencies": {
+    "zod": "^4.3.5"
   },
   "release-it": {
-    "npm": {
-      "publish": true,
-      "skipVersion": true
-    },
+    "npm": false,
     "github": {
       "release": true,
       "releaseName": "v${version}"
     },
     "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}",
@@ -89,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 } from './llm'
+export {
+  LLM,
+  type EventCallback,
+  type Message,
+  type ToolCallInfo,
+  type ToolCallUpdate,
+} from './llm'
 export { ModelManager } from './modelManager'
 export {
   MLXModel,
@@ -7,7 +13,38 @@ export {
   type ModelInfo,
   ModelProvider,
   type ModelQuantization,
+  type ModelType,
 } from './models'
-
-export type { GenerationStats, LLM as LLMSpec, LLMLoadOptions } from './specs/LLM.nitro'
+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
 
@@ -8,6 +15,16 @@ export type Message = {
   content: string
 }
 
+export type ToolCallInfo = {
+  name: string
+  arguments: Record<string, unknown>
+}
+
+export type ToolCallUpdate = {
+  toolCall: ToolCallInfo
+  allToolCalls: ToolCallInfo[]
+}
+
 function getInstance(): LLMSpec {
   if (!instance) {
     instance = NitroModules.createHybridObject<LLMSpec>('LLM')
@@ -58,13 +75,81 @@ export const LLM = {
   },
 
   /**
-   * Stream a response token by token.
+   * Stream a response token by token with optional tool calling support.
+   * Tools must be provided when loading the model via `load()` options.
+   * Tools are automatically executed when the model calls them.
    * @param prompt - The input text to generate a response for
    * @param onToken - Callback invoked for each generated token
+   * @param onToolCall - Optional callback invoked when a tool is called.
+   *   Receives the current tool call and an accumulated array of all tool calls so far.
    * @returns The complete generated text
    */
-  stream(prompt: string, onToken: (token: string) => void): Promise<string> {
-    return getInstance().stream(prompt, onToken)
+  stream(
+    prompt: string,
+    onToken: (token: string) => void,
+    onToolCall?: (update: ToolCallUpdate) => void,
+  ): Promise<string> {
+    const accumulatedToolCalls: ToolCallInfo[] = []
+
+    return getInstance().stream(prompt, onToken, (name: string, argsJson: string) => {
+      if (onToolCall) {
+        try {
+          const args = JSON.parse(argsJson) as Record<string, unknown>
+          const toolCall = { name, arguments: args }
+          accumulatedToolCalls.push(toolCall)
+          onToolCall({
+            toolCall,
+            allToolCalls: [...accumulatedToolCalls],
+          })
+        } catch {
+          const toolCall = { name, arguments: {} }
+          accumulatedToolCalls.push(toolCall)
+          onToolCall({
+            toolCall,
+            allToolCalls: [...accumulatedToolCalls],
+          })
+        }
+      }
+    })
+  },
+
+  /**
+   * 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
+      }
+    })
   },
 
   /**
@@ -84,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()