@gooddata/sdk-ui-geo 11.6.0-alpha.5 → 11.6.0-alpha.7

package/esm/next/hooks/init/useInitExecution.js

@@ -0,0 +1,91 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+import { compact } from "lodash-es";
+import { MeasureGroupIdentifier, bucketsAttributes, bucketsMeasures, newBucket, newDimension, } from "@gooddata/sdk-model";
+import { BucketNames, useBackendStrict, useWorkspaceStrict } from "@gooddata/sdk-ui";
+/**
+ * Creates dimensions for geo chart execution.
+ * @internal
+ */
+export function getGeoChartDimensions(def) {
+    const buckets = def.buckets;
+    const measures = bucketsMeasures(buckets);
+    const attributes = bucketsAttributes(buckets);
+    return compact([measures.length > 0 && newDimension([MeasureGroupIdentifier]), newDimension(attributes)]);
+}
+/**
+ * Creates an execution for GeoPushpinChartNext with proper bucket configuration.
+ *
+ * @remarks
+ * This hook creates a prepared execution with the appropriate buckets based on whether
+ * the chart is using location mode (single attribute) or lat/lng mode (two attributes).
+ *
+ * Buckets created:
+ * - LOCATION: Contains either location attribute or lat/lng attributes
+ * - SIZE: Contains size measure/attribute
+ * - COLOR: Contains color measure/attribute
+ * - SEGMENT: Contains segmentBy attribute
+ * - TOOLTIP_TEXT: Contains tooltipText attribute
+ *
+ * @param config - Execution configuration
+ * @returns Prepared execution ready to be executed
+ *
+ * @alpha
+ */
+export function useInitExecution(props) {
+    const { location, latitude, longitude, segmentBy, size, color, config, filters = [], sortBy = [], execConfig, } = props;
+    const backend = useBackendStrict(props.backend, "useInitExecution");
+    const workspace = useWorkspaceStrict(props.workspace, "useInitExecution");
+    const { tooltipText } = config ?? {};
+    return useMemo(() => {
+        const buckets = [];
+        // Location bucket - either single location or lat/lng pair
+        if (latitude && longitude) {
+            buckets.push(newBucket(BucketNames.LATITUDE, latitude));
+            buckets.push(newBucket(BucketNames.LONGITUDE, longitude));
+        }
+        else if (location) {
+            buckets.push(newBucket(BucketNames.LOCATION, location));
+        }
+        // Size bucket
+        if (size) {
+            buckets.push(newBucket(BucketNames.SIZE, size));
+        }
+        // Color bucket
+        if (color) {
+            buckets.push(newBucket(BucketNames.COLOR, color));
+        }
+        // Segment bucket
+        if (segmentBy) {
+            buckets.push(newBucket(BucketNames.SEGMENT, segmentBy));
+        }
+        // Tooltip text bucket
+        if (tooltipText) {
+            buckets.push(newBucket(BucketNames.TOOLTIP_TEXT, tooltipText));
+        }
+        let execution = backend
+            .workspace(workspace)
+            .execution()
+            .forBuckets(buckets, filters)
+            .withSorting(...sortBy)
+            .withDimensions(getGeoChartDimensions);
+        if (execConfig) {
+            execution = execution.withExecConfig(execConfig);
+        }
+        return execution;
+    }, [
+        backend,
+        workspace,
+        location,
+        latitude,
+        longitude,
+        segmentBy,
+        size,
+        color,
+        tooltipText,
+        filters,
+        sortBy,
+        execConfig,
+    ]);
+}
+//# sourceMappingURL=useInitExecution.js.map

