@ama-mfe/messages
v14.5.1
Published
Contains common messages types used for iframes dialog in mfe architecture
Keywords
Readme
Ama mfe messages package
The @ama-mfe/messages package exposes a set of message interfaces to help the communication between a host application
and module applications embedded via iframes.
These interfaces can be used to create messages compatible with the Amadeus Toolkit for Micro Frontends framework.
Installation
npm install @ama-mfe/messages
Message interfaces
The message interfaces exposed in this package cover common use cases such as:
- Navigation: an embedded application requests its host to navigate to a specific URL.
- Resize: an embedded application's dimension changed and requests its host to adapt the iframe dimension to fit the new content.
- [Theme](https://github.com/AmadeusITGroup/otter/blob/main/packages/%40ama-mfe/ng-utils/src/theme/: a host application requests its embedded module to apply a common css theme.
Messages are identified thanks to their type property and are versioned for backward compatibility.
Navigation messages
v1.0
Carries the target url only.
v1.1
Adds an optional extras field to forward a subset of Angular NavigationExtras across the iframe boundary so the
receiving router can reproduce the original history/location semantics. Currently supports:
replaceUrl: when set, the host navigates by replacing the current history entry instead of pushing a new one. This is the key fix for modules that callrouter.navigate(..., { replaceUrl: true })to skip a route from history — without forwarding, the host still pushes a new entry and the browser back button gets stuck in a loop.
