@nikovirtala/projen-typedoc 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/.amazonq/rules/standards.md +320 -0
  2. package/.jsii +1404 -0
  3. package/API.md +1188 -0
  4. package/LICENSE +19 -0
  5. package/README.md +72 -0
  6. package/docs/api/.nojekyll +1 -0
  7. package/docs/api/assets/hierarchy.js +1 -0
  8. package/docs/api/assets/highlight.css +71 -0
  9. package/docs/api/assets/icons.js +18 -0
  10. package/docs/api/assets/icons.svg +1 -0
  11. package/docs/api/assets/main.js +60 -0
  12. package/docs/api/assets/navigation.js +1 -0
  13. package/docs/api/assets/search.js +1 -0
  14. package/docs/api/assets/style.css +1633 -0
  15. package/docs/api/classes/TypeDoc.html +37 -0
  16. package/docs/api/enums/CommentStyle.html +7 -0
  17. package/docs/api/enums/EntryPointStrategy.html +11 -0
  18. package/docs/api/enums/LogLevel.html +8 -0
  19. package/docs/api/enums/Visibility.html +6 -0
  20. package/docs/api/functions/toJson_TypeDocConfiguration.html +2 -0
  21. package/docs/api/hierarchy.html +1 -0
  22. package/docs/api/index.html +24 -0
  23. package/docs/api/interfaces/TypeDocConfiguration.html +141 -0
  24. package/docs/api/interfaces/TypeDocOptions.html +9 -0
  25. package/docs/api/interfaces/ValidationOptions.html +9 -0
  26. package/docs/api/modules.html +1 -0
  27. package/lib/index.d.ts +37 -0
  28. package/lib/index.js +70 -0
  29. package/lib/typedoc-config.d.ts +363 -0
  30. package/lib/typedoc-config.js +129 -0
  31. package/package.json +84 -0
  32. package/typedoc.jsonc +9 -0
