Merge pull request #3630 from sranka/3629/fix

[api-extractor] fix references from computed properties

Author: octogonz

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

@@ -60,6 +60,7 @@ export class DeclarationReferenceGenerator {
   private static _isInExpressionContext(node: ts.Node): boolean {
     switch (node.parent.kind) {
       case ts.SyntaxKind.TypeQuery:
+      case ts.SyntaxKind.ComputedPropertyName:
         return true;
       case ts.SyntaxKind.QualifiedName:
         return DeclarationReferenceGenerator._isInExpressionContext(node.parent);

build-tests/api-extractor-scenarios/etc/referenceTokens/api-extractor-scenarios.api.json

@@ -791,6 +791,42 @@
           "name": "SomeInterface1",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "api-extractor-scenarios!SomeInterface1#[SomeSymbol1]:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SomeSymbol1",
+                  "canonicalReference": "api-extractor-scenarios!SomeSymbol1:var"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "[SomeSymbol1]",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "api-extractor-scenarios!SomeInterface1#prop:member",
@@ -817,9 +853,93 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "api-extractor-scenarios!SomeInterface1#ThisIsSomeVar1:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SomeVar1",
+                  "canonicalReference": "api-extractor-scenarios!SomeVar1:var"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "ThisIsSomeVar1",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              }
             }
           ],
           "extendsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "api-extractor-scenarios!SomeSymbol1:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "SomeSymbol1: "
+            },
+            {
+              "kind": "Content",
+              "text": "unique symbol"
+            }
+          ],
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "SomeSymbol1",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "api-extractor-scenarios!SomeVar1:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "SomeVar1 = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"ThisIsSomeVar1\""
+            }
+          ],
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "SomeVar1",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
         }
       ]
     }

build-tests/api-extractor-scenarios/etc/referenceTokens/api-extractor-scenarios.api.md

@@ -79,6 +79,20 @@ export interface SomeInterface1 {
     prop: number;
 }
 
+// @public
+export interface SomeInterface1 {
+    // (undocumented)
+    [SomeSymbol1]: () => string;
+    // (undocumented)
+    [SomeVar1]: () => string;
+}
+
+// @public (undocumented)
+export const SomeSymbol1: unique symbol;
+
+// @public (undocumented)
+export const SomeVar1 = "ThisIsSomeVar1";
+
 // (No @packageDocumentation comment for this package)
 
 ```

build-tests/api-extractor-scenarios/etc/referenceTokens/rollup.d.ts

@@ -86,4 +86,19 @@ export declare interface SomeInterface1 {
     prop: number;
 }
 
+/**
+ * References to computed properties.
+ * @public
+ */
+export declare interface SomeInterface1 {
+    [SomeVar1]: () => string;
+    [SomeSymbol1]: () => string;
+}
+
+/** @public */
+export declare const SomeSymbol1: unique symbol;
+
+/** @public */
+export declare const SomeVar1 = "ThisIsSomeVar1";
+
 export { }

build-tests/api-extractor-scenarios/src/referenceTokens/index.ts

@@ -102,3 +102,16 @@ export function someFunction8({ prop: prop2 }: Lib2Class): void {}
  * @public
  */
 export class SomeClass4 extends SomeClass5 {}
+
+/** @public */
+export const SomeSymbol1 = Symbol('ThisIsSomeSymbol1');
+/** @public */
+export const SomeVar1 = 'ThisIsSomeVar1';
+/**
+ * References to computed properties.
+ * @public
+ */
+export interface SomeInterface1 {
+  [SomeVar1]: () => string;
+  [SomeSymbol1]: () => string;
+}

common/changes/@microsoft/api-extractor/3629-fix_2022-09-14-19-34.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "Fix references from computed properties #3629",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor"
+}