package/esm/next/hooks/init/useInitExecution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitExecution.js","sourceRoot":"","sources":["../../../../src/next/hooks/init/useInitExecution.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EAGH,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,SAAS,EACT,YAAY,GACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAIrF;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAyB;IAC3D,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE9C,OAAO,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,CAAC,sBAAsB,CAAC,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAwC;IACrE,MAAM,EACF,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,SAAS,EACT,IAAI,EACJ,KAAK,EACL,MAAM,EACN,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,EAAE,EACX,UAAU,GACb,GAAG,KAAK,CAAC;IAEV,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAE1E,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;IAErC,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,2DAA2D;QAC3D,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;QAC9D,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5D,CAAC;QAED,cAAc;QACd,IAAI,IAAI,EAAE,CAAC;YACP,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,eAAe;QACf,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACtD,CAAC;QAED,iBAAiB;QACjB,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QAC5D,CAAC;QAED,sBAAsB;QACtB,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,SAAS,GAAG,OAAO;aAClB,SAAS,CAAC,SAAS,CAAC;aACpB,SAAS,EAAE;aACX,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;aAC5B,WAAW,CAAC,GAAG,MAAM,CAAC;aACtB,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAE3C,IAAI,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC,EAAE;QACC,OAAO;QACP,SAAS;QACT,QAAQ;QACR,QAAQ;QACR,SAAS;QACT,SAAS;QACT,IAAI;QACJ,KAAK;QACL,WAAW;QACX,OAAO;QACP,MAAM;QACN,UAAU;KACb,CAAC,CAAC;AACP,CAAC"}

package/esm/next/hooks/init/useInitExecutionResult.d.ts

@@ -0,0 +1,17 @@
+import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseState } from "@gooddata/sdk-ui";
+/**
+ * Fetches execution result and returns data view facade.
+ *
+ * @remarks
+ * This hook executes the prepared execution and returns the data view wrapped in a facade
+ * for easier data access. It handles loading states, errors, and provides callbacks for
+ * different stages of the data fetching process.
+ *
+ * @param config - Execution result configuration
+ * @param deps - Additional dependencies for the hook
+ * @returns Execution state with data view facade
+ *
+ * @alpha
+ */
+export declare function useInitExecutionResult(): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
+//# sourceMappingURL=useInitExecutionResult.d.ts.map

package/esm/next/hooks/init/useInitExecutionResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitExecutionResult.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/init/useInitExecutionResult.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EAE5B,MAAM,kBAAkB,CAAC;AAI1B;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,IAAI,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CA0BpG"}

package/esm/next/hooks/init/useInitExecutionResult.js

@@ -0,0 +1,44 @@
+// (C) 2025 GoodData Corporation
+import { useExecutionDataView, } from "@gooddata/sdk-ui";
+import { useGeoPushpinProps } from "../../context/GeoPushpinPropsContext.js";
+/**
+ * Fetches execution result and returns data view facade.
+ *
+ * @remarks
+ * This hook executes the prepared execution and returns the data view wrapped in a facade
+ * for easier data access. It handles loading states, errors, and provides callbacks for
+ * different stages of the data fetching process.
+ *
+ * @param config - Execution result configuration
+ * @param deps - Additional dependencies for the hook
+ * @returns Execution state with data view facade
+ *
+ * @alpha
+ */
+export function useInitExecutionResult() {
+    const { onLoadingChanged, onDataView, onError, backend, workspace, execution } = useGeoPushpinProps();
+    return useExecutionDataView({
+        backend,
+        workspace,
+        execution,
+        enableExecutionCancelling: true,
+        onLoading: () => {
+            onLoadingChanged?.({
+                isLoading: true,
+            });
+        },
+        onSuccess: (dataView) => {
+            onLoadingChanged?.({
+                isLoading: false,
+            });
+            onDataView?.(dataView);
+        },
+        onError: (error) => {
+            onLoadingChanged?.({
+                isLoading: false,
+            });
+            onError?.(error);
+        },
+    });
+}
+//# sourceMappingURL=useInitExecutionResult.js.map

