favware / graphql-pokemon Goto Github PK

The code should really be unit tested tbh

Please describe the problem you are having in as much detail as possible:

Sprites are missing the .gif extension thus resulting in invalid URLs

Include a reproducible code sample here, if possible:

fragment dexdetails on DexDetails {
  num species types
  abilities { first second hidden special }
  baseStats { hp attack defense specialattack specialdefense speed }
  gender { male female special }
  color eggGroups evolutionLevel evos prevo forme formeLetter
  height weight baseForme baseSpecies otherFormes
  sprite shinySprite smogonTier
  bulbapediaPage serebiiPage smogonPage
  flavorTexts { game flavor }
}

fragment evolutions on DexDetails {
  evolutions { ...dexdetails }
  preevolutions { ...dexdetails }
}

{
  getPokemonDetails(pokemon:melmetal) {
    ...dexdetails
    ...evolutions
  }
}

Further details:

• version: 1.0.1
• Node.js version: 12-LTS
• Operating system: Windows
• Priority this issue should have – please be realistic and elaborate if possible: Critical

• I have also tested the issue on latest master, commit hash: 97bb3ed

Is your feature request related to a problem? Please describe.

This is less a feature request than a proposition. I have implemented a documentation generator for GraphQL called Magidoc, and I am trying to bring this into open source projects in order to get some feedback and get the user-base to grow. I came across your project in my research.

Describe the solution you'd like

Basically, I noticed you didn't have Github pages set up yet, so I propose to implement an auto-generated GraphQL documentation for this project that would be hosted directly into the Github Pages. This could contain an auto-generated API Reference and whatever else you like in fact.

I don't mind doing the whole thing and opening a PR, or letting you try it out and give me feedback about what you liked and disliked.

In the end, it's just a proposition, so no pressure at all if you're not interested. Thank you!

Is your feature request related to a problem? Please describe.

With v1.0.0 all fields are always returned because they are returned as a GraphQLJSONObject. By writing custom Scalar Object Types subfield selections can be made.

Describe the ideal solution

Custom Scalar types should be written

Additional context

The SpaceX API also has this kind of system

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

Currently the response of getAllPokemon is, by default, not paginated. This sets a hard limit on how much data can be returned defined by the string limit that the v8 engine can handle (~1GB). At the time of writing (2023-15-12) with the data from Scarlet & Violet Indigo Disk the full JSON is ~524 MB. This size will ever only increase as time goes on and more Pokémon are released. Furthermore, this limit also blocks the expansion of further nesting data, such as changing otherFormes to be proper Pokemon references as opposed to just species strings.

Desired solution

To resolve this issue the response from getAllPokemon should be paginated by default. The following rules will be applied:

• If no pagination options are provided by the user the default amount per page of 250 is used
• Input validation will ensure the user can never request more than 250 Pokémon per page
• The following interface will be used for a paged response:

interface PaginatedResponse {
  data: TheOldDataObject;
  totalCount: number; // The total count of results
  pages: number; // The total amount of pages based on taken and totalCount
  page: number; // The current page number
  offsetForCurrentPage: number; // The offset provided for this request
  offsetNextPage: number; // The offset to provide to jump to the next page
  taken: number; // The amount taken (length of data)
}

Alternatives considered

• Migrating to a different programming language than TypeScript that doesn't have the 1GB limit that v8 does. This however is only delaying the inevitable because at some point any programming language is going to run out of space.

Additional context

#899 where otherFormes nesting was added as an attempt to provide more data to the end-user

Toxitricity GMax has been released which can now be included

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

High resolution images of pokemon would be a neat addition

Desired solution

redirection links to serebii images

Alternatives considered

none

Additional context

No response

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update all non-major dependencies (@vitest/coverage-v8, docker/build-push-action, vitest)

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency ansi-regex to v6
• chore(deps): update dependency eslint to v9

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

When adding specific properties in the query builder instead of showing the nested properties it just keeps adding itself to the path

Steps To Reproduce

1. Navigate to the query builder
2. Click preevolution
3. Repeat step 2 as many times as desired

Expected behavior

It should display a list of nested properties

Screenshots

Additional context

not sure if the issue lies with apollo and how many fields are affected, but this happens with quite a few of them

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

Currently the otherFormes field for a Pokemon is an array of strings, however, this field could be a nested reference to the actual Pokémon. This is currently blocked by #900 as v8 cannot handle so much data, but once that issue is resolved this should be changed.

Desired solution

• The otherFormes should be a [Pokemon!] type instead of a [String!] type
• The mappers should be updated to match

Alternatives considered

N.A.

Additional context

The bulk of the changes are already done in #899.

Item data should updated for Generation 8

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

showdown provides all cries as mp3 and ogg under

