@mastra/lance 0.2.3 → 0.2.4
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.
- package/.turbo/turbo-build.log +2 -21
- package/CHANGELOG.md +34 -0
- package/dist/index.cjs +2 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/storage/domains/legacy-evals/index.d.ts +25 -0
- package/dist/storage/domains/legacy-evals/index.d.ts.map +1 -0
- package/dist/storage/domains/memory/index.d.ts +94 -0
- package/dist/storage/domains/memory/index.d.ts.map +1 -0
- package/dist/storage/domains/operations/index.d.ts +40 -0
- package/dist/storage/domains/operations/index.d.ts.map +1 -0
- package/dist/storage/domains/scores/index.d.ts +39 -0
- package/dist/storage/domains/scores/index.d.ts.map +1 -0
- package/dist/storage/domains/traces/index.d.ts +34 -0
- package/dist/storage/domains/traces/index.d.ts.map +1 -0
- package/dist/storage/domains/utils.d.ts +10 -0
- package/dist/storage/domains/utils.d.ts.map +1 -0
- package/dist/storage/domains/workflows/index.d.ts +38 -0
- package/dist/storage/domains/workflows/index.d.ts.map +1 -0
- package/dist/storage/index.d.ts +233 -0
- package/dist/storage/index.d.ts.map +1 -0
- package/dist/vector/filter.d.ts +41 -0
- package/dist/vector/filter.d.ts.map +1 -0
- package/dist/vector/index.d.ts +85 -0
- package/dist/vector/index.d.ts.map +1 -0
- package/dist/vector/types.d.ts +15 -0
- package/dist/vector/types.d.ts.map +1 -0
- package/package.json +9 -8
- package/tsconfig.build.json +9 -0
- package/tsconfig.json +1 -1
- package/tsup.config.ts +17 -0
- package/dist/_tsup-dts-rollup.d.cts +0 -681
- package/dist/_tsup-dts-rollup.d.ts +0 -681
- package/dist/index.d.cts +0 -2
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import type { ConnectionOptions, CreateTableOptions, Table, TableLike } from '@lancedb/lancedb';
|
|
2
|
+
import type { CreateIndexParams, DeleteIndexParams, DeleteVectorParams, DescribeIndexParams, IndexStats, QueryResult, QueryVectorParams, UpdateVectorParams, UpsertVectorParams } from '@mastra/core';
|
|
3
|
+
import { MastraVector } from '@mastra/core/vector';
|
|
4
|
+
import type { LanceVectorFilter } from './filter.js';
|
|
5
|
+
import type { IndexConfig } from './types.js';
|
|
6
|
+
interface LanceCreateIndexParams extends CreateIndexParams {
|
|
7
|
+
indexConfig?: LanceIndexConfig;
|
|
8
|
+
tableName?: string;
|
|
9
|
+
}
|
|
10
|
+
interface LanceIndexConfig extends IndexConfig {
|
|
11
|
+
numPartitions?: number;
|
|
12
|
+
numSubVectors?: number;
|
|
13
|
+
}
|
|
14
|
+
interface LanceUpsertVectorParams extends UpsertVectorParams {
|
|
15
|
+
tableName: string;
|
|
16
|
+
}
|
|
17
|
+
interface LanceQueryVectorParams extends QueryVectorParams<LanceVectorFilter> {
|
|
18
|
+
tableName: string;
|
|
19
|
+
columns?: string[];
|
|
20
|
+
includeAllColumns?: boolean;
|
|
21
|
+
}
|
|
22
|
+
export declare class LanceVectorStore extends MastraVector<LanceVectorFilter> {
|
|
23
|
+
private lanceClient;
|
|
24
|
+
/**
|
|
25
|
+
* Creates a new instance of LanceVectorStore
|
|
26
|
+
* @param uri The URI to connect to LanceDB
|
|
27
|
+
* @param options connection options
|
|
28
|
+
*
|
|
29
|
+
* Usage:
|
|
30
|
+
*
|
|
31
|
+
* Connect to a local database
|
|
32
|
+
* ```ts
|
|
33
|
+
* const store = await LanceVectorStore.create('/path/to/db');
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
36
|
+
* Connect to a LanceDB cloud database
|
|
37
|
+
* ```ts
|
|
38
|
+
* const store = await LanceVectorStore.create('db://host:port');
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* Connect to a cloud database
|
|
42
|
+
* ```ts
|
|
43
|
+
* const store = await LanceVectorStore.create('s3://bucket/db', { storageOptions: { timeout: '60s' } });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
static create(uri: string, options?: ConnectionOptions): Promise<LanceVectorStore>;
|
|
47
|
+
/**
|
|
48
|
+
* @internal
|
|
49
|
+
* Private constructor to enforce using the create factory method
|
|
50
|
+
*/
|
|
51
|
+
private constructor();
|
|
52
|
+
close(): void;
|
|
53
|
+
query({ tableName, queryVector, filter, includeVector, topK, columns, includeAllColumns, }: LanceQueryVectorParams): Promise<QueryResult[]>;
|
|
54
|
+
private filterTranslator;
|
|
55
|
+
upsert({ tableName, vectors, metadata, ids }: LanceUpsertVectorParams): Promise<string[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Flattens a nested object, creating new keys with underscores for nested properties.
|
|
58
|
+
* Example: { metadata: { text: 'test' } } → { metadata_text: 'test' }
|
|
59
|
+
*/
|
|
60
|
+
private flattenObject;
|
|
61
|
+
createTable(tableName: string, data: Record<string, unknown>[] | TableLike, options?: Partial<CreateTableOptions>): Promise<Table>;
|
|
62
|
+
listTables(): Promise<string[]>;
|
|
63
|
+
getTableSchema(tableName: string): Promise<any>;
|
|
64
|
+
/**
|
|
65
|
+
* indexName is actually a column name in a table in lanceDB
|
|
66
|
+
*/
|
|
67
|
+
createIndex({ tableName, indexName, dimension, metric, indexConfig, }: LanceCreateIndexParams): Promise<void>;
|
|
68
|
+
listIndexes(): Promise<string[]>;
|
|
69
|
+
describeIndex({ indexName }: DescribeIndexParams): Promise<IndexStats>;
|
|
70
|
+
deleteIndex({ indexName }: DeleteIndexParams): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Deletes all tables in the database
|
|
73
|
+
*/
|
|
74
|
+
deleteAllTables(): Promise<void>;
|
|
75
|
+
deleteTable(tableName: string): Promise<void>;
|
|
76
|
+
updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
|
|
77
|
+
deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
|
|
78
|
+
/**
|
|
79
|
+
* Converts a flattened object with keys using underscore notation back to a nested object.
|
|
80
|
+
* Example: { name: 'test', details_text: 'test' } → { name: 'test', details: { text: 'test' } }
|
|
81
|
+
*/
|
|
82
|
+
private unflattenObject;
|
|
83
|
+
}
|
|
84
|
+
export {};
|
|
85
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vector/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAc,iBAAiB,EAAE,kBAAkB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5G,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,UAAU,sBAAuB,SAAQ,iBAAiB;IACxD,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,gBAAiB,SAAQ,WAAW;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,uBAAwB,SAAQ,kBAAkB;IAC1D,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,sBAAuB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAC;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,iBAAiB,CAAC;IACnE,OAAO,CAAC,WAAW,CAAc;IAEjC;;;;;;;;;;;;;;;;;;;;;OAqBG;WACiB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkB/F;;;OAGG;IACH,OAAO;IAIP,KAAK;IAMC,KAAK,CAAC,EACV,SAAS,EACT,WAAW,EACX,MAAM,EACN,aAAqB,EACrB,IAAS,EACT,OAAY,EACZ,iBAAyB,GAC1B,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAoGlD,OAAO,CAAC,gBAAgB;IA0ClB,MAAM,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,QAAa,EAAE,GAAQ,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA4EzG;;;OAGG;IACH,OAAO,CAAC,aAAa;IAYf,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS,EAC3C,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACpC,OAAO,CAAC,KAAK,CAAC;IA+BX,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAwB/B,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BrD;;OAEG;IACG,WAAW,CAAC,EAChB,SAAS,EACT,SAAS,EACT,SAAS,EACT,MAAiB,EACjB,WAAgB,GACjB,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkFnC,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkChC,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkEtE,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDlE;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBhC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B7C,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuH1E,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiExE;;;OAGG;IACH,OAAO,CAAC,eAAe;CAgCxB"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export type IndexType = 'ivfflat' | 'hnsw';
|
|
2
|
+
interface IVFConfig {
|
|
3
|
+
lists?: number;
|
|
4
|
+
}
|
|
5
|
+
interface HNSWConfig {
|
|
6
|
+
m?: number;
|
|
7
|
+
efConstruction?: number;
|
|
8
|
+
}
|
|
9
|
+
export interface IndexConfig {
|
|
10
|
+
type?: IndexType;
|
|
11
|
+
ivf?: IVFConfig;
|
|
12
|
+
hnsw?: HNSWConfig;
|
|
13
|
+
}
|
|
14
|
+
export {};
|
|
15
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/vector/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3C,UAAU,SAAS;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,UAAU;IAClB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/lance",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "Lance provider for Mastra - includes both vector and db storage capabilities",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"default": "./dist/index.js"
|
|
13
13
|
},
|
|
14
14
|
"require": {
|
|
15
|
-
"types": "./dist/index.d.
|
|
15
|
+
"types": "./dist/index.d.ts",
|
|
16
16
|
"default": "./dist/index.cjs"
|
|
17
17
|
}
|
|
18
18
|
},
|
|
@@ -29,16 +29,17 @@
|
|
|
29
29
|
"tsup": "^8.5.0",
|
|
30
30
|
"typescript": "^5.8.3",
|
|
31
31
|
"vitest": "^3.2.4",
|
|
32
|
-
"@internal/lint": "0.0.
|
|
33
|
-
"@internal/
|
|
34
|
-
"@mastra/core": "^0.
|
|
32
|
+
"@internal/lint": "0.0.27",
|
|
33
|
+
"@internal/types-builder": "0.0.2",
|
|
34
|
+
"@mastra/core": "^0.13.0",
|
|
35
|
+
"@internal/storage-test-utils": "0.0.23"
|
|
35
36
|
},
|
|
36
37
|
"peerDependencies": {
|
|
37
|
-
"@mastra/core": ">=0.
|
|
38
|
+
"@mastra/core": ">=0.13.0-0 <0.14.0-0"
|
|
38
39
|
},
|
|
39
40
|
"scripts": {
|
|
40
|
-
"build": "tsup
|
|
41
|
-
"build:watch": "
|
|
41
|
+
"build": "tsup --silent --config tsup.config.ts",
|
|
42
|
+
"build:watch": "tsup --watch --silent --config tsup.config.ts",
|
|
42
43
|
"test": "vitest run",
|
|
43
44
|
"test:watch": "vitest watch",
|
|
44
45
|
"lint": "eslint ."
|
package/tsconfig.json
CHANGED
package/tsup.config.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { generateTypes } from '@internal/types-builder';
|
|
2
|
+
import { defineConfig } from 'tsup';
|
|
3
|
+
|
|
4
|
+
export default defineConfig({
|
|
5
|
+
entry: ['src/index.ts'],
|
|
6
|
+
format: ['esm', 'cjs'],
|
|
7
|
+
clean: true,
|
|
8
|
+
dts: false,
|
|
9
|
+
splitting: true,
|
|
10
|
+
treeshake: {
|
|
11
|
+
preset: 'smallest',
|
|
12
|
+
},
|
|
13
|
+
sourcemap: true,
|
|
14
|
+
onSuccess: async () => {
|
|
15
|
+
await generateTypes(process.cwd());
|
|
16
|
+
},
|
|
17
|
+
});
|