@storecraft/database-turso 1.0.13 → 1.0.15

package/README.md

@@ -5,16 +5,85 @@
        width='90%' />
 </div><hr/><br/>
 
-Official `libSql` / `Turso` driver for `StoreCraft` on any platforms.
+Official `libSql` / `Turso` driver for `StoreCraft` on any platform.
 Includes a vector store.
 
 ```bash
 npm i @storecraft/database-turso
 ```
 
-## Setup
-You can run a local database,
-or,
+## Local usage
+
+```js
+import 'dotenv/config';
+import http from "node:http";
+import { App } from '@storecraft/core'
+import { NodePlatform } from '@storecraft/core/platform/node';
+import { NodeLocalStorage } from '@storecraft/core/storage/node'
+import { Turso, LibSQLVectorStore } from '@storecraft/database-turso'
+import { migrateToLatest } from '@storecraft/database-turso/migrate.js'
+
+const app = new App(
+  {
+    auth_admins_emails: ['admin@sc.com'],
+  }
+)
+.withPlatform(new NodePlatform())
+.withDatabase(
+  new Turso(
+    { 
+      url: 'file:local.db',
+    }
+  )
+)
+.withStorage(new NodeLocalStorage('storage'))
+.withVectorStore(
+  new LibSQLVectorStore(
+    {
+      embedder: new OpenAIEmbedder(),
+      url: 'file:local-vector.db'
+    }
+  )
+)
+
+await app.init();
+await migrateToLatest(app.db, false);
+await app.vectorstore.createVectorIndex();
+
+const server = http.createServer(app.handler).listen(
+  8000,
+  () => {
+    console.log(`Server is running on http://localhost:8000`);
+  }
+); 
+
+```
+
+Storecraft will search the following `env` variables
+
+```bash
+LIBSQL_URL=./data.db
+# optional, if absent will use the same as LIBSQL_URL
+LIBSQL_VECTOR_URL=./data-vector.db
+```
+
+So, you can instantiate with empty config
+
+```ts
+.withDatabase(
+  new Turso()
+)
+.withVectorStore(
+  new LibSQLVectorStore(
+    {
+      embedder: new OpenAIEmbedder(),
+    }
+  )
+)
+```
+
+
+## Cloud usage
 
 connect to a cloud `libsql` and `Turso` platform
 - First, login to your [turso](https://turso.tech) account.
@@ -36,8 +105,6 @@ import { migrateToLatest } from '@storecraft/database-turso/migrate.js'
 const app = new App(
   {
     auth_admins_emails: ['admin@sc.com'],
-    auth_secret_access_token: 'auth_secret_access_token',
-    auth_secret_refresh_token: 'auth_secret_refresh_token'
   }
 )
 .withPlatform(new NodePlatform())
@@ -48,8 +115,6 @@ const app = new App(
       // all of these configurations can be inferred by env variables at init
       url: process.env.LIBSQL_URL,
       authToken: process.env.LIBSQL_API_TOKEN,
-      // or local
-      url: 'file:local.db',
     }
   )
 )
@@ -57,14 +122,17 @@ const app = new App(
 .withVectorStore(
   new LibSQLVectorStore(
     {
-      embedder: new OpenAIEmbedder()
+      embedder: new OpenAIEmbedder(),
+      url: process.env.LIBSQL_URL,
+      authToken: process.env.LIBSQL_API_TOKEN,
     }
   )
 )
 
 await app.init();
 await migrateToLatest(app.db, false);
- 
+await app.vectorstore.createVectorIndex();
+
 const server = http.createServer(app.handler).listen(
   8000,
   () => {
@@ -74,6 +142,30 @@ const server = http.createServer(app.handler).listen(
 
 ```
 
+Storecraft will search the following `env` variables
+
+```bash
+LIBSQL_URL=libsql://<your_database_name>.something.com
+LIBSQL_AUTH_TOKEN=your_api_key
+```
+
+So, you can instantiate with empty config
+
+```ts
+.withDatabase(
+  new Turso()
+)
+.withVectorStore(
+  new LibSQLVectorStore(
+    {
+      embedder: new OpenAIEmbedder(),
+    }
+  )
+)
+```
+
+
+
 ```text
 Author: Tomer Shalev <tomer.shalev@gmail.com>
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-turso",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "`Storecraft` database driver for `Turso` (cloud sqlite)",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/vector-store/index.js

@@ -71,6 +71,16 @@ export class LibSQLVectorStore {
     };
   }
 
+  /** @type {VectorStore["metric"]} */
+  get metric() {
+    return this.config.similarity;
+  };
+
+  /** @type {VectorStore["dimensions"]} */
+  get dimensions() {
+    return this.config.dimensions;
+  };
+
   get client() {
     if(!this.config.url) {
       throw new Error('LibSQLVectorStore::client() - missing url');
@@ -251,7 +261,10 @@ export class LibSQLVectorStore {
             metadata: parse_json_safely(row.metadata),
             namespace: String(row.namespace),
           },
-          score: Number(row.score)
+          // `libsql` score is (1 - Cosine Similarity) which yields a distance
+          // between [0, 2] where 0 is the most similar.
+          // This is not in accordance with other apis, so we invert it to [-1, 1]
+          score: (this.metric==='cosine') ? (1.0 - Number(row.score)) : Number(row.score)
         }
       )
     );

package/vector-store/types.d.ts

@@ -1,6 +1,6 @@
 
 import type { AIEmbedder } from '@storecraft/core/ai';
-export * from './index.js';
+export { LibSQLVectorStore, DEFAULT_INDEX_NAME } from './index.js';
 
 export type Config = {
   /**