Skip to content

Commit feb3829

Browse files
v1.1.3
1 parent db88ee5 commit feb3829

File tree

13 files changed

+96
-25
lines changed

13 files changed

+96
-25
lines changed

docs/api-report/uix-host.api.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ export interface ExtensionRegistryExtensionRegistration extends ExtensionRegistr
7373
imsOrg: string;
7474
}
7575

76+
// @public (undocumented)
77+
export type ExtensionsArray = Array<[string, Extension | string]>;
78+
7679
// @public (undocumented)
7780
export type ExtensionsProvider = () => Promise<InstalledExtensions>;
7881

@@ -82,6 +85,8 @@ export function fetchExtensionsFromRegistry(config: ExtensionRegistryConfig): Pr
8285
// @public
8386
export class Host extends Emitter<HostEvents> {
8487
constructor(config: HostConfig);
88+
// (undocumented)
89+
addLoadsNewGuests(extensions: InstalledExtensions, options?: PortOptions): Promise<void>;
8590
// @eventProperty
8691
contextchange: HostEventContextChange;
8792
// @eventProperty
@@ -106,6 +111,7 @@ export class Host extends Emitter<HostEvents> {
106111
// @eventProperty
107112
loadallguests: HostEventLoadAllGuests;
108113
loading: boolean;
114+
removeGuest(id: string, extension: Extension): Promise<void>;
109115
shareContext(context: SharedContextValues): void;
110116
shareContext(setter: (context: SharedContextValues) => SharedContextValues): void;
111117
// (undocumented)
@@ -145,7 +151,7 @@ export type HostEventLoadAllGuests = HostEvent<"loadallguests", {
145151
}>;
146152

147153
// @public (undocumented)
148-
export type HostEvents = HostGuestEvent<"beforeload"> | HostGuestEvent<"load"> | HostEvent<"beforeunload"> | HostEvent<"unload"> | HostEventLoadAllGuests | HostEventContextChange | HostEventError;
154+
export type HostEvents = HostGuestEvent<"beforeload"> | HostGuestEvent<"load"> | HostGuestEvent<"beforeunload"> | HostGuestEvent<"unload"> | HostEvent<"beforeunload"> | HostEvent<"unload"> | HostEventLoadAllGuests | HostEventContextChange | HostEventError;
149155

150156
// @public (undocumented)
151157
export type InstalledExtensions = Record<Extension["id"], Extension["url"] | Extension>;
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@adobe/uix-host](./uix-host.md) &gt; [ExtensionsArray](./uix-host.extensionsarray.md)
4+
5+
## ExtensionsArray type
6+
7+
8+
**Signature:**
9+
10+
```typescript
11+
export type ExtensionsArray = Array<[string, Extension | string]>;
12+
```
13+
**References:** [Extension](./uix-core.extension.md)
14+
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@adobe/uix-host](./uix-host.md) &gt; [Host](./uix-host.host.md) &gt; [addLoadsNewGuests](./uix-host.host.addloadsnewguests.md)
4+
5+
## Host.addLoadsNewGuests() method
6+
7+
**Signature:**
8+
9+
```typescript
10+
addLoadsNewGuests(extensions: InstalledExtensions, options?: PortOptions): Promise<void>;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| extensions | [InstalledExtensions](./uix-host.installedextensions.md) | |
18+
| options | [PortOptions](./uix-host.portoptions.md) | _(Optional)_ |
19+
20+
**Returns:**
21+
22+
Promise&lt;void&gt;
23+

docs/markdown/uix-host.host.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,12 @@ When a Host creates a Guest, it must create an `<iframe>` element to contain the
5151
5252
| Method | Modifiers | Description |
5353
| --- | --- | --- |
54+
| [addLoadsNewGuests(extensions, options)](./uix-host.host.addloadsnewguests.md) | | |
5455
| [getLoadedGuests()](./uix-host.host.getloadedguests.md) | | Return all loaded guests. |
5556
| [getLoadedGuests(filter)](./uix-host.host.getloadedguests_1.md) | | Return loaded guests which satisfy the passed test function. |
5657
| [getLoadedGuests(capabilities)](./uix-host.host.getloadedguests_2.md) | | Return loaded guests which expose the provided [CapabilitySpec](./uix-host.capabilityspec.md)<!-- -->. |
5758
| [load(extensions, options)](./uix-host.host.load.md) | | Load extension into host application from provided extension description. Returned promise resolves when all extensions are loaded and registered. |
59+
| [removeGuest(id, extension)](./uix-host.host.removeguest.md) | | Unload and remove a specific extension by its ID. |
5860
| [shareContext(context)](./uix-host.host.sharecontext.md) | | Set the object of shared values that all Guests can access via [GuestServer.sharedContext](./uix-guest.guestserver.sharedcontext.md)<!-- -->. This overwrites any previous object. |
5961
| [shareContext(setter)](./uix-host.host.sharecontext_1.md) | | Update the object of shared values that all Guests can access via [GuestServer.sharedContext](./uix-guest.guestserver.sharedcontext.md)<!-- -->. This method takes a callback which receives the previous context and may return an entirely new context, or new values merged with the old context. |
6062
| [shareContext(setter)](./uix-host.host.sharecontext_2.md) | | |
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@adobe/uix-host](./uix-host.md) &gt; [Host](./uix-host.host.md) &gt; [removeGuest](./uix-host.host.removeguest.md)
4+
5+
## Host.removeGuest() method
6+
7+
Unload and remove a specific extension by its ID.
8+
9+
**Signature:**
10+
11+
```typescript
12+
removeGuest(id: string, extension: Extension): Promise<void>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| id | string | |
20+
| extension | [Extension](./uix-core.extension.md) | |
21+
22+
**Returns:**
23+
24+
Promise&lt;void&gt;
25+