package/esm/next/hooks/init/useInitExecutionResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitExecutionResult.js","sourceRoot":"","sources":["../../../../src/next/hooks/init/useInitExecutionResult.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAIH,oBAAoB,GACvB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAE7E;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB;IAClC,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAE,CAAC;IAEtG,OAAO,oBAAoB,CAAC;QACxB,OAAO;QACP,SAAS;QACT,SAAS;QACT,yBAAyB,EAAE,IAAI;QAC/B,SAAS,EAAE,GAAG,EAAE;YACZ,gBAAgB,EAAE,CAAC;gBACf,SAAS,EAAE,IAAI;aAClB,CAAC,CAAC;QACP,CAAC;QACD,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE;YACpB,gBAAgB,EAAE,CAAC;gBACf,SAAS,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACf,gBAAgB,EAAE,CAAC;gBACf,SAAS,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;KACJ,CAAC,CAAC;AACP,CAAC"}

package/esm/next/hooks/legend/useLegendConfig.d.ts

@@ -0,0 +1,35 @@
+import { PositionType } from "@gooddata/sdk-ui-vis-commons";
+import { IGeoPushpinChartNextConfig } from "../../types/config.js";
+/**
+ * Legend configuration computed from geo config.
+ *
+ * @alpha
+ */
+export interface ILegendConfig {
+    /**
+     * Whether legend should be rendered
+     */
+    enabled: boolean;
+    /**
+     * Legend position relative to the chart
+     */
+    position: PositionType;
+    /**
+     * Responsive behavior setting
+     */
+    responsive: boolean | "autoPositionWithPopup";
+}
+/**
+ * Hook to compute legend configuration from geo config.
+ *
+ * @remarks
+ * This hook extracts and normalizes legend configuration from the geo config,
+ * providing sensible defaults for enabled, position, and responsive settings.
+ *
+ * @param config - Geo chart configuration
+ * @returns Normalized legend configuration
+ *
+ * @alpha
+ */
+export declare function useLegendConfig(config?: IGeoPushpinChartNextConfig): ILegendConfig;
+//# sourceMappingURL=useLegendConfig.d.ts.map

package/esm/next/hooks/legend/useLegendConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendConfig.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendConfig.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAEnE;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACjD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,aAAa,CAUlF"}

package/esm/next/hooks/legend/useLegendConfig.js

@@ -0,0 +1,25 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+/**
+ * Hook to compute legend configuration from geo config.
+ *
+ * @remarks
+ * This hook extracts and normalizes legend configuration from the geo config,
+ * providing sensible defaults for enabled, position, and responsive settings.
+ *
+ * @param config - Geo chart configuration
+ * @returns Normalized legend configuration
+ *
+ * @alpha
+ */
+export function useLegendConfig(config) {
+    return useMemo(() => {
+        const legendConfig = config?.legend;
+        return {
+            enabled: legendConfig?.enabled ?? true,
+            position: legendConfig?.position ?? "top",
+            responsive: legendConfig?.responsive ?? false,
+        };
+    }, [config?.legend]);
+}
+//# sourceMappingURL=useLegendConfig.js.map

package/esm/next/hooks/legend/useLegendConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendConfig.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AA4BhC;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,MAAmC;IAC/D,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,MAAM,YAAY,GAAG,MAAM,EAAE,MAAM,CAAC;QAEpC,OAAO;YACH,OAAO,EAAE,YAAY,EAAE,OAAO,IAAI,IAAI;YACtC,QAAQ,EAAE,YAAY,EAAE,QAAQ,IAAI,KAAK;YACzC,UAAU,EAAE,YAAY,EAAE,UAAU,IAAI,KAAK;SAChD,CAAC;IACN,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACzB,CAAC"}

package/esm/next/hooks/legend/useLegendDetails.d.ts

