Abstract Create Types

type AbstractCreateTypesOptions<T extends {} = {}> = {
  TypesTable: React.ComponentType<TypesTableProps<T>>;
  components?: { pre?: React.ComponentType<{ 'data-precompute'?: string }> };
  /**
   * Required pre component for type code blocks.
   * Type signatures are not precomputed, so this has a different
   * contract from `components.pre`.
   * Can be overridden by TypesTableMeta.TypePre.
   */
  TypePre: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Optional pre component for detailed type blocks.
   * Falls back to `TypePre` when not provided.
   * Can be overridden by TypesTableMeta.DetailedTypePre.
   */
  DetailedTypePre?: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Optional code component for shortType fields.
   * Falls back to `components.code` when not provided.
   * Can be overridden by TypesTableMeta.ShortTypeCode.
   */
  ShortTypeCode?: React.ComponentType<{ children?: React.ReactNode; className?: string }>;
  /**
   * Optional code component for default value fields.
   * Falls back to `components.code` when not provided.
   * Can be overridden by TypesTableMeta.DefaultCode.
   */
  DefaultCode?: React.ComponentType<{ children?: React.ReactNode; className?: string }>;
  /**
   * Optional pre component for raw type formatted code blocks.
   * Falls back to `DetailedTypePre`, then `TypePre` when not provided.
   * Can be overridden by TypesTableMeta.RawTypePre.
   */
  RawTypePre?: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Rehype plugins to run on HAST before converting to JSX.
   * Can be overridden by TypesTableMeta.enhancers.
   * Defaults to `[enhanceCodeInline]` when undefined.
   * Pass an empty array to disable all enhancers.
   */
  enhancers?: Pluggable[];
  /**
   * Rehype plugins to run on inline HAST fields (shortType and default).
   * Can be overridden by TypesTableMeta.enhancersInline.
   * Defaults to `[enhanceCodeInline]` when undefined.
   * Pass an empty array to disable all inline enhancers.
   */
  enhancersInline?: Pluggable[];
  /**
   * Custom component tag name to use instead of `<a>` for type reference links.
   * When set, enhanceCodeTypes emits elements with this tag name,
   * adding a `name` property (the matched identifier) alongside `href`.
   * Can be overridden by TypesTableMeta.typeRefComponent.
   */
  typeRefComponent?: string;
  /**
   * Custom component tag name for property reference elements.
   * Can be overridden by TypesTableMeta.typePropRefComponent.
   */
  typePropRefComponent?: string;
  /**
   * Custom component tag name for function parameter reference elements.
   * Can be overridden by TypesTableMeta.typeParamRefComponent.
   */
  typeParamRefComponent?: string;
  /**
   * Opt-in property linking mode for enhanceCodeTypes.
   * Can be overridden by TypesTableMeta.linkProps.
   */
  linkProps?: 'shallow' | 'deep';
  /**
   * Opt-in function parameter linking for enhanceCodeTypes.
   * Can be overridden by TypesTableMeta.linkParams.
   */
  linkParams?: boolean;
  /**
   * Opt-in scope-based variable linking for enhanceCodeTypes.
   * Can be overridden by TypesTableMeta.linkScope.
   */
  linkScope?: boolean;
  /**
   * Module import linking map for enhanceCodeTypes.
   * Can be overridden by TypesTableMeta.moduleLinkMap.
   */
  moduleLinkMap?: {
    js?: Record<string, ModuleLinkMapEntry>;
    css?: Record<string, ModuleLinkMapEntry>;
  };
  /**
   * Default anchor slug for default/namespace imports.
   * Can be overridden by TypesTableMeta.defaultImportSlug.
   */
  defaultImportSlug?: string;
}

type defaultOrdering = {
  /** Order of CSS custom properties in documentation output */
  cssVariables: string[];
  /** Order of data-* attributes in documentation output */
  dataAttributes: string[];
  /** Order of component props in documentation output */
  props: string[];
  /** Order of namespace member parts (e.g., Root, Trigger, Item) */
  namespaceParts: string[];
  /** Order of type suffixes (e.g., Props, State, DataAttributes) */
  typeSuffixes: string[];
}

type ExportData = {
  /** The main component/hook/function type for this export */
  type: HighlightedTypesMeta;
  /** Related types like .Props, .State, .ChangeEventDetails for this export */
  additionalTypes: HighlightedTypesMeta[];
}

