347 lines
9.2 KiB
TypeScript
347 lines
9.2 KiB
TypeScript
declare module 'astro:content' {
|
|
interface Render {
|
|
'.mdx': Promise<{
|
|
Content: import('astro').MarkdownInstance<{}>['Content'];
|
|
headings: import('astro').MarkdownHeading[];
|
|
remarkPluginFrontmatter: Record<string, any>;
|
|
}>;
|
|
}
|
|
}
|
|
|
|
declare module 'astro:content' {
|
|
interface Render {
|
|
'.md': Promise<{
|
|
Content: import('astro').MarkdownInstance<{}>['Content'];
|
|
headings: import('astro').MarkdownHeading[];
|
|
remarkPluginFrontmatter: Record<string, any>;
|
|
}>;
|
|
}
|
|
}
|
|
|
|
declare module 'astro:content' {
|
|
export { z } from 'astro/zod';
|
|
|
|
type Flatten<T> = T extends { [K: string]: infer U } ? U : never;
|
|
|
|
export type CollectionKey = keyof AnyEntryMap;
|
|
export type CollectionEntry<C extends CollectionKey> = Flatten<AnyEntryMap[C]>;
|
|
|
|
export type ContentCollectionKey = keyof ContentEntryMap;
|
|
export type DataCollectionKey = keyof DataEntryMap;
|
|
|
|
// This needs to be in sync with ImageMetadata
|
|
export type ImageFunction = () => import('astro/zod').ZodObject<{
|
|
src: import('astro/zod').ZodString;
|
|
width: import('astro/zod').ZodNumber;
|
|
height: import('astro/zod').ZodNumber;
|
|
format: import('astro/zod').ZodUnion<
|
|
[
|
|
import('astro/zod').ZodLiteral<'png'>,
|
|
import('astro/zod').ZodLiteral<'jpg'>,
|
|
import('astro/zod').ZodLiteral<'jpeg'>,
|
|
import('astro/zod').ZodLiteral<'tiff'>,
|
|
import('astro/zod').ZodLiteral<'webp'>,
|
|
import('astro/zod').ZodLiteral<'gif'>,
|
|
import('astro/zod').ZodLiteral<'svg'>,
|
|
import('astro/zod').ZodLiteral<'avif'>,
|
|
]
|
|
>;
|
|
}>;
|
|
|
|
type BaseSchemaWithoutEffects =
|
|
| import('astro/zod').AnyZodObject
|
|
| import('astro/zod').ZodUnion<[BaseSchemaWithoutEffects, ...BaseSchemaWithoutEffects[]]>
|
|
| import('astro/zod').ZodDiscriminatedUnion<string, import('astro/zod').AnyZodObject[]>
|
|
| import('astro/zod').ZodIntersection<BaseSchemaWithoutEffects, BaseSchemaWithoutEffects>;
|
|
|
|
type BaseSchema =
|
|
| BaseSchemaWithoutEffects
|
|
| import('astro/zod').ZodEffects<BaseSchemaWithoutEffects>;
|
|
|
|
export type SchemaContext = { image: ImageFunction };
|
|
|
|
type DataCollectionConfig<S extends BaseSchema> = {
|
|
type: 'data';
|
|
schema?: S | ((context: SchemaContext) => S);
|
|
};
|
|
|
|
type ContentCollectionConfig<S extends BaseSchema> = {
|
|
type?: 'content';
|
|
schema?: S | ((context: SchemaContext) => S);
|
|
};
|
|
|
|
type CollectionConfig<S> = ContentCollectionConfig<S> | DataCollectionConfig<S>;
|
|
|
|
export function defineCollection<S extends BaseSchema>(
|
|
input: CollectionConfig<S>
|
|
): CollectionConfig<S>;
|
|
|
|
type AllValuesOf<T> = T extends any ? T[keyof T] : never;
|
|
type ValidContentEntrySlug<C extends keyof ContentEntryMap> = AllValuesOf<
|
|
ContentEntryMap[C]
|
|
>['slug'];
|
|
|
|
export function getEntryBySlug<
|
|
C extends keyof ContentEntryMap,
|
|
E extends ValidContentEntrySlug<C> | (string & {}),
|
|
>(
|
|
collection: C,
|
|
// 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]>(
|
|
collection: C,
|
|
entryId: E
|
|
): Promise<CollectionEntry<C>>;
|
|
|
|
export function getCollection<C extends keyof AnyEntryMap, E extends CollectionEntry<C>>(
|
|
collection: C,
|
|
filter?: (entry: CollectionEntry<C>) => entry is E
|
|
): Promise<E[]>;
|
|
export function getCollection<C extends keyof AnyEntryMap>(
|
|
collection: C,
|
|
filter?: (entry: CollectionEntry<C>) => unknown
|
|
): Promise<CollectionEntry<C>[]>;
|
|
|
|
export function getEntry<
|
|
C extends keyof ContentEntryMap,
|
|
E extends ValidContentEntrySlug<C> | (string & {}),
|
|
>(entry: {
|
|
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 & {}),
|
|
>(entry: {
|
|
collection: C;
|
|
id: E;
|
|
}): E extends keyof DataEntryMap[C]
|
|
? 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 */
|
|
export function getEntries<C extends keyof ContentEntryMap>(
|
|
entries: {
|
|
collection: C;
|
|
slug: ValidContentEntrySlug<C>;
|
|
}[]
|
|
): Promise<CollectionEntry<C>[]>;
|
|
export function getEntries<C extends keyof DataEntryMap>(
|
|
entries: {
|
|
collection: C;
|
|
id: keyof DataEntryMap[C];
|
|
}[]
|
|
): Promise<CollectionEntry<C>[]>;
|
|
|
|
export function reference<C extends keyof AnyEntryMap>(
|
|
collection: C
|
|
): import('astro/zod').ZodEffects<
|
|
import('astro/zod').ZodString,
|
|
C extends keyof ContentEntryMap
|
|
? {
|
|
collection: C;
|
|
slug: ValidContentEntrySlug<C>;
|
|
}
|
|
: {
|
|
collection: C;
|
|
id: keyof DataEntryMap[C];
|
|
}
|
|
>;
|
|
// Allow generic `string` to avoid excessive type errors in the config
|
|
// if `dev` is not running to update as you edit.
|
|
// Invalid collection names will be caught at build time.
|
|
export function reference<C extends string>(
|
|
collection: C
|
|
): import('astro/zod').ZodEffects<import('astro/zod').ZodString, never>;
|
|
|
|
type ReturnTypeOrOriginal<T> = T extends (...args: any[]) => infer R ? R : T;
|
|
type InferEntrySchema<C extends keyof AnyEntryMap> = import('astro/zod').infer<
|
|
ReturnTypeOrOriginal<Required<ContentConfig['collections'][C]>['schema']>
|
|
>;
|
|
|
|
type ContentEntryMap = {
|
|
"blog": {
|
|
"summer.mdx": {
|
|
id: "summer.mdx";
|
|
slug: "summer";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week1.mdx": {
|
|
id: "week1.mdx";
|
|
slug: "week1";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week2.mdx": {
|
|
id: "week2.mdx";
|
|
slug: "week2";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week3.mdx": {
|
|
id: "week3.mdx";
|
|
slug: "week3";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week4.mdx": {
|
|
id: "week4.mdx";
|
|
slug: "week4";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week5-6.mdx": {
|
|
id: "week5-6.mdx";
|
|
slug: "week5-6";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week7-8.mdx": {
|
|
id: "week7-8.mdx";
|
|
slug: "week7-8";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"week9-10.mdx": {
|
|
id: "week9-10.mdx";
|
|
slug: "week9-10";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work1.mdx": {
|
|
id: "work1.mdx";
|
|
slug: "work1";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work2.mdx": {
|
|
id: "work2.mdx";
|
|
slug: "work2";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work3.mdx": {
|
|
id: "work3.mdx";
|
|
slug: "work3";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work4.mdx": {
|
|
id: "work4.mdx";
|
|
slug: "work4";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work5.mdx": {
|
|
id: "work5.mdx";
|
|
slug: "work5";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"work6.mdx": {
|
|
id: "work6.mdx";
|
|
slug: "work6";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2022-1.mdx": {
|
|
id: "year2022-1.mdx";
|
|
slug: "year2022-1";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2022-end.mdx": {
|
|
id: "year2022-end.mdx";
|
|
slug: "year2022-end";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2022-w1.mdx": {
|
|
id: "year2022-w1.mdx";
|
|
slug: "year2022-w1";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2022-w2.mdx": {
|
|
id: "year2022-w2.mdx";
|
|
slug: "year2022-w2";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2022-w3.mdx": {
|
|
id: "year2022-w3.mdx";
|
|
slug: "year2022-w3";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2023-1.mdx": {
|
|
id: "year2023-1.mdx";
|
|
slug: "year2023-1";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
"year2024.mdx": {
|
|
id: "year2024.mdx";
|
|
slug: "year2024";
|
|
body: string;
|
|
collection: "blog";
|
|
data: InferEntrySchema<"blog">
|
|
} & { render(): Render[".mdx"] };
|
|
};
|
|
|
|
};
|
|
|
|
type DataEntryMap = {
|
|
|
|
};
|
|
|
|
type AnyEntryMap = ContentEntryMap & DataEntryMap;
|
|
|
|
type ContentConfig = typeof import("../src/content/config");
|
|
}
|