@zambon-dev/shared 2.1.1 → 2.1.2

package/CHANGELOG.md

@@ -23,6 +23,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### ⚠ Breaking Changes / Migration
 
+## [2.1.2] - 2026-09-20
+
+### Fixed
+
+- Declared `rxjs` and `@angular/platform-browser` in `peerDependencies`. `DomSanitizer` is used by
+  `ExternalContentComponent` and `BypassHtmlSanitizerPipe`, but neither package was declared.
+- Added a README to the published package.
+
 ## [2.1.1] - 2026-09-15
 
 ### Fixed
@@ -321,7 +329,8 @@ URL) in `AppConfig`, and implement a hub that pushes the notification list to cl
   available via [GitHub Releases](https://github.com/RicardoZambon/ZLibraries/releases) and the
   `shared-v*` tags.
 
-[Unreleased]: https://github.com/RicardoZambon/ZLibraries/compare/shared-v2.1.1...HEAD
+[Unreleased]: https://github.com/RicardoZambon/ZLibraries/compare/shared-v2.1.2...HEAD
+[2.1.2]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v2.1.2
 [2.1.1]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v2.1.1
 [2.1.0]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v2.1.0
 [2.0.0]: https://github.com/RicardoZambon/ZLibraries/releases/tag/shared-v2.0.0

package/README.md

@@ -0,0 +1,107 @@
+# @zambon-dev/shared
+
+Shared Angular services, utilities, and styles for Zambon applications.
+
+This is the top layer of [ZLibraries](https://github.com/RicardoZambon/ZLibraries). It supplies
+authentication, layouts, history features and cross-cutting services, and builds on both
+[`@zambon-dev/library`](https://www.npmjs.com/package/@zambon-dev/library) and
+[`@zambon-dev/framework`](https://www.npmjs.com/package/@zambon-dev/framework).
+
+## Installation
+
+```bash
+npm install @zambon-dev/shared
+```
+
+### Peer dependencies
+
+All peers must be present in the consuming application:
+
+| Package | Range |
+| --- | --- |
+| `@angular/common` | `^19.1.0` |
+| `@angular/core` | `^19.1.0` |
+| `@angular/forms` | `^19.1.0` |
+| `@angular/platform-browser` | `^19.1.0` |
+| `@angular/router` | `^19.1.0` |
+| `@auth0/angular-jwt` | `^5.2.0` |
+| `@microsoft/signalr` | `^10.0.0` |
+| `@ngx-translate/core` | `^16.0.4` |
+| `@zambon-dev/framework` | `^1.0.0` |
+| `@zambon-dev/library` | `^1.0.0` |
+| `ngx-translate-multi-http-loader` | `^19.0.2` |
+| `rxjs` | `^7.8.0` |
+
+## Usage
+
+### Authentication
+
+`SharedAuthModule` bundles the guard and HTTP interceptors. `AuthenticationService` handles sign-in, token
+storage (`localStorage` or `sessionStorage` depending on "remember me") and refresh.
+
+```ts
+import { AuthenticationService } from '@zambon-dev/shared';
+
+const service = inject(AuthenticationService);
+await firstValueFrom(service.authenticate(username, password, rememberMe));
+```
+
+Route protection uses the exported guard:
+
+```ts
+import { AuthGuard } from '@zambon-dev/shared';
+
+export const routes: Routes = [
+  { path: 'orders', component: OrdersComponent, canActivate: [AuthGuard] },
+];
+```
+
+Unauthenticated visitors are redirected to `/login` with a `returnUrl` query parameter.
+
+### Layouts and features
+
+`MainLayoutComponent` provides the application shell. Self-contained features ship with their own routes —
+for example `externalContentRoutes` for `ExternalContentComponent`.
+
+## Styles
+
+```scss
+@use '@zambon-dev/shared/styles' as shared;
+```
+
+That entry point resolves to `styles/common.scss`; design tokens are separately reachable at
+`@zambon-dev/shared/styles/variables`.
+
+## Translations
+
+```ts
+import translations from '@zambon-dev/shared/i18n/en.json';
+```
+
+## What's included
+
+**Services** — `AuthenticationService`, `ExternalContentService`, `ExternalUrlResolverService`,
+`NotificationsService` (SignalR-backed), `OperationsHistoryService`, `ServicesHistoryService`
+
+**Auth** — `SharedAuthModule`, route guards, HTTP interceptors
+
+**Features** — external content, operations history, services history
+
+**Layouts** — `MainLayoutComponent` and supporting shell components
+
+Components, models and pipes are exported from the package root as well.
+
+## Documentation
+
+```bash
+npm run storybook:shared
+```
+
+## Contributing
+
+See the [workspace README](https://github.com/RicardoZambon/ZLibraries#readme) for the development setup,
+and [CHANGELOG.md](./CHANGELOG.md) for release history.
+
+## License
+
+MIT © Ricardo Zambon

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zambon-dev/shared",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Shared Angular services, utilities, and styles for Zambon applications.",
   "keywords": [
     "angular",
@@ -25,13 +25,15 @@
     "@angular/common": "^19.1.0",
     "@angular/core": "^19.1.0",
     "@angular/forms": "^19.1.0",
+    "@angular/platform-browser": "^19.1.0",
     "@angular/router": "^19.1.0",
     "@auth0/angular-jwt": "^5.2.0",
     "@microsoft/signalr": "^10.0.0",
+    "@ngx-translate/core": "^16.0.4",
     "@zambon-dev/framework": "^1.0.0",
     "@zambon-dev/library": "^1.0.0",
-    "@ngx-translate/core": "^16.0.4",
-    "ngx-translate-multi-http-loader": "^19.0.2"
+    "ngx-translate-multi-http-loader": "^19.0.2",
+    "rxjs": "^7.8.0"
   },
   "publishConfig": {
     "access": "public"