feat: rewrite API to version 6 #516
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: The following queries have been removed `getAbilityByFuzzy`, `getAbilityByName`, `getDexEntries`, `getDexEntryBySpeciesName`, `getDexEntryByDexNumber`, `getItemByFuzzy`, `getItemByName`, `getMoveByFuzzy`, `getMoveByName`, `getTypeByName`
favna
added a commit
that referenced
this pull request
Sep 19, 2021
feat: `getFuzzy*` queries can now return multiple results that match the fuzzy query. By default only 1 result is returned. You can modify this by passing the `take` parameter. Furthermore you can provide the `offset` parameter to skip that many items from the start, and the `reverse` parameter to reverse the array before applying `take` and `offset`.
feat: added the missing type-specific hidden powers
fix: also return base Pokémon data for `getLearnset` when only requesting `backSprite` and/or `shinyBackSprite`
fix: fixed `hidden power` being marked as a water type move
fix: fixed the `basePower` for the moves `frustration` and `return`
fix: fixed the `cosmeticFormes` for `flabébé`
fix: fixed the `version_id` (game) for Missingno's flavour text
fix: fixed the `zMovePower` for the moves `frustration`, `return`, `seismic toss`, and `night shade`
fix: fixed the bulbapedia URL for nidoran-female
fix: fixed the bulbapedia URL for nidoran-male
fix: fixed the quotes used in the flavour texts
fix: fixed the registered name for `gengargmax`
fix: fixed the way prefixed fuzzy queries are parsed. It is now possible to prefix with `galarian`, `alolan`, and `gigantamax` alongside their respective values of `galar`, `alola` and `gmax`.
fix: fixed various text issues in flavour texts, in particular garbled characters being in the place of the common `é` character
fix: when a move's z-move power cannot be computed the value of `0` is now returned, as opposed to `Infinity`, which would cause an error.
BREAKING CHANGE: removed `DexEntry.evos` property, if you want to get just the evolution names use `evolutions { species }`
BREAKING CHANGE: removed `DexEntry.prevo` property, if you want to get just the evolution names use `preevolutions { species }`
BREAKING CHANGE: removed `DexEntry` structure, most of its properties are merged into `DexDetails`
BREAKING CHANGE: removed `getAbilityByFuzzy`
BREAKING CHANGE: removed `getAbilityByName`
BREAKING CHANGE: removed `getDexEntries`
BREAKING CHANGE: removed `getDexEntryByDexNumber`
BREAKING CHANGE: removed `getDexEntryBySpeciesName`
BREAKING CHANGE: removed `getItemByFuzzy`
BREAKING CHANGE: removed `getItemByName`
BREAKING CHANGE: removed `getMoveByFuzzy`
BREAKING CHANGE: removed `getMoveByName`
BREAKING CHANGE: removed `getTypeByName`
BREAKING CHANGE: removed `take`, `skip` and `reverse` from `getPokemon`. They are renamed to `takeFlavorTexts` (default: 1), `offsetFlavorTexts` (default: 0), and `reverseFlavorTexts` (default: true)
BREAKING CHANGE: renamed `Abilities` enum to `AbilitiesEnum`
BREAKING CHANGE: renamed `AbilityPaginatedArgs` to `FuzzyAbilityArgs`
BREAKING CHANGE: renamed `ExactPokemonPaginatedArgs` to `PokemonArgs`
BREAKING CHANGE: renamed `getAbilityDetailsByFuzzy` to `getFuzzyAbility`
BREAKING CHANGE: renamed `getAbilityDetailsByName` to `getAbility`
BREAKING CHANGE: renamed `getItemDetailsByFuzzy` to `getFuzzyItem`
BREAKING CHANGE: renamed `getItemDetailsByName` to `getItem`
BREAKING CHANGE: renamed `getMoveDetailsByFuzzy` to `getFuzzyMove`
BREAKING CHANGE: renamed `getMoveDetailsByName` to `getMove`
BREAKING CHANGE: renamed `getPokemonDetails` to `getPokemon`
BREAKING CHANGE: renamed `getPokemonDetailsByFuzzy` to `getFuzzyPokemon`
BREAKING CHANGE: renamed `getPokemonDetailsByName` to `getPokemonByName` and `getPokemonBySpecies`
BREAKING CHANGE: renamed `getPokemonDetailsByNumber` to `getPokemonByDexNumber`
BREAKING CHANGE: renamed `getPokemonLearnset` to `getLearnset`
BREAKING CHANGE: renamed `getPokemonLearnsetByFuzzy` to `getFuzzyLearnset`
BREAKING CHANGE: renamed `ItemPaginatedArgs` to `FuzzyItemArgs`
BREAKING CHANGE: renamed `Items` enum to `ItemsEnum`
BREAKING CHANGE: renamed `LearnsetFuzzyArgs` to `FuzzyLearnsetArgs`
BREAKING CHANGE: renamed `MovePaginatedArgs` to `FuzzyMoveArgs`
BREAKING CHANGE: renamed `Moves` enum to `MovesEnum`
BREAKING CHANGE: renamed `Pokemon` enum to `PokemonEnum`
BREAKING CHANGE: renamed `PokemonNumberPaginatedArgs` to `PokemonNumberArgs`
BREAKING CHANGE: renamed `PokemonPaginatedArgs` to `FuzzyPokemonArgs`
BREAKING CHANGE: renamed `Types` enum to `TypesEnum`
BREAKING CHANGE: renamed the `skip` parameter for all `getFuzzy*` queries has been renamed to `offset` to better represent what it does.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
feat: rewrite API to version 6
feat:
getFuzzy*queries can now return multiple results that match the fuzzy query. By default only 1 result is returned. You can modify this by passing thetakeparameter. Furthermore you can provide theoffsetparameter to skip that many items from the start, and thereverseparameter to reverse the array before applyingtakeandoffset.feat: added the missing type-specific hidden powers
fix: also return base Pokémon data for
getLearnsetwhen only requestingbackSpriteand/orshinyBackSpritefix: fixed
hidden powerbeing marked as a water type movefix: fixed the
basePowerfor the movesfrustrationandreturnfix: fixed the
cosmeticFormesforflabébéfix: fixed the
version_id(game) for Missingno's flavour textfix: fixed the
zMovePowerfor the movesfrustration,return,seismic toss, andnight shadefix: fixed the bulbapedia URL for nidoran-female
fix: fixed the bulbapedia URL for nidoran-male
fix: fixed the quotes used in the flavour texts
fix: fixed the registered name for
gengargmaxfix: fixed the way prefixed fuzzy queries are parsed. It is now possible to prefix with
galarian,alolan, andgigantamaxalongside their respective values ofgalar,alolaandgmax.fix: fixed various text issues in flavour texts, in particular garbled characters being in the place of the common
écharacterfix: when a move's z-move power cannot be computed the value of
0is now returned, as opposed toInfinity, which would cause an error.BREAKING CHANGE: removed
DexEntry.evosproperty, if you want to get just the evolution names useevolutions { species }BREAKING CHANGE: removed
DexEntry.prevoproperty, if you want to get just the evolution names usepreevolutions { species }BREAKING CHANGE: removed
DexEntrystructure, most of its properties are merged intoDexDetailsBREAKING CHANGE: removed
getAbilityByFuzzyBREAKING CHANGE: removed
getAbilityByNameBREAKING CHANGE: removed
getDexEntriesBREAKING CHANGE: removed
getDexEntryByDexNumberBREAKING CHANGE: removed
getDexEntryBySpeciesNameBREAKING CHANGE: removed
getItemByFuzzyBREAKING CHANGE: removed
getItemByNameBREAKING CHANGE: removed
getMoveByFuzzyBREAKING CHANGE: removed
getMoveByNameBREAKING CHANGE: removed
getTypeByNameBREAKING CHANGE: removed
take,skipandreversefromgetPokemon. They are renamed totakeFlavorTexts(default: 1),offsetFlavorTexts(default: 0), andreverseFlavorTexts(default: true)BREAKING CHANGE: renamed
Abilitiesenum toAbilitiesEnumBREAKING CHANGE: renamed
AbilityPaginatedArgstoFuzzyAbilityArgsBREAKING CHANGE: renamed
ExactPokemonPaginatedArgstoPokemonArgsBREAKING CHANGE: renamed
getAbilityDetailsByFuzzytogetFuzzyAbilityBREAKING CHANGE: renamed
getAbilityDetailsByNametogetAbilityBREAKING CHANGE: renamed
getItemDetailsByFuzzytogetFuzzyItemBREAKING CHANGE: renamed
getItemDetailsByNametogetItemBREAKING CHANGE: renamed
getMoveDetailsByFuzzytogetFuzzyMoveBREAKING CHANGE: renamed
getMoveDetailsByNametogetMoveBREAKING CHANGE: renamed
getPokemonDetailstogetPokemonBREAKING CHANGE: renamed
getPokemonDetailsByFuzzytogetFuzzyPokemonBREAKING CHANGE: renamed
getPokemonDetailsByNametogetPokemonByNameandgetPokemonBySpeciesBREAKING CHANGE: renamed
getPokemonDetailsByNumbertogetPokemonByDexNumberBREAKING CHANGE: renamed
getPokemonLearnsettogetLearnsetBREAKING CHANGE: renamed
getPokemonLearnsetByFuzzytogetFuzzyLearnsetBREAKING CHANGE: renamed
ItemPaginatedArgstoFuzzyItemArgsBREAKING CHANGE: renamed
Itemsenum toItemsEnumBREAKING CHANGE: renamed
LearnsetFuzzyArgstoFuzzyLearnsetArgsBREAKING CHANGE: renamed
MovePaginatedArgstoFuzzyMoveArgsBREAKING CHANGE: renamed
Movesenum toMovesEnumBREAKING CHANGE: renamed
Pokemonenum toPokemonEnumBREAKING CHANGE: renamed
PokemonNumberPaginatedArgstoPokemonNumberArgsBREAKING CHANGE: renamed
PokemonPaginatedArgstoFuzzyPokemonArgsBREAKING CHANGE: renamed
Typesenum toTypesEnumBREAKING CHANGE: renamed the
skipparameter for allgetFuzzy*queries has been renamed tooffsetto better represent what it does.