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

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

@@ -0,0 +1,29 @@
+import { type IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
+import { type IMeasureMetadataObject } from "@gooddata/sdk-model";
+interface ILoadListData {
+    items: IMeasureMetadataObject[];
+    totalCount: number;
+}
+type IUserMetricListData = (search: string, sort: IMetricListSort) => Promise<ILoadListData>;
+export interface IMetricListSort {
+    type: "title" | "id";
+    direction: "asc" | "desc";
+}
+export interface IUseMetricList {
+    items: IMeasureMetadataObject[];
+    search: string;
+    setSearch: (value: string) => void;
+    sort: IMetricListSort;
+    setSort: (sort: IMetricListSort) => void;
+    totalCount: number;
+}
+export declare const getMetricListData: (backend: IAnalyticalBackend, workspaceId: string, onDataLoaded: (data: IMeasureMetadataObject[]) => void, loadPermissions?: boolean) => IUserMetricListData;
+export interface IUseMetricListDataOptions {
+    /**
+     * Ask the backend for each metric's object-level permissions.
+     */
+    loadPermissions?: boolean;
+}
+export declare const useMetricListData: ({ loadPermissions, }?: IUseMetricListDataOptions) => IUseMetricList;
+export {};
+//# sourceMappingURL=useMetricListData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useMetricListData.d.ts","sourceRoot":"","sources":["../../../src/shared/metrics/useMetricListData.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAUlE,UAAU,aAAa;IACnB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,KAAK,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;AAE7F,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;IACzC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,iBAAiB,YAEb,kBAAkB,eACd,MAAM,gBACL,CAAC,IAAI,EAAE,sBAAsB,EAAE,KAAK,IAAI,gCAEvD,mBAqBF,CAAC;AAEN,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,eAAO,MAAM,iBAAiB,0BAE3B,yBAAyB,KAAQ,cAoCnC,CAAC"}

package/esm/shared/metrics/useMetricListData.events.d.ts

@@ -0,0 +1,12 @@
+import { type IMeasureMetadataObject } from "@gooddata/sdk-model";
+import { type IEvent } from "../eventing/EventContext.js";
+export type WorkspaceMetricStats = {
+    numberOfSameNames: number;
+    numberOfSameExpressions: number;
+};
+declare function workspaceMetricDataEvent(data: IMeasureMetadataObject[]): IEvent | null;
+export declare const events: {
+    workspaceMetricDataEvent: typeof workspaceMetricDataEvent;
+};
+export {};
+//# sourceMappingURL=useMetricListData.events.d.ts.map

package/esm/shared/metrics/useMetricListData.events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMetricListData.events.d.ts","sourceRoot":"","sources":["../../../src/shared/metrics/useMetricListData.events.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAG1D,MAAM,MAAM,oBAAoB,GAAG;IAC/B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB,EAAE,MAAM,CAAC;CACnC,CAAC;AAmBF,iBAAS,wBAAwB,CAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,MAAM,GAAG,IAAI,CAO/E;AAED,eAAO,MAAM,MAAM;;CAElB,CAAC"}

package/esm/shared/metrics/useMetricListData.events.js

@@ -0,0 +1,31 @@
+// (C) 2021-2026 GoodData Corporation
+import { groupBy, isEqual } from "lodash-es";
+import { EventCategories, Events } from "../eventing/events.js";
+function getSameItemNumber(collection, iteratee) {
+    const groups = groupBy(collection, iteratee);
+    return Object.values(groups).filter((group) => group.length > 1).length;
+}
+function calculateWorkspaceMetricStats(data) {
+    const numberOfSameNames = getSameItemNumber(data, (metric) => metric.title);
+    const numberOfSameExpressions = getSameItemNumber(data, (metric) => metric.expression);
+    return { numberOfSameNames, numberOfSameExpressions };
+}
+let workspaceMetricStats = null;
+function workspaceMetricDataEvent(data) {
+    const stats = calculateWorkspaceMetricStats(data);
+    if (workspaceMetricStats && !isEqual(stats, workspaceMetricStats)) {
+        return workspaceMetricStatsChangedEvent(stats);
+    }
+    workspaceMetricStats = stats;
+    return null;
+}
+export const events = {
+    workspaceMetricDataEvent,
+};
+function workspaceMetricStatsChangedEvent(stats) {
+    return {
+        action: Events.workspaceMetricStatsChanged,
+        category: EventCategories.metricList,
+        variables: stats,
+    };
+}

package/esm/shared/metrics/useMetricListData.js

@@ -0,0 +1,52 @@
+// (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,
+        };
+    });
+};
+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,16 @@
+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[]>;
+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
+ */
+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,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;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,34 @@
+// (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
+ */
+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,10 @@
+import { type IWorkspacePermissions } from "@gooddata/sdk-model";
+export interface IOrganizationPermissions {
+    hasOrgManagePermission: boolean;
+    hasBaseUiAccessPermission?: boolean;
+}
+export declare function emptyWorkspacePermissions(): IWorkspacePermissions;
+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,MAAM,WAAW,wBAAwB;IACrC,sBAAsB,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,wBAAgB,yBAAyB,IAAI,qBAAqB,CA+BjE;AAED,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,53 @@
+// (C) 2022-2026 GoodData Corporation
+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,
+    };
+}
+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;
+}