Zuplo Changelog

This release introduces improved syntax highlighting capabilities for Dev Portal documentation, enhancing the developer experience when viewing code examples and API documentation.

New Features 🎉#

Enhanced Syntax Highlighting

• Upgraded to Shiki syntax highlighter for improved code block rendering in #937
  • Provides server-side rendering (SSR) support for better performance
  • Adds customizable highlighting with transformer support and line highlighting features
  • Enables modern syntax highlighting for a wider range of programming languages
  • Improves visual consistency and readability of code examples in Dev Portal documentation

This release includes important improvements to error handling, and bug fixes to the GitLab integration. We've also made improvements to our project templates and development tooling.

New Features 🎉#

• Improved error messages for invalid module imports - When importing modules incorrectly in your Zuplo project, you'll now receive more helpful and descriptive error messages that make it easier to identify and fix import issues. This enhancement improves the developer experience when working with custom modules and policies.

Bug Fixes 🐛#

• Fixed virtual module namespace collisions - Resolved an issue where virtual modules could conflict with each other due to namespace collisions. Virtual modules are now properly namespaced to ensure they work reliably alongside other modules in your project.

• Fixed GitLab integration infinite loop - Corrected a critical issue where fetching from GitLab repositories could cause infinite loops under certain conditions. This fix ensures stable and reliable synchronization with your GitLab repositories when using Zuplo's source control integration.

Documentation 📚#

• Added /hello route to project template - The default project template now includes a /hello route example, making it easier for new users to understand how to create and configure routes in their Zuplo API gateway.

Other Changes 🔄#

• Zudoku template enhancements - Updated the Zudoku documentation template to properly set Zuplo flags on scripts, ensuring better integration between Zuplo and the Dev Portal.

This release enhances the Dev Portal with improved real-time updates, better authentication support, and a streamlined Zuplo integration experience. Key improvements include automatic sidebar refresh when API schemas change, enhanced Auth0 and OpenID authentication capabilities, and a new command-line option for Zuplo users.

New Features 🎉#

• Automatic sidebar refresh on API schema changes #910 - The Dev Portal sidebar now automatically refreshes when your API schema is modified, providing a seamless real-time experience without requiring manual page refreshes.

• Streamlined Zuplo integration #914 - Simplified the Zuplo integration process by replacing manual configuration with automated environment setup and build status monitoring, making it easier to integrate the Dev Portal with your Zuplo API gateway.

• Enhanced empty state experience for API documentation #922 - Added user-friendly empty state screens that display helpful guidance when OpenAPI documents lack operations or schema tags, improving the developer experience when working with incomplete documentation.

• New --zuplo command-line option #925 - Introduced a dedicated CLI flag that enables Zuplo-specific features with automatic diagnostics logging, simplifying the developer workflow for Zuplo users.

Bug Fixes 🐛#

• Auth0 scope configuration support #929 - Fixed an issue preventing custom authentication scopes configuration for Auth0 providers. You can now specify custom scopes like scopes: ["my-scope"] for more flexible authentication setups.

• OpenID authentication with base paths #927 - Resolved authentication issues when applications use custom base paths (e.g., /docs), ensuring OpenID authentication works correctly across different deployment configurations.

• Improved URL-based OpenAPI documentation routing #936 - Enhanced OpenAPI documentation generation with better tag parameter handling and streamlined route creation, making the system more robust and maintainable.

• Enhanced schema management architecture #924 - Refactored the schema management system with a dedicated SchemaManager class, featuring improved file watching and cache-busting capabilities for more efficient schema processing.

Dependency Updates 📦#

• Updated syntax highlighting library (shiki) from 3.2.1 to 3.2.2 #900
• Updated nx-dependencies group with 4 updates #930
• Updated postcss from 8.4.49 to 8.5.3 #933
• Updated @radix-ui/react-toggle from 1.1.3 to 1.1.6 #931
• Updated eslint-dependencies group with 4 updates #935

New Contributors#

• @ashipilov made their first contribution in #929

This release brings improvements to the Zuplo CLI authentication experience and bug fixes.

New Features 🎉#

• Enhanced CLI Authentication with Refresh Tokens - The Zuplo CLI now supports refresh tokens for improved authentication persistence. This update provides a more seamless experience when working with the CLI, eliminating the need for frequent re-authentication. Learn more about local development with Zuplo CLI.

• Account Deletion Capability - Users can now permanently delete their Zuplo accounts through the portal. This self-service feature provides full control over account management. See the account deletion guide for more details.

Bug Fixes 🐛#

• Request Logging Enhancement - Moved request received logging earlier in the handler for improved observability and debugging capabilities.

This release brings enhanced accessibility features and improved API schema processing capabilities to the Dev Portal. Notable improvements include better Windows keyboard shortcut support, dynamic sidebar padding for improved readability, and expanded API schema transformation options.

New Features 🎉#

• Enhanced keyboard shortcut support for Windows users #893
• Added API schema processors for advanced schema transformations and customizations #890

Bug Fixes 🐛#

• Improved sidebar visibility by adding dynamic padding to prevent content from being obscured by gradients #896
• Resolved duplicate sidebar key issue that could cause navigation problems #898
• Updated lucide-react icons to the latest version for consistent iconography #895

Dependency Updates 📦#

• Updated remark-mdx-frontmatter from 5.0.0 to 5.1.0 #902
• Updated graphql-yoga from 5.13.2 to 5.13.3 #901
• Updated nx-dependencies group with 3 package updates #899
• General package upgrades for improved security and performance #904

This release includes improvements to OpenAPI schema reference handling and a fix for the Zuplo CLI login behavior on middleware platforms.

Bug Fixes 🐛#

• Improved nested schema reference traversing - Fixed an issue where deeply nested schema references in OpenAPI specifications were not being properly resolved. This enhancement ensures that complex OpenAPI documents with multiple levels of $ref pointers are correctly processed, improving compatibility with sophisticated API specifications.

• Fixed CLI login behavior on middleware platforms - Resolved an issue where the Zuplo CLI would unexpectedly exit after login when running on certain middleware platforms. The CLI now properly maintains the session after successful authentication, ensuring a smooth development experience.