crewly 1.0.7 → 1.0.10

package/dist/cli/backend/src/services/memory/project-memory.service.d.ts

@@ -0,0 +1,252 @@
+/**
+ * Project Memory Service
+ *
+ * Manages project-level persistent memory stored in project/.crewly/knowledge/
+ * Provides storage for patterns, decisions, gotchas, and relationships.
+ *
+ * @module services/memory/project-memory.service
+ */
+import { ProjectMemory, PatternEntry, DecisionEntry, GotchaEntry, RelationshipEntry, type PatternCategory, type GotchaSeverity } from '../../types/memory.types.js';
+/**
+ * Search results from cross-entity search
+ */
+export interface SearchResults {
+    patterns: PatternEntry[];
+    decisions: DecisionEntry[];
+    gotchas: GotchaEntry[];
+    relationships: RelationshipEntry[];
+    totalCount: number;
+}
+/**
+ * Interface for the Project Memory Service
+ */
+export interface IProjectMemoryService {
+    initializeProject(projectPath: string): Promise<void>;
+    addPattern(projectPath: string, pattern: Omit<PatternEntry, 'id' | 'createdAt'>): Promise<string>;
+    getPatterns(projectPath: string, category?: PatternCategory): Promise<PatternEntry[]>;
+    searchPatterns(projectPath: string, query: string): Promise<PatternEntry[]>;
+    addDecision(projectPath: string, decision: Omit<DecisionEntry, 'id' | 'decidedAt'>): Promise<string>;
+    getDecisions(projectPath: string): Promise<DecisionEntry[]>;
+    addGotcha(projectPath: string, gotcha: Omit<GotchaEntry, 'id' | 'createdAt'>): Promise<string>;
+    getGotchas(projectPath: string, severity?: GotchaSeverity): Promise<GotchaEntry[]>;
+    addRelationship(projectPath: string, relationship: Omit<RelationshipEntry, 'id'>): Promise<string>;
+    getRelationships(projectPath: string, componentName?: string): Promise<RelationshipEntry[]>;
+    recordLearning(projectPath: string, agentId: string, agentRole: string, learning: string, metadata?: Record<string, unknown>): Promise<void>;
+    getRecentLearnings(projectPath: string, limit?: number): Promise<string>;
+    generateProjectContext(projectPath: string): Promise<string>;
+    searchAll(projectPath: string, query: string): Promise<SearchResults>;
+    getProjectMemory(projectPath: string): Promise<ProjectMemory | null>;
+}
+/**
+ * Service for managing project-level persistent memory
+ *
+ * Follows singleton pattern for consistent state management.
+ * Uses atomic file writes to prevent data corruption.
+ *
+ * @example
+ * ```typescript
+ * const memoryService = ProjectMemoryService.getInstance();
+ * await memoryService.initializeProject('/path/to/project');
+ * await memoryService.addPattern('/path/to/project', {
+ *   category: 'api',
+ *   title: 'Error Handling Wrapper',
+ *   description: 'All API endpoints use handleApiError() wrapper',
+ *   discoveredBy: 'backend-dev-001'
+ * });
+ * ```
+ */
+export declare class ProjectMemoryService implements IProjectMemoryService {
+    private static instance;
+    private readonly logger;
+    private readonly memoryCache;
+    private readonly CACHE_TTL_MS;
+    /**
+     * Creates a new ProjectMemoryService instance
+     */
+    constructor();
+    /**
+     * Gets the singleton instance of ProjectMemoryService
+     *
+     * @returns The singleton ProjectMemoryService instance
+     */
+    static getInstance(): ProjectMemoryService;
+    /**
+     * Clears the singleton instance (useful for testing)
+     */
+    static clearInstance(): void;
+    /**
+     * Gets the path to a project's knowledge directory
+     *
+     * @param projectPath - Absolute path to the project
+     * @returns Path to the knowledge directory
+     */
+    private getKnowledgePath;
+    /**
+     * Gets the path to a specific memory file for a project
+     *
+     * @param projectPath - Absolute path to the project
+     * @param fileName - The memory file name
+     * @returns Absolute path to the memory file
+     */
+    private getFilePath;
+    /**
+     * Checks if a file exists
+     *
+     * @param filePath - Path to check
+     * @returns true if file exists
+     */
+    private fileExists;
+    /**
+     * Invalidates the cache for a project
+     *
+     * @param projectPath - Project path
+     */
+    private invalidateCache;
+    /**
+     * Checks if content is similar (simple substring matching)
+     *
+     * @param existing - Existing content
+     * @param newContent - New content to compare
+     * @returns true if content is similar
+     */
+    private isSimilarContent;
+    /**
+     * Initializes memory storage for a project
+     *
+     * @param projectPath - Absolute path to the project
+     *
+     * @example
+     * ```typescript
+     * await memoryService.initializeProject('/home/user/projects/my-app');
+     * ```
+     */
+    initializeProject(projectPath: string): Promise<void>;
+    /**
+     * Adds a new pattern entry
+     *
+     * @param projectPath - Project path
+     * @param pattern - Pattern data (without id and createdAt)
+     * @returns ID of the created or existing pattern
+     */
+    addPattern(projectPath: string, pattern: Omit<PatternEntry, 'id' | 'createdAt'>): Promise<string>;
+    /**
+     * Gets all patterns, optionally filtered by category
+     *
+     * @param projectPath - Project path
+     * @param category - Optional category filter
+     * @returns Array of patterns
+     */
+    getPatterns(projectPath: string, category?: PatternCategory): Promise<PatternEntry[]>;
+    /**
+     * Saves patterns to disk
+     */
+    private savePatterns;
+    /**
+     * Searches patterns by query
+     *
+     * @param projectPath - Project path
+     * @param query - Search query
+     * @returns Matching patterns
+     */
+    searchPatterns(projectPath: string, query: string): Promise<PatternEntry[]>;
+    /**
+     * Adds a new decision entry
+     *
+     * @param projectPath - Project path
+     * @param decision - Decision data (without id and decidedAt)
+     * @returns ID of the created decision
+     */
+    addDecision(projectPath: string, decision: Omit<DecisionEntry, 'id' | 'decidedAt'>): Promise<string>;
+    /**
+     * Gets all decisions
+     *
+     * @param projectPath - Project path
+     * @returns Array of decisions (active ones first)
+     */
+    getDecisions(projectPath: string): Promise<DecisionEntry[]>;
+    /**
+     * Saves decisions to disk
+     */
+    private saveDecisions;
+    /**
+     * Adds a new gotcha entry
+     *
+     * @param projectPath - Project path
+     * @param gotcha - Gotcha data (without id and createdAt)
+     * @returns ID of the created gotcha
+     */
+    addGotcha(projectPath: string, gotcha: Omit<GotchaEntry, 'id' | 'createdAt'>): Promise<string>;
+    /**
+     * Gets all gotchas, optionally filtered by severity
+     *
+     * @param projectPath - Project path
+     * @param severity - Optional severity filter
+     * @returns Array of gotchas (high severity first)
+     */
+    getGotchas(projectPath: string, severity?: GotchaSeverity): Promise<GotchaEntry[]>;
+    /**
+     * Saves gotchas to disk
+     */
+    private saveGotchas;
+    /**
+     * Adds a new relationship entry
+     *
+     * @param projectPath - Project path
+     * @param relationship - Relationship data (without id)
+     * @returns ID of the created relationship
+     */
+    addRelationship(projectPath: string, relationship: Omit<RelationshipEntry, 'id'>): Promise<string>;
+    /**
+     * Gets relationships, optionally filtered by component name
+     *
+     * @param projectPath - Project path
+     * @param componentName - Optional component name filter
+     * @returns Array of relationships
+     */
+    getRelationships(projectPath: string, componentName?: string): Promise<RelationshipEntry[]>;
+    /**
+     * Saves relationships to disk
+     */
+    private saveRelationships;
+    /**
+     * Records a learning entry to the append-only log
+     *
+     * @param projectPath - Project path
+     * @param agentId - Agent that made the learning
+     * @param agentRole - Agent's role
+     * @param learning - The learning content
+     * @param metadata - Optional metadata
+     */
+    recordLearning(projectPath: string, agentId: string, agentRole: string, learning: string, metadata?: Record<string, unknown>): Promise<void>;
+    /**
+     * Gets recent learnings from the log
+     *
+     * @param projectPath - Project path
+     * @param limit - Maximum number of entries to return
+     * @returns Recent learnings as markdown
+     */
+    getRecentLearnings(projectPath: string, limit?: number): Promise<string>;
+    /**
+     * Generates a context string for prompt injection
+     *
+     * @param projectPath - Project path
+     * @returns Formatted context string
+     */
+    generateProjectContext(projectPath: string): Promise<string>;
+    /**
+     * Searches across all entity types
+     *
+     * @param projectPath - Project path
+     * @param query - Search query
+     * @returns Search results from all categories
+     */
+    searchAll(projectPath: string, query: string): Promise<SearchResults>;
+    /**
+     * Gets the complete project memory object
+     *
+     * @param projectPath - Project path
+     * @returns Full project memory or null if not initialized
+     */
+    getProjectMemory(projectPath: string): Promise<ProjectMemory | null>;
+}
+//# sourceMappingURL=project-memory.service.d.ts.map

