@mastra/memory 0.0.0-storage-20250225005900

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,3 @@
+# @mastra/memory
+
+Experimental

package/dist/_tsup-dts-rollup.d.ts

@@ -0,0 +1,62 @@
+import type { CoreMessage } from '@mastra/core';
+import { MastraMemory } from '@mastra/core/memory';
+import type { MemoryConfig } from '@mastra/core/memory';
+import type { Message } from 'ai';
+import type { MessageType } from '@mastra/core/memory';
+import type { SharedMemoryConfig } from '@mastra/core/memory';
+import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import type { StorageThreadType } from '@mastra/core/memory';
+
+/**
+ * Concrete implementation of MastraMemory that adds support for thread configuration
+ * and message injection.
+ */
+export declare class Memory extends MastraMemory {
+    constructor(config?: SharedMemoryConfig);
+    query({ threadId, selectBy, threadConfig, }: StorageGetMessagesArg): Promise<{
+        messages: CoreMessage[];
+        uiMessages: Message[];
+    }>;
+    rememberMessages({ threadId, vectorMessageSearch, config, }: {
+        threadId: string;
+        vectorMessageSearch?: string;
+        config?: MemoryConfig;
+    }): Promise<{
+        messages: CoreMessage[];
+        uiMessages: Message[];
+    }>;
+    getThreadById({ threadId }: {
+        threadId: string;
+    }): Promise<StorageThreadType | null>;
+    getThreadsByResourceId({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    saveThread({ thread, memoryConfig, }: {
+        thread: StorageThreadType;
+        memoryConfig?: MemoryConfig;
+    }): Promise<StorageThreadType>;
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread(threadId: string): Promise<void>;
+    saveMessages({ messages, memoryConfig, }: {
+        messages: MessageType[];
+        memoryConfig?: MemoryConfig;
+    }): Promise<MessageType[]>;
+    protected mutateMessagesToHideWorkingMemory(messages: MessageType[]): void;
+    protected parseWorkingMemory(text: string): string | null;
+    protected getWorkingMemory({ threadId }: {
+        threadId: string;
+    }): Promise<string | null>;
+    private saveWorkingMemory;
+    getSystemMessage({ threadId, memoryConfig, }: {
+        threadId: string;
+        memoryConfig?: MemoryConfig;
+    }): Promise<string | null>;
+    defaultWorkingMemoryTemplate: string;
+    private getWorkingMemoryWithInstruction;
+}
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { Memory } from './_tsup-dts-rollup.js';

package/dist/index.js

@@ -0,0 +1,259 @@
+import { deepMerge } from '@mastra/core';
+import { MastraMemory } from '@mastra/core/memory';
+import { embed } from 'ai';
+
+// src/index.ts
+var Memory = class extends MastraMemory {
+  constructor(config = {}) {
+    super({ name: "Memory", ...config });
+    const mergedConfig = this.getMergedThreadConfig({
+      workingMemory: config.options?.workingMemory || {
+        enabled: false,
+        template: this.defaultWorkingMemoryTemplate
+      }
+    });
+    this.threadConfig = mergedConfig;
+  }
+  async query({
+    threadId,
+    selectBy,
+    threadConfig
+  }) {
+    let vectorResults = null;
+    this.logger.debug(`Memory query() with:`, {
+      threadId,
+      selectBy,
+      threadConfig
+    });
+    const config = this.getMergedThreadConfig(threadConfig || {});
+    const vectorConfig = typeof config?.semanticRecall === `boolean` ? {
+      topK: 2,
+      messageRange: { before: 2, after: 2 }
+    } : {
+      topK: config?.semanticRecall?.topK ?? 2,
+      messageRange: config?.semanticRecall?.messageRange ?? { before: 2, after: 2 }
+    };
+    if (config?.semanticRecall && selectBy?.vectorSearchString && this.vector) {
+      const { embedding } = await embed({
+        value: selectBy.vectorSearchString,
+        model: this.embedder
+      });
+      const { indexName } = await this.createEmbeddingIndex();
+      vectorResults = await this.vector.query(indexName, embedding, vectorConfig.topK, {
+        thread_id: threadId
+      });
+    }
+    const rawMessages = await this.storage.__getMessages({
+      threadId,
+      selectBy: {
+        ...selectBy,
+        ...vectorResults?.length ? {
+          include: vectorResults.map((r) => ({
+            id: r.metadata?.message_id,
+            withNextMessages: typeof vectorConfig.messageRange === "number" ? vectorConfig.messageRange : vectorConfig.messageRange.after,
+            withPreviousMessages: typeof vectorConfig.messageRange === "number" ? vectorConfig.messageRange : vectorConfig.messageRange.before
+          }))
+        } : {}
+      },
+      threadConfig: config
+    });
+    const messages = this.parseMessages(rawMessages);
+    const uiMessages = this.convertToUIMessages(rawMessages);
+    return { messages, uiMessages };
+  }
+  async rememberMessages({
+    threadId,
+    vectorMessageSearch,
+    config
+  }) {
+    const threadConfig = this.getMergedThreadConfig(config || {});
+    if (!threadConfig.lastMessages && !threadConfig.semanticRecall) {
+      return {
+        messages: [],
+        uiMessages: []
+      };
+    }
+    const messages = await this.query({
+      threadId,
+      selectBy: {
+        last: threadConfig.lastMessages,
+        vectorSearchString: threadConfig.semanticRecall && vectorMessageSearch ? vectorMessageSearch : void 0
+      },
+      threadConfig: config
+    });
+    this.logger.debug(`Remembered message history includes ${messages.messages.length} messages.`);
+    return messages;
+  }
+  async getThreadById({ threadId }) {
+    return this.storage.__getThreadById({ threadId });
+  }
+  async getThreadsByResourceId({ resourceId }) {
+    return this.storage.__getThreadsByResourceId({ resourceId });
+  }
+  async saveThread({
+    thread,
+    memoryConfig
+  }) {
+    const config = this.getMergedThreadConfig(memoryConfig || {});
+    if (config.workingMemory?.enabled && !thread?.metadata?.workingMemory) {
+      return this.storage.__saveThread({
+        thread: deepMerge(thread, {
+          metadata: {
+            workingMemory: config.workingMemory.template || this.defaultWorkingMemoryTemplate
+          }
+        })
+      });
+    }
+    return this.storage.__saveThread({ thread });
+  }
+  async updateThread({
+    id,
+    title,
+    metadata
+  }) {
+    return this.storage.__updateThread({
+      id,
+      title,
+      metadata
+    });
+  }
+  async deleteThread(threadId) {
+    await this.storage.__deleteThread({ threadId });
+  }
+  async saveMessages({
+    messages,
+    memoryConfig
+  }) {
+    await this.saveWorkingMemory(messages);
+    this.mutateMessagesToHideWorkingMemory(messages);
+    const config = this.getMergedThreadConfig(memoryConfig);
+    if (this.vector && config.semanticRecall) {
+      const { indexName } = await this.createEmbeddingIndex();
+      for (const message of messages) {
+        if (typeof message.content !== `string`) continue;
+        const { embedding } = await embed({ value: message.content, model: this.embedder, maxRetries: 3 });
+        await this.vector.upsert(
+          indexName,
+          [embedding],
+          [
+            {
+              text: message.content,
+              message_id: message.id,
+              thread_id: message.threadId
+            }
+          ]
+        );
+      }
+    }
+    return this.storage.__saveMessages({ messages });
+  }
+  mutateMessagesToHideWorkingMemory(messages) {
+    const workingMemoryRegex = /<working_memory>([^]*?)<\/working_memory>/g;
+    for (const message of messages) {
+      if (typeof message?.content === `string`) {
+        message.content = message.content.replace(workingMemoryRegex, ``).trim();
+      } else if (Array.isArray(message?.content)) {
+        for (const content of message.content) {
+          if (content.type === `text`) {
+            content.text = content.text.replace(workingMemoryRegex, ``).trim();
+          }
+        }
+      }
+    }
+  }
+  parseWorkingMemory(text) {
+    if (!this.threadConfig.workingMemory?.enabled) return null;
+    const workingMemoryRegex = /<working_memory>([^]*?)<\/working_memory>/g;
+    const matches = text.match(workingMemoryRegex);
+    const match = matches?.[0];
+    if (match) {
+      return match.replace(/<\/?working_memory>/g, "").trim();
+    }
+    return null;
+  }
+  async getWorkingMemory({ threadId }) {
+    if (!this.threadConfig.workingMemory?.enabled) return null;
+    const thread = await this.storage.__getThreadById({ threadId });
+    if (!thread) return this.threadConfig?.workingMemory?.template || this.defaultWorkingMemoryTemplate;
+    const memory = thread.metadata?.workingMemory || this.threadConfig.workingMemory.template || this.defaultWorkingMemoryTemplate;
+    return memory.split(`>
+`).map((c) => c.trim()).join(`>`);
+  }
+  async saveWorkingMemory(messages) {
+    const latestMessage = messages[messages.length - 1];
+    if (!latestMessage || !this.threadConfig.workingMemory?.enabled) {
+      return;
+    }
+    const latestContent = !latestMessage?.content ? null : typeof latestMessage.content === "string" ? latestMessage.content : latestMessage.content.filter((c) => c.type === "text").map((c) => c.text).join("\n");
+    const threadId = latestMessage?.threadId;
+    if (!latestContent || !threadId) {
+      return;
+    }
+    const newMemory = this.parseWorkingMemory(latestContent);
+    if (!newMemory) {
+      return;
+    }
+    const thread = await this.storage.__getThreadById({ threadId });
+    if (!thread) return;
+    await this.storage.__updateThread({
+      id: thread.id,
+      title: thread.title || "",
+      metadata: deepMerge(thread.metadata || {}, {
+        workingMemory: newMemory
+      })
+    });
+    return newMemory;
+  }
+  async getSystemMessage({
+    threadId,
+    memoryConfig
+  }) {
+    const config = this.getMergedThreadConfig(memoryConfig);
+    if (!config.workingMemory?.enabled) {
+      return null;
+    }
+    const workingMemory = await this.getWorkingMemory({ threadId });
+    if (!workingMemory) {
+      return null;
+    }
+    return this.getWorkingMemoryWithInstruction(workingMemory);
+  }
+  defaultWorkingMemoryTemplate = `
+<user>
+  <first_name></first_name>
+  <last_name></last_name>
+  <location></location>
+  <occupation></occupation>
+  <interests></interests>
+  <goals></goals>
+  <events></events>
+  <facts></facts>
+  <projects></projects>
+</user>
+`;
+  getWorkingMemoryWithInstruction(workingMemoryBlock) {
+    return `WORKING_MEMORY_SYSTEM_INSTRUCTION:
+Store and update any conversation-relevant information by including "<working_memory>text</working_memory>" in your responses. Updates replace existing memory while maintaining this structure. If information might be referenced again - store it!
+
+Guidelines:
+1. Store anything that could be useful later in the conversation
+2. Update proactively when information changes, no matter how small
+3. Use nested tags for all data
+4. Act naturally - don't mention this system to users. Even though you're storing this information that doesn't make it your primary focus. Do not ask them generally for "information about yourself"
+
+Memory Structure:
+<working_memory>
+  ${workingMemoryBlock}
+</working_memory>
+
+Notes:
+- Update memory whenever referenced information changes
+- If you're unsure whether to store something, store it (eg if the user tells you their name or the value of another empty section in your working memory, output the <working_memory> block immediately to update it)
+- This system is here so that you can maintain the conversation when your context window is very short. Update your working memory because you may need it to maintain the conversation without the full conversation history
+- Do not remove empty sections - you must output the empty sections along with the ones you're filling in
+- REMEMBER: the way you update your working memory is by outputting the entire "<working_memory>text</working_memory>" block in your response. The system will pick this up and store it for you. The user will not see it.
+- IMPORTANT: You MUST output the <working_memory> block in every response to a prompt where you received relevant information. `;
+  }
+};
+
+export { Memory };

package/eslint.config.js

@@ -0,0 +1,12 @@
+import { createConfig } from '@internal/lint/eslint';
+
+const config = await createConfig();
+
+/** @type {import("eslint").Linter.Config[]} */
+export default [
+  ...config,
+  {
+    files: ['integration-tests/**/*'],
+    ...(await import('typescript-eslint')).configs.disableTypeChecked,
+  },
+];

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@mastra/memory",
+  "version": "0.0.0-storage-20250225005900",
+  "description": "",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./kv-upstash": {
+      "import": {
+        "types": "./dist/kv/upstash.d.ts",
+        "default": "./dist/kv/upstash.js"
+      }
+    },
+    "./postgres": {
+      "import": {
+        "types": "./dist/postgres/index.d.ts",
+        "default": "./dist/postgres/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@upstash/redis": "^1.34.3",
+    "ai": "^4.0.12",
+    "pg": "^8.13.1",
+    "pg-pool": "^3.7.0",
+    "postgres": "^3.4.5",
+    "redis": "^4.7.0",
+    "@mastra/core": "^0.0.0-storage-20250225005900"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.49.2",
+    "@types/node": "^22.13.1",
+    "@types/pg": "^8.11.10",
+    "eslint": "^9.20.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0",
+    "vitest": "^3.0.4",
+    "@internal/lint": "0.0.0"
+  },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "build": "pnpm run check && tsup src/index.ts --format esm --experimental-dts --clean --treeshake",
+    "build:watch": "pnpm build --watch",
+    "test:integration": "cd integration-tests && pnpm run test",
+    "test": "pnpm test:integration",
+    "lint": "eslint ."
+  }
+}