import type { ApiClassDeclaration, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiEvent, ApiFunctionDeclaration, ApiInterfaceDeclaration, ApiModule, ApiVariableDeclaration, ApiWithDeprecated, ApiWithDescription, ApiWithDocsTags } from "../../apiJson.js";

/** [Documentation](https://webgis.esri.com/references/api-extractor/tags-reference#copydoc)) */
export interface CopyDocDefinitions {
  properties?: CopyDocMemberDeclarations<ApiCustomElementField>;
  methods?: CopyDocMemberDeclarations<ApiClassMethod>;
  /**
   * This is only called for web component events.
   * Non-web component classes define events using the `@eventTypes` property,
   * and can copy doc by creating and extending common interfaces.
   */
  events?: CopyDocMemberDeclarations<ApiEvent>;
  classes?: CopyDocDeclarations<ApiClassDeclaration>;
  customElements?: CopyDocDeclarations<ApiCustomElementDeclaration>;
  functions?: CopyDocDeclarations<ApiFunctionDeclaration>;
  variables?: CopyDocDeclarations<ApiVariableDeclaration>;
  /** This includes both type aliases and interfaces */
  interfaces?: CopyDocDeclarations<ApiInterfaceDeclaration>;
}

/**
 * A common shape for metadata that can be included in declarative copy doc.
 * Extra fields can be specified by imperatively mutating the API declaration.
 */
export interface CopyDocCommonBase extends Partial<ApiWithDescription>, Partial<ApiWithDocsTags>, Partial<ApiWithDeprecated> {
  return?: ApiWithDescription;
}

export type CopyDocDeclarations<ApiType extends Partial<CopyDocCommonBase>> = Record<string, Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | ((apiDeclaration: ApiType, module: ApiModule) => Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase>) | undefined>;

export type CopyDocMemberDeclarations<ApiType extends Partial<CopyDocCommonBase>> = Record<string, Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | ((apiDeclaration: ApiType, classOrComponent: ApiClassDeclaration | ApiCustomElementDeclaration, module: ApiModule) => Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | undefined) | undefined>;