@synerise/ds-section-message 1.0.38 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.0.0](https://github.com/Synerise/synerise-design/compare/@synerise/ds-section-message@1.0.39...@synerise/ds-section-message@2.0.0) (2026-08-26)
+
+**Note:** Version bump only for package @synerise/ds-section-message
+
+## [1.0.39](https://github.com/Synerise/synerise-design/compare/@synerise/ds-section-message@1.0.38...@synerise/ds-section-message@1.0.39) (2026-07-23)
+
+**Note:** Version bump only for package @synerise/ds-section-message
+
 ## [1.0.38](https://github.com/Synerise/synerise-design/compare/@synerise/ds-section-message@1.0.37...@synerise/ds-section-message@1.0.38) (2026-06-17)
 
 **Note:** Version bump only for package @synerise/ds-section-message

package/CLAUDE.md

@@ -0,0 +1,123 @@
+# SectionMessage (`@synerise/ds-section-message`)
+
+> A themed alert/banner component that displays a message with a type-specific icon, optional description, actions, and a close button.
+
+## Package structure
+
+```
+src/
+ SectionMessage.tsx — main component
+ SectionMessage.types.ts — prop types and union types
+ SectionMessage.const.tsx — ICONS map and DEFAULT_ICON
+ SectionMessage.styles.tsx — styled-components
+ SectionMessage.utils.tsx — color helpers and isSectionType guard
+ index.ts — public exports
+ modules.d.ts — jest-dom augmentation
+ __specs__/
+ SectionMessage.spec.tsx — Vitest tests
+```
+
+## Public exports
+
+```ts
+export default SectionMessage;
+export type { SectionMessageProps, SectionType, CustomColorType };
+```
+
+### `SectionMessage`
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `type` | `SectionType` | — (required) | Visual variant; drives background, border and icon colours |
+| `message` | `ReactNode` | — | Bold heading text |
+| `description` | `ReactNode` | — | Regular-weight body text rendered below the message |
+| `icon` | `ReactNode` | type-derived icon | Overrides the automatic icon for the given type |
+| `customIcon` | `ReactElement` | — | Renders the element directly (bypasses `<Icon>` wrapper); takes precedence over `icon` |
+| `customColor` | `CustomColorType` | — | Overrides the background and border colours using the palette |
+| `customColorIcon` | `CustomColorType` | — | Overrides the icon and top-border colour |
+| `showMoreLabel` | `ReactNode` | — | Label for the "show more" link; only rendered when `onShowMore` is also provided |
+| `onShowMore` | `() => void` | — | Click handler for the "show more" link; requires `showMoreLabel` |
+| `onClose` | `() => void` | — | Called when the close button is clicked; only active when `withClose` is truthy |
+| `withClose` | `ReactNode` | — | When truthy, shows a close (`CloseM`) button; actual value is unused — only truthiness matters |
+| `suffixel` | `ReactNode` | — | Content placed in the right-hand action area, before the close button |
+| `moreButtons` | `ReactNode` | — | Additional action buttons rendered inside the content area |
+| `withEmphasis` | `ReactNode` | — | Bold inline content; only rendered when `withLink` is falsy |
+| `withLink` | `ReactNode` | — | Underlined link content; rendered instead of `withEmphasis`; also adjusts content area padding |
+| `unorderedList` | `ReactNode` | — | List content; only rendered when `moreButtons` is falsy |
+| `color` | `ColorType` | — | **Deprecated** — use `customColor` instead |
+
+All standard `HTMLDivElement` attributes are forwarded to the root `<div>` via `WithHTMLAttributes`.
+
+### Type aliases
+
+```ts
+type SectionType = 'positive' | 'notice' | 'negative' | 'neutral' | 'supply' | 'service' | 'entity';
+
+type CustomColorType =
+ | 'blue' | 'grey' | 'red' | 'green' | 'yellow'
+ | 'pink' | 'mars' | 'orange' | 'fern' | 'cyan' | 'purple' | 'violet';
+
+/** @deprecated */
+type ColorType = 'grey' | 'red' | 'green' | 'yellow' | 'violet' | 'purple' | 'cyan';
+```
+
+## Usage patterns
+
+```tsx
+import SectionMessage from '@synerise/ds-section-message';
+
+// Basic
+<SectionMessage type="negative" message="Payment failed" description="Please check your card details." />
+
+// With close button
+<SectionMessage type="notice" message="Maintenance window" withClose onClose={() => setVisible(false)} />
+
+// Custom colour override
+<SectionMessage type="neutral" message="Info" customColor="pink" customColorIcon="pink" />
+
+// Show more + suffix actions
+<SectionMessage
+ type="positive"
+ message="Import complete"
+ showMoreLabel="See details"
+ onShowMore={handleDetails}
+ suffixel={<Button>Undo</Button>}
+/>
+```
+
+## Styling
+
+All colours are derived from the design-system theme palette using the `type` prop:
+
+| `type` | Background | Border | Icon / top-border |
+|--------|-----------|--------|-------------------|
+| `positive` | `green-050` | `green-200` | `green-600` |
+| `negative` | `red-050` | `red-200` | `red-600` |
+| `notice` | `yellow-050` | `yellow-200` | `yellow-600` |
+| `neutral` | `grey-050` | `grey-200` | `grey-600` |
+| `supply` | `violet-050` | `violet-200` | `violet-600` |
+| `service` | `purple-050` | `purple-200` | `purple-600` |
+| `entity` | `cyan-050` | `cyan-200` | `cyan-600` |
+
+When `customColor` / `customColorIcon` are set, they use the same palette pattern (`<color>-050`, `<color>-200`, `<color>-600`) and fully override the type-derived values.
+
+The component has a `border-radius: 2px` and a thicker `border-top: 2px` that carries the accent colour.
+
+Several styled components (`NumberWrapper`, `OrderWrapper`, `IconOrderWrapper`, `Wrapper`) are defined in `SectionMessage.styles.tsx` but are not used in `SectionMessage.tsx` — they appear to be legacy/unused.
+
+## Key dependencies
+
+- `@synerise/ds-icon` — `Icon` wrapper component plus icon components (`Check2M`, `WarningM`, `InfoM`, `NotificationsReceiveM`, `UpdateDataM`, `UserUpM`, `CloseM`)
+- `@synerise/ds-utils` — `WithHTMLAttributes` utility type
+- `@synerise/ds-core` — `ThemePropsVars` (for colour helpers), `renderWithProvider` in tests
+
+## Implementation notes
+
+- `customIcon` takes a `ReactElement` and is rendered directly as a child of `IconWrapper`, bypassing the `<Icon component={..}>` wrapper. `icon` (type `ReactNode`) is passed as the `component` prop to `<Icon>`.
+- `withClose` controls visibility of the close button but the close action fires `onClose` — both props must be set together for the button to work.
+- `showMoreLabel` is only rendered when `onShowMore` is also provided (both must be truthy).
+- `unorderedList` is suppressed when `moreButtons` is truthy.
+- `withEmphasis` is suppressed when `withLink` is truthy.
+- The `data-testid` on the root element is `ds-section-message-${type}`.
+- `isSectionType` is a type-guard used internally to validate the `type` prop before indexing `ICONS`.
+- The package uses **Jest** (not Vitest) for testing.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synerise/ds-section-message",
-  "version": "1.0.38",
+  "version": "2.0.0",
   "description": "SectionMessage UI Component for the Synerise Design System",
   "license": "ISC",
   "repository": "Synerise/synerise-design",
@@ -17,6 +17,7 @@
   "files": [
     "/dist",
     "CHANGELOG.md",
+    "CLAUDE.md",
     "README.md",
     "package.json",
     "LICENSE.md"
@@ -41,8 +42,8 @@
   ],
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@synerise/ds-icon": "^1.18.4",
-    "@synerise/ds-utils": "^1.10.1"
+    "@synerise/ds-icon": "^2.0.0",
+    "@synerise/ds-utils": "^2.0.0"
   },
   "peerDependencies": {
     "@synerise/ds-core": "*",
@@ -50,5 +51,5 @@
     "styled-components": "^5.3.3",
     "vitest": "4"
   },
-  "gitHead": "d8c64070f58f14e3fb1bfbcbf00d1e3b8fd51eb8"
+  "gitHead": "033854a18f038079e9a16b0ff250f8401a2287c2"
 }