rspress-plugin-api-extractor 0.3.0 → 0.3.2

package/api-extracted-package.js

@@ -1,4 +1,4 @@
-import { ApiItemKind, ApiModel } from "@microsoft/api-extractor-model";
+import { ApiItemKind, ApiModel, ExcerptTokenKind } from "@microsoft/api-extractor-model";
 import { VirtualPackage } from "type-registry-effect";
 
 //#region src/api-extracted-package.ts
@@ -82,10 +82,10 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (jsDoc) lines.push(jsDoc);
 		let name = apiClass.displayName;
 		if (apiClass.typeParameters?.length) name += this.formatTypeParameters(apiClass.typeParameters);
-		const headerParts = ["export declare class", name];
-		if (apiClass.extendsType) headerParts.push(`extends ${apiClass.extendsType.excerpt.text}`);
+		const headerParts = apiClass.isAbstract ? ["export declare abstract class", name] : ["export declare class", name];
+		if (apiClass.extendsType) headerParts.push(`extends ${this.renderExcerpt(apiClass.extendsType.excerpt)}`);
 		if (apiClass.implementsTypes?.length) {
-			const impl = apiClass.implementsTypes.map((t) => t.excerpt.text).join(", ");
+			const impl = apiClass.implementsTypes.map((t) => this.renderExcerpt(t.excerpt)).join(", ");
 			headerParts.push(`implements ${impl}`);
 		}
 		lines.push(`${headerParts.join(" ")} {`);
@@ -104,7 +104,7 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (apiInterface.typeParameters?.length) name += this.formatTypeParameters(apiInterface.typeParameters);
 		const headerParts = ["export declare interface", name];
 		if (apiInterface.extendsTypes?.length) {
-			const ext = apiInterface.extendsTypes.map((t) => t.excerpt.text).join(", ");
+			const ext = apiInterface.extendsTypes.map((t) => this.renderExcerpt(t.excerpt)).join(", ");
 			headerParts.push(`extends ${ext}`);
 		}
 		lines.push(`${headerParts.join(" ")} {`);
@@ -121,14 +121,14 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (jsDoc) lines.push(jsDoc);
 		let name = typeAlias.displayName;
 		if (typeAlias.typeParameters?.length) name += this.formatTypeParameters(typeAlias.typeParameters);
-		lines.push(`export declare type ${name} = ${typeAlias.typeExcerpt.text};`);
+		lines.push(`export declare type ${name} = ${this.renderExcerpt(typeAlias.typeExcerpt)};`);
 		return lines.join("\n");
 	}
 	generateFunctionDeclaration(apiFunction) {
 		const lines = [];
 		const jsDoc = this.formatJSDoc(apiFunction);
 		if (jsDoc) lines.push(jsDoc);
-		const cleaned = this.cleanExcerpt(apiFunction.excerpt.text);
+		const cleaned = this.cleanExcerpt(this.renderExcerpt(apiFunction.excerpt));
 		const decl = cleaned.startsWith("function ") ? cleaned : `const ${cleaned}`;
 		lines.push(`export declare ${decl};`);
 		return lines.join("\n");
@@ -155,7 +155,7 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		const lines = [];
 		const jsDoc = this.formatJSDoc(apiVariable);
 		if (jsDoc) lines.push(jsDoc);
-		let cleaned = this.cleanExcerpt(apiVariable.excerpt.text);
+		let cleaned = this.cleanExcerpt(this.renderExcerpt(apiVariable.excerpt));
 		if (!cleaned.startsWith("const ") && !cleaned.startsWith("let ") && !cleaned.startsWith("var ")) cleaned = `const ${cleaned}`;
 		lines.push(`export declare ${cleaned};`);
 		return lines.join("\n");
@@ -187,7 +187,7 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		const lines = [];
 		const jsDoc = this.formatJSDoc(apiFunction, "    ");
 		if (jsDoc) lines.push(jsDoc);
-		const cleaned = this.cleanExcerpt(apiFunction.excerpt.text);
+		const cleaned = this.cleanExcerpt(this.renderExcerpt(apiFunction.excerpt));
 		lines.push(`    export ${cleaned};`);
 		return lines.join("\n");
 	}
