@gooddata/sdk-pluggable-application-model 11.27.0-alpha.1 → 11.27.0-alpha.2

package/esm/index.d.ts

@@ -6,4 +6,5 @@
 export { type EmbeddingMode, type IOrganization, type IOrganizationPermissions, type IPlatformContext, type IPlatformContextV1, type IPluggableApplicationNavigation, PantherTier, isPlatformContextV1, } from "./platformContext.js";
 export { type ILocale } from "@gooddata/sdk-model";
 export { type IAppInstance, type IPluggableApp, type IPluggableApplicationMountHandle, type IPluggableApplicationMountOptions, type IPluggableAppEvent, type PluggableApplicationMount, } from "./mount.js";
+export { type IShellUiModule, type IShellUiMountHandle, type IShellUiMountOptions, type ShellUiMount, } from "./shellUi.js";
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,WAAW,EACX,mBAAmB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACH,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,GACjC,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,WAAW,EACX,mBAAmB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACH,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,GACjC,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,YAAY,GACpB,MAAM,cAAc,CAAC"}

package/esm/sdk-pluggable-application-model.d.ts

@@ -14,6 +14,7 @@ import { IUserSettings } from '@gooddata/sdk-backend-spi';
 import { IWhiteLabeling } from '@gooddata/sdk-model';
 import { IWorkspacePermissions } from '@gooddata/sdk-model';
 import { ObjRef } from '@gooddata/sdk-model';
+import { PluggableApplicationRegistryItem } from '@gooddata/sdk-model';
 
 /**
  * Pluggable application embedding mode.
@@ -180,6 +181,108 @@ export declare interface IPluggableApplicationNavigation {
     openApp(id: string, path?: string): void;
 }
 
+/**
+ * Shell UI module contract.
+ *
+ * @remarks
+ * Implementations loaded via module federation or provided locally must conform
+ * to this interface. The shell application uses the `mount` function to render
+ * the application chrome and obtain the container for the active pluggable application.
+ *
+ * @alpha
+ */
+export declare interface IShellUiModule {
+    mount: ShellUiMount;
+}
+
+/**
+ * Handle returned from a shell UI mount for lifecycle management.
+ *
+ * @alpha
+ */
+export declare interface IShellUiMountHandle {
+    /**
+     * Unmounts the shell UI and releases all resources.
+     */
+    unmount(): void;
+    /**
+     * Pushes an updated platform context into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the context changes after initial mount.
+     */
+    updateContext?(ctx: IPlatformContext): void;
+    /**
+     * Pushes an updated list of resolved applications into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the application list changes after initial mount.
+     */
+    updateApplications?(apps: PluggableApplicationRegistryItem[]): void;
+    /**
+     * Pushes the current pathname into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the URL changes (e.g. after navigation or popstate).
+     * The shell UI uses this to update the active state of navigation items.
+     */
+    updatePathname?(pathname: string): void;
+    /**
+     * Returns the DOM element where the active pluggable application should be rendered.
+     *
+     * @remarks
+     * The host uses this element as the mount container for the currently active
+     * pluggable application. The shell UI is responsible for creating and managing
+     * this element as part of its layout.
+     */
+    getAppContainer(): HTMLElement;
+}
+
+/**
+ * Options passed by the host into a shell UI module's mount function.
+ *
+ * @alpha
+ */
+export declare interface IShellUiMountOptions {
+    /**
+     * DOM element into which the shell UI should render itself.
+     */
+    container: HTMLElement;
+    /**
+     * Platform context snapshot provided by the host.
+     */
+    ctx: IPlatformContext;
+    /**
+     * Resolved and filtered list of pluggable applications to render in the navigation.
+     */
+    resolvedApplications: PluggableApplicationRegistryItem[];
+    /**
+     * Current pathname of the host application.
+     *
+     * @remarks
+     * The shell UI uses this to determine which navigation item is active.
+     * Updated via {@link IShellUiMountHandle.updatePathname} when the URL changes.
+     */
+    pathname: string;
+    /**
+     * Callback for requesting client-side navigation (push).
+     *
+     * @remarks
+     * The host owns the router. When the shell UI needs to navigate (e.g. menu item click),
+     * it calls this callback and the host performs the actual navigation. The host then pushes
+     * the new pathname back via {@link IShellUiMountHandle.updatePathname}.
+     */
+    navigate: (url: string) => void;
+    /**
+     * Callback for requesting client-side navigation with history replacement.
+     *
+     * @remarks
+     * Works like {@link IShellUiMountOptions.navigate} but replaces the current history
+     * entry instead of pushing a new one.
+     */
+    replace: (url: string) => void;
+}
+
 /**
  * Type guard for {@link IPlatformContextV1}.
  *
@@ -207,4 +310,19 @@ export declare enum PantherTier {
  */
 export declare type PluggableApplicationMount = (options: IPluggableApplicationMountOptions) => IPluggableApplicationMountHandle;
 
+/**
+ * Shell UI mount function signature.
+ *
+ * @remarks
+ * A shell UI module must export a `mount` function conforming to this signature.
+ * The function receives a container element and context data, renders the application
+ * shell (header, navigation, layout), and returns a handle for lifecycle management.
+ *
+ * The implementation is framework-agnostic — a module can use React, vanilla DOM,
+ * or any other rendering approach internally.
+ *
+ * @alpha
+ */
+export declare type ShellUiMount = (options: IShellUiMountOptions) => IShellUiMountHandle;
+
 export { }

package/esm/shellUi.d.ts