type OrderingConfig = {
  /** Order of CSS custom properties in documentation output */
  cssVariables?: string[];
  /** Order of data-* attributes in documentation output */
  dataAttributes?: string[];
  /** Order of component props in documentation output */
  props?: string[];
  /** Order of namespace member parts (e.g., Root, Trigger, Item) */
  namespaceParts?: string[];
  /** Order of type suffixes (e.g., Props, State, DataAttributes) */
  typeSuffixes?: string[];
}

type TypesTableMeta = {
  precompute?: {
    exports: Record<string, ExportData>;
    additionalTypes: HighlightedTypesMeta[];
    variantOnlyAdditionalTypes?: Record<string, HighlightedTypesMeta[]>;
    variantTypeNames?: Record<string, string[]>;
    singleComponentName?: string;
    anchorMap?: { js?: Record<string, string>; css?: Record<string, string> };
  };
  name?: string;
  displayName?: string;
  disableOptimization?: boolean;
  watchSourceDirectly?: boolean;
  /**
   * When true, excludes this component from the parent index page.
   * The component types will still be processed, but won't be added to the index.
   */
  excludeFromIndex?: boolean;
  components?: { pre?: React.ComponentType<{ 'data-precompute'?: string }> };
  /**
   * Override pre component for type code blocks.
   * When set, overrides the factory-level TypePre.
   */
  TypePre?: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Override pre component for detailed type blocks.
   * When set, overrides the factory-level DetailedTypePre.
   */
  DetailedTypePre?: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Override code component for shortType fields.
   * When set, overrides the factory-level ShortTypeCode.
   */
  ShortTypeCode?: React.ComponentType<{ children?: React.ReactNode; className?: string }>;
  /**
   * Override code component for default value fields.
   * When set, overrides the factory-level DefaultCode.
   */
  DefaultCode?: React.ComponentType<{ children?: React.ReactNode; className?: string }>;
  /**
   * Override pre component for raw type formatted code blocks.
   * When set, overrides the factory-level RawTypePre.
   */
  RawTypePre?: React.ComponentType<{ children: React.ReactNode }>;
  /**
   * Rehype plugins to run on HAST before converting to JSX.
   * If set, completely overrides enhancers from AbstractCreateTypesOptions.
   * Defaults to `[enhanceCodeInline]` when undefined.
   * Pass an empty array to disable all enhancers.
   */
  enhancers?: Pluggable[];
  /**
   * Rehype plugins to run on inline HAST fields (shortType and default).
   * If set, completely overrides enhancersInline from AbstractCreateTypesOptions.
   * Defaults to `[enhanceCodeInline]` when undefined.
   * Pass an empty array to disable all inline enhancers.
   */
  enhancersInline?: Pluggable[];
  /**
   * Custom component tag name to use instead of `<a>` for type reference links.
   * When set, enhanceCodeTypes emits elements with this tag name,
   * adding a `name` property (the matched identifier) alongside `href`.
   * This enables interactive type popovers via a `TypeRef` component.
   */
  typeRefComponent?: string;
  /**
   * Custom component tag name to use instead of a plain HTML element
   * for property references within type definitions, object literals, function calls, and JSX.
   * For definitions the element receives `id`, for references it receives `href`.
   * Both also receive `name` (owner) and `prop` (kebab-case property path).
   */
  typePropRefComponent?: string;
  /**
   * Custom component tag name to use instead of a plain HTML element
   * for function parameter references.
   * For definitions the element receives `id`, for references it receives `href`.
   * Both also receive `name` (owner) and `param` (parameter name).
   */
  typeParamRefComponent?: string;
  /**
   * Opt-in property linking mode for enhanceCodeTypes.
   * - `'shallow'`: Link only top-level properties of known owners.
   * - `'deep'`: Link nested properties with dotted paths (e.g., `address.street-name`).
   * - `undefined` (default): No property linking.
   */
  linkProps?: 'shallow' | 'deep';
  /**
   * Opt-in function parameter linking for enhanceCodeTypes.
   * When `true`, links function parameter names to documentation anchors.
   */
  linkParams?: boolean;
  /**
   * Opt-in scope-based variable linking for enhanceCodeTypes.
   * When `true`, links variable references to the type from their declaration
   * using single-pass scope tracking.
   */
  linkScope?: boolean;
  /**
   * Module import linking map for enhanceCodeTypes.
   * Maps module specifiers to their documentation page and exports.
   */
  moduleLinkMap?: {
    js?: Record<string, ModuleLinkMapEntry>;
    css?: Record<string, ModuleLinkMapEntry>;
  };
  /**
   * Default anchor slug for default/namespace imports when the module entry
   * in `moduleLinkMap` does not specify a `defaultSlug`.
   */
  defaultImportSlug?: string;
}