react-native-litert-lm 0.3.6 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.md +207 -158
  2. package/android/build.gradle +12 -0
  3. package/android/src/main/AndroidManifest.xml +5 -0
  4. package/android/src/main/java/com/margelo/nitro/dev/litert/litertlm/HybridLiteRTLM.kt +316 -63
  5. package/android/src/main/java/dev/litert/litertlm/LiteRTLMPackage.kt +19 -2
  6. package/android/src/test/java/com/margelo/nitro/core/Promise.kt +46 -0
  7. package/android/src/test/java/com/margelo/nitro/dev/litert/litertlm/HybridLiteRTLMTest.kt +83 -0
  8. package/cpp/include/README.md +9 -11
  9. package/ios/HybridLiteRTLM.swift +1058 -0
  10. package/ios/Tests/HybridLiteRTLMTests.swift +67 -0
  11. package/lib/__mocks__/react-native-nitro-modules.d.ts +61 -0
  12. package/lib/__mocks__/react-native-nitro-modules.js +50 -0
  13. package/lib/__tests__/hooks.test.d.ts +1 -0
  14. package/lib/__tests__/hooks.test.js +124 -0
  15. package/lib/__tests__/memoryTracker.test.d.ts +1 -0
  16. package/lib/__tests__/memoryTracker.test.js +74 -0
  17. package/lib/__tests__/modelFactory.test.d.ts +1 -0
  18. package/lib/__tests__/modelFactory.test.js +52 -0
  19. package/lib/hooks.js +1 -1
  20. package/lib/index.d.ts +2 -4
  21. package/lib/index.js +12 -7
  22. package/lib/modelFactory.js +62 -63
  23. package/lib/specs/LiteRTLM.nitro.d.ts +71 -2
  24. package/nitrogen/generated/android/c++/JHybridLiteRTLMSpec.cpp +62 -7
  25. package/nitrogen/generated/android/c++/JHybridLiteRTLMSpec.hpp +3 -1
  26. package/nitrogen/generated/android/c++/JLLMConfig.hpp +40 -3
  27. package/nitrogen/generated/android/c++/JMultimodalPart.hpp +74 -0
  28. package/nitrogen/generated/android/c++/JPartType.hpp +61 -0
  29. package/nitrogen/generated/android/c++/JToolDefinition.hpp +65 -0
  30. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/GenerationStats.kt +23 -0
  31. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/HybridLiteRTLMSpec.kt +10 -2
  32. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/LLMConfig.kt +46 -3
  33. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/MemoryUsage.kt +19 -0
  34. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/Message.kt +15 -0
  35. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/MultimodalPart.kt +66 -0
  36. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/PartType.kt +24 -0
  37. package/nitrogen/generated/android/kotlin/com/margelo/nitro/dev/litert/litertlm/ToolDefinition.kt +61 -0
  38. package/nitrogen/generated/ios/LiteRTLM-Swift-Cxx-Bridge.cpp +57 -1
  39. package/nitrogen/generated/ios/LiteRTLM-Swift-Cxx-Bridge.hpp +414 -3
  40. package/nitrogen/generated/ios/LiteRTLM-Swift-Cxx-Umbrella.hpp +41 -3
  41. package/nitrogen/generated/ios/LiteRTLMAutolinking.mm +4 -6
  42. package/nitrogen/generated/ios/LiteRTLMAutolinking.swift +10 -0
  43. package/nitrogen/generated/ios/c++/HybridLiteRTLMSpecSwift.cpp +11 -0
  44. package/nitrogen/generated/ios/c++/HybridLiteRTLMSpecSwift.hpp +224 -0
  45. package/nitrogen/generated/ios/swift/Backend.swift +44 -0
  46. package/nitrogen/generated/ios/swift/Func_void.swift +46 -0
  47. package/nitrogen/generated/ios/swift/Func_void_double.swift +46 -0
  48. package/nitrogen/generated/ios/swift/Func_void_std__exception_ptr.swift +46 -0
  49. package/nitrogen/generated/ios/swift/Func_void_std__string.swift +46 -0
  50. package/nitrogen/generated/ios/swift/Func_void_std__string_bool.swift +46 -0
  51. package/nitrogen/generated/ios/swift/GenerationStats.swift +54 -0
  52. package/nitrogen/generated/ios/swift/HybridLiteRTLMSpec.swift +69 -0
  53. package/nitrogen/generated/ios/swift/HybridLiteRTLMSpec_cxx.swift +383 -0
  54. package/nitrogen/generated/ios/swift/LLMConfig.swift +203 -0
  55. package/nitrogen/generated/ios/swift/MemoryUsage.swift +44 -0
  56. package/nitrogen/generated/ios/swift/Message.swift +34 -0
  57. package/nitrogen/generated/ios/swift/MultimodalPart.swift +83 -0
  58. package/nitrogen/generated/ios/swift/PartType.swift +44 -0
  59. package/nitrogen/generated/ios/swift/Role.swift +44 -0
  60. package/nitrogen/generated/ios/swift/ToolDefinition.swift +39 -0
  61. package/nitrogen/generated/shared/c++/HybridLiteRTLMSpec.cpp +2 -0
  62. package/nitrogen/generated/shared/c++/HybridLiteRTLMSpec.hpp +7 -2
  63. package/nitrogen/generated/shared/c++/LLMConfig.hpp +22 -2
  64. package/nitrogen/generated/shared/c++/MultimodalPart.hpp +99 -0
  65. package/nitrogen/generated/shared/c++/PartType.hpp +80 -0
  66. package/nitrogen/generated/shared/c++/ToolDefinition.hpp +91 -0
  67. package/package.json +16 -8
  68. package/react-native-litert-lm.podspec +15 -19
  69. package/scripts/download-ios-frameworks.sh +14 -48
  70. package/scripts/postinstall.js +1 -2
  71. package/src/__mocks__/react-native-nitro-modules.ts +48 -0
  72. package/src/__tests__/hooks.test.ts +153 -0
  73. package/src/__tests__/memoryTracker.test.ts +87 -0
  74. package/src/__tests__/modelFactory.test.ts +68 -0
  75. package/src/hooks.ts +1 -1
  76. package/src/index.ts +12 -9
  77. package/src/modelFactory.ts +82 -80
  78. package/src/specs/LiteRTLM.nitro.ts +80 -2
  79. package/cpp/HybridLiteRTLM.cpp +0 -838
  80. package/cpp/HybridLiteRTLM.hpp +0 -167
  81. package/cpp/IOSDownloadHelper.h +0 -24
  82. package/ios/IOSDownloadHelper.mm +0 -129
  83. package/scripts/build-ios-engine.sh +0 -302
  84. package/scripts/stubs/cxx_bridge_stubs.cc +0 -224
  85. package/scripts/stubs/gemma_model_constraint_provider.cc +0 -46
  86. package/scripts/stubs/llguidance_stubs.c +0 -101
  87. package/src/templates.ts +0 -105
