Sorrell Docgen

Search documentation

Menu

API REFERENCE

@sorrell/docs-core

Effect schemas and normalized domain models for Sorrell documentation tooling.

97 exportsSource

Functions

Signature

export declare function apiReferenceRecordToAgentDocument(
    record: {
        breadcrumbs: readonly {
            current: boolean;
            href?: string;
            label: string
        }[];
        categories: readonly {
            collapsed: boolean;
            id: string;
            label: string;
            order: number
        }[];
        declarations: readonly {
            category?: string;
            categoryId: string;
            description?: string;
            descriptionParts?: readonly {
                code?: boolean;
                external?: boolean;
                href?: string;
                kind: "text" | "link";
                text: string
            }[];
            examples?: readonly {
                code: string;
                language?: string;
                name?: string
            }[];
            id: string;
            introductionVersion?: string;
            kind: "function" | "type" | "const" | "class" | "interface" | "variable" | "namespace";
            link?: {
                external: boolean;
                href: string;
                label?: string
            };
            name: string;
            signature: string;
            source?: {
                endLine?: number;
                file: string;
                line?: number;
                repositoryUrl: string;
                revision: string
            }
        }[];
        displayName: string;
        exportCount: number;
        introductionVersion?: string;
        link?: {
            external: boolean;
            href: string;
            label?: string
        };
        module: string;
        packageDescription?: string;
        packageExports?: readonly string[];
        packageId: string;
        packageName: string;
        packagePrivate?: boolean;
        packageSourceUrl?: string;
        source?: {
            endLine?: number;
            file: string;
            line?: number;
            repositoryUrl: string;
            revision: string
        };
        summary?: string;
        summaryParts?: readonly {
            code?: boolean;
            external?: boolean;
            href?: string;
            kind: "text" | "link";
            text: string
        }[];
        version: string
    }
): { content: string; context?: string; description?: string; id: string; kind: "article" | "api-module" | "component"; metadata?: { [key: string]: unknown }; source?: { endLine?: number; file: string; line?: number; repositoryUrl: string; revision: string }; title: string; url: string; version?: string };

decodeDocsConfigFUNCTION

Signature

export declare function decodeDocsConfig(
    input: unknown
): Result<DocsConfig, DocsConfigError>;

decodeDocsConfigEffectFUNCTION

Signature

export declare function decodeDocsConfigEffect(
    input: unknown
): Effect<DocsConfig, DocsConfigError>;

decodeDocsConfigSyncFUNCTION

Signature

export declare function decodeDocsConfigSync(
    input: unknown
): DocsConfig;

formatAgentDocumentFUNCTION

Signature

export declare function formatAgentDocument(
    document: {
        content: string;
        context?: string;
        description?: string;
        id: string;
        kind: "article" | "api-module" | "component";
        metadata?: { [key: string]: unknown };
        source?: {
            endLine?: number;
            file: string;
            line?: number;
            repositoryUrl: string;
            revision: string
        };
        title: string;
        url: string;
        version?: string
    }
): string;

formatConfigPathFUNCTION

Signature

export declare function formatConfigPath(
    path: readonly ConfigPathSegment[]
): string;

formatDiagnosticFUNCTION

Signature

export declare function formatDiagnostic(
    diagnostic: DocsConfigDiagnostic
): string;

normalizeAgentMarkdownFUNCTION

Signature

export declare function normalizeAgentMarkdown(
    value: string
): AgentMarkdownResult;

normalizeDocsConfigFUNCTION

Signature

