@sveltejs/kit 3.0.0-next.2 → 3.0.0-next.20

package/src/core/config/options.js

@@ -1,6 +1,7 @@
+/** @import { SvelteConfig } from '@sveltejs/vite-plugin-svelte' */
+/** @import { ValidatedKitConfig } from 'types' */
 /** @import { Validator } from './types.js' */
-
-import process from 'node:process';
+import { styleText } from 'node:util';
 
 const directives = object({
 	'child-src': string_array(),
@@ -36,8 +37,8 @@ const directives = object({
 	referrer: string_array()
 });
 
-/** @type {Validator} */
-const options = object(
+/** @type {Validator<{ extensions: string[] } & SvelteConfig>} */
+export const validate_svelte_options = object(
 	{
 		extensions: validate(['.svelte'], (input, keypath) => {
 			if (!Array.isArray(input) || !input.every((page) => typeof page === 'string')) {
@@ -54,280 +55,281 @@ const options = object(
 				}
 			});
 
+			return input;
+		})
+	},
+	true
+);
+
+const prerender_handler = validate(undefined, (input, keypath) => {
+	if (typeof input === 'function') return input;
+	if (['fail', 'warn', 'ignore'].includes(input)) return input;
+	throw new Error(`${keypath} should be "fail", "warn", "ignore" or a custom function`);
+});
+
+/** @type {Validator<ValidatedKitConfig>} */
+export const validate_kit_options = object({
+	adapter: validate(undefined, (input, keypath) => {
+		if (typeof input !== 'object' || !input.adapt) {
+			const message = `The SvelteKit Vite plugin ${keypath} should be an object with an \`adapt\` method`;
+			throw new Error(`${message}. See https://svelte.dev/docs/kit/adapters`);
+		}
+
+		return input;
+	}),
+
+	alias: deprecate(
+		validate({}, (input, keypath) => {
+			if (typeof input !== 'object') {
+				throw new Error(`${keypath} should be an object`);
+			}
+
+			for (const key in input) {
+				assert_string(input[key], `${keypath}.${key}`);
+			}
+
 			return input;
 		}),
+		(keypath) =>
+			`The \`${keypath}\` option is deprecated, and will be removed in a future version of SvelteKit. Use subpath imports instead: https://svelte.dev/docs/kit/$lib`
+	),
 
-		kit: object({
-			adapter: validate(undefined, (input, keypath) => {
-				if (typeof input !== 'object' || !input.adapt) {
-					const message = `The SvelteKit Vite plugin ${keypath} should be an object with an \`adapt\` method`;
-					throw new Error(`${message}. See https://svelte.dev/docs/kit/adapters`);
-				}
+	appDir: validate('_app', (input, keypath) => {
+		assert_string(input, keypath);
 
-				return input;
-			}),
+		if (input) {
+			if (input.startsWith('/') || input.endsWith('/')) {
+				throw new Error(
+					`${keypath} cannot start or end with '/'. See https://svelte.dev/docs/kit/configuration`
+				);
+			}
+		} else {
+			throw new Error(`${keypath} cannot be empty`);
+		}
+
+		return input;
+	}),
+
+	csp: object({
+		mode: list(['auto', 'hash', 'nonce']),
+		directives,
+		reportOnly: directives
+	}),
+
+	csrf: object({
+		checkOrigin: removed(
+			(keypath) => `\`${keypath}\` has been removed in favour of \`csrf.trustedOrigins\``
+		),
+		trustedOrigins: string_array([])
+	}),
+
+	embedded: boolean(false),
+
+	env: object({
+		dir: string('')
+	}),
+
+	experimental: object({
+		tracing: removed(
+			(keypath) =>
+				`\`${keypath}\` has been removed. Server-side tracing is now configured via \`tracing.server\``
+		),
+		instrumentation: removed(
+			(keypath) =>
+				`\`${keypath}\` has been removed. \`src/instrumentation.server.js\` is now included in the build automatically when it exists; no opt-in is required`
+		),
+		remoteFunctions: boolean(false),
+		forkPreloads: boolean(false),
+		handleRenderingErrors: removed()
+	}),
+
+	files: object({
+		src: string('src'),
+		assets: string('static'),
+		hooks: object({
+			client: string(null),
+			server: string(null),
+			universal: string(null)
+		}),
+		lib: removed(
+			(keypath) =>
+				`\`${keypath}\` has been removed. Use #lib instead of $lib: https://svelte.dev/docs/kit/$lib`
+		),
+		params: string(null),
+		routes: string(null),
+		serviceWorker: string(null),
+		appTemplate: string(null),
+		errorTemplate: string(null)
+	}),
+
+	inlineStyleThreshold: number(0),
+
+	moduleExtensions: string_array(['.js', '.ts']),
+
+	outDir: string('.svelte-kit'),
+
+	output: object({
+		linkHeaderPreload: boolean(false),
+		preloadStrategy: removed(
+			(keypath) => `\`${keypath}\` has been removed. modulepreload will always be used`
+		),
+		bundleStrategy: list(['split', 'single', 'inline'])
+	}),
+
+	paths: object({
+		base: validate('', (input, keypath) => {
+			assert_string(input, keypath);
+
+			if (input !== '' && (input.endsWith('/') || !input.startsWith('/'))) {
+				throw new Error(
+					`${keypath} option must either be the empty string or a root-relative path that starts but doesn't end with '/'. See https://svelte.dev/docs/kit/configuration#paths`
+				);
+			}
 
-			alias: validate({}, (input, keypath) => {
-				if (typeof input !== 'object') {
-					throw new Error(`${keypath} should be an object`);
+			return input;
+		}),
+		assets: validate('', (input, keypath) => {
+			assert_string(input, keypath);
+
+			if (input) {
+				if (!/^[a-z]+:\/\//.test(input)) {
+					throw new Error(
+						`${keypath} option must be an absolute path, if specified. See https://svelte.dev/docs/kit/configuration#paths`
+					);
 				}
 
-				for (const key in input) {
-					assert_string(input[key], `${keypath}.${key}`);
+				if (input.endsWith('/')) {
+					throw new Error(
+						`${keypath} option must not end with '/'. See https://svelte.dev/docs/kit/configuration#paths`
+					);
 				}
+			}
 
-				return input;
-			}),
+			return input;
+		}),
+		origin: validate(undefined, (input, keypath) => {
+			assert_string(input, keypath);
 
-			appDir: validate('_app', (input, keypath) => {
-				assert_string(input, keypath);
+			let url;
 
-				if (input) {
-					if (input.startsWith('/') || input.endsWith('/')) {
-						throw new Error(
-							"config.kit.appDir cannot start or end with '/'. See https://svelte.dev/docs/kit/configuration"
-						);
-					}
-				} else {
-					throw new Error(`${keypath} cannot be empty`);
-				}
+			try {
+				url = new URL(input);
+			} catch {
+				throw new Error(
+					`${keypath} must be a valid origin (e.g. 'https://my-site.com'). '${input}' could not be parsed as a URL`
+				);
+			}
 
-				return input;
-			}),
-
-			csp: object({
-				mode: list(['auto', 'hash', 'nonce']),
-				directives,
-				reportOnly: directives
-			}),
-
-			csrf: object({
-				checkOrigin: removed(
-					(keypath) => `\`${keypath}\` has been removed in favour of \`csrf.trustedOrigins\``
-				),
-				trustedOrigins: string_array([])
-			}),
-
-			embedded: boolean(false),
-
-			env: object({
-				dir: string(process.cwd())
-			}),
-
-			experimental: object({
-				tracing: object({
-					server: boolean(false)
-				}),
-				instrumentation: object({
-					server: boolean(false)
-				}),
-				remoteFunctions: boolean(false),
-				forkPreloads: boolean(false),
-				handleRenderingErrors: boolean(false)
-			}),
-
-			files: object({
-				src: string('src'),
-				assets: string('static'),
-				hooks: object({
-					client: string(null),
-					server: string(null),
-					universal: string(null)
-				}),
-				lib: string(null),
-				params: string(null),
-				routes: string(null),
-				serviceWorker: string(null),
-				appTemplate: string(null),
-				errorTemplate: string(null)
-			}),
-
-			inlineStyleThreshold: number(0),
-
-			moduleExtensions: string_array(['.js', '.ts']),
-
-			outDir: string('.svelte-kit'),
-
-			output: object({
-				linkHeaderPreload: boolean(false),
-				preloadStrategy: removed(
-					(keypath) => `\`${keypath}\` has been removed. modulepreload will always be used`
-				),
-				bundleStrategy: list(['split', 'single', 'inline'])
-			}),
-
-			paths: object({
-				base: validate('', (input, keypath) => {
-					assert_string(input, keypath);
-
-					if (input !== '' && (input.endsWith('/') || !input.startsWith('/'))) {
-						throw new Error(
-							`${keypath} option must either be the empty string or a root-relative path that starts but doesn't end with '/'. See https://svelte.dev/docs/kit/configuration#paths`
-						);
-					}
+			if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+				throw new Error(
+					`${keypath} must be a valid origin — only 'http' and 'https' protocols are supported, received '${url.protocol}'`
+				);
+			}
 
-					return input;
-				}),
-				assets: validate('', (input, keypath) => {
-					assert_string(input, keypath);
-
-					if (input) {
-						if (!/^[a-z]+:\/\//.test(input)) {
-							throw new Error(
-								`${keypath} option must be an absolute path, if specified. See https://svelte.dev/docs/kit/configuration#paths`
-							);
-						}
-
-						if (input.endsWith('/')) {
-							throw new Error(
-								`${keypath} option must not end with '/'. See https://svelte.dev/docs/kit/configuration#paths`
-							);
-						}
-					}
+			const origin = url.origin;
 
-					return input;
-				}),
-				relative: boolean(true)
-			}),
-
-			prerender: object({
-				concurrency: number(1),
-				crawl: boolean(true),
-				entries: validate(['*'], (input, keypath) => {
-					if (!Array.isArray(input) || !input.every((page) => typeof page === 'string')) {
-						throw new Error(`${keypath} must be an array of strings`);
-					}
+			if (input !== origin) {
+				throw new Error(
+					`${keypath} must be a valid origin — received '${input}' which contains a path, query, or hash. Use the bare origin '${origin}' instead`
+				);
+			}
 
-					input.forEach((page) => {
-						if (page !== '*' && page[0] !== '/') {
-							throw new Error(
-								`Each member of ${keypath} must be either '*' or an absolute path beginning with '/' — saw '${page}'`
-							);
-						}
-					});
-
-					return input;
-				}),
-
-				handleHttpError: validate(
-					(/** @type {any} */ { message }) => {
-						throw new Error(
-							message +
-								'\nTo suppress or handle this error, implement `handleHttpError` in https://svelte.dev/docs/kit/configuration#prerender'
-						);
-					},
-					(input, keypath) => {
-						if (typeof input === 'function') return input;
-						if (['fail', 'warn', 'ignore'].includes(input)) return input;
-						throw new Error(`${keypath} should be "fail", "warn", "ignore" or a custom function`);
-					}
-				),
-
-				handleMissingId: validate(
-					(/** @type {any} */ { message }) => {
-						throw new Error(
-							message +
-								'\nTo suppress or handle this error, implement `handleMissingId` in https://svelte.dev/docs/kit/configuration#prerender'
-						);
-					},
-					(input, keypath) => {
-						if (typeof input === 'function') return input;
-						if (['fail', 'warn', 'ignore'].includes(input)) return input;
-						throw new Error(`${keypath} should be "fail", "warn", "ignore" or a custom function`);
-					}
-				),
-
-				handleEntryGeneratorMismatch: validate(
-					(/** @type {any} */ { message }) => {
-						throw new Error(
-							message +
-								'\nTo suppress or handle this error, implement `handleEntryGeneratorMismatch` in https://svelte.dev/docs/kit/configuration#prerender'
-						);
-					},
-					(input, keypath) => {
-						if (typeof input === 'function') return input;
-						if (['fail', 'warn', 'ignore'].includes(input)) return input;
-						throw new Error(`${keypath} should be "fail", "warn", "ignore" or a custom function`);
-					}
-				),
-
-				handleUnseenRoutes: validate(
-					(/** @type {any} */ { message }) => {
-						throw new Error(
-							message +
-								'\nTo suppress or handle this error, implement `handleUnseenRoutes` in https://svelte.dev/docs/kit/configuration#prerender'
-						);
-					},
-					(input, keypath) => {
-						if (typeof input === 'function') return input;
-						if (['fail', 'warn', 'ignore'].includes(input)) return input;
-						throw new Error(`${keypath} should be "fail", "warn", "ignore" or a custom function`);
-					}
-				),
+			return origin;
+		}),
+		relative: boolean(true)
+	}),
 
-				origin: validate('http://sveltekit-prerender', (input, keypath) => {
-					assert_string(input, keypath);
+	prerender: object({
+		concurrency: number(1),
+		crawl: boolean(true),
+		entries: validate(['*'], (input, keypath) => {
+			if (!Array.isArray(input) || !input.every((page) => typeof page === 'string')) {
+				throw new Error(`${keypath} must be an array of strings`);
+			}
 
-					let origin;
+			input.forEach((page) => {
+				if (page !== '*' && page[0] !== '/') {
+					throw new Error(
+						`Each member of ${keypath} must be either '*' or an absolute path beginning with '/' — saw '${page}'`
+					);
+				}
+			});
 
-					try {
-						origin = new URL(input).origin;
-					} catch {
-						throw new Error(`${keypath} must be a valid origin`);
-					}
+			return input;
+		}),
 
-					if (input !== origin) {
-						throw new Error(`${keypath} must be a valid origin (${origin} rather than ${input})`);
-					}
+		handleHttpError: prerender_handler,
+		handleMissingId: prerender_handler,
+		handleEntryGeneratorMismatch: prerender_handler,
+		handleUnseenRoutes: prerender_handler,
+		handleInvalidUrl: prerender_handler,
+
+		origin: removed(
+			(keypath) => `\`${keypath}\` has been removed in favour of \`config.paths.origin\``
+		)
+	}),
+
+	router: object({
+		type: list(['pathname', 'hash']),
+		resolution: list(['client', 'server'])
+	}),
+
+	serviceWorker: object({
+		files: removed(),
+		register: boolean(true),
+		// options could be undefined but if it is defined we only validate that
+		// it's an object since the type comes from the browser itself
+		options: validate(undefined, object({}, true))
+	}),
+
+	tracing: object({
+		server: boolean(false)
+	}),
+
+	typescript: deprecate(
+		object({
+			config: fun((config) => config)
+		}),
+		(keypath) => {
+			return `The \`${keypath}\` option is deprecated, and will be removed in a future version. Add configuration to tsconfig.json directly`;
+		}
+	),
 
-					return origin;
-				})
-			}),
-
-			router: object({
-				type: list(['pathname', 'hash']),
-				resolution: list(['client', 'server'])
-			}),
-
-			serviceWorker: object({
-				register: boolean(true),
-				// options could be undefined but if it is defined we only validate that
-				// it's an object since the type comes from the browser itself
-				options: validate(undefined, object({}, true)),
-				files: fun((filename) => !/\.DS_Store/.test(filename))
-			}),
-
-			typescript: object({
-				config: fun((config) => config)
-			}),
-
-			version: object({
-				name: string(Date.now().toString()),
-				pollInterval: number(0)
-			})
-		})
-	},
-	true
-);
+	version: object({
+		name: string(Date.now().toString()),
+		pollInterval: number(3_600_000)
+	})
+});
 
-// /**
-//  * @param {Validator} fn
-//  * @param {(keypath: string) => string} get_message
-//  * @returns {Validator}
-//  */
-// function deprecate(
-// 	fn,
-// 	get_message = (keypath) =>
-// 		`The \`${keypath}\` option is deprecated, and will be removed in a future version`
-// ) {
-// 	return (input, keypath) => {
-// 		if (input !== undefined) {
-// 			console.warn(styleText(['bold', 'yellow'], get_message(keypath)));
-// 		}
-
-// 		return fn(input, keypath);
-// 	};
-// }
+/**
+ * @param {Validator} fn
+ * @param {(keypath: string) => string} get_message
+ * @returns {Validator}
+ */
+function deprecate(
+	fn,
+	get_message = (keypath) =>
+		`The \`${keypath}\` option is deprecated, and will be removed in a future version`
+) {
+	return (input, keypath) => {
+		if (input !== undefined) {
+			console.warn(styleText(['bold', 'yellow'], get_message(keypath)));
+		}
+
+		return fn(input, keypath);
+	};
+}
+
+// Derive the names of SvelteKit's own config options from the schema, so they
+// stay in sync automatically. These are used to separate Kit's options from
+// `vite-plugin-svelte`'s options when config is passed via the Vite plugin.
+const kit_defaults = validate_kit_options({}, 'config');
+
+/** The names of the options that live under the `kit` namespace */
+export const kit_options = Object.keys(kit_defaults);
+
+/** The names of the options that live under the `kit.experimental` namespace */
+export const kit_experimental_options = Object.keys(kit_defaults.experimental);
 
 /**
  * @param {(keypath: string) => string} get_message
@@ -366,7 +368,7 @@ export function object(children, allow_unknown = false) {
 					let message = `Unexpected option ${keypath}.${key}`;
 
 					// special case
-					if (keypath === 'config.kit' && key in options) {
+					if (keypath === 'config.kit' && key in kit_options) {
 						message += ` (did you mean config.${key}?)`;
 					}
 
@@ -492,5 +494,3 @@ function assert_string(input, keypath) {
 		throw new Error(`${keypath} should be a string, if specified`);
 	}
 }
-
-export default options;

package/src/core/config/types.d.ts

@@ -1 +1 @@
-export type Validator<T = any> = (input: T, keypath: string) => T;
+export type Validator<T = any> = (input: any, keypath: string) => T;