npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rpglogs/api-sdk

v1.0.0

Published

Sends HTTP requests to the RPGLogs v2 API.

Downloads

630

Readme

RPGLogs API SDK

Install the API SDK in your project:

npm install --save @rpglogs/api-sdk

Import the SDK builder function:

import { buildSdk } from "@rpglogs/api-sdk";

Build an SDK by providing an access token:

// Default game is Retail Warcraft
const retailWarcraftSdk = buildSdk(accessToken);

// But you can specify particular games
const classicWarcraftSdk = buildSdk(accessToken, 'classic.warcraft');
const vanillaWarcraftSdk = buildSdk(accessToken, 'vanilla.warcraft');
const ffSdk = buildSdk(accessToken, 'ff');
const esoSdk = buildSdk(accessToken, 'eso');
const swtorSdk = buildSdk(accessToken, 'swtor');

Use methods on the SDK to call the RPGLogs API:

const response = await sdk.getGuild({
  guildName: 'Reaction',
  guildServerSlug: 'Kazzak',
  guildServerRegion: 'EU',
  includeAttendance: false,
  includeServer: true,
  includeMembers: false,
  includeTags: false
});

const guild = response?.guildData?.guild;

Easy!

You can use the include* variables to include nested child data. Only set these to true if you actually need the data, as it will use up more of your rate limit!

Check out the sample application to see how to handle different error scenarios, as well as an example of getting an access token through the client credentials flow.

You can use this SDK to get all sorts of information from the API. This list of methods gives a good idea of what data you can retrieve:

  • getAbility
  • getAchievement
  • getAffixes
  • getCharacter
  • getCharacterEncounterRankings
  • getCharacterZoneRankings
  • getClasses
  • getEnchant
  • getEncounterCharacterRankings
  • getEncounterFightRankings
  • getFactions
  • getGuild
  • getGuildReports
  • getItem
  • getNpc
  • getProgressRace
  • getRateLimit
  • getReportEvents
  • getReportFights
  • getReportGraph
  • getReportRankedCharacters
  • getReportTable
  • getUserReports
  • getZones

There is also formal documentation for this library.

Roadmap

There are still some high-level features that would be good to add:

  • [ ] Include game-specific fields so that no data is missing for FF, ESO etc
  • [ ] Add support for just using the generator part of the library and specifying your own GraphQL queries
  • [ ] Add support for other programming languages supported by graphql-codegen (C#, Java)

Developing in this repository:

# Install dependencies
yarn install

# Now you can run various yarn commands:
yarn generate
yarn test
yarn build-all
yarn ts-node <filename>
yarn esbuild-browser
...