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

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

@@ -0,0 +1,47 @@
+import { BadgeType } from '../api/badge-type'
+import { MoralityExtended } from '../api/morality'
+
+export type BadgeQueryableField = 'name' | 'badge-text' | 'acquisition' | 'notes' | 'effect' | 'set-title-id'
+export type BadgeSortableField = 'canonical' | 'badge-name' | 'zone-key'
+
+export interface BadgeSearchOptions {
+
+  /**
+   * Text-based search.
+   *
+   * Case-insensitive. Defaults to searching on name only.
+   */
+  query?: {
+    str?: string
+    fields?: BadgeQueryableField[]
+  }
+
+  /**
+   * 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?: BadgeSortableField
+    dir?: 'asc' | 'desc'
+  }
+
+  /**
+   * The page (1-based)
+   */
+  page?: number
+
+  /**
+   * How many results per page
+   */
+  pageSize?: number
+}

package/src/main/db/badge.ts

@@ -1,13 +1,17 @@
 import { BadgeType } from '../api/badge-type'
-import { Alignment } from '../api/alignment'
 import { Link } from '../api/link'
 import { BadgeData } from '../api/badge-data'
-import { BadgePartial } from './badge-partial'
+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'
+import { AbstractIndex } from './abstract-index'
 
 export class Badge {
-  readonly #partialsIndex: Record<string, BadgePartial> = {}
+  readonly #requirementsIndex: AbstractIndex<BadgeRequirement>
+  readonly #zoneKeys = new Set<string>()
 
   /**
    * The database key for this badge.
@@ -17,7 +21,7 @@ export class Badge {
   /**
    * The type of badge.
    */
-  readonly type: BadgeType | string
+  readonly type: BadgeType
 
   /**
    * The name of this badge.
@@ -27,21 +31,19 @@ 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: Alignment[]
+  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>
 
   /**
-   * Description of how to acquire the badge.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
+   * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
    */
-  readonly acquisition?: string
+  readonly acquisition?: MarkdownString
 
   /**
    * Absolute URL to this badge's icon.
@@ -52,90 +54,93 @@ export class Badge {
 
   /**
    * Freeform notes or tips about the badge.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
    */
-  readonly notes?: string
+  readonly notes?: MarkdownString
 
   /**
-   * List of external links for this Badge. Wiki, forums, etc.
+   * List of external links. Wiki, forums, etc.
    */
-  readonly links?: Link[]
+  readonly links: Link[]
 
   /**
-   * For exploration badges, the key of the {@link GameMap} 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 mapKey?: string
+  readonly setTitleId?: [number, number?]
 
   /**
-   * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+   * A description of the effect the badge will have, such as a buff or granting a temporary power.
    */
-  readonly loc?: [number, number, number]
+  readonly effect?: MarkdownString
 
   /**
-   * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+   * 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 vidiotMapKey?: string
+  readonly ignoreInTotals: boolean
 
-  /**
-   * 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
+  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.#requirementsIndex = new AbstractIndex<BadgeRequirement>('key', badgeData.requirements?.map(x => new BadgeRequirement(x)))
+
+    for (const requirement of this.#requirementsIndex.values) {
+      if (requirement.location) for (const location of requirement.location) {
+        if (location.zoneKey) this.#zoneKeys.add(location.zoneKey)
+      }
+    }
   }
 
   /**
-   * A description of the effect the badge will have, such as a buff or granting a temporary power.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
+   * Represents the requirements for badges with multiple fulfillment steps, such as visiting monuments for history badges, completing missions, or collecting other badges.
    */
-  readonly effect?: string
+  get requirements(): BadgeRequirement[] {
+    return this.#requirementsIndex.values
+  }
+
+  getRequirement(key: string): BadgeRequirement | undefined {
+    return this.#requirementsIndex.get(key)
+  }
 
   /**
-   * A list of requirements for badges that have partial fulfilment steps, such as visiting plaques for history badges, or collecting other badges for meta-badges like accolades.
+   * Return a list of all the zone keys referenced by this badge.
    */
-  readonly partials?: BadgePartial[]
+  get zoneKeys(): string[] {
+    return [...this.#zoneKeys]
+  }
 
   /**
-   * 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.
+   * The zone key if this badge relates to a single zone.
    */
-  readonly ignoreInTotals: boolean
-
-  constructor(data: BadgeData) {
-    this.key = new Key(data.key).value
-    this.type = data.type
-    this.name = new Alternates(data.name)
-    this.alignment = data.alignment
-    this.badgeText = new Alternates(data.badgeText ?? [])
-    this.acquisition = data.acquisition
-    this.icon = new Alternates(data.icon ?? [])
-    this.notes = data.notes
-    this.links = data.links
-    this.mapKey = data.mapKey
-    this.loc = data.loc
-    this.effect = data.effect
-    this.vidiotMapKey = data.vidiotMapKey
-    this.setTitle = data.setTitle
-    this.ignoreInTotals = data.ignoreInTotals ?? false
-
-    this.partials = data.partials?.map((data) => {
-      if (this.#partialsIndex[data.key] !== undefined) throw new Error(`Duplicate badge partial key [${data.key}]`)
-      const badge = new BadgePartial(data)
-      this.#partialsIndex[badge.key] = badge
-      return badge
-    })
+  get zoneKey(): string | undefined {
+    return this.#zoneKeys.size === 1 ? this.#zoneKeys.values().next().value : undefined
   }
+}
 
-  getPartial(key: string): BadgePartial {
-    const result = this.#partialsIndex[key]
-    if (result === undefined) throw new Error(`Unknown badge partial key [${key}]`)
-    return result
-  }
+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

@@ -1,29 +1,138 @@
-import { ServerGroup } from './server-group'
-import { ServerGroupData } from '../api/server-group-data'
+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 #serverGroups: Record<string, ServerGroup> = {}
+  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)
+  }
 
   /**
-   * Load a server group data package into the database.
-   * @param data The data to load.
+   * List of badges.
    */
-  loadServerGroupData(data: ServerGroupData): void {
-    this.#serverGroups[data.key] = new ServerGroup(data)
+  get badges(): Badge[] {
+    return this.#badgeIndex.values
   }
 
   /**
-   * Get all the server groups currently loaded in the database.
+   * Get badge by key.
+   * @param key The key.
    */
-  listServerGroups(): ServerGroup[] {
-    return Object.values(this.#serverGroups)
+  getBadge(key: string | undefined): Badge | undefined {
+    return this.#badgeIndex.get(key)
   }
 
   /**
-   * get a server group by key.
-   * @param serverGroupKey The 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}
    */
-  getServerGroup(serverGroupKey: string): ServerGroup | null {
-    return this.#serverGroups[serverGroupKey]
+  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/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,
+  }
+}