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

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

@@ -0,0 +1,36 @@
+import { Zone } from '../../main'
+import { zoneDataFixture } from '../api/zone-data.fixture'
+
+describe(Zone.name, () => {
+  describe('Constructor', () => {
+    test(`should accept the test fixture`, () => {
+      new Zone(zoneDataFixture.create())
+    })
+  })
+
+  describe('key', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ key: 'foo' }))
+      expect(zone.key).toEqual('foo')
+    })
+  })
+
+  describe('name', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ name: 'foo' }))
+      expect(zone.name).toEqual('foo')
+    })
+  })
+
+  describe('links', () => {
+    test(`should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ links: [{ title: 'foo', href: 'bar' }] }))
+      expect(zone.links).toStrictEqual([{ title: 'foo', href: 'bar' }])
+    })
+
+    test(`should be optional`, () => {
+      const zone = new Zone(zoneDataFixture.omit('links').create())
+      expect(zone.links).toHaveLength(0)
+    })
+  })
+})

package/src/test/index.test.ts

@@ -7,6 +7,8 @@ test('should export the changelog', () => {
 test('should export badge reference utils', () => {
   expect(index).toHaveProperty('badgeUri')
   expect(index).toHaveProperty('badgeLink')
-  expect(index).toHaveProperty('mapUri')
-  expect(index).toHaveProperty('mapLink')
+  expect(index).toHaveProperty('contactUri')
+  expect(index).toHaveProperty('contactLink')
+  expect(index).toHaveProperty('zoneUri')
+  expect(index).toHaveProperty('zoneLink')
 })

package/src/test/util.test.ts

@@ -1,6 +1,8 @@
-import { Badge, badgeLink, badgeUri, GameMap, mapLink, mapUri } from '../main'
+import { Badge, badgeLink, badgeUri, coalesceToArray, Contact, contactLink, contactUri, Mission, missionLink, missionUri, Zone, zoneLink, zoneUri } from '../main'
 import { badgeDataFixture } from './api/badge-data.fixture'
-import { gameMapDataFixture } from './api/game-map-data.fixture'
+import { zoneDataFixture } from './api/zone-data.fixture'
+import { contactDataFixture } from './api/contact-data.fixture'
+import { missionDataFixture } from './api/mission-data.fixture'
 
 describe(badgeUri.name, () => {
   test('should return the expected pattern', () => {
@@ -38,38 +40,126 @@ describe(badgeLink.name, () => {
   })
 })
 
-describe(mapUri.name, () => {
+describe(contactUri.name, () => {
   test('should return the expected pattern', () => {
-    expect(mapUri('foo')).toBe('map://foo')
-    expect(mapUri('bar')).toBe('map://bar')
-    expect(mapUri('foo-bar')).toBe('map://foo-bar')
+    expect(contactUri('foo')).toBe('contact://foo')
+    expect(contactUri('bar')).toBe('contact://bar')
+    expect(contactUri('foo-bar')).toBe('contact://foo-bar')
   })
 
-  test('should accept a GameMap object', () => {
-    const map = new GameMap(gameMapDataFixture.create({ key: 'foo' }))
-    expect(mapUri(map)).toBe('map://foo')
+  test('should accept a Contact object', () => {
+    const contact = new Contact(contactDataFixture.create({ key: 'foo' }))
+    expect(contactUri(contact)).toBe('contact://foo')
   })
 
-  test('should accept a GameMapData object', () => {
-    const map = gameMapDataFixture.create({ key: 'foo' })
-    expect(mapUri(map)).toBe('map://foo')
+  test('should accept a ContactData object', () => {
+    const contact = contactDataFixture.create({ key: 'foo' })
+    expect(contactUri(contact)).toBe('contact://foo')
   })
 })
 
-describe(mapLink.name, () => {
+describe(contactLink.name, () => {
   test('should return the expected pattern', () => {
-    expect(mapLink('foo')).toBe('[foo](map://foo)')
-    expect(mapLink('bar')).toBe('[bar](map://bar)')
-    expect(mapLink('foo-bar')).toBe('[foo-bar](map://foo-bar)')
+    expect(contactLink('foo')).toBe('[foo](contact://foo)')
+    expect(contactLink('bar')).toBe('[bar](contact://bar)')
+    expect(contactLink('foo-bar')).toBe('[foo-bar](contact://foo-bar)')
   })
 
-  test('should accept a GameMap object', () => {
-    const map = new GameMap(gameMapDataFixture.create({ key: 'foo' }))
-    expect(mapLink(map)).toBe('[foo](map://foo)')
+  test('should accept a Contact object', () => {
+    const contact = new Contact(contactDataFixture.create({ key: 'foo' }))
+    expect(contactLink(contact)).toBe('[foo](contact://foo)')
   })
 
-  test('should accept a GameMapData object', () => {
-    const map = gameMapDataFixture.create({ key: 'foo' })
-    expect(mapLink(map)).toBe('[foo](map://foo)')
+  test('should accept a ContactData object', () => {
+    const contact = contactDataFixture.create({ key: 'foo' })
+    expect(contactLink(contact)).toBe('[foo](contact://foo)')
+  })
+})
+
+describe(missionUri.name, () => {
+  test('should return the expected pattern', () => {
+    expect(missionUri('foo')).toBe('mission://foo')
+    expect(missionUri('bar')).toBe('mission://bar')
+    expect(missionUri('foo-bar')).toBe('mission://foo-bar')
+  })
+
+  test('should accept a Mission object', () => {
+    const mission = new Mission(missionDataFixture.create({ key: 'foo' }))
+    expect(missionUri(mission)).toBe('mission://foo')
+  })
+
+  test('should accept a MissionData object', () => {
+    const mission = missionDataFixture.create({ key: 'foo' })
+    expect(missionUri(mission)).toBe('mission://foo')
+  })
+})
+
+describe(missionLink.name, () => {
+  test('should return the expected pattern', () => {
+    expect(missionLink('foo')).toBe('[foo](mission://foo)')
+    expect(missionLink('bar')).toBe('[bar](mission://bar)')
+    expect(missionLink('foo-bar')).toBe('[foo-bar](mission://foo-bar)')
+  })
+
+  test('should accept a Mission object', () => {
+    const mission = new Mission(missionDataFixture.create({ key: 'foo' }))
+    expect(missionLink(mission)).toBe('[foo](mission://foo)')
+  })
+
+  test('should accept a MissionData object', () => {
+    const mission = missionDataFixture.create({ key: 'foo' })
+    expect(missionLink(mission)).toBe('[foo](mission://foo)')
+  })
+})
+
+describe(zoneUri.name, () => {
+  test('should return the expected pattern', () => {
+    expect(zoneUri('foo')).toBe('zone://foo')
+    expect(zoneUri('bar')).toBe('zone://bar')
+    expect(zoneUri('foo-bar')).toBe('zone://foo-bar')
+  })
+
+  test('should accept a Zone object', () => {
+    const zone = new Zone(zoneDataFixture.create({ key: 'foo' }))
+    expect(zoneUri(zone)).toBe('zone://foo')
+  })
+
+  test('should accept a ZoneData object', () => {
+    const zone = zoneDataFixture.create({ key: 'foo' })
+    expect(zoneUri(zone)).toBe('zone://foo')
+  })
+})
+
+describe(zoneLink.name, () => {
+  test('should return the expected pattern', () => {
+    expect(zoneLink('foo')).toBe('[foo](zone://foo)')
+    expect(zoneLink('bar')).toBe('[bar](zone://bar)')
+    expect(zoneLink('foo-bar')).toBe('[foo-bar](zone://foo-bar)')
+  })
+
+  test('should accept a Zone object', () => {
+    const zone = new Zone(zoneDataFixture.create({ key: 'foo' }))
+    expect(zoneLink(zone)).toBe('[foo](zone://foo)')
+  })
+
+  test('should accept a ZoneData object', () => {
+    const zone = zoneDataFixture.create({ key: 'foo' })
+    expect(zoneLink(zone)).toBe('[foo](zone://foo)')
+  })
+})
+
+describe(coalesceToArray.name, () => {
+  test('should return an array unmodified', () => {
+    expect(coalesceToArray(['a', 'b'])).toStrictEqual(['a', 'b'])
+    expect(coalesceToArray([1, 2])).toStrictEqual([1, 2])
+  })
+
+  test('should return a single value as a single-value array', () => {
+    expect(coalesceToArray('a')).toStrictEqual(['a'])
+    expect(coalesceToArray(1)).toStrictEqual([1])
+  })
+
+  test('should return undefined value as undefined', () => {
+    expect(coalesceToArray()).toBeUndefined()
   })
 })

package/src/main/api/badge-partial-data.ts

@@ -1,66 +0,0 @@
-import { EnhancementCategory } from './enhancement-category'
-import { BadgePartialType } from './badge-partial-type'
-import { PlaqueType } from './plaque-type'
-import { MarkdownString } from './markdown-string'
-
-export interface BadgePartialData {
-  /**
-   * Key.
-   */
-  readonly key: string
-
-  /**
-   * Type of partial.
-   */
-  readonly type: BadgePartialType
-
-  /**
-   * Map the partial is located on.
-   */
-  readonly mapKey?: string
-
-  /**
-   * /loc coordinates.
-   */
-  readonly loc?: number[]
-
-  /**
-   * Is it a wall plaque or a physical monument?
-   */
-  readonly plaqueType?: PlaqueType
-
-  /**
-   * Plaque inscription.
-   */
-  readonly plaqueInscription?: string
-
-  /**
-   * The number or letter the partial appears as on Vidiot Maps.
-   */
-  readonly vidiotMapKey?: string
-
-  /**
-   * The badge required for this partial.
-   */
-  readonly badgeKey?: string
-
-  /**
-   * Level of the invention required.
-   */
-  readonly inventionLevel?: number
-
-  /**
-   * The types of enhancements required to be crafted.
-   */
-  readonly inventionTypes?: EnhancementCategory[]
-
-  /**
-   * Number of invention crafts required.
-   */
-  readonly inventionCount?: number
-
-  /**
-   * Any additional notes.
-   */
-  readonly notes?: MarkdownString
-}

package/src/main/api/badge-partial-type.ts

@@ -1,8 +0,0 @@
-export const BADGE_PARTIAL_TYPE = [
-  'PLAQUE',
-  'BADGE',
-  'INVENTION',
-  'INVENTION_PLUS_ONE', // Some invention badges require you to build x of two different invention levels, 'plus one of either level'.
-] as const
-
-export type BadgePartialType = typeof BADGE_PARTIAL_TYPE[number]

package/src/main/api/game-map-data.ts

@@ -1,26 +0,0 @@
-import { Link } from './link'
-import { VidiotMapData } from './vidiot-map-data'
-
-export interface GameMapData {
-  /**
-   * Unique key used to reference this badge.
-   *
-   * Keys can only contain lowercase letters, numbers and hyphens (`-`).
-   */
-  readonly key: string
-
-  /**
-   * The name of the map as it appears in-game.
-   */
-  readonly name: string
-
-  /**
-   * List of external links for this Map. Wiki, forums, etc.
-   */
-  readonly links?: Link[]
-
-  /**
-   * List of Vidiot Map assets for this map.
-   */
-  readonly vidiotMaps?: VidiotMapData[]
-}

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

@@ -1,6 +0,0 @@
-export const PLAQUE_TYPE = [
-  'WALL_PLAQUE',
-  'MONUMENT',
-]
-
-export type PlaqueType = typeof PLAQUE_TYPE[number]

package/src/main/api/vidiot-map-data.ts

@@ -1,18 +0,0 @@
-import { VidiotMapPointOfInterestData } from './vidiot-map-point-of-interest-data'
-
-export interface VidiotMapData {
-  /**
-   * URL of the map image.
-   */
-  readonly imageUrl: string
-
-  /**
-   * Name to display for the Vidiot map.
-   */
-  readonly name?: string
-
-  /**
-   * List of Points of Interest labelled on the image.
-   */
-  readonly pointsOfInterest?: VidiotMapPointOfInterestData[]
-}

package/src/main/api/vidiot-map-point-of-interest-data.ts

@@ -1,30 +0,0 @@
-import { MarkdownString } from './markdown-string'
-
-export interface VidiotMapPointOfInterestData {
-  /**
-   * The pixel-space position of the PoI on the map graphic.
-   *
-   * Screen-space, pixels from top-left `[0, 0]`.
-   */
-  readonly pos?: [number, number]
-
-  /**
-   * Freeform notes about the PoI.
-   */
-  readonly notes?: MarkdownString
-
-  /**
-   * If the POI is a zone transfer, the map it transfers to.
-   */
-  readonly mapKey?: string
-
-  /**
-   * If the POI is a badge, the badge.
-   */
-  readonly badgeKey?: string
-
-  /**
-   * If the POI is a partial for a badge, the partial key.
-   */
-  readonly badgePartialKey?: string
-}

package/src/main/db/alignments.ts

@@ -1,17 +0,0 @@
-import { Alignment } from '../api/alignment'
-
-export class Alignments {
-  readonly items: Alignment[]
-  readonly hero: boolean
-  readonly villain: boolean
-  readonly praetorian: boolean
-  readonly primal: boolean
-
-  constructor(raw: Alignment[]) {
-    this.items = raw
-    this.hero = raw.includes('H')
-    this.villain = raw.includes('V')
-    this.praetorian = raw.includes('P')
-    this.primal = !this.praetorian && (this.hero || this.villain)
-  }
-}

package/src/main/db/badge-partial.ts

@@ -1,83 +0,0 @@
-import { BadgePartialData } from '../api/badge-partial-data'
-import { PlaqueType } from '../api/plaque-type'
-import { BadgePartialType } from '../api/badge-partial-type'
-import { EnhancementCategory } from '../api/enhancement-category'
-import { Key } from './key'
-import { MarkdownString } from '../api/markdown-string'
-
-export class BadgePartial {
-  /**
-   * Key.
-   */
-  readonly key: string
-
-  /**
-   * Type of partial.
-   */
-  readonly type: BadgePartialType
-
-  /**
-   * Map the partial is located on.
-   */
-  readonly mapKey?: string
-
-  /**
-   * /loc coordinates.
-   */
-  readonly loc?: number[]
-
-  /**
-   * Is it a wall plaque or a physical monument?
-   */
-  readonly plaqueType?: PlaqueType
-
-  /**
-   * Plaque inscription.
-   */
-  readonly plaqueInscription?: string
-
-  /**
-   * The number or letter the partial appears as on Vidiot Maps.
-   */
-  readonly vidiotMapKey?: string
-
-  /**
-   * The badge required for this partial.
-   */
-  readonly badgeKey?: string
-
-  /**
-   * Level of the invention required.
-   */
-  readonly inventionLevel?: number
-
-  /**
-   * The types of enhancements required to be crafted.
-   */
-  readonly inventionTypes?: EnhancementCategory[]
-
-  /**
-   * Number of invention crafts required.
-   */
-  readonly inventionCount?: number
-
-  /**
-   * Any additional notes.
-   */
-  readonly notes?: MarkdownString
-
-  constructor(data: BadgePartialData) {
-    this.key = new Key(data.key).value
-    this.type = data.type
-    this.mapKey = data.mapKey
-    this.loc = data.loc
-    this.plaqueType = data.plaqueType
-    this.plaqueInscription = data.plaqueInscription
-    this.vidiotMapKey = data.vidiotMapKey
-    this.badgeKey = data.badgeKey
-    this.inventionLevel = data.inventionLevel
-    this.inventionTypes = data.inventionTypes
-    this.inventionCount = data.inventionCount
-    this.notes = data.notes
-  }
-}

package/src/main/db/game-map.ts

@@ -1,33 +0,0 @@
-import { VidiotMap } from './vidiot-map'
-import { Link } from '../api/link'
-import { GameMapData } from '../api/game-map-data'
-import { Key } from './key'
-
-export class GameMap {
-  /**
-   * The database key for this map.
-   */
-  readonly key: string
-
-  /**
-   * The name of the map as it appears in-game.
-   */
-  readonly name: string
-
-  /**
-   * List of external links for this Map. Wiki, forums, etc.
-   */
-  readonly links?: Link[]
-
-  /**
-   * List of Vidiot Map assets for this map.
-   */
-  readonly vidiotMaps?: VidiotMap[]
-
-  constructor(data: GameMapData) {
-    this.key = new Key(data.key).value
-    this.name = data.name
-    this.links = data.links
-    this.vidiotMaps = data.vidiotMaps?.map(data => new VidiotMap(data))
-  }
-}

package/src/main/db/vidiot-map-point-of-interest.ts

@@ -1,39 +0,0 @@
-import { VidiotMapPointOfInterestData } from '../api/vidiot-map-point-of-interest-data'
-import { MarkdownString } from '../api/markdown-string'
-
-export class VidiotMapPointOfInterest {
-  /**
-   * The pixel-space position of the PoI on the map graphic.
-   *
-   * Screen-space, pixels from top-left `[0, 0]`.
-   */
-  readonly pos?: [number, number]
-
-  /**
-   * Freeform notes about the PoI.
-   */
-  readonly notes?: MarkdownString
-
-  /**
-   * If the POI is a zone transfer, the map it transfers to.
-   */
-  readonly mapKey?: string
-
-  /**
-   * If the POI is a badge, the badge.
-   */
-  readonly badgeKey?: string
-
-  /**
-   * If the POI is a partial for a badge, the partial key.
-   */
-  readonly badgePartialKey?: string
-
-  constructor(data: VidiotMapPointOfInterestData) {
-    this.pos = data.pos
-    this.notes = data.notes
-    this.mapKey = data.mapKey
-    this.badgeKey = data.badgeKey
-    this.badgePartialKey = data.badgePartialKey
-  }
-}

package/src/main/db/vidiot-map.ts

@@ -1,25 +0,0 @@
-import { VidiotMapData } from '../api/vidiot-map-data'
-import { VidiotMapPointOfInterest } from './vidiot-map-point-of-interest'
-
-export class VidiotMap {
-  /**
-   * URL of the map image.
-   */
-  readonly imageUrl: string
-
-  /**
-   * Name to display for the Vidiot map.
-   */
-  readonly name?: string
-
-  /**
-   * List of Points of Interest labelled on the image.
-   */
-  readonly pointsOfInterest?: VidiotMapPointOfInterest[]
-
-  constructor(data: VidiotMapData) {
-    this.imageUrl = data.imageUrl
-    this.name = data.name
-    this.pointsOfInterest = data.pointsOfInterest?.map(data => new VidiotMapPointOfInterest(data))
-  }
-}

package/src/test/api/alignments.test.ts

@@ -1,40 +0,0 @@
-import { Alignments } from '../../main'
-
-describe(Alignments.name, () => {
-  test('should return the raw array', () => {
-    expect(new Alignments(['H', 'V']).items).toStrictEqual(['H', 'V'])
-  })
-
-  test('should detect a hero', () => {
-    expect(new Alignments(['H', 'V']).hero).toBeTruthy()
-  })
-
-  test('should detect a villain', () => {
-    expect(new Alignments(['H', 'V']).villain).toBeTruthy()
-  })
-
-  test('should detect a praetorian', () => {
-    expect(new Alignments(['H', 'V', 'P']).praetorian).toBeTruthy()
-  })
-
-  test('should detect a primal', () => {
-    expect(new Alignments(['H', 'V']).primal).toBeTruthy()
-  })
-
-  test('should not falsely detect a hero', () => {
-    expect(new Alignments(['V']).hero).toBeFalsy()
-  })
-
-  test('should not falsely detect a villain', () => {
-    expect(new Alignments(['H']).villain).toBeFalsy()
-  })
-
-  test('should not falsely detect a praetorian', () => {
-    expect(new Alignments(['V']).praetorian).toBeFalsy()
-  })
-
-  test('should falsely detect a primal', () => {
-    expect(new Alignments(['H', 'V', 'P']).primal).toBeFalsy()
-    expect(new Alignments(['P']).primal).toBeFalsy()
-  })
-})

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

@@ -1,17 +0,0 @@
-import { defineFixture } from 'efate'
-import { BADGE_PARTIAL_TYPE, BadgePartialData, ENHANCEMENT_CATEGORY, PLAQUE_TYPE } from '../../main'
-
-export const badgePartialDataFixture = defineFixture<BadgePartialData>((t) => {
-  t.key.as(index => `badge-partial-${index}`)
-  t.type.pickFrom([...BADGE_PARTIAL_TYPE])
-  t.mapKey?.asString()
-  t.loc?.asArray()
-  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()
-})

package/src/test/api/badge-partial-type.test.ts

@@ -1,31 +0,0 @@
-import { BADGE_PARTIAL_TYPE, BadgePartialType } from '../../main'
-
-describe('BADGE_PARTIAL_TYPE', () => {
-  test('should be an array', () => {
-    expect(Array.isArray(BADGE_PARTIAL_TYPE)).toBeTruthy()
-  })
-
-  test('should not be empty', () => {
-    expect(BADGE_PARTIAL_TYPE).not.toHaveLength(0)
-  })
-
-  test('should contain only strings', () => {
-    for (const entry of BADGE_PARTIAL_TYPE) {
-      expect(typeof entry).toBe('string')
-    }
-  })
-
-  test('should contain all known badge partial types', () => {
-    const expected = ['PLAQUE', 'BADGE', 'INVENTION', 'INVENTION_PLUS_ONE']
-    for (const category of expected) {
-      expect(BADGE_PARTIAL_TYPE).toContain(category)
-    }
-  })
-})
-
-describe('BadgePartialType', () => {
-  test('should be a usable type', () => {
-    const field: BadgePartialType = 'PLAQUE'
-    expect(field).toBe('PLAQUE')
-  })
-})

package/src/test/api/game-map-data.fixture.ts

@@ -1,10 +0,0 @@
-import { GameMapData } from '../../main'
-import { defineFixture } from 'efate'
-import { vidiotMapFixture } from './vidiot-map.fixture'
-
-export const gameMapDataFixture = defineFixture<GameMapData>((t) => {
-  t.key.as(index => `map-${index}`)
-  t.name.as(index => `Map ${index}`)
-  t.links?.asArray([{ href: 'https://nouri.org' }])
-  t.vidiotMaps?.arrayOfFixture({ fixture: vidiotMapFixture })
-})