@microsoft/api-extractor 7.32.1 → 7.33.1

package/lib/generators/ApiModelGenerator.js

@@ -27,6 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiModelGenerator = void 0;
 /* eslint-disable no-bitwise */
+const path = __importStar(require("path"));
 const ts = __importStar(require("typescript"));
 const api_extractor_model_1 = require("@microsoft/api-extractor-model");
 const ExcerptBuilder_1 = require("./ExcerptBuilder");
@@ -48,7 +49,8 @@ class ApiModelGenerator {
         const apiPackage = new api_extractor_model_1.ApiPackage({
             name: this._collector.workingPackage.name,
             docComment: packageDocComment,
-            tsdocConfiguration: this._collector.extractorConfig.tsdocConfiguration
+            tsdocConfiguration: this._collector.extractorConfig.tsdocConfiguration,
+            projectFolderUrl: this._collector.extractorConfig.projectFolderUrl
         });
         this._apiModel.addMember(apiPackage);
         const apiEntryPoint = new api_extractor_model_1.ApiEntryPoint({ name: '' });
@@ -101,6 +103,7 @@ class ApiModelGenerator {
         const astModule = astNamespaceImport.astModule;
         const { name, isExported, parentApiItem } = context;
         const containerKey = api_extractor_model_1.ApiNamespace.getContainerKey(name);
+        const fileUrlPath = this._getFileUrlPath(astNamespaceImport.declaration);
         let apiNamespace = parentApiItem.tryGetMemberByKey(containerKey);
         if (apiNamespace === undefined) {
             apiNamespace = new api_extractor_model_1.ApiNamespace({
@@ -108,7 +111,8 @@ class ApiModelGenerator {
                 docComment: undefined,
                 releaseTag: api_extractor_model_1.ReleaseTag.None,
                 excerptTokens: [],
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiNamespace);
         }
@@ -209,6 +213,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(callSignature);
             apiCallSignature = new api_extractor_model_1.ApiCallSignature({
                 docComment,
                 releaseTag,
@@ -216,7 +221,8 @@ class ApiModelGenerator {
                 parameters,
                 overloadIndex,
                 excerptTokens,
-                returnTypeTokenRange
+                returnTypeTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiCallSignature);
         }
@@ -235,13 +241,15 @@ class ApiModelGenerator {
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const isProtected = (astDeclaration.modifierFlags & ts.ModifierFlags.Protected) !== 0;
+            const fileUrlPath = this._getFileUrlPath(constructorDeclaration);
             apiConstructor = new api_extractor_model_1.ApiConstructor({
                 docComment,
                 releaseTag,
                 isProtected,
                 parameters,
                 overloadIndex,
-                excerptTokens
+                excerptTokens,
+                fileUrlPath
             });
             parentApiItem.addMember(apiConstructor);
         }
@@ -275,6 +283,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(classDeclaration);
             apiClass = new api_extractor_model_1.ApiClass({
                 name,
                 docComment,
@@ -283,7 +292,8 @@ class ApiModelGenerator {
                 typeParameters,
                 extendsTokenRange,
                 implementsTokenRanges,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiClass);
         }
@@ -305,6 +315,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(constructSignature);
             apiConstructSignature = new api_extractor_model_1.ApiConstructSignature({
                 docComment,
                 releaseTag,
@@ -312,7 +323,8 @@ class ApiModelGenerator {
                 parameters,
                 overloadIndex,
                 excerptTokens,
-                returnTypeTokenRange
+                returnTypeTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiConstructSignature);
         }
@@ -327,13 +339,15 @@ class ApiModelGenerator {
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const preserveMemberOrder = this._collector.extractorConfig.enumMemberOrder === api_extractor_model_1.EnumMemberOrder.Preserve;
+            const fileUrlPath = this._getFileUrlPath(astDeclaration.declaration);
             apiEnum = new api_extractor_model_1.ApiEnum({
                 name,
                 docComment,
                 releaseTag,
                 excerptTokens,
                 preserveMemberOrder,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiEnum);
         }
@@ -355,12 +369,14 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(enumMember);
             apiEnumMember = new api_extractor_model_1.ApiEnumMember({
                 name,
                 docComment,
                 releaseTag,
                 excerptTokens,
-                initializerTokenRange
+                initializerTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiEnumMember);
         }
@@ -381,6 +397,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(functionDeclaration);
             apiFunction = new api_extractor_model_1.ApiFunction({
                 name,
                 docComment,
@@ -390,7 +407,8 @@ class ApiModelGenerator {
                 overloadIndex,
                 excerptTokens,
                 returnTypeTokenRange,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiFunction);
         }
@@ -411,6 +429,7 @@ class ApiModelGenerator {
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const isReadonly = this._isReadonly(astDeclaration);
+            const fileUrlPath = this._getFileUrlPath(indexSignature);
             apiIndexSignature = new api_extractor_model_1.ApiIndexSignature({
                 docComment,
                 releaseTag,
@@ -418,7 +437,8 @@ class ApiModelGenerator {
                 overloadIndex,
                 excerptTokens,
                 returnTypeTokenRange,
-                isReadonly
+                isReadonly,
+                fileUrlPath
             });
             parentApiItem.addMember(apiIndexSignature);
         }
@@ -445,6 +465,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(interfaceDeclaration);
             apiInterface = new api_extractor_model_1.ApiInterface({
                 name,
                 docComment,
@@ -452,7 +473,8 @@ class ApiModelGenerator {
                 excerptTokens,
                 typeParameters,
                 extendsTokenRanges,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiInterface);
         }
@@ -480,6 +502,7 @@ class ApiModelGenerator {
             }
             const isOptional = (astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
             const isProtected = (astDeclaration.modifierFlags & ts.ModifierFlags.Protected) !== 0;
+            const fileUrlPath = this._getFileUrlPath(methodDeclaration);
             apiMethod = new api_extractor_model_1.ApiMethod({
                 name,
                 docComment,
@@ -491,7 +514,8 @@ class ApiModelGenerator {
                 parameters,
                 overloadIndex,
                 excerptTokens,
-                returnTypeTokenRange
+                returnTypeTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiMethod);
         }
@@ -513,6 +537,7 @@ class ApiModelGenerator {
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const isOptional = (astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
+            const fileUrlPath = this._getFileUrlPath(methodSignature);
             apiMethodSignature = new api_extractor_model_1.ApiMethodSignature({
                 name,
                 docComment,
@@ -522,7 +547,8 @@ class ApiModelGenerator {
                 parameters,
                 overloadIndex,
                 excerptTokens,
-                returnTypeTokenRange
+                returnTypeTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiMethodSignature);
         }
@@ -536,7 +562,15 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
-            apiNamespace = new api_extractor_model_1.ApiNamespace({ name, docComment, releaseTag, excerptTokens, isExported });
+            const fileUrlPath = this._getFileUrlPath(astDeclaration.declaration);
+            apiNamespace = new api_extractor_model_1.ApiNamespace({
+                name,
+                docComment,
+                releaseTag,
+                excerptTokens,
+                isExported,
+                fileUrlPath
+            });
             parentApiItem.addMember(apiNamespace);
         }
         this._processChildDeclarations(astDeclaration, Object.assign(Object.assign({}, context), { parentApiItem: apiNamespace }));
@@ -571,6 +605,7 @@ class ApiModelGenerator {
             const isOptional = (astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
             const isProtected = (astDeclaration.modifierFlags & ts.ModifierFlags.Protected) !== 0;
             const isReadonly = this._isReadonly(astDeclaration);
+            const fileUrlPath = this._getFileUrlPath(declaration);
             apiProperty = new api_extractor_model_1.ApiProperty({
                 name,
                 docComment,
@@ -581,7 +616,8 @@ class ApiModelGenerator {
                 isReadonly,
                 excerptTokens,
                 propertyTypeTokenRange,
-                initializerTokenRange
+                initializerTokenRange,
+                fileUrlPath
             });
             parentApiItem.addMember(apiProperty);
         }
@@ -605,6 +641,7 @@ class ApiModelGenerator {
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const isOptional = (astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
             const isReadonly = this._isReadonly(astDeclaration);
+            const fileUrlPath = this._getFileUrlPath(propertySignature);
             apiPropertySignature = new api_extractor_model_1.ApiPropertySignature({
                 name,
                 docComment,
@@ -612,7 +649,8 @@ class ApiModelGenerator {
                 isOptional,
                 excerptTokens,
                 propertyTypeTokenRange,
-                isReadonly
+                isReadonly,
+                fileUrlPath
             });
             parentApiItem.addMember(apiPropertySignature);
         }
@@ -635,6 +673,7 @@ class ApiModelGenerator {
             const apiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
+            const fileUrlPath = this._getFileUrlPath(typeAliasDeclaration);
             apiTypeAlias = new api_extractor_model_1.ApiTypeAlias({
                 name,
                 docComment,
@@ -642,7 +681,8 @@ class ApiModelGenerator {
                 releaseTag,
                 excerptTokens,
                 typeTokenRange,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiTypeAlias);
         }
@@ -666,6 +706,7 @@ class ApiModelGenerator {
             const docComment = apiItemMetadata.tsdocComment;
             const releaseTag = apiItemMetadata.effectiveReleaseTag;
             const isReadonly = this._isReadonly(astDeclaration);
+            const fileUrlPath = this._getFileUrlPath(variableDeclaration);
             apiVariable = new api_extractor_model_1.ApiVariable({
                 name,
                 docComment,
@@ -674,7 +715,8 @@ class ApiModelGenerator {
                 variableTypeTokenRange,
                 initializerTokenRange,
                 isReadonly,
-                isExported
+                isExported,
+                fileUrlPath
             });
             parentApiItem.addMember(apiVariable);
         }
@@ -750,6 +792,14 @@ class ApiModelGenerator {
             }
         }
     }
+    _getFileUrlPath(declaration) {
+        const sourceFile = declaration.getSourceFile();
+        const sourceLocation = this._collector.sourceMapper.getSourceLocation({
+            sourceFile,
+            pos: declaration.pos
+        });
+        return path.posix.relative(this._collector.extractorConfig.projectFolder, sourceLocation.sourceFilePath);
+    }
 }
 exports.ApiModelGenerator = ApiModelGenerator;
 //# sourceMappingURL=ApiModelGenerator.js.map