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

package/src/test/db/badge-index.test.ts

@@ -1,12 +1,6 @@
 import { badgeDataFixture } from '../api/badge-data.fixture'
-import { Badge, BadgeIndex, GameMap } from '../../main'
-import { gameMapDataFixture } from '../api/game-map-data.fixture'
-
-const TEST_MAPS = [
-  new GameMap(gameMapDataFixture.create({ key: 'atlas-park', name: 'Atlas Park' })),
-  new GameMap(gameMapDataFixture.create({ key: 'perez-park', name: 'Perez Park' })),
-  new GameMap(gameMapDataFixture.create({ key: 'abandoned-sewer-network', name: 'Abandoned Sewer Network' })),
-]
+import { Badge, BadgeIndex } from '../../main'
+import { badgeRequirementDataFixture } from '../api/badge-requirement-data.fixture'
 
 describe(BadgeIndex.name, () => {
   describe('Constructor', () => {
@@ -26,8 +20,12 @@ describe(BadgeIndex.name, () => {
       expect(new BadgeIndex(data).getBadge('foo')).not.toBeUndefined()
     })
 
-    test(`should throw error for unknown badge`, () => {
-      expect(() => new BadgeIndex([]).getBadge('foo')).toThrow('Unknown badge key [foo]')
+    test(`should return undefined for unknown badge`, () => {
+      expect(new BadgeIndex([]).getBadge('foo')).toBeUndefined()
+    })
+
+    test(`should return undefined for undefined key`, () => {
+      expect(new BadgeIndex([]).getBadge()).toBeUndefined()
     })
   })
 
@@ -116,10 +114,10 @@ describe(BadgeIndex.name, () => {
 
       test(`should match on setTitle`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'match-1', setTitle: { id: 123 } })),
-          new Badge(badgeDataFixture.create({ key: 'match-2', setTitle: { id: 456, praetorianId: 123 } })),
-          new Badge(badgeDataFixture.create({ key: 'miss-1', setTitle: { id: 456 } })),
-          new Badge(badgeDataFixture.create({ key: 'miss-2', setTitle: undefined })),
+          new Badge(badgeDataFixture.create({ key: 'match-1', setTitleId: [123] })),
+          new Badge(badgeDataFixture.create({ key: 'match-2', setTitleId: [456, 123] })),
+          new Badge(badgeDataFixture.create({ key: 'miss-1', setTitleId: [456] })),
+          new Badge(badgeDataFixture.create({ key: 'miss-2', setTitleId: undefined })),
         ]
 
         const result = new BadgeIndex(data).searchBadges({ query: { str: '123', on: { setTitle: true } } })
@@ -185,45 +183,50 @@ describe(BadgeIndex.name, () => {
 
       test(`should filter on badge type`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', type: 'EXPLORATION' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', type: 'EXPLORATION' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', type: 'HISTORY' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-4', type: 'HISTORY' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-5', type: 'ACCOLADE' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-6', type: 'ACCOLADE' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', type: 'exploration' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', type: 'exploration' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', type: 'history' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4', type: 'history' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-5', type: 'accolade' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-6', type: 'accolade' })),
         ]
 
-        const result = new BadgeIndex(data).searchBadges({ filter: { type: 'HISTORY' } })
+        const result = new BadgeIndex(data).searchBadges({ filter: { type: 'history' } })
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-3', 'badge-4'])
       })
 
-      test(`should filter on badge type`, () => {
+      test(`should filter on badge zone`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', mapKey: 'abandoned-sewer-network' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-4', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-5', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-6', mapKey: undefined })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', requirements: [{ location: { zoneKey: 'perez-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', requirements: [{ location: { zoneKey: 'abandoned-sewer-network' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({
+            key: 'badge-5', requirements: [
+              badgeRequirementDataFixture.create({ location: { zoneKey: 'atlas-park' } }),
+              badgeRequirementDataFixture.create({ location: { zoneKey: 'perez-park' } }),
+            ],
+          })),
+          new Badge(badgeDataFixture.create({ key: 'badge-6', requirements: [{ location: undefined }] })),
         ]
 
-        const result = new BadgeIndex(data).searchBadges({ filter: { mapKey: 'perez-park' } })
+        const result = new BadgeIndex(data).searchBadges({ filter: { zoneKey: 'perez-park' } })
         const keys = result.items.map(x => x.key)
-        expect(keys).toStrictEqual(['badge-2', 'badge-5'])
+        expect(keys).toStrictEqual(['badge-2'])
       })
 