export declare function normalizeDocsConfig(
    input: {
        agent?: {
            description?: string;
            enabled?: boolean;
            essentials?: readonly string[];
            mcp?: { enabled?: boolean };
            skill?: {
                enabled?: boolean;
                name?: string
            }
        };
        api?: {
            enabled?: boolean;
            entryPoints?: readonly string[];
            outputDirectory?: string;
            packages?: readonly string[];
            sourceRepository?: {
                branch?: string;
                directory?: string;
                url: string
            };
            typedoc?: { [key: string]: unknown }
        };
        footer?: {
            columns?: readonly {
                links: readonly {
                    href: string;
                    icon?: string;
                    label: string
                }[];
                title: string
            }[];
            links?: readonly {
                href: string;
                icon?: string;
                label: string
            }[];
            message?: string
        };
        landing?: {
            description?: string;
            primaryAction?: {
                href: string;
                label: string
            };
            sections?: readonly {
                body?: string;
                href?: string;
                id: string;
                title: string
            }[];
            title?: string
        };
        manifests?: readonly {
            checksum?: string;
            generatedAt?: string;
            kind: "project" | "storybook" | "site" | "api-reference";
            path: string;
            revision?: string
        }[];
        metadata?: {
            description?: string;
            logo?: string | {
                props?: { [key: string]: unknown };
                style?: string;
                type: "dicebear"
            };
            name?: string;
            repository?: {
                branch?: string;
                directory?: string;
                url: string
            };
            title?: string;
            url?: string
        };
        navigation?: { groups?: readonly {
            id: string;
            items: readonly NavigationItemInput[];
            label: string
        }[] };
        packages?: readonly {
            description?: string;
            directory?: string;
            id: string;
            name: string;
            source?: {
                branch?: string;
                directory?: string;
                url: string
            };
            version?: string
        }[];
        redirects?: readonly {
            from: string;
            status?: 301 | 302;
            to: string
        }[];
        routing?: {
            documentationPrefix?: string;
            storybookPrefix?: string
        };
        storybook?: {
            command?: string;
            directory?: string;
            enabled?: boolean;
            stories?: readonly string[];
            url?: string
        };
        tokens?: {
            dark?: {
                accent?: string;
                background?: string;
                border?: string;
                cardBackground?: string;
                codeBackground?: string;
                foreground?: string;
                muted?: string;
                proseForeground?: string;
                subtleForeground?: string
            };
            light?: {
                accent?: string;
                background?: string;
                border?: string;
                cardBackground?: string;
                codeBackground?: string;
                foreground?: string;
                muted?: string;
                proseForeground?: string;
                subtleForeground?: string
            }
        };
        vercel?: {
            domains?: readonly string[];
            enabled?: boolean;
            outputDirectory?: string;
            productionBranch?: string;
            project?: string;
            projects?: {
                documentation?: {
                    directory?: string;
                    id?: string;
                    origin?: string;
                    productionBranch?: string;
                    project?: string;
                    routePrefix?: string;
                    team?: string
                };
                landing?: {
                    directory?: string;
                    id?: string;
                    origin?: string;
                    productionBranch?: string;
                    project?: string;
                    routePrefix?: string;
                    team?: string
                };
                mcp?: {
                    directory?: string;
                    id?: string;
                    origin?: string;
                    productionBranch?: string;
                    project?: string;
                    routePrefix?: string;
                    team?: string
                };
                storybook?: {
                    directory?: string;
                    id?: string;
                    origin?: string;
                    productionBranch?: string;
                    project?: string;
                    routePrefix?: string;
                    team?: string
                }
            };
            team?: string
        };
        versions?: readonly {
            current?: boolean;
            directory?: string;
            href?: string;
            id: string;
            label?: string;
            order?: number;
            version?: string
        }[]
    }
): DocsConfig;

Classes

DocsConfigErrorCLASS

Signature

export declare class DocsConfigError extends YieldableError<this> & { _tag: "DocsConfigError" } & Readonly<{ diagnostics: readonly DocsConfigDiagnostic[] }> {
    constructor(
    args: { diagnostics: readonly DocsConfigDiagnostic[] }
): DocsConfigError;
    readonly _tag: "DocsConfigError";
    readonly ~effect/Effect: Variance<never, DocsConfigError, never>;
    readonly ~effect/ErrorReporter/attributes?: ReadonlyRecord<string, unknown>;
    readonly ~effect/ErrorReporter/ignore?: boolean;
    readonly ~effect/ErrorReporter/severity?: Severity;
    readonly ~effect/Runtime/errorExitCode?: number;
    readonly ~effect/Runtime/errorReported?: boolean;
    cause?: unknown;
    readonly diagnostics: readonly DocsConfigDiagnostic[];
    name: string;
    stack?: string;
    [iterator](): EffectIterator<Effect<never, DocsConfigError, never>>;
    [NodeInspectSymbol](): unknown;
    pipe<A>(
    this: A
): A;
    toJSON(): unknown;
    toString(): string;
}

