/serve-vercel-build-output

A runtime environment that executes output that targets the Vercel Build Output API on Fastly Compute

Primary LanguageTypeScriptMIT LicenseMIT

Serve Vercel Build Output (v3) on Fastly Compute

NOTE: @fastly/serve-vercel-build-output is provided as a Fastly Labs product. Visit the Fastly Labs site for terms of use.

This library's goal is to provide a runtime environment that executes output that targets the Vercel Build Output API.

Vercel's Build Output API is a file-system-based specification for a directory structure that represents a Vercel deployment. It includes static files, functions, and a configuration file that expresses routing and internationalization rules.

While it's not (currently) possible to simulate it 100%, it is able to run a wide variety of programs, including those written for Next.js v12.3 and v13.x.

Current support includes:

  • The standard .vercel directory containing output that targets Vercel's Build Output API
  • Static files
  • Functions that target the Vercel Edge Runtime
  • The following features of config.json:
    • Routing
    • Overrides
    • Wildcards
    • Image Optimization

Usage

This library is typically used with @fastly/next-compute-js (v2). See @fastly/next-compute-js for more details.

Issues

If you encounter any non-security-related bug or unexpected behavior, please file an issue using the bug report template.

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

License

MIT.