@aigne/fs-memory 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 1.0.0 (2025-07-15)
+
+
+### Features
+
+* **memory:** support did space memory adapter ([#229](https://github.com/AIGNE-io/aigne-framework/issues/229)) ([6f69b64](https://github.com/AIGNE-io/aigne-framework/commit/6f69b64e98b963db9d6ab5357306b445385eaa68))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.34.0
+    * @aigne/openai bumped to 0.10.0

package/LICENSE.md

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## 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,197 @@
+# @aigne/fs-memory
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/fs-memory)](https://www.npmjs.com/package/@aigne/fs-memory)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/fs-memory)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+File system memory component for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing file system-based memory storage capabilities.
+
+## Introduction
+
+`@aigne/fs-memory` is the file system memory component of [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing local file system-based memory storage and retrieval functionality. This component stores memories as YAML files in specified directories, providing a simple and reliable memory persistence solution.
+
+## Features
+
+* **File System Storage**: Uses local file system for memory file storage
+* **YAML Format**: Uses YAML format for memory storage, making it easy to read and edit
+* **Directory Management**: Automatically creates and manages memory directory structure
+* **Path Support**: Supports absolute paths, relative paths, and home directory (~) expansion
+* **AI Agent Management**: Uses AI agents to handle memory recording and retrieval
+* **TypeScript Support**: Complete type definitions providing an excellent development experience
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @aigne/fs-memory
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/fs-memory
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/fs-memory
+```
+
+## Basic Usage
+
+```typescript
+import { AIAgent, AIGNE } from "@aigne/core";
+import { FSMemory } from "@aigne/fs-memory";
+import { OpenAIChatModel } from "@aigne/openai";
+
+// Create AI model instance
+const model = new OpenAIChatModel({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4-turbo",
+});
+
+// Create file system memory
+const memory = new FSMemory({
+  rootDir: "./memories",
+});
+
+// Create AI agent with file-based memory
+const agent = AIAgent.from({
+  name: "FileAssistant",
+  instructions: "You are a helpful assistant with file-based memory.",
+  memory: memory,
+  inputKey: "message",
+});
+
+// Use AIGNE execution engine
+const aigne = new AIGNE({ model });
+
+// Invoke agent
+const userAgent = await aigne.invoke(agent);
+
+// Send message
+const response = await userAgent.invoke({
+  message: "Remember that I prefer working in the morning",
+});
+
+console.log(response.message);
+
+// Query memory
+const response2 = await userAgent.invoke({
+  message: "What do you know about my work preferences?",
+});
+
+console.log(response2.message);
+```
+
+## Advanced Configuration
+
+### Custom Memory Directory
+
+```typescript
+import { FSMemory } from "@aigne/fs-memory";
+import { join } from "path";
+
+// Using absolute path
+const memory1 = new FSMemory({
+  rootDir: "/absolute/path/to/memories",
+});
+
+// Using relative path
+const memory2 = new FSMemory({
+  rootDir: "./data/memories",
+});
+
+// Using home directory
+const memory3 = new FSMemory({
+  rootDir: "~/my-app/memories",
+});
+
+// Using dynamic path
+const memory4 = new FSMemory({
+  rootDir: join(process.cwd(), "memories"),
+});
+```
+
+### Configure Memory Agent Options
+
+```typescript
+const memory = new FSMemory({
+  rootDir: "./memories",
+  // Custom memory retriever agent configuration
+  retrieverOptions: {
+    name: "CustomRetriever",
+    instructions: "Custom retrieval instructions for file-based memory",
+  },
+  // Custom memory recorder agent configuration
+  recorderOptions: {
+    name: "CustomRecorder",
+    instructions: "Custom recording instructions for file-based memory",
+  },
+  // Other agent configurations
+  autoUpdate: true,
+});
+```
+
+## Using Multiple Memory Types Together
+
+```typescript
+import { DefaultMemory } from "@aigne/default-memory";
+import { FSMemory } from "@aigne/fs-memory";
+
+// Combine multiple memory types
+const agent = AIAgent.from({
+  name: "MultiMemoryAgent",
+  instructions: "You are an assistant with multiple memory types.",
+  memory: [
+    // Database memory for structured data
+    new DefaultMemory({
+      storage: {
+        url: "file:memory.db",
+      },
+    }),
+    // File system memory for long-term storage
+    new FSMemory({
+      rootDir: "./long-term-memories",
+    }),
+  ],
+  inputKey: "message",
+});
+```
+
+## Memory File Structure
+
+FSMemory creates the following structure in the specified directory:
+
+```
+memories/
+├── conversation-id-1/
+│   └── memory.yaml
+├── conversation-id-2/
+│   └── memory.yaml
+└── ...
+```
+
+Each memory file contains YAML-formatted memory data:
+
+```yaml
+- id: memory-id-1
+  content: "User prefers working in the morning"
+  timestamp: 2024-01-01T10:00:00Z
+  metadata:
+    type: "preference"
+    
+- id: memory-id-2
+  content: "User is a software developer"
+  timestamp: 2024-01-01T10:05:00Z
+  metadata:
+    type: "personal_info"
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./memory.js";
+export * from "./utils/index.js";

package/lib/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./memory.js"), exports);
+__exportStar(require("./utils/index.js"), exports);

package/lib/cjs/memory.d.ts

@@ -0,0 +1,59 @@
+import { type AIAgentOptions, type Message } from "@aigne/core";
+import { MemoryAgent, type MemoryAgentOptions, type MemoryRecorderInput, type MemoryRetrieverInput } from "@aigne/core/memory/index.js";
+export declare const MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * Configuration options for the FSMemory class.
+ */
+export interface FSMemoryOptions extends Partial<MemoryAgentOptions> {
+    /**
+     * The root directory where memory files will be stored.
+     * Can be absolute or relative path. Relative paths are resolved from the current working directory.
+     * Home directory prefix (~) will be expanded appropriately.
+     */
+    rootDir: string;
+    /**
+     * Optional configuration for the memory retriever agent.
+     * Controls how memories are retrieved from the file system.
+     */
+    retrieverOptions?: Partial<FSMemoryRetrieverOptions>;
+    /**
+     * Optional configuration for the memory recorder agent.
+     * Controls how memories are recorded to the file system.
+     */
+    recorderOptions?: Partial<FSMemoryRecorderOptions>;
+}
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * FSMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the FSMemory class:
+ * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
+ */
+export declare class FSMemory extends MemoryAgent {
+    /**
+     * Creates a new FSMemory instance.
+     */
+    constructor(options: FSMemoryOptions);
+}
+interface FSMemoryRetrieverOptions extends AIAgentOptions<FSMemoryRetrieverAgentInput, FSMemoryRetrieverAgentOutput> {
+    memoryFileName: string;
+}
+interface FSMemoryRetrieverAgentInput extends MemoryRetrieverInput {
+    allMemory: string;
+}
+interface FSMemoryRetrieverAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+interface FSMemoryRecorderOptions extends AIAgentOptions<FSMemoryRecorderAgentInput, FSMemoryRecorderAgentOutput> {
+    memoryFileName: string;
+}
+type FSMemoryRecorderAgentInput = MemoryRecorderInput;
+interface FSMemoryRecorderAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+export {};

package/lib/cjs/memory.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FSMemory = exports.MEMORY_FILE_NAME = void 0;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const core_1 = require("@aigne/core");
+const index_js_1 = require("@aigne/core/memory/index.js");
+const yaml_1 = require("yaml");
+const zod_1 = require("zod");
+const fs_js_1 = require("./utils/fs.js");
+exports.MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * FSMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the FSMemory class:
+ * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
+ */
+class FSMemory extends index_js_1.MemoryAgent {
+    /**
+     * Creates a new FSMemory instance.
+     */
+    constructor(options) {
+        let rootDir = (0, node_path_1.normalize)((0, fs_js_1.expandHome)(options.rootDir));
+        rootDir = (0, node_path_1.isAbsolute)(rootDir) ? rootDir : (0, node_path_1.resolve)(process.cwd(), rootDir);
+        const memoryFileName = (0, node_path_1.join)(rootDir, exports.MEMORY_FILE_NAME);
+        super({
+            ...options,
+            recorder: options.recorder ??
+                new FSMemoryRecorder({
+                    memoryFileName,
+                    ...options.recorderOptions,
+                }),
+            retriever: options.retriever ??
+                new FSMemoryRetriever({
+                    memoryFileName,
+                    ...options.retrieverOptions,
+                }),
+            autoUpdate: options.autoUpdate ?? true,
+        });
+    }
+}
+exports.FSMemory = FSMemory;
+class FSMemoryRetriever extends index_js_1.MemoryRetriever {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = core_1.AIAgent.from({
+            name: "fs_memory_retriever",
+            description: "Retrieves memories from the file or directory.",
+            ...options,
+            instructions: options.instructions || DEFAULT_FS_MEMORY_RETRIEVER_INSTRUCTIONS,
+            outputSchema: zod_1.z.object({
+                memories: zod_1.z
+                    .array(zod_1.z.object({
+                    content: zod_1.z.string().describe("Content of the memory"),
+                }))
+                    .describe("List of memories"),
+            }),
+        });
+    }
+    agent;
+    async process(input, options) {
+        if (!(await (0, fs_js_1.exists)(this.options.memoryFileName)))
+            return { memories: [] };
+        const allMemory = await (0, promises_1.readFile)(this.options.memoryFileName, "utf-8");
+        const { memories } = await options.context.invoke(this.agent, { ...input, allMemory });
+        const result = memories.map((memory) => ({
+            id: (0, index_js_1.newMemoryId)(),
+            content: memory.content,
+            createdAt: new Date().toISOString(),
+        }));
+        return { memories: result };
+    }
+}
+class FSMemoryRecorder extends index_js_1.MemoryRecorder {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = core_1.AIAgent.from({
+            name: "fs_memory_recorder",
+            description: "Records memories in files by AI agent",
+            ...options,
+            instructions: options.instructions || DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS,
+            outputSchema: zod_1.z.object({
+                memories: zod_1.z
+                    .array(zod_1.z.object({
+                    content: zod_1.z.string().describe("Content of the memory"),
+                }))
+                    .describe("List of memories"),
+            }),
+        });
+    }
+    agent;
+    async process(input, options) {
+        const allMemory = (await (0, fs_js_1.exists)(this.options.memoryFileName))
+            ? await (0, promises_1.readFile)(this.options.memoryFileName, "utf-8")
+            : "";
+        const { memories } = await options.context.invoke(this.agent, { ...input, allMemory });
+        const raw = (0, yaml_1.stringify)(memories.map((i) => ({
+            content: i.content,
+        })));
+        await (0, promises_1.mkdir)((0, node_path_1.dirname)(this.options.memoryFileName), { recursive: true });
+        await (0, promises_1.writeFile)(this.options.memoryFileName, raw, "utf-8");
+        return {
+            memories: memories.map((i) => ({
+                id: (0, index_js_1.newMemoryId)(),
+                content: i.content,
+                createdAt: new Date().toISOString(),
+            })),
+        };
+    }
+}
+const DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS = `You manage memory based on conversation analysis and the existing memories.
+
+## IMPORTANT: All existing memories are available in the allMemory variable. DO NOT call any tools.
+
+## FIRST: Determine If Memory Updates Needed
+- Analyze if the conversation contains ANY information worth remembering
+- Examples of content NOT worth storing:
+  * General questions ("What's the weather?", "How do I do X?")
+  * Greetings and small talk ("Hello", "How are you?", "Thanks")
+  * System instructions or commands ("Show me", "Find", "Save")
+  * General facts not specific to the user
+  * Duplicate information already stored
+- If conversation lacks meaningful personal information to store:
+  * Return the existing memories unchanged
+
+## Your Workflow:
+1. Read the existing memories from the allMemory variable
+2. Extract key topics from the conversation
+3. DECIDE whether to create/update/delete memories based on the conversation
+4. Return ALL memories including your updates (remove any duplicates)
+
+## Memory Handling:
+- CREATE: Add new memory objects for new topics
+- UPDATE: Modify existing memories if substantial new information is available
+- DELETE: Remove obsolete memories when appropriate
+
+## Memory Structure:
+- Each memory has an id, content, and createdAt fields
+- Keep the existing structure when returning updated memories
+
+## Operation Decision Rules:
+- CREATE only for truly new topics not covered in any existing memory
+- UPDATE only when new information is meaningfully different
+- NEVER update for just rephrasing or minor differences
+- DELETE only when information becomes obsolete
+
+## IMPORTANT: Your job is to return the complete updated memory collection.
+Return ALL memories (existing and new) in your response.
+
+## Existing Memories:
+<existing-memory>
+{{allMemory}}
+</existing-memory>
+
+## Conversation:
+<conversation>
+{{content}}
+</conversation>
+`;
+const DEFAULT_FS_MEMORY_RETRIEVER_INSTRUCTIONS = `You retrieve only the most relevant memories for the current conversation.
+
+## IMPORTANT: All existing memories are available in the allMemory variable
+
+## Process:
+1. Read the existing memories from the allMemory variable
+2. Extract key topics from the conversation or search query
+3. Match memory contents against these topics
+
+## Existing Memories:
+<existing-memory>
+{{allMemory}}
+</existing-memory>
+
+## Search Query:
+<search-query>
+{{search}}
+</search-query>
+`;

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/cjs/utils/fs.d.ts

