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

kcsapi

v1.191214.0

Published

Kantai Collection API TypeScript types

Downloads

52

Readme

KCSAPI: Kantai Collection Server API

npm GitHub issues GitHub license

Types for Kantai Collection (Phase 2) API

In brief

This library aims to help typescript developers for Kantai Colection (Kancolle) related projects. A good API typing unveils hidden pitfalls created by Mr. Tanaka / C2 Architecture, and also prevents typo bugs.

Usage

Install

npm install --save-dev kcsapi

or

yarn add --dev kcsapi

Use

// recommended
import { APIStart2GetDataResponse, APIMstMapinfo } from 'kcsapi/api_start2/getData/response'

// each API's top level interface could be imported in this way
import { APIStart2GetDataResponse } from 'kcsapi'

How are interfaces named

whole end point omitting kcsapi part will be splited by _ and /, and each part's first character will be upper cased.

Exception: api will always be API

Examples:

| Endpoint | Request | Response | | -------------------------------------- | --------------------------------- | ---------------------------------- | | /kcsapi/api_req_member/get_incentive | APIReqMemberGetIncentiveRequest | APIReqMemberGetIncentiveResponse | | /kcsapi/api_start2/getData | APIStart2GetDataRequest | APIStart2GetDataResponse |

Limitations

  • Important If top level shape is array, the infered interface will be of its element's shape.
  • Some API type missing due to inference failure. Corresponding json schema might be available, however.
  • Ranking / score API is removed because it is encrypted

Details

How are types generated

  1. Collect sample api data, both request and response
  2. Feed the samples into type generator, namely, quicktype
  3. Save the generated type

When types get updated

API change

In case the API shape change, old sample files will be completely replaced by new ones (if possible).

Hidden difference or not covered endpoint

A new sample file will be added, with detail description.

Anonymization of samples

Samples will be anonymized to remove sensitive data with which the provider could be identified by game service or third party. All string values are replaced by Tanaka and numbers by 0. This way API data shape is preserved and player specific information is removed.

Liccense

MIT