coh-content-db 2.0.0-rc.8 → 2.0.0

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

@@ -0,0 +1,52 @@
+import { Link } from '../api/link'
+import { MarkdownString } from '../api/markdown-string'
+import { BundleHeaderData } from '../api/bundle-header-data'
+import { toDate } from '../util/to-date'
+
+export class BundleHeader {
+  /**
+   * 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.
+   */
+  readonly lastUpdateTime: Date
+
+  /**
+   * 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[]
+
+  constructor(data: BundleHeaderData) {
+    if (!data) throw new Error('Missing header data')
+    this.name = data.name
+    this.version = data.version
+    this.lastUpdateTime = toDate(data.lastUpdateTime)
+    this.description = data?.description
+    this.repositoryUrl = data?.repositoryUrl
+    this.changelogUrl = data?.changelogUrl
+    this.links = data?.links ?? []
+  }
+}

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

@@ -1,45 +1,45 @@
-import { ContentBundle } from '../api/content-bundle'
+import { BundleData } from '../api/bundle-data'
 import { Archetype } from './archetype'
 import { Zone } from './zone'
 import { Badge } from './badge'
-import { BundleMetadata } from './bundle-metadata'
-import { BadgeIndex } from './badge-index'
+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 {
-  #archetypeIndex = new AbstractIndex<Archetype>('key')
-  #zoneIndex = new AbstractIndex<Zone>('key')
-  #contactIndex = new AbstractIndex<Contact>('key')
-  #missionIndex = new AbstractIndex<Mission>('key')
-  #badgeIndex = new BadgeIndex()
+  readonly #archetypeIndex
+  readonly #zoneIndex
+  readonly #contactIndex
+  readonly #missionIndex
+  readonly #badgeIndex
 
-  #metadata?: BundleMetadata
-  #servers?: string[]
+  readonly #header: BundleHeader
+  readonly #servers: string[]
 
   /**
-   * Load the given content bundle, resetting the db if a bundle is already loaded.
+   * Create a db instance from the given content bundle.
    * @param bundle The bundle to load.
    */
-  load(bundle: ContentBundle): void {
-    this.#metadata = new BundleMetadata(bundle)
+  constructor(bundle: BundleData) {
+    this.#header = new BundleHeader(bundle.header)
     this.#servers = bundle.servers ?? []
 
-    this.#archetypeIndex.load(bundle.archetypes?.map(x => new Archetype(x)))
-    this.#zoneIndex.load(bundle.zones?.map(x => new Zone(x)))
-    this.#contactIndex.load(bundle.contacts?.map(x => new Contact(x)))
-    this.#missionIndex.load(bundle.missions?.map(x => new Mission(x)))
-    this.#badgeIndex.load(bundle.badges?.map(x => new Badge(x)))
+    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)))
   }
 
   /**
-   * Metadata about the content bundle.
+   * Header information about the content bundle.
    */
