@astrojs/starlight 0.41.4 → 0.41.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/starlight
 
+## 0.41.5
+
+### Patch Changes
+
+- [#4095](https://github.com/withastro/starlight/pull/4095) [`bb06434`](https://github.com/withastro/starlight/commit/bb06434a1bc199b59f9d7953d0e41c6c287b1aa2) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a regression when using a union to [extend](https://starlight.astro.build/reference/frontmatter/#extend) Starlight’s `docsSchema()`.
+
 ## 0.41.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.41.4",
+  "version": "0.41.5",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",

package/schema.ts

@@ -115,7 +115,8 @@ const StarlightFrontmatterSchema = (context: SchemaContext) =>
 type DefaultSchema = ReturnType<typeof StarlightFrontmatterSchema>;
 
 /** Base subset of Zod types that we support passing to the `extend` option. */
-type BaseSchema<T extends z.ZodRawShape = z.ZodRawShape> = z.ZodObject<T>;
+type BaseObjectSchema = z.ZodObject<z.ZodRawShape, z.core.$ZodObjectConfig>;
+type BaseSchema = BaseObjectSchema | z.ZodUnion<readonly BaseObjectSchema[]>;
 
 /** Type that extends Starlight’s default schema with an optional, user-defined schema. */
 type ExtendedSchema<T extends BaseSchema = never> = [T] extends [never]

package/utils/zodDeepMerge.ts

@@ -10,17 +10,19 @@ export type DeepMergedSchema<Default extends z.core.$ZodType, User extends z.cor
 				? z.ZodDefault<DeepMergedSchema<UnwrappedSchema<Default>, WrappedSchema>>
 				: User extends z.ZodPrefault<infer WrappedSchema extends z.core.$ZodType>
 					? z.ZodPrefault<DeepMergedSchema<UnwrappedSchema<Default>, WrappedSchema>>
-					: UnwrappedSchema<Default> extends z.ZodObject<infer DefaultShape>
-						? User extends z.ZodObject<infer UserShape, infer UserConfig>
-							? z.ZodObject<DeepMergedShape<DefaultShape, UserShape>, UserConfig>
-							: User
-						: UnwrappedSchema<Default> extends z.ZodArray<
-									infer DefaultItemSchema extends z.core.$ZodType
-							  >
-							? User extends z.ZodArray<infer UserItemSchema extends z.core.$ZodType>
-								? z.ZodArray<DeepMergedSchema<DefaultItemSchema, UserItemSchema>>
+					: User extends z.ZodUnion<infer Users extends readonly z.core.$ZodType[]>
+						? z.ZodUnion<DeepMergedUnionMembers<UnwrappedSchema<Default>, Users>>
+						: UnwrappedSchema<Default> extends z.ZodObject<infer DefaultShape>
+							? User extends z.ZodObject<infer UserShape, infer UserConfig>
+								? z.ZodObject<DeepMergedShape<DefaultShape, UserShape>, UserConfig>
 								: User
-							: User;
+							: UnwrappedSchema<Default> extends z.ZodArray<
+										infer DefaultItemSchema extends z.core.$ZodType
+								  >
+								? User extends z.ZodArray<infer UserItemSchema extends z.core.$ZodType>
+									? z.ZodArray<DeepMergedSchema<DefaultItemSchema, UserItemSchema>>
+									: User
+								: User;
 
 /** Type-level equivalent of {@link unwrapSchema}. */
 type UnwrappedSchema<T extends z.core.$ZodType> =
@@ -48,6 +50,16 @@ type DeepMergedShape<Default extends z.ZodRawShape, User extends z.ZodRawShape>
 			: never;
 };
 
+/** Merged union schemas where each union member is deep-merged with the default schema. */
+type DeepMergedUnionMembers<
+	Default extends z.core.$ZodType,
+	Users extends readonly z.core.$ZodType[],
+> = {
+	[Key in keyof Users]: Users[Key] extends z.core.$ZodType
+		? DeepMergedSchema<Default, Users[Key]>
+		: Users[Key];
+};
+
 export function deepMergeSchemas(defaultSchema: z.ZodType, userSchema: z.ZodType): z.ZodType {
 	const unwrappedDefaultSchema = unwrapSchema(defaultSchema);
 
@@ -58,6 +70,13 @@ export function deepMergeSchemas(defaultSchema: z.ZodType, userSchema: z.ZodType
 		} as Parameters<typeof userSchema.clone>[0]);
 	}
 
+	if (isZodUnion(userSchema)) {
+		return userSchema.clone({
+			...userSchema._zod.def,
+			options: userSchema.options.map((schema) => deepMergeSchemas(unwrappedDefaultSchema, schema)),
+		});
+	}
+
 	if (isZodObject(unwrappedDefaultSchema) && isZodObject(userSchema)) {
 		const shape: z.core.$ZodLooseShape = { ...unwrappedDefaultSchema.shape };
 
@@ -119,3 +138,7 @@ function isZodObject(schema: z.ZodType): schema is z.ZodObject<z.ZodRawShape> {
 function isZodArray(schema: z.ZodType): schema is z.ZodArray<z.ZodType> {
 	return schema._zod.def.type === 'array';
 }
+
+function isZodUnion(schema: z.ZodType): schema is z.ZodUnion<readonly z.ZodType[]> {
+	return schema._zod.def.type === 'union';
+}