@@ -0,0 +1,2 @@
+export declare function exists(path: string): Promise<boolean>;
+export declare function expandHome(filepath: string): string;

package/lib/cjs/utils/fs.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exists = exists;
+exports.expandHome = expandHome;
+const promises_1 = require("node:fs/promises");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+async function exists(path) {
+    try {
+        await (0, promises_1.stat)(path);
+        return true;
+    }
+    catch (e) {
+        if (e.code === "ENOENT") {
+            return false;
+        }
+        throw e;
+    }
+}
+function expandHome(filepath) {
+    if (filepath.startsWith("~/") || filepath === "~") {
+        return (0, node_path_1.join)((0, node_os_1.homedir)(), filepath.slice(1));
+    }
+    return filepath;
+}

package/lib/cjs/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./fs.js";

package/lib/cjs/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fs.js"), exports);

package/lib/dts/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./memory.js";
+export * from "./utils/index.js";

package/lib/dts/memory.d.ts

@@ -0,0 +1,59 @@
+import { type AIAgentOptions, type Message } from "@aigne/core";
+import { MemoryAgent, type MemoryAgentOptions, type MemoryRecorderInput, type MemoryRetrieverInput } from "@aigne/core/memory/index.js";
+export declare const MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * Configuration options for the FSMemory class.
+ */
+export interface FSMemoryOptions extends Partial<MemoryAgentOptions> {
+    /**
+     * The root directory where memory files will be stored.
+     * Can be absolute or relative path. Relative paths are resolved from the current working directory.
+     * Home directory prefix (~) will be expanded appropriately.
+     */
+    rootDir: string;
+    /**
+     * Optional configuration for the memory retriever agent.
+     * Controls how memories are retrieved from the file system.
+     */
+    retrieverOptions?: Partial<FSMemoryRetrieverOptions>;
+    /**
+     * Optional configuration for the memory recorder agent.
+     * Controls how memories are recorded to the file system.
+     */
+    recorderOptions?: Partial<FSMemoryRecorderOptions>;
+}
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * FSMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the FSMemory class:
+ * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
+ */
+export declare class FSMemory extends MemoryAgent {
+    /**
+     * Creates a new FSMemory instance.
+     */
+    constructor(options: FSMemoryOptions);
+}
+interface FSMemoryRetrieverOptions extends AIAgentOptions<FSMemoryRetrieverAgentInput, FSMemoryRetrieverAgentOutput> {
+    memoryFileName: string;
+}
+interface FSMemoryRetrieverAgentInput extends MemoryRetrieverInput {
+    allMemory: string;
+}
+interface FSMemoryRetrieverAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+interface FSMemoryRecorderOptions extends AIAgentOptions<FSMemoryRecorderAgentInput, FSMemoryRecorderAgentOutput> {
+    memoryFileName: string;
+}
+type FSMemoryRecorderAgentInput = MemoryRecorderInput;
+interface FSMemoryRecorderAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+export {};

