laravel-vite-plugin/dist/fonts/types.d.ts

Laravel plugin for Vite.

export type FormatConfig = {
    extension: string;
    type: FontFormat;
};
export type FontProviderType = 'local' | 'google' | 'bunny' | 'fontsource';
export type FontFormat = 'woff2' | 'woff' | 'ttf' | 'otf' | 'eot';
export type FontStyle = 'normal' | 'italic' | 'oblique';
/**
 * Subset of FontStyle supported by remote providers (Google, Bunny, Fontsource).
 * The CSS2 / Fontsource APIs do not expose `oblique`.
 */
export type RemoteFontStyle = 'normal' | 'italic';
export type FontWeight = number | string;
export type FontDisplay = 'auto' | 'block' | 'swap' | 'fallback' | 'optional';
export type PreloadSelector<W extends FontWeight = FontWeight> = {
    weight: W;
    /** @default 'normal' */
    style?: FontStyle;
};
export type BaseFontOptions<W extends FontWeight = FontWeight> = {
    /**
     * Used to reference font with `@fonts` Blade directive or programatically.
     * Defaults to a slug of the family name.
     */
    alias?: string;
    /** Defaults to `--font-{alias}`. */
    variable?: string;
    /** @default [400] */
    weights?: readonly W[];
    /** @default ['normal'] */
    styles?: FontStyle[];
    /** @default ['latin'] */
    subsets?: string[];
    /** @default 'swap' */
    display?: FontDisplay;
    /**
     * - `true`: preload all WOFF2 variants (default)
     * - `false`: do not preload
     * - `[{ weight, style }]`: preload only matching variants.
     *   When `weights` is a literal tuple, preload weights are type-narrowed
     *   to its members.
     *
     * @default true
     */
    preload?: boolean | PreloadSelector<NoInfer<W>>[];
    /** @default [] */
    fallbacks?: string[];
    /**
     * Generate metric-optimized fallback font faces using fontaine.
     *
     * @default true
     */
    optimizedFallbacks?: boolean;
};
export type LocalVariantDefinition = {
    /** Path(s) relative to the project root. */
    src: string | string[];
    /** When omitted, inferred from filename. Defaults to 400 if no token found. */
    weight?: FontWeight;
    /** @default 'normal' — inferred from filename when omitted. */
    style?: FontStyle;
};
export type LocalFontOptions = Omit<BaseFontOptions, 'weights' | 'styles' | 'subsets'> & ({
    /** Explicit list of font variants. Mutually exclusive with `src`. */
    variants: LocalVariantDefinition[];
    src?: never;
} | {
    /**
     * Shorthand: a file path, directory, or glob pattern.
     * Mutually exclusive with `variants`.
     */
    src: string;
    variants?: never;
});
export type RemoteFontOptions<W extends FontWeight = FontWeight> = Omit<BaseFontOptions<W>, 'styles'> & {
    /** @default ['normal'] */
    styles?: RemoteFontStyle[];
};
export type FontsourceFontOptions<W extends FontWeight = FontWeight> = Omit<BaseFontOptions<W>, 'styles'> & {
    /** @default ['normal'] */
    styles?: RemoteFontStyle[];
    /** Defaults to `@fontsource/{family-slug}`. */
    package?: string;
};
export type FontDefinition = {
    family: string;
    alias: string;
    provider: FontProviderType;
    variable: string;
    weights: FontWeight[];
    styles: FontStyle[];
    subsets: string[];
    display: FontDisplay;
    preload: boolean | PreloadSelector[];
    fallbacks: string[];
    optimizedFallbacks: boolean;
    /** @internal */
    _local?: {
        variants: LocalVariantDefinition[];
    } | {
        src: string;
    };
    /** @internal */
    _fontsource?: {
        package?: string;
    };
};
export type ResolvedFontVariant = {
    weight: FontWeight;
    style: FontStyle;
    files: ResolvedFontFile[];
};
export type ResolvedFontFile = {
    source: string;
    format: FontFormat;
    unicodeRange?: string;
};
export type ResolvedFontFamily = {
    family: string;
    alias: string;
    variable: string;
    display: FontDisplay;
    optimizedFallbacks: boolean;
    fallbacks: string[];
    preload: boolean | PreloadSelector[];
    provider: FontProviderType;
    variants: ResolvedFontVariant[];
};
export type FontManifest = {
    version: 1;
    style: {
        file?: string;
        inline?: string;
        familyStyles: Record<string, string>;
        variables: Record<string, string>;
    };
    preloads: FontManifestPreload[];
    families: Record<string, FontManifestFamily>;
};
export type FontManifestPreload = {
    alias: string;
    family: string;
    weight: FontWeight;
    style: FontStyle;
    file?: string;
    url?: string;
    as: 'font';
    type: string;
    crossorigin: 'anonymous';
};
export type FontManifestFamily = {
    family: string;
    variable: string;
    fallbackFamily?: string;
    fallbacks?: string[];
    variants: Record<string, FontManifestVariant>;
};
export type FontManifestVariant = {
    files: FontManifestVariantFile[];
};
export type FontManifestVariantFile = {
    file?: string;
    url?: string;
    format: FontFormat;
    unicodeRange?: string;
};
export type FallbackMetrics = {
    localFont: string;
    ascentOverride: string;
    descentOverride: string;
    lineGapOverride: string;
    sizeAdjust: string;
};
export type FallbackCategory = 'sans-serif' | 'serif' | 'monospace';
export type FallbackEntry = {
    localFont: string;
    ascent: number;
    descent: number;
    lineGap: number;
    unitsPerEm: number;
    xWidthAvg: number;
};
export type ParsedFontFace = {
    family: string;
    style: FontStyle;
    weight: FontWeight;
    src: ParsedFontSrc[];
    unicodeRange?: string;
    display?: string;
};
export type ParsedFontSrc = {
    url: string;
    format: FontFormat;
};
export declare const FORMAT_MIME: Record<FontFormat, string>;