@@ -199,7 +199,7 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (apiInterface.typeParameters?.length) name += this.formatTypeParameters(apiInterface.typeParameters);
 		const headerParts = ["export interface", name];
 		if (apiInterface.extendsTypes?.length) {
-			const ext = apiInterface.extendsTypes.map((t) => t.excerpt.text).join(", ");
+			const ext = apiInterface.extendsTypes.map((t) => this.renderExcerpt(t.excerpt)).join(", ");
 			headerParts.push(`extends ${ext}`);
 		}
 		lines.push(`    ${headerParts.join(" ")} {`);
@@ -234,14 +234,14 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (jsDoc) lines.push(jsDoc);
 		let name = typeAlias.displayName;
 		if (typeAlias.typeParameters?.length) name += this.formatTypeParameters(typeAlias.typeParameters);
-		lines.push(`    export type ${name} = ${typeAlias.typeExcerpt.text};`);
+		lines.push(`    export type ${name} = ${this.renderExcerpt(typeAlias.typeExcerpt)};`);
 		return lines.join("\n");
 	}
 	generateNamespaceVariable(apiVariable) {
 		const lines = [];
 		const jsDoc = this.formatJSDoc(apiVariable, "    ");
 		if (jsDoc) lines.push(jsDoc);
-		let cleaned = this.cleanExcerpt(apiVariable.excerpt.text);
+		let cleaned = this.cleanExcerpt(this.renderExcerpt(apiVariable.excerpt));
 		if (!cleaned.startsWith("const ") && !cleaned.startsWith("let ") && !cleaned.startsWith("var ")) cleaned = `const ${cleaned}`;
 		lines.push(`    export ${cleaned};`);
 		return lines.join("\n");
@@ -249,7 +249,7 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 	generateNamespaceClass(apiClass) {
 		const decl = this.generateClassDeclaration(apiClass);
 		if (!decl) return "";
-		return decl.replace(/\bexport declare class\b/, "export class").split("\n").map((line) => line.trim() ? `    ${line}` : line).join("\n");
+		return decl.replace(/\bexport declare (abstract )?class\b/, "export $1class").split("\n").map((line) => line.trim() ? `    ${line}` : line).join("\n");
 	}
 	generateClassMember(member, indent = "    ") {
 		switch (member.kind) {
@@ -273,11 +273,43 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		const lines = [];
 		const jsDoc = this.formatJSDoc(member, indent);
 		if (jsDoc) lines.push(jsDoc);
-		const cleaned = this.cleanExcerpt(member.excerpt.text);
+		const cleaned = this.cleanExcerpt(this.renderExcerpt(member.excerpt));
 		lines.push(`${indent}${cleaned};`);
 		return lines.join("\n");
 	}
 	/**
+	* Render an excerpt to source text, normalizing dts-rollup disambiguation
+	* aliases. The dts rollup renames a re-imported symbol as `Name$1`, but its
+	* canonical reference is the un-suffixed `Name` (the same symbol). The import
+	* prepender ({@link TypeReferenceExtractor}) imports the canonical name, so
+	* emitting the suffixed text would leave `Name$1` undefined (TS2304). Emit the
+	* canonical name so the body and the prepended import agree.
+	*
+	* Equivalent to `excerpt.text` for excerpts without rollup aliases (the text
+	* is the concatenation of the spanned tokens), so unaliased output is unchanged.
+	*/
+	renderExcerpt(excerpt) {
+		return excerpt.spannedTokens.map((token) => this.normalizeTokenText(token)).join("");
+	}
+	/**
+	* Strip a dts-rollup `$N` suffix from a reference token when the de-suffixed
+	* text matches the token's canonical symbol. Never touches a non-reference
+	* token or a legitimate identifier that genuinely ends in `$N` (its canonical
+	* name would carry the suffix too).
+	*/
+	normalizeTokenText(token) {
+		if (token.kind !== ExcerptTokenKind.Reference) return token.text;
+		const match = /^(.+)\$\d+$/.exec(token.text);
+		if (!match) return token.text;
+		const canonical = token.canonicalReference?.toString();
+		if (!canonical) return token.text;
+		const afterBang = canonical.slice(canonical.indexOf("!") + 1);
+		const colon = afterBang.indexOf(":");
+		const symbol = colon === -1 ? afterBang : afterBang.slice(0, colon);
+		const leaf = symbol.includes(".") ? symbol.slice(symbol.lastIndexOf(".") + 1) : symbol;
+		return match[1] === symbol || match[1] === leaf ? match[1] : token.text;
+	}
+	/**
 	* Clean an excerpt text: strip export/declare keywords and trailing semicolons/whitespace.
 	*/
 	cleanExcerpt(text) {
@@ -287,8 +319,8 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 		if (!typeParameters.length) return "";
 		return `<${typeParameters.map((tp) => {
 			const parts = [tp.name];
-			if (tp.constraintExcerpt?.text.trim()) parts.push(`extends ${tp.constraintExcerpt.text.trim()}`);
-			if (tp.defaultTypeExcerpt?.text.trim()) parts.push(`= ${tp.defaultTypeExcerpt.text.trim()}`);
+			if (tp.constraintExcerpt && this.renderExcerpt(tp.constraintExcerpt).trim()) parts.push(`extends ${this.renderExcerpt(tp.constraintExcerpt).trim()}`);
+			if (tp.defaultTypeExcerpt && this.renderExcerpt(tp.defaultTypeExcerpt).trim()) parts.push(`= ${this.renderExcerpt(tp.defaultTypeExcerpt).trim()}`);
 			return parts.join(" ");
 		}).join(", ")}>`;
 	}

package/build-stages.js

@@ -755,4 +755,4 @@ function buildPipelineForApi(input) {
 }
 
 //#endregion
-export { buildPipelineForApi, cleanupAndCommit, prepareWorkItems, writeMetadata };
+export { buildPipelineForApi, cleanupAndCommit, crossLinkKindPriority, generateSinglePage, normalizeMarkdownSpacing, prepareWorkItems, writeMetadata, writeSingleFile };

package/config-utils.js

@@ -284,4 +284,4 @@ function validateExternalPackages(externalPackages, packageJson) {
 }
 
 //#endregion
-export { extractAutoDetectedPackages, isLoadedModel, isVersionConfig, mergeLlmsPluginConfig, resolveExternalPackageVersions, validateExternalPackages };
+export { extractAutoDetectedPackages, extractPeerDependencies, extractTypeUtilities, isLoadedModel, isVersionConfig, mergeLlmsPluginConfig, normalizeLlmsPluginConfig, resolveExternalPackageVersions, resolvePackageVersionConflicts, validateExternalPackages };

package/content-hash.js

@@ -76,4 +76,4 @@ function hashFrontmatter(frontmatter) {
 }
 
 //#endregion
-export { hashContent, hashFrontmatter };
+export { hashContent, hashFrontmatter, normalizeContent };

package/errors.js

@@ -26,4 +26,4 @@ const TwoslashProcessingErrorBase = Data.TaggedError("TwoslashProcessingError");
 const PrettierFormatErrorBase = Data.TaggedError("PrettierFormatError");
 
 //#endregion
-export { ConfigValidationError, SnapshotDbError, TypeRegistryError };
+export { ConfigValidationError, ConfigValidationErrorBase, SnapshotDbError, SnapshotDbErrorBase, TypeRegistryError, TypeRegistryErrorBase };

package/layers/ObservabilityLive.js

@@ -97,4 +97,4 @@ const logBuildSummary = (slowCodeBlockMs) => Effect.gen(function* () {
 });
 
 //#endregion
-export { buildEventBus, logBuildSummary, makeSummaryLoggerLayer };
+export { BuildMetrics, buildEventBus, logBuildSummary, makeSummaryLoggerLayer };

package/markdown/helpers.js

@@ -361,4 +361,4 @@ async function formatExampleCode(code, language, _context) {
 }
 
 //#endregion
-export { escapeMdxGenerics, escapeYamlString, formatExampleCode, generateAvailableFrom, generateFrontmatter, prepareExampleCode, prependHiddenImports, sanitizeId, stripTwoslashDirectives };
+export { escapeMdxGenerics, escapeYamlString, formatExampleCode, formatImportsWithCut, generateAvailableFrom, generateFrontmatter, prepareExampleCode, prependHiddenImports, sanitizeId, stripTwoslashDirectives };

package/markdown/index.js

@@ -8,4 +8,4 @@ import { NamespacePageGenerator } from "./page-generators/namespace-page.js";
 import { TypeAliasPageGenerator } from "./page-generators/type-alias-page.js";
 import { VariablePageGenerator } from "./page-generators/variable-page.js";
 
-export {  };
+export { ClassPageGenerator, EnumPageGenerator, FunctionPageGenerator, InterfacePageGenerator, MainIndexPageGenerator, NamespacePageGenerator, TypeAliasPageGenerator, VariablePageGenerator, markdownCrossLinker };

package/observability/EventBus.js

@@ -35,4 +35,4 @@ function makeRuntimeEmitter(runtime) {
 }
 
 //#endregion
-export { emit, makeEventBusLayer, makeRuntimeEmitter, wantsLevel };
+export { EventBus, emit, makeEventBusLayer, makeRuntimeEmitter, wantsLevel };

package/observability/spans.js

@@ -54,4 +54,4 @@ function withPhase(phase, ctx, effect, thresholds) {
 }
 
 //#endregion
-export { withPhase };
+export { PHASE_THRESHOLD_KEY, withPhase };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rspress-plugin-api-extractor",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"private": false,
 	"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
 	"keywords": [
@@ -37,8 +37,8 @@
 		"@effect/sql": "^0.51.1",
 		"@effect/sql-sqlite-node": "^0.52.0",
 		"@microsoft/api-extractor-model": "^7.33.8",
-		"@shikijs/twoslash": "^4.2.0",
-		"api-extractor-llms": "0.1.0",
+		"@shikijs/twoslash": "^4.3.0",
+		"api-extractor-llms": "0.2.0",
 		"clsx": "^2.1.1",
 		"effect": "^3.21.4",
 		"gray-matter": "^4.0.3",
@@ -50,7 +50,7 @@
 		"prettier": "^3.8.4",
 		"react-markdown": "^10.1.0",
 		"semver-effect": "^0.2.1",
-		"shiki": "^4.2.0",
+		"shiki": "^4.3.0",
 		"type-registry-effect": "^1.0.0",
 		"typescript": "^6.0.3",
 		"unist-util-visit": "^5.1.0"

package/route-collisions.js

@@ -49,4 +49,4 @@ function assertNoRouteCollisions(candidates, baseRoute) {
 }
 
 //#endregion
-export { assertNoRouteCollisions };
+export { assertNoRouteCollisions, detectRouteCollisions, formatRouteCollisionError };

package/schemas/index.js

@@ -3,4 +3,4 @@ import { EventLevelSchema, ObservabilityConfig, resolveObservability } from "./o
 import { OpenGraphImageConfig, OpenGraphImageMetadata } from "./opengraph.js";
 import { AutoDetectDependencies, CategoryConfig, DEFAULT_CATEGORIES, ErrorConfig, ExternalPackageSpec, LlmsPlugin, LogLevel, ModelInput, MultiApiConfig, PluginOptions, SingleApiConfig, SourceConfig, ThemeConfig, VersionConfig } from "./config.js";
 
-export {  };
+export { DEFAULT_CATEGORIES, PluginOptions };

package/tsconfig-parser.js

@@ -124,4 +124,4 @@ function extractTypeResolutionOptions(tsOptions) {
 }
 
 //#endregion
-export { TsConfigParseError, parseTsConfig };
+export { TsConfigParseError, parseTsConfig, parseTsConfigWithMetadata };

package/twoslash-patterns.js

@@ -84,4 +84,4 @@ function classifyCutDirective(trimmedLine) {
 }
 
 //#endregion
-export { classifyCutDirective, isTwoslashDirective };
+export { RE_ANNOTATION, RE_CONFIG, RE_CUT, classifyCutDirective, isTwoslashDirective };

package/type-reference-extractor.js

@@ -183,10 +183,8 @@ var TypeReferenceExtractor = class {
 		const isBuiltIn = packagePart === "" || packagePart.startsWith("\"");
 		const isInternal = packagePart === this.currentPackageName;
 		let symbolName;
-		if (symbolText.includes(".")) {
-			const parts = symbolText.split(".");
-			symbolName = parts[parts.length - 1].trim();
-		} else symbolName = symbolFromCanonical.trim();
+		if (symbolText.includes(".")) symbolName = symbolText.split(".")[0].trim();
+		else symbolName = symbolFromCanonical.trim();
 		return {
 			symbolName,
 			packageName: packagePart,

package/typescript-config.js

@@ -165,4 +165,4 @@ async function resolveTypeScriptConfig(projectRoot, global, api, version, packag
 }
 
 //#endregion
-export { DEFAULT_COMPILER_OPTIONS, resolveTypeScriptConfig };
+export { DEFAULT_COMPILER_OPTIONS, mergeCompilerOptions, resolveTypeScriptConfig, resolveTypeScriptConfigSingleAsync };