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

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

@@ -1,8 +1,19 @@
-declare const ALIGNMENT: readonly ["H", "V", "P"];
+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.
@@ -11,11 +22,11 @@ interface AlternateData<V> {
     /**
      * The character alignment this alternate applies to.
      */
-    readonly alignment?: Alignment | string;
+    readonly alignment?: Alignment;
     /**
      * The character sex this alternate applies to.
      */
-    readonly sex?: Sex | string;
+    readonly sex?: Sex;
     /**
      * The value for this combination.
      */
@@ -28,289 +39,412 @@ interface ArchetypeData {
     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"];
+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_PARTIAL_TYPE: readonly ["PLAQUE", "BADGE", "INVENTION", "INVENTION_PLUS_ONE"];
-type BadgePartialType = typeof BADGE_PARTIAL_TYPE[number];
+declare const BADGE_REQUIREMENT_TYPE: readonly ["badge", "invention", "invention-plus-one", "location", "monument", "mission", "task"];
+type BadgeRequirementType = typeof BADGE_REQUIREMENT_TYPE[number];
 
-declare const PLAQUE_TYPE: string[];
-type PlaqueType = typeof PLAQUE_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 BadgePartialData {
+interface LocationData {
     /**
-     * Key.
+     * Key of the {@link Zone} that the location references.
      */
-    readonly key: string;
+    readonly zoneKey?: string;
     /**
-     * Type of partial.
+     * In-game `/loc` coordinates of the location.
      */
-    readonly type: BadgePartialType | string;
+    readonly coords?: Coords;
     /**
-     * Map the partial is located on.
+     * The type of icon to use if the location appears on a map. (Typically the Vidiot map icon).
      */
-    readonly mapKey?: string;
+    readonly icon?: LocationIcon;
     /**
-     * /loc coordinates.
+     * The text that should appear in the location icon. (Typically a number or symbol from the Vidiot map).
      */
-    readonly loc?: number[];
+    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 {
     /**
-     * Is it a wall plaque or a physical monument?
+     * Unique key used to reference this badge requirement.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    readonly plaqueType?: PlaqueType | string;
+    readonly key: string;
     /**
-     * Plaque inscription.
+     * The requirement type.
      */
-    readonly inscription?: string;
+    readonly type: BadgeRequirementType;
     /**
-     * The number or letter the partial appears as on Vidiot Maps.
+     * If the requirement involves a location, where it is.
      */
-    readonly vidiotMapKey?: string;
+    readonly location?: LocationData | LocationData[];
     /**
-     * The badge required for this partial.
+     * If the requirement involves a badge, the badge key.
      */
     readonly badgeKey?: string;
     /**
-     * Level of the invention required.
+     * 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;
     /**
-     * The types of enhancements required to be crafted.
+     * If the requirement involves crafting an invention, the types of enhancements that will qualify.
      */
-    readonly inventionTypes?: (EnhancementCategory | string)[];
+    readonly inventionTypes?: EnhancementCategory[];
     /**
-     * Number of invention crafts required.
+     * Number of times the task needs to be repeated.
      */
-    readonly inventionCount?: number;
+    readonly count?: number;
     /**
-     * Any additional notes.
+     * Additional information about the requirement.
      */
-    readonly notes?: string;
-}
-
-interface Link {
-    title: string;
-    href: string;
+    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", "AE"];
+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 can only contain lowercase letters, numbers and hyphens (`-`).
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
     readonly key: string;
     /**
      * The type of badge.
      */
-    readonly type: BadgeType | string;
+    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: AlternateData<string>[];
+    readonly name: string | AlternateData<string>[];
     /**
-     * The character alignments that this badge is available to.
+     * The {@link MoralityExtended|moralities} that this badge is available to. If undefined then all moralities will be assumed.
      */
-    readonly alignment: Alignment[];
+    readonly morality?: MoralityExtended | MoralityExtended[];
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
-    readonly badgeText?: AlternateData<string>[];
+    readonly badgeText?: AlternateData<MarkdownString>[] | MarkdownString;
     /**
-     * Description of how to acquire the badge.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Short description of how to acquire the badge. Detailed instructions should go in the notes field.
      */
-    readonly acquisition?: string;
+    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?: AlternateData<string>[];
+    readonly icon?: string | AlternateData<string>[];
     /**
      * Freeform notes or tips about the badge.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
-    readonly notes?: string;
+    readonly notes?: MarkdownString;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
     /**
-     * For exploration badges, the key of the {@link GameMapData|GameMap} that this badge is found on.
+     * 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 mapKey?: string;
-    /**
-     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
-     */
-    readonly loc?: [number, number, number];
-    /**
-     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
-     */
-    readonly vidiotMapKey?: string;
-    /**
-     * ID used with the in-game `/settitle` command to apply the badge.
-     */
-    readonly setTitle?: {
-        /**
-         * `/settitle` id.
-         */
-        id?: number;
-        /**
-         * `/settitle` id if different for praetorian characters.
-         */
-        praetorianId?: number;
-    };
+    readonly setTitleId?: [number, number?];
     /**
      * A description of the effect the badge will have, such as a buff or granting a temporary power.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
-    readonly effect?: string;
+    readonly effect?: MarkdownString;
     /**
-     * A list of requirements for badges that have partial fulfilment steps, such as visiting plaques for history badges, or collecting other badges for meta-badges like accolades.
+     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
      */
-    readonly partials?: BadgePartialData[];
+    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 Change {
+interface ZoneData {
     /**
-     * The version number in {@link http://semver.org|semver} format.
+     * Unique key used to reference this zone.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    version: string;
+    readonly key: string;
     /**
-     * Date of the change.
+     * The name of the zone as it appears in-game.
      */
-    date: Date;
+    readonly name: string;
     /**
-     * Description of the change in {@link https://www.markdownguide.org/|Markdown} format.
+     * List of external links. Wiki, forums, etc.
      */
-    description: string;
+    readonly links?: Link[];
 }
 
-interface VidiotMapPointOfInterestData {
+interface ContactData {
     /**
-     * The pixel-space position of the PoI on the map graphic.
+     * Unique key used to reference this contact.
      *
-     * Screen-space, pixels from top-left `[0, 0]`.
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    readonly pos?: [number, number];
+    readonly key: string;
     /**
-     * Freeform notes about the PoI.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * The name of this contact.
      */
-    readonly notes?: string;
+    readonly name: string;
     /**
-     * If the POI is a zone transfer, the map it transfers to.
+     * The contact's title.
      */
-    readonly mapKey?: string;
+    readonly title?: string;
     /**
-     * If the POI is a badge, the badge.
+     * The character moralities that this contact will interact with.
      */
-    readonly badgeKey?: string;
+    readonly morality?: MoralityExtended | MoralityExtended[];
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * The location of this contact.
      */
-    readonly badgePartialKey?: string;
-}
-
-interface VidiotMapData {
+    readonly location?: LocationData;
     /**
-     * URL of the map image.
+     * The level range this contact will offer missions for.
      */
-    readonly imageUrl: string;
+    readonly levelRange?: [number, number?];
     /**
-     * Name to display for the Vidiot map.
+     * Freeform notes or tips about the contact.
      */
-    readonly name?: string;
+    readonly notes?: MarkdownString;
     /**
-     * List of Points of Interest labelled on the image.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly pointsOfInterest?: VidiotMapPointOfInterestData[];
+    readonly links?: Link[];
 }
 
-interface GameMapData {
+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 badge.
+     * Unique key used to reference this mission.
      *
-     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
     readonly key: string;
     /**
-     * The name of the map as it appears in-game.
+     * 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;
     /**
-     * List of external links for this Map. Wiki, forums, etc.
+     * 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[];
     /**
-     * List of Vidiot Map assets for this map.
+     * 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 vidiotMaps?: VidiotMapData[];
+    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;
 }
 
 /**
- * A server group is a group or company that hosts a set of game servers, such as Homecoming (https://forums.homecomingservers.com/).
+ * Metadata about a content bundle.
  */
-interface ServerGroupData {
+interface BundleHeaderData {
     /**
-     * Unique key used to reference this server group.
-     *
-     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     * Name of the fork this bundle contains data for.
      */
-    readonly key: string;
+    readonly name?: string;
     /**
-     * Name of the server group.
+     * Description of the fork.
      */
-    readonly name: string;
+    readonly description?: MarkdownString;
     /**
-     * Description of the server group.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Url for the repository where the bundle is maintained.
      */
-    readonly description?: string;
+    readonly repositoryUrl?: string;
     /**
-     * Repository where the db content package is maintained.
+     * Url for the location of the changelog.
      */
-    readonly repository?: string;
+    readonly changelogUrl?: string;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
     /**
-     * List of the game server names in this server group.
+     * 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 server group.
+     * List of archetypes available in this fork.
      */
     readonly archetypes?: ArchetypeData[];
     /**
-     * List of game maps supported by this server group.
+     * List of zones supported by this fork.
      */
-    readonly maps?: GameMapData[];
+    readonly zones?: ZoneData[];
     /**
-     * List of badges available on this server group.
+     * 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;
     /**
-     * Change log for this data package.
+     * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
      */
-    readonly changelog?: Change[];
+    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 {
@@ -320,34 +454,94 @@ declare class Archetype {
     constructor(data: ArchetypeData);
 }
 
-declare class BadgePartial {
+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 {
+    /**
+     * Unique key used to reference this badge requirement.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+     */
     readonly key: string;
-    readonly type: BadgePartialType | string;
-    readonly mapKey?: string;
-    readonly loc?: number[];
-    readonly plaqueType?: PlaqueType | string;
-    readonly inscription?: string;
-    readonly vidiotMapKey?: 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;
-    readonly inventionTypes?: (EnhancementCategory | string)[];
-    readonly inventionCount?: number;
-    readonly notes?: string;
-    constructor(data: BadgePartialData);
-}
-
-declare class Alternates<T> {
-    #private;
-    constructor(values: AlternateData<T>[]);
-    getValue(alignment?: Alignment | string, sex?: Sex | string): T | undefined;
     /**
-     * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
+     * If the requirement involves crafting an invention, the types of enhancements that will qualify.
      */
-    get default(): T | undefined;
+    readonly inventionTypes?: EnhancementCategory[];
     /**
-     * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
+     * Number of times the task needs to be repeated.
      */
-    get canonical(): AlternateData<T>[];
+    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 {
@@ -359,7 +553,7 @@ declare class Badge {
     /**
      * The type of badge.
      */
-    readonly type: BadgeType | string;
+    readonly type: BadgeType;
     /**
      * The name of this badge.
      *
@@ -367,19 +561,17 @@ declare class Badge {
      */
     readonly name: Alternates<string>;
     /**
-     * The character alignments that this badge is available to.
+     * The character moralities that this badge is available to.
      */
-    readonly alignment: Alignment[];
+    readonly morality: MoralityList;
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
-    readonly badgeText: Alternates<string>;
+    readonly badgeText: Alternates<MarkdownString>;
     /**
-     * Description of how to acquire the badge.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
      */
-    readonly acquisition?: string;
+    readonly acquisition?: MarkdownString;
     /**
      * Absolute URL to this badge's icon.
      *
@@ -388,188 +580,342 @@ declare class Badge {
     readonly icon: Alternates<string>;
     /**
      * Freeform notes or tips about the badge.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
-    readonly notes?: string;
+    readonly notes?: MarkdownString;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly links?: Link[];
+    readonly links: Link[];
     /**
-     * For exploration badges, the key of the {@link GameMap} that this badge is found on.
+     * 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 mapKey?: string;
+    readonly setTitleId?: [number, number?];
     /**
-     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+     * A description of the effect the badge will have, such as a buff or granting a temporary power.
      */
-    readonly loc?: [number, number, number];
+    readonly effect?: MarkdownString;
     /**
-     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
      */
-    readonly vidiotMapKey?: string;
+    readonly requirements?: BadgeRequirement[];
     /**
-     * ID used with the in-game `/settitle` command to apply the badge.
+     * 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 setTitle?: {
-        /**
-         * `/settitle` id.
-         */
-        id?: number;
-        /**
-         * `/settitle` id if different for praetorian characters.
-         */
-        praetorianId?: number;
+    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;
+        };
     };
     /**
-     * A description of the effect the badge will have, such as a buff or granting a temporary power.
+     * Filter results matching the given values.
+     */
+    filter?: {
+        type?: BadgeType;
+        zoneKey?: string;
+        morality?: MoralityExtended;
+    };
+    /**
+     * Sort results.
      *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Badges are assumed to be in canonical order in the content bundle, and should match the in-game display order.
      */
-    readonly effect?: string;
+    sort?: {
+        by?: 'canonical' | 'badge-name' | 'zone-key';
+        dir?: 'asc' | 'desc';
+    };
     /**
-     * A list of requirements for badges that have partial fulfilment steps, such as visiting plaques for history badges, or collecting other badges for meta-badges like accolades.
+     * The page (1-based)
      */
-    readonly partials?: BadgePartial[];
+    page?: number;
     /**
-     * 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.
+     * How many results per page
      */
-    readonly ignoreInTotals: boolean;
-    constructor(data: BadgeData);
-    getPartial(key: string): BadgePartial;
+    pageSize?: number;
 }
 
-declare class VidiotMapPointOfInterest {
+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>;
     /**
-     * The pixel-space position of the PoI on the map graphic.
-     *
-     * Screen-space, pixels from top-left `[0, 0]`.
+     * Create a new index.
+     * @param keyField The field of the values that will act as the key.
+     * @param values Values to index.
      */
-    readonly pos?: [number, number];
+    constructor(keyField: KeysOfType<T, string>, values: T[] | undefined);
     /**
-     * Freeform notes about the PoI.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Return all indexed values
      */
-    readonly notes?: string;
+    get values(): T[];
     /**
-     * If the POI is a zone transfer, the map it transfers to.
+     * Get a value from the index
+     * @param key Key string
      */
-    readonly mapKey?: 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 {
     /**
-     * If the POI is a badge, the badge.
+     * Name of the content bundle.
      */
-    readonly badgeKey?: string;
+    readonly name?: string;
+    /**
+     * Description of the fork.
+     */
+    readonly description?: MarkdownString;
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * Url for the repository where the bundle is maintained.
      */
-    readonly badgePartialKey?: string;
-    constructor(data: VidiotMapPointOfInterestData);
+    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 VidiotMap {
+declare class Zone {
     /**
-     * URL of the map image.
+     * Unique key used to reference this zone.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    readonly imageUrl: string;
+    readonly key: string;
     /**
-     * Name to display for the Vidiot map.
+     * The name of the zone as it appears in-game.
      */
-    readonly name?: string;
+    readonly name: string;
     /**
-     * List of Points of Interest labelled on the image.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly pointsOfInterest?: VidiotMapPointOfInterest[];
-    constructor(data: VidiotMapData);
+    readonly links: Link[];
+    constructor(data: ZoneData);
 }
 
-declare class GameMap {
+declare class Contact {
     /**
-     * The database key for this map.
+     * 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 the map as it appears in-game.
+     * The name of this contact.
      */
     readonly name: string;
     /**
-     * List of external links for this Map. Wiki, forums, etc.
+     * The contact's title.
      */
-    readonly links?: Link[];
+    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 Vidiot Map assets for this map.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly vidiotMaps?: VidiotMap[];
-    constructor(data: GameMapData);
+    readonly links: Link[];
+    constructor(data: ContactData);
 }
 
-declare class ServerGroup {
-    #private;
+declare class Mission {
     /**
-     * The database key for this server group.
+     * Unique key used to reference this mission.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
     readonly key: string;
     /**
-     * Name of the server group.
-     */
-    readonly name: string;
-    /**
-     * Description of the server group.
+     * The name of the mission as it appears from the contact.
      *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * The name may be different when viewed in Ouroboros as a Flashback.
      */
-    readonly description?: string;
+    readonly name: string;
     /**
-     * Repository where the db content package is maintained.
+     * The type of mission... Story arc, task force, trial, etc.
      */
-    readonly repository?: string;
+    readonly type: MissionType;
     /**
-     * List of external links for this Server Group. Wiki, forums, etc.
+     * The character moralities that may accept the mission.
      */
-    readonly links?: Link[];
+    readonly morality: MoralityList;
     /**
-     * List of the game server names in this server group.
-     * Torchbearer, Excelsior, etc.
+     * The keys of any contacts that provide this mission.
      */
-    readonly servers: string[];
+    readonly contactKeys?: string[];
     /**
-     * List of archetypes available in this server group.
+     * The level range this mission is available for.
      */
-    readonly archetypes: Archetype[];
+    readonly levelRange?: [number, number?];
     /**
-     * List of game maps supported by this server group.
+     * Freeform notes or tips about the mission.
      */
-    readonly maps: GameMap[];
+    readonly notes?: MarkdownString;
     /**
-     * List of badges available on this server group.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly badges: Badge[];
+    readonly links: Link[];
     /**
-     * Change log for this data package.
+     * If the mission is available in Ouroboros as a Flashback.
      */
-    readonly changelog?: Change[];
-    constructor(data: ServerGroupData);
-    getArchetype(key: string): Archetype;
-    getMap(key: string): GameMap;
-    getBadge(key: string): Badge;
+    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;
     /**
-     * Load a server group data package into the database.
-     * @param data The data to load.
+     * Create a db instance from the given content bundle.
+     * @param bundle The bundle to load.
      */
-    loadServerGroupData(data: ServerGroupData): void;
+    constructor(bundle: BundleData);
     /**
-     * Get all the server groups currently loaded in the database.
+     * Header information about the content bundle.
+     */
+    get header(): BundleHeader;
+    /**
+     * List of the game server names.
+     *
+     * Torchbearer, Excelsior, etc.
      */
-    listServerGroups(): ServerGroup[];
+    get servers(): string[];
     /**
-     * get a server group by key.
-     * @param serverGroupKey The key.
+     * List of archetypes.
      */
-    getServerGroup(serverGroupKey: string): ServerGroup | null;
+    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 {
@@ -578,21 +924,79 @@ declare class Key {
     get value(): string;
 }
 
-declare const CHANGELOG: Change[];
-
 /**
- * Create a reference string that can be used in most text strings to display a link to the given badge.
+ * 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 createBadgeReference(target: string | {
-    key: string;
-}): string;
+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;
 /**
- * Create a reference string that can be used in most text strings to display a link to the given map.
- * @param target The {@link GameMap} or map key to target.
+ * 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 createMapReference(target: string | {
-    key: string;
-}): string;
+declare function coalesceToArray<T>(value?: T | T[]): T[] | undefined;
 
-export { ALIGNMENT, type Alignment, type AlternateData, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeType, CHANGELOG, type Change, CohContentDatabase, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, PLAQUE_TYPE, type PlaqueType, SEX, ServerGroup, type ServerGroupData, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, createBadgeReference, createMapReference };
+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 };