@@ -0,0 +1,27 @@
+import { ContentRect } from "react-measure";
+import { ILegendDetails } from "@gooddata/sdk-ui-vis-commons";
+import { IGeoPushpinChartNextConfig } from "../../types/config.js";
+import { IGeoData } from "../../types/shared.js";
+/**
+ * Hook to extract legend details from configuration.
+ *
+ * @remarks
+ * This hook uses the `getLegendDetails` function from vis-commons to determine:
+ * - Legend position (computed based on responsive config and container size)
+ * - Whether to render popup legend (`renderPopUp`) - true when width less than 610px with autoPositionWithPopup
+ * - Maximum rows for popup collapsed state (`maxRows`) - 1 or 2 based on height
+ * - Dialog title (`name`) - from segment attribute name
+ *
+ * The popup legend is triggered when:
+ * - Config has `legend.responsive: "autoPositionWithPopup"`
+ * - Container width less than 610px (narrow) OR position is top/bottom
+ *
+ * @param config - Geo pushpin chart configuration
+ * @param geoData - Geographic data containing segment information
+ * @param contentRect - Container dimensions from react-measure
+ * @returns Legend details or null if cannot be determined
+ *
+ * @alpha
+ */
+export declare function useLegendDetails(config: IGeoPushpinChartNextConfig | undefined, geoData: IGeoData | null, contentRect: ContentRect | undefined): ILegendDetails | null;
+//# sourceMappingURL=useLegendDetails.d.ts.map

package/esm/next/hooks/legend/useLegendDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendDetails.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendDetails.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,cAAc,EAAoB,MAAM,8BAA8B,CAAC;AAEhF,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,gBAAgB,CAC5B,MAAM,EAAE,0BAA0B,GAAG,SAAS,EAC9C,OAAO,EAAE,QAAQ,GAAG,IAAI,EACxB,WAAW,EAAE,WAAW,GAAG,SAAS,GACrC,cAAc,GAAG,IAAI,CAmBvB"}

package/esm/next/hooks/legend/useLegendDetails.js

@@ -0,0 +1,39 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+import { getLegendDetails } from "@gooddata/sdk-ui-vis-commons";
+/**
+ * Hook to extract legend details from configuration.
+ *
+ * @remarks
+ * This hook uses the `getLegendDetails` function from vis-commons to determine:
+ * - Legend position (computed based on responsive config and container size)
+ * - Whether to render popup legend (`renderPopUp`) - true when width less than 610px with autoPositionWithPopup
+ * - Maximum rows for popup collapsed state (`maxRows`) - 1 or 2 based on height
+ * - Dialog title (`name`) - from segment attribute name
+ *
+ * The popup legend is triggered when:
+ * - Config has `legend.responsive: "autoPositionWithPopup"`
+ * - Container width less than 610px (narrow) OR position is top/bottom
+ *
+ * @param config - Geo pushpin chart configuration
+ * @param geoData - Geographic data containing segment information
+ * @param contentRect - Container dimensions from react-measure
+ * @returns Legend details or null if cannot be determined
+ *
+ * @alpha
+ */
+export function useLegendDetails(config, geoData, contentRect) {
+    return useMemo(() => {
+        const position = config?.legend?.position ?? "auto";
+        const responsive = config?.legend?.responsive;
+        const legendLabel = geoData?.segment?.name;
+        return getLegendDetails(position, responsive ?? false, { contentRect, legendLabel }, config?.respectLegendPosition);
+    }, [
+        config?.legend?.position,
+        config?.legend?.responsive,
+        config?.respectLegendPosition,
+        geoData?.segment?.name,
+        contentRect,
+    ]);
+}
+//# sourceMappingURL=useLegendDetails.js.map

package/esm/next/hooks/legend/useLegendDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendDetails.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendDetails.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAIhC,OAAO,EAAkB,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAKhF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,gBAAgB,CAC5B,MAA8C,EAC9C,OAAwB,EACxB,WAAoC;IAEpC,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,MAAM,QAAQ,GAAG,MAAM,EAAE,MAAM,EAAE,QAAQ,IAAI,MAAM,CAAC;QACpD,MAAM,UAAU,GAAG,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC;QAC9C,MAAM,WAAW,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC;QAE3C,OAAO,gBAAgB,CACnB,QAAQ,EACR,UAAU,IAAI,KAAK,EACnB,EAAE,WAAW,EAAE,WAAW,EAAE,EAC5B,MAAM,EAAE,qBAAqB,CAChC,CAAC;IACN,CAAC,EAAE;QACC,MAAM,EAAE,MAAM,EAAE,QAAQ;QACxB,MAAM,EAAE,MAAM,EAAE,UAAU;QAC1B,MAAM,EAAE,qBAAqB;QAC7B,OAAO,EAAE,OAAO,EAAE,IAAI;QACtB,WAAW;KACd,CAAC,CAAC;AACP,CAAC"}

