@mastra/memory 1.41.0-alpha.3 → 1.41.1-alpha.0

package/dist/docs/SKILL.md

@@ -0,0 +1,74 @@
+---
+name: mastra-memory
+description: Documentation for @mastra/memory. Use when working with @mastra/memory APIs, configuration, or implementation.
+metadata:
+  package: "@mastra/memory"
+  version: "1.41.1-alpha.0"
+---
+
+## When to use
+
+Use this skill whenever you are working with @mastra/memory to obtain the domain-specific knowledge.
+
+## How to use
+
+Read the individual reference documents for detailed explanations and code examples.
+
+### Docs
+
+- [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.
+- [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.
+- [Evals with memory](references/docs-evals-evals-with-memory.md) - Run Mastra evals against memory-enabled agents using shared or per-item threads, observational memory, runEvals, and dataset experiments.
+- [Context engineering](references/docs-guides-context-engineering.md) - Engineer the context Mastra agents receive by combining instructions, inline data, tools, RAG, filesystems, memory, and observational memory.
+- [Background tasks](references/docs-harness-background-tasks.md) - Run long-lived Mastra tool calls and subagents as background tasks while streams remain open, with per-call dispositions, cancellation, and completion events.
+- [Goals](references/docs-harness-goals.md) - Set a durable goal for a Mastra agent so an execution loop evaluates progress and continues working until the objective completes or its run budget ends.
+- [Knowledge](references/docs-knowledge-overview.md) - Give agents shared pages and notes they search, read and write, with access decided by your configuration rather than by the model.
+- [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.
+- [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.
+- [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.
+- [Observational Memory](references/docs-memory-observational-memory.md) - Configure Mastra Observational Memory to compress long conversations into durable observations while preserving context across threads and sessions.
+- [Memory](references/docs-memory-overview.md) - Add memory to Mastra agents with message history, observational memory, and working memory across threads and multi-agent delegation.
+- [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.
+- [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.
+- [Signals](references/docs-signals-overview.md) - Send asynchronous input into a Mastra agent thread while Mastra manages whether the agent is active or idle.
+- [Storage](references/docs-storage.md) - Configure Mastra storage to persist memory, workflow state, observability data, evals, schedules, and long-running agent state across restarts.
+- [Subagents](references/docs-subagents.md) - Build Mastra supervisor agents that delegate work to specialized subagents with hooks, request context, message filtering, and completion scoring.
+
+### Integrations
+
+- [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.
+- [Ring](references/integrations-channels-ring.md) - Send Ring doorbell and camera events to Mastra agents as notification signals with @mastra/ring-signals, and fetch snapshots and video clips with agent tools.
+- [Aurora DSQL](references/integrations-databases-aurora-dsql.md) - Store Mastra application data in Amazon Aurora DSQL with IAM authentication, configurable credentials, schema initialization, and connection options.
+- [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.
+- [Elasticsearch](references/integrations-databases-elasticsearch.md) - Store Mastra agent memory, workflow snapshots, and scores in Elasticsearch with URL, authentication, or shared client connection configuration.
+- [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.
+- [MongoDB](references/integrations-databases-mongodb.md) - Store Mastra application data and vectors in MongoDB, configure connections and collections, initialize schemas, and add persistent agent memory.
+- [OracleDB](references/integrations-databases-oracledb.md) - Persist Mastra memory, workflows, observability, scores, MCP metadata, and agent registry data in Oracle Database with OracleStore.
+- [PostgreSQL](references/integrations-databases-postgresql.md) - Persist Mastra application data in PostgreSQL with PostgresStore, configure connections and pools, initialize schemas, and enable observability.
+- [Redis](references/integrations-databases-redis.md) - Store Mastra application data in Redis using connection strings, host settings, or custom clients, including Sentinel deployments.
+- [Upstash](references/integrations-databases-upstash.md) - Use Upstash Redis as serverless Mastra storage with REST credentials, namespaced keys, durable persistence, and deployment-friendly connections.
+- [Valkey](references/integrations-databases-valkey.md) - Configure Valkey storage and caching for Mastra through the GLIDE client, including authentication, connection options, persistence, and cleanup.
+
+### Reference
+
+- [Reference: Mastra.getMemory()](references/reference-core-getMemory.md) - The .getMemory() method retrieves a memory instance from the Mastra registry by its key.
+- [Reference: Mastra.listMemory()](references/reference-core-listMemory.md) - The .listMemory() method returns all memory instances registered with the Mastra instance.
+- [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.
+- [Reference: Cloned thread utilities](references/reference-memory-clone-utilities.md) - Use Mastra Memory clone utilities to create threads derived from an existing conversation, then inspect clone relationships and manage their messages.
+- [Reference: Memory.cloneThread()](references/reference-memory-cloneThread.md) - The .cloneThread() method creates a copy of an existing conversation thread, including all its messages.
+- [Reference: Memory.copyThread()](references/reference-memory-copyThread.md) - The .copyThread() method copies a conversation thread and its messages inside the storage backend without loading message content into memory.
+- [Reference: Memory.createThread()](references/reference-memory-createThread.md) - The .createThread() method creates a new conversation thread in the memory system. Each thread represents a distinct conversation or context and can contain multiple messages.
+- [Reference: Memory.getThreadById()](references/reference-memory-getThreadById.md) - Use Memory.getThreadById() to retrieve a conversation thread by ID, including its resource association, metadata, and stored properties.
+- [Reference: Memory.listThreads()](references/reference-memory-listThreads.md) - The listThreads() method retrieves threads with pagination support and optional filtering by resourceId, metadata, or both.
+- [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.
+- [Reference: Observational Memory](references/reference-memory-observational-memory.md) - Observational Memory (OM) is Mastra's memory system for long-context agentic memory. An Observer watches conversations and creates observations.
+- [Reference: Memory.settled()](references/reference-memory-settled.md) - Use Memory.settled() to wait for asynchronous memory work, including working-memory updates and observational memory, before closing storage.
+- [Reference: summarizeConversation()](references/reference-memory-summarizeConversation.md) - The standalone summarizeConversation() function summarizes a conversation in one shot.
+- [Reference: Memory.summarizeThread()](references/reference-memory-summarizeThread.md) - Call Memory.summarizeThread() to produce a thread summary in one operation and extract configured structured values from its messages.
+- [Reference: Memory.updateThreadResourceId()](references/reference-memory-updateThreadResourceId.md) - The .updateThreadResourceId() method transfers ownership of a thread to a different resource by reassigning its resourceId.
+- [Migration: AgentNetwork to .network()](references/reference-migrations-agentnetwork.md) - Migrate deprecated AgentNetwork usage to supervisor agents and the standard Agent.generate() or Agent.stream() APIs in current Mastra releases.
+- [Memory](references/reference-migrations-upgrade-to-v1-memory.md) - Memory configuration now requires explicit parameters, and default settings have been updated for better performance and predictability.
+- [Reference: TokenLimiterProcessor](references/reference-processors-token-limiter-processor.md) - Use TokenLimiterProcessor to constrain message tokens during prompt, input, or output processing with configurable limits and strategies.
+
+
+Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.

package/dist/docs/assets/SOURCE_MAP.json

@@ -0,0 +1,244 @@
+{
+  "version": "1.41.1-alpha.0",
+  "package": "@mastra/memory",
+  "exports": {
+    "AUTO_MODEL_BY_PROVIDER": {
+      "types": "dist/processors/observational-memory/auto-model.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 32135
+    },
+    "Extractor": {
+      "types": "dist/processors/observational-memory/extractor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23936
+    },
+    "ModelByInputTokens": {
+      "types": "dist/processors/observational-memory/model-by-input-tokens.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 31918
+    },
+    "OBSERVATIONAL_MEMORY_DEFAULTS": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23675
+    },
+    "OBSERVATION_CONTEXT_INSTRUCTIONS": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23736
+    },
+    "OBSERVATION_CONTEXT_PROMPT": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23718
+    },
+    "OBSERVATION_CONTEXT_PROMPT_THREAD": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23723
+    },
+    "OBSERVATION_CONTINUATION_HINT": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23705
+    },
+    "OBSERVER_SYSTEM_PROMPT": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 26271
+    },
+    "ObservationalMemory": {
+      "types": "dist/processors/observational-memory/observational-memory.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 36943
+    },
+    "ObservationalMemoryProcessor": {
+      "types": "dist/processors/observational-memory/processor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 39678
+    },
+    "TokenCounter": {
+      "types": "dist/processors/observational-memory/token-counter.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 28768
+    },
+    "WorkingMemoryExtractor": {
+      "types": "dist/processors/observational-memory/working-memory-extractor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29784
+    },
+    "buildObserverPrompt": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 26954
+    },
+    "buildObserverSystemPrompt": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 26165
+    },
+    "combineObservationGroupRanges": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30238
+    },
+    "deriveObservationGroupProvenance": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30282
+    },
+    "extractCurrentTask": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 27267
+    },
+    "formatMessagesForObserver": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 26706
+    },
+    "getObservationContextPrompt": {
+      "types": "dist/processors/observational-memory/constants.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 23729
+    },
+    "getObservationsAsOf": {
+      "types": "dist/processors/observational-memory/observation-utils.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 39984
+    },
+    "hasCurrentTaskSection": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 27255
+    },
+    "injectAnchorIds": {
+      "types": "dist/processors/observational-memory/anchor-ids.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 24887
+    },
+    "optimizeObservationsForContext": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 27288
+    },
+    "parseAnchorId": {
+      "types": "dist/processors/observational-memory/anchor-ids.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 24871
+    },
+    "parseObservationGroups": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30193
+    },
+    "parseObserverOutput": {
+      "types": "dist/processors/observational-memory/observer-agent.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 26965
+    },
+    "reconcileObservationGroupsFromReflection": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30301
+    },
+    "renderObservationGroupsForReflection": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30267
+    },
+    "resolveAutoModelId": {
+      "types": "dist/processors/observational-memory/auto-model.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 32155
+    },
+    "stripEphemeralAnchorIds": {
+      "types": "dist/processors/observational-memory/anchor-ids.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 24910
+    },
+    "stripObservationGroups": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30210
+    },
+    "summarizeConversation": {
+      "types": "dist/processors/observational-memory/summarize.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29399
+    },
+    "wrapInObservationGroup": {
+      "types": "dist/processors/observational-memory/observation-groups.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 30189
+    },
+    "KnowledgeSemanticIndexCoordinator": {
+      "types": "dist/removed-subconscious.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29831
+    },
+    "Memory": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 40196
+    },
+    "SUMMARIZE_THREAD_DEFAULTS": {
+      "types": "dist/processors/observational-memory/summarize.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29355
+    },
+    "StaleKnowledgeSemanticIndexError": {
+      "types": "dist/removed-subconscious.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29837
+    },
+    "Subconscious": {
+      "types": "dist/removed-subconscious.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29825
+    },
+    "WORKING_MEMORY_STATE_ID": {
+      "types": "dist/processors/working-memory-state/processor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 31964
+    },
+    "WORKING_MEMORY_STATE_PROCESSOR_ID": {
+      "types": "dist/processors/working-memory-state/processor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 31965
+    },
+    "WorkingMemoryStateProcessor": {
+      "types": "dist/processors/working-memory-state/processor.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 31966
+    },
+    "deepMergeWorkingMemory": {
+      "types": "dist/tools/working-memory.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 29478
+    },
+    "extractWorkingMemoryContent": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 40049
+    },
+    "extractWorkingMemoryTags": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 40017
+    },
+    "removeWorkingMemoryTags": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/src-BIae5T_v.js",
+      "line": 40030
+    }
+  },
+  "modules": {
+    "processors": {
+      "index": "dist/processors/index.js",
+      "chunks": [
+        "src-BIae5T_v.js"
+      ]
+    }
+  }
+}