@zenuml/core 3.32.6 → 3.32.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/README.md +162 -0
- package/.claude/commands/code-review.md +322 -0
- package/.claude/commands/create-docs.md +309 -0
- package/.claude/commands/full-context.md +121 -0
- package/.claude/commands/gemini-consult.md +164 -0
- package/.claude/commands/handoff.md +146 -0
- package/.claude/commands/refactor.md +188 -0
- package/.claude/commands/update-docs.md +314 -0
- package/.claude/hooks/README.md +270 -0
- package/.claude/hooks/config/sensitive-patterns.json +86 -0
- package/.claude/hooks/gemini-context-injector.sh +129 -0
- package/.claude/hooks/mcp-security-scan.sh +147 -0
- package/.claude/hooks/notify.sh +103 -0
- package/.claude/hooks/setup/hook-setup.md +96 -0
- package/.claude/hooks/setup/settings.json.template +63 -0
- package/.claude/hooks/sounds/complete.wav +0 -0
- package/.claude/hooks/sounds/input-needed.wav +0 -0
- package/.claude/hooks/subagent-context-injector.sh +65 -0
- package/.storybook/main.ts +25 -0
- package/.storybook/preview.ts +29 -0
- package/MCP-ASSISTANT-RULES.md +85 -0
- package/dist/zenuml.esm.mjs +3037 -2994
- package/dist/zenuml.js +40 -40
- package/docs/CONTEXT-tier2-component.md +96 -0
- package/docs/CONTEXT-tier3-feature.md +162 -0
- package/docs/README.md +207 -0
- package/docs/ai-context/deployment-infrastructure.md +21 -0
- package/docs/ai-context/docs-overview.md +89 -0
- package/docs/ai-context/handoff.md +174 -0
- package/docs/ai-context/project-structure.md +160 -0
- package/docs/ai-context/system-integration.md +21 -0
- package/docs/open-issues/example-api-performance-issue.md +79 -0
- package/eslint.config.mjs +26 -26
- package/package.json +9 -2
- package/tailwind.config.js +0 -4
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# Task Management & Handoff Template
|
|
2
|
+
|
|
3
|
+
This file manages task continuity, session transitions, and knowledge transfer for AI-assisted development sessions.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This template helps maintain:
|
|
8
|
+
- **Session continuity** between AI development sessions
|
|
9
|
+
- **Task status tracking** for complex, multi-session work
|
|
10
|
+
- **Context preservation** when switching between team members
|
|
11
|
+
- **Knowledge transfer** for project handoffs
|
|
12
|
+
- **Progress documentation** for ongoing development efforts
|
|
13
|
+
|
|
14
|
+
## Current Session Status
|
|
15
|
+
|
|
16
|
+
### Active Tasks
|
|
17
|
+
Document currently in-progress work:
|
|
18
|
+
|
|
19
|
+
```markdown
|
|
20
|
+
## In Progress
|
|
21
|
+
- [ ] Task 1: [Brief description]
|
|
22
|
+
- Status: [Started/Blocked/Awaiting review]
|
|
23
|
+
- Context: [Relevant files, decisions made]
|
|
24
|
+
- Next steps: [What needs to be done next]
|
|
25
|
+
- Dependencies: [What this task depends on]
|
|
26
|
+
|
|
27
|
+
- [ ] Task 2: [Brief description]
|
|
28
|
+
- Status: [Current status]
|
|
29
|
+
- Files modified: [List of files changed]
|
|
30
|
+
- Challenges: [Any issues encountered]
|
|
31
|
+
- Notes: [Important context for continuation]
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Pending Tasks
|
|
35
|
+
Document queued work:
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
## Pending
|
|
39
|
+
- [ ] Task A: [Description]
|
|
40
|
+
- Priority: [High/Medium/Low]
|
|
41
|
+
- Dependencies: [What must be completed first]
|
|
42
|
+
- Estimated effort: [Time estimate]
|
|
43
|
+
- Context: [Background information]
|
|
44
|
+
|
|
45
|
+
- [ ] Task B: [Description]
|
|
46
|
+
- Priority: [Priority level]
|
|
47
|
+
- Requirements: [Specific requirements or constraints]
|
|
48
|
+
- Resources needed: [Tools, access, information needed]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Completed Tasks
|
|
52
|
+
Track completed work for context:
|
|
53
|
+
|
|
54
|
+
```markdown
|
|
55
|
+
## Completed This Session
|
|
56
|
+
- [x] Task X: [Description]
|
|
57
|
+
- Completed: [Date]
|
|
58
|
+
- Outcome: [What was accomplished]
|
|
59
|
+
- Files changed: [Modified files]
|
|
60
|
+
- Notes: [Important decisions or lessons learned]
|
|
61
|
+
|
|
62
|
+
- [x] Task Y: [Description]
|
|
63
|
+
- Completed: [Date]
|
|
64
|
+
- Impact: [How this affects other tasks]
|
|
65
|
+
- Follow-up needed: [Any follow-up actions required]
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Architecture & Design Decisions
|
|
69
|
+
|
|
70
|
+
### Recent Decisions
|
|
71
|
+
Document architectural decisions made during development:
|
|
72
|
+
|
|
73
|
+
```markdown
|
|
74
|
+
## Design Decisions Made
|
|
75
|
+
- **Decision**: [What was decided]
|
|
76
|
+
- Date: [When decision was made]
|
|
77
|
+
- Rationale: [Why this approach was chosen]
|
|
78
|
+
- Alternatives considered: [Other options evaluated]
|
|
79
|
+
- Impact: [How this affects the system]
|
|
80
|
+
- Validation: [How to verify this was the right choice]
|
|
81
|
+
|
|
82
|
+
- **Decision**: [Another decision]
|
|
83
|
+
- Context: [Situation that led to this decision]
|
|
84
|
+
- Trade-offs: [What was gained/lost with this choice]
|
|
85
|
+
- Dependencies: [What this decision depends on]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Technical Debt & Issues
|
|
89
|
+
Track technical debt and known issues:
|
|
90
|
+
|
|
91
|
+
```markdown
|
|
92
|
+
## Technical Debt Identified
|
|
93
|
+
- **Issue**: [Description of technical debt]
|
|
94
|
+
- Location: [Where in codebase]
|
|
95
|
+
- Impact: [How it affects development/performance]
|
|
96
|
+
- Proposed solution: [How to address it]
|
|
97
|
+
- Priority: [When should this be addressed]
|
|
98
|
+
|
|
99
|
+
- **Issue**: [Another issue]
|
|
100
|
+
- Root cause: [Why this debt exists]
|
|
101
|
+
- Workaround: [Current mitigation strategy]
|
|
102
|
+
- Long-term fix: [Proper solution approach]
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Next Session Goals
|
|
106
|
+
|
|
107
|
+
### Immediate Priorities
|
|
108
|
+
Define what should be tackled next:
|
|
109
|
+
|
|
110
|
+
```markdown
|
|
111
|
+
## Next Session Priorities
|
|
112
|
+
1. **Primary Goal**: [Main objective for next session]
|
|
113
|
+
- Success criteria: [How to know this is complete]
|
|
114
|
+
- Prerequisites: [What must be ready beforehand]
|
|
115
|
+
- Estimated effort: [Time estimate]
|
|
116
|
+
|
|
117
|
+
2. **Secondary Goal**: [Secondary objective]
|
|
118
|
+
- Dependencies: [What this depends on]
|
|
119
|
+
- Resources needed: [Tools, information, access required]
|
|
120
|
+
|
|
121
|
+
3. **If Time Permits**: [Optional tasks]
|
|
122
|
+
- Context: [Background on why these are valuable]
|
|
123
|
+
- Preparation: [What needs to be done to start these]
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Knowledge Gaps
|
|
127
|
+
Document areas needing research or clarification:
|
|
128
|
+
|
|
129
|
+
```markdown
|
|
130
|
+
## Knowledge Gaps to Address
|
|
131
|
+
- **Question**: [What needs to be clarified]
|
|
132
|
+
- Impact: [How this affects current work]
|
|
133
|
+
- Research needed: [What investigation is required]
|
|
134
|
+
- Decision maker: [Who can answer this]
|
|
135
|
+
|
|
136
|
+
- **Unknown**: [Technical uncertainty]
|
|
137
|
+
- Options: [Possible approaches to explore]
|
|
138
|
+
- Experiments: [What should be tested]
|
|
139
|
+
- Timeline: [When this needs to be resolved]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Context for Continuation
|
|
143
|
+
|
|
144
|
+
### Key Files & Components
|
|
145
|
+
Document important files for session continuity:
|
|
146
|
+
|
|
147
|
+
```markdown
|
|
148
|
+
## Files Currently Being Modified
|
|
149
|
+
- `[file-path]`: [Purpose and current changes]
|
|
150
|
+
- `[file-path]`: [What's being implemented here]
|
|
151
|
+
- `[file-path]`: [Status and next steps]
|
|
152
|
+
|
|
153
|
+
## Important Context Files
|
|
154
|
+
- `[context-file]`: [Why this is relevant]
|
|
155
|
+
- `[documentation]`: [What information this contains]
|
|
156
|
+
- `[reference]`: [How this relates to current work]
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Development Environment
|
|
160
|
+
Document environment and setup considerations:
|
|
161
|
+
|
|
162
|
+
```markdown
|
|
163
|
+
## Environment Status
|
|
164
|
+
- **Development setup**: [Current state of dev environment]
|
|
165
|
+
- **Database**: [Schema changes, migrations, data state]
|
|
166
|
+
- **External services**: [API keys, service configurations]
|
|
167
|
+
- **Testing**: [Test suite status, coverage, failing tests]
|
|
168
|
+
- **Build/Deploy**: [Build status, deployment considerations]
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
*This template provides a comprehensive framework for managing task continuity and knowledge transfer. Customize it based on your team's workflow, project complexity, and communication needs.*
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# Project Structure Template
|
|
2
|
+
|
|
3
|
+
This document provides a template for documenting the complete technology stack and file tree structure for your project. **AI agents MUST read this file to understand the project organization before making any changes.**
|
|
4
|
+
|
|
5
|
+
## Technology Stack Template
|
|
6
|
+
|
|
7
|
+
### Backend Technologies
|
|
8
|
+
Document your backend technology choices:
|
|
9
|
+
- **[Language] [Version]** with **[Package Manager]** - Dependency management and packaging
|
|
10
|
+
- **[Web Framework] [Version]** - Web framework with specific features (async, type hints, etc.)
|
|
11
|
+
- **[Server] [Version]** - Application server configuration
|
|
12
|
+
- **[Configuration] [Version]** - Configuration management approach
|
|
13
|
+
|
|
14
|
+
Example:
|
|
15
|
+
```
|
|
16
|
+
- Python 3.11+ with Poetry - Dependency management and packaging
|
|
17
|
+
- FastAPI 0.115.0+ - Web framework with type hints and async support
|
|
18
|
+
- Uvicorn 0.32.0+ - ASGI server with standard extras
|
|
19
|
+
- Pydantic Settings 2.5.2+ - Configuration management with type validation
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Integration Services & APIs
|
|
23
|
+
Document external services and integrations:
|
|
24
|
+
- **[Service Name] [API/SDK Version]** - Purpose and usage pattern
|
|
25
|
+
- **[AI Service] [Version]** - AI/ML service integration details
|
|
26
|
+
- **[Database] [Version]** - Data storage and management
|
|
27
|
+
- **[Monitoring] [Version]** - Observability and logging
|
|
28
|
+
|
|
29
|
+
### Real-time Communication
|
|
30
|
+
Document real-time features:
|
|
31
|
+
- **[WebSocket Library]** - Real-time communication patterns
|
|
32
|
+
- **[HTTP Client]** - Async HTTP communication
|
|
33
|
+
- **[Message Queue]** - Event processing (if applicable)
|
|
34
|
+
|
|
35
|
+
### Development & Quality Tools
|
|
36
|
+
Document development toolchain:
|
|
37
|
+
- **[Formatter] [Version]** - Code formatting
|
|
38
|
+
- **[Linter] [Version]** - Code quality and linting
|
|
39
|
+
- **[Type Checker] [Version]** - Static type checking
|
|
40
|
+
- **[Testing Framework] [Version]** - Testing approach
|
|
41
|
+
- **[Task Runner]** - Build automation and task orchestration
|
|
42
|
+
|
|
43
|
+
### Frontend Technologies (if applicable)
|
|
44
|
+
Document frontend technology stack:
|
|
45
|
+
- **[Language] [Version]** - Frontend development language
|
|
46
|
+
- **[Framework] [Version]** - UI framework
|
|
47
|
+
- **[Build Tool] [Version]** - Development and build tooling
|
|
48
|
+
- **[Deployment] [Version]** - Deployment and hosting approach
|
|
49
|
+
|
|
50
|
+
### Future Technologies
|
|
51
|
+
Document planned technology additions:
|
|
52
|
+
- **[Planned Technology]** - Future integration plans
|
|
53
|
+
- **[Platform]** - Target platform expansion
|
|
54
|
+
- **[Service]** - Planned service integrations
|
|
55
|
+
|
|
56
|
+
## Complete Project Structure Template
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
[PROJECT-NAME]/
|
|
60
|
+
├── README.md # Project overview and setup
|
|
61
|
+
├── CLAUDE.md # Master AI context file
|
|
62
|
+
├── [BUILD-FILE] # Build configuration (Makefile, package.json, etc.)
|
|
63
|
+
├── .gitignore # Git ignore patterns
|
|
64
|
+
├── .[IDE-CONFIG]/ # IDE workspace configuration
|
|
65
|
+
│ ├── settings.[ext] # IDE settings
|
|
66
|
+
│ ├── extensions.[ext] # Recommended extensions
|
|
67
|
+
│ └── launch.[ext] # Debug configurations
|
|
68
|
+
├── [BACKEND-DIR]/ # Backend application
|
|
69
|
+
│ ├── CONTEXT.md # Backend-specific AI context
|
|
70
|
+
│ ├── src/ # Source code
|
|
71
|
+
│ │ ├── config/ # Configuration management
|
|
72
|
+
│ │ │ └── settings.[ext] # Application settings
|
|
73
|
+
│ │ ├── core/ # Core business logic
|
|
74
|
+
│ │ │ ├── CONTEXT.md # Core logic patterns
|
|
75
|
+
│ │ │ ├── services/ # Business services
|
|
76
|
+
│ │ │ │ ├── [service1].[ext] # Service implementations
|
|
77
|
+
│ │ │ │ └── [service2].[ext]
|
|
78
|
+
│ │ │ ├── models/ # Data models
|
|
79
|
+
│ │ │ │ ├── [model1].[ext] # Model definitions
|
|
80
|
+
│ │ │ │ └── [model2].[ext]
|
|
81
|
+
│ │ │ └── utils/ # Utility functions
|
|
82
|
+
│ │ │ ├── logging.[ext] # Structured logging
|
|
83
|
+
│ │ │ ├── validation.[ext] # Input validation
|
|
84
|
+
│ │ │ └── helpers.[ext] # Helper functions
|
|
85
|
+
│ │ ├── api/ # API layer
|
|
86
|
+
│ │ │ ├── CONTEXT.md # API patterns and conventions
|
|
87
|
+
│ │ │ ├── routes/ # API route definitions
|
|
88
|
+
│ │ │ │ ├── [resource1].[ext] # Resource-specific routes
|
|
89
|
+
│ │ │ │ └── [resource2].[ext]
|
|
90
|
+
│ │ │ ├── middleware/ # API middleware
|
|
91
|
+
│ │ │ │ ├── auth.[ext] # Authentication middleware
|
|
92
|
+
│ │ │ │ ├── logging.[ext] # Request logging
|
|
93
|
+
│ │ │ │ └── validation.[ext] # Request validation
|
|
94
|
+
│ │ │ └── schemas/ # Request/response schemas
|
|
95
|
+
│ │ │ ├── [schema1].[ext] # Data schemas
|
|
96
|
+
│ │ │ └── [schema2].[ext]
|
|
97
|
+
│ │ └── integrations/ # External service integrations
|
|
98
|
+
│ │ ├── CONTEXT.md # Integration patterns
|
|
99
|
+
│ │ ├── [service1]/ # Service-specific integration
|
|
100
|
+
│ │ │ ├── client.[ext] # API client
|
|
101
|
+
│ │ │ ├── models.[ext] # Integration models
|
|
102
|
+
│ │ │ └── handlers.[ext] # Response handlers
|
|
103
|
+
│ │ └── [service2]/
|
|
104
|
+
│ ├── tests/ # Test suite
|
|
105
|
+
│ │ ├── unit/ # Unit tests
|
|
106
|
+
│ │ ├── integration/ # Integration tests
|
|
107
|
+
│ │ └── fixtures/ # Test fixtures and data
|
|
108
|
+
│ ├── [PACKAGE-FILE] # Package configuration
|
|
109
|
+
│ └── [ENV-FILE] # Environment configuration
|
|
110
|
+
├── [FRONTEND-DIR]/ # Frontend application (if applicable)
|
|
111
|
+
│ ├── CONTEXT.md # Frontend-specific AI context
|
|
112
|
+
│ ├── src/ # Source code
|
|
113
|
+
│ │ ├── components/ # UI components
|
|
114
|
+
│ │ │ ├── CONTEXT.md # Component patterns
|
|
115
|
+
│ │ │ ├── common/ # Shared components
|
|
116
|
+
│ │ │ └── [feature]/ # Feature-specific components
|
|
117
|
+
│ │ ├── pages/ # Page components/routes
|
|
118
|
+
│ │ │ ├── [page1].[ext] # Page implementations
|
|
119
|
+
│ │ │ └── [page2].[ext]
|
|
120
|
+
│ │ ├── stores/ # State management
|
|
121
|
+
│ │ │ ├── CONTEXT.md # State management patterns
|
|
122
|
+
│ │ │ ├── [store1].[ext] # Store implementations
|
|
123
|
+
│ │ │ └── [store2].[ext]
|
|
124
|
+
│ │ ├── api/ # API client layer
|
|
125
|
+
│ │ │ ├── CONTEXT.md # Client patterns
|
|
126
|
+
│ │ │ ├── client.[ext] # HTTP client setup
|
|
127
|
+
│ │ │ └── endpoints/ # API endpoint definitions
|
|
128
|
+
│ │ ├── utils/ # Utility functions
|
|
129
|
+
│ │ │ ├── logging.[ext] # Client-side logging
|
|
130
|
+
│ │ │ ├── validation.[ext] # Form validation
|
|
131
|
+
│ │ │ └── helpers.[ext] # Helper functions
|
|
132
|
+
│ │ └── assets/ # Static assets
|
|
133
|
+
│ ├── tests/ # Frontend tests
|
|
134
|
+
│ ├── [BUILD-CONFIG] # Build configuration
|
|
135
|
+
│ └── [PACKAGE-FILE] # Package configuration
|
|
136
|
+
├── docs/ # Documentation
|
|
137
|
+
│ ├── ai-context/ # AI-specific documentation
|
|
138
|
+
│ │ ├── project-structure.md # This file
|
|
139
|
+
│ │ ├── docs-overview.md # Documentation architecture
|
|
140
|
+
│ │ ├── system-integration.md # Integration patterns
|
|
141
|
+
│ │ ├── deployment-infrastructure.md # Infrastructure docs
|
|
142
|
+
│ │ └── handoff.md # Task management
|
|
143
|
+
│ ├── api/ # API documentation
|
|
144
|
+
│ ├── deployment/ # Deployment guides
|
|
145
|
+
│ └── development/ # Development guides
|
|
146
|
+
├── scripts/ # Automation scripts
|
|
147
|
+
│ ├── setup.[ext] # Environment setup
|
|
148
|
+
│ ├── deploy.[ext] # Deployment scripts
|
|
149
|
+
│ └── maintenance/ # Maintenance scripts
|
|
150
|
+
├── [INFRASTRUCTURE-DIR]/ # Infrastructure as code (if applicable)
|
|
151
|
+
│ ├── [PROVIDER]/ # Cloud provider configurations
|
|
152
|
+
│ ├── docker/ # Container configurations
|
|
153
|
+
│ └── monitoring/ # Monitoring and alerting
|
|
154
|
+
└── [CONFIG-FILES] # Root-level configuration files
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
*This template provides a comprehensive foundation for documenting project structure. Adapt it based on your specific technology stack, architecture decisions, and organizational requirements.*
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# System Integration Documentation
|
|
2
|
+
|
|
3
|
+
This document contains cross-component integration patterns and system-wide architectural decisions.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This template serves as a placeholder for documenting:
|
|
8
|
+
- Cross-component communication patterns
|
|
9
|
+
- Data flow architectures between services
|
|
10
|
+
- Integration strategies with external systems
|
|
11
|
+
- Performance optimization patterns
|
|
12
|
+
- Testing strategies for integrated systems
|
|
13
|
+
- Error handling across service boundaries
|
|
14
|
+
|
|
15
|
+
## Implementation Note
|
|
16
|
+
|
|
17
|
+
Replace this template with your actual system integration documentation as your project develops. Focus on patterns that AI agents need to understand when working across component boundaries or implementing features that span multiple services.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
*Customize this template based on your specific integration patterns and architectural requirements.*
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# API Performance Issue - Example Template
|
|
2
|
+
|
|
3
|
+
## Issue Description
|
|
4
|
+
|
|
5
|
+
Describe the specific performance issue or bug that needs to be addressed. Include symptoms, affected features, and user impact.
|
|
6
|
+
|
|
7
|
+
Example: "API endpoint `/api/data/process` has intermittent high latency (>5 seconds) under normal load conditions, causing user timeout errors."
|
|
8
|
+
|
|
9
|
+
## Root Cause
|
|
10
|
+
|
|
11
|
+
Detailed analysis of what's causing the issue. Include:
|
|
12
|
+
- Technical root cause
|
|
13
|
+
- Contributing factors
|
|
14
|
+
- System conditions that trigger the issue
|
|
15
|
+
|
|
16
|
+
Example: "Database query optimization needed for complex joins. Current query scans entire table without proper indexing."
|
|
17
|
+
|
|
18
|
+
## Impact Assessment
|
|
19
|
+
|
|
20
|
+
- **Severity**: Critical/High/Medium/Low
|
|
21
|
+
- **Affected Users**: Percentage or number of users impacted
|
|
22
|
+
- **Business Impact**: Revenue, user experience, or operational impact
|
|
23
|
+
- **Workarounds**: Any temporary solutions currently in place
|
|
24
|
+
|
|
25
|
+
## Proposed Solution
|
|
26
|
+
|
|
27
|
+
### Technical Approach
|
|
28
|
+
Detailed technical solution including:
|
|
29
|
+
- Code changes required
|
|
30
|
+
- Architecture modifications
|
|
31
|
+
- Database schema updates
|
|
32
|
+
- Performance improvements expected
|
|
33
|
+
|
|
34
|
+
### Implementation Plan
|
|
35
|
+
1. **Phase 1**: Initial fixes (timeline)
|
|
36
|
+
2. **Phase 2**: Optimization improvements (timeline)
|
|
37
|
+
3. **Phase 3**: Monitoring and validation (timeline)
|
|
38
|
+
|
|
39
|
+
## Testing Strategy
|
|
40
|
+
|
|
41
|
+
- **Unit Tests**: Specific test cases to validate the fix
|
|
42
|
+
- **Integration Tests**: End-to-end testing scenarios
|
|
43
|
+
- **Performance Tests**: Load testing and benchmarking
|
|
44
|
+
- **Regression Tests**: Ensure no existing functionality breaks
|
|
45
|
+
|
|
46
|
+
## Related Files
|
|
47
|
+
|
|
48
|
+
List all files that need to be modified:
|
|
49
|
+
- `src/api/routes/data.py` - Main endpoint logic
|
|
50
|
+
- `src/database/models.py` - Database model updates
|
|
51
|
+
- `src/utils/query_optimizer.py` - Query optimization utilities
|
|
52
|
+
- `tests/test_api_performance.py` - Performance test suite
|
|
53
|
+
|
|
54
|
+
## References
|
|
55
|
+
|
|
56
|
+
- [External documentation or APIs]
|
|
57
|
+
- [Related GitHub issues or PRs]
|
|
58
|
+
- [Performance benchmarking results]
|
|
59
|
+
- [Stack Overflow discussions or solutions]
|
|
60
|
+
|
|
61
|
+
## Status
|
|
62
|
+
|
|
63
|
+
- [ ] **Open** - Issue identified and documented
|
|
64
|
+
- [ ] **In Progress** - Solution being implemented
|
|
65
|
+
- [ ] **Testing** - Fix implemented, undergoing testing
|
|
66
|
+
- [ ] **Fixed** - Issue resolved and deployed
|
|
67
|
+
- [ ] **Closed** - Issue confirmed resolved in production
|
|
68
|
+
|
|
69
|
+
## Implementation Notes
|
|
70
|
+
|
|
71
|
+
Track progress and implementation details:
|
|
72
|
+
- Date started: [DATE]
|
|
73
|
+
- Key decisions made: [DECISIONS]
|
|
74
|
+
- Challenges encountered: [CHALLENGES]
|
|
75
|
+
- Performance improvements achieved: [METRICS]
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
*This template provides a structured approach to documenting and tracking technical issues. Customize sections based on your project's specific needs and workflow.*
|
package/eslint.config.mjs
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
// For more info, see https://github.com/storybookjs/eslint-plugin-storybook#configuration-flat-config-format
|
|
2
|
+
import storybook from "eslint-plugin-storybook";
|
|
3
|
+
|
|
1
4
|
import js from "@eslint/js";
|
|
2
5
|
import globals from "globals";
|
|
3
6
|
import reactHooks from "eslint-plugin-react-hooks";
|
|
@@ -5,31 +8,28 @@ import reactRefresh from "eslint-plugin-react-refresh";
|
|
|
5
8
|
import tseslint from "typescript-eslint";
|
|
6
9
|
import eslintConfigPrettier from "eslint-config-prettier/flat";
|
|
7
10
|
|
|
8
|
-
export default tseslint.config(
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
export default tseslint.config({ ignores: ["dist"] }, {
|
|
12
|
+
extends: [
|
|
13
|
+
js.configs.recommended,
|
|
14
|
+
...tseslint.configs.recommended,
|
|
15
|
+
eslintConfigPrettier,
|
|
16
|
+
],
|
|
17
|
+
files: ["**/*.{ts,tsx}"],
|
|
18
|
+
languageOptions: {
|
|
19
|
+
ecmaVersion: 2020,
|
|
20
|
+
globals: globals.browser,
|
|
21
|
+
},
|
|
22
|
+
plugins: {
|
|
23
|
+
"react-hooks": reactHooks,
|
|
24
|
+
"react-refresh": reactRefresh,
|
|
25
|
+
},
|
|
26
|
+
rules: {
|
|
27
|
+
...reactHooks.configs.recommended.rules,
|
|
28
|
+
"react-refresh/only-export-components": [
|
|
29
|
+
"warn",
|
|
30
|
+
{ allowConstantExport: true },
|
|
15
31
|
],
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
ecmaVersion: 2020,
|
|
19
|
-
globals: globals.browser,
|
|
20
|
-
},
|
|
21
|
-
plugins: {
|
|
22
|
-
"react-hooks": reactHooks,
|
|
23
|
-
"react-refresh": reactRefresh,
|
|
24
|
-
},
|
|
25
|
-
rules: {
|
|
26
|
-
...reactHooks.configs.recommended.rules,
|
|
27
|
-
"react-refresh/only-export-components": [
|
|
28
|
-
"warn",
|
|
29
|
-
{ allowConstantExport: true },
|
|
30
|
-
],
|
|
31
|
-
"@typescript-eslint/no-unsafe-function-type": "off",
|
|
32
|
-
"@typescript-eslint/no-explicit-any": "off",
|
|
33
|
-
},
|
|
32
|
+
"@typescript-eslint/no-unsafe-function-type": "off",
|
|
33
|
+
"@typescript-eslint/no-explicit-any": "off",
|
|
34
34
|
},
|
|
35
|
-
);
|
|
35
|
+
}, storybook.configs["flat/recommended"]);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zenuml/core",
|
|
3
|
-
"version": "3.32.
|
|
3
|
+
"version": "3.32.7",
|
|
4
4
|
"private": false,
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -34,7 +34,9 @@
|
|
|
34
34
|
"git:branch:clean:merged": "git branch --merged|egrep -v \"(\\*|master|main|dev|skip_branch_name)\" | xargs git branch -d",
|
|
35
35
|
"git:branch:safe-delete": "echo '> git log --graph --left-right --cherry --oneline another-branch...main'",
|
|
36
36
|
"git:forget": "git rm -r --cached . && git add . && git commit -m \"Forget all ignored files\"",
|
|
37
|
-
"test:specs": "echo \"Error: test:specs is not supported\""
|
|
37
|
+
"test:specs": "echo \"Error: test:specs is not supported\"",
|
|
38
|
+
"storybook": "storybook dev -p 6006",
|
|
39
|
+
"build-storybook": "storybook build"
|
|
38
40
|
},
|
|
39
41
|
"main": "./dist/zenuml.js",
|
|
40
42
|
"module": "./dist/zenuml.esm.mjs",
|
|
@@ -79,6 +81,9 @@
|
|
|
79
81
|
"devDependencies": {
|
|
80
82
|
"@eslint/js": "^9.21.0",
|
|
81
83
|
"@playwright/test": "^1.54.1",
|
|
84
|
+
"@storybook/addon-docs": "^9.0.16",
|
|
85
|
+
"@storybook/addon-onboarding": "^9.0.16",
|
|
86
|
+
"@storybook/react-vite": "^9.0.16",
|
|
82
87
|
"@testing-library/jest-dom": "^6.6.3",
|
|
83
88
|
"@testing-library/react": "^16.3.0",
|
|
84
89
|
"@types/antlr4": "~4.11.2",
|
|
@@ -96,12 +101,14 @@
|
|
|
96
101
|
"eslint-config-prettier": "^10.1.1",
|
|
97
102
|
"eslint-plugin-react-hooks": "^5.1.0",
|
|
98
103
|
"eslint-plugin-react-refresh": "^0.4.19",
|
|
104
|
+
"eslint-plugin-storybook": "^9.0.16",
|
|
99
105
|
"globals": "^15.15.0",
|
|
100
106
|
"jsdom": "^26.1.0",
|
|
101
107
|
"less": "^4.3.0",
|
|
102
108
|
"postcss": "^8.5.3",
|
|
103
109
|
"prettier": "3.5.3",
|
|
104
110
|
"sass": "^1.86.3",
|
|
111
|
+
"storybook": "^9.0.16",
|
|
105
112
|
"typescript": "~5.7.2",
|
|
106
113
|
"typescript-eslint": "^8.24.1",
|
|
107
114
|
"vite": "^6.2.0",
|
package/tailwind.config.js
CHANGED
|
@@ -38,8 +38,6 @@ module.exports = {
|
|
|
38
38
|
message: "var(--color-text-message, var(--color-text-base, #000))",
|
|
39
39
|
"message-arrow":
|
|
40
40
|
"var(--color-message-arrow, var(--color-border-frame, var(--color-border-base, #000)))", // message arrow head
|
|
41
|
-
"message-hover":
|
|
42
|
-
"var(--color-text-message-hover, var(--color-bg-base, var(--color-backup-white, #ffffff)))",
|
|
43
41
|
comment:
|
|
44
42
|
"var(--color-text-comment, var(--color-text-secondary, var(--color-text-base, #000)))",
|
|
45
43
|
"fragment-header":
|
|
@@ -71,8 +69,6 @@ module.exports = {
|
|
|
71
69
|
"var(--color-border-participant, var(--color-border-participant, var(--color-border-frame, var(--color-border-base, #000))))",
|
|
72
70
|
divider:
|
|
73
71
|
"var(--color-border-participant, var(--color-border-frame, var(--color-border-base, #000)))",
|
|
74
|
-
"message-hover":
|
|
75
|
-
"var(--color-bg-message-hover, var(--color-text-base, #000))",
|
|
76
72
|
"fragment-header":
|
|
77
73
|
"var(--color-bg-fragment-header, var(--color-bg-frame, var(--color-bg-canvas, var(--color-bg-base, var(--color-backup-white, #ffffff)))))",
|
|
78
74
|
occurrence:
|