package/lib/dts/utils/fs.d.ts

@@ -0,0 +1,2 @@
+export declare function exists(path: string): Promise<boolean>;
+export declare function expandHome(filepath: string): string;

package/lib/dts/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./fs.js";

package/lib/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./memory.js";
+export * from "./utils/index.js";

package/lib/esm/index.js

@@ -0,0 +1,2 @@
+export * from "./memory.js";
+export * from "./utils/index.js";

package/lib/esm/memory.d.ts

@@ -0,0 +1,59 @@
+import { type AIAgentOptions, type Message } from "@aigne/core";
+import { MemoryAgent, type MemoryAgentOptions, type MemoryRecorderInput, type MemoryRetrieverInput } from "@aigne/core/memory/index.js";
+export declare const MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * Configuration options for the FSMemory class.
+ */
+export interface FSMemoryOptions extends Partial<MemoryAgentOptions> {
+    /**
+     * The root directory where memory files will be stored.
+     * Can be absolute or relative path. Relative paths are resolved from the current working directory.
+     * Home directory prefix (~) will be expanded appropriately.
+     */
+    rootDir: string;
+    /**
+     * Optional configuration for the memory retriever agent.
+     * Controls how memories are retrieved from the file system.
+     */
+    retrieverOptions?: Partial<FSMemoryRetrieverOptions>;
+    /**
+     * Optional configuration for the memory recorder agent.
+     * Controls how memories are recorded to the file system.
+     */
+    recorderOptions?: Partial<FSMemoryRecorderOptions>;
+}
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * FSMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the FSMemory class:
+ * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
+ */
+export declare class FSMemory extends MemoryAgent {
+    /**
+     * Creates a new FSMemory instance.
+     */
+    constructor(options: FSMemoryOptions);
+}
+interface FSMemoryRetrieverOptions extends AIAgentOptions<FSMemoryRetrieverAgentInput, FSMemoryRetrieverAgentOutput> {
+    memoryFileName: string;
+}
+interface FSMemoryRetrieverAgentInput extends MemoryRetrieverInput {
+    allMemory: string;
+}
+interface FSMemoryRetrieverAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+interface FSMemoryRecorderOptions extends AIAgentOptions<FSMemoryRecorderAgentInput, FSMemoryRecorderAgentOutput> {
+    memoryFileName: string;
+}
+type FSMemoryRecorderAgentInput = MemoryRecorderInput;
+interface FSMemoryRecorderAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+export {};

