@scoutqa/mastra-core 0.24.6-fork.1

package/dist/mcp/types.d.ts

@@ -0,0 +1,255 @@
+import type * as http from 'node:http';
+import type { Context } from 'hono';
+import type { ToolsInput, Agent } from '../agent/index.js';
+import type { InternalCoreTool } from '../tools/index.js';
+import type { Workflow } from '../workflows/index.js';
+export type ConvertedTool = {
+    name: string;
+    description?: string;
+    parameters: InternalCoreTool['parameters'];
+    execute: InternalCoreTool['execute'];
+    toolType?: MCPToolType;
+    outputSchema?: InternalCoreTool['parameters'];
+};
+interface MCPServerSSEOptionsBase {
+    /**
+     * Parsed URL of the incoming request
+     */
+    url: URL;
+    /**
+     * Path for establishing the SSE connection (e.g. '/sse')
+     */
+    ssePath: string;
+    /**
+     * Path for POSTing client messages (e.g. '/message')
+     */
+    messagePath: string;
+}
+/**
+ * Options for starting an MCP server with SSE transport
+ */
+export interface MCPServerSSEOptions extends MCPServerSSEOptionsBase {
+    /**
+     * Incoming HTTP request
+     */
+    req: http.IncomingMessage;
+    /**
+     * HTTP response (must support .write/.end)
+     */
+    res: http.ServerResponse<http.IncomingMessage>;
+}
+/**
+ * Options for starting an MCP server with Hono SSE transport
+ */
+export interface MCPServerHonoSSEOptions extends MCPServerSSEOptionsBase {
+    /**
+     * Incoming Hono context
+     */
+    context: Context;
+}
+export interface MCPServerHTTPOptions {
+    /**
+     * Parsed URL of the incoming request
+     */
+    url: URL;
+    /**
+     * Path for establishing the HTTP connection (e.g. '/mcp')
+     */
+    httpPath: string;
+    /**
+     * Incoming HTTP request
+     */
+    req: http.IncomingMessage;
+    /**
+     * HTTP response (must support .write/.end)
+     */
+    res: http.ServerResponse<http.IncomingMessage>;
+    /**
+     * Optional options to pass to the transport (e.g. sessionIdGenerator)
+     */
+    options?: any;
+}
+/** Describes a source code repository. */
+export interface Repository {
+    /** The URL of the repository (e.g., a GitHub URL). */
+    url: string;
+    /** The source control platform (e.g., 'github', 'gitlab'). */
+    source: 'github' | 'gitlab' | string;
+    /** A unique identifier for the repository at the source. */
+    id: string;
+}
+/** Provides details about a specific version of an MCP server. */
+export interface VersionDetail {
+    /** The semantic version string (e.g., "1.0.2"). */
+    version: string;
+    /** The ISO 8601 date-time string when this version was released or registered. */
+    release_date: string;
+    /** Indicates if this version is the latest available. */
+    is_latest: boolean;
+}
+/** Base interface for command-line arguments. */
+export interface ArgumentInfo {
+    /** The name of the argument. */
+    name: string;
+    /** A description of what the argument is for. */
+    description: string;
+    /** Whether the argument is required. */
+    is_required: boolean;
+    /** Whether the argument can be specified multiple times. */
+    is_repeatable?: boolean;
+    /** Whether the argument's value can be edited by the user (e.g., in a UI). */
+    is_editable?: boolean;
+    /** A list of predefined choices for the argument's value. */
+    choices?: string[];
+    /** The default value for the argument if not specified. */
+    default_value?: string | number | boolean;
+}
+/** Describes a positional argument for a command. */
+export interface PositionalArgumentInfo extends ArgumentInfo {
+    /** The 0-indexed position of the argument. */
+    position: number;
+}
+/** Describes a named argument (flag) for a command. */
+export interface NamedArgumentInfo extends ArgumentInfo {
+    /** The short flag for the argument (e.g., "-y"). */
+    short_flag?: string;
+    /** The long flag for the argument (e.g., "--yes"). */
+    long_flag?: string;
+    /** Whether the flag requires a value (e.g., `--config <value>`) or is a boolean flag. */
+    requires_value?: boolean;
+}
+/** Describes a subcommand for a command-line tool. */
+export interface SubcommandInfo {
+    /** The name of the subcommand (e.g., "run", "list"). */
+    name: string;
+    /** A description of what the subcommand does. */
+    description: string;
+    /** Whether this subcommand is required if its parent command is used. */
+    is_required?: boolean;
+    /** Nested subcommands. */
+    subcommands?: SubcommandInfo[];
+    /** Positional arguments for this subcommand. */
+    positional_arguments?: PositionalArgumentInfo[];
+    /** Named arguments (flags) for this subcommand. */
+    named_arguments?: NamedArgumentInfo[];
+}
+/** Describes a command to run an MCP server package. */
+export interface CommandInfo {
+    /** The primary command executable (e.g., "npx", "docker"). */
+    name: 'npx' | 'docker' | 'pypi' | 'uvx' | string;
+    /** Subcommands to append to the primary command. */
+    subcommands?: SubcommandInfo[];
+    /** Positional arguments for the command. */
+    positional_arguments?: PositionalArgumentInfo[];
+    /** Named arguments (flags) for the command. */
+    named_arguments?: NamedArgumentInfo[];
+}
+/** Describes an environment variable required or used by an MCP server package. */
+export interface EnvironmentVariableInfo {
+    /** The name of the environment variable (e.g., "API_KEY"). */
+    name: string;
+    /** A description of what the environment variable is for. */
+    description: string;
+    /** Whether the environment variable is required. */
+    required?: boolean;
+    /** The default value for the environment variable if not set. */
+    default_value?: string;
+}
+/** Describes an installable package for an MCP server. */
+export interface PackageInfo {
+    /** The name of the package registry (e.g., "npm", "docker"). */
+    registry_name: 'npm' | 'docker' | 'pypi' | 'homebrew' | string;
+    /** The name of the package. */
+    name: string;
+    /** The version of the package. */
+    version: string;
+    /** The command structure to run this package as an MCP server. */
+    command?: CommandInfo;
+    /** Environment variables relevant to this package. */
+    environment_variables?: EnvironmentVariableInfo[];
+}
+/** Describes a remote endpoint for accessing an MCP server. */
+export interface RemoteInfo {
+    /** The transport type for the remote connection (e.g., "sse", "streamable"). */
+    transport_type: 'streamable' | 'sse' | string;
+    /** The URL of the remote endpoint. */
+    url: string;
+}
+/** Configuration options for creating an MCPServer instance. */
+export interface MCPServerConfig {
+    /** The display name of the MCP server. */
+    name: string;
+    /** The semantic version of the MCP server. */
+    version: string;
+    /** The tools that this MCP server will expose. */
+    tools: ToolsInput;
+    /**
+     * Optional Agent instances to be exposed as tools.
+     * Each agent will be converted into a tool named 'ask_<agentName>'.
+     */
+    agents?: Record<string, Agent>;
+    /**
+     * Optional Workflow instances to be exposed as tools.
+     * Each workflow will be converted into a tool named 'run_<workflowKey>'.
+     */
+    workflows?: Record<string, Workflow>;
+    /**
+     * Optional unique identifier for the server.
+     * If not provided, a UUID will be generated.
+     * If provided, this ID is considered final and cannot be changed by Mastra.
+     */
+    id?: string;
+    /** Optional description of the MCP server. */
+    description?: string;
+    /** Optional repository information for the server's source code. */
+    repository?: Repository;
+    /**
+     * Optional release date of this server version (ISO 8601 string).
+     * Defaults to the time of instantiation if not provided.
+     */
+    releaseDate?: string;
+    /**
+     * Optional flag indicating if this is the latest version.
+     * Defaults to true if not provided.
+     */
+    isLatest?: boolean;
+    /**
+     * Optional canonical packaging format if the server is distributed as a package
+     * (e.g., "npm", "docker").
+     */
+    packageCanonical?: 'npm' | 'docker' | 'pypi' | 'crates' | string;
+    /** Optional list of installable packages for this server. */
+    packages?: PackageInfo[];
+    /** Optional list of remote access points for this server. */
+    remotes?: RemoteInfo[];
+}
+/** Basic information about an MCP server, conforming to the MCP Registry 'Server' schema. */
+export interface ServerInfo {
+    /** The unique ID of the server. */
+    id: string;
+    /** The name of the server. */
+    name: string;
+    /** A description of the server. */
+    description?: string;
+    /** Repository information for the server. */
+    repository?: Repository;
+    /** Detailed version information. */
+    version_detail: VersionDetail;
+}
+/** Detailed information about an MCP server, conforming to the MCP Registry 'ServerDetail' schema. */
+export interface ServerDetailInfo extends ServerInfo {
+    /** The canonical packaging format, if applicable. */
+    package_canonical?: MCPServerConfig['packageCanonical'];
+    /** Information about installable packages for this server. */
+    packages?: PackageInfo[];
+    /** Information about remote access points for this server. */
+    remotes?: RemoteInfo[];
+}
+/**
+ * The type of tool registered with the MCP server.
+ * This is used to categorize tools in the MCP Server playground.
+ * If not specified, it defaults to a regular tool.
+ */
+export type MCPToolType = 'agent' | 'workflow';
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/mcp/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/mcp/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACrC,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,YAAY,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF,UAAU,uBAAuB;IAC/B;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE;;OAEG;IACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAE/C;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;CACf;AAGD,0CAA0C;AAC1C,MAAM,WAAW,UAAU;IACzB,sDAAsD;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,8DAA8D;IAC9D,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8EAA8E;IAC9E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC3C;AAED,qDAAqD;AACrD,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,uDAAuD;AACvD,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yFAAyF;IACzF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;IAC/B,gDAAgD;IAChD,oBAAoB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAChD,mDAAmD;IACnD,eAAe,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACvC;AAED,wDAAwD;AACxD,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,IAAI,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IACjD,oDAAoD;IACpD,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;IAC/B,4CAA4C;IAC5C,oBAAoB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAChD,+CAA+C;IAC/C,eAAe,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACvC;AAED,mFAAmF;AACnF,MAAM,WAAW,uBAAuB;IACtC,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC1B,gEAAgE;IAChE,aAAa,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IAC/D,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,sDAAsD;IACtD,qBAAqB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CACnD;AAED,+DAA+D;AAC/D,MAAM,WAAW,UAAU;IACzB,gFAAgF;IAChF,cAAc,EAAE,YAAY,GAAG,KAAK,GAAG,MAAM,CAAC;IAC9C,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;CACb;AAGD,gEAAgE;AAChE,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,KAAK,EAAE,UAAU,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;IACjE,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAGD,6FAA6F;AAC7F,MAAM,WAAW,UAAU;IACzB,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,oCAAoC;IACpC,cAAc,EAAE,aAAa,CAAC;CAC/B;AAED,sGAAsG;AACtG,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACxD,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,CAAC"}

