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

package/dist/plugin/PluginFeature.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @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.
+ */
+/**
+ * This is an internal part of the plugin infrastructure.
+ *
+ * @remarks
+ * This object is the constructor parameter for API Documenter plugin features.
+ *
+ * @public
+ */
+export declare class PluginFeatureInitialization {
+    /** @internal */
+    _context: PluginFeatureContext;
+    /** @internal */
+    constructor();
+}
+/**
+ * Context object for {@link PluginFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+export declare class PluginFeatureContext {
+}
+/**
+ * The abstract base class for all API Documenter plugin features.
+ * @public
+ */
+export declare abstract class PluginFeature {
+    /**
+     * Exposes various services that can be used by a plugin.
+     */
+    context: PluginFeatureContext;
+    /**
+     * 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: PluginFeatureInitialization);
+    /**
+     * This event function is called after the feature is initialized, but before any processing occurs.
+     * @virtual
+     */
+    onInitialized(): void;
+    static [Symbol.hasInstance](instance: object): boolean;
+}

package/dist/plugin/PluginFeature.js

@@ -0,0 +1,76 @@
+"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.PluginFeature = exports.PluginFeatureContext = exports.PluginFeatureInitialization = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const node_core_library_1 = require("@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
+ */
+class PluginFeatureInitialization {
+    /** @internal */
+    constructor() {
+        // reserved for future use
+    }
+}
+exports.PluginFeatureInitialization = PluginFeatureInitialization;
+/**
+ * Context object for {@link PluginFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+class PluginFeatureContext {
+}
+exports.PluginFeatureContext = PluginFeatureContext;
+const uuidPluginFeature = '56876472-7134-4812-819e-533de0ee10e6';
+/**
+ * The abstract base class for all API Documenter plugin features.
+ * @public
+ */
+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 node_core_library_1.TypeUuid.isInstanceOf(instance, uuidPluginFeature);
+    }
+}
+exports.PluginFeature = PluginFeature;
+node_core_library_1.TypeUuid.registerClass(PluginFeature, uuidPluginFeature);
+//# sourceMappingURL=PluginFeature.js.map

package/dist/plugin/PluginFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginFeature.js","sourceRoot":"","sources":["../../src/plugin/PluginFeature.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,oEAAwD;AAExD;;;;;;;GAOG;AACH,MAAa,2BAA2B;IAItC,gBAAgB;IAChB;QACE,0BAA0B;IAC5B,CAAC;CACF;AARD,kEAQC;AAED;;;;;GAKG;AACH,MAAa,oBAAoB;CAAG;AAApC,oDAAoC;AAEpC,MAAM,iBAAiB,GAAW,sCAAsC,CAAC;AAEzE;;;GAGG;AACH,MAAsB,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,4BAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAC5D,CAAC;CACF;AA5BD,sCA4BC;AAED,4BAAQ,CAAC,aAAa,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC"}

package/dist/plugin/PluginLoader.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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 { MarkdownDocumenterFeature, MarkdownDocumenterFeatureContext } from './MarkdownDocumenterFeature';
+import { DocumenterConfig } from '../documenters/DocumenterConfig';
+export declare class PluginLoader {
+    markdownDocumenterFeature: MarkdownDocumenterFeature | undefined;
+    load(documenterConfig: DocumenterConfig, createContext: () => MarkdownDocumenterFeatureContext): void;
+}

package/dist/plugin/PluginLoader.js

@@ -0,0 +1,100 @@
+"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.PluginLoader = void 0;
+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 resolve = tslib_1.__importStar(require("resolve"));
+const MarkdownDocumenterFeature_1 = require("./MarkdownDocumenterFeature");
+const PluginFeature_1 = require("./PluginFeature");
+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 PluginFeature_1.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_1.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);
+            }
+        }
+    }
+}
+exports.PluginLoader = PluginLoader;
+//# sourceMappingURL=PluginLoader.js.map

