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

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

@@ -0,0 +1,96 @@
+import { Contact } from '../../main'
+import { contactDataFixture } from '../api/contact-data.fixture'
+
+describe(Contact.name, () => {
+  describe('Constructor', () => {
+    test(`should accept the test fixture`, () => {
+      new Contact(contactDataFixture.create())
+    })
+  })
+
+  describe('key', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ key: 'foo' }))
+      expect(contact.key).toEqual('foo')
+    })
+  })
+
+  describe('name', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ name: 'foo' }))
+      expect(contact.name).toEqual('foo')
+    })
+  })
+
+  describe('title', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ title: 'foo' }))
+      expect(contact.title).toEqual('foo')
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('title').create())
+      expect(contact.title).toBeUndefined()
+    })
+  })
+
+  describe('zoneKey', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ zoneKey: 'foo' }))
+      expect(contact.zoneKey).toEqual('foo')
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('zoneKey').create())
+      expect(contact.zoneKey).toBeUndefined()
+    })
+  })
+
+  describe('loc', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ loc: [1, 2, 3] }))
+      expect(contact.loc).toStrictEqual([1, 2, 3])
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('loc').create())
+      expect(contact.loc).toBeUndefined()
+    })
+  })
+
+  describe('levelRange', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ levelRange: [1, 2] }))
+      expect(contact.levelRange).toStrictEqual([1, 2])
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('levelRange').create())
+      expect(contact.levelRange).toBeUndefined()
+    })
+  })
+
+  describe('notes', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ notes: 'foo' }))
+      expect(contact.notes).toEqual('foo')
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('notes').create())
+      expect(contact.notes).toBeUndefined()
+    })
+  })
+
+  describe('links', () => {
+    test(`should should be set from the data`, () => {
+      const contact = new Contact(contactDataFixture.create({ links: [{ title: 'foo', href: 'bar' }] }))
+      expect(contact.links).toStrictEqual([{ title: 'foo', href: 'bar' }])
+    })
+
+    test(`should should be optional`, () => {
+      const contact = new Contact(contactDataFixture.omit('links').create())
+      expect(contact.links).toHaveLength(0)
+    })
+  })
+})

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 should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ key: 'foo' }))
+      expect(zone.key).toEqual('foo')
+    })
+  })
+
+  describe('name', () => {
+    test(`should should be set from the data`, () => {
+      const zone = new Zone(zoneDataFixture.create({ name: 'foo' }))
+      expect(zone.name).toEqual('foo')
+    })
+  })
+
+  describe('links', () => {
+    test(`should 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 should be optional`, () => {
+      const zone = new Zone(zoneDataFixture.omit('links').create())
+      expect(zone.links).toHaveLength(0)
+    })
+  })
+})

package/src/test/index.test.ts

@@ -5,6 +5,10 @@ test('should export the changelog', () => {
 })
 
 test('should export badge reference utils', () => {
-  expect(index).toHaveProperty('createBadgeReference')
-  expect(index).toHaveProperty('createMapReference')
+  expect(index).toHaveProperty('badgeUri')
+  expect(index).toHaveProperty('badgeLink')
+  expect(index).toHaveProperty('contactUri')
+  expect(index).toHaveProperty('contactLink')
+  expect(index).toHaveProperty('zoneUri')
+  expect(index).toHaveProperty('zoneLink')
 })

package/src/test/util.test.ts

