@microsoft/api-documenter 7.28.9 → 7.29.1

package/lib-esm/nodes/DocEmphasisSpan.js

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNodeContainer } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+/**
+ * Represents a span of text that is styled with CommonMark emphasis (italics), strong emphasis (boldface),
+ * or both.
+ */
+export class DocEmphasisSpan extends DocNodeContainer {
+    constructor(parameters, children) {
+        super(parameters, children);
+        this.bold = !!parameters.bold;
+        this.italic = !!parameters.italic;
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.EmphasisSpan;
+    }
+}
+//# sourceMappingURL=DocEmphasisSpan.js.map

package/lib-esm/nodes/DocEmphasisSpan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocEmphasisSpan.js","sourceRoot":"","sources":["../../src/nodes/DocEmphasisSpan.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAgB,gBAAgB,EAAoC,MAAM,kBAAkB,CAAC;AAEpG,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUxD;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,gBAAgB;IAInD,YAAmB,UAAsC,EAAE,QAAoB;QAC7E,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;IACpC,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,YAAY,CAAC;IACxC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type DocNode, DocNodeContainer, type IDocNodeContainerParameters } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\n\n/**\n * Constructor parameters for {@link DocEmphasisSpan}.\n */\nexport interface IDocEmphasisSpanParameters extends IDocNodeContainerParameters {\n  bold?: boolean;\n  italic?: boolean;\n}\n\n/**\n * Represents a span of text that is styled with CommonMark emphasis (italics), strong emphasis (boldface),\n * or both.\n */\nexport class DocEmphasisSpan extends DocNodeContainer {\n  public readonly bold: boolean;\n  public readonly italic: boolean;\n\n  public constructor(parameters: IDocEmphasisSpanParameters, children?: DocNode[]) {\n    super(parameters, children);\n    this.bold = !!parameters.bold;\n    this.italic = !!parameters.italic;\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.EmphasisSpan;\n  }\n}\n"]}

package/lib-esm/nodes/DocHeading.js

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNode } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+/**
+ * Represents a section header similar to an HTML `<h1>` or `<h2>` element.
+ */
+export class DocHeading extends DocNode {
+    /**
+     * Don't call this directly.  Instead use {@link TSDocParser}
+     * @internal
+     */
+    constructor(parameters) {
+        super(parameters);
+        this.title = parameters.title;
+        this.level = parameters.level !== undefined ? parameters.level : 1;
+        if (this.level < 1 || this.level > 5) {
+            throw new Error('IDocHeadingParameters.level must be a number between 1 and 5');
+        }
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.Heading;
+    }
+}
+//# sourceMappingURL=DocHeading.js.map

package/lib-esm/nodes/DocHeading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocHeading.js","sourceRoot":"","sources":["../../src/nodes/DocHeading.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAA2B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUxD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,OAAO;IAIrC;;;OAGG;IACH,YAAmB,UAAiC;QAClD,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAEnE,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\n\n/**\n * Constructor parameters for {@link DocHeading}.\n */\nexport interface IDocHeadingParameters extends IDocNodeParameters {\n  title: string;\n  level?: number;\n}\n\n/**\n * Represents a section header similar to an HTML `<h1>` or `<h2>` element.\n */\nexport class DocHeading extends DocNode {\n  public readonly title: string;\n  public readonly level: number;\n\n  /**\n   * Don't call this directly.  Instead use {@link TSDocParser}\n   * @internal\n   */\n  public constructor(parameters: IDocHeadingParameters) {\n    super(parameters);\n    this.title = parameters.title;\n    this.level = parameters.level !== undefined ? parameters.level : 1;\n\n    if (this.level < 1 || this.level > 5) {\n      throw new Error('IDocHeadingParameters.level must be a number between 1 and 5');\n    }\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.Heading;\n  }\n}\n"]}

package/lib-esm/nodes/DocNoteBox.js

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNode, DocSection } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+/**
+ * Represents a note box, which is typically displayed as a bordered box containing informational text.
+ */
+export class DocNoteBox extends DocNode {
+    constructor(parameters, sectionChildNodes) {
+        super(parameters);
+        this.content = new DocSection({ configuration: this.configuration }, sectionChildNodes);
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.NoteBox;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return [this.content];
+    }
+}
+//# sourceMappingURL=DocNoteBox.js.map

package/lib-esm/nodes/DocNoteBox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocNoteBox.js","sourceRoot":"","sources":["../../src/nodes/DocNoteBox.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAA2B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAOxD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,OAAO;IAGrC,YAAmB,UAAiC,EAAE,iBAA0C;QAC9F,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,iBAAiB,CAAC,CAAC;IAC1F,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\n\n/**\n * Constructor parameters for {@link DocNoteBox}.\n */\nexport interface IDocNoteBoxParameters extends IDocNodeParameters {}\n\n/**\n * Represents a note box, which is typically displayed as a bordered box containing informational text.\n */\nexport class DocNoteBox extends DocNode {\n  public readonly content: DocSection;\n\n  public constructor(parameters: IDocNoteBoxParameters, sectionChildNodes?: ReadonlyArray<DocNode>) {\n    super(parameters);\n    this.content = new DocSection({ configuration: this.configuration }, sectionChildNodes);\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.NoteBox;\n  }\n\n  /** @override */\n  protected onGetChildNodes(): ReadonlyArray<DocNode | undefined> {\n    return [this.content];\n  }\n}\n"]}

