The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import type { SdkEntityId } from "embedding-sdk-bundle/types/entity";
import { DashboardClickAction } from "metabase/dashboard/click-behavior/DashboardClickAction";
import {
getClickBehavior,
getClickBehaviorData,
getDashboardDrillQuestionUrl,
getParameterIdValuePairs,
getParameterValuesBySlug,
} from "metabase/dashboard/click-behavior/dashboard-click-drill";
import type { ParameterIdValuePair } from "metabase/dashboard/click-behavior/types";
import type { ParameterValues } from "metabase/embedding-sdk/types/dashboard";
import { CombineColumnsAction } from "metabase/querying/click-actions/actions/CombineColumnsAction";
import { ExtractColumnAction } from "metabase/querying/click-actions/actions/ExtractColumnAction";
import { NativeQueryClickFallback } from "metabase/querying/click-actions/actions/NativeQueryClickFallback";
import type { QueryClickActionsMode } from "metabase/querying/click-actions/types";
import { HideColumnAction } from "metabase/visualizations/click-actions/actions/HideColumnAction";
import type { ClickObject, LegacyDrill } from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
import type { CardId, DashboardId, DashboardTabId } from "metabase-types/api";
type ParameterizedTarget = {
name: string;
entityId: SdkEntityId;
parameters: ParameterValues;
/**
* Same parameter values as {@link parameters}, but keyed by parameter id.
* Used for same-dashboard click behaviors that need to dispatch per-id
* setParameterValue actions (mirrors core app DashboardClickAction).
*/
parameterIdValuePairs: ParameterIdValuePair[];
};
export type ClickBehaviorTarget =
| (ParameterizedTarget & {
type: "dashboard";
id: DashboardId;
tabId?: DashboardTabId;
})
| (ParameterizedTarget & { type: "question"; id: CardId })
/**
* A non-native target question. The mapped values are already encoded as
* filters in the path, so there are no parameters left to carry.
*/
| { type: "ad-hoc-question"; name: string; adHocQuestionPath: string };
export const getClickBehaviorTarget = (
clicked: ClickObject,
question: Question,
): ClickBehaviorTarget | null => {
const clickBehavior = getClickBehavior(clicked);
if (!clickBehavior) {
return null;
}
const { linkType, targetId, extraData, parameterMapping, data, tabId } =
getClickBehaviorData(clicked, clickBehavior);
if (
(linkType !== "dashboard" && linkType !== "question") ||
targetId == null
) {
return null;
}
const parameters = parameterMapping
? getParameterValuesBySlug(parameterMapping, {
data,
extraData,
clickBehavior,
})
: {};
const parameterIdValuePairs = parameterMapping
? getParameterIdValuePairs(parameterMapping, {
data,
extraData,
clickBehavior,
})
: [];
if (linkType === "dashboard") {
const dashboard = extraData?.dashboards?.[targetId];
if (!dashboard) {
console.warn(
`[SDK Navigation] Could not find dashboard with id ${targetId}`,
);
return null;
}
return {
type: "dashboard",
id: dashboard.id,
entityId: dashboard.entity_id,
name: dashboard.name,
parameters,
parameterIdValuePairs,
tabId,
};
}
const targetCard = extraData?.questions?.[targetId];
if (!targetCard) {
console.warn(
`[SDK Navigation] Could not find question with id ${targetId}`,
);
return null;
}
const targetQuestion = new Question(targetCard, question.metadata());
const isTargetQuestionNative = Lib.queryDisplayInfo(
targetQuestion.query(),
).isNative;
// Only a native question's template tags can consume the mapped values, so a
// non-native target is opened as an ad-hoc, pre-filtered question instead.
if (!isTargetQuestionNative) {
return {
type: "ad-hoc-question",
name: targetCard.name,
adHocQuestionPath: getDashboardDrillQuestionUrl(question, clicked),
};
}
return {
type: "question",
id: targetCard.id,
entityId: targetCard.entity_id,
name: targetCard.name,
parameters,
parameterIdValuePairs,
};
};
type CreateEmbeddingSdkModeOptions = {
pushNavigation?: (target: ClickBehaviorTarget) => void;
};
export const createEmbeddingSdkMode = (
options: CreateEmbeddingSdkModeOptions = {},
): QueryClickActionsMode => {
const { pushNavigation } = options;
const SDKDashboardClickAction: LegacyDrill = ({ question, clicked = {} }) => {
const target = getClickBehaviorTarget(clicked, question);
if (target && pushNavigation) {
return [
{
name: "click_behavior",
defaultAlways: true,
onClick: () => {
pushNavigation(target);
},
},
];
}
// Fall back to default behavior if no navigation handler
return DashboardClickAction({ question, clicked });
};
return {
name: "embedding-sdk",
hasDrills: true,
availableOnlyDrills: [
"drill-thru/column-extract",
"drill-thru/column-filter",
"drill-thru/distribution",
"drill-thru/fk-details",
"drill-thru/fk-filter",
"drill-thru/pivot",
"drill-thru/pk",
"drill-thru/quick-filter",
"drill-thru/sort",
"drill-thru/summarize-column-by-time",
"drill-thru/summarize-column",
"drill-thru/underlying-records",
"drill-thru/zoom-in.binning",
"drill-thru/zoom-in.geographic",
"drill-thru/zoom-in.timeseries",
],
clickActions: [
HideColumnAction,
SDKDashboardClickAction,
ExtractColumnAction,
CombineColumnsAction,
],
fallback: NativeQueryClickFallback,
};
};
// Keep backwards compat export (without navigation)
export const EmbeddingSdkMode = createEmbeddingSdkMode();