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

package/src/main/db/contact.ts

@@ -0,0 +1,59 @@
+import { Link } from '../api/link'
+import { Key } from './key'
+import { MarkdownString } from '../api/markdown-string'
+import { ContactData } from '../api/contact-data'
+
+export class Contact {
+  /**
+   * Unique key used to reference this contact.
+   *
+   * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The name of this contact.
+   */
+  readonly name: string
+
+  /**
+   * The contact's title.
+   */
+  readonly title?: string
+
+  /**
+   * The zone this character is located in.
+   */
+  readonly zoneKey?: string
+
+  /**
+   * The `/loc` coordinates of the contact.
+   */
+  readonly loc?: [number, number, number]
+
+  /**
+   * The level range this contact will offer missions for.
+   */
+  readonly levelRange?: [number, number?]
+
+  /**
+   * Freeform notes or tips about the contact.
+   */
+  readonly notes?: MarkdownString
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  constructor(contactData: ContactData) {
+    this.key = new Key(contactData.key).value
+    this.name = contactData.name
+    this.title = contactData.title
+    this.zoneKey = contactData.zoneKey
+    this.loc = contactData.loc
+    this.levelRange = contactData.levelRange
+    this.notes = contactData.notes
+    this.links = contactData.links ?? []
+  }
+}

package/src/main/db/paged.ts

@@ -0,0 +1,7 @@
+export interface Paged<T> {
+  items: T[]
+  page: number
+  pageSize?: number
+  totalItems: number
+  totalPages: number
+}

package/src/main/db/zone.ts

@@ -0,0 +1,28 @@
+import { Link } from '../api/link'
+import { ZoneData } from '../api/zone-data'
+import { Key } from './key'
+
+export class Zone {
+  /**
+   * Unique key used to reference this zone.
+   *
+   * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+   */
+  readonly key: string
+
+  /**
+   * The name of the zone as it appears in-game.
+   */
+  readonly name: string
+
+  /**
+   * List of external links. Wiki, forums, etc.
+   */
+  readonly links: Link[]
+
+  constructor(data: ZoneData) {
+    this.key = new Key(data.key).value
+    this.name = data.name
+    this.links = data.links ?? []
+  }
+}

package/src/main/index.ts

@@ -3,29 +3,33 @@ export * from './api/alignment'
 export * from './api/alternate-data'
 export * from './api/archetype-data'
 export * from './api/badge-data'
-export * from './api/badge-partial-data'
-export * from './api/badge-partial-type'
+export * from './api/badge-requirement-data'
+export * from './api/badge-requirement-type'
 export * from './api/badge-type'
 export * from './api/change'
+export * from './api/contact-data'
+export * from './api/content-bundle'
 export * from './api/enhancement-category'
-export * from './api/game-map-data'
 export * from './api/link'
+export * from './api/markdown-string'
 export * from './api/plaque-type'
-export * from './api/content-bundle'
 export * from './api/sex'
-export * from './api/vidiot-map-data'
-export * from './api/vidiot-map-point-of-interest-data'
+export * from './api/zone-data'
 
 // DB
+export * from './db/alignments'
+export * from './db/alternates'
 export * from './db/archetype'
 export * from './db/badge'
-export * from './db/badge-partial'
+export * from './db/badge-index'
+export * from './db/badge-requirement'
+export * from './db/badge-search-options'
+export * from './db/bundle-metadata'
 export * from './db/coh-content-database'
-export * from './db/game-map'
+export * from './db/contact'
 export * from './db/key'
-export * from './db/bundle-metadata'
-export * from './db/vidiot-map'
-export * from './db/vidiot-map-point-of-interest'
+export * from './db/paged'
+export * from './db/zone'
 
 // ROOT
 export { CHANGELOG } from './changelog'

package/src/main/util.ts

@@ -1,17 +1,78 @@
+import { BadgeData } from './api/badge-data'
+import { Badge } from './db/badge'
+import { ZoneData } from './api/zone-data'
+import { Zone } from './db/zone'
+import { Contact } from './db/contact'
+import { ContactData } from './api/contact-data'
+
 /**
- * Create a reference string that can be used in most text strings to display a link to the given badge.
+ * Returns the URI of the given badge that can be used in {@link MarkdownString} links.
+ *
+ * URI format: `badge://<key>`
+ *
  * @param target The badge or badge key to target.
  */
