coh-content-db 2.0.0-rc.5 → 2.0.0-rc.7

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.
@@ -28,84 +39,135 @@ 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 PLAQUE_TYPE: string[];
-type PlaqueType = typeof PLAQUE_TYPE[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 BadgePartialData {
+interface Link {
+    title: string;
+    href: string;
+}
+
+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;
+    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;
+    readonly key: string;
     /**
-     * Plaque inscription.
+     * The requirement type.
      */
-    readonly plaqueInscription?: 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[];
     /**
-     * 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?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
 }
 
-interface Link {
-    title: string;
-    href: string;
-}
-
-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;
     /**
@@ -117,17 +179,17 @@ interface BadgeData {
      *
      * 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.
+     * Short description of how to acquire the badge. Detailed instructions should go in the notes field.
      */
     readonly acquisition?: MarkdownString;
     /**
@@ -135,48 +197,28 @@ interface BadgeData {
      *
      * 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.
      */
     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.
-     */
-    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.
+     * 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 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.
      */
     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.
      */
@@ -198,65 +240,126 @@ interface Change {
     description: MarkdownString;
 }
 
-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 key: string;
+    /**
+     * The name of this contact.
      */
-    readonly pos?: [number, number];
+    readonly name: string;
     /**
-     * Freeform notes about the PoI.
+     * The contact's title.
      */
-    readonly notes?: MarkdownString;
+    readonly title?: string;
     /**
-     * If the POI is a zone transfer, the map it transfers to.
+     * The character moralities that this contact will interact with.
      */
-    readonly mapKey?: string;
+    readonly morality?: MoralityExtended | MoralityExtended[];
     /**
-     * If the POI is a badge, the badge.
+     * The location of this contact.
      */
-    readonly badgeKey?: string;
+    readonly location?: LocationData;
+    /**
+     * The level range this contact will offer missions for.
+     */
+    readonly levelRange?: [number, number?];
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * Freeform notes or tips about the contact.
      */
-    readonly badgePartialKey?: string;
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
 }
 
-interface VidiotMapData {
+interface ZoneData {
     /**
-     * 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?: 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 vidiotMaps?: VidiotMapData[];
+    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;
 }
 
 /**
@@ -276,7 +379,7 @@ interface ContentBundle {
      */
     readonly repository?: string;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
     /**
@@ -289,9 +392,17 @@ interface ContentBundle {
      */
     readonly archetypes?: ArchetypeData[];
     /**
-     * List of game maps supported by this fork.
+     * 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 maps?: GameMapData[];
+    readonly missions?: MissionData[];
     /**
      * List of badges available on this fork.
      */
@@ -302,18 +413,25 @@ interface ContentBundle {
     readonly changelog?: Change[];
 }
 
-declare class Alignments {
-    readonly items: Alignment[];
+declare class AlignmentList {
+    #private;
     readonly hero: boolean;
     readonly villain: boolean;
     readonly praetorian: boolean;
     readonly primal: boolean;
-    constructor(raw: Alignment[]);
+    readonly all: boolean;
+    constructor(items?: AlignmentExtended[]);
+    get items(): Alignment[];
+    has(alignment?: AlignmentExtended): boolean;
 }
 
 declare class Alternates<T> {
     #private;
-    constructor(values: AlternateData<T>[]);
+    /**
+     * 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.
@@ -337,56 +455,94 @@ declare class Archetype {
     constructor(data: ArchetypeData);
 }
 
-declare class BadgePartial {
+declare class Location {
     /**
-     * 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;
+    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;
+    constructor(data: LocationData);
+}
+
+declare class BadgeRequirement {
     /**
-     * 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;
+    readonly key: string;
     /**
-     * Plaque inscription.
+     * The requirement type.
      */
-    readonly plaqueInscription?: 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?: Location[];
     /**
-     * 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[];
     /**
-     * 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?: MarkdownString;
-    constructor(data: BadgePartialData);
+    /**
+     * 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 {
@@ -406,15 +562,15 @@ 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: Alignments;
+    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.
+     * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
      */
     readonly acquisition?: MarkdownString;
     /**
@@ -428,49 +584,39 @@ declare class Badge {
      */
     readonly notes?: MarkdownString;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
-     */
-    readonly links?: Link[];
-    /**
-     * For exploration badges, the key of the {@link GameMap} that this badge is found on.
-     */
-    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.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly vidiotMapKey?: string;
+    readonly links: Link[];
     /**
-     * ID used with the in-game `/settitle` command to apply the badge.
+     * 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 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.
      */
     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?: BadgePartial[];
+    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(data: BadgeData);
-    getPartial(key: string): BadgePartial;
+    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 {
     /**
@@ -494,8 +640,8 @@ interface BadgeSearchOptions {
      */
     filter?: {
         type?: BadgeType;
-        mapKey?: string;
-        alignment?: Alignment;
+        zoneKey?: string;
+        morality?: MoralityExtended;
     };
     /**
      * Sort results.
@@ -503,8 +649,8 @@ interface BadgeSearchOptions {
      * 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' | 'MAP_NAME';
-        dir?: 'ASC' | 'DESC';
+        by?: 'canonical' | 'badge-name' | 'zone-key';
+        dir?: 'asc' | 'desc';
     };
     /**
      * The page (1-based)
@@ -516,105 +662,164 @@ interface BadgeSearchOptions {
     pageSize?: number;
 }
 
-declare class VidiotMapPointOfInterest {
+interface Paged<T> {
+    items: T[];
+    page: number;
+    pageSize?: number;
+    totalItems: number;
+    totalPages: number;
+}
+
+declare class BadgeIndex {
+    #private;
+    constructor(badges: Badge[]);
+    getBadge(key?: string): Badge | undefined;
+    searchBadges(options?: BadgeSearchOptions): Paged<Badge>;
+}
+
+declare class BundleMetadata {
     /**
-     * The pixel-space position of the PoI on the map graphic.
-     *
-     * Screen-space, pixels from top-left `[0, 0]`.
+     * Name of the content bundle.
      */
-    readonly pos?: [number, number];
+    readonly name: string;
     /**
-     * Freeform notes about the PoI.
+     * Description of the fork.
      */
-    readonly notes?: MarkdownString;
+    readonly description?: MarkdownString;
     /**
-     * If the POI is a zone transfer, the map it transfers to.
+     * Repository where the db content package is maintained.
      */
-    readonly mapKey?: string;
+    readonly repository?: string;
     /**
-     * If the POI is a badge, the badge.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly badgeKey?: string;
+    readonly links: Link[];
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * Change log for this data package.
      */
-    readonly badgePartialKey?: string;
-    constructor(data: VidiotMapPointOfInterestData);
+    readonly changelog: Change[];
+    constructor(bundle: ContentBundle);
 }
 
-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;
     /**
-     * List of Vidiot Map assets for this map.
+     * The character moralities that this contact will interact with.
      */
-    readonly vidiotMaps?: VidiotMap[];
-    constructor(data: GameMapData);
-}
-
-interface Paged<T> {
-    items: T[];
-    page: number;
-    pageSize?: number;
-    totalItems: number;
-    totalPages: number;
-}
-
-declare class BadgeIndex {
-    #private;
-    constructor(badges: Badge[], maps?: GameMap[]);
-    getBadge(key: string): Badge;
-    searchBadges(options?: BadgeSearchOptions): Paged<Badge>;
+    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 BundleMetadata {
+declare class Mission {
     /**
-     * Name of the 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;
+    /**
+     * 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;
     /**
-     * Description of the server group.
+     * The type of mission... Story arc, task force, trial, etc.
      */
-    readonly description?: MarkdownString;
+    readonly type: MissionType;
     /**
-     * Repository where the db content package is maintained.
+     * The character moralities that may accept the mission.
      */
-    readonly repository?: string;
+    readonly morality: MoralityList;
     /**
-     * List of external links for this Server Group. Wiki, forums, etc.
+     * 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[];
     /**
-     * Change log for this data package.
+     * If the mission is available in Ouroboros as a Flashback.
      */
-    readonly changelog: Change[];
-    constructor(bundle: ContentBundle);
+    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 {
@@ -624,20 +829,29 @@ declare class CohContentDatabase {
      */
     readonly metadata: BundleMetadata;
     /**
-     * List of the game server names in this server group.
+     * List of the game server names.
+     *
      * Torchbearer, Excelsior, etc.
      */
     readonly servers: string[];
     /**
-     * List of archetypes available in this server group.
+     * List of archetypes.
      */
     readonly archetypes: Archetype[];
     /**
-     * List of game maps supported by this server group.
+     * List of game zones.
+     */
+    readonly zones: Zone[];
+    /**
+     * List of contacts.
      */
-    readonly maps: GameMap[];
+    readonly contacts: Contact[];
     /**
-     * List of badges available on this server group.
+     * List of missions.
+     */
+    readonly missions: Contact[];
+    /**
+     * List of badges.
      */
     readonly badges: Badge[];
     /**
@@ -645,9 +859,11 @@ declare class CohContentDatabase {
      * @param bundle The data to load.
      */
     constructor(bundle: ContentBundle);
-    getArchetype(key: string): Archetype;
-    getMap(key: string): GameMap;
-    getBadge(key: string): Badge;
+    getArchetype(key?: string): Archetype | undefined;
+    getZone(key?: string): Zone | undefined;
+    getContact(key?: string): Contact | undefined;
+    getMission(key?: string): Mission | undefined;
+    getBadge(key?: string): 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
@@ -666,44 +882,78 @@ declare class Key {
 declare const CHANGELOG: Change[];
 
 /**
- * Returns the URI of the given badge that can be used in {@link MarkdownString} links.
+ * 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 | {
-    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 badge or badge key to target.
+ * @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 badgeLink(target: string | {
-    key: string;
-}): string;
+declare function zoneUri(target: string | Zone | ZoneData): string;
 /**
- * Returns the URI of the given map that can be used in {@link MarkdownString} links.
+ * Returns a {@link MarkdownString} link to the given zone.
  *
- * URI format: `map://<key>`
+ * Link format: `[<key>](zone://<key>)`
  *
- * @param target The {@link GameMap} or map key to target.
+ * @param target The {@link Zone} or zone key to target.
  */
-declare function mapUri(target: string | {
-    key: string;
-}): string;
+declare function zoneLink(target: string | Zone | ZoneData): string;
 /**
- * Returns a {@link MarkdownString} link to the given map.
+ * For fields that accept either an array of values or a single value, coalesces the value to an array.
  *
- * Link format: `[<key>](map://<key>)`
+ * Arrays are returned as-is.
+ * Single values are returned as a single-value array.
+ * Undefined values are returned as undefined.
  *
- * @param target The map or map key to target.
+ * @param value The value to coalesce.
  */
-declare function mapLink(target: string | {
-    key: string;
-}): string;
+declare function coalesceToArray<T>(value?: T | T[]): T[] | undefined;
 
-export { ALIGNMENT, type Alignment, Alignments, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeSearchOptions, type BadgeType, BundleMetadata, CHANGELOG, type Change, CohContentDatabase, type ContentBundle, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, type MarkdownString, PLAQUE_TYPE, type Paged, type PlaqueType, SEX, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, badgeLink, badgeUri, mapLink, mapUri };
+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, BundleMetadata, CHANGELOG, type Change, CohContentDatabase, Contact, type ContactData, type ContentBundle, 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 };