@espressif/dashboard-ui-components 1.0.0 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,172 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres
+to [Semantic Versioning](https://semver.org/).
+
+## [1.1.1] - 2026-08-04
+
+A patch release with no API changes: a much smaller published bundle, a wider default
+sidebar, and a fix to the internal release script. No component props were added,
+removed or renamed.
+
+### Added
+- `.webp` is now a recognised asset type: declared in the ambient asset typings and
+  inlined by the build, so `import bg from './x.webp'` behaves like the other image
+  formats.
+
+### Changed
+- `EntryLayout`'s default background ships as WebP instead of JPEG — the same artwork at
+  the same 1836×1092 dimensions, but **~338 KB smaller in the published bundle**. The
+  asset is inlined as a data URL, so it accounted for ~523 KB base64-encoded before and
+  ~186 KB now. Apps that pass their own `backgroundImage` are unaffected either way.
+- Default `--espd-sidebar-width` raised from `256px` to `288px`, giving nested sidebar
+  items and longer group labels more room before they truncate. This is a visual change
+  for apps that use the default; redeclare the token after the styles import to keep the
+  old width.
+
+### Internal
+Nothing in this section affects the published package — it covers the release tooling and
+the demo app, neither of which ships to consumers.
+
+- Release script: the version-bump and promote MRs are no longer merged the instant they
+  are created. GitLab computes mergeability asynchronously, and merging into that window
+  answers a bare `405 Method Not Allowed` — which is what broke the `v1.1.0` release
+  after eleven releases won the race by luck. The script now polls
+  `detailed_merge_status` until the MR is actually mergeable, retries `405`/`409` a few
+  times, and bails out immediately on the states that need a human (conflicts, drafts,
+  unresolved threads, missing approvals). Timeout and poll interval are tunable via
+  `RELEASE_MERGE_TIMEOUT` and `RELEASE_MERGE_POLL_INTERVAL`; failures now print the last
+  status GitLab reported instead of only the HTTP code.
+- Demo app: a search field in the header that jumps to any component page, with a `⌘K` /
+  `Ctrl K` shortcut to focus it. Matching is substring-based rather than cmdk's default
+  fuzzy scoring, so "tab" ranks `Tabs` first instead of burying it under subsequence
+  matches, and hyphens are ignored so "datatable" finds `data-table`.
+
+## [1.1.0] - 2026-08-03
+
+A maintenance release: one new component, a few new props, and fixes to the sidebar,
+inputs, scrollable sections and data table. No breaking changes — existing code keeps
+working as before.
+
+### Added
+- **`RequirementList`** — a new component that shows which conditions a value meets and
+  which it does not: a green check for met items, a muted hollow circle for the rest.
+  Built for password rules under an `InputPassword`, but not password-specific. Three
+  sizes, and updates are announced to screen readers as the user types.
+- `Alert`: `dismissible` adds a close button that hides the alert, with `onDismiss` to
+  react to it and `dismissLabel` for the accessible label. It sits alongside any actions
+  you already pass instead of replacing them.
+- `MonospaceContent`: `mask` hides the value behind dots — for API keys, passwords and
+  similar secrets — with an eye toggle to reveal it. Copying always copies the real
+  value. Set `allowUnmask={false}` to keep it hidden for good. Masking is a UI guard,
+  not a security boundary: the value is still in the page.
+- `CopiableText`: `actions` adds your own controls next to the copy button, and
+  `alwaysShowActions` keeps them visible instead of only on hover.
+- `SectionCard`: `truncateSecondaryText={false}` lets the secondary text wrap over as
+  many lines as it needs, instead of being cut to one line with a tooltip.
+- `DataTable`: `pageSizeOptions` sets the page sizes offered in the selector, so it can
+  match what your API accepts. Defaults to the page sizes used until now (exported as
+  `DEFAULT_PAGE_SIZE_OPTIONS`); pass `[]` to hide the selector.
+
+### Fixed
+- `Input`: add-ons now combine with icons, floating labels and the character counter —
+  previously only one of them showed at a time, and the password show/hide toggle
+  disappeared when an add-on was used. The counter and a trailing icon no longer
+  overlap, and both helper texts are read out correctly by screen readers.
+- `Sidebar`: the selected item is now clearly highlighted, and stays recognisable when
+  the sidebar is collapsed. Icons are one consistent size everywhere (items, groups,
+  chevrons and row actions), rows line up at equal height, nested items are indented
+  more clearly, long group labels truncate instead of growing the row, and items with
+  no icon show a small neutral dot instead of an initials avatar.
+- `Sidebar`: selection no longer bleeds between sibling pages whose paths share a
+  prefix — on `/components/input-password`, `/components/input` stays unselected.
+  Sub-pages still highlight their parent item.
+- `ScrollableSections`: on mobile the section picker now stays pinned to the top while
+  you scroll, and picking a section no longer leaves its heading hidden behind the
+  picker. Long tab labels wrap instead of overflowing the column, and the active-tab
+  highlight repositions itself correctly after a resize.
+- `DataTable`: the page-size selector is hidden when no `onPageSizeChange` handler is
+  given — it used to be shown even though picking a size did nothing. A current page
+  size outside the offered list also stays selectable.
+- `SectionCard`: the header icon is aligned to the middle of the header, and very long
+  words wrap instead of spilling out of the card.
+
+## [1.0.0] - 2026-07-31
+
+First public npm release.
+
+### Added
+- `MarkdownContent`: renders a markdown string using the library's own primitives
+  (`Typography`, `Code`, `Link`, `Table`, `Separator`), with GitHub-flavoured markdown
+  via `remark-gfm` and heading anchors via `rehype-slug`. Raw HTML in the source is
+  escaped rather than parsed, so no sanitizer is involved and embedded HTML does not
+  render. `react-markdown`, `remark-gfm` and `rehype-slug` are regular dependencies —
+  external to the bundle, but installed with the package, so consumers need no extra
+  install step.
+- `AppLogo` preset `rainmaker-classic` (light/dark × full/minimal assets), also
+  selectable as `WorkspaceLayout` / `EntryLayout` `appName`.
+- `Sidebar`: on mobile the sheet header now has a close button, and tapping a menu
+  item closes the sheet after navigating.
+- Apache-2.0 `LICENSE`, `NOTICE`, and `THIRD-PARTY-NOTICES.md`.
+- SPDX license headers (`SPDX-FileCopyrightText` + `SPDX-License-Identifier:
+  Apache-2.0`) on all source files, and `publishConfig.access: "public"` —
+  aligning with Espressif's other open-source TypeScript SDKs
+  (e.g. `@espressif/rainmaker-base-sdk`).
+
+### Changed
+- Standardized the copyright holder to **`Espressif Systems (Shanghai) CO LTD`**
+  across `LICENSE`, `NOTICE`, and `package.json` `author`, matching the wording
+  used in Espressif's other public repositories.
+- **BREAKING:** minimum supported runtime for consumers raised to **Node.js 20.19**
+  (`engines.node: ">=20.19.0"`), driven by the `shiki@4` alignment below. The `npm`
+  constraint was dropped from `engines` entirely — it only ever affected consumers.
+- Published to **public npm** under `@espressif` (previously internal GitLab
+  registry only).
+- Font stack now relies on `--font-sans`; consumers supply their own typeface.
+- `shiki` runtime dependency aligned to `^4` (matches the tested version). This is
+  what sets the Node 20.19 floor.
+
+### Security
+- `postcss` updated to `8.5.25` — fixes path traversal in previous-source-map
+  auto-loading ([GHSA-r28c-9q8g-f849](https://github.com/advisories/GHSA-r28c-9q8g-f849),
+  high). Build-time dependency; the published bundle is unaffected.
+- `esbuild` pinned to `^0.28.1` via `overrides` — fixes arbitrary file read in the
+  esbuild dev server on Windows
+  ([GHSA-g7r4-m6w7-qqqr](https://github.com/advisories/GHSA-g7r4-m6w7-qqqr), low).
+  The override exists because `tsup@8.5.1` still caps `esbuild` at `^0.27.0`; remove
+  it once tsup widens that range.
+
+### Removed
+- **BREAKING:** the `CustomIcon` component and its exports
+  (`CustomIcon`, `customIconRegistry`, `customIconIds`, `CustomIconProps`,
+  `CustomIconId`). It only rendered third-party brand logos; use
+  [`lucide-react`](https://lucide.dev) (already a dependency) or your own SVGs
+  instead.
+- **BREAKING:** bundled font binaries (Maison Neue, Trueno) and the `--font-*`
+  Tailwind families for them. Set `--font-sans` in your app to choose a typeface.
+
+### Internal
+Repository and CI changes only — no effect on the published package.
+
+- CI: `test` job (build, typecheck, unit tests) on the `node:24.18` image.
+- CI: dual-publish — the same tarball is published to public npm and the
+  internal GitLab registry from one tag pipeline.
+- Development toolchain pinned to **Node 24.18.1 / npm 11.16.0** via `.nvmrc` and
+  `.node-version`, with a `devEngines` floor of Node `>=24.18.0` / npm `>=11.16.0`.
+  `npm ci` and `npm run *` fail with `EBADDEVENGINES` below that floor. The floor is
+  a minor below the pinned version because Docker publishes Node patch image tags a
+  few days after the Node release. This is a contributor requirement only and does
+  not constrain consumers.
+- Install-script review policy: `esbuild` and `fsevents` are recorded in
+  `allowScripts` as the only dependencies permitted to run install scripts.
+
+## Earlier releases
+
+Versions up to and including 0.10.1 were distributed via the internal GitLab
+npm Package Registry only.
+
+`0.11.0` was published briefly to verify the release pipeline end to end and was
+unpublished from public npm; it is not a supported version. `1.0.0` is the first
+supported public release. See the package's
+[npm versions](https://www.npmjs.com/package/@espressif/dashboard-ui-components?activeTab=versions).

package/README.md

@@ -444,7 +444,7 @@ Re-run after upgrading the library to pick up guidance changes. Commit the copie
 | Dialog / ConfirmationDialog / FullscreenDialog | Modal dialogs |
 | Pagination | Page navigation controls |
 | Badge | Status and label badges |
-| Alert | Alert banners |
+| Alert | Alert banners (optionally dismissible) |
 | Link | Styled anchor element |
 | Code | Syntax-highlighted code blocks |
 | MarkdownContent | Renders a markdown string with library primitives (GFM, heading anchors; raw HTML is escaped, not parsed) |
@@ -455,6 +455,7 @@ Re-run after upgrading the library to pick up guidance changes. Commit the copie
 | PreviewCard | Content preview card |
 | PageContainer | Page wrapper with header |
 | DynamicList | Dynamic item list |
+| RequirementList | Met/unmet checklist (password rules, prerequisites); check for satisfied rows, muted circle for outstanding ones, with screen-reader state labels |
 | TogglableItemsList | Toggleable item list |
 | GlitchText / GradientText / HighlightText / ShimmeringText | Text effects |
 | LottieAnimationContainer | Lottie animation wrapper |