vitepress-plugin-api-extractor 0.2.0 → 0.2.2

package/index.d.ts

@@ -27,7 +27,7 @@ interface CategoryConfig extends WorkItemCategory {
  *
  * @public
  */
-declare const DEFAULT_CATEGORIES: Readonly<Record<string, CategoryConfig>>;
+export declare const DEFAULT_CATEGORIES: Readonly<Record<string, CategoryConfig>>;
 //#endregion
 //#region src/emit/sidebar.d.ts
 /**
@@ -60,14 +60,14 @@ type SidebarMulti = Record<string, SidebarItem[]>;
  *
  * @public
  */
-declare function sidebarItems(tree: NavTree): SidebarItem[];
+export 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;
+export declare function sidebarFor(tree: NavTree): SidebarMulti;
 //#endregion
 //#region src/Registry.d.ts
 /**
@@ -77,7 +77,7 @@ declare function sidebarFor(tree: NavTree): SidebarMulti;
  *
  * @public
  */
-declare const TSDOCTOR_NAMESPACE = "tsdoctor";
+export declare const TSDOCTOR_NAMESPACE = "tsdoctor";
 /**
  * An external package to load declarations for.
  *
@@ -109,7 +109,7 @@ interface ExternalTypesReport {
  *
  * @public
  */
-declare function externalPackagesOf(packageJson: Record<string, unknown> | undefined): ReadonlyArray<ExternalPackage>;
+export 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
@@ -123,7 +123,7 @@ declare function externalPackagesOf(packageJson: Record<string, unknown> | undef
  *
  * @public
  */
-declare const loadExternalTypes: (vfs: Vfs, packages: readonly ExternalPackage[], documented: ReadonlySet<string>) => Effect.Effect<{
+export declare const loadExternalTypes: (vfs: Vfs, packages: readonly ExternalPackage[], documented: ReadonlySet<string>) => Effect.Effect<{
   loaded: never[];
   skipped: string[];
   warning: string;
@@ -212,7 +212,7 @@ interface GenerateResult {
  *
  * @public
  */
-declare const generate: (input: GenerateInput) => Effect.Effect<{
+export declare const generate: (input: GenerateInput) => Effect.Effect<{
   packageName: string;
   baseRoute: string;
   sidebar: SidebarMulti;
@@ -287,7 +287,7 @@ declare const TwoslashCacheStore_base: Context.ServiceClass<TwoslashCacheStore,
  *
  * @public
  */
-declare class TwoslashCacheStore extends TwoslashCacheStore_base {
+export declare class TwoslashCacheStore extends TwoslashCacheStore_base {
   /**
    * The live store over the XDG sqlite cache.
    *
@@ -382,7 +382,7 @@ interface ApiExtractorResult {
  *
  * @public
  */
-declare function apiExtractor(options: ApiExtractorOptions): Promise<ApiExtractorResult>;
+export declare function apiExtractor(options: ApiExtractorOptions): Promise<ApiExtractorResult>;
 //#endregion
 //#region src/emit/frontmatter.d.ts
 /**
@@ -397,7 +397,7 @@ type HeadConfig = [string, Record<string, string>] | [string, Record<string, str
  *
  * @public
  */
-declare function headConfig(tag: HeadTag): HeadConfig;
+export declare function headConfig(tag: HeadTag): HeadConfig;
 /**
  * The facts a page's frontmatter is built from.
  *
@@ -417,7 +417,7 @@ interface FrontmatterInput {
  *
  * @public
  */
-declare function emitFrontmatter(input: FrontmatterInput): string;
+export declare function emitFrontmatter(input: FrontmatterInput): string;
 //#endregion
 //#region src/emit/markdown.d.ts
 /**
@@ -426,20 +426,20 @@ declare function emitFrontmatter(input: FrontmatterInput): string;
  *
  * @public
  */
-declare const TWOSLASH_META = "twoslash";
+export declare const TWOSLASH_META = "twoslash";
 /**
  * Render one block to flow nodes.
  *
  * @public
  */
-declare function markdownBlockTree(block: Block): ReadonlyArray<FlowContent>;
+export 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>;
+export 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`).
@@ -451,7 +451,7 @@ declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
  *
  * @public
  */
-declare function emitMarkdownBody(page: Page): Result.Result<string, MarkdownStringifyError>;
+export declare function emitMarkdownBody(page: Page): Result.Result<string, MarkdownStringifyError>;
 //#endregion
 //#region src/Twoslash.d.ts
 /**
@@ -474,7 +474,7 @@ interface TwoslashTransformerOptions {
  *
  * @public
  */
-declare function environmentHash(vfs: Vfs): string;
+export declare function environmentHash(vfs: Vfs): string;
 /**
  * Build the Shiki transformer for VitePress's `markdown.codeTransformers`.
  *
@@ -486,7 +486,7 @@ declare function environmentHash(vfs: Vfs): string;
  *
  * @public
  */
-declare function makeTwoslashTransformer(options: TwoslashTransformerOptions): ShikiTransformer;
+export 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 };
+export type { ApiExtractorOptions, ApiExtractorResult, CategoryConfig, ExternalPackage, ExternalTypesReport, FrontmatterInput, GenerateInput, GenerateResult, GenerateServices, HeadConfig, SidebarItem, SidebarMulti, TwoslashCacheReport, TwoslashCacheStoreShape, TwoslashTransformerOptions };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vitepress-plugin-api-extractor",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"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": [
@@ -37,23 +37,23 @@
 		"./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",
+		"@effect/platform-node": "4.0.0-rc.112",
+		"@effected/markdown": "^0.9.0",
+		"@effected/package-json": "^0.14.0",
+		"@effected/store": "^0.7.0",
+		"@effected/tsconfig-json": "^0.8.0",
+		"@effected/xdg": "^0.4.0",
 		"@microsoft/api-extractor-model": "^7.33.11",
 		"@shikijs/twoslash": "^4.4.3",
 		"@shikijs/vitepress-twoslash": "^4.4.3",
-		"@tsdoctor/bundle": "0.3.0",
-		"@tsdoctor/manifest": "0.1.0",
-		"@tsdoctor/model": "0.6.1",
-		"@tsdoctor/pages": "0.1.2",
-		"@tsdoctor/registry": "0.3.2",
-		"@tsdoctor/seo": "0.2.0",
-		"@tsdoctor/vfs": "0.2.1",
-		"effect": "4.0.0-rc.109",
+		"@tsdoctor/bundle": "0.3.1",
+		"@tsdoctor/manifest": "0.1.1",
+		"@tsdoctor/model": "0.6.3",
+		"@tsdoctor/pages": "0.1.4",
+		"@tsdoctor/registry": "0.3.4",
+		"@tsdoctor/seo": "0.2.1",
+		"@tsdoctor/vfs": "0.2.2",
+		"effect": "4.0.0-rc.112",
 		"image-size": "^2.0.2",
 		"shiki": "^4.4.3",
 		"typescript": "^6.0.3"