@gooddata/sdk-pluggable-application-model 11.28.0-alpha.0 → 11.28.0-alpha.2

package/esm/index.d.ts

@@ -5,6 +5,6 @@
  */
 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 IAppInstance, type IPluggableApp, type IPluggableApplicationMountHandle, type IPluggableApplicationMountOptions, type IPluggableAppEvent, type IPluggableAppTelemetryCallbacks, type ITelemetryEventOptions, type PluggableApplicationMount, 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,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"}
+{"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,+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"}

package/esm/mount.d.ts

@@ -13,6 +13,53 @@ export interface IPluggableAppEvent {
     type: string;
     payload?: unknown;
 }
+/**
+ * Telemetry channel determines which analytics pipeline receives the event.
+ *
+ * @remarks
+ * - `"standard"` — default channel for general UI events.
+ * - `"ai"` — channel for AI-related events that require separate compliance handling.
+ *
+ * @alpha
+ */
+export type TelemetryChannel = "standard" | "ai";
+/**
+ * Optional configuration for a telemetry event.
+ *
+ * @alpha
+ */
+export interface ITelemetryEventOptions {
+    /**
+     * Which analytics channel to route the event to.
+     *
+     * @defaultValue `"standard"`
+     */
+    channel?: TelemetryChannel;
+}
+/**
+ * Telemetry callbacks provided by the shell to pluggable applications.
+ *
+ * @remarks
+ * Pluggable applications can use these methods to log events through the shell's
+ * centralized telemetry system. All events are automatically tagged with the
+ * source application ID.
+ *
+ * @alpha
+ */
+export interface IPluggableAppTelemetryCallbacks {
+    /**
+     * Track a custom telemetry event from the pluggable application.
+     *
+     * @param eventName - Name of the event.
+     * @param data - Optional key-value payload.
+     * @param options - Optional event configuration (e.g. channel routing).
+     */
+    trackEvent: (eventName: string, data?: Record<string, unknown>, options?: ITelemetryEventOptions) => void;
+    /** Track a page view within the pluggable application. */
+    trackPageView: (page: string) => void;
+    /** Track a timing measurement from the pluggable application. */
+    trackTiming: (variable: string, label: string, valueMs: number) => void;
+}
 /**
  * Options passed by the host into a pluggable application's mount function.
  *
@@ -47,6 +94,16 @@ export interface IPluggableApplicationMountOptions {
      * instance.
      */
     onEvent?: (e: IPluggableAppEvent) => void;
+    /**
+     * Telemetry callbacks for the pluggable application to track events through the shell's
+     * centralized telemetry system.
+     *
+     * @remarks
+     * This is the preferred way for pluggable applications to emit telemetry. Events are
+     * automatically tagged with the source application ID and forwarded to all configured
+     * telemetry providers registered in the shell application.
+     */
+    onTelemetryEvent?: IPluggableAppTelemetryCallbacks;
 }
 /**
  * Handle returned from mount for lifecycle management and host -\> module interaction.

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;;;;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;CAC7C;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;;;;;;;;;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"}

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

@@ -169,6 +169,16 @@ export declare interface IPluggableApplicationMountOptions {
      * instance.
      */
     onEvent?: (e: IPluggableAppEvent) => void;
+    /**
+     * Telemetry callbacks for the pluggable application to track events through the shell's
+     * centralized telemetry system.
+     *
+     * @remarks
+     * This is the preferred way for pluggable applications to emit telemetry. Events are
+     * automatically tagged with the source application ID and forwarded to all configured
+     * telemetry providers registered in the shell application.
+     */
+    onTelemetryEvent?: IPluggableAppTelemetryCallbacks;
 }
 
 /**
@@ -181,6 +191,31 @@ export declare interface IPluggableApplicationNavigation {
     openApp(id: string, path?: string): void;
 }
 
+/**
+ * Telemetry callbacks provided by the shell to pluggable applications.
+ *
+ * @remarks
+ * Pluggable applications can use these methods to log events through the shell's
+ * centralized telemetry system. All events are automatically tagged with the
+ * source application ID.
+ *
+ * @alpha
+ */
+export declare interface IPluggableAppTelemetryCallbacks {
+    /**
+     * Track a custom telemetry event from the pluggable application.
+     *
+     * @param eventName - Name of the event.
+     * @param data - Optional key-value payload.
+     * @param options - Optional event configuration (e.g. channel routing).
+     */
+    trackEvent: (eventName: string, data?: Record<string, unknown>, options?: ITelemetryEventOptions) => void;
+    /** Track a page view within the pluggable application. */
+    trackPageView: (page: string) => void;
+    /** Track a timing measurement from the pluggable application. */
+    trackTiming: (variable: string, label: string, valueMs: number) => void;
+}
+
 /**
  * Shell UI module contract.
  *
@@ -290,6 +325,20 @@ export declare interface IShellUiMountOptions {
  */
 export declare function isPlatformContextV1(context: unknown): context is IPlatformContextV1;
 
+/**
+ * Optional configuration for a telemetry event.
+ *
+ * @alpha
+ */
+export declare interface ITelemetryEventOptions {
+    /**
+     * Which analytics channel to route the event to.
+     *
+     * @defaultValue `"standard"`
+     */
+    channel?: TelemetryChannel;
+}
+
 /**
  * Panther tier.
  *
@@ -325,4 +374,15 @@ export declare type PluggableApplicationMount = (options: IPluggableApplicationM
  */
 export declare type ShellUiMount = (options: IShellUiMountOptions) => IShellUiMountHandle;
 
+/**
+ * Telemetry channel determines which analytics pipeline receives the event.
+ *
+ * @remarks
+ * - `"standard"` — default channel for general UI events.
+ * - `"ai"` — channel for AI-related events that require separate compliance handling.
+ *
+ * @alpha
+ */
+export declare type TelemetryChannel = "standard" | "ai";
+
 export { }

package/package.json

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