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

package/src/main/db/badge.ts

@@ -0,0 +1,147 @@
+import { BadgeType } from '../api/badge-type'
+import { Link } from '../api/link'
+import { BadgeData } from '../api/badge-data'
+import { BadgeRequirement } from './badge-requirement'
+import { Key } from './key'
+import { Alternates } from './alternates'
+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.
+   */
+  readonly key: string
+
+  /**
+   * The type of badge.
+   */
+  readonly type: BadgeType
+
+  /**
+   * The name of this badge.
+   *
+   * May vary by character sex or alignment.
+   */
+  readonly name: Alternates<string>
+
+  /**
+   * The character moralities that this badge is available to.
+   */
+  readonly morality: MoralityList
+
+  /**
+   * The badge text as it appears in-game. May vary by character sex or alignment.
+   */
+  readonly badgeText: Alternates<MarkdownString>
+
+  /**
+   * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
+   */
+  readonly acquisition?: MarkdownString
+
+  /**
+   * Absolute URL to this badge's icon.
+   *
+   * May vary by character sex or alignment.
+   */
+  readonly icon: Alternates<string>
+
+  /**
+   * Freeform notes or tips about the badge.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  /**
+   * 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 setTitleId?: [number, number?]
+
+  /**
+   * 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) {
+    this.key = new Key(badgeData.key).value
+    this.type = badgeData.type
+    this.name = new Alternates(badgeData.name)
+    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.effect = badgeData.effect
+    this.setTitleId = badgeData.setTitleId
+    this.ignoreInTotals = badgeData.ignoreInTotals ?? false
+
+    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
+    })
+  }
+
+  getRequirement(key: string): BadgeRequirement {
+    const result = this.#requirementsIndex[key]
+    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-header.ts

@@ -0,0 +1,44 @@
+import { Link } from '../api/link'
+import { MarkdownString } from '../api/markdown-string'
+import { BundleHeaderData } from '../api/bundle-header-data'
+
+export class BundleHeader {
+  /**
+   * Name of the content bundle.
+   */
+  readonly name?: string
+
+  /**
+   * Description of the fork.
+   */
+  readonly description?: MarkdownString
+
+  /**
+   * Url for the repository where the bundle is maintained.
+   */
+  readonly repositoryUrl?: string
+
+  /**
+   * Url for the location of the changelog.
+   */
+  readonly changelogUrl?: string
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links?: Link[]
+
+  /**
+   * The current version of the data package.
+   */
+  readonly version?: string
+
+  constructor(data: BundleHeaderData | undefined) {
+    this.name = data?.name
+    this.description = data?.description
+    this.repositoryUrl = data?.repositoryUrl
+    this.changelogUrl = data?.changelogUrl
+    this.links = data?.links ?? []
+    this.version = data?.version
+  }
+}

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