package/docs/api/modules.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@nikovirtala/projen-typedoc</title><meta name="description" content="Documentation for @nikovirtala/projen-typedoc"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@nikovirtala/projen-typedoc</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"></ul><h1>@nikovirtala/projen-typedoc</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumerations"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Enumerations</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="commentstyle"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><a href="enums/CommentStyle.html">CommentStyle</a><a href="#commentstyle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="entrypointstrategy"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><a href="enums/EntryPointStrategy.html">EntryPointStrategy</a><a href="#entrypointstrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="loglevel"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><a href="enums/LogLevel.html">LogLevel</a><a href="#loglevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="visibility"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><a href="enums/Visibility.html">Visibility</a><a href="#visibility" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="typedoc"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><a href="classes/TypeDoc.html">TypeDoc</a><a href="#typedoc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Interfaces</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="typedocconfiguration"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><a href="interfaces/TypeDocConfiguration.html">TypeDocConfiguration</a><a href="#typedocconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="typedocoptions"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><a href="interfaces/TypeDocOptions.html">TypeDocOptions</a><a href="#typedocoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="validationoptions"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><a href="interfaces/ValidationOptions.html">ValidationOptions</a><a href="#validationoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="tojson_typedocconfiguration"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/toJson_TypeDocConfiguration.html">toJson_TypeDocConfiguration</a><a href="#tojson_typedocconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumerations"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Enumerations</summary><div><a href="#commentstyle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><span>Comment<wbr/>Style</span></a><a href="#entrypointstrategy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><span>Entry<wbr/>Point<wbr/>Strategy</span></a><a href="#loglevel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><span>Log<wbr/>Level</span></a><a href="#visibility"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="assets/icons.svg#icon-8"></use></svg><span>Visibility</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#typedoc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><span>Type<wbr/>Doc</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Interfaces</summary><div><a href="#typedocconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><span>Type<wbr/>Doc<wbr/>Configuration</span></a><a href="#typedocoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><span>Type<wbr/>Doc<wbr/>Options</span></a><a href="#validationoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg><span>Validation<wbr/>Options</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#tojson_typedocconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>to<wbr/>Json_<wbr/>Type<wbr/>Doc<wbr/>Configuration</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">@nikovirtala/projen-typedoc</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/lib/index.d.ts ADDED
@@ -0,0 +1,37 @@
1
+ import { Component } from "projen/lib/component";
2
+ import type { NodeProject } from "projen/lib/javascript/node-project";
3
+ import { JsonFile } from "projen/lib/json";
4
+ import type { Project } from "projen/lib/project";
5
+ import type { Task } from "projen/lib/task";
6
+ import { type TypeDocConfiguration } from "./typedoc-config";
7
+ export interface TypeDocOptions {
8
+ /**
9
+ * Version of TypeDoc to use
10
+ *
11
+ * @default "^0.28"
12
+ */
13
+ readonly version?: string;
14
+ /**
15
+ * Full TypeDoc configuration
16
+ *
17
+ * This configuration will be merged with the default configuration
18
+ */
19
+ readonly typeDocConfig?: TypeDocConfiguration;
20
+ }
21
+ /**
22
+ * TypeDoc component for projen projects
23
+ */
24
+ export declare class TypeDoc extends Component {
25
+ static of(project: Project): TypeDoc | undefined;
26
+ private readonly typeDocConfiguration;
27
+ /**
28
+ * TypeDoc task
29
+ */
30
+ readonly task: Task;
31
+ /**
32
+ * TypeDoc configuration file
33
+ */
34
+ readonly file: JsonFile;
35
+ constructor(project: NodeProject, options?: TypeDocOptions);
36
+ }
37
+ export * from "./typedoc-config";
package/lib/index.js ADDED
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ var _a;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.TypeDoc = void 0;
19
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
20
+ const component_1 = require("projen/lib/component");
21
+ const json_1 = require("projen/lib/json");
22
+ const util_1 = require("projen/lib/util");
23
+ const typedoc_config_1 = require("./typedoc-config");
24
+ /**
25
+ * Default TypeDoc configuration
26
+ */
27
+ const DEFAULT_CONFIG = {
28
+ entryPointStrategy: typedoc_config_1.EntryPointStrategy.EXPAND,
29
+ out: "docs/api",
30
+ exclude: ["**/*.test.ts"],
31
+ excludePrivate: true,
32
+ };
33
+ /**
34
+ * TypeDoc component for projen projects
35
+ */
36
+ class TypeDoc extends component_1.Component {
37
+ static of(project) {
38
+ const isTypeDoc = (c) => c instanceof TypeDoc;
39
+ return project.components.find(isTypeDoc);
40
+ }
41
+ constructor(project, options = {}) {
42
+ super(project);
43
+ const typedoc = "typedoc";
44
+ project.addDevDeps(`${typedoc}@${options.version ?? "^0.28"}`);
45
+ /*
46
+ * Merge default configuration with user-provided configuration
47
+ */
48
+ this.typeDocConfiguration = (0, util_1.deepMerge)([(0, typedoc_config_1.toJson_TypeDocConfiguration)(DEFAULT_CONFIG), (0, typedoc_config_1.toJson_TypeDocConfiguration)(options.typeDocConfig ?? {})], { mergeArrays: true });
49
+ this.file = new json_1.JsonFile(this, "typedoc.jsonc", {
50
+ obj: this.typeDocConfiguration,
51
+ allowComments: true,
52
+ marker: true,
53
+ readonly: false,
54
+ });
55
+ this.task = project.addTask("typedoc", {
56
+ description: "Generate TypeDoc documentation",
57
+ steps: [
58
+ {
59
+ exec: "typedoc",
60
+ },
61
+ ],
62
+ });
63
+ project.testTask.spawn(this.task);
64
+ }
65
+ }
66
+ exports.TypeDoc = TypeDoc;
67
+ _a = JSII_RTTI_SYMBOL_1;
68
+ TypeDoc[_a] = { fqn: "@nikovirtala/projen-typedoc.TypeDoc", version: "0.0.0" };
69
+ __exportStar(require("./typedoc-config"), exports);
70
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUFpRDtBQUVqRCwwQ0FBMkM7QUFHM0MsMENBQTRDO0FBQzVDLHFEQUE4RztBQUU5Rzs7R0FFRztBQUNILE1BQU0sY0FBYyxHQUF5QjtJQUN6QyxrQkFBa0IsRUFBRSxtQ0FBa0IsQ0FBQyxNQUFNO0lBQzdDLEdBQUcsRUFBRSxVQUFVO0lBQ2YsT0FBTyxFQUFFLENBQUMsY0FBYyxDQUFDO0lBQ3pCLGNBQWMsRUFBRSxJQUFJO0NBQ3ZCLENBQUM7QUFrQkY7O0dBRUc7QUFDSCxNQUFhLE9BQVEsU0FBUSxxQkFBUztJQUMzQixNQUFNLENBQUMsRUFBRSxDQUFDLE9BQWdCO1FBQzdCLE1BQU0sU0FBUyxHQUFHLENBQUMsQ0FBWSxFQUFnQixFQUFFLENBQUMsQ0FBQyxZQUFZLE9BQU8sQ0FBQztRQUN2RSxPQUFPLE9BQU8sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFjRCxZQUFZLE9BQW9CLEVBQUUsVUFBMEIsRUFBRTtRQUMxRCxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFZixNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUM7UUFDMUIsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxJQUFJLE9BQU8sRUFBRSxDQUFDLENBQUM7UUFFL0Q7O1dBRUc7UUFDSCxJQUFJLENBQUMsb0JBQW9CLEdBQUcsSUFBQSxnQkFBUyxFQUNqQyxDQUFDLElBQUEsNENBQTJCLEVBQUMsY0FBYyxDQUFDLEVBQUUsSUFBQSw0Q0FBMkIsRUFBQyxPQUFPLENBQUMsYUFBYSxJQUFJLEVBQUUsQ0FBQyxDQUFDLEVBQ3ZHLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxDQUN4QixDQUFDO1FBRUYsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLGVBQVEsQ0FBQyxJQUFJLEVBQUUsZUFBZSxFQUFFO1lBQzVDLEdBQUcsRUFBRSxJQUFJLENBQUMsb0JBQW9CO1lBQzlCLGFBQWEsRUFBRSxJQUFJO1lBQ25CLE1BQU0sRUFBRSxJQUFJO1lBQ1osUUFBUSxFQUFFLEtBQUs7U0FDbEIsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRTtZQUNuQyxXQUFXLEVBQUUsZ0NBQWdDO1lBQzdDLEtBQUssRUFBRTtnQkFDSDtvQkFDSSxJQUFJLEVBQUUsU0FBUztpQkFDbEI7YUFDSjtTQUNKLENBQUMsQ0FBQztRQUNILE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN0QyxDQUFDOztBQWhETCwwQkFpREM7OztBQUVELG1EQUFpQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbXBvbmVudCB9IGZyb20gXCJwcm9qZW4vbGliL2NvbXBvbmVudFwiO1xuaW1wb3J0IHR5cGUgeyBOb2RlUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL2phdmFzY3JpcHQvbm9kZS1wcm9qZWN0XCI7XG5pbXBvcnQgeyBKc29uRmlsZSB9IGZyb20gXCJwcm9qZW4vbGliL2pzb25cIjtcbmltcG9ydCB0eXBlIHsgUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL3Byb2plY3RcIjtcbmltcG9ydCB0eXBlIHsgVGFzayB9IGZyb20gXCJwcm9qZW4vbGliL3Rhc2tcIjtcbmltcG9ydCB7IGRlZXBNZXJnZSB9IGZyb20gXCJwcm9qZW4vbGliL3V0aWxcIjtcbmltcG9ydCB7IEVudHJ5UG9pbnRTdHJhdGVneSwgdHlwZSBUeXBlRG9jQ29uZmlndXJhdGlvbiwgdG9Kc29uX1R5cGVEb2NDb25maWd1cmF0aW9uIH0gZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcblxuLyoqXG4gKiBEZWZhdWx0IFR5cGVEb2MgY29uZmlndXJhdGlvblxuICovXG5jb25zdCBERUZBVUxUX0NPTkZJRzogVHlwZURvY0NvbmZpZ3VyYXRpb24gPSB7XG4gICAgZW50cnlQb2ludFN0cmF0ZWd5OiBFbnRyeVBvaW50U3RyYXRlZ3kuRVhQQU5ELFxuICAgIG91dDogXCJkb2NzL2FwaVwiLFxuICAgIGV4Y2x1ZGU6IFtcIioqLyoudGVzdC50c1wiXSxcbiAgICBleGNsdWRlUHJpdmF0ZTogdHJ1ZSxcbn07XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY09wdGlvbnMge1xuICAgIC8qKlxuICAgICAqIFZlcnNpb24gb2YgVHlwZURvYyB0byB1c2VcbiAgICAgKlxuICAgICAqIEBkZWZhdWx0IFwiXjAuMjhcIlxuICAgICAqL1xuICAgIHJlYWRvbmx5IHZlcnNpb24/OiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBGdWxsIFR5cGVEb2MgY29uZmlndXJhdGlvblxuICAgICAqXG4gICAgICogVGhpcyBjb25maWd1cmF0aW9uIHdpbGwgYmUgbWVyZ2VkIHdpdGggdGhlIGRlZmF1bHQgY29uZmlndXJhdGlvblxuICAgICAqL1xuICAgIHJlYWRvbmx5IHR5cGVEb2NDb25maWc/OiBUeXBlRG9jQ29uZmlndXJhdGlvbjtcbn1cblxuLyoqXG4gKiBUeXBlRG9jIGNvbXBvbmVudCBmb3IgcHJvamVuIHByb2plY3RzXG4gKi9cbmV4cG9ydCBjbGFzcyBUeXBlRG9jIGV4dGVuZHMgQ29tcG9uZW50IHtcbiAgICBwdWJsaWMgc3RhdGljIG9mKHByb2plY3Q6IFByb2plY3QpOiBUeXBlRG9jIHwgdW5kZWZpbmVkIHtcbiAgICAgICAgY29uc3QgaXNUeXBlRG9jID0gKGM6IENvbXBvbmVudCk6IGMgaXMgVHlwZURvYyA9PiBjIGluc3RhbmNlb2YgVHlwZURvYztcbiAgICAgICAgcmV0dXJuIHByb2plY3QuY29tcG9uZW50cy5maW5kKGlzVHlwZURvYyk7XG4gICAgfVxuXG4gICAgcHJpdmF0ZSByZWFkb25seSB0eXBlRG9jQ29uZmlndXJhdGlvbjogUmVjb3JkPHN0cmluZywgdW5rbm93bj47XG5cbiAgICAvKipcbiAgICAgKiBUeXBlRG9jIHRhc2tcbiAgICAgKi9cbiAgICBwdWJsaWMgcmVhZG9ubHkgdGFzazogVGFzaztcblxuICAgIC8qKlxuICAgICAqIFR5cGVEb2MgY29uZmlndXJhdGlvbiBmaWxlXG4gICAgICovXG4gICAgcHVibGljIHJlYWRvbmx5IGZpbGU6IEpzb25GaWxlO1xuXG4gICAgY29uc3RydWN0b3IocHJvamVjdDogTm9kZVByb2plY3QsIG9wdGlvbnM6IFR5cGVEb2NPcHRpb25zID0ge30pIHtcbiAgICAgICAgc3VwZXIocHJvamVjdCk7XG5cbiAgICAgICAgY29uc3QgdHlwZWRvYyA9IFwidHlwZWRvY1wiO1xuICAgICAgICBwcm9qZWN0LmFkZERldkRlcHMoYCR7dHlwZWRvY31AJHtvcHRpb25zLnZlcnNpb24gPz8gXCJeMC4yOFwifWApO1xuXG4gICAgICAgIC8qXG4gICAgICAgICAqIE1lcmdlIGRlZmF1bHQgY29uZmlndXJhdGlvbiB3aXRoIHVzZXItcHJvdmlkZWQgY29uZmlndXJhdGlvblxuICAgICAgICAgKi9cbiAgICAgICAgdGhpcy50eXBlRG9jQ29uZmlndXJhdGlvbiA9IGRlZXBNZXJnZShcbiAgICAgICAgICAgIFt0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24oREVGQVVMVF9DT05GSUcpLCB0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24ob3B0aW9ucy50eXBlRG9jQ29uZmlnID8/IHt9KV0sXG4gICAgICAgICAgICB7IG1lcmdlQXJyYXlzOiB0cnVlIH0sXG4gICAgICAgICk7XG5cbiAgICAgICAgdGhpcy5maWxlID0gbmV3IEpzb25GaWxlKHRoaXMsIFwidHlwZWRvYy5qc29uY1wiLCB7XG4gICAgICAgICAgICBvYmo6IHRoaXMudHlwZURvY0NvbmZpZ3VyYXRpb24sXG4gICAgICAgICAgICBhbGxvd0NvbW1lbnRzOiB0cnVlLFxuICAgICAgICAgICAgbWFya2VyOiB0cnVlLFxuICAgICAgICAgICAgcmVhZG9ubHk6IGZhbHNlLFxuICAgICAgICB9KTtcblxuICAgICAgICB0aGlzLnRhc2sgPSBwcm9qZWN0LmFkZFRhc2soXCJ0eXBlZG9jXCIsIHtcbiAgICAgICAgICAgIGRlc2NyaXB0aW9uOiBcIkdlbmVyYXRlIFR5cGVEb2MgZG9jdW1lbnRhdGlvblwiLFxuICAgICAgICAgICAgc3RlcHM6IFtcbiAgICAgICAgICAgICAgICB7XG4gICAgICAgICAgICAgICAgICAgIGV4ZWM6IFwidHlwZWRvY1wiLFxuICAgICAgICAgICAgICAgIH0sXG4gICAgICAgICAgICBdLFxuICAgICAgICB9KTtcbiAgICAgICAgcHJvamVjdC50ZXN0VGFzay5zcGF3bih0aGlzLnRhc2spO1xuICAgIH1cbn1cblxuZXhwb3J0ICogZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcbiJdfQ==
package/lib/typedoc-config.d.ts ADDED
@@ -0,0 +1,363 @@
1
+ /**
2
+ * TypeDoc configuration
3
+ *
4
+ * @see https://typedoc.org/options/
5
+ */
6
+ export interface TypeDocConfiguration {
7
+ /**
8
+ * Specifies the entry points to be documented by TypeDoc.
9
+ *
10
+ * @see https://typedoc.org/options/input/#entrypoints
11
+ */
12
+ readonly entryPoints?: string[];
13
+ /**
14
+ * Specifies the strategy to be used to convert entry points into documentation.
15
+ *
16
+ * @see https://typedoc.org/options/input/#entrypointstrategy
17
+ */
18
+ readonly entryPointStrategy?: EntryPointStrategy;
19
+ /**
20
+ * Define patterns to be excluded when expanding directories.
21
+ *
22
+ * @see https://typedoc.org/options/input/#exclude
23
+ */
24
+ readonly exclude?: string[];
25
+ /**
26
+ * Prevent externally resolved symbols from being documented.
27
+ *
28
+ * @see https://typedoc.org/options/input/#excludeexternals
29
+ */
30
+ readonly excludeExternals?: boolean;
31
+ /**
32
+ * Prevent private members from being included in the generated documentation.
33
+ *
34
+ * @see https://typedoc.org/options/input/#excludeprivate
35
+ */
36
+ readonly excludePrivate?: boolean;
37
+ /**
38
+ * Prevent protected members from being included in the generated documentation.
39
+ *
40
+ * @see https://typedoc.org/options/input/#excludeprotected
41
+ */
42
+ readonly excludeProtected?: boolean;
43
+ /**
44
+ * Prevent symbols that are not exported from being documented.
45
+ *
46
+ * @see https://typedoc.org/options/input/#excludeinternal
47
+ */
48
+ readonly excludeInternal?: boolean;
49
+ /**
50
+ * Specifies the output directory the documentation should be written to.
51
+ *
52
+ * @see https://typedoc.org/options/output/#out
53
+ */
54
+ readonly out?: string;
55
+ /**
56
+ * Specify the location the documentation should be written to.
57
+ *
58
+ * @see https://typedoc.org/options/output/#json
59
+ */
60
+ readonly json?: string;
61
+ /**
62
+ * Specify a theme name to use.
63
+ *
64
+ * @see https://typedoc.org/options/output/#theme
65
+ */
66
+ readonly theme?: string;
67
+ /**
68
+ * Specify the base path for all urls.
69
+ *
70
+ * @see https://typedoc.org/options/output/#basepath
71
+ */
72
+ readonly basePath?: string;
73
+ /**
74
+ * Set the name of the project that will be used in the header of the template.
75
+ *
76
+ * @see https://typedoc.org/options/output/#name
77
+ */
78
+ readonly name?: string;
79
+ /**
80
+ * Prevent TypeDoc from cleaning the output directory specified with --out.
81
+ *
82
+ * @see https://typedoc.org/options/output/#cleanoutputdir
83
+ */
84
+ readonly cleanOutputDir?: boolean;
85
+ /**
86
+ * Specify the location to look for included documents.
87
+ *
88
+ * @see https://typedoc.org/options/output/#includes
89
+ */
90
+ readonly includes?: string;
91
+ /**
92
+ * Specify the location with media files that should be copied to the output directory.
93
+ *
94
+ * @see https://typedoc.org/options/output/#media
95
+ */
96
+ readonly media?: string;
97
+ /**
98
+ * Specify the location and filename a .tsbuildinfo file should be written to.
99
+ *
100
+ * @see https://typedoc.org/options/input/#tsbuildinfo
101
+ */
102
+ readonly tsBuildInfo?: string;
103
+ /**
104
+ * Specify a TypeScript config file that should be used to load TypeScript configuration.
105
+ *
106
+ * @see https://typedoc.org/options/input/#tsconfig
107
+ */
108
+ readonly tsconfig?: string;
109
+ /**
110
+ * Specify the logger that should be used.
111
+ *
112
+ * @see https://typedoc.org/options/other/#loglevel
113
+ */
114
+ readonly logLevel?: LogLevel;
115
+ /**
116
+ * Specify the sort strategy for documented values.
117
+ *
118
+ * @see https://typedoc.org/options/organization/#sort
119
+ */
120
+ readonly sort?: string[];
121
+ /**
122
+ * Specify the sort strategy for static and instance members.
123
+ *
124
+ * @see https://typedoc.org/options/organization/#sortentrypoints
125
+ */
126
+ readonly sortEntryPoints?: boolean;
127
+ /**
128
+ * Specify the documentation mode TypeDoc should use.
129
+ *
130
+ * @see https://typedoc.org/options/comments/#commentstyle
131
+ */
132
+ readonly commentStyle?: CommentStyle;
133
+ /**
134
+ * Specify the default visibility for members without a visibility tag.
135
+ *
136
+ * @see https://typedoc.org/options/comments/#defaultvisibility
137
+ */
138
+ readonly defaultVisibility?: Visibility;
139
+ /**
140
+ * Specify the default category for reflections without a category.
141
+ *
142
+ * @see https://typedoc.org/options/organization/#defaultcategory
143
+ */
144
+ readonly defaultCategory?: string;
145
+ /**
146
+ * Specify the default group for reflections without a group.
147
+ *
148
+ * @see https://typedoc.org/options/organization/#defaultgroup
149
+ */
150
+ readonly defaultGroup?: string;
151
+ /**
152
+ * Specify the categories that will be used to group reflections.
153
+ *
154
+ * @see https://typedoc.org/options/organization/#categorizebygroup
155
+ */
156
+ readonly categorizeByGroup?: boolean;
157
+ /**
158
+ * Specify the search group boosts.
159
+ *
160
+ * @see https://typedoc.org/options/organization/#searchgroupboosts
161
+ */
162
+ readonly searchGroupBoosts?: Record<string, number>;
163
+ /**
164
+ * Specify the search category boosts.
165
+ *
166
+ * @see https://typedoc.org/options/organization/#searchcategoryboosts
167
+ */
168
+ readonly searchCategoryBoosts?: Record<string, number>;
169
+ /**
170
+ * Specify the readme file that should be displayed on the index page.
171
+ *
172
+ * @see https://typedoc.org/options/input/#readme
173
+ */
174
+ readonly readme?: string;
175
+ /**
176
+ * Specify the package.json file that should be used to determine the package name.
177
+ *
178
+ * @see https://typedoc.org/options/input/#packagejson
179
+ */
180
+ readonly packageJson?: string;
181
+ /**
182
+ * Specify the git revision that should be used to link to source files.
183
+ *
184
+ * @see https://typedoc.org/options/comments/#gitrevision
185
+ */
186
+ readonly gitRevision?: string;
187
+ /**
188
+ * Specify the git remote that should be used to link to source files.
189
+ *
190
+ * @see https://typedoc.org/options/comments/#gitremote
191
+ */
192
+ readonly gitRemote?: string;
193
+ /**
194
+ * Specify the base URL for links to source files.
195
+ *
196
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
197
+ */
198
+ readonly sourceUrlTemplate?: string;
199
+ /**
200
+ * Specify the base URL for links to source files.
201
+ *
202
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
203
+ */
204
+ readonly disableSources?: boolean;
205
+ /**
206
+ * Specify the base URL for links to source files.
207
+ *
208
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
209
+ */
210
+ readonly disableGit?: boolean;
211
+ /**
212
+ * Specify the base URL for links to source files.
213
+ *
214
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
215
+ */
216
+ readonly hideGenerator?: boolean;
217
+ /**
218
+ * Specify the base URL for links to source files.
219
+ *
220
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
221
+ */
222
+ readonly hideParameterTypesInTitle?: boolean;
223
+ /**
224
+ * Specify the base URL for links to source files.
225
+ *
226
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
227
+ */
228
+ readonly cacheBust?: boolean;
229
+ /**
230
+ * Specify the base URL for links to source files.
231
+ *
232
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
233
+ */
234
+ readonly searchInComments?: boolean;
235
+ /**
236
+ * Specify the base URL for links to source files.
237
+ *
238
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
239
+ */
240
+ readonly searchInDocuments?: boolean;
241
+ /**
242
+ * Specify the base URL for links to source files.
243
+ *
244
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
245
+ */
246
+ readonly validation?: ValidationOptions;
247
+ /**
248
+ * Specify the base URL for links to source files.
249
+ *
250
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
251
+ */
252
+ readonly requiredToBeDocumented?: string[];
253
+ /**
254
+ * Specify the base URL for links to source files.
255
+ *
256
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
257
+ */
258
+ readonly treatWarningsAsErrors?: boolean;
259
+ /**
260
+ * Specify the base URL for links to source files.
261
+ *
262
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
263
+ */
264
+ readonly treatValidationWarningsAsErrors?: boolean;
265
+ /**
266
+ * Specify the base URL for links to source files.
267
+ *
268
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
269
+ */
270
+ readonly intentionallyNotExported?: string[];
271
+ /**
272
+ * Specify the base URL for links to source files.
273
+ *
274
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
275
+ */
276
+ readonly externalPattern?: string[];
277
+ /**
278
+ * Specify the base URL for links to source files.
279
+ *
280
+ * @see https://typedoc.org/options/comments/#sourceurltemplate
281
+ */
282
+ readonly externalSymbolLinkMappings?: Record<string, Record<string, string>>;
283
+ }
284
+ /**
285
+ * Converts TypeDocConfiguration to JSON representation
286
+ * @internal
287
+ */
288
+ export declare function toJson_TypeDocConfiguration(obj: TypeDocConfiguration | undefined): Record<string, unknown> | undefined;
289
+ /**
290
+ * Specifies the strategy to be used to convert entry points into documentation
291
+ *
292
+ * @see https://typedoc.org/options/input/#entrypointstrategy
293
+ */
294
+ export declare enum EntryPointStrategy {
295
+ /**
296
+ * Expects all entry points to be contained within a single package
297
+ */
298
+ RESOLVE = "resolve",
299
+ /**
300
+ * Expects all entry points to be top-level directories
301
+ */
302
+ EXPAND = "expand",
303
+ /**
304
+ * Expects all entry points to be individual files
305
+ */
306
+ PACKAGES = "packages",
307
+ /**
308
+ * Merges multiple projects into a single documentation site
309
+ */
310
+ MERGE = "merge"
311
+ }
312
+ /**
313
+ * Specifies the logger that should be used
314
+ *
315
+ * @see https://typedoc.org/options/other/#loglevel
316
+ */
317
+ export declare enum LogLevel {
318
+ VERBOSE = "Verbose",
319
+ INFO = "Info",
320
+ WARN = "Warn",
321
+ ERROR = "Error",
322
+ NONE = "None"
323
+ }
324
+ /**
325
+ * Specifies the documentation mode TypeDoc should use
326
+ *
327
+ * @see https://typedoc.org/options/comments/#commentstyle
328
+ */
329
+ export declare enum CommentStyle {
330
+ JSDOC = "jsdoc",
331
+ BLOCK = "block",
332
+ LINE = "line",
333
+ ALL = "all"
334
+ }
335
+ /**
336
+ * Specifies the default visibility for members without a visibility tag
337
+ *
338
+ * @see https://typedoc.org/options/comments/#defaultvisibility
339
+ */
340
+ export declare enum Visibility {
341
+ PUBLIC = "public",
342
+ PROTECTED = "protected",
343
+ PRIVATE = "private"
344
+ }
345
+ /**
346
+ * Validation options
347
+ *
348
+ * @see https://typedoc.org/options/validation/
349
+ */
350
+ export interface ValidationOptions {
351
+ /**
352
+ * If set, TypeDoc will produce warnings when a symbol is referenced by the documentation
353
+ */
354
+ readonly notExported?: boolean;
355
+ /**
356
+ * If set, TypeDoc will produce warnings when an exported symbol is not documented
357
+ */
358
+ readonly notDocumented?: boolean;
359
+ /**
360
+ * If set, TypeDoc will produce warnings about \@link tags which will produce broken links
361
+ */
362
+ readonly invalidLink?: boolean;
363
+ }