@gooddata/sdk-ui-pluggable-application 11.29.0-alpha.3 → 11.29.0-alpha.5

package/esm/AppProviders.d.ts

@@ -0,0 +1,63 @@
+import { type PropsWithChildren } from "react";
+import { type ILocale } from "@gooddata/sdk-model";
+import { type IPlatformContext } from "@gooddata/sdk-pluggable-application-model";
+import { type ITranslations } from "@gooddata/sdk-ui";
+/**
+ * Props for {@link AppProviders}.
+ *
+ * @alpha
+ */
+export interface IAppProvidersProps {
+    /**
+     * Platform context snapshot provided by the host (from mount options).
+     */
+    ctx: IPlatformContext;
+    /**
+     * Package name reported to the backend for telemetry.
+     */
+    packageName: string;
+    /**
+     * Asynchronous translation message resolver — typically the memoized
+     * `resolveMessages` function exported from the module's `translations.ts`.
+     */
+    resolveMessages: (locale: string) => Promise<ITranslations>;
+    /**
+     * Eagerly-loaded default messages keyed by locale.
+     * Typically `{ "en-US": { ...sdkDefaults, ...appDefaults } }`.
+     */
+    defaultMessages: Record<string, ITranslations>;
+    /**
+     * Default language/locale used when `ctx.preferredLocale` is not set.
+     *
+     * @defaultValue `"en-US"`
+     */
+    defaultLanguage?: ILocale;
+}
+/**
+ * Standard provider stack for pluggable application modules.
+ *
+ * @remarks
+ * Wraps children with, in order:
+ *
+ * 1. **PlatformContextProvider** — exposes `IClientPlatformContext` (ctx + backend)
+ * 2. **BackendProvider** — makes backend available to SDK UI components (`useBackendStrict`)
+ * 3. **WorkspaceProvider** — conditionally mounted when a workspace ID is available
+ * 4. **ThemeProvider** — applies theme CSS variables from `ctx.theme`
+ * 5. **IntlProvider** — localization with async-loaded translation bundles
+ *
+ * @example
+ * ```tsx
+ * <AppProviders
+ *     ctx={ctx}
+ *     packageName="gdc-my-app-module"
+ *     resolveMessages={resolveMessages}
+ *     defaultMessages={DEFAULT_MESSAGES}
+ * >
+ *     <App />
+ * </AppProviders>
+ * ```
+ *
+ * @alpha
+ */
+export declare function AppProviders({ ctx, packageName, resolveMessages: resolveMessagesFn, defaultMessages, defaultLanguage, children }: PropsWithChildren<IAppProvidersProps>): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=AppProviders.d.ts.map

package/esm/AppProviders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppProviders.d.ts","sourceRoot":"","sources":["../src/AppProviders.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAAW,MAAM,OAAO,CAAC;AAIxD,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAEH,KAAK,aAAa,EAIrB,MAAM,kBAAkB,CAAC;AAM1B;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5D;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,YAAY,CAAC,EACzB,GAAG,EACH,WAAW,EACX,eAAe,EAAE,iBAAiB,EAClC,eAAe,EACf,eAAyB,EACzB,QAAQ,EACX,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,2CAuBvC"}

package/esm/AppProviders.js