@@ -0,0 +1,138 @@
+import { BundleData } from '../api/bundle-data'
+import { Archetype } from './archetype'
+import { Zone } from './zone'
+import { Badge } from './badge'
+import { BundleHeader } from './bundle-header'
+import { BadgeSearchOptions } from './badge-search-options'
+import { Paged } from './paged'
+import { Contact } from './contact'
+import { Mission } from './mission'
+import { AbstractIndex } from './abstract-index'
+import { BadgeIndex } from './badge-index'
+
+export class CohContentDatabase {
+  readonly #archetypeIndex
+  readonly #zoneIndex
+  readonly #contactIndex
+  readonly #missionIndex
+  readonly #badgeIndex
+
+  readonly #header: BundleHeader
+  readonly #servers: string[]
+
+  /**
+   * Create a db instance from the given content bundle.
+   * @param bundle The bundle to load.
+   */
+  constructor(bundle: BundleData) {
+    this.#header = new BundleHeader(bundle.header)
+    this.#servers = bundle.servers ?? []
+
+    this.#archetypeIndex = new AbstractIndex<Archetype>('key', bundle.archetypes?.map(x => new Archetype(x)))
+    this.#zoneIndex = new AbstractIndex<Zone>('key', bundle.zones?.map(x => new Zone(x)))
+    this.#contactIndex = new AbstractIndex<Contact>('key', bundle.contacts?.map(x => new Contact(x)))
+    this.#missionIndex = new AbstractIndex<Mission>('key', bundle.missions?.map(x => new Mission(x)))
+    this.#badgeIndex = new BadgeIndex(bundle.badges?.map(x => new Badge(x)))
+  }
+
+  /**
+   * Header information about the content bundle.
+   */
+  get header(): BundleHeader {
+    return this.#header
+  }
+
+  /**
+   * List of the game server names.
+   *
+   * Torchbearer, Excelsior, etc.
+   */
+  get servers(): string[] {
+    return this.#servers
+  }
+
+  /**
+   * List of archetypes.
+   */
+  get archetypes(): Archetype[] {
+    return this.#archetypeIndex.values
+  }
+
+  /**
+   * Get archetype by key.
+   * @param key The key.
+   */
+  getArchetype(key: string | undefined): Archetype | undefined {
+    return this.#archetypeIndex.get(key)
+  }
+
+  /**
+   * List of game zones.
+   */
+  get zones(): Zone[] {
+    return this.#zoneIndex.values
+  }
+
+  /**
+   * Get zone by key.
+   * @param key The key.
+   */
+  getZone(key: string | undefined): Zone | undefined {
+    return this.#zoneIndex.get(key)
+  }
+
+  /**
+   * List of contacts.
+   */
+  get contacts(): Contact[] {
+    return this.#contactIndex.values
+  }
+
+  /**
+   * Get contact by key.
+   * @param key The key.
+   */
+  getContact(key: string | undefined): Contact | undefined {
+    return this.#contactIndex.get(key)
+  }
+
+  /**
+   * List of missions.
+   */
+  get missions(): Mission[] {
+    return this.#missionIndex.values
+  }
+
+  /**
+   * Get mission by key.
+   * @param key The key.
+   */
+  getMission(key: string | undefined): Mission | undefined {
+    return this.#missionIndex.get(key)
+  }
+
+  /**
+   * List of badges.
+   */
+  get badges(): Badge[] {
+    return this.#badgeIndex.values
+  }
+
+  /**
+   * Get badge by key.
+   * @param key The key.
+   */
+  getBadge(key: string | undefined): Badge | undefined {
+    return this.#badgeIndex.get(key)
+  }
+
+  /**
+   * 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> {
+    return this.#badgeIndex.search(options)
+  }
+}

package/src/main/db/contact.ts

@@ -0,0 +1,62 @@
+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 must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The name of this contact.
+   */
+  readonly name: string
+
+  /**
+   * The contact's title.
+   */
+  readonly title?: string
+
+  /**
+   * The character moralities that this contact will interact with.
+   */
+  readonly morality?: MoralityList
+
+  /**
+   * The location of this contact.
+   */
+  readonly location?: Location
+
+  /**
+   * The level range this contact will offer missions for.
+   */
+  readonly levelRange?: [number, number?]
+
+  /**
+   * Freeform notes or tips about the contact.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  constructor(data: ContactData) {
+    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/key.ts

@@ -0,0 +1,18 @@
+const INVALID_KEY_PATTERN = /[^a-z0-9-]/
+
+export class Key {
+  readonly #value: string
+
+  constructor(value: string) {
+    this.#validateKey(value)
+    this.#value = value
+  }
+
+  get value(): string {
+    return this.#value
+  }
+
+  #validateKey(key: string): void {
+    if (INVALID_KEY_PATTERN.test(key)) throw new Error(`Invalid key: [${key}]; Keys can only contain lowercase characters, numbers and dashes.`)
+  }
+}

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
+  }
+}

package/src/main/db/mission.ts

@@ -0,0 +1,107 @@
+import { MissionType } from '../api/mission-type'
+import { MarkdownString } from '../api/markdown-string'
+import { Link } from '../api/link'
+import { MissionData } from '../api/mission-data'
+import { Key } from './key'
+import { coalesceToArray } from '../util'
+import { MoralityList } from './morality-list'
+
+export class Mission {
+  /**
+   * Unique key used to reference this mission.
+   *
+   * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The name of the mission as it appears from the contact.
+   *
+   * The name may be different when viewed in Ouroboros as a Flashback.
+   */
+  readonly name: string
+
+  /**
+   * The type of mission... Story arc, task force, trial, etc.
+   */
+  readonly type: MissionType
+
+  /**
+   * The character moralities that may accept the mission.
+   */
+  readonly morality: MoralityList
+
+  /**
+   * The keys of any contacts that provide this mission.
+   */
+  readonly contactKeys?: string[]
+
+  /**
+   * The level range this mission is available for.
+   */
+  readonly levelRange?: [number, number?]
+
+  /**
+   * Freeform notes or tips about the mission.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  /**
+   * If the mission is available in Ouroboros as a Flashback.
+   */
+  readonly flashback?: {
+
+    /**
+     * The id of the mission as seen in the Flashback menu, i.e. '14.01'.
+     */
+    readonly id: string
+
+    /**
+     * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
+     */
+    readonly levelRange?: [number, number?]
+
+    /**
+     * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly name?: string
+
+    /**
+     * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly morality?: MoralityList
+
+    /**
+     * Freeform notes or tips about the Flashback version of the mission.
+     */
+    readonly notes?: MarkdownString
+  }
+
+  constructor(data: MissionData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.type = data.type
+    this.morality = new MoralityList(coalesceToArray(data.morality))
+    this.contactKeys = coalesceToArray(data.contactKeys)
+    this.levelRange = data.levelRange
+    this.notes = data.notes
+    this.links = data.links ?? []
+    this.flashback = createFlashback(data)
+  }
+}
+
+function createFlashback(data: MissionData): Mission['flashback'] {
+  if (!data.flashback) return undefined
+  return {
+    id: data.flashback.id,
+    levelRange: data.flashback.levelRange ?? data.levelRange,
+    name: data.flashback.name ?? data.name,
+    morality: new MoralityList(coalesceToArray(data.flashback.morality ?? data.morality)),
+    notes: data.flashback.notes,
+  }
+}

