@firebase/api-documenter 0.1.2-canary.233e117f0

package/dist/markdown/test/CustomMarkdownEmitter.test.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+const CustomDocNodeKind_1 = require("../../nodes/CustomDocNodeKind");
+const DocHeading_1 = require("../../nodes/DocHeading");
+const DocEmphasisSpan_1 = require("../../nodes/DocEmphasisSpan");
+const DocTable_1 = require("../../nodes/DocTable");
+const DocTableRow_1 = require("../../nodes/DocTableRow");
+const DocTableCell_1 = require("../../nodes/DocTableCell");
+const CustomMarkdownEmitter_1 = require("../CustomMarkdownEmitter");
+const api_extractor_model_me_1 = require("api-extractor-model-me");
+const chai_1 = require("chai");
+const mocha_chai_jest_snapshot_1 = require("mocha-chai-jest-snapshot");
+chai_1.use(mocha_chai_jest_snapshot_1.jestSnapshotPlugin());
+it('render Markdown from TSDoc', () => {
+    const configuration = CustomDocNodeKind_1.CustomDocNodes.configuration;
+    const output = new tsdoc_1.DocSection({ configuration });
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Simple bold test' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocPlainText({ configuration, text: 'This is a ' }),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'bold' })
+            ]),
+            new tsdoc_1.DocPlainText({ configuration, text: ' word.' })
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'All whitespace bold' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: '  ' })
+            ])
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Newline bold' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'line 1' }),
+                new tsdoc_1.DocSoftBreak({ configuration }),
+                new tsdoc_1.DocPlainText({ configuration, text: 'line 2' })
+            ])
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Newline bold with spaces' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: '  line 1  ' }),
+                new tsdoc_1.DocSoftBreak({ configuration }),
+                new tsdoc_1.DocPlainText({ configuration, text: '  line 2  ' }),
+                new tsdoc_1.DocSoftBreak({ configuration }),
+                new tsdoc_1.DocPlainText({ configuration, text: '  line 3  ' })
+            ])
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Adjacent bold regions' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'one' })
+            ]),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'two' })
+            ]),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: ' three ' })
+            ]),
+            new tsdoc_1.DocPlainText({ configuration, text: '' }),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'four' })
+            ]),
+            new tsdoc_1.DocPlainText({ configuration, text: 'non-bold' }),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'five' })
+            ])
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Adjacent to other characters' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocLinkTag({
+                configuration,
+                tagName: '@link',
+                linkText: 'a link',
+                urlDestination: './index.md'
+            }),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'bold' })
+            ]),
+            new tsdoc_1.DocPlainText({ configuration, text: 'non-bold' }),
+            new tsdoc_1.DocPlainText({ configuration, text: 'more-non-bold' })
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Unknown block tag' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocBlockTag({
+                configuration,
+                tagName: '@unknown'
+            }),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'bold' })
+            ]),
+            new tsdoc_1.DocPlainText({ configuration, text: 'non-bold' }),
+            new tsdoc_1.DocPlainText({ configuration, text: 'more-non-bold' })
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Bad characters' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: '*one*two*' })
+            ]),
+            new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
+                new tsdoc_1.DocPlainText({ configuration, text: 'three*four' })
+            ])
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({
+            configuration,
+            title: 'Characters that should be escaped'
+        }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocPlainText({
+                configuration,
+                text: 'Double-encoded JSON: "{ \\"A\\": 123}"'
+            })
+        ]),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocPlainText({
+                configuration,
+                text: 'HTML chars: <script>alert("[You] are #1!");</script>'
+            })
+        ]),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocPlainText({ configuration, text: 'HTML escape: &quot;' })
+        ]),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocPlainText({
+                configuration,
+                text: '3 or more hyphens: - -- --- ---- ----- ------'
+            })
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'HTML tag' }),
+        new tsdoc_1.DocParagraph({ configuration }, [
+            new tsdoc_1.DocHtmlStartTag({ configuration, name: 'b' }),
+            new tsdoc_1.DocPlainText({ configuration, text: 'bold' }),
+            new tsdoc_1.DocHtmlEndTag({ configuration, name: 'b' })
+        ])
+    ]);
+    output.appendNodes([
+        new DocHeading_1.DocHeading({ configuration, title: 'Table' }),
+        new DocTable_1.DocTable({
+            configuration,
+            headerTitles: ['Header 1', 'Header 2']
+        }, [
+            new DocTableRow_1.DocTableRow({ configuration }, [
+                new DocTableCell_1.DocTableCell({ configuration }, [
+                    new tsdoc_1.DocParagraph({ configuration }, [
+                        new tsdoc_1.DocPlainText({ configuration, text: 'Cell 1' })
+                    ])
+                ]),
+                new DocTableCell_1.DocTableCell({ configuration }, [
+                    new tsdoc_1.DocParagraph({ configuration }, [
+                        new tsdoc_1.DocPlainText({ configuration, text: 'Cell 2' })
+                    ])
+                ])
+            ])
+        ])
+    ]);
+    const stringBuilder = new tsdoc_1.StringBuilder();
+    const apiModel = new api_extractor_model_me_1.ApiModel();
+    const markdownEmitter = new CustomMarkdownEmitter_1.CustomMarkdownEmitter(apiModel);
+    markdownEmitter.emit(stringBuilder, output, {
+        contextApiItem: undefined,
+        onGetFilenameForApiItem: (apiItem) => {
+            return '#';
+        }
+    });
+    chai_1.expect(stringBuilder).toMatchSnapshot();
+});
+//# sourceMappingURL=CustomMarkdownEmitter.test.js.map