Interfaces

AgentMarkdownDiagnosticINTERFACE

Signature

export declare interface AgentMarkdownDiagnostic {
    readonly code: "unresolved-mdx-component" | "unsupported-html";
    readonly line: number;
    readonly message: string;
}

AgentMarkdownResultINTERFACE

Signature

export declare interface AgentMarkdownResult {
    readonly diagnostics: readonly AgentMarkdownDiagnostic[];
    readonly markdown: string;
}

DocsConfigINTERFACE

Signature

export declare interface DocsConfig {
    readonly agent: { description?: string; enabled: boolean; essentials: readonly string[]; mcp: { enabled: boolean }; skill: { enabled: boolean; name: string } };
    readonly api: { enabled: boolean; entryPoints: readonly string[]; outputDirectory: string; packages: readonly string[]; sourceRepository?: { branch?: string; directory?: string; url: string }; typedoc: { [key: string]: unknown } };
    readonly footer: SiteFooter;
    readonly landing: { description: string; primaryAction?: { href: string; label: string }; sections: readonly { body: string; href?: string; id: string; title: string }[]; title: string };
    readonly manifests: readonly { checksum?: string; generatedAt?: string; kind: "project" | "storybook" | "site" | "api-reference"; path: string; revision?: string }[];
    readonly mcpEndpoint: string;
    readonly metadata: { description: string; logo?: string | { props?: { [key: string]: unknown }; style?: string; type: "dicebear" }; name: string; repository?: { branch?: string; directory?: string; url: string }; title: string; url: string };
    readonly navigation: Navigation;
    readonly packages: readonly { description?: string; directory?: string; id: string; name: string; source?: { branch?: string; directory?: string; url: string }; version?: string }[];
    readonly redirects: readonly { from: string; status: 301 | 302; to: string }[];
    readonly routing: { documentationPrefix: string; storybookPrefix: string };
    readonly storybook: { command?: string; directory?: string; enabled: boolean; stories: readonly string[]; url?: string };
    readonly tokens: { dark: { accent: string; background: string; border: string; cardBackground?: string; codeBackground: string; foreground: string; muted: string; proseForeground?: string; subtleForeground?: string }; light: { accent: string; background: string; border: string; cardBackground?: string; codeBackground: string; foreground: string; muted: string; proseForeground?: string; subtleForeground?: string } };
    readonly vercel: { domains: readonly string[]; enabled: boolean; outputDirectory: string; productionBranch: string; project?: string; projects: { documentation: { directory: string; id?: string; origin?: string; productionBranch?: string; project?: string; routePrefix: string; team?: string }; landing: { directory: string; id?: string; origin?: string; productionBranch?: string; project?: string; routePrefix: string; team?: string }; mcp?: { directory: string; id?: string; origin?: string; productionBranch?: string; project?: string; routePrefix: string; team?: string }; storybook?: { directory: string; id?: string; origin?: string; productionBranch?: string; project?: string; routePrefix: string; team?: string } }; team?: string };
    readonly versions: readonly { current: boolean; directory: string; href?: string; id: string; label: string; order: number; version?: string }[];
}

DocsConfigDiagnosticINTERFACE

Signature

export declare interface DocsConfigDiagnostic {
    readonly actual?: unknown;
    readonly expected?: string;
    readonly message: string;
    readonly path: readonly ConfigPathSegment[];
}

Types

AgentConfigTYPE

Signature

export declare type AgentConfig = Schema.Schema.Type<typeof AgentConfigSchema>;

AgentCorpusTYPE

Signature

export declare type AgentCorpus = Schema.Schema.Type<typeof AgentCorpusSchema>;

AgentDocumentTYPE

Signature

export declare type AgentDocument = Schema.Schema.Type<typeof AgentDocumentSchema>;

AgentManifestTYPE

Signature

export declare type AgentManifest = Schema.Schema.Type<typeof AgentManifestSchema>;

AgentManifestEntryTYPE

Signature

export declare type AgentManifestEntry = Schema.Schema.Type<typeof AgentManifestEntrySchema>;

