import { type HypernymDAGData } from "./lib/hypernymDAG.js";
import type { Linker } from "./linkers/index.js";
import { parse } from "./parse.js";
import * as T from "./templating/index.js";
/**
 * A Link is a relationship between a (possibly ordered) set of words, with how
 * strong it is quantified via its score.
 */
export type Link = {
    /** The name of the link. */
    name: string;
    /**
     * Any additional information about the link. Typically, this would be an
     * explanation for why the words satisfy the given link.
     */
    description?: string;
    /**
     * The score of the link. A higher score means it's more likely to be
     * important (because it's less likely to happen by chance).
     *
     * This is calculated as the negative of the log probability we'd expect to
     * see this link, if each word was replaced with a random puzzle answer,
     * rounded to 1 decimal place.
     */
    score: number;
    /** Structured link name. See LinkOptions.jsonOutput. */
    jsonName?: T.Inline;
    /** Structured link description. See LinkOptions.jsonOutput. */
    jsonDescription?: T.Table;
};
/** Options for Puzlink.link(). */
export type LinkOptions = {
    /**
     * Set to true to return the raw description of the link, in a structured
     * JSON format. Useful for custom rendering. See `templating/index.ts` for
     * the types.
     *
     * Defaults to false.
     */
    jsonOutput?: boolean;
    /**
     * Whether to return links via a generator instead of a list. If true, links
     * will be returned *unsorted*, and the limit option will be ignored.
     *
     * Defaults to false.
     */
    lazy?: boolean;
    /**
     * Limit the number of links returned. Pass null or Infinity to return
     * all links.
     *
     * Defaults to 10.
     */
    limit?: number | null;
    /**
     * Only report features that are satisfied by either 0, or at least
     * minFeatureRatio of the words.
     *
     * Defaults to 0.5.
     */
    minFeatureRatio?: number;
    /**
     * Set to true if the input has a particular order. Some of the links we use
     * apply only if the words have a given order.
     *
     * Defaults to true if the words are NOT alphabetically sorted.
     */
    ordered?: boolean;
};
/**
 * Create a Puzlink instance by downloading the wordlist and, optionally,
 * hypernym data.
 */
export declare function download({ 
/** TODO */
hypernym, }?: {
    hypernym?: boolean | "small" | "large";
}): Promise<Puzlink>;
export declare class Puzlink {
    linkers: Linker[];
    constructor({ lengthData, wordlist, hypernymDAGData, }: {
        lengthData?: [number, number][];
        wordlist: Record<string, number>;
        hypernymDAGData?: HypernymDAGData;
    });
    static download: typeof download;
    static parse: typeof parse;
    private linkLazy;
    /**
     * Given a list of words, returns a list of links they share, sorted from
     * highest to lowest score.
     */
    link(
    /** The words to link. See parse() for how these are parsed. */
    words: string | readonly string[], options?: LinkOptions & {
        lazy?: false;
    }): Link[];
    /** Given a list of words, returns a generator of links they share. */
    link(
    /** The words to link. See parse() for how these are parsed. */
    words: string | readonly string[], options?: LinkOptions & {
        lazy: true;
    }): Generator<Link>;
}
//# sourceMappingURL=puzlink.d.ts.map