import type { SheetOptions } from "./earth.ts";
/**
 * A capital city: its name, as the sheet says it in each language, and where it is.
 *
 * @example
 * ```ts
 * import { type Capital } from "@johnmorrisdotca/chikyu-earth/sheets";
 *
 * const tokyo: Capital = { name: "Tokyo", ja: "東京", lon: 139.69, lat: 35.69 };
 * console.log(tokyo.name);
 * ```
 */
export interface Capital {
    name: string;
    /** The Japanese name, when it has one. */
    ja?: string;
    lon: number;
    lat: number;
}
/**
 * What a "my country" sheet is drawn for: the room, the language and the type, and the capital.
 *
 * @example
 * ```ts
 * import { countrySheetSvg, type CountryOptions } from "@johnmorrisdotca/chikyu-earth/sheets";
 *
 * const options: CountryOptions = { widthMm: 184.6, heightMm: 170, capital: { name: "Paris", lon: 2.35, lat: 48.86 } };
 * console.log(countrySheetSvg("FR", options)?.includes("Paris"));
 * ```
 */
export interface CountryOptions extends SheetOptions {
    /** The capital, to put a star on it and say its name; without it the sheet asks the child to find it. */
    capital?: Capital;
}
/**
 * A "my country" colouring sheet: the country's outline as big as the room allows (an equal-area view centred on the country, with a far territory such as French Guiana left out), its capital as a star when `capital` is given, a box to draw the flag in, and three facts:
 * the continent, the countries it touches, the capital. The flag is a box to fill in, never a picture: the sheet carries no flag.
 * @param alpha2 - The country's two-letter code, such as `JP`.
 * @param options - The room, the language, the type and the capital.
 * @returns The `<svg>` markup, or `undefined` when the package has no outline for the code.
 *
 * @example
 * ```ts
 * import { countrySheetSvg } from "@johnmorrisdotca/chikyu-earth/sheets";
 *
 * const svg = countrySheetSvg("JP", { widthMm: 184.6, heightMm: 180, capital: { name: "Tokyo", lon: 139.7, lat: 35.7 } });
 * console.log(svg?.includes("Tokyo"), svg?.includes("Draw the flag!"));
 * ```
 */
export declare function countrySheetSvg(alpha2: string, options: CountryOptions): string | undefined;