AgentSearchIndexTYPE

Signature

export declare type AgentSearchIndex = Schema.Schema.Type<typeof AgentSearchIndexSchema>;

AgentSkillArtifactTYPE

Signature

export declare type AgentSkillArtifact = Schema.Schema.Type<typeof AgentSkillArtifactSchema>;

AgentSkillConfigTYPE

Signature

export declare type AgentSkillConfig = Schema.Schema.Type<typeof AgentSkillConfigSchema>;

ApiGenerationConfigTYPE

Signature

export declare type ApiGenerationConfig = Schema.Schema.Type<typeof ApiGenerationConfigSchema>;

ApiReferenceBreadcrumbTYPE

Signature

export declare type ApiReferenceBreadcrumb = Schema.Schema.Type<typeof ApiReferenceBreadcrumbSchema>;

ApiReferenceCategoryTYPE

Signature

export declare type ApiReferenceCategory = Schema.Schema.Type<typeof ApiReferenceCategorySchema>;

Signature

export declare type ApiReferenceDeclaration = Schema.Schema.Type<typeof ApiReferenceDeclarationSchema>;

Signature

export declare type ApiReferenceDescriptionPart = Schema.Schema.Type<typeof ApiReferenceDescriptionPartSchema>;

ApiReferenceExampleTYPE

Signature

export declare type ApiReferenceExample = Schema.Schema.Type<typeof ApiReferenceExampleSchema>;

ApiReferenceRecordTYPE

Signature

export declare type ApiReferenceRecord = Schema.Schema.Type<typeof ApiReferenceRecordSchema>;

ApiReferenceSourceTYPE

Signature

export declare type ApiReferenceSource = Schema.Schema.Type<typeof ApiReferenceSourceSchema>;

DesignTokensTYPE

Signature

export declare type DesignTokens = Schema.Schema.Type<typeof DesignTokensSchema>;

DocsConfigInputTYPE

Signature

export declare type DocsConfigInput = Schema.Schema.Type<typeof DocsConfigInputSchema>;

DocumentationVersionTYPE

Signature

export declare type DocumentationVersion = Schema.Schema.Type<typeof DocumentationVersionSchema>;

FooterColumnTYPE

Signature

export declare type FooterColumn = Schema.Schema.Type<typeof FooterColumnSchema>;

GeneratedManifestTYPE

Signature

export declare type GeneratedManifest = Schema.Schema.Type<typeof GeneratedManifestSchema>;

LandingContentTYPE

Signature

export declare type LandingContent = Schema.Schema.Type<typeof LandingContentSchema>;

PackageReferenceTYPE

Signature

export declare type PackageReference = Schema.Schema.Type<typeof PackageReferenceSchema>;

RedirectTYPE

Signature

export declare type Redirect = Schema.Schema.Type<typeof RedirectSchema>;

SiteMetadataTYPE

Signature

export declare type SiteMetadata = Schema.Schema.Type<typeof SiteMetadataSchema>;

SiteRoutingTYPE

Signature

export declare type SiteRouting = Schema.Schema.Type<typeof SiteRoutingSchema>;

StorybookConfigTYPE

Signature

export declare type StorybookConfig = Schema.Schema.Type<typeof StorybookConfigSchema>;

VercelConfigTYPE

Signature

export declare type VercelConfig = Schema.Schema.Type<typeof VercelConfigSchema>;

VercelDeploymentTYPE

Signature

export declare type VercelDeployment = Schema.Schema.Type<typeof VercelDeploymentSchema>;

VercelProjectTYPE

Signature

export declare type VercelProject = Schema.Schema.Type<typeof VercelProjectSchema>;

VercelProjectsTYPE

Signature

export declare type VercelProjects = Schema.Schema.Type<typeof VercelProjectsSchema>;

VercelReleaseManifestTYPE

Signature

export declare type VercelReleaseManifest = Schema.Schema.Type<typeof VercelReleaseManifestSchema>;

Constants

AgentConfigSchemaVARIABLE

Signature

export declare const AgentConfigSchema: Struct<{ description: optionalKey<String>; enabled: Boolean; essentials: $Array<String>; mcp: Struct<{ enabled: Boolean }>; skill: Struct<{ enabled: Boolean; name: String }> }>;

