# pnwkit-2.0

> The reincarnation of pnwkit by BSNK

Latest version **1.5.50** (published 2025-03-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install pnwkit-2.0
pnpm add pnwkit-2.0
yarn add pnwkit-2.0
bun add pnwkit-2.0
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.50 |
| Published | 2025-03-12 |
| First published | 2023-06-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 456.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | darkblade |
| Maintainers | darkblade1078 |

## Links

- npm: https://www.npmjs.com/package/pnwkit-2.0
- Repository: https://github.com/darkblade1078/pnwkit-2.0
- Homepage: https://github.com/darkblade1078/pnwkit-2.0#readme
- Issues: https://github.com/darkblade1078/pnwkit-2.0/issues
- npm.io page: https://npm.io/package/pnwkit-2.0

## Dependencies (4)

- [memoize](https://npm.io/package/memoize.md) ^0.1.1
- [memoizee](https://npm.io/package/memoizee.md) ^0.4.15
- [pusher-js](https://npm.io/package/pusher-js.md) ^8.0.2
- [superagent](https://npm.io/package/superagent.md) ^8.0.9

## Recent versions

- 1.5.50 (latest) — 2025-03-12
- 1.5.51 — 2024-11-28
- 1.5.40 — 2024-05-26
- 1.5.24 — 2023-12-02
- 1.5.22 — 2023-12-02
- 1.5.21 — 2023-12-02
- 1.5.20 — 2023-10-07
- 1.5.19 — 2023-10-07
- 1.5.18 — 2023-10-07
- 1.5.17 — 2023-10-06
- 1.5.16 — 2023-10-06
- 1.5.15 — 2023-10-05
- 1.5.14 — 2023-07-04
- 1.5.13 — 2023-06-28
- 1.5.12 — 2023-06-27
- … 18 more at https://npm.io/package/pnwkit-2.0/versions

## README

# pnwkit-2.0
A new 2.0 version that was made using code from pnwkit 1.0 with some modifications and additions.


## Authors

- [@darkblade](https://github.com/darkblade1078)

## Special Thanks

- [@Henrik](https://github.com/icehenrik)
- [@Doctor](https://github.com/BlackAsLight)
- [@Village](https://github.com/mrvillage)
- [@leonissenbaum](https://github.com/leonissenbaum)
- [@Sol](https://github.com/S0l4RIS9uk)


## Installation

Install pnwkit 2.0 with npm

```bash
  npm install pnwkit-2.0
```
    
## Usage/Examples

### Queries
Call whatever data you want with queries
```javascript
pnwkit.setKeys('api key');

const nations = await pnwkit.nationQuery({id: [100541], first: 1}, `name`);

console.log(`Nation name: ${nations[0].name}`);
```

### Mutations
Use mutations to handle bank transactions and other things
```javascript
pnwkit.setKeys('api key', 'bot key');

const bankDeposit = await pnwkit.bankDepositMutation({ money: 1, note: 'works' }, `date`);

console.log(`Deposit Date: ${bankDeposit.date}`);
```

### Subscriptions
Subscriptions can give you data in real time
```javascript
  pnwkit.setKeys('api key');

  const channel = await kit.subscriptionChannel(subscriptionModel.WAR, subscriptionEvent.CREATE);

  await kit.alliancePositionSubscription(channel, subscriptionEvent.UPDATE, callback);

  console.log(channel);

  function callback(data: war[]) {
    console.log(data);
   }
```

### Utilities
Utilities are here to help calculate data
```javascript
pnwkit.setKeys('api key');

  const cityCost = pnwkit.utilities.cityCost(30, 31, true, true, true, true, true);

  console.log(cityCost);
```


## Supported API Features
Here is a list of all the quries, mutations, and subscriptions that are supported by pnwkit 2.0 as of now.
### Queries
- activityStatsQuery
- allianceQuery
- apiKeyDetailsQuery
- bankRecordsQuery
- baseballGameQuery
- bannedNationQuery
- baseballPlayerQuery
- baseballTeamQuery
- bountyQuery
- cityQuery
- colorQuery
- customQuery (for those who want to run custom GraphQL queries)
- emabrgoQuery
- gameInfoQuery
- nationQuery
- nationResourceStatQuery
- resourceStatsQuery
- topTradeInfoQuery
- tradePricesQuery
- tradeQuery
- treasureQuery
- treasureTradeQuery
- warAttackQuery
- warQuery
- bulletinQuery
- bulletinRepliesQuery

### Mutations
- acceptPersonalTradeMutation
- declinePersonalTradeMutation
- approveTreatyMutation
- proposeTreatyMutation
- cancelTreatyMutation
- assignAlliancePositionMutation
- editAlliancePositionMutation
- assignTaxBracketMutation
- editTaxBracketMutation
- deleteTaxBracketMutation
- bankDepositMutation
- bankWithdrawMutation
- createAlliancePositionMutation
- deleteAlliancePositionMutation

### Subscriptions
- alliancePositionSubscription
- allianceSubscription
- bankRecSubscription
- baseballGameSubscription
- baseballTeamSubscription
- bountySubscription
- citySubscription
- embargoSubscription
- nationSubscription
- TaxBracketSubscription
- tradeSubscription
- treasureTradeSubscription
- treatySubscription
- warAttackSubscription
- warSubscription

### V2
- sendMessage

---
_Source: https://npm.io/package/pnwkit-2.0 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._