typedoc 0.26.10 → 0.27.0-beta.0

package/bin/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/bin/typedoc

@@ -2,4 +2,4 @@
 //@ts-check
 
 /* eslint-disable @typescript-eslint/no-var-requires */
-require("../dist/lib/cli");
+import("../dist/lib/cli.js");

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-export { Application, type ApplicationEvents } from "./lib/application";
-export { EventDispatcher } from "./lib/utils/events";
-export { resetReflectionID } from "./lib/models/reflections/abstract";
+/**
+ * @module TypeDoc API
+ */
+export { Application, type ApplicationEvents } from "./lib/application.js";
+export { EventDispatcher } from "./lib/utils/events.js";
+export { resetReflectionID } from "./lib/models/reflections/abstract.js";
 /**
  * All symbols documented under the Models namespace are also available in the root import.
  *
@@ -10,19 +13,26 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
  * @categoryDescription Reflections
  * Describes a documentation entry. The root entry is a {@link ProjectReflection}
  * and contains {@link DeclarationReflection} instances.
+ *
+ * @summary
+ * TypeDoc converts source code into these object types.
  */
-export * as Models from "./lib/models";
+export * as Models from "./lib/models/index.js";
 /**
  * All symbols documented under the Configuration namespace are also available in the root import.
+ * @summary
+ * Controls how TypeDoc reads option files and what options are available.
  */
-export * as Configuration from "./lib/utils/options";
-export * from "./lib/models";
-export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, type ConverterEvents, } from "./lib/converter";
-export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
-export type { RenderTemplate, RendererHooks, NavigationElement, RendererEvents, PageHeading, } from "./lib/output";
-export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, OptionDefaults, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
-export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, JsDocCompatibility, } from "./lib/utils";
-export { JSONOutput, Serializer, type SerializerEvents, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
-export * as Internationalization from "./lib/internationalization/index";
+export * as Configuration from "./lib/utils/options/index.js";
+export * from "./lib/models/index.js";
+export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, type ConverterEvents, } from "./lib/converter/index.js";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output/index.js";
+export type { RenderTemplate, RendererHooks, NavigationElement, RendererEvents, PageHeading, } from "./lib/output/index.js";
+export { Outputs } from "./lib/output/output.js";
+export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, OptionDefaults, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils/index.js";
+export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, JsDocCompatibility, OutputSpecification, } from "./lib/utils/index.js";
+export { JSONOutput, Serializer, type SerializerEvents, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization/index.js";
+export * as Internationalization from "./lib/internationalization/index.js";
+export type { TranslatableStrings } from "./lib/internationalization/internationalization.js";
 import TypeScript from "typescript";
 export { TypeScript };

package/dist/index.js

@@ -1,41 +1,9 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.OptionDefaults = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.EventDispatcher = exports.Application = void 0;
-var application_1 = require("./lib/application");
-Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
-var events_1 = require("./lib/utils/events");
-Object.defineProperty(exports, "EventDispatcher", { enumerable: true, get: function () { return events_1.EventDispatcher; } });
-var abstract_1 = require("./lib/models/reflections/abstract");
-Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: function () { return abstract_1.resetReflectionID; } });
+/**
+ * @module TypeDoc API
+ */
+export { Application } from "./lib/application.js";
+export { EventDispatcher } from "./lib/utils/events.js";
+export { resetReflectionID } from "./lib/models/reflections/abstract.js";
 /**
  * All symbols documented under the Models namespace are also available in the root import.
  *
@@ -45,50 +13,23 @@ Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: fun
  * @categoryDescription Reflections
  * Describes a documentation entry. The root entry is a {@link ProjectReflection}
  * and contains {@link DeclarationReflection} instances.
+ *
+ * @summary
+ * TypeDoc converts source code into these object types.
  */
-exports.Models = __importStar(require("./lib/models"));
+export * as Models from "./lib/models/index.js";
 /**
  * All symbols documented under the Configuration namespace are also available in the root import.
+ * @summary
+ * Controls how TypeDoc reads option files and what options are available.
  */