AgentCorpusSchemaVARIABLE

Signature

export declare const AgentCorpusSchema: Struct<{ checksum: String; documents: $Array<Struct<{ content: String; context: optionalKey<String>; description: optionalKey<String>; id: String; kind: Literals<readonly ["article", "api-module", "component"]>; metadata: optionalKey<$Record<String, Unknown>>; source: optionalKey<Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>>; title: String; url: String; version: optionalKey<String> }>>; generatedAt: String; sourceRevision: optionalKey<String>; version: Literals<readonly [1]> }>;

AgentDocumentSchemaVARIABLE

Signature

export declare const AgentDocumentSchema: Struct<{ content: String; context: optionalKey<String>; description: optionalKey<String>; id: String; kind: Literals<readonly ["article", "api-module", "component"]>; metadata: optionalKey<$Record<String, Unknown>>; source: optionalKey<Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>>; title: String; url: String; version: optionalKey<String> }>;

AgentManifestEntrySchemaVARIABLE

Signature

export declare const AgentManifestEntrySchema: Struct<{ checksum: String; id: String; kind: Literals<readonly ["article", "api-module", "component"]>; markdownUrl: String; title: String; url: String; version: optionalKey<String> }>;

AgentManifestSchemaVARIABLE

Signature

export declare const AgentManifestSchema: Struct<{ checksum: String; documents: $Array<Struct<{ checksum: String; id: String; kind: Literals<readonly ["article", "api-module", "component"]>; markdownUrl: String; title: String; url: String; version: optionalKey<String> }>>; generatedAt: String; mcpEndpoint: optionalKey<String>; skills: optionalKey<$Array<Struct<{ archive: String; checksum: String; directory: String; name: String }>>>; version: Literals<readonly [1]>; versions: $Array<String> }>;

AgentSearchIndexEntrySchemaVARIABLE

Signature

export declare const AgentSearchIndexEntrySchema: Struct<{ id: String; terms: $Array<String>; version: optionalKey<String> }>;

AgentSearchIndexSchemaVARIABLE

Signature

export declare const AgentSearchIndexSchema: Struct<{ checksum: String; entries: $Array<Struct<{ id: String; terms: $Array<String>; version: optionalKey<String> }>>; version: Literals<readonly [1]> }>;

AgentSkillArtifactSchemaVARIABLE

Signature

export declare const AgentSkillArtifactSchema: Struct<{ archive: String; checksum: String; directory: String; name: String }>;

AgentSkillConfigSchemaVARIABLE

Signature

export declare const AgentSkillConfigSchema: Struct<{ enabled: Boolean; name: String }>;

ApiGenerationConfigSchemaVARIABLE

Signature

export declare const ApiGenerationConfigSchema: Struct<{ enabled: Boolean; entryPoints: $Array<String>; outputDirectory: String; packages: $Array<String>; sourceRepository: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; typedoc: $Record<String, Unknown> }>;

ApiReferenceBreadcrumbSchemaVARIABLE

Signature

export declare const ApiReferenceBreadcrumbSchema: Struct<{ current: Boolean; href: optionalKey<String>; label: String }>;

ApiReferenceCategorySchemaVARIABLE

Signature

export declare const ApiReferenceCategorySchema: Struct<{ collapsed: Boolean; id: String; label: String; order: Number }>;

Signature

export declare const ApiReferenceDeclarationSchema: Struct<{ category: optionalKey<String>; categoryId: String; description: optionalKey<String>; descriptionParts: optionalKey<$Array<Struct<{ code: optionalKey<Boolean>; external: optionalKey<Boolean>; href: optionalKey<String>; kind: Literals<readonly ["text", "link"]>; text: String }>>>; examples: optionalKey<$Array<Struct<{ code: String; language: optionalKey<String>; name: optionalKey<String> }>>>; id: String; introductionVersion: optionalKey<String>; kind: Literals<readonly ["function", "const", "class", "interface", "type", "variable", "namespace"]>; link: optionalKey<Struct<{ external: Boolean; href: String; label: optionalKey<String> }>>; name: String; signature: String; source: optionalKey<Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>> }>;

Signature

