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

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 @@
-import { MarkdownString } from './markdown-string'
-
-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.
-   */
-  readonly notes?: MarkdownString
-
-  /**
-   * 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/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,39 +0,0 @@
-import { VidiotMapPointOfInterestData } from '../api/vidiot-map-point-of-interest-data'
-import { MarkdownString } from '../api/markdown-string'
-
-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.
-   */
-  readonly notes?: MarkdownString
-
-  /**
-   * 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.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-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 })
-})