-exports.Configuration = __importStar(require("./lib/utils/options"));
-__exportStar(require("./lib/models"), exports);
-var converter_1 = require("./lib/converter");
-Object.defineProperty(exports, "Converter", { enumerable: true, get: function () { return converter_1.Converter; } });
-Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return converter_1.Context; } });
-var output_1 = require("./lib/output");
-Object.defineProperty(exports, "Renderer", { enumerable: true, get: function () { return output_1.Renderer; } });
-Object.defineProperty(exports, "DefaultTheme", { enumerable: true, get: function () { return output_1.DefaultTheme; } });
-Object.defineProperty(exports, "DefaultThemeRenderContext", { enumerable: true, get: function () { return output_1.DefaultThemeRenderContext; } });
-Object.defineProperty(exports, "Slugger", { enumerable: true, get: function () { return output_1.Slugger; } });
-Object.defineProperty(exports, "UrlMapping", { enumerable: true, get: function () { return output_1.UrlMapping; } });
-Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { return output_1.Theme; } });
-Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return output_1.PageEvent; } });
-Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return output_1.RendererEvent; } });
-Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: function () { return output_1.MarkdownEvent; } });
-Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function () { return output_1.IndexEvent; } });
-var utils_1 = require("./lib/utils");
-Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
-Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return utils_1.Option; } });
-Object.defineProperty(exports, "CommentStyle", { enumerable: true, get: function () { return utils_1.CommentStyle; } });
-Object.defineProperty(exports, "JSX", { enumerable: true, get: function () { return utils_1.JSX; } });
-Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return utils_1.LogLevel; } });
-Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return utils_1.Logger; } });
-Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return utils_1.Options; } });
-Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return utils_1.OptionDefaults; } });
-Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return utils_1.PackageJsonReader; } });
-Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: function () { return utils_1.ParameterHint; } });
-Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return utils_1.ParameterType; } });
-Object.defineProperty(exports, "TSConfigReader", { enumerable: true, get: function () { return utils_1.TSConfigReader; } });
-Object.defineProperty(exports, "TypeDocReader", { enumerable: true, get: function () { return utils_1.TypeDocReader; } });
-Object.defineProperty(exports, "EntryPointStrategy", { enumerable: true, get: function () { return utils_1.EntryPointStrategy; } });
-Object.defineProperty(exports, "EventHooks", { enumerable: true, get: function () { return utils_1.EventHooks; } });
-Object.defineProperty(exports, "MinimalSourceFile", { enumerable: true, get: function () { return utils_1.MinimalSourceFile; } });
-Object.defineProperty(exports, "normalizePath", { enumerable: true, get: function () { return utils_1.normalizePath; } });
-var serialization_1 = require("./lib/serialization");
-Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function () { return serialization_1.JSONOutput; } });
-Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });
-Object.defineProperty(exports, "Deserializer", { enumerable: true, get: function () { return serialization_1.Deserializer; } });
-Object.defineProperty(exports, "SerializeEvent", { enumerable: true, get: function () { return serialization_1.SerializeEvent; } });
-exports.Internationalization = __importStar(require("./lib/internationalization/index"));
-const typescript_1 = __importDefault(require("typescript"));
-exports.TypeScript = typescript_1.default;
+export * as Configuration from "./lib/utils/options/index.js";
+export * from "./lib/models/index.js";
+export { Converter, Context, } from "./lib/converter/index.js";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output/index.js";
+export { Outputs } from "./lib/output/output.js";
+export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, OptionDefaults, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils/index.js";
+export { JSONOutput, Serializer, Deserializer, SerializeEvent, } from "./lib/serialization/index.js";
+export * as Internationalization from "./lib/internationalization/index.js";
+import TypeScript from "typescript";
+export { TypeScript };

