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

package/src/main/api/contact-data.ts

@@ -0,0 +1,48 @@
+import { Link } from './link'
+import { MarkdownString } from './markdown-string'
+import { LocationData } from './location-data'
+import { MoralityExtended } from './morality'
+
+export interface ContactData {
+  /**
+   * 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?: MoralityExtended | MoralityExtended[]
+
+  /**
+   * The location of this contact.
+   */
+  readonly location?: LocationData
+
+  /**
+   * 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[]
+}

package/src/main/api/enhancement-category.ts

@@ -0,0 +1,30 @@
+export const ENHANCEMENT_CATEGORY = [
+  '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',
+] as const
+
+export type EnhancementCategory = typeof ENHANCEMENT_CATEGORY[number]

package/src/main/api/link.ts

@@ -0,0 +1,4 @@
+export interface Link {
+  title: string
+  href: string
+}

package/src/main/api/location-data.ts

@@ -0,0 +1,28 @@
+export interface LocationData {
+  /**
+   * 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
+}
+
+/**
+ * Coordinates as they appear using the in-game `/loc` command.
+ */
+export type Coords = [number, number, number]
+
+export type LocationIcon = 'badge' | 'plaque' | 'pedestal' | 'object'

package/src/main/api/markdown-string.ts

@@ -0,0 +1,4 @@
+/**
+ * Tage type to indicate that a string will accept {@link https://www.markdownguide.org/|Markdown} format.
+ */
+export type MarkdownString = string

package/src/main/api/mission-data.ts

@@ -0,0 +1,83 @@
+import { Link } from './link'
+import { MarkdownString } from './markdown-string'
+import { MissionType } from './mission-type'
+import { MoralityExtended } from './morality'
+
+export interface MissionData {
+  /**
+   * 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?: MoralityExtended | MoralityExtended[]
+
+  /**
+   * The keys of any contacts that provide this mission.
+   */
+  readonly contactKeys?: string | 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?: MissionFlashbackData
+}
+
+export interface MissionFlashbackData {
+
+  /**
+   * 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?: MoralityExtended | MoralityExtended[]
+
+  /**
+   * Freeform notes or tips about the Flashback version of the mission.
+   */
+  readonly notes?: MarkdownString
+}

package/src/main/api/mission-type.ts

@@ -0,0 +1,2 @@
+export const MISSION_TYPE = ['story-arc', 'mission', 'task-force', 'strike-force', 'trial', 'personal-story'] as const
+export type MissionType = typeof MISSION_TYPE[number]

package/src/main/api/morality.ts

@@ -0,0 +1,31 @@
+export const MORALITY = ['hero', 'vigilante', 'villain', 'rogue', 'resistance', 'loyalist'] as const
+export type Morality = typeof MORALITY[number]
+export type MoralityExtended = Morality
+  /**
+   * Any of the Primal Earth moralities - Hero, Vigilante, Villain, Rogue.
+   */
+  | 'primal'
+  /**
+   * Either of the Praetorian Earth moralities - Resistance or Loyalist.
+   */
+  | 'praetorian'
+  /**
+   * The moralities that roll up to the Hero {@link Alignment} - Hero and Vigilante.
+   */
+  | 'heroic'
+  /**
+   * The moralities that roll up to the Villain {@link Alignment} - Villain and Rogue.
+   */
+  | 'villainous'
+  /**
+   * Moralities with access to Paragon City - Hero, Vigilante and Rogue.
+   */
+  | 'paragon-city-access'
+  /**
+   * Moralities with access to the Rogue Isles - Villain, Rogue and Vigilante.
+   */
+  | 'rogue-isles-access'
+  /**
+   * All the moralities.
+   */
+  | 'all'

package/src/main/api/sex.ts

@@ -0,0 +1,10 @@
+export const SEX = ['M', 'F'] as const
+export type Sex = typeof SEX[number]
+
+const SEX_ORDER = Object.fromEntries(SEX.map((x, index) => [x, index]))
+
+export function compareSex(a?: Sex, b?: Sex): number {
+  const orderA = a ? SEX_ORDER[a] : -1
+  const orderB = b ? SEX_ORDER[b] : -1
+  return orderA - orderB
+}

package/src/main/api/zone-data.ts

@@ -0,0 +1,20 @@
+import { Link } from './link'
+
+export interface ZoneData {
+  /**
+   * 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[]
+}

package/src/main/db/abstract-index.ts

@@ -0,0 +1,37 @@
+type KeysOfType<T, V> = { [P in keyof T]: T[P] extends V ? P : never }[keyof T]
+
+export class AbstractIndex<T> {
+  protected _values: T[] = []
+  protected _hashTable: Record<string, T> = {}
+
+  /**
+   * Create a new index.
+   * @param keyField The field of the values that will act as the key.
+   * @param values Values to index.
+   */
+  constructor(keyField: KeysOfType<T, string>, values: T[] | undefined) {
+    this._values = values ?? []
+    this._hashTable = {}
+    for (const value of this.values) {
+      const key = value[keyField] as string
+      if (this._hashTable[key] !== undefined) throw new Error(`Duplicate key [${key}]`)
+      this._hashTable[key] = value
+    }
+  }
+
+  /**
+   * Return all indexed values
+   */
+  get values(): T[] {
+    return this._values
+  }
+
+  /**
+   * Get a value from the index
+   * @param key Key string
+   */
+  get(key: string | undefined): T | undefined {
+    if (!key) return undefined
+    return this._hashTable[key]
+  }
+}

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

@@ -0,0 +1,54 @@
+import { ALIGNMENT, Alignment, AlignmentExtended } from '../api/alignment'
+
+export class AlignmentList {
+  readonly #items: Set<Alignment>
+
+  readonly hero: boolean
+  readonly villain: boolean
+  readonly praetorian: boolean
+
+  readonly primal: boolean
+  readonly all: boolean
+
+  constructor(items?: AlignmentExtended[]) {
+    const set = new Set(items ?? [...ALIGNMENT])
+    this.hero = set.has('hero') || set.has('primal') || set.has('all')
+    this.villain = set.has('villain') || set.has('primal') || set.has('all')
+    this.praetorian = set.has('praetorian') || set.has('all')
+
+    this.primal = this.hero && this.villain
+    this.all = this.hero && this.villain && this.praetorian
+
+    this.#items = new Set()
+    if (this.hero) this.#items.add('hero')
+    if (this.villain) this.#items.add('villain')
+    if (this.praetorian) this.#items.add('praetorian')
+  }
+
+  get items(): Alignment[] {
+    return [...this.#items]
+  }
+
+  has(alignment?: AlignmentExtended): boolean {
+    switch (alignment) {
+      case 'hero': {
+        return this.hero
+      }
+      case 'villain': {
+        return this.villain
+      }
+      case 'praetorian': {
+        return this.praetorian
+      }
+      case 'primal' : {
+        return this.primal
+      }
+      case 'all': {
+        return this.all
+      }
+      default: {
+        return false
+      }
+    }
+  }
+}

package/src/main/db/alternates.ts

@@ -0,0 +1,67 @@
+import { AlternateData } from '../api/alternate-data'
+import { compareSex, Sex } from '../api/sex'
+import { Alignment, compareAlignment } from '../api/alignment'
+
+export class Alternates<T> {
+  readonly #sortedValues: AlternateData<T>[] = []
+
+  /**
+   * 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) {
+    if (Array.isArray(value)) {
+      this.#sortedValues = value.sort()
+      this.#sortedValues.sort((a, b) => this.#compareAlternates(a, b))
+    } else {
+      this.#sortedValues = [{ value }]
+    }
+  }
+
+  getValue(alignment?: Alignment, sex?: Sex): T | undefined {
+    for (let index = this.#sortedValues.length; index--;) {
+      const entry = this.#sortedValues[index]
+      if ((entry.alignment === undefined || entry.alignment === alignment)
+        && (entry.sex === undefined || 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(): AlternateData<T> | undefined {
+    return this.#sortedValues[0]
+  }
+
+  /**
+   * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
+   */
+  get canonical(): AlternateData<T>[] {
+    return this.#sortedValues
+  }
+
+  /**
+   * Create a joined string from the alternate values in canonical order.
+   * @param separator Separator to use. Default is ' / '
+   */
+  toString(separator: string): string {
+    return this.canonical.map(x => x.value).join(separator)
+  }
+
+  #compareAlternates(a: AlternateData<T>, b: AlternateData<T>): number {
+    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 // Order first by least-specific
+
+    const alignmentComparison = compareAlignment(a.alignment, b.alignment) // Next by alignment
+    if (alignmentComparison !== 0) return alignmentComparison
+
+    const sexComparison = compareSex(a.sex, b.sex) // Last by sex
+    if (sexComparison !== 0) return sexComparison
+
+    return String(a.value).localeCompare(String(b.value))
+  }
+}

package/src/main/db/archetype.ts

@@ -0,0 +1,14 @@
+import { Key } from './key'
+import { ArchetypeData } from '../api/archetype-data'
+
+export class Archetype {
+  readonly key: string
+  readonly name: string
+  readonly description?: string
+
+  constructor(data: ArchetypeData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.description = data.description
+  }
+}

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

@@ -0,0 +1,57 @@
+import { Badge, compareByDefaultName, compareByZoneKey } from './badge'
+import { BadgeSearchOptions } from './badge-search-options'
+import { Paged } from './paged'
+import { AbstractIndex } from './abstract-index'
+
+export class BadgeIndex extends AbstractIndex<Badge> {
+  constructor(values: Badge[] | undefined) {
+    super('key', values)
+  }
+
+  search(options?: BadgeSearchOptions): Paged<Badge> {
+    const filtered = (options?.query || options?.filter)
+      ? this._values.filter(badge => this.#satisfiesQueryPredicate(badge, options?.query) && this.#satisfiesFilterPredicate(badge, options?.filter))
+      : this._values
+
+    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 ? filtered.slice((page - 1) * options.pageSize, page * options?.pageSize) : filtered
+
+    const sorted = this.#sort(paged, options?.sort)
+
+    return {
+      items: sorted,
+      page: page,
+      pageSize: options?.pageSize,
+      totalItems: filtered.length,
+      totalPages: totalPages,
+    }
+  }
+
+  #satisfiesQueryPredicate(badge: Badge, query?: BadgeSearchOptions['query']): boolean {
+    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)))))
+  }
+
+  #satisfiesFilterPredicate(badge: Badge, filter?: BadgeSearchOptions['filter']): boolean {
+    return (!filter?.type || badge.type === filter.type)
+      && (!filter?.zoneKey || badge.zoneKey === filter.zoneKey)
+      && (!filter?.morality || badge.morality.has(filter.morality))
+  }
+
+  #sort(badges: Badge[], sort?: BadgeSearchOptions['sort']): Badge[] {
+    if (!sort) return badges
+    const ascending = sort.dir !== 'desc'
+
+    if (sort.by === 'badge-name') return badges.sort((a, b) => ascending ? compareByDefaultName(a, b) : compareByDefaultName(b, a))
+
+    if (sort.by === 'zone-key') return badges.sort((a, b) => ascending ? compareByZoneKey(a, b) : compareByZoneKey(b, a))
+
+    return sort.dir === 'desc' ? badges.reverse() : badges
+  }
+}

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