package/src/main/db/morality-list.ts

@@ -0,0 +1,99 @@
+import { MORALITY, Morality, MoralityExtended } from '../api/morality'
+
+export class MoralityList {
+  readonly #items: Set<Morality>
+
+  readonly hero: boolean
+  readonly vigilante: boolean
+  readonly villain: boolean
+  readonly rogue: boolean
+  readonly resistance: boolean
+  readonly loyalist: boolean
+
+  readonly primal: boolean
+  readonly praetorian: boolean
+  readonly heroic: boolean
+  readonly villainous: boolean
+  readonly paragonCityAccess: boolean
+  readonly rogueIslesAccess: boolean
+
+  readonly all: boolean
+
+  constructor(items?: MoralityExtended[]) {
+    const set = new Set(items ?? [...MORALITY])
+    this.hero = set.has('hero') || set.has('primal') || set.has('heroic') || set.has('paragon-city-access') || set.has('all')
+    this.vigilante = set.has('vigilante') || set.has('primal') || set.has('heroic') || set.has('paragon-city-access') || set.has('rogue-isles-access') || set.has('all')
+    this.villain = set.has('villain') || set.has('primal') || set.has('villainous') || set.has('rogue-isles-access') || set.has('all')
+    this.rogue = set.has('rogue') || set.has('primal') || set.has('villainous') || set.has('paragon-city-access') || set.has('rogue-isles-access') || set.has('all')
+    this.resistance = set.has('resistance') || set.has('praetorian') || set.has('all')
+    this.loyalist = set.has('loyalist') || set.has('praetorian') || set.has('all')
+
+    this.primal = this.hero && this.vigilante && this.villain && this.rogue
+    this.praetorian = this.loyalist && this.resistance
+    this.heroic = this.hero && this.vigilante
+    this.villainous = this.villain && this.rogue
+    this.paragonCityAccess = this.heroic && this.rogue
+    this.rogueIslesAccess = this.villainous && this.vigilante
+
+    this.all = this.primal && this.praetorian
+
+    this.#items = new Set()
+    if (this.hero) this.#items.add('hero')
+    if (this.vigilante) this.#items.add('vigilante')
+    if (this.villain) this.#items.add('villain')
+    if (this.rogue) this.#items.add('rogue')
+    if (this.resistance) this.#items.add('resistance')
+    if (this.loyalist) this.#items.add('loyalist')
+  }
+
+  get items(): Morality[] {
+    return [...this.#items]
+  }
+
+  has(morality?: MoralityExtended): boolean {
+    switch (morality) {
+      case 'hero': {
+        return this.hero
+      }
+      case 'vigilante': {
+        return this.vigilante
+      }
+      case 'villain': {
+        return this.villain
+      }
+      case 'rogue': {
+        return this.rogue
+      }
+      case 'resistance': {
+        return this.resistance
+      }
+      case 'loyalist': {
+        return this.loyalist
+      }
+      case 'primal' : {
+        return this.primal
+      }
+      case 'praetorian': {
+        return this.praetorian
+      }
+      case 'heroic': {
+        return this.hero
+      }
+      case 'paragon-city-access': {
+        return this.paragonCityAccess
+      }
+      case 'rogue-isles-access': {
+        return this.rogueIslesAccess
+      }
+      case 'villainous': {
+        return this.villainous
+      }
+      case 'all': {
+        return this.all
+      }
+      default: {
+        return false
+      }
+    }
+  }
+}

package/src/main/db/paged.ts

@@ -0,0 +1,7 @@
+export interface Paged<T> {
+  items: T[]
+  page: number
+  pageSize?: number
+  totalItems: number
+  totalPages: number
+}

package/src/main/db/zone.ts

@@ -0,0 +1,28 @@
+import { Link } from '../api/link'
+import { ZoneData } from '../api/zone-data'
+import { Key } from './key'
+
+export class Zone {
+  /**
+   * Unique key used to reference this zone.
+   *
+   * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The name of the zone as it appears in-game.
+   */
+  readonly name: string
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  constructor(data: ZoneData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.links = data.links ?? []
+  }
+}