@@ -1,39 +1,112 @@
-import { Badge, createBadgeReference, createMapReference, GameMap } from '../main'
+import { Badge, badgeLink, badgeUri, Contact, contactLink, contactUri, 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'
 
-describe(createBadgeReference.name, () => {
+describe(badgeUri.name, () => {
   test('should return the expected pattern', () => {
-    expect(createBadgeReference('foo')).toBe('[badge:foo]')
-    expect(createBadgeReference('bar')).toBe('[badge:bar]')
-    expect(createBadgeReference('foo-bar')).toBe('[badge:foo-bar]')
+    expect(badgeUri('foo')).toBe('badge://foo')
+    expect(badgeUri('bar')).toBe('badge://bar')
+    expect(badgeUri('foo-bar')).toBe('badge://foo-bar')
   })
 
   test('should accept a Badge object', () => {
     const badge = new Badge(badgeDataFixture.create({ key: 'foo' }))
-    expect(createBadgeReference(badge)).toBe('[badge:foo]')
+    expect(badgeUri(badge)).toBe('badge://foo')
   })
 
   test('should accept a BadgeData object', () => {
     const badge = badgeDataFixture.create({ key: 'foo' })
-    expect(createBadgeReference(badge)).toBe('[badge:foo]')
+    expect(badgeUri(badge)).toBe('badge://foo')
   })
 })
 
-describe(createMapReference.name, () => {
+describe(badgeLink.name, () => {
   test('should return the expected pattern', () => {
-    expect(createMapReference('foo')).toBe('[map:foo]')
-    expect(createMapReference('bar')).toBe('[map:bar]')
-    expect(createMapReference('foo-bar')).toBe('[map:foo-bar]')
+    expect(badgeLink('foo')).toBe('[foo](badge://foo)')
+    expect(badgeLink('bar')).toBe('[bar](badge://bar)')
+    expect(badgeLink('foo-bar')).toBe('[foo-bar](badge://foo-bar)')
   })
 
-  test('should accept a GameMap object', () => {
-    const map = new GameMap(gameMapDataFixture.create({ key: 'foo' }))
-    expect(createMapReference(map)).toBe('[map:foo]')
+  test('should accept a Badge object', () => {
+    const badge = new Badge(badgeDataFixture.create({ key: 'foo' }))
+    expect(badgeLink(badge)).toBe('[foo](badge://foo)')
+  })
+
+  test('should accept a BadgeData object', () => {
+    const badge = badgeDataFixture.create({ key: 'foo' })
+    expect(badgeLink(badge)).toBe('[foo](badge://foo)')
+  })
+})
+
+describe(contactUri.name, () => {
+  test('should return the expected pattern', () => {
+    expect(contactUri('foo')).toBe('contact://foo')
+    expect(contactUri('bar')).toBe('contact://bar')
+    expect(contactUri('foo-bar')).toBe('contact://foo-bar')
+  })
+
+  test('should accept a Contact object', () => {
+    const contact = new Contact(contactDataFixture.create({ key: 'foo' }))
+    expect(contactUri(contact)).toBe('contact://foo')
+  })
+
+  test('should accept a ContactData object', () => {
+    const contact = contactDataFixture.create({ key: 'foo' })
+    expect(contactUri(contact)).toBe('contact://foo')
+  })
+})
+
+describe(contactLink.name, () => {
+  test('should return the expected pattern', () => {
+    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 Contact object', () => {
+    const contact = new Contact(contactDataFixture.create({ key: 'foo' }))
+    expect(contactLink(contact)).toBe('[foo](contact://foo)')
+  })
+
+  test('should accept a ContactData object', () => {
+    const contact = contactDataFixture.create({ key: 'foo' })
+    expect(contactLink(contact)).toBe('[foo](contact://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 GameMapData object', () => {
-    const map = gameMapDataFixture.create({ key: 'foo' })
-    expect(createMapReference(map)).toBe('[map:foo]')
+  test('should accept a ZoneData object', () => {
+    const zone = zoneDataFixture.create({ key: 'foo' })
+    expect(zoneLink(zone)).toBe('[foo](zone://foo)')
   })
 })

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

@@ -1,65 +0,0 @@
-import { EnhancementCategory } from './enhancement-category'
-import { BadgePartialType } from './badge-partial-type'
-import { PlaqueType } from './plaque-type'
-
-export interface BadgePartialData {
-  /**
-   * Key.
-   */
-  readonly key: string
-
-  /**
-   * Type of partial.
-   */
-  readonly type: BadgePartialType | string
-
-  /**
-   * 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 | string
-
-  /**
-   * Plaque inscription.
-   */
-  readonly inscription?: 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 | string)[]
-
-  /**
-   * Number of invention crafts required.
-   */
-  readonly inventionCount?: number
-
-  /**
-   * Any additional notes.
-   */
-  readonly notes?: string
-}

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/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 @@
-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.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
-   */
-  readonly notes?: string
-
-  /**
-   * 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/badge-partial.ts

@@ -1,35 +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'
-
-export class BadgePartial {
-  readonly key: string
-  readonly type: BadgePartialType | string
-  readonly mapKey?: string
-  readonly loc?: number[]
-  readonly plaqueType?: PlaqueType | string
-  readonly inscription?: string
-  readonly vidiotMapKey?: string
-  readonly badgeKey?: string
-  readonly inventionLevel?: number
-  readonly inventionTypes?: (EnhancementCategory | string)[]
-  readonly inventionCount?: number
-  readonly notes?: string
-
-  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.inscription = data.inscription
-    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/badge-search-document.ts

@@ -1,16 +0,0 @@
-import { Badge } from './badge'
-
-export class BadgeSearchDocument {
-  id: string
-  key: string
-  name: string
-  badgeText: string
-  acquisition: string
-
-  constructor(badge: Badge) {
-    this.id = this.key = badge.key
-    this.name = badge.name.toString(', ')
-    this.badgeText = badge.badgeText.toString(', ')
-    this.acquisition = badge.acquisition ?? ''
-  }
-}

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,40 +0,0 @@
-import { VidiotMapPointOfInterestData } from '../api/vidiot-map-point-of-interest-data'
-
-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.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
-   */
-  readonly notes?: string
-
-  /**
-   * 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/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.inscription?.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 })
-})

package/src/test/api/vidiot-map-point-of-interest.fixture.ts

@@ -1,10 +0,0 @@
-import { defineFixture } from 'efate'
-import { VidiotMapPointOfInterest } from '../../main'
-
-export const vidiotMapPointOfInterestFixture = defineFixture<VidiotMapPointOfInterest>((t) => {
-  t.pos?.as(index => [index, index])
-  t.notes?.asLoremIpsum()
-  t.mapKey?.as(index => `map-${index}`)
-  t.badgeKey?.as(index => `badge-${index}`)
-  t.badgePartialKey?.as(index => `partial-${index}`)
-})

package/src/test/api/vidiot-map.fixture.ts

@@ -1,9 +0,0 @@
-import { defineFixture } from 'efate'
-import { VidiotMap } from '../../main'
-import { vidiotMapPointOfInterestFixture } from './vidiot-map-point-of-interest.fixture'
-
-export const vidiotMapFixture = defineFixture<VidiotMap>((t) => {
-  t.imageUrl.as(index => `https://nouri.org?id=${index}`)
-  t.name?.as(index => `Vidiot Map ${index}`)
-  t.pointsOfInterest?.arrayOfFixture({ fixture: vidiotMapPointOfInterestFixture })
-})