package/lib-esm/nodes/DocTable.js

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNode } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+import { DocTableRow } from './DocTableRow';
+/**
+ * Represents table, similar to an HTML `<table>` element.
+ */
+export class DocTable extends DocNode {
+    constructor(parameters, rows) {
+        super(parameters);
+        this.header = new DocTableRow({ configuration: this.configuration });
+        this._rows = [];
+        if (parameters) {
+            if (parameters.headerTitles) {
+                if (parameters.headerCells) {
+                    throw new Error('IDocTableParameters.headerCells and IDocTableParameters.headerTitles' +
+                        ' cannot both be specified');
+                }
+                for (const cellText of parameters.headerTitles) {
+                    this.header.addPlainTextCell(cellText);
+                }
+            }
+            else if (parameters.headerCells) {
+                for (const cell of parameters.headerCells) {
+                    this.header.addCell(cell);
+                }
+            }
+        }
+        if (rows) {
+            for (const row of rows) {
+                this.addRow(row);
+            }
+        }
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.Table;
+    }
+    get rows() {
+        return this._rows;
+    }
+    addRow(row) {
+        this._rows.push(row);
+    }
+    createAndAddRow() {
+        const row = new DocTableRow({ configuration: this.configuration });
+        this.addRow(row);
+        return row;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return [this.header, ...this._rows];
+    }
+}
+//# sourceMappingURL=DocTable.js.map

package/lib-esm/nodes/DocTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTable.js","sourceRoot":"","sources":["../../src/nodes/DocTable.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAA2B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAW5C;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,OAAO;IAKnC,YAAmB,UAA+B,EAAE,IAAiC;QACnF,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAEhB,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;gBAC5B,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACb,sEAAsE;wBACpE,2BAA2B,CAC9B,CAAC;gBACJ,CAAC;gBACD,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;oBAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;iBAAM,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;oBAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACT,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,KAAK,CAAC;IACjC,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,GAAgB;QAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAEM,eAAe;QACpB,MAAM,GAAG,GAAgB,IAAI,WAAW,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\nimport { DocTableRow } from './DocTableRow';\nimport type { DocTableCell } from './DocTableCell';\n\n/**\n * Constructor parameters for {@link DocTable}.\n */\nexport interface IDocTableParameters extends IDocNodeParameters {\n  headerCells?: ReadonlyArray<DocTableCell>;\n  headerTitles?: string[];\n}\n\n/**\n * Represents table, similar to an HTML `<table>` element.\n */\nexport class DocTable extends DocNode {\n  public readonly header: DocTableRow;\n\n  private _rows: DocTableRow[];\n\n  public constructor(parameters: IDocTableParameters, rows?: ReadonlyArray<DocTableRow>) {\n    super(parameters);\n\n    this.header = new DocTableRow({ configuration: this.configuration });\n    this._rows = [];\n\n    if (parameters) {\n      if (parameters.headerTitles) {\n        if (parameters.headerCells) {\n          throw new Error(\n            'IDocTableParameters.headerCells and IDocTableParameters.headerTitles' +\n              ' cannot both be specified'\n          );\n        }\n        for (const cellText of parameters.headerTitles) {\n          this.header.addPlainTextCell(cellText);\n        }\n      } else if (parameters.headerCells) {\n        for (const cell of parameters.headerCells) {\n          this.header.addCell(cell);\n        }\n      }\n    }\n\n    if (rows) {\n      for (const row of rows) {\n        this.addRow(row);\n      }\n    }\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.Table;\n  }\n\n  public get rows(): ReadonlyArray<DocTableRow> {\n    return this._rows;\n  }\n\n  public addRow(row: DocTableRow): void {\n    this._rows.push(row);\n  }\n\n  public createAndAddRow(): DocTableRow {\n    const row: DocTableRow = new DocTableRow({ configuration: this.configuration });\n    this.addRow(row);\n    return row;\n  }\n\n  /** @override */\n  protected onGetChildNodes(): ReadonlyArray<DocNode | undefined> {\n    return [this.header, ...this._rows];\n  }\n}\n"]}

package/lib-esm/nodes/DocTableCell.js

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNode, DocSection } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+/**
+ * Represents table cell, similar to an HTML `<td>` element.
+ */
+export class DocTableCell extends DocNode {
+    constructor(parameters, sectionChildNodes) {
+        super(parameters);
+        this.content = new DocSection({ configuration: this.configuration }, sectionChildNodes);
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.TableCell;
+    }
+}
+//# sourceMappingURL=DocTableCell.js.map

package/lib-esm/nodes/DocTableCell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTableCell.js","sourceRoot":"","sources":["../../src/nodes/DocTableCell.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAA2B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAOxD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,OAAO;IAGvC,YAAmB,UAAmC,EAAE,iBAA0C;QAChG,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,iBAAiB,CAAC,CAAC;IAC1F,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACrC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\n\n/**\n * Constructor parameters for {@link DocTableCell}.\n */\nexport interface IDocTableCellParameters extends IDocNodeParameters {}\n\n/**\n * Represents table cell, similar to an HTML `<td>` element.\n */\nexport class DocTableCell extends DocNode {\n  public readonly content: DocSection;\n\n  public constructor(parameters: IDocTableCellParameters, sectionChildNodes?: ReadonlyArray<DocNode>) {\n    super(parameters);\n\n    this.content = new DocSection({ configuration: this.configuration }, sectionChildNodes);\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.TableCell;\n  }\n}\n"]}

