@sscodeaxis/paywall-sdk 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/CHANGELOG.md CHANGED
@@ -2,14 +2,16 @@
2
2
 
3
3
  All notable changes to this SDK are documented here. Format loosely follows [Keep a Changelog](https://keepachangelog.com/).
4
4
 
5
- ## 0.1.0Unreleased
5
+ ## 0.1.12026-08-31
6
+
7
+ - Updated npm installation and API availability documentation after the public release.
8
+
9
+ ## 0.1.0 — 2026-08-31
6
10
 
7
11
  Initial version. Covers all 5 planned phases:
8
12
 
9
13
  - **Core client** — `PaywallSDK`, API-key auth, typed `SdkApiError`/`SdkConfigError`.
10
- - **Checkout & catalog** — `listPlans`, `createIntent`, `getIntent`, `completeIntent`. Not currently backed by this repo's `apps/api` — the checkout-intent feature lives only in the `marketplace` fork; these methods 404 here until/unless that changes.
14
+ - **Checkout & catalog** — `listPlans`, `createIntent`, `getIntent`, `completeIntent`.
11
15
  - **Entitlements & licensing** — `entitlements.check/getUsage/incrementUsage/decrementUsage`, `licenseKeys.validate`, `devices.register`. Required adding new API-key-authenticated backend routes (`/public/runtime/**`, `/public/devices`) that didn't previously exist — see `apps/api/src/entitlements/public-runtime.controller.ts` and `apps/api/src/devices/public-devices.controller.ts`.
12
16
  - **Webhooks** — `constructWebhookEvent` (HMAC-SHA256 verification, matching `apps/api/src/webhooks/webhook-dispatch.service.ts`'s signing scheme exactly).
13
17
  - **Packaging & DX** — this package, README quickstart, CHANGELOG, test suite (14 tests covering the HTTP client and webhook verification).
14
-
15
- Not published to npm yet — see README's "External requirements" section.
package/README.md CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  Server-side SDK for integrating checkout, entitlements, licensing, and webhooks against the SSCodeAxis API. Node.js only (uses the built-in `fetch` on Node 18+, and Node's `crypto` module for webhook verification) — this is meant to run in your backend, never in a browser, since it's authenticated with a secret API key.
4
4
 
5
- Every method below is verified against a live sscodeaxis `apps/api` (see each client's own doc comment in `src/` for what was actually tested) — see [External requirements](#external-requirements) for the one thing still pending.
5
+ Every method below is verified against a live sscodeaxis `apps/api` (see each client's own doc comment in `src/` for what was actually tested).
6
6
 
7
7
  ## Install
8
8
 
9
- Currently a workspace-internal package (`workspace:*`) within the sscodeaxis monorepo, not yet published to the public npm registry - add it as a dependency the same way `@sscodeaxis/shared`/`@sscodeaxis/ui` are used elsewhere in this repo. Once it's published:
9
+ Install the public package from npm:
10
10
 
11
11
  ```bash
12
12
  npm install @sscodeaxis/paywall-sdk
@@ -132,8 +132,6 @@ try {
132
132
  }
133
133
  ```
134
134
 
135
- ## External requirements
135
+ ## API availability
136
136
 
137
- - **Publish to npm** the package builds and works as a workspace dependency today; publishing under `@sscodeaxis/paywall-sdk` to the public registry (`publishConfig.access: "public"` is already set) is the only step left before third-party developers can `npm install` it directly.
138
-
139
- Everything else this SDK talks to already exists and is verified against a live sscodeaxis `apps/api`: checkout (`/public/plans`, `/checkout-intents`), webhook signature verification, entitlement runtime checks/usage (`/public/runtime/entitlements/*`), license key validation (`/public/runtime/license-keys/validate`), and device registration (`/public/devices`).
137
+ Everything this SDK talks to exists and is verified against the live sscodeaxis `apps/api`: checkout (`/public/plans`, `/checkout-intents`), webhook signature verification, entitlement runtime checks/usage (`/public/runtime/entitlements/*`), license key validation (`/public/runtime/license-keys/validate`), and device registration (`/public/devices`).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sscodeaxis/paywall-sdk",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Server-side SDK for integrating checkout, entitlements, licensing, and webhooks against the SSCodeAxis API.",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",