GitShow/vercel/sdk
vercel

sdk

Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API.

by vercel
Star on GitHubForknpm

TypeScript

158 stars41 forks15 contributorsActive · 3h agoSince 2024v1.28.17Apache-2.0

Meet the team

See all 15 on GitHub →
github-actions[bot]Bot
github-actions[bot]148 contributions
ismaelrumzan
ismaelrumzan109 contributions
simplesagar
simplesagar4 contributions
logangingerich
logangingerich4 contributions
TristanSpeakEasy
TristanSpeakEasy3 contributions
walker-tx
walker-tx3 contributions
kanwardeep007
kanwardeep0072 contributions
mfbx9da4
mfbx9da41 contribution

Languages

View on GitHub →
TypeScript100%
Shell0%

Commit activity

Last 12 weeks · 33 commits

Full graph →

Community health

4 of 6 standards met

Community profile →
87
✓README✓License✓Contributing✓Code of Conduct○Issue Template○PR Template

Recent PRs & issues

Active · 1 in progress · Last activity 3h ago
See all on GitHub →
RodrigoTomeES
[Bug]: Unexpected API change (new 'BLOCKED' state) breaks backward compatibility and causes runtime Zod errors in older SDK versionsOpenIssue

Recently, our production SaaS application went down without any code changes on our end. This happened because the Vercel API started returning a new state and readyState value (BLOCKED) for deployments. Because the Vercel SDK uses strict Zod enum validation for the deployment state, our installed version of the SDK threw a runtime exception when parsing the response, effectively breaking our application. This is the second time an unannounced breaking change in the underlying Vercel API has broken our production environment due to strict validation in the SDK. It is highly frustrating to wake up to a broken product when no deployments or changes were made on our side. Error Log Here is the runtime error caused by the library failing to parse the new API response in the method : Expected Behavior APIs should ideally maintain backward compatibility. If a new enum value is added to the API, older SDK versions shouldn't crash entirely. The SDK should handle unknown states gracefully rather than failing strict validation and taking down the consuming application. Breaking API changes should be communicated transparently. Questions regarding workflow and updates Since we need to ensure our SaaS remains stable, I would like to ask for guidance on how we should consume this SDK: Communication: Is there a specific mailing list, changelog, or status page where these API changes (like adding new deployment states) are announced before they are deployed? This would allow us to adapt our code in advance. Release Cadence: Are new SDK versions released to support these API changes before the API changes actually go live in production? Recommended Workflow: What is Vercel's recommended workflow to prevent these runtime errors? Are we expected to constantly set up automated jobs to update the Vercel SDK to the latest version to avoid our production app from breaking? We love using Vercel, but we need a reliable way to interact with the API without the fear of strict validation breaking our app unexpectedly. Thank you for your time and help.

RodrigoTomeES · 4d ago
Structured data for AI agents

Repository: vercel/sdk. Description: Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API. Stars: 158, Forks: 41. Primary language: TypeScript. Languages: TypeScript (100%), Shell (0%). License: Apache-2.0. Latest release: v1.28.17 (11h ago). Open PRs: 1, open issues: 19. Last activity: 3h ago. Community health: 87%. Top contributors: github-actions[bot], ismaelrumzan, simplesagar, logangingerich, TristanSpeakEasy, walker-tx, kanwardeep007, mfbx9da4, mehulkar, TooTallNate and others.

·@ofershap

Replace github.com with gitshow.dev