coh-content-db 2.0.0-rc.8 → 2.0.0

package/src/test/db/{alternates.test.ts → variants.test.ts}

@@ -1,9 +1,9 @@
-import { Alternates } from '../../main'
+import { Variants } from '../../main'
 
-describe(Alternates.name, () => {
+describe(Variants.name, () => {
   describe('Constructor', () => {
-    test('should accept a list of alternate values', () => {
-      new Alternates([
+    test('should accept a list of variant values', () => {
+      new Variants([
         { value: 'Default' },
         { sex: 'M', value: 'Male' },
         { alignment: 'hero', value: 'Hero' },
@@ -13,17 +13,17 @@ describe(Alternates.name, () => {
     })
 
     test('should accept a single value', () => {
-      expect(new Alternates('foo').default?.value).toBe('foo')
+      expect(new Variants('foo').default?.value).toBe('foo')
     })
   })
 
   describe('getValue', () => {
     test('should return undefined if there are no values', () => {
-      expect(new Alternates([]).getValue()).toBeUndefined()
+      expect(new Variants([]).getValue()).toBeUndefined()
     })
 
     test('should return the least-specific value when no classifiers are provided', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { value: 'Default' },
         { sex: 'M', value: 'Male' },
         { alignment: 'hero', value: 'Hero' },
@@ -33,7 +33,7 @@ describe(Alternates.name, () => {
     })
 
     test('should return the least-specific value when no classifiers are provided, regardless of insert order', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { alignment: 'hero', value: 'Hero' },
         { value: 'Default' },
@@ -43,27 +43,27 @@ describe(Alternates.name, () => {
     })
 
     test('should return the most specific match', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { value: 'Default' },
         { sex: 'M', value: 'Male' },
         { alignment: 'hero', value: 'Hero' },
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
-      ]).getValue('villain', 'M')).toBe('Male Villain')
+      ]).getValue({ morality: 'villain', sex: 'M' })).toBe('Male Villain')
     })
 
     test('should return the most specific match, regardless of insert order', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
         { sex: 'M', value: 'Male' },
         { alignment: 'hero', value: 'Hero' },
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { value: 'Default' },
-      ]).getValue('villain', 'M')).toBe('Male Villain')
+      ]).getValue({ morality: 'villain', sex: 'M' })).toBe('Male Villain')
     })
 
     test('should return the lowest canonical value if there is no default', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'hero', value: 'Hero' },
         { sex: 'M', value: 'Male' },
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
@@ -72,22 +72,22 @@ describe(Alternates.name, () => {
     })
 
     test('should return the lowest canonical value if a specific is requested that does not exist', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'hero', value: 'Hero' },
         { alignment: 'villain', value: 'Villain' },
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
-      ]).getValue(undefined, 'F')).toBe('Hero')
+      ]).getValue({ sex: 'F' })).toBe('Hero')
     })
   })
 
   describe('default', () => {
     test('should return undefined if there are no values', () => {
-      expect(new Alternates([]).default).toBeUndefined()
+      expect(new Variants([]).default).toBeUndefined()
     })
 
     test('should return the lowest priority value', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { value: 'Default' },
         { sex: 'M', value: 'Male' },
         { alignment: 'hero', value: 'Hero' },
@@ -95,7 +95,7 @@ describe(Alternates.name, () => {
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
       ]).default?.value).toBe('Default')
 
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
         { sex: 'M', value: 'Male' },
@@ -103,7 +103,7 @@ describe(Alternates.name, () => {
         { alignment: 'hero', value: 'Hero' },
       ]).default?.value).toBe('Default')
 
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'villain', sex: 'M', value: 'Male Villain' },
         { alignment: 'praetorian', sex: 'F', value: 'Praetorian Female' },
         { sex: 'M', value: 'Male' },
