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 FC, type JSX, type PropsWithChildren, useMemo } from "react";
import { useTrackSdkComponentMount } from "embedding-sdk-bundle/analytics/component-events";
import { FlexibleSizeComponent } from "embedding-sdk-bundle/components/private/FlexibleSizeComponent";
import { withPublicComponentWrapper } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import { RenderIfHasContent } from "embedding-sdk-bundle/components/private/RenderIfHasContent/RenderIfHasContent";
import {
Breakout,
BreakoutDropdown,
ChartTypeDropdown,
ChartTypeSelector,
DownloadWidget,
DownloadWidgetDropdown,
Filter,
FilterDropdown,
QuestionResetButton,
QuestionSettings,
QuestionSettingsDropdown,
QuestionVisualization,
RefreshButton,
SqlParametersList,
Summarize,
SummarizeDropdown,
Title,
} from "embedding-sdk-bundle/components/private/SdkQuestion/components";
import { ResultToolbar } from "embedding-sdk-bundle/components/private/SdkQuestion/components/ResultToolbar/ResultToolbar";
import { DefaultViewTitle } from "embedding-sdk-bundle/components/private/SdkQuestionDefaultView/DefaultViewTitle";
import InteractiveQuestionS from "embedding-sdk-bundle/components/private/SdkQuestionDefaultView/SdkQuestionDefaultView.module.css";
import {
SdkQuestion,
type SdkQuestionProps,
} from "embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion";
import { QuestionAlertsButton } from "embedding-sdk-bundle/components/public/notifications/QuestionAlertsButton";
import { useMobileLayout } from "embedding-sdk-bundle/hooks/private/use-mobile-layout";
import { useNormalizeGuestEmbedQuestionOrDashboardComponentProps } from "embedding-sdk-bundle/hooks/private/use-normalize-guest-embed-question-or-dashboard-component-props";
import { EmbeddingSdkStaticMode } from "embedding-sdk-bundle/lib/modes/EmbeddingSdkStaticMode";
import { getEmbeddingMode } from "embedding-sdk-bundle/lib/modes/getEmbeddingMode";
import { resolveDeserializedCard } from "embedding-sdk-bundle/lib/sdk-question/resolve-deserialized-card";
import { useSdkSelector } from "embedding-sdk-bundle/store";
import { getIsGuestEmbed } from "embedding-sdk-bundle/store/selectors";
import type {
SdkQuestionEntityInternalProps,
SdkQuestionEntityPublicProps,
} from "embedding-sdk-bundle/types/question";
import { Box, Group, Stack } from "metabase/ui";
import { staticQuestionSchema } from "./StaticQuestion.schema";
const staticClickActionMode = getEmbeddingMode({
queryMode: EmbeddingSdkStaticMode,
});
type StaticQuestionBaseProps = PropsWithChildren<
Pick<
SdkQuestionProps,
| "withChartTypeSelector"
| "height"
| "width"
| "className"
| "style"
| "initialSqlParameters"
| "sqlParameters"
| "onSqlParametersChange"
| "hiddenParameters"
| "withDownloads"
| "withAlerts"
| "title"
>
>;
/**
* @interface
* @expand
* @category StaticQuestion
*/
export type StaticQuestionProps = StaticQuestionBaseProps &
SdkQuestionEntityPublicProps;
/**
* Internal type that includes the `query` prop used by the `useMetabot` hook.
* Not re-exported from the public SDK package entry point.
*/
export type StaticQuestionInternalProps = StaticQuestionBaseProps &
SdkQuestionEntityInternalProps;
/**
* @interface
*/
export type StaticQuestionComponents = {
Filter: typeof Filter;
FilterDropdown: typeof FilterDropdown;
ResetButton: typeof QuestionResetButton;
RefreshButton: typeof RefreshButton;
Title: typeof Title;
Summarize: typeof Summarize;
SummarizeDropdown: typeof SummarizeDropdown;
QuestionVisualization: typeof QuestionVisualization;
ChartTypeSelector: typeof ChartTypeSelector;
ChartTypeDropdown: typeof ChartTypeDropdown;
QuestionSettings: typeof QuestionSettings;
QuestionSettingsDropdown: typeof QuestionSettingsDropdown;
Breakout: typeof Breakout;
BreakoutDropdown: typeof BreakoutDropdown;
DownloadWidget: typeof DownloadWidget;
DownloadWidgetDropdown: typeof DownloadWidgetDropdown;
AlertsButton: typeof QuestionAlertsButton;
SqlParametersList: typeof SqlParametersList;
};
const StaticQuestionInner = (
props: StaticQuestionInternalProps,
): JSX.Element | null => {
const query = props.query;
const card = props.card;
// Normalize props for Guest Embed usage (e.g. enforce withDownloads in OSS).
const normalizedProps =
useNormalizeGuestEmbedQuestionOrDashboardComponentProps(
// Unjustified type cast. FIXME
props as StaticQuestionProps,
);
const {
questionId,
token,
withChartTypeSelector,
height,
width,
className,
style,
initialSqlParameters,
sqlParameters,
onSqlParametersChange,
hiddenParameters,
withDownloads,
withAlerts,
title = false, // Hidden by default for backwards-compatibility.
children,
} = normalizedProps;
const isNewQuestion = questionId === "new" || questionId === "new-native";
const trackingEntityId = questionId != null ? questionId : null;
useTrackSdkComponentMount(
"StaticQuestion",
trackingEntityId,
isNewQuestion
? {
id_new: questionId === "new",
id_new_native: questionId === "new-native",
with_title: title !== false,
with_downloads: withDownloads,
with_alerts: withAlerts,
}
: {
with_title: title !== false,
with_downloads: withDownloads,
with_alerts: withAlerts,
},
);
const deserializedCard = useMemo(
() => resolveDeserializedCard({ card, query }),
[card, query],
);
const isGuestEmbed = useSdkSelector(getIsGuestEmbed);
const { ref: containerRef, isMobile } = useMobileLayout();
return (
<SdkQuestion
questionId={questionId}
token={token}
deserializedCard={deserializedCard}
clickActionMode={staticClickActionMode}
navigateToNewCard={null}
initialSqlParameters={initialSqlParameters}
sqlParameters={sqlParameters}
onSqlParametersChange={onSqlParametersChange}
hiddenParameters={hiddenParameters}
withDownloads={withDownloads}
withAlerts={withAlerts}
>
{children ?? (
<FlexibleSizeComponent
ref={containerRef}
className={className}
width={width}
height={height}
style={style}
>
<Stack
className={InteractiveQuestionS.Container}
w="100%"
h="100%"
gap="xxs"
>
<RenderIfHasContent
component={Stack}
className={InteractiveQuestionS.TopBar}
gap="sm"
p="lg"
data-testid="static-question-top-bar"
>
{title && <DefaultViewTitle title={title} />}
<RenderIfHasContent
component={ResultToolbar}
data-testid="result-toolbar"
>
{withChartTypeSelector && <SdkQuestion.ChartTypeDropdown />}
<RenderIfHasContent component={Group} gap="sm" ml="auto">
<SdkQuestion.DownloadWidgetDropdown />
{!isMobile && <QuestionAlertsButton />}
</RenderIfHasContent>
</RenderIfHasContent>
{isGuestEmbed && <SdkQuestion.SqlParametersList />}
</RenderIfHasContent>
<Box className={InteractiveQuestionS.Main} w="100%" h="100%">
<Box className={InteractiveQuestionS.Content}>
<SdkQuestion.QuestionVisualization
height={height}
width={width}
className={className}
style={style}
/>
</Box>
</Box>
</Stack>
</FlexibleSizeComponent>
)}
</SdkQuestion>
);
};
const subComponents: StaticQuestionComponents = {
Filter: Filter,
FilterDropdown: FilterDropdown,
ResetButton: QuestionResetButton,
RefreshButton: RefreshButton,
Title: Title,
Summarize: Summarize,
SummarizeDropdown: SummarizeDropdown,
QuestionVisualization: QuestionVisualization,
ChartTypeSelector: ChartTypeSelector,
ChartTypeDropdown: ChartTypeDropdown,
QuestionSettings: QuestionSettings,
QuestionSettingsDropdown: QuestionSettingsDropdown,
Breakout: Breakout,
BreakoutDropdown: BreakoutDropdown,
DownloadWidget: DownloadWidget,
DownloadWidgetDropdown: DownloadWidgetDropdown,
AlertsButton: QuestionAlertsButton,
SqlParametersList: SqlParametersList,
};
const _StaticQuestionWrapped = withPublicComponentWrapper(StaticQuestionInner, {
supportsGuestEmbed: true,
});
export const StaticQuestion = Object.assign(
// Unjustified type cast. FIXME
_StaticQuestionWrapped as FC<StaticQuestionProps>,
subComponents,
{ schema: staticQuestionSchema },
);
/**
* Same runtime component as {@link StaticQuestion}, typed to accept the
* internal `query` prop. This component is intended for internal use only.
*/
export const StaticQuestionInternal = Object.assign(
// Unjustified type cast. FIXME
_StaticQuestionWrapped as FC<StaticQuestionInternalProps>,
subComponents,
{ schema: staticQuestionSchema },
);