-      test(`should filter on badge type`, () => {
+      test(`should filter on alignment`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', alignment: ['H'] })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', alignment: ['V'] })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', alignment: ['P'] })),
-          new Badge(badgeDataFixture.create({ key: 'badge-4', alignment: ['H', 'V'] })),
-          new Badge(badgeDataFixture.create({ key: 'badge-5', alignment: ['V', 'P'] })),
-          new Badge(badgeDataFixture.create({ key: 'badge-6', alignment: ['H', 'V', 'P'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', morality: ['hero'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', morality: ['villain'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', morality: ['loyalist'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4', morality: ['hero', 'villain'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-5', morality: ['villain', 'loyalist'] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-6', morality: ['hero', 'villain', 'loyalist'] })),
         ]
 
-        const result = new BadgeIndex(data).searchBadges({ filter: { alignment: 'H' } })
+        const result = new BadgeIndex(data).searchBadges({ filter: { morality: 'hero' } })
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-1', 'badge-4', 'badge-6'])
       })
@@ -359,6 +362,26 @@ describe(BadgeIndex.name, () => {
         const result = new BadgeIndex(data).searchBadges()
         expect(result.totalPages).toBe(1)
       })
+
+      test(`should return the last page if a page is requested past the max`, () => {
+        const data = [
+          new Badge(badgeDataFixture.create({ key: 'badge-1' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-5' })),
+        ]
+
+        const result = new BadgeIndex(data).searchBadges({ pageSize: 2, page: 10 })
+        const keys = result.items.map(x => x.key)
+        expect(keys).toStrictEqual(['badge-5'])
+        expect(result.page).toBe(3)
+      })
+
+      test(`should return the first page if a page is requested lower than 1`, () => {
+        const result = new BadgeIndex([]).searchBadges({ page: -10 })
+        expect(result.page).toBe(1)
+      })
     })
 
     describe('sort', () => {
@@ -370,7 +393,21 @@ describe(BadgeIndex.name, () => {
           new Badge(badgeDataFixture.create({ key: 'badge-4' })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges()
+        const result = new BadgeIndex(data).searchBadges()
+
+        const keys = result.items.map(x => x.key)
+        expect(keys).toStrictEqual(['badge-1', 'badge-2', 'badge-3', 'badge-4'])
+      })
+
+      test(`should not modify sort if order is canonical`, () => {
+        const data = [
+          new Badge(badgeDataFixture.create({ key: 'badge-1' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4' })),
+        ]
+
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'canonical' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-1', 'badge-2', 'badge-3', 'badge-4'])
@@ -384,7 +421,7 @@ describe(BadgeIndex.name, () => {
           new Badge(badgeDataFixture.create({ key: 'badge-4' })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { dir: 'DESC' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { dir: 'desc' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-4', 'badge-3', 'badge-2', 'badge-1'])
@@ -397,7 +434,7 @@ describe(BadgeIndex.name, () => {
           new Badge(badgeDataFixture.create({ key: 'badge-3', name: [{ value: 'AAB' }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'BADGE_NAME' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'badge-name' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-3', 'badge-1', 'badge-2'])
@@ -410,7 +447,7 @@ describe(BadgeIndex.name, () => {
           new Badge(badgeDataFixture.create({ key: 'badge-3', name: [{ value: 'AAB' }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'BADGE_NAME', dir: 'DESC' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'badge-name', dir: 'desc' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-2', 'badge-1', 'badge-3'])
@@ -423,62 +460,67 @@ describe(BadgeIndex.name, () => {
           new Badge(badgeDataFixture.create({ key: 'badge-3', name: [{ value: 'AAB' }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'BADGE_NAME' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'badge-name' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-3', 'badge-1', 'badge-2'])
       })
 
-      test(`should sort by map name`, () => {
+      test(`should sort by zone name`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', mapKey: 'abandoned-sewer-network' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', requirements: [{ location: { zoneKey: 'perez-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', requirements: [{ location: { zoneKey: 'abandoned-sewer-network' } }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'MAP_NAME' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'zone-key' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-3', 'badge-1', 'badge-2'])
       })
 
-      test(`should sort by map name descending`, () => {
+      test(`should sort by zone name descending`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', mapKey: 'abandoned-sewer-network' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', requirements: [{ location: { zoneKey: 'perez-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', requirements: [{ location: { zoneKey: 'abandoned-sewer-network' } }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'MAP_NAME', dir: 'DESC' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'zone-key', dir: 'desc' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-2', 'badge-1', 'badge-3'])
       })
 
-      test(`should maintain canonical as secondary sort when sorting by map name`, () => {
+      test(`should maintain canonical as secondary sort when sorting by zone name`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-4', mapKey: 'abandoned-sewer-network' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', requirements: [{ location: { zoneKey: 'perez-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-4', requirements: [{ location: { zoneKey: 'abandoned-sewer-network' } }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'MAP_NAME' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'zone-key' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-4', 'badge-1', 'badge-3', 'badge-2'])
       })
 
-      test(`should sort unknown map names to the end`, () => {
+      test(`should sort undefined or multiple zone names to the end`, () => {
         const data = [
-          new Badge(badgeDataFixture.create({ key: 'badge-1', mapKey: 'atlas-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-2', mapKey: 'unknown' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-3', mapKey: 'perez-park' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-4', mapKey: 'unexpected' })),
-          new Badge(badgeDataFixture.create({ key: 'badge-5', mapKey: 'abandoned-sewer-network' })),
+          new Badge(badgeDataFixture.create({ key: 'badge-1', requirements: [{ location: { zoneKey: 'atlas-park' } }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-2', requirements: [{ location: undefined }] })),
+          new Badge(badgeDataFixture.create({ key: 'badge-3', requirements: [{ location: { zoneKey: 'perez-park' } }] })),
+          new Badge(badgeDataFixture.create({
+            key: 'badge-4', requirements: [
+              badgeRequirementDataFixture.create({ location: { zoneKey: 'atlas-park' } }),
+              badgeRequirementDataFixture.create({ location: { zoneKey: 'perez-park' } }),
+            ],
+          })),
+          new Badge(badgeDataFixture.create({ key: 'badge-5', requirements: [{ location: { zoneKey: 'abandoned-sewer-network' } }] })),
         ]
 
-        const result = new BadgeIndex(data, TEST_MAPS).searchBadges({ sort: { by: 'MAP_NAME' } })
+        const result = new BadgeIndex(data).searchBadges({ sort: { by: 'zone-key' } })
 
         const keys = result.items.map(x => x.key)
         expect(keys).toStrictEqual(['badge-5', 'badge-1', 'badge-3', 'badge-2', 'badge-4'])

package/src/test/db/badge-requirement.test.ts

@@ -0,0 +1,145 @@
+import { BadgeRequirement } from '../../main'
+import { badgeRequirementDataFixture } from '../api/badge-requirement-data.fixture'
+
+describe(BadgeRequirement.name, () => {
+  describe('Constructor', () => {
+    test('should accept the test fixture', () => {
+      new BadgeRequirement(badgeRequirementDataFixture.create())
+    })
+  })
+
+  describe('key', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ key: 'foo' }))
+      expect(requirement.key).toEqual('foo')
+    })
+  })
+
+  describe('type', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ type: 'badge' }))
+      expect(requirement.type).toEqual('badge')
+    })
+  })
+
+  describe('location', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ location: { zoneKey: 'foo', coords: [1, 2, 3] } }))
+      expect(requirement.location).toStrictEqual([{ zoneKey: 'foo', coords: [1, 2, 3] }])
+    })
+
+    test('should accept an array', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({
+        location: [
+          { zoneKey: 'foo', coords: [1, 2, 3] },
+          { zoneKey: 'bar', coords: [4, 5, 6] },
+        ],
+      }))
+      expect(requirement.location).toStrictEqual([
+        { zoneKey: 'foo', coords: [1, 2, 3] },
+        { zoneKey: 'bar', coords: [4, 5, 6] },
+      ])
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('location').create())
+      expect(requirement.location).toBeUndefined()
+    })
+  })
+
+  describe('badgeKey', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ badgeKey: 'foo' }))
+      expect(requirement.badgeKey).toEqual('foo')
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('badgeKey').create())
+      expect(requirement.badgeKey).toBeUndefined()
+    })
+  })
+
+  describe('missionKey', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ missionKey: 'foo' }))
+      expect(requirement.missionKey).toEqual('foo')
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('missionKey').create())
+      expect(requirement.missionKey).toBeUndefined()
+    })
+  })
+
+  describe('monumentText', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ monumentText: 'foo' }))
+      expect(requirement.monumentText).toEqual('foo')
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('monumentText').create())
+      expect(requirement.monumentText).toBeUndefined()
+    })
+  })
+
+  describe('inventionLevel', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ inventionLevel: 10 }))
+      expect(requirement.inventionLevel).toEqual(10)
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('inventionLevel').create())
+      expect(requirement.inventionLevel).toBeUndefined()
+    })
+  })
+
+  describe('inventionTypes', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ inventionTypes: ['accuracy', 'confuse'] }))
+      expect(requirement.inventionTypes).toStrictEqual(['accuracy', 'confuse'])
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('inventionTypes').create())
+      expect(requirement.inventionTypes).toBeUndefined()
+    })
+  })
+
+  describe('count', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ count: 5 }))
+      expect(requirement.count).toEqual(5)
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('count').create())
+      expect(requirement.count).toBeUndefined()
+    })
+  })
+
+  describe('notes', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ notes: 'some notes' }))
+      expect(requirement.notes).toEqual('some notes')
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('notes').create())
+      expect(requirement.notes).toBeUndefined()
+    })
+  })
+
+  describe('links', () => {
+    test('should be set from the data', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.create({ links: [{ title: 'foo', href: 'bar' }] }))
+      expect(requirement.links).toStrictEqual([{ title: 'foo', href: 'bar' }])
+    })
+
+    test('should be optional', () => {
+      const requirement = new BadgeRequirement(badgeRequirementDataFixture.omit('links').create())
+      expect(requirement.links).toHaveLength(0)
+    })
+  })
+})