@fluid-app/widget-runtime 0.1.4 → 0.1.6

package/README.md

@@ -11,8 +11,41 @@ Widget discovery, descriptor validation, catalog access, publishing, and builder
 
 ## Host
 
+Portal applications should use the Portal SDK host. It owns the complete
+reviewed Fluid UI renderer map and keeps component overlays inside the widget
+shadow root. The application only supplies the compiled shadow-root CSS:
+
+```tsx
+import { createPortal } from "@fluid-app/portal-sdk";
+import fluidComponentCssUrl from "@fluid-app/portal-sdk/remote-widget-shadow.css?url";
+
+createPortal({
+  remoteWidgets: { fluidComponentCssUrls: [fluidComponentCssUrl] },
+});
+```
+
+The current portal application and generated portal starter include this
+configuration. Mist's direct live-preview host supplies the same renderer map,
+containment wrapper, and stylesheet as inline CSS.
+
+`mountRemoteDomWidget()` is the lower-level host API. A direct consumer of a
+current Fluid widget worker must provide all three Fluid UI host pieces:
+
+- the complete reviewed `componentRenderers` map;
+- a `wrapRemoteRoot` implementation that contains portals in the widget area;
+- the matching `fluidComponentCssText` or `fluidComponentCssUrls`.
+
+The runtime advertises Fluid UI contract v2 only when every v2 renderer is
+present. A Fluid UI worker therefore fails contract negotiation instead of
+mounting against a host with a partial renderer set.
+
 ```tsx
 import { mountRemoteDomWidget } from "@fluid-app/widget-runtime/remote-dom";
+import {
+  REMOTE_DOM_COMPONENT_RENDERERS,
+  wrapRemoteDomRoot,
+} from "@fluid-app/portal-sdk";
+import fluidComponentCssUrl from "@fluid-app/portal-sdk/remote-widget-shadow.css?url";
 
 const handle = mountRemoteDomWidget({
   host: document.querySelector("#widget")!,
@@ -26,6 +59,9 @@ const handle = mountRemoteDomWidget({
     capabilities: [{ name: "account", version: "1" }],
   },
   props: { name: "Ada" },
+  componentRenderers: REMOTE_DOM_COMPONENT_RENDERERS,
+  wrapRemoteRoot: wrapRemoteDomRoot,
+  fluidComponentCssUrls: [fluidComponentCssUrl],
   callCapability: (capability, method, payload) =>
     portalCapabilities.call(capability, method, payload),
 });

package/dist/index.cjs

@@ -1,6 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_remote_dom_renderer = require("./remote-dom-renderer-f7OWlvvv.cjs");
-const require_remote_dom_values = require("./remote-dom-values-DbgIedSg.cjs");
+const require_remote_dom_renderer = require("./remote-dom-renderer-BlZKfMAA.cjs");
+const require_remote_dom_values = require("./remote-dom-values-B5UZPDRy.cjs");
+exports.REMOTE_DOM_UI_COMPONENTS = require_remote_dom_values.REMOTE_DOM_UI_COMPONENTS;
 exports.isRemoteDomSerializableValue = require_remote_dom_values.isRemoteDomSerializableValue;
 exports.mountRemoteDomWidget = require_remote_dom_renderer.mountRemoteDomWidget;
 exports.toRemoteDomSerializableValue = require_remote_dom_values.toRemoteDomSerializableValue;

package/dist/index.d.cts

@@ -1,3 +1,4 @@
 import { a as isRemoteDomSerializableValue, i as RemoteDomUrlOriginPolicyInput, n as RemoteDomSerializableValue, o as toRemoteDomSerializableValue, r as RemoteDomUrlOriginPolicy, t as RemoteDomNavigationIntent } from "./remote-dom-values-D4AgBNWr.cjs";
-import { a as RemoteDomWidgetHandle, c as mountRemoteDomWidget, d as RemoteDomStyleAttachment, f as RemoteDomThemeBridgeOptions, i as RemoteDomWidgetArtifact, l as RemoteDomCssFetcher, n as RemoteDomCapabilityDeclaration, o as RemoteDomWorkerFactory, r as RemoteDomFullscreenRequest, s as RemoteDomWorkerLike, t as MountRemoteDomWidgetOptions, u as RemoteDomCssUrlInput } from "./remote-dom-renderer-CeYSItkU.cjs";
-export { type MountRemoteDomWidgetOptions, type RemoteDomCapabilityDeclaration, type RemoteDomCssFetcher, type RemoteDomCssUrlInput, type RemoteDomFullscreenRequest, type RemoteDomNavigationIntent, type RemoteDomSerializableValue, type RemoteDomStyleAttachment, type RemoteDomThemeBridgeOptions, type RemoteDomUrlOriginPolicy, type RemoteDomUrlOriginPolicyInput, type RemoteDomWidgetArtifact, type RemoteDomWidgetHandle, type RemoteDomWorkerFactory, type RemoteDomWorkerLike, isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };
+import { a as RemoteDomWidgetHandle, c as mountRemoteDomWidget, d as RemoteDomStyleAttachment, f as RemoteDomThemeBridgeOptions, i as RemoteDomWidgetArtifact, l as RemoteDomCssFetcher, n as RemoteDomCapabilityDeclaration, o as RemoteDomWorkerFactory, r as RemoteDomFullscreenRequest, s as RemoteDomWorkerLike, t as MountRemoteDomWidgetOptions, u as RemoteDomCssUrlInput } from "./remote-dom-renderer-BoB9jd3B.cjs";
+import { t as REMOTE_DOM_UI_COMPONENTS } from "./remote-dom-ui-contract-BLOyWbT2.cjs";
+export { type MountRemoteDomWidgetOptions, REMOTE_DOM_UI_COMPONENTS, type RemoteDomCapabilityDeclaration, type RemoteDomCssFetcher, type RemoteDomCssUrlInput, type RemoteDomFullscreenRequest, type RemoteDomNavigationIntent, type RemoteDomSerializableValue, type RemoteDomStyleAttachment, type RemoteDomThemeBridgeOptions, type RemoteDomUrlOriginPolicy, type RemoteDomUrlOriginPolicyInput, type RemoteDomWidgetArtifact, type RemoteDomWidgetHandle, type RemoteDomWorkerFactory, type RemoteDomWorkerLike, isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };

package/dist/index.d.mts

@@ -1,3 +1,4 @@
 import { a as isRemoteDomSerializableValue, i as RemoteDomUrlOriginPolicyInput, n as RemoteDomSerializableValue, o as toRemoteDomSerializableValue, r as RemoteDomUrlOriginPolicy, t as RemoteDomNavigationIntent } from "./remote-dom-values-EwoLXnSn.mjs";
-import { a as RemoteDomWidgetHandle, c as mountRemoteDomWidget, d as RemoteDomStyleAttachment, f as RemoteDomThemeBridgeOptions, i as RemoteDomWidgetArtifact, l as RemoteDomCssFetcher, n as RemoteDomCapabilityDeclaration, o as RemoteDomWorkerFactory, r as RemoteDomFullscreenRequest, s as RemoteDomWorkerLike, t as MountRemoteDomWidgetOptions, u as RemoteDomCssUrlInput } from "./remote-dom-renderer-CKvnUH8G.mjs";
-export { type MountRemoteDomWidgetOptions, type RemoteDomCapabilityDeclaration, type RemoteDomCssFetcher, type RemoteDomCssUrlInput, type RemoteDomFullscreenRequest, type RemoteDomNavigationIntent, type RemoteDomSerializableValue, type RemoteDomStyleAttachment, type RemoteDomThemeBridgeOptions, type RemoteDomUrlOriginPolicy, type RemoteDomUrlOriginPolicyInput, type RemoteDomWidgetArtifact, type RemoteDomWidgetHandle, type RemoteDomWorkerFactory, type RemoteDomWorkerLike, isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };
+import { a as RemoteDomWidgetHandle, c as mountRemoteDomWidget, d as RemoteDomStyleAttachment, f as RemoteDomThemeBridgeOptions, i as RemoteDomWidgetArtifact, l as RemoteDomCssFetcher, n as RemoteDomCapabilityDeclaration, o as RemoteDomWorkerFactory, r as RemoteDomFullscreenRequest, s as RemoteDomWorkerLike, t as MountRemoteDomWidgetOptions, u as RemoteDomCssUrlInput } from "./remote-dom-renderer-BGIZ0FRi.mjs";
+import { t as REMOTE_DOM_UI_COMPONENTS } from "./remote-dom-ui-contract-B140dMly.mjs";
+export { type MountRemoteDomWidgetOptions, REMOTE_DOM_UI_COMPONENTS, type RemoteDomCapabilityDeclaration, type RemoteDomCssFetcher, type RemoteDomCssUrlInput, type RemoteDomFullscreenRequest, type RemoteDomNavigationIntent, type RemoteDomSerializableValue, type RemoteDomStyleAttachment, type RemoteDomThemeBridgeOptions, type RemoteDomUrlOriginPolicy, type RemoteDomUrlOriginPolicyInput, type RemoteDomWidgetArtifact, type RemoteDomWidgetHandle, type RemoteDomWorkerFactory, type RemoteDomWorkerLike, isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };

package/dist/index.mjs

@@ -1,3 +1,3 @@
-import { c as isRemoteDomSerializableValue, u as toRemoteDomSerializableValue } from "./remote-dom-values-BSAxrOE7.mjs";
-import { t as mountRemoteDomWidget } from "./remote-dom-renderer-CpdKWANy.mjs";
-export { isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };
+import { a as isRemoteDomSerializableValue, l as REMOTE_DOM_UI_COMPONENTS, s as toRemoteDomSerializableValue } from "./remote-dom-values-wEbrw5iW.mjs";
+import { t as mountRemoteDomWidget } from "./remote-dom-renderer-Dn3pfVsl.mjs";
+export { REMOTE_DOM_UI_COMPONENTS, isRemoteDomSerializableValue, mountRemoteDomWidget, toRemoteDomSerializableValue };

package/dist/{remote-dom-renderer-CKvnUH8G.d.mts → remote-dom-renderer-BGIZ0FRi.d.mts}

@@ -1,4 +1,6 @@
 import { n as RemoteDomSerializableValue, t as RemoteDomNavigationIntent } from "./remote-dom-values-EwoLXnSn.mjs";
+import { RemoteComponentRendererMap } from "@remote-dom/react/host";
+import { ReactElement, ReactNode } from "react";
 
 //#region src/remote-dom-styles.d.ts
 interface RemoteDomStyleAttachment {
@@ -63,12 +65,34 @@ interface MountRemoteDomWidgetOptions {
   readonly cssText?: string | undefined;
   readonly widgetCssText?: string | undefined;
   readonly cssUrls?: readonly RemoteDomCssUrlInput[] | undefined;
+  /**
+   * Compiled Fluid UI CSS attached inside the widget shadow root. Supply this
+   * with {@link MountRemoteDomWidgetOptions.componentRenderers} and
+   * {@link MountRemoteDomWidgetOptions.wrapRemoteRoot} when the host supports
+   * the Fluid UI contract.
+   */
   readonly fluidComponentCssText?: string | undefined;
+  /**
+   * Compiled Fluid UI stylesheets attached inside the widget shadow root.
+   * Supply these with {@link MountRemoteDomWidgetOptions.componentRenderers}
+   * and {@link MountRemoteDomWidgetOptions.wrapRemoteRoot} when the host
+   * supports the Fluid UI contract.
+   */
   readonly fluidComponentCssUrls?: readonly RemoteDomCssUrlInput[] | undefined;
   readonly themeBridgeCssText?: string | undefined;
   readonly themeBridge?: Omit<RemoteDomThemeBridgeOptions, "root"> | false | undefined;
   readonly fetchCss?: RemoteDomCssFetcher | undefined;
   readonly useConstructableStylesheets?: boolean | undefined;
+  /**
+   * Host-owned Fluid component renderers keyed by reviewed remote tag. The
+   * runtime advertises UI contract v2 only when every v2 tag has a renderer.
+   */
+  readonly componentRenderers?: RemoteComponentRendererMap | undefined;
+  /**
+   * Wraps the receiver tree with host providers such as portal containment.
+   * Fluid UI hosts must keep overlays inside the supplied portal container.
+   */
+  readonly wrapRemoteRoot?: ((root: ReactElement, portalContainer: HTMLElement) => ReactNode) | undefined;
 }
 interface RemoteDomWidgetHandle {
   readonly shadowRoot: ShadowRoot;
@@ -87,7 +111,17 @@ interface RemoteDomWorkerLike {
   }) => void;
 }
 type RemoteDomWorkerFactory = (workerEntryUrl: string, options: WorkerOptions) => RemoteDomWorkerLike;
+/**
+ * Mounts one Remote DOM widget worker into an isolated shadow root.
+ *
+ * The low-level runtime supports native Remote DOM elements by default. A host
+ * that supports worker-facing Fluid UI components must also provide the full
+ * reviewed {@link MountRemoteDomWidgetOptions.componentRenderers} map, a
+ * containment-aware {@link MountRemoteDomWidgetOptions.wrapRemoteRoot}, and
+ * the matching Fluid component CSS. The runtime advertises Fluid UI contract
+ * v2 only when every v2 renderer is present.
+ */
 declare function mountRemoteDomWidget(options: MountRemoteDomWidgetOptions): RemoteDomWidgetHandle;
 //#endregion
 export { RemoteDomWidgetHandle as a, mountRemoteDomWidget as c, RemoteDomStyleAttachment as d, RemoteDomThemeBridgeOptions as f, RemoteDomWidgetArtifact as i, RemoteDomCssFetcher as l, RemoteDomCapabilityDeclaration as n, RemoteDomWorkerFactory as o, RemoteDomFullscreenRequest as r, RemoteDomWorkerLike as s, MountRemoteDomWidgetOptions as t, RemoteDomCssUrlInput as u };
-//# sourceMappingURL=remote-dom-renderer-CKvnUH8G.d.mts.map
+//# sourceMappingURL=remote-dom-renderer-BGIZ0FRi.d.mts.map

package/dist/remote-dom-renderer-BGIZ0FRi.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-dom-renderer-BGIZ0FRi.d.mts","names":[],"sources":["../src/remote-dom-styles.ts","../src/remote-dom-renderer.ts"],"mappings":";;;;;UASiB,wBAAA;EAAA,SACN,KAAA,EAAO,OAAA;EAAA,SACP,OAAA;AAAA;AAAA,UAGM,sBAAA;EAAA,SACN,SAAA;EAAA,SACA,OAAA;EAAA,SACA,cAAA;EAAA,SACA,OAAA;EAAA,SACA,SAAA;AAAA;AAAA,UAGM,qBAAA;EAAA,SACN,GAAA;EAAA,SACA,OAAA;AAAA;AAAA,KAGC,oBAAA,YAAgC,qBAAA;AAAA,KAEhC,mBAAA,IAAuB,GAAA,aAAgB,OAAA;AAAA,UAOlC,2BAAA;EAAA,SACN,IAAA,EAAM,UAAA;EAAA,SACN,aAAA,GAAgB,OAAA;EAAA,SAChB,aAAA,GAAgB,IAAA;EAAA,SAChB,OAAA;EAAA,SACA,gBAAA;EAAA,SACA,cAAA;EAAA,SACA,UAAA;EAAA,SACA,qBAAA;AAAA;;;UCqBM,8BAAA;EAAA,SACN,IAAA;EAAA,SACA,OAAA;AAAA;AAAA,UAGM,uBAAA,SAAgC,sBAAA;EAAA,SACtC,UAAA;EAAA,SACA,YAAA,WAAuB,8BAAA;EAAA,SACvB,oBAAA;AAAA;AAAA,UAGM,0BAAA;EAAA,SACN,MAAA;EAAA,SACA,OAAA,GAAU,0BAAA;EAAA,SACV,IAAA,EAAM,WAAA;EAAA,SACN,UAAA,EAAY,UAAA;AAAA;AAAA,UAGN,2BAAA;EAAA,SACN,IAAA,EAAM,WAAA;EAAA,SACN,QAAA,EAAU,uBAAA;EAAA,SACV,KAAA,GAAQ,0BAAA;EAAA,SACR,cAAA,KAEH,UAAA,UACA,MAAA,UACA,OAAA,GAAU,0BAAA,KACP,0BAAA,GAA6B,OAAA,CAAQ,0BAAA;EAAA,SAErC,UAAA,KACH,MAAA,EAAQ,yBAAA,YAAqC,OAAA;EAAA,SAE1C,YAAA,KAEH,OAAA,EAAS,0BAAA,KACN,0BAAA,GAA6B,OAAA,CAAQ,0BAAA;EAAA,SAErC,OAAA,KAAY,KAAA,EAAO,KAAA;EAAA,SACnB,aAAA,GAAgB,sBAAA;EAAA,SAChB,UAAA;EAAA,SACA,YAAA;ED9EqB;EAAA,SCgFrB,iBAAA,GAAoB,WAAA;EAAA,SACpB,oBAAA;EAAA,SACA,eAAA;EAAA,SACA,OAAA;EAAA,SACA,aAAA;EAAA,SACA,OAAA,YAAmB,oBAAA;EDnFK;;AAOnC;;;;EAPmC,SC0FxB,qBAAA;EDhFgB;;;;;;EAAA,SCuFhB,qBAAA,YAAiC,oBAAA;EAAA,SACjC,kBAAA;EAAA,SACA,WAAA,GACL,IAAA,CAAK,2BAAA;EAAA,SAGA,QAAA,GAAW,mBAAA;EAAA,SACX,2BAAA;ED3FA;;;;EAAA,SCgGA,kBAAA,GAAqB,0BAAA;;;;AAzEhC;WA8EW,cAAA,KACH,IAAA,EAAM,YAAA,EAAc,eAAA,EAAiB,WAAA,KAAgB,SAAA;AAAA;AAAA,UAI5C,qBAAA;EAAA,SACN,UAAA,EAAY,UAAA;EAAA,SACZ,MAAA,EAAQ,wBAAA;EAAA,SACR,KAAA,EAAO,OAAA;EAChB,WAAA,CAAY,KAAA,EAAO,0BAAA;EACnB,OAAA;AAAA;AAAA,UAGe,mBAAA;EACf,SAAA,IAAa,KAAA,EAAO,YAAA;EACpB,OAAA,IAAW,KAAA,EAAO,UAAA;EAClB,WAAA,CAAY,OAAA,WAAkB,QAAA,GAAW,YAAA;EACzC,SAAA;EACA,gBAAA,IACE,IAAA,aACA,QAAA,GAAW,KAAA,EAAO,YAAA,oBAClB,OAAA;IAAY,MAAA,GAAS,WAAA;EAAA;AAAA;AAAA,KAIb,sBAAA,IACV,cAAA,UACA,OAAA,EAAS,aAAA,KACN,mBAAA;;;;;;;;;;;iBAoWW,oBAAA,CACd,OAAA,EAAS,2BAAA,GACR,qBAAA"}