Skip to content

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

Dissolve the lib-tier type cycle between metabase-types, metabase-lib, and utils (#80053)

Romeo Van Snick234c695a2550
diff --git a/frontend/src/embedding-sdk-bundle/types/ui.ts b/frontend/src/embedding-sdk-bundle/types/ui.ts
index f5acb41a160..7b34a1936e0 100644
--- a/frontend/src/embedding-sdk-bundle/types/ui.ts
+++ b/frontend/src/embedding-sdk-bundle/types/ui.ts
@@ -39,7 +39,7 @@ export type InitializationStatus =
| InitializationStatusError;
export type { ButtonProps } from "metabase/ui";
-export type { MetabaseFontFamily } from "metabase/utils/fonts";
+export type { MetabaseFontFamily } from "metabase-types/api";
export type {
ChartColor,
MetabaseTheme,
diff --git a/frontend/src/metabase-lib/query/types.ts b/frontend/src/metabase-lib/query/types.ts
index 32df24dcdb6..2368a75858f 100644
--- a/frontend/src/metabase-lib/query/types.ts
+++ b/frontend/src/metabase-lib/query/types.ts
@@ -6,6 +6,7 @@ import type {
DatetimeUnit,
FieldId,
FieldValuesType,
+ JoinConditionOperator,
RowValue,
SchemaId,
TableId,
@@ -108,7 +109,7 @@ export type JoinStrategy = unknown & { _opaque: typeof JoinStrategySymbol };
declare const JoinConditionSymbol: unique symbol;
export type JoinCondition = unknown & { _opaque: typeof JoinConditionSymbol };
-export type JoinConditionOperator = "=" | "!=" | ">" | "<" | ">=" | "<=";
+export type { JoinConditionOperator } from "metabase-types/api/query";
export type Clause =
| AggregationClause
diff --git a/frontend/src/metabase-types/api/embedding-theme.ts b/frontend/src/metabase-types/api/embedding-theme.ts
index f0da4949151..06351553af1 100644
--- a/frontend/src/metabase-types/api/embedding-theme.ts
+++ b/frontend/src/metabase-types/api/embedding-theme.ts
@@ -1,7 +1,8 @@
import type { CSSProperties } from "react";
-import type { MetabaseFontFamily } from "metabase/utils/fonts";
-import type { DeepPartial } from "metabase/utils/types";
+import type { DeepPartial } from "metabase-types/utils/types";
+
+import type { MetabaseFontFamily } from "./fonts";
export type MetabaseThemePreset = "light" | "dark";
diff --git a/frontend/src/metabase-types/api/fonts.ts b/frontend/src/metabase-types/api/fonts.ts
new file mode 100644
index 00000000000..e94d9b0f96b
--- /dev/null
+++ b/frontend/src/metabase-types/api/fonts.ts
@@ -0,0 +1,22 @@
+export type MetabaseFontFamily =
+ | "Roboto"
+ | "Merriweather"
+ | "Open Sans"
+ | "Lato"
+ | "Inter"
+ | "Noto Sans"
+ | "Roboto Slab"
+ | "Source Sans Pro"
+ | "Raleway"
+ | "Slabo 27px"
+ | "PT Sans"
+ | "Poppins"
+ | "PT Serif"
+ | "Roboto Mono"
+ | "Roboto Condensed"
+ | "Playfair Display"
+ | "Oswald"
+ | "Ubuntu"
+ | "Montserrat"
+ | "Lora"
+ | "Custom";
diff --git a/frontend/src/metabase-types/api/index.ts b/frontend/src/metabase-types/api/index.ts
index e8417fe5a88..af0f00a70c3 100644
--- a/frontend/src/metabase-types/api/index.ts
+++ b/frontend/src/metabase-types/api/index.ts
@@ -29,6 +29,7 @@ export * from "./entity-id";
export * from "./erd";
export * from "./exploration";
export * from "./field";
+export * from "./fonts";
export * from "./formatting";
export * from "./geojson";
export * from "./group";
diff --git a/frontend/src/metabase-types/api/mocks/document.ts b/frontend/src/metabase-types/api/mocks/document.ts
index caa51fa15cf..05426d87d04 100644
--- a/frontend/src/metabase-types/api/mocks/document.ts
+++ b/frontend/src/metabase-types/api/mocks/document.ts
@@ -1,4 +1,3 @@
-import { uuid } from "metabase/utils/uuid";
import type { Document, DocumentContent } from "metabase-types/api";
import { createMockUser } from "./user";
@@ -27,13 +26,3 @@ export const createMockDocumentContent = (
content: [],
...opts,
});
-
-export const createMockDocumentContentParagraph = (
- text: string,
-): DocumentContent => ({
- type: "paragraph",
- attrs: {
- _id: uuid(),
- },
- content: [{ type: "text", text }],
-});
diff --git a/frontend/src/metabase-types/api/query.ts b/frontend/src/metabase-types/api/query.ts
index 3856708caca..5996bd9d0b4 100644
--- a/frontend/src/metabase-types/api/query.ts
+++ b/frontend/src/metabase-types/api/query.ts
@@ -1,5 +1,3 @@
-import type * as Lib from "metabase-lib";
-
import type { CardId } from "./card";
import type { DatabaseId } from "./database";
import type { TemplateTag, TemplateTags, TemporalUnit } from "./dataset";
@@ -321,6 +319,8 @@ export type SegmentFilter = ["segment", SegmentId];
type OrderByClause = Array<OrderBy>;
export type OrderBy = ["asc" | "desc", FieldReference];
+export type JoinConditionOperator = "=" | "!=" | ">" | "<" | ">=" | "<=";
+
export type JoinStrategy =
| "left-join"
| "right-join"
@@ -553,7 +553,7 @@ export type TestJoinSpec = {
};
type TestJoinConditionSpec = {
- operator: Lib.JoinConditionOperator;
+ operator: JoinConditionOperator;
left: TestColumnWithBinningSpec | TestExpressionSpec;
right: TestColumnWithBinningSpec | TestExpressionSpec;
};
diff --git a/frontend/src/metabase-types/utils/types.ts b/frontend/src/metabase-types/utils/types.ts
new file mode 100644
index 00000000000..14fcf2f2a71
--- /dev/null
+++ b/frontend/src/metabase-types/utils/types.ts
@@ -0,0 +1,8 @@
+/**
+ * Makes every property in the object optional, recursively.
+ *
+ * @inline
+ */
+export type DeepPartial<T> = {
+ [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
diff --git a/frontend/src/metabase/embedding-sdk/theme/default-component-theme.ts b/frontend/src/metabase/embedding-sdk/theme/default-component-theme.ts
index f25b5783b51..b28772a35ae 100644
--- a/frontend/src/metabase/embedding-sdk/theme/default-component-theme.ts
+++ b/frontend/src/metabase/embedding-sdk/theme/default-component-theme.ts
@@ -4,7 +4,7 @@ import { EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID } from "metabase/embedding-sdk/con
import type { MetabaseComponentTheme } from "metabase/embedding-sdk/theme";
import type { MantineThemeOverride } from "metabase/ui";
import { OVERLAY_Z_INDEX } from "metabase/ui/component-theme";
-import type { DeepPartial } from "metabase/utils/types";
+import type { DeepPartial } from "metabase-types/utils/types";
export const DEFAULT_SDK_FONT_SIZE = 14;
diff --git a/frontend/src/metabase/embedding-sdk/types/utils.ts b/frontend/src/metabase/embedding-sdk/types/utils.ts
index e51eada8e52..4a558abfd1c 100644
--- a/frontend/src/metabase/embedding-sdk/types/utils.ts
+++ b/frontend/src/metabase/embedding-sdk/types/utils.ts
@@ -1,4 +1,4 @@
-export type { DeepPartial } from "metabase/utils/types";
+export type { DeepPartial } from "metabase-types/utils/types";
// https://www.raygesualdo.com/posts/flattening-object-keys-with-typescript-types/
export type FlattenObjectKeys<
diff --git a/frontend/src/metabase/utils/fonts.ts b/frontend/src/metabase/utils/fonts.ts
index 718969c53be..890ef3960ba 100644
--- a/frontend/src/metabase/utils/fonts.ts
+++ b/frontend/src/metabase/utils/fonts.ts
@@ -1,25 +1,4 @@
-export type MetabaseFontFamily =
- | "Roboto"
- | "Merriweather"
- | "Open Sans"
- | "Lato"
- | "Inter"
- | "Noto Sans"
- | "Roboto Slab"
- | "Source Sans Pro"
- | "Raleway"
- | "Slabo 27px"
- | "PT Sans"
- | "Poppins"
- | "PT Serif"
- | "Roboto Mono"
- | "Roboto Condensed"
- | "Playfair Display"
- | "Oswald"
- | "Ubuntu"
- | "Montserrat"
- | "Lora"
- | "Custom";
+import type { MetabaseFontFamily } from "metabase-types/api/fonts";
type PredefinedFontName = Exclude<MetabaseFontFamily, "Custom">;
diff --git a/frontend/src/metabase/utils/types.ts b/frontend/src/metabase/utils/types.ts
index 5f7e1fee66d..b36b669c1b9 100644
--- a/frontend/src/metabase/utils/types.ts
+++ b/frontend/src/metabase/utils/types.ts
@@ -1,14 +1,5 @@
import _ from "underscore";
-/**
- * Makes every property in the object optional, recursively.
- *
- * @inline
- */
-export type DeepPartial<T> = {
- [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
-};
-
export const isNotNull = <T>(value: T | null | undefined): value is T => {
return value != null;
};