@aigne/did-space-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,171 @@
+# @aigne/did-space-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/did-space-memory)](https://www.npmjs.com/package/@aigne/did-space-memory)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/did-space-memory)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+DID Spaces memory system component for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing cloud-based memory storage capabilities with DID Spaces.
+
+## Introduction
+
+`@aigne/did-space-memory` is the DID Spaces memory system component of [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing cloud-based memory storage and retrieval functionality using DID Spaces. This component uses decentralized storage services to provide secure and reliable memory persistence capabilities for AI applications.
+
+## Features
+
+* **Cloud Storage**: Uses DID Spaces for secure cloud-based memory storage
+* **Decentralized**: Based on decentralized identity and storage technologies
+* **Automatic Management**: Supports automatic memory file management and README generation
+* **Secure Authentication**: Supports multiple authentication methods to ensure data security
+* **YAML Format**: Uses YAML format for memory storage, making it easy to read and maintain
+* **TypeScript Support**: Complete type definitions providing an excellent development experience
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @aigne/did-space-memory
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/did-space-memory
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/did-space-memory
+```
+
+## Basic Usage
+
+```typescript
+import { AIAgent, AIGNE } from "@aigne/core";
+import { DIDSpacesMemory } from "@aigne/did-space-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 DID Spaces memory system
+const memory = new DIDSpacesMemory({
+  url: process.env.DID_SPACES_URL!,
+  auth: {
+    authorization: process.env.DID_SPACES_AUTHORIZATION!,
+  },
+});
+
+// Create AI agent with cloud-based memory
+const agent = AIAgent.from({
+  name: "CloudAssistant",
+  instructions: "You are a helpful assistant with cloud-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: "I'm John, a doctor, and I like Bitcoin",
+});
+
+console.log(response.message);
+
+// Query memory
+const response2 = await userAgent.invoke({
+  message: "What is my profession?",
+});
+
+console.log(response2.message);
+```
+
+## Advanced Configuration
+
+### Custom Memory Agent Options
+
+```typescript
+import { DIDSpacesMemory } from "@aigne/did-space-memory";
+
+const memory = new DIDSpacesMemory({
+  url: process.env.DID_SPACES_URL!,
+  auth: {
+    authorization: process.env.DID_SPACES_AUTHORIZATION!,
+  },
+  // Custom memory retriever agent configuration
+  retrieverOptions: {
+    name: "CustomRetriever",
+    instructions: "Custom retrieval instructions",
+  },
+  // Custom memory recorder agent configuration
+  recorderOptions: {
+    name: "CustomRecorder", 
+    instructions: "Custom recording instructions",
+  },
+  // Other agent configurations
+  autoUpdate: true,
+});
+```
+
+### Using Different Authentication Methods
+
+```typescript
+// Using access token authentication
+const memory1 = new DIDSpacesMemory({
+  url: "https://your-did-spaces-url.com",
+  auth: {
+    accessToken: process.env.DID_SPACES_ACCESS_TOKEN!,
+  },
+});
+
+// Using authorization header authentication
+const memory2 = new DIDSpacesMemory({
+  url: "https://your-did-spaces-url.com",
+  auth: {
+    authorization: process.env.DID_SPACES_AUTHORIZATION!,
+  },
+});
+```
+
+## Memory Management Features
+
+```typescript
+// Get memory storage client
+const client = memory.client;
+
+// List all memory files
+const memories = await client.listObjects({
+  prefix: "/memories/",
+});
+
+// Read specific memory file
+const memoryContent = await client.getObject({
+  key: "/memories/conversation-123/memory.yaml",
+});
+```
+
+## Environment Variables Configuration
+
+Create a `.env` file and configure the following variables:
+
+```env
+DID_SPACES_URL=https://your-did-spaces-url.com
+DID_SPACES_AUTHORIZATION=your-authorization-token
+# Or use access token
+DID_SPACES_ACCESS_TOKEN=your-access-token
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./memory.js";
+export * from "./readme-contents.js";
+export * from "./readme-manager.js";

package/lib/cjs/index.js

@@ -0,0 +1,19 @@
+"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("./readme-contents.js"), exports);
+__exportStar(require("./readme-manager.js"), exports);

package/lib/cjs/memory.d.ts

@@ -0,0 +1,88 @@
+import { type AIAgentOptions, type Message } from "@aigne/core";
+import { MemoryAgent, type MemoryAgentOptions, type MemoryRecorderInput, type MemoryRetrieverInput } from "@aigne/core/memory/index.js";
+import { type SpaceClientOptionsAuth } from "@blocklet/did-space-js";
+export declare const MEMORY_FILE_NAME = "memory.yaml";
+/**
+ * Configuration options for the DIDSpacesMemory class.
+ */
+export interface DIDSpacesMemoryOptions extends Partial<MemoryAgentOptions> {
+    /**
+     * The URL of the DIDSpaces.
+     */
+    url: string;
+    /**
+     * The authentication method for the DIDSpaces.
+     */
+    auth: SpaceClientOptionsAuth;
+    /**
+     * Optional configuration for the memory retriever agent.
+     * Controls how memories are retrieved from the file system.
+     */
+    retrieverOptions?: Partial<DIDSpacesMemoryRetrieverOptions>;
+    /**
+     * Optional configuration for the memory recorder agent.
+     * Controls how memories are recorded to the file system.
+     */
+    recorderOptions?: Partial<DIDSpacesMemoryRecorderOptions>;
+}
+/**
+ * A memory implementation that stores and retrieves memories using the file system.
+ * DIDSpacesMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the DIDSpacesMemory class:
+ * {@includeCode ../../test/did-spaces-memory/did-spaces-memory.test.ts#example-did-spaces-memory-simple}
+ */
+export declare class DIDSpacesMemory extends MemoryAgent {
+    /**
+     * Creates a new DIDSpacesMemory instance.
+     */
+    constructor(options: DIDSpacesMemoryOptions);
+    /**
+     * Initialize README files in the memory directory
+     */
+    private initializeReadmeFiles;
+}
+interface DIDSpacesMemoryRetrieverOptions extends AIAgentOptions<DIDSpacesMemoryRetrieverAgentInput, DIDSpacesMemoryRetrieverAgentOutput> {
+    /**
+     * The URL of the DIDSpaces.
+     */
+    url: string;
+    /**
+     * The authentication method for the DIDSpaces.
+     */
+    auth: SpaceClientOptionsAuth;
+    /**
+     * The name of the memory file.
+     */
+    memoryFileName: string;
+}
+interface DIDSpacesMemoryRetrieverAgentInput extends MemoryRetrieverInput {
+    allMemory: string;
+}
+interface DIDSpacesMemoryRetrieverAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+interface DIDSpacesMemoryRecorderOptions extends AIAgentOptions<DIDSpacesMemoryRecorderAgentInput, DIDSpacesMemoryRecorderAgentOutput> {
+    /**
+     * The URL of the DIDSpaces.
+     */
+    url: string;
+    /**
+     * The authentication method for the DIDSpaces.
+     */
+    auth: SpaceClientOptionsAuth;
+    /**
+     * The name of the memory file.
+     */
+    memoryFileName: string;
+}
+type DIDSpacesMemoryRecorderAgentInput = MemoryRecorderInput;
+interface DIDSpacesMemoryRecorderAgentOutput extends Message {
+    memories: {
+        content: string;
+    }[];
+}
+export {};

package/lib/cjs/memory.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DIDSpacesMemory = exports.MEMORY_FILE_NAME = void 0;
+const node_path_1 = require("node:path");
+const core_1 = require("@aigne/core");
+const index_js_1 = require("@aigne/core/memory/index.js");
+const logger_js_1 = require("@aigne/core/utils/logger.js");
+const did_space_js_1 = require("@blocklet/did-space-js");
+const yaml_1 = require("yaml");
+const zod_1 = require("zod");
+const readme_manager_js_1 = require("./readme-manager.js");
+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.
+ * DIDSpacesMemory provides persistent storage of agent memories as files in a specified directory.
+ *
+ * @example
+ * Here is an example of how to use the DIDSpacesMemory class:
+ * {@includeCode ../../test/did-spaces-memory/did-spaces-memory.test.ts#example-did-spaces-memory-simple}
+ */
+class DIDSpacesMemory extends index_js_1.MemoryAgent {
+    /**
+     * Creates a new DIDSpacesMemory instance.
+     */
+    constructor(options) {
+        const rootDir = "/.aigne/";
+        const memoryFileName = (0, node_path_1.join)(rootDir, exports.MEMORY_FILE_NAME);
+        super({
+            ...options,
+            recorder: options.recorder ??
+                new DIDSpacesMemoryRecorder({
+                    url: options.url,
+                    auth: options.auth,
+                    memoryFileName,
+                    ...options.recorderOptions,
+                }),
+            retriever: options.retriever ??
+                new DIDSpacesMemoryRetriever({
+                    url: options.url,
+                    auth: options.auth,
+                    memoryFileName,
+                    ...options.retrieverOptions,
+                }),
+            autoUpdate: options.autoUpdate ?? true,
+        });
+        // Initialize README files asynchronously
+        this.initializeReadmeFiles(options.url, options.auth, rootDir).catch((error) => {
+            logger_js_1.logger.warn("Failed to initialize README files:", error);
+        });
+    }
+    /**
+     * Initialize README files in the memory directory
+     */
+    async initializeReadmeFiles(url, auth, rootDir) {
+        const readmeManager = new readme_manager_js_1.ReadmeManager(url, auth, rootDir);
+        await readmeManager.initializeReadmeFiles();
+    }
+}
+exports.DIDSpacesMemory = DIDSpacesMemory;
+class DIDSpacesMemoryRetriever extends index_js_1.MemoryRetriever {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = core_1.AIAgent.from({
+            name: "did_spaces_memory_retriever",
+            description: "Retrieves memories from the file or directory.",
+            ...options,
+            instructions: options.instructions || DEFAULT_DID_SPACES_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 exists() {
+        const client = new did_space_js_1.SpaceClient({
+            url: this.options.url,
+            auth: this.options.auth,
+        });
+        const listObjectCommandOutput = await client.send(new did_space_js_1.ListObjectCommand({
+            key: this.options.memoryFileName,
+        }));
+        return listObjectCommandOutput.statusCode === 200;
+    }
+    async read(input, options) {
+        const client = new did_space_js_1.SpaceClient({
+            url: this.options.url,
+            auth: this.options.auth,
+        });
+        const getObjectCommandOutput = await client.send(new did_space_js_1.GetObjectCommand({
+            key: this.options.memoryFileName,
+        }));
+        if (getObjectCommandOutput.statusCode !== 200) {
+            logger_js_1.logger.warn(`statusCode: ${getObjectCommandOutput.statusCode}, statusMessage: ${getObjectCommandOutput.statusMessage}`);
+            throw new Error(getObjectCommandOutput.statusMessage);
+        }
+        const allMemory = await (0, fs_js_1.streamToString)(getObjectCommandOutput.data);
+        const { memories } = await options.context.invoke(this.agent, {
+            ...input,
+            allMemory,
+        });
+        const results = memories.map((memory) => ({
+            id: (0, index_js_1.newMemoryId)(),
+            content: memory.content,
+            createdAt: new Date().toISOString(),
+        }));
+        return results;
+    }
+    async process(input, options) {
+        if (!(await this.exists())) {
+            return { memories: [] };
+        }
+        const memories = await this.read(input, options);
+        return { memories };
+    }
+}
+class DIDSpacesMemoryRecorder extends index_js_1.MemoryRecorder {
+    options;
+    constructor(options) {
+        super({});
+        this.options = options;
+        this.agent = core_1.AIAgent.from({
+            name: "did_spaces_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 write(input, options) {
+        const client = new did_space_js_1.SpaceClient({
+            url: this.options.url,
+            auth: this.options.auth,
+        });
+        const output = await client.send(new did_space_js_1.GetObjectCommand({
+            key: this.options.memoryFileName,
+        }));
+        const allMemory = output.statusCode === 200 ? await (0, fs_js_1.streamToString)(output.data) : "";
+        const { memories } = await options.context.invoke(this.agent, {
+            ...input,
+            allMemory,
+        });
+        const raws = (0, yaml_1.stringify)(memories.map((i) => ({
+            content: i.content,
+        })));
+        const putObjectCommandOutput = await client.send(new did_space_js_1.PutObjectCommand({
+            key: this.options.memoryFileName,
+            data: raws,
+        }));
+        if (putObjectCommandOutput.statusCode !== 200) {
+            logger_js_1.logger.warn(`statusCode: ${putObjectCommandOutput.statusCode}, statusMessage: ${putObjectCommandOutput.statusMessage}`);
+            throw new Error(putObjectCommandOutput.statusMessage);
+        }
+        const results = memories.map((memory) => ({
+            id: (0, index_js_1.newMemoryId)(),
+            content: memory.content,
+            createdAt: new Date().toISOString(),
+        }));
+        return { memories: results };
+    }
+    async process(input, options) {
+        return this.write(input, options);
+    }
+}
+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_DID_SPACES_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/readme-contents.d.ts

@@ -0,0 +1,4 @@
+/**
+ * README content for DID Spaces Memory
+ */
+export declare const README_EN_CONTENT = "# AIGNE Memory Directory\n\nThis directory is used to store agent context and conversation memories.\n\n## Files\n\n- `memory.yaml` - Contains the conversation history and context that the AI agent remembers across sessions\n- `README.md` - This file (English documentation)\n- `README.zh.md` - Chinese documentation\n\n## Purpose\n\nThe memory system allows AI agents to maintain context and remember important information from previous conversations, enabling more personalized and coherent interactions.\n\n## Privacy\n\nThe memory files are stored in your personal DID Space and are only accessible to you and the agents you authorize.";

package/lib/cjs/readme-contents.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * README content for DID Spaces Memory
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.README_EN_CONTENT = void 0;
+exports.README_EN_CONTENT = `# AIGNE Memory Directory
+
+This directory is used to store agent context and conversation memories.
+
+## Files
+
+- \`memory.yaml\` - Contains the conversation history and context that the AI agent remembers across sessions
+- \`README.md\` - This file (English documentation)
+- \`README.zh.md\` - Chinese documentation
+
+## Purpose
+
+The memory system allows AI agents to maintain context and remember important information from previous conversations, enabling more personalized and coherent interactions.
+
+## Privacy
+
+The memory files are stored in your personal DID Space and are only accessible to you and the agents you authorize.`;