@easynet/agent-memory 1.0.52 → 1.0.53

package/README.md

@@ -2,54 +2,40 @@
 
 ## Introduction
 
-`@easynet/agent-memory` adds memory storage and recall for agents. It supports common scopes such as `thread`, `cross_thread`, and `knowledge`, and registers the memory client into the default `AgentContext`.
+`@easynet/agent-memory` provides the memory layer for agents. It manages `thread`, `cross_thread`, and `knowledge` memory and registers the memory client into the default `AgentContext`.
 
-## API Reference
+## Exposed SDK
 
-| API | What it does | Minimal usage |
+| Export | Type | Purpose |
 | --- | --- | --- |
-| `createAgentMemory` | Create a memory client and register it into `AgentContext`. | `const memory = await createAgentMemory({ configPath: "./memory.yaml" })` |
+| `createAgentMemory` | function | Creates the memory client and registers it into the default `AgentContext`. |
+| `CreateAgentMemoryOptions` | type | Options for loading memory configuration and initializing memory. |
 
 ## Usage
 
-Create `config/memory.yaml`:
-
-```yaml
-providers:
-  - id: default
-    type: in_memory
-
-defaultProvider: default
-
-memoryTypes:
-  thread: { providerId: default, allowWrite: true, maxItems: 20 }
-  cross_thread: { providerId: default, allowWrite: true, maxItems: 20 }
-  knowledge: { providerId: default, allowWrite: true, maxItems: 20 }
+```bash
+npm i @easynet/agent-memory
 ```
 
-Initialize and use memory:
-
 ```ts
 import { createAgentMemory } from "@easynet/agent-memory";
 
-const memory = await createAgentMemory({
-  configPath: "./config/memory.yaml",
-});
-
-await memory.memorize("user:alice", "cross_thread", "Prefers concise English answers.");
+const memory = await createAgentMemory("./config/memory.yaml");
 
+await memory.memorize("user:demo", "cross_thread", "User prefers concise answers.");
 const result = await memory.recall({
-  namespace: "user:alice",
-  query: "language preference",
+  namespace: "user:demo",
+  query: "user preference",
+  types: ["cross_thread"],
   topK: 5,
 });
 
 console.log(result.injectedText);
 ```
 
-### YAML config
+## Configuration
 
-Example `config/memory.yaml`:
+The default config file is `config/memory.yaml`.
 
 ```yaml
 apiVersion: easynet.world/v1
@@ -63,12 +49,6 @@ spec:
         type: in_memory
       allowWrite: true
       maxItems: 20
-      sessionCompaction:
-        enabled: true
-        maxTokens: 3000
-        keepRecentTurns: 12
-        summaryKey: __session_summary__
-        checkEveryTurns: 3
 
     cross_thread:
       store:
@@ -81,26 +61,13 @@ spec:
         type: in_memory
       allowWrite: true
       maxItems: 20
-
-  observability:
-    trace: false
-
-  privacy:
-    forbiddenMetadataKeys:
-      - password
-      - api_key
-      - secret
-      - token
 ```
 
-Explanation:
-
-- `spec.memory.thread`: short-term conversational memory.
-- `spec.memory.cross_thread`: long-term user or session memory across conversations.
-- `spec.memory.knowledge`: knowledge storage for reusable facts and documents.
-- `store.type`: backend type, such as `in_memory`.
-- `allowWrite`: whether this memory scope can accept writes.
-- `maxItems`: maximum number of recalled items kept per scope.
-- `sessionCompaction`: optional summarization of long thread history.
-- `observability.trace`: enable recall tracing for debugging.
-- `privacy.forbiddenMetadataKeys`: metadata keys that should be stripped before storage.
+Key fields:
+
+- `spec.memory.thread`: current conversation memory
+- `spec.memory.cross_thread`: long-term memory across conversations
+- `spec.memory.knowledge`: document and knowledge memory
+- `store.type`: storage backend
+- `allowWrite`: whether writes are allowed
+- `maxItems`: recall limit

package/dist/src/register-memory.d.ts

@@ -9,8 +9,8 @@ export interface CreateAgentMemoryOptions extends CreateMemoryOptions {
  *
  * @example
  * ```ts
- * await createAgentMemory({ configPath: "config/memory.yaml" });
+ * await createAgentMemory("config/memory.yaml");
  * ```
  */
-export declare function createAgentMemory(options?: CreateAgentMemoryOptions): Promise<AgentMemoryClient>;
+export declare function createAgentMemory(configPathOrOptions?: string | CreateAgentMemoryOptions): Promise<AgentMemoryClient>;
 //# sourceMappingURL=register-memory.d.ts.map

package/dist/src/register-memory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register-memory.d.ts","sourceRoot":"","sources":["../../src/register-memory.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;CAAG;AAExE;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAItG"}
+{"version":3,"file":"register-memory.d.ts","sourceRoot":"","sources":["../../src/register-memory.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;CAAG;AAExE;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CACrC,mBAAmB,CAAC,EAAE,MAAM,GAAG,wBAAwB,GACtD,OAAO,CAAC,iBAAiB,CAAC,CAI5B"}

package/dist/src/register-memory.js

@@ -8,11 +8,11 @@ import { createAgentMemory as createAgentMemoryInstance, } from "./create-agent-
  *
  * @example
  * ```ts
- * await createAgentMemory({ configPath: "config/memory.yaml" });
+ * await createAgentMemory("config/memory.yaml");
  * ```
  */
-export async function createAgentMemory(options) {
-    const memory = await createAgentMemoryInstance(options ?? {});
+export async function createAgentMemory(configPathOrOptions) {
+    const memory = await createAgentMemoryInstance(configPathOrOptions ?? {});
     getDefaultAgentContext().set(AgentContextTokens.Memory, memory);
     return memory;
 }

package/dist/src/register-memory.js.map

@@ -1 +1 @@
-{"version":3,"file":"register-memory.js","sourceRoot":"","sources":["../../src/register-memory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EACL,iBAAiB,IAAI,yBAAyB,GAG/C,MAAM,0BAA0B,CAAC;AAIlC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAkC;IACxE,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAC9D,sBAAsB,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"register-memory.js","sourceRoot":"","sources":["../../src/register-memory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EACL,iBAAiB,IAAI,yBAAyB,GAG/C,MAAM,0BAA0B,CAAC;AAIlC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,mBAAuD;IAEvD,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC;IAC1E,sBAAsB,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easynet/agent-memory",
-  "version": "1.0.52",
+  "version": "1.0.53",
   "description": "Unified memory layer for LangChain / LangGraph / DeepAgents",
   "type": "module",
   "main": "dist/src/index.js",