docs/markdown/uix-host.hostevents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
**Signature:**
99

1010
```typescript
11-
export type HostEvents = HostGuestEvent<"beforeload"> | HostGuestEvent<"load"> | HostEvent<"beforeunload"> | HostEvent<"unload"> | HostEventLoadAllGuests | HostEventContextChange | HostEventError;
11+
export type HostEvents = HostGuestEvent<"beforeload"> | HostGuestEvent<"load"> | HostGuestEvent<"beforeunload"> | HostGuestEvent<"unload"> | HostEvent<"beforeunload"> | HostEvent<"unload"> | HostEventLoadAllGuests | HostEventContextChange | HostEventError;
1212
```
1313
**References:** [HostGuestEvent](./uix-host.hostguestevent.md)<!-- -->, [HostEvent](./uix-host.hostevent.md)<!-- -->, [HostEventLoadAllGuests](./uix-host.hosteventloadallguests.md)<!-- -->, [HostEventContextChange](./uix-host.hosteventcontextchange.md)<!-- -->, [HostEventError](./uix-host.hosteventerror.md)
1414

docs/markdown/uix-host.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ A React binding is currently available. See [Extensible()](./uix-host-react.exte
9292
| --- | --- |
9393
| [CapabilitySpec](./uix-host.capabilityspec.md) | A specifier for methods to be expected on a remote interface. |
9494
| [EndpointDefinition](./uix-host.endpointdefinition.md) | |
95+
| [ExtensionsArray](./uix-host.extensionsarray.md) | |
9596
| [ExtensionsProvider](./uix-host.extensionsprovider.md) | |
9697
| [GuestFilter](./uix-host.guestfilter.md) | Callback to use to filter the list returned from [Host.getLoadedGuests()](./uix-host.host.getloadedguests_1.md) |
9798
| [HostEvent](./uix-host.hostevent.md) | |

package-lock.json

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@adobe/uix-sdk-monorepo",
33
"private": true,
4-
"version": "1.1.2",
4+
"version": "1.1.3",
55
"description": "Monorepo for @adobe/uix-sdk development",
66
"author": "Adobe, Inc,",
77
"scripts": {

packages/uix-core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@adobe/uix-core",
3-
"version": "1.1.2",
3+
"version": "1.1.3",
44
"publishConfig": {
55
"access": "public"
66
},

0 commit comments

Comments
 (0)