feat: add locationEncounterAreas/duplicate exposed endpoint functions

Author: Naramsim

dist/index.js

@@ -1,50 +1,51 @@
 [
-    ["getBerryByName", "berry"], 
-    ["getBerryFirmnessByName", "berry-firmness"], 
-    ["getBerryFlavorByName", "berry-flavor"], 
-    ["getContestTypeByName", "contest-type"], 
-    ["getContestEffectById", "contest-effect"], 
-    ["getSuperContestEffectById", "super-contest-effect"], 
-    ["getEncounterMethodByName", "encounter-method"], 
-    ["getEncounterConditionByName", "encounter-condition"], 
-    ["getEncounterConditionValueByName", "encounter-condition-value"], 
-    ["getEvolutionChainById", "evolution-chain"], 
-    ["getEvolutionTriggerByName", "evolution-trigger"], 
-    ["getGenerationByName", "generation"], 
-    ["getPokedexByName", "pokedex"], 
-    ["getVersionByName", "version"], 
-    ["getVersionGroupByName", "version-group"], 
-    ["getItemByName", "item"], 
-    ["getItemAttributeByName", "item-attribute"], 
-    ["getItemCategoryByName", "item-category"], 
-    ["getItemFlingEffectByName", "item-fling-effect"], 
-    ["getItemPocketByName", "item-pocket"], 
-    ["getMachineById", "machine"],
-    ["getMoveByName", "move"], 
-    ["getMoveAilmentByName", "move-ailment"], 
-    ["getMoveBattleStyleByName", "move-battle-style"], 
-    ["getMoveCategoryByName", "move-category"], 
-    ["getMoveDamageClassByName", "move-damage-class"], 
-    ["getMoveLearnMethodByName", "move-learn-method"], 
-    ["getMoveTargetByName", "move-target"], 
-    ["getLocationByName", "location"], 
-    ["getLocationAreaByName", "location-area"], 
-    ["getPalParkAreaByName", "pal-park-area"], 
-    ["getRegionByName", "region"], 
-    ["getAbilityByName", "ability"], 
-    ["getCharacteristicById", "characteristic"], 
-    ["getEggGroupByName", "egg-group"], 
-    ["getGenderByName", "gender"], 
-    ["getGrowthRateByName", "growth-rate"], 
-    ["getNatureByName", "nature"], 
-    ["getPokeathlonStatByName", "pokeathlon-stat"], 
-    ["getPokemonByName", "pokemon"], 
-    ["getPokemonColorByName", "pokemon-color"], 
-    ["getPokemonFormByName", "pokemon-form"], 
-    ["getPokemonHabitatByName", "pokemon-habitat"], 
-    ["getPokemonShapeByName", "pokemon-shape"], 
-    ["getPokemonSpeciesByName", "pokemon-species"], 
-    ["getStatByName", "stat"], 
-    ["getTypeByName", "type"], 
-    ["getLanguageByName", "language"]
+    ["getBerry", "name", "/berry/:id/"],
+    ["getBerryFirmness", "name", "/berry-firmness/:id/"],
+    ["getBerryFlavor", "name", "/berry-flavor/:id/"],
+    ["getContestType", "name", "/contest-type/:id/"],
+    ["getContestEffect", "id", "/contest-effect/:id/"],
+    ["getSuperContestEffect", "id", "/super-contest-effect/:id/"],
+    ["getEncounterMethod", "name", "/encounter-method/:id/"],
+    ["getEncounterCondition", "name", "/encounter-condition/:id/"],
+    ["getEncounterConditionValue", "name", "/encounter-condition-value/:id/"],
+    ["getEvolutionChain", "id", "/evolution-chain/:id/"],
+    ["getEvolutionTrigger", "name", "/evolution-trigger/:id/"],
+    ["getGeneration", "name", "/generation/:id/"],
+    ["getPokedex", "name", "/pokedex/:id/"],
+    ["getVersion", "name", "/version/:id/"],
+    ["getVersionGroup", "name", "/version-group/:id/"],
+    ["getItem", "name", "/item/:id/"],
+    ["getItemAttribute", "name", "/item-attribute/:id/"],
+    ["getItemCategory", "name", "/item-category/:id/"],
+    ["getItemFlingEffect", "name", "/item-fling-effect/:id/"],
+    ["getItemPocket", "name", "/item-pocket/:id/"],
+    ["getMachine", "id", "/machine/:id/"],
+    ["getMove", "name", "/move/:id/"],
+    ["getMoveAilment", "name", "/move-ailment/:id/"],
+    ["getMoveBattleStyle", "name", "/move-battle-style/:id/"],
+    ["getMoveCategory", "name", "/move-category/:id/"],
+    ["getMoveDamageClass", "name", "/move-damage-class/:id/"],
+    ["getMoveLearnMethod", "name", "/move-learn-method/:id/"],
+    ["getMoveTarget", "name", "/move-target/:id/"],
+    ["getLocation", "name", "/location/:id/"],
+    ["getLocationArea", "name", "/location-area/:id/"],
+    ["getPalParkArea", "name", "/pal-park-area/:id/"],
+    ["getRegion", "name", "/region/:id/"],
+    ["getAbility", "name", "/ability/:id/"],
+    ["getCharacteristic", "id", "/characteristic/:id/"],
+    ["getEggGroup", "name", "/egg-group/:id/"],
+    ["getGender", "name", "/gender/:id/"],
+    ["getGrowthRate", "name", "/growth-rate/:id/"],
+    ["getNature", "name", "/nature/:id/"],
+    ["getPokeathlonStat", "name", "/pokeathlon-stat/:id/"],
+    ["getPokemon", "name", "/pokemon/:id/"],
+    ["getPokemonEncounterAreas", "name", "/pokemon/:id/encounters/"],
+    ["getPokemonColor", "name", "/pokemon-color/:id/"],
+    ["getPokemonForm", "name", "/pokemon-form/:id/"],
+    ["getPokemonHabitat", "name", "/pokemon-habitat/:id/"],
+    ["getPokemonShape", "name", "/pokemon-shape/:id/"],
+    ["getPokemonSpecies", "name", "/pokemon-species/:id/"],
+    ["getStat", "name", "/stat/:id/"],
+    ["getType", "name", "/type/:id/"],
+    ["getLanguage", "name", "/language/:id/"]
 ]

