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

package/esm/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @packageDocumentation
  */
-export { type EmbeddingMode, type IOrganization, type IOrganizationPermissions, type IPlatformContext, type IPlatformContextV1, type IPluggableApplicationNavigation, PantherTier, isPlatformContextV1, } from "./platformContext.js";
+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 IShellUiModule, type IShellUiMountHandle, type IShellUiMountOptions, type ShellUiMount, } from "./shellUi.js";

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,+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,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/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,EAOH,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"}

package/esm/platformContext.d.ts

@@ -1,4 +1,4 @@
-import { type IAnalyticalBackend, type IUserSettings } from "@gooddata/sdk-backend-spi";
+import { type IUserSettings } from "@gooddata/sdk-backend-spi";
 import { type ApplicationScope, type IEntitlementDescriptor, type ILocale, type ITheme, type IUser, type IWhiteLabeling, type IWorkspacePermissions, type ObjRef } from "@gooddata/sdk-model";
 /**
  * Pluggable application embedding mode.
@@ -53,14 +53,69 @@ export interface IPluggableApplicationNavigation {
     go(to: string): void;
     openApp(id: string, path?: string): void;
 }
+/**
+ * Cookie / session-based authentication — no explicit credentials required.
+ *
+ * @alpha
+ */
+export interface IContextDeferredAuthCredentials {
+    type: "contextDeferred";
+    /**
+     * Optional external identity-provider identifier for SSO flows.
+     * When building a backend with `ContextDeferredAuthProvider`, pass
+     * this value to `createNotAuthenticatedHandler` (or equivalent) so
+     * the redirect targets the correct IdP login page.
+     */
+    externalProviderId?: string;
+}
+/**
+ * GoodData API-token authentication.
+ *
+ * @alpha
+ */
+export interface IApiTokenAuthCredentials {
+    type: "apiToken";
+    token: string;
+}
+/**
+ * JWT-based authentication.
+ *
+ * @alpha
+ */
+export interface IJwtAuthCredentials {
+    type: "jwt";
+    token: string;
+    secondsBeforeTokenExpirationToCallReminder?: number;
+}
+/**
+ * Authentication credentials for building a backend instance.
+ *
+ * @remarks
+ * The shell application determines authentication method and passes the
+ * resolved credentials in the platform context. Client applications use
+ * them to construct their own backend instance.
+ *
+ * @alpha
+ */
+export type IAuthCredentials = IContextDeferredAuthCredentials | IApiTokenAuthCredentials | IJwtAuthCredentials;
 /**
  * Platform context contract version 1.0.
  *
+ * @remarks
+ * The shell application populates this context after bootstrapping and
+ * passes it to pluggable (client) applications. It intentionally does NOT
+ * include a backend instance — client applications create their own using
+ * the provided {@link IAuthCredentials} to avoid SDK version desync.
+ *
  * @alpha
  */
 export interface IPlatformContextV1 {
     version: "1.0";
-    backend: IAnalyticalBackend;
+    /**
+     * Authentication credentials resolved by the shell.
+     * Client applications use these to build their own backend instance.
+     */
+    auth: IAuthCredentials;
     user: IUser;
     organization?: IOrganization;
     organizationPermissions?: IOrganizationPermissions;

package/esm/platformContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"platformContext.d.ts","sourceRoot":"","sources":["../src/platformContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACxF,OAAO,EACH,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,MAAM,EACd,MAAM,qBAAqB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzD;;;;GAIG;AACH,oBAAY,WAAW;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACrC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC5C,EAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,KAAK,CAAC;IAEf,OAAO,EAAE,kBAAkB,CAAC;IAC5B,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,uBAAuB,CAAC,EAAE,wBAAwB,CAAC;IACnD,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAExC,YAAY,EAAE,aAAa,CAAC;IAE5B,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,gBAAgB,CAAC;IAE3C,aAAa,EAAE,aAAa,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,kBAAkB,CAOnF"}
+{"version":3,"file":"platformContext.d.ts","sourceRoot":"","sources":["../src/platformContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACH,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,MAAM,EACd,MAAM,qBAAqB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzD;;;;GAIG;AACH,oBAAY,WAAW;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACrC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC5C,EAAE,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAMD;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC5C,IAAI,EAAE,iBAAiB,CAAC;IACxB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C,CAAC,EAAE,MAAM,CAAC;CACvD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GACtB,+BAA+B,GAC/B,wBAAwB,GACxB,mBAAmB,CAAC;AAM1B;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,KAAK,CAAC;IAEf;;;OAGG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,uBAAuB,CAAC,EAAE,wBAAwB,CAAC;IACnD,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAExC,YAAY,EAAE,aAAa,CAAC;IAE5B,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,gBAAgB,CAAC;IAE3C,aAAa,EAAE,aAAa,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,kBAAkB,CAOnF"}

package/esm/platformContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"platformContext.js","sourceRoot":"","sources":["../src/platformContext.ts"],"names":[],"mappings":"AAAA,gCAAgC;SA0BpB,WAAW;AALvB;;;;GAIG;AACH,IAAY,WAMX;AAND,WAAY,WAAW;IACnB,8BAAe,CAAA;IACf,oCAAqB,CAAA;IACrB,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,4BAAa,CAAA;AAAC,CAClB,EANY,WAAW,KAAX,WAAW,QAMtB;AA6ED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAgB,EAAiC;IACjF,OAAO,CACH,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,SAAS,IAAI,OAAO;QACnB,OAAiC,CAAC,OAAO,KAAK,KAAK,CACvD,CAAC;AAAA,CACL"}
+{"version":3,"file":"platformContext.js","sourceRoot":"","sources":["../src/platformContext.ts"],"names":[],"mappings":"AAAA,gCAAgC;SA0BpB,WAAW;AALvB;;;;GAIG;AACH,IAAY,WAMX;AAND,WAAY,WAAW;IACnB,8BAAe,CAAA;IACf,oCAAqB,CAAA;IACrB,0BAAW,CAAA;IACX,4BAAa,CAAA;IACb,4BAAa,CAAA;AAAC,CAClB,EANY,WAAW,KAAX,WAAW,QAMtB;AAoJD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAgB,EAAiC;IACjF,OAAO,CACH,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,SAAS,IAAI,OAAO;QACnB,OAAiC,CAAC,OAAO,KAAK,KAAK,CACvD,CAAC;AAAA,CACL"}

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

@@ -5,7 +5,6 @@
  */
 
 import { ApplicationScope } from '@gooddata/sdk-model';
-import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
 import { IEntitlementDescriptor } from '@gooddata/sdk-model';
 import { ILocale } from '@gooddata/sdk-model';
 import { ITheme } from '@gooddata/sdk-model';
@@ -23,6 +22,16 @@ import { PluggableApplicationRegistryItem } from '@gooddata/sdk-model';
  */
 export declare type EmbeddingMode = "none" | "iframe" | "export";
 
+/**
+ * GoodData API-token authentication.
+ *
+ * @alpha
+ */
+export declare interface IApiTokenAuthCredentials {
+    type: "apiToken";
+    token: string;
+}
+
 /**
  * Mounted application instance.
  *
@@ -32,6 +41,45 @@ export declare interface IAppInstance extends IPluggableApplicationMountHandle {
     id: string;
 }
 
+/**
+ * Authentication credentials for building a backend instance.
+ *
+ * @remarks
+ * The shell application determines authentication method and passes the
+ * resolved credentials in the platform context. Client applications use
+ * them to construct their own backend instance.
+ *
+ * @alpha
+ */
+export declare type IAuthCredentials = IContextDeferredAuthCredentials | IApiTokenAuthCredentials | IJwtAuthCredentials;
+
+/**
+ * Cookie / session-based authentication — no explicit credentials required.
+ *
+ * @alpha
+ */
+export declare interface IContextDeferredAuthCredentials {
+    type: "contextDeferred";
+    /**
+     * Optional external identity-provider identifier for SSO flows.
+     * When building a backend with `ContextDeferredAuthProvider`, pass
+     * this value to `createNotAuthenticatedHandler` (or equivalent) so
+     * the redirect targets the correct IdP login page.
+     */
+    externalProviderId?: string;
+}
+
+/**
+ * JWT-based authentication.
+ *
+ * @alpha
+ */
+export declare interface IJwtAuthCredentials {
+    type: "jwt";
+    token: string;
+    secondsBeforeTokenExpirationToCallReminder?: number;
+}
+
 export { ILocale }
 
 /**
@@ -72,11 +120,21 @@ export declare type IPlatformContext = IPlatformContextV1;
 /**
  * Platform context contract version 1.0.
  *
+ * @remarks
+ * The shell application populates this context after bootstrapping and
+ * passes it to pluggable (client) applications. It intentionally does NOT
+ * include a backend instance — client applications create their own using
+ * the provided {@link IAuthCredentials} to avoid SDK version desync.
+ *
  * @alpha
  */
 export declare interface IPlatformContextV1 {
     version: "1.0";
-    backend: IAnalyticalBackend;
+    /**
+     * Authentication credentials resolved by the shell.
+     * Client applications use these to build their own backend instance.
+     */
+    auth: IAuthCredentials;
     user: IUser;
     organization?: IOrganization;
     organizationPermissions?: IOrganizationPermissions;

package/package.json

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