import { Awaitable } from '@antfu/utils';
import { FullIconCustomisations } from '../customisations/defaults.cjs';
import { IconifyIcon, IconifyJSON } from '@iconify/types';

/**
 * External package name.
 *
 * You can use scoped packages, for example, `@my-collections/collection-a` or normal packages `my-awaesome-collection`.
 */
type ExternalPkgName = string | [scope: string, collection: string];
/**
 * Type for universal icon loader.
 */
type UniversalIconLoader = (collection: string, icon: string, options?: IconifyLoaderOptions) => Promise<string | undefined>;
/**
 * Custom icon loader, used by `getCustomIcon`.
 */
type CustomIconLoader = (name: string) => Awaitable<string | undefined>;
/**
 * Auto-install options
 */
type AutoInstall = boolean | ((name: string) => Promise<void | undefined>);
/**
 * Custom icon customizer, it will allow to customize all icons on a collection or individual icons.
 */
type IconCustomizer = (collection: string, icon: string, props: Record<string, string>) => Awaitable<void>;
/**
 * Icon customizations: will be applied to all resolved icons.
 *
 * For each loaded icon, the customizations will be applied in this order:
 * - apply `transform` to raw `svg`, if provided and using custom icon collection
 * - apply `customize` with default customizations, if provided
 * - apply `iconCustomizer` with `customize` customizations, if provided
 * - apply `additionalProps` with `iconCustomizer` customizations, if provided
 * - apply `trimSVG` to the final `SVG` only when using custom icon collection and `trimCustomSvg` enabled
 */
type IconCustomizations = {
    /**
     * Transform raw `svg`.
     *
     * **WARNING**: `transform` will be only applied when using `custom` icon collection: it will be applied only when using `getCustomIcon` and excluded when using `searchForIcon`.
     *
     * @param svg The loaded `svg`
     * @param collection The name of the collection
     * @param icon The name of the icon
     * @return The transformed `svg`.
     */
    transform?: (svg: string, collection: string, icon: string) => Awaitable<string>;
    /**
     * Change default icon customizations values.
     *
     * @param defaultCustomizations Default icon's customizations values.
     * @param data The icon data. Mutable, you can change the icon data.
     * @param name The icon name, can be used to check if icon needs to be customised.
     * @return The modified icon's customizations values.
     */
    customize?: (defaultCustomizations: FullIconCustomisations, data: IconifyIcon, name: string) => FullIconCustomisations | undefined;
    /**
     * Custom icon customizer.
     */
    iconCustomizer?: IconCustomizer;
    /**
     * Additional icon properties.
     *
     * All properties without value will not be applied.
     */
    additionalProps?: Record<string, string | undefined>;
    /**
     * Should optimize the custom `svg` icon?.
     *
     * Enable this flag when using custom `SVG` on `CSS`.
     *
     * @default `false`.
     */
    trimCustomSvg?: boolean;
};
/**
 * List of icons as object. Key is the icon name, the value is the icon data or callback (can be async) to get icon data
 */
type InlineCollection = Record<string, string | (() => Awaitable<string | undefined>)>;
/**
 * Collection of custom icons. Key is the collection name, the value is the loader or InlineCollection object
 */
type CustomCollections = Record<string, CustomIconLoader | InlineCollection>;
/**
 * Options to use with the modern loader.
 */
type IconifyLoaderOptions = {
    /**
     * Emit warning when missing icons are matched
     */
    warn?: string;
    /**
     * Add svg and xlink xml namespace when necessary.
     *
     * @default false
     */
    addXmlNs?: boolean;
    /**
     * Scale of icons against 1em
     */
    scale?: number;
    /**
     * Style to apply to icons by default
     *
     * @default ''
     */
    defaultStyle?: string;
    /**
     * Class names to apply to icons by default
     *
     * @default ''
     */
    defaultClass?: string;
    /**
     * Loader for custom loaders
     */
    customCollections?: Record<string, (() => Awaitable<IconifyJSON>) | undefined | CustomIconLoader | InlineCollection>;
    /**
     * Icon customizer
     */
    customizations?: IconCustomizations;
    /**
     * Auto install icon sources package when the usages is detected
     *
     * **WARNING**: only on `node` environment, on `browser` this option will be ignored
     *
     * @default false
     */
    autoInstall?: AutoInstall;
    /**
     * The additional icon properties applied to the svg.
     *
     * The `width` and `height` will not be set to the `svg` if already present on it, and so, the `width` and `height` will be those you configure on the customizations.
     * If you omit the `width/height/scale` options and the `svg` contains the `width` and/or `height`, then, both will be extracted from the `svg`.
     *
     * If you need that properties just add an empty object here, useful for example when using the `svg` on `CSS`.
     */
    usedProps?: Record<string, string>;
    /**
     * Current working directory, used to resolve the @iconify-json package.
     *
     * Can be a string or an array of strings, the first existing path will be used.
     *
     * Only used on `node` environment.
     *
     * If value is an array and `autoInstall` is enabled, `autoInstall` will be used only for last entry.
     *
     * @default process.cwd()
     */
    cwd?: string | string[];
};

export type { AutoInstall, CustomCollections, CustomIconLoader, ExternalPkgName, IconCustomizations, IconCustomizer, IconifyLoaderOptions, InlineCollection, UniversalIconLoader };