package/dist/memory/index.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+var chunkCT2DMHGC_cjs = require('../chunk-CT2DMHGC.cjs');
+
+
+
+Object.defineProperty(exports, "MastraMemory", {
+  enumerable: true,
+  get: function () { return chunkCT2DMHGC_cjs.MastraMemory; }
+});
+Object.defineProperty(exports, "MemoryProcessor", {
+  enumerable: true,
+  get: function () { return chunkCT2DMHGC_cjs.MemoryProcessor; }
+});
+Object.defineProperty(exports, "memoryDefaultOptions", {
+  enumerable: true,
+  get: function () { return chunkCT2DMHGC_cjs.memoryDefaultOptions; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/memory/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/memory/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './memory.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/memory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/memory/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/memory/index.js

@@ -0,0 +1,3 @@
+export { MastraMemory, MemoryProcessor, memoryDefaultOptions } from '../chunk-ZIWN73GQ.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/memory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/memory/index.warning.d.ts

@@ -0,0 +1,6 @@
+import { MastraMemory as BaseMemory } from './memory.js';
+export * from './index.js';
+export declare abstract class MastraMemory extends BaseMemory {
+    constructor(_arg?: any);
+}
+//# sourceMappingURL=index.warning.d.ts.map

package/dist/memory/index.warning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.warning.d.ts","sourceRoot":"","sources":["../../src/memory/index.warning.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtD,cAAc,SAAS,CAAC;AAExB,8BAAsB,YAAa,SAAQ,UAAU;gBACvC,IAAI,CAAC,EAAE,GAAG;CAMvB"}

package/dist/memory/memory.d.ts

@@ -0,0 +1,272 @@
+import type { EmbeddingModelV2 } from '@ai-sdk/provider-v5';
+import type { AssistantContent, UserContent, CoreMessage, EmbeddingModel } from 'ai';
+import type { MastraMessageV2, UIMessageWithMetadata } from '../agent/message-list/index.js';
+import { MastraBase } from '../base.js';
+import type { Mastra } from '../mastra/index.js';
+import type { MastraStorage, PaginationInfo, StorageGetMessagesArg, ThreadSortOptions } from '../storage/index.js';
+import type { ToolAction } from '../tools/index.js';
+import type { MastraVector } from '../vector/index.js';
+import type { SharedMemoryConfig, StorageThreadType, MemoryConfig, MastraMessageV1, WorkingMemoryTemplate } from './types.js';
+export type MemoryProcessorOpts = {
+    systemMessage?: string;
+    memorySystemMessage?: string;
+    newMessages?: CoreMessage[];
+};
+/**
+ * Interface for message processors that can filter or transform messages
+ * before they're sent to the LLM.
+ */
+export declare abstract class MemoryProcessor extends MastraBase {
+    /**
+     * Process a list of messages and return a filtered or transformed list.
+     * @param messages The messages to process
+     * @returns The processed messages
+     */
+    process(messages: CoreMessage[], _opts: MemoryProcessorOpts): CoreMessage[] | Promise<CoreMessage[]>;
+}
+export declare const memoryDefaultOptions: {
+    lastMessages: number;
+    semanticRecall: false;
+    threads: {
+        generateTitle: true;
+    };
+    workingMemory: {
+        enabled: false;
+        template: string;
+    };
+};
+/**
+ * Abstract base class for implementing conversation memory systems.
+ *
+ * Key features:
+ * - Thread-based conversation organization with resource association
+ * - Optional vector database integration for semantic similarity search
+ * - Working memory templates for structured conversation state
+ * - Handles memory processors to manipulate messages before they are sent to the LLM
+ */
+export declare abstract class MastraMemory extends MastraBase {
+    #private;
+    MAX_CONTEXT_TOKENS?: number;
+    protected _storage?: MastraStorage;
+    vector?: MastraVector;
+    embedder?: EmbeddingModel<string> | EmbeddingModelV2<string>;
+    private processors;
+    protected threadConfig: MemoryConfig;
+    constructor(config: {
+        name: string;
+    } & SharedMemoryConfig);
+    /**
+     * Internal method used by Mastra to register itself with the memory.
+     * @param mastra The Mastra instance.
+     * @internal
+     */
+    __registerMastra(mastra: Mastra): void;
+    protected _hasOwnStorage: boolean;
+    get hasOwnStorage(): boolean;
+    get storage(): MastraStorage;
+    setStorage(storage: MastraStorage): void;
+    setVector(vector: MastraVector): void;
+    setEmbedder(embedder: EmbeddingModel<string>): void;
+    /**
+     * Get a system message to inject into the conversation.
+     * This will be called before each conversation turn.
+     * Implementations can override this to inject custom system messages.
+     */
+    getSystemMessage(_input: {
+        threadId: string;
+        resourceId?: string;
+        memoryConfig?: MemoryConfig;
+    }): Promise<string | null>;
+    /**
+     * Get tools that should be available to the agent.
+     * This will be called when converting tools for the agent.
+     * Implementations can override this to provide additional tools.
+     */
+    getTools(_config?: MemoryConfig): Record<string, ToolAction<any, any, any>>;
+    protected createEmbeddingIndex(dimensions?: number, config?: MemoryConfig): Promise<{
+        indexName: string;
+    }>;
+    getMergedThreadConfig(config?: MemoryConfig): MemoryConfig;
+    /**
+     * Apply all configured message processors to a list of messages.
+     * @param messages The messages to process
+     * @returns The processed messages
+     */
+    protected applyProcessors(messages: CoreMessage[], opts: {
+        processors?: MemoryProcessor[];
+    } & MemoryProcessorOpts): Promise<CoreMessage[]>;
+    processMessages({ messages, processors, ...opts }: {
+        messages: CoreMessage[];
+        processors?: MemoryProcessor[];
+    } & MemoryProcessorOpts): Promise<CoreMessage[]>;
+    abstract rememberMessages({ threadId, resourceId, vectorMessageSearch, config, }: {
+        threadId: string;
+        resourceId?: string;
+        vectorMessageSearch?: string;
+        config?: MemoryConfig;
+    }): Promise<{
+        messages: MastraMessageV1[];
+        messagesV2: MastraMessageV2[];
+    }>;
+    estimateTokens(text: string): number;
+    /**
+     * Retrieves a specific thread by its ID
+     * @param threadId - The unique identifier of the thread
+     * @returns Promise resolving to the thread or null if not found
+     */
+    abstract getThreadById({ threadId }: {
+        threadId: string;
+    }): Promise<StorageThreadType | null>;
+    /**
+     * Retrieves all threads that belong to the specified resource.
+     * @param resourceId - The unique identifier of the resource
+     * @param orderBy - Which timestamp field to sort by (`'createdAt'` or `'updatedAt'`);
+     *                  defaults to `'createdAt'`
+     * @param sortDirection - Sort order for the results (`'ASC'` or `'DESC'`);
+     *                        defaults to `'DESC'`
+     * @returns Promise resolving to an array of matching threads; resolves to an empty array
+     *          if the resource has no threads
+     */
+    abstract getThreadsByResourceId({ resourceId, orderBy, sortDirection, }: {
+        resourceId: string;
+    } & ThreadSortOptions): Promise<StorageThreadType[]>;
+    abstract getThreadsByResourceIdPaginated(args: {
+        resourceId: string;
+        page: number;
+        perPage: number;
+    } & ThreadSortOptions): Promise<PaginationInfo & {
+        threads: StorageThreadType[];
+    }>;
+    /**
+     * Saves or updates a thread
+     * @param thread - The thread data to save
+     * @returns Promise resolving to the saved thread
+     */
+    abstract saveThread({ thread, memoryConfig, }: {
+        thread: StorageThreadType;
+        memoryConfig?: MemoryConfig;
+    }): Promise<StorageThreadType>;
+    /**
+     * Saves messages to a thread
+     * @param messages - Array of messages to save
+     * @returns Promise resolving to the saved messages
+     */
+    abstract saveMessages(args: {
+        messages: (MastraMessageV1 | MastraMessageV2)[] | MastraMessageV1[] | MastraMessageV2[];
+        memoryConfig?: MemoryConfig | undefined;
+        format?: 'v1';
+    }): Promise<MastraMessageV1[]>;
+    abstract saveMessages(args: {
+        messages: (MastraMessageV1 | MastraMessageV2)[] | MastraMessageV1[] | MastraMessageV2[];
+        memoryConfig?: MemoryConfig | undefined;
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    abstract saveMessages(args: {
+        messages: (MastraMessageV1 | MastraMessageV2)[] | MastraMessageV1[] | MastraMessageV2[];
+        memoryConfig?: MemoryConfig | undefined;
+        format?: 'v1' | 'v2';
+    }): Promise<MastraMessageV2[] | MastraMessageV1[]>;
+    /**
+     * Retrieves all messages for a specific thread
+     * @param threadId - The unique identifier of the thread
+     * @returns Promise resolving to array of messages, uiMessages, and messagesV2
+     */
+    abstract query({ threadId, resourceId, selectBy }: StorageGetMessagesArg): Promise<{
+        messages: CoreMessage[];
+        uiMessages: UIMessageWithMetadata[];
+        messagesV2: MastraMessageV2[];
+    }>;
+    /**
+     * Helper method to create a new thread
+     * @param title - Optional title for the thread
+     * @param metadata - Optional metadata for the thread
+     * @returns Promise resolving to the created thread
+     */
+    createThread({ threadId, resourceId, title, metadata, memoryConfig, saveThread, }: {
+        resourceId: string;
+        threadId?: string;
+        title?: string;
+        metadata?: Record<string, unknown>;
+        memoryConfig?: MemoryConfig;
+        saveThread?: boolean;
+    }): Promise<StorageThreadType>;
+    /**
+     * Helper method to delete a thread
+     * @param threadId - the id of the thread to delete
+     */
+    abstract deleteThread(threadId: string): Promise<void>;
+    /**
+     * Helper method to add a single message to a thread
+     * @param threadId - The thread to add the message to
+     * @param content - The message content
+     * @param role - The role of the message sender
+     * @param type - The type of the message
+     * @param toolNames - Optional array of tool names that were called
+     * @param toolCallArgs - Optional array of tool call arguments
+     * @param toolCallIds - Optional array of tool call ids
+     * @returns Promise resolving to the saved message
+     * @deprecated use saveMessages instead
+     */
+    addMessage({ threadId, resourceId, config, content, role, type, toolNames, toolCallArgs, toolCallIds, }: {
+        threadId: string;
+        resourceId: string;
+        config?: MemoryConfig;
+        content: UserContent | AssistantContent;
+        role: 'user' | 'assistant';
+        type: 'text' | 'tool-call' | 'tool-result';
+        toolNames?: string[];
+        toolCallArgs?: Record<string, unknown>[];
+        toolCallIds?: string[];
+    }): Promise<MastraMessageV1>;
+    /**
+     * Generates a unique identifier
+     * @returns A unique string ID
+     */
+    generateId(): string;
+    /**
+     * Retrieves working memory for a specific thread
+     * @param threadId - The unique identifier of the thread
+     * @param resourceId - The unique identifier of the resource
+     * @param memoryConfig - Optional memory configuration
+     * @returns Promise resolving to working memory data or null if not found
+     */
+    abstract getWorkingMemory({ threadId, resourceId, memoryConfig, }: {
+        threadId: string;
+        resourceId?: string;
+        memoryConfig?: MemoryConfig;
+    }): Promise<string | null>;
+    /**
+     * Retrieves working memory template for a specific thread
+     * @param memoryConfig - Optional memory configuration
+     * @returns Promise resolving to working memory template or null if not found
+     */
+    abstract getWorkingMemoryTemplate({ memoryConfig, }?: {
+        memoryConfig?: MemoryConfig;
+    }): Promise<WorkingMemoryTemplate | null>;
+    abstract updateWorkingMemory({ threadId, resourceId, workingMemory, memoryConfig, }: {
+        threadId: string;
+        resourceId?: string;
+        workingMemory: string;
+        memoryConfig?: MemoryConfig;
+    }): Promise<void>;
+    /**
+     * @warning experimental! can be removed or changed at any time
+     */
+    abstract __experimental_updateWorkingMemoryVNext({ threadId, resourceId, workingMemory, searchString, memoryConfig, }: {
+        threadId: string;
+        resourceId?: string;
+        workingMemory: string;
+        searchString?: string;
+        memoryConfig?: MemoryConfig;
+    }): Promise<{
+        success: boolean;
+        reason: string;
+    }>;
+    /**
+     * Deletes multiple messages by their IDs
+     * @param messageIds - Array of message IDs to delete
+     * @returns Promise that resolves when all messages are deleted
+     */
+    abstract deleteMessages(messageIds: string[]): Promise<void>;
+}
+//# sourceMappingURL=memory.d.ts.map

package/dist/memory/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/memory/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AAErF,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE1G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;CAC7B,CAAC;AACF;;;GAGG;AACH,8BAAsB,eAAgB,SAAQ,UAAU;IACtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,mBAAmB,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAGrG;AAED,eAAO,MAAM,oBAAoB;;;;;;;;;;CAqBT,CAAC;AAEzB;;;;;;;;GAQG;AACH,8BAAsB,YAAa,SAAQ,UAAU;;IACnD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACnC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,UAAU,CAAyB;IAC3C,SAAS,CAAC,YAAY,EAAE,YAAY,CAA+B;gBAGvD,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,kBAAkB;IAiCzD;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAItC,SAAS,CAAC,cAAc,UAAS;IACjC,IAAI,aAAa,YAEhB;IAED,IAAI,OAAO,kBAOV;IAEM,UAAU,CAAC,OAAO,EAAE,aAAa;IAIjC,SAAS,CAAC,MAAM,EAAE,YAAY;IAI9B,WAAW,CAAC,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC;IAInD;;;;OAIG;IACU,gBAAgB,CAAC,MAAM,EAAE;QACpC,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI1B;;;;OAIG;IACI,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;cAIlE,oBAAoB,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAqCzG,qBAAqB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY;IAejE;;;;OAIG;cACa,eAAe,CAC7B,QAAQ,EAAE,WAAW,EAAE,EACvB,IAAI,EAAE;QACJ,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;KAChC,GAAG,mBAAmB,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC;IAmBzB,eAAe,CAAC,EACd,QAAQ,EACR,UAAU,EACV,GAAG,IAAI,EACR,EAAE;QACD,QAAQ,EAAE,WAAW,EAAE,CAAC;QACxB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;KAChC,GAAG,mBAAmB;IAIvB,QAAQ,CAAC,gBAAgB,CAAC,EACxB,QAAQ,EACR,UAAU,EACV,mBAAmB,EACnB,MAAM,GACP,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,eAAe,EAAE,CAAC;QAAC,UAAU,EAAE,eAAe,EAAE,CAAA;KAAE,CAAC;IAE3E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIpC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAE7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAC9B,UAAU,EACV,OAAO,EACP,aAAa,GACd,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAE5E,QAAQ,CAAC,+BAA+B,CACtC,IAAI,EAAE;QACJ,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,iBAAiB,GACpB,OAAO,CAAC,cAAc,GAAG;QAAE,OAAO,EAAE,iBAAiB,EAAE,CAAA;KAAE,CAAC;IAE7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAClB,MAAM,EACN,YAAY,GACb,EAAE;QACD,MAAM,EAAE,iBAAiB,CAAC;QAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE;QAC1B,QAAQ,EAAE,CAAC,eAAe,GAAG,eAAe,CAAC,EAAE,GAAG,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC;QACxF,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;QACxC,MAAM,CAAC,EAAE,IAAI,CAAC;KACf,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE;QAC1B,QAAQ,EAAE,CAAC,eAAe,GAAG,eAAe,CAAC,EAAE,GAAG,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC;QACxF,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;QACxC,MAAM,EAAE,IAAI,CAAC;KACd,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE;QAC1B,QAAQ,EAAE,CAAC,eAAe,GAAG,eAAe,CAAC,EAAE,GAAG,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC;QACxF,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;QACxC,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;KACtB,GAAG,OAAO,CAAC,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC;IAElD;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC;QACjF,QAAQ,EAAE,WAAW,EAAE,CAAC;QACxB,UAAU,EAAE,qBAAqB,EAAE,CAAC;QACpC,UAAU,EAAE,eAAe,EAAE,CAAC;KAC/B,CAAC;IAEF;;;;;OAKG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,UAAU,EACV,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,UAAiB,GAClB,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACnC,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAa9B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,EACf,QAAQ,EACR,UAAU,EACV,MAAM,EACN,OAAO,EACP,IAAI,EACJ,IAAI,EACJ,SAAS,EACT,YAAY,EACZ,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,OAAO,EAAE,WAAW,GAAG,gBAAgB,CAAC;QACxC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;QAC3B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,aAAa,CAAC;QAC3C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QACzC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,GAAG,OAAO,CAAC,eAAe,CAAC;IAmB5B;;;OAGG;IACI,UAAU,IAAI,MAAM;IAI3B;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EACxB,QAAQ,EACR,UAAU,EACV,YAAY,GACb,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAChC,YAAY,GACb,CAAC,EAAE;QACF,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAEzC,QAAQ,CAAC,mBAAmB,CAAC,EAC3B,QAAQ,EACR,UAAU,EACV,aAAa,EACb,YAAY,GACb,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,uCAAuC,CAAC,EAC/C,QAAQ,EACR,UAAU,EACV,aAAa,EACb,YAAY,EACZ,YAAY,GACb,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAEjD;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAC7D"}