vitepress-plugin-api-extractor 0.1.0

package/index.d.ts

@@ -0,0 +1,477 @@
+import { ShikiTransformer } from "shiki";
+import { Block, CrossLinkData, NavTree, Page, WorkItemCategory } from "@tsdoctor/pages";
+import { Model } from "@tsdoctor/model";
+import { TypeRegistry } from "@tsdoctor/registry";
+import { TwoslashCacheStats, TwoslashResultCache, TypeResolutionCompilerOptions, Vfs } from "@tsdoctor/vfs";
+import { Context, Effect, FileSystem, Layer, Option, Path, Result } from "effect";
+import "@effected/xdg";
+import { HeadTag } from "@tsdoctor/seo";
+import { FlowContent, MarkdownStringifyError } from "@effected/markdown";
+import { TwoslashTypesCache } from "@shikijs/twoslash";
+//#region src/Categories.d.ts
+/**
+ * A category as this adapter configures it: how items match it, where its
+ * pages live, and how its sidebar group presents.
+ *
+ * @public
+ */
+interface CategoryConfig extends WorkItemCategory {
+  /** Whether the sidebar group can be collapsed. Defaults to `true`. */
+  readonly collapsible?: boolean | undefined;
+  /** Whether the sidebar group starts collapsed. Defaults to `true`. */
+  readonly collapsed?: boolean | undefined;
+}
+/**
+ * The default categories, in sidebar order.
+ *
+ * @public
+ */
+declare const DEFAULT_CATEGORIES: Readonly<Record<string, CategoryConfig>>;
+//#endregion
+//#region src/emit/sidebar.d.ts
+/**
+ * One VitePress sidebar item — the subset of the default theme's
+ * `SidebarItem` this adapter emits. Arrays are mutable because VitePress's
+ * own `Sidebar` type is, and a `ReadonlyArray` would not assign to it.
+ *
+ * @public
+ */
+interface SidebarItem {
+  /** The item label. */
+  readonly text: string;
+  /** The page route, when the item is a link. */
+  readonly link?: string;
+  /** Child items, when the item is a group. */
+  readonly items?: SidebarItem[];
+  /** Whether a group starts collapsed; absent leaves it always open. */
+  readonly collapsed?: boolean;
+}
+/**
+ * A multi-sidebar object: sidebar items keyed by the path prefix they
+ * apply to.
+ *
+ * @public
+ */
+type SidebarMulti = Record<string, SidebarItem[]>;
+/**
+ * The sidebar items for one API: the index link, then one group per
+ * category in the tree's order.
+ *
+ * @public
+ */
+declare function sidebarItems(tree: NavTree): SidebarItem[];
+/**
+ * The `themeConfig.sidebar` entry for one API, keyed by its base route so
+ * the sidebar shows only under the API's pages.
+ *
+ * @public
+ */
+declare function sidebarFor(tree: NavTree): SidebarMulti;
+//#endregion
+//#region src/Registry.d.ts
+/**
+ * The XDG namespace every tsdoctor cache lives under — shared with the
+ * RSPress plugin so both adapters read one type cache and one Twoslash
+ * result cache.
+ *
+ * @public
+ */
+declare const TSDOCTOR_NAMESPACE = "tsdoctor";
+/**
+ * An external package to load declarations for.
+ *
+ * @public
+ */
+interface ExternalPackage {
+  /** The npm package name. */
+  readonly name: string;
+  /** The version spec as declared: exact, range or dist-tag. */
+  readonly version: string;
+}
+/**
+ * The outcome of {@link loadExternalTypes}: what merged, what was skipped
+ * and why. Never a failure.
+ *
+ * @public
+ */
+interface ExternalTypesReport {
+  /** Packages whose declarations were merged. */
+  readonly loaded: ReadonlyArray<string>;
+  /** Packages dropped because no published version matched, or loading failed. */
+  readonly skipped: ReadonlyArray<string>;
+  /** A human-readable reason when the whole batch degraded. */
+  readonly warning?: string;
+}
+/**
+ * The external packages a documented package's manifest declares, in the
+ * `dependencies` and `peerDependencies` fields.
+ *
+ * @public
+ */
+declare function externalPackagesOf(packageJson: Record<string, unknown> | undefined): ReadonlyArray<ExternalPackage>;
+/**
+ * Resolve each package to an exact published version and merge its
+ * declarations into `vfs`, in place. First-party packages (the ones being
+ * documented) are excluded: their api.json-derived declarations are
+ * authoritative and a published copy would clobber them.
+ *
+ * @remarks
+ * Degrades, never fails: an unresolvable package is skipped, and an
+ * infrastructure failure (no HOME for XDG, an unreachable CDN) leaves the
+ * VFS as it was with a `warning` in the report.
+ *
+ * @public
+ */
+declare const loadExternalTypes: (vfs: Vfs, packages: readonly ExternalPackage[], documented: ReadonlySet<string>) => Effect.Effect<{
+  loaded: never[];
+  skipped: string[];
+  warning: string;
+} | {
+  warning?: never;
+  loaded: string[];
+  skipped: string[];
+}, never, TypeRegistry>;
+//#endregion
+//#region src/Generate.d.ts
+/**
+ * The input to {@link generate}.
+ *
+ * @public
+ */
+interface GenerateInput {
+  /** The bundle folder: the api.json model plus its package.json and tsconfig. */
+  readonly dir: string;
+  /** Base for resolving `dir` and `docsDir`. */
+  readonly cwd: string;
+  /** VitePress's source directory; pages are written under it. */
+  readonly docsDir: string;
+  /** The route the API is mounted at, e.g. `/api`. */
+  readonly baseRoute: string;
+  /** The API's display name — the last title part, when the site names one. */
+  readonly apiName?: string | undefined;
+  /** The site origin, for canonical and Open Graph URLs; absent leaves them root-relative. */
+  readonly siteOrigin?: string | undefined;
+  /** VitePress's `base`. */
+  readonly base?: string | undefined;
+  /** Category overrides, merged over {@link DEFAULT_CATEGORIES} by key. */
+  readonly categories?: Readonly<Record<string, Partial<CategoryConfig>>> | undefined;
+  /** External packages to load declarations for; defaults to the manifest's dependencies. */
+  readonly externalPackages?: ReadonlyArray<ExternalPackage> | undefined;
+  /** Whether examples carry `@noErrors`; defaults to `true`. */
+  readonly suppressExampleErrors?: boolean | undefined;
+  /** The source repository, when the site links to it. */
+  readonly source?: {
+    readonly url: string;
+    readonly ref?: string | undefined;
+  } | undefined;
+}
+/**
+ * What generation produced, for the site's config and for the report.
+ *
+ * @public
+ */
+interface GenerateResult {
+  /** The documented package's name. */
+  readonly packageName: string;
+  /** The API's base route. */
+  readonly baseRoute: string;
+  /** The `themeConfig.sidebar` entry. */
+  readonly sidebar: SidebarMulti;
+  /** The combined virtual file system Twoslash checks against. */
+  readonly vfs: Vfs;
+  /** The resolved compiler options. */
+  readonly compilerOptions: TypeResolutionCompilerOptions;
+  /** Every page route written, in generation order. */
+  readonly routes: ReadonlyArray<string>;
+  /** The cross-link route map the pages were linked against. */
+  readonly crossLinkData: CrossLinkData;
+  /** What external type loading did. */
+  readonly externalTypes: ExternalTypesReport;
+  /** Items no category matched; they got no page. */
+  readonly uncategorized: ReadonlyArray<string>;
+  /** Items whose examples Prettier could not format, by display name. */
+  readonly formatFailures: ReadonlyArray<string>;
+}
+/**
+ * Generate the API pages for one bundle.
+ *
+ * @remarks
+ * Fails typed on what a user can fix — a missing bundle folder, an
+ * unreadable model — and degrades on what is an enhancement (external types,
+ * a manifest the SEO layer cannot decode, an example Prettier rejects). The
+ * error channel is the union of `@tsdoctor/bundle`'s discovery errors,
+ * `@tsdoctor/model`'s load errors and the platform's write errors.
+ *
+ * @public
+ */
+declare const generate: (input: GenerateInput) => Effect.Effect<{
+  packageName: string;
+  baseRoute: string;
+  sidebar: SidebarMulti;
+  vfs: Vfs;
+  compilerOptions: {
+    readonly target?: "es2015" | "es2016" | "es2017" | "es2018" | "es2019" | "es2020" | "es2021" | "es2022" | "es2023" | "es2024" | "es2025" | "es5" | "es6" | "esnext";
+    readonly module?: "amd" | "commonjs" | "es2015" | "es2020" | "es2022" | "es6" | "esnext" | "node16" | "node18" | "node20" | "nodenext" | "none" | "preserve" | "system" | "umd";
+    readonly moduleResolution?: "bundler" | "classic" | "node" | "node10" | "node16" | "nodenext";
+    readonly jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
+    readonly lib?: readonly ("decorators" | "decorators.legacy" | "dom" | "dom.asynciterable" | "dom.iterable" | "es2015" | "es2015.collection" | "es2015.core" | "es2015.generator" | "es2015.iterable" | "es2015.promise" | "es2015.proxy" | "es2015.reflect" | "es2015.symbol" | "es2015.symbol.wellknown" | "es2016" | "es2016.array.include" | "es2016.intl" | "es2017" | "es2017.arraybuffer" | "es2017.date" | "es2017.intl" | "es2017.object" | "es2017.sharedmemory" | "es2017.string" | "es2017.typedarrays" | "es2018" | "es2018.asyncgenerator" | "es2018.asynciterable" | "es2018.intl" | "es2018.promise" | "es2018.regexp" | "es2019" | "es2019.array" | "es2019.intl" | "es2019.object" | "es2019.string" | "es2019.symbol" | "es2020" | "es2020.bigint" | "es2020.date" | "es2020.intl" | "es2020.number" | "es2020.promise" | "es2020.sharedmemory" | "es2020.string" | "es2020.symbol.wellknown" | "es2021" | "es2021.intl" | "es2021.promise" | "es2021.string" | "es2021.weakref" | "es2022" | "es2022.array" | "es2022.error" | "es2022.intl" | "es2022.object" | "es2022.regexp" | "es2022.string" | "es2023" | "es2023.array" | "es2023.collection" | "es2023.intl" | "es2024" | "es2024.arraybuffer" | "es2024.collection" | "es2024.object" | "es2024.promise" | "es2024.regexp" | "es2024.sharedmemory" | "es2024.string" | "es2025" | "es2025.collection" | "es2025.float16" | "es2025.intl" | "es2025.iterator" | "es2025.promise" | "es2025.regexp" | "es5" | "es6" | "es7" | "esnext" | "esnext.array" | "esnext.asynciterable" | "esnext.bigint" | "esnext.collection" | "esnext.date" | "esnext.decorators" | "esnext.disposable" | "esnext.error" | "esnext.float16" | "esnext.intl" | "esnext.iterator" | "esnext.object" | "esnext.promise" | "esnext.regexp" | "esnext.sharedmemory" | "esnext.string" | "esnext.symbol" | "esnext.temporal" | "esnext.typedarrays" | "esnext.weakref" | "scripthost" | "webworker" | "webworker.asynciterable" | "webworker.importscripts" | "webworker.iterable")[];
+    readonly types?: readonly string[];
+    readonly typeRoots?: readonly string[];
+    readonly strict?: boolean;
+    readonly skipLibCheck?: boolean;
+    readonly esModuleInterop?: boolean;
+    readonly allowSyntheticDefaultImports?: boolean;
+  };
+  routes: string[];
+  crossLinkData: CrossLinkData;
+  externalTypes: {
+    loaded: never[];
+    skipped: string[];
+    warning: string;
+  } | {
+    warning?: never;
+    loaded: string[];
+    skipped: string[];
+  };
+  uncategorized: string[];
+  formatFailures: string[];
+}, import("@tsdoctor/bundle").BundleDiscoveryError | import("@tsdoctor/bundle").BundleLayerError | Model.ModelNotFoundError | Model.ModelParseError | import("effect/PlatformError").PlatformError, FileSystem.FileSystem | Path.Path | TypeRegistry>;
+/**
+ * The services {@link generate} runs over: the platform plus the registry.
+ *
+ * @public
+ */
+type GenerateServices = FileSystem.FileSystem | Path.Path | TypeRegistry;
+//#endregion
+//#region src/TwoslashCache.d.ts
+/**
+ * The stats a persisted generation reports, with the environment it was
+ * stored under.
+ *
+ * @public
+ */
+interface TwoslashCacheReport extends TwoslashCacheStats {
+  /** The type-environment hash the generation is keyed by. */
+  readonly envHash: string;
+  /** Whether the underlying store degraded at construction. */
+  readonly degraded: boolean;
+}
+/**
+ * The Twoslash generation store's contract.
+ *
+ * @public
+ */
+interface TwoslashCacheStoreShape {
+  /**
+   * Open the generation for `envHash` — seeded from the store — and hold it
+   * until {@link TwoslashCacheStoreShape.persist}.
+   */
+  readonly open: (envHash: string) => Effect.Effect<TwoslashResultCache>;
+  /**
+   * Persist what this build produced, if a generation was opened and it is
+   * dirty; report the stats either way.
+   */
+  readonly persist: () => Effect.Effect<Option.Option<TwoslashCacheReport>>;
+}
+declare const TwoslashCacheStore_base: Context.ServiceClass<TwoslashCacheStore, "vitepress-plugin-api-extractor/TwoslashCacheStore", TwoslashCacheStoreShape>;
+/**
+ * The Twoslash generation store.
+ *
+ * @public
+ */
+declare class TwoslashCacheStore extends TwoslashCacheStore_base {
+  /**
+   * The live store over the XDG sqlite cache.
+   *
+   * @remarks
+   * `Layer.suspend` because the composition below is declared after this
+   * class: a static initializer runs while the module body is still
+   * evaluating, so naming those consts directly throws at import time with a
+   * clean typecheck.
+   */
+  static readonly layer: Layer.Layer<TwoslashCacheStore>;
+  /** An always-cold in-memory store, for tests. */
+  static readonly layerTest: Layer.Layer<TwoslashCacheStore>;
+}
+//#endregion
+//#region src/ApiExtractor.d.ts
+/**
+ * The options {@link apiExtractor} takes.
+ *
+ * @public
+ */
+interface ApiExtractorOptions {
+  /** The bundle folder: the api.json model plus its package.json and tsconfig. */
+  readonly dir: string;
+  /** Base for resolving `dir` and `docsDir`. Defaults to `process.cwd()`. */
+  readonly cwd?: string | undefined;
+  /** VitePress's source directory. Defaults to `docs`. */
+  readonly docsDir?: string | undefined;
+  /** The route the API is mounted at. Defaults to `/api`. */
+  readonly baseRoute?: string | undefined;
+  /** The API's display name — the last title part, when the site names one. */
+  readonly name?: string | undefined;
+  /** The site origin, for canonical and Open Graph URLs. */
+  readonly siteOrigin?: string | undefined;
+  /** VitePress's `base`, when set. */
+  readonly base?: string | undefined;
+  /** Category overrides, merged over the defaults by key. */
+  readonly categories?: Readonly<Record<string, Partial<CategoryConfig>>> | undefined;
+  /** External packages to load declarations for; defaults to the manifest's dependencies. */
+  readonly externalPackages?: ReadonlyArray<ExternalPackage> | undefined;
+  /** Whether examples carry `@noErrors`. Defaults to `true`. */
+  readonly suppressExampleErrors?: boolean | undefined;
+  /** The source repository, when the site links to it. */
+  readonly source?: {
+    readonly url: string;
+    readonly ref?: string | undefined;
+  } | undefined;
+  /** Whether to print a one-line summary. Defaults to `true`. */
+  readonly log?: boolean | undefined;
+}
+/**
+ * What {@link apiExtractor} returns for the site to merge into its config.
+ *
+ * @public
+ */
+interface ApiExtractorResult {
+  /** The `themeConfig.sidebar` entry for the API. */
+  readonly sidebar: SidebarMulti;
+  /** The `markdown.codeTransformers` entries: the Twoslash transformer. */
+  readonly codeTransformers: ReadonlyArray<ShikiTransformer>;
+  /** Hooks for the site's config. */
+  readonly hooks: {
+    /** Persist the Twoslash result cache; the site's `buildEnd`. */
+    readonly buildEnd: () => Promise<TwoslashCacheReport | undefined>;
+  };
+  /** What generation produced. */
+  readonly generated: GenerateResult;
+}
+/**
+ * Generate the API pages and return what the site's config needs.
+ *
+ * @example
+ * ```ts
+ * // .vitepress/config.mts
+ * import { defineConfig } from "vitepress";
+ * import { apiExtractor } from "vitepress-plugin-api-extractor";
+ *
+ * const api = await apiExtractor({ dir: "./lib/models/kitchensink" });
+ *
+ * export default defineConfig({
+ *   themeConfig: { sidebar: api.sidebar },
+ *   markdown: { codeTransformers: [...api.codeTransformers] },
+ *   buildEnd: async () => { await api.hooks.buildEnd(); },
+ * });
+ * ```
+ *
+ * @public
+ */
+declare function apiExtractor(options: ApiExtractorOptions): Promise<ApiExtractorResult>;
+//#endregion
+//#region src/emit/frontmatter.d.ts
+/**
+ * One VitePress head entry: a pair for an attribute-only tag, a triple when
+ * the tag carries inner HTML.
+ *
+ * @public
+ */
+type HeadConfig = [string, Record<string, string>] | [string, Record<string, string>, string];
+/**
+ * Render a neutral head tag into VitePress's `HeadConfig` entry.
+ *
+ * @public
+ */
+declare function headConfig(tag: HeadTag): HeadConfig;
+/**
+ * The facts a page's frontmatter is built from.
+ *
+ * @public
+ */
+interface FrontmatterInput {
+  /** The page title. */
+  readonly title: string;
+  /** The page description. */
+  readonly description: string;
+  /** Every head tag the page carries. */
+  readonly headTags?: ReadonlyArray<HeadTag> | undefined;
+}
+/**
+ * Emit the frontmatter block for a page: `title`, `description` and, when
+ * the page carries any, `head` in VitePress's `HeadConfig[]` shape.
+ *
+ * @public
+ */
+declare function emitFrontmatter(input: FrontmatterInput): string;
+//#endregion
+//#region src/emit/markdown.d.ts
+/**
+ * The fence info string that triggers Twoslash under VitePress's default
+ * `explicitTrigger`.
+ *
+ * @public
+ */
+declare const TWOSLASH_META = "twoslash";
+/**
+ * Render one block to flow nodes.
+ *
+ * @public
+ */
+declare function markdownBlockTree(block: Block): ReadonlyArray<FlowContent>;
+/**
+ * Render a page's body to flow nodes — the pre-serialization form of
+ * {@link emitMarkdownBody}.
+ *
+ * @public
+ */
+declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
+/**
+ * Emit a page's markdown body. No frontmatter — the adapter assembles that
+ * from the page facts (see `emit/frontmatter.ts`).
+ *
+ * @remarks
+ * A stringify failure is surfaced rather than thrown: the prose inside a
+ * block arrived from a builder and may carry any node the kit admits, and the
+ * kit's own error names what it could not serialize.
+ *
+ * @public
+ */
+declare function emitMarkdownBody(page: Page): Result.Result<string, MarkdownStringifyError>;
+//#endregion
+//#region src/Twoslash.d.ts
+/**
+ * Everything one Twoslash transformer needs.
+ *
+ * @public
+ */
+interface TwoslashTransformerOptions {
+  /** Declaration files every code block is checked against. */
+  readonly vfs: Vfs;
+  /** The configuration to check under; defaults apply when omitted. */
+  readonly compilerOptions?: TypeResolutionCompilerOptions | undefined;
+  /** The persisted result cache; a hit skips the type-check entirely. */
+  readonly typesCache?: TwoslashTypesCache | undefined;
+}
+/**
+ * Fingerprint the type environment: the declarations plus the compiler that
+ * interprets them, so a generation cached by one TypeScript is never served
+ * by another.
+ *
+ * @public
+ */
+declare function environmentHash(vfs: Vfs): string;
+/**
+ * Build the Shiki transformer for VitePress's `markdown.codeTransformers`.
+ *
+ * @remarks
+ * Errors never throw: `noErrorValidation` lets a diagnostic render as an
+ * annotation, and `throws: false` keeps `@shikijs/vitepress-twoslash` from
+ * failing the build on one (it would, by default, on CI). Examples are
+ * documentation, not a test suite.
+ *
+ * @public
+ */
+declare function makeTwoslashTransformer(options: TwoslashTransformerOptions): ShikiTransformer;
+//#endregion
+export { type ApiExtractorOptions, type ApiExtractorResult, type CategoryConfig, DEFAULT_CATEGORIES, type ExternalPackage, type ExternalTypesReport, type FrontmatterInput, type GenerateInput, type GenerateResult, type GenerateServices, type HeadConfig, type SidebarItem, type SidebarMulti, TSDOCTOR_NAMESPACE, TWOSLASH_META, type TwoslashCacheReport, TwoslashCacheStore, type TwoslashCacheStoreShape, type TwoslashTransformerOptions, apiExtractor, emitFrontmatter, emitMarkdownBody, environmentHash, externalPackagesOf, generate, headConfig, loadExternalTypes, makeTwoslashTransformer, markdownBlockTree, markdownTree, sidebarFor, sidebarItems };
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,11 @@
+import { DEFAULT_CATEGORIES } from "./Categories.js";
+import { emitFrontmatter, headConfig } from "./emit/frontmatter.js";
+import { TWOSLASH_META, emitMarkdownBody, markdownBlockTree, markdownTree } from "./emit/markdown.js";
+import { sidebarFor, sidebarItems } from "./emit/sidebar.js";
+import { TSDOCTOR_NAMESPACE, externalPackagesOf, loadExternalTypes } from "./Registry.js";
+import { generate } from "./Generate.js";
+import { environmentHash, makeTwoslashTransformer } from "./Twoslash.js";
+import { TwoslashCacheStore } from "./TwoslashCache.js";
+import { apiExtractor } from "./ApiExtractor.js";
+
+export { DEFAULT_CATEGORIES, TSDOCTOR_NAMESPACE, TWOSLASH_META, TwoslashCacheStore, apiExtractor, emitFrontmatter, emitMarkdownBody, environmentHash, externalPackagesOf, generate, headConfig, loadExternalTypes, makeTwoslashTransformer, markdownBlockTree, markdownTree, sidebarFor, sidebarItems };

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "vitepress-plugin-api-extractor",
+	"version": "0.1.0",
+	"private": false,
+	"description": "VitePress adapter for generating API documentation from TypeScript API Extractor models: markdown pages over the @tsdoctor/pages IR, a sidebar from its navigation tree, and Twoslash type-checking over the same virtual file system the RSPress plugin resolves.",
+	"keywords": [
+		"vitepress",
+		"plugin",
+		"api-extractor",
+		"documentation",
+		"typescript",
+		"twoslash"
+	],
+	"homepage": "https://github.com/spencerbeggs/tsdoctor#readme",
+	"bugs": {
+		"url": "https://github.com/spencerbeggs/tsdoctor/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/spencerbeggs/tsdoctor.git",
+		"directory": "platforms/vitepress"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "C. Spencer Beggs",
+		"email": "spencer@beggs.codes",
+		"url": "https://spencerbeg.gs"
+	},
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js",
+			"default": "./index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"dependencies": {
+		"@effect/platform-node": "4.0.0-rc.109",
+		"@effected/markdown": "^0.8.0",
+		"@effected/package-json": "^0.13.0",
+		"@effected/store": "^0.6.0",
+		"@effected/tsconfig-json": "^0.7.0",
+		"@effected/xdg": "^0.3.0",
+		"@microsoft/api-extractor-model": "^7.33.11",
+		"@shikijs/twoslash": "^4.4.3",
+		"@shikijs/vitepress-twoslash": "^4.4.3",
+		"@tsdoctor/bundle": "0.2.2",
+		"@tsdoctor/model": "0.6.0",
+		"@tsdoctor/pages": "0.1.0",
+		"@tsdoctor/registry": "0.3.1",
+		"@tsdoctor/seo": "0.1.1",
+		"@tsdoctor/vfs": "0.2.0",
+		"effect": "4.0.0-rc.109",
+		"shiki": "^4.4.3",
+		"typescript": "^6.0.3"
+	},
+	"peerDependencies": {
+		"vitepress": "^2.0.0-alpha.19"
+	},
+	"engines": {
+		"node": ">=24.11.0"
+	}
+}

package/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.59.0"
+    }
+  ]
+}