@gooddata/sdk-pluggable-application-model 11.29.0-alpha.6 → 11.29.0-alpha.8

package/esm/index.d.ts

@@ -5,6 +5,6 @@
  */
 export { type EmbeddingMode, type IApiTokenAuthCredentials, type IAuthCredentials, type IContextDeferredAuthCredentials, type IJwtAuthCredentials, 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 IPluggableAppTelemetryCallbacks, type ITelemetryEventOptions, type PluggableApplicationMount, type TelemetryChannel, } from "./mount.js";
+export { type IAppInstance, type KnownPluggableAppEventTypeName, type IPluggableApp, type IPluggableApplicationMountHandle, type IPluggableApplicationMountOptions, type IPluggableAppEvent, type IPluggableAppTelemetryCallbacks, type IReloadPlatformContextRequestedEvent, type ITelemetryEventOptions, isReloadPlatformContextRequestedEvent, type PluggableApplicationMount, PluggableAppEventType, type PluggableAppEventTypeName, reloadPlatformContextRequested, type TelemetryChannel, } 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,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,mBAAmB,EACxB,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,+BAA+B,EACpC,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,YAAY,GACpB,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,mBAAmB,EACxB,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,8BAA8B,EACnC,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,KAAK,oCAAoC,EACzC,KAAK,sBAAsB,EAC3B,qCAAqC,EACrC,KAAK,yBAAyB,EAC9B,qBAAqB,EACrB,KAAK,yBAAyB,EAC9B,8BAA8B,EAC9B,KAAK,gBAAgB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,YAAY,GACpB,MAAM,cAAc,CAAC"}

package/esm/index.js

@@ -6,4 +6,5 @@
  * @packageDocumentation
  */
 export { PantherTier, isPlatformContextV1, } from "./platformContext.js";
+export { isReloadPlatformContextRequestedEvent, PluggableAppEventType, reloadPlatformContextRequested, } from "./mount.js";
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,EAWH,WAAW,EACX,mBAAmB,GACtB,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,EAWH,WAAW,EACX,mBAAmB,GACtB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAUH,qCAAqC,EAErC,qBAAqB,EAErB,8BAA8B,GAEjC,MAAM,YAAY,CAAC"}

package/esm/mount.d.ts

@@ -1,4 +1,29 @@
 import { type IPlatformContext } from "./platformContext.js";
+/**
+ * Known generic pluggable application event types.
+ *
+ * @alpha
+ */
+export declare const PluggableAppEventType: {
+    readonly RELOAD_PLATFORM_CONTEXT_REQUESTED: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED";
+};
+/**
+ * Union of known pluggable application event type names.
+ *
+ * @alpha
+ */
+export type KnownPluggableAppEventTypeName = (typeof PluggableAppEventType)[keyof typeof PluggableAppEventType];
+/**
+ * Event type name accepted by pluggable application to host events.
+ *
+ * @remarks
+ * This type is intentionally open for extension (`string & {}`) to preserve forward compatibility:
+ * newly introduced app-specific or future platform event types should not break existing consumers at compile time.
+ * For built-in platform events, prefer values from {@link PluggableAppEventType}.
+ *
+ * @alpha
+ */
+export type PluggableAppEventTypeName = KnownPluggableAppEventTypeName | (string & {});
 /**
  * Event emitted by the pluggable application towards the host.
  *
@@ -10,9 +35,29 @@ import { type IPlatformContext } from "./platformContext.js";
  * @alpha
  */
 export interface IPluggableAppEvent {
-    type: string;
-    payload?: unknown;
+    readonly type: PluggableAppEventTypeName;
+    readonly payload?: unknown;
 }