package/esm/next/hooks/legend/useLegendItemClick.d.ts

@@ -0,0 +1,16 @@
+import { IPushpinCategoryLegendItem } from "@gooddata/sdk-ui-vis-commons";
+/**
+ * Hook to handle legend item click interactions.
+ *
+ * @remarks
+ * This hook provides a callback for toggling legend items on/off.
+ * When a legend item is clicked, it updates the enabled state in the legend context,
+ * which will filter visible pushpins on the map.
+ *
+ * @param allUris - All available legend item URIs (for toggle logic)
+ * @returns Callback function for legend item clicks
+ *
+ * @alpha
+ */
+export declare function useLegendItemClick(allUris: string[]): (item: IPushpinCategoryLegendItem) => void;
+//# sourceMappingURL=useLegendItemClick.d.ts.map

package/esm/next/hooks/legend/useLegendItemClick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItemClick.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItemClick.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAI1E;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,0BAA0B,KAAK,IAAI,CAShG"}

package/esm/next/hooks/legend/useLegendItemClick.js

@@ -0,0 +1,23 @@
+// (C) 2025 GoodData Corporation
+import { useCallback } from "react";
+import { useGeoLegend } from "../../context/GeoLegendContext.js";
+/**
+ * Hook to handle legend item click interactions.
+ *
+ * @remarks
+ * This hook provides a callback for toggling legend items on/off.
+ * When a legend item is clicked, it updates the enabled state in the legend context,
+ * which will filter visible pushpins on the map.
+ *
+ * @param allUris - All available legend item URIs (for toggle logic)
+ * @returns Callback function for legend item clicks
+ *
+ * @alpha
+ */
+export function useLegendItemClick(allUris) {
+    const { toggleLegendItem } = useGeoLegend();
+    return useCallback((item) => {
+        toggleLegendItem(item.uri, allUris);
+    }, [toggleLegendItem, allUris]);
+}
+//# sourceMappingURL=useLegendItemClick.js.map

package/esm/next/hooks/legend/useLegendItemClick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItemClick.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItemClick.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAIpC,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAiB;IAChD,MAAM,EAAE,gBAAgB,EAAE,GAAG,YAAY,EAAE,CAAC;IAE5C,OAAO,WAAW,CACd,CAAC,IAAgC,EAAE,EAAE;QACjC,gBAAgB,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC,EACD,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAC9B,CAAC;AACN,CAAC"}

package/esm/next/hooks/legend/useLegendItems.d.ts

@@ -0,0 +1,27 @@
+import { DataViewFacade } from "@gooddata/sdk-ui";
+import { IColorStrategy, IPushpinCategoryLegendItem } from "@gooddata/sdk-ui-vis-commons";
+import { IGeoData } from "../../types/shared.js";
+/**
+ * Creates legend items from geo data for segment-based coloring.
+ *
+ * @remarks
+ * This hook creates category legend items when the visualization uses segment-based
+ * coloring (attribute-based). Each unique segment value gets a legend item with:
+ * - name: Display name of the segment value
+ * - uri: URI of the segment value for identification
+ * - color: Color from the color strategy
+ * - legendIndex: Index for consistent ordering
+ * - isVisible: Visibility state (all visible by default)
+ *
+ * Legend items are used to display the category legend and to filter visible pushpins
+ * by toggling legend items on/off.
+ *
+ * @param dataView - Data view facade for attribute metadata
+ * @param geoData - Transformed geographic data containing segment information
+ * @param colorStrategy - Color strategy to get colors for legend items
+ * @returns Array of category legend items, empty if no segments
+ *
+ * @alpha
+ */
+export declare function useLegendItems(dataView: DataViewFacade | null, geoData: IGeoData | null, colorStrategy: IColorStrategy | null): IPushpinCategoryLegendItem[];
+//# sourceMappingURL=useLegendItems.d.ts.map

