@octanejs/adapter-vercel 0.0.2 → 0.0.3

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@octanejs/adapter-vercel",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "MIT",
   "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
   "description": "Vercel adapter for octane apps (Build Output API v3)",
   "author": {
     "name": "Dominic Gannaway",
@@ -16,6 +19,10 @@
     "url": "git+https://github.com/octanejs/octane.git",
     "directory": "packages/adapter-vercel"
   },
+  "files": [
+    "src",
+    "types"
+  ],
   "module": "src/index.js",
   "main": "src/index.js",
   "exports": {
@@ -25,8 +32,11 @@
       "default": "./src/index.js"
     }
   },
+  "peerDependencies": {
+    "@octanejs/app-core": "0.0.2"
+  },
   "devDependencies": {
     "@types/node": "^24.3.0",
-    "@octanejs/vite-plugin": "0.1.4"
+    "@octanejs/app-core": "0.0.2"
   }
 }

package/src/adapt.js

@@ -3,7 +3,7 @@
  * Vercel Build Output API v3 emitter.
  *
  * Restructures an octane production build (`dist/client` + `dist/server`,
- * produced by @octanejs/vite-plugin) into `.vercel/output/`:
+ * produced by an Octane app integration) into `.vercel/output/`:
  *
  *   static/               ← dist/client verbatim (hashed assets; the build
  *                           already moved index.html — the SSR template —
@@ -21,13 +21,15 @@
  */
 
 /** @import { VercelAdapterOptions, VercelConfig, VercelRoute } from '@octanejs/adapter-vercel' */
-/** @import { AdaptContext } from '@octanejs/vite-plugin' */
+/** @import { AdaptContext } from '@octanejs/app-core' */
 
 import { existsSync, mkdirSync, cpSync, writeFileSync, rmSync } from 'node:fs';
 import { join, dirname } from 'node:path';
 import { createRequire } from 'node:module';
 
 const VERCEL_OUTPUT_DIR = '.vercel/output';
+const VALID_NODE_MAJORS = [22, 24];
+const VALID_NODE_RUNTIMES = new Set(VALID_NODE_MAJORS.map((major) => `nodejs${major}.x`));
 
 /**
  * The adapter's own version (for .vc-config.json `framework`). MUST stay lazy:
@@ -51,16 +53,32 @@ function get_adapter_version() {
  */
 function get_default_runtime() {
 	const major = Number(process.version.slice(1).split('.')[0]);
-	const valid = [20, 22, 24];
-	if (!valid.includes(major)) {
+	if (!VALID_NODE_MAJORS.includes(major)) {
 		throw new Error(
 			`[@octanejs/adapter-vercel] Unsupported Node.js version: ${process.version}. ` +
-				`Build with Node ${valid.join('/')} or set serverless.runtime explicitly.`,
+				`Build with Node ${VALID_NODE_MAJORS.join('/')} or set serverless.runtime to ` +
+				'nodejs22.x/nodejs24.x explicitly.',
 		);
 	}
 	return `nodejs${major}.x`;
 }
 
+/**
+ * Reject deployment runtimes outside Octane's supported Node.js baseline.
+ * An explicit runtime still lets a newer build machine target Node 22 or 24.
+ * @param {string} runtime
+ * @returns {string}
+ */
+function validate_runtime(runtime) {
+	if (!VALID_NODE_RUNTIMES.has(runtime)) {
+		throw new Error(
+			`[@octanejs/adapter-vercel] Unsupported serverless runtime: ${runtime}. ` +
+				'Use nodejs22.x or nodejs24.x.',
+		);
+	}
+	return runtime;
+}
+
 /**
  * @param {string} file_path
  * @param {string} data
@@ -113,12 +131,15 @@ function generate_vercel_config(options) {
 		});
 	}
 
-	// Hashed build assets are immutable by construction.
-	routes.push({
-		src: '/assets/.+',
-		headers: { 'Cache-Control': 'public, max-age=31536000, immutable' },
-		continue: true,
-	});
+	// Hashed build assets are immutable by construction. Vite emits them under
+	// /assets, while Rsbuild uses /static by default.
+	for (const assetDirectory of ['assets', 'static']) {
+		routes.push({
+			src: `/${assetDirectory}/.+`,
+			headers: { 'Cache-Control': 'public, max-age=31536000, immutable' },
+			continue: true,
+		});
+	}
 
 	for (const header of headers) {
 		routes.push({
@@ -144,7 +165,7 @@ function generate_vercel_config(options) {
 /**
  * Emit `.vercel/output` from a completed octane build.
  *
- * Callable two ways: by @octanejs/vite-plugin's closeBundle (which passes its
+ * Callable two ways: by an app integration's post-build hook (which passes its
  * {@link AdaptContext}) or directly with explicit dirs.
  *
  * @param {AdaptContext} ctx
@@ -162,6 +183,7 @@ export async function adapt(ctx, options = {}) {
 	if (!existsSync(server_entry)) {
 		throw new Error(`[@octanejs/adapter-vercel] Server entry not found at ${server_entry}.`);
 	}
+	const runtime = validate_runtime(options.serverless?.runtime ?? get_default_runtime());
 
 	const output_dir = join(root, VERCEL_OUTPUT_DIR);
 	rmSync(output_dir, { recursive: true, force: true });
@@ -181,27 +203,30 @@ export async function adapt(ctx, options = {}) {
 	write(join(func_dir, 'index.js'), generate_handler_source());
 	write(join(func_dir, 'package.json'), JSON.stringify({ type: 'module' }));
 
-	const runtime = options.serverless?.runtime ?? get_default_runtime();
 	/** @type {Record<string, unknown>} */
 	const vc_config = {
 		runtime,
 		handler: 'index.js',
 		launcherType: 'Nodejs',
-		experimentalResponseStreaming: true,
+		supportsResponseStreaming: true,
 		framework: { slug: 'octane', version: get_adapter_version() },
 	};
 	if (options.serverless?.regions) vc_config.regions = options.serverless.regions;
 	if (options.serverless?.memory) vc_config.memory = options.serverless.memory;
 	if (options.serverless?.maxDuration) vc_config.maxDuration = options.serverless.maxDuration;
 
-	// ISR: cache the function's response at the edge, revalidate after
-	// `expiration` seconds (false = never expire).
+	// ISR belongs in an ADJACENT prerender-config file, not in the function's
+	// .vc-config.json. Build Output API associates functions/index.func with
+	// functions/index.prerender-config.json by basename.
 	if (options.isr) {
 		/** @type {Record<string, unknown>} */
 		const prerender = { expiration: options.isr.expiration };
 		if (options.isr.bypassToken) prerender.bypassToken = options.isr.bypassToken;
 		if (options.isr.allowQuery !== undefined) prerender.allowQuery = options.isr.allowQuery;
-		vc_config.prerender = prerender;
+		write(
+			join(output_dir, 'functions', 'index.prerender-config.json'),
+			JSON.stringify(prerender, null, '\t'),
+		);
 	}
 
 	write(join(func_dir, '.vc-config.json'), JSON.stringify(vc_config, null, '\t'));

package/src/index.js

@@ -10,8 +10,8 @@
  *     router: { … },
  *   });
  *
