coh-content-db 2.0.0-rc.4 → 2.0.0-rc.6

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

@@ -11,11 +11,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.
      */
@@ -31,25 +31,35 @@ interface ArchetypeData {
 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 ["PLAQUE", "BADGE", "INVENTION", "MISSION", "ARC", "TASK_FORCE", "INVENTION_PLUS_ONE"];
+type BadgeRequirementType = typeof BADGE_REQUIREMENT_TYPE[number];
 
 declare const PLAQUE_TYPE: string[];
 type PlaqueType = typeof PLAQUE_TYPE[number];
 
-interface BadgePartialData {
+/**
+ * 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 BadgeRequirementData {
     /**
      * Key.
      */
     readonly key: string;
     /**
-     * Type of partial.
+     * Type of requirement.
      */
-    readonly type: BadgePartialType | string;
+    readonly type: BadgeRequirementType;
     /**
-     * Map the partial is located on.
+     * Zone the requirement is located in.
      */
-    readonly mapKey?: string;
+    readonly zoneKey?: string;
     /**
      * /loc coordinates.
      */
@@ -57,19 +67,27 @@ interface BadgePartialData {
     /**
      * Is it a wall plaque or a physical monument?
      */
-    readonly plaqueType?: PlaqueType | string;
+    readonly plaqueType?: PlaqueType;
     /**
      * Plaque inscription.
      */
-    readonly inscription?: string;
+    readonly plaqueInscription?: string;
     /**
-     * The number or letter the partial appears as on Vidiot Maps.
+     * The number or letter the plaque appears as on Vidiot Maps.
      */
     readonly vidiotMapKey?: string;
     /**
-     * The badge required for this partial.
+     * The key of the badge for this requirement.
      */
     readonly badgeKey?: string;
+    /**
+     * Mission name.
+     */
+    readonly missionName?: string;
+    /**
+     * {@link Contact} key for the story arc.
+     */
+    readonly contactKey?: string;
     /**
      * Level of the invention required.
      */
@@ -77,7 +95,7 @@ interface BadgePartialData {
     /**
      * The types of enhancements required to be crafted.
      */
-    readonly inventionTypes?: (EnhancementCategory | string)[];
+    readonly inventionTypes?: EnhancementCategory[];
     /**
      * Number of invention crafts required.
      */
@@ -85,12 +103,11 @@ interface BadgePartialData {
     /**
      * Any additional notes.
      */
-    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"];
@@ -106,7 +123,7 @@ interface BadgeData {
     /**
      * The type of badge.
      */
-    readonly type: BadgeType | string;
+    readonly type: BadgeType;
     /**
      * The name of this badge.
      *
@@ -122,11 +139,9 @@ interface BadgeData {
      */
     readonly badgeText?: AlternateData<string>[];
     /**
-     * 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.
      *
@@ -135,24 +150,22 @@ interface BadgeData {
     readonly icon?: 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.
+     * For exploration badges, the key of the {@link ZoneData|Zone} that this badge is found on.
      */
-    readonly mapKey?: string;
+    readonly zoneKey?: string;
     /**
-     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+     * For exploration badges, the `/loc` coordinates of the badge.
      */
     readonly loc?: [number, number, number];
     /**
-     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+     * For plaques that appear on a Vidiot Map, the number or letter the badge appears as.
      */
     readonly vidiotMapKey?: string;
     /**
@@ -170,14 +183,19 @@ interface BadgeData {
     };
     /**
      * 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 layered requirements for badges with multiple fulfillment steps,
+     * such as visiting plaques for history badges or collecting other badges.
+     *
+     * The outer array represents groups of requirements evaluated with OR logic —
+     * fulfilling any group satisfies the badge.
+     *
+     * Each inner array represents individual requirements evaluated with AND logic —
+     * all conditions in the group must be met.
      */
-    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.
      */
@@ -194,72 +212,63 @@ interface Change {
      */
     date: Date;
     /**
-     * Description of the change in {@link https://www.markdownguide.org/|Markdown} format.
+     * Description of the change.
      */
-    description: string;
+    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 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 zone this character is located in.
      */
-    readonly badgeKey?: string;
+    readonly zoneKey?: string;
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * The `/loc` coordinates of the contact.
      */
-    readonly badgePartialKey?: string;
-}
-
-interface VidiotMapData {
+    readonly loc?: [number, number, number];
     /**
-     * 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 {
+interface ZoneData {
     /**
-     * Unique key used to reference this badge.
+     * Unique key used to reference this zone.
      *
      * Keys 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 zone as it appears in-game.
      */
     readonly name: string;
     /**
-     * List of external links for this Map. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
-    /**
-     * List of Vidiot Map assets for this map.
-     */
-    readonly vidiotMaps?: VidiotMapData[];
 }
 
 /**
@@ -272,16 +281,14 @@ interface ContentBundle {
     readonly name: string;
     /**
      * Description of the fork.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
-    readonly description?: string;
+    readonly description?: MarkdownString;
     /**
      * Repository where the db content package is maintained.
      */
     readonly repository?: string;
     /**
-     * List of external links for this Badge. Wiki, forums, etc.
+     * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
     /**
@@ -294,9 +301,13 @@ interface ContentBundle {
      */
     readonly archetypes?: ArchetypeData[];
     /**
-     * List of game maps supported by this fork.
+     * List of zones supported by this fork.
      */
-    readonly maps?: GameMapData[];
+    readonly zones?: ZoneData[];
+    /**
+     * List of contacts available in this fork.
+     */
+    readonly contacts?: ContactData[];
     /**
      * List of badges available on this fork.
      */
@@ -307,6 +318,34 @@ interface ContentBundle {
     readonly changelog?: Change[];
 }
 
+declare class Alignments {
+    readonly items: Alignment[];
+    readonly hero: boolean;
+    readonly villain: boolean;
+    readonly praetorian: boolean;
+    readonly primal: boolean;
+    constructor(raw: Alignment[]);
+}
+
+declare class Alternates<T> {
+    #private;
+    constructor(values: AlternateData<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;
@@ -314,39 +353,68 @@ declare class Archetype {
     constructor(data: ArchetypeData);
 }
 
-declare class BadgePartial {
+declare class BadgeRequirement {
+    /**
+     * Key.
+     */
     readonly key: string;
-    readonly type: BadgePartialType | string;
-    readonly mapKey?: string;
+    /**
+     * Type of requirement.
+     */
+    readonly type: BadgeRequirementType;
+    /**
+     * Zone the requirement is located in.
+     */
+    readonly zoneKey?: string;
+    /**
+     * /loc coordinates.
+     */
     readonly loc?: number[];
-    readonly plaqueType?: PlaqueType | string;
-    readonly inscription?: string;
+    /**
+     * Is it a wall plaque or a physical monument?
+     */
+    readonly plaqueType?: PlaqueType;
+    /**
+     * Plaque inscription.
+     */
+    readonly plaqueInscription?: string;
+    /**
+     * The number or letter the plaque appears as on Vidiot Maps.
+     */
     readonly vidiotMapKey?: string;
+    /**
+     * The key of the badge for this requirement.
+     */
     readonly badgeKey?: string;
+    /**
+     * Mission name.
+     */
+    readonly missionName?: string;
+    /**
+     * {@link Contact} key for the story arc.
+     */
+    readonly contactKey?: string;
+    /**
+     * 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.
+     * The types of enhancements required to be crafted.
      */
-    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 invention crafts required.
      */
-    get canonical(): AlternateData<T>[];
+    readonly inventionCount?: number;
     /**
-     * Create a joined string from the alternate values in canonical order.
-     * @param separator Separator to use. Default is ' / '
+     * Any additional notes.
      */
-    toString(separator: string): string;
+    readonly notes?: MarkdownString;
+    /**
+     * List of external links. Wiki, forums, etc.
+     */
+    readonly links: Link[];
+    constructor(data: BadgeRequirementData);
 }
 
 declare class Badge {
@@ -358,7 +426,7 @@ declare class Badge {
     /**
      * The type of badge.
      */
-    readonly type: BadgeType | string;
+    readonly type: BadgeType;
     /**
      * The name of this badge.
      *
@@ -368,17 +436,15 @@ declare class Badge {
     /**
      * The character alignments that this badge is available to.
      */
-    readonly alignment: Alignment[];
+    readonly alignment: Alignments;
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
     readonly badgeText: Alternates<string>;
     /**
-     * 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.
      *
@@ -387,24 +453,22 @@ 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.
+     * For exploration badges, the key of the {@link Zone} that this badge is found on.
      */
-    readonly mapKey?: string;
+    readonly zoneKey?: string;
     /**
-     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+     * For exploration badges, the `/loc` coordinates of the badge.
      */
     readonly loc?: [number, number, number];
     /**
-     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+     * For plaques that appear on a Vidiot Map, the number or letter the badge appears as.
      */
     readonly vidiotMapKey?: string;
     /**
@@ -422,110 +486,165 @@ declare class Badge {
     };
     /**
      * 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 layered requirements for badges with multiple fulfillment steps,
+     * such as visiting plaques for history badges or collecting other badges.
+     *
+     * The outer array represents groups of requirements evaluated with OR logic —
+     * fulfilling any group satisfies the badge.
+     *
+     * Each inner array represents individual requirements evaluated with AND logic —
+     * all conditions in the group must be met.
      */
-    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;
 }
 
-declare class VidiotMapPointOfInterest {
+interface BadgeSearchOptions {
     /**
-     * The pixel-space position of the PoI on the map graphic.
+     * Text-based search.
      *
-     * Screen-space, pixels from top-left `[0, 0]`.
-     */
-    readonly pos?: [number, number];
+     * Case-insensitive. Defaults to searching on name only.
+     */
+    query?: {
+        str?: string;
+        on?: {
+            name?: boolean;
+            badgeText?: boolean;
+            acquisition?: boolean;
+            notes?: boolean;
+            effect?: boolean;
+            setTitle?: boolean;
+        };
+    };
     /**
-     * Freeform notes about the PoI.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * Filter results matching the given values.
      */
-    readonly notes?: string;
+    filter?: {
+        type?: BadgeType;
+        zoneKey?: string;
+        alignment?: Alignment;
+    };
     /**
-     * If the POI is a zone transfer, the map it transfers to.
+     * Sort results.
+     *
+     * Badges are assumed to be in canonical order in the content bundle, and should match the in-game display order.
      */
-    readonly mapKey?: string;
+    sort?: {
+        by?: 'CANONICAL' | 'BADGE_NAME' | 'ZONE_NAME';
+        dir?: 'ASC' | 'DESC';
+    };
     /**
-     * If the POI is a badge, the badge.
+     * The page (1-based)
      */
-    readonly badgeKey?: string;
+    page?: number;
     /**
-     * If the POI is a partial for a badge, the partial key.
+     * How many results per page
      */
-    readonly badgePartialKey?: string;
-    constructor(data: VidiotMapPointOfInterestData);
+    pageSize?: number;
 }
 
-declare class VidiotMap {
+declare class Zone {
     /**
-     * URL of the map image.
+     * Unique key used to reference this zone.
+     *
+     * Keys 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);
+}
+
+interface Paged<T> {
+    items: T[];
+    page: number;
+    pageSize?: number;
+    totalItems: number;
+    totalPages: number;
 }
 
-declare class GameMap {
+declare class BadgeIndex {
+    #private;
+    constructor(badges: Badge[], zones?: Zone[]);
+    getBadge(key: string): Badge;
+    badgeExists(key: string): boolean;
+    searchBadges(options?: BadgeSearchOptions): Paged<Badge>;
+}
+
+declare class BundleMetadata {
     /**
-     * The database key for this map.
+     * Name of the content bundle.
      */
-    readonly key: string;
+    readonly name: string;
     /**
-     * The name of the map as it appears in-game.
+     * Description of the fork.
      */
-    readonly name: string;
+    readonly description?: MarkdownString;
     /**
-     * List of external links for this Map. Wiki, forums, etc.
+     * Repository where the db content package is maintained.
      */
-    readonly links?: Link[];
+    readonly repository?: string;
     /**
-     * List of Vidiot Map assets for this map.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly vidiotMaps?: VidiotMap[];
-    constructor(data: GameMapData);
+    readonly links: Link[];
+    /**
+     * Change log for this data package.
+     */
+    readonly changelog: Change[];
+    constructor(bundle: ContentBundle);
 }
 
-declare class BundleMetadata {
+declare class Contact {
+    /**
+     * Unique key used to reference this contact.
+     *
+     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
     /**
-     * Name of the server group.
+     * The name of this contact.
      */
     readonly name: string;
     /**
-     * Description of the server group.
-     *
-     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     * The contact's title.
      */
-    readonly description?: string;
+    readonly title?: string;
     /**
-     * Repository where the db content package is maintained.
+     * The zone this character is located in.
      */
-    readonly repository?: string;
+    readonly zoneKey?: string;
     /**
-     * List of external links for this Server Group. Wiki, forums, etc.
+     * The `/loc` coordinates of the contact.
      */
-    readonly links: Link[];
+    readonly loc?: [number, number, number];
     /**
-     * Change log for this data package.
+     * The level range this contact will offer missions for.
      */
-    readonly changelog: Change[];
-    constructor(bundle: ContentBundle);
+    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(contactData: ContactData);
 }
 
 declare class CohContentDatabase {
@@ -535,20 +654,25 @@ 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 badges.
      */
     readonly badges: Badge[];
     /**
@@ -557,9 +681,19 @@ declare class CohContentDatabase {
      */
     constructor(bundle: ContentBundle);
     getArchetype(key: string): Archetype;
-    getMap(key: string): GameMap;
+    getZone(key: string): Zone;
+    getContact(key: string): Contact;
+    zoneExists(key: string): boolean;
+    contactExists(key: string): boolean;
     getBadge(key: string): Badge;
-    searchBadges(query?: string): Badge[];
+    badgeExists(key: string): boolean;
+    /**
+     * 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 {
@@ -571,18 +705,52 @@ declare class Key {
 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} links.
+ *
+ * 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} links.
+ *
+ * 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 zone that can be used in {@link MarkdownString} links.
+ *
+ * URI format: `zone://<key>`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+declare function zoneUri(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.
+ * 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 createMapReference(target: string | {
-    key: string;
-}): string;
+declare function zoneLink(target: string | Zone | ZoneData): string;
 
-export { ALIGNMENT, type Alignment, type AlternateData, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeType, BundleMetadata, CHANGELOG, type Change, CohContentDatabase, type ContentBundle, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, PLAQUE_TYPE, type PlaqueType, SEX, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, createBadgeReference, createMapReference };
+export { ALIGNMENT, type Alignment, Alignments, 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, ENHANCEMENT_CATEGORY, type EnhancementCategory, Key, type Link, type MarkdownString, PLAQUE_TYPE, type Paged, type PlaqueType, SEX, type Sex, Zone, type ZoneData, badgeLink, badgeUri, contactLink, contactUri, zoneLink, zoneUri };