@microsoft/api-extractor 7.56.3 → 7.57.0

package/lib-esm/api/CompilerState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompilerState.js","sourceRoot":"","sources":["../../src/api/CompilerState.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAiBpD;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAMxB,YAAoB,UAAyB;QAC3C,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAClB,eAAgC,EAChC,OAAqC;QAErC,IAAI,QAAQ,GAAmB,eAAe,CAAC,gBAAgB,CAAC;QAChE,IAAI,cAAc,GAAW,eAAe,CAAC,aAAa,CAAC;QAC3D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,kDAAkD;YAClD,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAC3D,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,WAAW,GAAyB,EAAE,CAAC,0BAA0B,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAE1G,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,IAAI,eAAe,CAAC,YAAY,EAAE,CAAC;YACtE,WAAW,CAAC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;YACxC,OAAO,CAAC,GAAG,CACT,QAAQ,CAAC,IAAI,CACX,qFAAqF;gBACnF,0BAA0B,CAC7B,CACF,CAAC;QACJ,CAAC;QAED,uFAAuF;QACvF,sFAAsF;QACtF,oFAAoF;QACpF,yFAAyF;QACzF,wFAAwF;QACxF,qFAAqF;QACrF,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,OAAO,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC;QAE1C,MAAM,cAAc,GAAa,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;QACtG,IAAI,OAAO,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAC7C,cAAc,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACxD,CAAC;QAED,6EAA6E;QAC7E,MAAM,iBAAiB,GAAa,aAAa,CAAC,6BAA6B,CAAC,cAAc,CAAC,CAAC;QAEhG,MAAM,YAAY,GAAoB,aAAa,CAAC,mBAAmB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE9F,MAAM,OAAO,GAAe,EAAE,CAAC,aAAa,CAAC,iBAAiB,EAAE,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAEnG,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,SAAS,GAAW,EAAE,CAAC,4BAA4B,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACnG,MAAM,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,IAAI,aAAa,CAAC;YACvB,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,MAAM,CAAC,6BAA6B,CAAC,cAAwB;QACnE,MAAM,iBAAiB,GAAa,EAAE,CAAC;QAEvC,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAU,CAAC;QAEjD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,MAAM,gBAAgB,GAAW,aAAa,CAAC,WAAW,EAAE,CAAC;YAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACrC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;gBAEhC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;oBACpC,MAAM,IAAI,KAAK,CAAC,sCAAsC,GAAG,aAAa,CAAC,CAAC;gBAC1E,CAAC;gBAED,IAAI,eAAe,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;oBACvD,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAChC,WAAiC,EACjC,OAA4C;QAE5C,sDAAsD;QACtD,MAAM,YAAY,GAAoB,EAAE,CAAC,kBAAkB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjF,6FAA6F;QAC7F,wFAAwF;QACxF,MAAM,mBAAmB,GAAoB,EAAE,GAAG,YAAY,EAAE,CAAC;QAEjE,IAAI,OAAO,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;YAChD,8BAA8B;YAC9B,MAAM,2BAA2B,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;YAC/F,YAAY,CAAC,qBAAqB,GAAG,GAAG,EAAE,CAAC,2BAA2B,CAAC;QACzE,CAAC;QAED,oCAAoC;QACpC,8CAA8C;QAC9C,MAAM,cAAc,GAAyB,IAAI,GAAG,EAAmB,CAAC;QAExE,oCAAoC;QACpC,oCAAoC;QACpC,MAAM,mBAAmB,GAAW,uBAAuB,CAAC;QAE5D,YAAY,CAAC,UAAU,GAAG,CAAC,QAAgB,EAAW,EAAE;YACtD,wFAAwF;YACxF,6FAA6F;YAC7F,gGAAgG;YAChG,2FAA2F;YAC3F,4BAA4B;YAE5B,2FAA2F;YAC3F,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnD,yEAAyE;gBACzE,MAAM,KAAK,GAA2B,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzE,IAAI,KAAK,EAAE,CAAC;oBACV,iCAAiC;oBACjC,MAAM,oBAAoB,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC9C,iBAAiB;oBACjB,MAAM,aAAa,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;oBAEvC,QAAQ,aAAa,CAAC,iBAAiB,EAAE,EAAE,CAAC;wBAC1C,KAAK,KAAK,CAAC;wBACX,KAAK,MAAM,CAAC;wBACZ,KAAK,KAAK,CAAC;wBACX,KAAK,MAAM;4BACT,gGAAgG;4BAChG,MAAM,WAAW,GAAW,GAAG,oBAAoB,OAAO,CAAC;4BAE3D,IAAI,aAAa,GAAwB,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;4BACzE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gCAChC,aAAa,GAAG,mBAAmB,CAAC,UAAW,CAAC,WAAW,CAAC,CAAC;gCAC7D,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;4BACjD,CAAC;4BAED,IAAI,aAAa,EAAE,CAAC;gCAClB,6EAA6E;gCAC7E,6FAA6F;gCAC7F,OAAO,KAAK,CAAC;4BACf,CAAC;4BACD,MAAM;oBACV,CAAC;gBACH,CAAC;YACH,CAAC;YAED,6CAA6C;YAC7C,OAAO,mBAAmB,CAAC,UAAW,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,OAAO,YAAY,CAAC;IACtB,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 ts from 'typescript';\n\nimport { JsonFile } from '@rushstack/node-core-library';\nimport { Colorize } from '@rushstack/terminal';\n\nimport { ExtractorConfig } from './ExtractorConfig';\nimport type { IExtractorInvokeOptions } from './Extractor';\n\n/**\n * Options for {@link CompilerState.create}\n * @public\n */\nexport interface ICompilerStateCreateOptions {\n  /** {@inheritDoc IExtractorInvokeOptions.typescriptCompilerFolder} */\n  typescriptCompilerFolder?: string;\n\n  /**\n   * Additional .d.ts files to include in the analysis.\n   */\n  additionalEntryPoints?: string[];\n}\n\n/**\n * This class represents the TypeScript compiler state.  This allows an optimization where multiple invocations\n * of API Extractor can reuse the same TypeScript compiler analysis.\n *\n * @public\n */\nexport class CompilerState {\n  /**\n   * The TypeScript compiler's `Program` object, which represents a complete scope of analysis.\n   */\n  public readonly program: unknown;\n\n  private constructor(properties: CompilerState) {\n    this.program = properties.program;\n  }\n\n  /**\n   * Create a compiler state for use with the specified `IExtractorInvokeOptions`.\n   */\n  public static create(\n    extractorConfig: ExtractorConfig,\n    options?: ICompilerStateCreateOptions\n  ): CompilerState {\n    let tsconfig: {} | undefined = extractorConfig.overrideTsconfig;\n    let configBasePath: string = extractorConfig.projectFolder;\n    if (!tsconfig) {\n      // If it wasn't overridden, then load it from disk\n      tsconfig = JsonFile.load(extractorConfig.tsconfigFilePath);\n      configBasePath = path.resolve(path.dirname(extractorConfig.tsconfigFilePath));\n    }\n\n    const commandLine: ts.ParsedCommandLine = ts.parseJsonConfigFileContent(tsconfig, ts.sys, configBasePath);\n\n    if (!commandLine.options.skipLibCheck && extractorConfig.skipLibCheck) {\n      commandLine.options.skipLibCheck = true;\n      console.log(\n        Colorize.cyan(\n          'API Extractor was invoked with skipLibCheck. This is not recommended and may cause ' +\n            'incorrect type analysis.'\n        )\n      );\n    }\n\n    // Delete outDir and declarationDir to prevent TypeScript from redirecting self-package\n    // imports to source files. When these options are set, TypeScript's module resolution\n    // tries to map output .d.ts files back to their source .ts files to avoid analyzing\n    // build outputs during compilation. However, API Extractor specifically wants to analyze\n    // the .d.ts build artifacts, not the source files. Since API Extractor doesn't emit any\n    // files, these options are unnecessary and interfere with correct module resolution.\n    delete commandLine.options.outDir;\n    delete commandLine.options.declarationDir;\n\n    const inputFilePaths: string[] = commandLine.fileNames.concat(extractorConfig.mainEntryPointFilePath);\n    if (options && options.additionalEntryPoints) {\n      inputFilePaths.push(...options.additionalEntryPoints);\n    }\n\n    // Append the entry points and remove any non-declaration files from the list\n    const analysisFilePaths: string[] = CompilerState._generateFilePathsForAnalysis(inputFilePaths);\n\n    const compilerHost: ts.CompilerHost = CompilerState._createCompilerHost(commandLine, options);\n\n    const program: ts.Program = ts.createProgram(analysisFilePaths, commandLine.options, compilerHost);\n\n    if (commandLine.errors.length > 0) {\n      const errorText: string = ts.flattenDiagnosticMessageText(commandLine.errors[0].messageText, '\\n');\n      throw new Error(`Error parsing tsconfig.json content: ${errorText}`);\n    }\n\n    return new CompilerState({\n      program\n    });\n  }\n\n  /**\n   * Given a list of absolute file paths, return a list containing only the declaration\n   * files.  Duplicates are also eliminated.\n   *\n   * @remarks\n   * The tsconfig.json settings specify the compiler's input (a set of *.ts source files,\n   * plus some *.d.ts declaration files used for legacy typings).  However API Extractor\n   * analyzes the compiler's output (a set of *.d.ts entry point files, plus any legacy\n   * typings).  This requires API Extractor to generate a special file list when it invokes\n   * the compiler.\n   *\n   * Duplicates are removed so that entry points can be appended without worrying whether they\n   * may already appear in the tsconfig.json file list.\n   */\n  private static _generateFilePathsForAnalysis(inputFilePaths: string[]): string[] {\n    const analysisFilePaths: string[] = [];\n\n    const seenFiles: Set<string> = new Set<string>();\n\n    for (const inputFilePath of inputFilePaths) {\n      const inputFileToUpper: string = inputFilePath.toUpperCase();\n      if (!seenFiles.has(inputFileToUpper)) {\n        seenFiles.add(inputFileToUpper);\n\n        if (!path.isAbsolute(inputFilePath)) {\n          throw new Error('Input file is not an absolute path: ' + inputFilePath);\n        }\n\n        if (ExtractorConfig.hasDtsFileExtension(inputFilePath)) {\n          analysisFilePaths.push(inputFilePath);\n        }\n      }\n    }\n\n    return analysisFilePaths;\n  }\n\n  private static _createCompilerHost(\n    commandLine: ts.ParsedCommandLine,\n    options: IExtractorInvokeOptions | undefined\n  ): ts.CompilerHost {\n    // Create a default CompilerHost that we will override\n    const compilerHost: ts.CompilerHost = ts.createCompilerHost(commandLine.options);\n\n    // Save a copy of the original members.  Note that \"compilerHost\" cannot be the copy, because\n    // createCompilerHost() captures that instance in a closure that is used by the members.\n    const defaultCompilerHost: ts.CompilerHost = { ...compilerHost };\n\n    if (options && options.typescriptCompilerFolder) {\n      // Prevent a closure parameter\n      const typescriptCompilerLibFolder: string = path.join(options.typescriptCompilerFolder, 'lib');\n      compilerHost.getDefaultLibLocation = () => typescriptCompilerLibFolder;\n    }\n\n    // Used by compilerHost.fileExists()\n    // .d.ts file path --> whether the file exists\n    const dtsExistsCache: Map<string, boolean> = new Map<string, boolean>();\n\n    // Used by compilerHost.fileExists()\n    // Example: \"c:/folder/file.part.ts\"\n    const fileExtensionRegExp: RegExp = /^(.+)(\\.[a-z0-9_]+)$/i;\n\n    compilerHost.fileExists = (fileName: string): boolean => {\n      // In certain deprecated setups, the compiler may write its output files (.js and .d.ts)\n      // in the same folder as the corresponding input file (.ts or .tsx).  When following imports,\n      // API Extractor wants to analyze the .d.ts file; however recent versions of the compiler engine\n      // will instead choose the .ts file.  To work around this, we hook fileExists() to hide the\n      // existence of those files.\n\n      // Is \"fileName\" a .d.ts file?  The double extension \".d.ts\" needs to be matched specially.\n      if (!ExtractorConfig.hasDtsFileExtension(fileName)) {\n        // It's not a .d.ts file.  Is the file extension a potential source file?\n        const match: RegExpExecArray | null = fileExtensionRegExp.exec(fileName);\n        if (match) {\n          // Example: \"c:/folder/file.part\"\n          const pathWithoutExtension: string = match[1];\n          // Example: \".ts\"\n          const fileExtension: string = match[2];\n\n          switch (fileExtension.toLocaleLowerCase()) {\n            case '.ts':\n            case '.tsx':\n            case '.js':\n            case '.jsx':\n              // Yes, this is a possible source file.  Is there a corresponding .d.ts file in the same folder?\n              const dtsFileName: string = `${pathWithoutExtension}.d.ts`;\n\n              let dtsFileExists: boolean | undefined = dtsExistsCache.get(dtsFileName);\n              if (dtsFileExists === undefined) {\n                dtsFileExists = defaultCompilerHost.fileExists!(dtsFileName);\n                dtsExistsCache.set(dtsFileName, dtsFileExists);\n              }\n\n              if (dtsFileExists) {\n                // fileName is a potential source file and a corresponding .d.ts file exists.\n                // Thus, API Extractor should ignore this file (so the .d.ts file will get analyzed instead).\n                return false;\n              }\n              break;\n          }\n        }\n      }\n\n      // Fall through to the default implementation\n      return defaultCompilerHost.fileExists!(fileName);\n    };\n\n    return compilerHost;\n  }\n}\n"]}

package/lib-esm/api/ConsoleMessageId.js

@@ -0,0 +1,82 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * Unique identifiers for console messages reported by API Extractor.
+ *
+ * @remarks
+ *
+ * These strings are possible values for the {@link ExtractorMessage.messageId} property
+ * when the `ExtractorMessage.category` is {@link ExtractorMessageCategory.Console}.
+ *
+ * @public
+ */
+export var ConsoleMessageId;
+(function (ConsoleMessageId) {
+    /**
+     * "Analysis will use the bundled TypeScript version ___"
+     */
+    ConsoleMessageId["Preamble"] = "console-preamble";
+    /**
+     * "The target project appears to use TypeScript ___ which is newer than the bundled compiler engine;
+     * consider upgrading API Extractor."
+     */
+    ConsoleMessageId["CompilerVersionNotice"] = "console-compiler-version-notice";
+    /**
+     * "Using custom TSDoc config from ___"
+     */
+    ConsoleMessageId["UsingCustomTSDocConfig"] = "console-using-custom-tsdoc-config";
+    /**
+     * "Found metadata in ___"
+     */
+    ConsoleMessageId["FoundTSDocMetadata"] = "console-found-tsdoc-metadata";
+    /**
+     * "Writing: ___"
+     */
+    ConsoleMessageId["WritingDocModelFile"] = "console-writing-doc-model-file";
+    /**
+     * "Writing package typings: ___"
+     */
+    ConsoleMessageId["WritingDtsRollup"] = "console-writing-dts-rollup";
+    /**
+     * "Generating ___ API report: ___"
+     */
+    ConsoleMessageId["WritingApiReport"] = "console-writing-api-report";
+    /**
+     * "You have changed the public API signature for this project.
+     * Please copy the file ___ to ___, or perform a local build (which does this automatically).
+     * See the Git repo documentation for more info."
+     *
+     * OR
+     *
+     * "The API report file is missing.
+     * Please copy the file ___ to ___, or perform a local build (which does this automatically).
+     * See the Git repo documentation for more info."
+     */
+    ConsoleMessageId["ApiReportNotCopied"] = "console-api-report-not-copied";
+    /**
+     * Changes to the API report:
+     * ___
+     */
+    ConsoleMessageId["ApiReportDiff"] = "console-api-report-diff";
+    /**
+     * "You have changed the public API signature for this project.  Updating ___"
+     */
+    ConsoleMessageId["ApiReportCopied"] = "console-api-report-copied";
+    /**
+     * "The API report is up to date: ___"
+     */
+    ConsoleMessageId["ApiReportUnchanged"] = "console-api-report-unchanged";
+    /**
+     * "The API report file was missing, so a new file was created. Please add this file to Git: ___"
+     */
+    ConsoleMessageId["ApiReportCreated"] = "console-api-report-created";
+    /**
+     * "Unable to create the API report file. Please make sure the target folder exists: ___"
+     */
+    ConsoleMessageId["ApiReportFolderMissing"] = "console-api-report-folder-missing";
+    /**
+     * Used for the information printed when the "--diagnostics" flag is enabled.
+     */
+    ConsoleMessageId["Diagnostics"] = "console-diagnostics";
+})(ConsoleMessageId || (ConsoleMessageId = {}));
+//# sourceMappingURL=ConsoleMessageId.js.map

package/lib-esm/api/ConsoleMessageId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsoleMessageId.js","sourceRoot":"","sources":["../../src/api/ConsoleMessageId.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,gBAgFX;AAhFD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,iDAA6B,CAAA;IAE7B;;;OAGG;IACH,6EAAyD,CAAA;IAEzD;;OAEG;IACH,gFAA4D,CAAA;IAE5D;;OAEG;IACH,uEAAmD,CAAA;IAEnD;;OAEG;IACH,0EAAsD,CAAA;IAEtD;;OAEG;IACH,mEAA+C,CAAA;IAE/C;;OAEG;IACH,mEAA+C,CAAA;IAE/C;;;;;;;;;;OAUG;IACH,wEAAoD,CAAA;IAEpD;;;OAGG;IACH,6DAAyC,CAAA;IAEzC;;OAEG;IACH,iEAA6C,CAAA;IAE7C;;OAEG;IACH,uEAAmD,CAAA;IAEnD;;OAEG;IACH,mEAA+C,CAAA;IAE/C;;OAEG;IACH,gFAA4D,CAAA;IAE5D;;OAEG;IACH,uDAAmC,CAAA;AACrC,CAAC,EAhFW,gBAAgB,KAAhB,gBAAgB,QAgF3B","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Unique identifiers for console messages reported by API Extractor.\n *\n * @remarks\n *\n * These strings are possible values for the {@link ExtractorMessage.messageId} property\n * when the `ExtractorMessage.category` is {@link ExtractorMessageCategory.Console}.\n *\n * @public\n */\nexport enum ConsoleMessageId {\n  /**\n   * \"Analysis will use the bundled TypeScript version ___\"\n   */\n  Preamble = 'console-preamble',\n\n  /**\n   * \"The target project appears to use TypeScript ___ which is newer than the bundled compiler engine;\n   * consider upgrading API Extractor.\"\n   */\n  CompilerVersionNotice = 'console-compiler-version-notice',\n\n  /**\n   * \"Using custom TSDoc config from ___\"\n   */\n  UsingCustomTSDocConfig = 'console-using-custom-tsdoc-config',\n\n  /**\n   * \"Found metadata in ___\"\n   */\n  FoundTSDocMetadata = 'console-found-tsdoc-metadata',\n\n  /**\n   * \"Writing: ___\"\n   */\n  WritingDocModelFile = 'console-writing-doc-model-file',\n\n  /**\n   * \"Writing package typings: ___\"\n   */\n  WritingDtsRollup = 'console-writing-dts-rollup',\n\n  /**\n   * \"Generating ___ API report: ___\"\n   */\n  WritingApiReport = 'console-writing-api-report',\n\n  /**\n   * \"You have changed the public API signature for this project.\n   * Please copy the file ___ to ___, or perform a local build (which does this automatically).\n   * See the Git repo documentation for more info.\"\n   *\n   * OR\n   *\n   * \"The API report file is missing.\n   * Please copy the file ___ to ___, or perform a local build (which does this automatically).\n   * See the Git repo documentation for more info.\"\n   */\n  ApiReportNotCopied = 'console-api-report-not-copied',\n\n  /**\n   * Changes to the API report:\n   * ___\n   */\n  ApiReportDiff = 'console-api-report-diff',\n\n  /**\n   * \"You have changed the public API signature for this project.  Updating ___\"\n   */\n  ApiReportCopied = 'console-api-report-copied',\n\n  /**\n   * \"The API report is up to date: ___\"\n   */\n  ApiReportUnchanged = 'console-api-report-unchanged',\n\n  /**\n   * \"The API report file was missing, so a new file was created. Please add this file to Git: ___\"\n   */\n  ApiReportCreated = 'console-api-report-created',\n\n  /**\n   * \"Unable to create the API report file. Please make sure the target folder exists: ___\"\n   */\n  ApiReportFolderMissing = 'console-api-report-folder-missing',\n\n  /**\n   * Used for the information printed when the \"--diagnostics\" flag is enabled.\n   */\n  Diagnostics = 'console-diagnostics'\n}\n"]}

package/lib-esm/api/Extractor.js

@@ -0,0 +1,290 @@
+// 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 semver from 'semver';
+import * as ts from 'typescript';
+import * as resolve from 'resolve';
+import { TSDocConfigFile } from '@microsoft/tsdoc-config';
+import { FileSystem, NewlineKind, PackageJsonLookup, Path } from '@rushstack/node-core-library';
+import { ExtractorConfig } from './ExtractorConfig';
+import { Collector } from '../collector/Collector';
+import { DtsRollupGenerator, DtsRollupKind } from '../generators/DtsRollupGenerator';
+import { ApiModelGenerator } from '../generators/ApiModelGenerator';
+import { ApiReportGenerator } from '../generators/ApiReportGenerator';
+import { PackageMetadataManager } from '../analyzer/PackageMetadataManager';
+import { ValidationEnhancer } from '../enhancers/ValidationEnhancer';
+import { DocCommentEnhancer } from '../enhancers/DocCommentEnhancer';
+import { CompilerState } from './CompilerState';
+import { MessageRouter } from '../collector/MessageRouter';
+import { ConsoleMessageId } from './ConsoleMessageId';
+import { SourceMapper } from '../collector/SourceMapper';
+/**
+ * This object represents the outcome of an invocation of API Extractor.
+ *
+ * @public
+ */
+export class ExtractorResult {
+    /** @internal */
+    constructor(properties) {
+        this.compilerState = properties.compilerState;
+        this.extractorConfig = properties.extractorConfig;
+        this.succeeded = properties.succeeded;
+        this.apiReportChanged = properties.apiReportChanged;
+        this.errorCount = properties.errorCount;
+        this.warningCount = properties.warningCount;
+    }
+}
+/**
+ * The starting point for invoking the API Extractor tool.
+ * @public
+ */
+export class Extractor {
+    /**
+     * Returns the version number of the API Extractor NPM package.
+     */
+    static get version() {
+        return Extractor._getPackageJson().version;
+    }
+    /**
+     * Returns the package name of the API Extractor NPM package.
+     */
+    static get packageName() {
+        return Extractor._getPackageJson().name;
+    }
+    static _getPackageJson() {
+        return PackageJsonLookup.loadOwnPackageJson(__dirname);
+    }
+    /**
+     * Load the api-extractor.json config file from the specified path, and then invoke API Extractor.
+     */
+    static loadConfigAndInvoke(configFilePath, options) {
+        const extractorConfig = ExtractorConfig.loadFileAndPrepare(configFilePath);
+        return Extractor.invoke(extractorConfig, options);
+    }
+    /**
+     * Invoke API Extractor using an already prepared `ExtractorConfig` object.
+     */
+    static invoke(extractorConfig, options) {
+        const { packageFolder, messages, tsdocConfiguration, tsdocConfigFile: { filePath: tsdocConfigFilePath, fileNotFound: tsdocConfigFileNotFound }, apiJsonFilePath, newlineKind, reportTempFolder, reportFolder, apiReportEnabled, reportConfigs, testMode, rollupEnabled, publicTrimmedFilePath, alphaTrimmedFilePath, betaTrimmedFilePath, untrimmedFilePath, tsdocMetadataEnabled, tsdocMetadataFilePath } = extractorConfig;
+        const { localBuild = false, compilerState = CompilerState.create(extractorConfig, options), messageCallback, showVerboseMessages = false, showDiagnostics = false, printApiReportDiff = false } = options !== null && options !== void 0 ? options : {};
+        const sourceMapper = new SourceMapper();
+        const messageRouter = new MessageRouter({
+            workingPackageFolder: packageFolder,
+            messageCallback,
+            messagesConfig: messages || {},
+            showVerboseMessages,
+            showDiagnostics,
+            tsdocConfiguration,
+            sourceMapper
+        });
+        if (tsdocConfigFilePath && !tsdocConfigFileNotFound) {
+            if (!Path.isEqual(tsdocConfigFilePath, ExtractorConfig._tsdocBaseFilePath)) {
+                messageRouter.logVerbose(ConsoleMessageId.UsingCustomTSDocConfig, `Using custom TSDoc config from ${tsdocConfigFilePath}`);
+            }
+        }
+        this._checkCompilerCompatibility(extractorConfig, messageRouter);
+        if (messageRouter.showDiagnostics) {
+            messageRouter.logDiagnostic('');
+            messageRouter.logDiagnosticHeader('Final prepared ExtractorConfig');
+            messageRouter.logDiagnostic(extractorConfig.getDiagnosticDump());
+            messageRouter.logDiagnosticFooter();
+            messageRouter.logDiagnosticHeader('Compiler options');
+            const serializedCompilerOptions = MessageRouter.buildJsonDumpObject(compilerState.program.getCompilerOptions());
+            messageRouter.logDiagnostic(JSON.stringify(serializedCompilerOptions, undefined, 2));
+            messageRouter.logDiagnosticFooter();
+            messageRouter.logDiagnosticHeader('TSDoc configuration');
+            // Convert the TSDocConfiguration into a tsdoc.json representation
+            const combinedConfigFile = TSDocConfigFile.loadFromParser(tsdocConfiguration);
+            const serializedTSDocConfig = MessageRouter.buildJsonDumpObject(combinedConfigFile.saveToObject());
+            messageRouter.logDiagnostic(JSON.stringify(serializedTSDocConfig, undefined, 2));
+            messageRouter.logDiagnosticFooter();
+        }
+        const collector = new Collector({
+            program: compilerState.program,
+            messageRouter,
+            extractorConfig,
+            sourceMapper
+        });
+        collector.analyze();
+        DocCommentEnhancer.analyze(collector);
+        ValidationEnhancer.analyze(collector);
+        const modelBuilder = new ApiModelGenerator(collector, extractorConfig);
+        const apiPackage = modelBuilder.buildApiPackage();
+        if (messageRouter.showDiagnostics) {
+            messageRouter.logDiagnostic(''); // skip a line after any diagnostic messages
+        }
+        if (modelBuilder.docModelEnabled) {
+            messageRouter.logVerbose(ConsoleMessageId.WritingDocModelFile, `Writing: ${apiJsonFilePath}`);
+            apiPackage.saveToJsonFile(apiJsonFilePath, {
+                toolPackage: Extractor.packageName,
+                toolVersion: Extractor.version,
+                newlineConversion: newlineKind,
+                ensureFolderExists: true,
+                testMode
+            });
+        }
+        function writeApiReport(reportConfig) {
+            return Extractor._writeApiReport(collector, extractorConfig, messageRouter, reportTempFolder, reportFolder, reportConfig, localBuild, printApiReportDiff);
+        }
+        let anyReportChanged = false;
+        if (apiReportEnabled) {
+            for (const reportConfig of reportConfigs) {
+                anyReportChanged = writeApiReport(reportConfig) || anyReportChanged;
+            }
+        }
+        if (rollupEnabled) {
+            Extractor._generateRollupDtsFile(collector, publicTrimmedFilePath, DtsRollupKind.PublicRelease, newlineKind);
+            Extractor._generateRollupDtsFile(collector, alphaTrimmedFilePath, DtsRollupKind.AlphaRelease, newlineKind);
+            Extractor._generateRollupDtsFile(collector, betaTrimmedFilePath, DtsRollupKind.BetaRelease, newlineKind);
+            Extractor._generateRollupDtsFile(collector, untrimmedFilePath, DtsRollupKind.InternalRelease, newlineKind);
+        }
+        if (tsdocMetadataEnabled) {
+            // Write the tsdoc-metadata.json file for this project
+            PackageMetadataManager.writeTsdocMetadataFile(tsdocMetadataFilePath, newlineKind);
+        }
+        // Show all the messages that we collected during analysis
+        messageRouter.handleRemainingNonConsoleMessages();
+        // Determine success
+        let succeeded;
+        if (localBuild) {
+            // For a local build, fail if there were errors (but ignore warnings)
+            succeeded = messageRouter.errorCount === 0;
+        }
+        else {
+            // For a production build, fail if there were any errors or warnings
+            succeeded = messageRouter.errorCount + messageRouter.warningCount === 0;
+        }
+        return new ExtractorResult({
+            compilerState,
+            extractorConfig,
+            succeeded,
+            apiReportChanged: anyReportChanged,
+            errorCount: messageRouter.errorCount,
+            warningCount: messageRouter.warningCount
+        });
+    }
+    /**
+     * Generates the API report at the specified release level, writes it to the specified file path, and compares
+     * the output to the existing report (if one exists).
+     *
+     * @param reportTempDirectoryPath - The path to the directory under which the temp report file will be written prior
+     * to comparison with an existing report.
+     * @param reportDirectoryPath - The path to the directory under which the existing report file is located, and to
+     * which the new report will be written post-comparison.
+     * @param reportConfig - API report configuration, including its file name and {@link ApiReportVariant}.
+     * @param printApiReportDiff - {@link IExtractorInvokeOptions.printApiReportDiff}
+     *
+     * @returns Whether or not the newly generated report differs from the existing report (if one exists).
+     */
+    static _writeApiReport(collector, extractorConfig, messageRouter, reportTempDirectoryPath, reportDirectoryPath, reportConfig, localBuild, printApiReportDiff) {
+        let apiReportChanged = false;
+        const actualApiReportPath = path.resolve(reportTempDirectoryPath, reportConfig.fileName);
+        const actualApiReportShortPath = extractorConfig._getShortFilePath(actualApiReportPath);
+        const expectedApiReportPath = path.resolve(reportDirectoryPath, reportConfig.fileName);
+        const expectedApiReportShortPath = extractorConfig._getShortFilePath(expectedApiReportPath);
+        collector.messageRouter.logVerbose(ConsoleMessageId.WritingApiReport, `Generating ${reportConfig.variant} API report: ${expectedApiReportPath}`);
+        const actualApiReportContent = ApiReportGenerator.generateReviewFileContent(collector, reportConfig.variant);
+        // Write the actual file
+        FileSystem.writeFile(actualApiReportPath, actualApiReportContent, {
+            ensureFolderExists: true,
+            convertLineEndings: extractorConfig.newlineKind
+        });
+        // Compare it against the expected file
+        if (FileSystem.exists(expectedApiReportPath)) {
+            const expectedApiReportContent = FileSystem.readFile(expectedApiReportPath, {
+                convertLineEndings: NewlineKind.Lf
+            });
+            if (!ApiReportGenerator.areEquivalentApiFileContents(actualApiReportContent, expectedApiReportContent)) {
+                apiReportChanged = true;
+                if (!localBuild) {
+                    // For a production build, issue a warning that will break the CI build.
+                    messageRouter.logWarning(ConsoleMessageId.ApiReportNotCopied, 'You have changed the API signature for this project.' +
+                        ` Please copy the file "${actualApiReportShortPath}" to "${expectedApiReportShortPath}",` +
+                        ` or perform a local build (which does this automatically).` +
+                        ` See the Git repo documentation for more info.`);
+                }
+                else {
+                    // For a local build, just copy the file automatically.
+                    messageRouter.logWarning(ConsoleMessageId.ApiReportCopied, `You have changed the API signature for this project. Updating ${expectedApiReportShortPath}`);
+                    FileSystem.writeFile(expectedApiReportPath, actualApiReportContent, {
+                        ensureFolderExists: true,
+                        convertLineEndings: extractorConfig.newlineKind
+                    });
+                }
+                if (messageRouter.showVerboseMessages || printApiReportDiff) {
+                    const Diff = require('diff');
+                    const patch = Diff.structuredPatch(expectedApiReportShortPath, actualApiReportShortPath, expectedApiReportContent, actualApiReportContent);
+                    const logFunction = printApiReportDiff
+                        ? messageRouter.logWarning.bind(messageRouter)
+                        : messageRouter.logVerbose.bind(messageRouter);
+                    logFunction(ConsoleMessageId.ApiReportDiff, 'Changes to the API report:\n\n' + Diff.formatPatch(patch));
+                }
+            }
+            else {
+                messageRouter.logVerbose(ConsoleMessageId.ApiReportUnchanged, `The API report is up to date: ${actualApiReportShortPath}`);
+            }
+        }
+        else {
+            // The target file does not exist, so we are setting up the API review file for the first time.
+            //
+            // NOTE: People sometimes make a mistake where they move a project and forget to update the "reportFolder"
+            // setting, which causes a new file to silently get written to the wrong place.  This can be confusing.
+            // Thus we treat the initial creation of the file specially.
+            apiReportChanged = true;
+            if (!localBuild) {
+                // For a production build, issue a warning that will break the CI build.
+                messageRouter.logWarning(ConsoleMessageId.ApiReportNotCopied, 'The API report file is missing.' +
+                    ` Please copy the file "${actualApiReportShortPath}" to "${expectedApiReportShortPath}",` +
+                    ` or perform a local build (which does this automatically).` +
+                    ` See the Git repo documentation for more info.`);
+            }
+            else {
+                const expectedApiReportFolder = path.dirname(expectedApiReportPath);
+                if (!FileSystem.exists(expectedApiReportFolder)) {
+                    messageRouter.logError(ConsoleMessageId.ApiReportFolderMissing, 'Unable to create the API report file. Please make sure the target folder exists:\n' +
+                        expectedApiReportFolder);
+                }
+                else {
+                    FileSystem.writeFile(expectedApiReportPath, actualApiReportContent, {
+                        convertLineEndings: extractorConfig.newlineKind
+                    });
+                    messageRouter.logWarning(ConsoleMessageId.ApiReportCreated, 'The API report file was missing, so a new file was created. Please add this file to Git:\n' +
+                        expectedApiReportPath);
+                }
+            }
+        }
+        return apiReportChanged;
+    }
+    static _checkCompilerCompatibility(extractorConfig, messageRouter) {
+        messageRouter.logInfo(ConsoleMessageId.Preamble, `Analysis will use the bundled TypeScript version ${ts.version}`);
+        try {
+            const typescriptPath = resolve.sync('typescript', {
+                basedir: extractorConfig.projectFolder,
+                preserveSymlinks: false
+            });
+            const packageJsonLookup = new PackageJsonLookup();
+            const packageJson = packageJsonLookup.tryLoadNodePackageJsonFor(typescriptPath);
+            if (packageJson && packageJson.version && semver.valid(packageJson.version)) {
+                // Consider a newer MINOR release to be incompatible
+                const ourMajor = semver.major(ts.version);
+                const ourMinor = semver.minor(ts.version);
+                const theirMajor = semver.major(packageJson.version);
+                const theirMinor = semver.minor(packageJson.version);
+                if (theirMajor > ourMajor || (theirMajor === ourMajor && theirMinor > ourMinor)) {
+                    messageRouter.logInfo(ConsoleMessageId.CompilerVersionNotice, `*** The target project appears to use TypeScript ${packageJson.version} which is newer than the` +
+                        ` bundled compiler engine; consider upgrading API Extractor.`);
+                }
+            }
+        }
+        catch (e) {
+            // The compiler detection heuristic is not expected to work in many configurations
+        }
+    }
+    static _generateRollupDtsFile(collector, outputPath, dtsKind, newlineKind) {
+        if (outputPath !== '') {
+            collector.messageRouter.logVerbose(ConsoleMessageId.WritingDtsRollup, `Writing package typings: ${outputPath}`);
+            DtsRollupGenerator.writeTypingsFile(collector, outputPath, dtsKind, newlineKind);
+        }
+    }
+}
+//# sourceMappingURL=Extractor.js.map

package/lib-esm/api/Extractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Extractor.js","sourceRoot":"","sources":["../../src/api/Extractor.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAGnC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EACL,UAAU,EACV,WAAW,EACX,iBAAiB,EAGjB,IAAI,EACL,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAkC,MAAM,mBAAmB,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAwEzD;;;;GAIG;AACH,MAAM,OAAO,eAAe;IA4C1B,gBAAgB;IAChB,YAAmB,UAA2B;QAC5C,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC9C,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;IAC9C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IACpB;;OAEG;IACI,MAAM,KAAK,OAAO;QACvB,OAAO,SAAS,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,WAAW;QAC3B,OAAO,SAAS,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC;IAC1C,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,OAAO,iBAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,mBAAmB,CAC/B,cAAsB,EACtB,OAAiC;QAEjC,MAAM,eAAe,GAAoB,eAAe,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAE5F,OAAO,SAAS,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,eAAgC,EAAE,OAAiC;QACtF,MAAM,EACJ,aAAa,EACb,QAAQ,EACR,kBAAkB,EAClB,eAAe,EAAE,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,uBAAuB,EAAE,EACzF,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,QAAQ,EACR,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACtB,GAAG,eAAe,CAAC;QACpB,MAAM,EACJ,UAAU,GAAG,KAAK,EAClB,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,EAC9D,eAAe,EACf,mBAAmB,GAAG,KAAK,EAC3B,eAAe,GAAG,KAAK,EACvB,kBAAkB,GAAG,KAAK,EAC3B,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QAElB,MAAM,YAAY,GAAiB,IAAI,YAAY,EAAE,CAAC;QAEtD,MAAM,aAAa,GAAkB,IAAI,aAAa,CAAC;YACrD,oBAAoB,EAAE,aAAa;YACnC,eAAe;YACf,cAAc,EAAE,QAAQ,IAAI,EAAE;YAC9B,mBAAmB;YACnB,eAAe;YACf,kBAAkB;YAClB,YAAY;SACb,CAAC,CAAC;QAEH,IAAI,mBAAmB,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACpD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAC3E,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,sBAAsB,EACvC,kCAAkC,mBAAmB,EAAE,CACxD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAEjE,IAAI,aAAa,CAAC,eAAe,EAAE,CAAC;YAClC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAChC,aAAa,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,CAAC;YACpE,aAAa,CAAC,aAAa,CAAC,eAAe,CAAC,iBAAiB,EAAE,CAAC,CAAC;YACjE,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAEpC,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;YACtD,MAAM,yBAAyB,GAAW,aAAa,CAAC,mBAAmB,CACxE,aAAa,CAAC,OAAsB,CAAC,kBAAkB,EAAE,CAC3D,CAAC;YACF,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,yBAAyB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;YACrF,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAEpC,aAAa,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;YACzD,kEAAkE;YAClE,MAAM,kBAAkB,GAAoB,eAAe,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;YAC/F,MAAM,qBAAqB,GAAW,aAAa,CAAC,mBAAmB,CACrE,kBAAkB,CAAC,YAAY,EAAE,CAClC,CAAC;YACF,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;YACjF,aAAa,CAAC,mBAAmB,EAAE,CAAC;QACtC,CAAC;QAED,MAAM,SAAS,GAAc,IAAI,SAAS,CAAC;YACzC,OAAO,EAAE,aAAa,CAAC,OAAqB;YAC5C,aAAa;YACb,eAAe;YACf,YAAY;SACb,CAAC,CAAC;QAEH,SAAS,CAAC,OAAO,EAAE,CAAC;QAEpB,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtC,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,YAAY,GAAsB,IAAI,iBAAiB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAe,YAAY,CAAC,eAAe,EAAE,CAAC;QAE9D,IAAI,aAAa,CAAC,eAAe,EAAE,CAAC;YAClC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,4CAA4C;QAC/E,CAAC;QAED,IAAI,YAAY,CAAC,eAAe,EAAE,CAAC;YACjC,aAAa,CAAC,UAAU,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,YAAY,eAAe,EAAE,CAAC,CAAC;YAC9F,UAAU,CAAC,cAAc,CAAC,eAAe,EAAE;gBACzC,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,WAAW,EAAE,SAAS,CAAC,OAAO;gBAE9B,iBAAiB,EAAE,WAAW;gBAC9B,kBAAkB,EAAE,IAAI;gBACxB,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;QAED,SAAS,cAAc,CAAC,YAAuC;YAC7D,OAAO,SAAS,CAAC,eAAe,CAC9B,SAAS,EACT,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,kBAAkB,CACnB,CAAC;QACJ,CAAC;QAED,IAAI,gBAAgB,GAAY,KAAK,CAAC;QACtC,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;gBACzC,gBAAgB,GAAG,cAAc,CAAC,YAAY,CAAC,IAAI,gBAAgB,CAAC;YACtE,CAAC;QACH,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,SAAS,CAAC,sBAAsB,CAC9B,SAAS,EACT,qBAAqB,EACrB,aAAa,CAAC,aAAa,EAC3B,WAAW,CACZ,CAAC;YACF,SAAS,CAAC,sBAAsB,CAC9B,SAAS,EACT,oBAAoB,EACpB,aAAa,CAAC,YAAY,EAC1B,WAAW,CACZ,CAAC;YACF,SAAS,CAAC,sBAAsB,CAC9B,SAAS,EACT,mBAAmB,EACnB,aAAa,CAAC,WAAW,EACzB,WAAW,CACZ,CAAC;YACF,SAAS,CAAC,sBAAsB,CAC9B,SAAS,EACT,iBAAiB,EACjB,aAAa,CAAC,eAAe,EAC7B,WAAW,CACZ,CAAC;QACJ,CAAC;QAED,IAAI,oBAAoB,EAAE,CAAC;YACzB,sDAAsD;YACtD,sBAAsB,CAAC,sBAAsB,CAAC,qBAAqB,EAAE,WAAW,CAAC,CAAC;QACpF,CAAC;QAED,0DAA0D;QAC1D,aAAa,CAAC,iCAAiC,EAAE,CAAC;QAElD,oBAAoB;QACpB,IAAI,SAAkB,CAAC;QACvB,IAAI,UAAU,EAAE,CAAC;YACf,qEAAqE;YACrE,SAAS,GAAG,aAAa,CAAC,UAAU,KAAK,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,oEAAoE;YACpE,SAAS,GAAG,aAAa,CAAC,UAAU,GAAG,aAAa,CAAC,YAAY,KAAK,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO,IAAI,eAAe,CAAC;YACzB,aAAa;YACb,eAAe;YACf,SAAS;YACT,gBAAgB,EAAE,gBAAgB;YAClC,UAAU,EAAE,aAAa,CAAC,UAAU;YACpC,YAAY,EAAE,aAAa,CAAC,YAAY;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,MAAM,CAAC,eAAe,CAC5B,SAAoB,EACpB,eAAgC,EAChC,aAA4B,EAC5B,uBAA+B,EAC/B,mBAA2B,EAC3B,YAAuC,EACvC,UAAmB,EACnB,kBAA2B;QAE3B,IAAI,gBAAgB,GAAY,KAAK,CAAC;QAEtC,MAAM,mBAAmB,GAAW,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QACjG,MAAM,wBAAwB,GAAW,eAAe,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;QAEhG,MAAM,qBAAqB,GAAW,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC/F,MAAM,0BAA0B,GAAW,eAAe,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEpG,SAAS,CAAC,aAAa,CAAC,UAAU,CAChC,gBAAgB,CAAC,gBAAgB,EACjC,cAAc,YAAY,CAAC,OAAO,gBAAgB,qBAAqB,EAAE,CAC1E,CAAC;QAEF,MAAM,sBAAsB,GAAW,kBAAkB,CAAC,yBAAyB,CACjF,SAAS,EACT,YAAY,CAAC,OAAO,CACrB,CAAC;QAEF,wBAAwB;QACxB,UAAU,CAAC,SAAS,CAAC,mBAAmB,EAAE,sBAAsB,EAAE;YAChE,kBAAkB,EAAE,IAAI;YACxB,kBAAkB,EAAE,eAAe,CAAC,WAAW;SAChD,CAAC,CAAC;QAEH,uCAAuC;QACvC,IAAI,UAAU,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC;YAC7C,MAAM,wBAAwB,GAAW,UAAU,CAAC,QAAQ,CAAC,qBAAqB,EAAE;gBAClF,kBAAkB,EAAE,WAAW,CAAC,EAAE;aACnC,CAAC,CAAC;YAEH,IACE,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,sBAAsB,EAAE,wBAAwB,CAAC,EAClG,CAAC;gBACD,gBAAgB,GAAG,IAAI,CAAC;gBAExB,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,wEAAwE;oBACxE,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,kBAAkB,EACnC,sDAAsD;wBACpD,0BAA0B,wBAAwB,SAAS,0BAA0B,IAAI;wBACzF,4DAA4D;wBAC5D,gDAAgD,CACnD,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,uDAAuD;oBACvD,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,eAAe,EAChC,iEAAiE,0BAA0B,EAAE,CAC9F,CAAC;oBAEF,UAAU,CAAC,SAAS,CAAC,qBAAqB,EAAE,sBAAsB,EAAE;wBAClE,kBAAkB,EAAE,IAAI;wBACxB,kBAAkB,EAAE,eAAe,CAAC,WAAW;qBAChD,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,aAAa,CAAC,mBAAmB,IAAI,kBAAkB,EAAE,CAAC;oBAC5D,MAAM,IAAI,GAA0B,OAAO,CAAC,MAAM,CAAC,CAAC;oBACpD,MAAM,KAAK,GAAmC,IAAI,CAAC,eAAe,CAChE,0BAA0B,EAC1B,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,CACvB,CAAC;oBACF,MAAM,WAAW,GAEoC,kBAAkB;wBACrE,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;wBAC9C,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBAEjD,WAAW,CACT,gBAAgB,CAAC,aAAa,EAC9B,gCAAgC,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAC3D,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,kBAAkB,EACnC,iCAAiC,wBAAwB,EAAE,CAC5D,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,+FAA+F;YAC/F,EAAE;YACF,0GAA0G;YAC1G,uGAAuG;YACvG,4DAA4D;YAC5D,gBAAgB,GAAG,IAAI,CAAC;YAExB,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,wEAAwE;gBACxE,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,kBAAkB,EACnC,iCAAiC;oBAC/B,0BAA0B,wBAAwB,SAAS,0BAA0B,IAAI;oBACzF,4DAA4D;oBAC5D,gDAAgD,CACnD,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,uBAAuB,GAAW,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;gBAC5E,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC;oBAChD,aAAa,CAAC,QAAQ,CACpB,gBAAgB,CAAC,sBAAsB,EACvC,oFAAoF;wBAClF,uBAAuB,CAC1B,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,SAAS,CAAC,qBAAqB,EAAE,sBAAsB,EAAE;wBAClE,kBAAkB,EAAE,eAAe,CAAC,WAAW;qBAChD,CAAC,CAAC;oBACH,aAAa,CAAC,UAAU,CACtB,gBAAgB,CAAC,gBAAgB,EACjC,4FAA4F;wBAC1F,qBAAqB,CACxB,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,2BAA2B,CACxC,eAAgC,EAChC,aAA4B;QAE5B,aAAa,CAAC,OAAO,CACnB,gBAAgB,CAAC,QAAQ,EACzB,oDAAoD,EAAE,CAAC,OAAO,EAAE,CACjE,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,cAAc,GAAW,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE;gBACxD,OAAO,EAAE,eAAe,CAAC,aAAa;gBACtC,gBAAgB,EAAE,KAAK;aACxB,CAAC,CAAC;YACH,MAAM,iBAAiB,GAAsB,IAAI,iBAAiB,EAAE,CAAC;YACrE,MAAM,WAAW,GACf,iBAAiB,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,IAAI,WAAW,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5E,oDAAoD;gBACpD,MAAM,QAAQ,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;gBAClD,MAAM,QAAQ,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;gBAElD,MAAM,UAAU,GAAW,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAC7D,MAAM,UAAU,GAAW,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAE7D,IAAI,UAAU,GAAG,QAAQ,IAAI,CAAC,UAAU,KAAK,QAAQ,IAAI,UAAU,GAAG,QAAQ,CAAC,EAAE,CAAC;oBAChF,aAAa,CAAC,OAAO,CACnB,gBAAgB,CAAC,qBAAqB,EACtC,oDAAoD,WAAW,CAAC,OAAO,0BAA0B;wBAC/F,6DAA6D,CAChE,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,kFAAkF;QACpF,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,sBAAsB,CACnC,SAAoB,EACpB,UAAkB,EAClB,OAAsB,EACtB,WAAwB;QAExB,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YACtB,SAAS,CAAC,aAAa,CAAC,UAAU,CAChC,gBAAgB,CAAC,gBAAgB,EACjC,4BAA4B,UAAU,EAAE,CACzC,CAAC;YACF,kBAAkB,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACnF,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 semver from 'semver';\nimport * as ts from 'typescript';\nimport * as resolve from 'resolve';\n\nimport type { ApiPackage } from '@microsoft/api-extractor-model';\nimport { TSDocConfigFile } from '@microsoft/tsdoc-config';\nimport {\n  FileSystem,\n  NewlineKind,\n  PackageJsonLookup,\n  type IPackageJson,\n  type INodePackageJson,\n  Path\n} from '@rushstack/node-core-library';\n\nimport { ExtractorConfig, type IExtractorConfigApiReport } from './ExtractorConfig';\nimport { Collector } from '../collector/Collector';\nimport { DtsRollupGenerator, DtsRollupKind } from '../generators/DtsRollupGenerator';\nimport { ApiModelGenerator } from '../generators/ApiModelGenerator';\nimport { ApiReportGenerator } from '../generators/ApiReportGenerator';\nimport { PackageMetadataManager } from '../analyzer/PackageMetadataManager';\nimport { ValidationEnhancer } from '../enhancers/ValidationEnhancer';\nimport { DocCommentEnhancer } from '../enhancers/DocCommentEnhancer';\nimport { CompilerState } from './CompilerState';\nimport type { ExtractorMessage } from './ExtractorMessage';\nimport { MessageRouter } from '../collector/MessageRouter';\nimport { ConsoleMessageId } from './ConsoleMessageId';\nimport { SourceMapper } from '../collector/SourceMapper';\n\n/**\n * Runtime options for Extractor.\n *\n * @public\n */\nexport interface IExtractorInvokeOptions {\n  /**\n   * An optional TypeScript compiler state.  This allows an optimization where multiple invocations of API Extractor\n   * can reuse the same TypeScript compiler analysis.\n   */\n  compilerState?: CompilerState;\n\n  /**\n   * Indicates that API Extractor is running as part of a local build, e.g. on developer's\n   * machine.\n   *\n   * @remarks\n   * This disables certain validation that would normally be performed for a ship/production build. For example,\n   * the *.api.md report file is automatically updated in a local build.\n   *\n   * The default value is false.\n   */\n  localBuild?: boolean;\n\n  /**\n   * If true, API Extractor will include {@link ExtractorLogLevel.Verbose} messages in its output.\n   */\n  showVerboseMessages?: boolean;\n\n  /**\n   * If true, API Extractor will print diagnostic information used for troubleshooting problems.\n   * These messages will be included as {@link ExtractorLogLevel.Verbose} output.\n   *\n   * @remarks\n   * Setting `showDiagnostics=true` forces `showVerboseMessages=true`.\n   */\n  showDiagnostics?: boolean;\n\n  /**\n   * Specifies an alternate folder path to be used when loading the TypeScript system typings.\n   *\n   * @remarks\n   * API Extractor uses its own TypeScript compiler engine to analyze your project.  If your project\n   * is built with a significantly different TypeScript version, sometimes API Extractor may report compilation\n   * errors due to differences in the system typings (e.g. lib.dom.d.ts).  You can use the \"--typescriptCompilerFolder\"\n   * option to specify the folder path where you installed the TypeScript package, and API Extractor's compiler will\n   * use those system typings instead.\n   */\n  typescriptCompilerFolder?: string;\n\n  /**\n   * An optional callback function that will be called for each `ExtractorMessage` before it is displayed by\n   * API Extractor.  The callback can customize the message, handle it, or discard it.\n   *\n   * @remarks\n   * If a `messageCallback` is not provided, then by default API Extractor will print the messages to\n   * the STDERR/STDOUT console.\n   */\n  messageCallback?: (message: ExtractorMessage) => void;\n\n  /**\n   * If true, then any differences between the actual and expected API reports will be\n   * printed on the console.\n   *\n   * @remarks\n   * The diff is not printed if the expected API report file has not been created yet.\n   */\n  printApiReportDiff?: boolean;\n}\n\n/**\n * This object represents the outcome of an invocation of API Extractor.\n *\n * @public\n */\nexport class ExtractorResult {\n  /**\n   * The TypeScript compiler state that was used.\n   */\n  public readonly compilerState: CompilerState;\n\n  /**\n   * The API Extractor configuration that was used.\n   */\n  public readonly extractorConfig: ExtractorConfig;\n\n  /**\n   * Whether the invocation of API Extractor was successful.  For example, if `succeeded` is false, then the build task\n   * would normally return a nonzero process exit code, indicating that the operation failed.\n   *\n   * @remarks\n   *\n   * Normally the operation \"succeeds\" if `errorCount` and `warningCount` are both zero.  However if\n   * {@link IExtractorInvokeOptions.localBuild} is `true`, then the operation \"succeeds\" if `errorCount` is zero\n   * (i.e. warnings are ignored).\n   */\n  public readonly succeeded: boolean;\n\n  /**\n   * Returns true if the API report was found to have changed.\n   */\n  public readonly apiReportChanged: boolean;\n\n  /**\n   * Reports the number of errors encountered during analysis.\n   *\n   * @remarks\n   * This does not count exceptions, where unexpected issues prematurely abort the operation.\n   */\n  public readonly errorCount: number;\n\n  /**\n   * Reports the number of warnings encountered during analysis.\n   *\n   * @remarks\n   * This does not count warnings that are emitted in the API report file.\n   */\n  public readonly warningCount: number;\n\n  /** @internal */\n  public constructor(properties: ExtractorResult) {\n    this.compilerState = properties.compilerState;\n    this.extractorConfig = properties.extractorConfig;\n    this.succeeded = properties.succeeded;\n    this.apiReportChanged = properties.apiReportChanged;\n    this.errorCount = properties.errorCount;\n    this.warningCount = properties.warningCount;\n  }\n}\n\n/**\n * The starting point for invoking the API Extractor tool.\n * @public\n */\nexport class Extractor {\n  /**\n   * Returns the version number of the API Extractor NPM package.\n   */\n  public static get version(): string {\n    return Extractor._getPackageJson().version;\n  }\n\n  /**\n   * Returns the package name of the API Extractor NPM package.\n   */\n  public static get packageName(): string {\n    return Extractor._getPackageJson().name;\n  }\n\n  private static _getPackageJson(): IPackageJson {\n    return PackageJsonLookup.loadOwnPackageJson(__dirname);\n  }\n\n  /**\n   * Load the api-extractor.json config file from the specified path, and then invoke API Extractor.\n   */\n  public static loadConfigAndInvoke(\n    configFilePath: string,\n    options?: IExtractorInvokeOptions\n  ): ExtractorResult {\n    const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(configFilePath);\n\n    return Extractor.invoke(extractorConfig, options);\n  }\n\n  /**\n   * Invoke API Extractor using an already prepared `ExtractorConfig` object.\n   */\n  public static invoke(extractorConfig: ExtractorConfig, options?: IExtractorInvokeOptions): ExtractorResult {\n    const {\n      packageFolder,\n      messages,\n      tsdocConfiguration,\n      tsdocConfigFile: { filePath: tsdocConfigFilePath, fileNotFound: tsdocConfigFileNotFound },\n      apiJsonFilePath,\n      newlineKind,\n      reportTempFolder,\n      reportFolder,\n      apiReportEnabled,\n      reportConfigs,\n      testMode,\n      rollupEnabled,\n      publicTrimmedFilePath,\n      alphaTrimmedFilePath,\n      betaTrimmedFilePath,\n      untrimmedFilePath,\n      tsdocMetadataEnabled,\n      tsdocMetadataFilePath\n    } = extractorConfig;\n    const {\n      localBuild = false,\n      compilerState = CompilerState.create(extractorConfig, options),\n      messageCallback,\n      showVerboseMessages = false,\n      showDiagnostics = false,\n      printApiReportDiff = false\n    } = options ?? {};\n\n    const sourceMapper: SourceMapper = new SourceMapper();\n\n    const messageRouter: MessageRouter = new MessageRouter({\n      workingPackageFolder: packageFolder,\n      messageCallback,\n      messagesConfig: messages || {},\n      showVerboseMessages,\n      showDiagnostics,\n      tsdocConfiguration,\n      sourceMapper\n    });\n\n    if (tsdocConfigFilePath && !tsdocConfigFileNotFound) {\n      if (!Path.isEqual(tsdocConfigFilePath, ExtractorConfig._tsdocBaseFilePath)) {\n        messageRouter.logVerbose(\n          ConsoleMessageId.UsingCustomTSDocConfig,\n          `Using custom TSDoc config from ${tsdocConfigFilePath}`\n        );\n      }\n    }\n\n    this._checkCompilerCompatibility(extractorConfig, messageRouter);\n\n    if (messageRouter.showDiagnostics) {\n      messageRouter.logDiagnostic('');\n      messageRouter.logDiagnosticHeader('Final prepared ExtractorConfig');\n      messageRouter.logDiagnostic(extractorConfig.getDiagnosticDump());\n      messageRouter.logDiagnosticFooter();\n\n      messageRouter.logDiagnosticHeader('Compiler options');\n      const serializedCompilerOptions: object = MessageRouter.buildJsonDumpObject(\n        (compilerState.program as ts.Program).getCompilerOptions()\n      );\n      messageRouter.logDiagnostic(JSON.stringify(serializedCompilerOptions, undefined, 2));\n      messageRouter.logDiagnosticFooter();\n\n      messageRouter.logDiagnosticHeader('TSDoc configuration');\n      // Convert the TSDocConfiguration into a tsdoc.json representation\n      const combinedConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromParser(tsdocConfiguration);\n      const serializedTSDocConfig: object = MessageRouter.buildJsonDumpObject(\n        combinedConfigFile.saveToObject()\n      );\n      messageRouter.logDiagnostic(JSON.stringify(serializedTSDocConfig, undefined, 2));\n      messageRouter.logDiagnosticFooter();\n    }\n\n    const collector: Collector = new Collector({\n      program: compilerState.program as ts.Program,\n      messageRouter,\n      extractorConfig,\n      sourceMapper\n    });\n\n    collector.analyze();\n\n    DocCommentEnhancer.analyze(collector);\n    ValidationEnhancer.analyze(collector);\n\n    const modelBuilder: ApiModelGenerator = new ApiModelGenerator(collector, extractorConfig);\n    const apiPackage: ApiPackage = modelBuilder.buildApiPackage();\n\n    if (messageRouter.showDiagnostics) {\n      messageRouter.logDiagnostic(''); // skip a line after any diagnostic messages\n    }\n\n    if (modelBuilder.docModelEnabled) {\n      messageRouter.logVerbose(ConsoleMessageId.WritingDocModelFile, `Writing: ${apiJsonFilePath}`);\n      apiPackage.saveToJsonFile(apiJsonFilePath, {\n        toolPackage: Extractor.packageName,\n        toolVersion: Extractor.version,\n\n        newlineConversion: newlineKind,\n        ensureFolderExists: true,\n        testMode\n      });\n    }\n\n    function writeApiReport(reportConfig: IExtractorConfigApiReport): boolean {\n      return Extractor._writeApiReport(\n        collector,\n        extractorConfig,\n        messageRouter,\n        reportTempFolder,\n        reportFolder,\n        reportConfig,\n        localBuild,\n        printApiReportDiff\n      );\n    }\n\n    let anyReportChanged: boolean = false;\n    if (apiReportEnabled) {\n      for (const reportConfig of reportConfigs) {\n        anyReportChanged = writeApiReport(reportConfig) || anyReportChanged;\n      }\n    }\n\n    if (rollupEnabled) {\n      Extractor._generateRollupDtsFile(\n        collector,\n        publicTrimmedFilePath,\n        DtsRollupKind.PublicRelease,\n        newlineKind\n      );\n      Extractor._generateRollupDtsFile(\n        collector,\n        alphaTrimmedFilePath,\n        DtsRollupKind.AlphaRelease,\n        newlineKind\n      );\n      Extractor._generateRollupDtsFile(\n        collector,\n        betaTrimmedFilePath,\n        DtsRollupKind.BetaRelease,\n        newlineKind\n      );\n      Extractor._generateRollupDtsFile(\n        collector,\n        untrimmedFilePath,\n        DtsRollupKind.InternalRelease,\n        newlineKind\n      );\n    }\n\n    if (tsdocMetadataEnabled) {\n      // Write the tsdoc-metadata.json file for this project\n      PackageMetadataManager.writeTsdocMetadataFile(tsdocMetadataFilePath, newlineKind);\n    }\n\n    // Show all the messages that we collected during analysis\n    messageRouter.handleRemainingNonConsoleMessages();\n\n    // Determine success\n    let succeeded: boolean;\n    if (localBuild) {\n      // For a local build, fail if there were errors (but ignore warnings)\n      succeeded = messageRouter.errorCount === 0;\n    } else {\n      // For a production build, fail if there were any errors or warnings\n      succeeded = messageRouter.errorCount + messageRouter.warningCount === 0;\n    }\n\n    return new ExtractorResult({\n      compilerState,\n      extractorConfig,\n      succeeded,\n      apiReportChanged: anyReportChanged,\n      errorCount: messageRouter.errorCount,\n      warningCount: messageRouter.warningCount\n    });\n  }\n\n  /**\n   * Generates the API report at the specified release level, writes it to the specified file path, and compares\n   * the output to the existing report (if one exists).\n   *\n   * @param reportTempDirectoryPath - The path to the directory under which the temp report file will be written prior\n   * to comparison with an existing report.\n   * @param reportDirectoryPath - The path to the directory under which the existing report file is located, and to\n   * which the new report will be written post-comparison.\n   * @param reportConfig - API report configuration, including its file name and {@link ApiReportVariant}.\n   * @param printApiReportDiff - {@link IExtractorInvokeOptions.printApiReportDiff}\n   *\n   * @returns Whether or not the newly generated report differs from the existing report (if one exists).\n   */\n  private static _writeApiReport(\n    collector: Collector,\n    extractorConfig: ExtractorConfig,\n    messageRouter: MessageRouter,\n    reportTempDirectoryPath: string,\n    reportDirectoryPath: string,\n    reportConfig: IExtractorConfigApiReport,\n    localBuild: boolean,\n    printApiReportDiff: boolean\n  ): boolean {\n    let apiReportChanged: boolean = false;\n\n    const actualApiReportPath: string = path.resolve(reportTempDirectoryPath, reportConfig.fileName);\n    const actualApiReportShortPath: string = extractorConfig._getShortFilePath(actualApiReportPath);\n\n    const expectedApiReportPath: string = path.resolve(reportDirectoryPath, reportConfig.fileName);\n    const expectedApiReportShortPath: string = extractorConfig._getShortFilePath(expectedApiReportPath);\n\n    collector.messageRouter.logVerbose(\n      ConsoleMessageId.WritingApiReport,\n      `Generating ${reportConfig.variant} API report: ${expectedApiReportPath}`\n    );\n\n    const actualApiReportContent: string = ApiReportGenerator.generateReviewFileContent(\n      collector,\n      reportConfig.variant\n    );\n\n    // Write the actual file\n    FileSystem.writeFile(actualApiReportPath, actualApiReportContent, {\n      ensureFolderExists: true,\n      convertLineEndings: extractorConfig.newlineKind\n    });\n\n    // Compare it against the expected file\n    if (FileSystem.exists(expectedApiReportPath)) {\n      const expectedApiReportContent: string = FileSystem.readFile(expectedApiReportPath, {\n        convertLineEndings: NewlineKind.Lf\n      });\n\n      if (\n        !ApiReportGenerator.areEquivalentApiFileContents(actualApiReportContent, expectedApiReportContent)\n      ) {\n        apiReportChanged = true;\n\n        if (!localBuild) {\n          // For a production build, issue a warning that will break the CI build.\n          messageRouter.logWarning(\n            ConsoleMessageId.ApiReportNotCopied,\n            'You have changed the API signature for this project.' +\n              ` Please copy the file \"${actualApiReportShortPath}\" to \"${expectedApiReportShortPath}\",` +\n              ` or perform a local build (which does this automatically).` +\n              ` See the Git repo documentation for more info.`\n          );\n        } else {\n          // For a local build, just copy the file automatically.\n          messageRouter.logWarning(\n            ConsoleMessageId.ApiReportCopied,\n            `You have changed the API signature for this project. Updating ${expectedApiReportShortPath}`\n          );\n\n          FileSystem.writeFile(expectedApiReportPath, actualApiReportContent, {\n            ensureFolderExists: true,\n            convertLineEndings: extractorConfig.newlineKind\n          });\n        }\n\n        if (messageRouter.showVerboseMessages || printApiReportDiff) {\n          const Diff: typeof import('diff') = require('diff');\n          const patch: import('diff').StructuredPatch = Diff.structuredPatch(\n            expectedApiReportShortPath,\n            actualApiReportShortPath,\n            expectedApiReportContent,\n            actualApiReportContent\n          );\n          const logFunction:\n            | (typeof MessageRouter.prototype)['logWarning']\n            | (typeof MessageRouter.prototype)['logVerbose'] = printApiReportDiff\n            ? messageRouter.logWarning.bind(messageRouter)\n            : messageRouter.logVerbose.bind(messageRouter);\n\n          logFunction(\n            ConsoleMessageId.ApiReportDiff,\n            'Changes to the API report:\\n\\n' + Diff.formatPatch(patch)\n          );\n        }\n      } else {\n        messageRouter.logVerbose(\n          ConsoleMessageId.ApiReportUnchanged,\n          `The API report is up to date: ${actualApiReportShortPath}`\n        );\n      }\n    } else {\n      // The target file does not exist, so we are setting up the API review file for the first time.\n      //\n      // NOTE: People sometimes make a mistake where they move a project and forget to update the \"reportFolder\"\n      // setting, which causes a new file to silently get written to the wrong place.  This can be confusing.\n      // Thus we treat the initial creation of the file specially.\n      apiReportChanged = true;\n\n      if (!localBuild) {\n        // For a production build, issue a warning that will break the CI build.\n        messageRouter.logWarning(\n          ConsoleMessageId.ApiReportNotCopied,\n          'The API report file is missing.' +\n            ` Please copy the file \"${actualApiReportShortPath}\" to \"${expectedApiReportShortPath}\",` +\n            ` or perform a local build (which does this automatically).` +\n            ` See the Git repo documentation for more info.`\n        );\n      } else {\n        const expectedApiReportFolder: string = path.dirname(expectedApiReportPath);\n        if (!FileSystem.exists(expectedApiReportFolder)) {\n          messageRouter.logError(\n            ConsoleMessageId.ApiReportFolderMissing,\n            'Unable to create the API report file. Please make sure the target folder exists:\\n' +\n              expectedApiReportFolder\n          );\n        } else {\n          FileSystem.writeFile(expectedApiReportPath, actualApiReportContent, {\n            convertLineEndings: extractorConfig.newlineKind\n          });\n          messageRouter.logWarning(\n            ConsoleMessageId.ApiReportCreated,\n            'The API report file was missing, so a new file was created. Please add this file to Git:\\n' +\n              expectedApiReportPath\n          );\n        }\n      }\n    }\n    return apiReportChanged;\n  }\n\n  private static _checkCompilerCompatibility(\n    extractorConfig: ExtractorConfig,\n    messageRouter: MessageRouter\n  ): void {\n    messageRouter.logInfo(\n      ConsoleMessageId.Preamble,\n      `Analysis will use the bundled TypeScript version ${ts.version}`\n    );\n\n    try {\n      const typescriptPath: string = resolve.sync('typescript', {\n        basedir: extractorConfig.projectFolder,\n        preserveSymlinks: false\n      });\n      const packageJsonLookup: PackageJsonLookup = new PackageJsonLookup();\n      const packageJson: INodePackageJson | undefined =\n        packageJsonLookup.tryLoadNodePackageJsonFor(typescriptPath);\n      if (packageJson && packageJson.version && semver.valid(packageJson.version)) {\n        // Consider a newer MINOR release to be incompatible\n        const ourMajor: number = semver.major(ts.version);\n        const ourMinor: number = semver.minor(ts.version);\n\n        const theirMajor: number = semver.major(packageJson.version);\n        const theirMinor: number = semver.minor(packageJson.version);\n\n        if (theirMajor > ourMajor || (theirMajor === ourMajor && theirMinor > ourMinor)) {\n          messageRouter.logInfo(\n            ConsoleMessageId.CompilerVersionNotice,\n            `*** The target project appears to use TypeScript ${packageJson.version} which is newer than the` +\n              ` bundled compiler engine; consider upgrading API Extractor.`\n          );\n        }\n      }\n    } catch (e) {\n      // The compiler detection heuristic is not expected to work in many configurations\n    }\n  }\n\n  private static _generateRollupDtsFile(\n    collector: Collector,\n    outputPath: string,\n    dtsKind: DtsRollupKind,\n    newlineKind: NewlineKind\n  ): void {\n    if (outputPath !== '') {\n      collector.messageRouter.logVerbose(\n        ConsoleMessageId.WritingDtsRollup,\n        `Writing package typings: ${outputPath}`\n      );\n      DtsRollupGenerator.writeTypingsFile(collector, outputPath, dtsKind, newlineKind);\n    }\n  }\n}\n"]}