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
Clean up `metabase-lib` (#73219)
Romeo Van Snickb0c09624ff14
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjsindex cb9e100c0a1..04f3768d121 100644--- a/frontend/lint/module-boundaries.mjs+++ b/frontend/lint/module-boundaries.mjs@@ -34,12 +34,22 @@ const elements = [mode: "full",enforceOutgoing: true,}),- // basic++ // mlv1/mlv2 need to be in this order+ // for precedencecreateElement({type: "basic",+ name: "mlv1",+ pattern: "frontend/src/metabase-lib/v1/**",+ }),+ createElement({+ type: "lib",name: "mlv2",pattern: "frontend/src/metabase-lib/**",+ enforceOutgoing: true,}),++ // basiccreateElement({ type: "basic", name: "ui", enforceOutgoing: true }),createElement({ type: "shared", name: "api" }),// shareddiff --git a/frontend/src/metabase-lib/metric/core.ts b/frontend/src/metabase-lib/metric/core.tsindex 11d7725758a..7b7f470d28f 100644--- a/frontend/src/metabase-lib/metric/core.ts+++ b/frontend/src/metabase-lib/metric/core.ts@@ -1,7 +1,7 @@import dayjs, { type Dayjs } from "dayjs";import * as LibMetric from "cljs/metabase.lib_metric.js";-import type Metadata from "metabase-lib/v1/metadata/Metadata";+import type { Metadata } from "metabase-lib";import type {ConcreteTableId,JsMetricDefinition,diff --git a/frontend/src/metabase-lib/metric/core.unit.spec.ts b/frontend/src/metabase-lib/metric/core.unit.spec.tsindex a73ae6acf39..6bfb22cbb0d 100644--- a/frontend/src/metabase-lib/metric/core.unit.spec.ts+++ b/frontend/src/metabase-lib/metric/core.unit.spec.ts@@ -1,5 +1,4 @@-import Metadata from "metabase-lib/v1/metadata/Metadata";-import Metric from "metabase-lib/v1/metadata/Metric";+import { createMockMetadata } from "__support__/metadata";import type { JsMetricDefinition } from "metabase-types/api";import {createMockMetric,@@ -77,14 +76,12 @@ const DIM_IDX = {TIME: 6, // Event Time - type/Time};-function createSampleMetadata(): Metadata {- const metadata = new Metadata();+function createSampleMetadata() {+ const metadata = createMockMetadata();- // Add the metric to the metadata object- const metricInstance = new Metric(SAMPLE_METRIC as any);- metricInstance.metadata = metadata;+ // @ts-expect-error - mock metric works just as well as a real onemetadata.metrics = {- [SAMPLE_METRIC.id]: metricInstance,+ [SAMPLE_METRIC.id]: SAMPLE_METRIC,};return metadata;diff --git a/frontend/src/metabase-lib/metric/types.unit.spec.ts b/frontend/src/metabase-lib/metric/types.unit.spec.tsindex 5ee4b412557..d707a18ab47 100644--- a/frontend/src/metabase-lib/metric/types.unit.spec.ts+++ b/frontend/src/metabase-lib/metric/types.unit.spec.ts@@ -1,5 +1,4 @@-import Metadata from "metabase-lib/v1/metadata/Metadata";-import Metric from "metabase-lib/v1/metadata/Metric";+import { createMockMetadata } from "__support__/metadata";import {createMockMetric,createMockMetricDimension,@@ -15,8 +14,8 @@ import type {/*** Creates test metrics with dimensions of specific types for testing type predicates.*/-function createTestMetadata(): Metadata {- const metadata = new Metadata();+function createTestMetadata() {+ const metadata = createMockMetadata();// Create a metric with various dimension typesconst testMetric = createMockMetric({@@ -105,10 +104,9 @@ function createTestMetadata(): Metadata {],});- const metricInstance = new Metric(testMetric as any);- metricInstance.metadata = metadata;+ // @ts-expect-error - mock metric works just as well as a real onemetadata.metrics = {- [testMetric.id]: metricInstance,+ [testMetric.id]: testMetric,};return metadata;diff --git a/frontend/src/metabase/querying/expressions/config.ts b/frontend/src/metabase-lib/query/clauses/clauses.tssimilarity index 99%rename from frontend/src/metabase/querying/expressions/config.tsrename to frontend/src/metabase-lib/query/clauses/clauses.tsindex 2aec6533faf..a9d15e26336 100644--- a/frontend/src/metabase/querying/expressions/config.ts+++ b/frontend/src/metabase-lib/query/clauses/clauses.ts@@ -1895,3 +1895,5 @@ export const MBQL_CLAUSES = {...EXPRESSION_FUNCTIONS,...EXPRESSION_OPERATORS,} as const;++export type DefinedClauseName = keyof typeof MBQL_CLAUSES;diff --git a/frontend/src/metabase/querying/expressions/define.ts b/frontend/src/metabase-lib/query/clauses/define.tssimilarity index 100%rename from frontend/src/metabase/querying/expressions/define.tsrename to frontend/src/metabase-lib/query/clauses/define.tsdiff --git a/frontend/src/metabase-lib/query/clauses/index.ts b/frontend/src/metabase-lib/query/clauses/index.tsnew file mode 100644index 00000000000..0b6351a856d--- /dev/null+++ b/frontend/src/metabase-lib/query/clauses/index.ts@@ -0,0 +1,2 @@+export * from "./clauses";+export * from "./types";diff --git a/frontend/src/metabase-lib/query/clauses/types.ts b/frontend/src/metabase-lib/query/clauses/types.tsnew file mode 100644index 00000000000..8a73330fc44--- /dev/null+++ b/frontend/src/metabase-lib/query/clauses/types.ts@@ -0,0 +1,75 @@+import type { Database, DatabaseFeature } from "metabase-types/api";++import type { ExpressionArg, ExpressionParts } from "../types";++import type { DefinedClauseName } from "./clauses";++export enum MBQLClauseCategory {+ Logical = "logical",+ Math = "math",+ String = "string",+ Date = "date",+ Conversion = "conversion",+ Window = "window",+ Aggregation = "aggregation",+}++export type ExpressionType =+ | "aggregation"+ | "any"+ | "boolean"+ | "datetime"+ | "expression"+ | "number"+ | "string";++export type ClauseArgDefinition = {+ name: string;+ type: ExpressionType;+ description?: string;+ example?:+ | ExpressionParts+ | ExpressionArg+ | (ExpressionParts | ExpressionArg)[];+ template?: string;+ optional?: boolean;+};++export type MBQLClauseDefinition = {+ name?: never;+ displayName: string;+ type: ExpressionType;+ args(): ClauseArgDefinition[];+ argType?(+ index: number,+ args: unknown[],+ type: ExpressionType,+ ): ExpressionType;+ requiresFeature?: DatabaseFeature;+ hasOptions?: boolean;+ multiple?: boolean;+ category?: MBQLClauseCategory;+ validator?: (...args: any) => string | undefined;+ description?(database: Database, reportTimezone?: string): string;+ docsPage?: string;+};++type DatabaseOptions = {+ engine?: string | undefined;+ features?: DatabaseFeature[] | undefined;+};++export type MBQLClauseFunctionConfig = {+ name: DefinedClauseName;+ displayName: string;+ type: ExpressionType;+ args: ClauseArgDefinition[];+ argType(index: number, args: unknown[], type: ExpressionType): ExpressionType;+ requiresFeature?: DatabaseFeature;+ hasOptions: boolean;+ multiple: boolean;+ category?: MBQLClauseCategory;+ validator?: (...args: any) => string | undefined;+ description?(database: DatabaseOptions, reportTimezone?: string): string;+ docsPage?: string;+};diff --git a/frontend/src/metabase-lib/query/index.ts b/frontend/src/metabase-lib/query/index.tsindex ec8d3bbc0fd..edf08ce2b7d 100644--- a/frontend/src/metabase-lib/query/index.ts+++ b/frontend/src/metabase-lib/query/index.ts@@ -4,6 +4,7 @@ export * from "./aggregation";export * from "./binning";export * from "./breakout";export * from "./buckets";+export * from "./clauses";export * from "./column_types";export * from "./comparison";export * from "./database";diff --git a/frontend/src/metabase-lib/query/metadata.ts b/frontend/src/metabase-lib/query/metadata.tsindex d926d4d5f69..dab661734e3 100644--- a/frontend/src/metabase-lib/query/metadata.ts+++ b/frontend/src/metabase-lib/query/metadata.ts@@ -1,16 +1,43 @@import * as ML from "cljs/metabase.lib.js";import type {- Field as ApiField,CardId,CardType,DatabaseId,DatasetColumn,+ Field,FieldId,+ NormalizedField,TableId,} from "metabase-types/api";-import type Field from "../v1/metadata/Field";-import type Metadata from "../v1/metadata/Metadata";+/**+ * We do not have full type-safety into the CLJS of metabase-lib, so+ * we mark objects that are instances of Metadata using this symbol+ * without having to import them here.+ */+export declare const MetadataSymbol: unique symbol;++/**+ * Structural shape consumed by {@link metadataProvider}. The CLJS-side provider+ * (`metabase.lib.js.metadata/metadata-provider`) only reads these top-level+ * keys and iterates each entry — it does not call any methods on the value.+ *+ * Branded so arbitrary objects do not accidentally satisfy it. Construct a+ * value either by using v1's `Metadata` class (which declares the brand) or+ * via the {@link metadataInput} helper.+ */+export interface Metadata {+ readonly [MetadataSymbol]?: void;+ databases?: Record<string, unknown>;+ tables?: Record<string, unknown>;+ fields?: Record<string, unknown>;+ metrics?: Record<string, unknown>;+ measures?: Record<string, unknown>;+ segments?: Record<string, unknown>;+ questions?: Record<string, unknown>;+ snippets?: Record<string, unknown>;+ settings?: object;+}import type {AggregationClause,@@ -204,7 +231,7 @@ export function returnedColumns(export function fromLegacyColumn(query: Query,stageIndex: number,- columnOrField: DatasetColumn | Field | ApiField,+ columnOrField: DatasetColumn | NormalizedField | Field,): ColumnMetadata {return ML.legacy_column__GT_metadata(query, stageIndex, columnOrField);}diff --git a/frontend/src/metabase-lib/query/query.ts b/frontend/src/metabase-lib/query/query.tsindex a189bbafbf4..c79639f1b95 100644--- a/frontend/src/metabase-lib/query/query.ts+++ b/frontend/src/metabase-lib/query/query.ts@@ -1,6 +1,5 @@import * as ML from "cljs/metabase.lib.js";-import { metadataProvider } from "metabase-lib";-import type Metadata from "metabase-lib/v1/metadata/Metadata";+import { type Metadata, metadataProvider } from "metabase-lib";import type {CardId,CardType,diff --git a/frontend/src/metabase-lib/query/test-helpers.ts b/frontend/src/metabase-lib/query/test-helpers.tsindex b1097a5e430..653edf2b3c7 100644--- a/frontend/src/metabase-lib/query/test-helpers.ts+++ b/frontend/src/metabase-lib/query/test-helpers.ts@@ -2,7 +2,6 @@import { createMockMetadata } from "__support__/metadata";import * as Lib from "metabase-lib";-import type Metadata from "metabase-lib/v1/metadata/Metadata";import type {DatabaseId,DatasetColumn,@@ -14,6 +13,8 @@ import {createSampleDatabase,} from "metabase-types/api/mocks/presets";+import type { Metadata } from "./metadata";+const SAMPLE_DATABASE = createSampleDatabase();const SAMPLE_METADATA = createMockMetadata({ databases: [SAMPLE_DATABASE] });diff --git a/frontend/src/metabase-lib/query/types.ts b/frontend/src/metabase-lib/query/types.tsindex bc59ac3d817..e645cf59eee 100644--- a/frontend/src/metabase-lib/query/types.ts+++ b/frontend/src/metabase-lib/query/types.ts@@ -1,5 +1,4 @@/* eslint-disable @typescript-eslint/no-unused-vars -- used for types */-import type { DefinedClauseName } from "metabase/querying/expressions";import type {CardId,DatabaseId,@@ -30,6 +29,7 @@ import type {TimeFilterOperator,} from "../common";+import type { DefinedClauseName } from "./clauses";import type { ColumnExtractionTag } from "./extractions";/**diff --git a/frontend/src/metabase-lib/v1/metadata/Field.ts b/frontend/src/metabase-lib/v1/metadata/Field.tsindex 767398d4927..7cdc744d075 100644--- a/frontend/src/metabase-lib/v1/metadata/Field.ts+++ b/frontend/src/metabase-lib/v1/metadata/Field.ts@@ -32,6 +32,7 @@ import type {FieldReference,FieldValuesType,FieldVisibilityType,+ NormalizedField,} from "metabase-types/api";import Base from "./Base";@@ -78,7 +79,7 @@ export default class Field extends Base {settings?: FieldFormattingSettings;visibility_type: FieldVisibilityType;- getPlainObject(): IField {+ getPlainObject(): NormalizedField {return this._plainObject;}diff --git a/frontend/src/metabase-lib/v1/metadata/Metadata.ts b/frontend/src/metabase-lib/v1/metadata/Metadata.tsindex 554ea9c0270..3f7f8e4d2e4 100644--- a/frontend/src/metabase-lib/v1/metadata/Metadata.ts+++ b/frontend/src/metabase-lib/v1/metadata/Metadata.ts@@ -1,5 +1,6 @@import _ from "underscore";+import { MetadataSymbol } from "metabase-lib";import type {CardId,DatabaseId,@@ -45,6 +46,10 @@ interface MetadataOpts {* Do not rely on data being implicitly loaded in some other place.*/class Metadata {+ // We brand this type with the MetadataSymbol to+ // to mark it as a Metadata instance.++ readonly [MetadataSymbol]?: void;databases: Record<string, Database> = {};schemas: Record<string, Schema> = {};tables: Record<string, Table> = {};diff --git a/frontend/src/metabase/common/components/AggregationPicker/AggregationPicker.tsx b/frontend/src/metabase/common/components/AggregationPicker/AggregationPicker.tsxindex d188bf7ce21..dcbc2bf73bf 100644--- a/frontend/src/metabase/common/components/AggregationPicker/AggregationPicker.tsx+++ b/frontend/src/metabase/common/components/AggregationPicker/AggregationPicker.tsx@@ -19,8 +19,6 @@ import {ExpressionWidgetHeader,} from "metabase/querying/components/expressions";import {- type DefinedClauseName,- type MBQLClauseFunctionConfig,clausesForMode,getClauseDefinition,} from "metabase/querying/expressions";@@ -73,7 +71,7 @@ type MeasureListItem = Lib.MeasureDisplayInfo & {type ExpressionClauseListItem = {type: "expression-clause";- clause: MBQLClauseFunctionConfig;+ clause: Lib.MBQLClauseFunctionConfig;displayName: string;};@@ -119,7 +117,7 @@ export function AggregationPicker({}),);const [initialExpressionClause, setInitialExpressionClause] =- useState<DefinedClauseName | null>(null);+ useState<Lib.DefinedClauseName | null>(null);// For really simple inline expressions like Average([Price]),// Lib can figure out that "Average" operator is used.@@ -258,7 +256,7 @@ export function AggregationPicker({);const handleExpressionSelect = useCallback(- (clause?: DefinedClauseName) => {+ (clause?: Lib.DefinedClauseName) => {if (clause) {setInitialExpressionClause(clause);}@@ -584,7 +582,7 @@ function getMeasureListItem(}function getExpressionClauseListItem(- clause: MBQLClauseFunctionConfig,+ clause: Lib.MBQLClauseFunctionConfig,): ExpressionClauseListItem {return {type: "expression-clause",diff --git a/frontend/src/metabase/common/components/QueryColumnPicker/QueryColumnPicker.tsx b/frontend/src/metabase/common/components/QueryColumnPicker/QueryColumnPicker.tsxindex 8b7f8c0369f..0087c3ce860 100644--- a/frontend/src/metabase/common/components/QueryColumnPicker/QueryColumnPicker.tsx+++ b/frontend/src/metabase/common/components/QueryColumnPicker/QueryColumnPicker.tsx@@ -15,7 +15,6 @@ import { getColumnGroupIcon } from "metabase/common/utils/column-groups";import { useTranslateContent } from "metabase/i18n/hooks";import { PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";import {- type DefinedClauseName,clausesForMode,getClauseDefinition,} from "metabase/querying/expressions";@@ -39,7 +38,7 @@ export type ColumnListItem = Lib.ColumnDisplayInfo & {type ExpressionClauseItem = {type: "expression-clause";- clause: DefinedClauseName;+ clause: Lib.DefinedClauseName;displayName: string;};@@ -64,7 +63,7 @@ export interface QueryColumnPickerProps {/*** Set onSelectExpression to allow custom expressions to be selected*/- onSelectExpression?: (clause?: DefinedClauseName) => void;+ onSelectExpression?: (clause?: Lib.DefinedClauseName) => void;expressionSectionIcon?: IconName;onClose?: () => void;"data-testid"?: string;diff --git a/frontend/src/metabase/query_builder/actions/object-detail.ts b/frontend/src/metabase/query_builder/actions/object-detail.tsindex e0a158852e5..fcb4c84eb61 100644--- a/frontend/src/metabase/query_builder/actions/object-detail.ts+++ b/frontend/src/metabase/query_builder/actions/object-detail.ts@@ -8,9 +8,8 @@ import { MetabaseApi } from "metabase/services";import type { ObjectId } from "metabase/visualizations/components/ObjectDetail/types";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";-import type Field from "metabase-lib/v1/metadata/Field";import type ForeignKey from "metabase-lib/v1/metadata/ForeignKey";-import type { Card, DatasetColumn, FieldId } from "metabase-types/api";+import type { Card, DatasetColumn, Field, FieldId } from "metabase-types/api";import {getCanZoomNextRow,@@ -140,7 +139,11 @@ export const loadObjectDetailFKReferences = createThunkAction(table,);const aggregatedQuery = Lib.aggregateByCount(baseQuery, -1);- const query = filterByFk(aggregatedQuery, fk.origin, objectId);+ const query = filterByFk(+ aggregatedQuery,+ fk.origin.getPlainObject() as Field,+ objectId,+ );const finalCard = Question.create({dataset_query: Lib.toJsQuery(query),metadata,diff --git a/frontend/src/metabase/query_builder/utils/index.ts b/frontend/src/metabase/query_builder/utils/index.tsindex e241d4412c1..f37a6c30f28 100644--- a/frontend/src/metabase/query_builder/utils/index.ts+++ b/frontend/src/metabase/query_builder/utils/index.ts@@ -8,7 +8,7 @@ import type { DatasetEditorTab, QueryBuilderMode } from "metabase/redux/store";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";-import type { Card, Field, Series } from "metabase-types/api";+import type { Card, Field, NormalizedField, Series } from "metabase-types/api";interface GetPathNameFromQueryBuilderModeOptions {pathname: string;@@ -188,7 +188,10 @@ const WRITABLE_NATIVE_COLUMN_PROPERTIES = [...WRITABLE_MBQL_COLUMN_PROPERTIES,];-export function getWritableColumnProperties(column: Field, isNative: boolean) {+export function getWritableColumnProperties(+ column: NormalizedField | Field,+ isNative: boolean,+) {return _.pick(column,isNativediff --git a/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx b/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsxindex 014fe296788..5ece8b6538f 100644--- a/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx+++ b/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx@@ -12,7 +12,6 @@ import {type CodeMirrorRef,} from "metabase/common/components/CodeMirror";import {- type DefinedClauseName,type ExpressionError,diagnoseAndCompile,format,@@ -55,7 +54,7 @@ type EditorProps = {error?: ExpressionError | Error | null;hasHeader?: boolean;onCloseEditor?: () => void;- initialExpressionClause?: DefinedClauseName | null;+ initialExpressionClause?: Lib.DefinedClauseName | null;onChange: (clause: Lib.ExpressionClause | null,diff --git a/frontend/src/metabase/querying/components/expressions/Editor/utils.ts b/frontend/src/metabase/querying/components/expressions/Editor/utils.tsindex 77eb5615772..92a4360c038 100644--- a/frontend/src/metabase/querying/components/expressions/Editor/utils.ts+++ b/frontend/src/metabase/querying/components/expressions/Editor/utils.ts@@ -8,15 +8,15 @@ import type { EditorView } from "@codemirror/view";import { useCallback } from "react";import {- type DefinedClauseName,expressionClauseSnippet,getClauseDefinition,} from "metabase/querying/expressions";+import type * as Lib from "metabase-lib";export function useInitialClause({initialExpressionClause,}: {- initialExpressionClause?: DefinedClauseName | null;+ initialExpressionClause?: Lib.DefinedClauseName | null;}) {return useCallback((view: EditorView) => {diff --git a/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.tsx b/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.tsxindex 654f5080688..e3202f89bba 100644--- a/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.tsx+++ b/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.tsx@@ -2,10 +2,7 @@ import type { ReactNode } from "react";import { useCallback, useMemo, useState } from "react";import { t } from "ttag";-import type {- DefinedClauseName,- ExpressionError,-} from "metabase/querying/expressions";+import type { ExpressionError } from "metabase/querying/expressions";import { Box, Button, Flex } from "metabase/ui";import { isNotNull } from "metabase/utils/types";import type * as Lib from "metabase-lib";@@ -34,7 +31,7 @@ export type ExpressionWidgetProps = {withName?: boolean;reportTimezone?: string;header?: ReactNode;- initialExpressionClause?: DefinedClauseName | null;+ initialExpressionClause?: Lib.DefinedClauseName | null;availableColumns: Lib.ColumnMetadata[];availableMetrics?: Lib.MetricMetadata[];readOnly?: boolean;diff --git a/frontend/src/metabase/querying/expressions/clause.ts b/frontend/src/metabase/querying/expressions/clause.tsindex 5beea8cd284..d05a9a31b64 100644--- a/frontend/src/metabase/querying/expressions/clause.ts+++ b/frontend/src/metabase/querying/expressions/clause.ts@@ -2,23 +2,21 @@ import _ from "underscore";import { isNotNull } from "metabase/utils/types";import type * as Lib from "metabase-lib";-import type Database from "metabase-lib/v1/metadata/Database";-import {AGGREGATION_FUNCTIONS,EXPRESSION_FUNCTIONS,+ type MBQLClauseDefinition,+ type MBQLClauseFunctionConfig,MBQL_CLAUSES,-} from "./config";-import type { MBQLClauseDefinition, MBQLClauseFunctionConfig } from "./types";--export type DefinedClauseName = keyof typeof MBQL_CLAUSES;+} from "metabase-lib";+import type Database from "metabase-lib/v1/metadata/Database";-export function isDefinedClause(name: string): name is DefinedClauseName {+export function isDefinedClause(name: string): name is Lib.DefinedClauseName {return name in MBQL_CLAUSES;}export function getClauseDefinition(- name: DefinedClauseName,+ name: Lib.DefinedClauseName,): MBQLClauseFunctionConfig;export function getClauseDefinition(name: string,@@ -49,13 +47,13 @@ const EXPRESSION_TO_MBQL_NAME = new Map(Object.entries(MBQL_CLAUSES).map(([mbql, { displayName }]) => [// case-insensitivedisplayName.toLowerCase(),- mbql as DefinedClauseName,+ mbql as Lib.DefinedClauseName,]),);export function getMBQLName(expressionName: string,-): DefinedClauseName | undefined {+): Lib.DefinedClauseName | undefined {// case-insensitivereturn EXPRESSION_TO_MBQL_NAME.get(expressionName.trim().toLowerCase());}diff --git a/frontend/src/metabase/querying/expressions/formatter/utils.ts b/frontend/src/metabase/querying/expressions/formatter/utils.tsindex 2a7f794c788..2f9100dc8fc 100644--- a/frontend/src/metabase/querying/expressions/formatter/utils.ts+++ b/frontend/src/metabase/querying/expressions/formatter/utils.ts@@ -2,7 +2,6 @@ import type { AstPath } from "prettier";import * as Lib from "metabase-lib";-import { EXPRESSION_OPERATORS } from "../config";import * as literal from "../literal";type Assertion<T> = T extends ((expr: any) => expr is infer U) ? U : never;@@ -64,7 +63,9 @@ export const pathMatchers = lift({export function isExpressionOperator(node: Lib.ExpressionParts | Lib.ExpressionArg,): node is Lib.ExpressionParts {- return Lib.isExpressionParts(node) && node.operator in EXPRESSION_OPERATORS;+ return (+ Lib.isExpressionParts(node) && node.operator in Lib.EXPRESSION_OPERATORS+ );}/**diff --git a/frontend/src/metabase/querying/expressions/help-text.ts b/frontend/src/metabase/querying/expressions/help-text.tsindex bec1248f06b..a87fd519a81 100644--- a/frontend/src/metabase/querying/expressions/help-text.ts+++ b/frontend/src/metabase/querying/expressions/help-text.ts@@ -3,12 +3,11 @@ import type * as Lib from "metabase-lib";import type Database from "metabase-lib/v1/metadata/Database";import { getClauseDefinition } from "./clause";-import type { ClauseArgDefinition, MBQLClauseCategory } from "./types";export type HelpText = {name: string;- category: MBQLClauseCategory;- args: ClauseArgDefinition[];+ category: Lib.MBQLClauseCategory;+ args: Lib.ClauseArgDefinition[];description: string;example: Lib.ExpressionParts;displayName: string;@@ -50,7 +49,7 @@ export function getHelpText(*/function getExample(name: string,- args: ClauseArgDefinition[],+ args: Lib.ClauseArgDefinition[],): Lib.ExpressionParts {return {operator: name as Lib.ExpressionOperator,diff --git a/frontend/src/metabase/querying/expressions/help-text.unit.spec.ts b/frontend/src/metabase/querying/expressions/help-text.unit.spec.tsindex 9b341369621..d2742dffc2c 100644--- a/frontend/src/metabase/querying/expressions/help-text.unit.spec.ts+++ b/frontend/src/metabase/querying/expressions/help-text.unit.spec.ts@@ -1,9 +1,9 @@import { createMockMetadata } from "__support__/metadata";import { checkNotNull } from "metabase/utils/types";+import * as Lib from "metabase-lib";import type { Database } from "metabase-types/api";import { createMockDatabase } from "metabase-types/api/mocks/database";-import { MBQL_CLAUSES } from "./config";import { formatExpressionParts } from "./formatter";import { getHelpText } from "./help-text";@@ -150,7 +150,7 @@ describe("getHelpText", () => {});it("all help texts can be formatted", async () => {- for (const name in MBQL_CLAUSES) {+ for (const name in Lib.MBQL_CLAUSES) {const { database } = setup();const helpText = getHelpText(name, database, reportTimezone);if (!helpText) {diff --git a/frontend/src/metabase/querying/expressions/pratt/compiler.ts b/frontend/src/metabase/querying/expressions/pratt/compiler.tsindex 73c956ff596..7340e976505 100644--- a/frontend/src/metabase/querying/expressions/pratt/compiler.ts+++ b/frontend/src/metabase/querying/expressions/pratt/compiler.ts@@ -7,7 +7,6 @@ import { getClauseDefinition, getMBQLName, isDefinedClause } from "../clause";import { CompileError, isExpressionError } from "../errors";import { isBigIntLiteral, isStringLiteral } from "../literal";import type { Resolver } from "../resolver";-import type { ExpressionType } from "../types";import { assert, check } from "../utils";import type { Node, NodeType } from "./node";@@ -43,7 +42,7 @@ type Options = {};type Context = {- type: ExpressionType;+ type: Lib.ExpressionType;resolver: Resolver;};@@ -56,14 +55,18 @@ export function compile(node: Node, options: Options) {function getTypeForExpressionMode(expressionMode: Lib.ExpressionMode,-): ExpressionType {+): Lib.ExpressionType {if (expressionMode === "filter") {return "boolean";}return expressionMode;}-function fallbackResolver(_type: ExpressionType, name: string, _node?: Node) {+function fallbackResolver(+ _type: Lib.ExpressionType,+ name: string,+ _node?: Node,+) {return {operator: "dimension" as Lib.ExpressionOperator,options: {},diff --git a/frontend/src/metabase/querying/expressions/pratt/compiler.unit.spec.ts b/frontend/src/metabase/querying/expressions/pratt/compiler.unit.spec.tsindex 47b48a70ec6..eea542132b4 100644--- a/frontend/src/metabase/querying/expressions/pratt/compiler.unit.spec.ts+++ b/frontend/src/metabase/querying/expressions/pratt/compiler.unit.spec.ts@@ -3,7 +3,6 @@ import * as Lib from "metabase-lib";import { compileExpression } from "../compile-expression";import { query } from "../test/shared";import { value } from "../test/utils";-import type { ExpressionType } from "../types";import { compile, lexify, parse } from ".";@@ -815,7 +814,7 @@ describe("resolve", () => {query,stageIndex,availableColumns: Lib.expressionableColumns(query, stageIndex),- resolver(type: ExpressionType, name: string) {+ resolver(type: Lib.ExpressionType, name: string) {if (type === "boolean") {segments.push(name);} else if (type === "aggregation") {diff --git a/frontend/src/metabase/querying/expressions/resolver.ts b/frontend/src/metabase/querying/expressions/resolver.tsindex bf873e83ca4..b772dd8894e 100644--- a/frontend/src/metabase/querying/expressions/resolver.ts+++ b/frontend/src/metabase/querying/expressions/resolver.ts@@ -6,10 +6,9 @@ import * as Lib from "metabase-lib";import { CompileError } from "./errors";import { EDITOR_FK_SYMBOLS, getDisplayNameWithSeparator } from "./identifier";import type { Node } from "./pratt";-import type { ExpressionType } from "./types";export type Resolver = (- type: ExpressionType,+ type: Lib.ExpressionType,name: string,node?: Node,) => Lib.ExpressionParts | Lib.ExpressionArg;diff --git a/frontend/src/metabase/querying/expressions/suggestions/util.ts b/frontend/src/metabase/querying/expressions/suggestions/util.tsindex 5e670893a8c..ffde68cf918 100644--- a/frontend/src/metabase/querying/expressions/suggestions/util.ts+++ b/frontend/src/metabase/querying/expressions/suggestions/util.ts@@ -1,13 +1,14 @@import { snippetCompletion } from "@codemirror/autocomplete";import Fuse from "fuse.js";+import type * as Lib from "metabase-lib";+import { CALL, FIELD, IDENTIFIER, type Token } from "../pratt";-import type { MBQLClauseFunctionConfig } from "../types";import type { ExpressionSuggestion } from "./types";export function expressionClauseCompletion(- clause: MBQLClauseFunctionConfig,+ clause: Lib.MBQLClauseFunctionConfig,{type,matches,@@ -24,7 +25,7 @@ export function expressionClauseCompletion(return { ...completion, icon: "function", matches };}-export function expressionClauseSnippet(clause: MBQLClauseFunctionConfig) {+export function expressionClauseSnippet(clause: Lib.MBQLClauseFunctionConfig) {const args =clause.args.filter((arg) => arg.name !== "…")diff --git a/frontend/src/metabase/querying/expressions/types.ts b/frontend/src/metabase/querying/expressions/types.tsindex 3713fa4fc0e..0f0bb78cfd2 100644--- a/frontend/src/metabase/querying/expressions/types.ts+++ b/frontend/src/metabase/querying/expressions/types.ts@@ -1,75 +1,7 @@import type * as Lib from "metabase-lib";-import type Database from "metabase-lib/v1/metadata/Database";-import type { DatabaseFeature } from "metabase-types/api";-import type { DefinedClauseName } from "./clause";import type { Token } from "./pratt";-export enum MBQLClauseCategory {- Logical = "logical",- Math = "math",- String = "string",- Date = "date",- Conversion = "conversion",- Window = "window",- Aggregation = "aggregation",-}--export type ExpressionType =- | "aggregation"- | "any"- | "boolean"- | "datetime"- | "expression"- | "number"- | "string";--export type ClauseArgDefinition = {- name: string;- type: ExpressionType;- description?: string;- example?:- | Lib.ExpressionParts- | Lib.ExpressionArg- | (Lib.ExpressionParts | Lib.ExpressionArg)[];- template?: string;- optional?: boolean;-};--export type MBQLClauseDefinition = {- name?: never;- displayName: string;- type: ExpressionType;- args(): ClauseArgDefinition[];- argType?(- index: number,- args: unknown[],- type: ExpressionType,- ): ExpressionType;- requiresFeature?: DatabaseFeature;- hasOptions?: boolean;- multiple?: boolean;- category?: MBQLClauseCategory;- validator?: (...args: any) => string | undefined;- description?(database: Database, reportTimezone?: string): string;- docsPage?: string;-};--export type MBQLClauseFunctionConfig = {- name: DefinedClauseName;- displayName: string;- type: ExpressionType;- args: ClauseArgDefinition[];- argType(index: number, args: unknown[], type: ExpressionType): ExpressionType;- requiresFeature?: DatabaseFeature;- hasOptions: boolean;- multiple: boolean;- category?: MBQLClauseCategory;- validator?: (...args: any) => string | undefined;- description?(database: Database, reportTimezone?: string): string;- docsPage?: string;-};-export type Hooks = {error?: (error: Error) => void;lexified?: (evt: { tokens: Token[] }) => void;diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterColumnPicker/FilterColumnPicker.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterColumnPicker/FilterColumnPicker.tsxindex 7c3875c09ef..9b5dcd2aecd 100644--- a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterColumnPicker/FilterColumnPicker.tsx+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterColumnPicker/FilterColumnPicker.tsx@@ -15,7 +15,6 @@ import { getColumnGroupIcon } from "metabase/common/utils/column-groups";import { useTranslateContent } from "metabase/i18n/hooks";import { PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";import {- type DefinedClauseName,clausesForMode,getClauseDefinition,} from "metabase/querying/expressions";@@ -54,7 +53,7 @@ export interface FilterColumnPickerProps {checkItemIsSelected?: (item: Item) => boolean;onColumnSelect: (item: ColumnListItem) => void;onSegmentSelect: (item: SegmentListItem) => void;- onExpressionSelect?: (clause?: DefinedClauseName) => void;+ onExpressionSelect?: (clause?: Lib.DefinedClauseName) => void;withCustomExpression?: boolean;withColumnGroupIcon?: boolean;diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.tsxindex e181f272468..5a47408dda4 100644--- a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.tsx+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.tsx@@ -1,7 +1,6 @@import { useDisclosure } from "@mantine/hooks";import { useCallback, useLayoutEffect, useMemo, useState } from "react";-import type { DefinedClauseName } from "metabase/querying/expressions";import * as Lib from "metabase-lib";import {@@ -56,7 +55,7 @@ export function FilterPicker({);const stageIndexes = useMemo(() => [stageIndex], [stageIndex]);const [initialExpressionClause, setInitialExpressionClause] =- useState<DefinedClauseName | null>(null);+ useState<Lib.DefinedClauseName | null>(null);const availableColumns = useMemo(() => Lib.expressionableColumns(query, stageIndex),[query, stageIndex],@@ -92,7 +91,7 @@ export function FilterPicker({handleChange(item.segment);};- const handleExpressionSelect = (clause?: DefinedClauseName) => {+ const handleExpressionSelect = (clause?: Lib.DefinedClauseName) => {setInitialExpressionClause(clause ?? null);openExpressionEditor();};diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/types.ts b/frontend/src/metabase/querying/filters/components/FilterPicker/types.tsindex 8e62835a9fc..b5e1e6b9de8 100644--- a/frontend/src/metabase/querying/filters/components/FilterPicker/types.ts+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/types.ts@@ -1,4 +1,3 @@-import type { DefinedClauseName } from "metabase/querying/expressions";import type * as Lib from "metabase-lib";export type FilterPickerWidgetProps = {@@ -37,6 +36,6 @@ export type SegmentListItem = Lib.SegmentDisplayInfo & {export type ExpressionClauseItem = {type: "expression-clause";- clause: DefinedClauseName;+ clause: Lib.DefinedClauseName;displayName: string;};diff --git a/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionColumnPicker/JoinColumnDropdown/JoinColumnDropdown.tsx b/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionColumnPicker/JoinColumnDropdown/JoinColumnDropdown.tsxindex 168cb43225f..11039d84303 100644--- a/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionColumnPicker/JoinColumnDropdown/JoinColumnDropdown.tsx+++ b/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionColumnPicker/JoinColumnDropdown/JoinColumnDropdown.tsx@@ -4,7 +4,6 @@ import {type ColumnListItem,QueryColumnPicker,} from "metabase/common/components/QueryColumnPicker";-import type { DefinedClauseName } from "metabase/querying/expressions";import * as Lib from "metabase-lib";import {@@ -46,7 +45,7 @@ export function JoinColumnDropdown({isEditingExpressionInitially(expression),);const [initialExpressionClause, setInitialExpressionClause] =- useState<DefinedClauseName | null>(null);+ useState<Lib.DefinedClauseName | null>(null);const { columns, columnGroups } = useMemo(() => {const getColumns = isLhsPicker@@ -75,7 +74,7 @@ export function JoinColumnDropdown({onClose();};- const handleExpressionClauseSelect = (clause?: DefinedClauseName) => {+ const handleExpressionClauseSelect = (clause?: Lib.DefinedClauseName) => {setInitialExpressionClause(clause ?? null);setIsEditingExpression(true);};