reference-marketing-website chore(deps): update dependency next-mdx-remote to v4.4.1

chore(deps): update dependency next-mdx-remote to v4.4.1

Open renovate[bot] opened this issue 2 years ago • 1 comments

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
next-mdx-remote	`4.0.2` -> `4.4.1`

Release Notes

hashicorp/next-mdx-remote (next-mdx-remote)

`v4.4.1`

Compare Source

What's Changed

chore(types): remove unused imports by @thiskevinwang in https://github.com/hashicorp/next-mdx-remote/pull/348
fix: Make sure frontmatter types flow through to MDXRemote by @BRKalow in https://github.com/hashicorp/next-mdx-remote/pull/351

Full Changelog: https://github.com/hashicorp/next-mdx-remote/compare/v4.4.0...v4.4.1

This release includes a few fixes for frontmatter types, as well as a way to provide a frontmatter type to serialize or compileMDX and have it propagate through to the returned frontmatter property. See the documentation for an example.

serialize:

import { serialize } from 'next-mdx-remote/serialize'

interface Frontmatter {
  title: string
  published: string
  description?: string
}

//     👇 should have type Frontmatter
const { frontmatter } = serialize<Record<string, unknown>, Frontmatter>(source)

compileMDX:

import { compileMDX } from 'next-mdx-remote/rsc'

interface Frontmatter {
  title: string
  published: string
  description?: string
}

export default async function Page({ source }) {
	//              👇 should have type Frontmatter
	const { content, frontmatter } = await compileMDX<Frontmatter>(source)

	return (
		<>
			<h1>{frontmatter.title}</h1>
			{content}
		</>
	)
}

What's Changed

docs: fix react server components example by @greyhere in https://github.com/hashicorp/next-mdx-remote/pull/334
fix(rsc): do not require compiledSource in types by @BRKalow in https://github.com/hashicorp/next-mdx-remote/pull/339
fix: TFrontmatter type to unknown by @RebootGG in https://github.com/hashicorp/next-mdx-remote/pull/340
remove newline from template literal by @chrisweb in https://github.com/hashicorp/next-mdx-remote/pull/346
feat: Improve frontmatter types, pass generic TFrontmatter type through by @BRKalow in https://github.com/hashicorp/next-mdx-remote/pull/342

New Contributors

@greyhere made their first contribution in https://github.com/hashicorp/next-mdx-remote/pull/334
@RebootGG made their first contribution in https://github.com/hashicorp/next-mdx-remote/pull/340
@chrisweb made their first contribution in https://github.com/hashicorp/next-mdx-remote/pull/346

Full Changelog: https://github.com/hashicorp/next-mdx-remote/compare/v4.3.0...v4.4.0

`v4.3.0`: - Server Components Support (experimental)

Compare Source

next-mdx-remote now has experimental support for React Server Components! 🎉 Access the new API by importing from next-mdx-remote/rsc, and head to the documentation for usage instructions and additional examples.

import { MDXRemote } from 'next-mdx-remote/rsc'

export default async function Page() {
  const mdxSource = await getContent()

  return (
    <MDXRemote source={mdxSource} />
  )
}

Big thanks to @timneutkens for his contribution!