@powerlines/plugin-typedoc 0.10.7 → 0.10.8

package/dist/index-B7n5dnGG.d.cts

@@ -0,0 +1,1358 @@
+import { Format } from '@storm-software/build-tools/types';
+import { LogLevelLabel } from '@storm-software/config-tools/types';
+import { StormWorkspaceConfig } from '@storm-software/config/types';
+import { MaybePromise, NonUndefined, FunctionLike } from '@stryke/types/base';
+import { TypeDefinitionParameter, TypeDefinition } from '@stryke/types/configuration';
+import { AssetGlob } from '@stryke/types/file';
+import { PreviewOptions, ResolvedPreviewOptions } from 'vite';
+import { EnvPaths } from '@stryke/env/get-env-paths';
+import { PackageJson } from '@stryke/types/package-json';
+import { Jiti } from 'jiti';
+import { ParserOptions, ParseResult } from 'oxc-parser';
+import { Range } from 'semver';
+import { UnpluginContext, UnpluginBuildContext, TransformResult, ExternalIdResult, HookFilter, UnpluginOptions } from 'unplugin';
+import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
+import ts from 'typescript';
+import { PrimitiveJsonValue } from '@stryke/json/types';
+import { Volume } from 'memfs';
+import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
+import { IUnionFs } from 'unionfs';
+import { ArrayValues } from '@stryke/types/array';
+import { TypeDocOptions, Application, ProjectReflection } from 'typedoc';
+
+type UnpluginBuildVariant = "rollup" | "webpack" | "rspack" | "vite" | "esbuild" | "farm" | "unloader" | "rolldown";
+interface BuildConfig {
+    /**
+     * The platform to build the project for
+     *
+     * @defaultValue "neutral"
+     */
+    platform?: "node" | "browser" | "neutral";
+    /**
+     * The alias mappings to use for module resolution during the build process.
+     *
+     * @remarks
+     * This option allows you to define custom path aliases for modules, which can be useful for simplifying imports and managing dependencies.
+     *
+     * @example
+     * ```ts
+     * {
+     *   alias: {
+     *     "@utils": "./src/utils",
+     *     "@components": "./src/components"
+     *   }
+     * }
+     * ```
+     */
+    alias?: Record<string, string>;
+    /**
+     * A list of modules that should not be bundled, even if they are external dependencies.
+     *
+     * @remarks
+     * This option is useful for excluding specific modules from the bundle, such as Node.js built-in modules or other libraries that should not be bundled.
+     */
+    external?: (string | RegExp)[];
+    /**
+     * A list of modules that should always be bundled, even if they are external dependencies.
+     */
+    noExternal?: (string | RegExp)[];
+    /**
+     * Should the Powerlines CLI processes skip bundling the `node_modules` directory?
+     */
+    skipNodeModulesBundle?: boolean;
+    /**
+     * Should the Powerlines processes skip the `"prepare"` task prior to building?
+     *
+     * @defaultValue false
+     */
+    skipPrepare?: boolean;
+}
+type BuildResolvedConfig = BuildConfig;
+
+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;
+};
+
+declare const __VFS_INIT__ = "__VFS_INIT__";
+declare const __VFS_REVERT__ = "__VFS_REVERT__";
+declare const __VFS_CACHE__ = "__VFS_CACHE__";
+declare const __VFS_VIRTUAL__ = "__VFS_VIRTUAL__";
+declare const __VFS_UNIFIED__ = "__VFS_UNIFIED__";
+type OutputModeType = "fs" | "virtual";
+interface VirtualFile {
+    /**
+     * The unique identifier for the virtual file.
+     *
+     * @remarks
+     * If no specific id is provided, it defaults to the file's {@link path}.
+     */
+    id: string;
+    /**
+     * Additional metadata associated with the virtual file.
+     */
+    details: Record<string, PrimitiveJsonValue>;
+    /**
+     * The variant of the file.
+     *
+     * @remarks
+     * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
+     * - `builtin`: Indicates that the file is a built-in module provided by the system.
+     * - `entry`: Indicates that the file is an entry point for execution.
+     * - `normal`: Indicates that the file is a standard file without any special role.
+     */
+    variant: string;
+    /**
+     * The output mode of the file.
+     *
+     * @remarks
+     * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
+     */
+    mode: OutputModeType;
+    /**
+     * A virtual (or actual) path to the file in the file system.
+     */
+    path: string;
+    /**
+     * The contents of the file.
+     */
+    code: string | NodeJS.ArrayBufferView;
+}
+type VirtualFileSystemMetadata = Pick<VirtualFile, "id" | "details" | "variant" | "mode">;
+interface ResolveFSOptions {
+    mode?: OutputModeType;
+}
+type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
+interface PowerlinesWriteFileOptions extends ResolveFSOptions {
+    skipFormat?: boolean;
+}
+type NodeWriteFileOptions = WriteFileOptions$1;
+type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
+type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
+type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
+interface ResolvePathOptions extends ResolveFSOptions {
+    /**
+     * Should the resolved path include the file extension?
+     *
+     * @defaultValue true
+     */
+    withExtension?: boolean;
+    /**
+     * The paths to search for the file.
+     */
+    paths?: string[];
+    /**
+     * The type of the path to resolve.
+     */
+    type?: "file" | "directory";
+}
+interface VirtualFileSystemInterface {
+    [__VFS_INIT__]: () => void;
+    [__VFS_REVERT__]: () => void;
+    /**
+     * The underlying file metadata.
+     */
+    meta: Record<string, VirtualFileSystemMetadata | undefined>;
+    /**
+     * A map of module ids to their file paths.
+     */
+    ids: Record<string, string>;
+    /**
+     * Check if a path or id corresponds to a virtual file **(does not actually exists on disk)**.
+     *
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a virtual file **(does not actually exists on disk)**.
+     */
+    isVirtual: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    /**
+     * Check if a path or id corresponds to a file written to the file system **(actually exists on disk)**.
+     *
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a file written to the file system **(actually exists on disk)**.
+     */
+    isFs: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path of the file to check.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    isFile: (path: string) => boolean;
+    /**
+     * Checks if a directory exists in the virtual file system (VFS).
+     *
+     * @param path - The path of the directory to check.
+     * @returns `true` if the directory exists, otherwise `false`.
+     */
+    isDirectory: (path: string) => boolean;
+    /**
+     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param pathOrId - The path or id to check.
+     * @returns Whether the path or id corresponds to a virtual file.
+     */
+    isTsconfigPath: (pathOrId: string) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync: (pathOrId: string) => boolean;
+    /**
+     * Gets the metadata of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The metadata of the file if it exists, otherwise undefined.
+     */
+    getMetadata: (pathOrId: PathLike) => VirtualFileSystemMetadata | undefined;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @param options - Optional parameters for getting the stats.
+     * @returns The stats of the file if it exists, otherwise undefined.
+     */
+    lstat: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Promise<Stats>;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @param options - Optional parameters for getting the stats.
+     * @returns The stats of the file if it exists, otherwise undefined.
+     */
+    lstatSync: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Stats | undefined;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The stats of the file if it exists, otherwise false.
+     */
+    stat: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Promise<Stats>;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The stats of the file if it exists, otherwise false.
+     */
+    statSync: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Stats | undefined;
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @param options - Options for listing files, such as encoding and recursion.
+     * @returns An array of file names in the specified path.
+     */
+    readdirSync: (path: string, options?: {
+        encoding: BufferEncoding | null;
+        withFileTypes?: false | undefined;
+        recursive?: boolean | undefined;
+    } | BufferEncoding) => string[];
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @param options - Options for listing files, such as encoding and recursion.
+     * @returns An array of file names in the specified path.
+     */
+    readdir: (path: string, options?: {
+        encoding: BufferEncoding | null;
+        withFileTypes?: false | undefined;
+        recursive?: boolean | undefined;
+    } | BufferEncoding) => Promise<string[]>;
+    /**
+     * Removes a file or symbolic link in the virtual file system (VFS).
+     *
+     * @param path - The path to the file to remove.
+     * @returns A promise that resolves when the file is removed.
+     */
+    unlinkSync: (path: PathLike, options?: ResolveFSOptions) => void;
+    /**
+     * Asynchronously removes a file or symbolic link in the virtual file system (VFS).
+     *
+     * @param path - The path to the file to remove.
+     * @returns A promise that resolves when the file is removed.
+     */
+    unlink: (path: string, options?: ResolveFSOptions) => Promise<void>;
+    /**
+     * Removes a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     */
+    rmdirSync: (path: PathLike, options?: RmDirOptions & ResolveFSOptions) => any;
+    /**
+     * Removes a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    rmdir: (path: PathLike, options?: RmDirOptions & ResolveFSOptions) => Promise<void>;
+    /**
+     * Removes a file or directory in the virtual file system (VFS).
+     *
+     * @param path - The path to the file or directory to remove.
+     * @param options - Options for removing the file or directory.
+     * @returns A promise that resolves when the file or directory is removed.
+     */
+    rm: (path: PathLike, options?: RmOptions & ResolveFSOptions) => Promise<void>;
+    /**
+     * Synchronously removes a file or directory in the virtual file system (VFS).
+     *
+     * @param path - The path to the file or directory to remove.
+     * @param options - Options for removing the file or directory.
+     */
+    rmSync: (path: PathLike, options?: RmOptions & ResolveFSOptions) => void;
+    /**
+     * Creates a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    mkdirSync: (path: PathLike, options?: MakeDirectoryOptions) => string | undefined;
+    /**
+     * Creates a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    mkdir: (path: PathLike, options?: MakeDirectoryOptions) => Promise<string | undefined>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The contents of the file if it exists, otherwise undefined.
+     */
+    readFile: (pathOrId: string) => Promise<string | undefined>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     */
+    readFileSync: (pathOrId: string) => string | undefined;
+    /**
+     * Writes a file to the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @param data - The contents of the file.
+     * @param options - Optional parameters for writing the file.
+     * @returns A promise that resolves when the file is written.
+     */
+    writeFile: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => Promise<void>;
+    /**
+     * Writes a file to the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @param data - The contents of the file.
+     * @param options - Optional parameters for writing the file.
+     */
+    writeFileSync: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => void;
+    /**
+     * Moves a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    move: (srcPath: string, destPath: string) => Promise<void>;
+    /**
+     * Synchronously moves a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    moveSync: (srcPath: string, destPath: string) => void;
+    /**
+     * Copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copy: (srcPath: string, destPath: string) => Promise<void>;
+    /**
+     * Synchronously copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copySync: (srcPath: string, destPath: string) => void;
+    /**
+     * Glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param pattern - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    glob: (pattern: string | string[]) => Promise<string[]>;
+    /**
+     * Synchronously glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param pattern - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    globSync: (pattern: string | string[]) => string[];
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @param options - Optional parameters for resolving the path.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    resolve: (pathOrId: string, options?: ResolvePathOptions) => string | false;
+    /**
+     * Resolves a path based on TypeScript's `tsconfig.json` paths.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param path - The path to check.
+     * @returns The resolved file path if it exists, otherwise undefined.
+     */
+    resolveTsconfigPath: (path: string) => string | false;
+    /**
+     * Resolves a package name based on TypeScript's `tsconfig.json` paths.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param path - The path to check.
+     * @returns The resolved package name if it exists, otherwise undefined.
+     */
+    resolveTsconfigPathPackage: (path: string) => string | false;
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    realpathSync: (pathOrId: string) => string;
+    /**
+     * Retrieves a partial metadata mapping of all files in the virtual file system (VFS).
+     *
+     * @returns A record mapping file paths to their partial metadata.
+     */
+    getPartialMeta: () => Record<string, Partial<VirtualFileSystemMetadata>>;
+    /**
+     * A map of cached file paths to their underlying file content.
+     */
+    [__VFS_CACHE__]: Map<string, string>;
+    /**
+     * A reference to the underlying virtual file system.
+     */
+    [__VFS_VIRTUAL__]: Volume;
+    /**
+     * A reference to the underlying unified file system.
+     */
+    [__VFS_UNIFIED__]: IUnionFs;
+}
+
+type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
+/**
+ * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
+ */
+type WorkspaceConfig = Partial<StormWorkspaceConfig> & Required<Pick<StormWorkspaceConfig, "workspaceRoot">>;
+type PluginFactory<in out TContext extends PluginContext = PluginContext, TOptions = any> = (options: TOptions) => MaybePromise<Plugin<TContext>>;
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfigTuple<TContext extends PluginContext = PluginContext, TOptions = any> = [string | PluginFactory<TContext, TOptions>, TOptions] | [Plugin<TContext>];
+/**
+ * A configuration object for a Powerlines plugin.
+ */
+type PluginConfigObject<TContext extends PluginContext = PluginContext, TOptions = any> = {
+    plugin: string | PluginFactory<TContext, TOptions>;
+    options: TOptions;
+} | {
+    plugin: Plugin<TContext>;
+    options?: never;
+};
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfig<TContext extends PluginContext = PluginContext> = string | PluginFactory<TContext, void> | Plugin<TContext> | Promise<Plugin<TContext>> | PluginConfigTuple<TContext> | PluginConfigObject<TContext>;
+type ProjectType = "application" | "library";
+interface OutputConfig {
+    /**
+     * The path to output the final compiled files to
+     *
+     * @remarks
+     * If a value is not provided, Powerlines will attempt to:
+     * 1. Use the `outDir` value in the `tsconfig.json` file.
+     * 2. Use the `dist` directory in the project root directory.
+     *
+     * @defaultValue "dist/\{projectRoot\}"
+     */
+    outputPath?: string;
+    /**
+     * The format of the output files
+     *
+     * @defaultValue "virtual"
+     */
+    mode?: OutputModeType;
+    /**
+     * The path of the generated runtime declaration file relative to the workspace root.
+     *
+     * @defaultValue "\{projectRoot\}/powerlines.d.ts"
+     */
+    dts?: string | false;
+    /**
+     * A prefix to use for identifying builtin modules
+     *
+     * @remarks
+     * This prefix will be used to identify all builtin modules generated during the "prepare" phase. An example builtin ID for a module called `"utils"` would be `"{builtinPrefix}:utils"`.
+     *
+     * @defaultValue "powerlines"
+     */
+    builtinPrefix?: string;
+    /**
+     * The folder where the generated runtime artifacts will be located
+     *
+     * @remarks
+     * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
+     *
+     * @defaultValue "\{projectRoot\}/.powerlines"
+     */
+    artifactsFolder?: string;
+    /**
+     * The module format of the output files
+     *
+     * @remarks
+     * This option can be a single format or an array of formats. If an array is provided, multiple builds will be generated for each format.
+     *
+     * @defaultValue "esm"
+     */
+    format?: Format | Format[];
+    /**
+     * A list of assets to copy to the output directory
+     *
+     * @remarks
+     * The assets can be specified as a string (path to the asset) or as an object with a `glob` property (to match multiple files). The paths are relative to the project root directory.
+     */
+    assets?: Array<string | AssetGlob>;
+}
+interface BaseConfig {
+    /**
+     * The name of the project
+     */
+    name?: string;
+    /**
+     * The project display title
+     *
+     * @remarks
+     * This option is used in documentation generation and other places where a human-readable title is needed.
+     */
+    title?: string;
+    /**
+     * A description of the project
+     *
+     * @remarks
+     * If this option is not provided, the build process will try to use the \`description\` value from the `\package.json\` file.
+     */
+    description?: string;
+    /**
+     * The log level to use for the Powerlines processes.
+     *
+     * @defaultValue "info"
+     */
+    logLevel?: LogLevelLabel | null;
+    /**
+     * A custom logger function to use for logging messages
+     */
+    customLogger?: LogFn;
+    /**
+     * Explicitly set a mode to run in. This mode will be used at various points throughout the Powerlines processes, such as when compiling the source code.
+     *
+     * @defaultValue "production"
+     */
+    mode?: "development" | "test" | "production";
+    /**
+     * The entry point(s) for the application
+     */
+    entry?: TypeDefinitionParameter | TypeDefinitionParameter[];
+    /**
+     * Configuration for linting the source code
+     */
+    lint?: Record<string, any> | false;
+    /**
+     * Configuration for testing the source code
+     */
+    test?: Record<string, any> | false;
+    /**
+     * Configuration for the output of the build process
+     */
+    output?: OutputConfig;
+    /**
+     * Configuration for the transformation of the source code
+     */
+    transform?: Record<string, any>;
+    /**
+     * Options to to provide to the build process
+     */
+    build?: BuildConfig;
+    /**
+     * Configuration for documentation generation
+     *
+     * @remarks
+     * This configuration will be used by the documentation generation plugins during the `docs` command.
+     */
+    docs?: Record<string, any>;
+    /**
+     * The path to the tsconfig file to be used by the compiler
+     *
+     * @remarks
+     * If a value is not provided, the plugin will attempt to find the `tsconfig.json` file in the project root directory. The parsed tsconfig compiler options will be merged with the {@link Options.tsconfigRaw} value (if provided).
+     *
+     * @defaultValue "\{projectRoot\}/tsconfig.json"
+     */
+    tsconfig?: string;
+    /**
+     * The raw {@link TSConfig} object to be used by the compiler. This object will be merged with the `tsconfig.json` file.
+     *
+     * @see https://www.typescriptlang.org/tsconfig
+     *
+     * @remarks
+     * If populated, this option takes higher priority than `tsconfig`
+     */
+    tsconfigRaw?: TSConfig;
+}
+interface EnvironmentConfig extends BaseConfig {
+    /**
+     * Array of strings indicating the order in which fields in a package.json file should be resolved to determine the entry point for a module.
+     *
+     * @defaultValue `['browser', 'module', 'jsnext:main', 'jsnext']`
+     */
+    mainFields?: string[];
+    /**
+     * Array of strings indicating what conditions should be used for module resolution.
+     */
+    conditions?: string[];
+    /**
+     * Array of strings indicating what conditions should be used for external modules.
+     */
+    externalConditions?: string[];
+    /**
+     * Array of strings indicating what file extensions should be used for module resolution.
+     *
+     * @defaultValue `['.mjs', '.js', '.mts', '.ts', '.jsx', '.tsx', '.json']`
+     */
+    extensions?: string[];
+    /**
+     * Array of strings indicating what modules should be deduplicated to a single version in the build.
+     *
+     * @remarks
+     * This option is useful for ensuring that only one version of a module is included in the bundle, which can help reduce bundle size and avoid conflicts.
+     */
+    dedupe?: string[];
+    /**
+     * Array of strings or regular expressions that indicate what modules are builtin for the environment.
+     */
+    builtins?: (string | RegExp)[];
+    /**
+     * Configuration options for the preview server
+     */
+    preview?: PreviewOptions;
+    /**
+     * A flag indicating whether the build is for a Server-Side Rendering environment.
+     */
+    ssr?: boolean;
+    /**
+     * Define if this environment is used for Server-Side Rendering
+     *
+     * @defaultValue "server" (if it isn't the client environment)
+     */
+    consumer?: "client" | "server";
+}
+interface CommonUserConfig extends BaseConfig {
+    /**
+     * The type of project being built
+     *
+     * @defaultValue "application"
+     */
+    type?: ProjectType;
+    /**
+     * The root directory of the project
+     */
+    root: string;
+    /**
+     * The root directory of the project's source code
+     *
+     * @defaultValue "\{root\}/src"
+     */
+    sourceRoot?: string;
+    /**
+     * A path to a custom configuration file to be used instead of the default `storm.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+     *
+     * @remarks
+     * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+     */
+    configFile?: string;
+    /**
+     * Should the Powerlines CLI processes skip installing missing packages?
+     *
+     * @remarks
+     * This option is useful for CI/CD environments where the installation of packages is handled by a different process.
+     *
+     * @defaultValue false
+     */
+    skipInstalls?: boolean;
+    /**
+     * Should the compiler processes skip any improvements that make use of cache?
+     *
+     * @defaultValue false
+     */
+    skipCache?: boolean;
+    /**
+     * A list of resolvable paths to plugins used during the build process
+     */
+    plugins?: PluginConfig<PluginContext<any>>[];
+    /**
+     * Environment-specific configurations
+     */
+    environments?: Record<string, EnvironmentConfig>;
+    /**
+     * A string identifier that allows a child framework or tool to identify itself when using Powerlines.
+     *
+     * @remarks
+     * If no values are provided for {@link OutputConfig.dts | output.dts}, {@link OutputConfig.builtinPrefix | output.builtinPrefix}, or {@link OutputConfig.artifactsFolder | output.artifactsFolder}, this value will be used as the default.
+     *
+     * @defaultValue "powerlines"
+     */
+    framework?: string;
+}
+type UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> = CommonUserConfig & {
+    build?: TBuildConfig & {
+        /**
+         * The build variant being used by the Powerlines engine.
+         */
+        variant?: TBuildVariant;
+    };
+    override?: Partial<TBuildResolvedConfig>;
+};
+type PowerlinesCommand = "new" | "prepare" | "build" | "lint" | "test" | "docs" | "release" | "clean";
+/**
+ * The configuration provided while executing Powerlines commands.
+ */
+type InlineConfig<TUserConfig extends UserConfig = UserConfig> = Partial<TUserConfig> & {
+    /**
+     * A string identifier for the Powerlines command being executed
+     */
+    command: PowerlinesCommand;
+};
+
+interface ResolvedEntryTypeDefinition extends TypeDefinition {
+    /**
+     * The user provided entry point in the source code
+     */
+    input: TypeDefinition;
+    /**
+     * An optional name to use in the package export during the build process
+     */
+    output?: string;
+}
+type EnvironmentResolvedConfig = Omit<EnvironmentConfig, "consumer" | "mode" | "ssr" | "preview" | "mainFields" | "extensions"> & Required<Pick<EnvironmentConfig, "consumer" | "mode" | "ssr" | "mainFields" | "extensions">> & {
+    /**
+     * The name of the environment
+     */
+    name: string;
+    /**
+     * Configuration options for the preview server
+     */
+    preview?: ResolvedPreviewOptions;
+};
+type ResolvedAssetGlob = AssetGlob & Required<Pick<AssetGlob, "input">>;
+type OutputResolvedConfig = Required<Omit<OutputConfig, "assets"> & {
+    assets: ResolvedAssetGlob[];
+}>;
+/**
+ * The resolved options for the Powerlines project configuration.
+ */
+type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "test" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel" | "framework"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "lint" | "test" | "build" | "transform" | "override" | "framework">> & {
+    /**
+     * The configuration options that were provided inline to the Powerlines CLI.
+     */
+    inlineConfig: InlineConfig<TUserConfig>;
+    /**
+     * The original configuration options that were provided by the user to the Powerlines process.
+     */
+    userConfig: TUserConfig;
+    /**
+     * A string identifier for the Powerlines command being executed.
+     */
+    command: NonUndefined<InlineConfig<TUserConfig>["command"]>;
+    /**
+     * The root directory of the project's source code
+     *
+     * @defaultValue "\{projectRoot\}/src"
+     */
+    sourceRoot: NonUndefined<TUserConfig["sourceRoot"]>;
+    /**
+     * The root directory of the project.
+     */
+    projectRoot: NonUndefined<TUserConfig["root"]>;
+    /**
+     * The type of project being built.
+     */
+    projectType: NonUndefined<TUserConfig["type"]>;
+    /**
+     * The output configuration options to use for the build process
+     */
+    output: OutputResolvedConfig;
+    /**
+     * The log level to use for the Powerlines processes.
+     *
+     * @defaultValue "info"
+     */
+    logLevel: "error" | "warn" | "info" | "debug" | "trace" | null;
+};
+
+interface MetaInfo {
+    /**
+     * The checksum generated from the resolved options
+     */
+    checksum: string;
+    /**
+     * The build id
+     */
+    buildId: string;
+    /**
+     * The release id
+     */
+    releaseId: string;
+    /**
+     * The build timestamp
+     */
+    timestamp: number;
+    /**
+     * A hash that represents the path to the project root directory
+     */
+    projectRootHash: string;
+    /**
+     * A hash that represents the path to the project root directory
+     */
+    configHash: string;
+    /**
+     * A mapping of runtime ids to their corresponding file paths
+     */
+    builtinIdMap: Record<string, string>;
+    /**
+     * A mapping of virtual file paths to their corresponding file contents
+     */
+    virtualFiles: Record<string, string | null>;
+}
+interface Resolver extends Jiti {
+    plugin: Jiti;
+}
+interface InitContextOptions {
+    /**
+     * If false, the plugin will be loaded after all other plugins.
+     *
+     * @defaultValue true
+     */
+    isHighPriority: boolean;
+}
+interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
+    /**
+     * The Storm workspace configuration
+     */
+    workspaceConfig: WorkspaceConfig;
+    /**
+     * An object containing the options provided to Powerlines
+     */
+    config: TResolvedConfig;
+    /**
+     * A logging function for the Powerlines engine
+     */
+    log: LogFn;
+    /**
+     * The metadata information
+     */
+    meta: MetaInfo;
+    /**
+     * The metadata information currently written to disk
+     */
+    persistedMeta?: MetaInfo;
+    /**
+     * The Powerlines artifacts directory
+     */
+    artifactsPath: string;
+    /**
+     * The path to the Powerlines builtin runtime modules directory
+     */
+    builtinsPath: string;
+    /**
+     * The path to the Powerlines entry modules directory
+     */
+    entryPath: string;
+    /**
+     * The path to the Powerlines TypeScript declaration files directory
+     */
+    dtsPath: string;
+    /**
+     * The path to a directory where the reflection data buffers (used by the build processes) are stored
+     */
+    dataPath: string;
+    /**
+     * The path to a directory where the project cache (used by the build processes) is stored
+     */
+    cachePath: string;
+    /**
+     * The Powerlines environment paths
+     */
+    envPaths: EnvPaths;
+    /**
+     * The file system path to the Powerlines package installation
+     */
+    powerlinesPath: string;
+    /**
+     * The relative path to the Powerlines workspace root directory
+     */
+    relativeToWorkspaceRoot: string;
+    /**
+     * The project's `package.json` file content
+     */
+    packageJson: PackageJson & Record<string, any>;
+    /**
+     * The project's `project.json` file content
+     */
+    projectJson?: Record<string, any>;
+    /**
+     * The dependency installations required by the project
+     */
+    dependencies: Record<string, string | Range>;
+    /**
+     * The development dependency installations required by the project
+     */
+    devDependencies: Record<string, string | Range>;
+    /**
+     * The parsed TypeScript configuration from the `tsconfig.json` file
+     */
+    tsconfig: ParsedTypeScriptConfig;
+    /**
+     * The entry points of the source code
+     */
+    entry: ResolvedEntryTypeDefinition[];
+    /**
+     * The virtual file system manager used during the build process to reference generated runtime files
+     */
+    fs: VirtualFileSystemInterface;
+    /**
+     * The Jiti module resolver
+     */
+    resolver: Resolver;
+    /**
+     * The builtin module id that exist in the Powerlines virtual file system
+     */
+    builtins: string[];
+    /**
+     * The Powerlines builtin virtual files
+     */
+    getBuiltins: () => Promise<VirtualFile[]>;
+    /**
+     * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
+     *
+     * @param code - The source code of the builtin file
+     * @param id - The unique identifier of the builtin file
+     * @param path - An optional path to write the builtin file to
+     * @param options - Options for writing the file
+     */
+    writeBuiltin: (code: string, id: string, path?: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
+    /**
+     * Resolves a entry virtual file and writes it to the VFS if it does not already exist
+     *
+     * @param code - The source code of the entry file
+     * @param path - An optional path to write the entry file to
+     * @param options - Options for writing the file
+     */
+    writeEntry: (code: string, path: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
+    /**
+     * Parses the source code and returns a {@link ParseResult} object.
+     */
+    parse: (code: string, id: string, options?: ParserOptions | null) => Promise<ParseResult>;
+    /**
+     * A function to update the context fields using a new user configuration options
+     */
+    withUserConfig: (userConfig: UserConfig, options?: InitContextOptions) => Promise<void>;
+    /**
+     * A function to update the context fields using inline configuration options
+     */
+    withInlineConfig: (inlineConfig: InlineConfig, options?: InitContextOptions) => Promise<void>;
+    /**
+     * Create a new logger instance
+     *
+     * @param name - The name to use for the logger instance
+     * @returns A logger function
+     */
+    createLog: (name: string | null) => LogFn;
+    /**
+     * Extend the current logger instance with a new name
+     *
+     * @param name - The name to use for the extended logger instance
+     * @returns A logger function
+     */
+    extendLog: (name: string) => LogFn;
+}
+interface PluginContext<out TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Context<TResolvedConfig>, UnpluginContext {
+    /**
+     * The environment specific resolved configuration
+     */
+    environment: EnvironmentResolvedConfig;
+    /**
+     * An alternative property name for the {@link log} property
+     *
+     * @remarks
+     * This is provided for compatibility with other logging libraries that expect a `logger` property.
+     */
+    logger: LogFn;
+}
+type BuildPluginContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = PluginContext<TResolvedConfig> & Omit<UnpluginBuildContext, "parse">;
+
+declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
+type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
+
+interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> {
+    /**
+     * The order in which the plugin should be applied.
+     */
+    order?: "pre" | "post" | null | undefined;
+    /**
+     * A filter to determine when the hook should be called.
+     */
+    filter?: TFilter;
+    /**
+     * The hook function to be called.
+     */
+    handler: THookFunction;
+}
+type PluginHook<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> = THookFunction | PluginHookObject<THookFunction, TFilter>;
+/**
+ * A result returned by the plugin from the `generateTypes` hook that describes the declaration types output file.
+ */
+interface GenerateTypesResult {
+    directives?: string[];
+    code: string;
+}
+interface BasePluginHookFunctions<TContext extends PluginContext = PluginContext> extends Record<CommandType, (this: TContext) => MaybePromise<void>> {
+    /**
+     * A function that returns configuration options to be merged with the build context's options.
+     *
+     * @remarks
+     * Modify config before it's resolved. The hook can either mutate {@link Context.config} on the passed-in context directly, or return a partial config object that will be deeply merged into existing config.
+     *
+     * @warning User plugins are resolved before running this hook so injecting other plugins inside the config hook will have no effect. If you want to add plugins, consider doing so in the {@link Plugin.dependsOn} property instead.
+     *
+     * @see https://vitejs.dev/guide/api-plugin#config
+     *
+     * @param this - The build context.
+     * @param config - The partial configuration object to be modified.
+     * @returns A promise that resolves to a partial configuration object.
+     */
+    config: (this: Context<TContext["config"]>) => MaybePromise<Partial<TContext["config"]["userConfig"]>>;
+    /**
+     * Modify environment configs before it's resolved. The hook can either mutate the passed-in environment config directly, or return a partial config object that will be deeply merged into existing config.
+     *
+     * @remarks
+     * This hook is called for each environment with a partially resolved environment config that already accounts for the default environment config values set at the root level. If plugins need to modify the config of a given environment, they should do it in this hook instead of the config hook. Leaving the config hook only for modifying the root default environment config.
+     *
+     * @see https://vitejs.dev/guide/api-plugin#configenvironment
+     *
+     * @param this - The build context.
+     * @param name - The name of the environment being configured.
+     * @param environment - The Vite-like environment object containing information about the current build environment.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    configEnvironment: (this: TContext, name: string, environment: EnvironmentConfig) => MaybePromise<Partial<EnvironmentResolvedConfig> | undefined | null>;
+    /**
+     * A hook that is called when the plugin is resolved.
+     *
+     * @see https://vitejs.dev/guide/api-plugin#configresolved
+     *
+     * @param this - The build context.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    configResolved: (this: TContext) => MaybePromise<void>;
+    /**
+     * A hook that is called to overwrite the generated declaration types file (.d.ts). The generated type definitions should describe the built-in modules/logic added during the `prepare` task.
+     *
+     * @param this - The build context.
+     * @param code - The source code to generate types for.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    generateTypes: (this: TContext, code: string) => MaybePromise<GenerateTypesResult | string | undefined | null>;
+    /**
+     * A hook that is called at the start of the build process.
+     *
+     * @param this - The build context and unplugin build context.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    buildStart: (this: BuildPluginContext<TContext["config"]> & TContext) => MaybePromise<void>;
+    /**
+     * A hook that is called at the end of the build process.
+     *
+     * @param this - The build context and unplugin build context.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    buildEnd: (this: BuildPluginContext<TContext["config"]> & TContext) => MaybePromise<void>;
+    /**
+     * A hook that is called to transform the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param code - The source code to transform.
+     * @param id - The identifier of the source code.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    transform: (this: BuildPluginContext<TContext["config"]> & TContext, code: string, id: string) => MaybePromise<TransformResult>;
+    /**
+     * A hook that is called to load the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param id - The identifier of the source code.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    load: (this: BuildPluginContext<TContext["config"]> & TContext, id: string) => MaybePromise<TransformResult>;
+    /**
+     * A hook that is called to resolve the identifier of the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param id - The identifier of the source code.
+     * @param importer - The importer of the source code.
+     * @param options - The options for resolving the identifier.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    resolveId: (this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
+        isEntry: boolean;
+    }) => MaybePromise<string | ExternalIdResult | null | undefined>;
+    /**
+     * A hook that is called to write the bundle to disk.
+     *
+     * @param this - The build context.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    writeBundle: (this: TContext) => MaybePromise<void>;
+}
+type BuildPlugin<TContext extends PluginContext = PluginContext, TBuildVariant extends UnpluginBuildVariant = UnpluginBuildVariant, TOptions extends Required<UnpluginOptions>[TBuildVariant] = Required<UnpluginOptions>[TBuildVariant]> = {
+    [TKey in keyof TOptions]: TOptions[TKey] extends FunctionLike ? (this: ThisParameterType<TOptions[TKey]> & TContext, ...args: Parameters<TOptions[TKey]>) => ReturnType<TOptions[TKey]> | MaybePromise<ReturnType<TOptions[TKey]>> : TOptions[TKey];
+};
+type PluginHooks<TContext extends PluginContext = PluginContext> = {
+    [TKey in keyof BasePluginHookFunctions<TContext>]: PluginHook<BasePluginHookFunctions<TContext>[TKey]>;
+} & {
+    /**
+     * A function that returns configuration options to be merged with the build context's options.
+     *
+     * @remarks
+     * Modify config before it's resolved. The hook can either mutate {@link Context.config} on the passed-in context directly, or return a partial config object that will be deeply merged into existing config.
+     *
+     * @warning User plugins are resolved before running this hook so injecting other plugins inside the config hook will have no effect. If you want to add plugins, consider doing so in the {@link Plugin.dependsOn} property instead.
+     *
+     * @see https://vitejs.dev/guide/api-plugin#config
+     *
+     * @param this - The build context.
+     * @param config - The partial configuration object to be modified.
+     * @returns A promise that resolves to a partial configuration object.
+     */
+    config: PluginHook<(this: Context<TContext["config"]>) => MaybePromise<Partial<TContext["config"]["userConfig"]>>> | Partial<TContext["config"]["userConfig"]>;
+    /**
+     * A hook that is called to transform the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param code - The source code to transform.
+     * @param id - The identifier of the source code.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    transform: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, code: string, id: string) => MaybePromise<TransformResult>, "code" | "id">;
+    /**
+     * A hook that is called to load the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param id - The identifier of the source code.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    load: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string) => MaybePromise<TransformResult>, "id">;
+    /**
+     * A hook that is called to resolve the identifier of the source code.
+     *
+     * @param this - The build context, unplugin build context, and unplugin context.
+     * @param id - The identifier of the source code.
+     * @param importer - The importer of the source code.
+     * @param options - The options for resolving the identifier.
+     * @returns A promise that resolves when the hook is complete.
+     */
+    resolveId: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
+        isEntry: boolean;
+    }) => MaybePromise<string | ExternalIdResult | null | undefined>, "id">;
+};
+type PluginBuildPlugins<TContext extends PluginContext = PluginContext> = {
+    [TBuildVariant in UnpluginBuildVariant]?: BuildPlugin<TContext, TBuildVariant>;
+};
+interface Plugin<in out TContext extends PluginContext<ResolvedConfig> = PluginContext<ResolvedConfig>> extends Partial<PluginHooks<TContext>>, PluginBuildPlugins<TContext> {
+    /**
+     * The name of the plugin, for use in deduplication, error messages and logs.
+     */
+    name: string;
+    /**
+     * Enforce plugin invocation tier similar to webpack loaders. Hooks ordering is still subject to the `order` property in the hook object.
+     *
+     * @remarks
+     * The Plugin invocation order is as follows:
+     * - `enforce: 'pre'` plugins
+     * - `order: 'pre'` plugin hooks
+     * - any other plugins (normal)
+     * - `order: 'post'` plugin hooks
+     * - `enforce: 'post'` plugins
+     *
+     * @see https://vitejs.dev/guide/api-plugin.html#plugin-ordering
+     * @see https://rollupjs.org/plugin-development/#build-hooks
+     * @see https://webpack.js.org/concepts/loaders/#enforce---pre-and-post
+     * @see https://esbuild.github.io/plugins/#concepts
+     */
+    enforce?: "pre" | "post";
+    /**
+     * A function to determine if two plugins are the same and can be de-duplicated.
+     *
+     * @remarks
+     * If this is not provided, plugins are de-duplicated by comparing their names.
+     *
+     * @param other - The other plugin to compare against.
+     * @returns `true` if the two plugins are the same, `false` otherwise.
+     */
+    dedupe?: false | ((other: Plugin<any>) => boolean);
+    /**
+     * A list of pre-requisite plugins that must be loaded before this plugin can be used.
+     */
+    dependsOn?: PluginConfig<any>[];
+    /**
+     * Define environments where this plugin should be active. By default, the plugin is active in all environments.
+     *
+     * @param environment - The environment to check.
+     * @returns `true` if the plugin should be active in the specified environment, `false` otherwise.
+     */
+    applyToEnvironment?: (environment: EnvironmentResolvedConfig) => MaybePromise<boolean | Plugin<any>>;
+}
+
+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;
+};
+
+export type { GenerateDocsOptions as G, Plugin as P, TypeDocPluginOptions as T, TypeDocPluginContext as a, TypeDocPluginUserConfig as b, TypeDocPluginResolvedConfig as c };