rspress-plugin-api-extractor 0.4.0 → 0.6.0

package/README.md

@@ -42,7 +42,7 @@ npx rspress dev
 # Generates one MDX page per public API item and serves them at http://localhost:3000
 ```
 
-The plugin reads your `.api.json` model and writes one MDX page per public API item under your docs root, grouped into category folders (classes, interfaces, functions, type aliases, enums, variables and namespaces) with navigation metadata. To produce the model, pair it with [@savvy-web/rslib-builder](https://github.com/savvy-web/rslib-builder), which emits the `.api.json` as part of your TypeScript build.
+The plugin reads your `.api.json` model and writes one MDX page per public API item under your docs root, grouped into category folders (classes, interfaces, functions, type aliases, enums, variables and namespaces) with navigation metadata. To produce the model, pair it with [@savvy-web/bundler](https://github.com/savvy-web/bundler), which emits the `.api.json` as part of your production TypeScript build.
 
 ## Features
 

package/api-extracted-package.js

@@ -2,7 +2,6 @@ import { ApiItemKind, ApiModel, ExcerptTokenKind } from "@microsoft/api-extracto
 import { VirtualPackage } from "type-registry-effect";
 
 //#region src/api-extracted-package.ts
-const VirtualPackageClass = VirtualPackage.VirtualPackage;
 /**
 * Reconstructs TypeScript declaration files from an API Extractor model.
 *
@@ -12,10 +11,14 @@ const VirtualPackageClass = VirtualPackage.VirtualPackage;
 *
 * Use the factory methods {@link fromApiModel} or {@link fromPackage} to create instances.
 */
-var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass {
+var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackage {
 	apiPackage;
 	constructor(apiPackage, packageName, entries) {
-		super(packageName, "1.0.0", entries);
+		super({
+			name: packageName,
+			version: "1.0.0",
+			entries
+		});
 		this.apiPackage = apiPackage;
 	}
 	/**
@@ -29,14 +32,23 @@ var ApiExtractedPackage = class ApiExtractedPackage extends VirtualPackageClass
 	* Create an ApiExtractedPackage from an existing ApiPackage instance.
 	*/
 	static fromPackage(apiPackage, packageName) {
-		const tempEntries = /* @__PURE__ */ new Map();
-		const tempInstance = new ApiExtractedPackage(apiPackage, packageName, tempEntries);
+		const scratch = new ApiExtractedPackage(apiPackage, packageName, /* @__PURE__ */ new Map([["index.d.ts", ""]]));
+		const entries = /* @__PURE__ */ new Map();
 		for (const ep of apiPackage.entryPoints) {
-			const entryName = tempInstance.getEntryPointName(ep);
+			const entryName = scratch.getEntryPointName(ep);
 			const fileName = entryName ? `${entryName}.d.ts` : "index.d.ts";
-			tempEntries.set(fileName, tempInstance.generateDeclarations(ep));
+			entries.set(fileName, scratch.generateDeclarations(ep));
 		}
-		return tempInstance;
+		return new ApiExtractedPackage(apiPackage, packageName, entries);
+	}
+	/**
+	* Generate the VFS map for this package (`node_modules/<name>/...`).
+	*
+	* Delegates to the v2 {@link VirtualPackage.toVfs}; kept under the v1 name
+	* because the config layer and tests consume it as `generateVfs()`.
+	*/
+	generateVfs() {
+		return this.toVfs();
 	}
 	/**
 	* Generate the .d.ts content for a specific entry point.

package/build-program.js

@@ -6,8 +6,7 @@ import { withPhase } from "./observability/spans.js";
 import { TwoslashManager } from "./twoslash-transformer.js";
 import { VfsRegistry } from "./vfs-registry.js";
 import path from "node:path";
-import { Effect } from "effect";
-import { FileSystem } from "@effect/platform";
+import { Effect, FileSystem } from "effect";
 
 //#region src/build-program.ts
 /**

package/build-stages.js

@@ -20,8 +20,7 @@ import { assertNoRouteCollisions } from "./route-collisions.js";
 import { SnapshotService } from "./services/SnapshotService.js";
 import { BASE_CLASS_ANCHOR, detectSyntheticBases } from "./synthetic-bases.js";
 import path from "node:path";
-import { Effect, Metric, Stream } from "effect";
-import { FileSystem } from "@effect/platform";
+import { Effect, FileSystem, Metric, Stream } from "effect";
 import { ApiItemKind } from "@microsoft/api-extractor-model";
 import matter from "gray-matter";
 
@@ -559,11 +558,11 @@ function writeMetadata(input) {
 			const indexDirPath = path.dirname(indexAbsolutePath);
 			yield* fileSystem.makeDirectory(indexDirPath, { recursive: true }).pipe(Effect.orDie);
 			yield* fileSystem.writeFileString(indexAbsolutePath, mainIndex.content).pipe(Effect.orDie);
-			yield* Metric.increment(BuildMetrics.filesTotal);
-			yield* Metric.increment(BuildMetrics.filesNew);
+			yield* Metric.update(BuildMetrics.filesTotal, 1);
+			yield* Metric.update(BuildMetrics.filesNew, 1);
 		} else {
-			yield* Metric.increment(BuildMetrics.filesTotal);
-			yield* Metric.increment(BuildMetrics.filesUnchanged);
+			yield* Metric.update(BuildMetrics.filesTotal, 1);
+			yield* Metric.update(BuildMetrics.filesUnchanged, 1);
 		}
 		generatedFiles.add("index.mdx");
 		const categoryMetaEntriesMap = /* @__PURE__ */ new Map();
@@ -765,7 +764,7 @@ function buildPipelineForApi(input) {
 		...input.packageName != null ? { packageName: input.packageName } : {},
 		...input.apiName != null ? { apiName: input.apiName } : {}
 	};
-	return Stream.fromIterable(input.workItems).pipe(Stream.mapEffect((workItem) => generateSinglePage(workItem, generateCtx), { concurrency: input.pageConcurrency }), Stream.filter((result) => result !== null), Stream.mapEffect((result) => writeSingleFile(result, writeCtx), { concurrency: input.pageConcurrency }), Stream.runFold([], (acc, result) => [...acc, result]));
+	return Stream.fromIterable(input.workItems).pipe(Stream.mapEffect((workItem) => generateSinglePage(workItem, generateCtx), { concurrency: input.pageConcurrency }), Stream.filter((result) => result !== null), Stream.mapEffect((result) => writeSingleFile(result, writeCtx), { concurrency: input.pageConcurrency }), Stream.runFold(() => [], (acc, result) => [...acc, result]));
 }
 
 //#endregion

package/config-helpers.js

@@ -52,17 +52,14 @@ function resolveBaseRoute(baseRoute, info) {
 function fromDir(dir, overrides = {}) {
 	const { baseRoute, cwd, ...rest } = overrides;
 	const info = discoverDir(path.resolve(cwd ?? process.cwd(), dir));
-	const discovered = {
+	const tsconfigPath = path.join(info.dir, "tsconfig.json");
+	return {
 		packageName: info.packageName,
 		name: info.packageName,
 		model: info.modelPath,
-		packageJson: path.join(info.dir, "package.json")
-	};
-	if (baseRoute !== void 0) discovered.baseRoute = resolveBaseRoute(baseRoute, info);
-	const tsconfigPath = path.join(info.dir, "tsconfig.json");
-	if (fs.existsSync(tsconfigPath)) discovered.tsconfig = tsconfigPath;
-	return {
-		...discovered,
+		packageJson: path.join(info.dir, "package.json"),
+		...baseRoute !== void 0 ? { baseRoute: resolveBaseRoute(baseRoute, info) } : {},
+		...fs.existsSync(tsconfigPath) ? { tsconfig: tsconfigPath } : {},
 		...rest
 	};
 }

package/config-utils.js

@@ -1,5 +1,5 @@
 import { Effect } from "effect";
-import { SemVer } from "semver-effect";
+import { SemVer } from "@effected/semver";
 
 //#region src/config-utils.ts
 /**
@@ -146,7 +146,7 @@ function extractAutoDetectedPackages(packageJson, options = {}) {
 }
 /**
 * Deduplicate external packages by name, resolving to the highest version when conflicts exist.
-* Uses semver-effect to pick the highest version from duplicates.
+* Uses @effected/semver to pick the highest version from duplicates.
 *
 * @param packages - Array of external package specs (may contain duplicates)
 * @returns Deduplicated array with highest versions
@@ -211,7 +211,7 @@ function resolveExternalPackageVersions(packages, resolve) {
 	return Effect.forEach(packages, (pkg) => resolve(pkg).pipe(Effect.map((version) => ({
 		name: pkg.name,
 		version
-	})), Effect.catchAll(() => Effect.succeed(null))), { concurrency: 5 }).pipe(Effect.map((results) => results.filter((spec) => spec !== null)));
+	})), Effect.catch(() => Effect.succeed(null))), { concurrency: 5 }).pipe(Effect.map((results) => results.filter((spec) => spec !== null)));
 }
 /**
 * Strip range prefixes from a version string to get a clean semver.
@@ -220,7 +220,7 @@ function stripRangePrefix(version) {
 	return version.replace(/^[~^>=<]+\s*/, "");
 }
 /**
-* Find the highest version from a list of version specifiers using semver-effect.
+* Find the highest version from a list of version specifiers using @effected/semver.
 * Handles version ranges and exact versions.
 *
 * @param versions - Array of version strings (can be ranges or exact versions)