coh-content-db 2.0.0-rc.5 → 2.0.0-rc.7

package/src/main/api/content-bundle.ts

@@ -1,9 +1,11 @@
 import { ArchetypeData } from './archetype-data'
-import { GameMapData } from './game-map-data'
+import { ZoneData } from './zone-data'
 import { BadgeData } from './badge-data'
 import { Change } from './change'
 import { Link } from './link'
 import { MarkdownString } from './markdown-string'
+import { ContactData } from './contact-data'
+import { MissionData } from './mission-data'
 
 /**
  * A content bundle holds the data that makes up one forked instance of the game since the original sunset, such as Homecoming (https://forums.homecomingservers.com/).
@@ -25,7 +27,7 @@ export interface ContentBundle {
   readonly repository?: string
 
   /**
-   * List of external links for this Badge. Wiki, forums, etc.
+   * List of external links. Wiki, forums, etc.
    */
   readonly links?: Link[]
 
@@ -41,9 +43,19 @@ export interface ContentBundle {
   readonly archetypes?: ArchetypeData[]
 
   /**
-   * List of game maps supported by this fork.
+   * List of zones supported by this fork.
    */
-  readonly maps?: GameMapData[]
+  readonly zones?: ZoneData[]
+
+  /**
+   * List of contacts available in this fork.
+   */
+  readonly contacts?: ContactData[]
+
+  /**
+   * List of missions available in this fork.
+   */
+  readonly missions?: MissionData[]
 
   /**
    * List of badges available on this fork.

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

@@ -1,30 +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',
+  '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/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/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

@@ -1,3 +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/changelog.ts

@@ -7,11 +7,16 @@ export const CHANGELOG: Change[] = [
     description: ''
       + '* Replaced redundant interfaces with their concrete equivalents.\n'
       + `* Server groups are now referred to as 'forks'.\n`
-      + '* Replaced enums with union types.\n'
-      + '* `IServerGroupData` is now `ContentBundle` and each database instance is now designed to accept only a single server group.\n'
+      + '* Replaced enums with union types and changed values to `kebab-case`.\n'
+      + '* `IServerGroupData` is now `ContentBundle` and each database instance is now designed to accept only a single bundle.\n'
+      + '* `GameMap` is now `Zone`.\n'
       + '* Removed the `serverGroup` property from entities to simplify the object tree given that only a single context can exist per db now.\n'
       + '* Added a simple indexing and search function for badge names, text and acquisition info.\n'
-      + '* Map and badge references now follow a standard Markdown link format with a `badge://` or `map://` protocol.\n'
+      + '* Zone and badge references now follow a standard Markdown link format with a `badge://` or `map://` protocol.\n'
+      + '* Badge partials are now known as badge requirements.\n'
+      + '* Removed the `VidiotMap` API as it was never used or fleshed out properly.\n'
+      + '* Added formal support for Missions and Contacts in badge requirements.\n'
+      + '* Move exploration badge locations into badge requirement list.\n'
       + '* Standardized pluralization of some field names (name, icon).\n'
       + '* Combined `settitle` ids into a single tuple field.\n'
       + '* Change from GNU to The Unlicense.\n'

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

@@ -1,16 +1,21 @@
 import { AlternateData } from '../api/alternate-data'
-import { Sex } from '../api/sex'
-import { Alignment } from '../api/alignment'
-
-const ALIGNMENT_SORT: Record<string, number> = { H: 2, V: 1, P: 0 }
-const SEX_SORT: Record<string, number> = { M: 1, F: 0 }
+import { compareSex, Sex } from '../api/sex'
+import { Alignment, compareAlignment } from '../api/alignment'
 
 export class Alternates<T> {
   readonly #sortedValues: AlternateData<T>[] = []
 
-  constructor(values: AlternateData<T>[]) {
-    this.#sortedValues = values.sort()
-    this.#sortedValues.sort((a, b) => this.#compareAlternates(a, b))
+  /**
+   * 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 {
@@ -51,34 +56,12 @@ export class Alternates<T> {
     const bSpecificity = (b.alignment ? 2 : 0) + (b.sex ? 1 : 0)
     if (aSpecificity !== bSpecificity) return aSpecificity - bSpecificity // Order first by least-specific
 
-    const alignmentComparison = this.#compareAlignment(a.alignment, b.alignment) // Next by alignment
+    const alignmentComparison = compareAlignment(a.alignment, b.alignment) // Next by alignment
     if (alignmentComparison !== 0) return alignmentComparison
 
-    const sexComparison = this.#compareSex(a.sex, b.sex) // Last by sex
+    const sexComparison = compareSex(a.sex, b.sex) // Last by sex
     if (sexComparison !== 0) return sexComparison
 
     return String(a.value).localeCompare(String(b.value))
   }
-
-  #compareAlignment(a?: Alignment, b?: Alignment): number {
-    if (a === b) return 0
-    if (a === undefined && b !== undefined) return -1
-    if (b === undefined && a !== undefined) return 1
-
-    const aSort = a === undefined ? -1 : ALIGNMENT_SORT[a] ?? -1 // Unknown values get -1 priority
-    const bSort = b === undefined ? -1 : ALIGNMENT_SORT[b] ?? -1
-
-    return bSort - aSort
-  }
-
-  #compareSex(a?: Sex, b?: Sex): number {
-    if (a === b) return 0
-    if (a === undefined && b !== undefined) return -1
-    if (b === undefined && a !== undefined) return 1
-
-    const aSort = SEX_SORT[a ?? -1] ?? -1 // Unknown values get -1 priority
-    const bSort = SEX_SORT[b ?? -1] ?? -1
-
-    return bSort - aSort
-  }
 }

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

@@ -1,21 +1,12 @@
-import { Badge } from './badge'
+import { Badge, compareByDefaultName, compareByZoneKey } from './badge'
 import { BadgeSearchOptions } from './badge-search-options'
-import { GameMap } from './game-map'
 import { Paged } from './paged'
 
 export class BadgeIndex {
   readonly #badges: Badge[] = []
   readonly #badgeIndex: Record<string, Badge> = {}
 
-  readonly #mapOrder: Record<string, number> = {}
-
-  constructor(badges: Badge[], maps?: GameMap[]) {
-    this.#mapOrder = Object.fromEntries(
-      maps
-        ?.sort((a, b) => a.name.localeCompare(b.name))
-        ?.map((x, index) => [x.key, index]) ?? [],
-    )
-
+  constructor(badges: Badge[]) {
     this.#badges = badges
     for (const badge of badges) {
       if (this.#badgeIndex[badge.key] !== undefined) throw new Error(`Duplicate badge key [${badge.key}]`)
@@ -23,10 +14,9 @@ export class BadgeIndex {
     }
   }
 
-  getBadge(key: string): Badge {
-    const result = this.#badgeIndex[key]
-    if (result === undefined) throw new Error(`Unknown badge key [${key}]`)
-    return result
+  getBadge(key?: string): Badge | undefined {
+    if (!key) return undefined
+    return this.#badgeIndex[key]
   }
 
   searchBadges(options?: BadgeSearchOptions): Paged<Badge> {
@@ -34,16 +24,18 @@ export class BadgeIndex {
       ? this.#badges.filter(badge => this.#satisfiesQueryPredicate(badge, options?.query) && this.#satisfiesFilterPredicate(badge, options?.filter))
       : this.#badges
 
-    const paged = options?.pageSize ? filtered.slice(((options?.page ?? 1) - 1) * options.pageSize, (options?.page ?? 1) * options?.pageSize) : filtered
+    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: options?.page ?? 1,
+      page: page,
       pageSize: options?.pageSize,
       totalItems: filtered.length,
-      totalPages: options?.pageSize ? Math.ceil(filtered.length / (options?.pageSize)) : 1,
+      totalPages: totalPages,
     }
   }
 
@@ -54,34 +46,23 @@ export class BadgeIndex {
       || (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.setTitle?.id?.toString().includes(queryString) || badge.setTitle?.praetorianId?.toString().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?.mapKey || badge.mapKey === filter.mapKey)
-      && (!filter?.alignment || badge.alignment.items.includes(filter.alignment))
+      && (!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 || sort.by === 'CANONICAL') return sort.dir === 'DESC' ? badges.reverse() : badges
-
-    if (sort.by === 'BADGE_NAME') return ascending
-      ? badges.sort((a, b) => a.name.default?.value.localeCompare(b.name.default?.value ?? '') ?? 0)
-      : badges.sort((a, b) => b.name.default?.value.localeCompare(a.name.default?.value ?? '') ?? 0)
+    const ascending = sort.dir !== 'desc'
 
-    return badges.sort((a, b) => {
-      const aIndex = this.#mapOrder[a.mapKey ?? '']
-      const bIndex = this.#mapOrder[b.mapKey ?? '']
+    if (sort.by === 'badge-name') return badges.sort((a, b) => ascending ? compareByDefaultName(a, b) : compareByDefaultName(b, a))
 
-      if (aIndex === bIndex) return 0
-      if (aIndex === undefined) return ascending ? 1 : -1
-      if (bIndex === undefined) return ascending ? -1 : 1
+    if (sort.by === 'zone-key') return badges.sort((a, b) => ascending ? compareByZoneKey(a, b) : compareByZoneKey(b, a))
 
-      return ascending ? aIndex - bIndex : bIndex - aIndex
-    })
+    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

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