vectlite 0.1.4 → 0.1.8

package/README.md

@@ -126,9 +126,11 @@ try {
 ### Text Helpers
 
 ```js
-// Handles embedding + sparse term generation for you
-vectlite.upsertText(db, 'doc1', 'Auth setup guide', embedFn, { source: 'docs' })
-const results = vectlite.searchText(db, 'how to authenticate', embedFn, { k: 5 })
+async function run() {
+  // embedFn can be sync or async
+  await vectlite.upsertText(db, 'doc1', 'Auth setup guide', embedFn, { source: 'docs' })
+  const results = await vectlite.searchText(db, 'how to authenticate', embedFn, { k: 5 })
+}
 ```
 
 ### Snapshots & Backup
@@ -191,6 +193,7 @@ console.log(outcome.results[0].explain) // Detailed scoring breakdown
 
 ## Links
 
+- [Official Documentation](https://vectlite.mcsedition.org/)
 - [GitHub Repository](https://github.com/mcsedition-hub/vectlite)
 - [Issue Tracker](https://github.com/mcsedition-hub/vectlite/issues)
 - [PyPI Package](https://pypi.org/project/vectlite/)

package/index.d.ts

@@ -10,6 +10,9 @@ export type Metadata = { [key: string]: MetadataValue }
 export type SparseVector = { [term: string]: number }
 export type NamedVectors = { [name: string]: number[] }
 export type Filter = { [key: string]: unknown }
+export type TextEmbedding = ArrayLike<number>
+export type TextEmbeddingResult = TextEmbedding | Promise<TextEmbedding>
+export type TextEmbedder = (text: string) => TextEmbeddingResult
 
 export interface Record {
   namespace: string
@@ -164,19 +167,39 @@ export function upsertText(
   db: Database,
   id: string,
   text: string,
-  embed: (text: string) => ArrayLike<number>,
+  embed: (text: string) => TextEmbedding,
   metadata?: Metadata | null,
   options?: WriteOptions,
 ): void
+export function upsertText(
+  db: Database,
+  id: string,
+  text: string,
+  embed: (text: string) => Promise<TextEmbedding>,
+  metadata?: Metadata | null,
+  options?: WriteOptions,
+): Promise<void>
 export function searchText(
   db: Database,
   text: string,
-  embed: (text: string) => ArrayLike<number>,
+  embed: (text: string) => TextEmbedding,
   options?: SearchOptions,
 ): SearchResult[]
+export function searchText(
+  db: Database,
+  text: string,
+  embed: (text: string) => Promise<TextEmbedding>,
+  options?: SearchOptions,
+): Promise<SearchResult[]>
 export function searchTextWithStats(
   db: Database,
   text: string,
-  embed: (text: string) => ArrayLike<number>,
+  embed: (text: string) => TextEmbedding,
   options?: SearchOptions,
 ): SearchResponse
+export function searchTextWithStats(
+  db: Database,
+  text: string,
+  embed: (text: string) => Promise<TextEmbedding>,
+  options?: SearchOptions,
+): Promise<SearchResponse>

package/index.js

@@ -85,6 +85,15 @@ function wrapError(fn) {
   }
 }
 
+function wrapAsync(value) {
+  return Promise.resolve(value).catch((error) => {
+    if (error instanceof VectLiteError) {
+      throw error
+    }
+    throw new VectLiteError(error?.message ?? String(error), error)
+  })
+}
+
 function encode(value) {
   return value == null ? null : JSON.stringify(value)
 }
@@ -97,6 +106,18 @@ function asArray(values) {
   return Array.from(values)
 }
 
+function isPromiseLike(value) {
+  return value != null && typeof value.then === 'function'
+}
+
+function embedText(text, embed) {
+  const embedded = wrapError(() => embed(text))
+  if (isPromiseLike(embedded)) {
+    return wrapAsync(embedded).then((vector) => asArray(vector))
+  }
+  return asArray(embedded)
+}
+
 function normalizeWriteOptions(options = {}) {
   return {
     namespace: options.namespace ?? null,
@@ -318,15 +339,30 @@ function upsertText(db, id, text, embed, metadata = null, options = {}) {
   if (payload.text === undefined) {
     payload.text = text
   }
-  return db.upsert(id, asArray(embed(text)), payload, { ...options, sparse: sparseTerms(text) })
+  const vector = embedText(text, embed)
+  const writeOptions = { ...options, sparse: sparseTerms(text) }
+  if (isPromiseLike(vector)) {
+    return wrapAsync(vector.then((resolved) => db.upsert(id, resolved, payload, writeOptions)))
+  }
+  return db.upsert(id, vector, payload, writeOptions)
 }
 
 function searchText(db, text, embed, options = {}) {
-  return db.search(asArray(embed(text)), { ...options, sparse: sparseTerms(text) })
+  const vector = embedText(text, embed)
+  const searchOptions = { ...options, sparse: sparseTerms(text) }
+  if (isPromiseLike(vector)) {
+    return wrapAsync(vector.then((resolved) => db.search(resolved, searchOptions)))
+  }
+  return db.search(vector, searchOptions)
 }
 
 function searchTextWithStats(db, text, embed, options = {}) {
-  return db.searchWithStats(asArray(embed(text)), { ...options, sparse: sparseTerms(text) })
+  const vector = embedText(text, embed)
+  const searchOptions = { ...options, sparse: sparseTerms(text) }
+  if (isPromiseLike(vector)) {
+    return wrapAsync(vector.then((resolved) => db.searchWithStats(resolved, searchOptions)))
+  }
+  return db.searchWithStats(vector, searchOptions)
 }
 
 module.exports = {

package/native/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "vectlite-node"
-version = "0.1.4"
+version = "0.1.8"
 edition = "2024"
 license = "MIT"
 description = "Node.js bindings for vectlite."
-homepage = "https://github.com/mcsedition-hub/vectlite"
+homepage = "https://vectlite.mcsedition.org/"
 repository = "https://github.com/mcsedition-hub/vectlite"
-documentation = "https://github.com/mcsedition-hub/vectlite/tree/main/bindings/node"
+documentation = "https://vectlite.mcsedition.org/"
 build = "build.rs"
 
 [lib]

package/native/vectlite-core/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "vectlite-core"
-version = "0.1.4"
+version = "0.1.8"
 edition = "2024"
 license = "MIT"
 description = "Core storage engine for vectlite."
-homepage = "https://github.com/mcsedition-hub/vectlite"
+homepage = "https://vectlite.mcsedition.org/"
 repository = "https://github.com/mcsedition-hub/vectlite"
-documentation = "https://github.com/mcsedition-hub/vectlite"
+documentation = "https://vectlite.mcsedition.org/"
 
 [lib]
 name = "vectlite"

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "vectlite",
-  "version": "0.1.4",
+  "version": "0.1.8",
   "description": "Embedded vector store for local-first AI applications.",
   "main": "index.js",
   "types": "index.d.ts",
-  "homepage": "https://github.com/mcsedition-hub/vectlite/tree/main/bindings/node",
+  "homepage": "https://vectlite.mcsedition.org/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mcsedition-hub/vectlite.git",