From 8628291f7d853b8799c4946af32700157c943002 Mon Sep 17 00:00:00 2001
From: metakai1 <km711@protonmail.com>
Date: Sat, 4 Jan 2025 22:22:54 -0700
Subject: [PATCH] create architectre doc for database

---
 packages/plugin-unreal/docs/architecture.md | 249 ++++++++++++++++++++
 1 file changed, 249 insertions(+)
 create mode 100644 packages/plugin-unreal/docs/architecture.md

diff --git a/packages/plugin-unreal/docs/architecture.md b/packages/plugin-unreal/docs/architecture.md
new file mode 100644
index 00000000..2477596c
--- /dev/null
+++ b/packages/plugin-unreal/docs/architecture.md
@@ -0,0 +1,249 @@
+# Land Property Search System Architecture
+
+## Table of Contents
+1. [Current Architecture](#current-architecture)
+2. [Problems and Challenges](#problems-and-challenges)
+3. [Proposed Architecture](#proposed-architecture)
+4. [Implementation Guide](#implementation-guide)
+5. [Object-Oriented Design Principles](#object-oriented-design-principles)
+
+## Current Architecture
+
+### System Overview
+The Land Property Search System is designed to manage and search property data in a virtual land marketplace. 
+
+### Current Object Relationships
+```mermaid
+classDiagram
+    class PropertySearchManager {
+        -LandMemorySystem memorySystem
+        +createSearchSession()
+        +executeSearch()
+    }
+    class LandDatabaseAdapter {
+        +createLandMemory()
+        +getLandMemoryById()
+    }
+    class PostgresLandDataProvider {
+        +searchProperties()
+        +getPropertyById()
+    }
+    class LandMemorySystem {
+        +searchPropertiesByParams()
+        +mockSearchPropertiesByParams()
+    }
+    class ILandDataProvider {
+        <<interface>>
+        +searchLandByMetadata()
+        +getLandMemories()
+    }
+
+    PropertySearchManager --> LandMemorySystem
+    PropertySearchManager --> LandDatabaseAdapter
+    LandDatabaseAdapter --|> PostgresDatabaseAdapter
+    PostgresLandDataProvider ..|> ILandDataProvider
+    LandMemorySystem --> ILandDataProvider
+```
+
+### Current Components
+
+1. **PropertySearchManager**
+   - Primary coordinator for search operations
+   - Creates its own database connection
+   - Manages search sessions and results
+   - Currently creates redundant database connections
+
+2. **LandDatabaseAdapter**
+   - Extends PostgresDatabaseAdapter
+   - Handles direct database operations
+   - Problem: Duplicates runtime database functionality
+
+3. **PostgresLandDataProvider**
+   - Implements ILandDataProvider interface
+   - Missing required methods
+   - Interface mismatch issues
+
+4. **LandMemorySystem**
+   - Manages property data and search operations
+   - Tightly coupled with database implementation
+
+## Problems and Challenges
+
+### 1. Database Connection Management
+- Multiple database connections created
+- Runtime's database connection not utilized
+- Resource inefficiency
+
+### 2. Architectural Issues
+```mermaid
+graph TD
+    A[PropertySearchManager] --> B[Creates Own DB Connection]
+    A --> C[LandMemorySystem]
+    C --> D[PostgresLandDataProvider]
+    D --> E[LandDatabaseAdapter]
+    F[Runtime DB Connection] --> G[Unused]
+    style G fill:#ff9999
+    style B fill:#ff9999
+```
+
+### 3. Interface Mismatches
+- Provider implementation doesn't match interface
+- Inconsistent method names
+- Missing required functionality
+
+## Proposed Architecture
+
+### New Object Relationships
+```mermaid
+classDiagram
+    class PropertySearchManager {
+        -LandMemorySystem memorySystem
+        -IAgentRuntime runtime
+        +executeSearch()
+    }
+    class LandMemorySystem {
+        -ILandRepository repository
+        +searchProperties()
+    }
+    class ILandRepository {
+        <<interface>>
+        +search()
+        +getById()
+    }
+    class PostgresLandRepository {
+        -RuntimeDatabaseAdapter dbAdapter
+        +search()
+        +getById()
+    }
+    class RuntimeDatabaseAdapter {
+        -IAgentRuntime runtime
+        +executeQuery()
+    }
+
+    PropertySearchManager --> LandMemorySystem
+    LandMemorySystem --> ILandRepository
+    PostgresLandRepository ..|> ILandRepository
+    PostgresLandRepository --> RuntimeDatabaseAdapter
+```
+
+### Key Improvements
+
+1. **Repository Pattern Implementation**
+```typescript
+interface ILandRepository {
+    search(params: SearchParams): Promise<Property[]>;
+    getById(id: string): Promise<Property>;
+    save(property: Property): Promise<void>;
+}
+```
+
+2. **Runtime Database Adapter**
+```typescript
+class RuntimeDatabaseAdapter {
+    constructor(private runtime: IAgentRuntime) {}
+    
+    async executeQuery(query: string, params: any[]): Promise<any> {
+        return this.runtime.databaseAdapter.query(query, params);
+    }
+}
+```
+
+3. **Factory Pattern Usage**
+```typescript
+class LandSystemFactory {
+    static create(runtime: IAgentRuntime): PropertySearchManager {
+        const dbAdapter = new RuntimeDatabaseAdapter(runtime);
+        const repository = new PostgresLandRepository(dbAdapter);
+        const memorySystem = new LandMemorySystem(repository);
+        return new PropertySearchManager(memorySystem, runtime);
+    }
+}
+```
+
+## Implementation Guide
+
+### Step 1: Create Base Interfaces
+```typescript
+interface ILandRepository {
+    search(params: SearchParams): Promise<Property[]>;
+    getById(id: string): Promise<Property>;
+    save(property: Property): Promise<void>;
+}
+```
+
+### Step 2: Implement Repository
+```typescript
+class PostgresLandRepository implements ILandRepository {
+    constructor(private dbAdapter: RuntimeDatabaseAdapter) {}
+    
+    async search(params: SearchParams): Promise<Property[]> {
+        // Implementation using runtime database adapter
+    }
+}
+```
+
+### Step 3: Update LandMemorySystem
+```typescript
+class LandMemorySystem {
+    constructor(private repository: ILandRepository) {}
+    
+    async searchProperties(params: SearchParams): Promise<Property[]> {
+        return this.repository.search(params);
+    }
+}
+```
+
+## Object-Oriented Design Principles
+
+### 1. Encapsulation
+- Hide implementation details
+- Expose only necessary interfaces
+- Example: Repository pattern hiding database details
+
+### 2. Dependency Inversion
+```mermaid
+graph TD
+    A[High-Level Modules] --> B[Abstractions]
+    C[Low-Level Modules] --> B
+    style B fill:#98ff98
+```
+
+### 3. Single Responsibility
+Each class should have one reason to change:
+- Repository: Data access
+- Memory System: Business logic
+- Search Manager: Coordination
+
+### Design Pattern Benefits
+
+1. **Repository Pattern**
+   - Abstracts data access
+   - Consistent interface
+   - Easy to test
+
+2. **Adapter Pattern**
+   - Converts between interfaces
+   - Reuses runtime functionality
+   - Clean integration
+
+3. **Factory Pattern**
+   - Centralizes object creation
+   - Manages dependencies
+   - Simplifies system setup
+
+## Migration Strategy
+
+1. **Phase 1: Interface Alignment**
+   - Create new interfaces
+   - Update existing implementations
+   - Add missing methods
+
+2. **Phase 2: Repository Implementation**
+   - Create new repository class
+   - Implement using runtime database
+   - Update memory system
+
+3. **Phase 3: Dependency Injection**
+   - Update constructors
+   - Implement factory
+   - Remove direct database creation