feat: add server endpoint fallback handler

.changeset/moody-ties-impress.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+feat: add catch-all method handler `all`

documentation/docs/20-core-concepts/10-routing.md

@@ -325,6 +325,31 @@ export async function POST({ request }) {
 
 > In general, [form actions](form-actions) are a better way to submit data from the browser to the server.
 
+> If a `GET` handler is exported, a `HEAD` request will return the `content-length` of the `GET` handler's response body.
+
+### Catch-all method
+
+Exporting the `all` handler will match any unhandled request methods, including methods like `MOVE` which have no dedicated export from `+server.js`.
+
+```js
+// @errors: 7031
+/// file: src/routes/api/add/+server.js
+import { json, text } from '@sveltejs/kit';
+
+export async function POST({ request }) {
+	const { a, b } = await request.json();
+	return json(a + b);
+}
+
+// This handler will respond to PUT, PATCH, DELETE, etc.
+/** @type {import('./$types').RequestHandler} */
+export async function all({ request }) {
+	return text(`I caught your ${request.method} request!`);
+}
+```
+
+> The `all` handler will also override the implicit `HEAD` handler that is added when a `GET` handler is exported.
+
 ### Content negotiation
 
 `+server.js` files can be placed in the same directory as `+page` files, allowing the same route to be either a page or an API endpoint. To determine which, SvelteKit applies the following rules:

packages/kit/src/core/postbuild/analyse.js

@@ -69,7 +69,7 @@ async function analyse({ manifest_path, env }) {
 		/** @type {Array<'GET' | 'POST'>} */
 		const page_methods = [];
 
-		/** @type {import('types').HttpMethod[]} */
+		/** @type {(import('types').HttpMethod | '*')[]} */
 		const api_methods = [];
 
 		/** @type {import('types').PrerenderOption | undefined} */
@@ -96,6 +96,8 @@ async function analyse({ manifest_path, env }) {
 			Object.values(mod).forEach((/** @type {import('types').HttpMethod} */ method) => {
 				if (mod[method] && ENDPOINT_METHODS.has(method)) {
 					api_methods.push(method);
+				} else if (mod.all) {
+					api_methods.push('*');
 				}
 			});
 

packages/kit/src/exports/public.d.ts

@@ -1059,15 +1059,15 @@ export interface ResolveOptions {
 export interface RouteDefinition<Config = any> {
 	id: string;
 	api: {
-		methods: HttpMethod[];
+		methods: (HttpMethod | '*')[];
 	};
 	page: {
 		methods: Extract<HttpMethod, 'GET' | 'POST'>[];
 	};
 	pattern: RegExp;
 	prerender: PrerenderOption;
 	segments: RouteSegment[];
-	methods: HttpMethod[];
+	methods: (HttpMethod | '*')[];
 	config: Config;
 }
 

packages/kit/src/runtime/server/endpoint.js

@@ -12,7 +12,7 @@ import { method_not_allowed } from './utils.js';
 export async function render_endpoint(event, mod, state) {
 	const method = /** @type {import('types').HttpMethod} */ (event.request.method);
 
-	let handler = mod[method];
+	let handler = mod[method] || mod.all;
 
 	if (!handler && method === 'HEAD') {
 		handler = mod.GET;

packages/kit/src/types/internal.d.ts

@@ -259,12 +259,12 @@ export interface ServerErrorNode {
 export interface ServerMetadataRoute {
 	config: any;
 	api: {
-		methods: HttpMethod[];
+		methods: (HttpMethod | '*')[];
 	};
 	page: {
 		methods: Array<'GET' | 'POST'>;
 	};
-	methods: HttpMethod[];
+	methods: (HttpMethod | '*')[];
 	prerender: PrerenderOption | undefined;
 	entries: Array<string> | undefined;
 }
@@ -367,6 +367,7 @@ export type SSREndpoint = Partial<Record<HttpMethod, RequestHandler>> & {
 	trailingSlash?: TrailingSlash;
 	config?: any;
 	entries?: PrerenderEntryGenerator;
+	all?: RequestHandler;
 };
 
 export interface SSRRoute {

packages/kit/src/utils/exports.js

@@ -79,6 +79,7 @@ const valid_server_exports = new Set([
 	'DELETE',
 	'OPTIONS',
 	'HEAD',
+	'all',
 	'prerender',
 	'trailingSlash',
 	'config',

packages/kit/src/utils/exports.spec.js

@@ -174,7 +174,7 @@ test('validates +server.js', () => {
 		validate_server_exports({
 			answer: 42
 		});
-	}, "Invalid export 'answer' (valid exports are GET, POST, PATCH, PUT, DELETE, OPTIONS, HEAD, prerender, trailingSlash, config, entries, or anything with a '_' prefix)");
+	}, "Invalid export 'answer' (valid exports are GET, POST, PATCH, PUT, DELETE, OPTIONS, HEAD, all, prerender, trailingSlash, config, entries, or anything with a '_' prefix)");
 
 	check_error(() => {
 		validate_server_exports({

packages/kit/test/apps/basics/src/routes/endpoint-output/all/+server.js

@@ -0,0 +1,7 @@
+export function GET() {
+	return new Response('ok');
+}
+
+export function all() {
+	return new Response('catch-all');
+}

packages/kit/test/apps/basics/test/server.test.js

@@ -225,6 +225,24 @@ test.describe('Endpoints', () => {
 		expect(await endpoint_response.text()).toBe('');
 		expect(endpoint_response.headers()['x-sveltekit-head-endpoint']).toBe('true');
 	});
+
+	test('catch-all handler', async ({ request }) => {
+		const url = '/endpoint-output/all';
+
+		let response = await request.fetch(url, {
+			method: 'GET'
+		});
+
+		expect(response.status()).toBe(200);
+		expect(await response.text()).toBe('ok');
+
+		response = await request.fetch(url, {
+			method: 'OPTIONS'
+		});
+
+		expect(response.status()).toBe(200);
+		expect(await response.text()).toBe('catch-all');
+	});
 });
 
 test.describe('Errors', () => {