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

package/src/main/db/{badge-partial.ts → badge-requirement.ts}

@@ -1,25 +1,26 @@
-import { BadgePartialData } from '../api/badge-partial-data'
+import { BadgeRequirementData } from '../api/badge-requirement-data'
 import { PlaqueType } from '../api/plaque-type'
-import { BadgePartialType } from '../api/badge-partial-type'
+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'
 
-export class BadgePartial {
+export class BadgeRequirement {
   /**
    * Key.
    */
   readonly key: string
 
   /**
-   * Type of partial.
+   * Type of requirement.
    */
-  readonly type: BadgePartialType
+  readonly type: BadgeRequirementType
 
   /**
-   * Map the partial is located on.
+   * Zone the requirement is located in.
    */
-  readonly mapKey?: string
+  readonly zoneKey?: string
 
   /**
    * /loc coordinates.
@@ -37,15 +38,25 @@ export class BadgePartial {
   readonly plaqueInscription?: string
 
   /**
-   * The number or letter the partial appears as on Vidiot Maps.
+   * The number or letter the plaque appears as on Vidiot Maps.
    */
   readonly vidiotMapKey?: string
 
   /**
-   * The badge required for this partial.
+   * The key of the badge for this requirement.
    */
   readonly badgeKey?: string
 
+  /**
+   * Mission name.
+   */
+  readonly missionName?: string
+
+  /**
+   * {@link Contact} key for the story arc.
+   */
+  readonly contactKey?: string
+
   /**
    * Level of the invention required.
    */
@@ -66,18 +77,26 @@ export class BadgePartial {
    */
   readonly notes?: MarkdownString
 
-  constructor(data: BadgePartialData) {
+  /**
+   * 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.mapKey = data.mapKey
+    this.zoneKey = data.zoneKey
     this.loc = data.loc
     this.plaqueType = data.plaqueType
     this.plaqueInscription = data.plaqueInscription
     this.vidiotMapKey = data.vidiotMapKey
     this.badgeKey = data.badgeKey
+    this.missionName = data.missionName
+    this.contactKey = data.contactKey
     this.inventionLevel = data.inventionLevel
     this.inventionTypes = data.inventionTypes
     this.inventionCount = data.inventionCount
     this.notes = data.notes
+    this.links = data.links ?? []
   }
 }

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

@@ -25,7 +25,7 @@ export interface BadgeSearchOptions {
    */
   filter?: {
     type?: BadgeType
-    mapKey?: string
+    zoneKey?: string
     alignment?: Alignment
   }
 
@@ -35,7 +35,7 @@ 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'
+    by?: 'CANONICAL' | 'BADGE_NAME' | 'ZONE_NAME'
     dir?: 'ASC' | 'DESC'
   }
 

package/src/main/db/badge.ts

@@ -1,14 +1,14 @@
 import { BadgeType } from '../api/badge-type'
 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 { Alignments } from './alignments'
 import { MarkdownString } from '../api/markdown-string'
 
 export class Badge {
-  readonly #partialsIndex: Record<string, BadgePartial> = {}
+  readonly #requirementsIndex: Record<string, BadgeRequirement> = {}
 
   /**
    * The database key for this badge.
@@ -38,7 +38,7 @@ export class Badge {
   readonly badgeText: Alternates<string>
 
   /**
-   * Description of how to acquire the badge.
+   * Short description of how to acquire the badge. Detailed instructions will be in the notes field.
    */
   readonly acquisition?: MarkdownString
 
@@ -55,22 +55,22 @@ export class Badge {
   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.
+   * For exploration badges, the key of the {@link Zone} that this badge is found on.
    */
-  readonly mapKey?: string
+  readonly zoneKey?: string
 
   /**
-   * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+   * For exploration badges, the `/loc` coordinates of the badge.
    */
   readonly loc?: [number, number, number]
 
   /**
-   * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+   * For plaques that appear on a Vidiot Map, the number or letter the badge appears as.
    */
   readonly vidiotMapKey?: string
 
@@ -94,43 +94,55 @@ export class Badge {
   readonly effect?: MarkdownString
 
   /**
-   * 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.
+   * Represents the layered requirements for badges with multiple fulfillment steps,
+   * such as visiting plaques for history badges or collecting other badges.
+   *
+   * The outer array represents groups of requirements evaluated with OR logic —
+   * fulfilling any group satisfies the badge.
+   *
+   * Each inner array represents individual requirements evaluated with AND logic —
+   * all conditions in the group must be met.
    */
-  readonly partials?: BadgePartial[]
+  readonly requirements?: BadgeRequirement[][]
 
   /**
    * 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 ignoreInTotals: boolean
 
-  constructor(data: BadgeData) {
-    this.key = new Key(data.key).value
-    this.type = data.type
-    this.name = new Alternates(data.name)
-    this.alignment = new Alignments(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
+  constructor(badgeData: BadgeData) {
+    this.key = new Key(badgeData.key).value
+    this.type = badgeData.type
+    this.name = new Alternates(badgeData.name)
+    this.alignment = new Alignments(badgeData.alignment)
+    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.zoneKey = badgeData.zoneKey
+    this.loc = badgeData.loc
+    this.effect = badgeData.effect
+    this.vidiotMapKey = badgeData.vidiotMapKey
+    this.setTitle = badgeData.setTitle
+    this.ignoreInTotals = badgeData.ignoreInTotals ?? false
+
+    this.requirements = badgeData.requirements?.map((groups, index) => {
+      const existingKeysInGroup = new Set<string>()
+      return groups.map((requirementData) => {
+        if (existingKeysInGroup.has(requirementData.key)) throw new Error(`Duplicate badge requirement key [${badgeData.key}:${requirementData.key}] in group [${index + 1}]`)
+        existingKeysInGroup.add(requirementData.key)
+
+        const badge = new BadgeRequirement(requirementData)
+        this.#requirementsIndex[badge.key] = badge
+        return badge
+      })
     })
   }
 
-  getPartial(key: string): BadgePartial {
-    const result = this.#partialsIndex[key]
-    if (result === undefined) throw new Error(`Unknown badge partial key [${key}]`)
+  getRequirement(key: string): BadgeRequirement {
+    const result = this.#requirementsIndex[key]
+    if (result === undefined) throw new Error(`Unknown badge requirement key [${key}]`)
     return result
   }
 }

package/src/main/db/bundle-metadata.ts

@@ -5,12 +5,12 @@ import { MarkdownString } from '../api/markdown-string'
 
 export class BundleMetadata {
   /**
-   * Name of the server group.
+   * Name of the content bundle.
    */
   readonly name: string
 
   /**
-   * Description of the server group.
+   * Description of the fork.
    */
   readonly description?: MarkdownString
 
@@ -20,7 +20,7 @@ export class BundleMetadata {
   readonly repository?: string
 
   /**
-   * List of external links for this Server Group. Wiki, forums, etc.
+   * List of external links. Wiki, forums, etc.
    */
   readonly links: Link[]
 

package/src/main/db/coh-content-database.ts

@@ -1,15 +1,17 @@
 import { ContentBundle } from '../api/content-bundle'
 import { Archetype } from './archetype'
-import { GameMap } from './game-map'
+import { Zone } from './zone'
 import { Badge } from './badge'
 import { BundleMetadata } from './bundle-metadata'
 import { BadgeIndex } from './badge-index'
 import { BadgeSearchOptions } from './badge-search-options'
 import { Paged } from './paged'
+import { Contact } from './contact'
 
 export class CohContentDatabase {
   readonly #archetypeIndex: Record<string, Archetype> = {}
-  readonly #mapIndex: Record<string, GameMap> = {}
+  readonly #zoneIndex: Record<string, Zone> = {}
+  readonly #contactIndex: Record<string, Contact> = {}
   readonly #badgeIndex: BadgeIndex
 
   /**
@@ -18,23 +20,29 @@ export class CohContentDatabase {
   readonly metadata: BundleMetadata
 
   /**
-   * List of the game server names in this server group.
+   * List of the game server names.
+   *
    * Torchbearer, Excelsior, etc.
    */
   readonly servers: string[]
 
   /**
-   * List of archetypes available in this server group.
+   * List of archetypes.
    */
   readonly archetypes: Archetype[]
 
   /**
-   * List of game maps supported by this server group.
+   * List of game zones.
    */
-  readonly maps: GameMap[]
+  readonly zones: Zone[]
 
   /**
-   * List of badges available on this server group.
+   * List of contacts.
+   */
+  readonly contacts: Contact[]
+
+  /**
+   * List of badges.
    */
   readonly badges: Badge[]
 
@@ -47,39 +55,64 @@ export class CohContentDatabase {
     this.servers = bundle.servers ?? []
 
     this.archetypes = bundle.archetypes?.map((data) => {
-      if (this.#archetypeIndex[data.key] !== undefined) throw new Error(`Duplicate archetype key [${data.key}]`)
+      if (this.#archetypeIndex[data.key] !== undefined) throw new Error(`Duplicate archetype key '${data.key}'`)
       const archetype = new Archetype(data)
       this.#archetypeIndex[archetype.key] = archetype
       return archetype
     }) ?? []
 
-    this.maps = bundle.maps?.map((data) => {
-      if (this.#mapIndex[data.key] !== undefined) throw new Error(`Duplicate map key [${data.key}]`)
-      const map = new GameMap(data)
-      this.#mapIndex[map.key] = map
-      return map
+    this.zones = bundle.zones?.map((data) => {
+      if (this.#zoneIndex[data.key] !== undefined) throw new Error(`Duplicate zone key '${data.key}'`)
+      const zone = new Zone(data)
+      this.#zoneIndex[zone.key] = zone
+      return zone
+    }) ?? []
+
+    this.contacts = bundle.contacts?.map((data) => {
+      if (this.#contactIndex[data.key] !== undefined) throw new Error(`Duplicate contact key '${data.key}'`)
+      const contact = new Contact(data)
+      this.#contactIndex[contact.key] = contact
+      return contact
     }) ?? []
 
     this.badges = bundle.badges?.map(data => new Badge(data)) ?? []
-    this.#badgeIndex = new BadgeIndex(this.badges, this.maps)
+    this.#badgeIndex = new BadgeIndex(this.badges, this.zones)
   }
 
   getArchetype(key: string): Archetype {
     const result = this.#archetypeIndex[key]
-    if (result === undefined) throw new Error(`Unknown archetype key [${key}]`)
+    if (result === undefined) throw new Error(`Unknown archetype key '${key}'`)
+    return result
+  }
+
+  getZone(key: string): Zone {
+    const result = this.#zoneIndex[key]
+    if (result === undefined) throw new Error(`Unknown zone key '${key}'`)
     return result
   }
 
-  getMap(key: string): GameMap {
-    const result = this.#mapIndex[key]
-    if (result === undefined) throw new Error(`Unknown map key [${key}]`)
+  getContact(key: string): Contact {
+    const result = this.#contactIndex[key]
+    if (result === undefined) throw new Error(`Unknown contact key '${key}'`)
     return result
   }
 
+  zoneExists(key: string): boolean {
+    return !!this.#zoneIndex[key]
+  }
+
+  contactExists(key: string): boolean {
+    return !!this.#contactIndex[key]
+  }
+
   getBadge(key: string): Badge {
     return this.#badgeIndex.getBadge(key)
   }
 
+  badgeExists(key: string): boolean {
+    return this.#badgeIndex.badgeExists(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

package/src/main/db/contact.ts

@@ -0,0 +1,59 @@
+import { Link } from '../api/link'
+import { Key } from './key'
+import { MarkdownString } from '../api/markdown-string'
+import { ContactData } from '../api/contact-data'
+
+export class Contact {
+  /**
+   * Unique key used to reference this contact.
+   *
+   * Keys 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 zone this character is located in.
+   */
+  readonly zoneKey?: string
+
+  /**
+   * The `/loc` coordinates of the contact.
+   */
+  readonly loc?: [number, number, number]
+
+  /**
+   * 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(contactData: ContactData) {
+    this.key = new Key(contactData.key).value
+    this.name = contactData.name
+    this.title = contactData.title
+    this.zoneKey = contactData.zoneKey
+    this.loc = contactData.loc
+    this.levelRange = contactData.levelRange
+    this.notes = contactData.notes
+    this.links = contactData.links ?? []
+  }
+}

package/src/main/db/zone.ts

@@ -0,0 +1,28 @@
+import { Link } from '../api/link'
+import { ZoneData } from '../api/zone-data'
+import { Key } from './key'
+
+export class Zone {
+  /**
+   * Unique key used to reference this zone.
+   *
+   * Keys 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[]
+
+  constructor(data: ZoneData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.links = data.links ?? []
+  }
+}

package/src/main/index.ts

@@ -3,19 +3,18 @@ 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/contact-data'
+export * from './api/content-bundle'
 export * from './api/enhancement-category'
-export * from './api/game-map-data'
 export * from './api/link'
 export * from './api/markdown-string'
 export * from './api/plaque-type'
-export * from './api/content-bundle'
 export * from './api/sex'
-export * from './api/vidiot-map-data'
-export * from './api/vidiot-map-point-of-interest-data'
+export * from './api/zone-data'
 
 // DB
 export * from './db/alignments'
@@ -23,15 +22,14 @@ export * from './db/alternates'
 export * from './db/archetype'
 export * from './db/badge'
 export * from './db/badge-index'
-export * from './db/badge-partial'
+export * from './db/badge-requirement'
 export * from './db/badge-search-options'
 export * from './db/bundle-metadata'
 export * from './db/coh-content-database'
-export * from './db/game-map'
+export * from './db/contact'
 export * from './db/key'
 export * from './db/paged'
-export * from './db/vidiot-map'
-export * from './db/vidiot-map-point-of-interest'
+export * from './db/zone'
 
 // ROOT
 export { CHANGELOG } from './changelog'

package/src/main/util.ts

@@ -1,3 +1,10 @@
+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'
+
 /**
  * Returns the URI of the given badge that can be used in {@link MarkdownString} links.
  *
@@ -5,7 +12,7 @@
  *
  * @param target The badge or badge key to target.
  */
-export function badgeUri(target: string | { key: string }): string {
+export function badgeUri(target: string | Badge | BadgeData): string {
   const key = typeof target === 'string' ? target : target.key
   return `badge://${key}`
 }
@@ -15,33 +22,57 @@ export function badgeUri(target: string | { key: string }): string {
  *
  * Link format: `[<key>](badge://<key>)`
  *
- * @param target The badge or badge key to target.
+ * @param target The {@link Badge} or badge key to target.
  */
-export function badgeLink(target: string | { key: string }): string {
+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 map that can be used in {@link MarkdownString} links.
+ * Returns the URI of the given contact that can be used in {@link MarkdownString} links.
+ *
+ * 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 zone that can be used in {@link MarkdownString} links.
  *
- * URI format: `map://<key>`
+ * URI format: `zone://<key>`
  *
- * @param target The {@link GameMap} or map key to target.
+ * @param target The {@link Zone} or zone key to target.
  */
-export function mapUri(target: string | { key: string }): string {
+export function zoneUri(target: string | Zone | ZoneData): string {
   const key = typeof target === 'string' ? target : target.key
-  return `map://${key}`
+  return `zone://${key}`
 }
 
 /**
- * Returns a {@link MarkdownString} link to the given map.
+ * Returns a {@link MarkdownString} link to the given zone.
  *
- * Link format: `[<key>](map://<key>)`
+ * Link format: `[<key>](zone://<key>)`
  *
- * @param target The map or map key to target.
+ * @param target The {@link Zone} or zone key to target.
  */
-export function mapLink(target: string | { key: string }): string {
+export function zoneLink(target: string | Zone | ZoneData): string {
   const key = typeof target === 'string' ? target : target.key
-  return `[${key}](${mapUri(target)})`
+  return `[${key}](${zoneUri(target)})`
 }

package/src/test/api/badge-data.fixture.ts

@@ -1,6 +1,6 @@
 import { defineFixture } from 'efate'
 import { ALIGNMENT, BADGE_TYPE, BadgeData } from '../../main'
-import { badgePartialDataFixture } from './badge-partial-data.fixture'
+import { badgeRequirementDataFixture } from './badge-requirement-data.fixture'
 
 export const badgeDataFixture = defineFixture<BadgeData>((t) => {
   t.key.as(index => `badge-${index}`)
@@ -9,14 +9,16 @@ export const badgeDataFixture = defineFixture<BadgeData>((t) => {
   t.alignment.pickFrom([...ALIGNMENT])
   t.badgeText?.as(index => [{ value: `This is badge ${index}` }])
   t.acquisition?.asLoremIpsum()
-  t.icon?.asArray([{ value: 'https://nouri.org' }])
+  t.icon?.as(() => [{ value: 'https://nouri.org' }])
   t.notes?.asLoremIpsum()
-  t.links?.asArray([{ href: 'https://nouri.org' }])
-  t.mapKey?.asString()
-  t.loc?.asArray()
+  t.links?.as(() => [{ href: 'https://nouri.org' }])
+  t.zoneKey?.asString()
+  t.loc?.as(index => [index, index, index])
   t.vidiotMapKey?.asString()
-  t.setTitle?.asArray({ length: 2 })
+  t.setTitle?.as((index) => {
+    return { id: index }
+  })
   t.effect?.asString()
-  t.partials?.arrayOfFixture({ fixture: badgePartialDataFixture })
+  t.requirements?.as(() => [[badgeRequirementDataFixture]])
   t.ignoreInTotals?.asBoolean()
 })

package/src/test/api/badge-requirement-data.fixture.ts

@@ -0,0 +1,17 @@
+import { defineFixture } from 'efate'
+import { BADGE_REQUIREMENT_TYPE, BadgeRequirementData, ENHANCEMENT_CATEGORY, PLAQUE_TYPE } from '../../main'
+
+export const badgeRequirementDataFixture = defineFixture<BadgeRequirementData>((t) => {
+  t.key.as(index => `badge-requirement-${index}`)
+  t.type.pickFrom([...BADGE_REQUIREMENT_TYPE])
+  t.zoneKey?.asString()
+  t.loc?.as(index => [index, index, index])
+  t.plaqueType?.pickFrom([...PLAQUE_TYPE])
+  t.plaqueInscription?.asLoremIpsum()
+  t.vidiotMapKey?.asString()
+  t.badgeKey?.as(index => `badge-${index}`)
+  t.inventionLevel?.asNumber()
+  t.inventionTypes?.pickFrom([...ENHANCEMENT_CATEGORY])
+  t.inventionCount?.asNumber()
+  t.notes?.asLoremIpsum()
+})