rspress-plugin-api-extractor 0.19.12 → 0.19.14

package/build-stages.js

@@ -7,6 +7,7 @@ import { emit } from "./observability/EventBus.js";
 import { emitSync, syncBuildId } from "./observability/sync-emitter.js";
 import { OgService } from "./services/OgService.js";
 import path from "node:path";
+import { ErrorText } from "@effected/engine";
 import { NavEntry, buildIndexPage, buildNav, buildPage, prepareWorkItems } from "@tsdoctor/pages";
 import { Effect, FileSystem, Metric, Option, Stream } from "effect";
 import { Routes, parseFrontmatter, stringifyFrontmatter } from "@tsdoctor/model";
@@ -104,7 +105,7 @@ function generateSinglePage(workItem, ctx) {
 						apiScope
 					},
 					file: "unknown",
-					reason: cause instanceof Error ? cause.message : String(cause),
+					reason: ErrorText.describe(cause),
 					level: "warn"
 				}));
 			}

package/layers/config-resolution.js

@@ -16,6 +16,7 @@ import { emitVfsPayloadEvents, mergeApiResult } from "./api-results.js";
 import { mergeExternalTypes } from "./external-types.js";
 import { registerTypeEnvironments, resolveTsConfigTyped } from "./type-environment.js";
 import path from "node:path";
+import { ErrorText } from "@effected/engine";
 import { apiScopeOf, normalizeBaseRoute, unscopedName } from "@tsdoctor/pages";
 import { Effect, Metric } from "effect";
 import { ApiExtractedPackage, TypeReferenceExtractor } from "@tsdoctor/model";
@@ -304,7 +305,7 @@ const makeConfigService = Effect.gen(function* () {
 					try: () => loadPackageJson(api.packageJson),
 					catch: (cause) => new ConfigValidationError({
 						field: "packageJson",
-						reason: cause instanceof Error ? cause.message : String(cause),
+						reason: ErrorText.describe(cause),
 						cause
 					})
 				}) : void 0;
@@ -313,7 +314,7 @@ const makeConfigService = Effect.gen(function* () {
 					try: () => validateExternalPackages(api.externalPackages, packageJson),
 					catch: (cause) => new ConfigValidationError({
 						field: "externalPackages",
-						reason: cause instanceof Error ? cause.message : String(cause),
+						reason: ErrorText.describe(cause),
 						cause
 					})
 				});
@@ -392,7 +393,7 @@ const makeConfigService = Effect.gen(function* () {
 								try: () => loadPackageJson(api.packageJson),
 								catch: (cause) => new ConfigValidationError({
 									field: "packageJson",
-									reason: cause instanceof Error ? cause.message : String(cause),
+									reason: ErrorText.describe(cause),
 									cause
 								})
 							}) : void 0);
@@ -401,7 +402,7 @@ const makeConfigService = Effect.gen(function* () {
 								try: () => validateExternalPackages(versionExternalPackages || api.externalPackages, packageJson),
 								catch: (cause) => new ConfigValidationError({
 									field: "externalPackages",
-									reason: cause instanceof Error ? cause.message : String(cause),
+									reason: ErrorText.describe(cause),
 									cause
 								})
 							});

package/layers/type-environment.js

@@ -3,6 +3,7 @@ import { emit } from "../observability/EventBus.js";
 import { TwoslashEnvironments } from "../services/TwoslashEnvironments.js";
 import { ConfigValidationError } from "../errors.js";
 import { TwoslashCacheService } from "../services/TwoslashCacheService.js";
+import { ErrorText } from "@effected/engine";
 import { Effect } from "effect";
 import { resolveTypeScriptConfig, twoslashEnvHash } from "@tsdoctor/vfs";
 import ts from "typescript";
