fraim-framework 2.0.55 → 2.0.56

package/dist/registry/templates/marketing/WEBSITE-TEMPLATE.md

@@ -0,0 +1,262 @@
+# Website Creation Brief: {PROJECT_NAME}
+
+**Project:** {PROJECT_NAME}  
+**Date:** {DATE}  
+**Stakeholders:** {STAKEHOLDERS}  
+**Timeline:** {TIMELINE}  
+
+---
+
+## Project Overview
+
+### Product/Service Description
+{PRODUCT_DESCRIPTION}
+
+### Target Audience
+{TARGET_AUDIENCE}
+
+### Primary Goals
+- [ ] Lead generation
+- [ ] Product showcase
+- [ ] Brand awareness
+- [ ] User education
+- [ ] Customer support
+- [ ] Other: {OTHER_GOALS}
+
+---
+
+## User Preferences & Inspiration
+
+### Favorite Websites
+1. **{WEBSITE_1}** - {URL_1}
+   - What you like: {WHAT_YOU_LIKE_1}
+   - Specific elements: {SPECIFIC_ELEMENTS_1}
+
+2. **{WEBSITE_2}** - {URL_2}
+   - What you like: {WHAT_YOU_LIKE_2}
+   - Specific elements: {SPECIFIC_ELEMENTS_2}
+
+3. **{WEBSITE_3}** - {URL_3}
+   - What you like: {WHAT_YOU_LIKE_3}
+   - Specific elements: {SPECIFIC_ELEMENTS_3}
+
+### Design Preferences
+- **Tone/Personality:** {TONE} (Professional, Playful, Technical, Friendly, etc.)
+- **Color Preferences:** {COLOR_PREFERENCES}
+- **Typography Style:** {TYPOGRAPHY_STYLE} (Modern, Classic, Technical, etc.)
+- **Layout Style:** {LAYOUT_STYLE} (Minimal, Rich, Grid-based, etc.)
+
+### Required Features
+- [ ] Dark/Light mode toggle
+- [ ] Mobile responsive design
+- [ ] Contact forms
+- [ ] Newsletter signup
+- [ ] Interactive demos
+- [ ] Customer testimonials
+- [ ] Pricing tables
+- [ ] Blog/News section
+- [ ] Search functionality
+- [ ] Multi-language support
+- [ ] Other: {OTHER_FEATURES}
+
+---
+
+## Content Strategy
+
+### Key Value Propositions
+1. {VALUE_PROP_1}
+2. {VALUE_PROP_2}
+3. {VALUE_PROP_3}
+
+### Primary Use Cases
+1. **{USE_CASE_1}**
+   - Description: {USE_CASE_1_DESC}
+   - Target user: {USE_CASE_1_USER}
+   - Benefit: {USE_CASE_1_BENEFIT}
+
+2. **{USE_CASE_2}**
+   - Description: {USE_CASE_2_DESC}
+   - Target user: {USE_CASE_2_USER}
+   - Benefit: {USE_CASE_2_BENEFIT}
+
+3. **{USE_CASE_3}**
+   - Description: {USE_CASE_3_DESC}
+   - Target user: {USE_CASE_3_USER}
+   - Benefit: {USE_CASE_3_BENEFIT}
+
+### Content Inventory
+- [ ] Product descriptions
+- [ ] Feature explanations
+- [ ] Customer testimonials
+- [ ] Case studies
+- [ ] Team bios
+- [ ] Company story
+- [ ] Technical documentation
+- [ ] Pricing information
+- [ ] Contact information
+- [ ] Legal pages (Privacy, Terms)
+
+---
+
+## Competitive Analysis
+
+### Direct Competitors
+1. **{COMPETITOR_1}** - {COMPETITOR_1_URL}
+   - Strengths: {COMPETITOR_1_STRENGTHS}
+   - Weaknesses: {COMPETITOR_1_WEAKNESSES}
+   - Key takeaways: {COMPETITOR_1_TAKEAWAYS}
+
+2. **{COMPETITOR_2}** - {COMPETITOR_2_URL}
+   - Strengths: {COMPETITOR_2_STRENGTHS}
+   - Weaknesses: {COMPETITOR_2_WEAKNESSES}
+   - Key takeaways: {COMPETITOR_2_TAKEAWAYS}
+
+3. **{COMPETITOR_3}** - {COMPETITOR_3_URL}
+   - Strengths: {COMPETITOR_3_STRENGTHS}
+   - Weaknesses: {COMPETITOR_3_WEAKNESSES}
+   - Key takeaways: {COMPETITOR_3_TAKEAWAYS}
+
+### Differentiation Opportunities
+- {DIFFERENTIATION_1}
+- {DIFFERENTIATION_2}
+- {DIFFERENTIATION_3}
+
+---
+
+## Technical Requirements
+
+### Performance Targets
+- Page load speed: < 3 seconds
+- Mobile performance score: > 90%
+- Accessibility score: > 90%
+- SEO score: > 85%
+
+### Browser Support
+- [ ] Chrome (latest 2 versions)
+- [ ] Firefox (latest 2 versions)
+- [ ] Safari (latest 2 versions)
+- [ ] Edge (latest 2 versions)
+- [ ] Mobile browsers (iOS Safari, Chrome Mobile)
+
+### Integrations Needed
+- [ ] Google Analytics
+- [ ] Email marketing platform: {EMAIL_PLATFORM}
+- [ ] CRM system: {CRM_SYSTEM}
+- [ ] Payment processing: {PAYMENT_SYSTEM}
+- [ ] Customer support: {SUPPORT_SYSTEM}
+- [ ] Social media platforms
+- [ ] Other: {OTHER_INTEGRATIONS}
+
+---
+
+## Hosting & Deployment
+
+### Hosting Preferences
+- [ ] Free hosting (GitHub Pages, Netlify free tier)
+- [ ] Premium hosting (Netlify Pro, Vercel Pro)
+- [ ] Enterprise hosting (AWS, Google Cloud)
+- [ ] Existing hosting provider: {EXISTING_PROVIDER}
+
+### Domain Information
+- **Domain name:** {DOMAIN_NAME}
+- **Domain registrar:** {DOMAIN_REGISTRAR}
+- **DNS provider:** {DNS_PROVIDER}
+
+### Deployment Requirements
+- [ ] Automatic deployment on code changes
+- [ ] Staging environment for testing
+- [ ] Custom domain setup
+- [ ] SSL certificate configuration
+- [ ] CDN setup for performance
+
+---
+
+## Success Metrics
+
+### Primary KPIs
+- {KPI_1}: Target {KPI_1_TARGET}
+- {KPI_2}: Target {KPI_2_TARGET}
+- {KPI_3}: Target {KPI_3_TARGET}
+
+### Secondary Metrics
+- Time on site: Target {TIME_ON_SITE_TARGET}
+- Bounce rate: Target {BOUNCE_RATE_TARGET}
+- Page views per session: Target {PAGE_VIEWS_TARGET}
+- Conversion rate: Target {CONVERSION_RATE_TARGET}
+
+---
+
+## Timeline & Milestones
+
+### Phase 1: Discovery & Research ({PHASE_1_TIMELINE})
+- [ ] User preference brainstorming session
+- [ ] Competitive analysis completion
+- [ ] Content strategy development
+- [ ] Design system creation
+
+### Phase 2: Design & Development ({PHASE_2_TIMELINE})
+- [ ] Wireframes and mockups
+- [ ] Development environment setup
+- [ ] Core pages development
+- [ ] Content integration
+
+### Phase 3: Testing & Optimization ({PHASE_3_TIMELINE})
+- [ ] Performance testing
+- [ ] Cross-browser testing
+- [ ] Accessibility validation
+- [ ] User experience testing
+
+### Phase 4: Deployment & Launch ({PHASE_4_TIMELINE})
+- [ ] Hosting setup and configuration
+- [ ] Domain and SSL setup
+- [ ] Analytics and monitoring setup
+- [ ] Soft launch and testing
+- [ ] Public launch
+
+---
+
+## Budget & Resources
+
+### Budget Range
+- Design & Development: {DESIGN_DEV_BUDGET}
+- Hosting & Domain: {HOSTING_BUDGET}
+- Third-party tools: {TOOLS_BUDGET}
+- Ongoing maintenance: {MAINTENANCE_BUDGET}
+
+### Team & Responsibilities
+- **Project Manager:** {PROJECT_MANAGER}
+- **Designer:** {DESIGNER}
+- **Developer:** {DEVELOPER}
+- **Content Creator:** {CONTENT_CREATOR}
+- **Stakeholder/Approver:** {STAKEHOLDER}
+
+---
+
+## Additional Notes
+
+### Special Requirements
+{SPECIAL_REQUIREMENTS}
+
+### Constraints & Limitations
+{CONSTRAINTS}
+
+### Future Enhancements
+{FUTURE_ENHANCEMENTS}
+
+---
+
+## Approval & Sign-off
+
+**Stakeholder Approval:**
+- [ ] Project scope approved
+- [ ] Timeline approved
+- [ ] Budget approved
+- [ ] Technical requirements approved
+
+**Approved by:** {APPROVER_NAME}  
+**Date:** {APPROVAL_DATE}  
+**Signature:** {SIGNATURE}
+
+---
+
+*This document serves as the foundation for the website creation project. All stakeholders should review and approve before development begins.*

