@zambon-dev/shared 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,95 @@
+# Changelog
+
+All notable changes to `@zambon-dev/shared` are documented in this file.
+
+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/spec/v2.0.0.html).
+
+> **Upgrading?** Each release lists what changed and, under
+> **⚠ Breaking Changes / Migration**, the concrete steps required to move to that version.
+> When no migration is needed, that subsection is omitted.
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### ⚠ Breaking Changes / Migration
+
+## [1.1.0] - 2026-07-24
+
+### Added
+
+- New application top bar (`shared-top-bar`), rendered by `MainLayoutComponent`, composing the
+  brand (app name, company name, optional logo), an environment badge, notifications, the language
+  selector, and the user profile — alongside the existing sidebar-collapse and logout controls.
+- `NotificationsService` (root-provided) that streams notifications from a **SignalR hub**. It
+  exposes `getNotifications()`, `getUnreadCount()`, `markAsRead()`, `markAllAsRead()`, `start()`,
+  `stop()`, and an `isEnabled` flag. When enabled it connects (authenticated with the current JWT)
+  to `AppConfig.notificationsUrl` and listens for the server's `ReceiveNotifications` push. The top
+  bar drives it — apps do not call it directly.
+- The notifications feature is toggleable and configurable via `AppConfig.notificationsEnabled` and
+  `AppConfig.notificationsUrl`; when disabled (or no URL is set) the bell is not rendered.
+- Notifications show an icon, title, and description, and — when a `callToActionUrl` is present —
+  clicking navigates to it (internal routes via the Angular router, external URLs in a new tab).
+- Individually reusable top-bar components: `BrandComponent`, `EnvironmentBadgeComponent`,
+  `NotificationsComponent`, `UserProfileComponent`, and the composing `TopBarComponent`.
+- `top-bar` i18n bundle (`en`/`pt`) registered in `ZAMBON_SHARED_I18N_RESOURCES`.
+- New peer dependency `@microsoft/signalr` (^10.0.0), used by `NotificationsService`.
+- `LanguageSelectorComponent` gained a `showFlag` input; when `true` the toggle shows the current
+  language's flag on a light-gray button instead of the text label (used by the top bar; the login
+  page keeps the text label).
+- `MainLayoutComponent` projects the application version (`AppConfig.version`) into the sidebar's
+  footer slot, shown at the bottom of the navigation when set.
+
+### Changed
+
+- `ICurrentUserInfo` gained optional `pictureUrl` and `position` fields, displayed in the top-bar
+  user profile. The avatar falls back to the user's initials when `pictureUrl` is absent, and the
+  position line is hidden when `position` is empty.
+- **`INotification` redefined** to `{ title, description, icon, callToActionUrl?, isRead }` (was
+  `{ id, title, message, read, createdAt }`) to match the SignalR hub contract.
+- The top bar no longer renders a sidebar-collapse button — the sidebar owns its own collapse/expand
+  toggle. The user profile now uses a light, on-palette surface (neutral chip + brand-colored avatar)
+  instead of the previous dark chip.
+- On small screens (< 768px) the top bar hides the brand text (app name + company; the logo remains)
+  and the entire user profile, for a compact layout.
+- `LanguageSelectorComponent` now renders language flags as self-contained inline SVGs (US for `en`,
+  Brazil for `pt`) instead of `/flags/*.png` background images, in both the flag toggle and the
+  dropdown. The selector no longer depends on app-provided flag assets; apps that supplied custom
+  `/flags/*.png` images will no longer see them in the language selector.
+
+### ⚠ Breaking Changes / Migration
+
+- **`INotification` shape changed** (see above). If you referenced the old fields (`id`, `message`,
+  `read`, `createdAt`), update to `title`, `description`, `icon`, `callToActionUrl`, `isRead`.
+- **Notifications now require `@microsoft/signalr`.** Install it in the consuming app
+  (`npm i @microsoft/signalr`) — it is a peer dependency.
+
+To populate the top bar, provide `appName`, `companyName`, `environment`, and optionally `logoUrl`
+via `AppConfig` options (requires `@zambon-dev/framework` with the new `AppConfig` options). The
+environment badge maps `DEV`/`QA`/`STG` to colors, renders any other non-empty value with a neutral
+style, and is hidden for `PROD` or when no environment is set.
+
+To enable notifications, set `notificationsEnabled: true` and `notificationsUrl` (the SignalR hub
+URL) in `AppConfig`, and implement a hub that pushes the notification list to clients via a
+`ReceiveNotifications` invocation (and optionally handles a `MarkAllAsRead` invoke). See
+`docs/guides/top-bar-configuration.md` for the full consuming-app guide. The user's
+`pictureUrl`/`position` are supplied by the auth response when available.
+
+## [1.0.2] - 2026-05-02
+
+- Baseline release: the changelog starts being tracked from this version. Earlier history is
+  available via [GitHub Releases](https://github.com/RicardoZambon/ZLibraries/releases) and the
+  `shared-v*` tags.
+
+[Unreleased]: https://github.com/RicardoZambon/ZLibraries/compare/shared-v1.1.0...HEAD
+[1.1.0]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v1.1.0
+[1.0.2]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v1.0.2