package/dist/plugin/PluginLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAC7B,yDAAmC;AAMnC,2EAGqC;AACrC,mDAA8D;AAQ9D,MAAa,YAAY;IAGhB,IAAI,CACT,gBAAkC,EAClC,aAAqD;QAErD,MAAM,gBAAgB,GAAW,IAAI,CAAC,OAAO,CAC3C,gBAAgB,CAAC,cAAc,CAChC,CAAC;QACF,KAAK,MAAM,YAAY,IAAI,gBAAgB,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE;YACpE,IAAI;gBACF,iEAAiE;gBACjE,MAAM,sBAAsB,GAAW,OAAO,CAAC,IAAI,CACjD,YAAY,CAAC,WAAW,EACxB;oBACE,OAAO,EAAE,gBAAgB;iBAC1B,CACF,CAAC;gBAEF,mBAAmB;gBACnB,MAAM,UAAU,GAEA,OAAO,CAAC,sBAAsB,CAAC,CAAC;gBAEhD,IAAI,CAAC,UAAU,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;iBACxC;gBAED,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE;oBAC3C,MAAM,IAAI,KAAK,CACb,8CAA8C;wBAC5C,yDAAyD,CAC5D,CAAC;iBACH;gBAED,MAAM,QAAQ,GACZ,UAAU,CAAC,2BAA2B,CAAC;gBAEzC,IAAI,QAAQ,CAAC,eAAe,KAAK,IAAI,EAAE;oBACrC,MAAM,IAAI,KAAK,CACb,mEAAmE;wBACjE,8BAA8B,CACjC,CAAC;iBACH;gBAED,MAAM,YAAY,GAAkB;oBAClC,WAAW,EAAE,YAAY,CAAC,WAAW;oBACrC,QAAQ;iBACT,CAAC;gBAEF,MAAM,wBAAwB,GAG1B,IAAI,GAAG,EAA8B,CAAC;gBAC1C,KAAK,MAAM,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,EAAE;oBACjD,wBAAwB,CAAC,GAAG,CAC1B,iBAAiB,CAAC,WAAW,EAC7B,iBAAiB,CAClB,CAAC;iBACH;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,mBAAmB,EAAE;oBAC1D,MAAM,iBAAiB,GAEP,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAC1D,IAAI,CAAC,iBAAiB,EAAE;wBACtB,MAAM,IAAI,KAAK,CACb,cAAc,YAAY,CAAC,WAAW,uCAAuC,WAAW,GAAG,CAC5F,CAAC;qBACH;oBAED,IAAI,iBAAiB,CAAC,IAAI,KAAK,2BAA2B,EAAE;wBAC1D,IAAI,IAAI,CAAC,yBAAyB,EAAE;4BAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;yBAClE;wBAED,MAAM,cAAc,GAAgC,IAAI,2CAA2B,EAAE,CAAC;wBACtF,cAAc,CAAC,QAAQ,GAAG,aAAa,EAAE,CAAC;wBAE1C,IAAI,yBAAyB,GAEb,SAAS,CAAC;wBAC1B,IAAI;4BACF,yBAAyB,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CACxD,cAAc,CACf,CAAC;yBACH;wBAAC,OAAO,CAAC,EAAE;4BACV,MAAM,IAAI,KAAK,CACb,yCAAyC,GAAG,CAAC,CAAC,QAAQ,EAAE,CACzD,CAAC;yBACH;wBACD,IACE,CAAC,CAAC,yBAAyB,YAAY,qDAAyB,CAAC,EACjE;4BACA,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;yBACH;wBAED,IAAI;4BACF,yBAAyB,CAAC,aAAa,EAAE,CAAC;yBAC3C;wBAAC,OAAO,CAAC,EAAE;4BACV,MAAM,IAAI,KAAK,CACb,mDAAmD;gCACjD,CAAC,CAAC,QAAQ,EAAE,CACf,CAAC;yBACH;wBAED,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;qBAC5D;yBAAM;wBACL,MAAM,IAAI,KAAK,CACb,qCAAqC,iBAAiB,CAAC,IAAI,GAAG,CAC/D,CAAC;qBACH;iBACF;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,KAAK,CACb,wBAAwB,YAAY,CAAC,WAAW,IAAI,GAAG,CAAC,CAAC,OAAO,CACjE,CAAC;aACH;SACF;IACH,CAAC;CACF;AA3HD,oCA2HC"}

package/dist/schemas/api-documenter-template.json