package/dist/lib/application-events.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplicationEvents = void 0;
-exports.ApplicationEvents = {
+export const ApplicationEvents = {
     BOOTSTRAP_END: "bootstrapEnd",
     REVIVE: "reviveProject",
     VALIDATE_PROJECT: "validateProject",

package/dist/lib/application.d.ts

@@ -1,14 +1,14 @@
-import { Converter } from "./converter/index";
-import { Renderer } from "./output/renderer";
-import { Deserializer, Serializer } from "./serialization";
-import type { ProjectReflection } from "./models/index";
-import { Logger, type OptionsReader } from "./utils/index";
-import { type AbstractComponent, ChildableComponent } from "./utils/component";
-import { Options } from "./utils";
-import type { TypeDocOptions } from "./utils/options/declaration";
-import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
-import { Internationalization } from "./internationalization/internationalization";
-import { FileRegistry } from "./models/FileRegistry";
+import { Deserializer, Serializer } from "./serialization/index.js";
+import { Converter } from "./converter/index.js";
+import { Renderer } from "./output/renderer.js";
+import type { ProjectReflection } from "./models/index.js";
+import { Logger, type OptionsReader, AbstractComponent } from "./utils/index.js";
+import { Options } from "./utils/index.js";
+import type { TypeDocOptions } from "./utils/options/declaration.js";
+import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point.js";
+import { Internationalization } from "./internationalization/internationalization.js";
+import { FileRegistry } from "./models/FileRegistry.js";
+import { Outputs } from "./output/output.js";
 export declare function createAppForTesting(): Application;
 export interface ApplicationEvents {
     bootstrapEnd: [Application];
@@ -32,14 +32,18 @@ export interface ApplicationEvents {
  *
  * Access to an Application instance can be retrieved with {@link Application.bootstrap} or
  * {@link Application.bootstrapWithPlugins}. It can not be constructed manually.
+ *
+ * @group Common
+ * @summary Root level class which contains most useful behavior.
  */
-export declare class Application extends ChildableComponent<Application, AbstractComponent<Application, {}>, ApplicationEvents> {
+export declare class Application extends AbstractComponent<Application, ApplicationEvents> {
     /**
      * The converter used to create the declaration reflections.
      */
     converter: Converter;
+    outputs: Outputs;
     /**
-     * The renderer used to generate the documentation output.
+     * The renderer used to generate the HTML documentation output.
      */
     renderer: Renderer;
     /**
@@ -62,7 +66,7 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     /**
      * Proxy based shortcuts for internationalization keys.
      */
-    i18n: import("./internationalization/internationalization").TranslationProxy;
+    i18n: import("./internationalization/internationalization.js").TranslationProxy;
     options: Options;
     files: FileRegistry;
     /** @internal */
@@ -114,17 +118,19 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      */
     static bootstrap(options?: Partial<TypeDocOptions>, readers?: readonly OptionsReader[]): Promise<Application>;
     private _bootstrap;
-    private setOptions;
+    /** @internal */
+    setOptions(options: Partial<TypeDocOptions>, reportErrors?: boolean): boolean;
     /**
      * Return the path to the TypeScript compiler.
      */
     getTypeScriptPath(): string;
     getTypeScriptVersion(): string;
+    getEntryPoints(): Promise<DocumentationEntryPoint[] | undefined>;
     /**
      * Gets the entry points to be documented according to the current `entryPoints` and `entryPointStrategy` options.
      * May return undefined if entry points fail to be expanded.
      */
-    getEntryPoints(): DocumentationEntryPoint[] | undefined;
+    getDefinedEntryPoints(): DocumentationEntryPoint[] | undefined;
     /**
      * Run the converter for the given set of files and return the generated reflections.
      *
@@ -133,6 +139,10 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     convert(): Promise<ProjectReflection | undefined>;
     convertAndWatch(success: (project: ProjectReflection) => Promise<void>): void;
     validate(project: ProjectReflection): void;
+    /**
+     * Render outputs selected with options for the specified project
+     */
+    generateOutputs(project: ProjectReflection): Promise<void>;
     /**
      * Render HTML for the given project
      */