Add support for Bandle City and deck minimum version

Author: chrysomallos

package.json

@@ -1,6 +1,6 @@
 {
   "name": "runeterra",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Legends of Runeterra deck code encoder/decoder",
   "main": "src/index.js",
   "types": "index.d.ts",

src/Card.js

@@ -26,4 +26,8 @@ module.exports = class Card {
   get id () {
     return parseInt(this.code.substring(4, 7))
   }
+
+  get version () {
+    return Faction.getVersion(this.code.substring(2, 4))
+  }
 }

src/DeckEncoder.js

@@ -15,8 +15,12 @@ class DeckEncoder {
     }
 
     const firstByte = bytes.shift()
+    const format = firstByte >> 4
     const version = firstByte & 0xF
 
+    if (format !== DeckEncoder.FORMAT) {
+      throw new TypeError('The provided code does not match the required format.')
+    }
     if (version > DeckEncoder.MAX_KNOWN_VERSION) {
       throw new TypeError('The provided code requires a higher version of this library; please update.')
     }
@@ -65,7 +69,7 @@ class DeckEncoder {
 
     const grouped = DeckEncoder.GROUPS.map(i => this.groupByFactionAndSetSorted(cards.filter(c => c.count === i)))
     return Base32.encode([
-      0x11,
+      DeckEncoder.FORMAT << 4 | cards.reduce((p, c) => Math.max(p, c.version), 0) & 0xF,
       ...grouped.map(group => this.encodeGroup(group)).reduce((prev, curr) => [...prev, ...curr], []),
       ...this.encodeNofs(cards.filter(c => c.count > DeckEncoder.GROUPS[0]))
     ])
@@ -130,7 +134,9 @@ class DeckEncoder {
   }
 }
 
-DeckEncoder.MAX_KNOWN_VERSION = 3
+DeckEncoder.MAX_KNOWN_VERSION = 4
+DeckEncoder.FORMAT = 1
+DeckEncoder.INITIAL_VERSION = 1
 DeckEncoder.GROUPS = [3, 2, 1]
 
 module.exports = DeckEncoder

src/Faction.js

@@ -5,7 +5,7 @@ class Faction {
   }
 
   static fromCode (code) {
-    const factionId = Faction.FACTIONS[code]
+    const [factionId] = Faction.FACTIONS[code] || []
 
     if (factionId === undefined) {
       throw new TypeError('Invalid faction code. It is possible you need to upgrade the runeterra package.')
@@ -15,26 +15,37 @@ class Faction {
   }
 
   static fromID (id) {
-    const [shortCode, factionId] = Object.entries(Faction.FACTIONS).find(([, factionId]) => factionId === id) || []
+    const [shortCode, [factionId]] = Object.entries(Faction.FACTIONS).find(([, [factionId]]) => factionId === id) || [undefined, []]
 
     if (factionId === undefined) {
       throw new TypeError('Invalid faction id. It is possible you need to upgrade the runeterra package.')
     }
 
     return new this(shortCode, factionId)
   }
+
+  static getVersion (code) {
+    const [, version] = Faction.FACTIONS[code] || []
+
+    if (version === undefined) {
+      throw new TypeError('Invalid faction code. It is possible you need to upgrade the runeterra package.')
+    }
+
+    return version
+  }
 }
 
 Faction.FACTIONS = {
-  DE: 0,
-  FR: 1,
-  IO: 2,
-  NX: 3,
-  PZ: 4,
-  SI: 5,
-  BW: 6,
-  MT: 9,
-  SH: 7
+  DE: [0, 1],
+  FR: [1, 1],
+  IO: [2, 1],
+  NX: [3, 1],
+  PZ: [4, 1],
+  SI: [5, 1],
+  BW: [6, 2],
+  MT: [9, 2],
+  SH: [7, 3],
+  BC: [10, 4]
 }
 
 module.exports = Faction

test/deckCodesTestData.json

@@ -428,12 +428,19 @@
     ]
   },
   {
-    "code": "CEAQCBAHBIAQCBAHAMAAIAQAAICQGBQE",
+    "code": "CMAQCBAHBIAQCBAHAMAAIAQAAICQGBQE",
     "cards": [
       "3:04SH010",
       "2:04SH003",
       "4:02DE002",
       "5:03BW004"
     ]
+  },
+  {
+    "code": "CQAQEAIKBIKAAAA",
+    "cards": [
+      "3:01BC010",
+      "3:01BC020"
+    ]
   }
 ]

test/enconding.js

@@ -76,6 +76,18 @@ describe('Encoding/Decoding', () => {
     assert.deepStrictEqual(deck, decoded)
   })
 
+  it('should decode decks with bandle city cards', () => {
+    const deck = [
+      Card.fromCardString('3:05BC009'),
+      Card.fromCardString('3:04SH003'),
+      Card.fromCardString('3:02DE002'),
+      Card.fromCardString('3:03BW004')
+    ]
+    const code = DeckEncoder.encode(deck)
+    const decoded = DeckEncoder.decode(code)
+    assert.deepStrictEqual(deck, decoded)
+  })
+
   it('should decode large decks', () => {
     const deck = [
       Card.fromCardString('3:01DE002'),