-  get metadata(): BundleMetadata | undefined {
-    return this.#metadata
+  get header(): BundleHeader {
+    return this.#header
   }
 
   /**
@@ -48,7 +48,7 @@ export class CohContentDatabase {
    * Torchbearer, Excelsior, etc.
    */
   get servers(): string[] {
-    return this.#servers ?? []
+    return this.#servers
   }
 
   /**

package/src/main/db/contact.ts

@@ -4,7 +4,8 @@ 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'
+import { coalesceToArray } from '../util/coalesce-to-array'
+import { LevelRange } from './level-range'
 
 export class Contact {
   /**
@@ -27,7 +28,7 @@ export class Contact {
   /**
    * The character moralities that this contact will interact with.
    */
-  readonly morality?: MoralityList
+  readonly morality: MoralityList
 
   /**
    * The location of this contact.
@@ -37,7 +38,7 @@ export class Contact {
   /**
    * The level range this contact will offer missions for.
    */
-  readonly levelRange?: [number, number?]
+  readonly levelRange?: LevelRange
 
   /**
    * Freeform notes or tips about the contact.
@@ -55,7 +56,7 @@ export class Contact {
     this.title = data.title
     this.morality = new MoralityList(coalesceToArray(data.morality))
     this.location = data.location
-    this.levelRange = data.levelRange
+    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/mission.ts

@@ -3,8 +3,9 @@ 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'
+import { coalesceToArray } from '../util/coalesce-to-array'
+import { LevelRange } from './level-range'
 
 export class Mission {
   /**
@@ -39,7 +40,7 @@ export class Mission {
   /**
    * The level range this mission is available for.
    */
-  readonly levelRange?: [number, number?]
+  readonly levelRange?: LevelRange
 
   /**
    * Freeform notes or tips about the mission.
@@ -62,19 +63,19 @@ export class Mission {
     readonly id: string
 
     /**
-     * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
+     * The level range this mission appears under as a Flashback.
      */
-    readonly levelRange?: [number, number?]
+    readonly levelRange?: LevelRange
 
     /**
-     * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+     * The name as it appears in the Flashback list.
      */
-    readonly name?: string
+    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.
+     * The character moralities that the mission will appear for in the Flashback list.
      */
-    readonly morality?: MoralityList
+    readonly morality: MoralityList
 
     /**
      * Freeform notes or tips about the Flashback version of the mission.
@@ -88,7 +89,7 @@ export class Mission {
     this.type = data.type
     this.morality = new MoralityList(coalesceToArray(data.morality))
     this.contactKeys = coalesceToArray(data.contactKeys)
-    this.levelRange = data.levelRange
+    this.levelRange = data.levelRange ? new LevelRange(data.levelRange) : undefined
     this.notes = data.notes
     this.links = data.links ?? []
     this.flashback = createFlashback(data)
@@ -99,7 +100,7 @@ function createFlashback(data: MissionData): Mission['flashback'] {
   if (!data.flashback) return undefined
   return {
     id: data.flashback.id,
-    levelRange: data.flashback.levelRange ?? data.levelRange,
+    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/paged.ts

@@ -1,7 +1,11 @@
 export interface Paged<T> {
   items: T[]
-  page: number
+
+  matchedItemCount: number
+  totalItemCount: number
+
   pageSize?: number
-  totalItems: number
-  totalPages: 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

@@ -1,6 +1,11 @@
 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 {
   /**
@@ -15,6 +20,26 @@ export class Zone {
    */
   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.
    */
@@ -23,6 +48,10 @@ export class Zone {
   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,42 +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-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/content-bundle'
 export * from './api/enhancement-category'
 export * from './api/link'
 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/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/alternates'
 export * from './db/archetype'
 export * from './db/badge'
 export * from './db/badge-index'
 export * from './db/badge-requirement'
 export * from './db/badge-search-options'
-export * from './db/bundle-metadata'
+export * from './db/bundle-header'
 export * from './db/coh-content-database'
 export * from './db/contact'
 export * from './db/key'
 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.ts → util/links.ts}

@@ -1,11 +1,11 @@
-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'
+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.
@@ -102,17 +102,3 @@ export function zoneLink(target: string | Zone | ZoneData): string {
   const key = typeof target === 'string' ? target : target.key
   return `[${key}](${zoneUri(target)})`
 }
-
-/**
- * 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/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
+}

package/src/test/api/alignment.test.ts

@@ -51,14 +51,14 @@ describe('compareAlignment', () => {
 
   test('should work as a compare function', () => {
     const unsorted: (Alignment | undefined)[] = [undefined, 'hero', 'villain', 'praetorian', undefined, 'villain', 'praetorian']
-    const sorted = unsorted.sort(compareAlignment)
+    const sorted = unsorted.toSorted(compareAlignment)
 
     expect(sorted).toStrictEqual(['hero', 'villain', 'villain', 'praetorian', 'praetorian', undefined, undefined])
   })
 
   test('should sort against undefined', () => {
     const unsorted: (Alignment | undefined)[] = [undefined, 'hero']
-    const sorted = unsorted.sort(compareAlignment)
+    const sorted = unsorted.toSorted(compareAlignment)
 
     expect(sorted).toStrictEqual(['hero', undefined])
   })

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

@@ -5,4 +5,5 @@ export const badgeDataFixture = defineFixture<BadgeData>((t) => {
   t.key.as(index => `badge-${index}`)
   t.type.pickFrom([...BADGE_TYPE])
   t.name.as(index => [{ value: `Badge ${index}` }])
+  t.releaseDate.as(() => '2025-02-03')
 })

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

@@ -5,6 +5,7 @@ export const TEST_BADGE: BadgeData = {
   key: 'test-badge',
   type: 'achievement',
   name: [{ value: 'Test Badge' }, { alignment: 'praetorian', value: 'My Badge for Praetorians' }],
+  releaseDate: '2020-03-01',
   morality: ['hero', 'praetorian'],
 }
 

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

@@ -0,0 +1,7 @@
+import { defineFixture } from 'efate'
+import { BundleData } from '../../main'
+import { bundleHeaderDataFixture } from './bundle-header-data.fixture'
+
+export const bundleDataFixture = defineFixture<BundleData>((t) => {
+  t.header.fromFixture(bundleHeaderDataFixture)
+})

package/src/test/api/bundle-header-data.fixture.ts

@@ -0,0 +1,8 @@
+import { defineFixture } from 'efate'
+import { BundleHeaderData } from '../../main'
+
+export const bundleHeaderDataFixture = defineFixture<BundleHeaderData>((t) => {
+  t.name.as(index => `Bundle ${index}`)
+  t.version.as(index => `${index}.${index}.${index}`)
+  t.lastUpdateTime.as(() => new Date().toISOString())
+})

package/src/test/api/morality.test.ts

@@ -0,0 +1,31 @@
+import { MoralityMap } from '../../main'
+
+describe('MoralityMap', () => {
+  test('should map hero to hero', () => {
+    expect(MoralityMap.hero).toEqual('hero')
+  })
+
+  test('should map vigilante to hero', () => {
+    expect(MoralityMap.vigilante).toEqual('hero')
+  })
+
+  test('should map villain to villain', () => {
+    expect(MoralityMap.villain).toEqual('villain')
+  })
+
+  test('should map rogue to villain', () => {
+    expect(MoralityMap.rogue).toEqual('villain')
+  })
+
+  test('should map resistance to praetorian', () => {
+    expect(MoralityMap.resistance).toEqual('praetorian')
+  })
+
+  test('should map loyalist to praetorian', () => {
+    expect(MoralityMap.loyalist).toEqual('praetorian')
+  })
+
+  test('should map praetorian to praetorian', () => {
+    expect(MoralityMap.loyalist).toEqual('praetorian')
+  })
+})

package/src/test/api/sex.test.ts

@@ -49,14 +49,14 @@ describe('compareSex', () => {
 
   test('should work as a compare function', () => {
     const unsorted: (Sex | undefined)[] = [undefined, 'M', 'F', 'M', undefined, 'F', 'M']
-    const sorted = unsorted.sort(compareSex)
+    const sorted = unsorted.toSorted(compareSex)
 
     expect(sorted).toStrictEqual(['M', 'M', 'M', 'F', 'F', undefined, undefined])
   })
 
   test('should sort against undefined', () => {
     const unsorted: (Sex | undefined)[] = [undefined, 'M']
-    const sorted = unsorted.sort(compareSex)
+    const sorted = unsorted.toSorted(compareSex)
 
     expect(sorted).toStrictEqual(['M', undefined])
   })

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

@@ -4,5 +4,6 @@ import { defineFixture } from 'efate'
 export const zoneDataFixture = defineFixture<ZoneData>((t) => {
   t.key.as(index => `zone-${index}`)
   t.name.as(index => `Zone ${index}`)
+  t.type.withValue('city')
   t.links?.as(() => [{ title: 'foo', href: 'https://nouri.org' }])
 })