@gooddata/sdk-ui-metric-component 0.0.0-stage → 11.65.0-alpha.11

package/esm/shared/metrics/useMetricListData.js

@@ -0,0 +1,55 @@
+// (C) 2021-2026 GoodData Corporation
+import { useEffect, useState } from "react";
+import { debounce } from "lodash-es";
+import { useBackendStrict, useCancelablePromise, useWorkspaceStrict } from "@gooddata/sdk-ui";
+import { useEvents } from "../eventing/useEvents.js";
+import { getFilteredItems } from "./functions/metricListData.js";
+import { events } from "./useMetricListData.events.js";
+import { loadMetrics } from "./useMetrics.js";
+import { useReloadMetrics } from "./useReloadMetrics.js";
+export const getMetricListData = (backend, workspaceId, onDataLoaded, loadPermissions = false) => (search, sort) => {
+    return loadMetrics(backend, workspaceId, loadPermissions).then((data) => {
+        if (onDataLoaded) {
+            onDataLoaded(data);
+        }
+        const filteredData = getFilteredItems(data, search);
+        filteredData.sort((a, b) => {
+            if (sort.direction === "asc") {
+                return a[sort.type].localeCompare(b[sort.type]);
+            }
+            return b[sort.type].localeCompare(a[sort.type]);
+        });
+        return {
+            items: filteredData,
+            totalCount: filteredData.length,
+        };
+    });
+};
+/**
+ * @internal
+ */
+export const useMetricListData = ({ loadPermissions = false, } = {}) => {
+    const [sort, setSort] = useState({ type: "title", direction: "asc" });
+    const [search, setSearch] = useState("");
+    const { workspaceMetricDataEvent } = useEvents(events);
+    const debouncedTrackWorkspace = debounce(workspaceMetricDataEvent, 500);
+    const workspaceId = useWorkspaceStrict();
+    const backend = useBackendStrict();
+    const { metricReloadRequest } = useReloadMetrics();
+    const [listLoader, setListLoader] = useState(() => getMetricListData(backend, workspaceId, debouncedTrackWorkspace, loadPermissions));
+    useEffect(() => {
+        setListLoader(() => getMetricListData(backend, workspaceId, debouncedTrackWorkspace, loadPermissions));
+        // oxlint-disable-next-line react-hooks/exhaustive-deps
+    }, [backend, workspaceId, loadPermissions]);
+    const { result = { items: [] } } = useCancelablePromise({
+        promise: () => listLoader(search, sort),
+    }, [listLoader, search, sort, metricReloadRequest]);
+    return {
+        items: result.items,
+        totalCount: result.items.length,
+        search,
+        setSearch,
+        sort,
+        setSort,
+    };
+};

package/esm/shared/metrics/useMetrics.d.ts