@@ -0,0 +1,92 @@
+/**
+ * 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"
+  }
+}

package/dist/schemas/api-documenter.schema.json

@@ -0,0 +1,42 @@
+{
+  "title": "API Documenter Configuration",
+  "description": "Describes how the API Documenter tool will process a project.",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "description": "Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.",
+      "type": "string"
+    },
+
+    "outputTarget": {
+      "description": "Specifies what type of documentation will be generated",
+      "type": "string",
+      "enum": ["docfx", "markdown"]
+    },
+
+    "newlineKind": {
+      "description": "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\".",
+      "type": "string",
+      "enum": ["crlf", "lf", "os"],
+      "default": "crlf"
+    },
+
+    "newDocfxNamespaces": {
+      "description": "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.",
+      "type": "boolean"
+    },
+
+    "plugins": {
+      "description": "Specifies plugin packages to be loaded",
+      "type": "array"
+    },
+
+    "tableOfContents": {
+      "description": "Configures how the table of contents is generated.",
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+
+  "additionalProperties": false
+}

package/dist/start.d.ts

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+/**
+ * @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.
+ */
+export {};

package/dist/start.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+"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 });
+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 os = tslib_1.__importStar(require("os"));
+const colors_1 = tslib_1.__importDefault(require("colors"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const ApiDocumenterCommandLine_1 = require("./cli/ApiDocumenterCommandLine");
+const myPackageVersion = node_core_library_1.PackageJsonLookup.loadOwnPackageJson(__dirname)
+    .version;
+console.log(os.EOL + colors_1.default.bold(`@firebase/api-documenter ${myPackageVersion} ` + os.EOL));
+const parser = new ApiDocumenterCommandLine_1.ApiDocumenterCommandLine();
+parser.execute().catch(console.error); // CommandLineParser.execute() should never reject the promise
+//# sourceMappingURL=start.js.map

package/dist/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,+CAAyB;AACzB,4DAA4B;AAE5B,oEAAiE;AAEjE,6EAA0E;AAE1E,MAAM,gBAAgB,GAAW,qCAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC;KAC7E,OAAO,CAAC;AAEX,OAAO,CAAC,GAAG,CACT,EAAE,CAAC,GAAG,GAAG,gBAAM,CAAC,IAAI,CAAC,4BAA4B,gBAAgB,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,CAC/E,CAAC;AAEF,MAAM,MAAM,GAA6B,IAAI,mDAAwB,EAAE,CAAC;AAExE,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,8DAA8D"}

package/dist/toc.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2021 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 { ApiModel } from 'api-extractor-model-me';
+export interface ITocGenerationOptions {
+    apiModel: ApiModel;
+    g3Path: string;
+    outputFolder: string;
+    addFileNameSuffix: boolean;
+    jsSdk: boolean;
+}
+export declare function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk }: ITocGenerationOptions): void;

package/dist/toc.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2021 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.generateToc = void 0;
+const tslib_1 = require("tslib");
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const MarkdownDocumenterHelpers_1 = require("./documenters/MarkdownDocumenterHelpers");
+const fs_1 = require("fs");
+const path_1 = require("path");
+function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk }) {
+    const toc = [];
+    if (jsSdk) {
+        const firebaseToc = {
+            title: 'firebase',
+            path: `${g3Path}/index`,
+            section: []
+        };
+        toc.push(firebaseToc);
+    }
+    generateTocRecursively(apiModel, g3Path, addFileNameSuffix, toc);
+    fs_1.writeFileSync(path_1.resolve(outputFolder, 'toc.yaml'), js_yaml_1.default.dump({ toc }, {
+        quotingType: '"'
+    }));
+}
+exports.generateToc = generateToc;
+function generateTocRecursively(apiItem, g3Path, addFileNameSuffix, toc) {
+    // generate toc item only for entry points
+    if (apiItem.kind === "EntryPoint" /* EntryPoint */) {
+        // Entry point
+        const entryPointName = apiItem.canonicalReference
+            .source.escapedPath.replace('@firebase/', '');
+        const entryPointToc = {
+            title: entryPointName,
+            path: `${g3Path}/${MarkdownDocumenterHelpers_1.getFilenameForApiItem(apiItem, addFileNameSuffix)}`,
+            section: []
+        };
+        toc.push(entryPointToc);
+    }
+    else {
+        // travel the api tree to find the next entry point
+        for (const member of apiItem.members) {
+            generateTocRecursively(member, g3Path, addFileNameSuffix, toc);
+        }
+    }
+}
+//# sourceMappingURL=toc.js.map

