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 { JSX, ReactNode } from "react";
import { withPublicComponentWrapper } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import { SdkInternalNavigationProvider } from "embedding-sdk-bundle/components/private/SdkInternalNavigation/SdkInternalNavigationProvider";
import {
BackButton,
Breakout,
BreakoutDropdown,
ChartTypeDropdown,
ChartTypeSelector,
DownloadWidget,
DownloadWidgetDropdown,
Editor,
EditorButton,
Filter,
FilterDropdown,
QuestionResetButton,
QuestionSettings,
QuestionSettingsDropdown,
QuestionVisualization,
RefreshButton,
SaveButton,
SdkSaveQuestionForm,
SqlParametersList,
Summarize,
SummarizeDropdown,
Title,
VisualizationButton,
} from "embedding-sdk-bundle/components/private/SdkQuestion/components";
import {
SdkQuestionProvider,
type SdkQuestionProviderProps,
} from "embedding-sdk-bundle/components/private/SdkQuestion/context";
import {
SdkQuestionDefaultView,
type SdkQuestionDefaultViewProps,
} from "embedding-sdk-bundle/components/private/SdkQuestionDefaultView";
import { QuestionAlertsButton } from "../notifications/QuestionAlertsButton";
import type { SdkQuestionIdProps } from "./types";
/**
* @interface
* @expand
*/
export type BaseSdkQuestionProps = SdkQuestionIdProps & {
/**
* The children of the component
*/
children?: ReactNode;
plugins?: SdkQuestionProviderProps["componentPlugins"];
} & Pick<
SdkQuestionProviderProps,
| "onBeforeSave"
| "onSave"
| "entityTypes"
| "dataPicker"
| "isSaveEnabled"
| "initialSqlParameters"
| "withDownloads"
| "withAlerts"
| "targetCollection"
| "initialCollection"
| "onRun"
>;
/**
* Props for the drill-through question
*
* @interface
* @expand
* @category InteractiveQuestion
*/
export type DrillThroughQuestionProps = Omit<
BaseSdkQuestionProps,
"questionId" | "initialSqlParameters"
> &
SdkQuestionDefaultViewProps & {
/**
* Initial values for SQL parameters, slug-keyed, applied to every SQL question that opens from the dashboard.
*
* To control a SQL question opened by a click behavior, use the dashboard's `navigatedEntityParameters` and `onNavigatedEntityParametersChange`.
*/
initialSqlParameters?: BaseSdkQuestionProps["initialSqlParameters"];
};
/**
* @interface
* @expand
* @category InteractiveQuestion
*/
export type SdkQuestionProps = SdkQuestionDefaultViewProps &
// TEMP: initialVisualization is disabled at the public boundary. The internal
// plumbing (provider, use-load-question, run-question-query) is kept; re-enable
// by removing it from this Omit and restoring the prop forwarding below.
Omit<
SdkQuestionProviderProps,
"componentPlugins" | "initialVisualization"
> & {
plugins?: SdkQuestionProviderProps["componentPlugins"];
};
/**
* @interface
*/
export type SdkQuestionComponents = {
BackButton: typeof BackButton;
Filter: typeof Filter;
FilterDropdown: typeof FilterDropdown;
ResetButton: typeof QuestionResetButton;
RefreshButton: typeof RefreshButton;
Title: typeof Title;
Summarize: typeof Summarize;
SummarizeDropdown: typeof SummarizeDropdown;
/** @deprecated Use `InteractiveQuestion.Editor` instead */
Notebook: typeof Editor;
Editor: typeof Editor;
/** @deprecated Use `InteractiveQuestion.EditorButton` instead */
NotebookButton: typeof EditorButton;
EditorButton: typeof EditorButton;
QuestionVisualization: typeof QuestionVisualization;
VisualizationButton: typeof VisualizationButton;
SaveQuestionForm: typeof SdkSaveQuestionForm;
SaveButton: typeof SaveButton;
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;
};
export const _SdkQuestion = ({
questionId,
token,
options,
deserializedCard,
plugins,
onNavigateBack,
children = null,
onBeforeSave,
onSave,
onRun,
isSaveEnabled = true,
entityTypes,
dataPicker,
targetCollection,
initialCollection,
initialSqlParameters,
sqlParameters,
onSqlParametersChange,
hiddenParameters,
withDownloads = false,
withAlerts = false,
targetDashboardId,
backToDashboard,
clickActionMode,
navigateToNewCard,
onDrillThrough,
navigatedEntity,
height,
width,
className,
style,
title,
withChartTypeSelector = true,
withEditorButton = true,
onVisualizationChange,
}: SdkQuestionProps): JSX.Element | null => {
const drillThroughQuestionProps: DrillThroughQuestionProps = {
height,
width,
className,
style,
title,
withChartTypeSelector,
withEditorButton,
isSaveEnabled,
targetCollection,
initialCollection,
entityTypes,
onBeforeSave,
onSave,
onRun,
withDownloads,
withAlerts,
plugins,
};
return (
<SdkInternalNavigationProvider
renderDrillThroughQuestion={() => <SdkQuestionDefaultView />}
drillThroughQuestionProps={drillThroughQuestionProps}
style={style}
className={className}
>
<SdkQuestionProvider
questionId={questionId}
token={token}
options={options}
deserializedCard={deserializedCard}
componentPlugins={plugins}
onNavigateBack={onNavigateBack}
onBeforeSave={onBeforeSave}
onSave={onSave}
onRun={onRun}
isSaveEnabled={isSaveEnabled}
entityTypes={entityTypes}
dataPicker={dataPicker}
targetCollection={targetCollection}
initialCollection={initialCollection}
initialSqlParameters={initialSqlParameters}
sqlParameters={sqlParameters}
onSqlParametersChange={onSqlParametersChange}
hiddenParameters={hiddenParameters}
withDownloads={withDownloads}
withAlerts={withAlerts}
targetDashboardId={targetDashboardId}
backToDashboard={backToDashboard}
clickActionMode={clickActionMode}
navigateToNewCard={navigateToNewCard}
onDrillThrough={onDrillThrough}
navigatedEntity={navigatedEntity}
onVisualizationChange={onVisualizationChange}
>
{children ?? (
<SdkQuestionDefaultView
height={height}
width={width}
className={className}
style={style}
title={title}
withChartTypeSelector={withChartTypeSelector}
withEditorButton={withEditorButton}
/>
)}
</SdkQuestionProvider>
</SdkInternalNavigationProvider>
);
};
const subComponents: SdkQuestionComponents = {
BackButton: BackButton,
Filter: Filter,
FilterDropdown: FilterDropdown,
ResetButton: QuestionResetButton,
RefreshButton: RefreshButton,
Title: Title,
Summarize: Summarize,
SummarizeDropdown: SummarizeDropdown,
Notebook: Editor,
Editor: Editor,
NotebookButton: EditorButton,
EditorButton: EditorButton,
QuestionVisualization: QuestionVisualization,
SaveQuestionForm: SdkSaveQuestionForm,
SaveButton: SaveButton,
ChartTypeSelector: ChartTypeSelector,
QuestionSettings: QuestionSettings,
QuestionSettingsDropdown: QuestionSettingsDropdown,
BreakoutDropdown: BreakoutDropdown,
Breakout: Breakout,
ChartTypeDropdown: ChartTypeDropdown,
DownloadWidget: DownloadWidget,
DownloadWidgetDropdown: DownloadWidgetDropdown,
AlertsButton: QuestionAlertsButton,
VisualizationButton: VisualizationButton,
SqlParametersList: SqlParametersList,
};
export const SdkQuestion = Object.assign(
withPublicComponentWrapper(_SdkQuestion, {
supportsGuestEmbed: true,
}),
subComponents,
);