June 2024 Summaries

Nolan Sullivan's blog post discusses the recent updates to SDK publication, highlighting a new feature that allows developers to generate and publish SDKs "On Demand" directly from the Speakeasy dashboard, which simplifies the process by supporting automatic version bumps with pre-release tags like -alpha and -beta. This update ensures that SDKs are not considered complete until they are published, echoing the sentiment that generating an SDK is only part of the job. Additional improvements include enabling Github Sandboxes by default for TypeScript, Go, and Python SDKs, improved naming conventions, enhanced handling of discriminated unions, and several other language-specific enhancements and bug fixes in platforms such as Terraform, Java, and C#.

In a recent update, several enhancements and changes were announced, including the full CLI support for Windows, a revamped Quickstart feature, and the planned sunset of TypeScript V1. The CLI now functions seamlessly on Windows, complementing its usability on MacOS and Linux, with integration testing extended to Windows environments. The Quickstart has been improved to handle errors more effectively, allowing teams to generate minimally viable SDKs despite OpenAPI syntax issues, with error logs provided for later correction. TypeScript V1 will be officially retired on August 9th, 2024, following the introduction of TypeScript v2, which offers several enhancements, such as using the Fetch API, supporting multiple platforms, integrating Zod for data validation, and better handling of complex API schemas. Additionally, various bug fixes and improvements have been made across different platforms, including handling edge cases in YAML and JSON files and improving support for client credentials in Java.

Zod, a powerful tool for writing safe TypeScript code, has significantly influenced how developers build TypeScript SDKs, particularly at Speakeasy, where it has been integral to their SDK generator design. When optimizing SDK sizes for better browser performance, the traditional method of writing Zod schemas, which involves importing the entire library as a single variable, proved less effective in achieving substantial minification. A revised approach involves importing standalone functions from Zod and using local variables, allowing for more efficient minification by tools like esbuild, resulting in a 43% reduction in code size from 512 bytes to 290 bytes. This method, although slightly more cumbersome due to the necessity of importing individual functions, provides a beneficial strategy for developers prioritizing bundle size optimization.