@@ -0,0 +1,116 @@
+import { type PluggableApplicationRegistryItem } from "@gooddata/sdk-model";
+import { type IPlatformContext } from "./platformContext.js";
+/**
+ * Options passed by the host into a shell UI module's mount function.
+ *
+ * @alpha
+ */
+export interface IShellUiMountOptions {
+    /**
+     * DOM element into which the shell UI should render itself.
+     */
+    container: HTMLElement;
+    /**
+     * Platform context snapshot provided by the host.
+     */
+    ctx: IPlatformContext;
+    /**
+     * Resolved and filtered list of pluggable applications to render in the navigation.
+     */
+    resolvedApplications: PluggableApplicationRegistryItem[];
+    /**
+     * Current pathname of the host application.
+     *
+     * @remarks
+     * The shell UI uses this to determine which navigation item is active.
+     * Updated via {@link IShellUiMountHandle.updatePathname} when the URL changes.
+     */
+    pathname: string;
+    /**
+     * Callback for requesting client-side navigation (push).
+     *
+     * @remarks
+     * The host owns the router. When the shell UI needs to navigate (e.g. menu item click),
+     * it calls this callback and the host performs the actual navigation. The host then pushes
+     * the new pathname back via {@link IShellUiMountHandle.updatePathname}.
+     */
+    navigate: (url: string) => void;
+    /**
+     * Callback for requesting client-side navigation with history replacement.
+     *
+     * @remarks
+     * Works like {@link IShellUiMountOptions.navigate} but replaces the current history
+     * entry instead of pushing a new one.
+     */
+    replace: (url: string) => void;
+}
+/**
+ * Handle returned from a shell UI mount for lifecycle management.
+ *
+ * @alpha
+ */
+export interface IShellUiMountHandle {
+    /**
+     * Unmounts the shell UI and releases all resources.
+     */
+    unmount(): void;
+    /**
+     * Pushes an updated platform context into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the context changes after initial mount.
+     */
+    updateContext?(ctx: IPlatformContext): void;
+    /**
+     * Pushes an updated list of resolved applications into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the application list changes after initial mount.
+     */
+    updateApplications?(apps: PluggableApplicationRegistryItem[]): void;
+    /**
+     * Pushes the current pathname into the shell UI.
+     *
+     * @remarks
+     * Called by the host whenever the URL changes (e.g. after navigation or popstate).
+     * The shell UI uses this to update the active state of navigation items.
+     */
+    updatePathname?(pathname: string): void;
+    /**
+     * Returns the DOM element where the active pluggable application should be rendered.
+     *
+     * @remarks
+     * The host uses this element as the mount container for the currently active
+     * pluggable application. The shell UI is responsible for creating and managing
+     * this element as part of its layout.
+     */
+    getAppContainer(): HTMLElement;
+}
+/**
+ * Shell UI mount function signature.
+ *
+ * @remarks
+ * A shell UI module must export a `mount` function conforming to this signature.
+ * The function receives a container element and context data, renders the application
+ * shell (header, navigation, layout), and returns a handle for lifecycle management.
+ *
+ * The implementation is framework-agnostic — a module can use React, vanilla DOM,
+ * or any other rendering approach internally.
+ *
+ * @alpha
+ */
+export type ShellUiMount = (options: IShellUiMountOptions) => IShellUiMountHandle;
+/**
+ * Shell UI module contract.
+ *
+ * @remarks
+ * Implementations loaded via module federation or provided locally must conform
+ * to this interface. The shell application uses the `mount` function to render
+ * the application chrome and obtain the container for the active pluggable application.
+ *
+ * @alpha
+ */
+export interface IShellUiModule {
+    mount: ShellUiMount;
+}
+//# sourceMappingURL=shellUi.d.ts.map

package/esm/shellUi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shellUi.d.ts","sourceRoot":"","sources":["../src/shellUi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,gCAAgC,EAAE,CAAC;IAEzD;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,cAAc,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;;OAOG;IACH,eAAe,IAAI,WAAW,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,mBAAmB,CAAC;AAElF;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,YAAY,CAAC;CACvB"}

package/esm/shellUi.js

@@ -0,0 +1,3 @@
+// (C) 2026 GoodData Corporation
+export {};
+//# sourceMappingURL=shellUi.js.map

package/esm/shellUi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shellUi.js","sourceRoot":"","sources":["../src/shellUi.ts"],"names":[],"mappings":"AAAA,gCAAgC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-pluggable-application-model",
-  "version": "11.27.0-alpha.1",
+  "version": "11.27.0-alpha.2",
   "description": "GoodData SDK model contracts for pluggable applications",
   "license": "MIT",
   "author": "GoodData Corporation",
@@ -23,8 +23,8 @@
   "dependencies": {
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
-    "@gooddata/sdk-model": "11.27.0-alpha.1",
-    "@gooddata/sdk-backend-spi": "11.27.0-alpha.1"
+    "@gooddata/sdk-backend-spi": "11.27.0-alpha.2",
+    "@gooddata/sdk-model": "11.27.0-alpha.2"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -48,8 +48,8 @@
     "oxlint-tsgolint": "0.11.4",
     "typescript": "5.9.3",
     "vitest": "4.1.0",
-    "@gooddata/oxlint-config": "11.27.0-alpha.1",
-    "@gooddata/eslint-config": "11.27.0-alpha.1"
+    "@gooddata/eslint-config": "11.27.0-alpha.2",
+    "@gooddata/oxlint-config": "11.27.0-alpha.2"
   },
   "scripts": {
     "_phase:build": "npm run build",