@astrojs/starlight 0.28.2 → 0.28.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @astrojs/starlight
 
+## 0.28.3
+
+### Patch Changes
+
+- [#2408](https://github.com/withastro/starlight/pull/2408) [`0b4823d`](https://github.com/withastro/starlight/commit/0b4823d534abe517fac5efd97f6febb5965714fe) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a link formatting issue when using the Astro `build.format` option set to `file` with a `base`.
+
+- [#2380](https://github.com/withastro/starlight/pull/2380) [`7b451cf`](https://github.com/withastro/starlight/commit/7b451cff6979bef1c817f3a84392221ac884ba3d) Thanks [@delucis](https://github.com/delucis)! - Loosen Starlight’s i18n schema to pass through unknown keys
+
+- [#2388](https://github.com/withastro/starlight/pull/2388) [`6bba3d8`](https://github.com/withastro/starlight/commit/6bba3d8e02b95ecee7f9c945b6ee33b4c4ba755d) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential type-checking issue in Starlight projects.
+
+- [#2443](https://github.com/withastro/starlight/pull/2443) [`a0f40b3`](https://github.com/withastro/starlight/commit/a0f40b3c3c7ab0cb9f0f5f11b94e3679547f6ab4) Thanks [@kevinzunigacuellar](https://github.com/kevinzunigacuellar)! - Fixes CSS issue where bottom padding is not applied in the search dialog.
+
 ## 0.28.2
 
 ### Patch Changes

package/components/Search.astro

@@ -231,6 +231,8 @@ const pagefindTranslations = {
 	}
 
 	.dialog-frame {
+		position: relative;
+		overflow: auto;
 		flex-direction: column;
 		flex-grow: 1;
 		gap: 1rem;

package/index.ts

@@ -5,6 +5,7 @@
  */
 /// <reference path="./locals.d.ts" />
 /// <reference path="./i18n.d.ts" />
+/// <reference path="./virtual.d.ts" />
 
 import mdx from '@astrojs/mdx';
 import type { AstroIntegration } from 'astro';

package/package.json

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

package/schemas/i18n.ts

@@ -23,16 +23,28 @@ const defaultI18nSchema = () =>
 /** Type of Starlight’s default i18n schema, including extensions from Pagefind and Expressive Code. */
 type DefaultI18nSchema = ReturnType<typeof defaultI18nSchema>;
 
+/**
+ * Based on the the return type of Zod’s `merge()` method. Merges the type of two `z.object()` schemas.
+ * Also sets them as “passthrough” schemas as that’s how we use them. In practice whether or not the types
+ * are passthrough or not doesn’t matter too much.
+ *
+ * @see https://github.com/colinhacks/zod/blob/3032e240a0c227692bb96eedf240ed493c53f54c/src/types.ts#L2656-L2660
+ */
+type MergeSchemas<A extends z.AnyZodObject, B extends z.AnyZodObject> = z.ZodObject<
+	z.objectUtil.extendShape<A['shape'], B['shape']>,
+	'passthrough',
+	B['_def']['catchall']
+>;
 /** Type that extends Starlight’s default i18n schema with an optional, user-defined schema. */
 type ExtendedSchema<T extends z.AnyZodObject> = T extends z.AnyZodObject
-	? z.ZodIntersection<DefaultI18nSchema, T>
+	? MergeSchemas<DefaultI18nSchema, T>
 	: DefaultI18nSchema;
 
 /** Content collection schema for Starlight’s optional `i18n` collection. */
 export function i18nSchema<T extends z.AnyZodObject = z.ZodObject<{}>>({
 	extend = z.object({}) as T,
 }: i18nSchemaOpts<T> = {}): ExtendedSchema<T> {
-	return defaultI18nSchema().merge(extend) as ExtendedSchema<T>;
+	return defaultI18nSchema().merge(extend).passthrough() as ExtendedSchema<T>;
 }
 export type i18nSchemaOutput = z.output<ReturnType<typeof i18nSchema>>;
 

package/utils/createPathFormatter.ts

@@ -40,12 +40,12 @@ function formatPath(
 	const formatStrategy = formatStrategies[format];
 	const trailingSlashStrategy = trailingSlashStrategies[trailingSlash];
 
-	// Add base
-	href = formatStrategy.addBase(href);
-
 	// Handle extension
 	href = formatStrategy.handleExtension(href);
 
+	// Add base
+	href = formatStrategy.addBase(href);
+
 	// Skip trailing slash handling for `build.format: 'file'`
 	if (format === 'file') return href;
 

package/virtual-internal.d.ts

@@ -0,0 +1,149 @@
+declare module 'virtual:starlight/project-context' {
+	const ProjectContext: {
+		root: string;
+		srcDir: string;
+		trailingSlash: import('astro').AstroConfig['trailingSlash'];
+		build: {
+			format: import('astro').AstroConfig['build']['format'];
+		};
+	};
+	export default ProjectContext;
+}
+
+declare module 'virtual:starlight/git-info' {
+	export function getNewestCommitDate(file: string): Date;
+}
+
+declare module 'virtual:starlight/user-css' {}
+
+declare module 'virtual:starlight/user-images' {
+	type ImageMetadata = import('astro').ImageMetadata;
+	export const logos: {
+		dark?: ImageMetadata;
+		light?: ImageMetadata;
+	};
+}
+
+declare module 'virtual:starlight/collection-config' {
+	export const collections: import('astro:content').ContentConfig['collections'] | undefined;
+}
+
+declare module 'virtual:starlight/components/Banner' {
+	const Banner: typeof import('./components/Banner.astro').default;
+	export default Banner;
+}
+declare module 'virtual:starlight/components/ContentPanel' {
+	const ContentPanel: typeof import('./components/ContentPanel.astro').default;
+	export default ContentPanel;
+}
+declare module 'virtual:starlight/components/PageTitle' {
+	const PageTitle: typeof import('./components/PageTitle.astro').default;
+	export default PageTitle;
+}
+declare module 'virtual:starlight/components/FallbackContentNotice' {
+	const FallbackContentNotice: typeof import('./components/FallbackContentNotice.astro').default;
+	export default FallbackContentNotice;
+}
+declare module 'virtual:starlight/components/DraftContentNotice' {
+	const DraftContentNotice: typeof import('./components/DraftContentNotice.astro').default;
+	export default DraftContentNotice;
+}
+
+declare module 'virtual:starlight/components/Footer' {
+	const Footer: typeof import('./components/Footer.astro').default;
+	export default Footer;
+}
+declare module 'virtual:starlight/components/LastUpdated' {
+	const LastUpdated: typeof import('./components/LastUpdated.astro').default;
+	export default LastUpdated;
+}
+declare module 'virtual:starlight/components/Pagination' {
+	const Pagination: typeof import('./components/Pagination.astro').default;
+	export default Pagination;
+}
+declare module 'virtual:starlight/components/EditLink' {
+	const EditLink: typeof import('./components/EditLink.astro').default;
+	export default EditLink;
+}
+
+declare module 'virtual:starlight/components/Header' {
+	const Header: typeof import('./components/Header.astro').default;
+	export default Header;
+}
+declare module 'virtual:starlight/components/LanguageSelect' {
+	const LanguageSelect: typeof import('./components/LanguageSelect.astro').default;
+	export default LanguageSelect;
+}
+declare module 'virtual:starlight/components/Search' {
+	const Search: typeof import('./components/Search.astro').default;
+	export default Search;
+}
+declare module 'virtual:starlight/components/SiteTitle' {
+	const SiteTitle: typeof import('./components/SiteTitle.astro').default;
+	export default SiteTitle;
+}
+declare module 'virtual:starlight/components/SocialIcons' {
+	const SocialIcons: typeof import('./components/SocialIcons.astro').default;
+	export default SocialIcons;
+}
+declare module 'virtual:starlight/components/ThemeSelect' {
+	const ThemeSelect: typeof import('./components/ThemeSelect.astro').default;
+	export default ThemeSelect;
+}
+
+declare module 'virtual:starlight/components/Head' {
+	const Head: typeof import('./components/Head.astro').default;
+	export default Head;
+}
+declare module 'virtual:starlight/components/Hero' {
+	const Hero: typeof import('./components/Hero.astro').default;
+	export default Hero;
+}
+declare module 'virtual:starlight/components/MarkdownContent' {
+	const MarkdownContent: typeof import('./components/MarkdownContent.astro').default;
+	export default MarkdownContent;
+}
+
+declare module 'virtual:starlight/components/PageSidebar' {
+	const PageSidebar: typeof import('./components/PageSidebar.astro').default;
+	export default PageSidebar;
+}
+declare module 'virtual:starlight/components/TableOfContents' {
+	const TableOfContents: typeof import('./components/TableOfContents.astro').default;
+	export default TableOfContents;
+}
+declare module 'virtual:starlight/components/MobileTableOfContents' {
+	const MobileTableOfContents: typeof import('./components/MobileTableOfContents.astro').default;
+	export default MobileTableOfContents;
+}
+
+declare module 'virtual:starlight/components/Sidebar' {
+	const Sidebar: typeof import('./components/Sidebar.astro').default;
+	export default Sidebar;
+}
+declare module 'virtual:starlight/components/SkipLink' {
+	const SkipLink: typeof import('./components/SkipLink.astro').default;
+	export default SkipLink;
+}
+declare module 'virtual:starlight/components/ThemeProvider' {
+	const ThemeProvider: typeof import('./components/ThemeProvider.astro').default;
+	export default ThemeProvider;
+}
+
+declare module 'virtual:starlight/components/PageFrame' {
+	const PageFrame: typeof import('./components/PageFrame.astro').default;
+	export default PageFrame;
+}
+declare module 'virtual:starlight/components/MobileMenuToggle' {
+	const MobileMenuToggle: typeof import('./components/MobileMenuToggle.astro').default;
+	export default MobileMenuToggle;
+}
+declare module 'virtual:starlight/components/MobileMenuFooter' {
+	const MobileMenuFooter: typeof import('./components/MobileMenuFooter.astro').default;
+	export default MobileMenuFooter;
+}
+
+declare module 'virtual:starlight/components/TwoColumnContent' {
+	const TwoColumnContent: typeof import('./components/TwoColumnContent.astro').default;
+	export default TwoColumnContent;
+}

package/virtual.d.ts

@@ -2,157 +2,8 @@ declare module 'virtual:starlight/user-config' {
 	const Config: import('./types').StarlightConfig;
 	export default Config;
 }
-declare module 'virtual:starlight/project-context' {
-	const ProjectContext: {
-		root: string;
-		srcDir: string;
-		trailingSlash: import('astro').AstroConfig['trailingSlash'];
-		build: {
-			format: import('astro').AstroConfig['build']['format'];
-		};
-	};
-	export default ProjectContext;
-}
-
-declare module 'virtual:starlight/git-info' {
-	export function getNewestCommitDate(file: string): Date;
-}
-
-declare module 'virtual:starlight/user-css' {}
-
-declare module 'virtual:starlight/user-images' {
-	type ImageMetadata = import('astro').ImageMetadata;
-	export const logos: {
-		dark?: ImageMetadata;
-		light?: ImageMetadata;
-	};
-}
 
 declare module 'virtual:starlight/plugin-translations' {
 	const PluginTranslations: import('./utils/plugins').PluginTranslations;
 	export default PluginTranslations;
 }
-
-declare module 'virtual:starlight/collection-config' {
-	export const collections: import('astro:content').ContentConfig['collections'] | undefined;
-}
-
-declare module 'virtual:starlight/components/Banner' {
-	const Banner: typeof import('./components/Banner.astro').default;
-	export default Banner;
-}
-declare module 'virtual:starlight/components/ContentPanel' {
-	const ContentPanel: typeof import('./components/ContentPanel.astro').default;
-	export default ContentPanel;
-}
-declare module 'virtual:starlight/components/PageTitle' {
-	const PageTitle: typeof import('./components/PageTitle.astro').default;
-	export default PageTitle;
-}
-declare module 'virtual:starlight/components/FallbackContentNotice' {
-	const FallbackContentNotice: typeof import('./components/FallbackContentNotice.astro').default;
-	export default FallbackContentNotice;
-}
-declare module 'virtual:starlight/components/DraftContentNotice' {
-	const DraftContentNotice: typeof import('./components/DraftContentNotice.astro').default;
-	export default DraftContentNotice;
-}
-
-declare module 'virtual:starlight/components/Footer' {
-	const Footer: typeof import('./components/Footer.astro').default;
-	export default Footer;
-}
-declare module 'virtual:starlight/components/LastUpdated' {
-	const LastUpdated: typeof import('./components/LastUpdated.astro').default;
-	export default LastUpdated;
-}
-declare module 'virtual:starlight/components/Pagination' {
-	const Pagination: typeof import('./components/Pagination.astro').default;
-	export default Pagination;
-}
-declare module 'virtual:starlight/components/EditLink' {
-	const EditLink: typeof import('./components/EditLink.astro').default;
-	export default EditLink;
-}
-
-declare module 'virtual:starlight/components/Header' {
-	const Header: typeof import('./components/Header.astro').default;
-	export default Header;
-}
-declare module 'virtual:starlight/components/LanguageSelect' {
-	const LanguageSelect: typeof import('./components/LanguageSelect.astro').default;
-	export default LanguageSelect;
-}
-declare module 'virtual:starlight/components/Search' {
-	const Search: typeof import('./components/Search.astro').default;
-	export default Search;
-}
-declare module 'virtual:starlight/components/SiteTitle' {
-	const SiteTitle: typeof import('./components/SiteTitle.astro').default;
-	export default SiteTitle;
-}
-declare module 'virtual:starlight/components/SocialIcons' {
-	const SocialIcons: typeof import('./components/SocialIcons.astro').default;
-	export default SocialIcons;
-}
-declare module 'virtual:starlight/components/ThemeSelect' {
-	const ThemeSelect: typeof import('./components/ThemeSelect.astro').default;
-	export default ThemeSelect;
-}
-
-declare module 'virtual:starlight/components/Head' {
-	const Head: typeof import('./components/Head.astro').default;
-	export default Head;
-}
-declare module 'virtual:starlight/components/Hero' {
-	const Hero: typeof import('./components/Hero.astro').default;
-	export default Hero;
-}
-declare module 'virtual:starlight/components/MarkdownContent' {
-	const MarkdownContent: typeof import('./components/MarkdownContent.astro').default;
-	export default MarkdownContent;
-}
-
-declare module 'virtual:starlight/components/PageSidebar' {
-	const PageSidebar: typeof import('./components/PageSidebar.astro').default;
-	export default PageSidebar;
-}
-declare module 'virtual:starlight/components/TableOfContents' {
-	const TableOfContents: typeof import('./components/TableOfContents.astro').default;
-	export default TableOfContents;
-}
-declare module 'virtual:starlight/components/MobileTableOfContents' {
-	const MobileTableOfContents: typeof import('./components/MobileTableOfContents.astro').default;
-	export default MobileTableOfContents;
-}
-
-declare module 'virtual:starlight/components/Sidebar' {
-	const Sidebar: typeof import('./components/Sidebar.astro').default;
-	export default Sidebar;
-}
-declare module 'virtual:starlight/components/SkipLink' {
-	const SkipLink: typeof import('./components/SkipLink.astro').default;
-	export default SkipLink;
-}
-declare module 'virtual:starlight/components/ThemeProvider' {
-	const ThemeProvider: typeof import('./components/ThemeProvider.astro').default;
-	export default ThemeProvider;
-}
-
-declare module 'virtual:starlight/components/PageFrame' {
-	const PageFrame: typeof import('./components/PageFrame.astro').default;
-	export default PageFrame;
-}
-declare module 'virtual:starlight/components/MobileMenuToggle' {
-	const MobileMenuToggle: typeof import('./components/MobileMenuToggle.astro').default;
-	export default MobileMenuToggle;
-}
-declare module 'virtual:starlight/components/MobileMenuFooter' {
-	const MobileMenuFooter: typeof import('./components/MobileMenuFooter.astro').default;
-	export default MobileMenuFooter;
-}
-
-declare module 'virtual:starlight/components/TwoColumnContent' {
-	const TwoColumnContent: typeof import('./components/TwoColumnContent.astro').default;
-	export default TwoColumnContent;
-}