Hi, I know that this is not really an issue but wanted to know if there is a way to check if the summoner is playing now? I saw this website called lolnexus.com where you type the summoner and its region and they display the match list. I think that this could be achieved with the Spectator V3 endpoint but I am not so sure. Could you please give me some hint? Will appreciate it! Thanks!

Delete old examples, add new & better ones, dot dot dot.

Untagged old commits:
6eab42e refactor: prettier everything / clean up examples folder
e6aada4 docs (examples): Add verification example
c80a636 fix (examples): beginIndex should start at 100 since we already proce…

After upgrading to kayn from kindred, I noticed that performing a few api calls at once was vastly slower than it was on kindred. I ran some tests with the following calls: https://pastebin.com/2BkFDw6Q (pastebin because code wasnt formatting correctly)
What I noticed were as follows: The kayn api takes ~9-12 seconds for the above 12 api calls when the sync rate limiter is being created, and after they get created it drops down to ~6 seconds. Whereas with the kindred api, all of those calls get completed in just under a second. No caching is being used, and it does not appear as though there are any calls that are being retried.

Lets say you had 100 calls per 10 seconds, and next call you get it's down to 10 calls per 10 seconds.

Not sure how I'd do this cleanly (though Kindred already is pretty unclean).

Not everyone wants to type out all the methods they want to cache...

Some people might want to cache the entire static service
Some people might want to cache specific method ttls.

https://discussion.developer.riotgames.com/articles/4906/announcing-new-endpoints-for-static-data-api.html

Waiting on API key (asked for one for both stub/regular) still!

[ 'GET /lol/league/v4/positional-rank-queues',
'GET /lol/league/v4/positions/{positionalQueue}/{tier}/{division}/{position}/{page}' ]

missing these 2 endpoints, firstly going to remove all the v3 stuffs/update types in 1 patch first though

:)

https://puu.sh/xkaXl/f0ed2a13da.png -_-

The league endpoints are also limited based on region, too, so that requires more changes.

GOAL: FINISH BY AUG 26 (1 day before deadline)

Code quality will be sucky, because I started a few days before deadline (aka procrastination). However, I will make sure that it improves over the next couple of weeks after I release it firstly. :)

base endpoints

• Champion
  • get
  • list
  • listFull
• Item (list)
• Language (list)
• LanguageString (list)
• Map (list)
• ProfileIcon (list)
• Realm
• ReforgedRunes
• SummonerSpell (list)
• Version

not mastery/rune because there's no need? I might add it anyways because it's just a few lines lol

• debug method for each
  • success
  • error (404 is probably main, but try 503 500? dont know)
• cache method available for each
• docs (changelog, pluralsingular, RuneReforged->RunesReforged)
  • Endpoints.md
• add default locale option

============
out-of-scope for now (aka the deadline release)? comment otherwise if you think it'd be useful

prolly add this next release once I figure it out more thoroughly

• [] automatic version grabbing for optional version. should respect cache options Not possible

tarball tgz or link (not sure what the use case is yet)
rune (do we need this anymore)
mastery (do we need this anymore)
TS types (will be added in subsequent releases)
images? ddragon provides img urls too (is this necessary)

This is TBD, but I'm thinking of adding additional helpers that may help the library be a lot easier to use.

