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(sdk): add isHostAppInDevMode (#69450)
Nicolò Prettob9e6c5bc0612
diff --git a/enterprise/frontend/src/embedding-sdk-package/bin/generate-nextjs-compat.ts b/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.tssimilarity index 72%rename from enterprise/frontend/src/embedding-sdk-package/bin/generate-nextjs-compat.tsrename to enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.tsindex 993d0ecda19..1fb1e1d148a 100644--- a/enterprise/frontend/src/embedding-sdk-package/bin/generate-nextjs-compat.ts+++ b/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts@@ -34,6 +34,23 @@ export * from "./main.bundle.js";writeToFile("nextjs.cjs", nextjs_cjs);writeToFile("nextjs.js", nextjs_js);+// Development mode entry point.+// When the host app bundler resolves the "development" exports condition,+// this file sets a window global so the SDK bundle can detect dev mode.+const devMode_js = `+try {+ if (typeof window !== "undefined") {+ window.METABASE_EMBEDDING_SDK_IS_HOST_APP_IN_DEV_MODE = true;+ }+} catch (e) {+ console.warn("Metabase SDK: Failed to set dev mode flag", e);+}++module.exports = require("./main.bundle");+`.trim();++writeToFile("main.development.js", devMode_js);+writeToFile("nextjs.d.ts",`diff --git a/enterprise/frontend/src/embedding-sdk-package/package.template.json b/enterprise/frontend/src/embedding-sdk-package/package.template.jsonindex 386a0e4bccf..3dde296837a 100644--- a/enterprise/frontend/src/embedding-sdk-package/package.template.json+++ b/enterprise/frontend/src/embedding-sdk-package/package.template.json@@ -11,6 +11,7 @@"exports": {".": {"types": "./dist/index.d.ts",+ "development": "./dist/main.development.js","default": "./dist/main.bundle.js"},"./nextjs": {diff --git a/frontend/src/embedding-sdk-shared/lib/is-host-app-in-dev-mode.ts b/frontend/src/embedding-sdk-shared/lib/is-host-app-in-dev-mode.tsnew file mode 100644index 00000000000..572cfd89e9b--- /dev/null+++ b/frontend/src/embedding-sdk-shared/lib/is-host-app-in-dev-mode.ts@@ -0,0 +1,16 @@+import { getWindow } from "embedding-sdk-shared/lib/get-window";++/**+ * Returns true if the host application's bundler resolved the SDK package+ * using the "development" exports condition, indicating dev mode.+ *+ * This is set by the SDK package's development entry point and read+ * by the SDK bundle at runtime.+ */+export function isHostAppInDevMode(): boolean {+ try {+ return getWindow()?.METABASE_EMBEDDING_SDK_IS_HOST_APP_IN_DEV_MODE === true;+ } catch (e) {+ return false;+ }+}diff --git a/frontend/src/embedding-sdk-shared/types/globals.d.ts b/frontend/src/embedding-sdk-shared/types/globals.d.tsindex af642b6620d..4c8d6a22b35 100644--- a/frontend/src/embedding-sdk-shared/types/globals.d.ts+++ b/frontend/src/embedding-sdk-shared/types/globals.d.ts@@ -10,4 +10,5 @@ interface Window {METABASE_PROVIDER_PROPS_STORE?: import("embedding-sdk-shared/lib/ensure-metabase-provider-props-store").MetabaseProviderPropsStore;METABASE_EMBEDDING_SDK_PACKAGE_BUILD_INFO?: import("metabase/embedding-sdk/types/build-info").BuildInfo;METABASE_EMBEDDING_SDK_BUNDLE_BUILD_INFO?: import("metabase/embedding-sdk/types/build-info").BuildInfo;+ METABASE_EMBEDDING_SDK_IS_HOST_APP_IN_DEV_MODE?: boolean; // Added in v59}diff --git a/package.json b/package.jsonindex d1d849bdaad..e0a6a53bd23 100644--- a/package.json+++ b/package.json@@ -446,7 +446,7 @@"scripts": {"mage": "./bin/mage","build": "bun run build:cljs && bun run build:js",- "build-embedding-sdk-package": "bun run embedding-sdk:clean:dist && bun install && bun run build-release:cljs && bun run embedding-sdk:generate-package && bun run embedding-sdk:generate-nextjs-compat && bun run build-release:embedding-sdk-package && bun run build-embedding-sdk-cli && bun run embedding-sdk:dts:generate",+ "build-embedding-sdk-package": "bun run embedding-sdk:clean:dist && bun install && bun run build-release:cljs && bun run embedding-sdk:generate-package && bun run embedding-sdk:generate-package-support-files && bun run build-release:embedding-sdk-package && bun run build-embedding-sdk-cli && bun run embedding-sdk:dts:generate","build-embedding-sdk-cli": "rspack --config rspack.embedding-sdk-cli.config.js","build-embedding-sdk-cli:watch": "bun run build-embedding-sdk-cli --watch","build-hot": "rm -f target/cljs_dev/cljs.core.js && bun run build:cljs && bun run concurrently -n 'js' -c 'green,cyan' 'bun run build-hot:js'",@@ -492,7 +492,7 @@"dev-ee-hot-be": "bun install && bun run clean-dev:cljs && concurrently -n 'backend,frontend,cljs,static-viz' -c 'blue,green,yellow,magenta,red,cyan' 'clojure -M:run:ee:dev:dev-start --hot' 'MB_EDITION=ee ENABLE_CLJS_HOT_RELOAD=true bun run build-hot:js-wait' 'MB_EDITION=ee bun run build-hot:cljs' 'bun run build-static-viz:watch-wait'","embedding-sdk:generate-package": "node ./bin/embedding-sdk/generate-sdk-package-files.js","embedding-sdk:publish": "cd ./resources/embedding-sdk && npm publish",- "embedding-sdk:generate-nextjs-compat": "tsx enterprise/frontend/src/embedding-sdk-package/bin/generate-nextjs-compat.ts",+ "embedding-sdk:generate-package-support-files": "tsx enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts","embedding-sdk:test-unit": "bun run test-unit enterprise/frontend/src/embedding-sdk-package/ enterprise/frontend/src/embedding-sdk-bundle/ enterprise/frontend/src/embedding-sdk-shared/","embedding-sdk:dts:generate": "bun run embedding-sdk:clean:tsbuildinfo && bun run tsc --project tsconfig.sdk.json || true && bun run embedding-sdk:dts:fixup","embedding-sdk:dts:fixup": "node ./bin/embedding-sdk/fixup-types-after-compilation.js",@@ -503,7 +503,7 @@"embedding-sdk:clean:dist": "rm -rf resources/embedding-sdk/dist","embedding-sdk:clean:tsbuildinfo": "rm -rf resources/embedding-sdk/.tsbuildinfo","embedding-sdk:dev": "EMBEDDING_SDK_BUNDLE_HOST=http://localhost:3100 concurrently -n 'serve-resources,tsc,webpack,fix-types' -c 'red,blue,green,yellow' 'bun run serve-resources' 'npm:embedding-sdk:dev:dts' 'npm:embedding-sdk:dev:webpack' 'npm:embedding-sdk:dev:fixup'",- "embedding-sdk:dev:webpack": "bun run embedding-sdk:generate-package && bun run embedding-sdk:generate-nextjs-compat && WEBPACK_BUNDLE=development concurrently -n 'embedding-sdk-package,embedding-sdk-bundle' 'rspack --config rspack.embedding-sdk-package.config.js --watch' 'rspack --config rspack.embedding-sdk-bundle.config.js --watch'",+ "embedding-sdk:dev:webpack": "bun run embedding-sdk:generate-package && bun run embedding-sdk:generate-package-support-files && WEBPACK_BUNDLE=development concurrently -n 'embedding-sdk-package,embedding-sdk-bundle' 'rspack --config rspack.embedding-sdk-package.config.js --watch' 'rspack --config rspack.embedding-sdk-bundle.config.js --watch'","embedding-sdk:dev:dts": "tsc --project tsconfig.sdk.json --watch --preserveWatchOutput","embedding-sdk:dev:fixup": "bun run embedding-sdk:dts:fixup --watch","eslint-fix": "bun run lint-eslint --fix",