package/dist/registry/templates/marketing/github-pages-workflow.yml

@@ -0,0 +1,64 @@
+# GitHub Pages deployment workflow for {PROJECT_NAME}
+name: Deploy {PROJECT_NAME} to GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main", "master"]
+    paths: ["{WEBSITE_FOLDER}/**"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      
+      # Optional: Add build steps here if needed
+      # - name: Setup Node.js
+      #   uses: actions/setup-node@v4
+      #   with:
+      #     node-version: '18'
+      # 
+      # - name: Install dependencies
+      #   run: npm ci
+      # 
+      # - name: Build website
+      #   run: npm run build
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload the website directory
+          path: './{WEBSITE_FOLDER}'
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/dist/registry/templates/replicate/implementation-checklist.md

@@ -0,0 +1,39 @@
+# Implementation Checklist
+
+**Application**: [Application Name]  
+**Date**: [Date]
+
+## Feature Implementation Status
+
+### Authentication & Account Management
+
+- [ ] **UC-001: User Registration**
+  - [ ] Database model: User
+  - [ ] API endpoint: POST /api/users/signup
+  - [ ] Frontend: SignUpPage component
+  - [ ] Integration: Connect frontend to API
+  - [ ] Tests: Server, client, E2E
+  - [ ] Validation: Test in browser
+
+- [ ] **UC-002: User Login**
+  - [ ] API endpoint: POST /api/users/login
+  - [ ] Frontend: LoginPage component
+  - [ ] Auth context: Session management
+  - [ ] Integration: Connect frontend to API
+  - [ ] Tests: Server, client, E2E
+  - [ ] Validation: Test in browser
+
+[Continue with more features...]
+
+## Implementation Progress
+
+**Overall Progress**: [X]% Complete
+
+- **Not Started**: [Number] features
+- **In Progress**: [Number] features
+- **Complete**: [Number] features
+- **Blocked**: [Number] features
+
+## Notes
+
+- [Add implementation notes, decisions, blockers, etc.]

package/dist/registry/templates/replicate/use-cases-template.md

@@ -0,0 +1,88 @@
+# Use Cases Documentation
+
+**Application**: [Application Name]  
+**Date**: [Date]  
+**Version**: [Version]
+
+## Overview
+
+This document contains all identified use cases for the application, organized by category.
+
+## Use Case Categories
+
+- [Authentication & Account Management](#authentication--account-management)
+- [Content Discovery & Browsing](#content-discovery--browsing)
+- [Content Creation & Management](#content-creation--management)
+- [Data Collection & Reporting](#data-collection--reporting)
+- [Administration & Configuration](#administration--configuration)
+- [Communication & Collaboration](#communication--collaboration)
+
+---
+
+## Authentication & Account Management
+
+### UC-001: User Registration
+
+**Actor**: Guest User  
+**Preconditions**: User is not logged in  
+**Priority**: High
+
+**Steps**:
+1. Navigate to sign up page
+2. Fill in registration form (name, email, password)
+3. Submit form
+4. Receive confirmation message
+5. Verify email (if required)
+6. Redirect to login or dashboard
+
+**Postconditions**: 
+- User account is created
+- User can log in
+- User profile is initialized
+
+**Screenshots**: `screenshots/signup_*.png`
+
+**Related Use Cases**: UC-002
+
+---
+
+### UC-002: User Login
+
+**Actor**: Registered User  
+**Preconditions**: User has an account  
+**Priority**: High
+
+**Steps**:
+1. Navigate to login page
+2. Enter email and password
+3. Click "Login" button
+4. System validates credentials
+5. User is redirected to dashboard/home
+
+**Postconditions**:
+- User session is created
+- User is authenticated
+- User can access protected pages
+
+**Screenshots**: `screenshots/login_*.png`
+
+**Related Use Cases**: UC-001, UC-003
+
+---
+
+[Continue with more use cases...]
+
+## Use Case Index
+
+| ID | Name | Actor | Priority | Status |
+|----|------|-------|----------|--------|
+| UC-001 | User Registration | Guest | High | ✅ Complete |
+| UC-002 | User Login | User | High | ✅ Complete |
+| ... | ... | ... | ... | ... |
+
+## Implementation Status
+
+- **Total Use Cases**: [Number]
+- **Implemented**: [Number]
+- **In Progress**: [Number]
+- **Not Started**: [Number]

package/dist/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md

@@ -0,0 +1,55 @@
+# Postmortem: {Issue Title} - Issue #{issue-number}
+
+**Date**: {current_date}  
+**Duration**: {time_spent}  
+**Objective**: {issue_description}  
+**Outcome**: {success/failure/partial}
+
+## Executive Summary
+
+{2-3 sentence summary of what happened and the outcome}
+
+## Timeline of Events
+
+### Phase 1: {Phase Name}
+- ✅/❌ **Action**: Description
+- ✅/❌ **Action**: Description
+
+### Phase 2: {Phase Name}
+- ✅/❌ **Action**: Description
+- ✅/❌ **Action**: Description
+
+## Root Cause Analysis
+
+### 1. **Primary Cause**
+**Problem**: {main issue}
+**Impact**: {what this caused}
+
+### 2. **Contributing Factors**
+**Problem**: {secondary issues}
+**Impact**: {what these caused}
+
+## What Went Wrong
+
+1. **Issue 1**: Description
+2. **Issue 2**: Description
+
+## What Went Right
+
+1. **Success 1**: Description
+2. **Success 2**: Description
+
+## Lessons Learned
+
+1. **Learning 1**: Description
+2. **Learning 2**: Description
+
+## Agent Rule Updates Made to avoid recurrence
+
+1. **Rule 1**: Description
+2. **Rule 2**: Description
+
+## Enforcement Updates Made to avoid recurrence
+
+1. **Improvement 1**: Description
+2. **Improvement 2**: Description

package/dist/registry/templates/specs/BUGSPEC-TEMPLATE.md

@@ -0,0 +1,37 @@
+# Bug: <Title>
+
+Issue: #<issue>  
+Owner: <agent>
+
+## Customer 
+
+## Customer Problem being solved
+
+## Repro Steps
+- Specific steps in the user workflow that reproduce the bug (eg start in dashboard, click on tab x, see list y, approve item z ....)
+- Confirm that you have reproduced the bug
+
+## Root Cause
+- What root cause was identified after repro and code analysis
+
+## Fix Details
+- UI, API, Service, DB changes: Which files will be modified and for what?
+ 
+## Validation Plan
+- Table with following columns
+  - User Scenario
+  - Expected outcome
+  - Validation method (UI validation, API validation, Database validation ...)
+
+## Confidence Level
+- On a scale of 0 to 100, how confident are you that your fix will work?
+
+## Test Matrix
+- Unit(as many as needed, mocking ok): what core functionality will be tested. What test suite will be added? Which existing test suites will be modified?
+- Integration(only mock external services): what tests will ensure the full stack integration does not regress. What test suite will be added? Which existing test suites will be modified?
+- E2E(1 at most, no mocking): If any changes are made to external integrations, what end to end tests will ensure external integrations work as expected.
+
+## Future Prevention
+ - What will prevent future introduction of similar bugs
+ - What agent rules will you update to ensure similar bugs do not recur
+ - What enforcement will you create to ensure similar bugs are caught before they are checked in

package/dist/registry/templates/specs/FEATURESPEC-TEMPLATE.md

@@ -0,0 +1,66 @@
+# Feature: <Title>
+
+Issue: #<issue>  
+Owner: <agent>
+
+## Customer 
+
+## Customer's Desired Outcome
+
+## Customer Problem being solved
+
+## User Experience that will solve the problem
+- Specific steps in the user workflow (eg start in dashboard, click on tab x, see list y, approve item z ....)
+- UI mocks showing the desired experience. Put these in the `docs/feature specs/mocks` folder and link to them here.
+
+## Compliance Requirements (if applicable)
+*Include this section if your feature involves anything that would need compliance review*
+
+Based on your project's `.fraim/config.json` compliance settings, ensure you list clear requirements that must be met to meet compliance standards. 
+
+## Validation Plan
+- How will you know the feature is working as intended (validate via browser, api, ...)
+- What steps will you follow to ensure the feature works
+- **Compliance Validation**: How will compliance requirements be tested and verified
+
+## Alternatives
+- Table with following columns
+  - Alternative: What other way could the customer solve their problem?
+  - Why discard?: Why is this alternative not chosen?
+
+## Competitive Analysis
+
+### Configured Competitors Analysis
+*Analysis of competitors from .fraim/config.json*
+
+| Competitor | Current Solution | Strengths | Weaknesses | Customer Feedback | Market Position |
+|------------|------------------|-----------|------------|-------------------|-----------------|
+| [Name] | [How they solve this] | [Key strengths] | [Key weaknesses] | [What customers say] | [Market share/position] |
+
+### Additional Competitors Analysis
+*Analysis of other relevant competitors discovered during research*
+
+| Competitor | Current Solution | Strengths | Weaknesses | Customer Feedback | Market Position |
+|------------|------------------|-----------|------------|-------------------|-----------------|
+| [Name] | [How they solve this] | [Key strengths] | [Key weaknesses] | [What customers say] | [Market share/position] |
+
+### Competitive Positioning Strategy
+
+#### Our Differentiation
+- **Key Advantage 1**: [How we're different/better]
+- **Key Advantage 2**: [How we're different/better]
+- **Key Advantage 3**: [How we're different/better]
+
+#### Competitive Response Strategy
+- **If Competitor A does X**: [Our response strategy]
+- **If Competitor B does Y**: [Our response strategy]
+
+#### Market Positioning
+- **Target Segment**: [Who we're targeting vs competitors]
+- **Value Proposition**: [Our unique value vs competitors]
+- **Pricing Strategy**: [How we position on price vs competitors]
+
+### Research Sources
+- [List of sources used for competitive research]
+- [Date of research]
+- [Research methodology]

package/dist/registry/templates/specs/TECHSPEC-TEMPLATE.md

@@ -0,0 +1,39 @@
+# Feature: <Title>
+
+Issue: #<issue>  
+Owner: <agent>
+
+## Customer 
+
+## Customer Problem being solved
+
+## User Experience that will solve the problem
+- Specific steps in the user workflow 
+  - If UI feature: start on UI page a, click on tab x, see list y, approve item z, achieve outcome ....
+  - If API feature: call API a with params x, y, z, receive result
+  - If refactoring/rearchitecture: what is the simpler developer workflow 
+
+## Technical Details
+- UI changes: Which files will be modified and for what?
+- API surface (OpenAPI) changes
+- Data model / schema changes
+- Failure modes & timeouts
+- Telemetry & analytics
+
+## Confidence Level
+- On a scale of 0 to 100, how confident are you that your solution will work?
+
+## Validation Plan
+- Table with following columns
+  - User Scenario
+  - Expected outcome
+  - Validation method (UI validation, API validation, Database validation ...)
+
+## Test Matrix
+- Unit(as many as needed, mocking ok): what core functionality will be tested. What test suite will be added? Which existing test suites will be modified?
+- Integration(only mock external services): what tests will ensure the full stack integration does not regress. What test suite will be added? Which existing test suites will be modified?
+- E2E(1 at most, no mocking): If any changes are made to external integrations, what end to end tests will ensure external integrations work as expected.
+
+## Risks & Mitigations
+
+## Observability (logs, metrics, alerts)

package/dist/registry/workflows/bootstrap/create-architecture.md

@@ -0,0 +1,38 @@
+# FRAIM Workflow: create-architecture
+
+## Intent
+To analyze the codebase and author a comprehensive `docs/architecture/architecture.md` document using the standard template. This document captures the system's design, tech stack, and architectural layers to serve as a map for development.
+
+## Execution Steps
+
+1. **Analyze Project Structure**
+   - Use `list_dir` to explore the root directory and key subdirectories (src, docs, etc.).
+   - Use `view_file` on key configuration files (package.json, tsconfig.json, etc.).
+   - Identify main entry points and architectural patterns.
+
+2. **Author Architecture Document**
+   - Locate the template: `get_fraim_file({ path: "templates/bootstrap/ARCHITECTURE-TEMPLATE.md" })`
+   - Analyze your findings from Step 1.
+   - Create a new file at `docs/architecture/architecture.md`.
+   - Use your intelligence to synthesize the findings into the template:
+     - **Tech Stack**: Detail specific languages, runtimes, and frameworks used.
+     - **Architectural Layers**: Define the system's layers (Presentation, Logic, Data, etc.).
+     - **Key Components**: Map out the core modules and their relationships.
+     - **Data Flow**: Explain the lifecycle of a typical request or action.
+
+3. **Update FRAIM Configuration**
+   - Read the project configuration file at `.fraim/config.json`.
+   - Update it to include a reference to the architecture document:
+     ```json
+     {
+       ...
+       "customizations": {
+         "architectureDoc": "docs/architecture/architecture.md",
+         ...
+       }
+     }
+     ```
+
+4. **Verify**
+   - Check that `docs/architecture/architecture.md` exists and is populated.
+   - Check that `.fraim/config.json` contains the `architectureDoc` field pointing to the correct path.