+/**
+ * Event requesting the host to reload the platform context.
+ *
+ * @alpha
+ */
+export interface IReloadPlatformContextRequestedEvent extends IPluggableAppEvent {
+    readonly type: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED";
+}
+/**
+ * Creates an {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export declare function reloadPlatformContextRequested(): IReloadPlatformContextRequestedEvent;
+/**
+ * Type guard for {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export declare function isReloadPlatformContextRequestedEvent(obj: unknown): obj is IReloadPlatformContextRequestedEvent;
 /**
  * Telemetry channel determines which analytics pipeline receives the event.
  *

package/esm/mount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAkB;IAE/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,IAAI,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,+BAA+B;IAC5C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC1G,0DAA0D;IAC1D,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,iEAAiE;IACjE,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3E;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,+BAA+B,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACpC,OAAO,EAAE,iCAAiC,KACzC,gCAAgC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,gCAAgC;IAClE,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,yBAAyB,CAAC;CACpC"}
+{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GACtC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAEvE;;;;;;;;;GASG;AACH,MAAM,MAAM,yBAAyB,GAAG,8BAA8B,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEvF;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAC;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAqC,SAAQ,kBAAkB;IAC5E,QAAQ,CAAC,IAAI,EAAE,yDAAyD,CAAC;CAC5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,IAAI,oCAAoC,CAErF;AAED;;;;GAIG;AACH,wBAAgB,qCAAqC,CACjD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,oCAAoC,CAO7C;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,IAAI,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,+BAA+B;IAC5C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC1G,0DAA0D;IAC1D,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,iEAAiE;IACjE,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3E;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,+BAA+B,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACpC,OAAO,EAAE,iCAAiC,KACzC,gCAAgC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,gCAAgC;IAClE,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,yBAAyB,CAAC;CACpC"}

package/esm/mount.js

@@ -1,3 +1,29 @@
 // (C) 2026 GoodData Corporation
-export {};
+/**
+ * Known generic pluggable application event types.
+ *
+ * @alpha
+ */
+export const PluggableAppEventType = {
+    RELOAD_PLATFORM_CONTEXT_REQUESTED: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED",
+};
+/**
+ * Creates an {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export function reloadPlatformContextRequested() {
+    return { type: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED" };
+}
+/**
+ * Type guard for {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export function isReloadPlatformContextRequestedEvent(obj) {
+    return (typeof obj === "object" &&
+        obj !== null &&
+        "type" in obj &&
+        obj.type === "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED");
+}
 //# sourceMappingURL=mount.js.map

package/esm/mount.js.map

@@ -1 +1 @@
-{"version":3,"file":"mount.js","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAAA,gCAAgC"}
+{"version":3,"file":"mount.js","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAIhC;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACjC,iCAAiC,EAAE,yDAAyD;CACtF,CAAC;AA8CX;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,GAAyC;IACnF,OAAO,EAAE,IAAI,EAAE,yDAAyD,EAAE,CAAC;AAAA,CAC9E;AAED;;;;GAIG;AACH,MAAM,UAAU,qCAAqC,CACjD,GAAY,EAC+B;IAC3C,OAAO,CACH,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,MAAM,IAAI,GAAG;QACZ,GAA0B,CAAC,IAAI,KAAK,yDAAyD,CACjG,CAAC;AAAA,CACL"}

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

@@ -170,8 +170,8 @@ export declare interface IPluggableApp {
  * @alpha
  */
 export declare interface IPluggableAppEvent {
-    type: string;
-    payload?: unknown;
+    readonly type: PluggableAppEventTypeName;
+    readonly payload?: unknown;
 }
 
 /**
@@ -274,6 +274,15 @@ export declare interface IPluggableAppTelemetryCallbacks {
     trackTiming: (variable: string, label: string, valueMs: number) => void;
 }
 
+/**
+ * Event requesting the host to reload the platform context.
+ *
+ * @alpha
+ */
+export declare interface IReloadPlatformContextRequestedEvent extends IPluggableAppEvent {
+    readonly type: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED";
+}
+
 /**
  * Shell UI module contract.
  *
@@ -383,6 +392,13 @@ export declare interface IShellUiMountOptions {
  */
 export declare function isPlatformContextV1(context: unknown): context is IPlatformContextV1;
 
+/**
+ * Type guard for {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export declare function isReloadPlatformContextRequestedEvent(obj: unknown): obj is IReloadPlatformContextRequestedEvent;
+
 /**
  * Optional configuration for a telemetry event.
  *
@@ -397,6 +413,13 @@ export declare interface ITelemetryEventOptions {
     channel?: TelemetryChannel;
 }
 
+/**
+ * Union of known pluggable application event type names.
+ *
+ * @alpha
+ */
+export declare type KnownPluggableAppEventTypeName = (typeof PluggableAppEventType)[keyof typeof PluggableAppEventType];
+
 /**
  * Panther tier.
  *
@@ -410,6 +433,27 @@ export declare enum PantherTier {
     DEMO = "DEMO"
 }
 
+/**
+ * Known generic pluggable application event types.
+ *
+ * @alpha
+ */
+export declare const PluggableAppEventType: {
+    readonly RELOAD_PLATFORM_CONTEXT_REQUESTED: "GDC.PLUGGABLE_APP/EVT.RELOAD_PLATFORM_CONTEXT.REQUESTED";
+};
+
+/**
+ * Event type name accepted by pluggable application to host events.
+ *
+ * @remarks
+ * This type is intentionally open for extension (`string & {}`) to preserve forward compatibility:
+ * newly introduced app-specific or future platform event types should not break existing consumers at compile time.
+ * For built-in platform events, prefer values from {@link PluggableAppEventType}.
+ *
+ * @alpha
+ */
+export declare type PluggableAppEventTypeName = KnownPluggableAppEventTypeName | (string & {});
+
 /**
  * Pluggable application mount function signature.
  *
@@ -417,6 +461,13 @@ export declare enum PantherTier {
  */
 export declare type PluggableApplicationMount = (options: IPluggableApplicationMountOptions) => IPluggableApplicationMountHandle;
 
+/**
+ * Creates an {@link IReloadPlatformContextRequestedEvent}.
+ *
+ * @alpha
+ */
+export declare function reloadPlatformContextRequested(): IReloadPlatformContextRequestedEvent;
+
 /**
  * Shell UI mount function signature.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-pluggable-application-model",
-  "version": "11.29.0-alpha.6",
+  "version": "11.29.0-alpha.8",
   "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-backend-spi": "11.29.0-alpha.6",
-    "@gooddata/sdk-model": "11.29.0-alpha.6"
+    "@gooddata/sdk-backend-spi": "11.29.0-alpha.8",
+    "@gooddata/sdk-model": "11.29.0-alpha.8"
   },
   "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/eslint-config": "11.29.0-alpha.6",
-    "@gooddata/oxlint-config": "11.29.0-alpha.6"
+    "@gooddata/oxlint-config": "11.29.0-alpha.8",
+    "@gooddata/eslint-config": "11.29.0-alpha.8"
   },
   "scripts": {
     "_phase:build": "npm run build",