Release v0.8.7

Origin-SHA: 9bae6fb0ecadb6b6eded11fa78987e5f5651572c

Author: ryanio

AGENTS.md

@@ -1,57 +1,35 @@
 # api-types — Agent Conventions
 
-Auto-generated TypeScript types from the OpenSea API v2 OpenAPI spec. Source of truth for API types across the devtools ecosystem.
+Auto-generated TypeScript types from the OpenSea API v2 OpenAPI spec. Source of truth for API types in the devtools ecosystem.
 
-## Quick Reference
+## Quick commands
 
 ```bash
 cd packages/api-types
-pnpm run update-spec   # Fetch latest OpenAPI spec from api.opensea.io
-pnpm run build         # Regenerate types from spec + bundle with tsup
-pnpm run lint          # Lint with Biome
-pnpm run type-check    # Type-check with tsc --noEmit
-pnpm run test          # Run smoke tests with Vitest
+pnpm run update-spec   # fetch latest OpenAPI spec
+pnpm run build         # regenerate types and bundle
+pnpm run type-check
+pnpm run test
+pnpm run lint
 ```
 
-## Architecture
+## Responsibilities
 
-| File | Role |
-|------|------|
-| `opensea-api.json` | Local copy of the OpenAPI spec (fetched from `api.opensea.io/api/v2/openapi.json`) |
-| `scripts/update-spec.mjs` | Fetches the latest spec; falls back to existing local file on network errors |
-| `src/generated.ts` | Auto-generated types from `openapi-typescript` — do not edit manually |
-| `src/schemas-generated.ts` | Auto-generated named re-exports of every `components.schemas.*` entry — do not edit manually |
-| `src/auth-scopes-generated.ts` | Auto-generated runtime scope metadata (`AUTH_SCOPES`, `AuthScopeInfo`) derived from the spec's `AuthScope` schema — do not edit manually |
-| `src/index.ts` | Hand-written. Re-exports `schemas-generated.ts` and `auth-scopes-generated.ts`, plus response envelopes and operation helpers |
-| `scripts/generate-schema-exports.mjs` | Emits `schemas-generated.ts` from the spec; runs as part of `pnpm run generate` |
-| `scripts/generate-auth-scopes.mjs` | Emits `auth-scopes-generated.ts` from the spec's `AuthScope` schema; runs as part of `pnpm run generate` |
-| `scripts/check-consumer-imports.mjs` | CI guard — verifies every name workspace packages import from `@opensea/api-types` is in the built `dist/index.d.ts` |
-| `test/smoke.test.ts` | Smoke test verifying the generated types compile and export correctly |
+- Keep `opensea-api.json` as the committed, versioned OpenAPI snapshot.
+- Generate named schema exports, auth-scope metadata, and response helpers from the spec.
+- Provide the types that `@opensea/sdk` and `@opensea/cli` import.
 
-## Review Checklist
+## Rules
 
