Remove dead code files and update source tree documentation
This commit is contained in:
Alex Newman
+340
@@ -0,0 +1,340 @@
|
||||
# Claude-Mem Source Code Analysis Report
|
||||
|
||||
## Executive Summary
|
||||
|
||||
Analyzed all 58 files in the `/Users/alexnewman/Scripts/claude-mem/src` directory. This report categorizes each file by purpose, usage status, and documents the cleanup of dead code files.
|
||||
|
||||
**Cleanup Status**: ✅ **7 dead code files successfully removed** (51 files remaining)
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/bin** (2 files)
|
||||
|
||||
### `src/bin/cleanup-duplicates.ts`
|
||||
- **Purpose**: Utility script to remove duplicate observations and summaries from the database
|
||||
- **Used?**: **No** - Standalone CLI utility, not imported anywhere
|
||||
- **Notes**: Maintenance tool for database cleanup. Keeps earliest entry (MIN(id)) for each duplicate group. Not part of the runtime system.
|
||||
|
||||
### `src/bin/import-xml-observations.ts`
|
||||
- **Purpose**: Import tool to restore XML observations back into SQLite database
|
||||
- **Used?**: **No** - Standalone CLI utility, not imported anywhere
|
||||
- **Notes**: Data migration tool. Parses XML timestamps and matches them to transcript files. Not part of the runtime system.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/hooks** (7 files, 1 deleted)
|
||||
|
||||
### `src/hooks/cleanup-hook.ts`
|
||||
- **Purpose**: SessionEnd hook that marks sessions as completed and notifies worker
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/cleanup-hook.js`, registered in `plugin/hooks/hooks.json`
|
||||
- **Notes**: Core hook, actively used
|
||||
|
||||
### `src/hooks/context-hook.ts`
|
||||
- **Purpose**: SessionStart hook that injects recent observations into Claude Code sessions
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/context-hook.js`, registered in hooks.json, also called by user-message-hook
|
||||
- **Notes**: Core hook displaying context timeline with progressive disclosure (index view)
|
||||
|
||||
### `src/hooks/hook-response.ts`
|
||||
- **Purpose**: Utility module for creating standardized hook responses
|
||||
- **Used?**: **Yes** - Imported by new-hook.ts, save-hook.ts, summary-hook.ts
|
||||
- **Notes**: Shared helper for hook JSON output
|
||||
|
||||
### `src/hooks/index.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Export barrel for hooks module
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Exports were outdated (referenced `context.js`, `save.js`, etc. which don't exist). The actual hooks are built as standalone executables, not imported as modules.
|
||||
|
||||
### `src/hooks/new-hook.ts`
|
||||
- **Purpose**: UserPromptSubmit hook that creates session records and saves raw user prompts
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/new-hook.js`, registered in hooks.json
|
||||
- **Notes**: Core hook, actively used
|
||||
|
||||
### `src/hooks/save-hook.ts`
|
||||
- **Purpose**: PostToolUse hook that captures tool executions and sends to worker
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/save-hook.js`, registered in hooks.json
|
||||
- **Notes**: Core hook, actively used
|
||||
|
||||
### `src/hooks/summary-hook.ts`
|
||||
- **Purpose**: Stop hook that requests session summaries from worker
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/summary-hook.js`, registered in hooks.json
|
||||
- **Notes**: Core hook, actively used
|
||||
|
||||
### `src/hooks/user-message-hook.ts`
|
||||
- **Purpose**: SessionStart hook that displays context to users via stderr
|
||||
- **Used?**: **Yes** - Built to `plugin/scripts/user-message-hook.js`, registered in hooks.json
|
||||
- **Notes**: Runs context-hook via execSync to show colored output. Active hook.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/sdk** (3 files, 1 deleted)
|
||||
|
||||
### `src/sdk/index.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Export barrel for SDK module
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Exported SDK functions but nothing imported from this module directly. Files import directly from prompts.ts and parser.ts instead.
|
||||
|
||||
### `src/sdk/parser.test.ts`
|
||||
- **Purpose**: Regression tests for XML parsing (v4.2.5 and v4.2.6 bugfixes)
|
||||
- **Used?**: **No** - Test file, not part of runtime
|
||||
- **Notes**: Test suite with 18 tests validating observation/summary parsing edge cases
|
||||
|
||||
### `src/sdk/parser.ts`
|
||||
- **Purpose**: XML parser for observation and summary blocks from SDK responses
|
||||
- **Used?**: **Yes** - Imported by worker-service.ts
|
||||
- **Notes**: Core parsing logic, actively used
|
||||
|
||||
### `src/sdk/prompts.ts`
|
||||
- **Purpose**: Prompt builders for Claude Agent SDK
|
||||
- **Used?**: **Yes** - Imported by worker-service.ts
|
||||
- **Notes**: Generates init, observation, and summary prompts for SDK agent
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/servers** (1 file)
|
||||
|
||||
### `src/servers/search-server.ts`
|
||||
- **Purpose**: MCP search server exposing 9 search tools with hybrid Chroma + FTS5 search
|
||||
- **Used?**: **Yes** - Built to `plugin/search-server.mjs`, configured in `plugin/.mcp.json`
|
||||
- **Notes**: 1,782 lines. Core search server providing progressive disclosure search tools.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/services/sqlite** (6 files)
|
||||
|
||||
### `src/services/sqlite/Database.ts`
|
||||
- **Purpose**: Base database class with better-sqlite3
|
||||
- **Used?**: **Yes** - Imported by SessionStore.ts, SessionSearch.ts, index.ts
|
||||
- **Notes**: Foundation class for SQLite operations
|
||||
|
||||
### `src/services/sqlite/index.ts`
|
||||
- **Purpose**: Export barrel for sqlite module
|
||||
- **Used?**: **Yes** - Imported by storage.ts
|
||||
- **Notes**: Exports all store types and utilities
|
||||
|
||||
### `src/services/sqlite/migrations.ts`
|
||||
- **Purpose**: Database migration function for schema changes
|
||||
- **Used?**: **Yes** - Imported by index.ts
|
||||
- **Notes**: Handles SQLite schema migrations
|
||||
|
||||
### `src/services/sqlite/SessionSearch.ts`
|
||||
- **Purpose**: FTS5 full-text search implementation
|
||||
- **Used?**: **Yes** - Imported by search-server.ts
|
||||
- **Notes**: Provides searchObservations, searchSessions, searchUserPrompts, findByConcept, findByFile, findByType
|
||||
|
||||
### `src/services/sqlite/SessionStore.ts`
|
||||
- **Purpose**: CRUD operations for sessions, observations, summaries, user prompts
|
||||
- **Used?**: **Yes** - Imported by all hooks, worker-service.ts, search-server.ts, bin utilities
|
||||
- **Notes**: Core database store, heavily used throughout the system
|
||||
|
||||
### `src/services/sqlite/types.ts`
|
||||
- **Purpose**: TypeScript type definitions for database records
|
||||
- **Used?**: **Yes** - Imported by search-server.ts
|
||||
- **Notes**: Defines ObservationSearchResult, SessionSummarySearchResult, UserPromptSearchResult
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/services/sync** (1 file)
|
||||
|
||||
### `src/services/sync/ChromaSync.ts`
|
||||
- **Purpose**: Vector database synchronization service for semantic search
|
||||
- **Used?**: **Yes** - Imported by worker-service.ts
|
||||
- **Notes**: 737 lines. Manages Chroma vector embeddings for observations, summaries, and prompts. Critical for hybrid search.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/services** (1 file)
|
||||
|
||||
### `src/services/worker-service.ts`
|
||||
- **Purpose**: Express HTTP server managed by PM2, handles SDK agent sessions
|
||||
- **Used?**: **Yes** - Built to `plugin/worker-service.cjs`, started by PM2
|
||||
- **Notes**: 1,173 lines. Core worker service with 14 HTTP/SSE endpoints. Serves viewer UI, manages SDK sessions, broadcasts SSE updates.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/shared** (2 files, 3 deleted)
|
||||
|
||||
### `src/shared/config.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Package configuration (name, version, description)
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Read from package.json but no code used these exports. The actual version reading happens inline in worker-service.ts.
|
||||
|
||||
### `src/shared/paths.ts`
|
||||
- **Purpose**: Path utilities and directory management
|
||||
- **Used?**: **Yes** - Imported by search-server.ts
|
||||
- **Notes**: Provides VECTOR_DB_DIR and other path constants. Actively used.
|
||||
|
||||
### `src/shared/storage.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Unified storage provider interface (SQLite abstraction layer)
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Defined IStorageProvider interface and SQLiteStorageProvider but nothing used this abstraction. Direct SessionStore usage is preferred.
|
||||
|
||||
### `src/shared/types.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Core type definitions (Settings interface)
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Defined Settings interface but no code imported it. Settings are read/written as raw JSON objects.
|
||||
|
||||
### `src/shared/worker-utils.ts`
|
||||
- **Purpose**: Worker health checks and PM2 management
|
||||
- **Used?**: **Yes** - Imported by context-hook.ts, new-hook.ts, save-hook.ts, summary-hook.ts, cleanup-hook.ts, user-message-hook.ts
|
||||
- **Notes**: Core utility, actively used by all hooks
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/utils** (1 file, 2 deleted)
|
||||
|
||||
### `src/utils/logger.ts`
|
||||
- **Purpose**: Structured logging with correlation IDs and data flow tracking
|
||||
- **Used?**: **Yes** - Imported by parser.ts, save-hook.ts, summary-hook.ts, worker-service.ts
|
||||
- **Notes**: Core logger, actively used
|
||||
|
||||
### `src/utils/platform.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Platform-specific utilities for Windows/Unix compatibility
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Provided installUv(), getShellConfigPaths(), getAliasDefinition() but nothing used these. Likely leftover from earlier installer/setup code.
|
||||
|
||||
### `src/utils/usage-logger.ts` 🗑️ **DELETED**
|
||||
- **Purpose**: Usage data logger for API cost tracking (JSONL files)
|
||||
- **Used?**: **No** - Not imported anywhere
|
||||
- **Notes**: **DELETED**. Defined UsageLogger class but it was never instantiated. Usage tracking may be handled differently now.
|
||||
|
||||
---
|
||||
|
||||
## **Directory: src/ui** (24 files + assets)
|
||||
|
||||
### `src/ui/claude-mem-logo-for-dark-mode.webp`
|
||||
- **Purpose**: Logo asset for dark mode
|
||||
- **Used?**: **Yes** - Referenced in Header.tsx, bundled into viewer.html
|
||||
- **Notes**: Web UI asset
|
||||
|
||||
### `src/ui/claude-mem-logomark.webp`
|
||||
- **Purpose**: Logomark asset
|
||||
- **Used?**: **Yes** - Referenced in Header.tsx, bundled into viewer.html
|
||||
- **Notes**: Web UI asset
|
||||
|
||||
### `src/ui/viewer-template.html`
|
||||
- **Purpose**: HTML template for viewer UI
|
||||
- **Used?**: **Yes** - Build process uses this to generate plugin/ui/viewer.html
|
||||
- **Notes**: Build artifact template
|
||||
|
||||
### `src/ui/viewer/App.tsx`
|
||||
- **Purpose**: Root React component for viewer UI
|
||||
- **Used?**: **Yes** - Entry point for viewer, imported by index.tsx
|
||||
- **Notes**: Main app component
|
||||
|
||||
### `src/ui/viewer/index.tsx`
|
||||
- **Purpose**: React app entry point
|
||||
- **Used?**: **Yes** - Built by esbuild into viewer-bundle.js
|
||||
- **Notes**: Mounts React app
|
||||
|
||||
### `src/ui/viewer/types.ts`
|
||||
- **Purpose**: TypeScript types for viewer UI
|
||||
- **Used?**: **Yes** - Imported by multiple viewer components
|
||||
- **Notes**: Type definitions for Observation, Summary, UserPrompt, etc.
|
||||
|
||||
### **src/ui/viewer/assets/fonts/** (2 files)
|
||||
- `monaspace-radon-var.woff` and `monaspace-radon-var.woff2`
|
||||
- **Purpose**: Monaspace Radon font files for viewer UI
|
||||
- **Used?**: **Yes** - Embedded in viewer.html via esbuild
|
||||
- **Notes**: Font assets
|
||||
|
||||
### **src/ui/viewer/components/** (8 files)
|
||||
All actively used by App.tsx:
|
||||
- `ErrorBoundary.tsx` - Error boundary wrapper
|
||||
- `Feed.tsx` - Infinite scroll feed component
|
||||
- `Header.tsx` - Top navigation with project selector, stats, settings
|
||||
- `ObservationCard.tsx` - Observation display card
|
||||
- `PromptCard.tsx` - User prompt display card
|
||||
- `Sidebar.tsx` - Project filtering sidebar
|
||||
- `SummaryCard.tsx` - Session summary display card
|
||||
- `ThemeToggle.tsx` - Light/dark mode toggle
|
||||
|
||||
### **src/ui/viewer/constants/** (4 files)
|
||||
All actively used by viewer components:
|
||||
- `api.ts` - API endpoint URLs
|
||||
- `settings.ts` - Default settings constants
|
||||
- `timing.ts` - Timing constants (reconnect delays, polling intervals)
|
||||
- `ui.ts` - UI constants (page sizes, etc.)
|
||||
|
||||
### **src/ui/viewer/hooks/** (5 files)
|
||||
All actively used by viewer components:
|
||||
- `usePagination.ts` - Infinite scroll pagination hook
|
||||
- `useSSE.ts` - Server-sent events hook for real-time updates
|
||||
- `useSettings.ts` - Settings management hook
|
||||
- `useStats.ts` - Worker stats fetching hook
|
||||
- `useTheme.ts` - Theme (light/dark) management hook
|
||||
|
||||
### **src/ui/viewer/utils/** (2 files)
|
||||
All actively used by viewer components:
|
||||
- `data.ts` - Data merging and deduplication utilities
|
||||
- `formatters.ts` - Date/time formatting utilities
|
||||
|
||||
---
|
||||
|
||||
## Dead Code Summary
|
||||
|
||||
### **🗑️ Deleted Files** (7 files - all removed)
|
||||
1. **src/hooks/index.ts** ✅ DELETED - Outdated export barrel, referenced non-existent files
|
||||
2. **src/shared/config.ts** ✅ DELETED - Package config not used anywhere, version read inline instead
|
||||
3. **src/shared/storage.ts** ✅ DELETED - Abstraction layer not used, direct SessionStore usage preferred
|
||||
4. **src/shared/types.ts** ✅ DELETED - Settings interface not imported anywhere
|
||||
5. **src/sdk/index.ts** ✅ DELETED - Export barrel, but imports happened directly from parser/prompts instead
|
||||
6. **src/utils/platform.ts** ✅ DELETED - Platform utilities not used, legacy installer code
|
||||
7. **src/utils/usage-logger.ts** ✅ DELETED - UsageLogger class never instantiated
|
||||
|
||||
### **Utility/Maintenance Scripts** (not dead, just not runtime code) (2 files)
|
||||
8. **src/bin/cleanup-duplicates.ts** - Maintenance CLI tool
|
||||
9. **src/bin/import-xml-observations.ts** - Data migration CLI tool
|
||||
|
||||
### **Test Files** (not dead, just not runtime code) (1 file)
|
||||
10. **src/sdk/parser.test.ts** - Regression test suite
|
||||
|
||||
---
|
||||
|
||||
## File Count Summary
|
||||
|
||||
- **Total files** (before cleanup): 58
|
||||
- **Total files** (after cleanup): **51** ✅
|
||||
- **Deleted dead code**: **7 files** 🗑️
|
||||
- **Actively used at runtime**: 43 files
|
||||
- **Utility/maintenance scripts**: 2 files
|
||||
- **Test files**: 1 file
|
||||
- **Build templates**: 1 file (viewer-template.html)
|
||||
- **Assets**: 4 files (2 logos, 2 fonts)
|
||||
|
||||
---
|
||||
|
||||
## Cleanup Actions Completed ✅
|
||||
|
||||
1. **✅ Removed all dead code** (7 files deleted):
|
||||
- ✅ Deleted `src/hooks/index.ts`
|
||||
- ✅ Deleted `src/shared/config.ts`
|
||||
- ✅ Deleted `src/shared/storage.ts`
|
||||
- ✅ Deleted `src/shared/types.ts`
|
||||
- ✅ Deleted `src/sdk/index.ts`
|
||||
- ✅ Deleted `src/utils/platform.ts`
|
||||
- ✅ Deleted `src/utils/usage-logger.ts`
|
||||
|
||||
2. **✅ Kept utility scripts** for maintenance purposes:
|
||||
- ✅ Kept `src/bin/cleanup-duplicates.ts`
|
||||
- ✅ Kept `src/bin/import-xml-observations.ts`
|
||||
|
||||
3. **✅ Kept test files** for regression testing:
|
||||
- ✅ Kept `src/sdk/parser.test.ts`
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Build and test** to ensure no broken imports:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
2. **Run TypeScript diagnostics** to catch any missing references:
|
||||
```bash
|
||||
npx tsc --noEmit
|
||||
```
|
||||
|
||||
3. **Commit the cleanup**:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "Remove dead code files"
|
||||
```
|
||||
+78
@@ -0,0 +1,78 @@
|
||||
src
|
||||
├── bin
|
||||
│ ├── cleanup-duplicates.ts
|
||||
│ └── import-xml-observations.ts
|
||||
├── hooks
|
||||
│ ├── cleanup-hook.ts
|
||||
│ ├── context-hook.ts
|
||||
│ ├── hook-response.ts
|
||||
│ ├── index.ts
|
||||
│ ├── new-hook.ts
|
||||
│ ├── save-hook.ts
|
||||
│ ├── summary-hook.ts
|
||||
│ └── user-message-hook.ts
|
||||
├── sdk
|
||||
│ ├── index.ts
|
||||
│ ├── parser.test.ts
|
||||
│ ├── parser.ts
|
||||
│ └── prompts.ts
|
||||
├── servers
|
||||
│ └── search-server.ts
|
||||
├── services
|
||||
│ ├── sqlite
|
||||
│ │ ├── Database.ts
|
||||
│ │ ├── SessionSearch.ts
|
||||
│ │ ├── SessionStore.ts
|
||||
│ │ ├── index.ts
|
||||
│ │ ├── migrations.ts
|
||||
│ │ └── types.ts
|
||||
│ ├── sync
|
||||
│ │ └── ChromaSync.ts
|
||||
│ └── worker-service.ts
|
||||
├── shared
|
||||
│ ├── config.ts
|
||||
│ ├── paths.ts
|
||||
│ ├── storage.ts
|
||||
│ ├── types.ts
|
||||
│ └── worker-utils.ts
|
||||
├── ui
|
||||
│ ├── claude-mem-logo-for-dark-mode.webp
|
||||
│ ├── claude-mem-logomark.webp
|
||||
│ ├── viewer
|
||||
│ │ ├── App.tsx
|
||||
│ │ ├── assets
|
||||
│ │ │ └── fonts
|
||||
│ │ │ ├── monaspace-radon-var.woff
|
||||
│ │ │ └── monaspace-radon-var.woff2
|
||||
│ │ ├── components
|
||||
│ │ │ ├── ErrorBoundary.tsx
|
||||
│ │ │ ├── Feed.tsx
|
||||
│ │ │ ├── Header.tsx
|
||||
│ │ │ ├── ObservationCard.tsx
|
||||
│ │ │ ├── PromptCard.tsx
|
||||
│ │ │ ├── Sidebar.tsx
|
||||
│ │ │ ├── SummaryCard.tsx
|
||||
│ │ │ └── ThemeToggle.tsx
|
||||
│ │ ├── constants
|
||||
│ │ │ ├── api.ts
|
||||
│ │ │ ├── settings.ts
|
||||
│ │ │ ├── timing.ts
|
||||
│ │ │ └── ui.ts
|
||||
│ │ ├── hooks
|
||||
│ │ │ ├── usePagination.ts
|
||||
│ │ │ ├── useSSE.ts
|
||||
│ │ │ ├── useSettings.ts
|
||||
│ │ │ ├── useStats.ts
|
||||
│ │ │ └── useTheme.ts
|
||||
│ │ ├── index.tsx
|
||||
│ │ ├── types.ts
|
||||
│ │ └── utils
|
||||
│ │ ├── data.ts
|
||||
│ │ └── formatters.ts
|
||||
│ └── viewer-template.html
|
||||
└── utils
|
||||
├── logger.ts
|
||||
├── platform.ts
|
||||
└── usage-logger.ts
|
||||
|
||||
18 directories, 58 files
|
||||
@@ -1,4 +0,0 @@
|
||||
export { contextHook } from './context.js';
|
||||
export { saveHook } from './save.js';
|
||||
export { newHook } from './new.js';
|
||||
export { summaryHook } from './summary.js';
|
||||
@@ -1,8 +0,0 @@
|
||||
/**
|
||||
* SDK Module Exports
|
||||
*/
|
||||
|
||||
export { buildInitPrompt, buildObservationPrompt } from './prompts.js';
|
||||
export { parseObservations, parseSummary } from './parser.js';
|
||||
export type { Observation, SDKSession } from './prompts.js';
|
||||
export type { ParsedObservation, ParsedSummary } from './parser.js';
|
||||
@@ -1,48 +0,0 @@
|
||||
import { readFileSync, existsSync } from 'fs';
|
||||
import { join, dirname } from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
|
||||
// <Block> 5.1 ====================================
|
||||
// Default values
|
||||
const DEFAULT_PACKAGE_NAME = 'claude-mem';
|
||||
// This MUST be replaced by build process with --define flag
|
||||
// @ts-ignore
|
||||
// For development, use fallback
|
||||
const DEFAULT_PACKAGE_VERSION = typeof __DEFAULT_PACKAGE_VERSION__ !== 'undefined'
|
||||
? __DEFAULT_PACKAGE_VERSION__
|
||||
: '3.5.6-dev';
|
||||
const DEFAULT_PACKAGE_DESCRIPTION = 'Memory compression system for Claude Code - persist context across sessions';
|
||||
|
||||
let packageName = DEFAULT_PACKAGE_NAME;
|
||||
let packageVersion = DEFAULT_PACKAGE_VERSION;
|
||||
let packageDescription = DEFAULT_PACKAGE_DESCRIPTION;
|
||||
// </Block> =======================================
|
||||
|
||||
// Try to read package.json if it exists (for development)
|
||||
// <Block> 5.2 ====================================
|
||||
try {
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = dirname(__filename);
|
||||
const packageJsonPath = join(__dirname, '..', '..', 'package.json');
|
||||
|
||||
// <Block> 5.2a ====================================
|
||||
if (existsSync(packageJsonPath)) {
|
||||
const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
|
||||
// <Block> 5.2b ====================================
|
||||
packageName = packageJson.name || DEFAULT_PACKAGE_NAME;
|
||||
packageVersion = packageJson.version || DEFAULT_PACKAGE_VERSION;
|
||||
packageDescription = packageJson.description || DEFAULT_PACKAGE_DESCRIPTION;
|
||||
// </Block> =======================================
|
||||
}
|
||||
// </Block> =======================================
|
||||
} catch {
|
||||
// Use defaults if package.json can't be read
|
||||
}
|
||||
// </Block> =======================================
|
||||
|
||||
// <Block> 5.3 ====================================
|
||||
// Export package configuration
|
||||
export const PACKAGE_NAME = packageName;
|
||||
export const PACKAGE_VERSION = packageVersion;
|
||||
export const PACKAGE_DESCRIPTION = packageDescription;
|
||||
// </Block> =======================================
|
||||
@@ -1,188 +0,0 @@
|
||||
import {
|
||||
createStores,
|
||||
SessionStore,
|
||||
MemoryStore,
|
||||
OverviewStore,
|
||||
DiagnosticsStore,
|
||||
SessionInput,
|
||||
MemoryInput,
|
||||
OverviewInput,
|
||||
DiagnosticInput,
|
||||
SessionRow,
|
||||
MemoryRow,
|
||||
OverviewRow,
|
||||
DiagnosticRow,
|
||||
normalizeTimestamp
|
||||
} from '../services/sqlite/index.js';
|
||||
|
||||
/**
|
||||
* Storage backend types
|
||||
*/
|
||||
export type StorageBackend = 'sqlite' | 'jsonl';
|
||||
|
||||
/**
|
||||
* Unified interface for storage operations
|
||||
*/
|
||||
export interface IStorageProvider {
|
||||
backend: StorageBackend;
|
||||
|
||||
// Session operations
|
||||
createSession(session: SessionInput): Promise<SessionRow | void>;
|
||||
getSession(sessionId: string): Promise<SessionRow | null>;
|
||||
hasSession(sessionId: string): Promise<boolean>;
|
||||
getAllSessionIds(): Promise<Set<string>>;
|
||||
getRecentSessions(limit?: number): Promise<SessionRow[]>;
|
||||
getRecentSessionsForProject(project: string, limit?: number): Promise<SessionRow[]>;
|
||||
|
||||
// Memory operations
|
||||
createMemory(memory: MemoryInput): Promise<MemoryRow | void>;
|
||||
createMemories(memories: MemoryInput[]): Promise<void>;
|
||||
getRecentMemories(limit?: number): Promise<MemoryRow[]>;
|
||||
getRecentMemoriesForProject(project: string, limit?: number): Promise<MemoryRow[]>;
|
||||
hasDocumentId(documentId: string): Promise<boolean>;
|
||||
|
||||
// Overview operations
|
||||
createOverview(overview: OverviewInput): Promise<OverviewRow | void>;
|
||||
upsertOverview(overview: OverviewInput): Promise<OverviewRow | void>;
|
||||
getRecentOverviews(limit?: number): Promise<OverviewRow[]>;
|
||||
getRecentOverviewsForProject(project: string, limit?: number): Promise<OverviewRow[]>;
|
||||
|
||||
// Diagnostic operations
|
||||
createDiagnostic(diagnostic: DiagnosticInput): Promise<DiagnosticRow | void>;
|
||||
|
||||
// Health check
|
||||
isAvailable(): Promise<boolean>;
|
||||
}
|
||||
|
||||
/**
|
||||
* SQLite-based storage provider
|
||||
*/
|
||||
export class SQLiteStorageProvider implements IStorageProvider {
|
||||
public readonly backend = 'sqlite';
|
||||
|
||||
private stores?: {
|
||||
sessions: SessionStore;
|
||||
memories: MemoryStore;
|
||||
overviews: OverviewStore;
|
||||
diagnostics: DiagnosticsStore;
|
||||
};
|
||||
|
||||
private async getStores() {
|
||||
if (!this.stores) {
|
||||
this.stores = await createStores();
|
||||
}
|
||||
return this.stores;
|
||||
}
|
||||
|
||||
async isAvailable(): Promise<boolean> {
|
||||
try {
|
||||
await this.getStores();
|
||||
return true;
|
||||
} catch (error) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async createSession(session: SessionInput): Promise<SessionRow> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.create(session);
|
||||
}
|
||||
|
||||
async getSession(sessionId: string): Promise<SessionRow | null> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.getBySessionId(sessionId);
|
||||
}
|
||||
|
||||
async hasSession(sessionId: string): Promise<boolean> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.has(sessionId);
|
||||
}
|
||||
|
||||
async getAllSessionIds(): Promise<Set<string>> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.getAllSessionIds();
|
||||
}
|
||||
|
||||
async getRecentSessions(limit = 5): Promise<SessionRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.getRecent(limit);
|
||||
}
|
||||
|
||||
async getRecentSessionsForProject(project: string, limit = 5): Promise<SessionRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.sessions.getRecentForProject(project, limit);
|
||||
}
|
||||
|
||||
async createMemory(memory: MemoryInput): Promise<MemoryRow> {
|
||||
const stores = await this.getStores();
|
||||
return stores.memories.create(memory);
|
||||
}
|
||||
|
||||
async createMemories(memories: MemoryInput[]): Promise<void> {
|
||||
const stores = await this.getStores();
|
||||
stores.memories.createMany(memories);
|
||||
}
|
||||
|
||||
async getRecentMemories(limit = 10): Promise<MemoryRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.memories.getRecent(limit);
|
||||
}
|
||||
|
||||
async getRecentMemoriesForProject(project: string, limit = 10): Promise<MemoryRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.memories.getRecentForProject(project, limit);
|
||||
}
|
||||
|
||||
async hasDocumentId(documentId: string): Promise<boolean> {
|
||||
const stores = await this.getStores();
|
||||
return stores.memories.hasDocumentId(documentId);
|
||||
}
|
||||
|
||||
async createOverview(overview: OverviewInput): Promise<OverviewRow> {
|
||||
const stores = await this.getStores();
|
||||
return stores.overviews.create(overview);
|
||||
}
|
||||
|
||||
async upsertOverview(overview: OverviewInput): Promise<OverviewRow> {
|
||||
const stores = await this.getStores();
|
||||
return stores.overviews.upsert(overview);
|
||||
}
|
||||
|
||||
async getRecentOverviews(limit = 5): Promise<OverviewRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.overviews.getRecent(limit);
|
||||
}
|
||||
|
||||
async getRecentOverviewsForProject(project: string, limit = 5): Promise<OverviewRow[]> {
|
||||
const stores = await this.getStores();
|
||||
return stores.overviews.getRecentForProject(project, limit);
|
||||
}
|
||||
|
||||
async createDiagnostic(diagnostic: DiagnosticInput): Promise<DiagnosticRow> {
|
||||
const stores = await this.getStores();
|
||||
return stores.diagnostics.create(diagnostic);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Storage provider singleton
|
||||
*/
|
||||
let storageProvider: IStorageProvider | null = null;
|
||||
|
||||
/**
|
||||
* Get the configured storage provider (always SQLite)
|
||||
*/
|
||||
export async function getStorageProvider(): Promise<IStorageProvider> {
|
||||
if (storageProvider) {
|
||||
return storageProvider;
|
||||
}
|
||||
|
||||
const sqliteProvider = new SQLiteStorageProvider();
|
||||
if (await sqliteProvider.isAvailable()) {
|
||||
storageProvider = sqliteProvider;
|
||||
return storageProvider;
|
||||
}
|
||||
|
||||
throw new Error('SQLite storage backend unavailable');
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
/**
|
||||
* Core Type Definitions
|
||||
*
|
||||
* Minimal type definitions for the claude-mem system.
|
||||
* Only includes types that are actively imported and used.
|
||||
*/
|
||||
|
||||
// =============================================================================
|
||||
// CONFIGURATION TYPES
|
||||
// =============================================================================
|
||||
|
||||
/**
|
||||
* Main settings interface for claude-mem configuration
|
||||
*/
|
||||
export interface Settings {
|
||||
autoCompress?: boolean;
|
||||
projectName?: string;
|
||||
installed?: boolean;
|
||||
backend?: string;
|
||||
embedded?: boolean;
|
||||
saveMemoriesOnClear?: boolean;
|
||||
rollingCaptureEnabled?: boolean;
|
||||
rollingSummaryEnabled?: boolean;
|
||||
rollingSessionStartEnabled?: boolean;
|
||||
rollingChunkTokens?: number;
|
||||
rollingChunkOverlapTokens?: number;
|
||||
rollingSummaryTurnLimit?: number;
|
||||
[key: string]: unknown; // Allow additional properties
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
import { platform, homedir } from 'os';
|
||||
import { execSync } from 'child_process';
|
||||
import { join } from 'path';
|
||||
|
||||
const isWindows = platform() === 'win32';
|
||||
|
||||
/**
|
||||
* Platform-specific utilities for cross-platform compatibility
|
||||
* Handles differences between Windows and Unix-like systems
|
||||
*/
|
||||
export const Platform = {
|
||||
/**
|
||||
* Installs uv package manager using platform-specific method
|
||||
*/
|
||||
installUv: (): void => {
|
||||
if (isWindows) {
|
||||
execSync('powershell -Command "irm https://astral.sh/uv/install.ps1 | iex"', {
|
||||
stdio: 'pipe'
|
||||
});
|
||||
} else {
|
||||
execSync('curl -LsSf https://astral.sh/uv/install.sh | sh', {
|
||||
stdio: 'pipe',
|
||||
shell: '/bin/sh'
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns shell configuration file paths for the current platform
|
||||
* @returns Array of shell config file paths
|
||||
*/
|
||||
getShellConfigPaths: (): string[] => {
|
||||
const home = homedir();
|
||||
|
||||
if (isWindows) {
|
||||
return [
|
||||
join(home, 'Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1'),
|
||||
join(home, 'Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1')
|
||||
];
|
||||
}
|
||||
|
||||
return [
|
||||
join(home, '.bashrc'),
|
||||
join(home, '.zshrc'),
|
||||
join(home, '.bash_profile')
|
||||
];
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets the appropriate alias syntax for the current platform's shell
|
||||
* @param aliasName - Name of the alias
|
||||
* @param command - Command to alias
|
||||
* @returns Alias definition string
|
||||
*/
|
||||
getAliasDefinition: (aliasName: string, command: string): string => {
|
||||
if (isWindows) {
|
||||
// PowerShell function syntax
|
||||
return `function ${aliasName} { ${command} $args }`;
|
||||
}
|
||||
|
||||
// Bash/Zsh alias syntax
|
||||
return `alias ${aliasName}='${command}'`;
|
||||
}
|
||||
};
|
||||
@@ -1,61 +0,0 @@
|
||||
import { appendFileSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { homedir } from 'os';
|
||||
|
||||
/**
|
||||
* Usage data structure from Claude Agent SDK result messages
|
||||
*/
|
||||
export interface UsageData {
|
||||
timestamp: string;
|
||||
sessionDbId: number;
|
||||
claudeSessionId: string;
|
||||
project: string;
|
||||
promptNumber: number;
|
||||
model: string;
|
||||
sessionId: string; // SDK session ID
|
||||
uuid: string; // SDK message UUID
|
||||
durationMs: number;
|
||||
durationApiMs: number;
|
||||
numTurns: number;
|
||||
totalCostUsd: number;
|
||||
usage: {
|
||||
inputTokens: number;
|
||||
outputTokens: number;
|
||||
cacheCreationInputTokens: number;
|
||||
cacheReadInputTokens: number;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Logger for capturing usage metrics to JSONL files
|
||||
*/
|
||||
export class UsageLogger {
|
||||
private logDir: string;
|
||||
private logFile: string;
|
||||
|
||||
constructor() {
|
||||
this.logDir = join(homedir(), '.claude-mem', 'usage-logs');
|
||||
// Create a daily log file
|
||||
const date = new Date().toISOString().split('T')[0]; // YYYY-MM-DD
|
||||
this.logFile = join(this.logDir, `usage-${date}.jsonl`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Log usage data from SDK result message
|
||||
*/
|
||||
logUsage(data: UsageData): void {
|
||||
try {
|
||||
const line = JSON.stringify(data) + '\n';
|
||||
appendFileSync(this.logFile, line, 'utf-8');
|
||||
} catch (error) {
|
||||
console.error('Failed to log usage data:', error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current log file path
|
||||
*/
|
||||
getLogFilePath(): string {
|
||||
return this.logFile;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user