Skip to content

Latest commit

 

History

History
260 lines (193 loc) · 9.44 KB

File metadata and controls

260 lines (193 loc) · 9.44 KB

Release Notes

v1.0.0 - Major Release (2026-01-25)

📦 Released Packages

All packages have been updated to version 1.0.0:

  • @objectstack/spec@1.0.0 - Core protocol definitions and TypeScript types
  • @objectstack/types@1.0.0 - Shared TypeScript type definitions
  • @objectstack/objectql@1.0.0 - ObjectQL query language and runtime
  • @objectstack/runtime@1.0.0 - Runtime execution environment
  • @objectstack/client@1.0.0 - Client library for ObjectStack
  • @objectstack/driver-memory@1.0.0 - In-memory data storage driver
  • @objectstack/plugin-hono-server@1.0.0 - Hono server plugin for REST API
  • @objectstack/plugin-msw@1.0.0 - MSW (Mock Service Worker) plugin

🎉 What's New

This is a major version 1.0.0 release marking the API as stable and production-ready!

Stability & Production Readiness

  • Stable API: The ObjectStack protocol and API are now considered stable
  • Production Ready: All core packages are ready for production use
  • Comprehensive Testing: Full test coverage across all packages
  • Complete Documentation: Extensive guides and API references

Foundation

Built on the solid foundation established in v0.4.0:

  • Complete documentation site with Fumadocs
  • Comprehensive GitHub workflows (CI, CodeQL, release automation)
  • Documentation guides (CONTRIBUTING.md, ARCHITECTURE.md, CODE_OF_CONDUCT.md)
  • Agent prompts for AI-assisted development
  • Multiple example applications
  • Infrastructure automation

📝 Changes Summary

  • Version Bump: All packages updated from 0.4.0 → 1.0.0 (major version bump)
  • API Stability: API is now considered stable and production-ready
  • No Breaking Changes: This release maintains compatibility with 0.4.0

🚀 Publishing

This release is ready for publishing to npm. When this PR is merged to main:

  1. The GitHub Actions release workflow will automatically detect the version bump
  2. Build all packages
  3. Publish to npm registry using NPM_TOKEN secret
  4. Create GitHub release with appropriate tags

🔗 Migration Notes

No migration required from v0.4.0 - this is a stability declaration release.


v0.4.0 - Minor Feature Release (2026-01-25)

📦 Released Packages

All packages have been updated to version 0.4.0:

  • @objectstack/spec@0.4.0 - Core protocol definitions and TypeScript types
  • @objectstack/types@0.4.0 - Shared TypeScript type definitions
  • @objectstack/objectql@0.4.0 - ObjectQL query language and runtime
  • @objectstack/runtime@0.4.0 - Runtime execution environment
  • @objectstack/client@0.4.0 - Client library for ObjectStack
  • @objectstack/driver-memory@0.4.0 - In-memory data storage driver
  • @objectstack/plugin-hono-server@0.4.0 - Hono server plugin for REST API
  • @objectstack/plugin-msw@0.4.0 - MSW (Mock Service Worker) plugin

✨ What's New

This is a minor feature release with significant infrastructure and documentation improvements:

Documentation & Developer Experience

  • Complete Documentation Site: Built with Fumadocs, featuring comprehensive guides and API references
  • Contributing Guidelines: CONTRIBUTING.md with detailed development workflow
  • Architecture Documentation: Deep dive into ObjectStack's architecture and design principles
  • Code of Conduct: Community guidelines for inclusive collaboration
  • Blog Posts: In-depth articles on metadata-driven architecture and protocol-first development

Infrastructure & Automation

  • GitHub Workflows:
    • Continuous Integration (CI) for automated testing
    • CodeQL security scanning
    • Automated release process
    • Dependency validation
    • Link checking
    • PR automation
  • Agent Prompts: AI-assisted development prompts for various protocol domains

Examples & Demos

  • Multiple example applications showcasing ObjectStack capabilities
  • AI-powered examples (Analyst, Sales, Support, Code Generator)
  • CRM and Todo applications
  • Plugin examples (BI, MSW demo)

📝 Changes Summary

  • Version Bump: All packages updated from 0.3.2 → 0.4.0
  • New Files: 100+ new files including documentation, workflows, and examples
  • Enhanced Structure: Improved project organization and developer experience

🚀 Publishing

This release is ready for publishing to npm. When this PR is merged to main:

  1. The GitHub Actions release workflow will automatically detect the version bump
  2. Build all packages
  3. Publish to npm registry using NPM_TOKEN secret
  4. Create GitHub release with appropriate tags

