Update imports for api-extractor and api-documenter projects to use api-extractor-model exports

octogonz · octogonz · commit fc65d36393c5 · 2019-03-09T21:36:10.000-08:00
diff --git a/apps/api-documenter/src/cli/BaseAction.ts b/apps/api-documenter/src/cli/BaseAction.ts
@@ -8,7 +8,7 @@ import {
   CommandLineStringParameter
 } from '@microsoft/ts-command-line';
 import { FileSystem } from '@microsoft/node-core-library';
-import { ApiModel } from '@microsoft/api-extractor';
+import { ApiModel } from '@microsoft/api-extractor-model';
 
 export abstract class BaseAction extends CommandLineAction {
   protected inputFolder: string;
diff --git a/apps/api-documenter/src/cli/MarkdownAction.ts b/apps/api-documenter/src/cli/MarkdownAction.ts
@@ -4,7 +4,7 @@
 import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
 import { MarkdownDocumenter } from '../documenters/MarkdownDocumenter';
-import { ApiModel } from '@microsoft/api-extractor';
+import { ApiModel } from '@microsoft/api-extractor-model';
 
 export class MarkdownAction extends BaseAction {
   constructor(parser: ApiDocumenterCommandLine) {
diff --git a/apps/api-documenter/src/cli/YamlAction.ts b/apps/api-documenter/src/cli/YamlAction.ts
@@ -10,7 +10,7 @@ import { BaseAction } from './BaseAction';
 
 import { YamlDocumenter } from '../documenters/YamlDocumenter';
 import { OfficeYamlDocumenter } from '../documenters/OfficeYamlDocumenter';
-import { ApiModel } from '@microsoft/api-extractor';
+import { ApiModel } from '@microsoft/api-extractor-model';
 
 export class YamlAction extends BaseAction {
   private _officeParameter: CommandLineFlagParameter;
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -40,7 +40,7 @@ import {
   ApiReturnTypeMixin,
   ApiDeclaredItem,
   ApiNamespace
-} from '@microsoft/api-extractor';
+} from '@microsoft/api-extractor-model';
 
 import { CustomDocNodes } from '../nodes/CustomDocNodeKind';
 import { DocHeading } from '../nodes/DocHeading';
diff --git a/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts b/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts
@@ -5,7 +5,7 @@ import * as colors from 'colors';
 import * as path from 'path';
 import yaml = require('js-yaml');
 
-import { ApiModel } from '@microsoft/api-extractor';
+import { ApiModel } from '@microsoft/api-extractor-model';
 import { Text, FileSystem } from '@microsoft/node-core-library';
 
 import { IYamlTocItem } from '../yaml/IYamlTocFile';
diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts
@@ -32,7 +32,7 @@ import {
   ApiConstructor,
   ApiFunction,
   ApiReturnTypeMixin
-} from '@microsoft/api-extractor';
+} from '@microsoft/api-extractor-model';
 
 import {
   IYamlApiFile,
diff --git a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts
@@ -22,7 +22,7 @@ import {
   IResolveDeclarationReferenceResult,
   ApiItem,
   IndentedWriter
-} from '@microsoft/api-extractor';
+} from '@microsoft/api-extractor-model';
 
 export interface ICustomMarkdownEmitterOptions extends IMarkdownEmitterOptions {
   contextApiItem: ApiItem | undefined;
diff --git a/apps/api-documenter/src/markdown/MarkdownEmitter.ts b/apps/api-documenter/src/markdown/MarkdownEmitter.ts
@@ -17,7 +17,7 @@ import {
   DocEscapedText,
   DocErrorText
 } from '@microsoft/tsdoc';
-import { IndentedWriter } from '@microsoft/api-extractor';
+import { IndentedWriter } from '@microsoft/api-extractor-model';
 import { InternalError } from '@microsoft/node-core-library';
 
 export interface IMarkdownEmitterOptions {
diff --git a/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts b/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts
@@ -20,7 +20,7 @@ import { DocTable } from '../../nodes/DocTable';
 import { DocTableRow } from '../../nodes/DocTableRow';
 import { DocTableCell } from '../../nodes/DocTableCell';
 import { CustomMarkdownEmitter } from '../CustomMarkdownEmitter';
-import { ApiModel, ApiItem } from '@microsoft/api-extractor';
+import { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
 
 test('render Markdown from TSDoc', () => {
   const configuration: TSDocConfiguration = CustomDocNodes.configuration;
diff --git a/apps/api-documenter/src/utils/Utilities.ts b/apps/api-documenter/src/utils/Utilities.ts
@@ -4,7 +4,7 @@
 import {
   ApiParameterListMixin,
   ApiItem
-} from '@microsoft/api-extractor';
+} from '@microsoft/api-extractor-model';
 
 export class Utilities {
   /**
diff --git a/apps/api-extractor-model/src/index.ts b/apps/api-extractor-model/src/index.ts
@@ -0,0 +1,156 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * API Extractor helps you build better TypeScript library packages.
+ * It helps with validation, documentation, and reviewing of the exported API
+ * for a TypeScript library.
+ *
+ * @packageDocumentation
+ */
+
+export { AedocDefinitions } from './aedoc/AedocDefinitions';
+export { ReleaseTag } from './aedoc/ReleaseTag';
+
+export { IndentedWriter } from './api/IndentedWriter';
+
+// items
+export {
+  IApiDeclaredItemOptions,
+  ApiDeclaredItem
+} from './api/items/ApiDeclaredItem';
+export {
+  IApiDocumentedItemOptions,
+  ApiDocumentedItem
+} from './api/items/ApiDocumentedItem';
+export {
+  ApiItemKind,
+  IApiItemOptions,
+  ApiItem
+} from './api/items/ApiItem';
+export {
+  IApiPropertyItemOptions,
+  ApiPropertyItem
+} from './api/items/ApiPropertyItem';
+
+// mixins
+export {
+  IApiParameterListMixinOptions,
+  IApiParameterOptions,
+  ApiParameterListMixin
+} from './api/mixins/ApiParameterListMixin';
+export {
+  IApiItemContainerMixinOptions,
+  ApiItemContainerMixin
+} from './api/mixins/ApiItemContainerMixin';
+export {
+  IApiReleaseTagMixinOptions,
+  ApiReleaseTagMixin
+} from './api/mixins/ApiReleaseTagMixin';
+export {
+  IApiReturnTypeMixinOptions,
+  ApiReturnTypeMixin
+} from './api/mixins/ApiReturnTypeMixin';
+export {
+  IApiStaticMixinOptions,
+  ApiStaticMixin
+} from './api/mixins/ApiStaticMixin';
+export {
+  ExcerptTokenKind,
+  IExcerptTokenRange,
+  IExcerptToken,
+  ExcerptToken,
+  Excerpt
+} from './api/mixins/Excerpt';
+export {
+  Constructor,
+  PropertiesOf
+} from './api/mixins/Mixin';
+
+// model
+export {
+  IApiCallSignatureOptions,
+  ApiCallSignature
+} from './api/model/ApiCallSignature';
+export {
+  IApiClassOptions,
+  ApiClass
+} from './api/model/ApiClass';
+export {
+  IApiConstructorOptions,
+  ApiConstructor
+} from './api/model/ApiConstructor';
+export {
+  IApiConstructSignatureOptions,
+  ApiConstructSignature
+} from './api/model/ApiConstructSignature';
+export {
+  IApiEntryPointOptions,
+  ApiEntryPoint
+} from './api/model/ApiEntryPoint';
+export {
+  IApiEnumOptions,
+  ApiEnum
+} from './api/model/ApiEnum';
+export {
+  IApiEnumMemberOptions,
+  ApiEnumMember
+} from './api/model/ApiEnumMember';
+export {
+  IApiFunctionOptions,
+  ApiFunction
+} from './api/model/ApiFunction';
+export {
+  IApiIndexSignatureOptions,
+  ApiIndexSignature
+} from './api/model/ApiIndexSignature';
+export {
+  IApiInterfaceOptions,
+  ApiInterface
+} from './api/model/ApiInterface';
+export {
+  IApiMethodOptions,
+  ApiMethod
+} from './api/model/ApiMethod';
+export {
+  IApiMethodSignatureOptions,
+  ApiMethodSignature
+} from './api/model/ApiMethodSignature';
+export {
+  ApiModel
+} from './api/model/ApiModel';
+export {
+  IApiNamespaceOptions,
+  ApiNamespace
+} from './api/model/ApiNamespace';
+export {
+  IApiPackageOptions,
+  ApiPackage,
+  IApiPackageSaveOptions
+} from './api/model/ApiPackage';
+export {
+  IParameterOptions,
+  Parameter
+} from './api/model/Parameter';
+export {
+  IApiPropertyOptions,
+  ApiProperty
+} from './api/model/ApiProperty';
+export {
+  IApiPropertySignatureOptions,
+  ApiPropertySignature
+} from './api/model/ApiPropertySignature';
+export {
+  IApiTypeAliasOptions,
+  ApiTypeAlias
+} from './api/model/ApiTypeAlias';
+export {
+  IApiVariableOptions,
+  ApiVariable
+} from './api/model/ApiVariable';
+export {
+  IResolveDeclarationReferenceResult
+} from './api/model/DeclarationReferenceResolver';
+export {
+  HeritageType
+} from './api/model/HeritageType';
diff --git a/apps/api-extractor/src/api/Extractor.ts b/apps/api-extractor/src/api/Extractor.ts
@@ -28,7 +28,7 @@ import { DtsRollupGenerator, DtsRollupKind } from '../generators/DtsRollupGenera
 import { MonitoredLogger } from './MonitoredLogger';
 import { TypeScriptMessageFormatter } from '../analyzer/TypeScriptMessageFormatter';
 import { ApiModelGenerator } from '../generators/ApiModelGenerator';
-import { ApiPackage } from './model/ApiPackage';
+import { ApiPackage } from '@microsoft/api-extractor-model';
 import { ReviewFileGenerator } from '../generators/ReviewFileGenerator';
 import { PackageMetadataManager } from '../analyzer/PackageMetadataManager';
 import { VisibilityChecker } from '../collector/VisibilityChecker';
diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts
@@ -9,6 +9,10 @@ import {
   Sort,
   InternalError
 } from '@microsoft/node-core-library';
+import {
+  ReleaseTag,
+  AedocDefinitions
+} from '@microsoft/api-extractor-model';
 
 import { ILogger } from '../api/ILogger';
 import {
@@ -23,7 +27,6 @@ import { CollectorEntity } from './CollectorEntity';
 import { AstSymbolTable, AstEntity } from '../analyzer/AstSymbolTable';
 import { AstModule, AstModuleExportInfo } from '../analyzer/AstModule';
 import { AstSymbol } from '../analyzer/AstSymbol';
-import { ReleaseTag } from '../aedoc/ReleaseTag';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
 import { TypeScriptHelpers } from '../analyzer/TypeScriptHelpers';
 import { WorkingPackage } from './WorkingPackage';
@@ -32,7 +35,6 @@ import { DeclarationMetadata } from './DeclarationMetadata';
 import { SymbolMetadata } from './SymbolMetadata';
 import { TypeScriptInternals } from '../analyzer/TypeScriptInternals';
 import { MessageRouter } from './MessageRouter';
-import { AedocDefinitions } from '../aedoc/AedocDefinitions';
 
 /**
  * Options for Collector constructor.
diff --git a/apps/api-extractor/src/collector/DeclarationMetadata.ts b/apps/api-extractor/src/collector/DeclarationMetadata.ts
@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 import * as tsdoc from '@microsoft/tsdoc';
-import { ReleaseTag } from '../aedoc/ReleaseTag';
+import { ReleaseTag } from '@microsoft/api-extractor-model';
 
 export class DeclarationMetadata {
   public tsdocComment: tsdoc.DocComment | undefined = undefined;
diff --git a/apps/api-extractor/src/collector/MessageRouter.ts b/apps/api-extractor/src/collector/MessageRouter.ts
@@ -4,6 +4,7 @@
 import * as ts from 'typescript';
 import * as tsdoc from '@microsoft/tsdoc';
 import { Sort } from '@microsoft/node-core-library';
+import { AedocDefinitions } from '@microsoft/api-extractor-model';
 
 import { TypeScriptMessageFormatter } from '../analyzer/TypeScriptMessageFormatter';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
@@ -19,7 +20,6 @@ import {
   ExtractorMessageLogLevel,
   IExtractorMessageReportingRuleConfig
 } from '../api/IExtractorConfig';
-import { AedocDefinitions } from '../aedoc/AedocDefinitions';
 import { ILogger } from '../api/ILogger';
 import { SourceMapper } from './SourceMapper';
 
diff --git a/apps/api-extractor/src/collector/SymbolMetadata.ts b/apps/api-extractor/src/collector/SymbolMetadata.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { ReleaseTag } from '../aedoc/ReleaseTag';
+import { ReleaseTag } from '@microsoft/api-extractor-model';
 
 export class SymbolMetadata {
   public releaseTag: ReleaseTag = ReleaseTag.None;
diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -5,33 +5,36 @@
 
 import * as ts from 'typescript';
 import * as tsdoc from '@microsoft/tsdoc';
+import {
+  ApiModel,
+  ApiClass,
+  ApiPackage,
+  ApiEntryPoint,
+  ApiMethod,
+  ApiNamespace,
+  ApiInterface,
+  ApiPropertySignature,
+  ApiItemContainerMixin,
+  ReleaseTag,
+  ApiProperty,
+  ApiMethodSignature,
+  IApiParameterOptions,
+  ApiEnum,
+  ApiEnumMember,
+  IExcerptTokenRange,
+  IExcerptToken,
+  ApiConstructor,
+  ApiConstructSignature,
+  ApiFunction,
+  ApiIndexSignature,
+  ApiVariable,
+  ApiTypeAlias,
+  ApiCallSignature
+} from '@microsoft/api-extractor-model';
 
 import { Collector } from '../collector/Collector';
-import { ApiModel } from '../api/model/ApiModel';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
-import { ApiClass } from '../api/model/ApiClass';
-import { ApiPackage } from '../api/model/ApiPackage';
-import { ApiEntryPoint } from '../api/model/ApiEntryPoint';
-import { ApiMethod } from '../api/model/ApiMethod';
-import { ApiNamespace } from '../api/model/ApiNamespace';
-import { ApiInterface } from '../api/model/ApiInterface';
-import { ApiPropertySignature } from '../api/model/ApiPropertySignature';
-import { ApiItemContainerMixin } from '../api/mixins/ApiItemContainerMixin';
-import { ReleaseTag } from '../aedoc/ReleaseTag';
-import { ApiProperty } from '../api/model/ApiProperty';
-import { ApiMethodSignature } from '../api/model/ApiMethodSignature';
-import { IApiParameterOptions } from '../api/mixins/ApiParameterListMixin';
-import { ApiEnum } from '../api/model/ApiEnum';
-import { ApiEnumMember } from '../api/model/ApiEnumMember';
-import { IExcerptTokenRange, IExcerptToken } from '../api/mixins/Excerpt';
 import { ExcerptBuilder, IExcerptBuilderNodeToCapture } from './ExcerptBuilder';
-import { ApiConstructor } from '../api/model/ApiConstructor';
-import { ApiConstructSignature } from '../api/model/ApiConstructSignature';
-import { ApiFunction } from '../api/model/ApiFunction';
-import { ApiIndexSignature } from '../api/model/ApiIndexSignature';
-import { ApiVariable } from '../api/model/ApiVariable';
-import { ApiTypeAlias } from '../api/model/ApiTypeAlias';
-import { ApiCallSignature } from '../api/model/ApiCallSignature';
 import { AstSymbol } from '../analyzer/AstSymbol';
 
 export class ApiModelGenerator {
diff --git a/apps/api-extractor/src/generators/DtsRollupGenerator.ts b/apps/api-extractor/src/generators/DtsRollupGenerator.ts
@@ -5,12 +5,14 @@
 
 import * as ts from 'typescript';
 import { FileSystem, NewlineKind, InternalError } from '@microsoft/node-core-library';
+import {
+  IndentedWriter,
+  ReleaseTag
+} from '@microsoft/api-extractor-model';
 
 import { Collector } from '../collector/Collector';
-import { IndentedWriter } from '../api/IndentedWriter';
 import { TypeScriptHelpers } from '../analyzer/TypeScriptHelpers';
 import { Span, SpanModification } from '../analyzer/Span';
-import { ReleaseTag } from '../aedoc/ReleaseTag';
 import { AstImport, AstImportKind } from '../analyzer/AstImport';
 import { CollectorEntity } from '../collector/CollectorEntity';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
diff --git a/apps/api-extractor/src/generators/ExcerptBuilder.ts b/apps/api-extractor/src/generators/ExcerptBuilder.ts
diff --git a/apps/api-extractor/src/generators/ReviewFileGenerator.ts b/apps/api-extractor/src/generators/ReviewFileGenerator.ts
diff --git a/apps/api-extractor/src/index.ts b/apps/api-extractor/src/index.ts
