diff --git a/.changeset/vercel-adapter.md b/.changeset/vercel-adapter.md new file mode 100644 index 00000000..7ef227d4 --- /dev/null +++ b/.changeset/vercel-adapter.md @@ -0,0 +1,5 @@ +--- +"@marko/run-adapter-vercel": minor +--- + +Add a Vercel adapter for deploying @marko/run apps to Vercel Node.js Serverless Functions (default) or Edge Functions via the Build Output API. diff --git a/package-lock.json b/package-lock.json index a01363b5..102cf8d3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2497,6 +2497,10 @@ "resolved": "packages/adapters/static", "link": true }, + "node_modules/@marko/run-adapter-vercel": { + "resolved": "packages/adapters/vercel", + "link": true + }, "node_modules/@marko/run-explorer": { "resolved": "packages/explorer", "link": true @@ -14038,6 +14042,381 @@ } } }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz", + "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-android-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz", + "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz", + "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-darwin-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz", + "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz", + "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz", + "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz", + "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz", + "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz", + "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz", + "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz", + "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz", + "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz", + "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz", + "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz", + "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz", + "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz", + "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz", + "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz", + "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz", + "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz", + "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz", + "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz", + "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz", + "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz", + "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, "node_modules/netlify-cli/node_modules/@sec-ant/readable-stream": { "version": "0.4.1", "dev": true, @@ -17283,6 +17662,19 @@ "safe-buffer": "~5.1.0" } }, + "node_modules/netlify-cli/node_modules/fsevents": { + "version": "2.3.3", + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, "node_modules/netlify-cli/node_modules/function-bind": { "version": "1.1.2", "dev": true, @@ -21065,6 +21457,53 @@ "dev": true, "license": "MIT" }, + "node_modules/netlify-cli/node_modules/rollup": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz", + "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==", + "dev": true, + "license": "MIT", + "optional": true, + "peer": true, + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.59.0", + "@rollup/rollup-android-arm64": "4.59.0", + "@rollup/rollup-darwin-arm64": "4.59.0", + "@rollup/rollup-darwin-x64": "4.59.0", + "@rollup/rollup-freebsd-arm64": "4.59.0", + "@rollup/rollup-freebsd-x64": "4.59.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.59.0", + "@rollup/rollup-linux-arm-musleabihf": "4.59.0", + "@rollup/rollup-linux-arm64-gnu": "4.59.0", + "@rollup/rollup-linux-arm64-musl": "4.59.0", + "@rollup/rollup-linux-loong64-gnu": "4.59.0", + "@rollup/rollup-linux-loong64-musl": "4.59.0", + "@rollup/rollup-linux-ppc64-gnu": "4.59.0", + "@rollup/rollup-linux-ppc64-musl": "4.59.0", + "@rollup/rollup-linux-riscv64-gnu": "4.59.0", + "@rollup/rollup-linux-riscv64-musl": "4.59.0", + "@rollup/rollup-linux-s390x-gnu": "4.59.0", + "@rollup/rollup-linux-x64-gnu": "4.59.0", + "@rollup/rollup-linux-x64-musl": "4.59.0", + "@rollup/rollup-openbsd-x64": "4.59.0", + "@rollup/rollup-openharmony-arm64": "4.59.0", + "@rollup/rollup-win32-arm64-msvc": "4.59.0", + "@rollup/rollup-win32-ia32-msvc": "4.59.0", + "@rollup/rollup-win32-x64-gnu": "4.59.0", + "@rollup/rollup-win32-x64-msvc": "4.59.0", + "fsevents": "~2.3.2" + } + }, "node_modules/netlify-cli/node_modules/router": { "version": "2.2.0", "dev": true, @@ -25590,6 +26029,18 @@ "@marko/run": "^0.7.7||^0.8||^0.9||^0.10" } }, + "packages/adapters/vercel": { + "name": "@marko/run-adapter-vercel", + "version": "0.1.0", + "license": "MIT", + "dependencies": { + "compression": "^1.8.1", + "serve-static": "^2.2.1" + }, + "peerDependencies": { + "@marko/run": "^0.7||^0.8||^0.9||^0.10" + } + }, "packages/explorer": { "name": "@marko/run-explorer", "version": "2.0.3", diff --git a/packages/adapters/vercel/README.md b/packages/adapters/vercel/README.md new file mode 100644 index 00000000..42a926ed --- /dev/null +++ b/packages/adapters/vercel/README.md @@ -0,0 +1,78 @@ +

+ + + + + Marko Run Logo + +
+ @marko/run-adapter-vercel +
+

+ +Preview and deploy [@marko/run](../../run/README.md) apps to [Vercel Functions](https://vercel.com/docs/functions) + +## Installation + +```sh +npm install @marko/run-adapter-vercel +``` + +That's all the setup required — Marko Run automatically discovers an installed adapter and uses it, so you **don't** need to register it in your Vite config. Builds target Vercel's Node.js runtime. (The Edge runtime is not supported — Vercel has [deprecated Edge Functions](https://vercel.com/docs/functions/runtimes/edge/edge-functions) in favor of the Node.js runtime.) + +## Previewing locally + +After building, `marko-run preview` serves the generated `.vercel/output` locally — static assets are served from disk and everything else is handled by the built function, mirroring how Vercel routes requests in production: + +```sh +npm run build +npm run preview +``` + +This runs entirely on your machine: no Vercel account, project link, or Vercel CLI is required. + +## Deploying + +`marko-run build` produces a [Vercel Build Output API](https://vercel.com/docs/build-output-api/v3) directory at `.vercel/output`, which Vercel deploys directly. + +The simplest option is Vercel's Git integration: set your project's build command to `marko-run build` and Vercel picks up `.vercel/output` automatically — no output directory configuration required. + +To deploy from your machine with the [Vercel CLI](https://vercel.com/docs/cli) (`npm i -g vercel`), build and upload the prebuilt output: + +```sh +npm run build +npx vercel deploy --prebuilt +``` + +Add `--prod` to deploy to production. + +## Configuration + +Marko Run uses this adapter automatically, but you can also register it explicitly in your Vite config (eg. `vite.config.js`): + +```ts +import { defineConfig } from "vite"; +import marko from "@marko/run/vite"; +import vercelAdapter from "@marko/run-adapter-vercel"; + +export default defineConfig({ + plugins: [ + marko({ + adapter: vercelAdapter(), + }), + ], +}); +``` + +## Platform info + +The route handler `platform` argument exposes the underlying Node request and response objects: + +```ts +import type { VercelNodePlatformInfo } from "@marko/run-adapter-vercel"; + +export const GET = (context) => { + const { request, response } = context.platform as VercelNodePlatformInfo; + return new Response(`Hello from ${request.url}!`); +}; +``` diff --git a/packages/adapters/vercel/package.json b/packages/adapters/vercel/package.json new file mode 100644 index 00000000..d7004294 --- /dev/null +++ b/packages/adapters/vercel/package.json @@ -0,0 +1,37 @@ +{ + "name": "@marko/run-adapter-vercel", + "version": "0.1.0", + "description": "Preview and deploy @marko/run apps to Vercel Functions", + "keywords": [ + "marko" + ], + "homepage": "https://github.com/marko-js/run/tree/main/packages/adapters/vercel", + "repository": { + "type": "git", + "url": "https://github.com/marko-js/run.git" + }, + "license": "MIT", + "author": "Ryan Turnquist ", + "type": "module", + "exports": { + ".": "./src/index.ts" + }, + "types": "./src/index.ts", + "files": [ + "dist" + ], + "scripts": { + "build": "tsc -b && tsx scripts/build.ts", + "test": "" + }, + "dependencies": { + "compression": "^1.8.1", + "serve-static": "^2.2.1" + }, + "peerDependencies": { + "@marko/run": "^0.7||^0.8||^0.9||^0.10" + }, + "logo": { + "url": "https://github.com/marko-js/run/raw/main/assets/marko-run.png" + } +} diff --git a/packages/adapters/vercel/package.toggle.json b/packages/adapters/vercel/package.toggle.json new file mode 100644 index 00000000..a2f5767a --- /dev/null +++ b/packages/adapters/vercel/package.toggle.json @@ -0,0 +1,15 @@ +{ + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js", + "require": "./dist/index.cjs" + } + }, + "types": "./dist/index.d.ts", + "typesVersions": { + "*": { + "*": ["./dist/index.d.ts"] + } + } +} diff --git a/packages/adapters/vercel/scripts/build.ts b/packages/adapters/vercel/scripts/build.ts new file mode 100644 index 00000000..455b8653 --- /dev/null +++ b/packages/adapters/vercel/scripts/build.ts @@ -0,0 +1,51 @@ +import { build, BuildOptions } from "esbuild"; +import path from "path"; + +const srcdir = path.resolve("src"); +const outdir = path.resolve("dist"); + +const opts: BuildOptions = { + entryPoints: ["src/index.ts"], + outdir, + outbase: srcdir, + platform: "node", + target: ["node14"], + bundle: true, + plugins: [ + { + name: "external-modules", + setup(build) { + build.onResolve( + { filter: /^[^./]|^\.[^./]|^\.\.[^/]/ }, + ({ path }) => ({ + path, + external: true, + }), + ); + }, + }, + ], +}; + +await Promise.all([ + build({ + ...opts, + format: "cjs", + outExtension: { ".js": ".cjs" }, + define: { + "import.meta.url": "__importMetaURL", + }, + inject: ["./scripts/importMetaURL.js"], + }), + build({ + ...opts, + format: "esm", + splitting: true, + }), + build({ + ...opts, + entryPoints: ["src/default-node-entry.ts", "src/preview-entry.mjs"], + format: "esm", + outExtension: { ".js": ".mjs" }, + }), +]); diff --git a/packages/adapters/vercel/scripts/importMetaURL.js b/packages/adapters/vercel/scripts/importMetaURL.js new file mode 100644 index 00000000..b1277af3 --- /dev/null +++ b/packages/adapters/vercel/scripts/importMetaURL.js @@ -0,0 +1,2 @@ +import { pathToFileURL } from "url"; +export const __importMetaURL = pathToFileURL(__filename).href; diff --git a/packages/adapters/vercel/src/default-node-entry.ts b/packages/adapters/vercel/src/default-node-entry.ts new file mode 100644 index 00000000..8fbcfec4 --- /dev/null +++ b/packages/adapters/vercel/src/default-node-entry.ts @@ -0,0 +1,7 @@ +import { createMiddleware } from "@marko/run/adapter/middleware"; +import { fetch } from "@marko/run/router"; + +// Vercel's Node.js runtime invokes the default export as a standard +// `(req, res)` request listener. Static assets are served by Vercel's +// filesystem layer, so the function only needs to handle dynamic routes. +export default createMiddleware(fetch); diff --git a/packages/adapters/vercel/src/index.ts b/packages/adapters/vercel/src/index.ts new file mode 100644 index 00000000..29c48c26 --- /dev/null +++ b/packages/adapters/vercel/src/index.ts @@ -0,0 +1,128 @@ +import baseAdapter, { type Adapter } from "@marko/run/adapter"; +import fs from "fs/promises"; +import path from "path"; +import { fileURLToPath } from "url"; + +export type { VercelNodePlatformInfo } from "./types"; + +const __dirname = fileURLToPath(path.dirname(import.meta.url)); +const defaultEntry = path.join(__dirname, "default-node-entry"); +const previewEntry = path.join(__dirname, "preview-entry.mjs"); + +/** Used for the generated Node Serverless Function. */ +const NODE_RUNTIME = "nodejs20.x"; + +export default function vercelAdapter(): Adapter { + const { startDev, startPreview } = baseAdapter(); + + return { + name: "vercel-adapter", + + viteConfig(config) { + if (config.build?.ssr) { + return { + ssr: { + target: "node", + noExternal: true, + }, + }; + } + }, + + getEntryFile() { + return defaultEntry; + }, + + startDev(event) { + return startDev!({ + ...event, + entry: event.entry === defaultEntry ? undefined : event.entry, + }); + }, + + startPreview(event) { + // Ignore the entry the CLI resolved from the build dir — the build + // moved it into `.vercel/output`, which `preview-entry.mjs` serves. + return startPreview!({ ...event, entry: previewEntry }); + }, + + async buildEnd({ config, builtEntries }) { + const serverEntry = builtEntries[0]; + if (!serverEntry) { + return; + } + + // During the client build `outDir` points at the static assets dir + // (`/public`); its parent is the SSR build dir that holds the + // built server entry. + const publicDir = path.resolve(config.root, config.build.outDir); + + // Assemble a Vercel Build Output API (v3) directory. Vercel uses this + // directly when it exists after the build. + // https://vercel.com/docs/build-output-api/v3 + const outputDir = path.join(config.root, ".vercel", "output"); + const staticDir = path.join(outputDir, "static"); + const funcDir = path.join(outputDir, "functions", "index.func"); + + await fs.rm(outputDir, { recursive: true, force: true }); + await fs.mkdir(funcDir, { recursive: true }); + await copyDir(publicDir, staticDir); + + await fs.rename(serverEntry, path.join(funcDir, "index.js")); + await fs.writeFile( + path.join(funcDir, "package.json"), + JSON.stringify({ type: "module" }, null, 2), + ); + await fs.writeFile( + path.join(funcDir, ".vc-config.json"), + JSON.stringify( + { + runtime: NODE_RUNTIME, + handler: "index.js", + launcherType: "Nodejs", + shouldAddHelpers: false, + }, + null, + 2, + ), + ); + + await fs.writeFile( + path.join(outputDir, "config.json"), + JSON.stringify( + { + version: 3, + routes: [ + { handle: "filesystem" }, + { src: "/(.*)", dest: "/index" }, + ], + }, + null, + 2, + ), + ); + }, + + typeInfo(writer) { + writer( + `import type { VercelNodePlatformInfo } from '@marko/run-adapter-vercel';`, + ); + return "VercelNodePlatformInfo"; + }, + }; +} + +/** Recursively copy a directory (kept `fs.cp`-free for older Node support). */ +async function copyDir(from: string, to: string) { + await fs.mkdir(to, { recursive: true }); + const entries = await fs.readdir(from, { withFileTypes: true }); + for (const entry of entries) { + const src = path.join(from, entry.name); + const dest = path.join(to, entry.name); + if (entry.isDirectory()) { + await copyDir(src, dest); + } else { + await fs.copyFile(src, dest); + } + } +} diff --git a/packages/adapters/vercel/src/preview-entry.mjs b/packages/adapters/vercel/src/preview-entry.mjs new file mode 100644 index 00000000..693f1d38 --- /dev/null +++ b/packages/adapters/vercel/src/preview-entry.mjs @@ -0,0 +1,84 @@ +import compression from "compression"; +import fs from "fs"; +import { createServer } from "http"; +import path from "path"; +import createStaticServe from "serve-static"; +import { pathToFileURL } from "url"; +import zlib from "zlib"; + +const { PORT = 3000 } = process.env; + +// `marko-run preview` spawns this entry with the app root as the working +// directory, where the build wrote the Vercel Build Output API directory. +// `vercel dev` cannot serve that output — it rebuilds from source and removes +// `.vercel/output` — so preview emulates the two rules the adapter's generated +// `config.json` describes: serve a matching static asset if one exists (the +// `filesystem` handler), otherwise invoke the function. +const outputDir = path.resolve(".vercel", "output"); +const funcEntry = path.join(outputDir, "functions", "index.func", "index.js"); +const staticDir = path.join(outputDir, "static"); + +if (!fs.existsSync(funcEntry)) { + console.error( + `Vercel build output not found at '${outputDir}'. Run \`marko-run build\` before previewing.`, + ); + process.exit(1); +} + +const compress = compression({ + flush: zlib.constants.Z_PARTIAL_FLUSH, + threshold: 500, +}); + +const servePublic = createStaticServe(staticDir, { + index: false, + redirect: false, + maxAge: "10 minutes", +}); + +const serveAssets = createStaticServe(`${staticDir}/assets`, { + index: false, + redirect: false, + immutable: true, + fallthrough: false, + maxAge: "365 days", +}); + +import(pathToFileURL(funcEntry).href) + .then(({ default: middleware }) => { + createServer((req, res) => + compress(req, res, () => { + if (req.url.startsWith("/assets/")) { + req.url = req.url.slice(7); + serveAssets(req, res, () => { + res.statusCode = 404; + res.end(); + }); + } else { + servePublic(req, res, () => + // The function handles everything itself; `next` only runs when it + // declines the request (unmatched route) or bubbles an error. + middleware(req, res, (err) => { + if (res.writableEnded) { + return; + } + if (err) { + console.error(err); + res.statusCode = 500; + res.end("Internal Server Error"); + } else { + res.statusCode = 404; + res.end("Not Found"); + } + }), + ); + } + }), + ).listen(PORT, () => { + console.log(`Serving Vercel build output at http://localhost:${PORT}`); + }); + }) + .catch((err) => { + console.error("Failed to load Vercel function entry:", err); + process.exit(1); + }); diff --git a/packages/adapters/vercel/src/types.ts b/packages/adapters/vercel/src/types.ts new file mode 100644 index 00000000..437d3ef4 --- /dev/null +++ b/packages/adapters/vercel/src/types.ts @@ -0,0 +1,8 @@ +import type { NodePlatformInfo } from "@marko/run/adapter"; + +/** + * The platform object passed to Marko Run route handlers when deployed as a + * Vercel (Node.js) Serverless Function. Exposes the underlying Node request + * and response objects. + */ +export interface VercelNodePlatformInfo extends NodePlatformInfo {} diff --git a/packages/adapters/vercel/tsconfig.json b/packages/adapters/vercel/tsconfig.json new file mode 100644 index 00000000..ed8bbf1a --- /dev/null +++ b/packages/adapters/vercel/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "include": ["src/**/*"], + "exclude": ["src/**/__tests__/**/*", "src/default-*-entry.ts"], + "compilerOptions": { + "rootDir": "src", + "outDir": "dist", + "tsBuildInfoFile": "dist/.tsbuildinfo" + } +} diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/.gitignore b/packages/run/src/__tests__/fixtures/vercel-adapter-node/.gitignore new file mode 100644 index 00000000..c49ff664 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/.gitignore @@ -0,0 +1,2 @@ +dist +.vercel diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/.marko-run/routes.d.ts b/packages/run/src/__tests__/fixtures/vercel-adapter-node/.marko-run/routes.d.ts new file mode 100644 index 00000000..13e057f6 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/.marko-run/routes.d.ts @@ -0,0 +1,36 @@ +/* + WARNING: This file is automatically generated and any changes made to it will be overwritten without warning. + Do NOT manually edit this file or your changes will be lost. +*/ + +import { NotHandled, NotMatched, GetPaths, PostPaths, GetablePath, GetableHref, PostablePath, PostableHref, Platform } from "@marko/run/namespace"; +import type * as Run from "@marko/run"; +import type { VercelNodePlatformInfo } from '@marko/run-adapter-vercel'; + +declare module "@marko/run" { + interface Platform extends VercelNodePlatformInfo {} + + interface AppData extends Run.DefineApp<{ + routes: { + "/": { verb: "get"; }; + } + }> {} +} + +declare module "../src/routes/+page.marko" { + namespace MarkoRun { + export { NotHandled, NotMatched, GetPaths, PostPaths, GetablePath, GetableHref, PostablePath, PostableHref, Platform }; + export type Route = Run.Routes["/"]; + export type Context = Run.MultiRouteContext & Marko.Global; + export type Handler = Run.HandlerLike; + export type GET = Run.HandlerLike; + export type HEAD = Run.HandlerLike; + export type POST = Run.HandlerLike; + export type PUT = Run.HandlerLike; + export type DELETE = Run.HandlerLike; + export type PATCH = Run.HandlerLike; + export type OPTIONS = Run.HandlerLike; + /** @deprecated use `((context, next) => { ... }) satisfies MarkoRun.Handler` instead */ + export const route: Run.HandlerTypeFn; + } +} diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/dev.expected.md b/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/dev.expected.md new file mode 100644 index 00000000..1ec2ae91 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/dev.expected.md @@ -0,0 +1,35 @@ +# Loading + +```html + +``` + +# Step 0 +ctx=>click(ctx) + +```diff +- 0 ++ 1 + +``` + +# Step 1 +ctx=>click(ctx) + +```diff +- 1 ++ 2 + +``` + +# Step 2 +ctx=>click(ctx) + +```diff +- 2 ++ 3 + +``` + diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/preview.expected.md b/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/preview.expected.md new file mode 100644 index 00000000..1ec2ae91 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/__snapshots__/preview.expected.md @@ -0,0 +1,35 @@ +# Loading + +```html + +``` + +# Step 0 +ctx=>click(ctx) + +```diff +- 0 ++ 1 + +``` + +# Step 1 +ctx=>click(ctx) + +```diff +- 1 ++ 2 + +``` + +# Step 2 +ctx=>click(ctx) + +```diff +- 2 ++ 3 + +``` + diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/package.json b/packages/run/src/__tests__/fixtures/vercel-adapter-node/package.json new file mode 100644 index 00000000..075a7cad --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/package.json @@ -0,0 +1,5 @@ +{ + "name": "vercel-adapter-node", + "version": "1.0.0", + "scripts": {} +} diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/components/counter.marko b/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/components/counter.marko new file mode 100644 index 00000000..436a9eb5 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/components/counter.marko @@ -0,0 +1,11 @@ +class { + declare state: { count: number }; + onCreate() { + this.state = { count: 0 }; + } + handleIncrement() { + this.state.count++; + } +} + + \ No newline at end of file diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/routes/+page.marko b/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/routes/+page.marko new file mode 100644 index 00000000..5dd8370a --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/src/routes/+page.marko @@ -0,0 +1,12 @@ + + + + + @marko/run Test Fixture + + + + + + + diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/test.config.ts b/packages/run/src/__tests__/fixtures/vercel-adapter-node/test.config.ts new file mode 100644 index 00000000..2b2c7170 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/test.config.ts @@ -0,0 +1,11 @@ +import { Step, StepContext } from "../../main.test"; + +export const steps: Step[] = [ + (ctx) => click(ctx), + (ctx) => click(ctx), + (ctx) => click(ctx), +]; + +async function click({ page }: StepContext) { + await page.click("button"); +} diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/tsconfig.json b/packages/run/src/__tests__/fixtures/vercel-adapter-node/tsconfig.json new file mode 100644 index 00000000..03ff88a5 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig-base.json", + "include": ["src/**/*", ".marko-run/*"], +} \ No newline at end of file diff --git a/packages/run/src/__tests__/fixtures/vercel-adapter-node/vite.config.ts b/packages/run/src/__tests__/fixtures/vercel-adapter-node/vite.config.ts new file mode 100644 index 00000000..6bd8def2 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/vercel-adapter-node/vite.config.ts @@ -0,0 +1,10 @@ +import marko from "@marko/run/vite"; +import adapter from "@marko/run-adapter-vercel"; +import { defineConfig } from "vite"; + +export default defineConfig({ + plugins: [marko({ adapter: adapter() })], + server: { + hmr: false, + }, +});