diff --git a/docs/.astro/astro/content.d.ts b/docs/.astro/astro/content.d.ts index cfe16ae..a4fb455 100644 --- a/docs/.astro/astro/content.d.ts +++ b/docs/.astro/astro/content.d.ts @@ -1,194 +1,197 @@ -declare module 'astro:content' { - interface Render { - '.mdx': Promise<{ - Content: import('astro').MarkdownInstance<{}>['Content']; - headings: import('astro').MarkdownHeading[]; - remarkPluginFrontmatter: Record; - components: import('astro').MDXInstance<{}>['components']; - }>; - } +declare module "astro:content" { + interface Render { + ".mdx": Promise<{ + Content: import("astro").MarkdownInstance<{}>["Content"]; + headings: import("astro").MarkdownHeading[]; + remarkPluginFrontmatter: Record; + 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; - } - interface Render { - '.md': Promise; - } - - export interface RenderedContent { - html: string; - metadata?: { - imagePaths: Array; - [key: string]: unknown; - }; - } +declare module "astro:content" { + interface RenderResult { + Content: import("astro/runtime/server/index.js").AstroComponentFactory; + headings: import("astro").MarkdownHeading[]; + remarkPluginFrontmatter: Record; + } + interface Render { + ".md": Promise; + } + + export interface RenderedContent { + html: string; + metadata?: { + imagePaths: Array; + [key: string]: unknown; + }; + } } -declare module 'astro:content' { - type Flatten = T extends { [K: string]: infer U } ? U : never; - - export type CollectionKey = keyof AnyEntryMap; - export type CollectionEntry = Flatten; - - export type ContentCollectionKey = keyof ContentEntryMap; - export type DataCollectionKey = keyof DataEntryMap; - - type AllValuesOf = T extends any ? T[keyof T] : never; - type ValidContentEntrySlug = AllValuesOf< - ContentEntryMap[C] - >['slug']; - - /** @deprecated Use `getEntry` instead. */ - export function getEntryBySlug< - C extends keyof ContentEntryMap, - E extends ValidContentEntrySlug | (string & {}), - >( - collection: C, - // Note that this has to accept a regular string too, for SSR - entrySlug: E, - ): E extends ValidContentEntrySlug - ? Promise> - : Promise | undefined>; - - /** @deprecated Use `getEntry` instead. */ - export function getDataEntryById( - collection: C, - entryId: E, - ): Promise>; - - export function getCollection>( - collection: C, - filter?: (entry: CollectionEntry) => entry is E, - ): Promise; - export function getCollection( - collection: C, - filter?: (entry: CollectionEntry) => unknown, - ): Promise[]>; - - export function getEntry< - C extends keyof ContentEntryMap, - E extends ValidContentEntrySlug | (string & {}), - >(entry: { - collection: C; - slug: E; - }): E extends ValidContentEntrySlug - ? Promise> - : Promise | 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 - : Promise | undefined>; - export function getEntry< - C extends keyof ContentEntryMap, - E extends ValidContentEntrySlug | (string & {}), - >( - collection: C, - slug: E, - ): E extends ValidContentEntrySlug - ? Promise> - : Promise | undefined>; - export function getEntry< - C extends keyof DataEntryMap, - E extends keyof DataEntryMap[C] | (string & {}), - >( - collection: C, - id: E, - ): E extends keyof DataEntryMap[C] - ? Promise - : Promise | undefined>; - - /** Resolve an array of entry references from the same collection */ - export function getEntries( - entries: { - collection: C; - slug: ValidContentEntrySlug; - }[], - ): Promise[]>; - export function getEntries( - entries: { - collection: C; - id: keyof DataEntryMap[C]; - }[], - ): Promise[]>; - - export function render( - entry: AnyEntryMap[C][string], - ): Promise; - - export function reference( - collection: C, - ): import('astro/zod').ZodEffects< - import('astro/zod').ZodString, - C extends keyof ContentEntryMap - ? { - collection: C; - slug: ValidContentEntrySlug; - } - : { - 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( - collection: C, - ): import('astro/zod').ZodEffects; - - type ReturnTypeOrOriginal = T extends (...args: any[]) => infer R ? R : T; - type InferEntrySchema = import('astro/zod').infer< - ReturnTypeOrOriginal['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"); +declare module "astro:content" { + type Flatten = T extends { [K: string]: infer U } ? U : never; + + export type CollectionKey = keyof AnyEntryMap; + export type CollectionEntry = Flatten< + AnyEntryMap[C] + >; + + export type ContentCollectionKey = keyof ContentEntryMap; + export type DataCollectionKey = keyof DataEntryMap; + + type AllValuesOf = T extends any ? T[keyof T] : never; + type ValidContentEntrySlug = AllValuesOf< + ContentEntryMap[C] + >["slug"]; + + /** @deprecated Use `getEntry` instead. */ + export function getEntryBySlug< + C extends keyof ContentEntryMap, + E extends ValidContentEntrySlug | (string & {}) + >( + collection: C, + // Note that this has to accept a regular string too, for SSR + entrySlug: E + ): E extends ValidContentEntrySlug + ? Promise> + : Promise | undefined>; + + /** @deprecated Use `getEntry` instead. */ + export function getDataEntryById< + C extends keyof DataEntryMap, + E extends keyof DataEntryMap[C] + >(collection: C, entryId: E): Promise>; + + export function getCollection< + C extends keyof AnyEntryMap, + E extends CollectionEntry + >( + collection: C, + filter?: (entry: CollectionEntry) => entry is E + ): Promise; + export function getCollection( + collection: C, + filter?: (entry: CollectionEntry) => unknown + ): Promise[]>; + + export function getEntry< + C extends keyof ContentEntryMap, + E extends ValidContentEntrySlug | (string & {}) + >(entry: { + collection: C; + slug: E; + }): E extends ValidContentEntrySlug + ? Promise> + : Promise | 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 + : Promise | undefined>; + export function getEntry< + C extends keyof ContentEntryMap, + E extends ValidContentEntrySlug | (string & {}) + >( + collection: C, + slug: E + ): E extends ValidContentEntrySlug + ? Promise> + : Promise | undefined>; + export function getEntry< + C extends keyof DataEntryMap, + E extends keyof DataEntryMap[C] | (string & {}) + >( + collection: C, + id: E + ): E extends keyof DataEntryMap[C] + ? Promise + : Promise | undefined>; + + /** Resolve an array of entry references from the same collection */ + export function getEntries( + entries: { + collection: C; + slug: ValidContentEntrySlug; + }[] + ): Promise[]>; + export function getEntries( + entries: { + collection: C; + id: keyof DataEntryMap[C]; + }[] + ): Promise[]>; + + export function render( + entry: AnyEntryMap[C][string] + ): Promise; + + export function reference( + collection: C + ): import("astro/zod").ZodEffects< + import("astro/zod").ZodString, + C extends keyof ContentEntryMap + ? { + collection: C; + slug: ValidContentEntrySlug; + } + : { + 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( + collection: C + ): import("astro/zod").ZodEffects; + + type ReturnTypeOrOriginal = T extends (...args: any[]) => infer R ? R : T; + type InferEntrySchema = + import("astro/zod").infer< + ReturnTypeOrOriginal["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"); } diff --git a/docs/.astro/settings.json b/docs/.astro/settings.json index 233ac2e..17fd89d 100644 --- a/docs/.astro/settings.json +++ b/docs/.astro/settings.json @@ -1,5 +1,5 @@ { - "_variables": { - "lastUpdateCheck": 1732631781468 - } -} \ No newline at end of file + "_variables": { + "lastUpdateCheck": 1732631781468 + } +} diff --git a/docs/.astro/types.d.ts b/docs/.astro/types.d.ts index 9a2a78c..add0945 100644 --- a/docs/.astro/types.d.ts +++ b/docs/.astro/types.d.ts @@ -1,2 +1,2 @@ /// -/// \ No newline at end of file +/// diff --git a/docs/package.json b/docs/package.json index b5f55f5..40f3948 100644 --- a/docs/package.json +++ b/docs/package.json @@ -31,8 +31,8 @@ "astro": "^4.16.10", "sharp": "^0.33.5", "starlight-contributor-list": "^0.1.0", - "starlight-plugin-show-latest-version": "workspace:*", - "starlight-links-validator": "^0.13.0" + "starlight-links-validator": "^0.13.0", + "starlight-plugin-show-latest-version": "workspace:*" }, "packageManager": "pnpm@9.3.0", "engines": {