coh-content-db 2.0.0-rc.19 → 2.0.0-rc.20

package/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.0.0-rc.19] - 2026-01-02
+## [2.0.0-rc.20] - 2026-01-03
 
 ### Added
 

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

@@ -11,28 +11,6 @@ type AlignmentExtended = Alignment
  | 'all';
 declare function compareAlignment(a?: Alignment, b?: Alignment): number;
 
-declare const SEX: readonly ["M", "F"];
-type Sex = typeof SEX[number];
-declare function compareSex(a?: Sex, b?: Sex): number;
-
-/**
- * Some badge values differ based on the alignment or sex of the character.
- */
-interface AlternateData<V> {
-    /**
-     * The character alignment this alternate applies to.
-     */
-    readonly alignment?: Alignment;
-    /**
-     * The character sex this alternate applies to.
-     */
-    readonly sex?: Sex;
-    /**
-     * The value for this combination.
-     */
-    readonly value: V;
-}
-
 interface ArchetypeData {
     readonly key: string;
     readonly name: string;
@@ -131,10 +109,36 @@ interface BadgeRequirementData {
 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 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 a character.
+ */
+interface VariantData<V> {
+    /**
+     * The character alignment this variant applies to.
+     */
+    readonly alignment?: Alignment;
+    /**
+     * The character sex this variant applies to.
+     */
+    readonly sex?: Sex;
+    /**
+     * The value for this combination.
+     */
+    readonly value: V;
+}
+
 declare const MORALITY: readonly ["hero", "vigilante", "villain", "rogue", "resistance", "loyalist"];
 declare const MORALITY_EXTENDED: readonly ["hero", "vigilante", "villain", "rogue", "resistance", "loyalist", "primal", "praetorian", "heroic", "villainous", "paragon-city-access", "rogue-isles-access", "all"];
 type Morality = typeof MORALITY[number];
 type MoralityExtended = typeof MORALITY_EXTENDED[number];
+/**
+ * Maps a morality to the underlying alignment
+ */
+declare const MoralityMap: Record<Morality | Alignment, Alignment>;
 
 /**
  * The id, or a pair of ids [primal, praetorian] that are used with the /settitle command to set a badge
@@ -155,9 +159,9 @@ interface BadgeData {
     /**
      * The name of this badge.
      *
-     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     * If the value differs by sex or alignment, include an {@link VariantData} for each variant.
      */
-    readonly name: string | AlternateData<string>[];
+    readonly name: string | VariantData<string>[];
     /**
      * The date that the badge was added to the game.
      */
@@ -169,7 +173,7 @@ interface BadgeData {
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
-    readonly badgeText?: AlternateData<MarkdownString>[] | MarkdownString;
+    readonly badgeText?: VariantData<MarkdownString>[] | MarkdownString;
     /**
      * Short description of how to acquire the badge. Detailed instructions should go in the notes field.
      */
@@ -177,9 +181,9 @@ interface BadgeData {
     /**
      * List of absolute URLs for this badge's icons.
      *
-     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     * If the value differs by sex or alignment, include an {@link VariantData} for each variant.
      */
-    readonly icon?: string | AlternateData<string>[];
+    readonly icon?: string | VariantData<string>[];
     /**
      * Freeform notes or tips about the badge.
      */
@@ -425,6 +429,14 @@ interface BundleData {
     readonly badges?: BadgeData[];
 }
 
+/**
+ * For badges, aspects like the name, icon, or badge text can vary depending on context, such as the alignment or sex of the character.
+ */
+interface VariantContext {
+    readonly morality?: Morality | Alignment;
+    readonly sex?: Sex;
+}
+
 declare class AlignmentList {
     #private;
     readonly hero: boolean;
@@ -437,29 +449,6 @@ declare class AlignmentList {
     has(alignment?: AlignmentExtended): boolean;
 }
 
-declare class Alternates<T> {
-    #private;
-    /**
-     * Create an alternate set from either a list of categorized values, or a single value when there are no alternates.
-     * @param value List of alternates, or a single value.
-     */
-    constructor(value: AlternateData<T>[] | T);
-    getValue(alignment?: Alignment, sex?: Sex): T | undefined;
-    /**
-     * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
-     */
-    get default(): AlternateData<T> | undefined;
-    /**
-     * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
-     */
-    get canonical(): AlternateData<T>[];
-    /**
-     * Create a joined string from the alternate values in canonical order.
-     * @param separator Separator to use. Default is ' / '
-     */
-    toString(separator: string): string;
-}
-
 declare class Archetype {
     readonly key: string;
     readonly name: string;
@@ -537,6 +526,38 @@ declare class BadgeRequirement {
     constructor(data: BadgeRequirementData);
 }
 
+declare class Variants<T> {
+    #private;
+    /**
+     * Create a variant set from either a list of categorized values, or a single value when there are no variants.
+     * @param value List of variants, or a single value.
+     */
+    constructor(value: VariantData<T>[] | T);
+    /**
+     * Get a variant by context
+     * @param context The context
+     */
+    getVariant(context?: VariantContext): VariantData<T> | undefined;
+    /**
+     * Get a value by variant context
+     * @param context The context
+     */
+    getValue(context?: VariantContext): T | undefined;
+    /**
+     * Get the default value for this list of variants, the value with the highest priority and lowest specificity.
+     */
+    get default(): VariantData<T> | undefined;
+    /**
+     * Get the list of variants sorted in canonical order (alignment then sex, low to high specificity).
+     */
+    get canonical(): VariantData<T>[];
+    /**
+     * Create a joined string from the variant values in canonical order.
+     * @param separator Separator to use. Default is ' / '
+     */
+    toString(separator: string): string;
+}
+
 declare class MoralityList {
     #private;
     readonly hero: boolean;
@@ -578,7 +599,7 @@ declare class Badge {
      *
      * May vary by character sex or alignment.
      */
-    readonly name: Alternates<string>;
+    readonly name: Variants<string>;
     /**
      * The date that the badge was added to the game.
      */
@@ -590,7 +611,7 @@ declare class Badge {
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
-    readonly badgeText: Alternates<MarkdownString>;
+    readonly badgeText: Variants<MarkdownString>;
     /**
      * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
      */
@@ -600,7 +621,7 @@ declare class Badge {
      *
      * May vary by character sex or alignment.
      */
-    readonly icon: Alternates<string>;
+    readonly icon: Variants<string>;
     /**
      * Freeform notes or tips about the badge.
      */
@@ -637,7 +658,7 @@ declare class Badge {
      */
     get zoneKey(): string | undefined;
 }
-declare function compareByDefaultName(a?: Badge, b?: Badge): number;
+declare function compareByName(a?: Badge, b?: Badge, context?: VariantContext): number;
 declare function compareByZoneKey(a?: Badge, b?: Badge): number;
 declare function compareByReleaseDate(a?: Badge, b?: Badge): number;
 
@@ -662,6 +683,10 @@ interface BadgeSearchOptions {
         morality?: Morality;
         predicate?: (badge: Badge) => boolean;
     };
+    /**
+     * Adjust search results based on a given variant context (morality or sex of a character).
+     */
+    variantContext?: VariantContext;
     /**
      * Sort results.
      *
@@ -1032,5 +1057,5 @@ declare function zoneUri(target: string | Zone | ZoneData): string;
  */
 declare function zoneLink(target: string | Zone | ZoneData): string;
 
-export { ALIGNMENT, AlignmentList, Alternates, Archetype, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, BadgeIndex, BadgeRequirement, BundleHeader, CohContentDatabase, Contact, ENHANCEMENT_CATEGORY, Key, LevelRange, Location, MISSION_TYPE, MORALITY, MORALITY_EXTENDED, Mission, MoralityList, SEX, SetTitleIds, ZONE_TYPE, Zone, badgeLink, badgeUri, compareAlignment, compareByDefaultName, compareByReleaseDate, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
-export type { Alignment, AlignmentExtended, AlternateData, ArchetypeData, BadgeData, BadgeQueryableField, BadgeRequirementData, BadgeRequirementType, BadgeSearchOptions, BadgeSort, BadgeType, BundleData, BundleHeaderData, ContactData, Coords, EnhancementCategory, LevelRangeData, Link, LocationData, LocationIcon, MarkdownString, MissionData, MissionFlashbackData, MissionType, Morality, MoralityExtended, Paged, SetTitleData, Sex, ZoneData, ZoneType };
+export { ALIGNMENT, AlignmentList, Archetype, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, BadgeIndex, BadgeRequirement, BundleHeader, CohContentDatabase, Contact, ENHANCEMENT_CATEGORY, Key, LevelRange, Location, MISSION_TYPE, MORALITY, MORALITY_EXTENDED, Mission, MoralityList, MoralityMap, SEX, SetTitleIds, Variants, ZONE_TYPE, Zone, badgeLink, badgeUri, compareAlignment, compareByName, compareByReleaseDate, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
+export type { Alignment, AlignmentExtended, ArchetypeData, BadgeData, BadgeQueryableField, BadgeRequirementData, BadgeRequirementType, BadgeSearchOptions, BadgeSort, BadgeType, BundleData, BundleHeaderData, ContactData, Coords, EnhancementCategory, LevelRangeData, Link, LocationData, LocationIcon, MarkdownString, MissionData, MissionFlashbackData, MissionType, Morality, MoralityExtended, Paged, SetTitleData, Sex, VariantContext, VariantData, ZoneData, ZoneType };

package/dist/coh-content-db.js

@@ -120,6 +120,15 @@ const MORALITY_EXTENDED = [
    */
   "all"
 ];
+const MoralityMap = {
+  hero: "hero",
+  vigilante: "hero",
+  villain: "villain",
+  rogue: "villain",
+  loyalist: "praetorian",
+  resistance: "praetorian",
+  praetorian: "praetorian"
+};
 
 const SEX = ["M", "F"];
 const SEX_ORDER = Object.fromEntries(SEX.map((x, index) => [x, index]));
@@ -254,81 +263,17 @@ var __privateGet$4 = (obj, member, getter) => (__accessCheck$5(obj, member, "rea
 var __privateAdd$5 = (obj, member, value) => member.has(obj) ? __typeError$5("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 var __privateSet$4 = (obj, member, value, setter) => (__accessCheck$5(obj, member, "write to private field"), member.set(obj, value), value);
 var __privateMethod$2 = (obj, member, method) => (__accessCheck$5(obj, member, "access private method"), method);
-var _sortedValues, _Alternates_instances, compareAlternates_fn;
-class Alternates {
-  /**
-   * 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) {
-    __privateAdd$5(this, _Alternates_instances);
-    __privateAdd$5(this, _sortedValues, []);
-    if (Array.isArray(value)) {
-      __privateSet$4(this, _sortedValues, value.toSorted());
-      __privateGet$4(this, _sortedValues).sort((a, b) => __privateMethod$2(this, _Alternates_instances, compareAlternates_fn).call(this, a, b));
-    } else {
-      __privateSet$4(this, _sortedValues, [{ value }]);
-    }
-  }
-  getValue(alignment, sex) {
-    for (let index = __privateGet$4(this, _sortedValues).length; index--; ) {
-      const entry = __privateGet$4(this, _sortedValues)[index];
-      if ((entry.alignment === void 0 || entry.alignment === alignment) && (entry.sex === void 0 || entry.sex === sex)) return entry.value;
-    }
-    return this.default?.value;
-  }
-  /**
-   * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
-   */
-  get default() {
-    return __privateGet$4(this, _sortedValues)[0];
-  }
-  /**
-   * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
-   */
-  get canonical() {
-    return __privateGet$4(this, _sortedValues);
-  }
-  /**
-   * Create a joined string from the alternate values in canonical order.
-   * @param separator Separator to use. Default is ' / '
-   */
-  toString(separator) {
-    return this.canonical.map((x) => x.value).join(separator);
-  }
-}
-_sortedValues = new WeakMap();
-_Alternates_instances = new WeakSet();
-compareAlternates_fn = function(a, b) {
-  const aSpecificity = (a.alignment ? 2 : 0) + (a.sex ? 1 : 0);
-  const bSpecificity = (b.alignment ? 2 : 0) + (b.sex ? 1 : 0);
-  if (aSpecificity !== bSpecificity) return aSpecificity - bSpecificity;
-  const alignmentComparison = compareAlignment(a.alignment, b.alignment);
-  if (alignmentComparison !== 0) return alignmentComparison;
-  const sexComparison = compareSex(a.sex, b.sex);
-  if (sexComparison !== 0) return sexComparison;
-  return String(a.value).localeCompare(String(b.value));
-};
-
-var __typeError$4 = (msg) => {
-  throw TypeError(msg);
-};
-var __accessCheck$4 = (obj, member, msg) => member.has(obj) || __typeError$4("Cannot " + msg);
-var __privateGet$3 = (obj, member, getter) => (__accessCheck$4(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
-var __privateAdd$4 = (obj, member, value) => member.has(obj) ? __typeError$4("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-var __privateSet$3 = (obj, member, value, setter) => (__accessCheck$4(obj, member, "write to private field"), member.set(obj, value), value);
-var __privateMethod$1 = (obj, member, method) => (__accessCheck$4(obj, member, "access private method"), method);
 var _value, _Key_instances, validateKey_fn;
 const INVALID_KEY_PATTERN = /[^a-z0-9-]/;
 class Key {
   constructor(value) {
-    __privateAdd$4(this, _Key_instances);
-    __privateAdd$4(this, _value);
-    __privateMethod$1(this, _Key_instances, validateKey_fn).call(this, value);
-    __privateSet$3(this, _value, value);
+    __privateAdd$5(this, _Key_instances);
+    __privateAdd$5(this, _value);
+    __privateMethod$2(this, _Key_instances, validateKey_fn).call(this, value);
+    __privateSet$4(this, _value, value);
   }
   get value() {
-    return __privateGet$3(this, _value);
+    return __privateGet$4(this, _value);
   }
 }
 _value = new WeakMap();
@@ -421,6 +366,83 @@ class BadgeRequirement {
   }
 }
 
+var __typeError$4 = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck$4 = (obj, member, msg) => member.has(obj) || __typeError$4("Cannot " + msg);
+var __privateGet$3 = (obj, member, getter) => (__accessCheck$4(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd$4 = (obj, member, value) => member.has(obj) ? __typeError$4("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet$3 = (obj, member, value, setter) => (__accessCheck$4(obj, member, "write to private field"), member.set(obj, value), value);
+var __privateMethod$1 = (obj, member, method) => (__accessCheck$4(obj, member, "access private method"), method);
+var _sortedValues, _Variants_instances, compareVariants_fn;
+class Variants {
+  /**
+   * Create a variant set from either a list of categorized values, or a single value when there are no variants.
+   * @param value List of variants, or a single value.
+   */
+  constructor(value) {
+    __privateAdd$4(this, _Variants_instances);
+    __privateAdd$4(this, _sortedValues, []);
+    if (Array.isArray(value)) {
+      __privateSet$3(this, _sortedValues, value.toSorted());
+      __privateGet$3(this, _sortedValues).sort((a, b) => __privateMethod$1(this, _Variants_instances, compareVariants_fn).call(this, a, b));
+    } else {
+      __privateSet$3(this, _sortedValues, [{ value }]);
+    }
+  }
+  /**
+   * Get a variant by context
+   * @param context The context
+   */
+  getVariant(context) {
+    const alignment = context?.morality ? MoralityMap[context.morality] : void 0;
+    const sex = context?.sex;
+    for (let index = __privateGet$3(this, _sortedValues).length; index--; ) {
+      const entry = __privateGet$3(this, _sortedValues)[index];
+      if ((entry.alignment === void 0 || entry.alignment === alignment) && (entry.sex === void 0 || entry.sex === sex)) return entry;
+    }
+    return this.default;
+  }
+  /**
+   * Get a value by variant context
+   * @param context The context
+   */
+  getValue(context) {
+    return this.getVariant(context)?.value;
+  }
+  /**
+   * Get the default value for this list of variants, the value with the highest priority and lowest specificity.
+   */
+  get default() {
+    return __privateGet$3(this, _sortedValues)[0];
+  }
+  /**
+   * Get the list of variants sorted in canonical order (alignment then sex, low to high specificity).
+   */
+  get canonical() {
+    return __privateGet$3(this, _sortedValues);
+  }
+  /**
+   * Create a joined string from the variant values in canonical order.
+   * @param separator Separator to use. Default is ' / '
+   */
+  toString(separator) {
+    return this.canonical.map((x) => x.value).join(separator);
+  }
+}
+_sortedValues = new WeakMap();
+_Variants_instances = new WeakSet();
+compareVariants_fn = function(a, b) {
+  const aSpecificity = (a.alignment ? 2 : 0) + (a.sex ? 1 : 0);
+  const bSpecificity = (b.alignment ? 2 : 0) + (b.sex ? 1 : 0);
+  if (aSpecificity !== bSpecificity) return aSpecificity - bSpecificity;
+  const alignmentComparison = compareAlignment(a.alignment, b.alignment);
+  if (alignmentComparison !== 0) return alignmentComparison;
+  const sexComparison = compareSex(a.sex, b.sex);
+  if (sexComparison !== 0) return sexComparison;
+  return String(a.value).localeCompare(String(b.value));
+};
+
 var __defProp$9 = Object.defineProperty;
 var __typeError$3 = (msg) => {
   throw TypeError(msg);
@@ -649,12 +671,12 @@ class Badge {
     __publicField$6(this, "ignoreInTotals");
     this.key = new Key(badgeData.key).value;
     this.type = badgeData.type;
-    this.name = new Alternates(badgeData.name);
+    this.name = new Variants(badgeData.name);
     this.releaseDate = toDate(badgeData.releaseDate);
     this.morality = new MoralityList(coalesceToArray(badgeData.morality));
-    this.badgeText = new Alternates(badgeData.badgeText ?? []);
+    this.badgeText = new Variants(badgeData.badgeText ?? []);
     this.acquisition = badgeData.acquisition;
-    this.icon = new Alternates(badgeData.icon ?? []);
+    this.icon = new Variants(badgeData.icon ?? []);
     this.notes = badgeData.notes;
     this.links = badgeData.links ?? [];
     this.effect = badgeData.effect;
@@ -691,9 +713,9 @@ class Badge {
 }
 _requirementsIndex = new WeakMap();
 _zoneKeys = new WeakMap();
-function compareByDefaultName(a, b) {
-  const aName = a?.name.default?.value;
-  const bName = b?.name.default?.value;
+function compareByName(a, b, context) {
+  const aName = a?.name?.getValue(context);
+  const bName = b?.name?.getValue(context);
   if (!aName && !bName) return 0;
   if (!aName) return 1;
   if (!bName) return -1;
@@ -730,7 +752,7 @@ class BadgeIndex extends AbstractIndex {
   }
   search(options) {
     const filtered = options?.query || options?.filter ? this._values.filter((badge) => __privateMethod(this, _BadgeIndex_instances, satisfiesQueryPredicate_fn).call(this, badge, options?.query) && __privateMethod(this, _BadgeIndex_instances, satisfiesFilterPredicate_fn).call(this, badge, options?.filter)) : this._values;
-    const sorted = __privateMethod(this, _BadgeIndex_instances, sort_fn).call(this, filtered, options?.sort);
+    const sorted = __privateMethod(this, _BadgeIndex_instances, sort_fn).call(this, filtered, options);
     const totalPages = options?.pageSize ? Math.ceil(filtered.length / options?.pageSize) : 1;
     const page = Math.max(1, Math.min(totalPages, options?.page ?? 1));
     const paged = options?.pageSize ? sorted.slice((page - 1) * options.pageSize, page * options?.pageSize) : sorted;
@@ -753,13 +775,13 @@ satisfiesQueryPredicate_fn = function(badge, query) {
 satisfiesFilterPredicate_fn = function(badge, filter) {
   return (!filter?.type || badge.type === filter.type) && (!filter?.zoneKey || badge.zoneKey === filter.zoneKey) && (!filter?.morality || badge.morality.has(filter.morality)) && (!filter?.predicate || filter.predicate(badge));
 };
-sort_fn = function(badges, sort) {
-  switch (sort) {
+sort_fn = function(badges, options) {
+  switch (options?.sort) {
     case "name.asc": {
-      return badges.toSorted(compareByDefaultName);
+      return badges.toSorted((a, b) => compareByName(a, b, options.variantContext));
     }
     case "name.desc": {
-      return badges.toSorted((a, b) => compareByDefaultName(b, a));
+      return badges.toSorted((a, b) => compareByName(b, a, options.variantContext));
     }
     case "zone-key.asc": {
       return badges.toSorted(compareByZoneKey);
@@ -1193,7 +1215,6 @@ function zoneLink(target) {
 
 exports.ALIGNMENT = ALIGNMENT;
 exports.AlignmentList = AlignmentList;
-exports.Alternates = Alternates;
 exports.Archetype = Archetype;
 exports.BADGE_REQUIREMENT_TYPE = BADGE_REQUIREMENT_TYPE;
 exports.BADGE_TYPE = BADGE_TYPE;
@@ -1212,14 +1233,16 @@ exports.MORALITY = MORALITY;
 exports.MORALITY_EXTENDED = MORALITY_EXTENDED;
 exports.Mission = Mission;
 exports.MoralityList = MoralityList;
+exports.MoralityMap = MoralityMap;
 exports.SEX = SEX;
 exports.SetTitleIds = SetTitleIds;
+exports.Variants = Variants;
 exports.ZONE_TYPE = ZONE_TYPE;
 exports.Zone = Zone;
 exports.badgeLink = badgeLink;
 exports.badgeUri = badgeUri;
 exports.compareAlignment = compareAlignment;
-exports.compareByDefaultName = compareByDefaultName;
+exports.compareByName = compareByName;
 exports.compareByReleaseDate = compareByReleaseDate;
 exports.compareByZoneKey = compareByZoneKey;
 exports.compareSex = compareSex;