package/esm/next/hooks/legend/useLegendItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItems.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItems.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1F,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC1B,QAAQ,EAAE,cAAc,GAAG,IAAI,EAC/B,OAAO,EAAE,QAAQ,GAAG,IAAI,EACxB,aAAa,EAAE,cAAc,GAAG,IAAI,GACrC,0BAA0B,EAAE,CAmC9B"}

package/esm/next/hooks/legend/useLegendItems.js

@@ -0,0 +1,54 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+/**
+ * Creates legend items from geo data for segment-based coloring.
+ *
+ * @remarks
+ * This hook creates category legend items when the visualization uses segment-based
+ * coloring (attribute-based). Each unique segment value gets a legend item with:
+ * - name: Display name of the segment value
+ * - uri: URI of the segment value for identification
+ * - color: Color from the color strategy
+ * - legendIndex: Index for consistent ordering
+ * - isVisible: Visibility state (all visible by default)
+ *
+ * Legend items are used to display the category legend and to filter visible pushpins
+ * by toggling legend items on/off.
+ *
+ * @param dataView - Data view facade for attribute metadata
+ * @param geoData - Transformed geographic data containing segment information
+ * @param colorStrategy - Color strategy to get colors for legend items
+ * @returns Array of category legend items, empty if no segments
+ *
+ * @alpha
+ */
+export function useLegendItems(dataView, geoData, colorStrategy) {
+    return useMemo(() => {
+        if (!dataView || !geoData?.segment || !colorStrategy) {
+            return [];
+        }
+        const { segment } = geoData;
+        // Get unique segment values with their URIs
+        const uniqueSegments = new Map();
+        segment.data.forEach((segmentValue, index) => {
+            const uri = segment.uris?.[index];
+            if (uri && !uniqueSegments.has(uri)) {
+                uniqueSegments.set(uri, {
+                    name: segmentValue,
+                    uri,
+                });
+            }
+        });
+        // Create legend items from unique segments with colors
+        const legendItems = Array.from(uniqueSegments.values()).map(({ name, uri }, index) => ({
+            type: "pushpin",
+            name,
+            uri,
+            color: colorStrategy.getColorByIndex(index),
+            legendIndex: index,
+            isVisible: true,
+        }));
+        return legendItems;
+    }, [dataView, geoData, colorStrategy]);
+}
+//# sourceMappingURL=useLegendItems.js.map

package/esm/next/hooks/legend/useLegendItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItems.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItems.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAOhC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,cAAc,CAC1B,QAA+B,EAC/B,OAAwB,EACxB,aAAoC;IAEpC,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,EAAE,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE5B,4CAA4C;QAC5C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyC,CAAC;QAExE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,YAAoB,EAAE,KAAa,EAAE,EAAE;YACzD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE;oBACpB,IAAI,EAAE,YAAY;oBAClB,GAAG;iBACN,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,uDAAuD;QACvD,MAAM,WAAW,GAAiC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CACrF,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACvB,IAAI,EAAE,SAAS;YACf,IAAI;YACJ,GAAG;YACH,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC;YAC3C,WAAW,EAAE,KAAK;YAClB,SAAS,EAAE,IAAI;SAClB,CAAC,CACL,CAAC;QAEF,OAAO,WAAW,CAAC;IACvB,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;AAC3C,CAAC"}

package/esm/next/hooks/legend/useLegendItemsWithState.d.ts

