Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

chore: Convert the store factory and whitelabel color bootstrap to TypeScript (#78618)

Andrei Chernykhaf747a5b3693
diff --git a/enterprise/frontend/src/metabase-enterprise/whitelabel/lib/whitelabel.js b/enterprise/frontend/src/metabase-enterprise/whitelabel/lib/whitelabel.ts
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/whitelabel/lib/whitelabel.js
rename to enterprise/frontend/src/metabase-enterprise/whitelabel/lib/whitelabel.ts
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index ba2d2ef0c93..0017b0ffb2e 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -326,7 +326,7 @@ const elements = [
createElement({
type: "shared",
name: "redux-store",
- pattern: "frontend/src/metabase/store.js",
+ pattern: "frontend/src/metabase/store.ts",
mode: "full",
}),
];
diff --git a/frontend/src/metabase/store.js b/frontend/src/metabase/store.js
deleted file mode 100644
index b3e673d9547..00000000000
--- a/frontend/src/metabase/store.js
+++ /dev/null
@@ -1,32 +0,0 @@
-import { combineReducers, configureStore } from "@reduxjs/toolkit";
-
-import { Api } from "metabase/api";
-import { PLUGIN_REDUX_MIDDLEWARES } from "metabase/plugins";
-import { routerMiddleware } from "metabase/router";
-
-export function getStore(
- reducers,
- history,
- initialState,
- extraMiddlewares = [],
-) {
- const reducer = combineReducers({
- ...reducers,
- [Api.reducerPath]: Api.reducer,
- });
-
- return configureStore({
- reducer,
- preloadedState: initialState,
- middleware: (getDefaultMiddleware) =>
- getDefaultMiddleware({
- immutableCheck: false,
- serializableCheck: false,
- }).concat([
- Api.middleware,
- ...(history ? [routerMiddleware(history)] : []),
- ...PLUGIN_REDUX_MIDDLEWARES,
- ...extraMiddlewares,
- ]),
- });
-}
diff --git a/frontend/src/metabase/store.ts b/frontend/src/metabase/store.ts
new file mode 100644
index 00000000000..cf36ab509ea
--- /dev/null
+++ b/frontend/src/metabase/store.ts
@@ -0,0 +1,45 @@
+import {
+ type Middleware,
+ type Reducer,
+ combineReducers,
+ configureStore,
+} from "@reduxjs/toolkit";
+
+import { Api } from "metabase/api";
+import { PLUGIN_REDUX_MIDDLEWARES } from "metabase/plugins";
+import type { State } from "metabase/redux/store";
+import { type RouterNavigator, routerMiddleware } from "metabase/router";
+
+// Each app passes its own reducer map, so per-slice types can't be known here.
+type AnySliceReducer = Reducer<any, any>;
+
+export function getStore(
+ reducers: Record<string, AnySliceReducer>,
+ navigator?: RouterNavigator | null,
+ initialState?: Partial<State> | Record<string, unknown>,
+ extraMiddlewares: Middleware[] = [],
+) {
+ // The slice map is dynamic (each app passes its own), so the combined state
+ // is typed as a plain record rather than one app's State.
+ const reducerMap: Record<string, AnySliceReducer> = {
+ ...reducers,
+ [Api.reducerPath]: Api.reducer,
+ };
+
+ const middlewares: Middleware[] = [
+ Api.middleware,
+ ...(navigator ? [routerMiddleware(navigator)] : []),
+ ...PLUGIN_REDUX_MIDDLEWARES,
+ ...extraMiddlewares,
+ ];
+
+ return configureStore({
+ reducer: combineReducers(reducerMap),
+ preloadedState: initialState,
+ middleware: (getDefaultMiddleware) =>
+ getDefaultMiddleware({
+ immutableCheck: false,
+ serializableCheck: false,
+ }).concat(middlewares),
+ });
+}
diff --git a/frontend/src/metabase/utils/settings.ts b/frontend/src/metabase/utils/settings.ts
index 0debdb1ba7c..7288ff1f256 100644
--- a/frontend/src/metabase/utils/settings.ts
+++ b/frontend/src/metabase/utils/settings.ts
@@ -2,6 +2,8 @@ import _ from "underscore";
import type {
ColorSettings,
+ EnterpriseSettingKey,
+ EnterpriseSettings,
PasswordComplexity,
SettingKey,
Settings,
@@ -10,24 +12,24 @@ import type {
type SettingListener = (value: any) => void;
class MetabaseSettings {
- _settings: Partial<Settings>;
+ _settings: Partial<EnterpriseSettings>;
_listeners: Partial<{ [key: string]: SettingListener[] }> = {};
- constructor(settings: Partial<Settings> = {}) {
+ constructor(settings: Partial<EnterpriseSettings> = {}) {
this._settings = settings;
}
/**
* @deprecated use getSetting(state, key)
*/
- get<T extends SettingKey>(key: T): Partial<Settings>[T] {
+ get<T extends EnterpriseSettingKey>(key: T): Partial<EnterpriseSettings>[T] {
return this._settings[key];
}
/**
* @deprecated set setting values in the redux store
*/
- set<T extends SettingKey>(key: T, value: Settings[T]) {
+ set<T extends EnterpriseSettingKey>(key: T, value: EnterpriseSettings[T]) {
if (this._settings[key] !== value) {
this._settings[key] = value;
const listeners = this._listeners[key];
@@ -57,7 +59,7 @@ class MetabaseSettings {
/**
* @deprecated call appropriate actions when modifying the setting
*/
- on(key: SettingKey, callback: SettingListener) {
+ on(key: EnterpriseSettingKey, callback: SettingListener) {
this._listeners[key] = this._listeners[key] || [];
this._listeners[key].push(callback);
}
@@ -65,7 +67,7 @@ class MetabaseSettings {
/**
* @deprecated remove an event listener
*/
- off(key: SettingKey, callback: SettingListener) {
+ off(key: EnterpriseSettingKey, callback: SettingListener) {
this._listeners[key] =
this._listeners[key]?.filter((c) => c !== callback) || [];
}
@@ -210,9 +212,8 @@ class MetabaseSettings {
*
* Only use this when Redux store is not always available, e.g. in ThemeProvider
*/
- applicationColors(): ColorSettings {
- // Unjustified type cast. FIXME
- return this.get("application-colors" as SettingKey) as ColorSettings;
+ applicationColors(): ColorSettings | undefined {
+ return this.get("application-colors") ?? undefined;
}
}