@ama-mfe/messages 14.3.0-prerelease.9 → 14.3.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/cjs/messages/core.js +4 -0
- package/cjs/messages/navigation/base.js +1 -1
- package/cjs/public_api.js +1 -0
- package/package.json +8 -8
- package/src/messages/core.d.ts +9 -0
- package/src/messages/core.d.ts.map +1 -0
- package/src/messages/core.js +2 -0
- package/src/messages/core.js.map +1 -0
- package/src/messages/navigation/base.d.ts +4 -0
- package/src/messages/navigation/base.d.ts.map +1 -1
- package/src/messages/navigation/base.js.map +1 -1
- package/src/messages/navigation/index.d.ts +2 -2
- package/src/messages/navigation/index.d.ts.map +1 -1
- package/src/messages/navigation/index.js.map +1 -1
- package/src/messages/navigation/navigation-versions.d.ts +22 -9
- package/src/messages/navigation/navigation-versions.d.ts.map +1 -1
- package/src/public_api.d.ts +1 -0
- package/src/public_api.d.ts.map +1 -1
- package/src/public_api.js +1 -0
- package/src/public_api.js.map +1 -1
package/README.md
CHANGED
|
@@ -15,3 +15,14 @@ The message interfaces exposed in this package cover common use cases such as:
|
|
|
15
15
|
- [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.
|
|
16
16
|
|
|
17
17
|
Messages are identified thanks to their type property and are versioned for backward compatibility.
|
|
18
|
+
|
|
19
|
+
## Navigation messages
|
|
20
|
+
### v1.0
|
|
21
|
+
Carries the target `url` only.
|
|
22
|
+
|
|
23
|
+
### v1.1
|
|
24
|
+
Adds an optional `extras` field to forward a subset of Angular `NavigationExtras` across the iframe boundary so the
|
|
25
|
+
receiving router can reproduce the original history/location semantics. Currently supports:
|
|
26
|
+
- `replaceUrl`: when set, the host navigates by replacing the current history entry instead of pushing a new one. This is
|
|
27
|
+
the key fix for modules that call `router.navigate(..., { replaceUrl: true })` to skip a route from history — without
|
|
28
|
+
forwarding, the host still pushes a new entry and the browser back button gets stuck in a loop.
|
package/cjs/public_api.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", {
|
|
3
3
|
value: true
|
|
4
4
|
});
|
|
5
|
+
_export_star(require("./messages/core"), exports);
|
|
5
6
|
_export_star(require("./messages/history/index"), exports);
|
|
6
7
|
_export_star(require("./messages/navigation/index"), exports);
|
|
7
8
|
_export_star(require("./messages/resize/index"), exports);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ama-mfe/messages",
|
|
3
|
-
"version": "14.3.0-
|
|
3
|
+
"version": "14.3.0-rc.3",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -43,18 +43,18 @@
|
|
|
43
43
|
"@amadeus-it-group/microfrontends": "0.0.10",
|
|
44
44
|
"@compodoc/compodoc": "^1.1.32",
|
|
45
45
|
"@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
|
|
46
|
-
"@nx/eslint-plugin": "~22.
|
|
47
|
-
"@nx/jest": "~22.
|
|
48
|
-
"@o3r/build-helpers": "~14.3.0-
|
|
49
|
-
"@o3r/eslint-plugin": "~14.3.0-
|
|
50
|
-
"@o3r/test-helpers": "~14.3.0-
|
|
46
|
+
"@nx/eslint-plugin": "~22.7.0",
|
|
47
|
+
"@nx/jest": "~22.7.0",
|
|
48
|
+
"@o3r/build-helpers": "~14.3.0-rc.3",
|
|
49
|
+
"@o3r/eslint-plugin": "~14.3.0-rc.3",
|
|
50
|
+
"@o3r/test-helpers": "~14.3.0-rc.3",
|
|
51
51
|
"@schematics/angular": "~21.2.0",
|
|
52
52
|
"@stylistic/eslint-plugin": "~5.10.0",
|
|
53
53
|
"@swc/cli": "~0.8.0",
|
|
54
54
|
"@swc/core": "~1.15.17",
|
|
55
55
|
"@types/jest": "~30.0.0",
|
|
56
56
|
"@types/node": "~24.12.0",
|
|
57
|
-
"@typescript-eslint/parser": "~8.
|
|
57
|
+
"@typescript-eslint/parser": "~8.58.0",
|
|
58
58
|
"cpy-cli": "^6.0.0",
|
|
59
59
|
"eslint": "~9.39.0",
|
|
60
60
|
"eslint-import-resolver-node": "~0.3.9",
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
"ts-jest": "~29.4.0",
|
|
78
78
|
"type-fest": "^5.3.1",
|
|
79
79
|
"typescript": "~5.9.2",
|
|
80
|
-
"typescript-eslint": "~8.
|
|
80
|
+
"typescript-eslint": "~8.58.0"
|
|
81
81
|
},
|
|
82
82
|
"engines": {
|
|
83
83
|
"node": "^22.17.0 || ^24.0.0"
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { VersionedMessage } from '@amadeus-it-group/microfrontends';
|
|
2
|
+
/** Base structure for all versioned messages in the communication protocol. */
|
|
3
|
+
export interface StrictTypedVersionedMessage<V extends string, T extends string> extends VersionedMessage {
|
|
4
|
+
/** @inheritdoc */
|
|
5
|
+
version: V;
|
|
6
|
+
/** @inheritdoc */
|
|
7
|
+
type: T;
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=core.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/messages/core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EACjB,MAAM,kCAAkC,CAAC;AAE1C,+EAA+E;AAC/E,MAAM,WAAW,2BAA2B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAE,SAAQ,gBAAgB;IACvG,kBAAkB;IAClB,OAAO,EAAE,CAAC,CAAC;IACX,kBAAkB;IAClB,IAAI,EAAE,CAAC,CAAC;CACT"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/messages/core.ts"],"names":[],"mappings":""}
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
import type { StrictTypedVersionedMessage } from '../core';
|
|
1
2
|
/** The navigation message type used at communication with iframes */
|
|
2
3
|
export declare const NAVIGATION_MESSAGE_TYPE = "navigation";
|
|
4
|
+
/** Versioned navigation message */
|
|
5
|
+
export interface VersionedNavigationMessage<V extends string> extends StrictTypedVersionedMessage<V, typeof NAVIGATION_MESSAGE_TYPE> {
|
|
6
|
+
}
|
|
3
7
|
//# sourceMappingURL=base.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/base.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,eAAO,MAAM,uBAAuB,eAAe,CAAC"}
|
|
1
|
+
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AAEjB,qEAAqE;AACrE,eAAO,MAAM,uBAAuB,eAAe,CAAC;AAEpD,mCAAmC;AACnC,MAAM,WAAW,0BAA0B,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,2BAA2B,CAAC,CAAC,EAAE,OAAO,uBAAuB,CAAC;CAAG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../src/messages/navigation/base.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../src/messages/navigation/base.ts"],"names":[],"mappings":"AAIA,qEAAqE;AACrE,MAAM,CAAC,MAAM,uBAAuB,GAAG,YAAY,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { NavigationV1_0 } from './navigation-versions';
|
|
1
|
+
import type { NavigationV1_0, NavigationV1_1 } from './navigation-versions';
|
|
2
2
|
export * from './navigation-versions';
|
|
3
3
|
export { NAVIGATION_MESSAGE_TYPE } from './base';
|
|
4
4
|
/** The versions of navigation messages */
|
|
5
|
-
export type NavigationMessage = NavigationV1_0;
|
|
5
|
+
export type NavigationMessage = NavigationV1_0 | NavigationV1_1;
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC;AAEjD,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC;AAEjD,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,cAAc,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/messages/navigation/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/messages/navigation/index.ts"],"names":[],"mappings":"AAKA,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC"}
|
|
@@ -1,16 +1,29 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
|
|
1
|
+
import type { VersionedNavigationMessage } from './base';
|
|
2
|
+
/** Navigation content for version 1.0 */
|
|
3
|
+
export interface NavigationContentV1_0 {
|
|
4
|
+
/** The url updated */
|
|
5
|
+
url: string;
|
|
6
|
+
}
|
|
3
7
|
/**
|
|
4
8
|
* The navigation message object sent via the communication protocol.
|
|
5
9
|
* Used in microfrontend architecture based on iframes where an iframe change its url and notify its parent with the url change
|
|
6
10
|
* The parent should update its own url with the information received in order to allow the refresh and the deep link share
|
|
7
11
|
*/
|
|
8
|
-
export interface NavigationV1_0 extends
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
export interface NavigationV1_0 extends NavigationContentV1_0, VersionedNavigationMessage<'1.0'> {
|
|
13
|
+
}
|
|
14
|
+
/** Navigation content for version 1.1 */
|
|
15
|
+
export interface NavigationContentV1_1 extends NavigationContentV1_0 {
|
|
16
|
+
/** Subset of NavigationExtras forwarded across the iframe boundary. */
|
|
17
|
+
extras?: {
|
|
18
|
+
/** Navigate while replacing the current history entry instead of pushing a new one. */
|
|
19
|
+
replaceUrl?: boolean;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* The navigation message object sent via the communication protocol.
|
|
24
|
+
* Carries a subset of NavigationExtras alongside the updated url so the receiving router
|
|
25
|
+
* can reproduce the original history/location semantics (e.g. skipping a route from history).
|
|
26
|
+
*/
|
|
27
|
+
export interface NavigationV1_1 extends NavigationContentV1_1, VersionedNavigationMessage<'1.1'> {
|
|
15
28
|
}
|
|
16
29
|
//# sourceMappingURL=navigation-versions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"navigation-versions.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/navigation-versions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,
|
|
1
|
+
{"version":3,"file":"navigation-versions.d.ts","sourceRoot":"","sources":["../../../../src/messages/navigation/navigation-versions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC3B,MAAM,QAAQ,CAAC;AAEhB,yCAAyC;AACzC,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAAG;AAEnG,yCAAyC;AACzC,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,uEAAuE;IACvE,MAAM,CAAC,EAAE;QACP,uFAAuF;QACvF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAAG"}
|
package/src/public_api.d.ts
CHANGED
package/src/public_api.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public_api.d.ts","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC"}
|
|
1
|
+
{"version":3,"file":"public_api.d.ts","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC"}
|
package/src/public_api.js
CHANGED
package/src/public_api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC"}
|
|
1
|
+
{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gCAAgC,CAAC"}
|