@pokewallet/sdk 0.0.0-stage → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PokeWallet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @pokewallet/sdk
 
-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.
+> Install with `npm install @pokewallet/sdk`. The [root README](../../README.md#2-install) has the quickstart, the full method table and the MCP server.
+
+Official TypeScript SDK for the [PokeWallet API](https://pokewallet.io): Pokémon, One Piece and ten more card games, with TCGPlayer and CardMarket prices. Zero runtime dependencies, ESM and CJS, Node 18+ (also Workers and browsers: it only needs `fetch`).
+
+```ts
+import { PokeWallet } from '@pokewallet/sdk'
+
+// Key format: pk_live_xxx. Keep it in the environment, never in source control.
+const pw = new PokeWallet({ apiKey: process.env.POKEWALLET_API_KEY })
+
+const page = await pw.pokemon.search('charizard', { limit: 10 })
+const op01 = await pw.onepiece.set('OP01')
+for await (const card of pw.games.mtg.setCards('FRA')) console.log(card.name)
+```
+
+Pokémon, One Piece and the ten games (`pw.games.mtg`, `pw.games.ygo`, ...) share one interface: `search`, `searchAll`, `card`, `sets`, `set`, `setCards`, `prices`, `statistics`, `completionValue`, `trending`, `topCards`. Pokémon adds `priceHistory`.
+
+- **Typed errors:** `AuthError`, `PlanRequiredError` (`redeemUrl` / `upgradeUrl`), `FeatureNotEnabledError`, `RateLimitError` (`limits`), `AmbiguousSetError` (`matches`), `NotFoundError`, `UnavailableError`, `ValidationError`.
+- **Retries:** only on 429 (when `Retry-After` is present, within `retryAfterCapSeconds`, default 30, and no quota window is exhausted) and on 503 (up to `maxRetries`, default 2). Never on other 4xx or 5xx. `fetch`, `timeoutMs` and `sleep` are injectable.
+- **Validation:** `limit` and `page` are checked before the request is sent.
+- **Normalization:** prices are `number | null`; set identifiers are exposed as `setId` / `setCode`; every object keeps the server value in `raw`. Ambiguous set answers (200, 300 and 409 on the wire) all raise `AmbiguousSetError`.
+- **Key safety:** the key is held in a private field and shown as `pk_***` by `JSON.stringify`, `util.inspect` and errors.
+- **Images:** `imageUrl(id)` only builds the URL. The image routes need the `X-API-Key` header, so the URL cannot be used directly in an `<img>` tag.
+
+The key is read from the `apiKey` option or the `POKEWALLET_API_KEY` environment variable. The client can be created without one: `health()` and `listGames()` are public and work without a key (the `X-API-Key` header is sent only when a key is set); every other call throws `ValidationError` before any request is made. Every request carries `User-Agent: pokewallet-sdk-ts/<version>`.
+
+Attribution: if you show data obtained through the PokeWallet API, SDKs or MCP server to other people, credit PokéWallet with visible text "Data by PokéWallet" (or "Powered by PokéWallet") linking to <https://pokewallet.io>; private use needs no attribution. See the [Terms of Use](https://pokewallet.io/terms-conditions). This concerns the data and the service; the MIT license of the code is separate.