-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4944aab
commit bff666d
Showing
26 changed files
with
359 additions
and
361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| declare module 'astro:content' { | ||
| interface Render { | ||
| '.mdx': Promise<{ | ||
| Content: import('astro').MarkdownInstance<{}>['Content']; | ||
| headings: import('astro').MarkdownHeading[]; | ||
| remarkPluginFrontmatter: Record<string, any>; | ||
| components: import('astro').MDXInstance<{}>['components']; | ||
| }>; | ||
| } | ||
| } | ||
|
|
||
| declare module 'astro:content' { | ||
| interface RenderResult { | ||
| Content: import('astro/runtime/server/index.js').AstroComponentFactory; | ||
| headings: import('astro').MarkdownHeading[]; | ||
| remarkPluginFrontmatter: Record<string, any>; | ||
| } | ||
| interface Render { | ||
| '.md': Promise<RenderResult>; | ||
| } | ||
|
|
||
| export interface RenderedContent { | ||
| html: string; | ||
| metadata?: { | ||
| imagePaths: Array<string>; | ||
| [key: string]: unknown; | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| declare module 'astro:content' { | ||
| 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; | ||
|
|
||
| type AllValuesOf<T> = T extends any ? T[keyof T] : never; | ||
| type ValidContentEntrySlug<C extends keyof ContentEntryMap> = AllValuesOf< | ||
| ContentEntryMap[C] | ||
| >['slug']; | ||
|
|
||
| /** @deprecated Use `getEntry` instead. */ | ||
| 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>; | ||
|
|
||
| /** @deprecated Use `getEntry` instead. */ | ||
| 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 render<C extends keyof AnyEntryMap>( | ||
| entry: AnyEntryMap[C][string], | ||
| ): Promise<RenderResult>; | ||
|
|
||
| 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 = { | ||
| "docs": { | ||
| "configuration.mdx": { | ||
| id: "configuration.mdx"; | ||
| slug: "configuration"; | ||
| body: string; | ||
| collection: "docs"; | ||
| data: InferEntrySchema<"docs"> | ||
| } & { render(): Render[".mdx"] }; | ||
| "getting-started.mdx": { | ||
| id: "getting-started.mdx"; | ||
| slug: "getting-started"; | ||
| body: string; | ||
| collection: "docs"; | ||
| data: InferEntrySchema<"docs"> | ||
| } & { render(): Render[".mdx"] }; | ||
| "index.mdx": { | ||
| id: "index.mdx"; | ||
| slug: "index"; | ||
| body: string; | ||
| collection: "docs"; | ||
| data: InferEntrySchema<"docs"> | ||
| } & { render(): Render[".mdx"] }; | ||
| "version-extraction-algorithm.mdx": { | ||
| id: "version-extraction-algorithm.mdx"; | ||
| slug: "version-extraction-algorithm"; | ||
| body: string; | ||
| collection: "docs"; | ||
| data: InferEntrySchema<"docs"> | ||
| } & { render(): Render[".mdx"] }; | ||
| }; | ||
|
|
||
| }; | ||
|
|
||
| type DataEntryMap = { | ||
|
|
||
| }; | ||
|
|
||
| type AnyEntryMap = ContentEntryMap & DataEntryMap; | ||
|
|
||
| export type ContentConfig = typeof import("./../../src/content/config.js"); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.