Changelog
All notable changes to this project will be documented in this file. See commit-and-tag-version for commit guidelines.
48.0.0 (2025-11-25)
⚠ BREAKING CHANGES
- add prefix
PFE to actions UPDATE_STATE_VALUES and TRIGGER_SERVICE_ACTIVATORS (#931)
- remove
httpSuccess tracking event (#949)
Features ✨
- add prefix
PFE to actions UPDATE_STATE_VALUES and TRIGGER_SERVICE_ACTIVATORS (#931) (231a603)
Bug Fixes 🐛
Other 🧾
47.2.2 (2025-11-24)
Other 🧾
47.2.1 (2025-11-24)
Bug Fixes 🐛
- provide deprecation annotation for
ConditionsAdvanced (#950) (51cb15a)
Other 🧾
47.2.0 (2025-10-14)
Features ✨
- @allianz/ngx-pfe: enhance error handling and success event tracking (#942) (7bf9120)
- add the property
queryParms to the service activator model that will allow to add query params to the URL (#941) (165dc89)
Other 🧾
47.1.0 (2025-10-07)
Features ✨
Bug Fixes 🐛
- @allianz/ngx-pfe: change destroy subject to avoid early unsubscriptions in pfe master page (#939) (fec916f)
Other 🧾
47.0.1 (2025-09-05)
Bug Fixes 🐛
Other 🧾
47.0.0 (2025-09-04)
⚠ BREAKING CHANGES
- remove value1Expression and value2Expression and operator (#924)
- With this update, the previously deprecated Angular
InjectFlags API has been removed.
This means that the constructors no longer requires the injected
dependency to be passed as parameter
// Before
new PfeStateService(...injectionDependencies)
// After
new PfeStateService()
Features ✨
- remove value1Expression and value2Expression and operator (#924) (7328552)
Other 🧾
46.1.1 (2025-09-04)
Bug Fixes 🐛
- memory leak in the PFEStateService when app is destroyed (#919) (3606288)
Other 🧾
46.1.0 (2025-08-25)
Features ✨
- add warning in pfe-dev-tools when an action from the PFE configuration is not registered (#920) (3a377aa)
Bug Fixes 🐛
- update baseURL assignment to use from configuration (#923) (e3aae6d)
Other 🧾
- add migration instructions to changelog (#926) (2933434)
- do not run the post build schematics cmds in parallel (#927) (ca3d051)
- release: 46.0.2-beta.0 (b38b2e5)
- release: 46.0.2-beta.1 (aacb19f)
- release: 46.0.2-beta.2 (b0fc464)
- release: 46.1.0-beta.0 (0e7197b)
46.0.1 (2025-08-13)
Bug Fixes 🐛
Other 🧾
46.0.0 (2025-07-24)
Migration Instructions 🚨
Please make sure you have PFE 46.0.1 installed, as this version contains important changes related to migrations. There are two ways to run the migrations:
* Inside a workspace: Use the usual ng update or nx migrate commands to run the migrations.
* Outside a workspace: If you are not inside a workspace, you can run the migrations using our CLI tool: npx ngx-pfe migrate error-page-id [--path <directory>]
⚠ BREAKING CHANGES
- remove deprecated error page id (#917)
Features ✨
Bug Fixes 🐛
- always allow global Actions with globalConfigId in the PFE_NESTED_ACTIONS (#922) (af9af33)
Other 🧾
45.1.0 (2025-06-02)
Features ✨
- improve default json schema validation for custom actions (#918) (16c52b1)
Other 🧾
Documentation 📚
- remove "value1Expression" and "value2Expression" (#916) (c0ee184)
45.0.1 (2025-05-08)
Bug Fixes 🐛
- correct the console log message for the PFE NDBX migration (#915) (827e4bd)
Other 🧾
45.0.0 (2025-05-08)
⚠ BREAKING CHANGES
- Adds a new library
@allianz/ngx-pfe-ndbx library that substracts all the ndbx dependencies from PFE leaving them in an isolated package.
The i18n entry point, that was used also as part of this library, has been moved also to this secondary entry point. The errorMessage$ that previously provides a translated message. Now provides the raw key.
And needs to be translated if used.
Features ✨
Other 🧾
44.1.0 (2025-05-07)
Features ✨
Bug Fixes 🐛
- properly export the PfeResetStateActionConfig and PfeReloadPageActionConfig (#914) (c7d1045)
Other 🧾
44.0.2 (2025-03-31)
Other 🧾
- relax @angular/forms and @allianz/ngx-logger versions (#907) (127108e)
- release: 44.0.2-beta.0 (a52e9ff)
- release: 44.0.2-beta.1 (124d677)
- update to latest ngx-logger version (#908) (e6d43d1)
44.0.1 (2025-03-28)
Other 🧾
- downgrade and relax rxjs dependency to increase compatibility range (#906) (c62397b)
- expand the changelog for PFE v44 (#904) (ed2db00)
- release: 44.0.1-beta.0 (5acb214)
- release: 44.0.1-beta.1 (1925404)
44.0.0 (2025-03-27)
⚠️️ BREAKING CHANGES
- The PFE dev tools have been moved into their own package:
@allianz/ngx-pfe-devtools. (#891)
💡 This change is covered by an ng update schematic! This schematic will automatically take care of the necessary changes in your repository. For regular Angular-CLI workspaces, run ng update @allianz/ngx-pfe to migrate to PFE v44. In Nx workspaces, run nx migrate @allianz/ngx-pfe.
This release contains a fix to the types in the Service Activator handling. This will not affect usage in configurations, but usage in code might require an update of the handling of the returned data. The behavior itself is unchanged. Only the types have been updated.
The NGX_PFE_CONFIGURATION and NGX_PFE_FLOW_CONFIGURATION now accept an Angular signal in addition to existing types. To accommodate the changes, we have removed the NGX_PFE_CONFIGURATION token injection from the following services:
PfeServiceActivatorServicePfeUtilServicePfeConfigurationServicePfePageMappingServicePfeRestServicePFEPageRoutingEventsHandlerServicePfeConfigurationServiceMock
If you are extending these services, please ensure to adjust accordingly.
Features ✨
- adding signal support to existing tokens (#900) (83db4dd)
- create
@allianz/ngx-pfe-devtools package (#891) (b8b10f3)
- provide a migration of the new devtools package (#896) (bbb6e16), closes #688
Bug Fixes 🐛
- ensure that navigationInProgress$ is also set correctly during the initial navigation (#898) (17427c3)
Other 🧾
43.0.0 (2025-01-29)
⚠️️ BREAKING CHANGES
- update to angular 19 (#894)
Other 🧾
42.0.0 (2024-11-01)
⚠️️ BREAKING CHANGES
- service activator
globalConfigId instead of globalConfigID (#884)
Features ✨
- service activator
globalConfigId instead of globalConfigID (#884) (6cc0985)
Other 🧾
41.2.0 (2024-09-23)
Features ✨
- ensure that the $._pfe.navigationState.navigatingTo value is al… (#883) (1e5112a)
Other 🧾
41.1.0 (2024-09-16)
Features ✨
- allow to use loadComponent in configuration for lazy loaded page (#880) (c46247d), closes #879
Other 🧾
- mention the Nx update in the changelog entry for the Angular update (#878) (ab97eda)
- release: 41.0.1-beta.0 (388926c)
- release: 41.1.0-beta.0 (85eacd6)
41.0.0 (2024-07-30)
⚠️️ BREAKING CHANGES
- update to Angular 18 and Nx 19 (#877)
Documentation 📚
- expand service activator documentation (#871) (a8b596e), closes #858
- fix broken links, use full URLs for self-links, and introduce broken links check (#872) (47e1e88)
Other 🧾
40.0.0 (2024-05-14)
⚠️️ BREAKING CHANGES
- We have made changes to how the PFE handles page
history, resulting in a change in behavior for applications that haven't
specified the
backOptionList. If you navigate to the previously
visited page, for example, 1 > 2 > 3 > 1 > 3, and click on the back
button, the previous behavior will navigate you to the second page. With
the new behavior, you will land on the first page.
Bug Fixes 🐛
- ensure the
popPageFromHistory won't be executed during forward navigation (#869) (a03e2cb), closes #868
Other 🧾
39.1.1 (2024-02-26)
Other 🧾
- release: 39.1.1-beta.0 (73c57f8)
- use major range for some pinned angular dependencies (#866) (adb292e)
39.1.0 (2024-02-23)
Features ✨
- provide more guidance on Actions tab of dev tools (#861) (69cf333), closes #817
Other 🧾
- explicitly list the deprecated/removed functionalities in the … (#855) (2fc5ecd)
- fix peer dependency list (#864) (3719b0c)
- release: 39.0.1-beta.0 (df86153)
- release: 39.0.1-beta.1 (e7afdab)
- release: 39.1.0-beta.0 (de0a69d)
- release: 39.1.0-beta.1 (a37e007)
- release: 39.1.0-beta.2 (0b013e4)
- remove extra readme file and update year in license file (#857) (48aee16)
- update to Nx 17.3.0 (#862) (063a07b)
39.0.0 (2024-01-05)
⚠️️ BREAKING CHANGES
- deprecate obsolete stateIDStateKey configuration attribute and… (#852)
- remove long-time deprecated functionalities (#853)
- update to angular 17 (#850)
- Due to security concerns, the
pfe- and pfestate- URL parameters are removed. You can achieve the same behavior using the urlParametersInState configuration.
These are the (deprecated) functionalities that have been removed or are newly marked as deprecated:
- The
PFE_NAVIGATE action (via the PfeNavigateActionService) is available by default and the service is therefore not exported anymore. You can simply remove all imports of it.
A direct usage of the service has to be migrated to call it via the PFE_NAVIGATE action. This can be done via the PfeActionsService.
- The
PfeUtilService.getValueOrListFromJsonExpression() method has been removed.
Please use PfeUtilService.getValueOrList() instead and set the optional third parameter (returnUndefinedForEmptyArray) to true
- The
stateIDStateKey configuration attribute in the PFE config has been marked as deprecated. It never had an effect on anything, so there is no change in functionality, just in the data model.
Bug Fixes 🐛
Features ✨
- remove support for the pfe and pfestate query params (#849) (c6ef6fe)
Other 🧾
38.0.0 (2023-12-15)
⚠️️ BREAKING CHANGES
- remove URL query param sanitization (#848)
Documentation 📚
- explain navigation behavior during firstPage phase (#847) (9fcde6d)
Features ✨
Other 🧾
37.1.1 (2023-12-12)
Documentation 📚
Other 🧾
- improve linting setup (#843) (cb233d3)
- introduce a commit hook that prevents accidental updates of pinned dependencies (#846) (047fded)
- release: 37.1.1-beta.0 (0037153)
- release: 37.1.1-beta.1 (defda99)
- release: 37.1.1-beta.2 (41852dc)
- release: 37.1.1-beta.3 (4150e4c)
- update links for jenkins pipelines and docs websites (#840) (29e9229)
37.1.0 (2023-11-14)
Features ✨
- expand the jsonpath and condition dev tools (#836) (6a999a6)
- use native trackify flag to check if trackify is initialized (#839) (77e43f9)
Other 🧾
37.0.0 (2023-10-16)
⚠️️ DEPRECATIONS
We deprecated the pfe- and pfestate- query parameters (documentation). To continue supporting these parameters after we removed that feature, app maintainers can add urlParametersInState configurations for the required query parameters (documentation).
Example: To continue supporting the query parameter pfe-domain=claims, one could add a configuration like this:
{
"pfeConfig": {
"urlParametersInState": [
{
"key": "pfe-domain",
"stateKeyExpression": "$.domain"
}
]
}
}
⚠️️ BREAKING CHANGES
- All URL parameters are going to be sanitized now before further processing. This change has been applied for security concerns. (#833)
- serviceActivatorCallInProgressDetails now emits an ExtendedDisplayMessage instead of a string (#830)
- introduce custom condition evaluators (#807)
Bug Fixes 🐛
- encode url path parametes in service activators (#831) (e835ca3)
Documentation 📚
Features ✨
Other 🧾
36.2.2 (2023-09-27)
Bug Fixes 🐛
- ⚠️️ Critical Security Fix: condition evaluations (#826) (f136681)
Other 🧾
36.2.1 (2023-09-21)
Bug Fixes 🐛
- provide a default value to
lastValueFrom (#824) (b047c5b)
Other 🧾
- add breaking change message to changelog for version 36.2.0 (#822) (72876ca)
- release: 36.2.1-beta.0 (5f95689)
- release: 36.2.1-beta.1 (dca59ff)
36.2.0 (2023-09-18)
⚠️️ BREAKING CHANGES
This is a new minor version and - according to the rules of semantic versioning - there should not be any breaking changes here. These changes were meant to be released as part of version 37.0.0. By accident, this was released as 36.2.0.
You should not be affected by this change. Nevertheless, if you experience unexpected behavior with your configured Route Guards, please approach us. We are happy to support you.
- We removed some internal validation logic that was meant to prevent faulty RouteGuard settings. This was part of a bigger refactoring to support Angular's new Functional Route Guards.
Features ✨
- replace class-based route guards with functional guards (#813) (0b4bf72)
Other 🧾
- integrate qualtrics TALY questionnaire (#819) (d3efbfa)
- release: 36.1.2-beta.0 (0d33ad8)
- release: 36.1.2-beta.1 (cc9bc74)
- release: 36.2.0-beta.0 (0807de4)
- update the GitHub templates for issues and pull requests (#815) (e5e93c7)
36.1.1 (2023-08-16)
Bug Fixes 🐛
- ensure a consistent order of tracking events during startup (#810) (f41b7bd)
Documentation 📚
- move pfe devtools documentation to own section and add screen r… (#811) (31d4ea6)
Other 🧾
- expose PFERouteGeneratorService and one of its methods through the public api (#805) (9159131)
- release: 36.1.1-beta.0 (f8a43f4)
- release: 36.1.1-beta.1 (6a63a14)
- release: 36.1.1-beta.2 (24ec553)
36.1.0 (2023-07-25)
Features ✨
Other 🧾
36.0.0 (2023-07-11)
⚠️️ BREAKING CHANGES
- PFE is now on Angular 16 and RxJS 7 🎉
Other 🧾
35.1.2 (2023-06-15)
Bug Fixes 🐛
- run all trackify methods outside the angular zone (#794) (640b190)
- run trackify outside the angular zone (#791) (e96e968)
Documentation 📚
- replace outdated usage of PfeInejctionService with PfePageMappingService (c1b82b5)
Other 🧾
- release: 35.1.2-beta.0 (987af86)
- release: 35.1.2-beta.1 (8a1a227)
- release: 35.1.2-beta.2 (8b43cf5)
- release: 35.1.2-beta.3 (5c728bc)
- update access modifiers in PFE action service method (#795) (4ffb780)
35.1.1 (2023-05-16)
Bug Fixes 🐛
- fix backward navigation triggered by browser button (#790) (4e6f7d3)
- tell azure to overwrite existing blobs during the viewer/documentation upload (#782) (fb0f8d6)
Other 🧾
- add backstage link (2787cb2)
- release: 35.1.1-beta.0 (ac92aa2)
- release: 35.1.1-beta.1 (6af9a95)
- release: 35.1.1-beta.2 (f65f972)
- release: 35.1.1-beta.3 (7a4dac4)
- release: 35.1.1-beta.4 (1b3baef)
- release: 35.1.1-beta.5 (de14d91)
- set authentication in the npmrc based on the environment varia… (#787) (34183db)
- update asset type to library (#786) (6c03726)
- update dev portal entry with new taxonomy (#783) (c526e21)
35.1.0 (2023-04-17)
Bug Fixes 🐛
- only use the internal nexus hostname on Jenkins (#779) (44d4e32)
- publish config URL (#780) (30c2bbd)
- update npm config to be compatible with npm 9.5 on Jenkins (#777) (4605ef8)
Features ✨
- add support for navigation nodes, which are invisible pages tha… (#772) (f0c87c9)
Documentation 📚
- extend the navigation documentation and add a navigation node d… (#771) (cf59c2a)
Other 🧾
- add backstage catalog configuration (a6d1b44)
- integrate authentication into publish pipelines (#778) (4fbcbd9)
- release: 35.0.1-beta.0 (57f139b)
- release: 35.0.1-beta.1 (182982e)
- release: 35.0.1-beta.2 (898707f)
- release: 35.0.1-beta.3 (f859058)
- release: 35.0.1-beta.4 (de51c6e)
- release: 35.1.0-beta.0 (5008f80)
- release: 35.1.0-beta.1 (78f9afb)
- update jenkins agent pointing to CRP 2.0 agent space (#775) (97655fe)
35.0.0 (2023-03-24)
⚠️️ BREAKING CHANGES
- update to angular 15 (#774)
Bug Fixes 🐛
- output path of the pfe config editor monaco editor assets (#770) (88d990a)
Other 🧾
34.0.1 (2023-02-15)
Bug Fixes 🐛
Other 🧾
34.0.0 (2023-01-10)
⚠️️ BREAKING CHANGES
- PFE is now on Angular 14 🎉
- Previously, an empty URL parameter is stored as "undefined" in the PFE state but now it is stored as an empty string ("").
Bug Fixes 🐛
- properly escape the git log grep regex of the publish job (#763) (95839a7)
- store empty url parameter as string (#764) (1195763)
Features ✨
Documentation 📚
- add tree shaking & lazy loading guidelines to the documentation (#762) (a8a4d96)
- update link to technical documentation on get-started page (#767) (9a98d39)
Other 🧾
33.0.0 (2022-12-14)
⚠️️ BREAKING CHANGES
- Due to a faulty routing setup, it happened in some apps that duplicate instances of services were
created.
This fix exports the NgxPfeRoutingModule, which allows it to fix the routing setup in apps.
The following change has to be applied in the routing setup of apps:
const routes: Routes = [
{
path: '',
loadChildren: () => NgxPfeModule,
},
];
turns into this:
const routes: Routes = [
{
path: '',
loadChildren: () => import('@allianz/ngx-pfe').then((m) => m.NgxPfeRoutingModule),
},
];
- The
PFE_NESTED_ACTIONS action is now enabled by default. Please remove your custom registration of this action to avoid this error: The action "PFE_NESTED_ACTIONS" is already registered.
- Certain errors that are thrown during
pfeNavigationService.navigateNext() will now bubble up to the user. Previously they have been swallowed by the PFE. The only errors that we know of that this change will affect are errors that happen during the lazy-loading of a chunk. If you encounter other errors that are related to this change, please let us know, so that we can handle/document them accordingly.
Features ✨
- extend triggerSingleServiceActivator method to accept service activator configuration (#760) (a906f2f)
- register PFE_NESTED_ACTIONS action by default (#754) (1415d07)
Bug Fixes 🐛
- remove NgxPfeRoutingModule from NgxPfeModule to fix duplicate s… (#731) (df08bb3)
- rethrow caught error during navigateNext (#755) (f990cfb)
- set nexus credentials in the npmrc on publish (#758) (5e77872)
- set nexus credentials in the npmrc on publish for beta versions (#761) (47024d9)
Other 🧾
- ensure that the stable release job only publishes the last stable release (#759) (b02d67d)
- release: 32.1.1-beta.0 (4ef9004)
- release: 33.0.0-beta.0 (0913b30)
- release: 33.0.0-beta.1 (6adab78)
- release: 33.0.0-beta.2 (da81ab0)
- release: 33.0.0-beta.3 (19ce526)
- release: 33.0.0-beta.4 (c82ff1f)
- release: 33.0.0-beta.5 (336e38f)
32.1.0 (2022-12-06)
Features ✨
- allow to use notBusyWhileRunning actions in onNavigationStartActions (#756) (8675a30)
Documentation 📚
- update documentation for actions with notBusyWhileRunning flag (#757) (089f29d)
Other 🧾
- release: 32.0.2-beta.0 (2957670)
- release: 32.0.2-beta.1 (9860fd3)
- release: 32.1.0-beta.0 (95020c2)
- release: 32.1.0-beta.1 (933440a)
- switch the pipeline to nodejs-with-browsers-latest as node 14 is quite old (#751) (c91d98a)
32.0.1 (2022-11-14)
Other 🧾
32.0.0 (2022-10-20)
⚠️️ BREAKING CHANGES
- Some of the property names for the PFE module configuration object changed. We did this to harmonize the property names (snake case vs. camel case).
💡 This change is covered by an ng update schematic! This schematic will automatically take care of the necessary changes in your repository. For regular Angular-CLI workspaces, run ng update @allianz/ngx-pfe to migrate to PFE v32. In Nx workspaces, run nx migrate @allianz/ngx-pfe.
If you want to do the changes manually, here are all the changed properties, before and after:
Before:
const PFEModuleConfig = {
applicationID: 'my-app',
config_api_format: 'STATIC',
config_api_endpoint: '/api/config',
state_service_endpoint: '/api/state',
service_activator_endpoint: '/api/sa'
};
After:
const PfeModuleConfig = {
applicationId: 'my-app',
configApiFormat: 'STATIC',
configApiEndpoint: '/api/config',
stateServiceEndpoint: '/api/state',
serviceActivatorEndpoint: '/api/sa'
};
Other 🧾
- release: 32.0.0-beta.0 (e7a86de)
- unify the properties names in NgxPfeModuleConfiguration (#688) (944a6a4)
31.1.3 (2022-10-18)
Other 🧾
31.1.2 (2022-09-21)
Bug Fixes 🐛
- only remove pages from history if backwards navigation was successful (#728) (1d0ac36)
Other 🧾
- release: 31.1.2-beta.0 (2a8a88c)
- release: 31.1.2-beta.1 (2b9a649)
- remove dependencies with outdated (peer) dependencies (#732) (f9e78a6)
31.1.1 (2022-09-13)
Bug Fixes 🐛
- expose NgxPfeRoutingModule to fix duplicate service instances du… (#730) (c0d65f9)
Other 🧾
31.1.0 (2022-07-26)
Documentation 📚
- extend the backend communication documentation and comparison (#721) (e5bb336)
Features ✨
- do not modify the state when the state restore promise resolves to a non-state-like value (#725) (38bc5ba)
Other 🧾
31.0.0 (2022-07-12)
⚠️️ BREAKING CHANGES
- we removed the
disableAutomaticScrolling flag from the app configuration. If you were using this flag, please switch to Angular's scrollPositionRestoration in the RouterModule configuration instead. See the Angular documentation for more details.
Features ✨
- introduce notBusyWhileRunning option for registered actions (#717) (8cd6b9c)
Documentation 📚
- add documentation on how to create releases (#722) (48d0f4f)
Other 🧾
- release: 30.2.0-beta.0 (29b9ea5)
- release: 30.2.0-beta.1 (6a55d92)
- release: 30.2.0-beta.2 (a853c54)
- release: 31.0.0-beta.0 (f95e073)
- remove deprecated disableAutomaticScrolling flag from app configuration (#720) (2da2830)
- update typescript-json-schema dependency to the latest version (#719) (395c49a), closes #696 #699
30.1.0 (2022-05-24)
Documentation 📚
- extend the documentation with a tutorial for a simple example app (#697) (799950d)
Features ✨
- add support for pfe.json files to the config editor (#708) (d69bb8d)
- allow to specify excludes for PFE_RESET_STATE action (#694) (99493e1)
Bug Fixes 🐛
- do not fail during startup with an empty sessionStorage (#711) (23e6806)
- do not trigger the config service through the business service c… (#698) (171f5e8)
- handle undefined values for the tracking of restored states (#713) (7c9dc47)
- switch no navigation result log message to be a warning instead … (#705) (dddc9be)
Other 🧾
- downgrade typescript-json-schema as a workaround for comment formatting issue (#699) (64278ed)
- ngx logger and dependencies update (#690) (56c2534), closes #695
- release: 30.0.1-beta.0 (df7809b)
- release: 30.0.1-beta.1 (3559f20)
- release: 30.1.0-beta.0 (eeb0933)
- release: 30.1.0-beta.1 (d8f7697)
- release: 30.1.0-beta.10 (c2d7006)
- release: 30.1.0-beta.2 (c168756)
- release: 30.1.0-beta.3 (23aac41)
- release: 30.1.0-beta.4 (5f66ce2)
- release: 30.1.0-beta.5 (3109a67)
- release: 30.1.0-beta.6 (b84ac68)
- release: 30.1.0-beta.7 (3044933)
- release: 30.1.0-beta.8 (9225502)
- release: 30.1.0-beta.9 (c37b397)
- remove depricated package sass-lint (#712) (6c7b399)
30.0.0 (2022-03-28)
⚠️️ BREAKING CHANGES
- update to Angular 13 (#676)
Features ✨
Bug Fixes 🐛
Other 🧾
29.1.0 (2022-03-22)
Features ✨
- introduce displayMessage and serviceActivatorCallInProgressDetails$ (#683) (ddea2d7)
- introduce optional NGX_PFE_INITIAL_STATE token, which allows it to supply an initial state (#684) (64da087)
Other 🧾
29.0.0 (2022-02-15)
⚠️ BREAKING CHANGES
- This changes the timing of the navigationInProgress$ states. Please verify that behavior relying on these still works as expected.
- update to latest trackify release (#675)
Features ✨
- provide busy$: Observable, that signals if the pfe is busy (#667) (ee6fe43)
Bug Fixes 🐛
- async service activator should allow navigation when previous call failed but latest was successful (#673) (45c646e)
- ensure that the navigationInProgress$ flag is also set for the navigation buttons (#666) (287d518)
- switch the trackify trigger from navigationInProgress$ to currentPageId$ (#671) (335d4ef)
Other 🧾
28.1.0 (2022-01-11)
Features ✨
- devtools: reset dropdown for page to jump to (#668) (9208f1a)
Other 🧾
28.0.3 (2022-01-07)
Documentation 📚
Other 🧾
28.0.2 (2021-11-29)
Documentation 📚
- clarify rewind history documentation a bit more (#651) (fb537d9)
- extend the global error page handling documentation (#656) (bb35ab2)
Bug Fixes 🐛
- do not create parent properties of non existing update state rem… (#659) (7cc9349)
- properly wait for async service activators with a asyncResolveBeforePageIds config (#653) (8597568)
- switch to nodejs-with-browsers-v14 (#657) (462dd61)
Other 🧾
28.0.1 (2021-10-15)
Bug Fixes 🐛
- properly export the configuration data models for all integrated actions (#650) (71794ac)
Other 🧾
28.0.0 (2021-10-12)
⚠️ BREAKING CHANGES
- update to Angular 12 (#647)
Bug Fixes 🐛
- allow to use array syntax for jsonpath expressions in PFE debugger (#645) (8ea9d39)
Features ✨
Other 🧾
27.2.0 (2021-10-01)
Bug Fixes 🐛
Features ✨
Other 🧾
27.1.0 (2021-09-20)
Bug Fixes 🐛
- deactivate typescript strict mode for the json schema generator to prevent information loss (#637) (ec62e9d)
Features ✨
- introduce [] prefix to always receive arrays from json path expressions (#635) (986be17)
- ngx-pfe: add conditions for path params (#634) (b6def52)
- dont throw if cant find the json path expression (#633) (1220096)
Other 🧾
27.0.0 (2021-08-30)
⚠️ BREAKING CHANGES
- Some of the public APIs changed their return types, they now clearly signal that
undefined is an additional possible return value. One effect of this change is that code consuming these public APIs needs to be adapted.
- Multiple imports of the
HttpClientModule in different locations within the injection hierarchy can cause issues with interceptors.
To avoid this, the NgxPfeModule does not import the HttpClientModule anymore.
Please ensure that the HttpClientModule is imported in the AppModule and that there are no duplicate imports.
A ng update schematic is provided, which automatically adds the import to all projects that use the NgxPfeModule.
The update can be run by executing:
ng update @allianz/ngx-pfe
Features ✨
- also replace falsy path params and replace all of them (#631) (a252eeb), closes #615
Bug Fixes 🐛
- do not import the HttpClientModule anymore in the pfe module (#630) (7e10469)
refactor
- activate strict Typescript & Angular strict mode for the ngx-pfe (#629) (04c8c5b)
Other 🧾
- release: 26.0.3-beta.0 (4179a66)
- release: 26.1.0-beta.0 (adb5abf)
- release: 27.0.0-beta.0 (8680400)
- release: 27.0.0-beta.1 (e41002c)
- allow all compodoc elements to span over a width of 46em (#628) (62122b1)
26.0.2 (2021-08-02)
Bug Fixes 🐛
- wrong navigateNextCallback signature in the master-page (#627) (7f5a738)
Other 🧾
26.0.1 (2021-07-27)
Documentation 📚
Bug Fixes 🐛
- do not swallow errors in the triggerSingleServiceActivator anymore (#625) (c1f8b93)
Other 🧾
- release: 26.0.1-beta.0 (bbf79ed)
- release: 26.0.1-beta.1 (a1f24ec)
- release: 26.0.1-beta.2 (2eed536)
- update dependencies that are not related to Angular (#624) (09042eb)
26.0.0 (2021-07-21)
⚠️ BREAKING CHANGES
- tslint to eslint fixes including the activation of esModuleInterop (#606)
Features ✨
- add field for conditions to avoid setting service activator response mapping in case where is not necessary (#610) (798756d)
- add field for conditions to avoid setting service activator request mapping in cases where is not necessary (2763c7b)
Documentation 📚
Bug Fixes 🐛
- make navigation action work with all trigger points (#620) (0ca2a31)
- re-trigger navigation to first page for return navigations in module integration (#616) (b05a277)
refactor
- tslint to eslint fixes including the activation of esModuleInterop (#606) (398ca92)
Other 🧾
- release: 25.3.1-beta.0 (7573def)
- release: 25.3.1-beta.1 (b95dc91)
- release: 25.3.1-beta.2 (1ec8bf3)
- release: 25.3.1-beta.3 (0aecf42)
- release: 25.3.1-beta.4 (28d5b70)
- release: 25.3.1-beta.5 (f512f0c)
- release: 25.4.0-beta.0 (9be8a63)
- release: 25.4.0-beta.1 (cebeb8f)
- release: 25.4.0-beta.2 (0550795)
- release: 25.4.0-beta.3 (1242e8c)
- release: 25.4.0-beta.4 (e46eb1d)
- release: 25.4.0-beta.5 (d1b1734)
- release: 25.4.0-beta.6 (1116324)
- release: 25.4.0-beta.7 (25bfeb6)
- release: 26.0.0-beta.0 (3f78dcb)
- update build node to nodejs-with-browsers-latest (4316cf0)
- update to latest version of compodoc-ndbx-theme (#617) (16a9a71)
25.3.0 (2021-06-09)
Features ✨
- added reset state and reload page action (#596) (15971da)
- introduce new and improved service activator error handling (#595) (a828534)
Other 🧾
25.2.0 (2021-06-08)
Documentation 📚
- extend documentation about the integration of the pfe within a parent routing (ee21506)
Features ✨
- make it possible to use custom attributes in the json schemas (a8e76aa)
Bug Fixes 🐛
- properly catch and log errors during json schema generation (65e5907)
- service activator emission when no service activators run (#593) (c69b670)
Other 🧾
- release: 25.2.0-beta.0 (40d0ea1)
- release: 25.2.0-beta.1 (36a5e8e)
- release: 25.2.0-beta.2 (c06bfa3)
- remove duplicate deprecated marker (9ea73c9)
- remove obsolete annotation (989cdd6)
- update the json schema docs and annotations to reflect that the TJS- prefix is optional (9934862)
- release: 25.1.3-beta.0 (1703f27)
25.1.2 (2021-05-18)
Bug Fixes 🐛
- cleanup error message during navigation start instead of end. Ignore error page navigations (1a814dd)
- mockRestore jest spies (16da18c)
- remove obsolete code (cdabb56)
Other 🧾
- release: 25.1.2-beta.0 (22ebfd3)
- release: 25.1.2-beta.1 (a6a4459)
- release: 25.1.2-beta.2 (f3fedb1)
- remove old and obsolete migrations.json (c2a7cb1)
- run prettier against all files (873e6a6)
- update: npm install (d00200b)
- update: nx migrate --run-migrations (25b7c6a)
- update: nx migrate latest (c67ce2a)
- update: update dependencies (d014131)
25.1.1 (2021-05-05)
Bug Fixes 🐛
- proper handling for secondary outlets. Only react to pfe specific navigations (ad80ee2)
Other 🧾
- release: 25.1.1-beta.0 (f4c49a5)
- extend tests to also rather the outside world effects of the navigation events (622132c)
25.1.0 (2021-05-04)
Features ✨
- actions: add rewind history action, that allows it to clear or rewind the history (119884a)
Documentation 📚
- extend documentation about the json schemas and their usage (60d61a5)
- extend the changelog with more release information (16dc733)
- fix wrong path description for json schema (e7c1414)
- improvements based on review (deb0f4d)
- simplify json schema remote loading explanation (b2198d8)
- update update state value action description (4dd7abc)
Bug Fixes 🐛
Other 🧾
- release: 25.0.2-beta.2 (ef8447c)
- release: 25.0.2-beta.3 (d777cce)
- release: 25.1.0-beta.0 (a0b556b)
- docs improvement (fb56f3e)
- docs improvement (5db205a)
- docs improvement (4462fcf)
- history state key const to separate file and import it instead (7628fd8)
- set CF deployment to redirect to Azure deployment (835bf57)
- typo (ce6aa66)
- update changelog and contributing link in README.md (bf0e9e4)
- update documentation viewer url in documentation (3da56ad)
- release: 25.0.2-beta.0 (2fcbcd3)
- release: 25.0.2-beta.1 (1d3f7a1)
25.0.1 (2021-04-27)
Bug Fixes 🐛
- replace inquirer.js with prompts for user interaction in the schematics (5e055c8)
- update whitelistedNonPeerDependencies with prompts as a dependency (f947ada)
Other 🧾
25.0.0 (2021-04-27)
This is the first ngx-pfe release that ships with ng update support! 🎉
To update, run the following command:
ng update @allianz/ngx-pfe
The schematics will update the app with necessary code changes automatically. 🤖
The following major changes are a part of this release:
Make ngx-translate optional
The integration of the pfe with ngx-translate is now optional. In addition to that, the native Angular translation (localize$) support is added.
A translation adapter needs to be imported if one of the translation backends should be used.
The schematics will automatically handle the integration. During the update, they will ask for the adapter to be used.
It is also possible to not use any of the translation backends. For example if a custom frame/navigation buttons are used. See the localization section in the documentation for more details.
To do during the update: Decide if a translation adapter should be used. Select this option in the schematics during the update. If a switch from ngx-translate to the native translation was done, it can be removed completely.
The import of some i18n integrations like the i18nFromState* pipe/directive were also changed. If these are used within unit tests, the imports will not be update automatically. Please check these cases manually.
Check page status in navigateNext()
The navigateNext() method of the pfeBusinessService will now check the page status and prevent the navigation if the page status is not ok.
There is a flag available to ignore the page status, which changes the behavior to be exactly like before this change.
To do during the update: Check every usage of this method, if the new behavior is ok.
Switch default for service activator calls from sending full state to sending nothing
Service activator configurations that do not define a requestDataMapping, will not send any payload anymore, by default.
There is a flag available to switch this behavior back to the previous one, to ease the transition.
The new behavior was made available a while ago and the default is now switched.
To do during the update: Check all service activator configurations if they have or require a requestDataMapping.
⚠️ BREAKING CHANGES
- switch the default service activator request body to empty
- business-service: do not navigateNext() if the pageStatus is negative
- translate: added native Angular translate backend
- translate: moved PfeI18nFromStatePipe into a secondary entry
- translate: introduced pfeTranslate layer to support multiple translation backends
Documentation 📚
- added Readme.md with testing source (cb5a02e)
- added sources for the cherry picked code (40274c9)
- extend documentation with new navigation actions (6494451)
refactor
- switch the default service activator request body to empty (f048017)
Bug Fixes 🐛
- schematics: properly check if the NgxPfeModule import also has forRoot (a8d1b78)
- serviceactivator: requestDataMapping do not spread non objects onto non objects in the payload (9b3682f)
- handle the NavigationCancel for navigationInProgress$ (ddc65cc)
- make check in tests more generic (2ad8a1b)
- make check in tests more generic (6b984b8)
- removed obsolete change ref parameter in pfe-angular-translate-adapter.service.spec (6054ff8)
- replace the faulty Spanish traductor translation with a proper one from @inmaculada-rodriguez (be1f5dc)
- switch to npx for execution (7bd82ce)
- use Type<> from @angular/core instead of the explicit new() type (6d1b9a1)
- schematics: immediately return if one of the conditions for the change doesn't apply (c94f5e0)
- pin typescript version (fb41dd9)
- slim down schematics test data a little more (35d2305)
- switch to nullish coalescing operator for the button labels (d624344)
- update @angular/localize (ba62607)
- business-service: do not navigateNext() if the pageStatus is negative (bb0ae60)
Features ✨
- schematics: added option to skip translation adapter migration (320e1cd)
- add i18n-from-state update migration (224dcc7)
- add page flow navigation plantuml diagram (d79bc5f)
- add support for onNavigationStartActions (757ee48)
- add translation adapter update schematic (659ff49)
- added example for navigatingFrom action conditions (cb2cebd)
- basic setup of the update schematics infrastructure (eef35b6)
- translate: added native Angular translate backend (5217777)
- translate: introduced pfeTranslate layer to support multiple translation backends (c68e0c4)
- translate: moved PfeI18nFromStatePipe into a secondary entry (0b424ba)
Other 🧾
- release: 25.0.0-beta.0 (0acff64)
- release: 25.0.0-beta.1 (2c2f3e7)
- release: 25.0.0-beta.2 (f968c21)
- release: 25.0.0-beta.3 (f1f7178)
- release: 25.0.0-beta.4 (899b2d1)
- release: 25.0.0-beta.5 (879f6f3)
- release: 25.0.0-beta.6 (dabc8d7)
- release: 25.0.0-beta.7 (32baad0)
- release: 25.0.0-beta.8 (cce3324)
- add i18n-from-state-imports schematics tests (6ad741d)
- add local registry setup with verdaccio (ffc3a0e)
- add schematics documentation (5b8ad17)
- add tests for navigation actions (1251ea0)
- add this might take a while message (abaf359)
- add translation adapter schematics tests (300d0d9)
- added explanation comments about the setNavigationState handling (e9fcc85)
- added first test for pfe-angular-translate-adapter.service (6bf19ad)
- added test for pfe-translate.pipe (cf8b71b)
- extended documentation of translation adapters (a852d94)
- extended pfe-angular-translate-adapter.service test (0d7781e)
- improve demo config a little (788125a)
- improve test naming (cf6bc3b)
- improve test naming (1393992)
- minor documentation updates (c2ef7e8)
- ngx-pfe vs NGX-PFE consistency. Use NGX-PFE (8b8799f)
- remove ngx-translate imports (0b4438b)
- remove obsolete if (82c6d6e)
- remove unused code and add extension recommendation (a38b33f)
- review fixes (86c4b83)
- switch issue id to link (08cf65c)
- update and extend tests (f52e5a8)
- schematics: remove code that is not yet used in these schematics (1376688)
- schematics: update schematics copy error message (1e1b8eb)
- schematics: use npm pre/post build for schematics build (e8a597d)
- update and extend ngx-translate demo in the viewer (d6f3fd9)
- update doc-files/developer-schematics.md (017c1cd)
- updated import path for i18n-from-state features: @allianz/ngx-pfe/util/i18n-from-state (235160d)
- updates based on review comments (db2f9ee)
- translate: updated documentation about localization (672f68c)
24.4.0 (2021-04-19)
Bug Fixes 🐛
- nx lint to call the new package dependency linting (4ea42b4)
- switch to npx for execution (637c528)
Features ✨
- provide response of serviceActivator in return of triggerSingleServiceActivator() (3022100)
- switch from package dependency linting script to @allianz/library-dependency-linter (1415a98)
Other 🧾
24.3.0 (2021-03-26)
Bug Fixes 🐛
Features ✨
- add possibility to supply the flow configuration as an NGX_PFE_FLOW_CONFIGURATION token (6c6915d)
- do not only accept promises but also values for the flow config token (05de381)
Other 🧾
- release: 24.3.0-beta.0 (56f389f)
- add tests for the non promise/static flow config token (88af0e1)
- extend README.md with more information about the config injection token (2e9d6ba)
- extend token description (7d474a1)
24.2.2 (2021-03-26)
Other 🧾
- release: 24.2.2-beta.1 (d7fffb5)
- extend documentation about copy URL parameters into state feature (04685e5)
- release: 24.2.2-beta.0 (fd7ca63)
24.2.1 (2021-03-15)
Bug Fixes 🐛
- pipeline environment configuration (4ae65c7)
Other 🧾
24.2.0 (2021-03-04)
Features ✨
- add json schema for pfe.json configuration files and ship it in the ngx-pfe package (00657b7)
- added logging when there is no error page (9b1682c)
Bug Fixes 🐛
- broken character in comment (7c5675f)
- close error message only when the x is clicked and not the body (0267433)
- example page unit test (5256753)
- handle external navigations in all locations that use a navigation option config (ba0365a)
- make the generics in the NgxPfeConfig specific to also validate bundled actions, etc (3a23ec5)
- refactor navigation handling to fix faulty handling of certain navigation configs (d0aa6cf)
- remove duplicated import due to merge error (8e82e9e)
- test coverage configuration (8ff770f)
- typo (7df96aa)
- update test with new error log (fceb686)
Other 🧾
- release: 24.1.1-beta.0 (612e41b)
- release: 24.1.1-beta.1 (e1e1461)
- release: 24.1.1-beta.2 (69c2d3e)
- release: 24.1.1-beta.3 (f7c83bd)
- release: 24.2.0-beta.0 (79a95b1)
- release: 24.2.0-beta.1 (1f45967)
- release: 24.2.0-beta.2 (ce88271)
- release: 24.2.0-beta.3 (07b61f4)
- add description of the new schema to the README.md (e87fe78)
- build test (6b38b9d)
- expand navigation.service tests (ef5f691)
- expand routing tests (a1e3022)
- expanded navigation.service tests (256fb11)
- minor updated to data model comments (0063ca9)
- move external navigation example config (ecf9c0f)
- organize imports and fix translate pipe tests (9dc55c3)
- removed obsolete optional handling of NgxLoggerService as it is always there now (6af8d34)
- review improvements (02ae166)
- take out unnecessary describes (34b7b0b)
- update documentation of the back navigation (4e817e5)
- update documentation of the back navigation (c9588c2)
- update jest matchers (8cda2e4)
- update jest matchers (ba10e11)
- update links to the eMerge slides in the readme (9f0cd04)
- use the power of mockResolvedValue (54822bd)
24.1.0 (2021-02-10)
Features ✨
- actions: add support for onPageLeaveBackwardsActions (0527b0e)
Bug Fixes 🐛
- fix page-navigation-config-json-schema default generic type (542b2a9)
Other 🧾
- release: 24.1.0-beta.0 (804e21c)
- added order of actions/service activator execution to the documentation (1d1e0ab)
- added reference of service activators through actions to documentation (6f32b76)
24.0.0 (2021-02-03)
⚠️ BREAKING CHANGES
- update ndbx to version 11
- apply updateStateValues from a page config after all other onPageEnter* operations
- removed updateStateValues from navigation config. Use the UpdateStateValues action instead
- angular 11: angular 11 update
Features ✨
- actions: added route guard functionality to pfeActions (b38e8da)
- angular 11: angular 11 update (14a2662)
- mark disableAutomaticScrolling as deprecated (d3ca10e)
- remove the workaround to downgrade rollup (5ba4694)
Bug Fixes 🐛
- allow the back navigation by browser independent of the current page status (49fc611)
- apply updateStateValues from a page config after all other onPageEnter* operations (72f9746)
- do not run configured route guards and the pfe guard in parallel (9bec318)
- service activator action example in documentation (af92517)
- take out ndbx 11 margin compatibility and move margins into the components (e4d1b00)
- the order of route guards to ensure that the configured ones are always executed first (e7ffd7a)
- angular 11: update build config to use production environment in onPR job (ad3ceeb)
- angular11: linting in the viewer (66f9d07)
- angular11: order of style imports (2bb0b24)
- whitelistedNonPeerDependencies still contained deep-equal (ae93622)
Other 🧾
- release: 24.0.0-beta.2 (f03c729)
- release: 24.0.0-beta.3 (3202f20)
- release: 24.0.0-beta.4 (2fd7351)
- disable blocking action in viewer (9101929)
- nx migrate (6cd57ae)
- readme formatting (f5e9e01)
- remove unused code (ed665a6)
- removed updateStateValues from navigation config. Use the UpdateStateValues action instead (36f17cc)
- run tsconfigs to solution style tsconfigs migration (667c12f)
- simplified route guard unit test a bit (cb230eb)
- take out deprecation marker of onPage* service activators (89618dd)
- update dependencies (ffe42f6)
- update ndbx to version 11 (8ecaf56)
- angular11: ie 9, 10 are not supported anymore (df66667)
- angular11: ng update @allianz/ngx-ndbx (9007165)
- angular11: ng update @angular/cdk@10 (3b0531b)
- angular11: nx migrate --run-migrations=migrations.json (5545579)
- angular11: run nx migrate next (09f96f0)
- angular11: update dependencies (4e37c12)
- angular11: update json-schema (7402cbd)
- angular11: update typescript. Fix variable used before declaration compile error (5e82656)
- release: 23.1.0-beta.0 (40edc08)
- release: 23.1.0-beta.1 (aae2cdb)
- release: 23.1.0-beta.2 (3c71997)
- release: 23.1.0-beta.3 (acd7415)
- release: 23.1.0-beta.4 (a38b81e)
- release: 24.0.0-beta.0 (9d1eb6d)
- release: 24.0.0-beta.1 (f8ce405)
23.0.0 (2021-01-11)
⚠️ BREAKING CHANGES
- removed the deprecated page status behavior that relied on the value in the state
Bug Fixes 🐛
- removed the deprecated page status behavior that relied on the value in the state (cccf767)
Other 🧾
22.0.0 (2021-01-08)
⚠️ BREAKING CHANGES
- do not auto convert empty arrays to undefined for state observables anymore
Bug Fixes 🐛
- do not auto convert empty arrays to undefined for state observables anymore (9fdd42d)
- repair the wrong URLs in the changelog (ec27ddc)
- wrong repository URLs in the changelog (61ba1b1)
Features ✨
- configurable default request body (a96b69c)
Other 🧾
21.0.1 (2020-10-13)
Bug Fixes 🐛
- deactivate the updateBuildableProjectDepsInPackageJson feature of nx (f4f26b4)
Other 🧾
21.0.0 (2020-10-08)
This release contains the update to Angular 10.
It also switches the release handling to standard version and a new build pipeline integration.
There are no breaking changes in this release. The Angular 10 changes are also non-breaking.
Features ✨
- added unit tests to the publish (1ef1e57)
- added basic setup for the new standard-version based release handling (041cc4a)
Bug Fixes 🐛
- abort of multiple releases doesn't work (25c18bc)
- do not abort stable releases when the last one was a beta (69821a7)
- don't throw error on navigation to the same page (692206d)
- downgrade typescript (bcd21ae)
- filenames of Jenkinsfiles (994df60)
- introduce fullJobName (6f3096d)
- jenkins job name (e8049f2)
- job name in dsl to start job after creation (966614b)
- json format (d5a79cf)
- readded commitStatusContext (a59c847)
- remove styles from library config in angular.json from ndbx -> aquila (e6c650a)
- returning within a stage doesn't stop the build. Has to be done outside (3d7418d)
- run github triggered jobs automatically once after creation (31a68d4)
- transfer release check fix to stable (cd2f726)
- trigger jobs after creation (1bf1864)
- turn around order of checkout and npm install. Set branch for publish job (83f3bf5)
- update path of package.json (d304855)
Other 🧾
Bug Fixes 🐛
Features ✨
- run nx migrate without the tsconfig solution style migration (21ea20d)
- updated to Angular 10 with nx migrate (0eb5498)
Other 🧾
- run nx migrate @nrwl/workspace. update package linting (234d657)
- separate folder for angular 10 (5f7f02f)
- set major version (6d2e71e)
- switch branch for beta (6263ef1)
- take out migration to solution style tsconfigs (e6129b7)
- update dependencies (7c069ac)
- updated README-nx.md (6aa809d)
18.0.0 (2020-08-10)
⚠️ BREAKING CHANGES
- do not append a / to service activators anymore
- do not ignore empty arrays in SAs by default (#445)
Bug Fixes 🐛
- do not append a / to service activators anymore (720cd84)
Features ✨
- do not ignore empty arrays in SAs by default (#445) (43bf83c)
Version 17
Service Activator Status Codes Exclude Handling
So far the configuration of any serviceActivatorErrorHandlingExcludeStatusCodes in a service activator would have the effect that the navigation was allowed for all status codes. Not just the configured ones.
This behavior is now changed, so that only the configured status codes are taken into consideration. All other status codes will prevent the navigation.
The preventNavigationOnError flag can still be used to block the navigation on any error.
⚠️ BREAKING CHANGES
- faulty service activator configs are considered as hard errors now
Features ✨
- replace deep-equal with fast-deep-equal (201d8ed)
Other 🧾
- remove cypress dependency (007a341)
Bug Fixes 🐛
- add the json schemas to the published package (b49bcb0)
- also rethrow error when there is no logger (f64b3f2)
- faulty service activator configs are considered as hard errors now (99fc65d)
- remove fit to also run the other tests (f89a6bc)
Version 16
The pfe was switched to use nx
Version 15
Breaking Changes
Until now the frontend state was always automatically stored on the remote state service with every navigation (If a state service was configured).
This behavior is now deactivated by default.
The NgxPfeModuleConfiguration provides a flag, enableAutomaticStateStorage, to turn the previous behavior back on.
Additionally a new action is now available to trigger a remote state storage: PFE_UPDATE_STATE_ON_BACKEND
Version 14
Breaking Changes
ngx-model was upgraded to @angular-extensions/model.
This fixes the issue that values that were not retrieved as observables from the state were no copies. This made is possible to actually mutate the state without using the dedicated API.
This is a breaking change, as it changes the behavior of the getValue* methods.
Although this is highly unlikely, there might be apps that depend on this wrong behavior. (https://xkcd.com/1172/)
Version 13
Improvements
- Cleanup of the peer dependencies
Breaking Changes
- The tracking integration (PfeTrackingService) was moved to it's own secondary entry:
@allianz/ngx-pfe/tracking
- The NgxHttpTokenModule was moved to
@allianz/ngx-pfe/ngx-http-token and marked as deprecated. It will be removed in the future.
Version 12.x
🎉 IVY 🎉
Changes to the lazy loading of modules
Angular 9 adds a lot of awesomeness with ivy, also in regard to the lazy loading of modules and even components (🎉).
But this new handling has a catch for the pages-mapping in the pfe. (The behavior is the same for the standard Angular routing without pfe.)
If the exported route (The loadChildren: () => import... statement), is part of the same file as the module it references, it will end up in the main bundle!
Background of this change
Ivy contains a new handling of side effects.
See also: https://angular.io/guide/ivy-compatibility#payload-size-debugging and https://github.com/angular/angular-cli/issues/16799#issuecomment-580912090
The previous view engine builds assumed, that the code of the app is side effects free.
With ivy this is turned around and the code is assumed to have side effects.
(The webpack default is now simply active: https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free)
This means the build will follow all imports and add that code to the bundle.
If there are additional imports, those will end up in the bundle.
What to do
A simple solution is to move the route definition to a separate file.
For example:
./viewer/src/app/documentation/demos/pfe-basic/app/pages/lazy-loaded-page/lazy-page.route.ts
Then the module is built as a separate chunk again.
See the documentation for further information about this
TL;DR
- The route definition and the actual module should not be in the same file
- Double check if lazy modules are actually built as a separate chunk
Other Changes
- The documentation was updated for Angular 9
- Removed angular2-hotkeys peer dependency
Breaking Changes
- The tenant and config-id headers are not added automatically anymore. If these headers are needed, the PfeHeaderInterceptor is still part of the package and can be imported in the app.
Version 11.x
Major new Features
- First release of the new pfeActions. These will replace the onPageEnter/onPageLeave ServiceActivators and state update features in the future. The actions allow it, to trigger those in a more generic and extensible way. It is also possible to add custom actions within an app that uses the pfe.
- It is now possible to configure URL parameters that are copied to the state during startup. The stateKey is also configurable. See the urlParametersInState attribute in the pfeConfig.
Version 10.x
Major new Features
- The
responseDataMapping default behavior has been changed. Before, if the service activator response included undefined data, the response mapping was still done, overwriting the previous values in the state.
Now by default if an undefined or null value arrives, it will not be updated in the state to preserve the previous value. However,
the old mapping behavior can be restored by setting the mapUndefinedResponses boolean to true in the service activator configuration.
- The new
errorPageNavigation configuration can be used to navigate to different error pages dependent on conditions. The conditions can access the state, as well as the full server response (Including status code, etc...)
- The pfeTrackingService can now watch any JsonPathExpressions in the state. Every time the value of a key changes, a tracking event is triggered. The values to be watched can be configured in the pfeConfig.
- There is a new method on the pfeBusinessService to manage the validity status of a page. setPageStatus(pageStatus: boolean) should be used for that now. The previous method of writing the pageId with a boolean value to the state is deprecated and will be removed.
New Features
- The
pfestate- parameter was renamed to pfe-. The previous one will also still work.
Bug Fixes
- Fixed the multiple loading of the config, when multiple callers requested the config at the same time.
Version 9
Major new Features
Config Editor
- The configEditor will now sort and format the navigation.json to make it easier for git to do merges.
- The configEditor can now help to identify possibly unused i18n keys.
Breaking Changes
- All ndbx based components got moved to a secondary entry point
@allianz/ngx-pfe/ndbx
- The pfe-master-page now only consists of templates. The previous ndbx based default components are now available in the pfe-ndbx-master-page, which behaves exactly the same as in previous versions.
- The dev tools got moved to a secondary entry point:
@allianz/ngx-pfe/pfe-dev-tools
- The error handling behavior of service activators was changed. Previously the navigation was never activated in case of an http error response. Now the navigation will be executed if the serviceActivatorErrorHandlingExcludeStatusCodes option is used. This makes it possible to run a custom navigation for these cases. If the previous behavior is needed, the preventNavigationOnError option can be used additionally. It is highly recommended to validate the behavior for existing configurations.
Angular 8, and in the future Ivy, come with a lot of changes to the routing and lazy loading. These changes also affect the pfe.
With version 8 the situation is as this:
- The lazy loading of modules can now be done with the new import based approach. The legacy approach still works, but it is highly recommended to switch.
- This means, that there is now type safety available for that mapping. This prevents errors that could happen before with typos in the loadChildren magic string.
- At the moment, the angular compiler is very picky about the format of the module import statements. So they need to be exactly like described in the documentation
Steps during the update:
- The angular update will automatically replace the legacy
loadChildren entries with the new import ones
- The provideRoutes can then be removed from the modules
- Instead, the routes object is simply exported and then imported in the
pages-mapping.ts
Version 7.x
Follow these steps, to update from the 6.x release to the 7.x versions:
- Add the app routing configuration, as described in this documentation
- Input injectors are not used anymore. This code needs to be moved into the page components
- The page mapping functionality of the PfeInjectionService is now provided by the PfePageMappingService
- Move the backButtonLabel and nextButtonLabel configuration to the application.json
- Check for further compile errors
- Run tslint which will provide further information about deprecated methods.
Make sure that the tslint configuration contains the deprecation setup.
For example:
"deprecation": {
"severity": "warn"
}
Older Major Versions
| Version |
Description |
| 0.x |
Beta versions |
| 1.x |
Based on NDBX 3.x versions. |
| 2.x |
|
| 3.x |
Based on NDBX 3.x versions. Supports the new service activator architecture. |
| 4.x |
Last Angular 5 based release. |
| 6.x |
Supports Angular 6 and ngx-ndbx 6. |
| 7.x |
First release, that switches to angular routing as basis. |