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

package/src/main/db/badge-requirement.ts

@@ -1,79 +1,62 @@
 import { BadgeRequirementData } from '../api/badge-requirement-data'
-import { PlaqueType } from '../api/plaque-type'
 import { BadgeRequirementType } from '../api/badge-requirement-type'
 import { EnhancementCategory } from '../api/enhancement-category'
 import { Key } from './key'
 import { MarkdownString } from '../api/markdown-string'
 import { Link } from '../api/link'
+import { Location } from './location'
+import { coalesceToArray } from '../util'
 
 export class BadgeRequirement {
   /**
-   * Key.
+   * Unique key used to reference this badge requirement.
+   *
+   * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
    */
   readonly key: string
 
   /**
-   * Type of requirement.
+   * The requirement type.
    */
   readonly type: BadgeRequirementType
 
   /**
-   * Zone the requirement is located in.
+   * If the requirement involves a location, where it is.
    */
-  readonly zoneKey?: string
+  readonly location?: Location[]
 
   /**
-   * /loc coordinates.
-   */
-  readonly loc?: number[]
-
-  /**
-   * 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.
+   * If the requirement involves a badge, the badge key.
    */
   readonly badgeKey?: string
 
   /**
-   * Mission name.
+   * If the requirement involves a mission, the mission key.
    */
-  readonly missionName?: string
+  readonly missionKey?: string
 
   /**
-   * {@link Contact} key for the story arc.
+   * If the requirement involves a monument, the text that is displayed thereon.
    */
-  readonly contactKey?: string
+  readonly monumentText?: string
 
   /**
-   * Level of the invention required.
+   * 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
 
@@ -85,17 +68,13 @@ export class BadgeRequirement {
   constructor(data: BadgeRequirementData) {
     this.key = new Key(data.key).value
     this.type = data.type
-    this.zoneKey = data.zoneKey
-    this.loc = data.loc
-    this.plaqueType = data.plaqueType
-    this.plaqueInscription = data.plaqueInscription
-    this.vidiotMapKey = data.vidiotMapKey
+    this.location = coalesceToArray(data.location)
     this.badgeKey = data.badgeKey
-    this.missionName = data.missionName
-    this.contactKey = data.contactKey
+    this.missionKey = data.missionKey
+    this.monumentText = data.monumentText
     this.inventionLevel = data.inventionLevel
     this.inventionTypes = data.inventionTypes
-    this.inventionCount = data.inventionCount
+    this.count = data.count
     this.notes = data.notes
     this.links = data.links ?? []
   }

package/src/main/db/badge-search-options.ts

@@ -1,5 +1,5 @@
 import { BadgeType } from '../api/badge-type'
-import { Alignment } from '../api/alignment'
+import { MoralityExtended } from '../api/morality'
 
 export interface BadgeSearchOptions {
 
@@ -26,7 +26,7 @@ export interface BadgeSearchOptions {
   filter?: {
     type?: BadgeType
     zoneKey?: string
-    alignment?: Alignment
+    morality?: MoralityExtended
   }
 
   /**
@@ -35,8 +35,8 @@ export 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_NAME'
-    dir?: 'ASC' | 'DESC'
+    by?: 'canonical' | 'badge-name' | 'zone-key'
+    dir?: 'asc' | 'desc'
   }
 
   /**

package/src/main/db/badge.ts

@@ -4,11 +4,13 @@ import { BadgeData } from '../api/badge-data'
 import { BadgeRequirement } from './badge-requirement'
 import { Key } from './key'
 import { Alternates } from './alternates'
-import { Alignments } from './alignments'
 import { MarkdownString } from '../api/markdown-string'
+import { coalesceToArray } from '../util'
+import { MoralityList } from './morality-list'
 
 export class Badge {
   readonly #requirementsIndex: Record<string, BadgeRequirement> = {}
+  readonly #zoneKeys = new Set<string>()
 
   /**
    * The database key for this badge.
@@ -28,14 +30,14 @@ export 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>
 
   /**
    * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
@@ -60,33 +62,10 @@ export class Badge {
   readonly links: Link[]
 
   /**
-   * For exploration badges, the key of the {@link Zone} that this badge is found on.
+   * The id used with the in-game `/settitle` command to apply the badge.
+   * The first value is the id for primal characters and the (optional) second number is the id for praetorian characters.
    */
-  readonly zoneKey?: string
-
-  /**
-   * For exploration badges, the `/loc` coordinates of the badge.
-   */
-  readonly loc?: [number, number, number]
-
-  /**
-   * For plaques that appear on a Vidiot Map, the number or letter the badge appears as.
-   */
-  readonly vidiotMapKey?: string
-
-  /**
-   * ID used with the in-game `/settitle` command to apply the badge.
-   */
-  readonly setTitle?: {
-    /**
-     * `/settitle` id.
-     */
-    id?: number
-    /**
-     * `/settitle` id if different for praetorian characters.
-     */
-    praetorianId?: number
-  }
+  readonly setTitleId?: [number, number?]
 
   /**
    * A description of the effect the badge will have, such as a buff or granting a temporary power.
@@ -94,16 +73,9 @@ export class Badge {
   readonly effect?: MarkdownString
 
   /**
-   * 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.
+   * 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[][]
+  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.
@@ -114,29 +86,24 @@ export class Badge {
     this.key = new Key(badgeData.key).value
     this.type = badgeData.type
     this.name = new Alternates(badgeData.name)
-    this.alignment = new Alignments(badgeData.alignment)
+    this.morality = new MoralityList(coalesceToArray(badgeData.morality))
     this.badgeText = new Alternates(badgeData.badgeText ?? [])
     this.acquisition = badgeData.acquisition
     this.icon = new Alternates(badgeData.icon ?? [])
     this.notes = badgeData.notes
     this.links = badgeData.links ?? []
-    this.zoneKey = badgeData.zoneKey
-    this.loc = badgeData.loc
     this.effect = badgeData.effect
-    this.vidiotMapKey = badgeData.vidiotMapKey
-    this.setTitle = badgeData.setTitle
+    this.setTitleId = badgeData.setTitleId
     this.ignoreInTotals = badgeData.ignoreInTotals ?? false
 
-    this.requirements = badgeData.requirements?.map((groups, index) => {
-      const existingKeysInGroup = new Set<string>()
-      return groups.map((requirementData) => {
-        if (existingKeysInGroup.has(requirementData.key)) throw new Error(`Duplicate badge requirement key [${badgeData.key}:${requirementData.key}] in group [${index + 1}]`)
-        existingKeysInGroup.add(requirementData.key)
-
-        const badge = new BadgeRequirement(requirementData)
-        this.#requirementsIndex[badge.key] = badge
-        return badge
-      })
+    this.requirements = badgeData.requirements?.map((requirementData) => {
+      if (this.#requirementsIndex[requirementData.key]) throw new Error(`Duplicate badge requirement key [${badgeData.key}:${requirementData.key}]`)
+      const requirement = new BadgeRequirement(requirementData)
+      this.#requirementsIndex[requirement.key] = requirement
+      if (requirement.location) for (const location of requirement.location) {
+        if (location.zoneKey) this.#zoneKeys.add(location.zoneKey)
+      }
+      return requirement
     })
   }
 
@@ -145,4 +112,36 @@ export class Badge {
     if (result === undefined) throw new Error(`Unknown badge requirement key [${key}]`)
     return result
   }
+
+  /**
+   * Return a list of all the zone keys referenced by this badge.
+   */
+  get zoneKeys(): string[] {
+    return [...this.#zoneKeys]
+  }
+
+  /**
+   * The zone key if this badge relates to a single zone.
+   */
+  get zoneKey(): string | undefined {
+    return this.#zoneKeys.size === 1 ? this.#zoneKeys.values().next().value : undefined
+  }
+}
+
+export function compareByDefaultName(a?: Badge, b?: Badge): number {
+  const aName = a?.name.default?.value
+  const bName = b?.name.default?.value
+  if (!aName && !bName) return 0
+  if (!aName) return 1
+  if (!bName) return -1
+  return aName.localeCompare(bName)
+}
+
+export function compareByZoneKey(a?: Badge, b?: Badge): number {
+  const aZone = a?.zoneKey
+  const bZone = b?.zoneKey
+  if (!aZone && !bZone) return 0
+  if (!aZone) return 1
+  if (!bZone) return -1
+  return aZone.localeCompare(bZone)
 }

package/src/main/db/bundle-metadata.ts

@@ -22,12 +22,17 @@ export class BundleMetadata {
   /**
    * List of external links. Wiki, forums, etc.
    */
-  readonly links: Link[]
+  readonly links?: Link[]
 
   /**
    * Change log for this data package.
    */
-  readonly changelog: Change[]
+  readonly changelog?: Change[]
+
+  /**
+   * The current version of the data package.
+   */
+  readonly version?: string
 
   constructor(bundle: ContentBundle) {
     this.name = bundle.name
@@ -35,5 +40,6 @@ export class BundleMetadata {
     this.repository = bundle.repository
     this.links = bundle.links ?? []
     this.changelog = bundle.changelog ?? []
+    this.version = this.changelog?.at(-1)?.version
   }
 }

package/src/main/db/coh-content-database.ts

@@ -7,110 +7,123 @@ import { BadgeIndex } from './badge-index'
 import { BadgeSearchOptions } from './badge-search-options'
 import { Paged } from './paged'
 import { Contact } from './contact'
+import { Mission } from './mission'
+import { AbstractIndex } from './abstract-index'
 
 export class CohContentDatabase {
-  readonly #archetypeIndex: Record<string, Archetype> = {}
-  readonly #zoneIndex: Record<string, Zone> = {}
-  readonly #contactIndex: Record<string, Contact> = {}
-  readonly #badgeIndex: BadgeIndex
+  #archetypeIndex = new AbstractIndex<Archetype>('key')
+  #zoneIndex = new AbstractIndex<Zone>('key')
+  #contactIndex = new AbstractIndex<Contact>('key')
+  #missionIndex = new AbstractIndex<Mission>('key')
+  #badgeIndex = new BadgeIndex()
+
+  #metadata?: BundleMetadata
+  #servers?: string[]
+
+  /**
+   * Load the given content bundle, resetting the db if a bundle is already loaded.
+   * @param bundle The bundle to load.
+   */
+  load(bundle: ContentBundle): void {
+    this.#metadata = new BundleMetadata(bundle)
+    this.#servers = bundle.servers ?? []
+
+    this.#archetypeIndex.load(bundle.archetypes?.map(x => new Archetype(x)))
+    this.#zoneIndex.load(bundle.zones?.map(x => new Zone(x)))
+    this.#contactIndex.load(bundle.contacts?.map(x => new Contact(x)))
+    this.#missionIndex.load(bundle.missions?.map(x => new Mission(x)))
+    this.#badgeIndex.load(bundle.badges?.map(x => new Badge(x)))
+  }
 
   /**
    * Metadata about the content bundle.
    */
-  readonly metadata: BundleMetadata
+  get metadata(): BundleMetadata | undefined {
+    return this.#metadata
+  }
 
   /**
    * List of the game server names.
    *
    * Torchbearer, Excelsior, etc.
    */
-  readonly servers: string[]
+  get servers(): string[] {
+    return this.#servers ?? []
+  }
 
   /**
    * List of archetypes.
    */
-  readonly archetypes: Archetype[]
+  get archetypes(): Archetype[] {
+    return this.#archetypeIndex.values
+  }
 
   /**
-   * List of game zones.
+   * Get archetype by key.
+   * @param key The key.
    */
-  readonly zones: Zone[]
+  getArchetype(key: string | undefined): Archetype | undefined {
+    return this.#archetypeIndex.get(key)
+  }
 
   /**
-   * List of contacts.
+   * List of game zones.
    */
-  readonly contacts: Contact[]
+  get zones(): Zone[] {
+    return this.#zoneIndex.values
+  }
 
   /**
-   * List of badges.
+   * Get zone by key.
+   * @param key The key.
    */
-  readonly badges: Badge[]
+  getZone(key: string | undefined): Zone | undefined {
+    return this.#zoneIndex.get(key)
+  }
 
   /**
-   * Initialize the database with a content bundle.
-   * @param bundle The data to load.
+   * List of contacts.
    */
-  constructor(bundle: ContentBundle) {
-    this.metadata = new BundleMetadata(bundle)
-    this.servers = bundle.servers ?? []
-
-    this.archetypes = bundle.archetypes?.map((data) => {
-      if (this.#archetypeIndex[data.key] !== undefined) throw new Error(`Duplicate archetype key '${data.key}'`)
-      const archetype = new Archetype(data)
-      this.#archetypeIndex[archetype.key] = archetype
-      return archetype
-    }) ?? []
-
-    this.zones = bundle.zones?.map((data) => {
-      if (this.#zoneIndex[data.key] !== undefined) throw new Error(`Duplicate zone key '${data.key}'`)
-      const zone = new Zone(data)
-      this.#zoneIndex[zone.key] = zone
-      return zone
-    }) ?? []
-
-    this.contacts = bundle.contacts?.map((data) => {
-      if (this.#contactIndex[data.key] !== undefined) throw new Error(`Duplicate contact key '${data.key}'`)
-      const contact = new Contact(data)
-      this.#contactIndex[contact.key] = contact
-      return contact
-    }) ?? []
-
-    this.badges = bundle.badges?.map(data => new Badge(data)) ?? []
-    this.#badgeIndex = new BadgeIndex(this.badges, this.zones)
+  get contacts(): Contact[] {
+    return this.#contactIndex.values
   }
 
-  getArchetype(key: string): Archetype {
-    const result = this.#archetypeIndex[key]
-    if (result === undefined) throw new Error(`Unknown archetype key '${key}'`)
-    return result
-  }
-
-  getZone(key: string): Zone {
-    const result = this.#zoneIndex[key]
-    if (result === undefined) throw new Error(`Unknown zone key '${key}'`)
-    return result
-  }
-
-  getContact(key: string): Contact {
-    const result = this.#contactIndex[key]
-    if (result === undefined) throw new Error(`Unknown contact key '${key}'`)
-    return result
+  /**
+   * Get contact by key.
+   * @param key The key.
+   */
+  getContact(key: string | undefined): Contact | undefined {
+    return this.#contactIndex.get(key)
   }
 
-  zoneExists(key: string): boolean {
-    return !!this.#zoneIndex[key]
+  /**
+   * List of missions.
+   */
+  get missions(): Mission[] {
+    return this.#missionIndex.values
   }
 
-  contactExists(key: string): boolean {
-    return !!this.#contactIndex[key]
+  /**
+   * Get mission by key.
+   * @param key The key.
+   */
+  getMission(key: string | undefined): Mission | undefined {
+    return this.#missionIndex.get(key)
   }
 
-  getBadge(key: string): Badge {
-    return this.#badgeIndex.getBadge(key)
+  /**
+   * List of badges.
+   */
+  get badges(): Badge[] {
+    return this.#badgeIndex.values
   }
 
-  badgeExists(key: string): boolean {
-    return this.#badgeIndex.badgeExists(key)
+  /**
+   * Get badge by key.
+   * @param key The key.
+   */
+  getBadge(key: string | undefined): Badge | undefined {
+    return this.#badgeIndex.get(key)
   }
 
   /**
@@ -120,6 +133,6 @@ export class CohContentDatabase {
    * @param options {@link BadgeSearchOptions}
    */
   searchBadges(options?: BadgeSearchOptions): Paged<Badge> {
-    return this.#badgeIndex.searchBadges(options)
+    return this.#badgeIndex.search(options)
   }
 }

package/src/main/db/contact.ts

@@ -2,12 +2,15 @@ import { Link } from '../api/link'
 import { Key } from './key'
 import { MarkdownString } from '../api/markdown-string'
 import { ContactData } from '../api/contact-data'
+import { Location } from './location'
+import { MoralityList } from './morality-list'
+import { coalesceToArray } from '../util'
 
 export class Contact {
   /**
    * Unique key used to reference this contact.
    *
-   * 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
 
@@ -22,14 +25,14 @@ export class Contact {
   readonly title?: string
 
   /**
-   * The zone this character is located in.
+   * The character moralities that this contact will interact with.
    */
-  readonly zoneKey?: string
+  readonly morality?: MoralityList
 
   /**
-   * The `/loc` coordinates of the contact.
+   * The location of this contact.
    */
-  readonly loc?: [number, number, number]
+  readonly location?: Location
 
   /**
    * The level range this contact will offer missions for.
@@ -46,14 +49,14 @@ export class Contact {
    */
   readonly links: Link[]
 
-  constructor(contactData: ContactData) {
-    this.key = new Key(contactData.key).value
-    this.name = contactData.name
-    this.title = contactData.title
-    this.zoneKey = contactData.zoneKey
-    this.loc = contactData.loc
-    this.levelRange = contactData.levelRange
-    this.notes = contactData.notes
-    this.links = contactData.links ?? []
+  constructor(data: ContactData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.title = data.title
+    this.morality = new MoralityList(coalesceToArray(data.morality))
+    this.location = data.location
+    this.levelRange = data.levelRange
+    this.notes = data.notes
+    this.links = data.links ?? []
   }
 }

package/src/main/db/location.ts

@@ -0,0 +1,30 @@
+import { Coords, LocationData, LocationIcon } from '../api/location-data'
+
+export class Location {
+  /**
+   * Key of the {@link Zone} that the location references.
+   */
+  readonly zoneKey?: string
+
+  /**
+   * In-game `/loc` coordinates of the location.
+   */
+  readonly coords?: Coords
+
+  /**
+   * The type of icon to use if the location appears on a map. (Typically the Vidiot map icon).
+   */
+  readonly icon?: LocationIcon
+
+  /**
+   * The text that should appear in the location icon. (Typically a number or symbol from the Vidiot map).
+   */
+  readonly iconText?: string
+
+  constructor(data: LocationData) {
+    this.zoneKey = data.zoneKey
+    this.coords = data.coords
+    this.icon = data.icon
+    this.iconText = data.iconText
+  }
+}