@gobodo/gobodo-api-heyapi 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,41 @@
-# Temporary Holding Version
+# gobodo-api-heyapi
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript client for the Gobodo graph API, generated from the **Spring Boot v1** OpenAPI spec (`/graph/api/v1/api-docs`) with [`@hey-api/openapi-ts`](https://heyapi.dev). Emits typed SDK calls on `@hey-api/client-fetch` plus optional TanStack Query `queryOptions`/`mutationOptions` wrappers.
+
+For the legacy `/graph/data` surface use `@gobodo/gobodo-api` / `@gobodo/gobodo-api-promise` (JavaScript clients); `@gobodo/gobodo-api-ts` is the `typescript-fetch` sibling for the same v1 spec.
+
+## Install
+
+```bash
+npm install @gobodo/gobodo-api-heyapi
+```
+
+## Usage
+
+```ts
+import { createClient } from '@gobodo/gobodo-api-heyapi/client';
+import { createObject } from '@gobodo/gobodo-api-heyapi/client/sdk.gen';
+
+const client = createClient({ baseUrl: 'https://your-host/graph/api/v1' });
+// TanStack Query helpers are generated too (optional peer: @tanstack/react-query).
+```
+
+## Regenerating
+
+Requires a running backend (local `run/run-app.sh` from `gobodo-core`, or a remote host via `OPENAPI_HOST`). See `gobodo-docs/standards/ai-assisted-development/api-client-generation.md` for the full convention (release branches, commits, PRs).
+
+```bash
+make openapi-generate                          # localhost:8080
+make openapi-generate OPENAPI_HOST=https://…   # remote backend
+```
+
+`src/client` is wiped before each run so stale generated files can't linger.
+
+## Publishing
+
+```bash
+make build
+make publish          # public npm
+make publish-all      # CodeArtifact (gobodo) + npm
+make publish-codeartifact-private   # gobodo-private (set NPM_PUBLISH_TAG for prereleases)
+```