@adobe/uix-host-react 0.6.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Adobe
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1 @@
+This is the `@adobe/uix-host-react` package alone. See [/README.md](../../README.md) for details.

package/dist/components/Extensible.d.ts

@@ -0,0 +1,41 @@
+import type { PropsWithChildren } from "react";
+import type { ExtensionsProvider, HostConfig, PortOptions, SharedContextValues } from "@adobe/uix-host";
+/** @public */
+export interface ExtensibleProps extends Omit<HostConfig, "hostName"> {
+    /**
+     * Unique name for identifying this extensible app. May be used as metadata in
+     * extension registry in the future.
+     */
+    appName?: string;
+    /**
+     * Function which returns a promise for the full list of extensions.
+     */
+    extensionsProvider: ExtensionsProvider;
+    /**
+     * {@inheritDoc HostConfig.guestOptions}
+     */
+    guestOptions?: PortOptions;
+    /**
+     * {@inheritDoc HostConfig.sharedContext}
+     */
+    sharedContext?: SharedContextValues;
+}
+/**
+ * Declares an extensible area in an app, and provides host and extension
+ * objects to all descendents. The {@link useExtensions} hook can only be called
+ * in a descendent of this component.
+ *
+ * @remarks
+ * For many apps, there will be only one Extensible provider, fairly high in the
+ * component tree. It is a context provider component that may be bundled with
+ * other context providers in your app architecture.
+ *
+ * Each Extensible element creates one {@link @adobe/uix-host#Host} object and
+ * one call to an extensions provider. If multiple Extensible elements are used,
+ * this may cause redundant calls. Such a design should be carefully considered.
+ *
+ * @public
+ */
+export declare function Extensible({ appName, children, extensionsProvider, guestOptions, runtimeContainer, debug, sharedContext, }: PropsWithChildren<ExtensibleProps>): JSX.Element;
+export default Extensible;
+//# sourceMappingURL=Extensible.d.ts.map

package/dist/components/Extensible.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Extensible.d.ts","sourceRoot":"","sources":["../../src/components/Extensible.tsx"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,KAAK,EAEV,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AAIzB,cAAc;AACd,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;IACnE;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;IACvC;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC;IAC3B;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC;AAaD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,KAAK,EACL,aAAkB,GACnB,EAAE,iBAAiB,CAAC,eAAe,CAAC,eAmDpC;AACD,eAAe,UAAU,CAAC"}

package/dist/components/GuestUIFrame.d.ts

@@ -0,0 +1,43 @@
+import type { VirtualApi } from "@adobe/uix-core";
+import type { PropsWithChildren, IframeHTMLAttributes } from "react";
+/**
+ * @public
+ */
+declare type FrameProps = IframeHTMLAttributes<HTMLIFrameElement>;
+/** @public */
+export interface GuestUIProps extends FrameProps {
+    guestId: string;
+    /**
+     * Receives the Penpal context when the frame is mounted.
+     */
+    onConnect: () => unknown;
+    /**
+     * Called when the frame disconnects and unmounts.
+     */
+    onDisconnect: () => unknown;
+    /**
+     * Called when the connection process throws an exception
+     */
+    onConnectionError?: (error: Error) => void;
+    /**
+     * Optional custom URL or path.
+     */
+    src: string;
+    /**
+     * Host methods to provide only to the guest inside this iframe.
+     */
+    methods?: VirtualApi;
+    /**
+     *
+     * @defaultValue "100%"
+     */
+    width: FrameProps["width"];
+}
+/**
+ * An iframe that attaches to a running GuestServer, to display visible UI pages
+ * delivered by the Extension server.
+ * @public
+ */
+export declare function GuestUIFrame({ guestId, src, onConnect, onDisconnect, onConnectionError, methods, ...customFrameProps }: PropsWithChildren<GuestUIProps>): JSX.Element;
+export default GuestUIFrame;
+//# sourceMappingURL=GuestUIFrame.d.ts.map

package/dist/components/GuestUIFrame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GuestUIFrame.d.ts","sourceRoot":"","sources":["../../src/components/GuestUIFrame.tsx"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAGrE;;GAEG;AACH,aAAK,UAAU,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAE1D,cAAc;AACd,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC;IACzB;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC5B;AAWD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,EAC3B,OAAO,EACP,GAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,GAAG,gBAAgB,EACpB,EAAE,iBAAiB,CAAC,YAAY,CAAC,eA4CjC;AACD,eAAe,YAAY,CAAC"}

