Merge pull request #89 from SimplrJS/dev

v4.0.0-beta.5
SimplrJS · Jan 16, 2018 · 4b6f1ee · 4b6f1ee
2 parents 4a92793 + fbc7b3e
commit 4b6f1ee
Show file tree

Hide file tree

Showing 109 changed files with 896 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ts-extractor",
-    "version": "4.0.0-beta.4",
+    "version": "4.0.0-beta.5",
     "description": "TypeScript AST extractor to useful JSON structure.",
     "keywords": [
         "typescript",

diff --git a/src/abstractions/api-item.ts b/src/abstractions/api-item.ts
@@ -52,6 +52,9 @@ export abstract class ApiItem<TDeclaration extends ts.Declaration = ts.Declarati
         return this.ItemStatus;
     }
 
+    /**
+     * It gives precise TypeScript information about item after extracting.
+     */
     protected GetTsDebugInfo(): TypeScriptTypeDeclarationDebug | undefined {
         if (this.Options.ExtractorOptions.IncludeTsDebugInfo) {
             return {

diff --git a/src/api-helpers.ts b/src/api-helpers.ts
@@ -306,4 +306,21 @@ export namespace ApiHelpers {
             IsExternalPackage: isExternalPackage
         };
     }
+
+    /**
+     * Get parent reference id from declaration.
+     */
+    export function GetParentIdFromDeclaration(declaration: ts.Declaration, options: ApiItemOptions): string | undefined {
+        const parentDeclaration = declaration.parent as ts.Declaration;
+        if (parentDeclaration == null) {
+            return undefined;
+        }
+
+        const parentSymbol = TSHelpers.GetSymbolFromDeclaration(parentDeclaration, options.Program.getTypeChecker());
+        if (parentSymbol == null) {
+            return undefined;
+        }
+
+        return ApiHelpers.GetItemId(parentDeclaration, parentSymbol, options);
+    }
 }
diff --git a/src/contracts/api-base-item-dto.ts b/src/contracts/api-base-item-dto.ts
@@ -16,5 +16,12 @@ export interface ApiBaseItemDto {
     ApiKind: ApiItemKinds;
     Metadata: ApiMetadataDto;
     Location: ApiItemLocationDto;
+    /**
+     * Parent reference id.
+     */
+    ParentId: string | undefined;
+    /**
+     * TypeScript debug info.
+     */
     _ts?: TypeScriptTypeDeclarationDebug;
 }
diff --git a/src/definitions/api-call.ts b/src/definitions/api-call.ts
@@ -9,12 +9,14 @@ import { ApiItemLocationDto } from "../contracts/api-item-location-dto";
 
 export class ApiCall extends ApiCallableBase<ts.CallSignatureDeclaration, ApiCallDto> {
     public OnExtract(): ApiCallDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Call,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-class-constructor.ts b/src/definitions/api-class-constructor.ts
@@ -27,12 +27,14 @@ export class ApiClassConstructor extends ApiItem<ts.ConstructorDeclaration, ApiC
     }
 
     public OnExtract(): ApiClassConstructorDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.ClassConstructor,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.isOverloadBase,

diff --git a/src/definitions/api-class-method.ts b/src/definitions/api-class-method.ts
@@ -30,12 +30,14 @@ export class ApiClassMethod extends ApiCallableBase<ts.MethodDeclaration, ApiCla
     }
 
     public OnExtract(): ApiClassMethodDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.ClassMethod,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-class-property.ts b/src/definitions/api-class-property.ts
@@ -34,12 +34,14 @@ export class ApiClassProperty extends ApiItem<ts.PropertyDeclaration, ApiClassPr
     }
 
     public OnExtract(): ApiClassPropertyDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.ClassProperty,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             AccessModifier: this.accessModifier,

diff --git a/src/definitions/api-class.ts b/src/definitions/api-class.ts
@@ -50,12 +50,14 @@ export class ApiClass extends ApiItem<ts.ClassDeclaration, ApiClassDto> {
     }
 
     public OnExtract(): ApiClassDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Class,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsAbstract: this.isAbstract,