src/endpoints.json

@@ -17,21 +17,23 @@ export class Pokedex {
 
         // add to Pokedex.prototype all our endpoint functions
         endpoints.forEach(endpoint => {
-            this[endpoint[0]] = input => { 
+            const endpointFullName = buildEndpointFullName(endpoint)
+            this[endpointFullName] = input => { 
                 if (input) {
 
                     // if the user has submitted a Name or an ID, return the JSON promise
                     if (typeof input === 'number' || typeof input === 'string') {
-                        return loadResource(this.config, `${this.config.versionPath}${endpoint[1]}/${input}/`) 
+                        return loadResource(this.config, `${this.config.versionPath}${endpoint[2].replace(':id', input)}`) 
                     }
-
+            
                     // if the user has submitted an Array
                     // return a new promise which will resolve when all loadResource calls are ended
                     else if (typeof input === 'object') {
                         return Promise.all(mapResources(this.config, endpoint, input))
                     }
                 }
             }
+            this[buildEndpointName(endpoint)] = this[endpointFullName]
         })
 
         rootEndpoints.forEach(rootEndpoint => {
@@ -78,8 +80,20 @@ export class Pokedex {
     }
 }
 
-function mapResources(config, endpoint, input) {
-    return input.map(res => {
-        return loadResource(config, `${config.versionPath}${endpoint[1]}/${res}/`)
+function mapResources(config, endpoint, inputs) {
+    return inputs.map(input => {
+        return loadResource(config, `${config.versionPath}${endpoint[2].replace(':id', input)}`)
     })
-}
+}
+
+function buildEndpointFullName(endpoint) {
+    return `${endpoint[0]}By${capitalize(endpoint[1])}`
+}
+
+function buildEndpointName(endpoint) {
+    return `${endpoint[0]}}`
+}
+
+function capitalize([first,...rest]) {
+    return first.toUpperCase() + rest.join('').toLowerCase()
+}

src/index.js

@@ -113,6 +113,18 @@ describe("pokedex", function () {
     });
   });
 
+  describe(".getPokemonEncounterAreasByName(Id: int)", function () {
+    before(function () {
+      promise = secureP.getPokemonEncounterAreasByName(id);
+    });
+    it("should succeed", function () {
+      return promise;
+    });
+    it("should be an array", function () {
+      return expect(promise).to.eventually.be.an("array");
+    });
+  });
+
   describe(".getVersionByName(Id: int)", function () {
     before(function () {
       promise = secureP.getVersionByName(id);