@firebase/api-documenter 0.5.0 → 0.6.0-crashlytics2.142b40983

package/dist/cli/ApiDocumenterCommandLine.d.ts

@@ -17,6 +17,4 @@
 import { CommandLineParser } from '@rushstack/ts-command-line';
 export declare class ApiDocumenterCommandLine extends CommandLineParser {
     constructor();
-    protected onDefineParameters(): void;
-    private _populateActions;
 }

package/dist/cli/ApiDocumenterCommandLine.js

@@ -29,13 +29,6 @@ class ApiDocumenterCommandLine extends ts_command_line_1.CommandLineParser {
             toolDescription: 'Reads *.api.json files produced by api-extractor, ' +
                 ' and generates API documentation in various output formats.'
         });
-        this._populateActions();
-    }
-    onDefineParameters() {
-        // override
-        // No parameters
-    }
-    _populateActions() {
         this.addAction(new MarkdownAction_1.MarkdownAction(this));
         this.addAction(new TocAction_1.TocAction(this));
     }

package/dist/cli/ApiDocumenterCommandLine.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiDocumenterCommandLine.js","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,gEAA+D;AAC/D,qDAAkD;AAClD,2CAAwC;AAExC,MAAa,wBAAyB,SAAQ,mCAAiB;IAC7D;QACE,KAAK,CAAC;YACJ,YAAY,EAAE,gBAAgB;YAC9B,eAAe,EACb,oDAAoD;gBACpD,6DAA6D;SAChE,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAES,kBAAkB;QAC1B,WAAW;QACX,gBAAgB;IAClB,CAAC;IAEO,gBAAgB;QACtB,IAAI,CAAC,SAAS,CAAC,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;CACF;AApBD,4DAoBC"}
+{"version":3,"file":"ApiDocumenterCommandLine.js","sourceRoot":"","sources":["../../src/cli/ApiDocumenterCommandLine.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,gEAA+D;AAC/D,qDAAkD;AAClD,2CAAwC;AAExC,MAAa,wBAAyB,SAAQ,mCAAiB;IAC7D;QACE,KAAK,CAAC;YACJ,YAAY,EAAE,gBAAgB;YAC9B,eAAe,EACb,oDAAoD;gBACpD,6DAA6D;SAChE,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;CACF;AAXD,4DAWC"}

package/dist/cli/BaseAction.d.ts

@@ -14,21 +14,24 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CommandLineAction } from '@rushstack/ts-command-line';
-import { ApiModel } from 'api-extractor-model-me';
+import { CommandLineAction, ICommandLineActionOptions } from '@rushstack/ts-command-line';
+import { ApiModel } from '@microsoft/api-extractor-model';
+import { ISubpackageInfo } from '../documenters/MarkdownDocumenterHelpers';
 export interface IBuildApiModelResult {
     apiModel: ApiModel;
     inputFolder: string;
     outputFolder: string;
     addFileNameSuffix: boolean;
     projectName?: string;
+    subpackages?: Map<string, ISubpackageInfo>;
 }
 export declare abstract class BaseAction extends CommandLineAction {
     private _inputFolderParameter;
     private _outputFolderParameter;
     private _fileNameSuffixParameter;
     private _projectNameParameter;
-    protected onDefineParameters(): void;
+    private _subpackageParameter;
+    constructor(options: ICommandLineActionOptions);
     protected buildApiModel(): IBuildApiModelResult;
     private _applyInheritDoc;
     /**

package/dist/cli/BaseAction.js

@@ -21,13 +21,14 @@ const tslib_1 = require("tslib");
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 const path = tslib_1.__importStar(require("path"));
-const colors_1 = tslib_1.__importDefault(require("colors"));
+const style_1 = require("../utils/style");
 const ts_command_line_1 = require("@rushstack/ts-command-line");
 const node_core_library_1 = require("@rushstack/node-core-library");
-const api_extractor_model_me_1 = require("api-extractor-model-me");
+const api_extractor_model_1 = require("@microsoft/api-extractor-model");
+const MarkdownDocumenterHelpers_1 = require("../documenters/MarkdownDocumenterHelpers");
 class BaseAction extends ts_command_line_1.CommandLineAction {
-    onDefineParameters() {
-        // override
+    constructor(options) {
+        super(options);
         this._inputFolderParameter = this.defineStringParameter({
             parameterLongName: '--input-folder',
             parameterShortName: '-i',
@@ -58,9 +59,14 @@ class BaseAction extends ts_command_line_1.CommandLineAction {
             description: `Name of the project (js, admin, functions, etc.). This will be ` +
                 `used in the devsite header path to the _project.yaml file.`
         });
+        this._subpackageParameter = this.defineStringListParameter({
+            parameterLongName: '--subpackage',
+            argumentName: 'MAPPING',
+            description: 'Subpackage mapping in the format "<npmPackageName>=<canonicalName>" (e.g. "@firebase/firestore-lite=@firebase/firestore/lite")'
+        });
     }
     buildApiModel() {
-        const apiModel = new api_extractor_model_me_1.ApiModel();
+        const apiModel = new api_extractor_model_1.ApiModel();
         const inputFolder = this._inputFolderParameter.value || './input';
         if (!node_core_library_1.FileSystem.exists(inputFolder)) {
             throw new Error('The input folder does not exist: ' + inputFolder);
@@ -68,7 +74,7 @@ class BaseAction extends ts_command_line_1.CommandLineAction {
         const outputFolder = this._outputFolderParameter.value || `./${this.actionName}`;
         node_core_library_1.FileSystem.ensureFolder(outputFolder);
         const addFileNameSuffix = this._fileNameSuffixParameter.value;
-        for (const filename of node_core_library_1.FileSystem.readFolder(inputFolder)) {
+        for (const filename of node_core_library_1.FileSystem.readFolderItemNames(inputFolder)) {
             if (filename.match(/\.api\.json$/i)) {
                 console.log(`Reading ${filename}`);
                 const filenamePath = path.join(inputFolder, filename);
@@ -76,30 +82,32 @@ class BaseAction extends ts_command_line_1.CommandLineAction {
             }
         }
         this._applyInheritDoc(apiModel, apiModel);
+        const subpackages = (0, MarkdownDocumenterHelpers_1.parseSubpackageMapping)(this._subpackageParameter.values || []);
         return {
             apiModel,
             inputFolder,
             outputFolder,
             addFileNameSuffix,
-            projectName: this._projectNameParameter.value
+            projectName: this._projectNameParameter.value,
+            subpackages
         };
     }
     // TODO: This is a temporary workaround.  The long term plan is for API Extractor's DocCommentEnhancer
     // to apply all @inheritDoc tags before the .api.json file is written.
     // See DocCommentEnhancer._applyInheritDoc() for more info.
     _applyInheritDoc(apiItem, apiModel) {
-        if (apiItem instanceof api_extractor_model_me_1.ApiDocumentedItem) {
+        if (apiItem instanceof api_extractor_model_1.ApiDocumentedItem) {
             if (apiItem.tsdocComment) {
                 const inheritDocTag = apiItem.tsdocComment.inheritDocTag;
                 if (inheritDocTag && inheritDocTag.declarationReference) {
                     // Attempt to resolve the declaration reference
                     const result = apiModel.resolveDeclarationReference(inheritDocTag.declarationReference, apiItem);
                     if (result.errorMessage) {
-                        console.log(colors_1.default.yellow(`Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` +
+                        console.log((0, style_1.yellow)(`Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` +
                             result.errorMessage));
                     }
                     else {
-                        if (result.resolvedApiItem instanceof api_extractor_model_me_1.ApiDocumentedItem &&
+                        if (result.resolvedApiItem instanceof api_extractor_model_1.ApiDocumentedItem &&
                             result.resolvedApiItem.tsdocComment &&
                             result.resolvedApiItem !== apiItem) {
                             this._copyInheritedDocs(apiItem.tsdocComment, result.resolvedApiItem.tsdocComment);
@@ -109,7 +117,7 @@ class BaseAction extends ts_command_line_1.CommandLineAction {
             }
         }
         // Recurse members
-        if (api_extractor_model_me_1.ApiItemContainerMixin.isBaseClassOf(apiItem)) {
+        if (api_extractor_model_1.ApiItemContainerMixin.isBaseClassOf(apiItem)) {
             for (const member of apiItem.members) {
                 this._applyInheritDoc(member, apiModel);
             }

package/dist/cli/BaseAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseAction.js","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAE7B,4DAA4B;AAE5B,gEAIoC;AACpC,oEAA0D;AAC1D,mEAMgC;AAUhC,MAAsB,UAAW,SAAQ,mCAAiB;IAM9C,kBAAkB;QAC1B,WAAW;QACX,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACtD,iBAAiB,EAAE,gBAAgB;YACnC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,6EAA6E;gBAC7E,uCAAuC;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACvD,iBAAiB,EAAE,iBAAiB;YACpC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,sEAAsE;gBACtE,yCAAyC;gBACzC,kCAAkC,IAAI,CAAC,UAAU,GAAG;SACvD,CAAC,CAAC;QAEH,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,mBAAmB,CAAC;YACvD,iBAAiB,EAAE,eAAe;YAClC,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,2DAA2D;gBAC3D,oEAAoE;gBACpE,8CAA8C;gBAC9C,wHAAwH;gBACxH,gFAAgF;SACnF,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACtD,iBAAiB,EAAE,WAAW;YAC9B,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,iEAAiE;gBACjE,4DAA4D;SAC/D,CAAC,CAAC;IACL,CAAC;IAES,aAAa;QACrB,MAAM,QAAQ,GAAa,IAAI,iCAAQ,EAAE,CAAC;QAE1C,MAAM,WAAW,GAAW,IAAI,CAAC,qBAAqB,CAAC,KAAK,IAAI,SAAS,CAAC;QAC1E,IAAI,CAAC,8BAAU,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,WAAW,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,YAAY,GAChB,IAAI,CAAC,sBAAsB,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;QAC9D,8BAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,iBAAiB,GAAY,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAEvE,KAAK,MAAM,QAAQ,IAAI,8BAAU,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1D,IAAI,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;gBACnC,MAAM,YAAY,GAAW,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC9D,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE1C,OAAO;YACL,QAAQ;YACR,WAAW;YACX,YAAY;YACZ,iBAAiB;YACjB,WAAW,EAAE,IAAI,CAAC,qBAAqB,CAAC,KAAK;SAC9C,CAAC;IACJ,CAAC;IAED,sGAAsG;IACtG,sEAAsE;IACtE,2DAA2D;IACnD,gBAAgB,CAAC,OAAgB,EAAE,QAAkB;QAC3D,IAAI,OAAO,YAAY,0CAAiB,EAAE,CAAC;YACzC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;gBACzB,MAAM,aAAa,GACjB,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;gBAErC,IAAI,aAAa,IAAI,aAAa,CAAC,oBAAoB,EAAE,CAAC;oBACxD,+CAA+C;oBAC/C,MAAM,MAAM,GACV,QAAQ,CAAC,2BAA2B,CAClC,aAAa,CAAC,oBAAoB,EAClC,OAAO,CACR,CAAC;oBAEJ,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;wBACxB,OAAO,CAAC,GAAG,CACT,gBAAM,CAAC,MAAM,CACX,2CAA2C,OAAO,CAAC,WAAW,IAAI;4BAChE,MAAM,CAAC,YAAY,CACtB,CACF,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,IACE,MAAM,CAAC,eAAe,YAAY,0CAAiB;4BACnD,MAAM,CAAC,eAAe,CAAC,YAAY;4BACnC,MAAM,CAAC,eAAe,KAAK,OAAO,EAClC,CAAC;4BACD,IAAI,CAAC,kBAAkB,CACrB,OAAO,CAAC,YAAY,EACpB,MAAM,CAAC,eAAe,CAAC,YAAY,CACpC,CAAC;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,IAAI,8CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACrC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,kBAAkB,CACxB,gBAAkC,EAClC,gBAAkC;QAElC,gBAAgB,CAAC,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC;QAClE,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC5C,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;YACpD,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;QACD,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,aAAa,GAAG,SAAS,CAAC;IAC7C,CAAC;CACF;AAtJD,gCAsJC"}
+{"version":3,"file":"BaseAction.js","sourceRoot":"","sources":["../../src/cli/BaseAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAE7B,0CAAwC;AAExC,gEAMoC;AACpC,oEAA0D;AAC1D,wEAMwC;AACxC,wFAGkD;AAWlD,MAAsB,UAAW,SAAQ,mCAAiB;IAOxD,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACtD,iBAAiB,EAAE,gBAAgB;YACnC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,6EAA6E;gBAC7E,uCAAuC;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACvD,iBAAiB,EAAE,iBAAiB;YACpC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,sEAAsE;gBACtE,yCAAyC;gBACzC,kCAAkC,IAAI,CAAC,UAAU,GAAG;SACvD,CAAC,CAAC;QAEH,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,mBAAmB,CAAC;YACvD,iBAAiB,EAAE,eAAe;YAClC,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,2DAA2D;gBAC3D,oEAAoE;gBACpE,8CAA8C;gBAC9C,wHAAwH;gBACxH,gFAAgF;SACnF,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACtD,iBAAiB,EAAE,WAAW;YAC9B,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,iEAAiE;gBACjE,4DAA4D;SAC/D,CAAC,CAAC;QAEH,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,yBAAyB,CAAC;YACzD,iBAAiB,EAAE,cAAc;YACjC,YAAY,EAAE,SAAS;YACvB,WAAW,EACT,gIAAgI;SACnI,CAAC,CAAC;IACL,CAAC;IAES,aAAa;QACrB,MAAM,QAAQ,GAAa,IAAI,8BAAQ,EAAE,CAAC;QAE1C,MAAM,WAAW,GAAW,IAAI,CAAC,qBAAqB,CAAC,KAAK,IAAI,SAAS,CAAC;QAC1E,IAAI,CAAC,8BAAU,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,WAAW,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,YAAY,GAChB,IAAI,CAAC,sBAAsB,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;QAC9D,8BAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,iBAAiB,GAAY,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAEvE,KAAK,MAAM,QAAQ,IAAI,8BAAU,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAAC;YACnE,IAAI,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;gBACnC,MAAM,YAAY,GAAW,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC9D,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE1C,MAAM,WAAW,GAAG,IAAA,kDAAsB,EACxC,IAAI,CAAC,oBAAoB,CAAC,MAAM,IAAI,EAAE,CACvC,CAAC;QAEF,OAAO;YACL,QAAQ;YACR,WAAW;YACX,YAAY;YACZ,iBAAiB;YACjB,WAAW,EAAE,IAAI,CAAC,qBAAqB,CAAC,KAAK;YAC7C,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,sGAAsG;IACtG,sEAAsE;IACtE,2DAA2D;IACnD,gBAAgB,CAAC,OAAgB,EAAE,QAAkB;QAC3D,IAAI,OAAO,YAAY,uCAAiB,EAAE,CAAC;YACzC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;gBACzB,MAAM,aAAa,GACjB,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;gBAErC,IAAI,aAAa,IAAI,aAAa,CAAC,oBAAoB,EAAE,CAAC;oBACxD,+CAA+C;oBAC/C,MAAM,MAAM,GACV,QAAQ,CAAC,2BAA2B,CAClC,aAAa,CAAC,oBAAoB,EAClC,OAAO,CACR,CAAC;oBAEJ,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;wBACxB,OAAO,CAAC,GAAG,CACT,IAAA,cAAM,EACJ,2CAA2C,OAAO,CAAC,WAAW,IAAI;4BAChE,MAAM,CAAC,YAAY,CACtB,CACF,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,IACE,MAAM,CAAC,eAAe,YAAY,uCAAiB;4BACnD,MAAM,CAAC,eAAe,CAAC,YAAY;4BACnC,MAAM,CAAC,eAAe,KAAK,OAAO,EAClC,CAAC;4BACD,IAAI,CAAC,kBAAkB,CACrB,OAAO,CAAC,YAAY,EACpB,MAAM,CAAC,eAAe,CAAC,YAAY,CACpC,CAAC;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,IAAI,2CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACrC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,kBAAkB,CACxB,gBAAkC,EAClC,gBAAkC;QAElC,gBAAgB,CAAC,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC;QAClE,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC5C,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,gBAAgB,CAAC,UAAU,EAAE,CAAC;YACpD,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;QACD,gBAAgB,CAAC,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAE9D,gBAAgB,CAAC,aAAa,GAAG,SAAS,CAAC;IAC7C,CAAC;CACF;AApKD,gCAoKC"}

package/dist/cli/MarkdownAction.d.ts

@@ -19,6 +19,5 @@ import { BaseAction } from './BaseAction';
 export declare class MarkdownAction extends BaseAction {
     private _sortFunctions;
     constructor(parser: ApiDocumenterCommandLine);
-    protected onDefineParameters(): void;
-    protected onExecute(): Promise<void>;
+    protected onExecuteAsync(): Promise<void>;
 }

package/dist/cli/MarkdownAction.js

@@ -28,9 +28,6 @@ class MarkdownAction extends BaseAction_1.BaseAction {
             documentation: 'Generates API documentation as a collection of files in' +
                 ' Markdown format, suitable for example for publishing on a GitHub site.'
         });
-    }
-    onDefineParameters() {
-        super.onDefineParameters();
         this._sortFunctions = this.defineStringParameter({
             parameterLongName: '--sort-functions',
             argumentName: 'PRIORITY_PARAMS',
@@ -39,10 +36,10 @@ class MarkdownAction extends BaseAction_1.BaseAction {
                 `ordered first. Alphabetical otherwise.`
         });
     }
-    onExecute() {
+    onExecuteAsync() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // override
-            const { apiModel, outputFolder, addFileNameSuffix, projectName } = this.buildApiModel();
+            const { apiModel, outputFolder, addFileNameSuffix, projectName, subpackages } = this.buildApiModel();
             const sortFunctions = this._sortFunctions.value || '';
             if (!projectName) {
                 throw new Error('No project name provided. Use --project.');
@@ -53,7 +50,8 @@ class MarkdownAction extends BaseAction_1.BaseAction {
                 outputFolder,
                 addFileNameSuffix,
                 projectName,
-                sortFunctions
+                sortFunctions,
+                subpackages
             });
             markdownDocumenter.generateFiles();
         });

package/dist/cli/MarkdownAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"MarkdownAction.js","sourceRoot":"","sources":["../../src/cli/MarkdownAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAMH,6CAA0C;AAC1C,0EAAuE;AAGvE,MAAa,cAAe,SAAQ,uBAAU;IAE5C,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,UAAU;YACtB,OAAO,EAAE,iDAAiD;YAC1D,aAAa,EACX,yDAAyD;gBACzD,yEAAyE;SAC5E,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAE3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC;YAC/C,iBAAiB,EAAE,kBAAkB;YACrC,YAAY,EAAE,iBAAiB;YAC/B,WAAW,EACT,0DAA0D;gBAC1D,6DAA6D;gBAC7D,wCAAwC;SAC3C,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,aAAa,GAAW,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;YAE9D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,kBAAkB,GAAuB,IAAI,uCAAkB,CAAC;gBACpE,QAAQ;gBACR,gBAAgB,EAAE,SAAS;gBAC3B,YAAY;gBACZ,iBAAiB;gBACjB,WAAW;gBACX,aAAa;aACd,CAAC,CAAC;YACH,kBAAkB,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;KAAA;CACF;AA7CD,wCA6CC"}
+{"version":3,"file":"MarkdownAction.js","sourceRoot":"","sources":["../../src/cli/MarkdownAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAMH,6CAA0C;AAC1C,0EAAuE;AAGvE,MAAa,cAAe,SAAQ,uBAAU;IAE5C,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,UAAU;YACtB,OAAO,EAAE,iDAAiD;YAC1D,aAAa,EACX,yDAAyD;gBACzD,yEAAyE;SAC5E,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC;YAC/C,iBAAiB,EAAE,kBAAkB;YACrC,YAAY,EAAE,iBAAiB;YAC/B,WAAW,EACT,0DAA0D;gBAC1D,6DAA6D;gBAC7D,wCAAwC;SAC3C,CAAC,CAAC;IACL,CAAC;IAEe,cAAc;;YAC5B,WAAW;YACX,MAAM,EACJ,QAAQ,EACR,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,WAAW,EACZ,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACzB,MAAM,aAAa,GAAW,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;YAE9D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,kBAAkB,GAAuB,IAAI,uCAAkB,CAAC;gBACpE,QAAQ;gBACR,gBAAgB,EAAE,SAAS;gBAC3B,YAAY;gBACZ,iBAAiB;gBACjB,WAAW;gBACX,aAAa;gBACb,WAAW;aACZ,CAAC,CAAC;YACH,kBAAkB,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;KAAA;CACF;AA/CD,wCA+CC"}

package/dist/cli/TocAction.d.ts

@@ -20,6 +20,5 @@ export declare class TocAction extends BaseAction {
     private _g3PathParameter;
     private _jsSDKParameter;
     constructor(parser: ApiDocumenterCommandLine);
-    protected onDefineParameters(): void;
-    protected onExecute(): Promise<void>;
+    protected onExecuteAsync(): Promise<void>;
 }

package/dist/cli/TocAction.js

@@ -27,9 +27,6 @@ class TocAction extends BaseAction_1.BaseAction {
             summary: 'Generate TOC(table of content) for Firebase devsite.',
             documentation: 'Generate TOC(table of content) for Firebase devsite.'
         });
-    }
-    onDefineParameters() {
-        super.onDefineParameters();
         this._g3PathParameter = this.defineStringParameter({
             parameterLongName: '--host-path',
             parameterShortName: '-p',
@@ -44,10 +41,10 @@ class TocAction extends BaseAction_1.BaseAction {
                 `It will create an artificial top level toc item "firebase".`
         });
     }
-    onExecute() {
+    onExecuteAsync() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // override
-            const { apiModel, outputFolder, addFileNameSuffix } = this.buildApiModel();
+            const { apiModel, outputFolder, addFileNameSuffix, subpackages } = this.buildApiModel();
             const g3Path = this._g3PathParameter.value;
             const jsSdk = this._jsSDKParameter.value;
             if (!g3Path) {
@@ -58,7 +55,8 @@ class TocAction extends BaseAction_1.BaseAction {
                 outputFolder,
                 addFileNameSuffix,
                 g3Path,
-                jsSdk
+                jsSdk,
+                subpackages
             });
         });
     }

package/dist/cli/TocAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"TocAction.js","sourceRoot":"","sources":["../../src/cli/TocAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAOH,6CAA0C;AAC1C,gCAAqC;AAErC,MAAa,SAAU,SAAQ,uBAAU;IAGvC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,sDAAsD;YAC/D,aAAa,EAAE,sDAAsD;SACtE,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAE3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACjD,iBAAiB,EAAE,aAAa;YAChC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,UAAU;YACxB,WAAW,EAAE;kDAC+B;SAC7C,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC9C,iBAAiB,EAAE,UAAU;YAC7B,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,yCAAyC;gBACzC,6DAA6D;SAChE,CAAC,CAAC;IACL,CAAC;IAEe,SAAS;;YACvB,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAuB,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAC/D,MAAM,KAAK,GAAY,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;YAElD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;YACJ,CAAC;YAED,IAAA,iBAAW,EAAC;gBACV,QAAQ;gBACR,YAAY;gBACZ,iBAAiB;gBACjB,MAAM;gBACN,KAAK;aACN,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAnDD,8BAmDC"}
+{"version":3,"file":"TocAction.js","sourceRoot":"","sources":["../../src/cli/TocAction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAOH,6CAA0C;AAC1C,gCAAqC;AAErC,MAAa,SAAU,SAAQ,uBAAU;IAGvC,YAAmB,MAAgC;QACjD,KAAK,CAAC;YACJ,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,sDAAsD;YAC/D,aAAa,EAAE,sDAAsD;SACtE,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACjD,iBAAiB,EAAE,aAAa;YAChC,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,UAAU;YACxB,WAAW,EAAE;kDAC+B;SAC7C,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC9C,iBAAiB,EAAE,UAAU;YAC7B,kBAAkB,EAAE,IAAI;YACxB,WAAW,EACT,yCAAyC;gBACzC,6DAA6D;SAChE,CAAC,CAAC;IACL,CAAC;IAEe,cAAc;;YAC5B,WAAW;YACX,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAC9D,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,MAAM,GAAuB,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAC/D,MAAM,KAAK,GAAY,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;YAElD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;YACJ,CAAC;YAED,IAAA,iBAAW,EAAC;gBACV,QAAQ;gBACR,YAAY;gBACZ,iBAAiB;gBACjB,MAAM;gBACN,KAAK;gBACL,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAjDD,8BAiDC"}

package/dist/documenters/MarkdownDocumenter.d.ts

@@ -15,8 +15,9 @@
  * limitations under the License.
  */
 import { DocNode } from '@microsoft/tsdoc';
-import { ApiModel, ApiItem } from 'api-extractor-model-me';
+import { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
 import { DocumenterConfig } from './DocumenterConfig';
+import { ISubpackageInfo } from './MarkdownDocumenterHelpers';
 export interface IMarkdownDocumenterOptions {
     apiModel: ApiModel;
     documenterConfig: DocumenterConfig | undefined;
@@ -24,6 +25,7 @@ export interface IMarkdownDocumenterOptions {
     addFileNameSuffix: boolean;
     projectName: string;
     sortFunctions: string;
+    subpackages?: Map<string, ISubpackageInfo>;
 }
 /**
  * Renders API documentation in the Markdown file format.
@@ -39,8 +41,11 @@ export declare class MarkdownDocumenter {
     private readonly _addFileNameSuffix;
     private readonly _projectName;
     private readonly _sortFunctions;
+    private readonly _subpackages?;
     constructor(options: IMarkdownDocumenterOptions);
     generateFiles(): void;
+    private _createTitleCell;
+    private _createEntryPointTitleCell;
     _writeApiItemPage(apiItem: ApiItem): void;
     _functionHeadingLevel(): number;
     _createCompleteOutputForApiItem(apiItem: ApiItem): DocNode[];
@@ -64,7 +69,7 @@ export declare class MarkdownDocumenter {
      * GENERATE PAGE: MODEL
      */
     private _createModelTable;
-    /**´
+    /**
      * Generate a table of entry points if there are more than one entry points.
      * Otherwise, generate the entry point directly in the package page.
      */