- * `vercel(options)` returns the plugin's adapter contract: after `vite build`
- * produces both bundles, @octanejs/vite-plugin calls `adapt(ctx)` and this
+ * `vercel(options)` returns the shared adapter contract: after a production
+ * build produces both bundles, the active integration calls `adapt(ctx)` and this
  * adapter restructures them into Vercel's Build Output API v3 under
  * `.vercel/output/` — no vercel.json rewrites, no hand-written api/ function.
  * The same contract shape (`{ name, adapt }`) is what a Cloudflare/Netlify
@@ -24,7 +24,7 @@
  */
 
 /** @import { VercelAdapterOptions } from '@octanejs/adapter-vercel' */
-/** @import { OctaneAdapter } from '@octanejs/vite-plugin' */
+/** @import { OctaneAdapter } from '@octanejs/app-core' */
 
 import { adapt } from './adapt.js';
 

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import type { OctaneAdapter, AdaptContext } from '@octanejs/vite-plugin';
+import type { OctaneAdapter, AdaptContext } from '@octanejs/app-core';
 
 // ============================================================================
 // Adapter options
@@ -8,9 +8,9 @@ import type { OctaneAdapter, AdaptContext } from '@octanejs/vite-plugin';
 export interface ServerlessConfig {
 	/**
 	 * Node.js runtime version for the function.
-	 * @default auto-detected from the build machine's Node major (20/22/24)
+	 * @default auto-detected from the build machine's Node major (22/24)
 	 */
-	runtime?: string;
+	runtime?: 'nodejs22.x' | 'nodejs24.x';
 	/** Regions to deploy the function to (e.g. ['iad1']). */
 	regions?: string[];
 	/** Maximum execution duration in seconds. */
@@ -69,8 +69,8 @@ export interface VercelConfig {
 // ============================================================================
 
 /**
- * The octane.config.ts adapter: @octanejs/vite-plugin runs its `adapt()` after
- * `vite build` produces dist/client + dist/server, emitting `.vercel/output/`
+ * The octane.config.ts adapter: the active app integration runs its `adapt()`
+ * after producing dist/client + dist/server, emitting `.vercel/output/`
  * (Build Output API v3).
  */
 export function vercel(options?: VercelAdapterOptions): OctaneAdapter;

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @octanejs/adapter-vercel
-
-## 0.0.2
-
-### Patch Changes
-
-- 6d332ad: New package: Vercel adapter (Build Output API v3). `adapter: vercel()` in octane.config.ts makes `vite build` emit `.vercel/output` — the hashed client assets as static files plus one self-contained Node serverless function wrapping the SSR handler (the plugin's server bundle is self-contained, so no dependency tracing is needed). Options cover the serverless function (runtime/regions/memory/maxDuration), ISR, cleanUrls/trailingSlash, extra headers, and redirects; routing is filesystem-first with everything else — including the 404 catch-all — server-rendered by the function.

package/tests/adapt.test.ts

@@ -1,100 +0,0 @@
-// @vitest-environment node
-//
-// adapt() emitter test — feeds a fake completed octane build (the dist/client +
-// dist/server layout @octanejs/vite-plugin produces) through adapt() and
-// asserts the emitted `.vercel/output` is valid Build Output API v3: static
-// assets, one self-contained Node function, and the routing config. The
-// emitted function entry is then actually imported and invoked. The end-to-end
-// wiring (closeBundle → adapt via `adapter: vercel()`) is covered by the
-// website's ssr-smoke test, which runs the real `vite build`.
-import { describe, it, expect, beforeAll, afterAll } from 'vitest';
-import fs from 'node:fs';
-import path from 'node:path';
-import { pathToFileURL, fileURLToPath } from 'node:url';
-import { adapt } from '../src/index.js';
-
-// The tests dir doubles as the fake project root: the fake build goes in
-// `dist/` and adapt() writes `.vercel/output/` next to it — both gitignored.
-const root = fileURLToPath(new URL('.', import.meta.url));
-const clientDir = path.join(root, 'dist/client');
-const serverDir = path.join(root, 'dist/server');
-const outputDir = path.join(root, '.vercel/output');
-const funcDir = path.join(outputDir, 'functions/index.func');
-
-// A stand-in for the plugin's self-contained server bundle: same shape (fetch
-// `handler` export next to the SSR template), no dependencies.
-const FAKE_ENTRY = `export const handler = async (req) => new Response('ok:' + new URL(req.url).pathname);\n`;
-
-function write(file: string, data: string) {
-	fs.mkdirSync(path.dirname(file), { recursive: true });
-	fs.writeFileSync(file, data);
-}
-
-beforeAll(async () => {
-	fs.rmSync(path.join(root, 'dist'), { recursive: true, force: true });
-	fs.rmSync(path.join(root, '.vercel'), { recursive: true, force: true });
-
-	write(path.join(clientDir, 'assets/app-abc.js'), 'console.log("app");\n');
-	write(path.join(serverDir, 'entry.js'), FAKE_ENTRY);
-	write(path.join(serverDir, 'index.html'), '<!doctype html><html><!--ssr-body--></html>\n');
-
-	await adapt({ root, outDir: 'dist', clientDir, serverDir, log: () => {} });
-});
-
-afterAll(() => {
-	fs.rmSync(path.join(root, 'dist'), { recursive: true, force: true });
-	fs.rmSync(path.join(root, '.vercel'), { recursive: true, force: true });
-});
-
-describe('adapt()', () => {
-	it('emits Build Output API v3 routing config', () => {
-		const config = JSON.parse(fs.readFileSync(path.join(outputDir, 'config.json'), 'utf-8'));
-		expect(config.version).toBe(3);
-
-		// Static files first, then EVERYTHING else (including the 404 catch-all
-		// route) goes to the SSR function.
-		const filesystemIndex = config.routes.findIndex(
-			(r: Record<string, unknown>) => r.handle === 'filesystem',
-		);
-		const catchAllIndex = config.routes.findIndex(
-			(r: Record<string, unknown>) => r.src === '/.*' && r.dest === '/index',
-		);
-		expect(filesystemIndex).toBeGreaterThanOrEqual(0);
-		expect(catchAllIndex).toBe(filesystemIndex + 1);
-
-		// Hashed assets are immutable, applied BEFORE the filesystem handler.
-		const assetsRoute = config.routes.find((r: Record<string, unknown>) => r.src === '/assets/.+');
-		expect(assetsRoute).toMatchObject({
-			headers: { 'Cache-Control': 'public, max-age=31536000, immutable' },
-			continue: true,
-		});
-		expect(config.routes.indexOf(assetsRoute)).toBeLessThan(filesystemIndex);
-	});
-
-	it('copies the client bundle to static/ (no index.html to shadow SSR)', () => {
-		expect(fs.existsSync(path.join(outputDir, 'static/assets/app-abc.js'))).toBe(true);
-		expect(fs.existsSync(path.join(outputDir, 'static/index.html'))).toBe(false);
-	});
-
-	it('emits the serverless function: dist/server verbatim + wrapper + config', () => {
-		for (const file of ['index.js', 'entry.js', 'index.html', '.vc-config.json', 'package.json']) {
-			expect(fs.existsSync(path.join(funcDir, file)), file).toBe(true);
-		}
-
-		const vcConfig = JSON.parse(fs.readFileSync(path.join(funcDir, '.vc-config.json'), 'utf-8'));
-		expect(vcConfig.handler).toBe('index.js');
-		expect(vcConfig.launcherType).toBe('Nodejs');
-		expect(vcConfig.runtime).toMatch(/^nodejs(20|22|24)\.x$/);
-
-		// The wrapper imports as ESM — the function dir must say so.
-		const pkg = JSON.parse(fs.readFileSync(path.join(funcDir, 'package.json'), 'utf-8'));
-		expect(pkg.type).toBe('module');
-	});
-
-	it('emitted function entry serves requests through the bundled handler', async () => {
-		const mod = await import(pathToFileURL(path.join(funcDir, 'index.js')).href);
-		const response = await mod.default.fetch(new Request('http://x/hello'));
-		expect(response.status).toBe(200);
-		expect(await response.text()).toBe('ok:/hello');
-	});
-});

package/tsconfig.typecheck.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "target": "es2022",
-    "lib": ["esnext", "dom", "dom.iterable"],
-    "noEmit": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "resolveJsonModule": true,
-    "allowSyntheticDefaultImports": true,
-    "types": ["node"],
-    "allowJs": true,
-    "checkJs": false
-  },
-  "include": ["src/**/*", "types/**/*", "tests/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}