-export function createBadgeReference(target: string | { key: string }): string {
+export function badgeUri(target: string | Badge | BadgeData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `badge://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given badge.
+ *
+ * Link format: `[<key>](badge://<key>)`
+ *
+ * @param target The {@link Badge} or badge key to target.
+ */
+export function badgeLink(target: string | Badge | BadgeData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${badgeUri(target)})`
+}
+
+/**
+ * Returns the URI of the given contact that can be used in {@link MarkdownString} links.
+ *
+ * URI format: `contact://<key>`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+export function contactUri(target: string | Contact | ContactData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `contact://${key}`
+}
+
+/**
+ * Returns a {@link MarkdownString} link to the given contact.
+ *
+ * Link format: `[<key>](contact://<key>)`
+ *
+ * @param target The {@link Contact} or contact key to target.
+ */
+export function contactLink(target: string | Contact | ContactData): string {
+  const key = typeof target === 'string' ? target : target.key
+  return `[${key}](${contactUri(target)})`
+}
+
+/**
+ * Returns the URI of the given zone that can be used in {@link MarkdownString} links.
+ *
+ * URI format: `zone://<key>`
+ *
+ * @param target The {@link Zone} or zone key to target.
+ */
+export function zoneUri(target: string | Zone | ZoneData): string {
   const key = typeof target === 'string' ? target : target.key
-  return `[badge:${key}]`
+  return `zone://${key}`
 }
 
 /**
- * Create a reference string that can be used in most text strings to display a link to the given map.
- * @param target The {@link GameMap} or map key to target.
+ * Returns a {@link MarkdownString} link to the given zone.
+ *
+ * Link format: `[<key>](zone://<key>)`
+ *
+ * @param target The {@link Zone} or zone key to target.
  */
-export function createMapReference(target: string | { key: string }): string {
+export function zoneLink(target: string | Zone | ZoneData): string {
   const key = typeof target === 'string' ? target : target.key
-  return `[map:${key}]`
+  return `[${key}](${zoneUri(target)})`
 }

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

@@ -0,0 +1,40 @@
+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-data.fixture.ts

@@ -1,6 +1,6 @@
 import { defineFixture } from 'efate'
 import { ALIGNMENT, BADGE_TYPE, BadgeData } from '../../main'
-import { badgePartialDataFixture } from './badge-partial-data.fixture'
+import { badgeRequirementDataFixture } from './badge-requirement-data.fixture'
 
 export const badgeDataFixture = defineFixture<BadgeData>((t) => {
   t.key.as(index => `badge-${index}`)
@@ -9,14 +9,16 @@ export const badgeDataFixture = defineFixture<BadgeData>((t) => {
   t.alignment.pickFrom([...ALIGNMENT])
   t.badgeText?.as(index => [{ value: `This is badge ${index}` }])
   t.acquisition?.asLoremIpsum()
-  t.icon?.asArray([{ value: 'https://nouri.org' }])
+  t.icon?.as(() => [{ value: 'https://nouri.org' }])
   t.notes?.asLoremIpsum()
-  t.links?.asArray([{ href: 'https://nouri.org' }])
-  t.mapKey?.asString()
-  t.loc?.asArray()
+  t.links?.as(() => [{ href: 'https://nouri.org' }])
+  t.zoneKey?.asString()
+  t.loc?.as(index => [index, index, index])
   t.vidiotMapKey?.asString()
-  t.setTitle?.asArray({ length: 2 })
+  t.setTitle?.as((index) => {
+    return { id: index }
+  })
   t.effect?.asString()
-  t.partials?.arrayOfFixture({ fixture: badgePartialDataFixture })
+  t.requirements?.as(() => [[badgeRequirementDataFixture]])
   t.ignoreInTotals?.asBoolean()
 })

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

@@ -0,0 +1,17 @@
+import { defineFixture } from 'efate'
+import { BADGE_REQUIREMENT_TYPE, BadgeRequirementData, ENHANCEMENT_CATEGORY, PLAQUE_TYPE } from '../../main'
+
+export const badgeRequirementDataFixture = defineFixture<BadgeRequirementData>((t) => {
+  t.key.as(index => `badge-requirement-${index}`)
+  t.type.pickFrom([...BADGE_REQUIREMENT_TYPE])
+  t.zoneKey?.asString()
+  t.loc?.as(index => [index, index, index])
+  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-requirement-type.test.ts

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

package/src/test/api/contact-data.fixture.ts

@@ -0,0 +1,13 @@
+import { defineFixture } from 'efate'
+import { ContactData } from '../../main'
+
+export const contactDataFixture = defineFixture<ContactData>((t) => {
+  t.key.as(index => `contact-${index}`)
+  t.name.as(index => [{ value: `Contact ${index}` }])
+  t.title?.as(index => [{ value: `Contact title ${index}` }])
+  t.zoneKey?.asString()
+  t.loc?.as(index => [index, index, index])
+  t.levelRange?.as(index => [index, index])
+  t.notes?.asLoremIpsum()
+  t.links?.as(() => [{ href: 'https://nouri.org' }])
+})

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

@@ -1,7 +1,7 @@
 import { defineFixture } from 'efate'
 import { Change, ContentBundle } from '../../main'
 import { archetypeDataFixture } from './archetype-data.fixture'
-import { gameMapDataFixture } from './game-map-data.fixture'
+import { zoneDataFixture } from './zone-data.fixture'
 import { badgeDataFixture } from './badge-data.fixture'
 
 export const contentBundleFixture = defineFixture<ContentBundle>((t) => {
@@ -10,7 +10,7 @@ export const contentBundleFixture = defineFixture<ContentBundle>((t) => {
   t.repository?.as(index => `https://nouri.org?id=${index}`)
   t.servers?.asArray()
   t.archetypes?.arrayOfFixture({ fixture: archetypeDataFixture })
-  t.maps?.arrayOfFixture({ fixture: gameMapDataFixture })
+  t.zones?.arrayOfFixture({ fixture: zoneDataFixture })
   t.badges?.arrayOfFixture({ fixture: badgeDataFixture })
   t.changelog?.arrayOfFixture({
     fixture: defineFixture<Change>((t) => {

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

@@ -7,7 +7,7 @@ export const TEST_BUNDLE: ContentBundle = {
   badges: [TEST_BADGE],
 }
 
-describe('ServerGroupData', () => {
+describe('ContentBundle', () => {
   test('should be a usable interface', () => {
     expect(TEST_BUNDLE).not.toBeUndefined()
   })

package/src/test/api/zone-data.fixture.ts

@@ -0,0 +1,8 @@
+import { ZoneData } from '../../main'
+import { defineFixture } from 'efate'
+
+export const zoneDataFixture = defineFixture<ZoneData>((t) => {
+  t.key.as(index => `zone-${index}`)
+  t.name.as(index => `Zone ${index}`)
+  t.links?.as(() => [{ href: 'https://nouri.org' }])
+})

package/src/test/db/alternates.test.ts

@@ -1,4 +1,4 @@
-import { Alternates } from '../../main/db/alternates'
+import { Alternates } from '../../main'
 
 describe(Alternates.name, () => {
   describe('Constructor', () => {
@@ -89,7 +89,7 @@ describe(Alternates.name, () => {
         { alignment: 'H', value: 'Hero' },
         { alignment: 'V', sex: 'M', value: 'Male Villain' },
         { alignment: 'P', sex: 'F', value: 'Praetorian Female' },
-      ]).default).toBe('Default')
+      ]).default?.value).toBe('Default')
 
       expect(new Alternates([
         { alignment: 'V', sex: 'M', value: 'Male Villain' },
@@ -97,14 +97,14 @@ describe(Alternates.name, () => {
         { sex: 'M', value: 'Male' },
         { value: 'Default' },
         { alignment: 'H', value: 'Hero' },
-      ]).default).toBe('Default')
+      ]).default?.value).toBe('Default')
 
       expect(new Alternates([
         { alignment: 'V', sex: 'M', value: 'Male Villain' },
         { alignment: 'P', sex: 'F', value: 'Praetorian Female' },
         { sex: 'M', value: 'Male' },
         { alignment: 'H', value: 'Hero' },
-      ]).default).toBe('Male')
+      ]).default?.value).toBe('Male')
     })
   })
 
@@ -118,64 +118,30 @@ describe(Alternates.name, () => {
         { alignment: 'H', sex: 'F', value: 'Female Hero' },
         { alignment: 'P', value: 'Praetorian' },
         { sex: 'F', value: 'Female' },
-        { alignment: 'H', sex: 'A', value: 'A Hero' },
-        { alignment: 'Y', sex: 'A', value: 'A Y' },
         { alignment: 'V', sex: 'M', value: 'Male Villain' },
-        { alignment: 'V', sex: 'B', value: 'B Villain' },
         { alignment: 'P', sex: 'M', value: 'Male Praetorian' },
         { alignment: 'H', value: 'Hero' },
-        { alignment: 'V', sex: 'A', value: 'A Villain' },
-        { sex: 'A', value: 'A Sex' },
-        { alignment: 'X', sex: 'F', value: 'Female X' },
         { alignment: 'H', sex: 'M', value: 'Male Hero' },
-        { alignment: 'X', value: 'X' },
-        { alignment: 'P', sex: 'B', value: 'B Praetorian' },
-        { alignment: 'P', sex: 'A', value: 'A Praetorian' },
-        { alignment: 'X', sex: 'M', value: 'Male X' },
         { sex: 'M', value: 'Male' },
-        { alignment: 'X', sex: 'B', value: 'B X' },
-        { alignment: 'H', sex: 'B', value: 'B Hero' },
         { alignment: 'V', value: 'Villain' },
-        { alignment: 'Y', sex: 'M', value: 'Male Y' },
         { alignment: 'V', sex: 'F', value: 'Female Villain' },
-        { sex: 'B', value: 'B Sex' },
-        { alignment: 'Y', sex: 'B', value: 'B Y' },
         { alignment: 'P', sex: 'F', value: 'Female Praetorian' },
-        { alignment: 'X', sex: 'A', value: 'A X' },
         { value: 'Default' },
-        { alignment: 'Y', sex: 'F', value: 'Female Y' },
       ]).canonical
 
       expect(result).toStrictEqual([
         { value: 'Default' },
         { sex: 'M', value: 'Male' },
         { sex: 'F', value: 'Female' },
-        { sex: 'A', value: 'A Sex' },
-        { sex: 'B', value: 'B Sex' },
         { alignment: 'H', value: 'Hero' },
         { alignment: 'V', value: 'Villain' },
         { alignment: 'P', value: 'Praetorian' },
-        { alignment: 'X', value: 'X' },
         { alignment: 'H', sex: 'M', value: 'Male Hero' },
         { alignment: 'H', sex: 'F', value: 'Female Hero' },
-        { alignment: 'H', sex: 'A', value: 'A Hero' },
-        { alignment: 'H', sex: 'B', value: 'B Hero' },
         { alignment: 'V', sex: 'M', value: 'Male Villain' },
         { alignment: 'V', sex: 'F', value: 'Female Villain' },
-        { alignment: 'V', sex: 'A', value: 'A Villain' },
-        { alignment: 'V', sex: 'B', value: 'B Villain' },
         { alignment: 'P', sex: 'M', value: 'Male Praetorian' },
         { alignment: 'P', sex: 'F', value: 'Female Praetorian' },
-        { alignment: 'P', sex: 'A', value: 'A Praetorian' },
-        { alignment: 'P', sex: 'B', value: 'B Praetorian' },
-        { alignment: 'X', sex: 'M', value: 'Male X' },
-        { alignment: 'X', sex: 'F', value: 'Female X' },
-        { alignment: 'X', sex: 'A', value: 'A X' },
-        { alignment: 'X', sex: 'B', value: 'B X' },
-        { alignment: 'Y', sex: 'M', value: 'Male Y' },
-        { alignment: 'Y', sex: 'F', value: 'Female Y' },
-        { alignment: 'Y', sex: 'A', value: 'A Y' },
-        { alignment: 'Y', sex: 'B', value: 'B Y' },
       ])
     })
 
@@ -191,41 +157,17 @@ describe(Alternates.name, () => {
       ])
     })
 
-    test('should sort identical values similarly', () => {
+    test('should sort identical values by value alpha', () => {
       expect(new Alternates([
-        { value: 'A' },
-        { value: 'B' },
-        { value: 'C' },
-        { value: 'B' },
-      ]).canonical).toStrictEqual([
-        { value: 'A' },
-        { value: 'B' },
-        { value: 'B' },
-        { value: 'C' },
-      ])
-    })
-
-    test('should sort unknown alignments by alpha', () => {
-      expect(new Alternates([
-        { alignment: 'A', value: 'A' },
-        { alignment: 'C', value: 'C' },
-        { alignment: 'B', value: 'B' },
-      ]).canonical).toStrictEqual([
-        { alignment: 'A', value: 'A' },
-        { alignment: 'B', value: 'B' },
-        { alignment: 'C', value: 'C' },
-      ])
-    })
-
-    test('should sort unknown sex by alpha', () => {
-      expect(new Alternates([
-        { sex: 'A', value: 'A' },
-        { sex: 'C', value: 'C' },
-        { sex: 'B', value: 'B' },
+        { alignment: 'V', value: 'B' },
+        { sex: 'M', value: 'D' },
+        { alignment: 'V', value: 'A' },
+        { sex: 'M', value: 'C' },
       ]).canonical).toStrictEqual([
-        { sex: 'A', value: 'A' },
-        { sex: 'B', value: 'B' },
-        { sex: 'C', value: 'C' },
+        { sex: 'M', value: 'C' },
+        { sex: 'M', value: 'D' },
+        { alignment: 'V', value: 'A' },
+        { alignment: 'V', value: 'B' },
       ])
     })
   })
@@ -233,9 +175,9 @@ describe(Alternates.name, () => {
   describe('toString', () => {
     test('should create a string separated by the separator', () => {
       expect(new Alternates([
-        { sex: 'A', value: 'A' },
-        { sex: 'B', value: 'B' },
-        { sex: 'C', value: 'C' },
+        { sex: 'M', value: 'A' },
+        { sex: 'F', value: 'B' },
+        { alignment: 'H', value: 'C' },
       ]).toString(', ')).toBe('A, B, C')
     })
   })