# Kcwiki Quest Data

[![npm](https://img.shields.io/npm/v/kcwiki-quest-data)](https://www.npmjs.com/package/kcwiki-quest-data)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/kcwiki-quest-data)
![build](https://github.com/kcwikizh/kcwiki-quest-data/workflows/build/badge.svg)

The Structured data for Kantai Collection quest

## Supported features

- Auto complete for quest data

![image](https://user-images.githubusercontent.com/18554747/79259047-08d52700-7ec7-11ea-8a0c-729392866905.png)

- Hover documentation

![image](https://user-images.githubusercontent.com/18554747/79258575-4c7b6100-7ec6-11ea-880f-48ce728e6063.png)

- Types support
- JSON schema support
- Unit test
- Linter
- CI/CD
- Monitor new quest data from [poi server](https://github.com/poooi/poi-server) dump

![image](https://user-images.githubusercontent.com/18554747/81589987-1661cc00-93f5-11ea-8dd2-aaadfc3a524d.png)

## Instructions

### Quest data update

- Clone this repo
- Run `npm install`
- Run `npm run generateSchema`
- Edit `data/*.json` or `draft/*.json` in [vscode](https://code.visualstudio.com/)

### Use in other libraries

To install the latest version, run the following command:

```sh
# Stable version
npm install kcwiki-quest-data

# Nightly version
npm install kcwikizh/kcwiki-quest-data#nightly
```

Or if you're using [yarn](https://classic.yarnpkg.com/en/docs/install/):

```sh
# Stable version
yarn add kcwiki-quest-data

# Nightly version
yarn add kcwikizh/kcwiki-quest-data#nightly
```

```js
import type { Quest } from 'kcwiki-quest-data' // quest json type
import { questData } from 'kcwiki-quest-data' // all quests json array
import { questDataMap } from 'kcwiki-quest-data' // all quests json keyBy game_id
import quest101 from 'kcwiki-quest-data/data/101.json'
import { QuestHelper } from 'kcwiki-quest-data'

QuestHelper.of(101).ensure()?.unwrap().wiki_id // "A01"
QuestHelper.of(101).ensure(
  (questContainer) => console.log(questContainer.unwrap().wiki_id),
  (err) => console.error('Error!', err),
) // "A01"
QuestHelper.of(99999999).forceEnsure().unwrap().name // "UNKNOWN_QUEST"
```

- Or use [gh-pages/data.min.json](https://github.com/kcwikizh/kcwiki-quest-data/tree/gh-pages) directly

## API

### Quest

The type of quest json.

### QuestHelper

#### Basic

- `static QuestHelper.of(gameId: number): MaybeQuest`
- `static QuestHelper.of(quest: Quest): QuestHelper`
- `QuestHelper.id: number`
- `QuestHelper.unwrap(): Quest`

#### Utils

- `QuestHelper.translate(lng: string): string`
- `QuestHelper.getPrerequisite(): QuestHelper[]`
- `QuestHelper.getPostQuest(): QuestHelper[]`

### MaybeQuest

- `MaybeQuest.ensure(): QuestHelper | undefined`
- `MaybeQuest.ensure((questContainer: QuestHelper) => {}, (error: Error) => {})`
- `MaybeQuest.forceEnsure(): QuestHelper<Quest | UNKNOWN_QUEST>`

## Reference

- [kcwikizh/kcdata](https://github.com/kcwikizh/kcdata)
- [任务 - 舰娘百科](https://zh.kcwiki.org/wiki/%E4%BB%BB%E5%8A%A1)
- [KC3Kai/kc3-translations/quests.json](https://github.com/KC3Kai/kc3-translations/blob/master/data/jp/quests.json)
- [poooi/plugin-quest](https://github.com/poooi/plugin-quest)
- [poooi/plugin-translator](https://github.com/poooi/plugin-translator)
- [Editing JSON with Visual Studio Code](https://code.visualstudio.com/docs/languages/json)
- [quicktype](https://github.com/quicktype/quicktype)