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

package/.github/workflows/build.yml

@@ -1,5 +1,7 @@
 name: Build
-on: push
+on:
+  push:
+    branches: '*'
 jobs:
   build:
     runs-on: ubuntu-latest

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.10] - 2025-04-16
+## [2.0.0-rc.11] - 2025-04-19
 
 ### Added
 
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Database instance is now immutable and bundle data is loaded in the constructor.
 - `GameMap` was renamed to `Zone`.
 - Badge partials are now referred to as badge requirements.
+- `Badge.getRequirement()` now returns undefined instead of throwing an error on unknown key.
 - Exploration badge locations were moved into the badge requirements list.
 - References to zones and badges now use a standard Markdown link format (`badge://`, `map://`).
 - Some field names were updated for consistent pluralization (e.g., `name`, `icon`).

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

@@ -595,16 +595,16 @@ declare class Badge {
      * A description of the effect the badge will have, such as a buff or granting a temporary power.
      */
     readonly effect?: MarkdownString;
-    /**
-     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
-     */
-    readonly requirements?: BadgeRequirement[];
     /**
      * Some badges are not included in the badge total count... such as Flames of Prometheus, which can be removed by redeeming it for a Notice of the Well.
      */
     readonly ignoreInTotals: boolean;
     constructor(badgeData: BadgeData);
-    getRequirement(key: string): BadgeRequirement;
+    /**
+     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
+     */
+    get requirements(): BadgeRequirement[];
+    getRequirement(key: string): BadgeRequirement | undefined;
     /**
      * Return a list of all the zone keys referenced by this badge.
      */
@@ -617,6 +617,8 @@ declare class Badge {
 declare function compareByDefaultName(a?: Badge, b?: Badge): number;
 declare function compareByZoneKey(a?: Badge, b?: Badge): number;
 
+type BadgeQueryableField = 'name' | 'badge-text' | 'acquisition' | 'notes' | 'effect' | 'set-title-id';
+type BadgeSortableField = 'canonical' | 'badge-name' | 'zone-key';
 interface BadgeSearchOptions {
     /**
      * Text-based search.
@@ -625,14 +627,7 @@ interface BadgeSearchOptions {
      */
     query?: {
         str?: string;
-        on?: {
-            name?: boolean;
-            badgeText?: boolean;
-            acquisition?: boolean;
-            notes?: boolean;
-            effect?: boolean;
-            setTitle?: boolean;
-        };
+        fields?: BadgeQueryableField[];
     };
     /**
      * Filter results matching the given values.
@@ -648,7 +643,7 @@ 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' | 'zone-key';
+        by?: BadgeSortableField;
         dir?: 'asc' | 'desc';
     };
     /**
@@ -999,4 +994,4 @@ declare function zoneLink(target: string | Zone | ZoneData): string;
  */
 declare function coalesceToArray<T>(value?: T | T[]): T[] | undefined;
 
-export { ALIGNMENT, type Alignment, type AlignmentExtended, AlignmentList, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, BadgeRequirement, type BadgeRequirementData, type BadgeRequirementType, type BadgeSearchOptions, type BadgeType, type BundleData, BundleHeader, type BundleHeaderData, CohContentDatabase, Contact, type ContactData, type Coords, ENHANCEMENT_CATEGORY, type EnhancementCategory, Key, type Link, Location, type LocationData, type LocationIcon, MISSION_TYPE, MORALITY, type MarkdownString, Mission, type MissionData, type MissionFlashbackData, type MissionType, type Morality, type MoralityExtended, MoralityList, type Paged, SEX, type Sex, Zone, type ZoneData, badgeLink, badgeUri, coalesceToArray, compareAlignment, compareByDefaultName, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
+export { ALIGNMENT, type Alignment, type AlignmentExtended, AlignmentList, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, type BadgeQueryableField, BadgeRequirement, type BadgeRequirementData, type BadgeRequirementType, type BadgeSearchOptions, type BadgeSortableField, 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 };

package/dist/coh-content-db.js

@@ -107,7 +107,7 @@ var __publicField$a = (obj, key, value) => __defNormalProp$a(obj, typeof key !==
 var __accessCheck$6 = (obj, member, msg) => member.has(obj) || __typeError$6("Cannot " + msg);
 var __privateGet$5 = (obj, member, getter) => (__accessCheck$6(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateAdd$6 = (obj, member, value) => member.has(obj) ? __typeError$6("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$6(obj, member, "write to private field"), member.set(obj, value), value);
+var __privateSet$5 = (obj, member, value, setter) => (__accessCheck$6(obj, member, "write to private field"), member.set(obj, value), value);
 var _items$1;
 class AlignmentList {
   constructor(items) {
@@ -123,7 +123,7 @@ class AlignmentList {
     this.praetorian = set.has("praetorian") || set.has("all");
     this.primal = this.hero && this.villain;
     this.all = this.hero && this.villain && this.praetorian;
-    __privateSet$4(this, _items$1, /* @__PURE__ */ new Set());
+    __privateSet$5(this, _items$1, /* @__PURE__ */ new Set());
     if (this.hero) __privateGet$5(this, _items$1).add("hero");
     if (this.villain) __privateGet$5(this, _items$1).add("villain");
     if (this.praetorian) __privateGet$5(this, _items$1).add("praetorian");
@@ -162,7 +162,7 @@ var __typeError$5 = (msg) => {
 var __accessCheck$5 = (obj, member, msg) => member.has(obj) || __typeError$5("Cannot " + msg);
 var __privateGet$4 = (obj, member, getter) => (__accessCheck$5(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 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$3 = (obj, member, value, setter) => (__accessCheck$5(obj, member, "write to private field"), member.set(obj, value), 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 {
@@ -174,10 +174,10 @@ class Alternates {
     __privateAdd$5(this, _Alternates_instances);
     __privateAdd$5(this, _sortedValues, []);
     if (Array.isArray(value)) {
-      __privateSet$3(this, _sortedValues, value.sort());
+      __privateSet$4(this, _sortedValues, value.sort());
       __privateGet$4(this, _sortedValues).sort((a, b) => __privateMethod$2(this, _Alternates_instances, compareAlternates_fn).call(this, a, b));
     } else {
-      __privateSet$3(this, _sortedValues, [{ value }]);
+      __privateSet$4(this, _sortedValues, [{ value }]);
     }
   }
   getValue(alignment, sex) {
@@ -226,7 +226,7 @@ var __typeError$4 = (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$2 = (obj, member, value, setter) => (__accessCheck$4(obj, member, "write to private field"), member.set(obj, value), 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-]/;
@@ -235,7 +235,7 @@ class Key {
     __privateAdd$4(this, _Key_instances);
     __privateAdd$4(this, _value);
     __privateMethod$1(this, _Key_instances, validateKey_fn).call(this, value);
-    __privateSet$2(this, _value, value);
+    __privateSet$3(this, _value, value);
   }
   get value() {
     return __privateGet$3(this, _value);
@@ -372,7 +372,7 @@ var __publicField$7 = (obj, key, value) => __defNormalProp$7(obj, typeof key !==
 var __accessCheck$3 = (obj, member, msg) => member.has(obj) || __typeError$3("Cannot " + msg);
 var __privateGet$2 = (obj, member, getter) => (__accessCheck$3(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateAdd$3 = (obj, member, value) => member.has(obj) ? __typeError$3("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-var __privateSet$1 = (obj, member, value, setter) => (__accessCheck$3(obj, member, "write to private field"), member.set(obj, value), value);
+var __privateSet$2 = (obj, member, value, setter) => (__accessCheck$3(obj, member, "write to private field"), member.set(obj, value), value);
 var _items;
 class MoralityList {
   constructor(items) {
@@ -404,7 +404,7 @@ class MoralityList {
     this.paragonCityAccess = this.heroic && this.rogue;
     this.rogueIslesAccess = this.villainous && this.vigilante;
     this.all = this.primal && this.praetorian;
-    __privateSet$1(this, _items, /* @__PURE__ */ new Set());
+    __privateSet$2(this, _items, /* @__PURE__ */ new Set());
     if (this.hero) __privateGet$2(this, _items).add("hero");
     if (this.vigilante) __privateGet$2(this, _items).add("vigilante");
     if (this.villain) __privateGet$2(this, _items).add("villain");
@@ -465,76 +465,109 @@ class MoralityList {
 _items = new WeakMap();
 
 var __defProp$6 = Object.defineProperty;
+var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$6 = (obj, key, value) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+class AbstractIndex {
+  /**
+   * Create a new index.
+   * @param keyField The field of the values that will act as the key.
+   * @param values Values to index.
+   */
+  constructor(keyField, values) {
+    __publicField$6(this, "_values", []);
+    __publicField$6(this, "_hashTable", {});
+    this._values = values ?? [];
+    this._hashTable = {};
+    for (const value of this.values) {
+      const key = value[keyField];
+      if (this._hashTable[key] !== void 0) throw new Error(`Duplicate key [${key}]`);
+      this._hashTable[key] = value;
+    }
+  }
+  /**
+   * Return all indexed values
+   */
+  get values() {
+    return this._values;
+  }
+  /**
+   * Get a value from the index
+   * @param key Key string
+   */
+  get(key) {
+    if (!key) return void 0;
+    return this._hashTable[key];
+  }
+}
+
+var __defProp$5 = Object.defineProperty;
 var __typeError$2 = (msg) => {
   throw TypeError(msg);
 };
-var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$6 = (obj, key, value) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$5 = (obj, key, value) => __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
 var __accessCheck$2 = (obj, member, msg) => member.has(obj) || __typeError$2("Cannot " + msg);
 var __privateGet$1 = (obj, member, getter) => (__accessCheck$2(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateAdd$2 = (obj, member, value) => member.has(obj) ? __typeError$2("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet$1 = (obj, member, value, setter) => (__accessCheck$2(obj, member, "write to private field"), member.set(obj, value), value);
 var _requirementsIndex, _zoneKeys;
 class Badge {
   constructor(badgeData) {
-    __privateAdd$2(this, _requirementsIndex, {});
+    __privateAdd$2(this, _requirementsIndex);
     __privateAdd$2(this, _zoneKeys, /* @__PURE__ */ new Set());
     /**
      * The database key for this badge.
      */
-    __publicField$6(this, "key");
+    __publicField$5(this, "key");
     /**
      * The type of badge.
      */
-    __publicField$6(this, "type");
+    __publicField$5(this, "type");
     /**
      * The name of this badge.
      *
      * May vary by character sex or alignment.
      */
-    __publicField$6(this, "name");
+    __publicField$5(this, "name");
     /**
      * The character moralities that this badge is available to.
      */
-    __publicField$6(this, "morality");
+    __publicField$5(this, "morality");
     /**
      * The badge text as it appears in-game. May vary by character sex or alignment.
      */
-    __publicField$6(this, "badgeText");
+    __publicField$5(this, "badgeText");
     /**
      * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
      */
-    __publicField$6(this, "acquisition");
+    __publicField$5(this, "acquisition");
     /**
      * Absolute URL to this badge's icon.
      *
      * May vary by character sex or alignment.
      */
-    __publicField$6(this, "icon");
+    __publicField$5(this, "icon");
     /**
      * Freeform notes or tips about the badge.
      */
-    __publicField$6(this, "notes");
+    __publicField$5(this, "notes");
     /**
      * List of external links. Wiki, forums, etc.
      */
-    __publicField$6(this, "links");
+    __publicField$5(this, "links");
     /**
      * 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.
      */
-    __publicField$6(this, "setTitleId");
+    __publicField$5(this, "setTitleId");
     /**
      * A description of the effect the badge will have, such as a buff or granting a temporary power.
      */
-    __publicField$6(this, "effect");
-    /**
-     * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
-     */
-    __publicField$6(this, "requirements");
+    __publicField$5(this, "effect");
     /**
      * 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.
      */
-    __publicField$6(this, "ignoreInTotals");
+    __publicField$5(this, "ignoreInTotals");
     this.key = new Key(badgeData.key).value;
     this.type = badgeData.type;
     this.name = new Alternates(badgeData.name);
@@ -547,20 +580,21 @@ class Badge {
     this.effect = badgeData.effect;
     this.setTitleId = badgeData.setTitleId;
     this.ignoreInTotals = badgeData.ignoreInTotals ?? false;
-    this.requirements = badgeData.requirements?.map((requirementData) => {
-      if (__privateGet$1(this, _requirementsIndex)[requirementData.key]) throw new Error(`Duplicate badge requirement key [${badgeData.key}:${requirementData.key}]`);
-      const requirement = new BadgeRequirement(requirementData);
-      __privateGet$1(this, _requirementsIndex)[requirement.key] = requirement;
+    __privateSet$1(this, _requirementsIndex, new AbstractIndex("key", badgeData.requirements?.map((x) => new BadgeRequirement(x))));
+    for (const requirement of __privateGet$1(this, _requirementsIndex).values) {
       if (requirement.location) for (const location of requirement.location) {
         if (location.zoneKey) __privateGet$1(this, _zoneKeys).add(location.zoneKey);
       }
-      return requirement;
-    });
+    }
+  }
+  /**
+   * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
+   */
+  get requirements() {
+    return __privateGet$1(this, _requirementsIndex).values;
   }
   getRequirement(key) {
-    const result = __privateGet$1(this, _requirementsIndex)[key];
-    if (result === void 0) throw new Error(`Unknown badge requirement key [${key}]`);
-    return result;
+    return __privateGet$1(this, _requirementsIndex).get(key);
   }
   /**
    * Return a list of all the zone keys referenced by this badge.
@@ -594,42 +628,6 @@ function compareByZoneKey(a, b) {
   return aZone.localeCompare(bZone);
 }
 
-var __defProp$5 = Object.defineProperty;
-var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$5 = (obj, key, value) => __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
-class AbstractIndex {
-  /**
-   * Create a new index.
-   * @param keyField The field of the values that will act as the key.
-   * @param values Values to index.
-   */
-  constructor(keyField, values) {
-    __publicField$5(this, "_values", []);
-    __publicField$5(this, "_hashTable", {});
-    this._values = values ?? [];
-    this._hashTable = {};
-    for (const value of this.values) {
-      const key = value[keyField];
-      if (this._hashTable[key] !== void 0) throw new Error(`Duplicate key [${key}]`);
-      this._hashTable[key] = value;
-    }
-  }
-  /**
-   * Return all indexed values
-   */
-  get values() {
-    return this._values;
-  }
-  /**
-   * Get a value from the index
-   * @param key Key string
-   */
-  get(key) {
-    if (!key) return void 0;
-    return this._hashTable[key];
-  }
-}
-
 var __typeError$1 = (msg) => {
   throw TypeError(msg);
 };
@@ -660,7 +658,9 @@ class BadgeIndex extends AbstractIndex {
 _BadgeIndex_instances = new WeakSet();
 satisfiesQueryPredicate_fn = function(badge, query) {
   const queryString = query?.str?.toLowerCase() ?? "";
-  return !!((query?.on?.name ?? true) && badge.name.canonical.some((x) => x.value.toLowerCase().includes(queryString)) || query?.on?.badgeText && badge.badgeText.canonical.some((x) => x.value.toLowerCase().includes(queryString)) || query?.on?.acquisition && badge.acquisition?.toLowerCase().includes(queryString) || query?.on?.effect && badge.effect?.toLowerCase().includes(queryString) || query?.on?.notes && badge.notes?.toLowerCase().includes(queryString) || query?.on?.setTitle && badge.setTitleId?.some((x) => x?.toString().includes(queryString)));
+  const fields = query?.fields ? new Set(query?.fields) : /* @__PURE__ */ new Set(["name"]);
+  if (fields.size === 0) return true;
+  return !!(fields.has("name") && badge.name.canonical.some((x) => x.value.toLowerCase().includes(queryString)) || fields.has("badge-text") && badge.badgeText.canonical.some((x) => x.value.toLowerCase().includes(queryString)) || fields.has("acquisition") && badge.acquisition?.toLowerCase().includes(queryString) || fields.has("effect") && badge.effect?.toLowerCase().includes(queryString) || fields.has("notes") && badge.notes?.toLowerCase().includes(queryString) || fields.has("set-title-id") && badge.setTitleId?.some((x) => x?.toString().includes(queryString)));
 };
 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));