package/dist/toc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toc.js","sourceRoot":"","sources":["../src/toc.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,8DAA2B;AAE3B,uFAAgF;AAEhF,2BAAmC;AACnC,+BAA+B;AAgB/B,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,KAAK,EACiB;IACtB,MAAM,GAAG,GAAG,EAAE,CAAC;IAEf,IAAI,KAAK,EAAE;QACT,MAAM,WAAW,GAAa;YAC5B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,GAAG,MAAM,QAAQ;YACvB,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACvB;IAED,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAEjE,kBAAa,CACX,cAAO,CAAC,YAAY,EAAE,UAAU,CAAC,EACjC,iBAAI,CAAC,IAAI,CACP,EAAE,GAAG,EAAE,EACP;QACE,WAAW,EAAE,GAAG;KACjB,CACF,CACF,CAAC;AACJ,CAAC;AA7BD,kCA6BC;AAED,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,MAAc,EACd,iBAA0B,EAC1B,GAAe;IAEf,0CAA0C;IAC1C,IAAI,OAAO,CAAC,IAAI,kCAA2B,EAAE;QAC3C,cAAc;QACd,MAAM,cAAc,GAAI,OAAO,CAAC,kBAAkB;aAC/C,MAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAClE,MAAM,aAAa,GAAa;YAC9B,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,GAAG,MAAM,IAAI,iDAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE;YACtE,OAAO,EAAE,EAAE;SACZ,CAAC;QAEF,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACzB;SAAM;QACL,mDAAmD;QACnD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;YACpC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;SAChE;KACF;AACH,CAAC"}

package/dist/utils/IndentedWriter.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @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 { IStringBuilder } from '@rushstack/node-core-library';
+/**
+ * A utility for writing indented text.
+ *
+ * @remarks
+ *
+ * Note that the indentation is inserted at the last possible opportunity.
+ * For example, this code...
+ *
+ * ```ts
+ *   writer.write('begin\n');
+ *   writer.increaseIndent();
+ *   writer.write('one\ntwo\n');
+ *   writer.decreaseIndent();
+ *   writer.increaseIndent();
+ *   writer.decreaseIndent();
+ *   writer.write('end');
+ * ```
+ *
+ * ...would produce this output:
+ *
+ * ```
+ *   begin
+ *     one
+ *     two
+ *   end
+ * ```
+ */
+export declare class IndentedWriter {
+    /**
+     * The text characters used to create one level of indentation.
+     * Two spaces by default.
+     */
+    defaultIndentPrefix: string;
+    private readonly _builder;
+    private _latestChunk;
+    private _previousChunk;
+    private _atStartOfLine;
+    private readonly _indentStack;
+    private _indentText;
+    constructor(builder?: IStringBuilder);
+    /**
+     * Retrieves the output that was built so far.
+     */
+    getText(): string;
+    toString(): string;
+    /**
+     * Increases the indentation.  Normally the indentation is two spaces,
+     * however an arbitrary prefix can optional be specified.  (For example,
+     * the prefix could be "// " to indent and comment simultaneously.)
+     * Each call to IndentedWriter.increaseIndent() must be followed by a
+     * corresponding call to IndentedWriter.decreaseIndent().
+     */
+    increaseIndent(indentPrefix?: string): void;
+    /**
+     * Decreases the indentation, reverting the effect of the corresponding call
+     * to IndentedWriter.increaseIndent().
+     */
+    decreaseIndent(): void;
+    /**
+     * A shorthand for ensuring that increaseIndent()/decreaseIndent() occur
+     * in pairs.
+     */
+    indentScope(scope: () => void, indentPrefix?: string): void;
+    /**
+     * Adds a newline if the file pointer is not already at the start of the line (or start of the stream).
+     */
+    ensureNewLine(): void;
+    /**
+     * Adds up to two newlines to ensure that there is a blank line above the current line.
+     */
+    ensureSkippedLine(): void;
+    /**
+     * Returns the last character that was written, or an empty string if no characters have been written yet.
+     */
+    peekLastCharacter(): string;
+    /**
+     * Returns the second to last character that was written, or an empty string if less than one characters
+     * have been written yet.
+     */
+    peekSecondLastCharacter(): string;
+    /**
+     * Writes some text to the internal string buffer, applying indentation according
+     * to the current indentation level.  If the string contains multiple newlines,
+     * each line will be indented separately.
+     */
+    write(message: string): void;
+    /**
+     * A shorthand for writing an optional message, followed by a newline.
+     * Indentation is applied following the semantics of IndentedWriter.write().
+     */
+    writeLine(message?: string): void;
+    /**
+     * Writes a string that does not contain any newline characters.
+     */
+    private _writeLinePart;
+    private _writeNewLine;
+    private _write;
+    private _updateIndentText;
+}