package/lib-esm/nodes/DocTableRow.js

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNode, DocPlainText } from '@microsoft/tsdoc';
+import { CustomDocNodeKind } from './CustomDocNodeKind';
+import { DocTableCell } from './DocTableCell';
+/**
+ * Represents table row, similar to an HTML `<tr>` element.
+ */
+export class DocTableRow extends DocNode {
+    constructor(parameters, cells) {
+        super(parameters);
+        this._cells = [];
+        if (cells) {
+            for (const cell of cells) {
+                this.addCell(cell);
+            }
+        }
+    }
+    /** @override */
+    get kind() {
+        return CustomDocNodeKind.TableRow;
+    }
+    get cells() {
+        return this._cells;
+    }
+    addCell(cell) {
+        this._cells.push(cell);
+    }
+    createAndAddCell() {
+        const newCell = new DocTableCell({ configuration: this.configuration });
+        this.addCell(newCell);
+        return newCell;
+    }
+    addPlainTextCell(cellContent) {
+        const cell = this.createAndAddCell();
+        cell.content.appendNodeInParagraph(new DocPlainText({
+            configuration: this.configuration,
+            text: cellContent
+        }));
+        return cell;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return this._cells;
+    }
+}
+//# sourceMappingURL=DocTableRow.js.map

package/lib-esm/nodes/DocTableRow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTableRow.js","sourceRoot":"","sources":["../../src/nodes/DocTableRow.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAA2B,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAO9C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IAGtC,YAAmB,UAAkC,EAAE,KAAmC;QACxF,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,iBAAiB,CAAC,QAAQ,CAAC;IACpC,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,OAAO,CAAC,IAAkB;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAEM,gBAAgB;QACrB,MAAM,OAAO,GAAiB,IAAI,YAAY,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACtF,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,gBAAgB,CAAC,WAAmB;QACzC,MAAM,IAAI,GAAiB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAChC,IAAI,YAAY,CAAC;YACf,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,WAAW;SAClB,CAAC,CACH,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IDocNodeParameters, DocNode, DocPlainText } from '@microsoft/tsdoc';\n\nimport { CustomDocNodeKind } from './CustomDocNodeKind';\nimport { DocTableCell } from './DocTableCell';\n\n/**\n * Constructor parameters for {@link DocTableRow}.\n */\nexport interface IDocTableRowParameters extends IDocNodeParameters {}\n\n/**\n * Represents table row, similar to an HTML `<tr>` element.\n */\nexport class DocTableRow extends DocNode {\n  private readonly _cells: DocTableCell[];\n\n  public constructor(parameters: IDocTableRowParameters, cells?: ReadonlyArray<DocTableCell>) {\n    super(parameters);\n\n    this._cells = [];\n    if (cells) {\n      for (const cell of cells) {\n        this.addCell(cell);\n      }\n    }\n  }\n\n  /** @override */\n  public get kind(): string {\n    return CustomDocNodeKind.TableRow;\n  }\n\n  public get cells(): ReadonlyArray<DocTableCell> {\n    return this._cells;\n  }\n\n  public addCell(cell: DocTableCell): void {\n    this._cells.push(cell);\n  }\n\n  public createAndAddCell(): DocTableCell {\n    const newCell: DocTableCell = new DocTableCell({ configuration: this.configuration });\n    this.addCell(newCell);\n    return newCell;\n  }\n\n  public addPlainTextCell(cellContent: string): DocTableCell {\n    const cell: DocTableCell = this.createAndAddCell();\n    cell.content.appendNodeInParagraph(\n      new DocPlainText({\n        configuration: this.configuration,\n        text: cellContent\n      })\n    );\n    return cell;\n  }\n\n  /** @override */\n  protected onGetChildNodes(): ReadonlyArray<DocNode | undefined> {\n    return this._cells;\n  }\n}\n"]}

package/lib-esm/plugin/IApiDocumenterPluginManifest.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+export {};
+//# sourceMappingURL=IApiDocumenterPluginManifest.js.map

package/lib-esm/plugin/IApiDocumenterPluginManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IApiDocumenterPluginManifest.js","sourceRoot":"","sources":["../../src/plugin/IApiDocumenterPluginManifest.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { MarkdownDocumenterFeature } from './MarkdownDocumenterFeature';\nimport type { PluginFeatureInitialization } from './PluginFeature';\n\n/**\n * Defines a \"feature\" that is provided by an API Documenter plugin.  A feature is a user-defined module\n * that customizes the behavior of API Documenter.\n *\n * @public\n */\nexport interface IFeatureDefinition {\n  /**\n   * The name of this feature, as it will appear in the config file.\n   *\n   * The name should consist of one or more words separated by hyphens.  Each word should consist of lower case\n   * letters and numbers.  Example: `my-feature`\n   */\n  featureName: string;\n\n  /**\n   * Determines the kind of feature.  The specified value is the name of the base class that `subclass` inherits from.\n   *\n   * @remarks\n   * For now, `MarkdownDocumenterFeature` is the only supported value.\n   */\n  kind: 'MarkdownDocumenterFeature';\n\n  /**\n   * Your subclass that extends from the base class.\n   */\n  subclass: { new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature };\n}\n\n/**\n * The manifest for an API Documenter plugin.\n *\n * @remarks\n * An API documenter plugin is an NPM package. By convention, the NPM package name should have the prefix\n * `doc-plugin-`.  Its main entry point should export an object named `apiDocumenterPluginManifest` which implements\n * the `IApiDocumenterPluginManifest` interface.\n *\n * For example:\n * ```ts\n * class MyMarkdownDocumenter extends MarkdownDocumenterFeature {\n *   public onInitialized(): void {\n *     console.log('MyMarkdownDocumenter: onInitialized()');\n *   }\n * }\n *\n * export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = {\n *   manifestVersion: 1000,\n *   features: [\n *     {\n *       featureName: 'my-markdown-documenter',\n *       kind: 'MarkdownDocumenterFeature',\n *       subclass: MyMarkdownDocumenter\n *     }\n *   ]\n * };\n * ```\n * @public\n */\nexport interface IApiDocumenterPluginManifest {\n  /**\n   * The manifest version number.  For now, this must always be `1000`.\n   */\n  manifestVersion: 1000;\n\n  /**\n   * The list of features provided by this plugin.\n   */\n  features: IFeatureDefinition[];\n}\n"]}

