coh-content-db 1.4.1 → 2.0.0-rc.10

package/dist/coh-content-db.d.ts

@@ -1,36 +1,1002 @@
-import { IServerGroup, IServerGroupData } from "./types/server-group";
-interface ICohContentDb {
+declare const ALIGNMENT: readonly ["hero", "villain", "praetorian"];
+type Alignment = typeof ALIGNMENT[number];
+type AlignmentExtended = Alignment
+/**
+ * The alignments available for Primal Earth characters - Hero and Villain.
+ */
+ | 'primal'
+/**
+ * All the alignments.
+ */
+ | 'all';
+declare function compareAlignment(a?: Alignment, b?: Alignment): number;
+
+declare const SEX: readonly ["M", "F"];
+type Sex = typeof SEX[number];
+declare function compareSex(a?: Sex, b?: Sex): number;
+
+/**
+ * Some badge values differ based on the alignment or sex of the character.
+ */
+interface AlternateData<V> {
     /**
-     * Load server group data package into the database.
-     * @param data The data to load.
+     * The character alignment this alternate applies to.
      */
-    load(data: IServerGroupData): void;
+    readonly alignment?: Alignment;
     /**
-     * Get all the server groups currently loaded in the database.
+     * The character sex this alternate applies to.
      */
-    getServerGroups(): IServerGroup[];
+    readonly sex?: Sex;
     /**
-     * get a server group by key.
-     * @param serverGroupKey The key.
+     * The value for this combination.
      */
-    getServerGroup(serverGroupKey: string): IServerGroup | null;
+    readonly value: V;
 }
-export declare class CohContentDb implements ICohContentDb {
-    private readonly serverGroups;
+
+interface ArchetypeData {
+    readonly key: string;
+    readonly name: string;
+    readonly description?: string;
+}
+
+declare const ENHANCEMENT_CATEGORY: readonly ["defense-debuff", "to-hit-debuff", "taunt", "confuse", "healing", "defense-buff", "resist-damage", "intangibility", "sleep", "slow", "hold", "stun", "immobilize", "fear", "endurance-modification", "endurance-reduction", "recharge-reduction", "interrupt-duration", "accuracy", "to-hit-buff", "damage", "knockback", "run-speed", "jump", "fly-speed", "range"];
+type EnhancementCategory = typeof ENHANCEMENT_CATEGORY[number];
+
+declare const BADGE_REQUIREMENT_TYPE: readonly ["badge", "invention", "invention-plus-one", "location", "monument", "mission", "task"];
+type BadgeRequirementType = typeof BADGE_REQUIREMENT_TYPE[number];
+
+/**
+ * Tage type to indicate that a string will accept {@link https://www.markdownguide.org/|Markdown} format.
+ */
+type MarkdownString = string;
+
+interface Link {
+    title: string;
+    href: string;
+}
+
+interface LocationData {
+    /**
+     * Key of the {@link Zone} that the location references.
+     */
+    readonly zoneKey?: string;
+    /**
+     * In-game `/loc` coordinates of the location.
+     */
+    readonly coords?: Coords;
+    /**
+     * The type of icon to use if the location appears on a map. (Typically the Vidiot map icon).
+     */
+    readonly icon?: LocationIcon;
+    /**
+     * The text that should appear in the location icon. (Typically a number or symbol from the Vidiot map).
+     */
+    readonly iconText?: string;
+}
+/**
+ * Coordinates as they appear using the in-game `/loc` command.
+ */
+type Coords = [number, number, number];
+type LocationIcon = 'badge' | 'plaque' | 'pedestal' | 'object';
+
+interface BadgeRequirementData {
+    /**
+     * Unique key used to reference this badge requirement.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The requirement type.
+     */
+    readonly type: BadgeRequirementType;
+    /**
+     * If the requirement involves a location, where it is.
+     */
+    readonly location?: LocationData | LocationData[];
+    /**
+     * If the requirement involves a badge, the badge key.
+     */
+    readonly badgeKey?: string;
+    /**
+     * If the requirement involves a mission, the mission key.
+     */
+    readonly missionKey?: string;
+    /**
+     * If the requirement involves a monument, the text that is displayed thereon.
+     */
+    readonly monumentText?: string;
+    /**
+     * If the requirement involves crafting an invention, the Level of the invention required.
+     */
+    readonly inventionLevel?: number;
+    /**
+     * If the requirement involves crafting an invention, the types of enhancements that will qualify.
+     */
+    readonly inventionTypes?: EnhancementCategory[];
+    /**
+     * Number of times the task needs to be repeated.
+     */
+    readonly count?: number;
+    /**
+     * Additional information about the requirement.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+}
+
+declare const BADGE_TYPE: readonly ["exploration", "history", "accomplishment", "achievement", "accolade", "gladiator", "veteran", "pvp", "invention", "defeat", "event", "ouroboros", "consignment", "day-job", "architect-entertainment"];
+type BadgeType = typeof BADGE_TYPE[number];
+
+declare const MORALITY: readonly ["hero", "vigilante", "villain", "rogue", "resistance", "loyalist"];
+type Morality = typeof MORALITY[number];
+type MoralityExtended = Morality
+/**
+ * Any of the Primal Earth moralities - Hero, Vigilante, Villain, Rogue.
+ */
+ | 'primal'
+/**
+ * Either of the Praetorian Earth moralities - Resistance or Loyalist.
+ */
+ | 'praetorian'
+/**
+ * The moralities that roll up to the Hero {@link Alignment} - Hero and Vigilante.
+ */
+ | 'heroic'
+/**
+ * The moralities that roll up to the Villain {@link Alignment} - Villain and Rogue.
+ */
+ | 'villainous'
+/**
+ * Moralities with access to Paragon City - Hero, Vigilante and Rogue.
+ */
+ | 'paragon-city-access'
+/**
+ * Moralities with access to the Rogue Isles - Villain, Rogue and Vigilante.
+ */
+ | 'rogue-isles-access'
+/**
+ * All the moralities.
+ */
+ | 'all';
+
+interface BadgeData {
+    /**
+     * Unique key used to reference this badge.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The type of badge.
+     */
+    readonly type: BadgeType;
+    /**
+     * The name of this badge.
+     *
+     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     */
+    readonly name: string | AlternateData<string>[];
+    /**
+     * The {@link MoralityExtended|moralities} that this badge is available to. If undefined then all moralities will be assumed.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * The badge text as it appears in-game. May vary by character sex or alignment.
+     */
+    readonly badgeText?: AlternateData<MarkdownString>[] | MarkdownString;
+    /**
+     * Short description of how to acquire the badge. Detailed instructions should go in the notes field.
+     */
+    readonly acquisition?: MarkdownString;
+    /**
+     * List of absolute URLs for this badge's icons.
+     *
+     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     */
+    readonly icon?: string | AlternateData<string>[];
+    /**
+     * Freeform notes or tips about the badge.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * The id used with the in-game `/settitle` command to apply the badge.
+     * The first value is the id for primal characters and the (optional) second number is the id for praetorian characters.
+     */
+    readonly setTitleId?: [number, number?];
+    /**
+     * A description of the effect the badge will have, such as a buff or granting a temporary power.
+     */
+    readonly effect?: MarkdownString;
+    /**
+     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
+     */
+    readonly requirements?: BadgeRequirementData[];
+    /**
+     * Some badges are not included in the badge total count... such as Flames of Prometheus, which can be removed by redeeming it for a Notice of the Well.
+     */
+    readonly ignoreInTotals?: boolean;
+}
+
+interface ZoneData {
+    /**
+     * Unique key used to reference this zone.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of the zone as it appears in-game.
+     */
+    readonly name: string;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+}
+
+interface ContactData {
+    /**
+     * Unique key used to reference this contact.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of this contact.
+     */
+    readonly name: string;
+    /**
+     * The contact's title.
+     */
+    readonly title?: string;
+    /**
+     * The character moralities that this contact will interact with.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * The location of this contact.
+     */
+    readonly location?: LocationData;
+    /**
+     * The level range this contact will offer missions for.
+     */
+    readonly levelRange?: [number, number?];
     /**
-     * @inheritDoc
-     * @override
+     * Freeform notes or tips about the contact.
      */
-    load(data: IServerGroupData): void;
+    readonly notes?: MarkdownString;
     /**
-     * @inheritDoc
-     * @override
+     * List of external links. Wiki, forums, etc.
      */
-    getServerGroups(): IServerGroup[];
+    readonly links?: Link[];
+}
+
+declare const MISSION_TYPE: readonly ["story-arc", "mission", "task-force", "strike-force", "trial", "personal-story"];
+type MissionType = typeof MISSION_TYPE[number];
+
+interface MissionData {
+    /**
+     * Unique key used to reference this mission.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of the mission as it appears from the contact.
+     *
+     * The name may be different when viewed in Ouroboros as a Flashback.
+     */
+    readonly name: string;
+    /**
+     * The type of mission... Story arc, task force, trial, etc.
+     */
+    readonly type: MissionType;
+    /**
+     * The character moralities that may accept the mission.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * The keys of any contacts that provide this mission.
+     */
+    readonly contactKeys?: string | string[];
+    /**
+     * The level range this mission is available for.
+     */
+    readonly levelRange?: [number, number?];
+    /**
+     * Freeform notes or tips about the mission.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * If the mission is available in Ouroboros as a Flashback.
+     */
+    readonly flashback?: MissionFlashbackData;
+}
+interface MissionFlashbackData {
+    /**
+     * The id of the mission as seen in the Flashback menu, i.e. '14.01'.
+     */
+    readonly id: string;
+    /**
+     * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
+     */
+    readonly levelRange?: [number, number?];
+    /**
+     * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly name?: string;
+    /**
+     * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * Freeform notes or tips about the Flashback version of the mission.
+     */
+    readonly notes?: MarkdownString;
+}
+
+/**
+ * Metadata about a content bundle.
+ */
+interface BundleHeaderData {
+    /**
+     * Name of the fork this bundle contains data for.
+     */
+    readonly name?: string;
+    /**
+     * Description of the fork.
+     */
+    readonly description?: MarkdownString;
+    /**
+     * Url for the repository where the bundle is maintained.
+     */
+    readonly repositoryUrl?: string;
+    /**
+     * Url for the location of the changelog.
+     */
+    readonly changelogUrl?: string;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * Version number for this data package.
+     */
+    readonly version?: string;
+}
+
+/**
+ * A bundle of game data from a forked instance of the game, such as Homecoming (https://forums.homecomingservers.com/).
+ */
+interface BundleData {
+    /**
+     * Bundle header.
+     */
+    readonly header?: BundleHeaderData;
+    /**
+     * List of the game server names in this fork.
+     * Torchbearer, Excelsior, etc.
+     */
+    readonly servers?: string[];
+    /**
+     * List of archetypes available in this fork.
+     */
+    readonly archetypes?: ArchetypeData[];
+    /**
+     * List of zones supported by this fork.
+     */
+    readonly zones?: ZoneData[];
+    /**
+     * List of contacts available in this fork.
+     */
+    readonly contacts?: ContactData[];
+    /**
+     * List of missions available in this fork.
+     */
+    readonly missions?: MissionData[];
+    /**
+     * List of badges available on this fork.
+     */
+    readonly badges?: BadgeData[];
+}
+
+declare class AlignmentList {
+    #private;
+    readonly hero: boolean;
+    readonly villain: boolean;
+    readonly praetorian: boolean;
+    readonly primal: boolean;
+    readonly all: boolean;
+    constructor(items?: AlignmentExtended[]);
+    get items(): Alignment[];
+    has(alignment?: AlignmentExtended): boolean;
+}
+
+declare class Alternates<T> {
+    #private;
+    /**
+     * Create an alternate set from either a list of categorized values, or a single value when there are no alternates.
+     * @param value List of alternates, or a single value.
+     */
+    constructor(value: AlternateData<T>[] | T);
+    getValue(alignment?: Alignment, sex?: Sex): T | undefined;
+    /**
+     * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
+     */
+    get default(): AlternateData<T> | undefined;
+    /**
+     * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
+     */
+    get canonical(): AlternateData<T>[];
+    /**
+     * Create a joined string from the alternate values in canonical order.
+     * @param separator Separator to use. Default is ' / '
+     */
+    toString(separator: string): string;
+}
+
+declare class Archetype {
+    readonly key: string;
+    readonly name: string;
+    readonly description?: string;
+    constructor(data: ArchetypeData);
+}
+
+declare class Location {
+    /**
+     * Key of the {@link Zone} that the location references.
+     */
+    readonly zoneKey?: string;
+    /**
+     * In-game `/loc` coordinates of the location.
+     */
+    readonly coords?: Coords;
+    /**
+     * The type of icon to use if the location appears on a map. (Typically the Vidiot map icon).
+     */
+    readonly icon?: LocationIcon;
+    /**
+     * The text that should appear in the location icon. (Typically a number or symbol from the Vidiot map).
+     */
+    readonly iconText?: string;
+    constructor(data: LocationData);
+}
+
+declare class BadgeRequirement {
     /**
-     * @inheritDoc
-     * @override
+     * Unique key used to reference this badge requirement.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    getServerGroup(serverGroupKey: string): IServerGroup | null;
+    readonly key: string;
+    /**
+     * The requirement type.
+     */
+    readonly type: BadgeRequirementType;
+    /**
+     * If the requirement involves a location, where it is.
+     */
+    readonly location?: Location[];
+    /**
+     * If the requirement involves a badge, the badge key.
+     */
+    readonly badgeKey?: string;
+    /**
+     * If the requirement involves a mission, the mission key.
+     */
+    readonly missionKey?: string;
+    /**
+     * If the requirement involves a monument, the text that is displayed thereon.
+     */
+    readonly monumentText?: string;
+    /**
+     * If the requirement involves crafting an invention, the Level of the invention required.
+     */
+    readonly inventionLevel?: number;
+    /**
+     * If the requirement involves crafting an invention, the types of enhancements that will qualify.
+     */
+    readonly inventionTypes?: EnhancementCategory[];
+    /**
+     * Number of times the task needs to be repeated.
+     */
+    readonly count?: number;
+    /**
+     * Additional information about the requirement.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    constructor(data: BadgeRequirementData);
+}
+
+declare class MoralityList {
+    #private;
+    readonly hero: boolean;
+    readonly vigilante: boolean;
+    readonly villain: boolean;
+    readonly rogue: boolean;
+    readonly resistance: boolean;
+    readonly loyalist: boolean;
+    readonly primal: boolean;
+    readonly praetorian: boolean;
+    readonly heroic: boolean;
+    readonly villainous: boolean;
+    readonly paragonCityAccess: boolean;
+    readonly rogueIslesAccess: boolean;
+    readonly all: boolean;
+    constructor(items?: MoralityExtended[]);
+    get items(): Morality[];
+    has(morality?: MoralityExtended): boolean;
+}
+
+declare class Badge {
+    #private;
+    /**
+     * The database key for this badge.
+     */
+    readonly key: string;
+    /**
+     * The type of badge.
+     */
+    readonly type: BadgeType;
+    /**
+     * The name of this badge.
+     *
+     * May vary by character sex or alignment.
+     */
+    readonly name: Alternates<string>;
+    /**
+     * The character moralities that this badge is available to.
+     */
+    readonly morality: MoralityList;
+    /**
+     * The badge text as it appears in-game. May vary by character sex or alignment.
+     */
+    readonly badgeText: Alternates<MarkdownString>;
+    /**
+     * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
+     */
+    readonly acquisition?: MarkdownString;
+    /**
+     * Absolute URL to this badge's icon.
+     *
+     * May vary by character sex or alignment.
+     */
+    readonly icon: Alternates<string>;
+    /**
+     * Freeform notes or tips about the badge.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    /**
+     * The id used with the in-game `/settitle` command to apply the badge.
+     * The first value is the id for primal characters and the (optional) second number is the id for praetorian characters.
+     */
+    readonly setTitleId?: [number, number?];
+    /**
+     * A description of the effect the badge will have, such as a buff or granting a temporary power.
+     */
+    readonly effect?: MarkdownString;
+    /**
+     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
+     */
+    readonly requirements?: BadgeRequirement[];
+    /**
+     * Some badges are not included in the badge total count... such as Flames of Prometheus, which can be removed by redeeming it for a Notice of the Well.
+     */
+    readonly ignoreInTotals: boolean;
+    constructor(badgeData: BadgeData);
+    getRequirement(key: string): BadgeRequirement;
+    /**
+     * Return a list of all the zone keys referenced by this badge.
+     */
+    get zoneKeys(): string[];
+    /**
+     * The zone key if this badge relates to a single zone.
+     */
+    get zoneKey(): string | undefined;
+}
+declare function compareByDefaultName(a?: Badge, b?: Badge): number;
+declare function compareByZoneKey(a?: Badge, b?: Badge): number;
+
+interface BadgeSearchOptions {
+    /**
+     * Text-based search.
+     *
+     * Case-insensitive. Defaults to searching on name only.
+     */
+    query?: {
+        str?: string;
+        on?: {
+            name?: boolean;
+            badgeText?: boolean;
+            acquisition?: boolean;
+            notes?: boolean;
+            effect?: boolean;
+            setTitle?: boolean;
+        };
+    };
+    /**
+     * Filter results matching the given values.
+     */
+    filter?: {
+        type?: BadgeType;
+        zoneKey?: string;
+        morality?: MoralityExtended;
+    };
+    /**
+     * Sort results.
+     *
+     * Badges are assumed to be in canonical order in the content bundle, and should match the in-game display order.
+     */
+    sort?: {
+        by?: 'canonical' | 'badge-name' | 'zone-key';
+        dir?: 'asc' | 'desc';
+    };
+    /**
+     * The page (1-based)
+     */
+    page?: number;
+    /**
+     * How many results per page
+     */
+    pageSize?: number;
+}
+
+interface Paged<T> {
+    items: T[];
+    page: number;
+    pageSize?: number;
+    totalItems: number;
+    totalPages: number;
+}
+
+type KeysOfType<T, V> = {
+    [P in keyof T]: T[P] extends V ? P : never;
+}[keyof T];
+declare class AbstractIndex<T> {
+    protected _values: T[];
+    protected _hashTable: Record<string, T>;
+    /**
+     * Create a new index.
+     * @param keyField The field of the values that will act as the key.
+     * @param values Values to index.
+     */
+    constructor(keyField: KeysOfType<T, string>, values: T[] | undefined);
+    /**
+     * Return all indexed values
+     */
+    get values(): T[];
+    /**
+     * Get a value from the index
+     * @param key Key string
+     */
+    get(key: string | undefined): T | undefined;
+}
+
+declare class BadgeIndex extends AbstractIndex<Badge> {
+    #private;
+    constructor(values: Badge[] | undefined);
+    search(options?: BadgeSearchOptions): Paged<Badge>;
+}
+
+declare class BundleHeader {
+    /**
+     * Name of the content bundle.
+     */
+    readonly name?: string;
+    /**
+     * Description of the fork.
+     */
+    readonly description?: MarkdownString;
+    /**
+     * Url for the repository where the bundle is maintained.
+     */
+    readonly repositoryUrl?: string;
+    /**
+     * Url for the location of the changelog.
+     */
+    readonly changelogUrl?: string;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * The current version of the data package.
+     */
+    readonly version?: string;
+    constructor(data: BundleHeaderData | undefined);
+}
+
+declare class Zone {
+    /**
+     * Unique key used to reference this zone.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of the zone as it appears in-game.
+     */
+    readonly name: string;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    constructor(data: ZoneData);
+}
+
+declare class Contact {
+    /**
+     * Unique key used to reference this contact.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of this contact.
+     */
+    readonly name: string;
+    /**
+     * The contact's title.
+     */
+    readonly title?: string;
+    /**
+     * The character moralities that this contact will interact with.
+     */
+    readonly morality?: MoralityList;
+    /**
+     * The location of this contact.
+     */
+    readonly location?: Location;
+    /**
+     * The level range this contact will offer missions for.
+     */
+    readonly levelRange?: [number, number?];
+    /**
+     * Freeform notes or tips about the contact.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    constructor(data: ContactData);
+}
+
+declare class Mission {
+    /**
+     * Unique key used to reference this mission.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of the mission as it appears from the contact.
+     *
+     * The name may be different when viewed in Ouroboros as a Flashback.
+     */
+    readonly name: string;
+    /**
+     * The type of mission... Story arc, task force, trial, etc.
+     */
+    readonly type: MissionType;
+    /**
+     * The character moralities that may accept the mission.
+     */
+    readonly morality: MoralityList;
+    /**
+     * The keys of any contacts that provide this mission.
+     */
+    readonly contactKeys?: string[];
+    /**
+     * The level range this mission is available for.
+     */
+    readonly levelRange?: [number, number?];
+    /**
+     * Freeform notes or tips about the mission.
+     */
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    /**
+     * If the mission is available in Ouroboros as a Flashback.
+     */
+    readonly flashback?: {
+        /**
+         * The id of the mission as seen in the Flashback menu, i.e. '14.01'.
+         */
+        readonly id: string;
+        /**
+         * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
+         */
+        readonly levelRange?: [number, number?];
+        /**
+         * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+         */
+        readonly name?: string;
+        /**
+         * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
+         */
+        readonly morality?: MoralityList;
+        /**
+         * Freeform notes or tips about the Flashback version of the mission.
+         */
+        readonly notes?: MarkdownString;
+    };
+    constructor(data: MissionData);
+}
+
+declare class CohContentDatabase {
+    #private;
+    /**
+     * Create a db instance from the given content bundle.
+     * @param bundle The bundle to load.
+     */
+    constructor(bundle: BundleData);
+    /**
+     * Header information about the content bundle.
+     */
+    get header(): BundleHeader;
+    /**
+     * List of the game server names.
+     *
+     * Torchbearer, Excelsior, etc.
+     */
+    get servers(): string[];
+    /**
+     * List of archetypes.
+     */
+    get archetypes(): Archetype[];
+    /**
+     * Get archetype by key.
+     * @param key The key.
+     */
+    getArchetype(key: string | undefined): Archetype | undefined;
+    /**
+     * List of game zones.
+     */
+    get zones(): Zone[];
+    /**
+     * Get zone by key.
+     * @param key The key.
+     */
+    getZone(key: string | undefined): Zone | undefined;
+    /**
+     * List of contacts.
+     */
+    get contacts(): Contact[];
+    /**
+     * Get contact by key.
+     * @param key The key.
+     */
+    getContact(key: string | undefined): Contact | undefined;
+    /**
+     * List of missions.
+     */
+    get missions(): Mission[];
+    /**
+     * Get mission by key.
+     * @param key The key.
+     */
+    getMission(key: string | undefined): Mission | undefined;
+    /**
+     * List of badges.
+     */
+    get badges(): Badge[];
+    /**
+     * Get badge by key.
+     * @param key The key.
+     */
+    getBadge(key: string | undefined): Badge | undefined;
+    /**
+     * Search, sort and filter the badge list.
+     * This is a fairly brute-forced approach and will not be as performant as loading the badge data into a traditional
+     * database engine, but is sufficient for most operations.
+     * @param options {@link BadgeSearchOptions}
+     */
+    searchBadges(options?: BadgeSearchOptions): Paged<Badge>;
+}
+
+declare class Key {
+    #private;
+    constructor(value: string);
+    get value(): string;
 }
-export {};
+
+/**
+ * Returns the URI of the given badge that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `badge://<key>`
+ *
+ * @param target The badge or badge key to target.
+ */
+declare function badgeUri(target: string | Badge | BadgeData): string;
+/**
+ * Returns a {@link MarkdownString} link to the given badge.
+ *
+ * Link format: `[<key>](badge://<key>)`
+ *
+ * @param target The {@link Badge} or badge key to target.
+ */
+declare function badgeLink(target: string | Badge | BadgeData): string;
+/**
+ * Returns the URI of the given contact that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `contact://<key>`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+declare function contactUri(target: string | Contact | ContactData): string;
+/**
+ * Returns a {@link MarkdownString} link to the given contact.
+ *
+ * Link format: `[<key>](contact://<key>)`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+declare function contactLink(target: string | Contact | ContactData): string;
+/**
+ * Returns the URI of the given mission that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `mission://<key>`
+ *
+ * @param target The {@link Mission} or mission key to target.
+ */
+declare function missionUri(target: string | Mission | MissionData): string;
+/**
+ * Returns a {@link MarkdownString} link to the given mission.
+ *
+ * Link format: `[<key>](mission://<key>)`
+ *
+ * @param target The {@link Mission} or mission key to target.
+ */
+declare function missionLink(target: string | Mission | MissionData): string;
+/**
+ * Returns the URI of the given zone that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `zone://<key>`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+declare function zoneUri(target: string | Zone | ZoneData): string;
+/**
+ * Returns a {@link MarkdownString} link to the given zone.
+ *
+ * Link format: `[<key>](zone://<key>)`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+declare function zoneLink(target: string | Zone | ZoneData): string;
+/**
+ * For fields that accept either an array of values or a single value, coalesces the value to an array.
+ *
+ * Arrays are returned as-is.
+ * Single values are returned as a single-value array.
+ * Undefined values are returned as undefined.
+ *
+ * @param value The value to coalesce.
+ */
+declare function coalesceToArray<T>(value?: T | T[]): T[] | undefined;
+
+export { ALIGNMENT, type Alignment, type AlignmentExtended, AlignmentList, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, BadgeRequirement, type BadgeRequirementData, type BadgeRequirementType, type BadgeSearchOptions, type BadgeType, type BundleData, BundleHeader, type BundleHeaderData, CohContentDatabase, Contact, type ContactData, type Coords, ENHANCEMENT_CATEGORY, type EnhancementCategory, Key, type Link, Location, type LocationData, type LocationIcon, MISSION_TYPE, MORALITY, type MarkdownString, Mission, type MissionData, type MissionFlashbackData, type MissionType, type Morality, type MoralityExtended, MoralityList, type Paged, SEX, type Sex, Zone, type ZoneData, badgeLink, badgeUri, coalesceToArray, compareAlignment, compareByDefaultName, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };