rspress-plugin-api-extractor 0.4.0 → 0.6.0

package/schemas/config.js

@@ -1,7 +1,7 @@
 import { PerformanceConfig } from "./performance.js";
 import { ObservabilityConfig } from "./observability.js";
 import { OpenGraphImageConfig } from "./opengraph.js";
-import { Schema } from "effect";
+import { Effect, Schema } from "effect";
 import { ApiItemKind } from "@microsoft/api-extractor-model";
 
 //#region src/schemas/config.ts
@@ -15,40 +15,51 @@ const ModelInput = Schema.declare((input) => typeof input === "string" || typeof
 *
 * @public
 */
-const LogLevel$1 = Schema.Literal("none", "info", "verbose", "debug", "warn", "error");
-const ExternalPackageSpec = Schema.mutable(Schema.Struct({
+const LogLevel = Schema.Literals([
+	"none",
+	"info",
+	"verbose",
+	"debug",
+	"warn",
+	"error"
+]);
+const ExternalPackageSpec = Schema.Struct({
 	name: Schema.String,
 	version: Schema.String,
 	tsconfig: Schema.optional(ModelInput),
 	compilerOptions: Schema.optional(Schema.Unknown)
-}));
-const AutoDetectDependencies = Schema.mutable(Schema.Struct({
-	dependencies: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	devDependencies: Schema.optionalWith(Schema.Boolean, { default: () => false }),
-	peerDependencies: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	autoDependencies: Schema.optionalWith(Schema.Boolean, { default: () => true })
-}));
-const ErrorConfig = Schema.mutable(Schema.Struct({ example: Schema.optional(Schema.Literal("suppress", "show")) }));
-const LlmsPlugin = Schema.mutable(Schema.Struct({
-	enabled: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	scopes: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	apiTxt: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	showCopyButton: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	showViewOptions: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	copyButtonText: Schema.optionalWith(Schema.String, { default: () => "Copy Markdown" }),
-	viewOptions: Schema.optionalWith(Schema.mutable(Schema.Array(Schema.Literal("markdownLink", "chatgpt", "claude"))), { default: () => [
+});
+const AutoDetectDependencies = Schema.Struct({
+	dependencies: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	devDependencies: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false))),
+	peerDependencies: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	autoDependencies: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true)))
+});
+const ErrorConfig = Schema.Struct({ example: Schema.optional(Schema.Literals(["suppress", "show"])) });
+const LlmsPlugin = Schema.Struct({
+	enabled: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	scopes: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	apiTxt: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	showCopyButton: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	showViewOptions: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	copyButtonText: Schema.String.pipe(Schema.withDecodingDefault(Effect.succeed("Copy Markdown"))),
+	viewOptions: Schema.mutable(Schema.Array(Schema.Literals([
 		"markdownLink",
 		"chatgpt",
 		"claude"
-	] })
-}));
+	]))).pipe(Schema.withDecodingDefault(Effect.succeed([
+		"markdownLink",
+		"chatgpt",
+		"claude"
+	])))
+});
 const ApiItemKindSchema = Schema.declare((input) => typeof input === "number");
 /**
 * Configuration for a single documentation category (e.g. Classes, Functions).
 *
 * @public
 */
