Overview of sdk-ui-pluggable-host · GoodData.UI API reference

sdk-ui-pluggable-host package

Functions

Function	Description
dispatchHostNotification(notification)	*(ALPHA)* Dispatches a notification into the currently mounted host UI module.
getBackend()	*(ALPHA)*
installPreloadErrorHandler()	*(ALPHA)* Installs a window listener for `vite:preloadError`. When fired (e.g. a chunk has been removed by a redeploy), the page is hard-reloaded once to pick up new chunk hashes from a fresh index.html. Idempotent: calling more than once registers the listener only once.
installVersionWatcher({ url, intervalMs, onNewDeployment })	*(ALPHA)* Periodically polls the COMMITHASH file and fires `onNewDeployment` once when the deployed commit differs from the one the tab was loaded with. Stops polling after the first detection — the caller decides what to do (typically: show a "please reload" banner). Idempotent: calling more than once is a no-op after the first invocation.
registerAppLifecycleCallbacks(callbacks)	*(ALPHA)* Registers app lifecycle callbacks used by the loader (e.g. for preload telemetry). Called by the host or harness at startup.
registerLocalApplicationLoaders(loaders)	*(ALPHA)* Registers the local application loaders map. Called by the host or harness before any app loading occurs.
registerLocalApplications(registry)	*(ALPHA)* Registers the local pluggable applications manifest. Called by the host or harness before rendering.
registerPlatformContextCallbacks(callbacks)	*(ALPHA)* Registers the host's platform-context lifecycle callbacks. Must be called once at host boot before `<Root>` is rendered so the very first load can report telemetry / errors back to the host application.
reloadForStaleChunks(reason)	*(ALPHA)* Triggers a hard page reload once, guarded against loops by sessionStorage. If the same COMMITHASH already triggered a reload within the last 30 seconds, the call is a no-op so the user is not stuck reloading a broken build.
Root({ callbacks })	*(ALPHA)*
setHostPricingExtension(extension)	*(ALPHA)* Registers a pricing extension that the default host chrome will consume to render trial-upgrade affordances. Optional — when no extension is registered, the chrome shows no upsell button and no pricing dialog.
setRuntimePackageName(name)	*(ALPHA)* Sets the package name reported to the backend for telemetry. Must be called before the first backend request (i.e., before Root renders).
setStaleChunkReloadListener(listener)	*(ALPHA)* Registers a listener invoked synchronously just before a stale-chunk hard reload, intended for telemetry. Called only when the reload actually happens — skipped reloads (loop-guard hits) do not fire the listener.

Interfaces

Interface	Description
IAppLifecycleCallbacks	*(ALPHA)*
IHostChromePricing	*(ALPHA)* Shape returned by a pricing extension hook. Provides the trial-info derived from entitlements + a dialog element so the host chrome can wire the upsell affordances on `<AppHeader>` without owning the dialog implementation.
ILoadPlatformContextCallbacks	*(ALPHA)*
IRootCallbacks	*(ALPHA)*
IStaleChunkReloadInfo	*(ALPHA)* Optional callback invoked synchronously immediately before a stale-chunk hard reload. Gives the host app a chance to record telemetry before navigation cancels in-flight requests.
IVersionWatcherOptions	*(ALPHA)* Options for installVersionWatcher().

Variables

Variable	Description
STALE_CHUNK_RELOAD_PARAM	*(ALPHA)* Query-string parameter appended to the URL on a stale-chunk reload. The value is a timestamp; its only purpose is to make the navigation target a URL the browser has never seen before, defeating any cached HTML/remoteEntry that might otherwise replay the stale module graph. Exported so callers and tests can recognise (and strip) the marker if needed.

Variable

Description

STALE_CHUNK_RELOAD_PARAM

(ALPHA) Query-string parameter appended to the URL on a stale-chunk reload. The value is a timestamp; its only purpose is to make the navigation target a URL the browser has never seen before, defeating any cached HTML/remoteEntry that might otherwise replay the stale module graph.

Exported so callers and tests can recognise (and strip) the marker if needed.

Type Aliases

Type Alias	Description
LocalPluggableApplicationLoader	*(ALPHA)*
StaleChunkReloadListener	*(ALPHA)*
UseHostPricingExtension	*(ALPHA)* A host pricing extension. The `Use` prefix signals that this MUST be a React hook — it is invoked from `HostChrome`'s render and therefore must obey the React Rules of Hooks (stable call order, no conditional hook calls, etc.).