import { DocCollection, Processor } from 'dgeni'; import { ConstExportDoc } from 'dgeni-packages/typescript/api-doc-types/ConstExportDoc'; import { FunctionExportDoc } from 'dgeni-packages/typescript/api-doc-types/FunctionExportDoc'; import { InterfaceExportDoc } from 'dgeni-packages/typescript/api-doc-types/InterfaceExportDoc'; import { TypeAliasExportDoc } from 'dgeni-packages/typescript/api-doc-types/TypeAliasExportDoc'; import { NgEntryPoint } from 'ng-packagr/lib/ng-package/entry-point/entry-point'; import { CategorizedClassDoc } from '../common/dgeni-definitions'; export interface ModuleInfo { /** Name of the module (e.g. toolbar, drag-drop, ripple, slider-testing) */ name: string; /** Name of the package that contains this entry point. */ packageName: string; /** Name of the entry-point that contains this module. */ entryPointName: string; } /** Document type for an entry-point. */ export declare class EntryPointDoc { /** Unique document type for Dgeni. */ docType: string; /** Name of the component group. */ name: string; /** Display name of the entry-point. */ displayName: string; /** Module import path for the entry-point. */ moduleImportPath: string; /** Name of the package, either material or cdk */ packageName: string; /** Display name of the package. */ /** Unique id for the entry-point. */ id: string; /** Known aliases for the entry-point. This is only needed for the `computeIdsProcessor`. */ aliases: string[]; /** List of categorized class docs that are defining a directive. */ directives: CategorizedClassDoc[]; /** List of categorized class docs that are defining a pipe. */ pipes: CategorizedClassDoc[]; /** List of categorized class docs that are defining a service. */ services: CategorizedClassDoc[]; /** Classes that belong to the entry-point. */ classes: CategorizedClassDoc[]; /** Interfaces that belong to the entry-point. */ interfaces: InterfaceExportDoc[]; /** Type aliases that belong to the entry-point. */ typeAliases: TypeAliasExportDoc[]; /** Functions that belong to the entry-point. */ functions: FunctionExportDoc[]; /** Constants that belong to the entry-point. */ constants: ConstExportDoc[]; /** List of NgModules which are exported in the current entry-point. */ exportedNgModules: CategorizedClassDoc[]; /** List of test harnesses which are exported in the entry-point. */ testHarnesses: CategorizedClassDoc[]; /** * Name of the primary export of the entry-point. This export will be showed * in the API docs as export when show-casing the import to the entry-point. */ primaryExportName: string | null; constructor(name: string); } /** * Processor to group docs into entry-points that consist of directives, component, classes, * interfaces, functions or type aliases. */ export declare class EntryPointGrouper implements Processor { name: string; $runBefore: string[]; $runAfter: string[]; entryPoints: NgEntryPoint[]; $process(docs: DocCollection): EntryPointDoc[]; private hasExports; /** * Walks through the specified API documents and looks for the best * API document that could serve as primary export of an entry-point. */ private _findBestPrimaryExport; /** * Resolves entrypoint of the given Dgeni document. */ private _getDocumentEntryPoint; /** Finds the matching entry-point of the given file path. */ private _findMatchingEntryPoint; }