DataBridge DataBridge

Changelog

Complete version history and changes for DataBridge

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[0.2.9] - 2025-12-23

Fixed

  • OpenAPI Generation Bugs

    • Fixed duplicate operationId conflict (getUserPosts renamed to getUserPostsByUserId)
    • Excluded relations from CreateDTO/UpdateDTO schemas (prevented impossible validation)
    • Excluded auto-generated fields (createdAt, updatedAt, hasDefaultValue) from Zod schemas
    • Fixed custom query path syntax (converted Express :param to OpenAPI {param} format)

  • SDK Generation Improvements

    • Added Java 11+ detection with corruption handling for openapi-generator-cli
    • Added global install fallback when local install fails
    • Added --list-languages flag showing 30+ language descriptions
    • Fixed Angular SDK path expectations (frontend-sdks/angular)

  • CI/CD Pipeline Hardening

    • Fixed test-database.sh to use proper databridge commands (not hardcoded paths)
    • Fixed init command to use positional arguments with DATABASE_URL in .env
    • Added database seeding for MySQL/PostgreSQL test databases
    • Fixed empty database test for Prisma 7 compatibility (removed url field)
    • Fixed port conflicts in multi-database tests (MySQL:3000, PostgreSQL:3001)
    • Added HTTP status code validation to all database tests
    • Fixed API_PORT environment variable handling
    • Fixed test-full-e2e.sh Suite 10 directory handling

  • Validation & Error Handling

    • Improved error messages for missing Java installations
    • Added graceful fallback for missing test directories
    • Enhanced test output with proper success/failure reporting

Changed

  • Documentation Updates
    • Updated all version references from 0.2.8 to 0.2.9
    • Enhanced CLI command documentation
    • Improved SDK generation guides

0.2.0 - 2025-12-09

Added

  • OpenAPI 3.0 Specification Generation - Automatic generation from Prisma schema

    • Schema generation for all models with proper types
    • CRUD operation definitions with DTOs
    • Enum and relation handling
    • PascalCase operation IDs (e.g., listProducts, createOrders)

  • Swagger UI Integration - Interactive API documentation

    • Accessible at /docs endpoint
    • Enhanced UI configuration (filter, deep linking, tryItOut enabled)
    • Automatic route registration with proper logging

  • Multi-Language SDK Generation Command - databridge generate-sdk

    • Support for 50+ languages via openapi-generator-cli
    • Languages: Python, TypeScript, Java, C#, Go, PHP, Ruby, Swift, Kotlin, and more
    • Automatic USAGE.md generation per SDK with examples
    • Language-specific templates and configurations
    • Port configuration support (default: localhost:3000)

  • Testing Ecosystem Scripts

    • export-postman.sh - Convert OpenAPI spec to Postman collection
    • setup-dredd.sh - Set up Dredd contract testing with hooks
    • start-prism.sh - Launch Prism mock server
    • validate-openapi.sh - Validate OpenAPI specification
    • test-sdk-batch.sh - Batch test SDK generation for multiple languages

  • Comprehensive API Documentation (8,300+ words)

    • OpenAPI & Swagger UI Tutorial (2,000 words)
    • API Testing with Dredd Guide (2,500 words)
    • Mock Servers with Prism Guide (2,700 words)
    • Multi-Language SDK Generation Guide (2,800 words)
    • Quick Reference Guide (1,000 words)
    • API Tutorials Index (1,300 words)

  • Integration Test Suite

    • openapi-flow.test.ts - Full workflow testing (400+ lines)
    • Test coverage for spec generation, validation, SDK generation

  • Planning & Strategy Documents

    • Pre-merge audit plan with 6-phase testing strategy
    • Versioning strategy following SemVer 2.0
    • Post-merge action plan with roadmap updates

Changed

  • Updated README.md with OpenAPI ecosystem features
  • Enhanced getting-started guides with OpenAPI workflows
  • Improved core concepts documentation
  • Updated introduction tutorial with API-first approach

Fixed

  • SDK generation path resolution with absolute paths
  • GeneratorConfig type definition for orchestrator
  • OpenAPI enabled check in generator
  • Operation ID casing consistency

Dependencies

  • Added @fastify/swagger@^9.3.1 for OpenAPI support
  • Added @fastify/swagger-ui@^5.2.3 for Swagger UI
  • Added @openapitools/openapi-generator-cli@^2.9.0 for SDK generation

0.1.0 - 2024-12-04

Added

  • CLI Commands

    • databridge init - Initialize new DataBridge project with interactive prompts
    • databridge introspect - Introspect database and generate Prisma schema
    • databridge generate - Generate API routes, services, and Prisma plugin
    • databridge serve - Start development server (deprecated in favor of npm run dev)
    • databridge --version - Display CLI version
    • databridge --help - Display help information

  • Automatic Code Generation

    • Auto-generate Fastify routes with Zod validation
    • Auto-generate service layer with Prisma integration
    • Auto-generate Prisma plugin for dependency injection
    • Auto-run prisma generate after code generation

  • Server Features

    • Dynamic port selection (auto-retry ports 3000-3004)
    • CORS enabled by default
    • Pino logging with pretty formatting
    • Graceful shutdown handling

  • Platform-Specific Builds

    • Windows (databridge-cli-win32) - ~60 MB
    • macOS (databridge-cli-darwin) - ~60 MB
    • Linux (databridge-cli-linux) - ~60 MB
    • All dependencies bundled (zero npm install required)

  • Documentation

    • Getting Started Guide
    • Quick Start Tutorial
    • Core Concepts
    • CLI Development Guide (Parts 1-3)
    • Architecture Documentation
    • Testing Plan
    • Platform Builds Documentation

Changed

  • Improved CLI output with better formatting and instructions
  • Simplified workflow: removed need for manual databridge serve command
  • Updated tutorials to reflect automatic Prisma plugin generation

Fixed

  • Windows PowerShell compatibility (removed NODE_ENV from scripts)
  • Cross-platform file operations using Node.js fs APIs
  • GitHub Actions permissions for release creation
  • YAML syntax in release body generation
  • Prisma client generation now runs automatically
  • Port conflict resolution with automatic retry

Security

  • All 706 packages scanned - 0 CVEs detected
  • Prisma v5.22.0 (stable, no known vulnerabilities)
  • All dependencies at secure versions

Dependencies

Bundled runtime dependencies:

  • @fastify/cors@11.1.0
  • @prisma/client@5.22.0
  • @prisma/engines@5.22.0
  • fastify@5.6.2
  • fastify-plugin@5.1.0
  • pino@9.6.0
  • pino-pretty@13.1.2
  • prisma@5.22.0
  • tsx@4.20.6
  • zod@3.25.76

Was this page helpful?

Edit this page on GitHub