coh-content-db 2.0.0-rc.16 → 2.0.0-rc.18

package/src/main/db/contact.ts

@@ -5,6 +5,7 @@ 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 {
   /**
@@ -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

@@ -5,6 +5,7 @@ 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 {
   /**
@@ -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/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/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

@@ -12,12 +12,16 @@ export * from './api/contact-data'
 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/zone-data'
+export * from './api/zone-type'
 
 // DB
 export * from './db/alignment-list'
@@ -32,9 +36,11 @@ 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/zone'
 
 // UTILS

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' }])
 })

package/src/test/db/badge.test.ts

@@ -152,12 +152,14 @@ describe(Badge.name, () => {
   describe('setTitle', () => {
     test('should be set from the data', () => {
       const badge = new Badge(badgeDataFixture.create({ setTitleId: [123, 456] }))
-      expect(badge.setTitleId).toStrictEqual([123, 456])
+      expect(badge.setTitleId?.primal).toEqual(123)
+      expect(badge.setTitleId?.praetorian).toEqual(456)
     })
 
     test('should treat the praetorian id as optional', () => {
       const badge = new Badge(badgeDataFixture.create({ setTitleId: [123] }))
-      expect(badge.setTitleId).toStrictEqual([123])
+      expect(badge.setTitleId?.primal).toEqual(123)
+      expect(badge.setTitleId?.praetorian).toBeUndefined()
     })
 
     test('should be optional', () => {

package/src/test/db/contact.test.ts

@@ -62,7 +62,8 @@ describe(Contact.name, () => {
   describe('levelRange', () => {
     test(`should be set from the data`, () => {
       const contact = new Contact(contactDataFixture.create({ levelRange: [1, 2] }))
-      expect(contact.levelRange).toStrictEqual([1, 2])
+      expect(contact?.levelRange?.min).toEqual(1)
+      expect(contact?.levelRange?.max).toEqual(2)
     })
 
     test(`should be optional`, () => {

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

@@ -0,0 +1,47 @@
+import { LevelRange } from '../../main'
+
+describe(LevelRange.name, () => {
+  describe('Constructor', () => {
+    test('should accept a full array (5-10)', () => {
+      const range = new LevelRange([5, 10])
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(5)
+      expect(range.max).toEqual(10)
+    })
+
+    test('should accept a partial array (15+)', () => {
+      const range = new LevelRange([15])
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(15)
+      expect(range.max).toBeUndefined()
+    })
+
+    test('should not coalesce a explicit max of 50 (20-50)', () => {
+      const range = new LevelRange([20, 50])
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(20)
+      expect(range.max).toEqual(50)
+    })
+
+    test('should accept a single-level range (1-1)', () => {
+      const range = new LevelRange([1, 1])
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(1)
+      expect(range.max).toEqual(1)
+    })
+
+    test('should accept a zero value (0-0)', () => {
+      const range = new LevelRange([0, 0])
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(0)
+      expect(range.max).toEqual(0)
+    })
+
+    test('should accept a number (5+)', () => {
+      const range = new LevelRange(5)
+      expect(range).toBeDefined()
+      expect(range.min).toEqual(5)
+      expect(range.max).toBeUndefined()
+    })
+  })
+})

package/src/test/db/mission.test.ts

@@ -56,8 +56,9 @@ describe(Mission.name, () => {
 
   describe('levelRange', () => {
     test(`should be set from the data`, () => {
-      const mission = new Mission(missionDataFixture.create({ levelRange: [1, 2] }))
-      expect(mission.levelRange).toStrictEqual([1, 2])
+      const mission = new Mission(missionDataFixture.create({ levelRange: 25 }))
+      expect(mission?.levelRange?.min).toEqual(25)
+      expect(mission?.levelRange?.max).toBeUndefined()
     })
 
     test(`should be optional`, () => {
@@ -105,13 +106,14 @@ describe(Mission.name, () => {
 
     describe('levelRange', () => {
       test(`should be set from the data`, () => {
-        const mission = new Mission(missionDataFixture.create({ flashback: { levelRange: [1, 2] } }))
-        expect(mission.flashback?.levelRange).toStrictEqual([1, 2])
+        const mission = new Mission(missionDataFixture.create({ flashback: { levelRange: [1, 20] } }))
+        expect(mission.flashback?.levelRange?.min).toEqual(1)
+        expect(mission.flashback?.levelRange?.max).toEqual(20)
       })
 
-      test(`should default to the mission value`, () => {
+      test(`should *not* default to the mission value due to Ouro level grouping`, () => {
         const mission = new Mission(missionDataFixture.create({ levelRange: [1, 2], flashback: missionFlashbackDataFixture.omit('levelRange').create() }))
-        expect(mission.flashback?.levelRange).toStrictEqual([1, 2])
+        expect(mission.flashback?.levelRange).toBeUndefined()
       })
 
       test(`should be optional`, () => {

package/src/test/db/morality-list.test.ts

@@ -29,7 +29,7 @@ describe(MoralityList.name, () => {
       expect(new MoralityList().items).toStrictEqual(['hero', 'vigilante', 'villain', 'rogue', 'resistance', 'loyalist'])
     })
 
-    test('should treat empty as no values', () => {
+    test('should treat explicit empty as no values', () => {
       expect(new MoralityList([]).items).toStrictEqual([])
     })
   })

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

@@ -0,0 +1,19 @@
+import { SetTitleIds } from '../../main'
+
+describe(SetTitleIds.name, () => {
+  describe('Constructor', () => {
+    test('should accept both primal and praetorian values', () => {
+      const ids = new SetTitleIds([5, 10])
+      expect(ids).toBeDefined()
+      expect(ids.primal).toEqual(5)
+      expect(ids.praetorian).toEqual(10)
+    })
+
+    test('should accept primal only', () => {
+      const ids = new SetTitleIds([1])
+      expect(ids).toBeDefined()
+      expect(ids.primal).toEqual(1)
+      expect(ids.praetorian).toBeUndefined()
+    })
+  })
+})

package/src/test/db/zone.test.ts

@@ -22,6 +22,51 @@ describe(Zone.name, () => {
     })
   })
 
+  describe('type', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ type: 'city' }))
+      expect(zone.type).toEqual('city')
+    })
+  })
+
+  describe('morality', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ morality: ['hero'] }))
+      expect(zone.morality?.hero).toBeTruthy()
+      expect(zone.morality?.vigilante).toBeFalsy()
+    })
+
+    test(`should be optional`, () => {
+      const zone = new Zone(zoneDataFixture.omit('morality').create())
+      expect(zone.morality?.all).toBeTruthy()
+    })
+  })
+
+  describe('levelRange', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ levelRange: [10] }))
+      expect(zone.levelRange?.min).toEqual(10)
+      expect(zone.levelRange?.max).toBeUndefined()
+    })
+
+    test(`should be optional`, () => {
+      const zone = new Zone(zoneDataFixture.omit('levelRange').create())
+      expect(zone.levelRange).toBeUndefined()
+    })
+  })
+
+  describe('notes', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ notes: 'foo' }))
+      expect(zone.notes).toEqual('foo')
+    })
+
+    test(`should be optional`, () => {
+      const zone = new Zone(zoneDataFixture.omit('notes').create())
+      expect(zone.notes).toBeUndefined()
+    })
+  })
+
   describe('links', () => {
     test(`should be set from the data`, () => {
       const zone = new Zone(zoneDataFixture.create({ links: [{ title: 'foo', href: 'bar' }] }))