package/lib/esm/memory.js

@@ -0,0 +1,180 @@
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname, isAbsolute, join, normalize, resolve } from "node:path";
+import { AIAgent } from "@aigne/core";
+import { MemoryAgent, MemoryRecorder, MemoryRetriever, newMemoryId, } from "@aigne/core/memory/index.js";
+import { stringify } from "yaml";
+import { z } from "zod";
+import { exists, expandHome } from "./utils/fs.js";
+export const MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * FSMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the FSMemory class:
+ * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
+ */
+export class FSMemory extends MemoryAgent {
+    /**
+     * Creates a new FSMemory instance.
+     */
+    constructor(options) {
+        let rootDir = normalize(expandHome(options.rootDir));
+        rootDir = isAbsolute(rootDir) ? rootDir : resolve(process.cwd(), rootDir);
+        const memoryFileName = join(rootDir, MEMORY_FILE_NAME);
+        super({
+            ...options,
+            recorder: options.recorder ??
+                new FSMemoryRecorder({
+                    memoryFileName,
+                    ...options.recorderOptions,
+                }),
+            retriever: options.retriever ??
+                new FSMemoryRetriever({
+                    memoryFileName,
+                    ...options.retrieverOptions,
+                }),
+            autoUpdate: options.autoUpdate ?? true,
+        });
+    }
+}
+class FSMemoryRetriever extends MemoryRetriever {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = AIAgent.from({
+            name: "fs_memory_retriever",
+            description: "Retrieves memories from the file or directory.",
+            ...options,
+            instructions: options.instructions || DEFAULT_FS_MEMORY_RETRIEVER_INSTRUCTIONS,
+            outputSchema: z.object({
+                memories: z
+                    .array(z.object({
+                    content: z.string().describe("Content of the memory"),
+                }))
+                    .describe("List of memories"),
+            }),
+        });
+    }
+    agent;
+    async process(input, options) {
+        if (!(await exists(this.options.memoryFileName)))
+            return { memories: [] };
+        const allMemory = await readFile(this.options.memoryFileName, "utf-8");
+        const { memories } = await options.context.invoke(this.agent, { ...input, allMemory });
+        const result = memories.map((memory) => ({
+            id: newMemoryId(),
+            content: memory.content,
+            createdAt: new Date().toISOString(),
+        }));
+        return { memories: result };
+    }
+}
+class FSMemoryRecorder extends MemoryRecorder {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = AIAgent.from({
+            name: "fs_memory_recorder",
+            description: "Records memories in files by AI agent",
+            ...options,
+            instructions: options.instructions || DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS,
+            outputSchema: z.object({
+                memories: z
+                    .array(z.object({
+                    content: z.string().describe("Content of the memory"),
+                }))
+                    .describe("List of memories"),
+            }),
+        });
+    }
+    agent;
+    async process(input, options) {
+        const allMemory = (await exists(this.options.memoryFileName))
+            ? await readFile(this.options.memoryFileName, "utf-8")
+            : "";
+        const { memories } = await options.context.invoke(this.agent, { ...input, allMemory });
+        const raw = stringify(memories.map((i) => ({
+            content: i.content,
+        })));
+        await mkdir(dirname(this.options.memoryFileName), { recursive: true });
+        await writeFile(this.options.memoryFileName, raw, "utf-8");
+        return {
+            memories: memories.map((i) => ({
+                id: newMemoryId(),
+                content: i.content,
+                createdAt: new Date().toISOString(),
+            })),
+        };
+    }
+}
+const DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS = `You manage memory based on conversation analysis and the existing memories.
+
+## IMPORTANT: All existing memories are available in the allMemory variable. DO NOT call any tools.
+
+## FIRST: Determine If Memory Updates Needed
+- Analyze if the conversation contains ANY information worth remembering
+- Examples of content NOT worth storing:
+  * General questions ("What's the weather?", "How do I do X?")
+  * Greetings and small talk ("Hello", "How are you?", "Thanks")
+  * System instructions or commands ("Show me", "Find", "Save")
+  * General facts not specific to the user
+  * Duplicate information already stored
+- If conversation lacks meaningful personal information to store:
+  * Return the existing memories unchanged
+
+## Your Workflow:
+1. Read the existing memories from the allMemory variable
+2. Extract key topics from the conversation
+3. DECIDE whether to create/update/delete memories based on the conversation
+4. Return ALL memories including your updates (remove any duplicates)
+
+## Memory Handling:
+- CREATE: Add new memory objects for new topics
+- UPDATE: Modify existing memories if substantial new information is available
+- DELETE: Remove obsolete memories when appropriate
+
+## Memory Structure:
+- Each memory has an id, content, and createdAt fields
+- Keep the existing structure when returning updated memories
+
+## Operation Decision Rules:
+- CREATE only for truly new topics not covered in any existing memory
+- UPDATE only when new information is meaningfully different
+- NEVER update for just rephrasing or minor differences
+- DELETE only when information becomes obsolete
+
+## IMPORTANT: Your job is to return the complete updated memory collection.
+Return ALL memories (existing and new) in your response.
+
+## Existing Memories:
+<existing-memory>
+{{allMemory}}
+</existing-memory>
+
+## Conversation:
+<conversation>
+{{content}}
+</conversation>
+`;
+const DEFAULT_FS_MEMORY_RETRIEVER_INSTRUCTIONS = `You retrieve only the most relevant memories for the current conversation.
+
+## IMPORTANT: All existing memories are available in the allMemory variable
+
+## Process:
+1. Read the existing memories from the allMemory variable
+2. Extract key topics from the conversation or search query
+3. Match memory contents against these topics
+
+## Existing Memories:
+<existing-memory>
+{{allMemory}}
+</existing-memory>
+
+## Search Query:
+<search-query>
+{{search}}
+</search-query>
+`;

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/esm/utils/fs.d.ts