package/dist/cli/backend/src/services/memory/project-memory.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-memory.service.d.ts","sourceRoot":"","sources":["../../../../../../backend/src/services/memory/project-memory.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EACL,aAAa,EACb,YAAY,EACZ,aAAa,EACb,WAAW,EACX,iBAAiB,EAEjB,KAAK,eAAe,EACpB,KAAK,cAAc,EAEpB,MAAM,6BAA6B,CAAC;AAIrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClG,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACtF,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5E,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrG,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5D,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/F,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACnF,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC5F,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7I,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzE,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACtE,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;CACtE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,oBAAqB,YAAW,qBAAqB;IAChE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqC;IAE5D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6E;IAGpG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsE;IAClG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;OAEG;;IAKH;;;;OAIG;WACW,WAAW,IAAI,oBAAoB;IAOjD;;OAEG;WACW,aAAa,IAAI,IAAI;IAInC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAInB;;;;;OAKG;YACW,UAAU;IASxB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAIvB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;;;;;;;;OASG;IACU,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6ClE;;;;;;OAMG;IACU,UAAU,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,WAAW,CAAC,GAC9C,OAAO,CAAC,MAAM,CAAC;IAuDlB;;;;;;OAMG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAUlG;;OAEG;YACW,YAAY;IAM1B;;;;;;OAMG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAYxF;;;;;;OAMG;IACU,WAAW,CACtB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,GAAG,WAAW,CAAC,GAChD,OAAO,CAAC,MAAM,CAAC;IA6ClB;;;;;OAKG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAWxE;;OAEG;YACW,aAAa;IAM3B;;;;;;OAMG;IACU,SAAS,CACpB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,WAAW,CAAC,GAC5C,OAAO,CAAC,MAAM,CAAC;IAmDlB;;;;;;OAMG;IACU,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAa/F;;OAEG;YACW,WAAW;IAMzB;;;;;;OAMG;IACU,eAAe,CAC1B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,GAC1C,OAAO,CAAC,MAAM,CAAC;IAoClB;;;;;;OAMG;IACU,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAYxG;;OAEG;YACW,iBAAiB;IAM/B;;;;;;;;OAQG;IACU,cAAc,CACzB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;OAMG;IACU,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAezF;;;;;OAKG;IACU,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkEzE;;;;;;OAMG;IACU,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA0ClF;;;;;OAKG;IACU,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;CAIlF"}