The base API will remain untouched. I'm simply just adding some helpers (that will mirror kayn's request API) that if useful for my LoL project, would probably be useful for other projects as well. These helpers simply use kayn to reduce the amount of redundant requests and make the code nicer IMO (you don't have to manually call every endpoint), and so performance should be ok if you care about that (one of kindred-api's flaw was that you can make identical requests if you're not careful).

The response objects themselves remain untouched as well! (accountId, name, etc for example)

This idea is kinda based off of Cassiopeia (https://github.com/meraki-analytics/cassiopeia/blob/master/examples/summoner.py) where there are ghost objects that represent what you want, but in this case it'll be asynchronous because of async/await and promises.

I'm going to see if this API works well on one of my other hobby projects before I work on it further though. I'm not going to abstract everything in the API since that's a headache, but I think that having a lot of helpers for specifically the summoner response would be useful since it's used in every other endpoint.

const Summoner = Rhaast(kayn).Summoner;

const main = async () => {
    // A shell that simply has a name property and helper functions.
    const summoner = Summoner({ name: 'Contractz' });

    // summoner.name = 'Contractz';
    // summoner.region = Summoner(args, **region**) or kayn's default region;

    // get() fills out the Summoner properties (name, accountId, etc) while also returning
    // the response.
    const fullSummoner = await summoner.get();
  
    /*
    { name: 'Contractz',
  id: 32932398,
  accountId: 47776491,
  region: 'na',
  profileIconId: 3155,
  revisionDate: 1512621047000,
  summonerLevel: 30 }
     */
    
    // After .get() is called, the **summoner** object in the first line is 'filled out'
    // and can now be accessed just like const fullSummoner.
    // but fullSummoner is simply the raw response data while
    // summoner has tons of helper methods.
     console.log(summoner.id === fullSummoner.id); // true

    // Getting the matchlist with the same summoner helper above. :)
    // Notice how you're able to call this without any mention of the account ID.
    // I guess to refresh the data, users must call get() manually.
    const matchlist = await summoner.matchlist();

   // should be able to pass in config / region too
   // matchlist(args, config, region)
};

main();

ofc one problem is that the data will stay the same unless a new object is constructed (atm), more thinking needs to be done XD

https://puu.sh/wJDD4/b6ed675682.png

How can I assign this to a variable?

e.g:
let summoner = k.Summoner.get({ name }, KindredAPI.print)

Thanks

For the matchlist endpoint, it is critical to be able to pass query parameters (beginTime, beginIndex, etc.) - without those parameters, its use case is very limited.

Or is there a way to do this that I'm missing?

I haven't done much testing but some endpoints seem to respond with arrays which cause JSON.parse() to fail. For example:
ChampionMastery.list returns a stringified array that parses with no issue.
TournamentStub.create returns a normal array that throws errors in JSON.parse().

I'm not sure if it's Riots fault or something in the lib causing it but I'm using this workaround for now.
I haven't tested it with every endpoint but checking for array and calling stringify on it seems to be a working bandaid until a permanent solution is found.

let res = await this.limiter.executing({
...
try { 
  if (Array.isArray(res)) {
    res = JSON.stringify(res)
   }
   const blob = JSON.parse(res)
...
}

One huge TypeScript problem (though it's ignorable) is that the response body properties are all optional.

Problem

sw2dts generates optional types by default unless the user sets the required tag in the property of a component.

Point:
  type: object
  properties:
    x:
      type: number
    y:
      type: number
  required: # <-- This
    - x
    - y

=>

export interface Point {
  x: number
  y: number
}

Without the required tags, we end up with

export interface Point {
   x?: number
   y?: number
}

The auto-generated JSON that we read from (http://www.mingweisamuel.com/riotapi-schema/openapi-3.0.0.yml) does not have the required property. However, I do not believe that is the problem of the JSON we read from. required (based on what I know) is based on parameters (path & query) for an endpoint, and not for the response classes themselves.

Manual Workaround

Workaround 1

const name: string = summoner.name // BREAKS. string != string | undefined
const name: string = summoner.name! // probably the best way (non-null assertion operator)
const name = summoner.name as string // force it to work if you know it's not undefined

Workaround 2

Manual file-editing, which is not fun.

If I forget about this and you're having issues due to bad code and run-time errors hit me up

Hi, i'm having problem with the static data - getChampions
when i start my node server, and try to call the API, it's return ok

but if I refresh the page, it's return null, and in my debug console, they send me a message of cache.

this problem is with cache ? can you help me ?

Will be removed (https://nexus.leagueoflegends.com/en-us/2019/03/dev-state-of-ranked/).

I read in the README.md that if there were people who wanted it, you would work on a mongodb caching system along with a reset function. This is my way of saying I could use these additions. And I assume that the reset function is meant to clear the cache and allow you to query directly from the riot api. Thanks.

First of all, I really like your lib. Keep up the good work !

I'm facing issues when trying to set the Redis cache options.
I got this :

this.api = new KindredApi.Kindred({
  key: apiKey,
  defaultRegion: region,
  debug: !prod,
  showKey: true,
  showHeaders: false,
  limits: prod ? KindredApi.LIMITS.PROD : KindredApi.LIMITS.DEV,
  spread: false,
  retryOptions: {
    auto: true,
    numberOfRetriesBeforeBreak: 3,
  },
  timeout: 5000,
  cache: new KindredApi.RedisCache({ // Problem here, I can't set the options
    host: cache.redis.host || 'localhost',
    port: cache.redis.port || 6379,
    keyPrefix: cache.redis.prefix || 'league-tooltips_',
  }),
  cacheTTL: {
    STATIC: cache.TTL,
  },
});

The problem is that it is impossible to set the Redis config I want. They always get overridden by your default config. See here. Your code behaves this way : whatever the user gives, the default options are overriding it.

The way to fix this is to change the line to this :

var options = Object.assign({
  host: '127.0.0.1',
  port: 6379,
  keyPrefix: 'kindredAPI-'
}, opts || {});

The second problem is that the Wiki needs more docs about the RedisCache options. I had to dig in the lib code.

If you don't have the time to fix this, I can send you a PR with the fixed code :)

I trying to use the static data, get List Champion and get Champion By Id
but if I try to use the champListData: All, doesn't work

i Trying by two ways

 k.Static.champion({
        id: champId, champListData: 'all'
    })

and

const config = {
        options: {
            champData: 'all'
        }
    }
    k.Static.champions({ config }

is something wrong ?
thanks

added this for you

WxWatch/riot-api-libraries@02e5e36

Version:

0.9.1

Steps to reproduce:

The following code, taken from the docs:

kayn.DDragon.Champion.list() // Implicitly targets 8.15.1
    .callback(function(error, champions) {
        console.log(champions)
    })

Expected:

Expected to return an object containing all champions data.

Result:

(node:8844) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'get' of null
    at DDragonRequest.<anonymous> (C:\rito_api\node_modules\kayn\dist\lib\RequestClient\DDragonRequest.js:144:44)
    at Generator.next (<anonymous>)
    at step (C:\rito_api\node_modules\kayn\dist\lib\RequestClient\DDragonRequest.js:18:191)
    at C:\rito_api\node_modules\kayn\dist\lib\RequestClient\DDragonRequest.js:18:437
    at new Promise (<anonymous>)
    at DDragonRequest.<anonymous> (C:\rito_api\node_modules\kayn\dist\lib\RequestClient\DDragonRequest.js:18:99)
    at DDragonRequest.callback (C:\rito_api\node_modules\kayn\dist\lib\RequestClient\DDragonRequest.js:164:21)
    at main (C:\rito_api\index.js:31:6)
    at Object.<anonymous> (C:\rito_api\index.js:62:1)
    at Module._compile (module.js:652:30)
    at Object.Module._extensions..js (module.js:663:10)
    at Module.load (module.js:565:32)
    at tryModuleLoad (module.js:505:12)
    at Function.Module._load (module.js:497:3)
    at Function.Module.runMain (module.js:693:10)
    at startup (bootstrap_node.js:191:16)
    at bootstrap_node.js:612:3
(node:8844) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:8844) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

After adding .version('8.15.1') to the initial code the result is the expected champion data.

Hello, in initialization, this code is :

defaultRegion: REGIONS.NORTH_AMERICA,

but how can i used for EUW or another ?

Not everyone uses async/await and import and blahblahblah, and the Basic Usage/How to Initialize section is pretty garbage.

Tournament Stub endpoint allows you to create a number of tournament codes (upto 1000 Max)

This is also the same with the main tournament API

Using the function kayn.Matchlist.by.accountID(accountId), I can't use the other parameters that I can use with the API, like specifying Season e/or Champion

Hi, I really liked your API and decided to use it in a project. But I have one issue - how do I get the current rank of a summoner by passing as an option different queues and regions?

It would be very helpful if you can help!

I sometimes get weird JSON.parse errors, especially when processing requests from all regions at once or parsing large objects.

I'm thinking of adding an option that allows try/catching the JSON.parse calls, and on the catch it could simply just return an empty object or something (lol probably not idk ahh).

https://discussion.developer.riotgames.com/articles/6579/player-universally-unique-identifiers-and-a-new-se.html

Scheduled Deprecation Date: January 14th, 2019

Going to start early and going to separate V4 endpoints from the regular endpoints for now until I think of better ideas.,

Summoner
SummonerV4

I'll release some deprecation warnings later on tomorrow as well. Once the endpoints are actually removed, I can replace the regular endpoints with the V4 ones.

SummonerV4 => Summoner, while SummonerV4 will still work

Checklist:

• CHAMPION MASTERIES V4
• LEAGUE V4
• MATCH V4
• SPECTATOR V4
• SUMMONER V4
• THIRD PARTY CODE V4
• TOURNAMENT STUB V4
• TOURNAMENT V4
• TS Bindings
• Release
• Change deprecation date to January 28th (as noted on Riot API docs)

Hello, as far as I can tell by the wiki, there is no by-summoner endpoint in your leagues-v3.
https://developer.riotgames.com/api-methods/#league-v3/GET_getAllLeaguesForSummoner

I'd like to use your API in a project, but I cannot until this feature is added.
(No rush)

Thanks.

Currently, users only receive a simple numeric status code when a request error occurs.

Quick example:

kayn.Summoner.by.name('adsfiudsaiufsadofiahfds') => 404

It would be better to be like other libraries and return a more proper error object that contains the status code and URL firstly.

I'll start with that and add more as I study other libraries.

Riot has now added official rate limits to the static data endpoints which is 10 requests / 1 hr.

Will work on this later today (just a simple configuration change).

Title says it all. You can easily workaround it by encoding the name yourself, but this should be built in.

setInterval and setTimeouts stall out the process (but are harmless). A developer can use unref to make the process exit if there are no more events besides the interval/timeouts.

Colorfulstan/RiotRateLimiter-node@154eb8a

this works (thanks to https://github.com/MingweiSamuel), and is testable in

https://github.com/cnguy/kayn/tree/with-unref-changes

Will probably be released (using my temporary rate limiter fork) in the next version along with the Tournament stuffs + TS bindings

How to reproduce

Just make a request in some random index.js file, the process will harmlessly hang.

await kayn.SummonerV4.by.name('Contractz')
// process will not exit

Tags proposed by user (Djinnes).

This issue will reimplement the old functionality provided by static data (tags) where the feature will do the following:

• cache individual data by id + params (which can be defined as a URL)

// Flashback to KindredAPI code
const rakanConfig = {
  id: 497,
  options: {
    tags: ['image', 'sanitizedDescription']
  },
  region: REGIONS.BRAZIL
}

k.Static.champion(rakanConfig)
        .then(data => console.log(data))
        .catch(err => console.error(err))

I forgot what the resulting JSON loos like but you get the point

This issue needs rewriting

Before starting on this, it might be a good idea to have some example JSON outputs given some tags.
Note that version and locale used to be tags but is actually already implemented through DDragon urls

Is there a reason this package is still using the v3 summoner endpoint? I am getting a forbidden error every time I make a call to this endpoint using this package.

Create more integration tests that work off fixtures (values do not have to be exactly equal. for example, if a fixture has a summoner that was level 30, but they are now 31, you can simply assert restApiData.level >= fixture.level).

These tests will not be ran on Travis due to hanging, but this is fine as the tests can just be ran locally for anyone interested.

Hey,

first: thanks for creating this great API!

I am currently trying to get kayn to work with TypeScript. Unfortunately, it looks like the typings are incorrect for TypeScript v3.2.2 and are missing multiple declare modifiers in front of top level classes/enums.

Repo for reproduction: https://github.com/TiFu/kayn-bug
Output of npm run build:

$ npm run build

> [email protected] build ~\test
> tsc

node_modules/kayn/typings/index.d.ts(293,1): error TS1046: A 'declare' modifier is required for a top level declaration in a .d.ts file.
npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! [email protected] build: `tsc`
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the [email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     ~\AppData\Roaming\npm-cache\_logs\2018-12-31T02_14_58_111Z-debug.log

A trivial fix would be prepending declare in front of all top level classes/enums in typings/index.d.ts and upgrading the TypeScript version in typings/package.json.

It's possible that it's a mistake on my part, but I've been doing some testing and it appears that special characters that are allowed on League (in my case, the Á in ÁssBlaster) aren't working with the library. Testing the same method with different usernames without them works, which leads me to believe that these characters are screwing it up.

In light of my lack of static compatibility to prevent breaking code, I'll be working also on a few things over the next few days to help out everyone, and be working on things early (pushed ChampionRotation yesterday) and so I have much more time to think about releases. I'll admit that sometimes I don't prioritize certain new things because I don't have to use them (I didn't use static endpoints for example. My app pretty much just uses matchlist+challenger league+master league+literally saved copies of static data). However, I do want kayn to be easy-to-use and have a lot of examples, docs, and copy-pastable code, + good defaults so...

• My static endpoints are already broken, and I'm sure users either swapped libraries, swapped to DDragon, etcetc. So, they will be removed eventually as it's too late anyways... But:
  • CDragon will be added
  • DDragon helpers will be added
• Types will be addressed
• A ton of more ES5 callback examples and ES6+ async/await examples will be added. These examples will be based on real code used by others or myself (#46). I added an example early on how to use the new ChampionRotation endpoints and then convert it into the correct DDragon champion objects, for example.
• Improve docs so it's easier to refer to examples and endpoint APIs, coverage pic (low priority obviously), tests (these tests are simple to make, low priority)

One example of a DDragon helper is:
For example, DDragon.Champion.get(266) =>

await DDragon.Champion.get(266) // If cache is enabled, DDragon.Champion.list is cached
/*
{
	"version": "6.24.1",
	"id": "Aatrox",
	"key": "266",
	"name": "Aatrox",
	"title": "the Darkin Blade",
	"blurb": "Aatrox is a legendary warrior, one of only five that remain of an ancient race known as the Darkin. He wields his massive blade with grace and poise, slicing through legions in a style that is hypnotic to behold. With each foe felled, Aatrox's ...",
	"info": {
		"attack": 8,
		"defense": 4,
		"magic": 3,
		"difficulty": 4
	},
	"image": {
		"full": "Aatrox.png",
		"sprite": "champion0.png",
		"group": "champion",
		"x": 0,
		"y": 0,
		"w": 48,
		"h": 48
	},
	"tags": [
		"Fighter",
		"Tank"
	],
	"partype": "BloodWell",
	"stats": {
		"hp": 537.8,
		"hpperlevel": 85,
		"mp": 105.6,
		"mpperlevel": 45,
		"movespeed": 345,
		"armor": 24.384,
		"armorperlevel": 3.8,
		"spellblock": 32.1,
		"spellblockperlevel": 1.25,
		"attackrange": 150,
		"hpregen": 6.59,
		"hpregenperlevel": 0.5,
		"mpregen": 0,
		"mpregenperlevel": 0,
		"crit": 0,
		"critperlevel": 0,
		"attackdamage": 60.376,
		"attackdamageperlevel": 3.2,
		"attackspeedoffset": -0.04,
		"attackspeedperlevel": 3
	}
}
*/

After integrating this, #59, I did quick testing but didn't re-run all my examples to verify that the library still works properly. The hanging was solved, but batch promises don't seem to resolve via Promise.all.

For now stay on v0.9.3 or upgrade to v0.9.5 (they are the same things). v0.9.4 only introduces this hanging change.

What basically happens is the first promise of Promise.all will resolve, but the rest will not be resolved (in debug, the first request will be a success, while the rest are ignored, and then the process resolves).

For now I'll revert the change for v0.9.5 to prevent new install issues.

error in c:....\node_modules\kindred-api\typings\index.d.ts

[tsl] ERROR in c:....\node_modules\kindred-api\typings\index.d.ts(365,27)
TS1005: '(' expected.

I'm running nuxtjs and only accessing the kindred-api library from the backend. I'll fork and raise a PR for the fix

At the moment, there are 429 rate limit errors when using the new development key limits (20/1, 100/120) with Kindred. The retry-afters are always 0 which implies that I'm barely missing (this just applies to the keys that work in a really short window like 20/1).

A temporary workaround is to just use the old LIMITS which is LIMITS.OLD_DEV.
Another workaround is to use the modified limits [20, 1.2], [100, 120] just to give some more buffer. Tinker it as necessary.

I'll add the reproducible code later but let's say a user's not running DEBUG=kayn:* for npm/debug, if there is a certain error in the code (I believe it was Rejected Promise), they might get something like this:

rejectedblahblahblah: #Object

which is obviously useless information and should be improved...

if I remember my error is a simple object with no stacktraces too so let's fix that!

If you're interested in helping, leave a note here or on discord (and then I"ll leave a note here for you)

Most important thing is backwards compatibility.

function updateLeague(profile) { const { region } = profile; return leagueApi.League.positions({id: profile['summonerId'], region}) .then((league) => { let leagueRanks = []; for (let entry of league) { let { queueType, tier, rank, leaguePoints } = entry; leagueRanks.push({ queueType, tier, division: rank, leaguePoints }); } profile['leagueRanks'] = leagueRanks; return profile; }).catch((err) => { if (err.message == 'Error getting league data: 404 Not Found') { return profile; } else { handleErr(err); } }); }

Riot will release a stats endpoint some time in the future (could be months). Probably good to note anything related to that in this issue