package/lib-esm/plugin/MarkdownDocumenterAccessor.js

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * Provides access to the documenter that is generating the output.
+ *
+ * @privateRemarks
+ * This class is wrapper that provides access to the underlying MarkdownDocumenter, while hiding the implementation
+ * details to ensure that the plugin API contract is stable.
+ *
+ * @public
+ */
+export class MarkdownDocumenterAccessor {
+    /** @internal */
+    constructor(implementation) {
+        this._implementation = implementation;
+    }
+    /**
+     * For a given `ApiItem`, return its markdown hyperlink.
+     *
+     * @returns The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.
+     */
+    getLinkForApiItem(apiItem) {
+        return this._implementation.getLinkForApiItem(apiItem);
+    }
+}
+//# sourceMappingURL=MarkdownDocumenterAccessor.js.map

package/lib-esm/plugin/MarkdownDocumenterAccessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownDocumenterAccessor.js","sourceRoot":"","sources":["../../src/plugin/MarkdownDocumenterAccessor.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAS3D;;;;;;;;GAQG;AACH,MAAM,OAAO,0BAA0B;IAGrC,gBAAgB;IAChB,YAAmB,cAAyD;QAC1E,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,OAAgB;QACvC,OAAO,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { ApiItem } from '@microsoft/api-extractor-model';\n\n/** @internal */\nexport interface IMarkdownDocumenterAccessorImplementation {\n  getLinkForApiItem(apiItem: ApiItem): string | undefined;\n}\n\n/**\n * Provides access to the documenter that is generating the output.\n *\n * @privateRemarks\n * This class is wrapper that provides access to the underlying MarkdownDocumenter, while hiding the implementation\n * details to ensure that the plugin API contract is stable.\n *\n * @public\n */\nexport class MarkdownDocumenterAccessor {\n  private _implementation: IMarkdownDocumenterAccessorImplementation;\n\n  /** @internal */\n  public constructor(implementation: IMarkdownDocumenterAccessorImplementation) {\n    this._implementation = implementation;\n  }\n\n  /**\n   * For a given `ApiItem`, return its markdown hyperlink.\n   *\n   * @returns The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.\n   */\n  public getLinkForApiItem(apiItem: ApiItem): string | undefined {\n    return this._implementation.getLinkForApiItem(apiItem);\n  }\n}\n"]}

package/lib-esm/plugin/MarkdownDocumenterFeature.js

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TypeUuid } from '@rushstack/node-core-library';
+import { PluginFeature } from './PluginFeature';
+/**
+ * Context object for {@link MarkdownDocumenterFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+export class MarkdownDocumenterFeatureContext {
+    /** @internal */
+    constructor(options) {
+        this.apiModel = options.apiModel;
+        this.outputFolder = options.outputFolder;
+        this.documenter = options.documenter;
+    }
+}
+const uuidMarkdownDocumenterFeature = '34196154-9eb3-4de0-a8c8-7e9539dfe216';
+/**
+ * Inherit from this base class to implement an API Documenter plugin feature that customizes
+ * the generation of markdown output.
+ *
+ * @public
+ */
+export class MarkdownDocumenterFeature extends PluginFeature {
+    /**
+     * This event occurs before each markdown file is written.  It provides an opportunity to customize the
+     * content of the file.
+     * @virtual
+     */
+    onBeforeWritePage(eventArgs) {
+        // (implemented by child class)
+    }
+    /**
+     * This event occurs after all output files have been written.
+     * @virtual
+     */
+    onFinished(eventArgs) {
+        // (implemented by child class)
+    }
+    static [Symbol.hasInstance](instance) {
+        return TypeUuid.isInstanceOf(instance, uuidMarkdownDocumenterFeature);
+    }
+}
+TypeUuid.registerClass(MarkdownDocumenterFeature, uuidMarkdownDocumenterFeature);
+//# sourceMappingURL=MarkdownDocumenterFeature.js.map

