coh-content-db 2.0.0-rc.2 → 2.0.0-rc.21

package/src/main/db/contact.ts

@@ -0,0 +1,63 @@
+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/coalesce-to-array'
+import { LevelRange } from './level-range'
+
+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?: LevelRange
+
+  /**
+   * 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 ? new LevelRange(data.levelRange) : undefined
+    this.notes = data.notes
+    this.links = data.links ?? []
+  }
+}

package/src/main/db/level-range.ts

@@ -0,0 +1,15 @@
+import { LevelRangeData } from '../api/level-range-data'
+
+export class LevelRange {
+  readonly min: number
+  readonly max?: number
+
+  constructor(value: LevelRangeData) {
+    if (Array.isArray(value)) {
+      this.min = value[0]
+      this.max = value[1] === undefined ? undefined : value[1]
+    } else {
+      this.min = value
+    }
+  }
+}

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,108 @@
+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 { MoralityList } from './morality-list'
+import { coalesceToArray } from '../util/coalesce-to-array'
+import { LevelRange } from './level-range'
+
+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?: LevelRange
+
+  /**
+   * 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.
+     */
+    readonly levelRange?: LevelRange
+
+    /**
+     * The name as it appears in the Flashback list.
+     */
+    readonly name: string
+
+    /**
+     * The character moralities that the mission will appear for in the Flashback list.
+     */
+    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 ? new LevelRange(data.levelRange) : undefined
+    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 ? new LevelRange(data.flashback.levelRange) : undefined,
+    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,11 @@
+export interface Paged<T> {
+  items: T[]
+
+  matchedItemCount: number
+  totalItemCount: number
+
+  pageSize?: number
+  pageIndex: number
+  pageNumber: number
+  totalPageCount: number
+}

package/src/main/db/set-title-ids.ts

@@ -0,0 +1,10 @@
+import { SetTitleData } from '../api/set-title-data'
+
+export class SetTitleIds {
+  readonly primal: number
+  readonly praetorian?: number
+
+  constructor(value: SetTitleData) {
+    [this.primal, this.praetorian] = value
+  }
+}

package/src/main/db/variants.ts

@@ -0,0 +1,84 @@
+import { VariantData } from '../api/variant-data'
+import { compareSex } from '../api/sex'
+import { compareAlignment } from '../api/alignment'
+import { VariantContext } from '../api/variant-context'
+import { MoralityMap } from '../api/morality'
+
+export class Variants<T> {
+  readonly #sortedValues: VariantData<T>[] = []
+
+  /**
+   * Create a variant set from either a list of categorized values, or a single value when there are no variants.
+   * @param value List of variants, or a single value.
+   */
+  constructor(value: VariantData<T>[] | T) {
+    if (Array.isArray(value)) {
+      this.#sortedValues = value.toSorted()
+      this.#sortedValues.sort((a, b) => this.#compareVariants(a, b))
+    } else {
+      this.#sortedValues = [{ value }]
+    }
+  }
+
+  /**
+   * Get a variant by context
+   * @param context The context
+   */
+  getVariant(context?: VariantContext): VariantData<T> | undefined {
+    const alignment = context?.morality ? MoralityMap[context.morality] : undefined
+    const sex = context?.sex
+
+    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
+    }
+
+    return this.default
+  }
+
+  /**
+   * Get a value by variant context
+   * @param context The context
+   */
+  getValue(context?: VariantContext): T | undefined {
+    return this.getVariant(context)?.value
+  }
+
+  /**
+   * Get the default value for this list of variants, the value with the highest priority and lowest specificity.
+   */
+  get default(): VariantData<T> | undefined {
+    return this.#sortedValues[0]
+  }
+
+  /**
+   * Get the list of variants sorted in canonical order (alignment then sex, low to high specificity).
+   */
+  get canonical(): VariantData<T>[] {
+    return this.#sortedValues
+  }
+
+  /**
+   * Create a joined string from the variant values in canonical order.
+   * @param separator Separator to use. Default is ' / '
+   */
+  toString(separator: string): string {
+    return this.canonical.map(x => x.value).join(separator)
+  }
+
+  #compareVariants(a: VariantData<T>, b: VariantData<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/zone.ts

@@ -0,0 +1,57 @@
+import { Link } from '../api/link'
+import { ZoneData } from '../api/zone-data'
+import { Key } from './key'
+import { MoralityList } from './morality-list'
+import { coalesceToArray } from '../util/coalesce-to-array'
+import { ZoneType } from '../api/zone-type'
+import { MarkdownString } from '../api/markdown-string'
+import { LevelRange } from './level-range'
+
+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
+
+  /**
+   * The type of zone.
+   */
+  readonly type: ZoneType
+
+  /**
+   * The character moralities that this zone is accessible by.
+   */
+  readonly morality: MoralityList
+
+  /**
+   * The level range this zone is recommended for.
+   */
+  readonly levelRange?: LevelRange
+
+  /**
+   * Freeform notes or tips about the zone.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * 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.type = data.type
+    this.morality = new MoralityList(coalesceToArray(data.morality))
+    this.levelRange = data.levelRange ? new LevelRange(data.levelRange) : undefined
+    this.notes = data.notes
+    this.links = data.links ?? []
+  }
+}

package/src/main/index.ts

@@ -1,33 +1,48 @@
 // API
 export * from './api/alignment'
-export * from './api/alternate-data'
 export * from './api/archetype-data'
 export * from './api/badge-data'
-export * from './api/badge-partial-data'
-export * from './api/badge-partial-type'
+export * from './api/badge-requirement-data'
+export * from './api/badge-requirement-type'
 export * from './api/badge-type'
-export * from './api/change'
+export * from './api/bundle-data'
+export * from './api/bundle-header-data'
+export * from './api/contact-data'
 export * from './api/enhancement-category'
-export * from './api/game-map-data'
 export * from './api/link'
-export * from './api/plaque-type'
-export * from './api/server-group-data'
+export * from './api/location-data'
+export * from './api/level-range-data'
+export * from './api/markdown-string'
+export * from './api/mission-data'
+export * from './api/mission-flashback-data'
+export * from './api/mission-type'
+export * from './api/morality'
+export * from './api/set-title-data'
 export * from './api/sex'
-export * from './api/vidiot-map-data'
-export * from './api/vidiot-map-point-of-interest-data'
+export * from './api/variant-context'
+export * from './api/variant-data'
+export * from './api/zone-data'
+export * from './api/zone-type'
 
 // DB
+export * from './db/alignment-list'
 export * from './db/archetype'
 export * from './db/badge'
-export * from './db/badge-partial'
+export * from './db/badge-index'
+export * from './db/badge-requirement'
+export * from './db/badge-search-options'
+export * from './db/bundle-header'
 export * from './db/coh-content-database'
-export * from './db/game-map'
+export * from './db/contact'
 export * from './db/key'
-export * from './db/server-group'
-export * from './db/vidiot-map'
-export * from './db/vidiot-map-point-of-interest'
+export * from './db/location'
+export * from './db/level-range'
+export * from './db/mission'
+export * from './db/morality-list'
+export * from './db/paged'
+export * from './db/set-title-ids'
+export * from './db/variants'
+export * from './db/zone'
 
-// ROOT
-export { CHANGELOG } from './changelog'
-
-export * from './util'
+// UTILS
+export * from './util/links'

package/src/main/util/coalesce-to-array.ts

@@ -0,0 +1,13 @@
+/**
+ * For fields that accept either an array of values or a single value, coalesces the value to an array.
+ *
+ * Arrays are returned as-is.
+ * Single values are returned as a single-value array.
+ * Undefined values are returned as undefined.
+ *
+ * @param value The value to coalesce.
+ */
+export function coalesceToArray<T>(value?: T | T[]): T[] | undefined {
+  if (!value) return undefined
+  return Array.isArray(value) ? value as T[] : [value]
+}

package/src/main/util/links.ts

@@ -0,0 +1,104 @@
+import { BadgeData } from '../api/badge-data'
+import { Badge } from '../db/badge'
+import { ZoneData } from '../api/zone-data'
+import { Zone } from '../db/zone'
+import { Contact } from '../db/contact'
+import { ContactData } from '../api/contact-data'
+import { Mission } from '../db/mission'
+import { MissionData } from '../api/mission-data'
+
+/**
+ * Returns the URI of the given badge that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `badge://<key>`
+ *
+ * @param target The badge or badge key to target.
+ */
+export function badgeUri(target: string | Badge | BadgeData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `badge://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given badge.
+ *
+ * Link format: `[<key>](badge://<key>)`
+ *
+ * @param target The {@link Badge} or badge key to target.
+ */
+export function badgeLink(target: string | Badge | BadgeData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${badgeUri(target)})`
+}
+
+/**
+ * Returns the URI of the given contact that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `contact://<key>`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+export function contactUri(target: string | Contact | ContactData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `contact://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given contact.
+ *
+ * Link format: `[<key>](contact://<key>)`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+export function contactLink(target: string | Contact | ContactData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${contactUri(target)})`
+}
+
+/**
+ * Returns the URI of the given mission that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `mission://<key>`
+ *
+ * @param target The {@link Mission} or mission key to target.
+ */
+export function missionUri(target: string | Mission | MissionData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `mission://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given mission.
+ *
+ * Link format: `[<key>](mission://<key>)`
+ *
+ * @param target The {@link Mission} or mission key to target.
+ */
+export function missionLink(target: string | Mission | MissionData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${missionUri(target)})`
+}
+
+/**
+ * Returns the URI of the given zone that can be used in {@link MarkdownString} fields.
+ *
+ * URI format: `zone://<key>`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+export function zoneUri(target: string | Zone | ZoneData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `zone://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given zone.
+ *
+ * Link format: `[<key>](zone://<key>)`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+export function zoneLink(target: string | Zone | ZoneData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${zoneUri(target)})`
+}

package/src/main/util/to-date.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts an iso string to a Date object, throwing an error if the iso string is invalid.
+ * @param iso ISO-8601 Date string
+ */
+export function toDate(iso: string): Date {
+  const date = new Date(iso)
+  if (!date || Number.isNaN(date.getTime())) throw new Error(`Invalid date format: [${iso}]`)
+  return date
+}