package/dist/components/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Extensible.js";
+export * from "./GuestUIFrame.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAYA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,194 @@
+import { Host } from '@adobe/uix-host';
+export * from '@adobe/uix-host';
+import React, { createContext, useState, useEffect, useMemo, useCallback, useContext } from 'react';
+
+// src/index.ts
+var ExtensionContext = createContext({});
+
+// src/components/Extensible.tsx
+function areExtensionsDifferent(set1, set2) {
+  const ids1 = Object.keys(set1).sort();
+  const ids2 = Object.keys(set2).sort();
+  return ids1.length !== ids2.length || ids1.some((id, index) => id !== ids2[index]);
+}
+function Extensible({
+  appName,
+  children,
+  extensionsProvider,
+  guestOptions,
+  runtimeContainer,
+  debug,
+  sharedContext = {}
+}) {
+  const [extensions, setExtensions] = useState({});
+  useEffect(() => {
+    extensionsProvider().then((loadedExtensions) => {
+      if (areExtensionsDifferent(extensions, loadedExtensions)) {
+        setExtensions(loadedExtensions);
+      }
+    }).catch((e) => {
+      console.error("Fetching list of extensions failed!", e);
+    });
+  }, [extensionsProvider]);
+  const hostName = appName || window.location.host || "mainframe";
+  const host = useMemo(() => {
+    const host2 = new Host({
+      debug,
+      hostName,
+      runtimeContainer,
+      sharedContext
+    });
+    return host2;
+  }, [debug, hostName, runtimeContainer, sharedContext]);
+  useEffect(() => {
+    function logError(msg) {
+      return (e) => {
+        const error = e instanceof Error ? e : new Error(String(e));
+        console.error(msg, error, extensions, guestOptions);
+      };
+    }
+    if (!Object.entries(extensions).length) {
+      return;
+    }
+    host.load(extensions, guestOptions).catch(logError("Load of extensions failed!"));
+    return () => {
+      host.unload().catch(logError("Unload of extensions failed!"));
+    };
+  }, [host, extensions]);
+  return /* @__PURE__ */ React.createElement(ExtensionContext.Provider, {
+    value: host
+  }, children);
+}
+var OutsideOfExtensionContextError = class extends Error {
+  constructor(msg) {
+    super(msg);
+    this.outsideOfExtensionContext = true;
+    Object.setPrototypeOf(this, OutsideOfExtensionContextError.prototype);
+  }
+};
+function useHost() {
+  const host = useContext(ExtensionContext);
+  if (!(host instanceof Host)) {
+    const error = new OutsideOfExtensionContextError(
+      "Attempt to use extensions outside of ExtensionContext. Wrap extensible part of application with Extensible component."
+    );
+    return {
+      host: void 0,
+      error
+    };
+  }
+  return { error: void 0, host };
+}
+
+// src/components/GuestUIFrame.tsx
+var defaultFrameProps = {
+  width: "100%",
+  height: "100%",
+  sandbox: "allow-scripts",
+  style: {
+    border: "none"
+  }
+};
+function GuestUIFrame({
+  guestId,
+  src = "",
+  onConnect,
+  onDisconnect,
+  onConnectionError,
+  methods,
+  ...customFrameProps
+}) {
+  const { host } = useHost();
+  if (!host) {
+    return null;
+  }
+  const guest = host.guests.get(guestId);
+  const frameUrl = new URL(src, guest.url.href);
+  const ref = useCallback((iframe) => {
+    if (iframe) {
+      if (methods) {
+        guest.provide(methods);
+      }
+      const connection = guest.attachUI(iframe);
+      connection.promise.then(() => {
+        if (onConnect) {
+          onConnect();
+        }
+      }).catch((error) => {
+        if (onConnectionError)
+          onConnectionError(error);
+        else
+          throw error;
+      });
+      return async () => {
+        if (onDisconnect) {
+          await onDisconnect();
+          return guest.unload();
+        }
+      };
+    }
+  }, []);
+  const frameProps = { ...defaultFrameProps, ...customFrameProps };
+  return /* @__PURE__ */ React.createElement("iframe", {
+    ref,
+    src: frameUrl.href,
+    name: `uix-guest-${guest.id}`,
+    ...frameProps,
+    sandbox: "allow-scripts allow-downloads allow-same-origin allow-presentation"
+  });
+}
+var NO_EXTENSIONS = [];
+function useExtensions(configFactory, deps = []) {
+  const { host, error } = useHost();
+  if (error) {
+    return {
+      extensions: NO_EXTENSIONS,
+      loading: false,
+      error
+    };
+  }
+  const baseDeps = [host, ...deps];
+  const {
+    requires,
+    provides,
+    updateOn = "each"
+  } = useMemo(() => configFactory(host), baseDeps);
+  const getExtensions = useCallback(() => {
+    const newExtensions = [];
+    const guests = host.getLoadedGuests(requires);
+    for (const guest of guests) {
+      if (provides) {
+        guest.provide(provides);
+      }
+      newExtensions.push(guest);
+    }
+    return newExtensions.length === 0 ? NO_EXTENSIONS : newExtensions;
+  }, [...baseDeps, requires]);
+  const subscribe = useCallback(
+    (handler) => {
+      const eventName = updateOn === "all" ? "loadallguests" : "guestload";
+      host.addEventListener(eventName, handler);
+      return () => host.removeEventListener(eventName, handler);
+    },
+    [...baseDeps, updateOn]
+  );
+  const [extensions, setExtensions] = useState(() => getExtensions());
+  useEffect(() => {
+    return subscribe(() => {
+      setExtensions(getExtensions());
+    });
+  }, [subscribe, getExtensions]);
+  const [hostError, setHostError] = useState();
+  useEffect(
+    () => host.addEventListener(
+      "error",
+      (event) => setHostError(event.detail.error)
+    ),
+    baseDeps
+  );
+  return { extensions, loading: !host.loading, error: hostError };
+}
+
+export { Extensible, GuestUIFrame, useExtensions };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts","../../src/components/Extensible.tsx","../../src/extension-context.ts","../../src/components/GuestUIFrame.tsx","../../src/hooks/useHost.ts","../../src/hooks/useExtensions.ts"],"names":["host","React","Host","useCallback","useEffect","useMemo","useState"],"mappings":";AAYA,cAAc;;;ACAd,OAAO,SAAS,UAAU,WAAW,eAAe;AASpD,SAAS,YAAY;;;ACNrB,SAAS,qBAAqB;AAGvB,IAAM,mBAAmB,cAAoB,CAAC,CAAoB;;;AD2BzE,SAAS,uBACP,MACA,MACA;AACA,QAAM,OAAO,OAAO,KAAK,IAAI,EAAE,KAAK;AACpC,QAAM,OAAO,OAAO,KAAK,IAAI,EAAE,KAAK;AACpC,SACE,KAAK,WAAW,KAAK,UAAU,KAAK,KAAK,CAAC,IAAI,UAAU,OAAO,KAAK,MAAM;AAE9E;AAkBO,SAAS,WAAW;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,gBAAgB,CAAC;AACnB,GAAuC;AACrC,QAAM,CAAC,YAAY,aAAa,IAAI,SAAS,CAAC,CAAC;AAE/C,YAAU,MAAM;AACd,uBAAmB,EAChB,KAAK,CAAC,qBAA0C;AAC/C,UAAI,uBAAuB,YAAY,gBAAgB,GAAG;AACxD,sBAAc,gBAAgB;AAAA,MAChC;AAAA,IACF,CAAC,EACA,MAAM,CAAC,MAAuB;AAC7B,cAAQ,MAAM,uCAAuC,CAAC;AAAA,IACxD,CAAC;AAAA,EACL,GAAG,CAAC,kBAAkB,CAAC;AAEvB,QAAM,WAAW,WAAW,OAAO,SAAS,QAAQ;AACpD,QAAM,OAAO,QAAQ,MAAM;AACzB,UAAMA,QAAO,IAAI,KAAK;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,WAAOA;AAAA,EACT,GAAG,CAAC,OAAO,UAAU,kBAAkB,aAAa,CAAC;AAErD,YAAU,MAAM;AACd,aAAS,SAAS,KAAa;AAC7B,aAAO,CAAC,MAAuB;AAC7B,cAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,gBAAQ,MAAM,KAAK,OAAO,YAAY,YAAY;AAAA,MACpD;AAAA,IACF;AAEA,QAAI,CAAC,OAAO,QAAQ,UAAU,EAAE,QAAQ;AACtC;AAAA,IACF;AAEA,SACG,KAAK,YAAY,YAAY,EAC7B,MAAM,SAAS,4BAA4B,CAAC;AAC/C,WAAO,MAAM;AACX,WAAK,OAAO,EAAE,MAAM,SAAS,8BAA8B,CAAC;AAAA,IAC9D;AAAA,EACF,GAAG,CAAC,MAAM,UAAU,CAAC;AAErB,SACE,oCAAC,iBAAiB,UAAjB;AAAA,IAA0B,OAAO;AAAA,KAC/B,QACH;AAEJ;;;AEtHA,OAAOC,UAAS,mBAAmB;;;ACDnC,SAAS,kBAAkB;AAC3B,SAAS,QAAAC,aAAY;AAMd,IAAM,iCAAN,cAA6C,MAAM;AAAA,EAExD,YAAY,KAAa;AACvB,UAAM,GAAG;AACT,SAAK,4BAA4B;AACjC,WAAO,eAAe,MAAM,+BAA+B,SAAS;AAAA,EACtE;AACF;AAaO,SAAS,UAA2B;AACzC,QAAM,OAAO,WAAW,gBAAgB;AACxC,MAAI,EAAE,gBAAgBA,QAAO;AAC3B,UAAM,QAAQ,IAAI;AAAA,MAChB;AAAA,IACF;AACA,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACA,SAAO,EAAE,OAAO,QAAW,KAAK;AAClC;;;ADEA,IAAM,oBAAgC;AAAA,EACpC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,OAAO;AAAA,IACL,QAAQ;AAAA,EACV;AACF;AAOO,SAAS,aAAa;AAAA,EAC3B;AAAA,EACA,MAAM;AAAA,EACN;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,KACG;AACL,GAAoC;AAClC,QAAM,EAAE,KAAK,IAAI,QAAQ;AACzB,MAAI,CAAC,MAAM;AACT,WAAO;AAAA,EACT;AACA,QAAM,QAAQ,KAAK,OAAO,IAAI,OAAO;AACrC,QAAM,WAAW,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI;AAE5C,QAAM,MAAM,YAAY,CAAC,WAA8B;AACrD,QAAI,QAAQ;AACV,UAAI,SAAS;AACX,cAAM,QAAQ,OAAO;AAAA,MACvB;AACA,YAAM,aAAa,MAAM,SAAS,MAAM;AACxC,iBAAW,QACR,KAAK,MAAM;AACV,YAAI,WAAW;AACb,oBAAU;AAAA,QACZ;AAAA,MACF,CAAC,EACA,MAAM,CAAC,UAAiB;AACvB,YAAI;AAAmB,4BAAkB,KAAK;AAAA;AACzC,gBAAM;AAAA,MACb,CAAC;AACH,aAAO,YAAY;AACjB,YAAI,cAAc;AAChB,gBAAM,aAAa;AACnB,iBAAO,MAAM,OAAO;AAAA,QACtB;AAAA,MACF;AAAA,IACF;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,aAAa,EAAE,GAAG,mBAAmB,GAAG,iBAAiB;AAE/D,SACE,gBAAAD,OAAA,cAAC;AAAA,IACC;AAAA,IACA,KAAK,SAAS;AAAA,IACd,MAAM,aAAa,MAAM;AAAA,IACxB,GAAG;AAAA,IACJ,SAAQ;AAAA,GACV;AAEJ;;;AE3GA,SAAS,eAAAE,cAAa,aAAAC,YAAW,WAAAC,UAAS,YAAAC,iBAAgB;AAiF1D,IAAM,gBAAoB,CAAC;AAapB,SAAS,cAId,eACA,OAAkB,CAAC,GACY;AAC/B,QAAM,EAAE,MAAM,MAAM,IAAI,QAAQ;AAChC,MAAI,OAAO;AACT,WAAO;AAAA,MACL,YAAY;AAAA,MACZ,SAAS;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAEA,QAAM,WAAW,CAAC,MAAM,GAAG,IAAI;AAC/B,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA,WAAW;AAAA,EACb,IAAID,SAAQ,MAAM,cAAc,IAAI,GAAG,QAAQ;AAE/C,QAAM,gBAAgBF,aAAY,MAAM;AACtC,UAAM,gBAAgB,CAAC;AACvB,UAAM,SAAS,KAAK,gBAAgB,QAAQ;AAC5C,eAAW,SAAS,QAAQ;AAC1B,UAAI,UAAU;AACZ,cAAM,QAAQ,QAAQ;AAAA,MACxB;AACA,oBAAc,KAAK,KAAkD;AAAA,IACvE;AACA,WAAO,cAAc,WAAW,IAAI,gBAAgB;AAAA,EACtD,GAAG,CAAC,GAAG,UAAU,QAAQ,CAAC;AAE1B,QAAM,YAAYA;AAAA,IAChB,CAAC,YAA2B;AAC1B,YAAM,YAAY,aAAa,QAAQ,kBAAkB;AACzD,WAAK,iBAAiB,WAAW,OAAO;AACxC,aAAO,MAAM,KAAK,oBAAoB,WAAW,OAAO;AAAA,IAC1D;AAAA,IACA,CAAC,GAAG,UAAU,QAAQ;AAAA,EACxB;AAEA,QAAM,CAAC,YAAY,aAAa,IAAIG,UAAS,MAAM,cAAc,CAAC;AAClE,EAAAF,WAAU,MAAM;AACd,WAAO,UAAU,MAAM;AACrB,oBAAc,cAAc,CAAC;AAAA,IAC/B,CAAC;AAAA,EACH,GAAG,CAAC,WAAW,aAAa,CAAC;AAE7B,QAAM,CAAC,WAAW,YAAY,IAAIE,UAAgB;AAClD,EAAAF;AAAA,IACE,MACE,KAAK;AAAA,MACH;AAAA,MACA,CAAC,UACC,aAAa,MAAM,OAAO,KAAK;AAAA,IACnC;AAAA,IACF;AAAA,EACF;AAEA,SAAO,EAAE,YAAY,SAAS,CAAC,KAAK,SAAS,OAAO,UAAU;AAChE","sourcesContent":["/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nexport * from \"@adobe/uix-host\";\nexport * from \"./components/index.js\";\nexport * from \"./hooks/index.js\";\n","/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport React, { useState, useEffect, useMemo } from \"react\";\nimport type { PropsWithChildren } from \"react\";\nimport type {\n  InstalledExtensions,\n  ExtensionsProvider,\n  HostConfig,\n  PortOptions,\n  SharedContextValues,\n} from \"@adobe/uix-host\";\nimport { Host } from \"@adobe/uix-host\";\nimport { ExtensionContext } from \"../extension-context.js\";\n\n/** @public */\nexport interface ExtensibleProps extends Omit<HostConfig, \"hostName\"> {\n  /**\n   * Unique name for identifying this extensible app. May be used as metadata in\n   * extension registry in the future.\n   */\n  appName?: string;\n  /**\n   * Function which returns a promise for the full list of extensions.\n   */\n  extensionsProvider: ExtensionsProvider;\n  /**\n   * {@inheritDoc HostConfig.guestOptions}\n   */\n  guestOptions?: PortOptions;\n  /**\n   * {@inheritDoc HostConfig.sharedContext}\n   */\n  sharedContext?: SharedContextValues;\n}\n\nfunction areExtensionsDifferent(\n  set1: InstalledExtensions,\n  set2: InstalledExtensions\n) {\n  const ids1 = Object.keys(set1).sort();\n  const ids2 = Object.keys(set2).sort();\n  return (\n    ids1.length !== ids2.length || ids1.some((id, index) => id !== ids2[index])\n  );\n}\n\n/**\n * Declares an extensible area in an app, and provides host and extension\n * objects to all descendents. The {@link useExtensions} hook can only be called\n * in a descendent of this component.\n *\n * @remarks\n * For many apps, there will be only one Extensible provider, fairly high in the\n * component tree. It is a context provider component that may be bundled with\n * other context providers in your app architecture.\n *\n * Each Extensible element creates one {@link @adobe/uix-host#Host} object and\n * one call to an extensions provider. If multiple Extensible elements are used,\n * this may cause redundant calls. Such a design should be carefully considered.\n *\n * @public\n */\nexport function Extensible({\n  appName,\n  children,\n  extensionsProvider,\n  guestOptions,\n  runtimeContainer,\n  debug,\n  sharedContext = {},\n}: PropsWithChildren<ExtensibleProps>) {\n  const [extensions, setExtensions] = useState({});\n\n  useEffect(() => {\n    extensionsProvider()\n      .then((loadedExtensions: InstalledExtensions) => {\n        if (areExtensionsDifferent(extensions, loadedExtensions)) {\n          setExtensions(loadedExtensions);\n        }\n      })\n      .catch((e: Error | unknown) => {\n        console.error(\"Fetching list of extensions failed!\", e);\n      });\n  }, [extensionsProvider]);\n\n  const hostName = appName || window.location.host || \"mainframe\";\n  const host = useMemo(() => {\n    const host = new Host({\n      debug,\n      hostName,\n      runtimeContainer,\n      sharedContext,\n    });\n    return host;\n  }, [debug, hostName, runtimeContainer, sharedContext]);\n\n  useEffect(() => {\n    function logError(msg: string) {\n      return (e: Error | unknown) => {\n        const error = e instanceof Error ? e : new Error(String(e));\n        console.error(msg, error, extensions, guestOptions);\n      };\n    }\n\n    if (!Object.entries(extensions).length) {\n      return;\n    }\n\n    host\n      .load(extensions, guestOptions)\n      .catch(logError(\"Load of extensions failed!\"));\n    return () => {\n      host.unload().catch(logError(\"Unload of extensions failed!\"));\n    };\n  }, [host, extensions]);\n\n  return (\n    <ExtensionContext.Provider value={host}>\n      {children}\n    </ExtensionContext.Provider>\n  );\n}\nexport default Extensible;\n","/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\n/**\n * @hidden\n */\nimport { createContext } from \"react\";\nimport { Host } from \"@adobe/uix-host\";\n\nexport const ExtensionContext = createContext<Host>({} as unknown as Host);\n","/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport type { VirtualApi } from \"@adobe/uix-core\";\nimport React, { useCallback } from \"react\";\nimport type { PropsWithChildren, IframeHTMLAttributes } from \"react\";\nimport { useHost } from \"../hooks/useHost.js\";\n\n/**\n * @public\n */\ntype FrameProps = IframeHTMLAttributes<HTMLIFrameElement>;\n\n/** @public */\nexport interface GuestUIProps extends FrameProps {\n  guestId: string;\n  /**\n   * Receives the Penpal context when the frame is mounted.\n   */\n  onConnect: () => unknown;\n  /**\n   * Called when the frame disconnects and unmounts.\n   */\n  onDisconnect: () => unknown;\n  /**\n   * Called when the connection process throws an exception\n   */\n  onConnectionError?: (error: Error) => void;\n  /**\n   * Optional custom URL or path.\n   */\n  src: string;\n  /**\n   * Host methods to provide only to the guest inside this iframe.\n   */\n  methods?: VirtualApi;\n\n  /**\n   *\n   * @defaultValue \"100%\"\n   */\n  width: FrameProps[\"width\"];\n}\n\nconst defaultFrameProps: FrameProps = {\n  width: \"100%\",\n  height: \"100%\",\n  sandbox: \"allow-scripts\",\n  style: {\n    border: \"none\",\n  },\n};\n\n/**\n * An iframe that attaches to a running GuestServer, to display visible UI pages\n * delivered by the Extension server.\n * @public\n */\nexport function GuestUIFrame({\n  guestId,\n  src = \"\",\n  onConnect,\n  onDisconnect,\n  onConnectionError,\n  methods,\n  ...customFrameProps\n}: PropsWithChildren<GuestUIProps>) {\n  const { host } = useHost();\n  if (!host) {\n    return null;\n  }\n  const guest = host.guests.get(guestId);\n  const frameUrl = new URL(src, guest.url.href);\n\n  const ref = useCallback((iframe: HTMLIFrameElement) => {\n    if (iframe) {\n      if (methods) {\n        guest.provide(methods);\n      }\n      const connection = guest.attachUI(iframe);\n      connection.promise\n        .then(() => {\n          if (onConnect) {\n            onConnect();\n          }\n        })\n        .catch((error: Error) => {\n          if (onConnectionError) onConnectionError(error);\n          else throw error;\n        });\n      return async () => {\n        if (onDisconnect) {\n          await onDisconnect();\n          return guest.unload();\n        }\n      };\n    }\n  }, []);\n\n  const frameProps = { ...defaultFrameProps, ...customFrameProps };\n\n  return (\n    <iframe\n      ref={ref}\n      src={frameUrl.href}\n      name={`uix-guest-${guest.id}`}\n      {...frameProps}\n      sandbox=\"allow-scripts allow-downloads allow-same-origin allow-presentation\"\n    />\n  );\n}\nexport default GuestUIFrame;\n","/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { useContext } from \"react\";\nimport { Host } from \"@adobe/uix-host\";\nimport { ExtensionContext } from \"../extension-context.js\";\n\n/**\n * @public\n */\nexport class OutsideOfExtensionContextError extends Error {\n  outsideOfExtensionContext: boolean;\n  constructor(msg: string) {\n    super(msg);\n    this.outsideOfExtensionContext = true;\n    Object.setPrototypeOf(this, OutsideOfExtensionContextError.prototype);\n  }\n}\n\n/** @public */\ntype UseHostResponse =\n  | { host: undefined; error: Error }\n  | { host: Host; error: undefined };\n\n/**\n * Retrieve the {@link @adobe/uix-host#Host} object hosting all extensions inside the current parent provider.\n *\n * @remarks Returns a `{ host, error }` tuple, not the host object directly.\n * @beta\n */\nexport function useHost(): UseHostResponse {\n  const host = useContext(ExtensionContext);\n  if (!(host instanceof Host)) {\n    const error = new OutsideOfExtensionContextError(\n      \"Attempt to use extensions outside of ExtensionContext. Wrap extensible part of application with Extensible component.\"\n    );\n    return {\n      host: undefined,\n      error,\n    };\n  }\n  return { error: undefined, host };\n}\n","/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { useCallback, useEffect, useMemo, useState } from \"react\";\nimport type {\n  GuestConnection,\n  GuestApis,\n  RemoteGuestApis,\n  VirtualApi,\n} from \"@adobe/uix-core\";\n\nimport { Host, HostEvents } from \"@adobe/uix-host\";\nimport type { CapabilitySpec } from \"@adobe/uix-host\";\nimport { useHost } from \"./useHost.js\";\n\n/**\n * @internal\n */\nexport interface TypedGuestConnection<T extends GuestApis>\n  extends GuestConnection {\n  id: GuestConnection[\"id\"];\n  apis: RemoteGuestApis<T>;\n}\n\n/** @public */\nexport interface UseExtensionsConfig<\n  Incoming extends GuestApis,\n  Outgoing extends VirtualApi\n> {\n  /**\n   * A {@link @adobe/uix-host#CapabilitySpec} describing the namespaced methods\n   * extensions must implement to be used by this component.\n   *\n   * @remarks\n   * This declaration is used to filter the extensions that will be\n   * returned; if they don't implement those methods, they will be filtered out.\n   */\n  requires?: CapabilitySpec<Incoming>;\n  /**\n   * A namespaced object of methods which extensions will be able to call.\n   *\n   * @remarks This is the counterpart of `requires`; in `requires`, the you\n   * describes methods the extension must implement that your host code will\n   * call, and in `provides`, you implement host methods that extensions will be\n   * able to call.\n   *\n   * Most cases for host-side methods will use the state of the component. This\n   * can cause unexpected bugs in React if the config callback is run on every\n   * render. **useExtensions caches the config callback by default!**\n   * So remember to pass a deps array, so that the config callback re-runs under\n   * the right conditions.\n   */\n  provides?: Outgoing;\n  /**\n   * Sets when re-render is triggered on extension load.\n   *\n   * @remarks\n   * Set to `each` to trigger a component re-render every time an individual\n   * extension loads, which may result in multiple UI updates. Set to `all` to\n   * wait until all extensions have loaded to re-render the component.\n   * @defaultValue \"each\"\n   */\n  updateOn?: \"each\" | \"all\";\n}\n\n/** @public */\nexport interface UseExtensionsResult<T extends GuestApis> {\n  /**\n   * A list of loaded guests which implement the methods specified in\n   * `requires`, represented as {@link @adobe/uix-host#Port} objects which\n   * present methods to be called.\n   */\n  extensions: TypedGuestConnection<T>[];\n  /**\n   * This is `true` until all extensions are loaded. Use for rendering spinners\n   * or other intermediate UI.\n   */\n  loading: boolean;\n  /**\n   * Populated with an Error if there were any problems during the load process.\n   */\n  error?: Error;\n}\n\nconst NO_EXTENSIONS: [] = [];\n\n/**\n * Fetch extensions which implement an API, provide them methods, and use them.\n *\n * @remarks `useExtensions` does three things at once:\n *  - Gets all extensions which implement the APIs described in the `require` field\n *  - Exposes any functions defined in the `provide` field to those extensions\n *  - Returns an object whose `extensions` property is a list of `Port` objects representing those extensions\n *\n * useExtensions will trigger a re-render when extensions load. You can choose whether it triggers that rerender as each extension loads, or only after all extensions have loaded.\n * @public\n */\nexport function useExtensions<\n  Incoming extends GuestApis,\n  Outgoing extends VirtualApi\n>(\n  configFactory: (host: Host) => UseExtensionsConfig<Incoming, Outgoing>,\n  deps: unknown[] = []\n): UseExtensionsResult<Incoming> {\n  const { host, error } = useHost();\n  if (error) {\n    return {\n      extensions: NO_EXTENSIONS,\n      loading: false,\n      error,\n    };\n  }\n\n  const baseDeps = [host, ...deps];\n  const {\n    requires,\n    provides,\n    updateOn = \"each\",\n  } = useMemo(() => configFactory(host), baseDeps);\n\n  const getExtensions = useCallback(() => {\n    const newExtensions = [];\n    const guests = host.getLoadedGuests(requires);\n    for (const guest of guests) {\n      if (provides) {\n        guest.provide(provides);\n      }\n      newExtensions.push(guest as unknown as TypedGuestConnection<Incoming>);\n    }\n    return newExtensions.length === 0 ? NO_EXTENSIONS : newExtensions;\n  }, [...baseDeps, requires]);\n\n  const subscribe = useCallback(\n    (handler: EventListener) => {\n      const eventName = updateOn === \"all\" ? \"loadallguests\" : \"guestload\";\n      host.addEventListener(eventName, handler);\n      return () => host.removeEventListener(eventName, handler);\n    },\n    [...baseDeps, updateOn]\n  );\n\n  const [extensions, setExtensions] = useState(() => getExtensions());\n  useEffect(() => {\n    return subscribe(() => {\n      setExtensions(getExtensions());\n    });\n  }, [subscribe, getExtensions]);\n\n  const [hostError, setHostError] = useState<Error>();\n  useEffect(\n    () =>\n      host.addEventListener(\n        \"error\",\n        (event: Extract<HostEvents, { detail: { error: Error } }>) =>\n          setHostError(event.detail.error)\n      ),\n    baseDeps\n  );\n\n  return { extensions, loading: !host.loading, error: hostError };\n}\n"]}