@@ -0,0 +1,83 @@
1
+ package com.margelo.nitro.dev.litert.litertlm
2
+
3
+ import org.junit.Assert.*
4
+ import org.junit.Before
5
+ import org.junit.After
6
+ import org.junit.Test
7
+ import org.junit.runner.RunWith
8
+ import org.robolectric.RobolectricTestRunner
9
+ import org.robolectric.RuntimeEnvironment
10
+ import dev.litert.litertlm.LiteRTLMInitProvider
11
+ import java.lang.IllegalArgumentException
12
+
13
+ @RunWith(RobolectricTestRunner::class)
14
+ class HybridLiteRTLMTest {
15
+ private lateinit var bridge: HybridLiteRTLM
16
+
17
+ @Before
18
+ fun setUp() {
19
+ // Initialize the static applicationContext inside LiteRTLMInitProvider via reflection
20
+ try {
21
+ val field = LiteRTLMInitProvider::class.java.getDeclaredField("applicationContext")
22
+ field.isAccessible = true
23
+ field.set(null, RuntimeEnvironment.getApplication())
24
+ } catch (e: Exception) {
25
+ e.printStackTrace()
26
+ }
27
+
28
+ bridge = HybridLiteRTLM()
29
+ }
30
+
31
+ @After
32
+ fun tearDown() {
33
+ bridge.close()
34
+ }
35
+
36
+ @Test
37
+ fun testAndroidPathTraversalPrevention() {
38
+ val traversals = arrayOf("../secret", "/etc/hosts", "nested\\..\\file", "..", "../", "..\\")
39
+ for (traversal in traversals) {
40
+ val promise = bridge.deleteModel(traversal)
41
+ assertNotNull("Promise should not be null", promise)
42
+ assertTrue("Promise should be completed", promise.isCompleted)
43
+ assertNotNull("Promise should have rejected with an error for filename: $traversal", promise.error)
44
+ val error = promise.error!!
45
+ val errMsg = error.message ?: error.cause?.message ?: ""
46
+ assertTrue("Expected message to contain traversal warning, got: $errMsg",
47
+ errMsg.contains("path traversal or directory separators are not allowed"))
48
+ }
49
+ }
50
+
51
+ @Test
52
+ fun testAndroidHTTPSDownloadEnforcement() {
53
+ val promise = bridge.downloadModel("http://insecure.site/model.bin", "model.bin", null)
54
+ assertNotNull("Promise should not be null", promise)
55
+ assertTrue("Promise should be completed", promise.isCompleted)
56
+ assertNotNull("Promise should have rejected with an error", promise.error)
57
+ val error = promise.error!!
58
+ val errMsg = error.message ?: error.cause?.message ?: ""
59
+ assertTrue("Expected message to contain HTTPS warning, got: $errMsg",
60
+ errMsg.contains("HTTPS is required for security"))
61
+ }
62
+
63
+ @Test
64
+ fun testAndroidMemoryTelemetry() {
65
+ val mem = bridge.getMemoryUsage()
66
+ assertNotNull(mem)
67
+ assertTrue(mem.nativeHeapBytes >= 0.0)
68
+ assertTrue(mem.residentBytes >= 0.0)
69
+ assertTrue(mem.availableMemoryBytes >= 0.0)
70
+ }
71
+
72
+ @Test
73
+ fun testAndroidInitialStats() {
74
+ val stats = bridge.getStats()
75
+ assertNotNull(stats)
76
+ assertEquals(0.0, stats.promptTokens, 0.0)
77
+ assertEquals(0.0, stats.completionTokens, 0.0)
78
+ assertEquals(0.0, stats.totalTokens, 0.0)
79
+ assertEquals(0.0, stats.timeToFirstToken, 0.0)
80
+ assertEquals(0.0, stats.totalTime, 0.0)
81
+ assertEquals(0.0, stats.tokensPerSecond, 0.0)
82
+ }
83
+ }
@@ -1,34 +1,32 @@
1
1
  # LiteRT-LM Headers Fallback
