@powerlines/plugin-typedoc 0.10.131 → 0.10.132

package/dist/powerlines/src/types/tsconfig.d.cts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/powerlines/src/types/tsconfig.d.mts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/types/index.cjs

@@ -1,2 +0,0 @@
-require('../plugin-DHXHjv16.cjs');
-require('../types-DHkg7xmX.cjs');

package/dist/types/index.d.cts

@@ -1,3 +1,2 @@
-import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "../plugin-CXv0bOCa.cjs";
-import "../index-CEgs-Dz2.cjs";
+import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.cjs";
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/index.d.mts

@@ -1,3 +1,2 @@
-import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "../plugin-eh7gcj9k.mjs";
-import "../index-BgAdqTbb.mjs";
+import { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from "./plugin.mjs";
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/index.mjs

@@ -1,4 +1 @@
-import "../plugin-C3MaN5jp.mjs";
-import "../types-CTUnla4x.mjs";
-
 export {  };

package/dist/types/plugin.cjs

@@ -1 +0,0 @@
-require('../plugin-DHXHjv16.cjs');

package/dist/types/plugin.d.cts

@@ -1,2 +1,65 @@
-import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "../plugin-CXv0bOCa.cjs";
+import { UserConfig } from "../powerlines/src/types/config.cjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.cjs";
+import { PluginContext } from "../powerlines/src/types/context.cjs";
+import { Application, ProjectReflection, TypeDocOptions } from "typedoc";
+
+//#region src/types/plugin.d.ts
+interface GenerateDocsOptions {
+  frontmatter?: Record<string, any>;
+  outputPath?: string;
+  project: ProjectReflection;
+}
+interface TypeDocPluginOptions extends Partial<Omit<TypeDocOptions, "out">> {
+  /**
+   * The output path for the generated documentation.
+   *
+   * @defaultValue "docs/generated/api-reference"
+   */
+  outputPath?: string;
+  /**
+   * The base URL for the documentation site.
+   *
+   * @defaultValue "/docs/"
+   */
+  basePath?: string;
+  /**
+   * Options to be passed to the TypeDoc generator.
+   *
+   * @remarks
+   * These options will be override any other values passed to the TypeDoc generator.
+   */
+  override?: Partial<TypeDocOptions>;
+}
+interface TypeDocPluginUserConfig extends UserConfig {
+  /**
+   * Options for the TypeDoc plugin.
+   */
+  docs?: {
+    typedoc: TypeDocPluginOptions;
+  };
+}
+interface TypeDocPluginResolvedConfig extends ResolvedConfig {
+  /**
+   * Options for the TypeDoc plugin.
+   */
+  docs: {
+    typedoc: TypeDocOptions & {
+      outputPath: string;
+      baseUrl: string;
+      override?: Partial<TypeDocOptions>;
+    };
+  };
+}
+type TypeDocPluginContext<TResolvedConfig extends TypeDocPluginResolvedConfig = TypeDocPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
+  /**
+   * The initialized TypeDoc application.
+   */
+  typedoc: Application;
+};
+declare type __ΩGenerateDocsOptions = any[];
+declare type __ΩTypeDocPluginOptions = any[];
+declare type __ΩTypeDocPluginUserConfig = any[];
+declare type __ΩTypeDocPluginResolvedConfig = any[];
+declare type __ΩTypeDocPluginContext = any[];
+//#endregion
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/plugin.d.mts

@@ -1,2 +1,65 @@
-import { a as TypeDocPluginUserConfig, c as __ΩTypeDocPluginOptions, i as TypeDocPluginResolvedConfig, l as __ΩTypeDocPluginResolvedConfig, n as TypeDocPluginContext, o as __ΩGenerateDocsOptions, r as TypeDocPluginOptions, s as __ΩTypeDocPluginContext, t as GenerateDocsOptions, u as __ΩTypeDocPluginUserConfig } from "../plugin-eh7gcj9k.mjs";
+import { UserConfig } from "../powerlines/src/types/config.mjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.mjs";
+import { PluginContext } from "../powerlines/src/types/context.mjs";
+import { Application, ProjectReflection, TypeDocOptions } from "typedoc";
+
+//#region src/types/plugin.d.ts
+interface GenerateDocsOptions {
+  frontmatter?: Record<string, any>;
+  outputPath?: string;
+  project: ProjectReflection;
+}
+interface TypeDocPluginOptions extends Partial<Omit<TypeDocOptions, "out">> {
+  /**
+   * The output path for the generated documentation.
+   *
+   * @defaultValue "docs/generated/api-reference"
+   */
+  outputPath?: string;
+  /**
+   * The base URL for the documentation site.
+   *
+   * @defaultValue "/docs/"
+   */
+  basePath?: string;
+  /**
+   * Options to be passed to the TypeDoc generator.
+   *
+   * @remarks
+   * These options will be override any other values passed to the TypeDoc generator.
+   */
+  override?: Partial<TypeDocOptions>;
+}
+interface TypeDocPluginUserConfig extends UserConfig {
+  /**
+   * Options for the TypeDoc plugin.
+   */
+  docs?: {
+    typedoc: TypeDocPluginOptions;
+  };
+}
+interface TypeDocPluginResolvedConfig extends ResolvedConfig {
+  /**
+   * Options for the TypeDoc plugin.
+   */
+  docs: {
+    typedoc: TypeDocOptions & {
+      outputPath: string;
+      baseUrl: string;
+      override?: Partial<TypeDocOptions>;
+    };
+  };
+}
+type TypeDocPluginContext<TResolvedConfig extends TypeDocPluginResolvedConfig = TypeDocPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
+  /**
+   * The initialized TypeDoc application.
+   */
+  typedoc: Application;
+};
+declare type __ΩGenerateDocsOptions = any[];
+declare type __ΩTypeDocPluginOptions = any[];
+declare type __ΩTypeDocPluginUserConfig = any[];
+declare type __ΩTypeDocPluginResolvedConfig = any[];
+declare type __ΩTypeDocPluginContext = any[];
+//#endregion
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };

package/dist/types/plugin.mjs

@@ -1,3 +1 @@
-import "../plugin-C3MaN5jp.mjs";
-
 export {  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-typedoc",
-  "version": "0.10.131",
+  "version": "0.10.132",
   "type": "module",
   "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
   "repository": {
@@ -103,16 +103,16 @@
     "@storm-software/config-tools": "^1.188.75",
     "@stryke/fs": "^0.33.27",
     "@stryke/path": "^0.24.1",
-    "powerlines": "^0.36.27",
+    "powerlines": "^0.36.28",
     "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "4.0.0-next.20"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.11.53",
+    "@powerlines/nx": "^0.11.54",
     "@storm-software/tsup": "^0.2.73",
     "@types/node": "^24.10.4",
     "tsup": "8.4.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "fbc59ce584fd0f78d90d2dbaa18f9c9267bd3b61"
+  "gitHead": "6891ff1330798e807c4caef6134df09d9f57686d"
 }

package/dist/index-BgAdqTbb.d.mts

@@ -1 +0,0 @@
-export { };

package/dist/index-CEgs-Dz2.d.cts

@@ -1 +0,0 @@
-export { };

package/dist/plugin-C3MaN5jp.mjs

@@ -1 +0,0 @@
-export {  };