react-native-nitro-sqlite-vec 9.7.0 → 9.8.1

package/README.md

@@ -0,0 +1,60 @@
+# react-native-nitro-sqlite-vec
+
+Opt-in [sqlite-vec](https://github.com/asg017/sqlite-vec) support for [`react-native-nitro-sqlite`](https://github.com/margelo/react-native-nitro-sqlite). sqlite-vec is statically linked into the core package's SQLite build, so it does not load an extension at runtime.
+
+## Installation
+
+Install both this package and `react-native-nitro-sqlite`, then enable the native build flag.
+
+```bash
+npm install react-native-nitro-sqlite react-native-nitro-sqlite-vec
+```
+
+- **iOS:**
+  ```bash
+  NITRO_SQLITE_VEC=1 npx pod-install
+  ```
+- **Android:** add this to `android/gradle.properties` and rebuild:
+  ```properties
+  nitroSqliteVec=true
+  ```
+
+`isVecAvailable()` returns `false` when the native flag was not enabled.
+
+## API
+
+```ts
+import { open } from 'react-native-nitro-sqlite'
+import {
+  createVectorTable,
+  isVecAvailable,
+  knnSearch,
+  vecVersion,
+} from 'react-native-nitro-sqlite-vec'
+
+const db = open({ name: 'vectors.sqlite' })
+
+if (!isVecAvailable(db)) {
+  throw new Error('Enable sqlite-vec in the native build first')
+}
+
+console.log(vecVersion(db))
+createVectorTable(db, 'embeddings', {
+  dimensions: 3,
+  type: 'float', // 'float' (default), 'int8', or 'bit'
+  distanceMetric: 'L2', // 'L2' (default), 'cosine', or 'L1'
+  column: 'embedding', // default
+})
+
+db.execute('INSERT INTO embeddings (rowid, embedding) VALUES (?, ?)', [
+  1,
+  '[0.1, 0.2, 0.3]',
+])
+
+const matches = knnSearch(db, 'embeddings', [0.1, 0.2, 0.25], 10)
+// [{ rowid: 1, distance: 0.05... }]
+```
+
+`knnSearch()` accepts a JSON vector string or a `number[]` and returns rows containing `rowid`, `distance`, and any selected columns. `createVectorTable()` and `knnSearch()` interpolate table and column identifiers into SQL, so only pass trusted identifiers.
+
+For the core SQLite API, see the [repository README](../../README.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-sqlite-vec",
-  "version": "9.7.0",
+  "version": "9.8.1",
   "description": "Vector search (sqlite-vec) for react-native-nitro-sqlite. Native sqlite-vec is statically linked into the core's single sqlite3 — no second SQLite, no runtime extension loading.",
   "source": "./src/index",
   "react-native": "./src/index",
@@ -8,13 +8,15 @@
   "types": "./src/index",
   "files": [
     "src",
+    "!**/__tests__",
     "cpp",
     "RNNitroSqliteVec.podspec",
     "react-native.config.js",
     "README.md"
   ],
   "scripts": {
-    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "typecheck": "tsc --build",
     "lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
     "release": "release-it",
     "prepublishOnly": "bun typecheck"
@@ -42,9 +44,27 @@
     "react-native-nitro-sqlite": ">=9.0.0"
   },
   "devDependencies": {
-    "react-native-nitro-sqlite": "9.7.0",
+    "react-native-nitro-sqlite": "9.8.1",
     "typescript": "^5.8.3"
   },
+  "jest": {
+    "preset": "@react-native/jest-preset",
+    "watchman": false,
+    "testMatch": [
+      "<rootDir>/src/__tests__/**/*.test.ts"
+    ],
+    "collectCoverageFrom": [
+      "src/index.ts"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100,
+        "statements": 100
+      }
+    }
+  },
   "release-it": {
     "npm": {
       "publish": true,