2
2
 
3
- This directory is a fallback location for LiteRT-LM C++ headers when Prefab doesn't expose them correctly.
3
+ This directory contains the LiteRT-LM C API header (`litert_lm_engine.h`) used by the iOS C++ implementation.
4
4
 
5
5
  ## If Headers Are Missing
6
6
 
7
- If you get compilation errors like `litert/lm/engine.h: No such file or directory`, you need to manually copy LiteRT-LM headers here:
7
+ If you get compilation errors like `litert_lm_engine.h: No such file or directory`, you need to manually copy the LiteRT-LM C API header here:
8
8
 
9
9
  1. Clone LiteRT-LM repository:
10
10
 
11
11
  ```bash
12
12
  git clone https://github.com/google-ai-edge/LiteRT-LM.git /tmp/LiteRT-LM
13
+ cd /tmp/LiteRT-LM && git checkout v0.10.2
13
14
  ```
14
15
 
15
- 2. Copy the headers:
16
+ 2. Copy the header:
16
17
  ```bash
17
- cp -r /tmp/LiteRT-LM/runtime/include/litert ./
18
+ cp /tmp/LiteRT-LM/c/litert_lm_engine.h ./
18
19
  ```
19
20
 
20
21
  The expected directory structure after copying:
21
22
 
22
23
  ```
23
24
  cpp/include/
24
- └── litert/
25
- └── lm/
26
- ├── engine.h
27
- ├── conversation.h
28
- ├── types.h
29
- └── ...
25
+ ├── litert_lm_engine.h # LiteRT-LM C API header
26
+ ├── stb_image.h # Image loading for multimodal
27
+ └── README.md
30
28
  ```
31
29
 
32
30
  ## Note
33
31
 
34
- The ideal scenario is that the Maven package `litertlm-android:0.9.0-alpha01` exposes headers via Prefab, making this directory unnecessary. This is just a fallback.
32
+ On **Android**, headers are provided by the `litertlm-android` AAR via Prefab this directory is only needed for the **iOS** build which uses the raw C API via the prebuilt XCFramework.