@riverbankcms/sdk 0.130.0 → 0.132.0

package/CHANGELOG.md

@@ -0,0 +1,85 @@
+# Changelog — `@riverbankcms/sdk`
+
+Notable changes to the SDK's public contracts. Releases go out through the
+release coordinator (`pnpm release sdk …`), so an entry sits under *Unreleased*
+until the next version ships and then gets the version it went out in.
+
+## Unreleased
+
+### Breaking: the `transparent` header variant is gone
+
+- **`Layout`'s `headerVariant` prop no longer accepts `'transparent'`.** The
+  union narrows from `'classic' | 'centered' | 'transparent' | 'floating'` to
+  `'classic' | 'centered' | 'floating'`. The variant never had any CSS of its
+  own, and everything it did — a transparent header background and content
+  flowing underneath an overlay header — is what `'floating'` already does, so
+  `headerVariant="floating"` is the replacement and should render the same.
+  - If you have a persisted theme that still says `variant: 'transparent'`, it
+    keeps working: the theme parse boundary reads the old spelling as
+    `floating`. Only the TypeScript prop is narrowed.
+
+### Card contracts (issue #1297 follow-up)
+
+Additive throughout — every value that parsed before still parses, so no
+consumer needs to change anything.
+
+- **`FeatureCard.surfaceRole` speaks the card-role vocabulary.** The union
+  widens from `'open' | 'panel'` to `'none' | 'open' | 'default' | 'alternative'
+  | 'panel'`. `panel` is a permanent alias of the `alternative` role, and `open`
+  keeps its historical meaning (an unmarked boxless card, which is role `none`)
+  rather than the `open` role. The exported type is
+  `FeatureCardSurfaceRole`. The `data-surface-role` attribute still carries the
+  authored value, so composition CSS selecting `[data-surface-role="open"]` is
+  unaffected.
+  - Worth knowing if you author the new spellings: the role values give you the
+    card surface but not the editorial-diptych composition. `'panel'` gets both
+    `.card-role-alternative` and the `[data-surface-role="panel"]` rules (the
+    filled media frame and background that variant's layout expects), while
+    `'alternative'` gets the card surface only. The two spellings of "statement
+    card" are therefore not interchangeable inside `editorial-diptych`.
+- **`CardStylesContent` names a card surface with `role`.** Persisted
+  `cardVariant` values are repaired to `role` by the release migration; the SDK
+  and renderer no longer expose a parallel compatibility field.
+- **Missing compiled fields declared.** `MediaTextContent._frameStyles`,
+  `CollectionContent._cardStyles` and `EventCalendarContent._containerStyles`
+  are now part of the SDK's block content types, alongside the card fields on
+  team-members and media-text.
+- **`EventCalendarContent` catches up with the block**: `variant`,
+  `paginationMode`, `seeAllUrl`, `showCapacity`, `boardTitle`, `footerNote`,
+  `elevated` and `banded`.
+- **`EventSurfacePreset` gains `'term'`**, which the events blocks have accepted
+  for a while.
+- **Theme bridge: `open` is the boxless card it claims to be.** A bridge theme's
+  `.card-role-open` now renders the boxless marked card the role contract
+  describes (transparent, a hairline plus a short accent, no elevation) instead
+  of the fully outlined box. `.card-outlined` keeps its old declarations as a
+  compatibility class with no role attached; naming it in
+  `components.cards.variants` enables that class only.
+  - **Fixed**: a bridge `open` card's media no longer keeps rounded top corners
+    while its container is square. Card media radii now resolve from the same
+    per-corner geometry as the container, so a variant that overrides its
+    corners overrides its media edge too.
+- **`FeatureCardSurfaceRole` states the `open` exception in the type.** The
+  union is now built as `Exclude<CardRole, 'open'> | FeatureCardLegacySurfaceRole`
+  (`FeatureCardLegacySurfaceRole = 'open' | 'panel'`, also exported). The set of
+  accepted strings is unchanged — this is a documentation-in-types change, not a
+  behaviour change — but it now says out loud that `open` reaches this field
+  only as a legacy spelling. **The canonical `open` role is permanently
+  unaddressable per item on a feature card**: the alias always wins and maps it
+  to role `none`. A card that should render the marked boxless `open` surface
+  gets it from the block's card role, not from `surfaceRole`.
+- **`CardRole` is exported.** The canonical card-role vocabulary
+  (`'none' | 'open' | 'default' | 'alternative'`) is now a named public type
+  rather than being spelled out inline, and a typetest pins it equal to
+  theme-core's in both directions so the two cannot drift.
+- **Theme bridge: card role CSS is no longer opt-in.** `.card-role-default`,
+  `.card-role-alternative` and `.card-role-open` now emit from
+  `buildThemeBridgeRuntime` whether or not you configure `components.cards`.
+  They are the surface contract compiled content renders against, so a bridge
+  theme that omitted them left role-styled blocks unstyled. `components.cards`
+  continues to govern the named `.card-default` / `.card-elevated` /
+  `.card-outlined` catalogue exactly as before, including its `variants`
+  allow-list.
+- **`CHANGELOG.md` ships in the published package.** It was written but not in
+  the `files` allowlist, so installed copies of the SDK had no release record.
+  The packed-package check now asserts its presence.

package/README.md

@@ -988,7 +988,7 @@ Override the header variant from your code:
 ```tsx
 <Layout
   siteData={siteData}
-  headerVariant="centered"  // Options: classic, centered, transparent, floating, editorial
+  headerVariant="centered"  // Options: classic, centered, floating
 >
   <main>Content with centered header</main>
 </Layout>