Slug schema

[florian-lefebvre]

Body

Summary

Add a way to compute data from slugs / ids in Content Collections.

Background & Motivation

Content Collections are powerful when it comes to the schema. Since it's just powered by Zod, you benefit from all its functionalities like .refine and .transform.

However, this only applies to entries data, not slugs/ids. . You may want to store data in slugs without duplicating it, like so:

src/content/2023-10-27.blog-post.md

Currently, you also have to either add date to the frontmatter (duplication) or make your own helpers to wrap Content Collections functions (eg getCollection).

Other example: i18n. It would be great to inject locale based on this path, eg src/content/en/my-entry.md.

Goals

• Be able to compute data from slug
• Slug remains unique and untouched

Example

Here is an example API:

import { defineCollection, z } from "astro:content";

const posts = defineCollection({
	slugSchema: (slug) => {
		const segments = slug.split("/");

		return {
			data: {
				locale: segments[0],
				date: segments.at(-1).split(".")[0]
			},
			schema: z.object({
				locale: z.string(),
				date: z.string().transform(d => new Date(d))
			})
		}
	},
	schema: () => z.object({
		title: z.string()
	})
});

For the following entry

---
# src/content/fr/2023-10-27.blog-post.md
title: Blog post
---
some content

the CollectionEntry type would be

// type BlogPost = CollectionEntry<"posts">
type BlogPost = {
	slug: string;
	collection: string;
	data: {
		title: string;
		locale: string;
		date: Date
	}
}

[florian-lefebvre]

No longer relevant with the content layer