@gooddata/sdk-ui-analytical-designer 0.0.0-stage → 11.65.0-alpha.7

package/README.md

@@ -1,3 +1,310 @@
-# Temporary Holding Version
+# @gooddata/sdk-ui-analytical-designer
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Analytical Designer** (AD) as a React component, `AnalyticalDesigner`, and the runtime behind the
+AD pluggable module and the in-process AD editor that Dashboards and Publisher open for an insight.
+
+It is published on every gdc-ui release as a private package in the `@gooddata` npm org, with the
+same version as the GoodData.UI SDK (version policy `gdc-ui-private`). The public API is `@alpha`.
+
+## Entry points
+
+| Import                                          | Content                                                                                                                                                | Used by                                                                      |
+| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |
+| `@gooddata/sdk-ui-analytical-designer`          | The public API: `AnalyticalDesigner` and its types, tracked in `api/gdc-analytical-designer.api.md`                                                    | Applications that embed AD                                                   |
+| `@gooddata/sdk-ui-analytical-designer/internal` | App wiring (`Root`, the redux store and sagas, bootstrap and mode actions), the platform-context mappers and `AnalyticalDesigner` with the token props | The AD pluggable module and the Dashboards insight overlay; not a public API |
+| `@gooddata/sdk-ui-analytical-designer/styles/*` | AD's stylesheet, `styles/css/main.css`, its SCSS source and the images it references                                                                   | Every host, see Styles                                                       |
+
+## Quick start
+
+This setup embeds AD in a Vite application.
+
+### Dependencies
+
+The package is private: the npm user needs read access to the `@gooddata` npm org. The package has
+the version of the GoodData.UI SDK it was built with. Install it at the SDK version the host uses,
+with the `@gooddata/sdk-*` packages at the same version (`<sdk-version>` below), and with the
+React peers:
+
+```json
+{
+    "dependencies": {
+        "@gooddata/sdk-ui-analytical-designer": "<sdk-version>",
+        "@gooddata/sdk-backend-base": "<sdk-version>",
+        "@gooddata/sdk-backend-spi": "<sdk-version>",
+        "@gooddata/sdk-backend-tiger": "<sdk-version>",
+        "@gooddata/sdk-ui": "<sdk-version>",
+        "react": "19.1.1",
+        "react-dom": "19.1.1",
+        "react-intl": "10.1.25"
+    }
+}
+```
+
+With the same version, the host and AD share one copy of each SDK package, so they share its React
+contexts and the bundle contains one SDK.
+
+### Vite configuration
+
+```ts
+// vite.config.ts
+import react from "@vitejs/plugin-react";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+    plugins: [react()],
+    define: {
+        // Legacy CommonJS dependencies bundled with AD read these.
+        global: "globalThis",
+        "process.env": "{}",
+    },
+    optimizeDeps: {
+        rolldownOptions: {
+            // The metric editor in AD imports its Monaco worker with `?worker&url`, which the
+            // dependency pre-bundler cannot load. Leave that import external, so Vite's own
+            // pipeline resolves it to the worker URL when it serves the pre-bundled chunk.
+            plugins: [
+                {
+                    name: "external-worker-url",
+                    resolveId: (id: string) => (/\?worker(&url)?$/.test(id) ? { id, external: true } : null),
+                },
+            ],
+        },
+    },
+});
+```
+
+Without the `optimizeDeps` plugin, the dev server stops while it pre-bundles dependencies, with
+`[UNLOADABLE_DEPENDENCY] Could not load …/editorWebWorkerMain.js?worker&url`. See Workers below.
+
+### Backend
+
+AD runs on the host's backend. When the backend caches, give AD the cache resets, so the catalog
+Refresh button and a metric edit load fresh data:
+
+```ts
+// backend.ts
+import { type CacheControl, RecommendedCachingConfiguration, withCaching } from "@gooddata/sdk-backend-base";
+import { ContextDeferredAuthProvider, tigerFactory } from "@gooddata/sdk-backend-tiger";
+
+let cacheControl: CacheControl | undefined;
+
+export const backend = withCaching(tigerFactory().withAuthentication(new ContextDeferredAuthProvider()), {
+    ...RecommendedCachingConfiguration,
+    onCacheReady: (control) => {
+        cacheControl = control;
+    },
+});
+
+export const cacheReset = {
+    resetAll: () => cacheControl?.resetAll(),
+    resetCatalogs: () => cacheControl?.resetCatalogs(),
+};
+```
+
+### Component
+
+```tsx
+// App.tsx
+import {
+    AnalyticalDesigner,
+    type AnalyticalDesignerSlotComponent,
+    type IAnalyticalDesignerErrorProps,
+    type IAnalyticalDesignerLoadingProps,
+    type IAnalyticalDesignerSlots,
+} from "@gooddata/sdk-ui-analytical-designer";
+// The SDK stylesheets AD needs come first (see Styles), then AD's own stylesheet.
+import "@gooddata/sdk-ui-analytical-designer/styles/css/main.css";
+import { BackendProvider, WorkspaceProvider } from "@gooddata/sdk-ui";
+
+import { backend, cacheReset } from "./backend.js";
+
+// A slot gets the default region and the props the default would get: wrap it or replace it.
+const HostLoading: AnalyticalDesignerSlotComponent<IAnalyticalDesignerLoadingProps> = ({
+    Default,
+    defaultProps,
+}) => (
+    <div className="my-loading">
+        <p>Starting Analytical Designer…</p>
+        <Default {...defaultProps} />
+    </div>
+);
+
+const HostError: AnalyticalDesignerSlotComponent<IAnalyticalDesignerErrorProps> = ({ defaultProps }) => (
+    <div className="my-error">
+        {defaultProps.error instanceof Error ? defaultProps.error.message : "AD cannot start."}
+    </div>
+);
+
+// Define the slots once, outside the component, so they keep their identity between renders.
+const slots: IAnalyticalDesignerSlots = { Loading: HostLoading, Error: HostError };
+
+export function App() {
+    return (
+        <BackendProvider backend={backend}>
+            <WorkspaceProvider workspace="workspace-id">
+                {/* AD fills its container: give the container a height. */}
+                <div style={{ height: "100vh" }}>
+                    <AnalyticalDesigner
+                        insight="insight-id"
+                        config={{ locale: "en-US" }}
+                        cacheReset={cacheReset}
+                        slots={slots}
+                        onInsightOpened={({ insight }) => console.log("opened", insight)}
+                        onInsightSaved={({ insight }) => console.log("saved", insight)}
+                        onError={(error) => console.error("AD error", error)}
+                    />
+                </div>
+            </WorkspaceProvider>
+        </BackendProvider>
+    );
+}
+```
+
+Leave out `insight` to open a new insight. The AnalyticalDesigner component section below lists all props.
+
+## Requirements for a consumer
+
+- **React**: `react`, `react-dom` and `react-intl` are peer dependencies.
+- **SDK versions**: the `@gooddata/sdk-*` dependencies are pinned to the SDK version the package was
+  built with. AD mounts its own backend, workspace and theme providers, so it runs next to a host on
+  another SDK version. Align the versions when host components and AD components have to share a
+  React context from the SDK, and to avoid bundling two SDK copies.
+- **Build-time defines**: `global` and `process.env` must be defined, because legacy CommonJS
+  dependencies bundled with AD read them (`globalThis` and `{}`). No other define is needed. The
+  build flags `DEBUG`, `TESTING`, `READONLY_MODE` and `TIGER_API_TOKEN` are optional: the code reads
+  them behind `typeof` guards and falls back to production defaults, so define them only to change
+  that behavior. `modules/gdc-analytical-designer/module/vite.config.ts` is the reference setup.
+- **Workers**: the metric editor (`@gooddata/sdk-ui-metric-component`) starts Monaco's editor worker
+  from an import with the Vite-only `?worker&url` suffix, which ships unchanged in the package:
+    - A Vite build handles it.
+    - The Vite dev server pre-bundles the package from `node_modules` and cannot load the
+      import. Add the `optimizeDeps` plugin from the Quick start. Hosts inside gdc-ui do not need
+      it: Vite does not pre-bundle the linked workspace packages.
+    - webpack does not understand the suffix. `apps/gdc-dashboards/webpack.monacoWorker.loader.cjs`
+      replaces the import with a webpack worker.
+
+- **Import side effects**: importing an entry creates no router and no browser history. `Root`
+  creates its router when it mounts: a `BrowserRouter` under the host's base path in the pluggable
+  module, and none in hosted-component mode. AD's own modules load in Node without a
+  DOM, but two dependencies use browser APIs when they load: `@gooddata/sdk-ui-metric-component`
+  (through `monaco-editor`) and `jquery.browser`. `rushx validate-esm` imports both entries in
+  Node, loads CSS and image imports as a bundler does, and replaces those two dependencies with
+  stubs.
+
+- **Styles**: importing the package loads no stylesheet, and no module of the package imports one.
+  Import the SDK stylesheets AD needs and then AD's `main.css` once, where AD loads, in this order so
+  AD's rules win over the SDK rules:
+
+    ```ts
+    import "@gooddata/sdk-ui-kit/styles/css/main.css";
+    import "@gooddata/sdk-ui-pivot/styles/css/main.css";
+    import "@gooddata/sdk-ui-geo/styles/css/main.css";
+    import "@gooddata/sdk-ui-charts/styles/css/main.css";
+    import "@gooddata/sdk-ui-filters/styles/css/measureValueFilter.css";
+    import "@gooddata/sdk-ui-filters/styles/css/dateFilter.css";
+    import "@gooddata/sdk-ui-filters/styles/css/rankingFilter.css";
+    import "@gooddata/sdk-ui-filters/styles/css/attributeFilterNext.css";
+    import "@gooddata/sdk-ui-ext/styles/css/main.css";
+    import "@gooddata/sdk-ui-semantic-search/styles/css/internal.css";
+    import "@gooddata/sdk-ui-analytical-designer/styles/css/main.css";
+    ```
+
+    Each stylesheet is a separate import, so a bundler loads it once when the host imports it too,
+    and it comes from the SDK version the host installs. A host that already loads the SDK
+    stylesheets imports only `main.css`.
+
+    `main.css` has AD's rules, the sdk-ui-ext config-panel and dropdown-icon partials that no public
+    SDK stylesheet ships, and sdk-ui-kit's editable-label styles from the buckets partial. It sets no
+    page-level rules: headings, paragraphs and native form controls are styled only inside AD's root
+    element and its error screen, with `:where(.app-root, .main-error)`, so they keep the specificity of
+    an element selector. The page reset (`normalize.css`), the `html` and `body` baselines, links, and
+    dialogs AD portals to `document.body` take the host's typography.
+
+    The stylesheet is compiled from `styles/scss/main.scss` by the build, like every SDK package; the
+    images it references live in `styles/images` and ship with the package. The pluggable-app dev
+    servers in gdc-ui serve `styles/css/main.css` from that SCSS source
+    (`common/dev-server/gooddataSdkSourcePlugin.js`), so style changes reload without a rebuild.
+    Other hosts, such as the webpack Dashboards app, use the compiled file and need a lib rebuild.
+
+- **One instance per page**: the redux store is a module-level singleton, so mounting a second
+  `AnalyticalDesigner` while one is mounted throws an error.
+- **Telemetry**: AD sends its tracking events to the host's telemetry callbacks, and tracks nothing
+  when the host passes none. It ships no telemetry backend of its own. Its `appBootstrap` span goes
+  through `@opentelemetry/api`, so it reaches a tracer provider the host registers globally.
+
+## The AnalyticalDesigner component
+
+```tsx
+import { AnalyticalDesigner } from "@gooddata/sdk-ui-analytical-designer";
+import "@gooddata/sdk-ui-analytical-designer/styles/css/main.css";
+
+<BackendProvider backend={backend}>
+    <WorkspaceProvider workspace="workspace-id">
+        <AnalyticalDesigner
+            insight="insight-id"
+            config={{ locale: "en-US", hiddenActions: ["open"], isReadOnly: false }}
+            cacheReset={cacheReset}
+            onInsightSaved={({ insight }) => console.log("saved", insight)}
+            onMetricsChanged={() => console.log("metrics changed")}
+        />
+    </WorkspaceProvider>
+</BackendProvider>;
+```
+
+- **Backend and workspace**: the `backend` and `workspace` props, else the `BackendProvider` and
+  `WorkspaceProvider` above. AD runs on the host's backend instance, so the host's authentication
+  and cache apply.
+- **Insight**: an identifier, a reference or the insight object; undefined opens a new insight. URI
+  references are resolved to identifiers first. A new `insight`, `config.sourceDashboard` or
+  `config.sourceInsight` navigates AD.
+- **Loading**: before AD mounts, it loads the user, the organization and its entitlements, the
+  workspace settings, color palette and theme, and the user's permissions in the workspace. A value
+  the host already has skips its request: `config.settings`, `config.user`, `config.organization.id`
+  (with `title`), `config.organization.entitlements`, `config.colorPalette`, `theme` and
+  `permissions`. A host that passes all of them makes AD start without a request. The values that set
+  up the runtime (`backend`, `workspace`, `permissions`, the theme props and `config` except the
+  route values) are read at mount; the route values (actions, tags, separators, `asOfDate`,
+  `isEmbedded`, `allowDashboardLinks`) follow the props.
+- **Theme**: `theme` replaces the workspace theme, `disableThemeLoading` skips it, and
+  `themeModifier` changes the theme AD applies.
+- **Events**: `onInsightSaved`, `onInsightEditingCancelled`, `onInsightOpened`,
+  `onInsightRendered`, `onInsightChanged`, `onFilterContextChanged`, `onAttributeHierarchyModified`,
+  `onError`, the catch-all `onEvent`, and `eventHandlers` (`{ eval, handler }` pairs). The results of
+  the commands are `onClearFinished`, `onClearInsightFinished`, `onUndoFinished`, `onRedoFinished`,
+  `onExportFinished`, `onSetFilterContextFinished`, `onRemoveFilterContextFinished` and
+  `onCommandFailed`; they and `onInsightSaved` get the `contextId` of the command as the second
+  argument. The other events (`drill`, `listeningForDrillableItems`, `apiTokenIsAboutToExpire`)
+  reach `onEvent` only. `onMetricsChanged` fires when the user
+  saves or deletes a metric. A host that shares a caching backend with AD passes `cacheReset`
+  (`resetAll`, `resetCatalogs`; the `CacheControl` of `withCaching` fits): AD calls it when the user
+  refreshes the catalog or edits a metric, before it reloads the data.
+- **Commands**: `apiRef` takes `clear`, `requestCancellation`, `setFilterContext` and
+  `sendCommand`. Commands sent before AD mounts run once it does.
+- **Slots**: `slots.Loading` and `slots.Error`, each a component that gets the `Default` region and
+  its `defaultProps` (ADR-26-02). `Error` covers both a failed load and
+  AD's own bootstrap errors.
+- **Not yet**: the `Header` and `MetricEditor` slots and a portal target: AD's
+  overlays open in `document.body`.
+
+The `./internal` entry exports the same component with `auth`, `externalProviderId` and an
+`apiRef` that also takes `setApiToken`, for GoodData apps that renew tokens through AD.
+
+## Development
+
+```bash
+# Build to esm/
+rushx build
+
+# Run tests in watch mode, or once
+rushx test
+rushx test-once
+
+# Lint, dependency rules, styles, formatting, locales and the state-architecture gate
+rushx validate
+
+# Import both entries in Node (needs a build)
+rushx validate-esm
+
+# Update the API report, api/gdc-analytical-designer.api.md (also part of the build)
+rushx api-extractor
+```