@@ -0,0 +1,2 @@
+export declare function exists(path: string): Promise<boolean>;
+export declare function expandHome(filepath: string): string;

package/lib/esm/utils/fs.js

@@ -0,0 +1,21 @@
+import { stat } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+export async function exists(path) {
+    try {
+        await stat(path);
+        return true;
+    }
+    catch (e) {
+        if (e.code === "ENOENT") {
+            return false;
+        }
+        throw e;
+    }
+}
+export function expandHome(filepath) {
+    if (filepath.startsWith("~/") || filepath === "~") {
+        return join(homedir(), filepath.slice(1));
+    }
+    return filepath;
+}

package/lib/esm/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./fs.js";

package/lib/esm/utils/index.js

@@ -0,0 +1 @@
+export * from "./fs.js";

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@aigne/fs-memory",
+  "version": "1.0.0",
+  "description": "FS memory for AIGNE framework",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/memory/fs",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "files": [
+    "lib/cjs",
+    "lib/dts",
+    "lib/esm",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/dts/index.d.ts",
+  "dependencies": {
+    "yaml": "^2.8.0",
+    "zod": "^3.25.67",
+    "@aigne/core": "^1.34.0",
+    "@aigne/openai": "^0.10.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.18",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "build": "tsc --build scripts/tsconfig.build.json",
+    "clean": "rimraf lib test/coverage",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-reporter=text",
+    "postbuild": "node ../../scripts/post-build-lib.mjs"
+  }
+}