package/dist/extension-context.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { Host } from "@adobe/uix-host";
+export declare const ExtensionContext: import("react").Context<Host>;
+//# sourceMappingURL=extension-context.d.ts.map

package/dist/extension-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-context.d.ts","sourceRoot":"","sources":["../src/extension-context.ts"],"names":[],"mappings":";AAgBA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,eAAO,MAAM,gBAAgB,+BAA6C,CAAC"}

package/dist/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./useExtensions.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAYA,cAAc,oBAAoB,CAAC"}

package/dist/hooks/useExtensions.d.ts

@@ -0,0 +1,78 @@
+import type { GuestConnection, GuestApis, RemoteGuestApis, VirtualApi } from "@adobe/uix-core";
+import { Host } from "@adobe/uix-host";
+import type { CapabilitySpec } from "@adobe/uix-host";
+/**
+ * @internal
+ */
+export interface TypedGuestConnection<T extends GuestApis> extends GuestConnection {
+    id: GuestConnection["id"];
+    apis: RemoteGuestApis<T>;
+}
+/** @public */
+export interface UseExtensionsConfig<Incoming extends GuestApis, Outgoing extends VirtualApi> {
+    /**
+     * A {@link @adobe/uix-host#CapabilitySpec} describing the namespaced methods
+     * extensions must implement to be used by this component.
+     *
+     * @remarks
+     * This declaration is used to filter the extensions that will be
+     * returned; if they don't implement those methods, they will be filtered out.
+     */
+    requires?: CapabilitySpec<Incoming>;
+    /**
+     * A namespaced object of methods which extensions will be able to call.
+     *
+     * @remarks This is the counterpart of `requires`; in `requires`, the you
+     * describes methods the extension must implement that your host code will
+     * call, and in `provides`, you implement host methods that extensions will be
+     * able to call.
+     *
+     * Most cases for host-side methods will use the state of the component. This
+     * can cause unexpected bugs in React if the config callback is run on every
+     * render. **useExtensions caches the config callback by default!**
+     * So remember to pass a deps array, so that the config callback re-runs under
+     * the right conditions.
+     */
+    provides?: Outgoing;
+    /**
+     * Sets when re-render is triggered on extension load.
+     *
+     * @remarks
+     * Set to `each` to trigger a component re-render every time an individual
+     * extension loads, which may result in multiple UI updates. Set to `all` to
+     * wait until all extensions have loaded to re-render the component.
+     * @defaultValue "each"
+     */
+    updateOn?: "each" | "all";
+}
+/** @public */
+export interface UseExtensionsResult<T extends GuestApis> {
+    /**
+     * A list of loaded guests which implement the methods specified in
+     * `requires`, represented as {@link @adobe/uix-host#Port} objects which
+     * present methods to be called.
+     */
+    extensions: TypedGuestConnection<T>[];
+    /**
+     * This is `true` until all extensions are loaded. Use for rendering spinners
+     * or other intermediate UI.
+     */
+    loading: boolean;
+    /**
+     * Populated with an Error if there were any problems during the load process.
+     */
+    error?: Error;
+}
+/**
+ * Fetch extensions which implement an API, provide them methods, and use them.
+ *
+ * @remarks `useExtensions` does three things at once:
+ *  - Gets all extensions which implement the APIs described in the `require` field
+ *  - Exposes any functions defined in the `provide` field to those extensions
+ *  - Returns an object whose `extensions` property is a list of `Port` objects representing those extensions
+ *
+ * useExtensions will trigger a re-render when extensions load. You can choose whether it triggers that rerender as each extension loads, or only after all extensions have loaded.
+ * @public
+ */
+export declare function useExtensions<Incoming extends GuestApis, Outgoing extends VirtualApi>(configFactory: (host: Host) => UseExtensionsConfig<Incoming, Outgoing>, deps?: unknown[]): UseExtensionsResult<Incoming>;
+//# sourceMappingURL=useExtensions.d.ts.map

package/dist/hooks/useExtensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useExtensions.d.ts","sourceRoot":"","sources":["../../src/hooks/useExtensions.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,eAAe,EACf,SAAS,EACT,eAAe,EACf,UAAU,EACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,IAAI,EAAc,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,SAAS,CACvD,SAAQ,eAAe;IACvB,EAAE,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,mBAAmB,CAClC,QAAQ,SAAS,SAAS,EAC1B,QAAQ,SAAS,UAAU;IAE3B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IACpC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC3B;AAED,cAAc;AACd,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,SAAS;IACtD;;;;OAIG;IACH,UAAU,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAID;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,SAAS,SAAS,EAC1B,QAAQ,SAAS,UAAU,EAE3B,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACtE,IAAI,GAAE,OAAO,EAAO,GACnB,mBAAmB,CAAC,QAAQ,CAAC,CAyD/B"}