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
feat(embed-js): add the Metabot experience to embed wizard (#64388)
Phoomparin Mano9eb0ae770027
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.tsindex cf44f907437..a8d392fb57c 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts@@ -54,7 +54,7 @@ export const assertDashboard = ({ id, name }: { id: number; name: string }) => {type NavigateToStepOptions =| {- experience: "exploration";+ experience: "exploration" | "metabot";resourceName?: never;}| {@@ -71,24 +71,27 @@ export const navigateToEntitySelectionStep = (cy.log("select an experience");- if (experience === "chart") {- cy.findByText("Chart").click();- } else if (experience === "exploration") {- cy.findByText("Exploration").click();- } else if (experience === "browser") {- cy.findByText("Browser").click();+ const hasEntitySelection =+ experience !== "exploration" && experience !== "metabot";++ const labelByExperience = match(experience)+ .with("chart", () => "Chart")+ .with("exploration", () => "Exploration")+ .with("browser", () => "Browser")+ .with("metabot", () => "Metabot")+ .otherwise(() => undefined);++ if (labelByExperience) {+ cy.findByText(labelByExperience).click();}- // exploration template does not have the entity selection step- if (experience !== "exploration") {+ // exploration and metabot experience does not have the entity selection step+ if (hasEntitySelection && options.resourceName) {cy.log("navigate to the entity selection step");+getEmbedSidebar().within(() => {cy.findByText("Next").click(); // Entity selection step});- }-- if (experience !== "exploration") {- const { resourceName } = options;const resourceType = match(experience).with("dashboard", () => "Dashboards")@@ -103,7 +106,7 @@ export const navigateToEntitySelectionStep = (entityPickerModal().within(() => {cy.findByText(resourceType).click();- cy.findAllByText(resourceName).first().click();+ cy.findAllByText(options.resourceName).first().click();// Collection picker requires an explicit confirmation.if (experience === "browser") {@@ -113,7 +116,7 @@ export const navigateToEntitySelectionStep = (cy.log(`${resourceType} title should be visible by default`);getEmbedSidebar().within(() => {- cy.findByText(resourceName).should("be.visible");+ cy.findByText(options.resourceName).should("be.visible");});}};diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.tsindex 461b69a15c2..65f2e3dbd59 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts@@ -219,4 +219,22 @@ H.describeWithSnowplow(suiteTitle, () => {cy.findByTestId("preview-loading-indicator").should("not.exist");});++ it("shows Metabot experience when selected", () => {+ visitNewEmbedPage();++ getEmbedSidebar().within(() => {+ cy.findByText("Metabot").click();+ cy.findByText("Next").click();+ });++ H.expectUnstructuredSnowplowEvent({+ event: "embed_wizard_experience_completed",+ event_detail: "custom=metabot",+ });++ H.getSimpleEmbedIframeContent().within(() => {+ cy.findByText("Ask questions to AI.").should("be.visible");+ });+ });});diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.tsindex 88fe295a6cf..f7ac61a8ebf 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts@@ -486,4 +486,40 @@ H.describeWithSnowplow(suiteTitle, () => {codeBlock().should("contain", '"text-secondary": "rgb(169, 169, 169)"');codeBlock().should("contain", '"brand-hover": "rgba(189, 81, 253, 0.5)"');});++ it("can toggle the Metabot layout from auto to stacked to sidebar", () => {+ navigateToEmbedOptionsStep({ experience: "metabot" });++ getEmbedSidebar().findByLabelText("Auto").should("be.checked");+ getEmbedSidebar().findByLabelText("Stacked").click().should("be.checked");++ H.getSimpleEmbedIframeContent()+ .findByTestId("metabot-question-container")+ .should("have.attr", "data-layout", "stacked");++ getEmbedSidebar().findByText("Get code").click();+ codeBlock().should("contain", 'layout="stacked"');++ H.expectUnstructuredSnowplowEvent({+ event: "embed_wizard_options_completed",+ event_detail:+ "settings=custom,theme=default,auth=user_session,layout=stacked",+ });++ getEmbedSidebar().findByText("Back").click();+ getEmbedSidebar().findByLabelText("Sidebar").click().should("be.checked");++ H.getSimpleEmbedIframeContent()+ .findByTestId("metabot-question-container")+ .should("have.attr", "data-layout", "sidebar");++ getEmbedSidebar().findByText("Get code").click();+ codeBlock().should("contain", 'layout="sidebar"');++ H.expectUnstructuredSnowplowEvent({+ event: "embed_wizard_options_completed",+ event_detail:+ "settings=custom,theme=default,auth=user_session,layout=sidebar",+ });+ });});diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.tsindex 7519948dea5..8ac7f5145e3 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts@@ -2,6 +2,7 @@ import type {BrowserEmbedOptions,DashboardEmbedOptions,ExplorationEmbedOptions,+ MetabotEmbedOptions,QuestionEmbedOptions,SdkIframeEmbedBaseSettings,SdkIframeEmbedSettingKey,@@ -60,6 +61,7 @@ export const ALLOWED_EMBED_SETTING_KEYS_MAP = {"withNewQuestion","withNewDashboard",] satisfies (keyof BrowserEmbedOptions)[],+ metabot: ["layout"] satisfies (keyof MetabotEmbedOptions)[],} as const;// This file is used by embed.js, so we shouldn't import external dependencies.@@ -71,6 +73,7 @@ export const ALLOWED_EMBED_SETTING_KEYS = uniq([...ALLOWED_EMBED_SETTING_KEYS_MAP.chart,...ALLOWED_EMBED_SETTING_KEYS_MAP.exploration,...ALLOWED_EMBED_SETTING_KEYS_MAP.browser,+ ...ALLOWED_EMBED_SETTING_KEYS_MAP.metabot,]) satisfies SdkIframeEmbedSettingKey[];export type AllowedEmbedSettingKey =diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.tsindex 22bea67e178..4e3b08bac06 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts@@ -185,6 +185,7 @@ export type SdkIframeEmbedElementSettings = SdkIframeEmbedBaseSettings &| QuestionEmbedOptions| (Omit<ExplorationEmbedOptions, "questionId"> & { questionId: "new" })| BrowserEmbedOptions+ | MetabotEmbedOptions);export type SdkIframeEmbedEvent = { type: "ready" };@@ -197,4 +198,5 @@ export type SdkIframeEmbedSettingKey =| keyof DashboardEmbedOptions| keyof QuestionEmbedOptions| keyof ExplorationEmbedOptions- | keyof BrowserEmbedOptions;+ | keyof BrowserEmbedOptions+ | keyof MetabotEmbedOptions;diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.tsindex 6ab0a3148d1..9193685eff9 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts@@ -25,6 +25,7 @@ const EMBED_SETTINGS_TO_TRACK: SdkIframeEmbedSettingKey[] = ["withDownloads","isSaveEnabled","readOnly",+ "layout",];/**diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/MetabotLayoutSetting.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/MetabotLayoutSetting.tsxnew file mode 100644index 00000000000..839a765943e--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/MetabotLayoutSetting.tsx@@ -0,0 +1,49 @@+import { t } from "ttag";++import { Group, HoverCard, Icon, Radio, Stack, Text } from "metabase/ui";++import { useSdkIframeEmbedSetupContext } from "../context";++export const MetabotLayoutSetting = () => {+ const { settings, updateSettings } = useSdkIframeEmbedSetupContext();++ if (settings.componentName !== "metabase-metabot") {+ return null;+ }++ return (+ <Stack gap="xs">+ <Group align="center" gap="xs" mb="sm">+ <Text fw="bold">{t`Layout`}</Text>++ <HoverCard position="right-start">+ <HoverCard.Target>+ <Icon name="info" size={14} c="text-medium" cursor="pointer" />+ </HoverCard.Target>++ <HoverCard.Dropdown>+ <Text size="sm" p="md" style={{ width: 300 }}>+ {t`Auto layout adapts to screen sizes. Stacked and sidebar layout uses the same layout on all screen sizes.`}+ </Text>+ </HoverCard.Dropdown>+ </HoverCard>+ </Group>++ <Radio.Group+ value={settings.layout ?? "auto"}+ onChange={(layout) =>+ updateSettings({+ layout:+ layout === "auto" ? undefined : (layout as "stacked" | "sidebar"),+ })+ }+ >+ <Group gap="md">+ <Radio value="auto" label={t`Auto`} />+ <Radio value="stacked" label={t`Stacked`} />+ <Radio value="sidebar" label={t`Sidebar`} />+ </Group>+ </Radio.Group>+ </Stack>+ );+};diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsxindex c227aa6727f..674d5458943 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx@@ -189,8 +189,9 @@ export const SdkIframeEmbedPreview = () => {: undefined,}),)- // TODO(EMB-869): add Metabot experience to embed flow- .with({ componentName: "metabase-metabot" }, () => null)+ .with({ componentName: "metabase-metabot" }, (s) =>+ createElement("metabase-metabot", { layout: s.layout }),+ ).exhaustive()}<EmbedPreviewLoadingOverlaydiff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsxindex 5544af2f361..3a91d214a66 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx@@ -1,10 +1,11 @@import cx from "classnames";-import { match } from "ts-pattern";+import { P, match } from "ts-pattern";import { t } from "ttag";import _ from "underscore";import { useSetting } from "metabase/common/hooks";import CS from "metabase/css/core/index.css";+import { PLUGIN_METABOT } from "metabase/plugins";import { Card, Radio, Stack, Text } from "metabase/ui";import { ALLOWED_EMBED_SETTING_KEYS_MAP } from "metabase-enterprise/embedding_iframe_sdk/constants";@@ -29,6 +30,7 @@ export const SelectEmbedExperienceStep = () => {} = useSdkIframeEmbedSetupContext();const isSimpleEmbeddingEnabled = useSetting("enable-embedding-simple");+ const isMetabotAvailable = PLUGIN_METABOT.isEnabled();const handleEmbedExperienceChange = (experience: SdkIframeEmbedSetupExperience,@@ -46,8 +48,7 @@ export const SelectEmbedExperienceStep = () => {"dashboard",() => recentDashboards[0]?.id ?? EMBED_FALLBACK_DASHBOARD_ID,)- .with("exploration", () => 0) // resource id does not apply- .with("browser", () => 0) // resource id does not apply+ .with(P.union("exploration", "browser", "metabot"), () => 0) // resource id does not apply.exhaustive();replaceSettings({@@ -62,6 +63,8 @@ export const SelectEmbedExperienceStep = () => {});};+ const experiences = getEmbedExperiences({ isMetabotAvailable });+return (<><EnableEmbeddedAnalyticsCard />@@ -85,7 +88,7 @@ export const SelectEmbedExperienceStep = () => {}><Stack gap="md">- {getEmbedExperiences().map((experience) => (+ {experiences.map((experience) => (<Radiokey={experience.value}value={experience.value}diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedOptionsStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedOptionsStep.tsxindex 716acb3cb06..b166a0ebb86 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedOptionsStep.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedOptionsStep.tsx@@ -1,4 +1,5 @@-import { useCallback } from "react";+import { useCallback, useMemo } from "react";+import { P, match } from "ts-pattern";import { t } from "ttag";import type { MetabaseColors } from "metabase/embedding-sdk/theme";@@ -7,48 +8,41 @@ import { Card, Checkbox, Divider, Stack, Text } from "metabase/ui";import { useSdkIframeEmbedSetupContext } from "../context";import { ColorCustomizationSection } from "./ColorCustomizationSection";+import { MetabotLayoutSetting } from "./MetabotLayoutSetting";import { ParameterSettings } from "./ParameterSettings";export const SelectEmbedOptionsStep = () => {- const { experience, settings, updateSettings } =- useSdkIframeEmbedSetupContext();-- const { theme } = settings;-- const isQuestionOrDashboardEmbed =- (experience === "dashboard" && settings.dashboardId) ||- (experience === "chart" && settings.questionId);-- const isBrowserComponent = settings.componentName === "metabase-browser";- const isQuestionComponent = settings.componentName === "metabase-question";-- const updateColors = useCallback(- (nextColors: Partial<MetabaseColors>) => {- updateSettings({- theme: { ...theme, colors: { ...theme?.colors, ...nextColors } },- });- },- [theme, updateSettings],+ return (+ <Stack gap="md">+ <BehaviorSection />+ <ParametersSection />+ <AppearanceSection />+ </Stack>);+};- const isDashboardOrQuestion = settings.dashboardId || settings.questionId;+const BehaviorSection = () => {+ const { settings, updateSettings } = useSdkIframeEmbedSetupContext();- return (- <Stack gap="md">- <Card p="md">- <Text size="lg" fw="bold" mb="md">- {t`Behavior`}- </Text>- <Stack gap="md">- {isQuestionOrDashboardEmbed && (+ const behaviorSection = useMemo(() => {+ return match(settings)+ .with({ template: "exploration" }, (settings) => (+ <Checkbox+ label={t`Allow people to save new questions`}+ checked={settings.isSaveEnabled}+ onChange={(e) => updateSettings({ isSaveEnabled: e.target.checked })}+ />+ ))+ .with(+ { componentName: "metabase-question", questionId: P.nonNullable },+ (settings) => (+ <Stack gap="md"><Checkboxlabel={t`Allow people to drill through on data points`}checked={settings.drills}onChange={(e) => updateSettings({ drills: e.target.checked })}/>- )}- {isDashboardOrQuestion && (<Checkboxlabel={t`Allow downloads`}checked={settings.withDownloads}@@ -56,9 +50,7 @@ export const SelectEmbedOptionsStep = () => {updateSettings({ withDownloads: e.target.checked })}/>- )}- {isQuestionComponent && (<Checkboxlabel={t`Allow people to save new questions`}checked={settings.isSaveEnabled}@@ -66,53 +58,124 @@ export const SelectEmbedOptionsStep = () => {updateSettings({ isSaveEnabled: e.target.checked })}/>- )}+ </Stack>+ ),+ )+ .with(+ { componentName: "metabase-dashboard", dashboardId: P.nonNullable },+ (settings) => (+ <Stack gap="md">+ <Checkbox+ label={t`Allow people to drill through on data points`}+ checked={settings.drills}+ onChange={(e) => updateSettings({ drills: e.target.checked })}+ />- {isBrowserComponent && (<Checkbox- label={t`Allow editing dashboards and questions`}- checked={!settings.readOnly}- onChange={(e) => updateSettings({ readOnly: !e.target.checked })}+ label={t`Allow downloads`}+ checked={settings.withDownloads}+ onChange={(e) =>+ updateSettings({ withDownloads: e.target.checked })+ }/>- )}- </Stack>- </Card>-- {isQuestionOrDashboardEmbed && (- <Card p="md">- <Text size="lg" fw="bold" mb="xs">- {t`Parameters`}- </Text>-- <Text size="sm" c="text-medium" mb="lg">- {experience === "dashboard"- ? t`Set default values and control visibility`- : t`Set default values for parameters`}- </Text>-- <ParameterSettings />- </Card>- )}-- <Card p="md">- <ColorCustomizationSection- theme={theme}- onColorChange={updateColors}- onColorReset={() => updateSettings({ theme: undefined })}+ </Stack>+ ),+ )+ .with({ componentName: "metabase-browser" }, (settings) => (+ <Checkbox+ label={t`Allow editing dashboards and questions`}+ checked={!settings.readOnly}+ onChange={(e) => updateSettings({ readOnly: !e.target.checked })}/>+ ))+ .otherwise(() => null);+ }, [settings, updateSettings]);- {isQuestionOrDashboardEmbed && (- <>- <Divider mt="lg" mb="md" />+ if (behaviorSection === null) {+ return null;+ }- <Checkbox- label={t`Show ${experience} title`}- checked={settings.withTitle}- onChange={(e) => updateSettings({ withTitle: e.target.checked })}- />- </>- )}- </Card>- </Stack>+ return (+ <Card p="md">+ <Text size="lg" fw="bold" mb="md">+ {t`Behavior`}+ </Text>++ {behaviorSection}+ </Card>+ );+};++const ParametersSection = () => {+ const { experience } = useSdkIframeEmbedSetupContext();++ if (experience !== "dashboard" && experience !== "chart") {+ return null;+ }++ return (+ <Card p="md">+ <Text size="lg" fw="bold" mb="xs">+ {t`Parameters`}+ </Text>++ <Text size="sm" c="text-medium" mb="lg">+ {experience === "dashboard"+ ? t`Set default values and control visibility`+ : t`Set default values`}+ </Text>++ <ParameterSettings />+ </Card>+ );+};++const AppearanceSection = () => {+ const { settings, updateSettings } = useSdkIframeEmbedSetupContext();++ const { theme } = settings;++ const updateColors = useCallback(+ (nextColors: Partial<MetabaseColors>) => {+ updateSettings({+ theme: { ...theme, colors: { ...theme?.colors, ...nextColors } },+ });+ },+ [theme, updateSettings],+ );++ const appearanceSection = match(settings)+ .with({ template: "exploration" }, () => null)+ .with({ componentName: "metabase-metabot" }, () => <MetabotLayoutSetting />)+ .with(+ { componentName: P.union("metabase-question", "metabase-dashboard") },+ (settings) => {+ const label = match(settings.componentName)+ .with("metabase-dashboard", () => t`Show dashboard title`)+ .with("metabase-question", () => t`Show chart title`)+ .exhaustive();++ return (+ <Checkbox+ label={label}+ checked={settings.withTitle}+ onChange={(e) => updateSettings({ withTitle: e.target.checked })}+ />+ );+ },+ )+ .otherwise(() => null);++ return (+ <Card p="md">+ <ColorCustomizationSection+ theme={theme}+ onColorChange={updateColors}+ onColorReset={() => updateSettings({ theme: undefined })}+ />++ {appearanceSection && <Divider mt="lg" mb="md" />}+ {appearanceSection}+ </Card>);};diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceRecentItemCard.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceRecentItemCard.tsxindex 385b4fa09ee..f5bc3e77c40 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceRecentItemCard.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceRecentItemCard.tsx@@ -1,7 +1,8 @@-import { match } from "ts-pattern";+import { P, match } from "ts-pattern";import { Card, Group, Icon, type IconName, Stack, Text } from "metabase/ui";+import { STEPS_WITHOUT_RESOURCE_SELECTION } from "../constants";import type {SdkIframeEmbedSetupExperience,SdkIframeEmbedSetupRecentItem,@@ -54,5 +55,5 @@ const getCardIcon = (experience: SdkIframeEmbedSetupExperience): IconName =>.with("chart", () => "bar").with("dashboard", () => "dashboard").with("browser", () => "collection")- .with("exploration", () => "question") // not possible+ .with(P.union(...STEPS_WITHOUT_RESOURCE_SELECTION), () => "question") // these do not require resource selection.exhaustive();diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsxindex c5a0d09ab2c..462e9829903 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx@@ -8,6 +8,7 @@ import { QuestionPickerModal } from "metabase/common/components/Pickers/Questionimport { ActionIcon, Card, Group, Icon, Stack, Text } from "metabase/ui";import type { CollectionId } from "metabase-types/api";+import { STEPS_WITHOUT_RESOURCE_SELECTION } from "../constants";import { useSdkIframeEmbedSetupContext } from "../context";import type {SdkIframeEmbedSetupExperience,@@ -33,8 +34,8 @@ export const SelectEmbedResourceStep = () => {const [isPickerOpen, { open: openPicker, close: closePicker }] =useDisclosure(false);- // Exploration does not allow selecting resources.- if (experience === "exploration") {+ // If a step does not allow resource selection, hide it.+ if (!hasResourceSelectionStep(experience)) {return null;}@@ -252,3 +253,13 @@ const COLLECTION_MODAL_OPTIONS = {showRootCollection: true,hasConfirmButtons: true,} as const;++const hasResourceSelectionStep = (+ experience: SdkIframeEmbedSetupExperience,+): experience is Exclude<+ SdkIframeEmbedSetupExperience,+ (typeof STEPS_WITHOUT_RESOURCE_SELECTION)[number]+> =>+ !(+ STEPS_WITHOUT_RESOURCE_SELECTION as SdkIframeEmbedSetupExperience[]+ ).includes(experience);diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/constants.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/constants.tsindex b54dec9dfd7..9b260fa4c1a 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/constants.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/constants.ts@@ -12,7 +12,11 @@ import type {/** The maximum number of recent items to show in the resource selection step. */export const EMBED_RESOURCE_LIST_MAX_RECENTS = 6;-export const getEmbedExperiences = () =>+export const getEmbedExperiences = ({+ isMetabotAvailable,+}: {+ isMetabotAvailable: boolean;+}) =>[{value: "dashboard",@@ -34,6 +38,15 @@ export const getEmbedExperiences = () =>title: t`Browser`,description: t`Embed a browser to manage dashboards and charts`,},+ ...(isMetabotAvailable+ ? [+ {+ value: "metabot" as const,+ title: t`Metabot`,+ description: t`Embed a Metabot chat interface`,+ },+ ]+ : []),] satisfies {title: string;description: string;@@ -46,6 +59,11 @@ type EmbedStepConfig = {skipFor?: SdkIframeEmbedSetupExperience[];};+export const STEPS_WITHOUT_RESOURCE_SELECTION = [+ "exploration",+ "metabot",+] as const satisfies SdkIframeEmbedSetupExperience[];+export const EMBED_STEPS: EmbedStepConfig[] = [{id: "select-embed-experience",@@ -54,7 +72,7 @@ export const EMBED_STEPS: EmbedStepConfig[] = [{id: "select-embed-resource",component: SelectEmbedResourceStep,- skipFor: ["exploration"],+ skipFor: STEPS_WITHOUT_RESOURCE_SELECTION,},{id: "select-embed-options",diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.tsindex 9a2d5ee8a49..cf3863371d9 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts@@ -12,7 +12,8 @@ export type SdkIframeEmbedSetupExperience =| "dashboard"| "chart"| "exploration"- | "browser";+ | "browser"+ | "metabot";export type SdkIframeEmbedSetupStep =| "select-embed-experience"diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.tsindex ff56d174894..914e0d7c66c 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts@@ -66,6 +66,7 @@ export function getEmbedCustomElementSnippet({.with("chart", () => "metabase-question").with("exploration", () => "metabase-question").with("browser", () => "metabase-browser")+ .with("metabot", () => "metabase-metabot").exhaustive();const settingsWithOverrides = match(experience)@@ -105,7 +106,7 @@ export function getEmbedCustomElementSnippet({ALLOWED_EMBED_SETTING_KEYS_MAP[experience],);- return `<${elementName} ${attributes}></${elementName}>`;+ return `<${elementName}${attributes ? ` ${attributes}` : ""}></${elementName}>`;}// Convert camelCase keys to lower-dash-case for web componentsdiff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.tsindex 377fa8e1cb9..35da6757bef 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts@@ -5,6 +5,7 @@ import type {BrowserEmbedOptions,DashboardEmbedOptions,ExplorationEmbedOptions,+ MetabotEmbedOptions,QuestionEmbedOptions,} from "metabase-enterprise/embedding_iframe_sdk/types/embed";@@ -58,6 +59,12 @@ export const getDefaultSdkIframeEmbedSettings = ({readOnly: true,}),)+ .with(+ "metabot",+ (): MetabotEmbedOptions => ({+ componentName: "metabase-metabot",+ }),+ ).exhaustive();return {@@ -83,6 +90,5 @@ export const getExperienceFromSettings = (.with({ componentName: "metabase-question" }, () => "chart").with({ componentName: "metabase-browser" }, () => "browser").with({ componentName: "metabase-dashboard" }, () => "dashboard")- // TODO(EMB-869): add Metabot experience to embed flow - replace this with "metabot"- .with({ componentName: "metabase-metabot" }, () => "chart")+ .with({ componentName: "metabase-metabot" }, () => "metabot").exhaustive();diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.tsindex 8031bb9aca3..361d03cfb7b 100644--- a/frontend/src/metabase-types/analytics/event.ts+++ b/frontend/src/metabase-types/analytics/event.ts@@ -201,7 +201,8 @@ export type SdkIframeEmbedSetupExperience =| "dashboard"| "chart"| "exploration"- | "browser";+ | "browser"+ | "metabot";export type EmbedWizardOpenedEvent = ValidateEvent<{event: "embed_wizard_opened";