@mastra/core 1.9.0 → 1.10.0
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/CHANGELOG.md +202 -0
- package/dist/agent/agent.d.ts +22 -3
- package/dist/agent/agent.d.ts.map +1 -1
- package/dist/agent/index.cjs +13 -13
- package/dist/agent/index.js +2 -2
- package/dist/agent/message-list/index.cjs +18 -18
- package/dist/agent/message-list/index.js +1 -1
- package/dist/agent/message-list/message-list.d.ts.map +1 -1
- package/dist/{chunk-IOY7Y5GV.js → chunk-3VVNJPTO.js} +602 -187
- package/dist/chunk-3VVNJPTO.js.map +1 -0
- package/dist/{chunk-VDKWYUGC.cjs → chunk-5WBEMKE2.cjs} +7 -3
- package/dist/chunk-5WBEMKE2.cjs.map +1 -0
- package/dist/{chunk-H5S4PS44.cjs → chunk-76Q75VI4.cjs} +602 -187
- package/dist/chunk-76Q75VI4.cjs.map +1 -0
- package/dist/{chunk-ZBESCKPX.cjs → chunk-7AHCLTZZ.cjs} +1572 -36
- package/dist/chunk-7AHCLTZZ.cjs.map +1 -0
- package/dist/{chunk-SEKQJ447.js → chunk-ACAILOJE.js} +166 -68
- package/dist/chunk-ACAILOJE.js.map +1 -0
- package/dist/{chunk-YIJZBU54.cjs → chunk-BCSVBOAN.cjs} +240 -463
- package/dist/chunk-BCSVBOAN.cjs.map +1 -0
- package/dist/{chunk-ZVWVQ6MG.js → chunk-CY4ZWL2X.js} +8 -3
- package/dist/chunk-CY4ZWL2X.js.map +1 -0
- package/dist/{chunk-ET7GXCHS.js → chunk-DIKRJVK6.js} +5 -5
- package/dist/{chunk-ET7GXCHS.js.map → chunk-DIKRJVK6.js.map} +1 -1
- package/dist/{chunk-P6ZX7OKT.cjs → chunk-E6I5LBDM.cjs} +7 -7
- package/dist/{chunk-P6ZX7OKT.cjs.map → chunk-E6I5LBDM.cjs.map} +1 -1
- package/dist/{chunk-BFV3GSGS.js → chunk-FT5Q6XTK.js} +1546 -22
- package/dist/chunk-FT5Q6XTK.js.map +1 -0
- package/dist/{chunk-K54LFB4P.js → chunk-FXOWXS4O.js} +3 -3
- package/dist/{chunk-K54LFB4P.js.map → chunk-FXOWXS4O.js.map} +1 -1
- package/dist/{chunk-QNXY3J6B.cjs → chunk-GCRPNAAR.cjs} +22 -19
- package/dist/chunk-GCRPNAAR.cjs.map +1 -0
- package/dist/{chunk-5M3RMO7U.js → chunk-GTA5BKXZ.js} +8 -8
- package/dist/{chunk-5M3RMO7U.js.map → chunk-GTA5BKXZ.js.map} +1 -1
- package/dist/{chunk-G5R2755Q.cjs → chunk-HAIQ57YB.cjs} +53 -20
- package/dist/chunk-HAIQ57YB.cjs.map +1 -0
- package/dist/{chunk-3ZBLD2Y4.cjs → chunk-HH76UOJL.cjs} +2 -2
- package/dist/{chunk-3ZBLD2Y4.cjs.map → chunk-HH76UOJL.cjs.map} +1 -1
- package/dist/{chunk-HAGCXIBX.cjs → chunk-HNYQITSV.cjs} +9 -9
- package/dist/{chunk-HAGCXIBX.cjs.map → chunk-HNYQITSV.cjs.map} +1 -1
- package/dist/{chunk-GJTLWOKJ.js → chunk-HQA3IBLZ.js} +51 -18
- package/dist/chunk-HQA3IBLZ.js.map +1 -0
- package/dist/{chunk-4BXXAZ75.js → chunk-HQTHWVAK.js} +15 -7
- package/dist/chunk-HQTHWVAK.js.map +1 -0
- package/dist/{chunk-CCLV5CAA.js → chunk-JGOH7RWL.js} +7 -3
- package/dist/chunk-JGOH7RWL.js.map +1 -0
- package/dist/{chunk-Y6TGIUGL.js → chunk-LSF5WJ6G.js} +2 -2
- package/dist/{chunk-Y6TGIUGL.js.map → chunk-LSF5WJ6G.js.map} +1 -1
- package/dist/{chunk-D6HO5QAM.cjs → chunk-M26GEN4C.cjs} +14 -9
- package/dist/chunk-M26GEN4C.cjs.map +1 -0
- package/dist/{chunk-4P35AVPE.cjs → chunk-MEMYFFOL.cjs} +256 -157
- package/dist/chunk-MEMYFFOL.cjs.map +1 -0
- package/dist/{chunk-BQ355Z3O.js → chunk-NUZWQA4J.js} +4 -4
- package/dist/{chunk-BQ355Z3O.js.map → chunk-NUZWQA4J.js.map} +1 -1
- package/dist/{chunk-JIRB5LX4.js → chunk-OHX36YXF.js} +5 -3
- package/dist/chunk-OHX36YXF.js.map +1 -0
- package/dist/{chunk-PKORY4ZZ.cjs → chunk-OOTLMVNN.cjs} +107 -7
- package/dist/chunk-OOTLMVNN.cjs.map +1 -0
- package/dist/{chunk-D4M6E4OQ.cjs → chunk-OWZ6QT24.cjs} +16 -8
- package/dist/chunk-OWZ6QT24.cjs.map +1 -0
- package/dist/{chunk-6OHS6ZQ3.js → chunk-PDJCIONR.js} +8 -8
- package/dist/{chunk-6OHS6ZQ3.js.map → chunk-PDJCIONR.js.map} +1 -1
- package/dist/{chunk-WU2P7XOU.cjs → chunk-PP4G2TZZ.cjs} +20 -20
- package/dist/{chunk-WU2P7XOU.cjs.map → chunk-PP4G2TZZ.cjs.map} +1 -1
- package/dist/{chunk-VWAK25TU.js → chunk-SBBWRNZA.js} +10 -7
- package/dist/chunk-SBBWRNZA.js.map +1 -0
- package/dist/{chunk-TU4YMXOQ.js → chunk-TJIFNVPX.js} +6 -6
- package/dist/{chunk-TU4YMXOQ.js.map → chunk-TJIFNVPX.js.map} +1 -1
- package/dist/{chunk-V5YNS2QO.cjs → chunk-XJNQHPBJ.cjs} +15 -15
- package/dist/{chunk-V5YNS2QO.cjs.map → chunk-XJNQHPBJ.cjs.map} +1 -1
- package/dist/{chunk-MVYP55NA.js → chunk-YC6Z75K2.js} +113 -336
- package/dist/chunk-YC6Z75K2.js.map +1 -0
- package/dist/{chunk-3ZF7IC6Q.cjs → chunk-YZMSJKAK.cjs} +5 -3
- package/dist/chunk-YZMSJKAK.cjs.map +1 -0
- package/dist/{chunk-L3WDI7HP.cjs → chunk-Z2X5VTYJ.cjs} +65 -65
- package/dist/{chunk-L3WDI7HP.cjs.map → chunk-Z2X5VTYJ.cjs.map} +1 -1
- package/dist/{chunk-BN5MV2QK.cjs → chunk-Z52OAJ73.cjs} +4 -4
- package/dist/{chunk-BN5MV2QK.cjs.map → chunk-Z52OAJ73.cjs.map} +1 -1
- package/dist/{chunk-WYPSC6CO.js → chunk-ZBU6P4JV.js} +104 -4
- package/dist/chunk-ZBU6P4JV.js.map +1 -0
- package/dist/datasets/experiment/index.d.ts.map +1 -1
- package/dist/datasets/experiment/scorer.d.ts.map +1 -1
- package/dist/datasets/index.cjs +17 -17
- package/dist/datasets/index.js +2 -2
- package/dist/di/index.cjs +4 -4
- package/dist/di/index.js +1 -1
- package/dist/docs/SKILL.md +1 -1
- package/dist/docs/assets/SOURCE_MAP.json +443 -384
- package/dist/docs/references/docs-agents-agent-approval.md +61 -31
- package/dist/docs/references/docs-agents-supervisor-agents.md +1 -1
- package/dist/docs/references/docs-memory-observational-memory.md +9 -0
- package/dist/docs/references/docs-memory-semantic-recall.md +17 -1
- package/dist/docs/references/docs-workspace-skills.md +7 -5
- package/dist/docs/references/reference-agents-agent.md +20 -20
- package/dist/docs/references/reference-agents-generate.md +200 -66
- package/dist/docs/references/reference-agents-generateLegacy.md +77 -35
- package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDefaultOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +4 -6
- package/dist/docs/references/reference-agents-getDescription.md +1 -1
- package/dist/docs/references/reference-agents-getInstructions.md +4 -6
- package/dist/docs/references/reference-agents-getLLM.md +6 -8
- package/dist/docs/references/reference-agents-getMemory.md +4 -6
- package/dist/docs/references/reference-agents-getModel.md +4 -6
- package/dist/docs/references/reference-agents-getTools.md +5 -7
- package/dist/docs/references/reference-agents-getVoice.md +4 -6
- package/dist/docs/references/reference-agents-listAgents.md +4 -6
- package/dist/docs/references/reference-agents-listScorers.md +4 -6
- package/dist/docs/references/reference-agents-listTools.md +4 -6
- package/dist/docs/references/reference-agents-listWorkflows.md +4 -6
- package/dist/docs/references/reference-agents-network.md +69 -23
- package/dist/docs/references/reference-ai-sdk-chat-route.md +7 -7
- package/dist/docs/references/reference-ai-sdk-network-route.md +3 -3
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +9 -9
- package/dist/docs/references/reference-ai-sdk-with-mastra.md +12 -12
- package/dist/docs/references/reference-ai-sdk-workflow-route.md +3 -3
- package/dist/docs/references/reference-auth-auth0.md +6 -6
- package/dist/docs/references/reference-auth-clerk.md +5 -5
- package/dist/docs/references/reference-auth-firebase.md +7 -7
- package/dist/docs/references/reference-auth-jwt.md +1 -1
- package/dist/docs/references/reference-auth-supabase.md +4 -4
- package/dist/docs/references/reference-auth-workos.md +6 -6
- package/dist/docs/references/reference-core-addGateway.md +2 -2
- package/dist/docs/references/reference-core-getAgent.md +2 -2
- package/dist/docs/references/reference-core-getAgentById.md +2 -2
- package/dist/docs/references/reference-core-getDeployer.md +1 -1
- package/dist/docs/references/reference-core-getGateway.md +2 -2
- package/dist/docs/references/reference-core-getGatewayById.md +2 -2
- package/dist/docs/references/reference-core-getLogger.md +1 -1
- package/dist/docs/references/reference-core-getMCPServer.md +2 -2
- package/dist/docs/references/reference-core-getMCPServerById.md +3 -3
- package/dist/docs/references/reference-core-getMemory.md +2 -2
- package/dist/docs/references/reference-core-getScorer.md +2 -2
- package/dist/docs/references/reference-core-getScorerById.md +2 -2
- package/dist/docs/references/reference-core-getServer.md +1 -1
- package/dist/docs/references/reference-core-getStorage.md +1 -1
- package/dist/docs/references/reference-core-getStoredAgentById.md +18 -20
- package/dist/docs/references/reference-core-getTelemetry.md +1 -1
- package/dist/docs/references/reference-core-getVector.md +2 -2
- package/dist/docs/references/reference-core-getWorkflow.md +3 -3
- package/dist/docs/references/reference-core-listAgents.md +1 -1
- package/dist/docs/references/reference-core-listGateways.md +1 -1
- package/dist/docs/references/reference-core-listLogs.md +9 -11
- package/dist/docs/references/reference-core-listLogsByRunId.md +9 -9
- package/dist/docs/references/reference-core-listMCPServers.md +1 -1
- package/dist/docs/references/reference-core-listMemory.md +1 -1
- package/dist/docs/references/reference-core-listScorers.md +1 -1
- package/dist/docs/references/reference-core-listStoredAgents.md +9 -11
- package/dist/docs/references/reference-core-listVectors.md +1 -1
- package/dist/docs/references/reference-core-listWorkflows.md +2 -2
- package/dist/docs/references/reference-core-mastra-class.md +17 -17
- package/dist/docs/references/reference-core-mastra-model-gateway.md +15 -15
- package/dist/docs/references/reference-core-setLogger.md +2 -4
- package/dist/docs/references/reference-core-setStorage.md +1 -1
- package/dist/docs/references/reference-datasets-addItem.md +20 -4
- package/dist/docs/references/reference-datasets-addItems.md +8 -2
- package/dist/docs/references/reference-datasets-compareExperiments.md +15 -3
- package/dist/docs/references/reference-datasets-create.md +6 -6
- package/dist/docs/references/reference-datasets-dataset.md +1 -1
- package/dist/docs/references/reference-datasets-delete.md +2 -2
- package/dist/docs/references/reference-datasets-deleteExperiment.md +2 -2
- package/dist/docs/references/reference-datasets-deleteItem.md +2 -2
- package/dist/docs/references/reference-datasets-deleteItems.md +2 -2
- package/dist/docs/references/reference-datasets-get.md +2 -2
- package/dist/docs/references/reference-datasets-getDetails.md +9 -9
- package/dist/docs/references/reference-datasets-getExperiment.md +2 -2
- package/dist/docs/references/reference-datasets-getItem.md +3 -3
- package/dist/docs/references/reference-datasets-getItemHistory.md +22 -2
- package/dist/docs/references/reference-datasets-list.md +7 -3
- package/dist/docs/references/reference-datasets-listExperimentResults.md +34 -4
- package/dist/docs/references/reference-datasets-listExperiments.md +41 -3
- package/dist/docs/references/reference-datasets-listItems.md +18 -6
- package/dist/docs/references/reference-datasets-listVersions.md +23 -3
- package/dist/docs/references/reference-datasets-startExperiment.md +62 -12
- package/dist/docs/references/reference-datasets-startExperimentAsync.md +5 -1
- package/dist/docs/references/reference-datasets-update.md +6 -6
- package/dist/docs/references/reference-datasets-updateItem.md +5 -5
- package/dist/docs/references/reference-evals-answer-relevancy.md +11 -11
- package/dist/docs/references/reference-evals-answer-similarity.md +17 -19
- package/dist/docs/references/reference-evals-bias.md +10 -10
- package/dist/docs/references/reference-evals-completeness.md +3 -3
- package/dist/docs/references/reference-evals-content-similarity.md +6 -6
- package/dist/docs/references/reference-evals-context-precision.md +4 -4
- package/dist/docs/references/reference-evals-create-scorer.md +47 -49
- package/dist/docs/references/reference-evals-faithfulness.md +11 -11
- package/dist/docs/references/reference-evals-hallucination.md +17 -21
- package/dist/docs/references/reference-evals-keyword-coverage.md +4 -4
- package/dist/docs/references/reference-evals-mastra-scorer.md +14 -14
- package/dist/docs/references/reference-evals-run-evals.md +16 -16
- package/dist/docs/references/reference-evals-scorer-utils.md +3 -3
- package/dist/docs/references/reference-evals-textual-difference.md +3 -3
- package/dist/docs/references/reference-evals-tone-consistency.md +3 -3
- package/dist/docs/references/reference-evals-toxicity.md +8 -8
- package/dist/docs/references/reference-harness-harness-class.md +34 -42
- package/dist/docs/references/reference-logging-pino-logger.md +5 -5
- package/dist/docs/references/reference-memory-deleteMessages.md +2 -2
- package/dist/docs/references/reference-memory-memory-class.md +12 -14
- package/dist/docs/references/reference-memory-observational-memory.md +102 -94
- package/dist/docs/references/reference-observability-tracing-configuration.md +27 -10
- package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +4 -7
- package/dist/docs/references/reference-processors-batch-parts-processor.md +8 -10
- package/dist/docs/references/reference-processors-language-detector.md +14 -16
- package/dist/docs/references/reference-processors-message-history-processor.md +7 -9
- package/dist/docs/references/reference-processors-moderation-processor.md +13 -15
- package/dist/docs/references/reference-processors-pii-detector.md +14 -16
- package/dist/docs/references/reference-processors-processor-interface.md +62 -62
- package/dist/docs/references/reference-processors-prompt-injection-detector.md +11 -13
- package/dist/docs/references/reference-processors-semantic-recall-processor.md +14 -16
- package/dist/docs/references/reference-processors-system-prompt-scrubber.md +12 -14
- package/dist/docs/references/reference-processors-token-limiter-processor.md +11 -13
- package/dist/docs/references/reference-processors-tool-call-filter.md +5 -7
- package/dist/docs/references/reference-processors-tool-search-processor.md +9 -11
- package/dist/docs/references/reference-processors-unicode-normalizer.md +8 -10
- package/dist/docs/references/reference-processors-working-memory-processor.md +14 -18
- package/dist/docs/references/reference-rag-database-config.md +11 -7
- package/dist/docs/references/reference-rag-embeddings.md +12 -12
- package/dist/docs/references/reference-server-mastra-server.md +10 -10
- package/dist/docs/references/reference-server-register-api-route.md +13 -13
- package/dist/docs/references/reference-storage-cloudflare-d1.md +5 -5
- package/dist/docs/references/reference-storage-composite.md +9 -9
- package/dist/docs/references/reference-storage-lance.md +3 -3
- package/dist/docs/references/reference-storage-libsql.md +2 -2
- package/dist/docs/references/reference-storage-mongodb.md +5 -5
- package/dist/docs/references/reference-storage-mssql.md +2 -2
- package/dist/docs/references/reference-storage-postgresql.md +25 -25
- package/dist/docs/references/reference-storage-upstash.md +3 -3
- package/dist/docs/references/reference-streaming-ChunkType.md +251 -59
- package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +86 -16
- package/dist/docs/references/reference-streaming-agents-streamLegacy.md +79 -39
- package/dist/docs/references/reference-streaming-workflows-resumeStream.md +18 -8
- package/dist/docs/references/reference-streaming-workflows-stream.md +21 -9
- package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +4 -4
- package/dist/docs/references/reference-tools-create-tool.md +25 -21
- package/dist/docs/references/reference-tools-graph-rag-tool.md +16 -18
- package/dist/docs/references/reference-tools-mcp-client.md +38 -27
- package/dist/docs/references/reference-tools-mcp-server.md +45 -45
- package/dist/docs/references/reference-tools-vector-query-tool.md +34 -22
- package/dist/docs/references/reference-vectors-libsql.md +31 -31
- package/dist/docs/references/reference-vectors-mongodb.md +32 -32
- package/dist/docs/references/reference-vectors-pg.md +60 -44
- package/dist/docs/references/reference-vectors-upstash.md +25 -25
- package/dist/docs/references/reference-voice-composite-voice.md +10 -10
- package/dist/docs/references/reference-voice-mastra-voice.md +20 -20
- package/dist/docs/references/reference-voice-voice.addInstructions.md +1 -1
- package/dist/docs/references/reference-voice-voice.addTools.md +1 -1
- package/dist/docs/references/reference-voice-voice.connect.md +3 -3
- package/dist/docs/references/reference-voice-voice.events.md +11 -11
- package/dist/docs/references/reference-voice-voice.listen.md +9 -9
- package/dist/docs/references/reference-voice-voice.on.md +2 -2
- package/dist/docs/references/reference-voice-voice.speak.md +11 -11
- package/dist/docs/references/reference-workflows-run-methods-cancel.md +2 -2
- package/dist/docs/references/reference-workflows-run-methods-restart.md +17 -5
- package/dist/docs/references/reference-workflows-run-methods-resume.md +23 -9
- package/dist/docs/references/reference-workflows-run-methods-start.md +22 -8
- package/dist/docs/references/reference-workflows-run-methods-startAsync.md +12 -6
- package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +29 -13
- package/dist/docs/references/reference-workflows-run.md +12 -12
- package/dist/docs/references/reference-workflows-step.md +24 -26
- package/dist/docs/references/reference-workflows-workflow-methods-branch.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-commit.md +1 -1
- package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +4 -4
- package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +3 -3
- package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +3 -3
- package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +9 -9
- package/dist/docs/references/reference-workflows-workflow-methods-map.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +2 -2
- package/dist/docs/references/reference-workflows-workflow-methods-then.md +2 -2
- package/dist/docs/references/reference-workflows-workflow.md +40 -50
- package/dist/docs/references/reference-workspace-filesystem.md +22 -22
- package/dist/docs/references/reference-workspace-local-filesystem.md +35 -35
- package/dist/docs/references/reference-workspace-local-sandbox.md +26 -26
- package/dist/docs/references/reference-workspace-sandbox.md +8 -8
- package/dist/docs/references/reference-workspace-workspace-class.md +30 -34
- package/dist/editor/types.d.ts +1 -0
- package/dist/editor/types.d.ts.map +1 -1
- package/dist/evals/index.cjs +20 -20
- package/dist/evals/index.js +3 -3
- package/dist/evals/scoreTraces/index.cjs +5 -5
- package/dist/evals/scoreTraces/index.js +2 -2
- package/dist/harness/harness.d.ts.map +1 -1
- package/dist/harness/index.cjs +25 -21
- package/dist/harness/index.cjs.map +1 -1
- package/dist/harness/index.js +15 -11
- package/dist/harness/index.js.map +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.js +1 -1
- package/dist/integration/index.cjs +2 -2
- package/dist/integration/index.js +1 -1
- package/dist/llm/index.cjs +12 -12
- package/dist/llm/index.js +3 -3
- package/dist/llm/model/model.d.ts.map +1 -1
- package/dist/llm/model/model.loop.d.ts.map +1 -1
- package/dist/llm/model/provider-types.generated.d.ts +5 -1
- package/dist/loop/index.cjs +14 -14
- package/dist/loop/index.js +1 -1
- package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
- package/dist/mastra/index.cjs +2 -2
- package/dist/mastra/index.js +1 -1
- package/dist/memory/index.cjs +14 -14
- package/dist/memory/index.js +1 -1
- package/dist/models-dev-2FJK72J2.cjs +12 -0
- package/dist/{models-dev-UVWCKPA2.cjs.map → models-dev-2FJK72J2.cjs.map} +1 -1
- package/dist/models-dev-CMQG6EMO.js +3 -0
- package/dist/{models-dev-W3LXZTEB.js.map → models-dev-CMQG6EMO.js.map} +1 -1
- package/dist/processor-provider/index.cjs +10 -10
- package/dist/processor-provider/index.js +1 -1
- package/dist/processors/index.cjs +42 -42
- package/dist/processors/index.js +1 -1
- package/dist/processors/processors/skills.d.ts +9 -42
- package/dist/processors/processors/skills.d.ts.map +1 -1
- package/dist/provider-registry-EHOAWHFE.cjs +40 -0
- package/dist/{provider-registry-4HLP2JRR.cjs.map → provider-registry-EHOAWHFE.cjs.map} +1 -1
- package/dist/provider-registry-LVP6T63V.js +3 -0
- package/dist/{provider-registry-K3DWQSMH.js.map → provider-registry-LVP6T63V.js.map} +1 -1
- package/dist/provider-registry.json +12 -4
- package/dist/relevance/index.cjs +3 -3
- package/dist/relevance/index.js +1 -1
- package/dist/request-context/index.cjs +4 -4
- package/dist/request-context/index.d.ts.map +1 -1
- package/dist/request-context/index.js +1 -1
- package/dist/storage/base.d.ts +34 -1
- package/dist/storage/base.d.ts.map +1 -1
- package/dist/storage/constants.cjs +56 -56
- package/dist/storage/constants.js +1 -1
- package/dist/storage/domains/agents/filesystem.d.ts +28 -0
- package/dist/storage/domains/agents/filesystem.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/experiments/inmemory.d.ts.map +1 -1
- package/dist/storage/domains/mcp-clients/filesystem.d.ts +28 -0
- package/dist/storage/domains/mcp-clients/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/mcp-clients/index.d.ts +1 -0
- package/dist/storage/domains/mcp-clients/index.d.ts.map +1 -1
- package/dist/storage/domains/mcp-servers/filesystem.d.ts +28 -0
- package/dist/storage/domains/mcp-servers/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/mcp-servers/index.d.ts +1 -0
- package/dist/storage/domains/mcp-servers/index.d.ts.map +1 -1
- package/dist/storage/domains/prompt-blocks/filesystem.d.ts +28 -0
- package/dist/storage/domains/prompt-blocks/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/prompt-blocks/index.d.ts +1 -0
- package/dist/storage/domains/prompt-blocks/index.d.ts.map +1 -1
- package/dist/storage/domains/scorer-definitions/filesystem.d.ts +28 -0
- package/dist/storage/domains/scorer-definitions/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/scorer-definitions/index.d.ts +1 -0
- package/dist/storage/domains/scorer-definitions/index.d.ts.map +1 -1
- package/dist/storage/domains/skills/filesystem.d.ts +28 -0
- package/dist/storage/domains/skills/filesystem.d.ts.map +1 -0
- 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/workspaces/filesystem.d.ts +28 -0
- package/dist/storage/domains/workspaces/filesystem.d.ts.map +1 -0
- package/dist/storage/domains/workspaces/index.d.ts +1 -0
- package/dist/storage/domains/workspaces/index.d.ts.map +1 -1
- package/dist/storage/filesystem-db.d.ts +82 -0
- package/dist/storage/filesystem-db.d.ts.map +1 -0
- package/dist/storage/filesystem-versioned.d.ts +148 -0
- package/dist/storage/filesystem-versioned.d.ts.map +1 -0
- package/dist/storage/filesystem.d.ts +39 -0
- package/dist/storage/filesystem.d.ts.map +1 -0
- package/dist/storage/git-history.d.ts +68 -0
- package/dist/storage/git-history.d.ts.map +1 -0
- package/dist/storage/index.cjs +208 -160
- package/dist/storage/index.d.ts +4 -0
- package/dist/storage/index.d.ts.map +1 -1
- package/dist/storage/index.js +2 -2
- package/dist/storage/types.d.ts +1 -0
- package/dist/storage/types.d.ts.map +1 -1
- package/dist/stream/RunOutput.d.ts +1 -1
- package/dist/stream/aisdk/v5/output-helpers.d.ts +6 -6
- package/dist/stream/base/output.d.ts +3 -3
- package/dist/stream/base/schema.d.ts +1 -1
- package/dist/stream/index.cjs +11 -11
- package/dist/stream/index.js +2 -2
- package/dist/test-utils/llm-mock.cjs +4 -4
- package/dist/test-utils/llm-mock.js +1 -1
- package/dist/tool-loop-agent/index.cjs +4 -4
- package/dist/tool-loop-agent/index.js +1 -1
- package/dist/tools/index.cjs +6 -6
- package/dist/tools/index.js +1 -1
- package/dist/tools/is-vercel-tool.cjs +2 -2
- package/dist/tools/is-vercel-tool.js +1 -1
- package/dist/tools/tool-builder/builder.d.ts.map +1 -1
- package/dist/tools/tool.d.ts +6 -0
- package/dist/tools/tool.d.ts.map +1 -1
- package/dist/tools/types.d.ts +27 -0
- package/dist/tools/types.d.ts.map +1 -1
- package/dist/utils.cjs +23 -23
- package/dist/utils.js +1 -1
- package/dist/vector/index.cjs +9 -9
- package/dist/vector/index.js +2 -2
- package/dist/workflows/evented/index.cjs +10 -10
- package/dist/workflows/evented/index.js +1 -1
- package/dist/workflows/index.cjs +25 -25
- package/dist/workflows/index.js +1 -1
- package/dist/workspace/index.cjs +70 -66
- package/dist/workspace/index.d.ts +1 -0
- package/dist/workspace/index.d.ts.map +1 -1
- package/dist/workspace/index.js +1 -1
- package/dist/workspace/sandbox/execa.d.ts +9 -0
- package/dist/workspace/sandbox/execa.d.ts.map +1 -0
- package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -1
- package/dist/workspace/skills/index.d.ts +1 -0
- package/dist/workspace/skills/index.d.ts.map +1 -1
- package/dist/workspace/skills/tools.d.ts +36 -0
- package/dist/workspace/skills/tools.d.ts.map +1 -0
- package/dist/workspace/tools/execute-command.d.ts.map +1 -1
- package/dist/workspace/tools/output-helpers.d.ts +4 -3
- package/dist/workspace/tools/output-helpers.d.ts.map +1 -1
- package/package.json +9 -9
- package/src/llm/model/provider-types.generated.d.ts +5 -1
- package/dist/chunk-3ZF7IC6Q.cjs.map +0 -1
- package/dist/chunk-4BXXAZ75.js.map +0 -1
- package/dist/chunk-4P35AVPE.cjs.map +0 -1
- package/dist/chunk-BFV3GSGS.js.map +0 -1
- package/dist/chunk-CCLV5CAA.js.map +0 -1
- package/dist/chunk-D4M6E4OQ.cjs.map +0 -1
- package/dist/chunk-D6HO5QAM.cjs.map +0 -1
- package/dist/chunk-G5R2755Q.cjs.map +0 -1
- package/dist/chunk-GJTLWOKJ.js.map +0 -1
- package/dist/chunk-H5S4PS44.cjs.map +0 -1
- package/dist/chunk-IOY7Y5GV.js.map +0 -1
- package/dist/chunk-JIRB5LX4.js.map +0 -1
- package/dist/chunk-MVYP55NA.js.map +0 -1
- package/dist/chunk-PKORY4ZZ.cjs.map +0 -1
- package/dist/chunk-QNXY3J6B.cjs.map +0 -1
- package/dist/chunk-SEKQJ447.js.map +0 -1
- package/dist/chunk-VDKWYUGC.cjs.map +0 -1
- package/dist/chunk-VWAK25TU.js.map +0 -1
- package/dist/chunk-WYPSC6CO.js.map +0 -1
- package/dist/chunk-YIJZBU54.cjs.map +0 -1
- package/dist/chunk-ZBESCKPX.cjs.map +0 -1
- package/dist/chunk-ZVWVQ6MG.js.map +0 -1
- package/dist/models-dev-UVWCKPA2.cjs +0 -12
- package/dist/models-dev-W3LXZTEB.js +0 -3
- package/dist/provider-registry-4HLP2JRR.cjs +0 -40
- package/dist/provider-registry-K3DWQSMH.js +0 -3
|
@@ -23,39 +23,35 @@ const processor = new WorkingMemory({
|
|
|
23
23
|
|
|
24
24
|
## Constructor parameters
|
|
25
25
|
|
|
26
|
-
**options
|
|
26
|
+
**options** (`Options`): Configuration options for the working memory processor
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
**options.storage** (`MemoryStorage`): Storage instance for retrieving working memory data
|
|
29
29
|
|
|
30
|
-
**
|
|
30
|
+
**options.template** (`WorkingMemoryTemplate`): Template defining the format and structure of working memory
|
|
31
31
|
|
|
32
|
-
**template
|
|
32
|
+
**options.template.format** (`'markdown' | 'json'`): Format of the working memory content
|
|
33
33
|
|
|
34
|
-
**
|
|
34
|
+
**options.template.content** (`string`): Template content defining the structure of working memory data
|
|
35
35
|
|
|
36
|
-
**
|
|
36
|
+
**options.scope** (`'thread' | 'resource'`): Scope of working memory. 'thread' scopes to current thread, 'resource' shares across all threads for the resource
|
|
37
37
|
|
|
38
|
-
**
|
|
38
|
+
**options.useVNext** (`boolean`): Use the next-generation instruction format with improved guidelines
|
|
39
39
|
|
|
40
|
-
**
|
|
40
|
+
**options.readOnly** (`boolean`): When true, working memory is provided as read-only context. The data is injected into the conversation but without the updateWorkingMemory tool or update instructions. Useful for agents that should reference working memory without modifying it.
|
|
41
41
|
|
|
42
|
-
**
|
|
42
|
+
**options.templateProvider** (`{ getWorkingMemoryTemplate(args: { memoryConfig?: MemoryConfig }): Promise<WorkingMemoryTemplate | null> }`): Dynamic template provider for runtime template resolution
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
**format:** (`'markdown' | 'json'`): Format of the working memory content
|
|
47
|
-
|
|
48
|
-
**content:** (`string`): Template content defining the structure of working memory data
|
|
44
|
+
**options.logger** (`IMastraLogger`): Optional logger instance for structured logging
|
|
49
45
|
|
|
50
46
|
## Returns
|
|
51
47
|
|
|
52
|
-
**id
|
|
48
|
+
**id** (`string`): Processor identifier set to 'working-memory'
|
|
53
49
|
|
|
54
|
-
**name
|
|
50
|
+
**name** (`string`): Processor display name set to 'WorkingMemory'
|
|
55
51
|
|
|
56
|
-
**defaultWorkingMemoryTemplate
|
|
52
|
+
**defaultWorkingMemoryTemplate** (`string`): The default markdown template used when no custom template is provided
|
|
57
53
|
|
|
58
|
-
**processInput
|
|
54
|
+
**processInput** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Retrieves working memory and adds it as a system message to the message list
|
|
59
55
|
|
|
60
56
|
## Extended usage example
|
|
61
57
|
|
|
@@ -19,9 +19,13 @@ export type DatabaseConfig = {
|
|
|
19
19
|
|
|
20
20
|
Configuration options specific to Pinecone vector store.
|
|
21
21
|
|
|
22
|
-
**namespace
|
|
22
|
+
**namespace** (`string`): Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.
|
|
23
23
|
|
|
24
|
-
**sparseVector
|
|
24
|
+
**sparseVector** (`{ indices: number[]; values: number[]; }`): Sparse vector for hybrid search combining dense and sparse embeddings. Enables better search quality for keyword-based queries. The indices and values arrays must be the same length.
|
|
25
|
+
|
|
26
|
+
**sparseVector.indices** (`number[]`): Array of indices for sparse vector components
|
|
27
|
+
|
|
28
|
+
**sparseVector.values** (`number[]`): Array of values corresponding to the indices
|
|
25
29
|
|
|
26
30
|
**Use Cases:**
|
|
27
31
|
|
|
@@ -33,11 +37,11 @@ Configuration options specific to Pinecone vector store.
|
|
|
33
37
|
|
|
34
38
|
Configuration options specific to PostgreSQL with pgvector extension.
|
|
35
39
|
|
|
36
|
-
**minScore
|
|
40
|
+
**minScore** (`number`): Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.
|
|
37
41
|
|
|
38
|
-
**ef
|
|
42
|
+
**ef** (`number`): HNSW search parameter that controls the size of the dynamic candidate list during search. Higher values improve accuracy at the cost of speed. Typically set between topK and 200.
|
|
39
43
|
|
|
40
|
-
**probes
|
|
44
|
+
**probes** (`number`): IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.
|
|
41
45
|
|
|
42
46
|
**Performance Guidelines:**
|
|
43
47
|
|
|
@@ -55,9 +59,9 @@ Configuration options specific to PostgreSQL with pgvector extension.
|
|
|
55
59
|
|
|
56
60
|
Configuration options specific to Chroma vector store.
|
|
57
61
|
|
|
58
|
-
**where
|
|
62
|
+
**where** (`Record<string, any>`): Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.
|
|
59
63
|
|
|
60
|
-
**whereDocument
|
|
64
|
+
**whereDocument** (`Record<string, any>`): Document content filtering conditions. Allows filtering based on the actual document text content.
|
|
61
65
|
|
|
62
66
|
**Filter Syntax Examples:**
|
|
63
67
|
|
|
@@ -19,19 +19,19 @@ const result = await embed({
|
|
|
19
19
|
|
|
20
20
|
### Parameters
|
|
21
21
|
|
|
22
|
-
**model
|
|
22
|
+
**model** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
|
|
23
23
|
|
|
24
|
-
**value
|
|
24
|
+
**value** (`string | Record<string, any>`): The text content or object to embed
|
|
25
25
|
|
|
26
|
-
**maxRetries
|
|
26
|
+
**maxRetries** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
|
|
27
27
|
|
|
28
|
-
**abortSignal
|
|
28
|
+
**abortSignal** (`AbortSignal`): Optional abort signal to cancel the request
|
|
29
29
|
|
|
30
|
-
**headers
|
|
30
|
+
**headers** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
|
|
31
31
|
|
|
32
32
|
### Return Value
|
|
33
33
|
|
|
34
|
-
**embedding
|
|
34
|
+
**embedding** (`number[]`): The embedding vector for the input
|
|
35
35
|
|
|
36
36
|
## Multiple Embeddings
|
|
37
37
|
|
|
@@ -49,19 +49,19 @@ const result = await embedMany({
|
|
|
49
49
|
|
|
50
50
|
### Parameters
|
|
51
51
|
|
|
52
|
-
**model
|
|
52
|
+
**model** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
|
|
53
53
|
|
|
54
|
-
**values
|
|
54
|
+
**values** (`string[] | Record<string, any>[]`): Array of text content or objects to embed
|
|
55
55
|
|
|
56
|
-
**maxRetries
|
|
56
|
+
**maxRetries** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
|
|
57
57
|
|
|
58
|
-
**abortSignal
|
|
58
|
+
**abortSignal** (`AbortSignal`): Optional abort signal to cancel the request
|
|
59
59
|
|
|
60
|
-
**headers
|
|
60
|
+
**headers** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
|
|
61
61
|
|
|
62
62
|
### Return Value
|
|
63
63
|
|
|
64
|
-
**embeddings
|
|
64
|
+
**embeddings** (`number[][]`): Array of embedding vectors corresponding to the input values
|
|
65
65
|
|
|
66
66
|
## Example Usage
|
|
67
67
|
|
|
@@ -28,25 +28,25 @@ constructor(options: MastraServerOptions<TApp>)
|
|
|
28
28
|
|
|
29
29
|
### Options
|
|
30
30
|
|
|
31
|
-
**app
|
|
31
|
+
**app** (`TApp`): Framework app instance
|
|
32
32
|
|
|
33
|
-
**mastra
|
|
33
|
+
**mastra** (`Mastra`): Mastra instance
|
|
34
34
|
|
|
35
|
-
**prefix
|
|
35
|
+
**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
|
|
36
36
|
|
|
37
|
-
**openapiPath
|
|
37
|
+
**openapiPath** (`string`): Path to serve OpenAPI spec (Default: `''`)
|
|
38
38
|
|
|
39
|
-
**bodyLimitOptions
|
|
39
|
+
**bodyLimitOptions** (`BodyLimitOptions`): Request body size limits
|
|
40
40
|
|
|
41
|
-
**streamOptions
|
|
41
|
+
**streamOptions** (`StreamOptions`): Stream redaction config (Default: `{ redact: true }`)
|
|
42
42
|
|
|
43
|
-
**customRouteAuthConfig
|
|
43
|
+
**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides
|
|
44
44
|
|
|
45
|
-
**tools
|
|
45
|
+
**tools** (`Record<string, Tool>`): Available tools for the server
|
|
46
46
|
|
|
47
|
-
**taskStore
|
|
47
|
+
**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
|
|
48
48
|
|
|
49
|
-
**mcpOptions
|
|
49
|
+
**mcpOptions** (`MCPOptions`): MCP transport options for serverless environments
|
|
50
50
|
|
|
51
51
|
## Abstract methods
|
|
52
52
|
|
|
@@ -22,35 +22,35 @@ registerApiRoute("/items/:itemId", { ... })
|
|
|
22
22
|
|
|
23
23
|
### options
|
|
24
24
|
|
|
25
|
-
**method
|
|
25
|
+
**method** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method for the route
|
|
26
26
|
|
|
27
|
-
**handler
|
|
27
|
+
**handler** (`Handler`): Route handler function receiving Hono Context. Use either \`handler\` or \`createHandler\`, not both.
|
|
28
28
|
|
|
29
|
-
**createHandler
|
|
29
|
+
**createHandler** (`(c: Context) => Promise<Handler>`): Async factory function to create the handler. Use either \`handler\` or \`createHandler\`, not both.
|
|
30
30
|
|
|
31
|
-
**middleware
|
|
31
|
+
**middleware** (`MiddlewareHandler | MiddlewareHandler[]`): Route-specific middleware functions
|
|
32
32
|
|
|
33
|
-
**openapi
|
|
33
|
+
**openapi** (`DescribeRouteOptions`): OpenAPI metadata for Swagger UI documentation
|
|
34
34
|
|
|
35
35
|
## OpenAPI Options
|
|
36
36
|
|
|
37
37
|
The `openapi` property accepts standard OpenAPI 3.1 operation fields from [hono-openapi](https://github.com/honojs/middleware/tree/main/packages/openapi). Routes without an `openapi` property are not included in Swagger UI.
|
|
38
38
|
|
|
39
|
-
**summary
|
|
39
|
+
**summary** (`string`): Short summary of the operation
|
|
40
40
|
|
|
41
|
-
**description
|
|
41
|
+
**description** (`string`): Detailed description of the operation
|
|
42
42
|
|
|
43
|
-
**tags
|
|
43
|
+
**tags** (`string[]`): Tags for grouping in Swagger UI. Defaults to \['custom'] if not specified.
|
|
44
44
|
|
|
45
|
-
**deprecated
|
|
45
|
+
**deprecated** (`boolean`): Mark the operation as deprecated
|
|
46
46
|
|
|
47
|
-
**parameters
|
|
47
|
+
**parameters** (`ParameterObject[]`): Path, query, and header parameters
|
|
48
48
|
|
|
49
|
-
**requestBody
|
|
49
|
+
**requestBody** (`RequestBodyObject`): Request body specification
|
|
50
50
|
|
|
51
|
-
**responses
|
|
51
|
+
**responses** (`ResponsesObject`): Response specifications by status code
|
|
52
52
|
|
|
53
|
-
**security
|
|
53
|
+
**security** (`SecurityRequirementObject[]`): Security requirements for the operation
|
|
54
54
|
|
|
55
55
|
## Return Value
|
|
56
56
|
|
|
@@ -129,15 +129,15 @@ Or in `wrangler.jsonc`:
|
|
|
129
129
|
|
|
130
130
|
## Parameters
|
|
131
131
|
|
|
132
|
-
**binding
|
|
132
|
+
**binding** (`D1Database`): Cloudflare D1 Workers binding (for Workers runtime)
|
|
133
133
|
|
|
134
|
-
**accountId
|
|
134
|
+
**accountId** (`string`): Cloudflare Account ID (for REST API)
|
|
135
135
|
|
|
136
|
-
**databaseId
|
|
136
|
+
**databaseId** (`string`): Cloudflare D1 Database ID (for REST API)
|
|
137
137
|
|
|
138
|
-
**apiToken
|
|
138
|
+
**apiToken** (`string`): Cloudflare API Token (for REST API)
|
|
139
139
|
|
|
140
|
-
**tablePrefix
|
|
140
|
+
**tablePrefix** (`string`): Optional prefix for all table names (useful for environment isolation)
|
|
141
141
|
|
|
142
142
|
## Additional Notes
|
|
143
143
|
|
|
@@ -120,23 +120,23 @@ export const mastra = new Mastra({
|
|
|
120
120
|
|
|
121
121
|
## Options
|
|
122
122
|
|
|
123
|
-
**id
|
|
123
|
+
**id** (`string`): Unique identifier for this storage instance.
|
|
124
124
|
|
|
125
|
-
**default
|
|
125
|
+
**default** (`MastraCompositeStore`): Default storage adapter. Domains not explicitly specified in \`domains\` will use this storage's domains as fallbacks.
|
|
126
126
|
|
|
127
|
-
**domains
|
|
127
|
+
**domains** (`object`): Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over the default storage.
|
|
128
128
|
|
|
129
|
-
**domains.memory
|
|
129
|
+
**domains.memory** (`MemoryStorage`): Storage for threads, messages, and resources.
|
|
130
130
|
|
|
131
|
-
**domains.workflows
|
|
131
|
+
**domains.workflows** (`WorkflowsStorage`): Storage for workflow snapshots.
|
|
132
132
|
|
|
133
|
-
**domains.scores
|
|
133
|
+
**domains.scores** (`ScoresStorage`): Storage for evaluation scores.
|
|
134
134
|
|
|
135
|
-
**domains.observability
|
|
135
|
+
**domains.observability** (`ObservabilityStorage`): Storage for traces and spans.
|
|
136
136
|
|
|
137
|
-
**domains.agents
|
|
137
|
+
**domains.agents** (`AgentsStorage`): Storage for stored agent configurations.
|
|
138
138
|
|
|
139
|
-
**disableInit
|
|
139
|
+
**disableInit** (`boolean`): When true, automatic initialization is disabled. You must call init() explicitly.
|
|
140
140
|
|
|
141
141
|
## Initialization
|
|
142
142
|
|
|
@@ -53,11 +53,11 @@ const storage = await LanceStorage.create('my-storage', 's3://bucket/db', {
|
|
|
53
53
|
|
|
54
54
|
### LanceStorage.create()
|
|
55
55
|
|
|
56
|
-
**name
|
|
56
|
+
**name** (`string`): Name identifier for the storage instance
|
|
57
57
|
|
|
58
|
-
**uri
|
|
58
|
+
**uri** (`string`): URI to connect to the LanceDB database. Can be a local path, cloud DB URL, or S3 bucket URL
|
|
59
59
|
|
|
60
|
-
**options
|
|
60
|
+
**options** (`ConnectionOptions`): Connection options for LanceDB, such as timeout settings, authentication, etc.
|
|
61
61
|
|
|
62
62
|
## Additional Notes
|
|
63
63
|
|
|
@@ -89,9 +89,9 @@ storage: new LibSQLStore({
|
|
|
89
89
|
|
|
90
90
|
## Options
|
|
91
91
|
|
|
92
|
-
**url
|
|
92
|
+
**url** (`string`): Database URL. Use \`:memory:\` for in-memory database, \`file:filename.db\` for a file database, or a libSQL connection string (e.g., \`libsql://your-database.turso.io\`) for remote storage.
|
|
93
93
|
|
|
94
|
-
**authToken
|
|
94
|
+
**authToken** (`string`): Authentication token for remote libSQL databases.
|
|
95
95
|
|
|
96
96
|
## Initialization
|
|
97
97
|
|
|
@@ -44,15 +44,15 @@ const storage = new MongoDBStore({
|
|
|
44
44
|
|
|
45
45
|
## Parameters
|
|
46
46
|
|
|
47
|
-
**id
|
|
47
|
+
**id** (`string`): Unique identifier for this storage instance.
|
|
48
48
|
|
|
49
|
-
**uri
|
|
49
|
+
**uri** (`string`): MongoDB connection string (e.g., mongodb+srv://user:password\@cluster.mongodb.net)
|
|
50
50
|
|
|
51
|
-
**url
|
|
51
|
+
**url** (`string`): Deprecated. Use uri instead. MongoDB connection string (supported for backward compatibility).
|
|
52
52
|
|
|
53
|
-
**dbName
|
|
53
|
+
**dbName** (`string`): The name of the database you want the storage to use.
|
|
54
54
|
|
|
55
|
-
**options
|
|
55
|
+
**options** (`MongoClientOptions`): MongoDB client options for advanced configuration (SSL, connection pooling, etc.).
|
|
56
56
|
|
|
57
57
|
> **Deprecation Notice:** The `url` parameter is deprecated but still supported for backward compatibility. Please use `uri` instead in all new code.
|
|
58
58
|
|
|
@@ -41,9 +41,9 @@ const storage = new MSSQLStore({
|
|
|
41
41
|
|
|
42
42
|
## Parameters
|
|
43
43
|
|
|
44
|
-
**connectionString
|
|
44
|
+
**connectionString** (`string`): MSSQL connection string (e.g., Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true)
|
|
45
45
|
|
|
46
|
-
**schemaName
|
|
46
|
+
**schemaName** (`string`): The name of the schema you want the storage to use. Will use the default schema if not provided.
|
|
47
47
|
|
|
48
48
|
## Constructor Examples
|
|
49
49
|
|
|
@@ -41,35 +41,35 @@ const storage = new PostgresStore({
|
|
|
41
41
|
|
|
42
42
|
## Parameters
|
|
43
43
|
|
|
44
|
-
**id
|
|
44
|
+
**id** (`string`): Unique identifier for this storage instance.
|
|
45
45
|
|
|
46
|
-
**connectionString
|
|
46
|
+
**connectionString** (`string`): PostgreSQL connection string (e.g., postgresql://user:pass\@host:5432/dbname). Required unless using \`pool\` or individual host-based parameters (\`host\`, \`port\`, \`database\`, \`user\`, \`password\`).
|
|
47
47
|
|
|
48
|
-
**host
|
|
48
|
+
**host** (`string`): Database server hostname or IP address. Used with other host-based parameters as an alternative to connectionString.
|
|
49
49
|
|
|
50
|
-
**port
|
|
50
|
+
**port** (`number`): Database server port number. Defaults to 5432 if not specified.
|
|
51
51
|
|
|
52
|
-
**database
|
|
52
|
+
**database** (`string`): Name of the database to connect to.
|
|
53
53
|
|
|
54
|
-
**user
|
|
54
|
+
**user** (`string`): Database user for authentication.
|
|
55
55
|
|
|
56
|
-
**password
|
|
56
|
+
**password** (`string`): Password for the database user.
|
|
57
57
|
|
|
58
|
-
**pool
|
|
58
|
+
**pool** (`pg.Pool`): Pre-configured pg.Pool instance. Use this to reuse an existing connection pool. When provided, Mastra will not create its own pool and will not close it when \`store.close()\` is called.
|
|
59
59
|
|
|
60
|
-
**schemaName
|
|
60
|
+
**schemaName** (`string`): The name of the schema you want the storage to use. Defaults to 'public'.
|
|
61
61
|
|
|
62
|
-
**ssl
|
|
62
|
+
**ssl** (`boolean | ConnectionOptions`): SSL configuration for the connection; set to true to use default SSL or provide a ConnectionOptions object for custom SSL settings.
|
|
63
63
|
|
|
64
|
-
**max
|
|
64
|
+
**max** (`number`): Maximum number of connections in the pool. Defaults to 20.
|
|
65
65
|
|
|
66
|
-
**idleTimeoutMillis
|
|
66
|
+
**idleTimeoutMillis** (`number`): How long a connection can sit idle before being closed. Defaults to 30000 (30 seconds).
|
|
67
67
|
|
|
68
|
-
**disableInit
|
|
68
|
+
**disableInit** (`boolean`): When true, automatic table creation/migrations are disabled. Useful for CI/CD pipelines where migrations are run separately.
|
|
69
69
|
|
|
70
|
-
**skipDefaultIndexes
|
|
70
|
+
**skipDefaultIndexes** (`boolean`): When true, default indexes will not be created during initialization.
|
|
71
71
|
|
|
72
|
-
**indexes
|
|
72
|
+
**indexes** (`CreateIndexOptions[]`): Custom indexes to create during initialization.
|
|
73
73
|
|
|
74
74
|
## Constructor Examples
|
|
75
75
|
|
|
@@ -448,25 +448,25 @@ For advanced index types, you can specify additional options:
|
|
|
448
448
|
|
|
449
449
|
### Index Options
|
|
450
450
|
|
|
451
|
-
**name
|
|
451
|
+
**name** (`string`): Unique name for the index
|
|
452
452
|
|
|
453
|
-
**table
|
|
453
|
+
**table** (`string`): Table name (e.g., 'mastra\_threads')
|
|
454
454
|
|
|
455
|
-
**columns
|
|
455
|
+
**columns** (`string[]`): Array of column names with optional sort order (e.g., \['id', 'createdAt DESC'])
|
|
456
456
|
|
|
457
|
-
**unique
|
|
457
|
+
**unique** (`boolean`): Creates a unique constraint index
|
|
458
458
|
|
|
459
|
-
**concurrent
|
|
459
|
+
**concurrent** (`boolean`): Creates index without locking table (default: true)
|
|
460
460
|
|
|
461
|
-
**where
|
|
461
|
+
**where** (`string`): Partial index condition (PostgreSQL specific)
|
|
462
462
|
|
|
463
|
-
**method
|
|
463
|
+
**method** (`'btree' | 'hash' | 'gin' | 'gist' | 'spgist' | 'brin'`): Index method (default: 'btree')
|
|
464
464
|
|
|
465
|
-
**opclass
|
|
465
|
+
**opclass** (`string`): Operator class for GIN/GIST indexes
|
|
466
466
|
|
|
467
|
-
**storage
|
|
467
|
+
**storage** (`Record<string, any>`): Storage parameters (e.g., { fillfactor: 90 })
|
|
468
468
|
|
|
469
|
-
**tablespace
|
|
469
|
+
**tablespace** (`string`): Tablespace name for index placement
|
|
470
470
|
|
|
471
471
|
### Schema-Specific Indexes
|
|
472
472
|
|
|
@@ -46,11 +46,11 @@ const storage = new UpstashStore({
|
|
|
46
46
|
|
|
47
47
|
## Parameters
|
|
48
48
|
|
|
49
|
-
**url
|
|
49
|
+
**url** (`string`): Upstash Redis URL
|
|
50
50
|
|
|
51
|
-
**token
|
|
51
|
+
**token** (`string`): Upstash Redis authentication token
|
|
52
52
|
|
|
53
|
-
**prefix
|
|
53
|
+
**prefix** (`string`): Key prefix for all stored items (Default: `mastra:`)
|
|
54
54
|
|
|
55
55
|
## Additional Notes
|
|
56
56
|
|