"https://play.pokemonshowdown.com/audio/cries/:species.mp3"
"https://play.pokemonshowdown.com/audio/cries/:species.ogg"

Desired solution

two additional fields on the Pokemon object, cryMP3URL, cryOGGURL

Alternatives considered

manually formatting the url within source code, which works, but hey still would be useful

Additional context

No response

Since the release of v1.1.0 more data has been discovered and this changed data should be included in the v1.2.0 release of the API.

Pokedex data should updated for Generation 8

Once all is done a cleanup throughout the code should be performed

One example is pichu spiky eared which only has a DPP sprite. Adding 2 option fields "specialSprite" and "specialSpriteShiny" will let us specify sprites for these Pokémon. The special fields are then preferred when parsing to DexDetails.

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

A field on the Pokemon object containing the classification (see serebii)

Desired solution

An additional field on the object holding the string
Could prolly look around myself if there's a decent way to scrape it again like 2 years ago

Alternatives considered

none

Additional context

Would be useful for my CoreML AI PokéDex

Please describe the problem you are having in as much detail as possible:

It appears that the evos and prevo fields are not being parsed correctly because they are reported as null even on something like Ivysaur.

Include a reproducible code sample here, if possible:

fragment dexdetails on DexDetails {
  num species types
  abilities { first second hidden special }
  baseStats { hp attack defense specialattack specialdefense speed }
  gender { male female special }
  color eggGroups evolutionLevel evos prevo forme formeLetter
  height weight baseForme baseSpecies otherFormes
  sprite shinySprite smogonTier
  bulbapediaPage serebiiPage smogonPage
  flavorTexts { game flavor }
}

fragment evolutions on DexDetails {
  evolutions { ...dexdetails }
  preevolutions { ...dexdetails }
}

{
  getPokemonDetails(pokemon:melmetal) {
    ...dexdetails
    ...evolutions
  }
}

Further details:

• version: 1.0.1
• Node.js version: 12-LTS
• Operating system: Windows
• Priority this issue should have – please be realistic and elaborate if possible: High

• I have also tested the issue on latest master, commit hash: 97bb3ed

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

Following issue #900 the same should be applied to the getFuzzy{Ability, Pokemon, Item, Learnset, Move} queries so they forcibly use pagination as well.

Desired solution

For details refer to #900

Alternatives considered

N.A.

Additional context

No response

Alias data should updated for Generation 8

Learnsets data should updated for Generation 8

Ability data should updated for Generation 8

This was requested by spacesanjeet#1363 on Discord. It would be nice if the base stats total would also be returned.

FlavorTexts data should updated for Generation 8

For Skyra it is required to also be able to fuzzy search on pokemon and learnset to make resolving arguments much much easier, therefore a query to support that has to be added.

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

The dragonite bot has some utilities for parsing the graphql-pokemon data. It would be useful if these are also exposed to users of graphql-pokemon.

Desired solution

• Migrate the code from dragonite to graphql-pokemon and expose it under @favware/graphql-pokemon/utilities using export mapping in package.json
• Update the README to list that the npm package is no longer only useful for TS users
• Document the migrated code more properly
• Add static images to the GitHub repository with small colour blocks so the user gets a preview for the different colours, similar to https://github.com/mui/material-ui/blob/e7b9793afd312c338affbb58c49cd8a28bad8110/packages/mui-material/src/colors/red.d.ts

Alternatives considered

N.A.

Additional context

No response

Hello!

I hope you are doing well!

We are a security research team. Our tool automatically detected a vulnerability in this repository. We want to disclose it responsibly. GitHub has a feature called Private vulnerability reporting, which enables security research to privately disclose a vulnerability. Unfortunately, it is not enabled for this repository.

Can you enable it, so that we can report it?

Thanks in advance!

PS: you can read about how to enable private vulnerability reporting here: https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository

GraphQL can generate client-side typings, these should be published to NPM as @favware/graphql-pokemon

Various gender ratios are incorrect, possibly due to wrong copy-pasting.

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

in pokemonResolver.ts, there is getAllPokemons, but when I access https://graphqlpokemon.favware.tech I can't find the query getAllPokemons

Desired solution

Can use query getAllPokemons from https://graphqlpokemon.favware.tech

Alternatives considered

I hope I can user query getAllPokemons from GrappQL endpoint, thanks

Additional context

No response

Moves data should updated for Generation 8

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

Another niche field request birthed from working on PokéDex stuff, this page has phonetic listings for Gen 1-8, those would make for a niche but useful additional field
https://bulbapedia.bulbagarden.net/wiki/User:SnorlaxMonster/Pronunciation

Desired solution

An additional field on the Pokemon object something along the lines of pronounciation, ipa-notation etc…

Alternatives considered

Scraping the page and bundling a json document into my application

Additional context

I’ll do the above anyway and will attach the file later for ease of implementation if deemed useful enough