-const CategoryConfig = Schema.mutable(Schema.Struct({
+const CategoryConfig = Schema.Struct({
 	/** Human-readable plural display name shown in the sidebar. */
 	displayName: Schema.String,
 	/** Human-readable singular name used in page titles. */
@@ -60,30 +71,31 @@ const CategoryConfig = Schema.mutable(Schema.Struct({
 	/** TSDoc modifier tag that marks items for this category. */
 	tsdocModifier: Schema.optional(Schema.String),
 	/** Whether the sidebar section is collapsible. Defaults to `true`. */
-	collapsible: Schema.optionalWith(Schema.Boolean, { default: () => true }),
+	collapsible: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
 	/** Whether the sidebar section starts collapsed. Defaults to `true`. */
-	collapsed: Schema.optionalWith(Schema.Boolean, { default: () => true }),
+	collapsed: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
 	/** Heading levels shown in the overview. Defaults to `[2]`. */
-	overviewHeaders: Schema.optionalWith(Schema.mutable(Schema.Array(Schema.Number)), { default: () => [2] })
-}));
+	overviewHeaders: Schema.mutable(Schema.Array(Schema.Number)).pipe(Schema.withDecodingDefault(Effect.succeed([2])))
+});
 /**
 * Source repository link configuration for an API.
 *
 * @public
 */
-const SourceConfig = Schema.mutable(Schema.Struct({
+const SourceConfig = Schema.Struct({
 	/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
 	url: Schema.String,
 	/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
 	ref: Schema.optional(Schema.String)
-}));
-const ThemeConfig = Schema.Union(Schema.String, Schema.mutable(Schema.Struct({
-	light: Schema.String,
-	dark: Schema.String
-})), Schema.mutable(Schema.Record({
-	key: Schema.String,
-	value: Schema.Unknown
-})));
+});
+const ThemeConfig = Schema.Union([
+	Schema.String,
+	Schema.Struct({
+		light: Schema.String,
+		dark: Schema.String
+	}),
+	Schema.Record(Schema.String, Schema.Unknown)
+]);
 /**
 * Built-in default category definitions covering Classes, Interfaces, Functions,
 * Types, Enums, Variables, and Namespaces.
@@ -156,16 +168,13 @@ const DEFAULT_CATEGORIES = {
 	}
 };
 /** Reusable categories record (internal helper) */
-const CategoriesRecord = Schema.mutable(Schema.Record({
-	key: Schema.String,
-	value: CategoryConfig
-}));
+const CategoriesRecord = Schema.Record(Schema.String, CategoryConfig);
 /**
 * Configuration for a single version of an API within a multi-version setup.
 *
 * @public
 */
-const VersionConfig = Schema.mutable(Schema.Struct({
+const VersionConfig = Schema.Struct({
 	/** Path or loader for the `.api.json` model file for this version. */
 	model: ModelInput,
 	/** Path or loader for the `package.json` for this version. */
@@ -186,15 +195,15 @@ const VersionConfig = Schema.mutable(Schema.Struct({
 	tsconfig: Schema.optional(ModelInput),
 	/** TypeScript compiler options for Twoslash. */
 	compilerOptions: Schema.optional(Schema.Unknown)
-}));
+});
 /** Union for the versions record value: can be a path/function OR a full VersionConfig */
-const VersionValue = Schema.Union(ModelInput, VersionConfig);
+const VersionValue = Schema.Union([ModelInput, VersionConfig]);
 /**
 * Configuration for a single-package API documentation site (the `api:` option).
 *
 * @public
 */
-const SingleApiConfig = Schema.mutable(Schema.Struct({
+const SingleApiConfig = Schema.Struct({
 	/** npm package name of the documented package. */
 	packageName: Schema.String,
 	/** Optional display name shown in the sidebar and page titles. */
@@ -202,16 +211,13 @@ const SingleApiConfig = Schema.mutable(Schema.Struct({
 	/** Base URL route for API pages (defaults to `/api`). */
 	baseRoute: Schema.optional(Schema.String),
 	/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
-	apiFolder: Schema.optional(Schema.Union(Schema.String, Schema.Null)),
+	apiFolder: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
 	/** Path or loader for the `.api.json` model file. */
 	model: Schema.optional(ModelInput),
 	/** Path or loader for the `package.json`. */
 	packageJson: Schema.optional(ModelInput),
 	/** Versioned models keyed by version label. */
-	versions: Schema.optional(Schema.mutable(Schema.Record({
-		key: Schema.String,
-		value: VersionValue
-	}))),
+	versions: Schema.optional(Schema.Record(Schema.String, VersionValue)),
 	/** Shiki syntax-highlighting theme. */
 	theme: Schema.optional(ThemeConfig),
 	/** Category definitions (defaults to {@link DEFAULT_CATEGORIES}). */
@@ -230,13 +236,13 @@ const SingleApiConfig = Schema.mutable(Schema.Struct({
 	tsconfig: Schema.optional(ModelInput),
 	/** TypeScript compiler options for Twoslash. */
 	compilerOptions: Schema.optional(Schema.Unknown)
-}));
+});
 /**
 * Configuration for one package in a multi-API portal (each element of the `apis:` array).
 *
 * @public
 */
-const MultiApiConfig = Schema.mutable(Schema.Struct({
+const MultiApiConfig = Schema.Struct({
 	/** npm package name of the documented package. */
 	packageName: Schema.String,
 	/** Optional display name shown in the sidebar and page titles. */
@@ -244,7 +250,7 @@ const MultiApiConfig = Schema.mutable(Schema.Struct({
 	/** Base URL route for this package's API pages. */
 	baseRoute: Schema.optional(Schema.String),
 	/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
-	apiFolder: Schema.optional(Schema.Union(Schema.String, Schema.Null)),
+	apiFolder: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
 	/** Path or loader for the `.api.json` model file (required). */
 	model: ModelInput,
 	/** Path or loader for the `package.json`. */
@@ -267,13 +273,13 @@ const MultiApiConfig = Schema.mutable(Schema.Struct({
 	tsconfig: Schema.optional(ModelInput),
 	/** TypeScript compiler options for Twoslash. */
 	compilerOptions: Schema.optional(Schema.Unknown)
-}));
+});
 /**
 * Top-level options passed to {@link ApiExtractorPlugin}.
 *
 * @public
 */
-const PluginOptions = Schema.mutable(Schema.Struct({
+const PluginOptions = Schema.Struct({
 	/** Single-API configuration (mutually exclusive with `apis`). */
 	api: Schema.optional(SingleApiConfig),
 	/** Multi-API portal configuration (mutually exclusive with `api`). */
@@ -287,14 +293,14 @@ const PluginOptions = Schema.mutable(Schema.Struct({
 	/** Error display options for code examples. */
 	errors: Schema.optional(ErrorConfig),
 	/** LLMs integration options, or `false` to disable. */
-	llmsPlugin: Schema.optional(Schema.Union(Schema.Boolean, LlmsPlugin)),
+	llmsPlugin: Schema.optional(Schema.Union([Schema.Boolean, LlmsPlugin])),
 	/** Verbosity level for plugin build output. @deprecated Use `observability.logLevel`. */
-	logLevel: Schema.optional(LogLevel$1),
+	logLevel: Schema.optional(LogLevel),
 	/** Performance tuning options. @deprecated Use `observability.thresholds`. */
 	performance: Schema.optional(PerformanceConfig),
 	/** Unified observability configuration (logLevel, trace artifact, thresholds). */
 	observability: Schema.optional(ObservabilityConfig)
-}));
+});
 
 //#endregion
-export { AutoDetectDependencies, CategoryConfig, DEFAULT_CATEGORIES, ErrorConfig, ExternalPackageSpec, LlmsPlugin, LogLevel$1 as LogLevel, ModelInput, MultiApiConfig, PluginOptions, SingleApiConfig, SourceConfig, ThemeConfig, VersionConfig };
+export { AutoDetectDependencies, CategoryConfig, DEFAULT_CATEGORIES, ErrorConfig, ExternalPackageSpec, LlmsPlugin, LogLevel, ModelInput, MultiApiConfig, PluginOptions, SingleApiConfig, SourceConfig, ThemeConfig, VersionConfig };

package/schemas/observability.js

@@ -2,12 +2,20 @@ import { PerformanceThresholds } from "./performance.js";
 import { Schema } from "effect";
 
 //#region src/schemas/observability.ts
-const EventLevelSchema = Schema.Literal("none", "error", "warn", "info", "debug", "trace", "verbose");
-const ObservabilityConfig = Schema.mutable(Schema.Struct({
+const EventLevelSchema = Schema.Literals([
+	"none",
+	"error",
+	"warn",
+	"info",
+	"debug",
+	"trace",
+	"verbose"
+]);
+const ObservabilityConfig = Schema.Struct({
 	logLevel: Schema.optional(EventLevelSchema),
-	trace: Schema.optional(Schema.Union(Schema.Boolean, Schema.String)),
+	trace: Schema.optional(Schema.Union([Schema.Boolean, Schema.String])),
 	thresholds: Schema.optional(PerformanceThresholds)
-}));
+});
 const DEFAULT_THRESHOLDS = {
 	slowCodeBlock: 500,
 	slowPageGeneration: 500,

package/schemas/opengraph.js

@@ -6,7 +6,7 @@ import { Schema } from "effect";
 *
 * @public
 */
-const OpenGraphImageMetadata = Schema.mutable(Schema.Struct({
+const OpenGraphImageMetadata = Schema.Struct({
 	/** Absolute URL of the image. */
 	url: Schema.String,
 	/** HTTPS URL of the image (for secure contexts). */
@@ -19,19 +19,19 @@ const OpenGraphImageMetadata = Schema.mutable(Schema.Struct({
 	height: Schema.optional(Schema.Number),
 	/** Alt text for the image. */
 	alt: Schema.optional(Schema.String)
-}));
+});
 /**
 * Open Graph image: either a plain URL string or structured `OpenGraphImageMetadata`.
 *
 * @public
 */
-const OpenGraphImageConfig = Schema.Union(Schema.String, OpenGraphImageMetadata);
+const OpenGraphImageConfig = Schema.Union([Schema.String, OpenGraphImageMetadata]);
 /**
 * Resolved Open Graph metadata emitted into each generated page's frontmatter.
 *
 * @public
 */
-const OpenGraphMetadata = Schema.mutable(Schema.Struct({
+const OpenGraphMetadata = Schema.Struct({
 	/** Canonical site base URL. */
 	siteUrl: Schema.String,
 	/** Page route path (e.g. `/api/classes/myclass`). */
@@ -50,7 +50,7 @@ const OpenGraphMetadata = Schema.mutable(Schema.Struct({
 	ogImage: Schema.optional(OpenGraphImageMetadata),
 	/** Open Graph object type (e.g. `"article"`). */
 	ogType: Schema.String
-}));
+});
 
 //#endregion
 export { OpenGraphImageConfig, OpenGraphImageMetadata };

package/schemas/performance.js

@@ -1,19 +1,19 @@
-import { Schema } from "effect";
+import { Effect, Schema } from "effect";
 
 //#region src/schemas/performance.ts
-const PerformanceThresholds = Schema.mutable(Schema.Struct({
-	slowCodeBlock: Schema.optionalWith(Schema.Number, { default: () => 500 }),
-	slowPageGeneration: Schema.optionalWith(Schema.Number, { default: () => 500 }),
-	slowApiLoad: Schema.optionalWith(Schema.Number, { default: () => 1e3 }),
-	slowFileOperation: Schema.optionalWith(Schema.Number, { default: () => 50 }),
-	slowHttpRequest: Schema.optionalWith(Schema.Number, { default: () => 2e3 }),
-	slowDbOperation: Schema.optionalWith(Schema.Number, { default: () => 100 })
-}));
-const PerformanceConfig = Schema.mutable(Schema.Struct({
+const PerformanceThresholds = Schema.Struct({
+	slowCodeBlock: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(500))),
+	slowPageGeneration: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(500))),
+	slowApiLoad: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(1e3))),
+	slowFileOperation: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(50))),
+	slowHttpRequest: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(2e3))),
+	slowDbOperation: Schema.Number.pipe(Schema.withDecodingDefault(Effect.succeed(100)))
+});
+const PerformanceConfig = Schema.Struct({
 	thresholds: Schema.optional(PerformanceThresholds),
-	showInsights: Schema.optionalWith(Schema.Boolean, { default: () => true }),
-	trackDetailedMetrics: Schema.optionalWith(Schema.Boolean, { default: () => false })
-}));
+	showInsights: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(true))),
+	trackDetailedMetrics: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false)))
+});
 
 //#endregion
 export { PerformanceConfig, PerformanceThresholds };

package/services/ConfigService.js

@@ -1,7 +1,7 @@
 import { Context } from "effect";
 
 //#region src/services/ConfigService.ts
-var ConfigService = class extends Context.Tag("rspress-plugin-api-extractor/ConfigService")() {};
+var ConfigService = class extends Context.Service()("rspress-plugin-api-extractor/ConfigService") {};
 
 //#endregion
 export { ConfigService };

package/services/PathDerivationService.js

@@ -1,7 +1,7 @@
 import { Context } from "effect";
 
 //#region src/services/PathDerivationService.ts
-var PathDerivationService = class extends Context.Tag("rspress-plugin-api-extractor/PathDerivationService")() {};
+var PathDerivationService = class extends Context.Service()("rspress-plugin-api-extractor/PathDerivationService") {};
 
 //#endregion
 export { PathDerivationService };

package/services/SnapshotService.js

@@ -1,7 +1,7 @@
 import { Context } from "effect";
 
 //#region src/services/SnapshotService.ts
-var SnapshotService = class extends Context.Tag("rspress-plugin-api-extractor/SnapshotService")() {};
+var SnapshotService = class extends Context.Service()("rspress-plugin-api-extractor/SnapshotService") {};
 
 //#endregion
 export { SnapshotService };

package/services/TypeRegistryService.js

@@ -1,7 +1,7 @@
 import { Context } from "effect";
 
 //#region src/services/TypeRegistryService.ts
-var TypeRegistryService = class extends Context.Tag("rspress-plugin-api-extractor/TypeRegistryService")() {};
+var TypeRegistryService = class extends Context.Service()("rspress-plugin-api-extractor/TypeRegistryService") {};
 
 //#endregion
 export { TypeRegistryService };

package/tsdoc-metadata.json

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