🔗 Migration Notes

No breaking changes in this release. All existing code will continue to work with version 0.4.0.


v0.3.2 - Maintenance Release (2026-01-24)

📦 Released Packages

All packages have been updated to version 0.3.2:

  • @objectstack/spec@0.3.2 - Core protocol definitions and TypeScript types
  • @objectstack/types@0.3.2 - Shared TypeScript type definitions
  • @objectstack/objectql@0.3.2 - ObjectQL query language and runtime
  • @objectstack/runtime@0.3.2 - Runtime execution environment
  • @objectstack/client@0.3.2 - Client library for ObjectStack
  • @objectstack/driver-memory@0.3.2 - In-memory data storage driver
  • @objectstack/plugin-hono-server@0.3.2 - Hono server plugin for REST API
  • @objectstack/plugin-msw@0.3.2 - MSW (Mock Service Worker) plugin

📝 Changes

This is a patch release focusing on:

  • Maintenance and stability improvements
  • Updated dependencies across all packages
  • Improved build consistency

🚀 Publishing

This release is ready for publishing to npm. When this PR is merged to main:

  1. The GitHub Actions release workflow will automatically detect the version bump
  2. Build all packages
  3. Publish to npm registry using NPM_TOKEN secret
  4. Create GitHub release with appropriate tags

v0.2.0 - Initial Public Release

📦 Released Packages

All packages are ready for publishing to npm:

  • @objectstack/spec@0.2.0 - Core protocol definitions and TypeScript types
  • @objectstack/types@0.2.0 - Shared TypeScript type definitions
  • @objectstack/objectql@0.2.0 - ObjectQL query language and runtime
  • @objectstack/runtime@0.2.0 - Runtime execution environment
  • @objectstack/client@0.2.0 - Client library for ObjectStack
  • @objectstack/driver-memory@0.2.0 - In-memory data storage driver
  • @objectstack/plugin-hono-server@0.2.0 - Hono server plugin for REST API

✨ Features

This is the first public release of the ObjectStack ecosystem, providing:

Core Capabilities

  • Data Protocol (ObjectQL): Complete schema definitions for Objects and Fields
    • 35 field types (text, number, select, lookup, formula, autonumber, slider, qrcode, etc.)
    • Validation rules, workflows, and triggers
    • Permission system and sharing rules
    • Abstract query language for unified data access

UI Protocol

  • App Configuration: Navigation, branding, theming
  • View System: ListView (grid, kanban, calendar, gantt), FormView
  • Analytics: Dashboards and reports
  • Actions: Custom buttons and interactions

System Protocol

  • Manifest: Package configuration
  • Datasources: External data connections
  • API: REST/GraphQL endpoint definitions
  • Translation: i18n support

Developer Experience

  • 187 JSON Schemas automatically generated from Zod definitions
  • Complete TypeScript types with runtime validation
  • Comprehensive documentation with examples
  • Monorepo structure with pnpm workspaces

📝 Changelog

See individual CHANGELOG.md files in each package:

🚀 Publishing

Automated Publishing (Recommended)

This release is prepared and ready for automated publishing via GitHub Actions:

  1. Merge this PR to main branch
  2. GitHub Actions workflow will automatically:
    • Detect the version bump
    • Build all packages
    • Publish to npm registry using NPM_TOKEN secret
    • Create GitHub release with tags

Manual Publishing (If needed)

If you need to publish manually:

# Ensure you're authenticated to npm
npm login

# Build and publish all packages
pnpm run build
pnpm run release

🏷️ Git Tags

Version tag v0.2.0 has been created for this release.

📚 Documentation

Full documentation is available at:

🛠️ Build Status

✅ All packages built successfully ✅ All JSON schemas generated (187 schemas) ✅ All documentation generated (187 reference docs) ✅ TypeScript compilation passed ✅ Package versions bumped ✅ Changelogs updated

🔍 Pre-publish Verification

Dry-run output confirms all 7 packages are ready:

  • ✅ @objectstack/client@0.2.0
  • ✅ @objectstack/driver-memory@0.2.0
  • ✅ @objectstack/objectql@0.2.0
  • ✅ @objectstack/plugin-hono-server@0.2.0
  • ✅ @objectstack/runtime@0.2.0
  • ✅ @objectstack/spec@0.2.0
  • ✅ @objectstack/types@0.2.0

All packages are new and have not been published to npm yet.