types.ts — astro Source File

Source Code

import type { Font } from '@capsizecss/unpack';
import type * as unifont from 'unifont';
import type * as z from 'zod/v4';
import type { DisplaySchema, StyleSchema, WeightSchema } from './config.js';
import type { FONT_TYPES, GENERIC_FALLBACK_NAMES } from './constants.js';
import type { CollectedFontForMetrics } from './core/optimize-fallbacks.js';

export type Weight = z.infer<typeof WeightSchema>;
type Display = z.infer<typeof DisplaySchema>;

export interface FontProviderInitContext {
	/**
	 * Useful for caching.
	 */
	storage: {
		getItem: {
			<T = unknown>(key: string): Promise<T | null>;
			<T = unknown>(key: string, init: () => Awaitable<T>): Promise<T>;
		};
		setItem: (key: string, value: unknown) => Awaitable<void>;
	};
	/**
	 * The project root, useful for resolving local files paths.
	 */
	root: URL;
}

type Awaitable<T> = T | Promise<T>;

export interface FontProvider<
	TFamilyOptions extends Record<string, any> | undefined | never = never,
> {
	/**
	 * A unique name for the provider, used in logs and for identification.
	 */
	name: string;
	/**
	 * A serializable object, used for identification.
	 */
	config?: Record<string, any> | undefined;
	/**
	 * Optional callback, used to perform any initialization logic.
	 */
	init?: ((context: FontProviderInitContext) => Awaitable<void>) | undefined;
	/**
	 * Used to retrieve and return font face data based on the given options.
	 */
	resolveFont: (options: ResolveFontOptions<TFamilyOptions>) => Awaitable<
		| {
				fonts: Array<unifont.FontFaceData>;
		  }
		| undefined
	>;
	/**
	 * Optional callback, used to return the list of available font names.
	 */
	listFonts?: (() => Awaitable<Array<string> | undefined>) | undefined;
}

export interface FamilyProperties {
// ... (230 more lines)