@@ -0,0 +1,21 @@
+import { IPushpinCategoryLegendItem } from "@gooddata/sdk-ui-vis-commons";
+/**
+ * Hook to merge legend items with their visibility state from context.
+ *
+ * @remarks
+ * This hook takes the base legend items (with colors, names, etc.) and merges
+ * them with the current visibility state from the GeoLegendContext. It returns
+ * updated legend items with the correct `isVisible` property.
+ *
+ * In the old implementation, all items start visible. When you click an item,
+ * it toggles its visibility. The same behavior is replicated here:
+ * - Empty enabledLegendItems array = all items visible (initial state)
+ * - Items in enabledLegendItems array = those items are visible
+ *
+ * @param baseLegendItems - Base legend items from data transformation
+ * @returns Legend items with updated isVisible state
+ *
+ * @alpha
+ */
+export declare function useLegendItemsWithState(baseLegendItems: IPushpinCategoryLegendItem[]): IPushpinCategoryLegendItem[];
+//# sourceMappingURL=useLegendItemsWithState.d.ts.map

package/esm/next/hooks/legend/useLegendItemsWithState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItemsWithState.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItemsWithState.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAI1E;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,uBAAuB,CACnC,eAAe,EAAE,0BAA0B,EAAE,GAC9C,0BAA0B,EAAE,CAsB9B"}

package/esm/next/hooks/legend/useLegendItemsWithState.js

@@ -0,0 +1,42 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+import { useGeoLegend } from "../../context/GeoLegendContext.js";
+/**
+ * Hook to merge legend items with their visibility state from context.
+ *
+ * @remarks
+ * This hook takes the base legend items (with colors, names, etc.) and merges
+ * them with the current visibility state from the GeoLegendContext. It returns
+ * updated legend items with the correct `isVisible` property.
+ *
+ * In the old implementation, all items start visible. When you click an item,
+ * it toggles its visibility. The same behavior is replicated here:
+ * - Empty enabledLegendItems array = all items visible (initial state)
+ * - Items in enabledLegendItems array = those items are visible
+ *
+ * @param baseLegendItems - Base legend items from data transformation
+ * @returns Legend items with updated isVisible state
+ *
+ * @alpha
+ */
+export function useLegendItemsWithState(baseLegendItems) {
+    const { enabledLegendItems } = useGeoLegend();
+    return useMemo(() => {
+        if (!baseLegendItems.length) {
+            return [];
+        }
+        // If no items are explicitly tracked, all are visible (initial state)
+        if (enabledLegendItems.length === 0) {
+            return baseLegendItems.map((item) => ({
+                ...item,
+                isVisible: true,
+            }));
+        }
+        // Otherwise, item is visible if it's in the enabled list
+        return baseLegendItems.map((item) => ({
+            ...item,
+            isVisible: enabledLegendItems.includes(item.uri),
+        }));
+    }, [baseLegendItems, enabledLegendItems]);
+}
+//# sourceMappingURL=useLegendItemsWithState.js.map

package/esm/next/hooks/legend/useLegendItemsWithState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendItemsWithState.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendItemsWithState.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAIhC,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,uBAAuB,CACnC,eAA6C;IAE7C,MAAM,EAAE,kBAAkB,EAAE,GAAG,YAAY,EAAE,CAAC;IAE9C,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACd,CAAC;QAED,sEAAsE;QACtE,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAClC,GAAG,IAAI;gBACP,SAAS,EAAE,IAAI;aAClB,CAAC,CAAC,CAAC;QACR,CAAC;QAED,yDAAyD;QACzD,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClC,GAAG,IAAI;YACP,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;SACnD,CAAC,CAAC,CAAC;IACR,CAAC,EAAE,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAC9C,CAAC"}

package/esm/next/hooks/legend/useLegendProps.d.ts

