fix(@astro/mdx): add components property to RenderResult type definit…

…ion (#12245)
withastro · Oct 25, 2024 · 1d4f6a4 · 1d4f6a4
1 parent 9d6bcdb
commit 1d4f6a4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/.changeset/twenty-gifts-kick.md b/.changeset/twenty-gifts-kick.md
@@ -0,0 +1,6 @@
+---
+'@astrojs/mdx': patch
+'astro': patch
+---
+
+Add `components` property to MDXInstance type definition (RenderResult and module import)
diff --git a/packages/astro/client.d.ts b/packages/astro/client.d.ts
@@ -289,6 +289,7 @@ declare module '*.mdx' {
 	export const url: MDX['url'];
 	export const getHeadings: MDX['getHeadings'];
 	export const Content: MDX['Content'];
+	export const components: MDX['components'];
 
 	const load: MDX['default'];
 	export default load;

diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
@@ -2648,10 +2648,12 @@ export interface MarkdownInstance<T extends Record<string, any>> {
 
 type MD = MarkdownInstance<Record<string, any>>;
 
-export type MDXInstance<T extends Record<string, any>> = Omit<
+export interface MDXInstance<T extends Record<string, any>> extends Omit<
 	MarkdownInstance<T>,
 	'rawContent' | 'compiledContent'
->;
+> {
+	components: Record<string, AstroComponentFactory> | undefined;
+}
 
 export interface MarkdownLayoutProps<T extends Record<string, any>> {
 	frontmatter: {
@@ -2665,10 +2667,12 @@ export interface MarkdownLayoutProps<T extends Record<string, any>> {
 	compiledContent: MarkdownInstance<T>['compiledContent'];
 }
 
-export type MDXLayoutProps<T extends Record<string, any>> = Omit<
+export interface MDXLayoutProps<T extends Record<string, any>> extends Omit<
 	MarkdownLayoutProps<T>,
 	'rawContent' | 'compiledContent'
->;
+> {
+	components: MDXInstance<T>['components'];
+}
 
 export type GetHydrateCallback = () => Promise<() => void | Promise<void>>;
 

diff --git a/packages/integrations/mdx/template/content-module-types.d.ts b/packages/integrations/mdx/template/content-module-types.d.ts
@@ -4,6 +4,7 @@ declare module 'astro:content' {
 			Content: import('astro').MarkdownInstance<{}>['Content'];
 			headings: import('astro').MarkdownHeading[];
 			remarkPluginFrontmatter: Record<string, any>;
+			components: import('astro').MDXInstance<{}>['components'];
 		}>;
 	}
 }