export declare const ApiReferenceDescriptionPartSchema: Struct<{ code: optionalKey<Boolean>; external: optionalKey<Boolean>; href: optionalKey<String>; kind: Literals<readonly ["text", "link"]>; text: String }>;

ApiReferenceRecordSchemaVARIABLE

Signature

export declare const ApiReferenceRecordSchema: Struct<{ breadcrumbs: $Array<Struct<{ current: Boolean; href: optionalKey<String>; label: String }>>; categories: $Array<Struct<{ collapsed: Boolean; id: String; label: String; order: Number }>>; declarations: $Array<Struct<{ category: optionalKey<String>; categoryId: String; description: optionalKey<String>; descriptionParts: optionalKey<$Array<Struct<{ code: optionalKey<Boolean>; external: optionalKey<Boolean>; href: optionalKey<String>; kind: Literals<readonly [(...), (...)]>; text: String }>>>; examples: optionalKey<$Array<Struct<{ code: String; language: optionalKey<String>; name: optionalKey<String> }>>>; id: String; introductionVersion: optionalKey<String>; kind: Literals<readonly ["function", "const", "class", "interface", "type", "variable", "namespace"]>; link: optionalKey<Struct<{ external: Boolean; href: String; label: optionalKey<String> }>>; name: String; signature: String; source: optionalKey<Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>> }>>; displayName: String; exportCount: Number; introductionVersion: optionalKey<String>; link: optionalKey<Struct<{ external: Boolean; href: String; label: optionalKey<String> }>>; module: String; packageDescription: optionalKey<String>; packageExports: optionalKey<$Array<String>>; packageId: String; packageName: String; packagePrivate: optionalKey<Boolean>; packageSourceUrl: optionalKey<String>; source: optionalKey<Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>>; summary: optionalKey<String>; summaryParts: optionalKey<$Array<Struct<{ code: optionalKey<Boolean>; external: optionalKey<Boolean>; href: optionalKey<String>; kind: Literals<readonly ["text", "link"]>; text: String }>>>; version: String }>;

ApiReferenceSourceSchemaVARIABLE

Signature

export declare const ApiReferenceSourceSchema: Struct<{ endLine: optionalKey<Number>; file: String; line: optionalKey<Number>; repositoryUrl: String; revision: String }>;

ColorTokensSchemaVARIABLE

Signature

export declare const ColorTokensSchema: Struct<{ accent: String; background: String; border: String; cardBackground: optionalKey<String>; codeBackground: String; foreground: String; muted: String; proseForeground: optionalKey<String>; subtleForeground: optionalKey<String> }>;

DesignTokensSchemaVARIABLE

Signature

export declare const DesignTokensSchema: Struct<{ dark: Struct<{ accent: String; background: String; border: String; cardBackground: optionalKey<String>; codeBackground: String; foreground: String; muted: String; proseForeground: optionalKey<String>; subtleForeground: optionalKey<String> }>; light: Struct<{ accent: String; background: String; border: String; cardBackground: optionalKey<String>; codeBackground: String; foreground: String; muted: String; proseForeground: optionalKey<String>; subtleForeground: optionalKey<String> }> }>;

DicebearLogoSchemaVARIABLE

Signature

export declare const DicebearLogoSchema: Struct<{ props: optionalKey<$Record<String, Unknown>>; style: optionalKey<String>; type: Literal<"dicebear"> }>;

DocsConfigInputSchemaVARIABLE

Signature

