-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Typescript Conversion #75
Draft
ogrady
wants to merge
72
commits into
queicherius:master
Choose a base branch
from
ogrady:feat/typescript
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
+3,626
−329
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
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.
Migrate to Typescript.
Fixes #64
⚠ This is still a draft and far from done. Some parts are currently not even in a compileable state.
Most parts of the migration are rather straightforward, thanks to the well-structured nature of the current state of
gw2-api-client
.The problematic part is the variety of schemas that not always follow a linear inheritance, but sometimes change the structure of the old schema entirely.
Accomodating the Various Schemas
My best guess as to how to solve this is currently the following:
Each endpoint has their various responses defined in the
endpoints/schemas/responses
directory. If a response can vary based on the selected schema, then that is reflected by exposing the type in various schema versions through namespaces1. SeeCategory
, which has changed significantly on 2022-03-23.Schemas are then bundled in the
endpoints/schemas
directory.Each schema files exports an interface
Schema
which provides the type information for all endpoints (or the encapsulating client) for that specific schema version. Calls toget
,all
, etc. change their result type accordingly.Take the
Cats
response, which has changed from the original schema to the 2019-03-22 schema:I believe this makes the most sense, but requires a bit of voodoo and probably a change in
gw2api-client
s API, as users would have to explicitely give a schema version while instantiating the client (see below).As this requires quite a bit of manual work, could you please give your opinion on this to make sure this doesn't go in a completely unmaintainable direction, @queicherius?
EDIT: shoehorning a demonstration of how the instantiation with different schemas would look like and what issues would arise from it:
Different Schema Versions in Action
Footnotes
although namespaces are kind of deprecated, I believe they make the most sense here. ↩