coh-content-db 2.0.0-rc.1 → 2.0.0-rc.11

package/src/test/util.test.ts

@@ -1,39 +1,165 @@
-import { Badge, createBadgeReference, createMapReference, GameMap } 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(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(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 accept a GameMapData object', () => {
-    const map = gameMapDataFixture.create({ key: 'foo' })
-    expect(createMapReference(map)).toBe('[map:foo]')
+  test('should return undefined value as undefined', () => {
+    expect(coalesceToArray()).toBeUndefined()
   })
 })

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/change.ts

@@ -1,14 +0,0 @@
-export interface Change {
-  /**
-   * The version number in {@link http://semver.org|semver} format.
-   */
-  version: string
-  /**
-   * Date of the change.
-   */
-  date: Date
-  /**
-   * Description of the change in {@link https://www.markdownguide.org/|Markdown} format.
-   */
-  description: string
-}

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/server-group-data.ts

@@ -1,65 +0,0 @@
-import { ArchetypeData } from './archetype-data'
-import { GameMapData } from './game-map-data'
-import { BadgeData } from './badge-data'
-import { Change } from './change'
-import { Link } from './link'
-
-/**
- * A server group is a group or company that hosts a set of game servers, such as Homecoming (https://forums.homecomingservers.com/).
- */
-export interface ServerGroupData {
-  /**
-   * Unique key used to reference this server group.
-   *
-   * Keys can only contain lowercase letters, numbers and hyphens (`-`).
-   */
-  readonly key: string
-
-  /**
-   * Name of the server group.
-   */
-  readonly name: string
-
-  /**
-   * Description of the server group.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
-   */
-  readonly description?: string
-
-  /**
-   * Repository where the db content package is maintained.
-   */
-  readonly repository?: string
-
-  /**
-   * List of external links for this Badge. Wiki, forums, etc.
-   */
-  readonly links?: Link[]
-
-  /**
-   * List of the game server names in this server group.
-   * Torchbearer, Excelsior, etc.
-   */
-  readonly servers?: string[]
-
-  /**
-   * List of archetypes available in this server group.
-   */
-  readonly archetypes?: ArchetypeData[]
-
-  /**
-   * List of game maps supported by this server group.
-   */
-  readonly maps?: GameMapData[]
-
-  /**
-   * List of badges available on this server group.
-   */
-  readonly badges?: BadgeData[]
-
-  /**
-   * Change log for this data package.
-   */
-  readonly changelog?: Change[]
-}

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/changelog.ts

@@ -1,20 +0,0 @@
-import { Change } from './api/change'
-
-export const CHANGELOG: Change[] = [
-  {
-    version: '2.0.0',
-    date: new Date('2025-03-12'),
-    description: ''
-      + '* Replaced redundant interfaces with their concrete equivalents.\n'
-      + '* Replaced enums with extensible union types; Server groups with new badge types, enhancement types, etc. can now extend them locally.\n'
-      + '* Removed the `serverGroup` property from entities to simplify the object tree; Server group context will need to be managed separately.\n'
-      + '* Standardized pluralization of some field names (name, icon).\n'
-      + '* Combined `settitle` ids into a single tuple field.\n'
-      + '* Change from GNU to The Unlicense.\n'
-      + '* Removed dependency on lodash. There are now no third-party runtime dependencies.\n'
-      + '* Moved from webpack to rollup for packaging.\n'
-      + '* Add eslint for linting.\n'
-      + '* Add jest for unit tests.\n'
-      + '* Added GitHub Actions for CI.\n',
-  },
-]

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/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/server-group.ts

@@ -1,112 +0,0 @@
-import { Archetype } from './archetype'
-import { Badge } from './badge'
-import { ServerGroupData } from '../api/server-group-data'
-import { Key } from './key'
-import { Change } from '../api/change'
-import { GameMap } from './game-map'
-import { Link } from '../api/link'
-
-export class ServerGroup {
-  readonly #archetypeIndex: Record<string, Archetype> = {}
-  readonly #mapIndex: Record<string, GameMap> = {}
-  readonly #badgeIndex: Record<string, Badge> = {}
-
-  /**
-   * The database key for this server group.
-   */
-  readonly key: string
-
-  /**
-   * Name of the server group.
-   */
-  readonly name: string
-
-  /**
-   * Description of the server group.
-   *
-   * Supports {@link https://www.markdownguide.org/|Markdown} format.
-   */
-  readonly description?: string
-
-  /**
-   * Repository where the db content package is maintained.
-   */
-  readonly repository?: string
-
-  /**
-   * List of external links for this Server Group. Wiki, forums, etc.
-   */
-  readonly links?: Link[]
-
-  /**
-   * List of the game server names in this server group.
-   * Torchbearer, Excelsior, etc.
-   */
-  readonly servers: string[]
-
-  /**
-   * List of archetypes available in this server group.
-   */
-  readonly archetypes: Archetype[]
-
-  /**
-   * List of game maps supported by this server group.
-   */
-  readonly maps: GameMap[]
-
-  /**
-   * List of badges available on this server group.
-   */
-  readonly badges: Badge[]
-
-  /**
-   * Change log for this data package.
-   */
-  readonly changelog?: Change[]
-
-  constructor(data: ServerGroupData) {
-    this.key = new Key(data.key).value
-    this.name = data.name
-    this.description = data.description
-    this.repository = data.repository
-    this.links = data.links
-    this.servers = data.servers ?? []
-    this.archetypes = data.archetypes?.map((data) => {
-      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 = data.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.badges = data.badges?.map((data) => {
-      if (this.#badgeIndex[data.key] !== undefined) throw new Error(`Duplicate badge key [${data.key}]`)
-      const badge = new Badge(data)
-      this.#badgeIndex[badge.key] = badge
-      return badge
-    }) ?? []
-    this.changelog = data.changelog
-  }
-
-  getArchetype(key: string): Archetype {
-    const result = this.#archetypeIndex[key]
-    if (result === undefined) throw new Error(`Unknown archetype key [${key}]`)
-    return result
-  }
-
-  getMap(key: string): GameMap {
-    const result = this.#mapIndex[key]
-    if (result === undefined) throw new Error(`Unknown map key [${key}]`)
-    return result
-  }
-
-  getBadge(key: string): Badge {
-    const result = this.#badgeIndex[key]
-    if (result === undefined) throw new Error(`Unknown badge key [${key}]`)
-    return result
-  }
-}

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
-  }
-}