package/lib-esm/plugin/MarkdownDocumenterFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownDocumenterFeature.js","sourceRoot":"","sources":["../../src/plugin/MarkdownDocumenterFeature.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAG3D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;GAKG;AACH,MAAM,OAAO,gCAAgC;IAgB3C,gBAAgB;IAChB,YAAmB,OAAyC;QAC1D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,CAAC;CACF;AA8BD,MAAM,6BAA6B,GAAW,sCAAsC,CAAC;AAErF;;;;;GAKG;AACH,MAAM,OAAO,yBAA0B,SAAQ,aAAa;IAI1D;;;;OAIG;IACI,iBAAiB,CAAC,SAA0D;QACjF,+BAA+B;IACjC,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,SAAmD;QACnE,+BAA+B;IACjC,CAAC;IAEM,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAgB;QACjD,OAAO,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IACxE,CAAC;CACF;AAED,QAAQ,CAAC,aAAa,CAAC,yBAAyB,EAAE,6BAA6B,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { ApiItem, ApiModel } from '@microsoft/api-extractor-model';\nimport { TypeUuid } from '@rushstack/node-core-library';\n\nimport { PluginFeature } from './PluginFeature';\nimport type { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';\n\n/**\n * Context object for {@link MarkdownDocumenterFeature}.\n * Exposes various services that can be used by a plugin.\n *\n * @public\n */\nexport class MarkdownDocumenterFeatureContext {\n  /**\n   * Provides access to the `ApiModel` for the documentation being generated.\n   */\n  public readonly apiModel: ApiModel;\n\n  /**\n   * The full path to the output folder.\n   */\n  public readonly outputFolder: string;\n\n  /**\n   * Exposes functionality of the documenter.\n   */\n  public readonly documenter: MarkdownDocumenterAccessor;\n\n  /** @internal */\n  public constructor(options: MarkdownDocumenterFeatureContext) {\n    this.apiModel = options.apiModel;\n    this.outputFolder = options.outputFolder;\n    this.documenter = options.documenter;\n  }\n}\n\n/**\n * Event arguments for MarkdownDocumenterFeature.onBeforeWritePage()\n * @public\n */\nexport interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs {\n  /**\n   * The API item corresponding to this page.\n   */\n  readonly apiItem: ApiItem;\n\n  /**\n   * The page content.  The {@link MarkdownDocumenterFeature.onBeforeWritePage} handler can reassign this\n   * string to customize the page appearance.\n   */\n  pageContent: string;\n\n  /**\n   * The filename where the output will be written.\n   */\n  readonly outputFilename: string;\n}\n\n/**\n * Event arguments for MarkdownDocumenterFeature.onFinished()\n * @public\n */\nexport interface IMarkdownDocumenterFeatureOnFinishedArgs {}\n\nconst uuidMarkdownDocumenterFeature: string = '34196154-9eb3-4de0-a8c8-7e9539dfe216';\n\n/**\n * Inherit from this base class to implement an API Documenter plugin feature that customizes\n * the generation of markdown output.\n *\n * @public\n */\nexport class MarkdownDocumenterFeature extends PluginFeature {\n  /** {@inheritdoc PluginFeature.context} */\n  public context!: MarkdownDocumenterFeatureContext;\n\n  /**\n   * This event occurs before each markdown file is written.  It provides an opportunity to customize the\n   * content of the file.\n   * @virtual\n   */\n  public onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void {\n    // (implemented by child class)\n  }\n\n  /**\n   * This event occurs after all output files have been written.\n   * @virtual\n   */\n  public onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void {\n    // (implemented by child class)\n  }\n\n  public static [Symbol.hasInstance](instance: object): boolean {\n    return TypeUuid.isInstanceOf(instance, uuidMarkdownDocumenterFeature);\n  }\n}\n\nTypeUuid.registerClass(MarkdownDocumenterFeature, uuidMarkdownDocumenterFeature);\n"]}

package/lib-esm/plugin/PluginFeature.js

@@ -0,0 +1,54 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TypeUuid } from '@rushstack/node-core-library';
+/**
+ * This is an internal part of the plugin infrastructure.
+ *
+ * @remarks
+ * This object is the constructor parameter for API Documenter plugin features.
+ *
+ * @public
+ */
+export class PluginFeatureInitialization {
+    /** @internal */
+    constructor() {
+        // reserved for future use
+    }
+}
+/**
+ * Context object for {@link PluginFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+export class PluginFeatureContext {
+}
+const uuidPluginFeature = '56876472-7134-4812-819e-533de0ee10e6';
+/**
+ * The abstract base class for all API Documenter plugin features.
+ * @public
+ */
+export class PluginFeature {
+    /**
+     * The subclass should pass the `initialization` through to the base class.
+     * Do not put custom initialization code in the constructor.  Instead perform your initialization in the
+     * `onInitialized()` event function.
+     * @internal
+     */
+    constructor(initialization) {
+        // reserved for future expansion
+        this.context = initialization._context;
+    }
+    /**
+     * This event function is called after the feature is initialized, but before any processing occurs.
+     * @virtual
+     */
+    onInitialized() {
+        // (implemented by child class)
+    }
+    static [Symbol.hasInstance](instance) {
+        return TypeUuid.isInstanceOf(instance, uuidPluginFeature);
+    }
+}
+TypeUuid.registerClass(PluginFeature, uuidPluginFeature);
+//# sourceMappingURL=PluginFeature.js.map