@@ -0,0 +1,53 @@
+import { IColorStrategy, IPushpinCategoryLegendItem } from "@gooddata/sdk-ui-vis-commons";
+import { IGeoPushpinChartNextConfig } from "../../types/config.js";
+import { IGeoData } from "../../types/shared.js";
+/**
+ * Props for legend renderer components.
+ *
+ * @alpha
+ */
+export interface ILegendProps {
+    /**
+     * Geographic data for rendering color and size legends
+     */
+    geoData: IGeoData | null;
+    /**
+     * Category items for rendering category legend
+     */
+    categoryItems: IPushpinCategoryLegendItem[];
+    /**
+     * Color strategy for legend colors
+     */
+    colorStrategy: IColorStrategy | null;
+    /**
+     * First color from the color strategy (used for color legend)
+     */
+    colorLegendValue: string | null;
+    /**
+     * Format string for measure values
+     */
+    format: string | undefined;
+    /**
+     * Geo configuration
+     */
+    config: IGeoPushpinChartNextConfig | undefined;
+}
+/**
+ * Hook to prepare props for legend components from context.
+ *
+ * @remarks
+ * This hook consolidates data from various contexts and prepares
+ * the props needed by legend renderer components. It extracts:
+ * - Geographic data for color/size legends
+ * - Category items for segment-based legends (with visibility state)
+ * - Color strategy and format information
+ *
+ * @param colorStrategy - Color strategy for the chart
+ * @param config - Geo configuration
+ * @param categoryItems - Category legend items with visibility state
+ * @returns Props for legend components
+ *
+ * @alpha
+ */
+export declare function useLegendProps(colorStrategy: IColorStrategy | null, config: IGeoPushpinChartNextConfig | undefined, categoryItems: IPushpinCategoryLegendItem[]): ILegendProps;
+//# sourceMappingURL=useLegendProps.d.ts.map

package/esm/next/hooks/legend/useLegendProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendProps.d.ts","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendProps.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAG1F,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,0BAA0B,EAAE,CAAC;IAE5C;;OAEG;IACH,aAAa,EAAE,cAAc,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,0BAA0B,GAAG,SAAS,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAC1B,aAAa,EAAE,cAAc,GAAG,IAAI,EACpC,MAAM,EAAE,0BAA0B,GAAG,SAAS,EAC9C,aAAa,EAAE,0BAA0B,EAAE,GAC5C,YAAY,CAmBd"}

package/esm/next/hooks/legend/useLegendProps.js

@@ -0,0 +1,38 @@
+// (C) 2025 GoodData Corporation
+import { useMemo } from "react";
+import { useGeoData } from "../../context/GeoDataContext.js";
+/**
+ * Hook to prepare props for legend components from context.
+ *
+ * @remarks
+ * This hook consolidates data from various contexts and prepares
+ * the props needed by legend renderer components. It extracts:
+ * - Geographic data for color/size legends
+ * - Category items for segment-based legends (with visibility state)
+ * - Color strategy and format information
+ *
+ * @param colorStrategy - Color strategy for the chart
+ * @param config - Geo configuration
+ * @param categoryItems - Category legend items with visibility state
+ * @returns Props for legend components
+ *
+ * @alpha
+ */
+export function useLegendProps(colorStrategy, config, categoryItems) {
+    const { geoData } = useGeoData();
+    return useMemo(() => {
+        const colorFormat = geoData?.color?.format;
+        const sizeFormat = geoData?.size?.format;
+        const format = colorFormat || sizeFormat;
+        const colorLegendValue = colorStrategy ? colorStrategy.getColorByIndex(0) : null;
+        return {
+            geoData,
+            categoryItems,
+            colorStrategy,
+            colorLegendValue,
+            format,
+            config,
+        };
+    }, [geoData, categoryItems, colorStrategy, config]);
+}
+//# sourceMappingURL=useLegendProps.js.map

package/esm/next/hooks/legend/useLegendProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLegendProps.js","sourceRoot":"","sources":["../../../../src/next/hooks/legend/useLegendProps.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAIhC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAyC7D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC1B,aAAoC,EACpC,MAA8C,EAC9C,aAA2C;IAE3C,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,CAAC;IAEjC,OAAO,OAAO,CAAC,GAAG,EAAE;QAChB,MAAM,WAAW,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC;QAC3C,MAAM,UAAU,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC;QACzC,MAAM,MAAM,GAAG,WAAW,IAAI,UAAU,CAAC;QAEzC,MAAM,gBAAgB,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEjF,OAAO;YACH,OAAO;YACP,aAAa;YACb,aAAa;YACb,gBAAgB;YAChB,MAAM;YACN,MAAM;SACT,CAAC;IACN,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;AACxD,CAAC"}