@@ -114,11 +114,11 @@ describe(Alternates.name, () => {
 
   describe('canonical', () => {
     test('should be empty if there are no values', () => {
-      expect(new Alternates([]).canonical).toHaveLength(0)
+      expect(new Variants([]).canonical).toHaveLength(0)
     })
 
     test('should return values sorted in canonical order', () => {
-      const result = new Alternates([
+      const result = new Variants([
         { alignment: 'hero', sex: 'F', value: 'Female Hero' },
         { alignment: 'praetorian', value: 'Praetorian' },
         { sex: 'F', value: 'Female' },
@@ -150,7 +150,7 @@ describe(Alternates.name, () => {
     })
 
     test('should sort unspecified values by alpha', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { value: 'A' },
         { value: 'C' },
         { value: 'B' },
@@ -162,7 +162,7 @@ describe(Alternates.name, () => {
     })
 
     test('should sort identical values by value alpha', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { alignment: 'villain', value: 'B' },
         { sex: 'M', value: 'D' },
         { alignment: 'villain', value: 'A' },
@@ -178,7 +178,7 @@ describe(Alternates.name, () => {
 
   describe('toString', () => {
     test('should create a string separated by the separator', () => {
-      expect(new Alternates([
+      expect(new Variants([
         { sex: 'M', value: 'A' },
         { sex: 'F', value: 'B' },
         { alignment: 'hero', value: 'C' },

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

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.test.ts → util/links.test.ts}

@@ -1,8 +1,8 @@
-import { Badge, badgeLink, badgeUri, coalesceToArray, 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'
+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', () => {
@@ -147,19 +147,3 @@ describe(zoneLink.name, () => {
     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/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/change.ts

@@ -1,17 +0,0 @@
-import { MarkdownString } from './markdown-string'
-
-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.
-   */
-  description: MarkdownString
-}

package/src/main/changelog.ts

@@ -1,29 +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'
-      + `* Server groups are now referred to as 'forks'.\n`
-      + '* Replaced enums with union types and changed values to `kebab-case`.\n'
-      + '* `IServerGroupData` is now `ContentBundle` and each database instance is now designed to accept only a single bundle.\n'
-      + '* `GameMap` is now `Zone`.\n'
-      + '* Removed the `serverGroup` property from entities to simplify the object tree given that only a single context can exist per db now.\n'
-      + '* Added a simple indexing and search function for badge names, text and acquisition info.\n'
-      + '* Zone and badge references now follow a standard Markdown link format with a `badge://` or `map://` protocol.\n'
-      + '* Badge partials are now known as badge requirements.\n'
-      + '* Removed the `VidiotMap` API as it was never used or fleshed out properly.\n'
-      + '* Added formal support for Missions and Contacts in badge requirements.\n'
-      + '* Move exploration badge locations into badge requirement list.\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 all third-party 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,67 +0,0 @@
-import { AlternateData } from '../api/alternate-data'
-import { compareSex, Sex } from '../api/sex'
-import { Alignment, compareAlignment } from '../api/alignment'
-
-export class Alternates<T> {
-  readonly #sortedValues: AlternateData<T>[] = []
-
-  /**
-   * Create an alternate set from either a list of categorized values, or a single value when there are no alternates.
-   * @param value List of alternates, or a single value.
-   */
-  constructor(value: AlternateData<T>[] | T) {
-    if (Array.isArray(value)) {
-      this.#sortedValues = value.sort()
-      this.#sortedValues.sort((a, b) => this.#compareAlternates(a, b))
-    } else {
-      this.#sortedValues = [{ value }]
-    }
-  }
-
-  getValue(alignment?: Alignment, sex?: Sex): 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 this.default?.value
-  }
-
-  /**
-   * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
-   */
-  get default(): AlternateData<T> | undefined {
-    return this.#sortedValues[0]
-  }
-
-  /**
-   * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
-   */
-  get canonical(): AlternateData<T>[] {
-    return this.#sortedValues
-  }
-
-  /**
-   * Create a joined string from the alternate values in canonical order.
-   * @param separator Separator to use. Default is ' / '
-   */
-  toString(separator: string): string {
-    return this.canonical.map(x => x.value).join(separator)
-  }
-
-  #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 = compareAlignment(a.alignment, b.alignment) // Next by alignment
-    if (alignmentComparison !== 0) return alignmentComparison
-
-    const sexComparison = compareSex(a.sex, b.sex) // Last by sex
-    if (sexComparison !== 0) return sexComparison
-
-    return String(a.value).localeCompare(String(b.value))
-  }
-}

package/src/main/db/bundle-metadata.ts

@@ -1,45 +0,0 @@
-import { ContentBundle } from '../api/content-bundle'
-import { Change } from '../api/change'
-import { Link } from '../api/link'
-import { MarkdownString } from '../api/markdown-string'
-
-export class BundleMetadata {
-  /**
-   * Name of the content bundle.
-   */
-  readonly name: string
-
-  /**
-   * Description of the fork.
-   */
-  readonly description?: MarkdownString
-
-  /**
-   * Repository where the db content package is maintained.
-   */
-  readonly repository?: string
-
-  /**
-   * List of external links. Wiki, forums, etc.
-   */
-  readonly links?: Link[]
-
-  /**
-   * Change log for this data package.
-   */
-  readonly changelog?: Change[]
-
-  /**
-   * The current version of the data package.
-   */
-  readonly version?: string
-
-  constructor(bundle: ContentBundle) {
-    this.name = bundle.name
-    this.description = bundle.description
-    this.repository = bundle.repository
-    this.links = bundle.links ?? []
-    this.changelog = bundle.changelog ?? []
-    this.version = this.changelog?.at(-1)?.version
-  }
-}

package/src/test/api/content-bundle.fixture.ts

@@ -1,6 +0,0 @@
-import { defineFixture } from 'efate'
-import { ContentBundle } from '../../main'
-
-export const contentBundleFixture = defineFixture<ContentBundle>((t) => {
-  t.name.as(index => `Bundle ${index}`)
-})

package/src/test/api/content-bundle.test.ts

@@ -1,14 +0,0 @@
-import { ContentBundle } from '../../main'
-import { TEST_BADGE } from './badge-data.test'
-
-// If you change this test, update the example in the README as well
-export const TEST_BUNDLE: ContentBundle = {
-  name: 'My Content Bundle',
-  badges: [TEST_BADGE],
-}
-
-describe('ContentBundle', () => {
-  test('should be a usable interface', () => {
-    expect(TEST_BUNDLE).not.toBeUndefined()
-  })
-})

package/src/test/changelog.test.ts

@@ -1,36 +0,0 @@
-import { CHANGELOG } from '../main'
-
-describe('CHANGELOG', () => {
-  test('should be extant', () => {
-    expect(CHANGELOG).not.toBeUndefined()
-    expect(CHANGELOG).not.toBeUndefined()
-  })
-
-  test('should be an array', () => {
-    expect(Array.isArray(CHANGELOG)).toBeTruthy()
-  })
-
-  test('should have only semver versions', () => {
-    // semver.org - https://regex101.com/r/vkijKf/1/
-    const pattern = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/
-
-    for (const change of CHANGELOG) {
-      expect(pattern.test(change.version)).toBeTruthy()
-    }
-  })
-
-  test('should have dates', () => {
-    for (const change of CHANGELOG) {
-      const date = change.date
-      expect(date).not.toBeUndefined()
-      expect(date).not.toBeUndefined()
-    }
-  })
-
-  test('should have descriptions', () => {
-    for (const change of CHANGELOG) {
-      expect(change).not.toBeUndefined()
-      expect(change).not.toBeUndefined()
-    }
-  })
-})

package/src/test/db/bundle-metadata.test.ts

@@ -1,84 +0,0 @@
-import { BundleMetadata } from '../../main'
-import { contentBundleFixture } from '../api/content-bundle.fixture'
-
-describe(BundleMetadata.name, () => {
-  describe('Constructor', () => {
-    test(`should accept the test fixture`, () => {
-      new BundleMetadata(contentBundleFixture.create())
-    })
-  })
-
-  describe('name', () => {
-    test(`should be read from the bundle`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({ name: 'foo' }))
-      expect(bundle.name).toBe('foo')
-    })
-  })
-
-  describe('description', () => {
-    test(`should be read from the bundle`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({ description: 'foo' }))
-      expect(bundle.description).toBe('foo')
-    })
-
-    test(`should be optional`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.omit('description').create())
-      expect(bundle.description).toBeUndefined()
-    })
-  })
-
-  describe('repository', () => {
-    test(`should be read from the bundle`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({ repository: 'foo' }))
-      expect(bundle.repository).toBe('foo')
-    })
-
-    test(`should be optional`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.omit('repository').create())
-      expect(bundle.repository).toBeUndefined()
-    })
-  })
-
-  describe('links', () => {
-    test(`should be read from the bundle`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({ links: [{ title: 'foo', href: 'bar' }] }))
-      expect(bundle.links).toStrictEqual([{ title: 'foo', href: 'bar' }])
-    })
-
-    test(`should be optional`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.omit('links').create())
-      expect(bundle.links).toHaveLength(0)
-    })
-  })
-
-  describe('changelog', () => {
-    test(`should be read from the bundle`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({
-        changelog: [{ version: 'foo', date: new Date('2025-03-12'), description: 'bar' }],
-      }))
-      expect(bundle.changelog).toStrictEqual([{ version: 'foo', date: new Date('2025-03-12'), description: 'bar' }])
-    })
-
-    test(`should be optional`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.omit('changelog').create())
-      expect(bundle.changelog).toHaveLength(0)
-    })
-  })
-
-  describe('version', () => {
-    test(`should be read from the latest changelog entry`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.create({
-        changelog: [
-          { version: 'foo', date: new Date('2025-03-12'), description: 'Foo' },
-          { version: 'latest', date: new Date('2025-04-12'), description: 'Bar' },
-        ],
-      }))
-      expect(bundle.version).toBe('latest')
-    })
-
-    test(`should be undefined if there is no changelog`, () => {
-      const bundle = new BundleMetadata(contentBundleFixture.omit('changelog').create())
-      expect(bundle.version).toBeUndefined()
-    })
-  })
-})

package/src/test/index.test.ts

@@ -1,14 +0,0 @@
-import * as index from '../main/index'
-
-test('should export the changelog', () => {
-  expect(index).toHaveProperty('CHANGELOG')
-})
-
-test('should export badge reference utils', () => {
-  expect(index).toHaveProperty('badgeUri')
-  expect(index).toHaveProperty('badgeLink')
-  expect(index).toHaveProperty('contactUri')
-  expect(index).toHaveProperty('contactLink')
-  expect(index).toHaveProperty('zoneUri')
-  expect(index).toHaveProperty('zoneLink')
-})