package/lib-esm/plugin/PluginFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginFeature.js","sourceRoot":"","sources":["../../src/plugin/PluginFeature.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA2B;IAItC,gBAAgB;IAChB;QACE,0BAA0B;IAC5B,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;CAAG;AAEpC,MAAM,iBAAiB,GAAW,sCAAsC,CAAC;AAEzE;;;GAGG;AACH,MAAM,OAAgB,aAAa;IAMjC;;;;;OAKG;IACH,YAAmB,cAA2C;QAC5D,gCAAgC;QAChC,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,+BAA+B;IACjC,CAAC;IAEM,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAgB;QACjD,OAAO,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAC5D,CAAC;CACF;AAED,QAAQ,CAAC,aAAa,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { TypeUuid } from '@rushstack/node-core-library';\n\n/**\n * This is an internal part of the plugin infrastructure.\n *\n * @remarks\n * This object is the constructor parameter for API Documenter plugin features.\n *\n * @public\n */\nexport class PluginFeatureInitialization {\n  /** @internal */\n  public _context!: PluginFeatureContext;\n\n  /** @internal */\n  public constructor() {\n    // reserved for future use\n  }\n}\n\n/**\n * Context object for {@link PluginFeature}.\n * Exposes various services that can be used by a plugin.\n *\n * @public\n */\nexport class PluginFeatureContext {}\n\nconst uuidPluginFeature: string = '56876472-7134-4812-819e-533de0ee10e6';\n\n/**\n * The abstract base class for all API Documenter plugin features.\n * @public\n */\nexport abstract class PluginFeature {\n  /**\n   * Exposes various services that can be used by a plugin.\n   */\n  public context: PluginFeatureContext;\n\n  /**\n   * The subclass should pass the `initialization` through to the base class.\n   * Do not put custom initialization code in the constructor.  Instead perform your initialization in the\n   * `onInitialized()` event function.\n   * @internal\n   */\n  public constructor(initialization: PluginFeatureInitialization) {\n    // reserved for future expansion\n    this.context = initialization._context;\n  }\n\n  /**\n   * This event function is called after the feature is initialized, but before any processing occurs.\n   * @virtual\n   */\n  public onInitialized(): void {\n    // (implemented by child class)\n  }\n\n  public static [Symbol.hasInstance](instance: object): boolean {\n    return TypeUuid.isInstanceOf(instance, uuidPluginFeature);\n  }\n}\n\nTypeUuid.registerClass(PluginFeature, uuidPluginFeature);\n"]}

package/lib-esm/plugin/PluginLoader.js

@@ -0,0 +1,78 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import * as path from 'node:path';
+import * as resolve from 'resolve';
+import { MarkdownDocumenterFeature } from './MarkdownDocumenterFeature';
+import { PluginFeatureInitialization } from './PluginFeature';
+export class PluginLoader {
+    load(documenterConfig, createContext) {
+        const configFileFolder = path.dirname(documenterConfig.configFilePath);
+        for (const configPlugin of documenterConfig.configFile.plugins || []) {
+            try {
+                // Look for the package name in the same place as the config file
+                const resolvedEntryPointPath = resolve.sync(configPlugin.packageName, {
+                    basedir: configFileFolder
+                });
+                // Load the package
+                const entryPoint = require(resolvedEntryPointPath);
+                if (!entryPoint) {
+                    throw new Error('Invalid entry point');
+                }
+                if (!entryPoint.apiDocumenterPluginManifest) {
+                    throw new Error(`The package is not an API documenter plugin;` +
+                        ` the "apiDocumenterPluginManifest" export was not found`);
+                }
+                const manifest = entryPoint.apiDocumenterPluginManifest;
+                if (manifest.manifestVersion !== 1000) {
+                    throw new Error(`The plugin is not compatible with this version of API Documenter;` +
+                        ` unsupported manifestVersion`);
+                }
+                const loadedPlugin = {
+                    packageName: configPlugin.packageName,
+                    manifest
+                };
+                const featureDefinitionsByName = new Map();
+                for (const featureDefinition of manifest.features) {
+                    featureDefinitionsByName.set(featureDefinition.featureName, featureDefinition);
+                }
+                for (const featureName of configPlugin.enabledFeatureNames) {
+                    const featureDefinition = featureDefinitionsByName.get(featureName);
+                    if (!featureDefinition) {
+                        throw new Error(`The plugin ${loadedPlugin.packageName} does not have a feature with name "${featureName}"`);
+                    }
+                    if (featureDefinition.kind === 'MarkdownDocumenterFeature') {
+                        if (this.markdownDocumenterFeature) {
+                            throw new Error('A MarkdownDocumenterFeature is already loaded');
+                        }
+                        const initialization = new PluginFeatureInitialization();
+                        initialization._context = createContext();
+                        let markdownDocumenterFeature = undefined;
+                        try {
+                            markdownDocumenterFeature = new featureDefinition.subclass(initialization);
+                        }
+                        catch (e) {
+                            throw new Error(`Failed to construct feature subclass:\n` + e.toString());
+                        }
+                        if (!(markdownDocumenterFeature instanceof MarkdownDocumenterFeature)) {
+                            throw new Error('The constructed subclass was not an instance of MarkdownDocumenterFeature');
+                        }
+                        try {
+                            markdownDocumenterFeature.onInitialized();
+                        }
+                        catch (e) {
+                            throw new Error('Error occurred during the onInitialized() event: ' + e.toString());
+                        }
+                        this.markdownDocumenterFeature = markdownDocumenterFeature;
+                    }
+                    else {
+                        throw new Error(`Unknown feature definition kind: "${featureDefinition.kind}"`);
+                    }
+                }
+            }
+            catch (e) {
+                throw new Error(`Error loading plugin ${configPlugin.packageName}: ` + e.message);
+            }
+        }
+    }
+}
+//# sourceMappingURL=PluginLoader.js.map

package/lib-esm/plugin/PluginLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,OAAO,EACL,yBAAyB,EAE1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAQ9D,MAAM,OAAO,YAAY;IAGhB,IAAI,CACT,gBAAkC,EAClC,aAAqD;QAErD,MAAM,gBAAgB,GAAW,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;QAC/E,KAAK,MAAM,YAAY,IAAI,gBAAgB,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACrE,IAAI,CAAC;gBACH,iEAAiE;gBACjE,MAAM,sBAAsB,GAAW,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;oBAC5E,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;gBAEH,mBAAmB;gBACnB,MAAM,UAAU,GAEA,OAAO,CAAC,sBAAsB,CAAC,CAAC;gBAEhD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;gBACzC,CAAC;gBAED,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAC;oBAC5C,MAAM,IAAI,KAAK,CACb,8CAA8C;wBAC5C,yDAAyD,CAC5D,CAAC;gBACJ,CAAC;gBAED,MAAM,QAAQ,GAAiC,UAAU,CAAC,2BAA2B,CAAC;gBAEtF,IAAI,QAAQ,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;oBACtC,MAAM,IAAI,KAAK,CACb,mEAAmE;wBACjE,8BAA8B,CACjC,CAAC;gBACJ,CAAC;gBAED,MAAM,YAAY,GAAkB;oBAClC,WAAW,EAAE,YAAY,CAAC,WAAW;oBACrC,QAAQ;iBACT,CAAC;gBAEF,MAAM,wBAAwB,GAAoC,IAAI,GAAG,EAGtE,CAAC;gBACJ,KAAK,MAAM,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBAClD,wBAAwB,CAAC,GAAG,CAAC,iBAAiB,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;gBACjF,CAAC;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,mBAAmB,EAAE,CAAC;oBAC3D,MAAM,iBAAiB,GAAmC,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBACpG,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACvB,MAAM,IAAI,KAAK,CACb,cAAc,YAAY,CAAC,WAAW,uCAAuC,WAAW,GAAG,CAC5F,CAAC;oBACJ,CAAC;oBAED,IAAI,iBAAiB,CAAC,IAAI,KAAK,2BAA2B,EAAE,CAAC;wBAC3D,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;4BACnC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;wBACnE,CAAC;wBAED,MAAM,cAAc,GAAgC,IAAI,2BAA2B,EAAE,CAAC;wBACtF,cAAc,CAAC,QAAQ,GAAG,aAAa,EAAE,CAAC;wBAE1C,IAAI,yBAAyB,GAA0C,SAAS,CAAC;wBACjF,IAAI,CAAC;4BACH,yBAAyB,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;wBAC7E,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAI,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACvF,CAAC;wBACD,IAAI,CAAC,CAAC,yBAAyB,YAAY,yBAAyB,CAAC,EAAE,CAAC;4BACtE,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;wBAC/F,CAAC;wBAED,IAAI,CAAC;4BACH,yBAAyB,CAAC,aAAa,EAAE,CAAC;wBAC5C,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,MAAM,IAAI,KAAK,CAAC,mDAAmD,GAAI,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACjG,CAAC;wBAED,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;oBAC7D,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,qCAAqC,iBAAiB,CAAC,IAAI,GAAG,CAAC,CAAC;oBAClF,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,wBAAwB,YAAY,CAAC,WAAW,IAAI,GAAI,CAAW,CAAC,OAAO,CAAC,CAAC;YAC/F,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'node:path';\n\nimport * as resolve from 'resolve';\n\nimport type { IApiDocumenterPluginManifest, IFeatureDefinition } from './IApiDocumenterPluginManifest';\nimport {\n  MarkdownDocumenterFeature,\n  type MarkdownDocumenterFeatureContext\n} from './MarkdownDocumenterFeature';\nimport { PluginFeatureInitialization } from './PluginFeature';\nimport type { DocumenterConfig } from '../documenters/DocumenterConfig';\n\ninterface ILoadedPlugin {\n  packageName: string;\n  manifest: IApiDocumenterPluginManifest;\n}\n\nexport class PluginLoader {\n  public markdownDocumenterFeature: MarkdownDocumenterFeature | undefined;\n\n  public load(\n    documenterConfig: DocumenterConfig,\n    createContext: () => MarkdownDocumenterFeatureContext\n  ): void {\n    const configFileFolder: string = path.dirname(documenterConfig.configFilePath);\n    for (const configPlugin of documenterConfig.configFile.plugins || []) {\n      try {\n        // Look for the package name in the same place as the config file\n        const resolvedEntryPointPath: string = resolve.sync(configPlugin.packageName, {\n          basedir: configFileFolder\n        });\n\n        // Load the package\n        const entryPoint:\n          | { apiDocumenterPluginManifest?: IApiDocumenterPluginManifest }\n          | undefined = require(resolvedEntryPointPath);\n\n        if (!entryPoint) {\n          throw new Error('Invalid entry point');\n        }\n\n        if (!entryPoint.apiDocumenterPluginManifest) {\n          throw new Error(\n            `The package is not an API documenter plugin;` +\n              ` the \"apiDocumenterPluginManifest\" export was not found`\n          );\n        }\n\n        const manifest: IApiDocumenterPluginManifest = entryPoint.apiDocumenterPluginManifest;\n\n        if (manifest.manifestVersion !== 1000) {\n          throw new Error(\n            `The plugin is not compatible with this version of API Documenter;` +\n              ` unsupported manifestVersion`\n          );\n        }\n\n        const loadedPlugin: ILoadedPlugin = {\n          packageName: configPlugin.packageName,\n          manifest\n        };\n\n        const featureDefinitionsByName: Map<string, IFeatureDefinition> = new Map<\n          string,\n          IFeatureDefinition\n        >();\n        for (const featureDefinition of manifest.features) {\n          featureDefinitionsByName.set(featureDefinition.featureName, featureDefinition);\n        }\n\n        for (const featureName of configPlugin.enabledFeatureNames) {\n          const featureDefinition: IFeatureDefinition | undefined = featureDefinitionsByName.get(featureName);\n          if (!featureDefinition) {\n            throw new Error(\n              `The plugin ${loadedPlugin.packageName} does not have a feature with name \"${featureName}\"`\n            );\n          }\n\n          if (featureDefinition.kind === 'MarkdownDocumenterFeature') {\n            if (this.markdownDocumenterFeature) {\n              throw new Error('A MarkdownDocumenterFeature is already loaded');\n            }\n\n            const initialization: PluginFeatureInitialization = new PluginFeatureInitialization();\n            initialization._context = createContext();\n\n            let markdownDocumenterFeature: MarkdownDocumenterFeature | undefined = undefined;\n            try {\n              markdownDocumenterFeature = new featureDefinition.subclass(initialization);\n            } catch (e) {\n              throw new Error(`Failed to construct feature subclass:\\n` + (e as Error).toString());\n            }\n            if (!(markdownDocumenterFeature instanceof MarkdownDocumenterFeature)) {\n              throw new Error('The constructed subclass was not an instance of MarkdownDocumenterFeature');\n            }\n\n            try {\n              markdownDocumenterFeature.onInitialized();\n            } catch (e) {\n              throw new Error('Error occurred during the onInitialized() event: ' + (e as Error).toString());\n            }\n\n            this.markdownDocumenterFeature = markdownDocumenterFeature;\n          } else {\n            throw new Error(`Unknown feature definition kind: \"${featureDefinition.kind}\"`);\n          }\n        }\n      } catch (e) {\n        throw new Error(`Error loading plugin ${configPlugin.packageName}: ` + (e as Error).message);\n      }\n    }\n  }\n}\n"]}

package/lib-esm/schemas/api-documenter-template.json

@@ -0,0 +1,99 @@
+/**
+ * Config file for API Documenter.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-documenter.schema.json",
+
+  /**
+   * Specifies the output target.
+   * Supported values are "docfx" or "markdown"
+   */
+  // "outputTarget": "markdown",
+
+  /**
+   * Specifies what type of newlines API Documenter should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+   * To use the OS's default newline kind, specify "os".
+   *
+   * DEFAULT VALUE: "crlf"
+   */
+  // "newlineKind": "crlf",
+
+  /**
+   * This enables an experimental feature that will be officially released with the next major version
+   * of API Documenter.  It requires DocFX 2.46 or newer.  It enables documentation for namespaces and
+   * adds them to the table of contents.  This will also affect file layout as namespaced items will be nested
+   * under a directory for the namespace instead of just within the package.
+   *
+   * This setting currently only affects the 'docfx' output target.  It is equivalent to the `--new-docfx-namespaces`
+   * command-line parameter.
+   */
+  // "newDocfxNamespaces": false,
+
+  /**
+   * Describes plugin packages to be loaded, and which features to enable.
+   */
+  "plugins": [
+    // {
+    //  "packageName": "doc-plugin-example",
+    //  "enabledFeatureNames": [ "example-feature" ]
+    // }
+  ],
+
+  /**
+   * Configures how the table of contents is generated.
+   */
+  "tableOfContents": {
+    /**
+     * Allows hand-coded items to be injected into the table of contents.
+     *
+     * DEFAULT VALUE: (none)
+     */
+    // "items": [
+    //   { "name": "Example Node", "href": "~/homepage/homepage.md" },
+    //   {
+    //     "name": "API Reference",
+    //     "items": [
+    //       { "name": "References" }
+    //     ]
+    //   }
+    // ],
+    /**
+     * Optional category name that is recommended to include in the `tocConfig`,
+     * along with one of the filters: `filterByApiItemName` or `filterByInlineTag`.
+     * Any items that are not matched to the mentioned filters will be placed under this
+     * catchAll category. If none provided the items will not be included in the final toc.yml file.
+     *
+     * DEFAULT VALUE: (none)
+     */
+    // "catchAllCategory": "References",
+    /**
+     * When loading more than one api.json files that might include the same API items,
+     * toggle either to show duplicates or not.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "noDuplicateEntries": true,
+    /**
+     * Toggle either sorting of the API items should be made based on category name presence
+     * in the API item's name.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "filterByApiItemName": false,
+    /**
+     * Filter that can be used to sort the API items according to an inline custom tag
+     * that is present on them.
+     *
+     * DEFAULT VALUE: (none)
+     */
+    // "filterByInlineTag": "@docCategory"
+  }
+
+  /**
+   * Specifies whether inherited members should also be shown on an API item's page.
+   *
+   * DEFAULT VALUE: false
+   */
+  // "showInheritedMembers": false
+}