package/dist/markdown/test/CustomMarkdownEmitter.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomMarkdownEmitter.test.js","sourceRoot":"","sources":["../../../src/markdown/test/CustomMarkdownEmitter.test.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAW0B;AAE1B,qEAA+D;AAC/D,uDAAoD;AACpD,iEAA8D;AAC9D,mDAAgD;AAChD,yDAAsD;AACtD,2DAAwD;AACxD,oEAAiE;AACjE,mEAA2D;AAC3D,+BAAmC;AACnC,uEAA8D;AAE9D,UAAG,CAAC,6CAAkB,EAAE,CAAC,CAAC;AAE1B,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,aAAa,GAAuB,kCAAc,CAAC,aAAa,CAAC;IAEvE,MAAM,MAAM,GAAe,IAAI,kBAAU,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;IAE7D,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;QAC5D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;YACvD,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SACpD,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC;QAC/D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;aAChD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;QACxD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACnD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;aACpD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;QACpE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;gBACvD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;gBACvD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aACxD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC;QACjE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;aACjD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;aACjD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;aACrD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAC7C,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACxE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,kBAAU,CAAC;gBACb,aAAa;gBACb,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,QAAQ;gBAClB,cAAc,EAAE,YAAY;aAC7B,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;SAC3D,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;QAC7D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,mBAAW,CAAC;gBACd,aAAa;gBACb,OAAO,EAAE,UAAU;aACpB,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;SAC3D,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;QAC1D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;aACvD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aACxD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC;YACb,aAAa;YACb,KAAK,EAAE,mCAAmC;SAC3C,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,wCAAwC;aAC/C,CAAC;SACH,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,sDAAsD;aAC7D,CAAC;SACH,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;SACjE,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,+CAA+C;aACtD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QACpD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,uBAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;YACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACjD,IAAI,qBAAa,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;SAChD,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACjD,IAAI,mBAAQ,CACV;YACE,aAAa;YACb,YAAY,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;SACvC,EACD;YACE,IAAI,yBAAW,CAAC,EAAE,aAAa,EAAE,EAAE;gBACjC,IAAI,2BAAY,CAAC,EAAE,aAAa,EAAE,EAAE;oBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;wBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;qBACpD,CAAC;iBACH,CAAC;gBACF,IAAI,2BAAY,CAAC,EAAE,aAAa,EAAE,EAAE;oBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;wBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;qBACpD,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CACF;KACF,CAAC,CAAC;IAEH,MAAM,aAAa,GAAkB,IAAI,qBAAa,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAa,IAAI,iCAAQ,EAAE,CAAC;IAC1C,MAAM,eAAe,GAA0B,IAAI,6CAAqB,CACtE,QAAQ,CACT,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE;QAC1C,cAAc,EAAE,SAAS;QACzB,uBAAuB,EAAE,CAAC,OAAgB,EAAE,EAAE;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC,CAAC;IAEH,aAAM,CAAC,aAAa,CAAC,CAAC,eAAe,EAAE,CAAC;AAC1C,CAAC,CAAC,CAAC"}

package/dist/nodes/CustomDocNodeKind.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { TSDocConfiguration } from '@microsoft/tsdoc';
+/**
+ * Identifies custom subclasses of {@link DocNode}.
+ */
+export declare const enum CustomDocNodeKind {
+    EmphasisSpan = "EmphasisSpan",
+    Heading = "Heading",
+    NoteBox = "NoteBox",
+    Table = "Table",
+    TableCell = "TableCell",
+    TableRow = "TableRow"
+}
+export declare class CustomDocNodes {
+    private static _configuration;
+    static get configuration(): TSDocConfiguration;
+}

