// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. import { DeclarationReference, Meaning, Navigation, type Component } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, type IApiItemContainerMixinOptions, type IApiItemContainerJson } from '../mixins/ApiItemContainerMixin'; import { ApiDeclaredItem, type IApiDeclaredItemOptions, type IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin, type IApiReleaseTagMixinJson } from '../mixins/ApiReleaseTagMixin'; import type { IExcerptTokenRange } from '../mixins/Excerpt'; import { HeritageType } from './HeritageType'; import { type IApiNameMixinOptions, ApiNameMixin, type IApiNameMixinJson } from '../mixins/ApiNameMixin'; import { type IApiTypeParameterListMixinOptions, type IApiTypeParameterListMixinJson, ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin'; import type { DeserializerContext } from './DeserializerContext'; import { type IApiExportedMixinJson, type IApiExportedMixinOptions, ApiExportedMixin } from '../mixins/ApiExportedMixin'; /** * 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)))) ) { 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}`; } public static override onDeserializeInto( options: Partial, context: DeserializerContext, jsonObject: IApiInterfaceJson ): void { super.onDeserializeInto(options, context, jsonObject); options.extendsTokenRanges = jsonObject.extendsTokenRanges; } public override get kind(): ApiItemKind { return ApiItemKind.Interface; } 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(): ReadonlyArray { return this.#extendsTypes; } public override serializeInto(jsonObject: Partial): void { super.serializeInto(jsonObject); jsonObject.extendsTokenRanges = this.extendsTypes.map((x) => x.excerpt.tokenRange); } /** @beta */ 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, nameComponent) .withMeaning(Meaning.Interface); } }