fix: experimental svg types

.changeset/rare-cooks-battle.md

@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Fixes an issue where the `experimental.svg` had incorrect type, resulting in some errors in the editors.

packages/astro/src/assets/utils/svg.ts

@@ -22,7 +22,7 @@ export type SvgRenderMode = 'inline' | 'sprite';
 export function makeSvgComponent(
 	meta: ImageMetadata,
 	contents: Buffer | string,
-	options?: { mode?: SvgRenderMode },
+	options?: { mode: SvgRenderMode },
 ) {
 	const file = typeof contents === 'string' ? contents : contents.toString('utf-8');
 	const { attributes, body: children } = parseSvg(file);

packages/astro/src/core/config/schema.ts

@@ -11,6 +11,7 @@ import type { OutgoingHttpHeaders } from 'node:http';
 import path from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'node:url';
 import { z } from 'zod';
+import type { SvgRenderMode } from '../../assets/utils/svg.js';
 import { EnvSchema } from '../../env/schema.js';
 import type { AstroUserConfig, ViteUserConfig } from '../../types/public/config.js';
 import { appendForwardSlash, prependForwardSlash, removeTrailingForwardSlash } from '../path.js';
@@ -96,9 +97,7 @@ export const ASTRO_CONFIG_DEFAULTS = {
 		clientPrerender: false,
 		contentIntellisense: false,
 		responsiveImages: false,
-		svg: {
-			mode: 'inline',
-		},
+		svg: false,
 	},
 } satisfies AstroUserConfig & { server: { open: boolean } };
 
@@ -541,17 +540,19 @@ export const AstroConfigSchema = z.object({
 				.union([
 					z.boolean(),
 					z.object({
-						mode: z
-							.union([z.literal('inline'), z.literal('sprite')])
-							.optional()
-							.default(ASTRO_CONFIG_DEFAULTS.experimental.svg.mode),
+						mode: z.union([z.literal('inline'), z.literal('sprite')]),
 					}),
 				])
 				.optional()
+				.default(ASTRO_CONFIG_DEFAULTS.experimental.svg)
 				.transform((svgConfig) => {
 					// Handle normalization of `experimental.svg` config boolean values
 					if (typeof svgConfig === 'boolean') {
-						return svgConfig ? ASTRO_CONFIG_DEFAULTS.experimental.svg : undefined;
+						return svgConfig
+							? {
+									mode: 'inline' as SvgRenderMode,
+								}
+							: undefined;
 					}
 					return svgConfig;
 				}),

packages/astro/src/types/public/config.ts

@@ -1940,28 +1940,30 @@ export interface ViteUserConfig extends OriginalViteUserConfig {
 		 * For a complete overview, and to give feedback on this experimental API,
 		 * see the [Feature RFC](https://github.com/withastro/roadmap/pull/1035).
 		 */
-		svg?: {
-			/**
-			 *
-			 * @name experimental.svg.mode
-			 * @type {string}
-			 * @default 'inline'
-			 *
-			 * The default technique for handling imported SVG files. Astro will inline the SVG content into your HTML output if not specified.
-			 *
-			 * - `inline`: Astro will inline the SVG content into your HTML output.
-			 * - `sprite`: Astro will generate a sprite sheet with all imported SVG files.
-			 *
-			 * ```astro
-			 * ---
-			 * import Logo from './path/to/svg/file.svg';
-			 * ---
-			 *
-			 * <Logo size={24} mode="sprite" />
-			 * ```
-			 */
-			mode?: SvgRenderMode;
-		};
+		svg?:
+			| boolean
+			| {
+					/**
+					 *
+					 * @name experimental.svg.mode
+					 * @type {string}
+					 * @default 'inline'
+					 *
+					 * The default technique for handling imported SVG files. Astro will inline the SVG content into your HTML output if not specified.
+					 *
+					 * - `inline`: Astro will inline the SVG content into your HTML output.
+					 * - `sprite`: Astro will generate a sprite sheet with all imported SVG files.
+					 *
+					 * ```astro
+					 * ---
+					 * import Logo from './path/to/svg/file.svg';
+					 * ---
+					 *
+					 * <Logo size={24} mode="sprite" />
+					 * ```
+					 */
+					mode: SvgRenderMode;
+			  };
 	};
 }
 

packages/astro/test/fixtures/core-image-svg/astro.config.mjs

@@ -4,6 +4,6 @@ import { defineConfig } from 'astro/config';
 export default defineConfig({
   integrations: [mdx()],
 	experimental: {
-		svg: {}
+		svg: true
 	}
 });