@klappay/types 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @klappay/types
 
+## 1.0.3
+
+### Patch Changes
+
+- 1d3e9b1: No code changes — updates package metadata and README.md so npm shows
+  everything correctly:
+
+  - Adds `keywords` for npm search discoverability.
+  - `README.md`'s documentation table, `CHANGELOG.md` link, and `LICENSE`
+    link all now point at real, working URLs — a public docs site at
+    [api.klappay.com/types](https://api.klappay.com/types) (including a
+    changelog page) for the first, `unpkg.com` for the second — instead
+    of relative paths, which never rendered as navigable links on
+    npmjs.com.
+  - `docs/` is no longer bundled in the published tarball — the public
+    docs site above is now the canonical place to read it.
+  - `docs/*.md` had five stray references to this repo's own internal
+    (private, unpublished) documentation by bare path — removed, since an
+    external reader could never reach them.
+
 ## 1.0.2
 
 ### Patch Changes
@@ -35,6 +55,6 @@ TypeScript types and Zod schemas for the Klap Core API's full request/response s
 - **Sandbox** — simulate charge and account events with `test` API keys, no real transactions.
 - **Verify** — public, unauthenticated proof-of-payment lookup.
 - **Distributions** — discover settlement payouts claimable within their grace period.
-- **Auth & accounts**, **tokens & networks**, **errors & health** — see [`packages/types/docs`](../docs) for the full topic-split reference.
+- **Auth & accounts**, **tokens & networks**, **errors & health** — see `packages/types/docs` (published at [api.klappay.com/types](https://api.klappay.com/types)) for the full topic-split reference.
 
-See [`packages/types/README.md`](../README.md) for usage.
+See `packages/types/README.md` for usage.

package/README.md

@@ -55,20 +55,21 @@ API itself (open the API's base URL in a browser once you have access).
 ## Documentation
 
 Full docs (with search and navigation) are published at
-[api.klappay.com/docs](https://api.klappay.com/docs) — generated from
+[api.klappay.com/types](https://api.klappay.com/types) — generated from
 this same package's `docs/` source, so they never drift from what's
 actually exported.
 
 | Doc | Covers |
 |---|---|
-| [Getting started](https://api.klappay.com/docs/getting-started) | Install, what's in this package, typing vs. runtime validation |
-| [Charges](https://api.klappay.com/docs/charges) | `Charge`, `CreateChargeInput`, `AcceptedPayment`, `Capabilities` (`GET /v1/networks`), listing/pagination, `VerifyCharge`, `TimelineEvent` |
-| [Webhooks](https://api.klappay.com/docs/webhooks) | Every `WebhookEventType`, categories, `Webhook`, `WebhookPayload`, `TypedWebhookPayload` |
-| [Sandbox](https://api.klappay.com/docs/sandbox) | `SandboxTriggerInput`, `SandboxEventTriggerInput`, `TriggerableChargeEvent` |
-| [Distributions](https://api.klappay.com/docs/distributions) | `PendingDistribution`, `PendingDistributionEvent` — the 0xSplits keeper feed |
-| [Auth & accounts](https://api.klappay.com/docs/auth-and-accounts) | Signup/login, email verification, password reset, `ApiKey`, `User`/`UserRole`, `Organization` |
-| [Tokens & networks](https://api.klappay.com/docs/tokens-and-networks) | `Token`, `Network`, and every chain/token constant |
-| [Errors & health](https://api.klappay.com/docs/errors-and-health) | `ErrorPayload` (every non-2xx response shape), `Health` |
+| [Getting started](https://api.klappay.com/types/getting-started) | Install, what's in this package, typing vs. runtime validation |
+| [Charges](https://api.klappay.com/types/charges) | `Charge`, `CreateChargeInput`, `AcceptedPayment`, `Capabilities` (`GET /v1/networks`), listing/pagination, `VerifyCharge`, `TimelineEvent` |
+| [Webhooks](https://api.klappay.com/types/webhooks) | Every `WebhookEventType`, categories, `Webhook`, `WebhookPayload`, `TypedWebhookPayload` |
+| [Sandbox](https://api.klappay.com/types/sandbox) | `SandboxTriggerInput`, `SandboxEventTriggerInput`, `TriggerableChargeEvent` |
+| [Distributions](https://api.klappay.com/types/distributions) | `PendingDistribution`, `PendingDistributionEvent` — the 0xSplits keeper feed |
+| [Auth & accounts](https://api.klappay.com/types/auth-and-accounts) | Signup/login, email verification, password reset, `ApiKey`, `User`/`UserRole`, `Organization` |
+| [Tokens & networks](https://api.klappay.com/types/tokens-and-networks) | `Token`, `Network`, and every chain/token constant |
+| [Errors & health](https://api.klappay.com/types/errors-and-health) | `ErrorPayload` (every non-2xx response shape), `Health` |
+| [Changelog](https://api.klappay.com/types/changelog) | Every published version of this package |
 
 ## Usage
 
@@ -117,12 +118,14 @@ needed. See the live API reference for details.
 
 This package follows the API's own versioning. A breaking change to a
 schema here means a breaking change to the corresponding API contract —
-check [`CHANGELOG.md`](./CHANGELOG.md) before upgrading across a major
-version. The API implementation itself is closed-source, so this
-package's changelog is the only public record of what changed release
-to release.
+check the [changelog](https://api.klappay.com/types/changelog) before
+upgrading across a major version. The API implementation itself is
+closed-source, so this package's changelog is the only public record of
+what changed release to release.
 
 ## License
 
-MIT — see [`LICENSE`](./LICENSE). This applies to this package only; the
-Klap Core API implementation itself is closed-source.
+MIT — see the
+[`LICENSE`](https://unpkg.com/@klappay/types/LICENSE) file included in
+this package. This applies to this package only; the Klap Core API
+implementation itself is closed-source.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@klappay/types",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "license": "MIT",
   "description": "TypeScript types and Zod schemas for the Klap Core API — the request/response contracts, published separately so integrators get them without needing access to the (closed-source) API implementation.",
   "keywords": [