export declare const DocsConfigInputSchema: Struct<{ agent: optionalKey<Struct<{ description: optionalKey<String>; enabled: optionalKey<Boolean>; essentials: optionalKey<$Array<String>>; mcp: optionalKey<Struct<{ enabled: optionalKey<Boolean> }>>; skill: optionalKey<Struct<{ enabled: optionalKey<Boolean>; name: optionalKey<String> }>> }>>; api: optionalKey<Struct<{ enabled: optionalKey<Boolean>; entryPoints: optionalKey<$Array<String>>; outputDirectory: optionalKey<String>; packages: optionalKey<$Array<String>>; sourceRepository: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; typedoc: optionalKey<$Record<String, Unknown>> }>>; footer: optionalKey<Struct<{ columns: optionalKey<$Array<Struct<{ links: $Array<Struct<(...)>>; title: String }>>>; links: optionalKey<$Array<Struct<{ href: String; icon: optionalKey<String>; label: String }>>>; message: optionalKey<String> }>>; landing: optionalKey<Struct<{ description: optionalKey<String>; primaryAction: optionalKey<Struct<{ href: String; label: String }>>; sections: optionalKey<$Array<Struct<{ body: optionalKey<String>; href: optionalKey<String>; id: String; title: String }>>>; title: optionalKey<String> }>>; manifests: optionalKey<$Array<Struct<{ checksum: optionalKey<String>; generatedAt: optionalKey<String>; kind: Literals<readonly ["site", "api-reference", "storybook", "project"]>; path: String; revision: optionalKey<String> }>>>; metadata: optionalKey<Struct<{ description: optionalKey<String>; logo: optionalKey<Union<readonly [String, Struct<{ props: optionalKey<(...)>; style: optionalKey<(...)>; type: Literal<(...)> }>]>>; name: optionalKey<String>; repository: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; title: optionalKey<String>; url: optionalKey<String> }>>; navigation: optionalKey<Struct<{ groups: optionalKey<$Array<Struct<{ id: String; items: $Array<Schema<(...)>>; label: String }>>> }>>; packages: optionalKey<$Array<Struct<{ description: optionalKey<String>; directory: optionalKey<String>; id: String; name: String; source: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; version: optionalKey<String> }>>>; redirects: optionalKey<$Array<Struct<{ from: String; status: optionalKey<Literals<readonly [301, 302]>>; to: String }>>>; routing: optionalKey<Struct<{ documentationPrefix: optionalKey<String>; storybookPrefix: optionalKey<String> }>>; storybook: optionalKey<Struct<{ command: optionalKey<String>; directory: optionalKey<String>; enabled: optionalKey<Boolean>; stories: optionalKey<$Array<String>>; url: optionalKey<String> }>>; tokens: optionalKey<Struct<{ dark: optionalKey<Struct<{ accent: optionalKey<String>; background: optionalKey<String>; border: optionalKey<String>; cardBackground: optionalKey<String>; codeBackground: optionalKey<String>; foreground: optionalKey<String>; muted: optionalKey<String>; proseForeground: optionalKey<String>; subtleForeground: optionalKey<String> }>>; light: optionalKey<Struct<{ accent: optionalKey<String>; background: optionalKey<String>; border: optionalKey<String>; cardBackground: optionalKey<String>; codeBackground: optionalKey<String>; foreground: optionalKey<String>; muted: optionalKey<String>; proseForeground: optionalKey<String>; subtleForeground: optionalKey<String> }>> }>>; vercel: optionalKey<Struct<{ domains: optionalKey<$Array<String>>; enabled: optionalKey<Boolean>; outputDirectory: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; projects: optionalKey<Struct<{ documentation: optionalKey<Struct<{ directory: ...; id: ...; origin: ...; productionBranch: ...; project: ...; routePrefix: ...; team: ... }>>; landing: optionalKey<Struct<{ directory: ...; id: ...; origin: ...; productionBranch: ...; project: ...; routePrefix: ...; team: ... }>>; mcp: optionalKey<Struct<{ directory: ...; id: ...; origin: ...; productionBranch: ...; project: ...; routePrefix: ...; team: ... }>>; storybook: optionalKey<Struct<{ directory: ...; id: ...; origin: ...; productionBranch: ...; project: ...; routePrefix: ...; team: ... }>> }>>; team: optionalKey<String> }>>; versions: optionalKey<$Array<Struct<{ current: optionalKey<Boolean>; directory: optionalKey<String>; href: optionalKey<String>; id: String; label: optionalKey<String>; order: optionalKey<Number>; version: optionalKey<String> }>>> }>;

DocumentationVersionSchemaVARIABLE

Signature

export declare const DocumentationVersionSchema: Struct<{ current: Boolean; directory: String; href: optionalKey<String>; id: String; label: String; order: Number; version: optionalKey<String> }>;

GeneratedManifestSchemaVARIABLE

Signature

