build: package api-extractor and -model (#9920)

* fix(ExceptText): don't display import("d..-types/v10"). in return type * Squashed 'packages/api-extractor-model/' content from commit 39ecb196c git-subtree-dir: packages/api-extractor-model git-subtree-split: 39ecb196ca210bdf84ba6c9cadb1bb93571849d7 * Squashed 'packages/api-extractor/' content from commit 341ad6c51 git-subtree-dir: packages/api-extractor git-subtree-split: 341ad6c51b01656d4f73b74ad4bdb3095f9262c4 * feat(api-extractor): add api-extractor and -model * fix: package.json docs script * fix(SourcLink): use <> instead of function syntax * fix: make packages private * fix: rest params showing in docs, added labels * fix: missed two files * fix: cpy-cli & pnpm-lock * fix: increase icon size * fix: icon size again
2026-03-12 17:43:30 +01:00 · 2023-11-07 21:53:36 +01:00
parent 95c0b1a59f
commit 5c0fad3b2d
251 changed files with 36017 additions and 296 deletions
--- a/packages/api-extractor-model/src/model/ApiInterface.ts
+++ b/packages/api-extractor-model/src/model/ApiInterface.ts
@@ -0,0 +1,143 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { DeclarationReference, type Component } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference.js';
+import { ApiDeclaredItem, type IApiDeclaredItemOptions, type IApiDeclaredItemJson } from '../items/ApiDeclaredItem.js';
+import { ApiItemKind, Navigation, Meaning } from '../items/ApiItem.js';
+import {
+	type IApiExportedMixinJson,
+	type IApiExportedMixinOptions,
+	ApiExportedMixin,
+} from '../mixins/ApiExportedMixin.js';
+import {
+	ApiItemContainerMixin,
+	type IApiItemContainerMixinOptions,
+	type IApiItemContainerJson,
+} from '../mixins/ApiItemContainerMixin.js';
+import { type IApiNameMixinOptions, ApiNameMixin, type IApiNameMixinJson } from '../mixins/ApiNameMixin.js';
+import {
+	type IApiReleaseTagMixinOptions,
+	ApiReleaseTagMixin,
+	type IApiReleaseTagMixinJson,
+} from '../mixins/ApiReleaseTagMixin.js';
+import {
+	type IApiTypeParameterListMixinOptions,
+	type IApiTypeParameterListMixinJson,
+	ApiTypeParameterListMixin,
+} from '../mixins/ApiTypeParameterListMixin.js';
+import type { IExcerptTokenRange } from '../mixins/Excerpt.js';
+import type { DeserializerContext } from './DeserializerContext.js';
+import { HeritageType } from './HeritageType.js';
+
+/**
+ * Constructor options for {@link ApiInterface}.
+ *
+ * @public
+ */
+export interface IApiInterfaceOptions
+	extends IApiItemContainerMixinOptions,
+		IApiNameMixinOptions,
+		IApiTypeParameterListMixinOptions,
+		IApiReleaseTagMixinOptions,
+		IApiDeclaredItemOptions,
+		IApiExportedMixinOptions {
+	extendsTokenRanges: IExcerptTokenRange[];
+}
+
+export interface IApiInterfaceJson
+	extends IApiItemContainerJson,
+		IApiNameMixinJson,
+		IApiTypeParameterListMixinJson,
+		IApiReleaseTagMixinJson,
+		IApiDeclaredItemJson,
+		IApiExportedMixinJson {
+	extendsTokenRanges: IExcerptTokenRange[];
+}
+
+/**
+ * Represents a TypeScript class declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiInterface` represents a TypeScript declaration such as this:
+ *
+ * ```ts
+ * export interface X extends Y {
+ * }
+ * ```
+ * @public
+ */
+export class ApiInterface extends ApiItemContainerMixin(
+	ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))),
+) {
+	private readonly _extendsTypes: HeritageType[] = [];
+
+	public constructor(options: IApiInterfaceOptions) {
+		super(options);
+
+		for (const extendsTokenRange of options.extendsTokenRanges) {
+			this._extendsTypes.push(new HeritageType(this.buildExcerpt(extendsTokenRange)));
+		}
+	}
+
+	public static getContainerKey(name: string): string {
+		return `${name}|${ApiItemKind.Interface}`;
+	}
+
+	/**
+	 * @override
+	 */
+	public static override onDeserializeInto(
+		options: Partial<IApiInterfaceOptions>,
+		context: DeserializerContext,
+		jsonObject: IApiInterfaceJson,
+	): void {
+		super.onDeserializeInto(options, context, jsonObject);
+
+		options.extendsTokenRanges = jsonObject.extendsTokenRanges;
+	}
+
+	/**
+	 * @override
+	 */
+	public override get kind(): ApiItemKind {
+		return ApiItemKind.Interface;
+	}
+
+	/**
+	 * @override
+	 */
+	public override get containerKey(): string {
+		return ApiInterface.getContainerKey(this.name);
+	}
+
+	/**
+	 * The list of base interfaces that this interface inherits from using the `extends` keyword.
+	 */
+	public get extendsTypes(): readonly HeritageType[] {
+		return this._extendsTypes;
+	}
+
+	/**
+	 * @override
+	 */
+	public override serializeInto(jsonObject: Partial<IApiInterfaceJson>): void {
+		super.serializeInto(jsonObject);
+
+		jsonObject.extendsTokenRanges = this.extendsTypes.map((x) => x.excerpt.tokenRange);
+	}
+
+	/**
+	 * @beta @override
+	 */
+	public override buildCanonicalReference(): DeclarationReference {
+		const nameComponent: Component = DeclarationReference.parseComponent(this.name);
+		const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+		return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+			.addNavigationStep(navigation as any, nameComponent)
+			.withMeaning(Meaning.Interface as any);
+	}
+}