b-cho / galeforce Goto Github PK

Hey,

could you change all the .d.ts files to export all interfaces? There are two reasons why I think this would be a good change:

1. you could go from this: foo(match.info : any) to foo(match.info : Info) This has two advantages: first type safety and second enabling auto complete for the properties of Info in the method. I know you could also just always pass the entire match to any function. however i think thats kind of unnecessary.
2. you could create a variable in a type safe way without having to define them right away. So instead of let matchInfo: any; you could write matchInfo : Info; This comes with the same adantages as the first reason.

Description
When trying to make any request, the request will hang if the client's cache is set to redis.

Reproduction Steps

1. Set rate limit cache to use redis
2. Make any request to Riot's API

Expected/Actual behavior
The client to connect properly to the redis cache and execute the requests.

Additional Information
Here is the config I use:

{
  'riot-api': { key: 'XXXXXXXX' },
  'rate-limit': {
    type: 'bottleneck',
    cache: {
      type: 'redis',
      uri: 'redis://127.0.0.1:6379',
      'key-id': 'galeforce'
    },
    options: {
      intervals: [Object],
      'max-concurrent': null,
      'min-time': 0,
      'retry-count-after-429': 3
    }
  },
  debug: [ 'all' ]
}

Note that when setting the cache to internal, everything runs fine. Also, my redis server (Redis version=5.0.8, bits=64) is running and accessible through the passed URI. I've also tried setting the database in the URI as follows: redis://127.0.0.1:6379/0, but that didn't help.

Hey,

I'd realy like to use this. However when I try to create a new instace of the GaleforceModule I get the error galeforce_1.default is not a constructor

I alreay tried adding "esModuleInterop": true, to my tsconfig. But it didnt help.
I am importing the module like so import GaleforceModule from "galeforce";
Here is my tsconfig.json:

  "compileOnSave": false,
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "./dist/out-tsc",
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "noImplicitOverride": true,
    "noPropertyAccessFromIndexSignature": true,
    "esModuleInterop": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    "sourceMap": true,
    "declaration": false,
    "downlevelIteration": true,
    "experimentalDecorators": true,
    "moduleResolution": "node",
    "importHelpers": true,
    "target": "es2017",
    "module": "commonjs",
    "lib": [
      "es2020",
      "dom"
    ],
    "allowSyntheticDefaultImports": true,
  },
  "angularCompilerOptions": {
    "enableI18nLegacyMessageIdFormat": false,
    "strictInjectionParameters": true,
    "strictInputAccessModifiers": true,
    "strictTemplates": true
  }
}

Is your feature request related to a problem? Please describe.
Getting perks from match data does not have an endpoint in galeforce to help translate them to.

Describe the solution you'd like
Endpoint added in ddragon for runes.

Describe alternatives you've considered
Have to directly request the json

Additional context
Example runesReforged json:
http://ddragon.leagueoflegends.com/cdn/11.16.1/data/en_US/runesReforged.json

When trying to separate code into multiple functions using typescript it is sometimes not possible to define the type of arguments because Galeforce does not export all interfaces. An example:

const match = getMatch(matchId) // MatchDTO from galeforce
for (const p of match.data.info.participants){
    const runeData = getRuneData(p)
    ...
}
...

// Here I can't define the type because the Participant type is not exported.
const getRuneData = (participant: ?): string[] => {
    ...
}

Simply exporting all interfaces would solve this issue.
If you don't want to do this (let's be honest it's a really boring task) but think it is a good idea I can create a PR with the changes.

This would be useful for encapsulating all Riot APIs within a single library and allowing for more efficient development.

See #24 (comment)

Description
I set up my project using create-react-app and installed Galeforce, but when I try to import the package I get an error in the terminal: Module not found: Can't resolve 'console' in 'D:\Projects\LoLTest\node_modules\ts-node\dist'.

Reproduction Steps

1. Create a new project by running the command npx create-react-app LoLTest
2. In the project directory, install Galeforce by running npm i galeforce
3. In the App.js file, import Galeforce using the following code:
   import GaleforceModule from 'galeforce';
4. Run npm start and the page will fail to display due to the compile error described above

Specifications (please complete the following information):

• OS: Windows

All match-v4 endpoints will be deprecated on August 23, 2021 in compliance with Riot's 60-day deprecation timer and the upcoming release of the match-v5 endpoints. galeforce.lol.match will need to be rewritten in a manner that limits breaking changes and associated documentation within the project's README and docblocks will need to be updated accordingly.

Currently missing unit tests for the associated DTOs to the val-match-v1 endpoint due to a lack of sample match data.