-When reviewing changes to this package, verify:
-
-1. **Never hand-edit `src/generated.ts` or `src/schemas-generated.ts`**. Both are produced from `opensea-api.json` by `pnpm run generate`. Changes are overwritten on the next build.
-
-2. **Adding a new schema export — no action needed**. When the spec adds a new `components.schemas.X`, it surfaces as a named export automatically via `src/schemas-generated.ts`. Only edit `src/index.ts` for non-schema additions: response envelopes (`components.responses`), operation helpers, or namespace re-exports.
-
-3. **Downstream consumers**: The SDK (`@opensea/sdk`) and CLI (`@opensea/cli`) depend on this package. After updating the spec, rebuild api-types and verify downstream packages still compile:
-   ```bash
-   pnpm --filter @opensea/api-types run build
-   pnpm --filter sdk run check-types
-   pnpm --filter cli run build
-   ```
-
-   **Always-update-this-first rule**: when adding a new OpenSea v2 endpoint to the SDK or CLI, refresh the spec and regenerate types here BEFORE writing the SDK/CLI method. Hand-rolling request/response types in `packages/sdk/src/api/types.ts` or `packages/cli/src/types/api.ts` is forbidden and CI will block it (`pnpm check-api-paths`).
-
-4. **Chain enum sync**: The SDK's `Chain` enum has a compile-time assertion against `ChainIdentifier` from this package. If the spec adds a new chain, the SDK build will fail until `Chain` is updated.
-
-5. **Consumer-imports CI guard**: A standalone CI job (`API Types consumer imports` in `.github/workflows/ci.yml`) runs `scripts/check-consumer-imports.mjs` on every PR. It greps every `from "@opensea/api-types"` import across the workspace and verifies each named import is exported by the built `dist/index.d.ts`. If a name is missing, the job fails with the file/line that imports it. This catches the failure mode where a downstream change happens to resolve through the workspace but would break against the published artifact (the exact bug that briefly broke order posting in SDK 11.0).
+1. **Never hand-edit generated files** in `src/generated.ts`, `src/schemas-generated.ts`, or `src/auth-scopes-generated.ts`. Run `pnpm run build` after `update-spec`.
+2. **Add API endpoints via the spec first**. Before writing SDK/CLI methods, run `pnpm --filter @opensea/api-types run update-spec && build`. Hand-rolling request/response types is forbidden and `pnpm check-api-paths` will fail.
+3. **Schema additions are automatic**. New `components.schemas.*` entries become named exports automatically; only edit `src/index.ts` for non-schema helpers or response envelopes.
+4. **Rebuild downstream**. After spec changes, rebuild api-types, then run `pnpm --filter sdk run check-types` and `pnpm --filter cli run build`.
+5. **Export check**. CI runs `node packages/api-types/scripts/check-consumer-imports.mjs` to ensure every workspace import from `@opensea/api-types` exists in `dist/index.d.ts`.
+6. **Auth-scope drift**. CI runs `node scripts/check-auth-scope-drift.mjs` (repo root) to compare the auth scopes in `opensea-api.json` against the live `/api/v2/auth/scopes` registry. Re-run `update-spec` + `build` when it reports drift.
 
 ## Conventions
 
-- ESM-only (`"type": "module"`).
-- Dual CJS/ESM output via tsup (consumers can `import` or `require`).
-- The `update-spec` script is idempotent — safe to run anytime. It prints the path/schema counts on success.
-- Use `/sync-openapi` (monorepo slash command) for the full flow: fetch spec, regenerate, open a PR if changed.
+- ESM-only, dual CJS/ESM output via tsup.
+- `pnpm run update-spec` is idempotent and falls back to the local file on network errors.
+- Use `/sync-openapi` for the full fetch → regenerate → PR flow.

CHANGELOG.md

@@ -1,5 +1,16 @@
 # @opensea/api-types
 
+## 0.8.7
+
+### Patch Changes
+
+- 7d2dbef: Sync OpenAPI spec: add `stablechain` to `ChainIdentifier`, add `Chain.StableChain` (chain id 988) to the SDK and generated chain maps
+- 8b7ddd2: Sync OpenAPI spec: add wallet visibility endpoints (`PUT`/`DELETE /api/v2/accounts/wallets/{wallet}/private`), the public `GET /api/v2/accounts/{address_or_username}/agent-relationships` endpoint, and the `WalletVisibilityResponse`, `AgentProfileRelationshipsResponse`, and `AgentProfileSummaryResponse` schemas
+- 0031eed: Sync OpenAPI spec: add SVM transaction detail schemas
+
+  - Adds `SvmInstructionAccountResponse`, `SvmInstructionResponse`, and `SvmTransactionDetailsResponse` schemas.
+  - Adds an optional `svm` field to `SwapTransactionResponse` for structured Solana transaction contents on SVM chains.
+
 ## 0.8.6
 
 ### Patch Changes