Update PR based upon reviewer feedback

Author: zelliott

apps/api-extractor/src/collector/Collector.ts

@@ -818,7 +818,7 @@ export class Collector {
         // Don't report missing release tags for forgotten exports
         const astSymbol: AstSymbol = astDeclaration.astSymbol;
         const entity: CollectorEntity | undefined = this._entitiesByAstEntity.get(astSymbol.rootAstSymbol);
-        if (entity && entity.exported) {
+        if (entity && entity.consumable) {
           // We also don't report errors for the default export of an entry point, since its doc comment
           // isn't easy to obtain from the .d.ts file
           if (astSymbol.rootAstSymbol.localName !== '_default') {

apps/api-extractor/src/collector/CollectorEntity.ts

@@ -96,21 +96,54 @@ export class CollectorEntity {
   }
 
   /**
-   * Returns true if the entity is exported from the entry point. If the entity is not exported,
+   * Indicates that this entity is exported from its parent module (i.e. either the package entry point or
+   * a local namespace).
+   *
+   * @remarks
+   * In the example below:
+   *
+   * ```ts
+   * declare function add(): void;
+   * declare namespace calculator {
+   *  export {
+   *    add
+   *  }
+   * }
+   * ```
+   *
+   * Namespace `calculator` is neither exported nor consumable, function `add` is exported (from `calculator`)
+   * but not consumable.
+   */
+  public get exported(): boolean {
+    const exportedFromTopLevel: boolean = this.exportNames.size > 0;
+
+    let exportedFromParent: boolean = false;
+    for (const localExportNames of this._localExportNamesByParent.values()) {
+      if (localExportNames.size > 0) {
+        exportedFromParent = true;
+        break;
+      }
+    }
+
+    return exportedFromTopLevel || exportedFromParent;
+  }
+
+  /**
+   * Indicates that it is possible for a consumer of the API to access this entity, either by importing
+   * it directly, or via some other alias such as a member of a namespace. If an entity is not consumable,
    * then API Extractor will report an `ae-forgotten-export` warning.
    *
    * @remarks
-   * An API item is exported if:
+   * An API item is consumable if:
    *
    * 1. It is exported from the top-level entry point OR
-   * 2. It is exported from a parent entity that is also exported.
+   * 2. It is exported from a consumable parent entity.
    *
-   * #2 occurs when processing `AstNamespaceImport` entities. A generated rollup.d.ts
+   * For an example of #2, consider how `AstNamespaceImport` entities are processed. A generated rollup.d.ts
    * might look like this:
    *
    * ```ts
    * declare function add(): void;
-   *
    * declare namespace calculator {
    *   export {
    *     add
@@ -119,14 +152,14 @@ export class CollectorEntity {
    * export { calculator }
    * ```
    *
-   * In this example, `add` is exported via the exported `calculator` namespace.
+   * In this example, `add` is exported via the consumable `calculator` namespace.
    */
-  public get exported(): boolean {
+  public get consumable(): boolean {
     const exportedFromTopLevel: boolean = this.exportNames.size > 0;
 
     let exportedFromExportedParent: boolean = false;
     for (const [parent, localExportNames] of this._localExportNamesByParent) {
-      if (localExportNames.size > 0 && parent.exported) {
+      if (localExportNames.size > 0 && parent.consumable) {
         exportedFromExportedParent = true;
         break;
       }

apps/api-extractor/src/enhancers/DocCommentEnhancer.ts

@@ -28,7 +28,7 @@ export class DocCommentEnhancer {
   public analyze(): void {
     for (const entity of this._collector.entities) {
       if (entity.astEntity instanceof AstSymbol) {
-        if (entity.exported || this._collector.extractorConfig.apiReportIncludeForgottenExports) {
+        if (entity.consumable || this._collector.extractorConfig.apiReportIncludeForgottenExports) {
           entity.astEntity.forEachDeclarationRecursive((astDeclaration: AstDeclaration) => {
             this._analyzeApiItem(astDeclaration);
           });

apps/api-extractor/src/enhancers/ValidationEnhancer.ts

@@ -21,7 +21,7 @@ export class ValidationEnhancer {
     const alreadyWarnedEntities: Set<AstEntity> = new Set<AstEntity>();
 
     for (const entity of collector.entities) {
-      if (!(entity.exported || collector.extractorConfig.apiReportIncludeForgottenExports)) {
+      if (!(entity.consumable || collector.extractorConfig.apiReportIncludeForgottenExports)) {
         continue;
       }
 
@@ -226,7 +226,7 @@ export class ValidationEnhancer {
         continue;
       }
 
-      if (collectorEntity && collectorEntity.exported) {
+      if (collectorEntity && collectorEntity.consumable) {
         if (ReleaseTag.compare(declarationReleaseTag, referencedReleaseTag) > 0) {
           collector.messageRouter.addAnalyzerIssue(
             ExtractorMessageId.IncompatibleReleaseTags,

apps/api-extractor/src/generators/ApiModelGenerator.ts

@@ -87,7 +87,7 @@ export class ApiModelGenerator {
       // processed by the parent.
       if (
         !entity.hasParents &&
-        (entity.exported || this._collector.extractorConfig.docModelIncludeForgottenExports)
+        (entity.consumable || this._collector.extractorConfig.docModelIncludeForgottenExports)
       ) {
         this._processAstEntity(entity.astEntity, entity.nameForEmit, apiEntryPoint);
       }

apps/api-extractor/src/generators/ApiReportGenerator.ts

@@ -78,7 +78,7 @@ export class ApiReportGenerator {
     // Emit the regular declarations
     for (const entity of collector.entities) {
       const astEntity: AstEntity = entity.astEntity;
-      if (entity.exported || collector.extractorConfig.apiReportIncludeForgottenExports) {
+      if (entity.consumable || collector.extractorConfig.apiReportIncludeForgottenExports) {
         // First, collect the list of export names for this symbol.  When reporting messages with
         // ExtractorMessage.properties.exportName, this will enable us to emit the warning comments alongside
         // the associated export statement.