Allow custom metadata on schema.collection

[willthomson]

Registry, uses collections, where each collection is a separate microsite (some with several pages), most of which are showcasing a TLD, for example get.dad, get.ing etc. Each of these TLD sites (collections) has some metadata associated with it, for example:

• TLD
• Site root URL
• Initiative logo (URL and alt)

I suggest adding a new optional meta option on the collection schema, where key/value pairs can be created arbitrarily like so:

export default createCollection({
  name: 'Get.ing pages',
  description: 'Landing pages for get.ing',
  url: '/get.ing/[...slug]',
  meta: {
    tld: 'ing',
    rootUrl: 'https://get.ing',
    initiativeLogo: {
      src: 'https://lh3.googleusercontent.com/hElmA3OIiqvwRaRxqSZQ5G6pVdzzk6nUf0lGcCYJCxQVMc2pHz1RVKqgudAYklWqVg8HzixOs40SEuYOI5KBvUgFLiEEZKTgKDtX2XA',
      alt: 'dot ing logo',
    },
  },
});

This could then either be exposed to the Page and be looked up through usePage(), or the collection could get its own useCollection() function.

[stevenle]

I think there are a couple of ways this can be handled:

1. Extend the root's Collection type in your project, e.g.

// utils/schema.ts

export type SiteMetadata {
  tld: string;
  rootUrl: string;
  logo: {src: string; alt: string};
}

export type CollectionWithMetadata = schemas.Collection & SiteMetadata;

export defineCollection = (collection: CollectionWithMetadata) => collection;

// collections/Foo.schema.ts

import {defineCollection} from '@/utils/schema.ts';

export default defineCollection({
  ...
});

2. If you just need to grab metadata programmatically you can also use import.meta.glob and export the metadata as a separate variable

// collections/Foo.schema.ts

export const METADATA = {...};

export default defineCollection({...});

And with import.meta.glob:

const collectionModules = import.meta.glob('/collections/*.schema.ts', {eager: true});
const allMetadata = collectionModules.map((module) => module.METADATA);