@@ -0,0 +1,21 @@
+import { type IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
+import { type IMeasureMetadataObject } from "@gooddata/sdk-model";
+import { type UseCancelablePromiseState } from "@gooddata/sdk-ui";
+export declare function loadMetrics(backend: IAnalyticalBackend, workspaceId: string, loadPermissions?: boolean): Promise<IMeasureMetadataObject[]>;
+/**
+ * @internal
+ */
+export interface IUseMetricsOptions {
+    /**
+     * Ask the backend for each metric's object-level permissions. Defaults to the
+     * enableMetricPermissions feature flag when the caller sits inside the metric dialog.
+     */
+    loadPermissions?: boolean;
+}
+/**
+ * Hook allowing to get metrics
+ *
+ * @internal
+ */
+export declare function useMetrics({ loadPermissions }?: IUseMetricsOptions): UseCancelablePromiseState<IMeasureMetadataObject[], unknown>;
+//# sourceMappingURL=useMetrics.d.ts.map

package/esm/shared/metrics/useMetrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMetrics.d.ts","sourceRoot":"","sources":["../../../src/shared/metrics/useMetrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACH,KAAK,yBAAyB,EAIjC,MAAM,kBAAkB,CAAC;AAM1B,wBAAsB,WAAW,CAC7B,OAAO,EAAE,kBAAkB,EAC3B,WAAW,EAAE,MAAM,EACnB,eAAe,UAAQ,GACxB,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAYnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EAAE,eAAe,EAAE,GAAE,kBAAuB,GAAG,yBAAyB,CAC/F,sBAAsB,EAAE,EACxB,OAAO,CACV,CAmBA"}

package/esm/shared/metrics/useMetrics.js

@@ -0,0 +1,36 @@
+// (C) 2021-2026 GoodData Corporation
+import { useBackend, useCancelablePromise, useWorkspace, } from "@gooddata/sdk-ui";
+import { useFeaturesAndSettings } from "../../MetricComponent/FeaturesAndSettings/index.js";
+import { useReloadMetrics } from "./useReloadMetrics.js";
+export async function loadMetrics(backend, workspaceId, loadPermissions = false) {
+    return (backend
+        .workspace(workspaceId)
+        .catalog()
+        // omitted when false so the cache key stays identical to the one used without the
+        // feature flag — the catalog is cached per stringified options
+        .withOptions({ types: ["measure"], ...(loadPermissions ? { loadPermissions } : {}) })
+        .load()
+        .then((workspaceCatalog) => workspaceCatalog.measures())
+        .then((catalogMeasures) => catalogMeasures.map((catalogMeasure) => catalogMeasure.measure)));
+}
+/**
+ * Hook allowing to get metrics
+ *
+ * @internal
+ */
+export function useMetrics({ loadPermissions } = {}) {
+    const workspaceId = useWorkspace();
+    const backend = useBackend();
+    const { metricReloadRequest } = useReloadMetrics();
+    const { enableMetricPermissions } = useFeaturesAndSettings();
+    // every caller has to end up with the same value, or the catalog is loaded once per value
+    const withPermissions = loadPermissions ?? enableMetricPermissions;
+    return useCancelablePromise({
+        promise: () => {
+            if (backend && workspaceId) {
+                return loadMetrics(backend, workspaceId, withPermissions);
+            }
+            return Promise.resolve([]);
+        },
+    }, [backend, workspaceId, metricReloadRequest, withPermissions]);
+}

package/esm/shared/metrics/useReloadMetrics.d.ts

@@ -0,0 +1,3 @@
+import { type IMetricsReloadContext } from "./MetricsReloadContext.js";
+export declare function useReloadMetrics(): IMetricsReloadContext;
+//# sourceMappingURL=useReloadMetrics.d.ts.map

package/esm/shared/metrics/useReloadMetrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReloadMetrics.d.ts","sourceRoot":"","sources":["../../../src/shared/metrics/useReloadMetrics.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,qBAAqB,EAAwB,MAAM,2BAA2B,CAAC;AAE7F,wBAAgB,gBAAgB,IAAI,qBAAqB,CAOxD"}

package/esm/shared/metrics/useReloadMetrics.js

@@ -0,0 +1,10 @@
+// (C) 2021-2026 GoodData Corporation
+import { useContext } from "react";
+import { MetricsReloadContext } from "./MetricsReloadContext.js";
+export function useReloadMetrics() {
+    const reloadContext = useContext(MetricsReloadContext);
+    if (!reloadContext) {
+        throw new Error("useReloadMetrics must be used inside MetricsReloadContextProvider");
+    }
+    return reloadContext;
+}

package/esm/shared/permissions.d.ts

@@ -0,0 +1,19 @@
+import { type IWorkspacePermissions } from "@gooddata/sdk-model";
+/**
+ * @internal
+ */
+export interface IOrganizationPermissions {
+    hasOrgManagePermission: boolean;
+    hasBaseUiAccessPermission?: boolean;
+}
+/**
+ * @internal
+ */
+export declare function emptyWorkspacePermissions(): IWorkspacePermissions;
+/**
+ * @internal
+ */
+export declare function emptyOrganizationPermissions(): IOrganizationPermissions;
+export declare function fullWorkspacePermissions(): IWorkspacePermissions;
+export declare function fullOrganizationPermissions(): IOrganizationPermissions;
+//# sourceMappingURL=permissions.d.ts.map

package/esm/shared/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/shared/permissions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,sBAAsB,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,qBAAqB,CA+BjE;AAED;;GAEG;AACH,wBAAgB,4BAA4B,IAAI,wBAAwB,CAKvE;AAED,wBAAgB,wBAAwB,IAAI,qBAAqB,CAMhE;AAED,wBAAgB,2BAA2B,IAAI,wBAAwB,CAMtE"}

package/esm/shared/permissions.js

@@ -0,0 +1,59 @@
+// (C) 2022-2026 GoodData Corporation
+/**
+ * @internal
+ */
+export function emptyWorkspacePermissions() {
+    return {
+        canAccessWorkbench: false,
+        canCreateAnalyticalDashboard: false,
+        canCreateReport: false,
+        canCreateScheduledMail: false,
+        canAnalyzeWorkspace: false,
+        canCreateVisualization: false,
+        canCreateComputedAttribute: false,
+        canManageVisualizations: false,
+        canExecuteRaw: false,
+        canExportReport: false,
+        canInitData: false,
+        canInviteUserToProject: false,
+        canListUsersInProject: false,
+        canManageACL: false,
+        canManageAnalyticalDashboard: false,
+        canManageDomain: false,
+        canCreateMetric: false,
+        canManageMetric: false,
+        canManageProject: false,
+        canManageReport: false,
+        canRefreshData: false,
+        canUploadNonProductionCSV: false,
+        canManageScheduledMail: false,
+        canExportPdf: false,
+        canExportTabular: false,
+        canCreateFilterView: false,
+        canCreateAutomation: false,
+        canUseAiAssistant: false,
+    };
+}
+/**
+ * @internal
+ */
+export function emptyOrganizationPermissions() {
+    return {
+        hasOrgManagePermission: false,
+        hasBaseUiAccessPermission: true,
+    };
+}
+export function fullWorkspacePermissions() {
+    const permissions = {};
+    Object.keys(emptyWorkspacePermissions()).forEach((key) => {
+        permissions[key] = true;
+    });
+    return permissions;
+}
+export function fullOrganizationPermissions() {
+    const permissions = {};
+    Object.keys(emptyOrganizationPermissions()).forEach((key) => {
+        permissions[key] = true;
+    });
+    return permissions;
+}

package/esm/shared/platform.d.ts

@@ -0,0 +1,2 @@
+export declare function isMac(): boolean;
+//# sourceMappingURL=platform.d.ts.map

package/esm/shared/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../src/shared/platform.ts"],"names":[],"mappings":"AAEA,wBAAgB,KAAK,IAAI,OAAO,CAE/B"}

package/esm/shared/platform.js

@@ -0,0 +1,4 @@
+// (C) 2021-2026 GoodData Corporation
+export function isMac() {
+    return navigator.platform.indexOf("Mac") > -1;
+}

package/esm/shared/theme/index.d.ts

@@ -0,0 +1,424 @@
+import { type CSSObject } from "tss-react";
+/**
+ * @internal
+ */
+export declare function useTheme(): {
+    fonts: {
+        main: string;
+        placeholder: string;
+    };
+    globals: {
+        font: string;
+        colors: {
+            title: string;
+            subtitle: string;
+            description: string;
+            defaultWhite: string;
+            defaultText: string;
+            defaultGreyedText: string;
+            defaultStateBlank: string;
+            defaultBorder: string;
+            defaultBorderDarker: string;
+            dropdownButton: string;
+            dropdownButtonHover: string;
+            dropdownButtonMoreHover: string;
+            dropdownHeaderBackground: string;
+            editorBackground: string;
+            editableRowHover: string;
+            line: string;
+            placeholder: string;
+            white: string;
+            border: string;
+            link: string;
+            maqlKeyword: string;
+            metric: string;
+            fact: string;
+            attribute: string;
+            dataset: string;
+            parameter: string;
+            comment: string;
+            value: string;
+            active: string;
+            negative: string;
+            negativeBackground: string;
+            warning: string;
+        };
+        spinner: CSSObject;
+        normalItemStyle: {
+            fontWeight: number;
+            fontSize: number;
+            padding: string;
+            background: string;
+            borderRadius: number;
+            outline: number;
+            height: number;
+            lineHeight: string;
+            display: string;
+        };
+        smallItemStyle: {
+            fontSize: number;
+            fontWeight: number;
+            lineHeight: string;
+            height: string;
+        };
+        metricList: {
+            itemSize: number;
+            padding: number;
+        };
+        community: {
+            color: string;
+            background: string;
+        };
+    };
+    tabs: {
+        colors: {
+            border: string;
+            active: string;
+            divider: string;
+            dirty: string;
+            background: string;
+            negative: string;
+            separator: string;
+            normal: string;
+            create: string;
+            hover: string;
+            placeholder: string;
+            arrow: string;
+            disabled: string;
+        };
+        sizes: {
+            arrowButtonWidth: number;
+            controlsDividerWidth: number;
+            controlsDividerMargin: number;
+            buttonMargin: number;
+            flag: number;
+            space: number;
+            tabsPadding: number;
+            tabLastDivider: number;
+            tabBorderRadius: number;
+        };
+        lineHeight: {
+            close: number;
+            title: number;
+        };
+        fontSize: {
+            title: number;
+        };
+    };
+    preview: {
+        colors: {
+            text: string;
+            default: string;
+            create: string;
+            hover: string;
+        };
+    };
+    minimize: {
+        boxShadow: string;
+        colors: {
+            editing: string;
+            count: string;
+            border: string;
+            divider: string;
+            background: string;
+        };
+        sizes: {
+            borderRadius: number;
+            gap: number;
+            countsMinWidth: number;
+            button: number;
+        };
+        lineHeight: {
+            text: number;
+        };
+        fontSize: {
+            text: number;
+        };
+    };
+};
+/**
+ * @internal
+ */
+export type DefaultTheme = ReturnType<typeof useTheme>;
+/**
+ * @internal
+ */
+export declare const makeStyles: <Params = void, RuleNameSubsetReferencableInNestedSelectors extends string = never>(params?: {
+    name?: string | Record<string, unknown> | undefined;
+    uniqId?: string | undefined;
+} | undefined) => <RuleName extends string>(cssObjectByRuleNameOrGetCssObjectByRuleName: Record<RuleName, CSSObject> | ((theme: {
+    fonts: {
+        main: string;
+        placeholder: string;
+    };
+    globals: {
+        font: string;
+        colors: {
+            title: string;
+            subtitle: string;
+            description: string;
+            defaultWhite: string;
+            defaultText: string;
+            defaultGreyedText: string;
+            defaultStateBlank: string;
+            defaultBorder: string;
+            defaultBorderDarker: string;
+            dropdownButton: string;
+            dropdownButtonHover: string;
+            dropdownButtonMoreHover: string;
+            dropdownHeaderBackground: string;
+            editorBackground: string;
+            editableRowHover: string;
+            line: string;
+            placeholder: string;
+            white: string;
+            border: string;
+            link: string;
+            maqlKeyword: string;
+            metric: string;
+            fact: string;
+            attribute: string;
+            dataset: string;
+            parameter: string;
+            comment: string;
+            value: string;
+            active: string;
+            negative: string;
+            negativeBackground: string;
+            warning: string;
+        };
+        spinner: CSSObject;
+        normalItemStyle: {
+            fontWeight: number;
+            fontSize: number;
+            padding: string;
+            background: string;
+            borderRadius: number;
+            outline: number;
+            height: number;
+            lineHeight: string;
+            display: string;
+        };
+        smallItemStyle: {
+            fontSize: number;
+            fontWeight: number;
+            lineHeight: string;
+            height: string;
+        };
+        metricList: {
+            itemSize: number;
+            padding: number;
+        };
+        community: {
+            color: string;
+            background: string;
+        };
+    };
+    tabs: {
+        colors: {
+            border: string;
+            active: string;
+            divider: string;
+            dirty: string;
+            background: string;
+            negative: string;
+            separator: string;
+            normal: string;
+            create: string;
+            hover: string;
+            placeholder: string;
+            arrow: string;
+            disabled: string;
+        };
+        sizes: {
+            arrowButtonWidth: number;
+            controlsDividerWidth: number;
+            controlsDividerMargin: number;
+            buttonMargin: number;
+            flag: number;
+            space: number;
+            tabsPadding: number;
+            tabLastDivider: number;
+            tabBorderRadius: number;
+        };
+        lineHeight: {
+            close: number;
+            title: number;
+        };
+        fontSize: {
+            title: number;
+        };
+    };
+    preview: {
+        colors: {
+            text: string;
+            default: string;
+            create: string;
+            hover: string;
+        };
+    };
+    minimize: {
+        boxShadow: string;
+        colors: {
+            editing: string;
+            count: string;
+            border: string;
+            divider: string;
+            background: string;
+        };
+        sizes: {
+            borderRadius: number;
+            gap: number;
+            countsMinWidth: number;
+            button: number;
+        };
+        lineHeight: {
+            text: number;
+        };
+        fontSize: {
+            text: number;
+        };
+    };
+}, params: Params, classes: Record<RuleNameSubsetReferencableInNestedSelectors, string>) => Record<RuleName | RuleNameSubsetReferencableInNestedSelectors, CSSObject>)) => (params: Params, muiStyleOverridesParams?: {
+    props: Record<string, unknown>;
+    ownerState?: Record<string, unknown>;
+} | undefined) => {
+    classes: Record<RuleName, string>;
+    theme: {
+        fonts: {
+            main: string;
+            placeholder: string;
+        };
+        globals: {
+            font: string;
+            colors: {
+                title: string;
+                subtitle: string;
+                description: string;
+                defaultWhite: string;
+                defaultText: string;
+                defaultGreyedText: string;
+                defaultStateBlank: string;
+                defaultBorder: string;
+                defaultBorderDarker: string;
+                dropdownButton: string;
+                dropdownButtonHover: string;
+                dropdownButtonMoreHover: string;
+                dropdownHeaderBackground: string;
+                editorBackground: string;
+                editableRowHover: string;
+                line: string;
+                placeholder: string;
+                white: string;
+                border: string;
+                link: string;
+                maqlKeyword: string;
+                metric: string;
+                fact: string;
+                attribute: string;
+                dataset: string;
+                parameter: string;
+                comment: string;
+                value: string;
+                active: string;
+                negative: string;
+                negativeBackground: string;
+                warning: string;
+            };
+            spinner: CSSObject;
+            normalItemStyle: {
+                fontWeight: number;
+                fontSize: number;
+                padding: string;
+                background: string;
+                borderRadius: number;
+                outline: number;
+                height: number;
+                lineHeight: string;
+                display: string;
+            };
+            smallItemStyle: {
+                fontSize: number;
+                fontWeight: number;
+                lineHeight: string;
+                height: string;
+            };
+            metricList: {
+                itemSize: number;
+                padding: number;
+            };
+            community: {
+                color: string;
+                background: string;
+            };
+        };
+        tabs: {
+            colors: {
+                border: string;
+                active: string;
+                divider: string;
+                dirty: string;
+                background: string;
+                negative: string;
+                separator: string;
+                normal: string;
+                create: string;
+                hover: string;
+                placeholder: string;
+                arrow: string;
+                disabled: string;
+            };
+            sizes: {
+                arrowButtonWidth: number;
+                controlsDividerWidth: number;
+                controlsDividerMargin: number;
+                buttonMargin: number;
+                flag: number;
+                space: number;
+                tabsPadding: number;
+                tabLastDivider: number;
+                tabBorderRadius: number;
+            };
+            lineHeight: {
+                close: number;
+                title: number;
+            };
+            fontSize: {
+                title: number;
+            };
+        };
+        preview: {
+            colors: {
+                text: string;
+                default: string;
+                create: string;
+                hover: string;
+            };
+        };
+        minimize: {
+            boxShadow: string;
+            colors: {
+                editing: string;
+                count: string;
+                border: string;
+                divider: string;
+                background: string;
+            };
+            sizes: {
+                borderRadius: number;
+                gap: number;
+                countsMinWidth: number;
+                button: number;
+            };
+            lineHeight: {
+                text: number;
+            };
+            fontSize: {
+                text: number;
+            };
+        };
+    };
+    css: import("tss-react").Css;
+    cx: import("tss-react").Cx;
+};
+//# sourceMappingURL=index.d.ts.map

package/esm/shared/theme/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/shared/theme/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAoB,MAAM,WAAW,CAAC;AAE7D;;GAEG;AACH,wBAAgB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAuJZ,gBAAgB;YAChB,oBAAoB;YACpB,qBAAqB;YACrB,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,WAAW;YACX,cAAc;YACd,eAAe;;;YAGf,KAAK;YACL,KAAK;;;YAGL,KAAK;;;;;;;;;;;;;;;;;;;;;YAcL,YAAY;YACZ,GAAG;YACH,cAAc;YACd,MAAM;;;YAGN,IAAI;;;YAGJ,IAAI;;;EAWf;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAQ,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA3Db,gBAAgB;YAChB,oBAAoB;YACpB,qBAAqB;YACrB,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,WAAW;YACX,cAAc;YACd,eAAe;;;YAGf,KAAK;YACL,KAAK;;;YAGL,KAAK;;;;;;;;;;;;;;;;;;;;;YAcL,YAAY;YACZ,GAAG;YACH,cAAc;YACd,MAAM;;;YAGN,IAAI;;;YAGJ,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqB4C,CAAC"}