@@ -0,0 +1,52 @@
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+// (C) 2026 GoodData Corporation
+import { useMemo } from "react";
+import { IntlProvider } from "react-intl";
+import { BackendProvider, WorkspaceProvider, resolveLocale, useResolveMessages, } from "@gooddata/sdk-ui";
+import { ThemeProvider } from "@gooddata/sdk-ui-theme-provider";
+import { createBackendForModule } from "./backend.js";
+import { PlatformContextProvider } from "./context.js";
+/**
+ * Standard provider stack for pluggable application modules.
+ *
+ * @remarks
+ * Wraps children with, in order:
+ *
+ * 1. **PlatformContextProvider** — exposes `IClientPlatformContext` (ctx + backend)
+ * 2. **BackendProvider** — makes backend available to SDK UI components (`useBackendStrict`)
+ * 3. **WorkspaceProvider** — conditionally mounted when a workspace ID is available
+ * 4. **ThemeProvider** — applies theme CSS variables from `ctx.theme`
+ * 5. **IntlProvider** — localization with async-loaded translation bundles
+ *
+ * @example
+ * ```tsx
+ * <AppProviders
+ *     ctx={ctx}
+ *     packageName="gdc-my-app-module"
+ *     resolveMessages={resolveMessages}
+ *     defaultMessages={DEFAULT_MESSAGES}
+ * >
+ *     <App />
+ * </AppProviders>
+ * ```
+ *
+ * @alpha
+ */
+export function AppProviders({ ctx, packageName, resolveMessages: resolveMessagesFn, defaultMessages, defaultLanguage = "en-US", children, }) {
+    const backend = useMemo(() => createBackendForModule(ctx.auth, { packageName }), [ctx.auth, packageName]);
+    const clientCtx = useMemo(() => ({ ...ctx, backend }), [ctx, backend]);
+    const locale = resolveLocale(ctx.preferredLocale ?? defaultLanguage);
+    const messages = useResolveMessages(locale, resolveMessagesFn, defaultMessages);
+    return (_jsx(PlatformContextProvider, { value: clientCtx, children: _jsx(BackendProvider, { backend: backend, children: _jsx(WorkspaceProviderIfAvailable, { workspaceId: ctx.currentWorkspaceId, children: _jsx(ThemeProvider, { theme: ctx.theme, children: messages[locale] ? (_jsx(IntlProvider, { locale: locale, messages: messages[locale], children: children })) : null }) }) }) }));
+}
+/**
+ * Only mounts WorkspaceProvider when a workspace ID is available (organization-scope apps
+ * may not have one). This prevents WorkspaceProvider from receiving an undefined value.
+ */
+function WorkspaceProviderIfAvailable({ workspaceId, children, }) {
+    if (!workspaceId) {
+        return _jsx(_Fragment, { children: children });
+    }
+    return _jsx(WorkspaceProvider, { workspace: workspaceId, children: children });
+}
+//# sourceMappingURL=AppProviders.js.map

package/esm/AppProviders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppProviders.js","sourceRoot":"","sources":["../src/AppProviders.tsx"],"names":[],"mappings":";AAAA,gCAAgC;AAEhC,OAAO,EAA0B,OAAO,EAAE,MAAM,OAAO,CAAC;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI1C,OAAO,EACH,eAAe,EAEf,iBAAiB,EACjB,aAAa,EACb,kBAAkB,GACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAA+B,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAsCpF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,YAAY,CAAC,EACzB,GAAG,EACH,WAAW,EACX,eAAe,EAAE,iBAAiB,EAClC,eAAe,EACf,eAAe,GAAG,OAAO,EACzB,QAAQ,GAC4B,EAAE;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;IAE1G,MAAM,SAAS,GAA2B,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAE/F,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,eAAe,IAAI,eAAe,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAC;IAEhF,OAAO,CACH,KAAC,uBAAuB,IAAC,KAAK,EAAE,SAAS,YACrC,KAAC,eAAe,IAAC,OAAO,EAAE,OAAO,YAC7B,KAAC,4BAA4B,IAAC,WAAW,EAAE,GAAG,CAAC,kBAAkB,YAC7D,KAAC,aAAa,IAAC,KAAK,EAAE,GAAG,CAAC,KAAK,YAC1B,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAChB,KAAC,YAAY,IAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,YACnD,QAAQ,GACE,CAClB,CAAC,CAAC,CAAC,IAAI,GACI,GACW,GACjB,GACI,CAC7B,CAAC;AAAA,CACL;AAED;;;GAGG;AACH,SAAS,4BAA4B,CAAC,EAClC,WAAW,EACX,QAAQ,GAC6C,EAAE;IACvD,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,OAAO,4BAAG,QAAQ,GAAI,CAAC;IAC3B,CAAC;IACD,OAAO,KAAC,iBAAiB,IAAC,SAAS,EAAE,WAAW,YAAG,QAAQ,GAAqB,CAAC;AAAA,CACpF"}

package/esm/context.d.ts

@@ -14,7 +14,7 @@ import { type IPlatformContext } from "@gooddata/sdk-pluggable-application-model
  * backend-specific escape hatches (e.g., tiger-specific functions)
  * automatically.
  *