package/dist/nodes/CustomDocNodeKind.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomDocNodes = void 0;
+const tsdoc_1 = require("@microsoft/tsdoc");
+const DocEmphasisSpan_1 = require("./DocEmphasisSpan");
+const DocHeading_1 = require("./DocHeading");
+const DocNoteBox_1 = require("./DocNoteBox");
+const DocTable_1 = require("./DocTable");
+const DocTableCell_1 = require("./DocTableCell");
+const DocTableRow_1 = require("./DocTableRow");
+class CustomDocNodes {
+    static get configuration() {
+        if (CustomDocNodes._configuration === undefined) {
+            const configuration = new tsdoc_1.TSDocConfiguration();
+            configuration.docNodeManager.registerDocNodes('@micrososft/api-documenter', [
+                {
+                    docNodeKind: "EmphasisSpan" /* EmphasisSpan */,
+                    constructor: DocEmphasisSpan_1.DocEmphasisSpan
+                },
+                { docNodeKind: "Heading" /* Heading */, constructor: DocHeading_1.DocHeading },
+                { docNodeKind: "NoteBox" /* NoteBox */, constructor: DocNoteBox_1.DocNoteBox },
+                { docNodeKind: "Table" /* Table */, constructor: DocTable_1.DocTable },
+                {
+                    docNodeKind: "TableCell" /* TableCell */,
+                    constructor: DocTableCell_1.DocTableCell
+                },
+                { docNodeKind: "TableRow" /* TableRow */, constructor: DocTableRow_1.DocTableRow }
+            ]);
+            configuration.docNodeManager.registerAllowableChildren("EmphasisSpan" /* EmphasisSpan */, ["PlainText" /* PlainText */, "SoftBreak" /* SoftBreak */]);
+            configuration.docNodeManager.registerAllowableChildren("Section" /* Section */, [
+                "Heading" /* Heading */,
+                "NoteBox" /* NoteBox */,
+                "Table" /* Table */
+            ]);
+            configuration.docNodeManager.registerAllowableChildren("Paragraph" /* Paragraph */, ["EmphasisSpan" /* EmphasisSpan */]);
+            CustomDocNodes._configuration = configuration;
+        }
+        return CustomDocNodes._configuration;
+    }
+}
+exports.CustomDocNodes = CustomDocNodes;
+//# sourceMappingURL=CustomDocNodeKind.js.map

package/dist/nodes/CustomDocNodeKind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomDocNodeKind.js","sourceRoot":"","sources":["../../src/nodes/CustomDocNodeKind.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4CAAmE;AACnE,uDAAoD;AACpD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AACtC,iDAA8C;AAC9C,+CAA4C;AAiB5C,MAAa,cAAc;IAGlB,MAAM,KAAK,aAAa;QAC7B,IAAI,cAAc,CAAC,cAAc,KAAK,SAAS,EAAE;YAC/C,MAAM,aAAa,GAAuB,IAAI,0BAAkB,EAAE,CAAC;YAEnE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAC3C,4BAA4B,EAC5B;gBACE;oBACE,WAAW,mCAAgC;oBAC3C,WAAW,EAAE,iCAAe;iBAC7B;gBACD,EAAE,WAAW,yBAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,yBAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,qBAAyB,EAAE,WAAW,EAAE,mBAAQ,EAAE;gBAC/D;oBACE,WAAW,6BAA6B;oBACxC,WAAW,EAAE,2BAAY;iBAC1B;gBACD,EAAE,WAAW,2BAA4B,EAAE,WAAW,EAAE,yBAAW,EAAE;aACtE,CACF,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,oCAEpD,0DAA8C,CAC/C,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,0BAEpD;;;;aAIC,CACF,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,8BAEpD,mCAAgC,CACjC,CAAC;YAEF,cAAc,CAAC,cAAc,GAAG,aAAa,CAAC;SAC/C;QACD,OAAO,cAAc,CAAC,cAAc,CAAC;IACvC,CAAC;CACF;AAhDD,wCAgDC"}

package/dist/nodes/DocEmphasisSpan.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DocNode, DocNodeContainer, IDocNodeContainerParameters } from '@microsoft/tsdoc';
+/**
+ * Constructor parameters for {@link DocEmphasisSpan}.
+ */
+export interface IDocEmphasisSpanParameters extends IDocNodeContainerParameters {
+    bold?: boolean;
+    italic?: boolean;
+}
+/**
+ * Represents a span of text that is styled with CommonMark emphasis (italics), strong emphasis (boldface),
+ * or both.
+ */
+export declare class DocEmphasisSpan extends DocNodeContainer {
+    readonly bold: boolean;
+    readonly italic: boolean;
+    constructor(parameters: IDocEmphasisSpanParameters, children?: DocNode[]);
+    /** @override */
+    get kind(): string;
+}