@@ -0,0 +1,81 @@
+import { BadgeRequirementData } from '../api/badge-requirement-data'
+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 {
+  /**
+   * Unique key used to reference this badge requirement.
+   *
+   * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The requirement type.
+   */
+  readonly type: BadgeRequirementType
+
+  /**
+   * If the requirement involves a location, where it is.
+   */
+  readonly location?: Location[]
+
+  /**
+   * If the requirement involves a badge, the badge key.
+   */
+  readonly badgeKey?: string
+
+  /**
+   * If the requirement involves a mission, the mission key.
+   */
+  readonly missionKey?: string
+
+  /**
+   * If the requirement involves a monument, the text that is displayed thereon.
+   */
+  readonly monumentText?: string
+
+  /**
+   * If the requirement involves crafting an invention, the Level of the invention required.
+   */
+  readonly inventionLevel?: number
+
+  /**
+   * If the requirement involves crafting an invention, the types of enhancements that will qualify.
+   */
+  readonly inventionTypes?: EnhancementCategory[]
+
+  /**
+   * Number of times the task needs to be repeated.
+   */
+  readonly count?: number
+
+  /**
+   * Additional information about the requirement.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  constructor(data: BadgeRequirementData) {
+    this.key = new Key(data.key).value
+    this.type = data.type
+    this.location = coalesceToArray(data.location)
+    this.badgeKey = data.badgeKey
+    this.missionKey = data.missionKey
+    this.monumentText = data.monumentText
+    this.inventionLevel = data.inventionLevel
+    this.inventionTypes = data.inventionTypes
+    this.count = data.count
+    this.notes = data.notes
+    this.links = data.links ?? []
+  }
+}

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

@@ -0,0 +1,51 @@
+import { BadgeType } from '../api/badge-type'
+import { MoralityExtended } from '../api/morality'
+
+export interface BadgeSearchOptions {
+
+  /**
+   * Text-based search.
+   *
+   * Case-insensitive. Defaults to searching on name only.
+   */
+  query?: {
+    str?: string
+    on?: {
+      name?: boolean
+      badgeText?: boolean
+      acquisition?: boolean
+      notes?: boolean
+      effect?: boolean
+      setTitle?: boolean
+    }
+  }
+
+  /**
+   * Filter results matching the given values.
+   */
+  filter?: {
+    type?: BadgeType
+    zoneKey?: string
+    morality?: MoralityExtended
+  }
+
+  /**
+   * Sort results.
+   *
+   * 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'
+    dir?: 'asc' | 'desc'
+  }
+
+  /**
+   * The page (1-based)
+   */
+  page?: number
+
+  /**
+   * How many results per page
+   */
+  pageSize?: number
+}