minecraft-data 2.117.0 → 2.117.1

package/doc/history.md

@@ -1,3 +1,6 @@
+## 2.117.1
+* Add support for custom supportFeature return type
+
 ## 2.117.0
 * update mcdata
 

package/index.js

@@ -55,7 +55,8 @@ module.exports = function (mcVersion, preNetty) {
 
   const majorVersion = toMajor(mcVersion, preNetty)
   if (majorVersion == null) { return null }
-  if (cache[majorVersion.type + '_' + majorVersion.majorVersion]) { return cache[majorVersion.type + '_' + majorVersion.majorVersion] }
+  const cachedName = `${majorVersion.type}_${majorVersion.majorVersion}_${majorVersion.dataVersion}`
+  if (cache[cachedName]) { return cache[cachedName] }
   const mcData = data[majorVersion.type][majorVersion.majorVersion]
   if (mcData == null) { return null }
   const nmcData = mcDataToNode(mcData)
@@ -63,8 +64,8 @@ module.exports = function (mcVersion, preNetty) {
   nmcData.isNewerOrEqualTo = version => nmcData.version['>='](version)
   nmcData.isOlderThan = version => nmcData.version['<'](version)
   nmcData.version = Object.assign(majorVersion, nmcData.version)
-  cache[majorVersion.type + '_' + majorVersion.majorVersion] = nmcData
-  nmcData.supportFeature = feature => supportFeature(feature, nmcData.version.minecraftVersion)
+  cache[cachedName] = nmcData
+  nmcData.supportFeature = feature => supportFeature(feature, nmcData.version)
   return nmcData
 }
 

package/lib/supportsFeature.js

@@ -1,31 +1,63 @@
 const features = require('../minecraft-data/data/pc/common/features.json')
-
-const versions = {
-  pc: require('../minecraft-data/data/pc/common/protocolVersions.json'),
-  bedrock: require('../minecraft-data/data/bedrock/common/protocolVersions.json')
-}
-const versionList = versions.pc
-const versionToIndex = Object.fromEntries(versionList.map((version, i) => [version.minecraftVersion, versionList.length - i]))
 const nameToFeature = Object.fromEntries(features.map(feature => [feature.name, feature]))
 
-module.exports = (featureName, minecraftVersion) => {
+function isFeatureInRange (featureName, versionObj) {
   const feature = nameToFeature[featureName]
   if (feature === undefined) {
     throw new Error(`Feature ${feature} doesn't exist`)
   }
 
-  const currentVer = versionToIndex[minecraftVersion]
-  const minVer = versionToIndex[feature.versions[0]]
-  const maxVer = versionToIndex[feature.versions[1]]
-  if (currentVer === undefined) {
-    throw new Error(`Version ${minecraftVersion} doesn't exist`)
+  if (feature.values) {
+    for (const { value, versions, version } of feature.values) { // we're using feature.version
+      if (version) {
+        const ver = version.replace('_major', '')
+        if (!/^\d\.\d+$/.test(ver)) {
+          throw new Error(`Not a correct major version value, instead the version is: "${version}"`)
+        }
+        if (versionObj.majorVersion === ver) {
+          return value
+        }
+      } else { // we're using feature.versions
+        const [minVer, maxVer] = versions
+        if (isVersionInRange(minVer, versionObj, maxVer)) {
+          return value
+        }
+      }
+    }
+    return null // if we didn't match anything, return null
+  } else {
+    const [minVer, maxVer] = feature.versions
+    return isVersionInRange(minVer, versionObj, maxVer)
+  }
+}
+
+function isVersionInRange (minVer, versionObj, maxVer) {
+  let inRange = true
+  const { majorVersion } = versionObj
+  if (minVer.endsWith('_major')) {
+    const ver = removeMajorSuffix(minVer)
+    inRange = inRange && getVersionObj(majorVersion)['>='](ver)
+  } else {
+    inRange = inRange && versionObj['>='](minVer)
   }
-  if (minVer === undefined) {
-    throw new Error(`Version ${feature.versions[0]} doesn't exist`)
+  if (maxVer === 'latest') { // no need to check upper bound if upperbound is latest
+    return inRange
   }
-  if (maxVer === undefined) {
-    throw new Error(`Version ${feature.versions[1]} doesn't exist`)
+  if (maxVer.endsWith('_major')) {
+    const ver = removeMajorSuffix(maxVer)
+    inRange = inRange && getVersionObj(majorVersion)['<='](ver)
+  } else {
+    inRange = inRange && versionObj['<='](maxVer)
   }
+  return inRange
+}
+
+function removeMajorSuffix (verStr) {
+  return verStr.replace('_major', '')
+}
 
-  return minVer <= currentVer && currentVer <= maxVer
+function getVersionObj (ver) {
+  return require('minecraft-data')(ver).version
 }
+
+module.exports = isFeatureInRange

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minecraft-data",
-  "version": "2.117.0",
+  "version": "2.117.1",
   "description": "Provide easy access to minecraft data in node.js",
   "main": "index.js",
   "tonicExampleFilename": "example.js",

package/test/load.js

@@ -44,3 +44,32 @@ describe('versions with block data have block state IDs', () => {
     assert(oks > 0)
   })
 })
+
+describe('supportFeature', () => {
+  it('dimensionIsAnInt is only accessible in 1.8 - 1.15.2', () => {
+    const mcData1Dot9 = require('minecraft-data')('1.9')
+    const mcData1Dot17 = require('minecraft-data')('1.17')
+    assert.equal(mcData1Dot9.supportFeature('dimensionIsAnInt'), true)
+    assert.equal(mcData1Dot17.supportFeature('dimensionIsAnInt'), false)
+  })
+
+  it('metadataIxOfItem works right', () => {
+    const assertions = {
+      1.18: 8,
+      1.17: 8,
+      '1.16.1': 7,
+      1.16: 7,
+      1.15: 7,
+      '1.13.2': 6,
+      '1.10': 6,
+      '1.9.1': 5,
+      1.9: 5,
+      1.8: 8
+    }
+    for (const [k, v] of Object.entries(assertions)) {
+      const mcData = require('minecraft-data')(k)
+      const newVal = mcData.supportFeature('metadataIxOfItem')
+      assert.equal(newVal, v, `Failed on mc version ${k} | Expected: ${v}, Got: ${newVal}`)
+    }
+  })
+})