@dreamboard-games/api-client 0.1.0 → 0.1.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 +20 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# @dreamboard-games/api-client
|
|
2
|
+
|
|
3
|
+
Generated public API client and shared event/problem types for Dreamboard.
|
|
4
|
+
|
|
5
|
+
This package is published as `@dreamboard-games/api-client`. Dreamboard
|
|
6
|
+
workspaces and the CLI may install it through the npm alias
|
|
7
|
+
`@dreamboard/api-client` so generated source can keep stable Dreamboard import
|
|
8
|
+
paths.
|
|
9
|
+
|
|
10
|
+
## Exports
|
|
11
|
+
|
|
12
|
+
- `@dreamboard/api-client`: generated client types and helpers.
|
|
13
|
+
- `@dreamboard/api-client/client.gen`: generated client configuration.
|
|
14
|
+
- `@dreamboard/api-client/react-query`: TanStack Query request helpers.
|
|
15
|
+
- `@dreamboard/api-client/problem-types`: shared problem detail types.
|
|
16
|
+
- `@dreamboard/api-client/zod.gen`: generated Zod schemas.
|
|
17
|
+
|
|
18
|
+
The source of truth for the public API contract is
|
|
19
|
+
`packages/api-client/openapi/documentation.yaml` in the public repository.
|
|
20
|
+
|