@proveanything/smartlinks 2.0.17 → 2.0.18

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.
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 2.0.17 | Generated: 2026-09-24T09:42:39.649Z
3
+ Version: 2.0.18 | Generated: 2026-09-24T11:49:54.037Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -1,12 +1,17 @@
1
1
  # SmartLinks Theme Tokens — host theming contract
2
2
 
3
- Status: **v1 (draft) — FORTHCOMING, not yet live host-side.**
4
- > ⚠️ **Do not build apps against this yet.** The host (Hub/Portal) does not yet set `--sl-*` tokens
5
- > or send `smartlinks:root-state`. Until it does, apps follow the **current** theming — see
6
- > [`theme.system.md`](./theme.system.md) (`useSmartLinksTheme()` + shadcn vars `--primary`/`--background`,
7
- > the `?theme=` base64 payload). This document is the target model that will supersede it once the host
8
- > serves it; it exists so the SDK preset (`theme.css`), the iframe bootstrap (`theme-boot.js`) and the
9
- > Hub theme engine can be built against a fixed contract.
3
+ Status: **v1 — live. This is the theming contract to build against.**
4
+ > ✅ **Adopt this.** The R5 host (Hub/Portal) sets the `--sl-*` tokens on your mount root and sends
5
+ > `smartlinks:root-state` for live viewer-preference changes; the SDK preset (`theme.css`), the iframe
6
+ > bootstrap (`theme-boot.js`) and the Hub theme engine all speak this contract. Bind your app to these
7
+ > tokens (via `theme.css`) and it is themed by every host, forever, with no per-app theme code.
8
+ >
9
+ > **It degrades gracefully, so adoption is safe.** `theme.css` ships sensible fallback values for every
10
+ > token, so on a host that hasn't enabled token theming yet the app simply renders with neutral
11
+ > defaults rather than breaking. The legacy path (`useSmartLinksTheme()` + shadcn `--primary`/`--background`
12
+ > via the `?theme=` payload, see [`theme.system.md`](./theme.system.md)) still works during the
13
+ > transition, and [step 17] shows how to bridge shadcn variables to these tokens so both paths stay live.
14
+ > New work should bind to the tokens here.
10
15
 
11
16
  Applies to: `@proveanything/smartlinks` ^2.0 (R5), container + widget embeds
12
17
  Companion to: [`css-baseline.md`](./css-baseline.md) (mechanics, live) — this doc is **brand** (colour, shape, type)
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 2.0.17 | Generated: 2026-09-24T09:42:39.649Z
3
+ Version: 2.0.18 | Generated: 2026-09-24T11:49:54.037Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -1,12 +1,17 @@
1
1
  # SmartLinks Theme Tokens — host theming contract
2
2
 
3
- Status: **v1 (draft) — FORTHCOMING, not yet live host-side.**
4
- > ⚠️ **Do not build apps against this yet.** The host (Hub/Portal) does not yet set `--sl-*` tokens
5
- > or send `smartlinks:root-state`. Until it does, apps follow the **current** theming — see
6
- > [`theme.system.md`](./theme.system.md) (`useSmartLinksTheme()` + shadcn vars `--primary`/`--background`,
7
- > the `?theme=` base64 payload). This document is the target model that will supersede it once the host
8
- > serves it; it exists so the SDK preset (`theme.css`), the iframe bootstrap (`theme-boot.js`) and the
9
- > Hub theme engine can be built against a fixed contract.
3
+ Status: **v1 — live. This is the theming contract to build against.**
4
+ > ✅ **Adopt this.** The R5 host (Hub/Portal) sets the `--sl-*` tokens on your mount root and sends
5
+ > `smartlinks:root-state` for live viewer-preference changes; the SDK preset (`theme.css`), the iframe
6
+ > bootstrap (`theme-boot.js`) and the Hub theme engine all speak this contract. Bind your app to these
7
+ > tokens (via `theme.css`) and it is themed by every host, forever, with no per-app theme code.
8
+ >
9
+ > **It degrades gracefully, so adoption is safe.** `theme.css` ships sensible fallback values for every
10
+ > token, so on a host that hasn't enabled token theming yet the app simply renders with neutral
11
+ > defaults rather than breaking. The legacy path (`useSmartLinksTheme()` + shadcn `--primary`/`--background`
12
+ > via the `?theme=` payload, see [`theme.system.md`](./theme.system.md)) still works during the
13
+ > transition, and [step 17] shows how to bridge shadcn variables to these tokens so both paths stay live.
14
+ > New work should bind to the tokens here.
10
15
 
11
16
  Applies to: `@proveanything/smartlinks` ^2.0 (R5), container + widget embeds
12
17
  Companion to: [`css-baseline.md`](./css-baseline.md) (mechanics, live) — this doc is **brand** (colour, shape, type)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "2.0.17",
3
+ "version": "2.0.18",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",