@xybrid/react-native 0.10.0-rc1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Xybrid, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,298 @@
+# @xybrid/react-native
+
+On-device AI for React Native — LLMs, speech recognition, text-to-speech,
+embeddings and vision — backed by the same Rust SDK as Xybrid's Swift, Kotlin,
+Flutter and Unity bindings. Runs offline with no account; add an API key to
+light up cloud fallback and telemetry.
+
+```ts
+import { Envelope, ModelLoader } from '@xybrid/react-native';
+
+const model = await ModelLoader.fromRegistry('qwen3.5-0.8b').load();
+const result = await model.run(Envelope.text('Write a haiku about the sea.'));
+console.log(result.text);
+await model.release();
+```
+
+> **Status: preview.** The API mirrors the Swift and Kotlin SDKs and is
+> covered by tests on every change, but it may still move before 1.0.
+
+## Requirements
+
+| | |
+|---|---|
+| React Native | 0.76 or newer, **New Architecture** (the default since 0.76; the only option since 0.82) |
+| iOS | 16.0+. Simulator builds need an Apple Silicon Mac (there is no x86_64 simulator slice) |
+| Android | API 24+, `arm64-v8a`, `armeabi-v7a`, `x86_64` |
+| Expo | SDK 52+ with a [development build](https://docs.expo.dev/develop/development-builds/introduction/) — not Expo Go |
+
+## Install
+
+```sh
+npm install @xybrid/react-native
+cd ios && pod install
+```
+
+- **iOS** — `pod install` downloads the Rust core (`XybridFFI.xcframework`)
+  from this version's GitHub Release, checks it against the SHA-256 pinned in
+  the package, and caches it in `~/.xybrid/cache/xcframework`. Behind a proxy or
+  offline, point `XYBRID_NATIVES_BASE_URL` at a mirror, or
+  `XYBRID_XCFRAMEWORK_PATH` at a local copy (directory or `.zip`). If your app
+  targets iOS below 16.0, raise it in the Podfile (`platform :ios, '16.0'`).
+- **Android** — nothing to do: Gradle pulls `ai.xybrid:xybrid-kotlin` (the
+  Kotlin SDK with the native libraries) from Maven Central.
+- **Expo** — `npx expo install @xybrid/react-native`, then
+  `npx expo prebuild` / `npx expo run:ios|android`. No config plugin needed.
+
+## Quick tour
+
+### Configure (optional)
+
+Local inference needs no setup. Call `initialize` first only when you have
+options — an API key enables the platform features on top of the same local
+runtime: cloud fallback, speculative cloud serving and dashboard telemetry.
+
+```ts
+import { Xybrid } from '@xybrid/react-native';
+
+await Xybrid.initialize({ apiKey: XYBRID_API_KEY });
+```
+
+Options apply once per app process; calling again with different options
+rejects with `xybrid_config_error` (restart the app to change them).
+
+### Load and run
+
+```ts
+import { Envelope, GenerationConfigs, ModelLoader } from '@xybrid/react-native';
+
+const model = await ModelLoader.fromRegistry('qwen3.5-0.8b').load();
+await model.warmup(); // optional: pay cold start now, not on the first run
+
+const result = await model.run(Envelope.text('Summarise: …'), {
+  generationConfig: GenerationConfigs.greedy({ maxTokens: 128 }),
+});
+result.text;              // the answer
+result.reasoningContent;  // <think> text, if the model emitted any
+result.metrics;           // totalMs, ttftMs, tokensPerSecond, …
+result.executionTarget;   // 'local' or 'cloud'
+```
+
+Other sources: `ModelLoader.fromBundle(path)`, `fromDirectory(path)`,
+`fromHuggingFace('org/repo', { revision })`, `fromModelFile('model.gguf')`
+(`file://` URLs work too). `model.info()` returns the model id, output type
+and capabilities; `model.unload()` frees the weights but keeps the handle;
+`model.release()` frees everything.
+
+### Stream tokens, with a stop button
+
+```ts
+const controller = new AbortController();
+
+for await (const token of model.runStreaming(Envelope.text('Tell me a story'), {
+  signal: controller.signal,
+})) {
+  setText((previous) => previous + token.token);
+}
+// Elsewhere (a Stop button, unmount): controller.abort();
+```
+
+Generation stops natively when the loop ends — completion, `break`, an
+error, or `abort()`. An aborted run rejects with `xybrid_cancelled`. A loop that
+is simply abandoned is never cleaned up (JavaScript runs no `finally` on
+garbage collection), so abort on unmount. The final `InferenceResult` is the
+generator's return value.
+
+### Conversations
+
+```ts
+import { ConversationContext, Envelope } from '@xybrid/react-native';
+
+const chat = await ConversationContext.create();
+await chat.setSystem('You are concise.');
+
+const question = Envelope.user('What is the capital of France?');
+const reply = await model.run(question, { context: chat });
+await chat.push(question);       // the run never changes the context:
+await chat.push(reply.envelope); // push both turns yourself, after the run
+```
+
+### Structured output
+
+```ts
+import { jsonSchemaToGbnf } from '@xybrid/react-native';
+
+const grammar = await jsonSchemaToGbnf({
+  type: 'object',
+  properties: { name: { type: 'string' }, total: { type: 'number' } },
+  required: ['name', 'total'],
+});
+const result = await model.run(Envelope.text('Extract: 2x espresso, 8.40 EUR'), {
+  generationConfig: { grammar, maxTokens: 128 },
+});
+JSON.parse(result.text!);
+```
+
+### Tool calling
+
+One `run` is one model turn; the loop is yours.
+
+```ts
+const tools = [{ name: 'weather', description: 'Current weather', parameters: { type: 'object', properties: { city: { type: 'string' } } } }];
+const prompt = 'Weather in Paris?';
+
+const first = await model.run(Envelope.text(prompt), { generationConfig: { tools } });
+if (first.toolCalls.length > 0) {
+  const results = await Promise.all(first.toolCalls.map(async (call) => ({
+    callId: call.id,
+    name: call.name,
+    content: await runTool(call.name, JSON.parse(call.argumentsJson)),
+  })));
+  const next = await Envelope.toolResults(prompt, first.text ?? '', results);
+  const answer = await model.run(next, { generationConfig: { tools } });
+}
+```
+
+When streaming, the terminal token carries `toolCalls` and `rawText` (use
+`rawText` as `priorAssistantText`).
+
+### Vision
+
+```ts
+const message = Envelope.userMessage('What is in this photo?', [
+  Envelope.image(photoBase64, 'jpeg'),
+]);
+const result = await visionModel.run(message);
+```
+
+### Text-to-speech
+
+```ts
+const tts = await ModelLoader.fromRegistry('kokoro-82m').load();
+const voices = await tts.voices();
+const speech = await tts.run(Envelope.text('Hello!', { voiceId: voices[0].id, speed: 1.1 }));
+speech.audioBytesBase64; // WAV/PCM, base64
+```
+
+### Speech recognition
+
+Batch — transcribe a recording:
+
+```ts
+const asr = await ModelLoader.fromRegistry('whisper-tiny-ggml').load();
+const { text } = await asr.run(Envelope.audio(wavBase64)); // 16 kHz mono by default
+```
+
+Live — feed microphone audio as it arrives (Float32, mono, 16 kHz):
+
+```ts
+const session = await asr.stream({ language: 'en' });
+(async () => {
+  for await (const partial of session.partials()) setCaption(partial.text);
+})();
+await session.feed(float32Samples);       // from your audio callback
+const transcript = await session.flush(); // when the user stops talking
+await session.release();
+```
+
+### Pipelines
+
+```ts
+import { Pipeline } from '@xybrid/react-native';
+
+const pipeline = await Pipeline.fromFile(`${documentDirectory}voice-assistant.yaml`);
+const result = await pipeline.run(Envelope.audio(recordingBase64));
+const heard = result.stages.find((stage) => stage.stageId === 'asr')?.text;
+play(result.audioBytesBase64);
+```
+
+### Downloads, speculative cloud, cache and memory
+
+```ts
+// Download with a progress bar, then load instantly from cache.
+const loader = ModelLoader.fromRegistry('qwen3.5-0.8b');
+const download = await loader.download();
+for await (const status of download!.progress()) setProgress(status.progress);
+const model = await loader.load();
+
+// Answer from the cloud while the weights download (needs an API key).
+const fast = await ModelLoader.fromRegistrySpeculative('qwen3.5-0.8b').load();
+await fast.isCloudServing(); // true until the local weights land
+
+await Xybrid.modelCacheStatus();       // bytes and models on disk
+await Xybrid.removeCachedModel('qwen3.5-0.8b');
+Xybrid.releaseMemoryOnWarning();       // free idle models on OS memory warnings
+```
+
+### Errors
+
+Every rejection has a stable `code` (`XybridErrorCodes` lists them):
+
+```ts
+import { isRetryable, isXybridError } from '@xybrid/react-native';
+
+try {
+  await model.run(envelope);
+} catch (error) {
+  if (isXybridError(error) && error.code === 'xybrid_model_not_found') { /* … */ }
+  if (isRetryable(error)) { /* network, rate limit, timeout, offline */ }
+}
+```
+
+`xybrid_handle` means the object was released; `xybrid_invalid_argument`
+means a malformed argument (bad envelope, options, base64).
+
+## How it works
+
+```
+JS / TS (src/) ── TurboModule (src/NativeXybrid.ts, Codegen)
+  ├── iOS      ios/XybridModule.mm → XybridModuleImpl.swift → Swift SDK (Xybrid.swift) ─┐
+  └── Android  XybridModule.kt → Kotlin SDK (ai.xybrid:xybrid-kotlin)                 ─┤
+                                                                   xybrid-bolt (BoltFFI)
+                                                                   → xybrid-ffi-facade → xybrid-sdk → xybrid-core
+```
+
+- Native objects (models, contexts, streams, sessions…) are opaque handles in
+  one registry per platform; `release()` frees them, and a model's release
+  also stops the streams started from it.
+- Envelopes cross as a payload plus string metadata, exactly like the Rust
+  type; convenience fields (`voiceId`, `sampleRate`, `role`…) are folded in on
+  the JS side (`src/wire.ts`), so both native shims stay generic.
+- Binary payloads (audio, images) cross as base64 strings: TurboModules have no
+  zero-copy buffer type. Fine for prompts, clips and TTS output; a JSI buffer
+  path is on the roadmap for high-rate audio.
+
+## Developing in this repo
+
+```sh
+npm install && npm test          # types, unit tests, spec conformance, SDK parity
+npm run test:ios                 # Swift type-check + codec tests (macOS, Xcode)
+npm run test:android             # Kotlin codec tests on the JVM (kotlinc + java)
+```
+
+Run the example app (`example/`) against the working tree:
+
+```sh
+# iOS: build the Rust core; `pod install` picks up bazel-bin automatically.
+bazel build --config=ios //bindings/apple:XybridFFI
+cd example && npm install && npx expo run:ios
+
+# Android: build the AAR, publish the Kotlin SDK to mavenLocal (the example
+# prefers mavenLocal), then run.
+bazel build -c opt --config=remote //bindings/kotlin:xybrid_kotlin_aar
+#   stage its jni/* into bindings/kotlin/libs/ — see bindings/kotlin/README.md
+(cd ../kotlin && ./gradlew publishToMavenLocal)
+cd example && npm install && npx expo run:android
+```
+
+The example runs a smoke test on launch and logs each step with a
+`[xybrid-smoke]` prefix.
+
+**Adding SDK surface.** `tests/parity.test.mjs` reads every export of
+`crates/xybrid-bolt/src/lib.rs` and fails until each new function, method,
+field, enum variant or error variant is mapped in `parity.json` (or excluded
+with a reason). To map one: add the method to `src/NativeXybrid.ts`, implement
+it in `ios/XybridModuleImpl.swift` (+ its forwarder in `ios/XybridModule.mm`)
+and `android/.../XybridModule.kt`, expose it in `src/`, and record it in
+`parity.json`. `tests/spec-conformance.test.mjs` checks the iOS selectors and
+Kotlin overrides against the spec.

package/android/build.gradle

@@ -0,0 +1,61 @@
+// The Android half of @xybrid/react-native: a TurboModule (XybridModule.kt)
+// over the Kotlin SDK. The SDK — Kotlin classes plus libxybrid_bolt.so and the
+// ONNX Runtime — comes from the `ai.xybrid:xybrid-kotlin` AAR on Maven
+// Central, so nothing native is built or staged here.
+
+buildscript {
+  ext.xybridExt = { name, fallback ->
+    rootProject.ext.has(name) ? rootProject.ext.get(name) : fallback
+  }
+  repositories {
+    google()
+    mavenCentral()
+  }
+  dependencies {
+    // The host app's versions win when it already has these on its classpath.
+    classpath "com.android.tools.build:gradle:8.7.3"
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${xybridExt('kotlinVersion', '2.0.21')}"
+  }
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+// Runs Codegen for this library's spec (`codegenConfig` in package.json):
+// generates the `NativeXybridSpec` base class XybridModule extends, and the
+// `react_codegen_RNXybridSpec` JNI target autolinking wires into the app.
+// The host app's settings.gradle makes the plugin available.
+apply plugin: "com.facebook.react"
+
+android {
+  namespace "ai.xybrid.reactnative"
+  compileSdkVersion xybridExt("compileSdkVersion", 35)
+
+  defaultConfig {
+    minSdkVersion xybridExt("minSdkVersion", 24)
+    targetSdkVersion xybridExt("targetSdkVersion", 35)
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
+  }
+
+  kotlinOptions {
+    jvmTarget = "17"
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  // Versioned by the host app's React Native Gradle plugin.
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3"
+
+  // The Kotlin SDK. Kept in lockstep with the workspace version by
+  // tools/scripts/version-sync.sh (`just bump-version`).
+  implementation "ai.xybrid:xybrid-kotlin:0.10.0-rc1"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />