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

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

@@ -0,0 +1,47 @@
+import { ArchetypeData } from './archetype-data'
+import { ZoneData } from './zone-data'
+import { BadgeData } from './badge-data'
+import { ContactData } from './contact-data'
+import { MissionData } from './mission-data'
+import { BundleHeaderData } from './bundle-header-data'
+
+/**
+ * A bundle of game data from a forked instance of the game, such as Homecoming (https://forums.homecomingservers.com/).
+ */
+export interface BundleData {
+  /**
+   * Bundle header.
+   */
+  readonly header: BundleHeaderData
+
+  /**
+   * List of the game server names in this fork.
+   * Torchbearer, Excelsior, etc.
+   */
+  readonly servers?: string[]
+
+  /**
+   * List of archetypes available in this fork.
+   */
+  readonly archetypes?: ArchetypeData[]
+
+  /**
+   * List of zones supported by this fork.
+   */
+  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.
+   */
+  readonly badges?: BadgeData[]
+}

package/src/main/api/bundle-header-data.ts

@@ -0,0 +1,44 @@
+import { Link } from './link'
+import { MarkdownString } from './markdown-string'
+
+/**
+ * Metadata about a content bundle.
+ */
+export interface BundleHeaderData {
+  /**
+   * Name of the fork this bundle contains data for.
+   */
+  readonly name: string
+
+  /**
+   * Version number for this data package.
+   */
+  readonly version: string
+
+  /**
+   * The time this bundle was last updated.
+   *
+   * Must be an ISO-8601 string in UTC.
+   */
+  readonly lastUpdateTime: 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[]
+}

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

@@ -0,0 +1,49 @@
+import { Link } from './link'
+import { MarkdownString } from './markdown-string'
+import { LocationData } from './location-data'
+import { MoralityExtended } from './morality'
+import { LevelRangeData } from './level-range-data'
+
+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?: LevelRangeData
+
+  /**
+   * 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

@@ -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/level-range-data.ts

@@ -0,0 +1,4 @@
+/**
+ * Can be an array of [min, max], just the [min], or a number representing the minimum value
+ */
+export type LevelRangeData = [number, number?] | 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/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,57 @@
+import { Link } from './link'
+import { MarkdownString } from './markdown-string'
+import { MissionType } from './mission-type'
+import { MoralityExtended } from './morality'
+import { LevelRangeData } from './level-range-data'
+import { MissionFlashbackData } from './mission-flashback-data'
+
+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?: LevelRangeData
+
+  /**
+   * 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
+}

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

@@ -0,0 +1,31 @@
+import { MarkdownString } from './markdown-string'
+import { MoralityExtended } from './morality'
+import { LevelRangeData } from './level-range-data'
+
+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.
+   */
+  readonly levelRange?: LevelRangeData
+
+  /**
+   * 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,49 @@
+import { Alignment } from './alignment'
+
+export const MORALITY = ['hero', 'vigilante', 'villain', 'rogue', 'resistance', 'loyalist'] as const
+export const MORALITY_EXTENDED = [
+  ...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',
+] as const
+export type Morality = typeof MORALITY[number]
+export type MoralityExtended = typeof MORALITY_EXTENDED[number]
+
+/**
+ * Maps a morality to the underlying alignment
+ */
+export const MoralityMap: Record<Morality | Alignment, Alignment> = {
+  hero: 'hero',
+  vigilante: 'hero',
+  villain: 'villain',
+  rogue: 'villain',
+  loyalist: 'praetorian',
+  resistance: 'praetorian',
+  praetorian: 'praetorian',
+}

package/src/main/api/set-title-data.ts

@@ -0,0 +1,4 @@
+/**
+ * The id, or a pair of ids [primal, praetorian] that are used with the /settitle command to set a badge
+ */
+export type SetTitleData = [number, number?]

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/variant-context.ts

@@ -0,0 +1,11 @@
+import { Sex } from './sex'
+import { Morality } from './morality'
+import { Alignment } from './alignment'
+
+/**
+ * For badges, aspects like the name, icon, or badge text can vary depending on context, such as the alignment or sex of the character.
+ */
+export interface VariantContext {
+  readonly morality?: Morality | Alignment
+  readonly sex?: Sex
+}

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

@@ -0,0 +1,22 @@
+import { Sex } from './sex'
+import { Alignment } from './alignment'
+
+/**
+ * Some badge values differ based on the alignment or sex of a character.
+ */
+export interface VariantData<V> {
+  /**
+   * The character alignment this variant applies to.
+   */
+  readonly alignment?: Alignment
+
+  /**
+   * The character sex this variant applies to.
+   */
+  readonly sex?: Sex
+
+  /**
+   * The value for this combination.
+   */
+  readonly value: V
+}

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

@@ -0,0 +1,44 @@
+import { Link } from './link'
+import { MoralityExtended } from './morality'
+import { ZoneType } from './zone-type'
+import { MarkdownString } from './markdown-string'
+import { LevelRangeData } from './level-range-data'
+
+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
+
+  /**
+   * The type of zone.
+   */
+  readonly type: ZoneType
+
+  /**
+   * The character moralities that this zone is accessible by.
+   */
+  readonly morality?: MoralityExtended | MoralityExtended[]
+
+  /**
+   * The level range this zone is recommended for.
+   */
+  readonly levelRange?: LevelRangeData
+
+  /**
+   * Freeform notes or tips about the zone.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links?: Link[]
+}

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

@@ -0,0 +1,59 @@
+export const ZONE_TYPE = [
+  /**
+   * The standard zone type, even if not technically occurring in the 'City' proper.
+   */
+  'city',
+  /**
+   * An Ouroboros flashback to a zone as it was in a previous era.
+   */
+  'echo',
+  /**
+   * Tutorial zon, usually inaccessible after leaving.
+   */
+  'tutorial',
+  /**
+   * Trial zones, like the Abandoned Sewers trial.
+   */
+  'trial',
+  /**
+   * Hazard zones like the Hollows.
+   */
+  'hazard',
+  /**
+   * Mayhem mission zones.
+   */
+  'mayhem',
+  /**
+   * Safeguard mission zones.
+   */
+  'safeguard',
+  /**
+   * Exists inside a mission not covered by the other types.
+   */
+  'mission',
+  /**
+   * Incarnate trial zones.
+   */
+  'incarnate',
+  /**
+   * Cooprative zones where Heroes and Villains can team up for PvE content.
+   */
+  'co-op',
+  /**
+   * PvP zones like Bloody Bay.
+   */
+  'pvp',
+  /**
+   * Located in an arena PvP map.
+   */
+  'arena',
+  /**
+   * A building, usually contained within another zone, like the AE buildings.
+   */
+  'building',
+  /**
+   * Stuff like the (Phone only) zone.
+   */
+  'other',
+] as const
+export type ZoneType = typeof ZONE_TYPE[number]

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