admin/cim_summary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
57770fd99dee32e22c55ae1fbcaf8111717c5b4d
cim_summary/.kiro/specs/cim-document-processor/requirements.md
Jon 5a3c961bfc feat: Complete implementation of Tasks 1-5 - CIM Document Processor 
Backend Infrastructure:
- Complete Express server setup with security middleware (helmet, CORS, rate limiting)
- Comprehensive error handling and logging with Winston
- Authentication system with JWT tokens and session management
- Database models and migrations for Users, Documents, Feedback, and Processing Jobs
- API routes structure for authentication and document management
- Integration tests for all server components (86 tests passing)

Frontend Infrastructure:
- React application with TypeScript and Vite
- Authentication UI with login form, protected routes, and logout functionality
- Authentication context with proper async state management
- Component tests with proper async handling (25 tests passing)
- Tailwind CSS styling and responsive design

Key Features:
- User registration, login, and authentication
- Protected routes with role-based access control
- Comprehensive error handling and user feedback
- Database schema with proper relationships
- Security middleware and validation
- Production-ready build configuration

Test Coverage: 111/111 tests passing
Tasks Completed: 1-5 (Project setup, Database, Auth system, Frontend UI, Backend infrastructure)

Ready for Task 6: File upload backend infrastructure
2025-07-27 13:29:26 -04:00

8.7 KiB
Raw Blame History

Requirements Document

Introduction

This feature enables team members to upload CIM (Confidential Information Memorandum) documents through a secure web interface, have them analyzed by an LLM for detailed review, and receive structured summaries in both Markdown and PDF formats. The system provides authentication, document processing, and downloadable outputs following a specific template format.

Requirements

Requirement 1

User Story: As a team member, I want to securely log into the website, so that I can access the CIM processing functionality with proper authentication.

Acceptance Criteria

  1. WHEN a user visits the website THEN the system SHALL display a login page
  2. WHEN a user enters valid credentials THEN the system SHALL authenticate them and redirect to the main dashboard
  3. WHEN a user enters invalid credentials THEN the system SHALL display an error message and remain on the login page
  4. WHEN a user is not authenticated THEN the system SHALL redirect them to the login page for any protected routes
  5. WHEN a user logs out THEN the system SHALL clear their session and redirect to the login page

Requirement 2

User Story: As an authenticated team member, I want to upload CIM PDF documents (75-100+ pages), so that I can have them processed and analyzed.

Acceptance Criteria

  1. WHEN a user accesses the upload interface THEN the system SHALL display a file upload component
  2. WHEN a user selects a PDF file THEN the system SHALL validate it is a PDF format
  3. WHEN a user uploads a file larger than 100MB THEN the system SHALL reject it with an appropriate error message
  4. WHEN a user uploads a non-PDF file THEN the system SHALL reject it with an appropriate error message
  5. WHEN a valid PDF is uploaded THEN the system SHALL store it securely and initiate processing
  6. WHEN upload is in progress THEN the system SHALL display upload progress to the user

Requirement 3

User Story: As a team member, I want the uploaded CIM to be reviewed in detail by an LLM using a two-part analysis process, so that I can get both structured data extraction and expert investment analysis.

Acceptance Criteria

  1. WHEN a CIM document is uploaded THEN the system SHALL extract text content from the PDF
  2. WHEN text extraction is complete THEN the system SHALL send the content to an LLM with the predefined analysis prompt
  3. WHEN LLM processing begins THEN the system SHALL execute Part 1 (CIM Data Extraction) using only information from the CIM text
  4. WHEN Part 1 is complete THEN the system SHALL execute Part 2 (Analyst Diligence Questions) using both CIM content and general industry knowledge
  5. WHEN LLM processing is in progress THEN the system SHALL display processing status to the user
  6. WHEN LLM analysis fails THEN the system SHALL log the error and notify the user
  7. WHEN LLM analysis is complete THEN the system SHALL store both the populated template and diligence analysis results
  8. IF the document is too large for single LLM processing THEN the system SHALL chunk it appropriately and process in segments

Requirement 4

User Story: As a team member, I want the LLM to populate the predefined BPCP CIM Review Template with extracted data and include investment diligence analysis, so that I receive consistent and structured summaries following our established format.

