@mastra/libsql 0.0.0-key-fix-20260227010020 → 0.0.0-knowledge-org-scope-20260902233451
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/LICENSE.md +17 -0
- package/README.md +13 -107
- package/dist/docs/SKILL.md +30 -27
- package/dist/docs/assets/SOURCE_MAP.json +1 -1
- package/dist/docs/references/docs-agents-human-in-the-loop.md +682 -0
- package/dist/docs/references/docs-agents-networks.md +93 -206
- package/dist/docs/references/docs-deployment-workers.md +394 -0
- package/dist/docs/references/docs-memory-memory-processors.md +94 -21
- package/dist/docs/references/docs-memory-message-history.md +107 -17
- package/dist/docs/references/docs-memory-multi-user-threads.md +210 -0
- package/dist/docs/references/docs-memory-overview.md +248 -25
- package/dist/docs/references/docs-memory-semantic-recall.md +188 -39
- package/dist/docs/references/docs-memory-working-memory.md +67 -33
- package/dist/docs/references/docs-storage.md +222 -0
- package/dist/docs/references/docs-studio-editor.md +353 -0
- package/dist/docs/references/docs-workflows-snapshots.md +21 -15
- package/dist/docs/references/integrations-channels-github.md +152 -0
- package/dist/docs/references/{reference-storage-dynamodb.md → integrations-databases-dynamodb.md} +28 -24
- package/dist/docs/references/{reference-storage-libsql.md → integrations-databases-libsql.md} +31 -5
- package/dist/docs/references/{guides-agent-frameworks-ai-sdk.md → reference-ai-sdk-overview.md} +13 -9
- package/dist/docs/references/reference-core-getMemory.md +8 -5
- package/dist/docs/references/reference-core-listMemory.md +7 -4
- package/dist/docs/references/reference-core-mastra-class.md +110 -19
- package/dist/docs/references/reference-file-based-agents-memory.md +62 -0
- package/dist/docs/references/reference-file-based-agents-storage.md +34 -0
- package/dist/docs/references/reference-memory-memory-class.md +23 -19
- package/dist/docs/references/{docs-rag-retrieval.md → reference-rag-retrieval.md} +175 -35
- package/dist/docs/references/reference-storage-composite.md +183 -19
- package/dist/docs/references/reference-storage-retention.md +250 -0
- package/dist/docs/references/reference-vectors-libsql.md +52 -48
- package/dist/index.cjs +14232 -9967
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +14198 -9943
- package/dist/index.js.map +1 -1
- package/dist/storage/db/client.d.ts +31 -0
- package/dist/storage/db/client.d.ts.map +1 -0
- package/dist/storage/db/index.d.ts +84 -1
- package/dist/storage/db/index.d.ts.map +1 -1
- package/dist/storage/db/utils.d.ts +17 -1
- package/dist/storage/db/utils.d.ts.map +1 -1
- package/dist/storage/db/write-lock.d.ts +8 -0
- package/dist/storage/db/write-lock.d.ts.map +1 -0
- package/dist/storage/domains/agents/index.d.ts +1 -0
- package/dist/storage/domains/agents/index.d.ts.map +1 -1
- package/dist/storage/domains/background-tasks/index.d.ts +29 -0
- package/dist/storage/domains/background-tasks/index.d.ts.map +1 -0
- package/dist/storage/domains/blobs/index.d.ts.map +1 -1
- package/dist/storage/domains/channels/index.d.ts +20 -0
- package/dist/storage/domains/channels/index.d.ts.map +1 -0
- package/dist/storage/domains/datasets/index.d.ts +7 -7
- package/dist/storage/domains/datasets/index.d.ts.map +1 -1
- package/dist/storage/domains/experiments/index.d.ts +27 -1
- package/dist/storage/domains/experiments/index.d.ts.map +1 -1
- package/dist/storage/domains/favorites/index.d.ts +17 -0
- package/dist/storage/domains/favorites/index.d.ts.map +1 -0
- package/dist/storage/domains/harness/index.d.ts +17 -0
- package/dist/storage/domains/harness/index.d.ts.map +1 -0
- package/dist/storage/domains/knowledge/index.d.ts +81 -0
- package/dist/storage/domains/knowledge/index.d.ts.map +1 -0
- package/dist/storage/domains/mcp-clients/index.d.ts.map +1 -1
- package/dist/storage/domains/mcp-servers/index.d.ts.map +1 -1
- package/dist/storage/domains/memory/index.d.ts +30 -5
- package/dist/storage/domains/memory/index.d.ts.map +1 -1
- package/dist/storage/domains/notifications/index.d.ts +23 -0
- package/dist/storage/domains/notifications/index.d.ts.map +1 -0
- package/dist/storage/domains/observability/index.d.ts +9 -1
- package/dist/storage/domains/observability/index.d.ts.map +1 -1
- package/dist/storage/domains/prompt-blocks/index.d.ts.map +1 -1
- package/dist/storage/domains/schedules/index.d.ts +27 -0
- package/dist/storage/domains/schedules/index.d.ts.map +1 -0
- package/dist/storage/domains/scorer-definitions/index.d.ts.map +1 -1
- package/dist/storage/domains/scores/index.d.ts +15 -5
- package/dist/storage/domains/scores/index.d.ts.map +1 -1
- package/dist/storage/domains/skills/index.d.ts +1 -0
- package/dist/storage/domains/skills/index.d.ts.map +1 -1
- package/dist/storage/domains/thread-state/index.d.ts +38 -0
- package/dist/storage/domains/thread-state/index.d.ts.map +1 -0
- package/dist/storage/domains/tool-provider-connections/index.d.ts +14 -0
- package/dist/storage/domains/tool-provider-connections/index.d.ts.map +1 -0
- package/dist/storage/domains/utils.d.ts +34 -0
- package/dist/storage/domains/utils.d.ts.map +1 -0
- package/dist/storage/domains/workflow-definitions/index.d.ts +14 -0
- package/dist/storage/domains/workflow-definitions/index.d.ts.map +1 -0
- package/dist/storage/domains/workflows/index.d.ts +8 -1
- package/dist/storage/domains/workflows/index.d.ts.map +1 -1
- package/dist/storage/domains/workspaces/index.d.ts.map +1 -1
- package/dist/storage/factory-storage.d.ts +28 -0
- package/dist/storage/factory-storage.d.ts.map +1 -0
- package/dist/storage/index.d.ts +79 -3
- package/dist/storage/index.d.ts.map +1 -1
- package/dist/storage/retention.d.ts +77 -0
- package/dist/storage/retention.d.ts.map +1 -0
- package/dist/vector/filter.d.ts.map +1 -1
- package/dist/vector/index.d.ts +26 -1
- package/dist/vector/index.d.ts.map +1 -1
- package/dist/vector/sql-builder.d.ts.map +1 -1
- package/dist/vector/write-lock.d.ts +7 -0
- package/dist/vector/write-lock.d.ts.map +1 -0
- package/package.json +20 -19
- package/CHANGELOG.md +0 -4133
- package/dist/docs/references/docs-agents-agent-approval.md +0 -558
- package/dist/docs/references/docs-agents-agent-memory.md +0 -209
- package/dist/docs/references/docs-agents-network-approval.md +0 -275
- package/dist/docs/references/docs-memory-storage.md +0 -261
- package/dist/docs/references/docs-observability-overview.md +0 -70
- package/dist/docs/references/docs-observability-tracing-exporters-default.md +0 -209
package/LICENSE.md
CHANGED
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
Portions of this software are licensed as follows:
|
|
2
|
+
|
|
3
|
+
- All content that resides under any directory named `ee/` within this
|
|
4
|
+
repository, including but not limited to:
|
|
5
|
+
- `@mastra/core/auth/ee`
|
|
6
|
+
- `@mastra/core/agent-builder/ee`
|
|
7
|
+
- `@mastra/editor/ee`
|
|
8
|
+
|
|
9
|
+
is licensed under the license defined in [`ee/LICENSE`](https://github.com/mastra-ai/mastra/blob/main/ee/LICENSE).
|
|
10
|
+
|
|
11
|
+
- All third-party components incorporated into the Mastra Software are
|
|
12
|
+
licensed under the original license provided by the owner of the
|
|
13
|
+
applicable component.
|
|
14
|
+
|
|
15
|
+
- Content outside of the above-mentioned directories or restrictions is
|
|
16
|
+
available under the "Apache License 2.0" as defined below.
|
|
17
|
+
|
|
1
18
|
# Apache License 2.0
|
|
2
19
|
|
|
3
20
|
Copyright (c) 2025 Kepler Software, Inc.
|
package/README.md
CHANGED
|
@@ -16,27 +16,30 @@ npm install @mastra/libsql
|
|
|
16
16
|
import { LibSQLVector } from '@mastra/libsql';
|
|
17
17
|
|
|
18
18
|
const vectorStore = new LibSQLVector({
|
|
19
|
-
url: 'file:./my-db.db'
|
|
19
|
+
url: 'file:./my-db.db',
|
|
20
20
|
});
|
|
21
21
|
|
|
22
22
|
// Create a new table with vector support
|
|
23
23
|
await vectorStore.createIndex({
|
|
24
24
|
indexName: 'my_vectors',
|
|
25
|
-
dimension:
|
|
25
|
+
dimension: 3,
|
|
26
26
|
metric: 'cosine',
|
|
27
27
|
});
|
|
28
28
|
|
|
29
29
|
// Add vectors
|
|
30
30
|
const ids = await vectorStore.upsert({
|
|
31
31
|
indexName: 'my_vectors',
|
|
32
|
-
vectors: [
|
|
32
|
+
vectors: [
|
|
33
|
+
[0.1, 0.2, 0.3],
|
|
34
|
+
[0.3, 0.4, 0.5],
|
|
35
|
+
],
|
|
33
36
|
metadata: [{ text: 'doc1' }, { text: 'doc2' }],
|
|
34
37
|
});
|
|
35
38
|
|
|
36
39
|
// Query vectors
|
|
37
40
|
const results = await vectorStore.query({
|
|
38
41
|
indexName: 'my_vectors',
|
|
39
|
-
queryVector: [0.1, 0.2,
|
|
42
|
+
queryVector: [0.1, 0.2, 0.3],
|
|
40
43
|
topK: 10, // topK
|
|
41
44
|
filter: { text: 'doc1' }, // filter
|
|
42
45
|
includeVector: false, // includeVector
|
|
@@ -44,111 +47,14 @@ const results = await vectorStore.query({
|
|
|
44
47
|
});
|
|
45
48
|
```
|
|
46
49
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
```typescript
|
|
50
|
-
import { LibSQLStore } from '@mastra/libsql';
|
|
51
|
-
|
|
52
|
-
const store = new LibSQLStore({
|
|
53
|
-
id: 'libsql-storage',
|
|
54
|
-
url: 'file:./my-db.db',
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
// Create a thread
|
|
58
|
-
await store.saveThread({
|
|
59
|
-
thread: {
|
|
60
|
-
id: 'thread-123',
|
|
61
|
-
resourceId: 'resource-456',
|
|
62
|
-
title: 'My Thread',
|
|
63
|
-
metadata: { key: 'value' },
|
|
64
|
-
createdAt: new Date(),
|
|
65
|
-
},
|
|
66
|
-
});
|
|
67
|
-
|
|
68
|
-
// Add messages to thread
|
|
69
|
-
await store.saveMessages({
|
|
70
|
-
messages: [
|
|
71
|
-
{
|
|
72
|
-
id: 'msg-789',
|
|
73
|
-
threadId: 'thread-123',
|
|
74
|
-
role: 'user',
|
|
75
|
-
content: { content: 'Hello' },
|
|
76
|
-
resourceId: 'resource-456',
|
|
77
|
-
createdAt: new Date(),
|
|
78
|
-
},
|
|
79
|
-
],
|
|
80
|
-
});
|
|
81
|
-
|
|
82
|
-
// Query threads and messages
|
|
83
|
-
const savedThread = await store.getThreadById({ threadId: 'thread-123' });
|
|
84
|
-
const messages = await store.listMessages({ threadId: 'thread-123' });
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Configuration
|
|
88
|
-
|
|
89
|
-
The LibSQLStore store can be initialized with:
|
|
90
|
-
|
|
91
|
-
- Configuration object with url and auth. Auth is only necessary when using a provider like [Turso](https://turso.tech/)
|
|
92
|
-
|
|
93
|
-
## Features
|
|
94
|
-
|
|
95
|
-
### Vector Store Features
|
|
96
|
-
|
|
97
|
-
- Vector similarity search with cosine, euclidean, and dot product metrics
|
|
98
|
-
- Advanced metadata filtering with MongoDB-like query syntax
|
|
99
|
-
- Minimum score threshold for queries
|
|
100
|
-
- Automatic UUID generation for vectors
|
|
101
|
-
- Table management (create, list, describe, delete, truncate)
|
|
102
|
-
|
|
103
|
-
### Storage Features
|
|
104
|
-
|
|
105
|
-
- Thread and message storage with JSON support
|
|
106
|
-
- Atomic transactions for data consistency
|
|
107
|
-
- Efficient batch operations
|
|
108
|
-
- Rich metadata support
|
|
109
|
-
- Timestamp tracking
|
|
110
|
-
- Cascading deletes
|
|
111
|
-
|
|
112
|
-
## Supported Filter Operators
|
|
113
|
-
|
|
114
|
-
The following filter operators are supported for metadata queries:
|
|
115
|
-
|
|
116
|
-
- Comparison: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`
|
|
117
|
-
- Logical: `$and`, `$or`
|
|
118
|
-
- Array: `$in`, `$nin`
|
|
119
|
-
- Text: `$regex`, `$like`
|
|
120
|
-
|
|
121
|
-
Example filter:
|
|
122
|
-
|
|
123
|
-
```typescript
|
|
124
|
-
{
|
|
125
|
-
$and: [{ age: { $gt: 25 } }, { tags: { $in: ['tag1', 'tag2'] } }];
|
|
126
|
-
}
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Vector Store Methods
|
|
50
|
+
## Documentation
|
|
130
51
|
|
|
131
|
-
-
|
|
132
|
-
- `upsert({indexName, vectors, metadata?, ids?})`: Add or update vectors
|
|
133
|
-
- `query({indexName, queryVector, topK?, filter?, includeVector?, minScore?})`: Search for similar vectors
|
|
134
|
-
- `updateVector({ indexName, id?, filter?, update })`: Update a single vector by ID or metadata filter
|
|
135
|
-
- `deleteVector({ indexName, id })`: Delete a single vector by ID
|
|
136
|
-
- `deleteVectors({ indexName, ids?, filter? })`: Delete multiple vectors by IDs or metadata filter
|
|
137
|
-
- `defineIndex({indexName, metric?, indexConfig?})`: Define an index
|
|
138
|
-
- `listIndexes()`: List all vector-enabled tables
|
|
139
|
-
- `describeIndex(indexName)`: Get table statistics
|
|
140
|
-
- `deleteIndex(indexName)`: Delete a table
|
|
141
|
-
- `truncateIndex(indexName)`: Remove all data from a table
|
|
52
|
+
- [@mastra/libsql documentation](https://mastra.ai/reference/vectors/libsql)
|
|
142
53
|
|
|
143
|
-
##
|
|
54
|
+
## Changelog
|
|
144
55
|
|
|
145
|
-
|
|
146
|
-
- `getThreadById({ threadId })`: Get a thread by ID
|
|
147
|
-
- `deleteThread({ threadId })`: Delete a thread and its messages
|
|
148
|
-
- `saveMessages({ messages })`: Save multiple messages in a transaction
|
|
149
|
-
- `listMessages({ threadId, perPage?, page? })`: Get messages for a thread with pagination
|
|
150
|
-
- `deleteMessages(messageIds)`: Delete specific messages
|
|
56
|
+
See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/stores/libsql/CHANGELOG.md) for version history and release notes.
|
|
151
57
|
|
|
152
|
-
##
|
|
58
|
+
## Support
|
|
153
59
|
|
|
154
|
-
|
|
60
|
+
We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.
|
package/dist/docs/SKILL.md
CHANGED
|
@@ -3,7 +3,7 @@ name: mastra-libsql
|
|
|
3
3
|
description: Documentation for @mastra/libsql. Use when working with @mastra/libsql APIs, configuration, or implementation.
|
|
4
4
|
metadata:
|
|
5
5
|
package: "@mastra/libsql"
|
|
6
|
-
version: "0.0.0-
|
|
6
|
+
version: "0.0.0-knowledge-org-scope-20260902233451"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
## When to use
|
|
@@ -16,35 +16,38 @@ Read the individual reference documents for detailed explanations and code examp
|
|
|
16
16
|
|
|
17
17
|
### Docs
|
|
18
18
|
|
|
19
|
-
- [
|
|
20
|
-
- [Agent
|
|
21
|
-
- [
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
25
|
-
- [Memory
|
|
26
|
-
- [Semantic
|
|
27
|
-
- [
|
|
28
|
-
- [
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
- [
|
|
19
|
+
- [Human-in-the-loop](references/docs-agents-human-in-the-loop.md) - Add human-in-the-loop controls to Mastra agents with tool approval and suspended execution, so people can provide input before a run resumes or stops.
|
|
20
|
+
- [Agent networks](references/docs-agents-networks.md) - Understand deprecated Mastra agent networks, including multi-agent routing, structured output, tool approvals, and migration to supervisor agents.
|
|
21
|
+
- [Workers](references/docs-deployment-workers.md) - Run Mastra workflow orchestration, schedules, and long-running background tasks in dedicated workers to keep API processes responsive under load.
|
|
22
|
+
- [Memory processors](references/docs-memory-memory-processors.md) - Configure Mastra memory processors to filter, trim, transform, and deduplicate messages before they reach the model while managing context limits.
|
|
23
|
+
- [Message history](references/docs-memory-message-history.md) - Store and retrieve recent Mastra conversation messages, configure history limits and thread titles, and query threads for chat interfaces.
|
|
24
|
+
- [Multi-user threads](references/docs-memory-multi-user-threads.md) - Share one Mastra memory thread across multiple users by preserving speaker identity in messages and combining history with observational or working memory.
|
|
25
|
+
- [Memory](references/docs-memory-overview.md) - Add memory to Mastra agents with message history, semantic recall, working memory, and observational memory across threads and multi-agent delegation.
|
|
26
|
+
- [Semantic recall](references/docs-memory-semantic-recall.md) - Retrieve relevant messages from past Mastra conversations with semantic recall, vector search, embeddings, metadata filters, and configurable storage.
|
|
27
|
+
- [Working memory](references/docs-memory-working-memory.md) - Persist user profiles, preferences, and application data with Mastra working memory using resource- or thread-scoped templates and storage adapters.
|
|
28
|
+
- [Storage](references/docs-storage.md) - Configure Mastra storage to persist memory, workflow state, observability data, evals, schedules, and long-running agent state across restarts.
|
|
29
|
+
- [Editor](references/docs-studio-editor.md) - Use Mastra Studio Editor so collaborators can change agent instructions and tools without modifying source code, from draft testing through publication.
|
|
30
|
+
- [Snapshots](references/docs-workflows-snapshots.md) - Store and retrieve Mastra workflow snapshots so suspended executions preserve step results and state and can resume reliably across processes.
|
|
31
|
+
|
|
32
|
+
### Integrations
|
|
33
|
+
|
|
34
|
+
- [GitHub](references/integrations-channels-github.md) - Subscribe Mastra agents to GitHub pull requests with @mastra/github-signals, polling modes, notification signals, and subscription management tools.
|
|
35
|
+
- [DynamoDB](references/integrations-databases-dynamodb.md) - Persist Mastra data in Amazon DynamoDB with a single-table ElectroDB design, configurable indexes, TTL support, credentials, and table initialization.
|
|
36
|
+
- [libSQL](references/integrations-databases-libsql.md) - Persist Mastra messages, workflow snapshots, traces, and eval scores in local or remote libSQL with managed tables and initialization options.
|
|
37
37
|
|
|
38
38
|
### Reference
|
|
39
39
|
|
|
40
|
-
- [
|
|
41
|
-
- [Reference: Mastra.
|
|
42
|
-
- [Reference: Mastra
|
|
43
|
-
- [Reference:
|
|
44
|
-
- [
|
|
45
|
-
- [
|
|
46
|
-
- [Reference:
|
|
47
|
-
- [
|
|
40
|
+
- [AI SDK overview](references/reference-ai-sdk-overview.md) - Wrap Vercel AI SDK models with Mastra processors and memory using withMastra(), while retaining existing AI SDK generation, streaming, and UI integrations.
|
|
41
|
+
- [Reference: Mastra.getMemory()](references/reference-core-getMemory.md) - The .getMemory() method retrieves a memory instance from the Mastra registry by its key.
|
|
42
|
+
- [Reference: Mastra.listMemory()](references/reference-core-listMemory.md) - The .listMemory() method returns all memory instances registered with the Mastra instance.
|
|
43
|
+
- [Reference: Mastra class](references/reference-core-mastra-class.md) - The Mastra class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, observability, and more.
|
|
44
|
+
- [Memory](references/reference-file-based-agents-memory.md) - A file-based agent gets memory from a memory.ts file that default-exports a Memory instance.
|
|
45
|
+
- [Storage](references/reference-file-based-agents-storage.md) - Mastra sets the project's default storage from a storage.ts file directly under src/mastra/.
|
|
46
|
+
- [Reference: Memory class](references/reference-memory-memory-class.md) - The Memory class provides a reliable system for managing conversation history and thread-based message storage in Mastra.
|
|
47
|
+
- [Retrieval, semantic search, reranking](references/reference-rag-retrieval.md) - After storing embeddings, you need to retrieve relevant chunks to answer user queries.
|
|
48
|
+
- [Reference: Composite storage](references/reference-storage-composite.md) - MastraCompositeStore can compose storage domains from different providers. Use it when you need different databases for different purposes.
|
|
49
|
+
- [Reference: Storage retention (prune)](references/reference-storage-retention.md) - prune() deletes rows. It caps growth and is safe to run against large tables (batched, bounded, resumable, cancellable).
|
|
50
|
+
- [Reference: libSQL vector store](references/reference-vectors-libsql.md) - Configure LibSQLVector for similarity search and metadata filtering with local libSQL, SQLite-compatible vector extensions, or Turso databases.
|
|
48
51
|
|
|
49
52
|
|
|
50
53
|
Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.
|