@@ -39,7 +40,7 @@ const resolveTsConfigTyped = (projectRoot, config) => Effect.tryPromise({
 	try: () => resolveTypeScriptConfig(projectRoot, config),
 	catch: (cause) => new ConfigValidationError({
 		field: "tsconfig",
-		reason: cause instanceof Error ? cause.message : String(cause),
+		reason: ErrorText.describe(cause),
 		cause
 	})
 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rspress-plugin-api-extractor",
-	"version": "0.19.12",
+	"version": "0.19.14",
 	"private": false,
 	"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
 	"keywords": [
@@ -37,36 +37,37 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@effect/platform-node": "^4.0.6",
-		"@effected/github": "^0.25.1",
-		"@effected/glob": "^0.15.0",
-		"@effected/images": "^0.6.2",
-		"@effected/jsonc": "^0.20.1",
-		"@effected/markdown": "^0.23.0",
-		"@effected/memfs": "^0.20.0",
-		"@effected/npm": "^0.27.1",
-		"@effected/package-json": "^0.26.1",
-		"@effected/schema-org": "^0.11.0",
-		"@effected/semver": "^0.18.0",
-		"@effected/spdx": "^0.16.1",
-		"@effected/store": "^0.20.0",
-		"@effected/tsconfig-json": "^0.17.4",
-		"@effected/walker": "^0.21.0",
-		"@effected/xdg": "^0.16.0",
-		"@effected/yaml": "^0.25.1",
+		"@effect/platform-node": "~4.1.1",
+		"@effected/engine": "^0.11.0",
+		"@effected/github": "^0.27.0",
+		"@effected/glob": "^0.17.0",
+		"@effected/images": "^0.8.0",
+		"@effected/jsonc": "^0.22.0",
+		"@effected/markdown": "^0.25.0",
+		"@effected/memfs": "^0.22.0",
+		"@effected/npm": "^0.29.0",
+		"@effected/package-json": "^0.28.0",
+		"@effected/schema-org": "^0.13.0",
+		"@effected/semver": "^0.20.0",
+		"@effected/spdx": "^0.18.0",
+		"@effected/store": "^0.22.0",
+		"@effected/tsconfig-json": "^0.19.0",
+		"@effected/walker": "^0.24.0",
+		"@effected/xdg": "^0.18.0",
+		"@effected/yaml": "^0.27.0",
 		"@microsoft/api-extractor-model": "^7.33.15",
 		"@shikijs/twoslash": "^4.5.0",
-		"@tsdoctor/bundle": "0.6.10",
-		"@tsdoctor/manifest": "0.2.10",
-		"@tsdoctor/model": "0.8.14",
-		"@tsdoctor/pages": "0.3.16",
-		"@tsdoctor/registry": "0.5.13",
-		"@tsdoctor/seo": "0.4.12",
-		"@tsdoctor/snapshot": "0.5.10",
-		"@tsdoctor/vfs": "0.4.8",
+		"@tsdoctor/bundle": "0.7.0",
+		"@tsdoctor/manifest": "0.3.0",
+		"@tsdoctor/model": "0.9.0",
+		"@tsdoctor/pages": "0.4.0",
+		"@tsdoctor/registry": "0.6.0",
+		"@tsdoctor/seo": "0.5.0",
+		"@tsdoctor/snapshot": "0.6.0",
+		"@tsdoctor/vfs": "0.6.0",
 		"@typescript/vfs": "^1.6.5",
 		"clsx": "^2.1.1",
-		"effect": "^4.0.6",
+		"effect": "~4.1.1",
 		"hast-util-to-jsx-runtime": "^2.3.6",
 		"mdast-util-to-hast": "^13.2.1",
 		"open": "^11.0.0",

package/plugin.js

@@ -27,6 +27,7 @@ import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
+import { ErrorText } from "@effected/engine";
 import { normalizeBaseRoute, unscopedName } from "@tsdoctor/pages";
 import { Effect, FileSystem, ManagedRuntime, Option, Ref, Schema } from "effect";
 
@@ -230,7 +231,7 @@ function ApiExtractorPluginImpl(rawOptions) {
 					}));
 				}).pipe(Effect.scoped));
 			} catch (error) {
-				const message = error instanceof Error ? error.message : String(error);
+				const message = ErrorText.describe(error);
 				emitSync(PluginEvent.BuildFailed({
 					ctx: { buildId },
 					level: "error",

package/prettier-formatter.js

@@ -1,5 +1,6 @@
 import { PluginEvent } from "./observability/events.js";
 import { emitSync, syncBuildId } from "./observability/sync-emitter.js";
+import { ErrorText } from "@effected/engine";
 import { formatExampleCode } from "@tsdoctor/pages";
 import { Effect, Result } from "effect";
 
@@ -27,7 +28,7 @@ async function formatCode(code, language) {
 		formatTime
 	};
 	const cause = result.failure.cause;
-	const errorMsg = cause instanceof Error ? cause.message : String(cause);
+	const errorMsg = ErrorText.describe(cause);
 	emitSync(PluginEvent.PrettierError({
 		ctx: { buildId: syncBuildId() },
 		file: "unknown",

package/services/OgService.js

@@ -1,5 +1,6 @@
 import { PluginEvent } from "../observability/events.js";
 import { emit } from "../observability/EventBus.js";
+import { ErrorText } from "@effected/engine";
 import { Context, Data, Effect, FileSystem, Layer, Option, Path } from "effect";
 import { resolveUrl } from "@tsdoctor/seo";
 import { ImageFacts } from "@effected/images";
@@ -32,7 +33,7 @@ var OgImageError = class extends OgImageErrorBase {
 	get message() {
 		if (this.code === "invalid-url") return `Invalid Open Graph image URL in '${this.field}': ${this.value} — expected an absolute http(s) URL or a path starting with '/'`;
 		if (this.code === "invalid-secure-url") return `Invalid Open Graph secure URL in '${this.field}': ${this.value} — secureUrl must be an absolute https URL`;
-		const cause = this.cause instanceof Error ? this.cause.message : String(this.cause);
+		const cause = ErrorText.describe(this.cause);
 		return `Could not read Open Graph image '${this.value}': ${cause}`;
 	}
 };

package/services/TypeRegistryService.js

@@ -3,6 +3,7 @@ import { emit } from "../observability/EventBus.js";
 import { resolveExternalPackageVersions } from "../config-utils.js";
 import { TypeRegistryError } from "../errors.js";
 import { AppDirsLive, PlatformLive } from "../layers/xdg.js";
+import { ErrorText } from "@effected/engine";
 import { Cause, Context, Duration, Effect, Layer, Path } from "effect";
 import { NodeHttpClient } from "@effect/platform-node";
 import { Cache } from "@effected/store";
@@ -110,7 +111,7 @@ const RegistryObserverLayer = Layer.succeed(RegistryObserver, { emit: (event) =>
 			},
 			level: "warn",
 			kind: "PackageLoadFailed",
-			detail: `[${event.kind}] ${event.error instanceof Error ? event.error.message : String(event.error)}`
+			detail: `[${event.kind}] ${ErrorText.describe(event.error)}`
 		}));
 		case "BatchStart": return emit(PluginEvent.TypeRegistryEvent({
 			ctx: {},
@@ -155,7 +156,7 @@ const RegistryBackedLive = Layer.effect(TypeRegistryService, Effect.gen(function
 		}).pipe(Effect.catch((error) => Effect.fail(new TypeRegistryError({
 			packageName: packages.map((p) => p.name).join(", "),
 			version: packages.map((p) => p.version).join(", "),
-			reason: error instanceof Error ? error.message ?? String(error) : String(error)
+			reason: ErrorText.describe(error)
 		}))))
 	};
 })).pipe(Layer.provide(RegistryLayer));

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.59.4"
+      "packageVersion": "7.60.0"
     }
   ]
 }

package/twoslash-transformer.js

@@ -1,5 +1,6 @@
 import { PluginEvent } from "./observability/events.js";
 import { emitSync, syncBuildId } from "./observability/sync-emitter.js";
+import { ErrorText } from "@effected/engine";
 import { Result } from "effect";
 import { Markdown, Mdast } from "@effected/markdown";
 import { rendererRich, transformerTwoslash } from "@shikijs/twoslash";
@@ -360,7 +361,7 @@ var TwoslashEnvironmentRegistry = class {
 		return this._resolvedCompilerOptions;
 	}
 	handleTwoslashError(error, _code, file) {
-		const message = error instanceof Error ? error.message : String(error);
+		const message = ErrorText.describe(error);
 		const match = /TS(\d+)/.exec(message);
 		const tsCode = match ? Number(match[1]) : 0;
 		emitSync(PluginEvent.TwoslashDiagnostic({