package/dist/nodes/DocEmphasisSpan.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocEmphasisSpan = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+/**
+ * Represents a span of text that is styled with CommonMark emphasis (italics), strong emphasis (boldface),
+ * or both.
+ */
+class DocEmphasisSpan extends tsdoc_1.DocNodeContainer {
+    constructor(parameters, children) {
+        super(parameters, children);
+        this.bold = !!parameters.bold;
+        this.italic = !!parameters.italic;
+    }
+    /** @override */
+    get kind() {
+        return "EmphasisSpan" /* EmphasisSpan */;
+    }
+}
+exports.DocEmphasisSpan = DocEmphasisSpan;
+//# sourceMappingURL=DocEmphasisSpan.js.map

package/dist/nodes/DocEmphasisSpan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocEmphasisSpan.js","sourceRoot":"","sources":["../../src/nodes/DocEmphasisSpan.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAI0B;AAY1B;;;GAGG;AACH,MAAa,eAAgB,SAAQ,wBAAgB;IAInD,YACE,UAAsC,EACtC,QAAoB;QAEpB,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,yCAAsC;IACxC,CAAC;CACF;AAjBD,0CAiBC"}

package/dist/nodes/DocHeading.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+/**
+ * Constructor parameters for {@link DocHeading}.
+ */
+export interface IDocHeadingParameters extends IDocNodeParameters {
+    title: string;
+    level?: number;
+}
+/**
+ * Represents a section header similar to an HTML `<h1>` or `<h2>` element.
+ */
+export declare class DocHeading extends DocNode {
+    readonly title: string;
+    readonly level: number;
+    /**
+     * Don't call this directly.  Instead use {@link TSDocParser}
+     * @internal
+     */
+    constructor(parameters: IDocHeadingParameters);
+    /** @override */
+    get kind(): string;
+}

package/dist/nodes/DocHeading.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocHeading = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+/**
+ * Represents a section header similar to an HTML `<h1>` or `<h2>` element.
+ */
+class DocHeading extends tsdoc_1.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 "Heading" /* Heading */;
+    }
+}
+exports.DocHeading = DocHeading;
+//# sourceMappingURL=DocHeading.js.map

package/dist/nodes/DocHeading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocHeading.js","sourceRoot":"","sources":["../../src/nodes/DocHeading.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAA+D;AAW/D;;GAEG;AACH,MAAa,UAAW,SAAQ,eAAO;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;YACpC,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,+BAAiC;IACnC,CAAC;CACF;AAxBD,gCAwBC"}

package/dist/nodes/DocNoteBox.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
+/**
+ * Constructor parameters for {@link DocNoteBox}.
+ */
+export interface IDocNoteBoxParameters extends IDocNodeParameters {
+}
+/**
+ * Represents a note box, which is typically displayed as a bordered box containing informational text.
+ */
+export declare class DocNoteBox extends DocNode {
+    readonly content: DocSection;
+    constructor(parameters: IDocNoteBoxParameters, sectionChildNodes?: ReadonlyArray<DocNode>);
+    /** @override */
+    get kind(): string;
+    /** @override */
+    protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
+}

package/dist/nodes/DocNoteBox.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocNoteBox = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+/**
+ * Represents a note box, which is typically displayed as a bordered box containing informational text.
+ */
+class DocNoteBox extends tsdoc_1.DocNode {
+    constructor(parameters, sectionChildNodes) {
+        super(parameters);
+        this.content = new tsdoc_1.DocSection({ configuration: this.configuration }, sectionChildNodes);
+    }
+    /** @override */
+    get kind() {
+        return "NoteBox" /* NoteBox */;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return [this.content];
+    }
+}
+exports.DocNoteBox = DocNoteBox;
+//# sourceMappingURL=DocNoteBox.js.map

package/dist/nodes/DocNoteBox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocNoteBox.js","sourceRoot":"","sources":["../../src/nodes/DocNoteBox.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAA2E;AAQ3E;;GAEG;AACH,MAAa,UAAW,SAAQ,eAAO;IAGrC,YACE,UAAiC,EACjC,iBAA0C;QAE1C,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAU,CAC3B,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EACrC,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,+BAAiC;IACnC,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF;AAvBD,gCAuBC"}

package/dist/nodes/DocTable.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+import { DocTableRow } from './DocTableRow';
+import { DocTableCell } from './DocTableCell';
+/**
+ * Constructor parameters for {@link DocTable}.
+ */
+export interface IDocTableParameters extends IDocNodeParameters {
+    headerCells?: ReadonlyArray<DocTableCell>;
+    headerTitles?: string[];
+}
+/**
+ * Represents table, similar to an HTML `<table>` element.
+ */
+export declare class DocTable extends DocNode {
+    readonly header: DocTableRow;
+    private _rows;
+    constructor(parameters: IDocTableParameters, rows?: ReadonlyArray<DocTableRow>);
+    /** @override */
+    get kind(): string;
+    get rows(): ReadonlyArray<DocTableRow>;
+    addRow(row: DocTableRow): void;
+    createAndAddRow(): DocTableRow;
+    /** @override */
+    protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
+}