@lichess-org/types 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,8 +1,31 @@
|
|
|
1
|
+
# Lichess.org API Types
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install @lichess-org/types
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { components, operations } from "@lichess-org/types";
|
|
13
|
+
|
|
14
|
+
type LichessGame = components["schemas"]["GameJson"];
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## For Maintainers
|
|
18
|
+
|
|
19
|
+
To re-generate:
|
|
20
|
+
|
|
1
21
|
```bash
|
|
2
22
|
pnpm gen
|
|
3
23
|
pnpm format
|
|
4
24
|
```
|
|
5
25
|
|
|
26
|
+
To publish:
|
|
27
|
+
|
|
6
28
|
```bash
|
|
7
29
|
npm version patch --no-git-tag-version
|
|
30
|
+
npm publish
|
|
8
31
|
```
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lichess-org/types",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "Lichess.org API types",
|
|
5
|
+
"homepage": "https://github.com/lichess-org/api",
|
|
6
|
+
"license": "AGPL-3.0-or-later",
|
|
5
7
|
"types": "lichess-api.d.ts",
|
|
6
8
|
"scripts": {
|
|
7
9
|
"format": "prettier --write .",
|
|
8
10
|
"gen": "openapi-typescript ../doc/specs/lichess-api.yaml -o lichess-api.d.ts"
|
|
9
11
|
},
|
|
10
|
-
"license": "AGPL-3.0-or-later",
|
|
11
12
|
"devDependencies": {
|
|
12
13
|
"openapi-typescript": "7.0.0-rc.0",
|
|
13
14
|
"prettier": "^3.2.5"
|