export declare const GeneratedManifestSchema: Struct<{ checksum: optionalKey<String>; generatedAt: optionalKey<String>; kind: Literals<readonly ["site", "api-reference", "storybook", "project"]>; path: String; revision: optionalKey<String> }>;

LandingContentSchemaVARIABLE

Signature

export declare const LandingContentSchema: Struct<{ description: String; primaryAction: optionalKey<Struct<{ href: String; label: String }>>; sections: $Array<Struct<{ body: String; href: optionalKey<String>; id: String; title: String }>>; title: String }>;

LandingSectionSchemaVARIABLE

Signature

export declare const LandingSectionSchema: Struct<{ body: String; href: optionalKey<String>; id: String; title: String }>;

PackageReferenceSchemaVARIABLE

Signature

export declare const PackageReferenceSchema: Struct<{ description: optionalKey<String>; directory: optionalKey<String>; id: String; name: String; source: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; version: optionalKey<String> }>;

RedirectSchemaVARIABLE

Signature

export declare const RedirectSchema: Struct<{ from: String; status: Literals<readonly [301, 302]>; to: String }>;

RepositorySchemaVARIABLE

Signature

export declare const RepositorySchema: Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>;

SiteMetadataSchemaVARIABLE

Signature

export declare const SiteMetadataSchema: Struct<{ description: String; logo: optionalKey<Union<readonly [String, Struct<{ props: optionalKey<$Record<String, Unknown>>; style: optionalKey<String>; type: Literal<"dicebear"> }>]>>; name: String; repository: optionalKey<Struct<{ branch: optionalKey<String>; directory: optionalKey<String>; url: String }>>; title: String; url: String }>;

SiteRoutingSchemaVARIABLE

Signature

export declare const SiteRoutingSchema: Struct<{ documentationPrefix: String; storybookPrefix: String }>;

StableLinkSchemaVARIABLE

Signature

export declare const StableLinkSchema: Struct<{ external: Boolean; href: String; label: optionalKey<String> }>;

StorybookConfigSchemaVARIABLE

Signature

export declare const StorybookConfigSchema: Struct<{ command: optionalKey<String>; directory: optionalKey<String>; enabled: Boolean; stories: $Array<String>; url: optionalKey<String> }>;

VercelConfigSchemaVARIABLE

Signature

export declare const VercelConfigSchema: Struct<{ domains: $Array<String>; enabled: Boolean; outputDirectory: String; productionBranch: String; project: optionalKey<String>; projects: Struct<{ documentation: Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>; landing: Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>; mcp: optionalKey<Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>>; storybook: optionalKey<Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>> }>; team: optionalKey<String> }>;

VercelDeploymentSchemaVARIABLE

Signature

export declare const VercelDeploymentSchema: Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>;

VercelDeploymentsSchemaVARIABLE

Signature

export declare const VercelDeploymentsSchema: Struct<{ documentation: Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>; landing: Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>; mcp: optionalKey<Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>>; storybook: optionalKey<Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>> }>;

VercelProjectSchemaVARIABLE

Signature

export declare const VercelProjectSchema: Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>;

VercelProjectsSchemaVARIABLE

Signature

export declare const VercelProjectsSchema: Struct<{ documentation: Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>; landing: Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>; mcp: optionalKey<Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>>; storybook: optionalKey<Struct<{ directory: String; id: optionalKey<String>; origin: optionalKey<String>; productionBranch: optionalKey<String>; project: optionalKey<String>; routePrefix: String; team: optionalKey<String> }>> }>;

VercelReleaseManifestSchemaVARIABLE

Signature

export declare const VercelReleaseManifestSchema: Struct<{ apiSnapshot: optionalKey<String>; deployments: Struct<{ documentation: Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>; landing: Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>; mcp: optionalKey<Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>>; storybook: optionalKey<Struct<{ deploymentId: String; project: String; revision: optionalKey<String>; url: String }>> }>; generatedAt: String; landingConfig: Unknown; mcpEndpoint: optionalKey<String>; mode: Literals<readonly ["preview", "production"]>; previousReleaseId: optionalKey<String>; publicUrl: String; releaseId: String; revision: String; routes: Struct<{ documentationPrefix: String; storybookPrefix: String }>; version: Literals<readonly [2]> }>;