@open-pioneer/integration 2.0.9 → 2.2.0
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/CHANGELOG.md +20 -0
- package/README.md +6 -7
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# @open-pioneer/integration
|
|
2
2
|
|
|
3
|
+
## 2.2.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 39dad46: Switch to a new versioning strategy.
|
|
8
|
+
From now on, packages released by this repository share a common version number.
|
|
9
|
+
- Updated dependencies [39dad46]
|
|
10
|
+
- @open-pioneer/runtime@2.2.0
|
|
11
|
+
|
|
12
|
+
## 2.0.10
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- 5c62522: Update wording and harmonize structure
|
|
17
|
+
- 6cc7fcd: Allow synchronous `getApiMethods()` when implementing an `ApiExtension`.
|
|
18
|
+
- Updated dependencies [58ce24f]
|
|
19
|
+
- Updated dependencies [e0b2fae]
|
|
20
|
+
- Updated dependencies [6cc7fcd]
|
|
21
|
+
- @open-pioneer/runtime@2.1.7
|
|
22
|
+
|
|
3
23
|
## 2.0.9
|
|
4
24
|
|
|
5
25
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
# @open-pioneer/integration
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This package provides techniques for the communication between an application (web component) and its embedding site.
|
|
4
4
|
This is useful when the application's web component is embedded into another site.
|
|
5
5
|
|
|
6
|
-
The package exports the `ApiExtension` interface that can be used to provide API functions
|
|
7
|
-
that can be called from the outer site to trigger actions in the web component.
|
|
6
|
+
The package exports the `ApiExtension` interface that can be used to provide API functions that can be called from the outer site to trigger actions in the web component.
|
|
8
7
|
The ApiExtension support is implemented in the `@open-pioneer/runtime` package.
|
|
9
8
|
|
|
10
9
|
Additionally, the package contains the `ExternalEventService`,
|
|
11
10
|
which can be used to emit events to the host site from inside the Open Pioneer Trails application.
|
|
12
11
|
|
|
13
|
-
##
|
|
12
|
+
## Usage
|
|
14
13
|
|
|
15
14
|
### Web component API
|
|
16
15
|
|
|
@@ -57,7 +56,7 @@ export class TextApiExtension implements ApiExtension {
|
|
|
57
56
|
|
|
58
57
|
To use the API methods in the surrounding site, call the `when()` method on the app.
|
|
59
58
|
It resolves to the app's API when the application has started.
|
|
60
|
-
|
|
59
|
+
It is then possible to call the provided methods on the returned API instance.
|
|
61
60
|
|
|
62
61
|
For example:
|
|
63
62
|
|
|
@@ -81,7 +80,7 @@ For example:
|
|
|
81
80
|
```
|
|
82
81
|
|
|
83
82
|
> Note: The `when()` method is implemented as a method on the custom element class generated by the `createCustomElement()` function in the runtime package.
|
|
84
|
-
> It
|
|
83
|
+
> It is available once the web component is defined (which is why the example code waits by calling `customElements.whenDefined`).
|
|
85
84
|
|
|
86
85
|
### ExternalEventService
|
|
87
86
|
|
|
@@ -118,7 +117,7 @@ eventService.emitEvent("extent-selected", {
|
|
|
118
117
|
eventService.emitEvent(new CustomEvent(...));
|
|
119
118
|
```
|
|
120
119
|
|
|
121
|
-
The events
|
|
120
|
+
The events are emitted on the application's host node.
|
|
122
121
|
You can subscribe to them from outside the application via `addEventListener`:
|
|
123
122
|
|
|
124
123
|
```js
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"type": "module",
|
|
3
3
|
"name": "@open-pioneer/integration",
|
|
4
|
-
"version": "2.0
|
|
4
|
+
"version": "2.2.0",
|
|
5
5
|
"description": "Provides techniques for the communication between an application (web component) and its embedding site.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"open-pioneer-trails"
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"directory": "src/packages/integration"
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
|
-
"@open-pioneer/runtime": "^2.
|
|
17
|
+
"@open-pioneer/runtime": "^2.2.0"
|
|
18
18
|
},
|
|
19
19
|
"exports": {
|
|
20
20
|
"./package.json": "./package.json",
|