Changelog
All notable changes to this project will be documented here. The format is based on Keep a Changelog.
[0.2.2]
2024-12-10Added
- Features page (/features) with competitive comparison, feature showcase, and CTA section.
- Platform metrics constants file (lib/platform-metrics.ts) for centralized runtime and status data.
- Changelog link to developer documentation quick links section.
- CI/CD gating support: fail_on_score and fail_on_drop parameters in POST /audit.
- Gating response fields: gating.failed, gating.reason, gating.overall, gating.delta in audit results.
- CI/CD documentation in developer docs explaining threshold usage and response fields.
Changed
- Landing page structure: Removed PricingTiers (now only on /pricing), enabled SocialProof section.
- Navigation: Added 'Features' link across landing, pricing, and features pages.
- Site footer: Added Features page link under Product section after Enterprise.
- Pricing page: Renamed 'Feature Matrix' heading to 'Features', moved sample report link to features page.
- TrustStrip component: Now uses dynamic PLATFORM_METRICS constants instead of hardcoded values.
- Hero section: Removed 'Free audit • No credit card required' text, improved error logging with status details.
- Sample report link: Moved from pricing page header to features page for better context.
Fixed
- Platform metrics validation: Runtime expectations (30-120s), development status (Alpha), and sequential processing confirmed from status page data.
[0.2.1]
2024-12-10Added
- Sample report page (/sample-report) showing real audit output with scores, issues, and recommendations.
- Competitive differentiation section comparing Vertaa to Lighthouse, WAVE, and Hotjar.
- Social proof section with early adopter testimonials, stats (500+ users, 10,000+ audits), and feature status clarity.
- Feature status badges (Live/Alpha/Coming Soon) on pricing page for transparency.
- Link to sample report from hero section and pricing page.
- Alpha testing status section clearly documenting what's live vs. planned features.
Changed
- Landing page structure: Added social proof and competitive edge sections above features.
- Pricing tiers now show feature status (Live/Alpha/Soon) inline with each feature.
Fixed
- Production audit failure error messaging: API now returns specific error details instead of generic 'Failed to start audit'.
- Error categorization with appropriate HTTP status codes (400/429/500) for validation, rate limit, and server errors.
- Database query resilience: Wrapped Prisma queries in try-catch to prevent cascading failures.
- Client-side error logging: Added console.error with full error details for production debugging.
[0.2.0]
2024-12-10Added
- Expanded issue library from 51 to 91 comprehensive checks (+78%) across 7 categories.
- Metadata fields to all issues: recommendedFix (code snippets), businessImpact (revenue metrics), impactScore (1-10 scale), estimatedEffort (easy/medium/hard).
- Color-coded impact badges, effort indicators, and business impact sections to UI.
- Comprehensive testing scripts (test-audit-engine.ts, benchmark-performance.ts).
- PageSpeed Insights integration with PSI scores and recommendations.
- Webhook delivery table to Dashboard → API Keys page with status tracking and replay controls.
- Webhook delivery logs API endpoints (GET/POST /api/webhooks/logs) for monitoring and replay.
- In-app toast notifications with targeting (all, tier, specific users), priorities, and admin UI.
- PDF export health check endpoint (/api/health/pdf) and dashboard at /status/pdf.
- Issue filtering by severity (error/warning/info) on GET /audit/{job_id}.
- Pagination support with page/per_page query params (max 1000 per page).
- Field selection via 'fields' query param to reduce payload size.
- Streaming endpoint: GET /audit/{job_id}/issues/stream (NDJSON format).
- Engines listing endpoint: GET /api/v1/engines for version discovery.
- Engine version tracking: engine_version input on audit creation and output in results.
- SSRF protection via isBlockedHost() guard (blocks localhost/private IPs).
- Per-mode timeout handling (basic: 20s, standard: 40s, deep: 60s).
- Timeout error detection with actionable retry suggestions.
- Dynamic llms.txt generation at /llms.txt (auto-timestamp, 300+ lines).
- OpenAPI 3.1 spec at /openapi.json (CORS-enabled, 7-metric scoring).
- Security model documentation (SECURITY-MODEL.md, DATA-RETENTION.md, RATE-LIMITS.md).
- Postman collection for API testing (POSTMAN_COLLECTION.json).
- CI/CD examples documentation (GitHub Actions, GitLab CI) in CI-EXAMPLES.md.
- Comprehensive llms.txt documentation (LLMS-TXT-GENERATION.md, 200+ lines).
- Comprehensive OpenAPI documentation (OPENAPI-JSON-SPEC.md, 400+ lines).
- 2,600+ lines of comprehensive documentation.
Changed
- Enhanced UI rendering with improved code blocks and mobile-responsive design.
- Extended webhook delivery retries from 3 to 6 attempts over ~24h spread (1m, 5m, 15m, 1h, 4h, 12h).
- Updated webhook signature scheme: HMAC-SHA256 over 'timestamp.payload' format.
- Webhook header names: X-Vertaaux-Signature, X-Vertaaux-Signature-Timestamp.
- Added timestamp validation (reject requests older than 5 minutes) for webhooks.
- Improved webhook error message truncation (512 char limit) to prevent log overflow.
- Updated developer docs with pagination/streaming guidance and NDJSON examples.
- Enhanced developer docs with 6-retry webhook delivery details and exponential backoff.
- Added webhook signature verification examples (Node.js + Python with timestamp validation).
- Updated rate limiting docs with tier-specific limits (Free: 5/day, Pro: ~33/day, Business: 5000/mo).
- Updated robots.txt to allow /openapi.json and /llms.txt for all crawlers (GPTBot, ClaudeBot, etc.).
- Replaced static /public/llms.txt with dynamic route handler for auto-updating content.
- Updated JS/TS SDK with MIT license, enhanced keywords, and npm publish scripts.
- Updated Python SDK with MIT license, keywords, and PyPI publish guidance.
- Improved SDK quickstart documentation with license and publishing guidance.
- Changelog header with user navigation and improved branding.
- Webhook delivery table with pagination support (page query param).
- API-MCP-IMPROVEMENTS.md updated with issue filtering/pagination completion status.
Fixed
- Admin notification date parsing with proper validation and error handling.
- Python webhook verification example with length check before timing-safe comparison.
- Scroll hijacking detection using proper event-based approach instead of style check.
- PageSpeed Insights recommendation sorting to include all recommendations before limiting.
- Test script to include semantic and keyboard issues in metadata coverage calculation.
- CLI error handling with better JSON parsing and error message extraction.
- SDK webhook signature verification using crypto.subtle.verify() instead of sign() for browser compatibility.
- Streaming endpoint response handling using NextResponse consistently for error cases.
- Audit job response formatting with simplified engine_version assignment.
- Audit creation to remove unused engineVersion field from database write.
- Duplicate WebhookDeliveryTable import in API keys page.
- Developer docs HTML entity encoding for > symbol in webhook documentation.
- Webhook delivery table UI by removing toast dependencies and simplifying loading state.
- Test script type checking for optional metadata fields using 'in' operator.
Removed
- Static /public/llms.txt file (replaced by dynamic route handler).
[0.1.0]
2024-12-09Added
- Organization, OrganizationMember, OrganizationInvite models with OWNER/ADMIN/EDITOR/VIEWER roles.
- Tier-aware dashboard and Organization page for agency/enterprise customers.
- Redis-backed audit queue and background worker with retry/stale cleanup.
- Rate-limit headers to API audit endpoints.
- Webhook delivery with HMAC signature verification and exponential backoff.
- MCP server with audit and quota management tools.
- Developer docs search/filter functionality and clearer navigation.
- JS/TS client with retries, idempotency helper, webhook verifier, and pagination helper.
- Python client generated from OpenAPI specification.
- Node CLI and GitHub Action example with score gating.
- API versioning header (X-API-Version: 2025-01-10) to audit/quota endpoints.
- Test mode and staging environment guidance documentation.
- Stripe billing integration with checkout and portal sessions.
- Billing dashboard with subscription management.
- Feature matrix component for plan comparisons.
- Comprehensive E2E test suite (audit-quota, dashboard, payment flows).
- Postman collection and environment files for API testing.
- Stripe test mode documentation and setup guides.
- User service layer for tier and quota management.
- Error boundary component for graceful error handling.
- Inline edit component for profile updates.
- Status icon component for visual feedback.
- NDA template for enterprise customers.
- Product screenshots for marketing materials.
- Testing strategy documentation.
- UI consistency audit documentation.
- Code refactoring guidelines.
- Semantic color system documentation.
Changed
- Permission helpers and invites system architecture.
- Developer docs with SDK snippets and webhook verification examples.
- Pricing tiers component with enhanced feature display.
- Dashboard profile page with inline editing.
- Account page with subscription management.
- Audit history table with improved filtering.
- Badge component with additional variants.
- User navigation with billing access.
- Global styles with extended color system.
- README with comprehensive feature list.
- Product roadmap with PLG strategy updates.
[0.0.2]
2024-12-08Added
- Vitest testing setup for component and integration tests.
- Test configuration files (vitest.config.ts, vitest.config.unit.ts, vitest.setup.ts).
- User tier API endpoint (/api/user/tier).
- Stripe mode API endpoint for environment detection.
- Billing sync subscription endpoint.
- Create portal session endpoint for Stripe Customer Portal.
Changed
- Production NEXT_AUTH URL configuration and environment setup.
- Favicon and branding polish with new high-resolution assets.
- README with current project status and features.
- Stripe webhook handling with improved error handling.
- Create checkout session with enhanced validation.
- About page copy and structure.
- Contact page styling.
- Landing page navigation.
- API authentication utilities.
Fixed
- TypeScript type errors in multiple components.
- Stripe integration issues with mode detection.
- API authentication edge cases.
Removed
- Vitest tests from CI pipeline for faster builds.
[0.0.1]
2024-12-08Added
- Initial project setup with Next.js 16, TypeScript 5, Tailwind CSS.
- Core audit engine with 51 checks across 7 categories (Accessibility, Usability, Clarity, IA, Conversion, Semantic HTML, Keyboard Navigation).
- Authentication system with NextAuth.js and email provider.
- PostgreSQL database with Prisma ORM.
- Basic dashboard with audit history.
- User profile and account management.
- New audit form with URL validation.
- Score card components with visual feedback.
- Audit history table with status tracking.
- Pricing page with tier comparison.
- Landing page with hero section and feature cards.
- Contact form with validation.
- About page with company information.
- Site footer with navigation links.
- User navigation component with avatar.
- Logo component with brand colors.
- Trust strip component for social proof.
- Organization, Product, Website, Breadcrumb, and FAQ JSON-LD schema markup.
- Robots.txt and sitemap configuration for public pages and developer docs.
- Developer documentation site with API reference.
- Storybook integration for component development.
- ESLint and Prettier configuration.
- Vitest configuration for unit testing.
- Playwright configuration for E2E testing.
- Environment variable templates (.env.local.example).
- Comprehensive PRD and technical documentation.
- Agent-based architecture documentation.
- PLG (Product-Led Growth) strategy documentation.
- Design system guidelines.
- Accessibility and keyboard navigation PRD.
- Integration summary and implementation guides.
- Project setup and Vercel deployment guides.