Acceptance Criteria

  1. WHEN LLM processing begins THEN the system SHALL provide both the CIM text and the BPCP CIM Review Template to the LLM
  2. WHEN executing Part 1 THEN the system SHALL ensure the LLM populates all template sections (A-G) using only CIM-sourced information
  3. WHEN template fields cannot be populated from CIM THEN the system SHALL ensure "Not specified in CIM" is entered
  4. WHEN executing Part 2 THEN the system SHALL ensure the LLM adds a "Key Investment Considerations & Diligence Areas" section
  5. WHEN LLM processing is complete THEN the system SHALL validate the output maintains proper markdown formatting and template structure
  6. WHEN template validation fails THEN the system SHALL log the error and retry the LLM processing
  7. WHEN the populated template is ready THEN the system SHALL store it as the final markdown summary

Requirement 5

User Story: As a team member, I want to download the CIM summary in both Markdown and PDF formats, so that I can use the analysis in different contexts and share it appropriately.

Acceptance Criteria

  1. WHEN a CIM summary is ready THEN the system SHALL provide download links for both MD and PDF formats
  2. WHEN a user clicks the Markdown download THEN the system SHALL serve the .md file for download
  3. WHEN a user clicks the PDF download THEN the system SHALL convert the markdown to PDF and serve it for download
  4. WHEN PDF conversion is in progress THEN the system SHALL display conversion status
  5. WHEN PDF conversion fails THEN the system SHALL log the error and notify the user
  6. WHEN downloads are requested THEN the system SHALL ensure proper file naming with timestamps

Requirement 6

User Story: As a team member, I want to view the processing status and history of my uploaded CIMs, so that I can track progress and access previous analyses.

Acceptance Criteria

  1. WHEN a user accesses the dashboard THEN the system SHALL display a list of their uploaded documents
  2. WHEN viewing document history THEN the system SHALL show upload date, processing status, and completion status
  3. WHEN a document is processing THEN the system SHALL display real-time status updates
  4. WHEN a document processing is complete THEN the system SHALL show download options
  5. WHEN a document processing fails THEN the system SHALL display error information and retry options
  6. WHEN viewing document details THEN the system SHALL show file name, size, and processing timestamps

Requirement 7

User Story: As a team member, I want to provide feedback on generated summaries and request regeneration with specific instructions, so that I can get summaries that better meet my needs.

Acceptance Criteria

  1. WHEN viewing a completed summary THEN the system SHALL provide a feedback interface for user comments
  2. WHEN a user submits feedback THEN the system SHALL store the commentary with the document record
  3. WHEN a user requests summary regeneration THEN the system SHALL provide a text field for specific instructions
  4. WHEN regeneration is requested THEN the system SHALL reprocess the document using the original content plus user instructions
  5. WHEN regeneration is complete THEN the system SHALL replace the previous summary with the new version
  6. WHEN multiple regenerations occur THEN the system SHALL maintain a history of previous versions
  7. WHEN viewing summary history THEN the system SHALL show timestamps and user feedback for each version

Requirement 8

User Story: As a system administrator, I want to view and manage all uploaded PDF files and summary files from all users, so that I can maintain an archive and have oversight of all processed documents.

Acceptance Criteria

  1. WHEN an administrator accesses the admin dashboard THEN the system SHALL display all uploaded documents from all users
  2. WHEN viewing the admin archive THEN the system SHALL show document details including uploader, upload date, and processing status
  3. WHEN an administrator selects a document THEN the system SHALL provide access to both original PDF and generated summaries
  4. WHEN an administrator downloads files THEN the system SHALL log the admin access for audit purposes
  5. WHEN viewing user documents THEN the system SHALL display user information alongside document metadata
  6. WHEN searching the archive THEN the system SHALL allow filtering by user, date range, and processing status
  7. WHEN an administrator deletes a document THEN the system SHALL remove both the original PDF and all generated summaries
  8. WHEN an administrator confirms deletion THEN the system SHALL log the deletion action for audit purposes
  9. WHEN files are deleted THEN the system SHALL free up storage space and update storage metrics

Requirement 9

User Story: As a system administrator, I want the application to handle errors gracefully and maintain security, so that the system remains stable and user data is protected.

Acceptance Criteria

  1. WHEN any system error occurs THEN the system SHALL log detailed error information
  2. WHEN file uploads fail THEN the system SHALL clean up any partial uploads
  3. WHEN LLM processing fails THEN the system SHALL retry up to 3 times before marking as failed
  4. WHEN user sessions expire THEN the system SHALL redirect to login without data loss
  5. WHEN unauthorized access is attempted THEN the system SHALL log the attempt and deny access
  6. WHEN sensitive data is processed THEN the system SHALL ensure encryption at rest and in transit
Reference in New Issue View Git Blame Copy Permalink