- * @public
+ * @alpha
  */
 export interface IClientPlatformContext extends IPlatformContext {
     /**
@@ -26,7 +26,7 @@ export interface IClientPlatformContext extends IPlatformContext {
 /**
  * Props for {@link PlatformContextProvider}.
  *
- * @public
+ * @alpha
  */
 export interface IPlatformContextProviderProps extends PropsWithChildren {
     /**
@@ -37,19 +37,19 @@ export interface IPlatformContextProviderProps extends PropsWithChildren {
 /**
  * React provider that binds platform context into React context.
  *
- * @public
+ * @alpha
  */
 export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): import("react/jsx-runtime").JSX.Element;
 /**
  * Returns client platform context snapshot (or undefined if not available yet).
  *
- * @public
+ * @alpha
  */
 export declare function usePlatformContext(): IClientPlatformContext | undefined;
 /**
  * Returns client platform context snapshot and throws if it's not available.
  *
- * @public
+ * @alpha
  */
 export declare function usePlatformContextStrict(context?: string): IClientPlatformContext;
 //# sourceMappingURL=context.d.ts.map

package/esm/context.js

@@ -7,7 +7,7 @@ PlatformContext.displayName = "PlatformContext";
 /**
  * React provider that binds platform context into React context.
  *
- * @public
+ * @alpha
  */
 export function PlatformContextProvider({ value, children }) {
     return _jsx(PlatformContext.Provider, { value: value, children: children });
@@ -15,7 +15,7 @@ export function PlatformContextProvider({ value, children }) {
 /**
  * Returns client platform context snapshot (or undefined if not available yet).
  *
- * @public
+ * @alpha
  */
 export function usePlatformContext() {
     return useContext(PlatformContext);
@@ -23,7 +23,7 @@ export function usePlatformContext() {
 /**
  * Returns client platform context snapshot and throws if it's not available.
  *
- * @public
+ * @alpha
  */
 export function usePlatformContextStrict(context = "usePlatformContextStrict") {
     const value = usePlatformContext();

package/esm/index.d.ts

@@ -5,4 +5,5 @@
  */
 export { type IClientPlatformContext, PlatformContextProvider, type IPlatformContextProviderProps, usePlatformContext, usePlatformContextStrict, } from "./context.js";
 export { createBackendForModule, type ICreateBackendForModuleOptions } from "./backend.js";
+export { AppProviders, type IAppProvidersProps } from "./AppProviders.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,sBAAsB,EAC3B,uBAAuB,EACvB,KAAK,6BAA6B,EAClC,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAE,KAAK,8BAA8B,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EACH,KAAK,sBAAsB,EAC3B,uBAAuB,EACvB,KAAK,6BAA6B,EAClC,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAE,KAAK,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAE3F,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}

package/esm/index.js

@@ -7,4 +7,5 @@
  */
 export { PlatformContextProvider, usePlatformContext, usePlatformContextStrict, } from "./context.js";
 export { createBackendForModule } from "./backend.js";
+export { AppProviders } from "./AppProviders.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,EAEH,uBAAuB,EAEvB,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAuC,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,EAEH,uBAAuB,EAEvB,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,sBAAsB,EAAuC,MAAM,cAAc,CAAC;AAE3F,OAAO,EAAE,YAAY,EAA2B,MAAM,mBAAmB,CAAC"}

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

@@ -6,10 +6,40 @@
 
 import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
 import { IAuthCredentials } from '@gooddata/sdk-pluggable-application-model';
+import { ILocale } from '@gooddata/sdk-model';
 import { IPlatformContext } from '@gooddata/sdk-pluggable-application-model';
+import { ITranslations } from '@gooddata/sdk-ui';
 import { JSX } from 'react/jsx-runtime';
 import { PropsWithChildren } from 'react';
 
+/**
+ * Standard provider stack for pluggable application modules.
+ *
+ * @remarks
+ * Wraps children with, in order:
+ *
+ * 1. **PlatformContextProvider** — exposes `IClientPlatformContext` (ctx + backend)
+ * 2. **BackendProvider** — makes backend available to SDK UI components (`useBackendStrict`)
+ * 3. **WorkspaceProvider** — conditionally mounted when a workspace ID is available
+ * 4. **ThemeProvider** — applies theme CSS variables from `ctx.theme`
+ * 5. **IntlProvider** — localization with async-loaded translation bundles
+ *
+ * @example
+ * ```tsx
+ * <AppProviders
+ *     ctx={ctx}
+ *     packageName="gdc-my-app-module"
+ *     resolveMessages={resolveMessages}
+ *     defaultMessages={DEFAULT_MESSAGES}
+ * >
+ *     <App />
+ * </AppProviders>
+ * ```
+ *
+ * @alpha
+ */
+export declare function AppProviders({ ctx, packageName, resolveMessages: resolveMessagesFn, defaultMessages, defaultLanguage, children }: PropsWithChildren<IAppProvidersProps>): JSX.Element;
+
 /**
  * Creates an analytical backend instance from the platform context auth credentials.
  *
@@ -36,6 +66,38 @@ import { PropsWithChildren } from 'react';
  */
 export declare function createBackendForModule(auth: IAuthCredentials, options: ICreateBackendForModuleOptions): IAnalyticalBackend;
 
+/**
+ * Props for {@link AppProviders}.
+ *
+ * @alpha
+ */
+export declare interface IAppProvidersProps {
+    /**
+     * Platform context snapshot provided by the host (from mount options).
+     */
+    ctx: IPlatformContext;
+    /**
+     * Package name reported to the backend for telemetry.
+     */
+    packageName: string;
+    /**
+     * Asynchronous translation message resolver — typically the memoized
+     * `resolveMessages` function exported from the module's `translations.ts`.
+     */
+    resolveMessages: (locale: string) => Promise<ITranslations>;
+    /**
+     * Eagerly-loaded default messages keyed by locale.
+     * Typically `{ "en-US": { ...sdkDefaults, ...appDefaults } }`.
+     */
+    defaultMessages: Record<string, ITranslations>;
+    /**
+     * Default language/locale used when `ctx.preferredLocale` is not set.
+     *
+     * @defaultValue `"en-US"`
+     */
+    defaultLanguage?: ILocale;
+}
+
 /**
  * Platform context extended with a client-created backend instance.
  *
@@ -49,7 +111,7 @@ export declare function createBackendForModule(auth: IAuthCredentials, options:
  * backend-specific escape hatches (e.g., tiger-specific functions)
  * automatically.
  *
- * @public
+ * @alpha
  */
 export declare interface IClientPlatformContext extends IPlatformContext {
     /**
@@ -78,7 +140,7 @@ export declare interface ICreateBackendForModuleOptions {
 /**
  * Props for {@link PlatformContextProvider}.
  *
- * @public
+ * @alpha
  */
 export declare interface IPlatformContextProviderProps extends PropsWithChildren {
     /**
@@ -90,21 +152,21 @@ export declare interface IPlatformContextProviderProps extends PropsWithChildren
 /**
  * React provider that binds platform context into React context.
  *
- * @public
+ * @alpha
  */
 export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): JSX.Element;
 
 /**
  * Returns client platform context snapshot (or undefined if not available yet).
  *
- * @public
+ * @alpha
  */
 export declare function usePlatformContext(): IClientPlatformContext | undefined;
 
 /**
  * Returns client platform context snapshot and throws if it's not available.
  *
- * @public
+ * @alpha
  */
 export declare function usePlatformContextStrict(context?: string): IClientPlatformContext;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-pluggable-application",
-  "version": "11.29.0-alpha.3",
+  "version": "11.29.0-alpha.5",
   "description": "GoodData SDK React helpers for pluggable applications",
   "license": "MIT",
   "author": "GoodData Corporation",
@@ -21,12 +21,16 @@
   "types": "./esm/index.d.ts",
   "exports": "./esm/index.js",
   "dependencies": {
+    "react-intl": "7.1.11",
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
-    "@gooddata/sdk-backend-base": "11.29.0-alpha.3",
-    "@gooddata/sdk-backend-spi": "11.29.0-alpha.3",
-    "@gooddata/sdk-backend-tiger": "11.29.0-alpha.3",
-    "@gooddata/sdk-pluggable-application-model": "11.29.0-alpha.3"
+    "@gooddata/sdk-backend-base": "11.29.0-alpha.5",
+    "@gooddata/sdk-backend-tiger": "11.29.0-alpha.5",
+    "@gooddata/sdk-model": "11.29.0-alpha.5",
+    "@gooddata/sdk-backend-spi": "11.29.0-alpha.5",
+    "@gooddata/sdk-pluggable-application-model": "11.29.0-alpha.5",
+    "@gooddata/sdk-ui": "11.29.0-alpha.5",
+    "@gooddata/sdk-ui-theme-provider": "11.29.0-alpha.5"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -58,8 +62,8 @@
     "react-dom": "19.1.1",
     "typescript": "5.9.3",
     "vitest": "4.1.0",
-    "@gooddata/eslint-config": "11.29.0-alpha.3",
-    "@gooddata/oxlint-config": "11.29.0-alpha.3"
+    "@gooddata/eslint-config": "11.29.0-alpha.5",
+    "@gooddata/oxlint-config": "11.29.0-alpha.5"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",