coh-content-db 2.0.0-rc.2 → 2.0.0-rc.21

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

@@ -0,0 +1,81 @@
+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('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' }] }))
+      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/integration.test.ts

@@ -0,0 +1,16 @@
+import { BundleData } from '../main'
+import { TEST_BADGE } from './api/badge-data.test'
+
+/**
+ * If you change this test, update the example in the README as well
+ */
+export const MyBundle: BundleData = {
+  header: { name: 'My Content Bundle', version: '1.0.0', lastUpdateTime: '2025-04-21T00:00:00Z' },
+  badges: [TEST_BADGE],
+}
+
+describe('BundleData', () => {
+  test('should be a usable interface', () => {
+    expect(MyBundle).not.toBeUndefined()
+  })
+})

package/src/test/util/coalese-to-array.test.ts

@@ -0,0 +1,17 @@
+import { coalesceToArray } from '../../main/util/coalesce-to-array'
+
+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/test/util/links.test.ts

@@ -0,0 +1,149 @@
+import { Badge, badgeLink, badgeUri, Contact, contactLink, contactUri, Mission, missionLink, missionUri, Zone, zoneLink, zoneUri } from '../../main'
+import { badgeDataFixture } from '../api/badge-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', () => {
+    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(badgeUri(badge)).toBe('badge://foo')
+  })
+
+  test('should accept a BadgeData object', () => {
+    const badge = badgeDataFixture.create({ key: 'foo' })
+    expect(badgeUri(badge)).toBe('badge://foo')
+  })
+})
+
+describe(badgeLink.name, () => {
+  test('should return the expected pattern', () => {
+    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 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)')
+  })
+})

package/src/test/util/to-date.test.ts

@@ -0,0 +1,15 @@
+import { toDate } from '../../main/util/to-date'
+
+describe(toDate.name, () => {
+  test('should return a valid date', () => {
+    expect(toDate('2025-02-01')).toStrictEqual(new Date('2025-02-01'))
+  })
+
+  test('should return a valid time', () => {
+    expect(toDate('2025-04-21T02:57:52.402Z')).toStrictEqual(new Date('2025-04-21T02:57:52.402Z'))
+  })
+
+  test('should throw on invalid ISO string', () => {
+    expect(() => toDate('foo')).toThrow('Invalid date')
+  })
+})

package/src/main/api/alternate-data.ts

@@ -1,22 +0,0 @@
-import { Sex } from './sex'
-import { Alignment } from './alignment'
-
-/**
- * Some badge values differ based on the alignment or sex of the character.
- */
-export interface AlternateData<V> {
-  /**
-   * The character alignment this alternate applies to.
-   */
-  readonly alignment?: Alignment | string
-
-  /**
-   * The character sex this alternate applies to.
-   */
-  readonly sex?: Sex | string
-
-  /**
-   * The value for this combination.
-   */
-  readonly value: V
-}

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

@@ -1,81 +0,0 @@
-import { AlternateData } from '../api/alternate-data'
-import { Sex } from '../api/sex'
-import { Alignment } from '../api/alignment'
-
-const ALIGNMENT_SORT: Record<string, number> = { H: 2, V: 1, P: 0 }
-const SEX_SORT: Record<string, number> = { M: 1, F: 0 }
-
-export class Alternates<T> {
-  readonly #sortedValues: AlternateData<T>[] = []
-
-  constructor(values: AlternateData<T>[]) {
-    this.#sortedValues = values.sort()
-    this.#sortedValues.sort((a, b) => this.#compareAlternates(a, b))
-  }
-
-  getValue(alignment?: Alignment | string, sex?: Sex | string): T | undefined {
-    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.value
-    }
-    return undefined
-  }
-
-  /**
-   * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
-   */
-  get default(): T | undefined {
-    return this.#sortedValues[0]?.value
-  }
-
-  /**
-   * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
-   */
-  get canonical(): AlternateData<T>[] {
-    return this.#sortedValues
-  }
-
-  #compareAlternates(a: AlternateData<T>, b: AlternateData<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 = this.#compareAlignment(a.alignment, b.alignment) // Next by alignment
-    if (alignmentComparison !== 0) return alignmentComparison
-
-    const sexComparison = this.#compareSex(a.sex, b.sex) // Last by sex
-    if (sexComparison !== 0) return sexComparison
-
-    return String(a.value).localeCompare(String(b.value))
-  }
-
-  #compareAlignment(a: Alignment | string | undefined, b: Alignment | string | undefined): number {
-    if (a === b) return 0
-    if (a === undefined && b !== undefined) return -1
-    if (b === undefined && a !== undefined) return 1
-
-    const aSort = a === undefined ? -1 : ALIGNMENT_SORT[a] ?? -1 // Unknown values get -1 priority
-    const bSort = b === undefined ? -1 : ALIGNMENT_SORT[b] ?? -1
-
-    if (aSort !== bSort) return bSort - aSort
-
-    // Unknown values (not in ALIGNMENT_SORT) are sorted alphabetically
-    return a?.localeCompare(b ?? '') ?? 0
-  }
-
-  #compareSex(a?: Sex | string | undefined, b?: Sex | string | undefined): number {
-    if (a === b) return 0
-    if (a === undefined && b !== undefined) return -1
-    if (b === undefined && a !== undefined) return 1
-
-    const aSort = SEX_SORT[a ?? -1] ?? -1 // Unknown values get -1 priority
-    const bSort = SEX_SORT[b ?? -1] ?? -1
-
-    if (aSort !== bSort) return bSort - aSort
-
-    // Unknown values (not in SEX_SORT) are sorted alphabetically
-    return a?.localeCompare(b ?? '') ?? 0
-  }
-}

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