package/esm/BackendProvider.d.ts

@@ -0,0 +1,10 @@
+import { type PropsWithChildren } from "react";
+/**
+ * The component wraps SDK BackendProvider so we can render children then requires it conditionally until the
+ * backend is ready. Backend can be created later when it is created without API token in special embedded
+ * mode when it waits for API token injection via postMessage. When the token is received, the new backend
+ * instance is created and assigned into the variable exported by the backend module and redux store flag
+ * is updated with information that backend is ready.
+ */
+export declare function BackendProvider({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element | null;
+//# sourceMappingURL=BackendProvider.d.ts.map

package/esm/BackendProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackendProvider.d.ts","sourceRoot":"","sources":["../src/BackendProvider.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAS/C;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,EAAE,QAAQ,EAAE,EAAE,iBAAiB,kDAO9D"}

package/esm/BackendProvider.js

@@ -0,0 +1,19 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useSelector } from "react-redux";
+import { BackendProvider as SdkBackendProvider } from "@gooddata/sdk-ui";
+import { backend } from "./backend.js";
+import { selectIsBackendInitialized } from "./store/application_context/app_context_selector.js";
+/**
+ * The component wraps SDK BackendProvider so we can render children then requires it conditionally until the
+ * backend is ready. Backend can be created later when it is created without API token in special embedded
+ * mode when it waits for API token injection via postMessage. When the token is received, the new backend
+ * instance is created and assigned into the variable exported by the backend module and redux store flag
+ * is updated with information that backend is ready.
+ */
+export function BackendProvider({ children }) {
+    const isBackendInitialized = useSelector(selectIsBackendInitialized);
+    if (!isBackendInitialized) {
+        return null;
+    }
+    return _jsx(SdkBackendProvider, { backend: backend, children: children });
+}

package/esm/DetectLocationChange.d.ts

@@ -0,0 +1,3 @@
+import { type PropsWithChildren } from "react";
+export declare function DetectLocationChange({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=DetectLocationChange.d.ts.map

package/esm/DetectLocationChange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DetectLocationChange.d.ts","sourceRoot":"","sources":["../src/DetectLocationChange.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAAa,MAAM,OAAO,CAAC;AAQ1D,wBAAgB,oBAAoB,CAAC,EAAE,QAAQ,EAAE,EAAE,iBAAiB,2CAUnE"}

package/esm/DetectLocationChange.js

@@ -0,0 +1,15 @@
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+// (C) 2007-2026 GoodData Corporation
+import { useEffect } from "react";
+import { useDispatch } from "react-redux";
+import { useLocation } from "react-router";
+import { locationChanged } from "./store/router/router_actions.js";
+export function DetectLocationChange({ children }) {
+    const location = useLocation();
+    const dispatch = useDispatch();
+    useEffect(() => {
+        const action = locationChanged(location.hash);
+        dispatch(action);
+    }, [location, dispatch]);
+    return _jsx(_Fragment, { children: children });
+}

package/esm/Root.d.ts

@@ -0,0 +1,9 @@
+import "@formatjs/intl-pluralrules";
+import "@formatjs/intl-pluralrules/polyfill-locales.js";
+interface IRootProps {
+    basename?: string;
+    initialLocation?: string;
+}
+export declare function Root({ basename, initialLocation }?: IRootProps): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=Root.d.ts.map

package/esm/Root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Root.d.ts","sourceRoot":"","sources":["../src/Root.tsx"],"names":[],"mappings":"AAEA,OAAO,4BAA4B,CAAC;AAGpC,OAAO,gDAAgD,CAAC;AAmBxD,UAAU,UAAU;IAIhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,wBAAgB,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAE,UAAe,2CAgDlE"}

package/esm/Root.js

@@ -0,0 +1,48 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+// (C) 2007-2026 GoodData Corporation
+import "@formatjs/intl-pluralrules";
+// Fully-specified (.js) so strict-ESM consumers (webpack fullySpecified, e.g. the dashboards app
+// loading the direct-AD-embedding chunk) can resolve these extensionless-unfriendly packages.
+import "@formatjs/intl-pluralrules/polyfill-locales.js";
+import { useRef } from "react";
+import { DndProvider } from "@evil-internetmann/react-dnd";
+import { Provider } from "react-redux";
+import { BrowserRouter } from "react-router";
+import { isHostedComponentSelector } from "./appMode/appMode.js";
+import { BackendProvider } from "./BackendProvider.js";
+import { Root as InnerRoot } from "./components/Root.js";
+import { DetectLocationChange } from "./DetectLocationChange.js";
+import { HostedLocation } from "./embedding/HostedLocation.js";
+import { store } from "./reduxStore.js";
+import { createCustomMouseBackend } from "./utils/custom_mouse_backend.js";
+import { TranslationsWrapper } from "./utils/with_connected_intl.js";
+const dndBackend = createCustomMouseBackend();
+export function Root({ basename, initialLocation } = {}) {
+    const isHostedComponent = isHostedComponentSelector(store.getState());
+    // Pluggable mode mounts in a separate React root from the host shell —
+    // the shell's router context doesn't propagate across createRoot boundaries.
+    // Provide a fresh BrowserRouter scoped to the host-allocated basename.
+    //
+    // useTransitions={false}: React Router v7 wraps location-state updates in
+    // React.startTransition by default (the v6 `v7_startTransition` future flag,
+    // which this app never opted into). AD's location changes drive redux/sagas
+    // synchronously via DetectLocationChange; deferring them as concurrent
+    // transitions breaks the ordering of that flow. Opting out restores v6 timing.
+    let content;
+    if (isHostedComponent) {
+        // No router in hosted-component mode: a host's own react-router tree rejects a nested one.
+        content = (_jsx(HostedLocation, { initialLocation: initialLocation, children: _jsx(InnerRoot, {}) }));
+    }
+    else {
+        content = (_jsx(BrowserRouter, { basename: basename, useTransitions: false, children: _jsx(DetectLocationChange, { children: _jsx(InnerRoot, {}) }) }));
+    }
+    // @evil-internetmann/react-dnd stores a single DnD manager on a global (window) under a shared
+    // Symbol.for(), keyed only by the DndProvider `context` prop. AD and its host (sdk-ui-dashboard)
+    // depend on the same react-dnd copy, so in hosted-component mode the host's HTML5-backend
+    // DndProvider mounts first and owns that global instance; AD's provider would reuse it and never
+    // create its own custom mouse backend, leaving catalog drag-and-drop dead. Passing AD its own
+    // context object gives it a separate manager + mouse backend, isolated from the host. Pluggable
+    // mode keeps the global instance (undefined context) unchanged.
+    const dndContext = useRef({}).current;
+    return (_jsx(DndProvider, { backend: dndBackend, context: isHostedComponent ? dndContext : undefined, children: _jsx(Provider, { store: store, children: _jsx(BackendProvider, { children: _jsx(TranslationsWrapper, { children: content }) }) }) }));
+}

package/esm/actions/app_context_actions.d.ts

@@ -0,0 +1,135 @@
+import { type ApiEntitlement } from "@gooddata/sdk-backend-tiger";
+import { type IColorPalette, type ITheme } from "@gooddata/sdk-model";
+import { type ISeparators } from "@gooddata/sdk-ui";
+import { ActionTypeKeys } from "../constants/actions.js";
+import { type IBearBootstrap } from "../typings/bear/bearTypes.js";
+export interface IExternalScripts {
+    walkMe: string;
+    walkMeEnvironment: string;
+    includeTrialSnippet: string;
+}
+export interface IBootstrapData {
+    mapboxToken?: string;
+    agGridToken?: string;
+    maxZoomLevel?: number | null;
+    user: {
+        firstName: string;
+        lastName: string;
+        email: string;
+        uri: string;
+        domain: string;
+        loginMD5: string;
+        language: string;
+        stashedProjectUri: string;
+        separators: ISeparators;
+        created: string;
+        companyName: string;
+        formatLocale?: string;
+        permissions?: string[];
+    };
+    uiSettings: {
+        applicationTitle?: string;
+        organizationName: string;
+        organizationId?: string;
+        displayProjects: boolean;
+        displayAccountPage: boolean;
+        logoUrl: string;
+        faviconUrl: string;
+        appleTouchIconUrl: string;
+        activeColor?: string;
+        headerColor?: string;
+        headerTextColor?: string;
+        documentationUrl?: string;
+        isBranded: boolean;
+        supportEmail?: string;
+        supportForumUrl?: string;
+        ssoLogoutUrl?: string;
+        ssoExpiredUrl?: string;
+        ssoUnauthorizedUrl?: string;
+        showSSOCustomUnauthorizedLoginPage?: boolean;
+    };
+    project: null | {
+        identifier: string;
+        uri: string;
+        title: string;
+        templateUrl: string;
+        timezoneOffset: number;
+        description: string;
+        defaultDashboard: string;
+        defaultDashboardTab: string;
+        analyticalDashboards: IBearBootstrap["bootstrapResource"]["current"]["analyticalDashboards"];
+    };
+    externalScripts?: IExternalScripts;
+    colorPalette?: IColorPalette;
+    bear: {
+        profileSetting?: IBearBootstrap["bootstrapResource"]["profileSetting"];
+        projectPermissions?: IBearBootstrap["bootstrapResource"]["current"]["projectPermissions"];
+    };
+    tiger: {
+        isOrganizationAdmin?: boolean;
+        organizationExpiredDate?: string;
+        organizationEntitlements?: ApiEntitlement[];
+    };
+    theme?: ITheme;
+}
+export type AppContextActions = IAppLoadingAction | IResetApplicationAction | IClearInsightContentAction | IBootstrapErrorAction | IBootstrapDataAction | IRefreshSessionIdAction | ReturnType<typeof setIntlMessages> | ReturnType<typeof setLocale> | ISetThemeAction | ISetColorPaletteAction;
+export declare const bootstrapData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[data: IBootstrapData, windowInstance?: any], {
+    data: IBootstrapData;
+    windowInfo: {
+        viewport: string;
+        pixelRatio: any;
+        isMobileDevice: boolean;
+    };
+    sessionId: string;
+}, ActionTypeKeys.BOOTSTRAP_DATA, never, never>;
+/** Kept for consumers that type case reducers / saga handlers by the action shape. */
+export type IBootstrapDataAction = ReturnType<typeof bootstrapData>;
+export type BootstrapError = {
+    type: string;
+};
+export declare const bootstrapError: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[projectId: string, error: BootstrapError], {
+    projectId: string;
+    error: BootstrapError;
+}, ActionTypeKeys.BOOTSTRAP_ERROR, never, never>;
+export type IBootstrapErrorAction = ReturnType<typeof bootstrapError>;
+export declare const appStartedLoading: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[], {
+    isReady: boolean;
+}, ActionTypeKeys.APP_READINESS_CHANGE, never, never>;
+export declare const appFinishedLoading: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[], {
+    isReady: boolean;
+}, ActionTypeKeys.APP_READINESS_CHANGE, never, never>;
+export type IAppLoadingAction = ReturnType<typeof appStartedLoading>;
+export declare const appFinishedSuccessfulInitialization: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[isEmptyReport: boolean], {
+    isEmptyReport: boolean;
+}, ActionTypeKeys.APP_FINISHED_SUCCESSFUL_INITIALIZATION, never, never>;
+export type IAppFinishedInitialization = ReturnType<typeof appFinishedSuccessfulInitialization>;
+export declare const resetApplication: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<ActionTypeKeys.RESET_APPLICATION>;
+export type IResetApplicationAction = ReturnType<typeof resetApplication>;
+export declare const clearInsightContent: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<ActionTypeKeys.CLEAR_INSIGHT_CONTENT>;
+export type IClearInsightContentAction = ReturnType<typeof clearInsightContent>;
+export declare const loadExternalScripts: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[scripts: IExternalScripts], {
+    scripts: IExternalScripts;
+}, ActionTypeKeys.LOAD_EXTERNAL_SCRIPTS_REQUESTED, never, never>;
+export type ILoadExternalScriptsAction = ReturnType<typeof loadExternalScripts>;
+export declare const refreshSessionId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[], {
+    sessionId: string;
+}, ActionTypeKeys.STORE_REFRESH_SESSION_ID, never, never>;
+export type IRefreshSessionIdAction = ReturnType<typeof refreshSessionId>;
+export declare const setIntlMessages: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[locale: string, messages: Record<string, string>], {
+    locale: string;
+    messages: Record<string, string>;
+}, ActionTypeKeys.SET_INTL_MESSAGES, never, never>;
+export declare const setLocale: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[locale: string], {
+    locale: string;
+}, ActionTypeKeys.SET_LOCALE, never, never>;
+/** Kept for the public index export — the creator is a createAction. */
+export type ISetLocaleAction = ReturnType<typeof setLocale>;
+export declare const setTheme: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[theme?: ITheme | undefined], {
+    theme: ITheme | undefined;
+}, ActionTypeKeys.SET_THEME, never, never>;
+export type ISetThemeAction = ReturnType<typeof setTheme>;
+export declare const setColorPalette: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[colorPalette?: IColorPalette | undefined], {
+    colorPalette: IColorPalette | undefined;
+}, ActionTypeKeys.SET_COLOR_PALETTE, never, never>;
+export type ISetColorPaletteAction = ReturnType<typeof setColorPalette>;
+//# sourceMappingURL=app_context_actions.d.ts.map

package/esm/actions/app_context_actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app_context_actions.d.ts","sourceRoot":"","sources":["../../src/actions/app_context_actions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAGnE,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAGD,MAAM,WAAW,cAAc;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG7B,IAAI,EAAE;QACF,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,UAAU,EAAE,WAAW,CAAC;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;IAGF,UAAU,EAAE;QAIR,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,gBAAgB,EAAE,MAAM,CAAC;QACzB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,eAAe,EAAE,OAAO,CAAC;QACzB,kBAAkB,EAAE,OAAO,CAAC;QAG5B,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,CAAC;QAG1B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,MAAM,CAAC;QAGzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,SAAS,EAAE,OAAO,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,eAAe,CAAC,EAAE,MAAM,CAAC;QAGzB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,kCAAkC,CAAC,EAAE,OAAO,CAAC;KAChD,CAAC;IAGF,OAAO,EAAE,IAAI,GAAG;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,gBAAgB,EAAE,MAAM,CAAC;QACzB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,oBAAoB,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;KAChG,CAAC;IAGF,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAGnC,YAAY,CAAC,EAAE,aAAa,CAAC;IAG7B,IAAI,EAAE;QAEF,cAAc,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAGvE,kBAAkB,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;KAC7F,CAAC;IAGF,KAAK,EAAE;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,uBAAuB,CAAC,EAAE,MAAM,CAAC;QACjC,wBAAwB,CAAC,EAAE,cAAc,EAAE,CAAC;KAC/C,CAAC;IAGF,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,iBAAiB,GACvB,iBAAiB,GACjB,uBAAuB,GACvB,0BAA0B,GAC1B,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,GACvB,UAAU,CAAC,OAAO,eAAe,CAAC,GAClC,UAAU,CAAC,OAAO,SAAS,CAAC,GAC5B,eAAe,GACf,sBAAsB,CAAC;AAE7B,eAAO,MAAM,aAAa;;;;;;;;+CAuBzB,CAAC;AAEF,sFAAsF;AACtF,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpE,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,cAAc;;;gDAG1B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtE,eAAO,MAAM,iBAAiB;;qDAE3B,CAAC;AAEJ,eAAO,MAAM,kBAAkB;;qDAE5B,CAAC;AAEJ,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE,eAAO,MAAM,mCAAmC;;uEAG/C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG,eAAO,MAAM,gBAAgB,0FAAiD,CAAC;AAE/E,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1E,eAAO,MAAM,mBAAmB,8FAAqD,CAAC;AAEtF,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhF,eAAO,MAAM,mBAAmB;;gEAG/B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAGhF,eAAO,MAAM,gBAAgB;;yDAE1B,CAAC;AAEJ,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1E,eAAO,MAAM,eAAe;;;kDAG3B,CAAC;AAEF,eAAO,MAAM,SAAS;;2CAEnB,CAAC;AAEJ,wEAAwE;AACxE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAU5D,eAAO,MAAM,QAAQ;;0CAElB,CAAC;AAEJ,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC;AAE1D,eAAO,MAAM,eAAe;;kDAG3B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/esm/actions/app_context_actions.js

@@ -0,0 +1,56 @@
+// (C) 2007-2026 GoodData Corporation
+import { createAction } from "@reduxjs/toolkit";
+import $ from "jquery";
+import { v4 as uuid } from "uuid";
+import { ActionTypeKeys } from "../constants/actions.js";
+import { isMobile } from "../utils/browser_detect.js";
+export const bootstrapData = createAction(ActionTypeKeys.BOOTSTRAP_DATA, (data, windowInstance = window) => {
+    const $window = $(windowInstance);
+    const viewportWidth = $window.width();
+    const viewportHeight = $window.height();
+    const windowInfo = {
+        viewport: `${viewportWidth}x${viewportHeight}`,
+        pixelRatio: windowInstance.devicePixelRatio || 1,
+        isMobileDevice: isMobile(),
+    };
+    return {
+        payload: {
+            data,
+            windowInfo,
+            // a bootstrap starts a fresh session — the id is generated HERE so the
+            // sessionId reducer stays pure (store/app_context/session_id_reducer.ts)
+            sessionId: uuid(),
+        },
+    };
+});
+export const bootstrapError = createAction(ActionTypeKeys.BOOTSTRAP_ERROR, (projectId, error) => ({ payload: { projectId, error } }));
+export const appStartedLoading = createAction(ActionTypeKeys.APP_READINESS_CHANGE, () => ({
+    payload: { isReady: false },
+}));
+export const appFinishedLoading = createAction(ActionTypeKeys.APP_READINESS_CHANGE, () => ({
+    payload: { isReady: true },
+}));
+export const appFinishedSuccessfulInitialization = createAction(ActionTypeKeys.APP_FINISHED_SUCCESSFUL_INITIALIZATION, (isEmptyReport) => ({ payload: { isEmptyReport } }));
+export const resetApplication = createAction(ActionTypeKeys.RESET_APPLICATION);
+export const clearInsightContent = createAction(ActionTypeKeys.CLEAR_INSIGHT_CONTENT);
+export const loadExternalScripts = createAction(ActionTypeKeys.LOAD_EXTERNAL_SCRIPTS_REQUESTED, (scripts) => ({ payload: { scripts } }));
+// the fresh id is generated HERE so the sessionId reducer stays pure
+export const refreshSessionId = createAction(ActionTypeKeys.STORE_REFRESH_SESSION_ID, () => ({
+    payload: { sessionId: uuid() },
+}));
+export const setIntlMessages = createAction(ActionTypeKeys.SET_INTL_MESSAGES, (locale, messages) => ({ payload: { locale, messages } }));
+export const setLocale = createAction(ActionTypeKeys.SET_LOCALE, (locale) => ({
+    payload: { locale },
+}));
+// `theme?:` / `colorPalette?:` are deliberately OPTIONAL parameters rather than
+// `T | undefined` unions. Both are part of the package's public API (src/index.ts) and are
+// called by the pluggable module with a possibly-absent host value. This package compiles
+// with `strictNullChecks: false`, so the declaration emitter — which has to SYNTHESIZE the
+// inferred createAction type — strips `undefined` out of the union and would publish
+// `[theme: ITheme]`, breaking strict-null consumers. Parameter optionality is a flag on the
+// parameter, not a union member, so it survives that erasure. (The pre-4.4 hand-written
+// creators were unaffected: declaration emit prints EXPLICIT annotations verbatim.)
+export const setTheme = createAction(ActionTypeKeys.SET_THEME, (theme) => ({
+    payload: { theme },
+}));
+export const setColorPalette = createAction(ActionTypeKeys.SET_COLOR_PALETTE, (colorPalette) => ({ payload: { colorPalette } }));