diff --git a/src/definitions/api-construct.ts b/src/definitions/api-construct.ts
@@ -10,12 +10,14 @@ import { ApiItemLocationDto } from "../contracts/api-item-location-dto";
 
 export class ApiConstruct extends ApiCallableBase<ts.ConstructSignatureDeclaration | ts.ConstructorTypeNode, ApiConstructDto> {
     public OnExtract(): ApiConstructDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Construct,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-enum-member.ts b/src/definitions/api-enum-member.ts
@@ -36,13 +36,15 @@ export class ApiEnumMember extends ApiItem<ts.EnumMember, ApiEnumMemberDto> {
     }
 
     public OnExtract(): ApiEnumMemberDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
         const value: string = this.GetValue();
 
         return {
             ApiKind: ApiItemKinds.EnumMember,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             Value: value,

diff --git a/src/definitions/api-enum.ts b/src/definitions/api-enum.ts
@@ -22,12 +22,14 @@ export class ApiEnum extends ApiItem<ts.EnumDeclaration, ApiEnumDto> {
     }
 
     public OnExtract(): ApiEnumDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Enum,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsConst: this.isConst,

diff --git a/src/definitions/api-export-specifier.ts b/src/definitions/api-export-specifier.ts
@@ -23,12 +23,14 @@ export class ApiExportSpecifier extends ApiItem<ts.ExportSpecifier, ApiExportSpe
     }
 
     public OnExtract(): ApiExportSpecifierDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.ExportSpecifier,
             Name: this.Declaration.name.getText(),
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             ApiItems: this.apiItems,

diff --git a/src/definitions/api-export.ts b/src/definitions/api-export.ts
@@ -43,13 +43,15 @@ export class ApiExport extends ApiItem<ts.ExportDeclaration, ApiExportDto> {
     }
 
     public OnExtract(): ApiExportDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const exportPath: string | undefined = this.getExportPath();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Export,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             SourceFileId: this.sourceFileId,

diff --git a/src/definitions/api-function-type.ts b/src/definitions/api-function-type.ts
@@ -9,12 +9,14 @@ import { ApiItemLocationDto } from "../contracts/api-item-location-dto";
 
 export class ApiFunctionType extends ApiCallableBase<ts.FunctionTypeNode, ApiFunctionTypeDto> {
     public OnExtract(): ApiFunctionTypeDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.FunctionType,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-function.ts b/src/definitions/api-function.ts
@@ -18,12 +18,14 @@ export class ApiFunction extends ApiCallableBase<ts.FunctionDeclaration, ApiFunc
     }
 
     public OnExtract(): ApiFunctionDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Function,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-get-accessor.ts b/src/definitions/api-get-accessor.ts
@@ -28,12 +28,14 @@ export class ApiGetAccessor extends ApiItem<ts.GetAccessorDeclaration, ApiGetAcc
     }
 
     public OnExtract(): ApiGetAccessorDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.GetAccessor,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             AccessModifier: this.accessModifier,

diff --git a/src/definitions/api-import-specifier.ts b/src/definitions/api-import-specifier.ts
@@ -24,12 +24,14 @@ export class ApiImportSpecifier extends ApiItem<ts.ImportSpecifier, ApiImportSpe
     }
 
     public OnExtract(): ApiImportSpecifierDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.ImportSpecifier,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             ApiItems: this.apiItems,

diff --git a/src/definitions/api-index.ts b/src/definitions/api-index.ts
@@ -44,12 +44,14 @@ export class ApiIndex extends ApiItem<ts.IndexSignatureDeclaration, ApiIndexDto>
     }
 
     public OnExtract(): ApiIndexDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Index,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             Parameter: this.parameter,

diff --git a/src/definitions/api-interface.ts b/src/definitions/api-interface.ts
@@ -34,12 +34,14 @@ export class ApiInterface extends ApiItem<ts.InterfaceDeclaration, ApiInterfaceD
     }
 
     public OnExtract(): ApiInterfaceDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Interface,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             Members: this.members,

diff --git a/src/definitions/api-mapped.ts b/src/definitions/api-mapped.ts
@@ -39,12 +39,14 @@ export class ApiMapped extends ApiItem<ts.MappedTypeNode, ApiMappedDto> {
     }
 
     public OnExtract(): ApiMappedDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Mapped,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             TypeParameter: this.typeParameter,

diff --git a/src/definitions/api-method.ts b/src/definitions/api-method.ts
@@ -19,12 +19,14 @@ export class ApiMethod extends ApiCallableBase<ts.MethodSignature, ApiMethodDto>
     }
 
     public OnExtract(): ApiMethodDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Method,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOverloadBase: this.IsOverloadBase,

diff --git a/src/definitions/api-namespace.ts b/src/definitions/api-namespace.ts
@@ -17,12 +17,14 @@ export class ApiNamespace extends ApiItem<ts.ModuleDeclaration | ts.NamespaceImp
     }
 
     public OnExtract(): ApiNamespaceDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Namespace,
             Name: this.Declaration.name.getText(),
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             Members: this.members,

diff --git a/src/definitions/api-parameter.ts b/src/definitions/api-parameter.ts
@@ -31,12 +31,14 @@ export class ApiParameter extends ApiItem<ts.ParameterDeclaration, ApiParameterD
     }
 
     public OnExtract(): ApiParameterDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Parameter,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOptional: this.isOptional,

diff --git a/src/definitions/api-property.ts b/src/definitions/api-property.ts
@@ -27,12 +27,14 @@ export class ApiProperty extends ApiItem<ts.PropertySignature, ApiPropertyDto> {
     }
 
     public OnExtract(): ApiPropertyDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.Property,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             IsOptional: this.isOptional,

diff --git a/src/definitions/api-set-accessor.ts b/src/definitions/api-set-accessor.ts
@@ -38,12 +38,14 @@ export class ApiSetAccessor extends ApiItem<ts.SetAccessorDeclaration, ApiSetAcc
     }
 
     public OnExtract(): ApiSetAccessorDto {
+        const parentId: string | undefined = ApiHelpers.GetParentIdFromDeclaration(this.Declaration, this.Options);
         const metadata: ApiMetadataDto = this.GetItemMetadata();
         const location: ApiItemLocationDto = ApiHelpers.GetApiItemLocationDtoFromNode(this.Declaration, this.Options);
 
         return {
             ApiKind: ApiItemKinds.SetAccessor,
             Name: this.Symbol.name,
+            ParentId: parentId,
             Metadata: metadata,
             Location: location,
             AccessModifier: this.accessModifier,