@sscodeaxis/paywall-sdk 0.1.0 → 0.1.2
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 +10 -4
- package/LICENSE +21 -0
- package/README.md +4 -6
- package/package.json +4 -3
package/CHANGELOG.md
CHANGED
|
@@ -2,14 +2,20 @@
|
|
|
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.
|
|
5
|
+
## 0.1.2 — 2026-09-10
|
|
6
|
+
|
|
7
|
+
- Licensed under MIT (was `UNLICENSED`, which gave nobody legal permission to actually use the package) and added a `LICENSE` file to the published tarball.
|
|
8
|
+
|
|
9
|
+
## 0.1.1 — 2026-08-31
|
|
10
|
+
|
|
11
|
+
- Updated npm installation and API availability documentation after the public release.
|
|
12
|
+
|
|
13
|
+
## 0.1.0 — 2026-08-31
|
|
6
14
|
|
|
7
15
|
Initial version. Covers all 5 planned phases:
|
|
8
16
|
|
|
9
17
|
- **Core client** — `PaywallSDK`, API-key auth, typed `SdkApiError`/`SdkConfigError`.
|
|
10
|
-
- **Checkout & catalog** — `listPlans`, `createIntent`, `getIntent`, `completeIntent`.
|
|
18
|
+
- **Checkout & catalog** — `listPlans`, `createIntent`, `getIntent`, `completeIntent`.
|
|
11
19
|
- **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
20
|
- **Webhooks** — `constructWebhookEvent` (HMAC-SHA256 verification, matching `apps/api/src/webhooks/webhook-dispatch.service.ts`'s signing scheme exactly).
|
|
13
21
|
- **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/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SSCodeAxis
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
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)
|
|
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
|
-
|
|
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
|
-
##
|
|
135
|
+
## API availability
|
|
136
136
|
|
|
137
|
-
|
|
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.
|
|
3
|
+
"version": "0.1.2",
|
|
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",
|
|
@@ -13,7 +13,8 @@
|
|
|
13
13
|
"files": [
|
|
14
14
|
"dist",
|
|
15
15
|
"README.md",
|
|
16
|
-
"CHANGELOG.md"
|
|
16
|
+
"CHANGELOG.md",
|
|
17
|
+
"LICENSE"
|
|
17
18
|
],
|
|
18
19
|
"publishConfig": {
|
|
19
20
|
"access": "public"
|
|
@@ -32,7 +33,7 @@
|
|
|
32
33
|
"webhooks",
|
|
33
34
|
"sdk"
|
|
34
35
|
],
|
|
35
|
-
"license": "
|
|
36
|
+
"license": "MIT",
|
|
36
37
|
"devDependencies": {
|
|
37
38
|
"@types/node": "catalog:",
|
|
38
39
|
"typescript": "catalog:",
|