Merge pull request #96 from SimplrJS/dev

v4.0.0-beta.8

Author: Martynas Žilinskas

package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-extractor",
-    "version": "4.0.0-beta.7",
+    "version": "4.0.0-beta.8",
     "description": "TypeScript AST extractor to useful JSON structure.",
     "keywords": [
         "typescript",

src/abstractions/api-callable-base.ts

@@ -3,25 +3,30 @@ import { ApiItem } from "../abstractions/api-item";
 
 import { ApiHelpers } from "../api-helpers";
 import { ApiItemReference } from "../contracts/api-item-reference";
-import { ApiType } from "../contracts/api-type";
-import { ApiCallableDto } from "../contracts/api-callable-dto";
+import { ApiType } from "../contracts/api-types";
+import { ApiCallableBaseDefinition } from "../contracts/api-definitions";
 import { ApiTypeHelpers } from "../api-type-helpers";
+import { ApiItemLocationDto } from "../contracts";
 
 /**
  * A callable api item base.
  */
 export abstract class ApiCallableBase<
     TDeclaration extends ts.SignatureDeclaration,
-    TExtractDto extends ApiCallableDto
+    TExtractDto extends ApiCallableBaseDefinition
     >
     extends ApiItem<TDeclaration, TExtractDto> {
 
     protected IsOverloadBase: boolean;
     protected Parameters: ApiItemReference[] = [];
     protected TypeParameters: ApiItemReference[] = [];
     protected ReturnType: ApiType | undefined;
+    protected Location: ApiItemLocationDto;
 
     protected OnGatherData(): void {
+        // ApiItemLocation
+        this.Location = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
+
         // Overload
         this.IsOverloadBase = this.TypeChecker.isImplementationOfOverload(this.Declaration as ts.FunctionLike) || false;
 
@@ -38,7 +43,7 @@ export abstract class ApiCallableBase<
         if (signature != null) {
             const type = this.TypeChecker.getReturnTypeOfSignature(signature);
 
-            this.ReturnType = ApiTypeHelpers.ResolveApiType(this.Options, type, this.Declaration.type);
+            this.ReturnType = ApiTypeHelpers.ResolveApiType(this.Options, this.Location, type, this.Declaration.type);
         }
     }
 }

src/abstractions/api-item.ts

@@ -1,6 +1,6 @@
 import * as ts from "typescript";
 
-import { ApiBaseItemDto, TypeScriptTypeDeclarationDebug } from "../contracts/api-base-item-dto";
+import { ApiBaseDefinition, TypeScriptTypeDeclarationDebug } from "../contracts/api-definitions";
 import { ApiMetadataDto } from "../contracts/api-metadata-dto";
 import { ExtractorOptions } from "../contracts/extractor-options";
 import { ReadonlyRegistry } from "../contracts/registry";
@@ -20,7 +20,7 @@ export enum ApiItemStatus {
     GatheredAndExtracted = Gathered | Extracted
 }
 
-export abstract class ApiItem<TDeclaration extends ts.Declaration = ts.Declaration, TExtractDto = ApiBaseItemDto> {
+export abstract class ApiItem<TDeclaration extends ts.Declaration = ts.Declaration, TExtractDto = ApiBaseDefinition> {
     constructor(private declaration: TDeclaration, private symbol: ts.Symbol, private options: ApiItemOptions) {
         this.TypeChecker = options.Program.getTypeChecker();
     }

src/api-helpers.ts

@@ -6,7 +6,7 @@ import { ApiItem, ApiItemOptions } from "./abstractions/api-item";
 
 import { ApiItemReference } from "./contracts/api-item-reference";
 import { AccessModifier } from "./contracts/access-modifier";
-import { TSHelpers } from "./ts-helpers";
+import { TsHelpers } from "./ts-helpers";
 import { Logger } from "./utils/logger";
 import { ApiItemLocationDto } from "./contracts/api-item-location-dto";
 
@@ -35,7 +35,7 @@ import { ApiCall } from "./definitions/api-call";
 import { ApiConstruct } from "./definitions/api-construct";
 import { ApiTypeParameter } from "./definitions/api-type-parameter";
 import { ApiTypeLiteral } from "./definitions/api-type-literal";
-import { ApiFunctionType } from "./definitions/api-function-type";
+import { ApiFunctionExpression } from "./definitions/api-function-expression";
 import { ApiMapped } from "./definitions/api-mapped";
 import { PathIsInside } from "./utils/path-is-inside";
 
@@ -97,7 +97,7 @@ export namespace ApiHelpers {
         } else if (ts.isTypeLiteralNode(declaration) || ts.isObjectLiteralExpression(declaration)) {
             apiItem = new ApiTypeLiteral(declaration, symbol, options);
         } else if (ts.isFunctionTypeNode(declaration) || ts.isArrowFunction(declaration) || ts.isFunctionExpression(declaration)) {
-            apiItem = new ApiFunctionType(declaration, symbol, options);
+            apiItem = new ApiFunctionExpression(declaration, symbol, options);
         } else if (ts.isMappedTypeNode(declaration)) {
             apiItem = new ApiMapped(declaration, symbol, options);
         }
@@ -147,7 +147,7 @@ export namespace ApiHelpers {
             return options.Registry.GetDeclarationId(declaration);
         }
 
-        const resolveRealSymbol = TSHelpers.FollowSymbolAliases(symbol, options.Program.getTypeChecker());
+        const resolveRealSymbol = TsHelpers.FollowSymbolAliases(symbol, options.Program.getTypeChecker());
         const apiItem = VisitApiItem(declaration, resolveRealSymbol, options);
         if (apiItem == null) {
             return undefined;
@@ -212,7 +212,7 @@ export namespace ApiHelpers {
         const typeChecker = options.Program.getTypeChecker();
 
         declarations.forEach(declaration => {
-            const symbol = TSHelpers.GetSymbolFromDeclaration(declaration, typeChecker);
+            const symbol = TsHelpers.GetSymbolFromDeclaration(declaration, typeChecker);
             if (symbol == null) {
                 return;
             }
@@ -277,6 +277,11 @@ export namespace ApiHelpers {
         Logger.Log(logLevel, `${linePrefix}: ${message}`);
     }
 
+    export function LogWithLocation(logLevel: LogLevel, location: ApiItemLocationDto, message: string): void {
+        const linePrefix = `${location.FileName}(${location.Line + 1},${location.Character + 1})`;
+        Logger.Log(logLevel, `${linePrefix}: ${message}`);
+    }
+
     export function StandardizeRelativePath(location: string, options: ApiItemOptions): string {
         const workingSep = options.ExtractorOptions.OutputPathSeparator;
         const fixedLocation = location.split(path.sep).join(workingSep);
@@ -326,7 +331,7 @@ export namespace ApiHelpers {
             return undefined;
         }
 
-        const parentSymbol = TSHelpers.GetSymbolFromDeclaration(parentDeclaration, options.Program.getTypeChecker());
+        const parentSymbol = TsHelpers.GetSymbolFromDeclaration(parentDeclaration, options.Program.getTypeChecker());
         if (parentSymbol == null) {
             return undefined;
         }

src/api-registry.ts

@@ -2,9 +2,9 @@ import * as ts from "typescript";
 import { ApiItem } from "./abstractions/api-item";
 import { Dictionary } from "./contracts/dictionary";
 import { Registry } from "./contracts/registry";
-import { ApiItemDto } from "./contracts/api-item-dto";
+import { ApiDefinition } from "./contracts/api-definitions";
 
-export type ExtractedApiRegistry = Dictionary<ApiItemDto>;
+export type ExtractedApiRegistry = Dictionary<ApiDefinition>;
 
 export class ApiRegistry implements Registry<ApiItem> {
     protected registry: Map<string, ApiItem> = new Map<string, ApiItem>();
@@ -20,7 +20,7 @@ export class ApiRegistry implements Registry<ApiItem> {
         for (const [key, apiItem] of this.Registry) {
             const extractedData = apiItem.Extract(forceExtract);
 
-            this.ExtractedData[key] = extractedData as ApiItemDto;
+            this.ExtractedData[key] = extractedData as ApiDefinition;
         }
 
         this.IsDataExtracted = true;