@dsivd/prestations-ng 19.2.0-beta.3 → 19.2.0-beta.4

package/CHANGELOG.md

@@ -13,6 +13,15 @@
 Library now runs as strict mode, which may cause some errors to appear in your project after updating.
 Please check the [UPGRADING_V19.md](UPGRADING_V19.md) guide for more information.
 
+- [foehn-list-summary.component.ts](projects/prestations-ng/src/foehn-menu-prestation/foehn-list-summary/foehn-list-summary.component.ts)
+    - `FoehnListSummaryComponent` is now generic: `FoehnListSummaryComponent<T extends FoehnListItem>`,
+      so the model, `getListItemTitle` and `listItemDescriptions` are typed with your own item class
+      instead of the base `FoehnListItem`
+- [foehn-list-item-description.ts](projects/prestations-ng/src/foehn-menu-prestation/foehn-list-summary/foehn-list-item-description.ts)
+    - 🚨 `FoehnListItemDescription` now takes a type parameter: `FoehnListItemDescription<T>`.
+      `getFormattedValue(item: T)` and `hideIfEmpty(item: T)` receive your item type directly, no cast needed.
+      Replace `FoehnListItemDescription[]` with `FoehnListItemDescription<MyItem>[]` in your project.
+
 ## [19.1.1]
 
 ### Fixed

package/UPGRADING_V19.md

@@ -1449,6 +1449,42 @@ npm run test
 npm start
 ```
 
+### `foehn-list-summary` is now generic (since 19.2.0)
+
+`FoehnListSummaryComponent` is now `FoehnListSummaryComponent<T extends FoehnListItem>` and `FoehnListItemDescription` now takes a type parameter: `FoehnListItemDescription<T>`.
+Using `FoehnListItemDescription` without its type parameter no longer compiles.
+
+Replace every `FoehnListItemDescription` with `FoehnListItemDescription<MyItem>`, where `MyItem` is your class extending `FoehnListItem`. You can then drop the casts (or `any`) in `getFormattedValue` and `hideIfEmpty`:
+
+Before:
+
+```typescript
+getListItemsDescription(): FoehnListItemDescription[] {
+    return [
+        {
+            label: 'Name',
+            getFormattedValue: (item: FoehnListItem) =>
+                (item as MyItem).name ?? '',
+        },
+    ];
+}
+```
+
+After:
+
+```typescript
+getListItemsDescription(): FoehnListItemDescription<MyItem>[] {
+    return [
+        {
+            label: 'Name',
+            getFormattedValue: (item: MyItem) => item.name ?? '',
+        },
+    ];
+}
+```
+
+The same applies to the function passed to `getListItemTitle`, which now receives a `MyItem`.
+
 ### Last but not least, check if your application is working!!!
 
 #### Be sure your application gets a fresh start