format autogenerated types

This commit is contained in:
Felix Roos 2024-01-14 23:16:44 +01:00
parent 0566b7bcb3
commit ceb4376eb8

View file

@ -1,206 +1,172 @@
declare module 'astro:content' { declare module 'astro:content' {
interface Render { interface Render {
'.mdx': Promise<{ '.mdx': Promise<{
Content: import('astro').MarkdownInstance<{}>['Content']; Content: import('astro').MarkdownInstance<{}>['Content'];
headings: import('astro').MarkdownHeading[]; headings: import('astro').MarkdownHeading[];
remarkPluginFrontmatter: Record<string, any>; remarkPluginFrontmatter: Record<string, any>;
}>; }>;
} }
} }
declare module 'astro:content' { declare module 'astro:content' {
interface Render { interface Render {
'.md': Promise<{ '.md': Promise<{
Content: import('astro').MarkdownInstance<{}>['Content']; Content: import('astro').MarkdownInstance<{}>['Content'];
headings: import('astro').MarkdownHeading[]; headings: import('astro').MarkdownHeading[];
remarkPluginFrontmatter: Record<string, any>; remarkPluginFrontmatter: Record<string, any>;
}>; }>;
} }
} }
declare module 'astro:content' { declare module 'astro:content' {
export { z } from 'astro/zod'; export { z } from 'astro/zod';
type Flatten<T> = T extends { [K: string]: infer U } ? U : never; type Flatten<T> = T extends { [K: string]: infer U } ? U : never;
export type CollectionKey = keyof AnyEntryMap; export type CollectionKey = keyof AnyEntryMap;
export type CollectionEntry<C extends CollectionKey> = Flatten<AnyEntryMap[C]>; export type CollectionEntry<C extends CollectionKey> = Flatten<AnyEntryMap[C]>;
export type ContentCollectionKey = keyof ContentEntryMap; export type ContentCollectionKey = keyof ContentEntryMap;
export type DataCollectionKey = keyof DataEntryMap; export type DataCollectionKey = keyof DataEntryMap;
// This needs to be in sync with ImageMetadata // This needs to be in sync with ImageMetadata
export type ImageFunction = () => import('astro/zod').ZodObject<{ export type ImageFunction = () => import('astro/zod').ZodObject<{
src: import('astro/zod').ZodString; src: import('astro/zod').ZodString;
width: import('astro/zod').ZodNumber; width: import('astro/zod').ZodNumber;
height: import('astro/zod').ZodNumber; height: import('astro/zod').ZodNumber;
format: import('astro/zod').ZodUnion< format: import('astro/zod').ZodUnion<
[ [
import('astro/zod').ZodLiteral<'png'>, import('astro/zod').ZodLiteral<'png'>,
import('astro/zod').ZodLiteral<'jpg'>, import('astro/zod').ZodLiteral<'jpg'>,
import('astro/zod').ZodLiteral<'jpeg'>, import('astro/zod').ZodLiteral<'jpeg'>,
import('astro/zod').ZodLiteral<'tiff'>, import('astro/zod').ZodLiteral<'tiff'>,
import('astro/zod').ZodLiteral<'webp'>, import('astro/zod').ZodLiteral<'webp'>,
import('astro/zod').ZodLiteral<'gif'>, import('astro/zod').ZodLiteral<'gif'>,
import('astro/zod').ZodLiteral<'svg'>, import('astro/zod').ZodLiteral<'svg'>,
import('astro/zod').ZodLiteral<'avif'>, import('astro/zod').ZodLiteral<'avif'>,
] ]
>; >;
}>; }>;
type BaseSchemaWithoutEffects = type BaseSchemaWithoutEffects =
| import('astro/zod').AnyZodObject | import('astro/zod').AnyZodObject
| import('astro/zod').ZodUnion<[BaseSchemaWithoutEffects, ...BaseSchemaWithoutEffects[]]> | import('astro/zod').ZodUnion<[BaseSchemaWithoutEffects, ...BaseSchemaWithoutEffects[]]>
| import('astro/zod').ZodDiscriminatedUnion<string, import('astro/zod').AnyZodObject[]> | import('astro/zod').ZodDiscriminatedUnion<string, import('astro/zod').AnyZodObject[]>
| import('astro/zod').ZodIntersection<BaseSchemaWithoutEffects, BaseSchemaWithoutEffects>; | import('astro/zod').ZodIntersection<BaseSchemaWithoutEffects, BaseSchemaWithoutEffects>;
type BaseSchema = type BaseSchema = BaseSchemaWithoutEffects | import('astro/zod').ZodEffects<BaseSchemaWithoutEffects>;
| BaseSchemaWithoutEffects
| import('astro/zod').ZodEffects<BaseSchemaWithoutEffects>;
export type SchemaContext = { image: ImageFunction }; export type SchemaContext = { image: ImageFunction };
type DataCollectionConfig<S extends BaseSchema> = { type DataCollectionConfig<S extends BaseSchema> = {
type: 'data'; type: 'data';
schema?: S | ((context: SchemaContext) => S); schema?: S | ((context: SchemaContext) => S);
}; };
type ContentCollectionConfig<S extends BaseSchema> = { type ContentCollectionConfig<S extends BaseSchema> = {
type?: 'content'; type?: 'content';
schema?: S | ((context: SchemaContext) => S); schema?: S | ((context: SchemaContext) => S);
}; };
type CollectionConfig<S> = ContentCollectionConfig<S> | DataCollectionConfig<S>; type CollectionConfig<S> = ContentCollectionConfig<S> | DataCollectionConfig<S>;
export function defineCollection<S extends BaseSchema>( export function defineCollection<S extends BaseSchema>(input: CollectionConfig<S>): CollectionConfig<S>;
input: CollectionConfig<S>
): CollectionConfig<S>;
type AllValuesOf<T> = T extends any ? T[keyof T] : never; type AllValuesOf<T> = T extends any ? T[keyof T] : never;
type ValidContentEntrySlug<C extends keyof ContentEntryMap> = AllValuesOf< type ValidContentEntrySlug<C extends keyof ContentEntryMap> = AllValuesOf<ContentEntryMap[C]>['slug'];
ContentEntryMap[C]
>['slug'];
export function getEntryBySlug< export function getEntryBySlug<C extends keyof ContentEntryMap, E extends ValidContentEntrySlug<C> | (string & {})>(
C extends keyof ContentEntryMap, collection: C,
E extends ValidContentEntrySlug<C> | (string & {}), // Note that this has to accept a regular string too, for SSR
>( entrySlug: E,
collection: C, ): E extends ValidContentEntrySlug<C> ? Promise<CollectionEntry<C>> : Promise<CollectionEntry<C> | undefined>;
// Note that this has to accept a regular string too, for SSR
entrySlug: E
): E extends ValidContentEntrySlug<C>
? Promise<CollectionEntry<C>>
: Promise<CollectionEntry<C> | undefined>;
export function getDataEntryById<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C]>( export function getDataEntryById<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C]>(
collection: C, collection: C,
entryId: E entryId: E,
): Promise<CollectionEntry<C>>; ): Promise<CollectionEntry<C>>;
export function getCollection<C extends keyof AnyEntryMap, E extends CollectionEntry<C>>( export function getCollection<C extends keyof AnyEntryMap, E extends CollectionEntry<C>>(
collection: C, collection: C,
filter?: (entry: CollectionEntry<C>) => entry is E filter?: (entry: CollectionEntry<C>) => entry is E,
): Promise<E[]>; ): Promise<E[]>;
export function getCollection<C extends keyof AnyEntryMap>( export function getCollection<C extends keyof AnyEntryMap>(
collection: C, collection: C,
filter?: (entry: CollectionEntry<C>) => unknown filter?: (entry: CollectionEntry<C>) => unknown,
): Promise<CollectionEntry<C>[]>; ): Promise<CollectionEntry<C>[]>;
export function getEntry< export function getEntry<C extends keyof ContentEntryMap, E extends ValidContentEntrySlug<C> | (string & {})>(entry: {
C extends keyof ContentEntryMap, collection: C;
E extends ValidContentEntrySlug<C> | (string & {}), slug: E;
>(entry: { }): E extends ValidContentEntrySlug<C> ? Promise<CollectionEntry<C>> : Promise<CollectionEntry<C> | undefined>;
collection: C; export function getEntry<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C] | (string & {})>(entry: {
slug: E; collection: C;
}): E extends ValidContentEntrySlug<C> id: E;
? Promise<CollectionEntry<C>> }): E extends keyof DataEntryMap[C] ? Promise<DataEntryMap[C][E]> : Promise<CollectionEntry<C> | undefined>;
: Promise<CollectionEntry<C> | undefined>; export function getEntry<C extends keyof ContentEntryMap, E extends ValidContentEntrySlug<C> | (string & {})>(
export function getEntry< collection: C,
C extends keyof DataEntryMap, slug: E,
E extends keyof DataEntryMap[C] | (string & {}), ): E extends ValidContentEntrySlug<C> ? Promise<CollectionEntry<C>> : Promise<CollectionEntry<C> | undefined>;
>(entry: { export function getEntry<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C] | (string & {})>(
collection: C; collection: C,
id: E; id: E,
}): E extends keyof DataEntryMap[C] ): E extends keyof DataEntryMap[C] ? Promise<DataEntryMap[C][E]> : Promise<CollectionEntry<C> | undefined>;
? Promise<DataEntryMap[C][E]>
: Promise<CollectionEntry<C> | undefined>;
export function getEntry<
C extends keyof ContentEntryMap,
E extends ValidContentEntrySlug<C> | (string & {}),
>(
collection: C,
slug: E
): E extends ValidContentEntrySlug<C>
? Promise<CollectionEntry<C>>
: Promise<CollectionEntry<C> | undefined>;
export function getEntry<
C extends keyof DataEntryMap,
E extends keyof DataEntryMap[C] | (string & {}),
>(
collection: C,
id: E
): E extends keyof DataEntryMap[C]
? Promise<DataEntryMap[C][E]>
: Promise<CollectionEntry<C> | undefined>;
/** Resolve an array of entry references from the same collection */ /** Resolve an array of entry references from the same collection */
export function getEntries<C extends keyof ContentEntryMap>( export function getEntries<C extends keyof ContentEntryMap>(
entries: { entries: {
collection: C; collection: C;
slug: ValidContentEntrySlug<C>; slug: ValidContentEntrySlug<C>;
}[] }[],
): Promise<CollectionEntry<C>[]>; ): Promise<CollectionEntry<C>[]>;
export function getEntries<C extends keyof DataEntryMap>( export function getEntries<C extends keyof DataEntryMap>(
entries: { entries: {
collection: C; collection: C;
id: keyof DataEntryMap[C]; id: keyof DataEntryMap[C];
}[] }[],
): Promise<CollectionEntry<C>[]>; ): Promise<CollectionEntry<C>[]>;
export function reference<C extends keyof AnyEntryMap>( export function reference<C extends keyof AnyEntryMap>(
collection: C collection: C,
): import('astro/zod').ZodEffects< ): import('astro/zod').ZodEffects<
import('astro/zod').ZodString, import('astro/zod').ZodString,
C extends keyof ContentEntryMap C extends keyof ContentEntryMap
? { ? {
collection: C; collection: C;
slug: ValidContentEntrySlug<C>; slug: ValidContentEntrySlug<C>;
} }
: { : {
collection: C; collection: C;
id: keyof DataEntryMap[C]; id: keyof DataEntryMap[C];
} }
>; >;
// Allow generic `string` to avoid excessive type errors in the config // Allow generic `string` to avoid excessive type errors in the config
// if `dev` is not running to update as you edit. // if `dev` is not running to update as you edit.
// Invalid collection names will be caught at build time. // Invalid collection names will be caught at build time.
export function reference<C extends string>( export function reference<C extends string>(
collection: C collection: C,
): import('astro/zod').ZodEffects<import('astro/zod').ZodString, never>; ): import('astro/zod').ZodEffects<import('astro/zod').ZodString, never>;
type ReturnTypeOrOriginal<T> = T extends (...args: any[]) => infer R ? R : T; type ReturnTypeOrOriginal<T> = T extends (...args: any[]) => infer R ? R : T;
type InferEntrySchema<C extends keyof AnyEntryMap> = import('astro/zod').infer< type InferEntrySchema<C extends keyof AnyEntryMap> = import('astro/zod').infer<
ReturnTypeOrOriginal<Required<ContentConfig['collections'][C]>['schema']> ReturnTypeOrOriginal<Required<ContentConfig['collections'][C]>['schema']>
>; >;
type ContentEntryMap = { type ContentEntryMap = {
"blog": { blog: {
"hello.mdx": { 'hello.mdx': {
id: "hello.mdx"; id: 'hello.mdx';
slug: "hello"; slug: 'hello';
body: string; body: string;
collection: "blog"; collection: 'blog';
data: any data: any;
} & { render(): Render[".mdx"] }; } & { render(): Render['.mdx'] };
}; };
};
}; type DataEntryMap = {};
type DataEntryMap = { type AnyEntryMap = ContentEntryMap & DataEntryMap;
};
type AnyEntryMap = ContentEntryMap & DataEntryMap; type ContentConfig = never;
type ContentConfig = never;
} }