Skip to content

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

Nick/gdgt 2101 data reference ts (#74267)

Nick Fitzpatrick39bc06929146
diff --git a/frontend/src/metabase-types/api/database.ts b/frontend/src/metabase-types/api/database.ts
index d614abd539f..fa94f61f35c 100644
--- a/frontend/src/metabase-types/api/database.ts
+++ b/frontend/src/metabase-types/api/database.ts
@@ -68,6 +68,7 @@ export interface Database extends DatabaseData {
native_permissions: "write" | "none";
transforms_permissions?: "write" | "none";
initial_sync_status: InitialSyncStatus;
+ description?: string;
caveats?: string;
points_of_interest?: string;
created_at: ISO8601Time;
diff --git a/frontend/src/metabase-types/api/segment.ts b/frontend/src/metabase-types/api/segment.ts
index 3c6b41909e4..403ad6ae4a2 100644
--- a/frontend/src/metabase-types/api/segment.ts
+++ b/frontend/src/metabase-types/api/segment.ts
@@ -11,6 +11,8 @@ export interface Segment {
table_id: TableId;
table?: Table;
archived: boolean;
+ caveats?: string;
+ points_of_interest?: string;
// Backend always returns MBQL5 format
definition: DatasetQuery;
definition_description: string;
diff --git a/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx b/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
index 33086a6c498..6c92d76f901 100644
--- a/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
+++ b/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
@@ -15,12 +15,22 @@ import {
Text,
} from "metabase/ui";
import { isFK } from "metabase-lib/v1/types/utils/isa";
-import type { Field as ApiField, Field, FieldId } from "metabase-types/api";
+import type { Field, FieldId } from "metabase-types/api";
import S from "./FkTargetPicker.module.css";
+// Only the type-classification + FK target fields are read on the input
+// `field`; the rich `Field.table` shape is only needed on the candidate
+// `idFields`. Widening to this minimal shape lets callers pass
+// normalized/stub shapes without casting.
+export type FkTargetPickerField = {
+ effective_type?: Field["effective_type"];
+ semantic_type?: Field["semantic_type"];
+ fk_target_field_id?: Field["fk_target_field_id"];
+};
+
interface Props extends Omit<SelectProps, "data" | "value" | "onChange"> {
- field: ApiField;
+ field: FkTargetPickerField;
idFields: Field[];
value: FieldId | null;
onChange: (value: FieldId | null) => void;
@@ -167,7 +177,7 @@ function stringifyValue(value: FieldId | null): string | null {
return value === null ? null : JSON.stringify(value);
}
-function getFkFieldPlaceholder(field: ApiField, idFields: Field[]) {
+function getFkFieldPlaceholder(field: FkTargetPickerField, idFields: Field[]) {
const hasIdFields = idFields?.length > 0;
const isRestrictedFKTargetSelected =
isFK(field) &&
diff --git a/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx b/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
index 4bf80345f65..cb46bb5eaaf 100644
--- a/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
+++ b/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
@@ -10,8 +10,15 @@ import { getCompatibleSemanticTypes } from "./utils";
const NO_SEMANTIC_TYPE = null;
const NO_SEMANTIC_TYPE_STRING = "null";
+// Only the type-classification properties of `Field` are read; widening to
+// this minimal shape lets callers pass normalized/stub shapes without casting.
+export type SemanticTypePickerField = {
+ base_type?: Field["base_type"];
+ effective_type?: Field["effective_type"];
+};
+
interface Props extends Omit<SelectProps, "data" | "value" | "onChange"> {
- field: Field;
+ field: SemanticTypePickerField;
value: string | null;
onChange: (value: string | null) => void;
}
diff --git a/frontend/src/metabase/metadata/components/SemanticTypePicker/utils.ts b/frontend/src/metabase/metadata/components/SemanticTypePicker/utils.ts
index 80b52eaa7f1..46ec02d5b0c 100644
--- a/frontend/src/metabase/metadata/components/SemanticTypePicker/utils.ts
+++ b/frontend/src/metabase/metadata/components/SemanticTypePicker/utils.ts
@@ -4,7 +4,10 @@ import { isTypeFK, isTypePK, isa } from "metabase-lib/v1/types/utils/isa";
import type { Field } from "metabase-types/api";
export function getCompatibleSemanticTypes(
- field: Field,
+ field: {
+ base_type?: Field["base_type"];
+ effective_type?: Field["effective_type"];
+ },
currentValue: string | null,
) {
const fieldType = field.effective_type ?? field.base_type;
diff --git a/frontend/src/metabase/metadata/utils/field.ts b/frontend/src/metabase/metadata/utils/field.ts
index 4552fea7860..a3bc166379e 100644
--- a/frontend/src/metabase/metadata/utils/field.ts
+++ b/frontend/src/metabase/metadata/utils/field.ts
@@ -22,7 +22,10 @@ import { getSchemaDisplayName } from "./schema";
* there's no logic on FE to reliably decide whether two columns are comparable. Trying to come up with that in ad-hoc
* manner could disable some cases that users may depend on.
*/
-export function areFieldsComparable(field1: Field, field2: Field): boolean {
+export function areFieldsComparable(
+ field1: Pick<Field, "effective_type">,
+ field2: Pick<Field, "effective_type">,
+): boolean {
return field1.effective_type === "type/MongoBSONID" ||
field2.effective_type === "type/MongoBSONID"
? field1.effective_type === field2.effective_type
diff --git a/frontend/src/metabase/reference/components/Detail.jsx b/frontend/src/metabase/reference/components/Detail.tsx
similarity index 72%
rename from frontend/src/metabase/reference/components/Detail.jsx
rename to frontend/src/metabase/reference/components/Detail.tsx
index a13e33be219..26ad80baa4b 100644
--- a/frontend/src/metabase/reference/components/Detail.jsx
+++ b/frontend/src/metabase/reference/components/Detail.tsx
@@ -1,6 +1,4 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
import { memo } from "react";
import { Link } from "react-router";
import { t } from "ttag";
@@ -9,6 +7,23 @@ import CS from "metabase/css/core/index.css";
import S from "./Detail.module.css";
+interface DetailField {
+ name: string;
+ onChange: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+ error?: string;
+ touched?: boolean;
+}
+
+interface DetailProps {
+ name: string;
+ description?: string | null;
+ placeholder?: string;
+ subtitleClass?: string;
+ url?: string;
+ isEditing?: boolean;
+ field?: DetailField;
+}
+
const Detail = ({
name,
description,
@@ -17,7 +32,7 @@ const Detail = ({
url,
isEditing,
field,
-}) => (
+}: DetailProps) => (
<div className={cx(S.detail)}>
<div className={isEditing ? cx(S.detailBody, CS.flexFull) : S.detailBody}>
<div className={S.detailTitle}>
@@ -26,7 +41,7 @@ const Detail = ({
<div
className={cx(description ? S.detailSubtitle : S.detailSubtitleLight)}
>
- {isEditing ? (
+ {isEditing && field ? (
<textarea
className={S.detailTextarea}
name={field.name}
@@ -34,14 +49,14 @@ const Detail = ({
onChange={field.onChange}
//FIXME: use initialValues from redux forms instead of default value
// to allow for reinitializing on cancel (see GettingStartedGuide.jsx)
- defaultValue={description}
+ defaultValue={description ?? undefined}
/>
) : (
<span className={subtitleClass}>
{description || placeholder || t`No description yet`}
</span>
)}
- {isEditing && field.error && field.touched && (
+ {isEditing && field?.error && field?.touched && (
<span className={CS.textError}>{field.error}</span>
)}
</div>
@@ -49,15 +64,5 @@ const Detail = ({
</div>
);
-Detail.propTypes = {
- name: PropTypes.string.isRequired,
- url: PropTypes.string,
- description: PropTypes.string,
- placeholder: PropTypes.string,
- subtitleClass: PropTypes.string,
- isEditing: PropTypes.bool,
- field: PropTypes.object,
-};
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default memo(Detail);
diff --git a/frontend/src/metabase/reference/components/EditableReferenceHeader.jsx b/frontend/src/metabase/reference/components/EditableReferenceHeader.tsx
similarity index 71%
rename from frontend/src/metabase/reference/components/EditableReferenceHeader.jsx
rename to frontend/src/metabase/reference/components/EditableReferenceHeader.tsx
index 3c607e17a14..27ff0344195 100644
--- a/frontend/src/metabase/reference/components/EditableReferenceHeader.jsx
+++ b/frontend/src/metabase/reference/components/EditableReferenceHeader.tsx
@@ -1,5 +1,4 @@
import cx from "classnames";
-import PropTypes from "prop-types";
import { memo } from "react";
import { Link } from "react-router";
import { t } from "ttag";
@@ -8,12 +7,42 @@ import { Button } from "metabase/common/components/Button";
import L from "metabase/common/components/List/List.module.css";
import CS from "metabase/css/core/index.css";
import { Ellipsified, Icon, TextInputBlurChange } from "metabase/ui";
+import type { IconName } from "metabase-types/api";
import S from "./ReferenceHeader.module.css";
+interface FormField {
+ name: string;
+ onChange: (...args: unknown[]) => void;
+}
+
+interface EditableReferenceHeaderEntity {
+ schema?: string;
+ name?: string;
+ display_name?: string;
+}
+
+interface EditableReferenceHeaderUser {
+ is_superuser?: boolean;
+}
+
+interface EditableReferenceHeaderProps {
+ entity?: EditableReferenceHeaderEntity;
+ type?: string;
+ headerIcon?: IconName;
+ headerLink?: string;
+ name?: string;
+ user?: EditableReferenceHeaderUser | null;
+ isEditing?: boolean;
+ hasSingleSchema?: boolean;
+ hasDisplayName?: boolean;
+ startEditing?: () => void;
+ displayNameFormField?: FormField;
+ nameFormField?: FormField;
+}
+
const EditableReferenceHeader = ({
entity = {},
- table,
type,
headerIcon,
headerLink,
@@ -25,7 +54,7 @@ const EditableReferenceHeader = ({
startEditing,
displayNameFormField,
nameFormField,
-}) => (
+}: EditableReferenceHeaderProps) => (
<div className={CS.wrapper}>
<div className={cx(CS.relative, L.header)}>
<div className={cx(CS.flex, CS.alignCenter, CS.mr1)}>
@@ -47,21 +76,22 @@ const EditableReferenceHeader = ({
className={S.headerTextInput}
type="text"
name={
- hasDisplayName ? displayNameFormField.name : nameFormField.name
+ hasDisplayName ? displayNameFormField?.name : nameFormField?.name
}
placeholder={entity.name}
onChange={
hasDisplayName
- ? displayNameFormField.onChange
- : nameFormField.onChange
+ ? displayNameFormField?.onChange
+ : nameFormField?.onChange
}
+ value={undefined}
defaultValue={hasDisplayName ? entity.display_name : entity.name}
/>
) : (
[
<Ellipsified
key="1"
- className={!headerLink && CS.flexFull}
+ className={!headerLink ? CS.flexFull : undefined}
tooltipProps={{ w: "auto" }}
>
{name === "Details"
@@ -72,6 +102,7 @@ const EditableReferenceHeader = ({
</Ellipsified>,
headerLink && (
<Button
+ key="2"
primary
className={cx(CS.flex, CS.flexAlignRight, CS.mr2)}
style={{ fontSize: 14 }}
@@ -95,21 +126,6 @@ const EditableReferenceHeader = ({
</div>
</div>
);
-EditableReferenceHeader.propTypes = {
- entity: PropTypes.object,
- table: PropTypes.object,
- type: PropTypes.string,
- headerIcon: PropTypes.string,
- headerLink: PropTypes.string,
- name: PropTypes.string,
- user: PropTypes.object,
- isEditing: PropTypes.bool,
- hasSingleSchema: PropTypes.bool,
- hasDisplayName: PropTypes.bool,
- startEditing: PropTypes.func,
- displayNameFormField: PropTypes.object,
- nameFormField: PropTypes.object,
-};
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default memo(EditableReferenceHeader);
diff --git a/frontend/src/metabase/reference/components/Field.jsx b/frontend/src/metabase/reference/components/Field.tsx
similarity index 81%
rename from frontend/src/metabase/reference/components/Field.jsx
rename to frontend/src/metabase/reference/components/Field.tsx
index fc4d6df9cfb..2660180ea09 100644
--- a/frontend/src/metabase/reference/components/Field.jsx
+++ b/frontend/src/metabase/reference/components/Field.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { getIn } from "icepick";
-import PropTypes from "prop-types";
import { memo } from "react";
import { Link } from "react-router";
import { P, match } from "ts-pattern";
@@ -17,11 +15,45 @@ import {
import { getFieldCurrency } from "metabase/metadata/utils/field";
import { Box, Icon } from "metabase/ui";
import { isTypeCurrency, isTypeFK } from "metabase-lib/v1/types/utils/isa";
+import type {
+ Field as ApiField,
+ DatabaseId,
+ FieldFormattingSettings,
+ FieldId,
+ IconName,
+ NormalizedField,
+} from "metabase-types/api";
+
+import type { FormFieldEntry, StubbedField } from "../types";
import F from "./Field.module.css";
import { FieldFkTargetPicker } from "./FieldFkTargetPicker";
-const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
+interface FieldFormFields {
+ display_name: FormFieldEntry<string>;
+ description: FormFieldEntry<string | null>;
+ semantic_type: FormFieldEntry<string | null>;
+ fk_target_field_id: FormFieldEntry<FieldId | null>;
+ settings: FormFieldEntry<FieldFormattingSettings>;
+}
+
+interface FieldProps {
+ databaseId: DatabaseId;
+ field: ApiField | NormalizedField | StubbedField;
+ url: string;
+ icon?: IconName;
+ isEditing?: boolean;
+ formField: FieldFormFields;
+}
+
+const Field = ({
+ databaseId,
+ field,
+ url,
+ icon,
+ isEditing,
+ formField,
+}: FieldProps) => {
const semanticType =
typeof formField.semantic_type.value !== "undefined"
? formField.semantic_type.value
@@ -62,7 +94,7 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
}}
field={field}
fw="bold"
- value={semanticType}
+ value={semanticType ?? null}
onChange={(value) => {
formField.semantic_type.onChange({
target: {
@@ -82,7 +114,7 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
<span
className={
getIn(FIELD_SEMANTIC_TYPES_MAP, [
- field.semantic_type,
+ field.semantic_type ?? "",
"name",
])
? CS.textMedium
@@ -90,7 +122,7 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
}
>
{getIn(FIELD_SEMANTIC_TYPES_MAP, [
- field.semantic_type,
+ field.semantic_type ?? "",
"name",
]) || t`No field type`}
</span>
@@ -106,7 +138,9 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
databaseId={databaseId}
field={field}
value={
- formField.fk_target_field_id.value || field.fk_target_field_id
+ formField.fk_target_field_id.value ||
+ field.fk_target_field_id ||
+ null
}
onChange={(value) => {
formField.fk_target_field_id.onChange({
@@ -121,7 +155,7 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
)}
{isEditing && isTypeCurrency(semanticType) && (
- <Box Box mt="sm">
+ <Box mt="sm">
<CurrencyPicker
value={getFieldCurrency(
formField.settings.value ?? field.settings,
@@ -141,12 +175,14 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
{match({ description: field.description, isEditing })
.with({ isEditing: true }, () => {
+ const { value: _descriptionValue, ...descriptionRest } =
+ formField.description;
return (
<input
className={cx(F.fieldTextInput, CS.mb2, CS.mt1)}
type="text"
placeholder={t`No column description yet`}
- {...formField.description}
+ {...descriptionRest}
defaultValue={field.description ?? ""}
/>
);
@@ -163,15 +199,5 @@ const Field = ({ databaseId, field, url, icon, isEditing, formField }) => {
);
};
-Field.propTypes = {
- databaseId: PropTypes.number.isRequired,
- field: PropTypes.object.isRequired,
- url: PropTypes.string.isRequired,
- placeholder: PropTypes.string,
- icon: PropTypes.string,
- isEditing: PropTypes.bool,
- formField: PropTypes.object,
-};
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default memo(Field);
diff --git a/frontend/src/metabase/reference/components/FieldFkTargetPicker.tsx b/frontend/src/metabase/reference/components/FieldFkTargetPicker.tsx
index a61a92e8f2b..b17730ee30d 100644
--- a/frontend/src/metabase/reference/components/FieldFkTargetPicker.tsx
+++ b/frontend/src/metabase/reference/components/FieldFkTargetPicker.tsx
@@ -1,12 +1,13 @@
import { useListDatabaseIdFieldsQuery } from "metabase/api";
import { FkTargetPicker } from "metabase/metadata/components";
+import type { FkTargetPickerField } from "metabase/metadata/components/FkTargetPicker/FkTargetPicker";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
import type { SelectProps } from "metabase/ui";
-import type { DatabaseId, Field, FieldId } from "metabase-types/api";
+import type { DatabaseId, FieldId } from "metabase-types/api";
interface Props {
databaseId: DatabaseId;
- field: Field;
+ field: FkTargetPickerField;
value: FieldId | null;
onChange: (value: FieldId | null) => void;
comboboxProps?: SelectProps["comboboxProps"];
diff --git a/frontend/src/metabase/reference/components/FieldTypeDetail.jsx b/frontend/src/metabase/reference/components/FieldTypeDetail.tsx
similarity index 81%
rename from frontend/src/metabase/reference/components/FieldTypeDetail.jsx
rename to frontend/src/metabase/reference/components/FieldTypeDetail.tsx
index 59f957bebda..ea34dad0297 100644
--- a/frontend/src/metabase/reference/components/FieldTypeDetail.jsx
+++ b/frontend/src/metabase/reference/components/FieldTypeDetail.tsx
@@ -1,6 +1,5 @@
import cx from "classnames";
import { getIn } from "icepick";
-import PropTypes from "prop-types";
import { memo } from "react";
import { t } from "ttag";
@@ -13,9 +12,27 @@ import { getFieldCurrency } from "metabase/metadata/utils/field";
import D from "metabase/reference/components/Detail.module.css";
import { Box } from "metabase/ui";
import { isTypeCurrency, isTypeFK } from "metabase-lib/v1/types/utils/isa";
+import type {
+ Field as ApiField,
+ DatabaseId,
+ FieldFormattingSettings,
+ FieldId,
+ NormalizedField,
+} from "metabase-types/api";
+
+import type { FormFieldEntry, StubbedField } from "../types";
import { FieldFkTargetPicker } from "./FieldFkTargetPicker";
+interface FieldTypeDetailProps {
+ databaseId: DatabaseId;
+ field: ApiField | NormalizedField | StubbedField;
+ fieldTypeFormField: FormFieldEntry<string | null>;
+ foreignKeyFormField: FormFieldEntry<FieldId | null>;
+ fieldSettingsFormField: FormFieldEntry<FieldFormattingSettings>;
+ isEditing: boolean;
+}
+
const FieldTypeDetail = ({
databaseId,
field,
@@ -23,7 +40,7 @@ const FieldTypeDetail = ({
foreignKeyFormField,
fieldSettingsFormField,
isEditing,
-}) => {
+}: FieldTypeDetailProps) => {
const semanticType =
typeof fieldTypeFormField.value !== "undefined"
? fieldTypeFormField.value
@@ -49,7 +66,7 @@ const FieldTypeDetail = ({
}}
field={field}
fw="bold"
- value={semanticType}
+ value={semanticType ?? null}
onChange={(value) => {
fieldTypeFormField.onChange({
target: {
@@ -62,7 +79,7 @@ const FieldTypeDetail = ({
) : (
<span>
{getIn(FIELD_SEMANTIC_TYPES_MAP, [
- field.semantic_type,
+ field.semantic_type ?? "",
"name",
]) || t`No field type`}
</span>
@@ -89,7 +106,9 @@ const FieldTypeDetail = ({
<FieldFkTargetPicker
databaseId={databaseId}
field={field}
- value={foreignKeyFormField.value || field.fk_target_field_id}
+ value={
+ foreignKeyFormField.value || field.fk_target_field_id || null
+ }
/** bottom-start with flip: true opens down and shrinks height
* of popover to one line */
comboboxProps={{ position: "top-start" }}
@@ -110,14 +129,5 @@ const FieldTypeDetail = ({
);
};
-FieldTypeDetail.propTypes = {
- databaseId: PropTypes.number.isRequired,
- field: PropTypes.object.isRequired,
- fieldTypeFormField: PropTypes.object.isRequired,
- foreignKeyFormField: PropTypes.object.isRequired,
- fieldSettingsFormField: PropTypes.object.isRequired,
- isEditing: PropTypes.bool.isRequired,
-};
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default memo(FieldTypeDetail);
diff --git a/frontend/src/metabase/reference/components/Formula.tsx b/frontend/src/metabase/reference/components/Formula.tsx
index 9e768a17256..cc41a956e67 100644
--- a/frontend/src/metabase/reference/components/Formula.tsx
+++ b/frontend/src/metabase/reference/components/Formula.tsx
@@ -3,16 +3,14 @@ import { t } from "ttag";
import { QueryDefinition } from "metabase/querying/segments/components/QueryDefinition";
import { Icon, Transition, type TransitionProps } from "metabase/ui";
-import type { Segment } from "metabase-types/api";
+import type { DatasetQuery, TableId } from "metabase-types/api";
import S from "./Formula.module.css";
-type FormulaEntityProps = {
+type FormulaProps = {
type: "segment";
- entity: Segment;
-};
-
-type FormulaProps = FormulaEntityProps & {
+ definition: DatasetQuery;
+ tableId: TableId;
isExpanded: boolean;
expandFormula: () => void;
collapseFormula: () => void;
@@ -30,7 +28,8 @@ const TRANSITION: TransitionProps["transition"] = {
export const Formula = ({
type,
- entity,
+ definition,
+ tableId,
isExpanded,
expandFormula,
collapseFormula,
@@ -48,8 +47,8 @@ export const Formula = ({
<div className={S.formulaDefinition} style={styles}>
<QueryDefinition
className={S.formulaDefinitionInner}
- definition={entity.definition}
- tableId={entity.table_id}
+ definition={definition}
+ tableId={tableId}
/>
</div>
)}
diff --git a/frontend/src/metabase/reference/databases/DatabaseDetail.jsx b/frontend/src/metabase/reference/databases/DatabaseDetail.tsx
similarity index 75%
rename from frontend/src/metabase/reference/databases/DatabaseDetail.jsx
rename to frontend/src/metabase/reference/databases/DatabaseDetail.tsx
index ae5083084ae..6f003acaee7 100644
--- a/frontend/src/metabase/reference/databases/DatabaseDetail.jsx
+++ b/frontend/src/metabase/reference/databases/DatabaseDetail.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { push } from "react-router-redux";
import { t } from "ttag";
@@ -14,31 +12,39 @@ import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import * as actions from "metabase/reference/reference";
import { getShallowFields as getFields } from "metabase/selectors/metadata";
+import type { User } from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getDatabase,
getError,
getIsEditing,
getIsFormulaExpanded,
getLoading,
- getTable,
getUser,
} from "../selectors";
+import type { BaseDetailFormFields, StubbedDatabase } from "../types";
-const mapStateToProps = (state, props) => {
+interface DatabaseDetailFormFields extends BaseDetailFormFields {
+ revision_message?: string;
+}
+
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const entity = getDatabase(state, props) || {};
- const fields = getFields(state, props);
+ const fields = getFields(state);
return {
entity,
- table: getTable(state, props),
metadataFields: fields,
- loading: getLoading(state, props),
+ loading: getLoading(state),
// naming this 'error' will conflict with redux form
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
- isFormulaExpanded: getIsFormulaExpanded(state, props),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
+ isFormulaExpanded: getIsFormulaExpanded(state),
};
};
@@ -49,28 +55,23 @@ const mapDispatchToProps = {
onChangeLocation: push,
};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entity: PropTypes.object.isRequired,
- table: PropTypes.object,
- user: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- onSubmit: PropTypes.func.isRequired,
-};
+interface DatabaseDetailProps {
+ style: React.CSSProperties;
+ entity: StubbedDatabase;
+ user: User | null;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ loading?: boolean;
+ loadingError?: unknown;
+ // The action handler in reference.ts types its own props parameter.
+ onSubmit: (fields: DatabaseDetailFormFields, props: any) => void;
+}
-const DatabaseDetail = (props) => {
+const DatabaseDetail = (props: DatabaseDetailProps) => {
const {
style,
entity,
- table,
loadingError,
loading,
user,
@@ -86,13 +87,14 @@ const DatabaseDetail = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<DatabaseDetailFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
@@ -104,14 +106,13 @@ const DatabaseDetail = (props) => {
hasRevisionHistory={false}
onSubmit={handleSubmit}
endEditing={endEditing}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
submitting={isSubmitting}
revisionMessageFormField={getFormField("revision_message")}
/>
)}
<EditableReferenceHeader
entity={entity}
- table={table}
type="database"
name="Details"
headerIcon="database"
@@ -144,7 +145,6 @@ const DatabaseDetail = (props) => {
<ul>
<li className={CS.relative}>
<Detail
- id="description"
name={t`Description`}
description={entity.description}
placeholder={t`No description yet`}
@@ -154,7 +154,6 @@ const DatabaseDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="points_of_interest"
name={t`Why this database is interesting`}
description={entity.points_of_interest}
placeholder={t`Nothing interesting yet`}
@@ -164,7 +163,6 @@ const DatabaseDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="caveats"
name={t`Things to be aware of about this database`}
description={entity.caveats}
placeholder={t`Nothing to be aware of yet`}
@@ -181,7 +179,5 @@ const DatabaseDetail = (props) => {
);
};
-DatabaseDetail.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(mapStateToProps, mapDispatchToProps)(DatabaseDetail);
diff --git a/frontend/src/metabase/reference/databases/DatabaseDetailContainer.jsx b/frontend/src/metabase/reference/databases/DatabaseDetailContainer.tsx
similarity index 52%
rename from frontend/src/metabase/reference/databases/DatabaseDetailContainer.jsx
rename to frontend/src/metabase/reference/databases/DatabaseDetailContainer.tsx
index f9229049c42..0dd0e1b7abe 100644
--- a/frontend/src/metabase/reference/databases/DatabaseDetailContainer.jsx
+++ b/frontend/src/metabase/reference/databases/DatabaseDetailContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,14 +9,24 @@ import * as metadataActions from "metabase/redux/metadata";
import DatabaseDetail from "metabase/reference/databases/DatabaseDetail";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import { getDatabase, getDatabaseId, getIsEditing } from "../selectors";
+import type { StubbedDatabase } from "../types";
import DatabaseSidebar from "./DatabaseSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -25,27 +34,33 @@ const mapDispatchToProps = {
...actions,
};
-class DatabaseDetailContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadata(
- this.props,
- this.props.databaseId,
- );
+interface DatabaseDetailContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps (metadataActions spread)
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+}
+
+class DatabaseDetailContainer extends Component<DatabaseDetailContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadata(this.props, this.props.databaseId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: DatabaseDetailContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -68,8 +83,9 @@ class DatabaseDetailContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(DatabaseDetailContainer);
+)(DatabaseDetailContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/DatabaseList.jsx b/frontend/src/metabase/reference/databases/DatabaseList.tsx
similarity index 80%
rename from frontend/src/metabase/reference/databases/DatabaseList.jsx
rename to frontend/src/metabase/reference/databases/DatabaseList.tsx
index f317194ccbc..de62054346a 100644
--- a/frontend/src/metabase/reference/databases/DatabaseList.jsx
+++ b/frontend/src/metabase/reference/databases/DatabaseList.tsx
@@ -1,6 +1,4 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
import { Component } from "react";
import { t } from "ttag";
@@ -13,27 +11,29 @@ import { connect } from "metabase/redux";
import * as metadataActions from "metabase/redux/metadata";
import { NoDatabasesEmptyState } from "metabase/reference/databases/NoDatabasesEmptyState";
import { getShallowDatabases as getDatabases } from "metabase/selectors/metadata";
+import type { NormalizedDatabase } from "metabase-types/api";
import ReferenceHeader from "../components/ReferenceHeader";
+import type { StateWithReference } from "../selectors";
import { getError, getLoading } from "../selectors";
-const mapStateToProps = (state, props) => ({
- entities: getDatabases(state, props),
- loading: getLoading(state, props),
- loadingError: getError(state, props),
+interface DatabaseListProps {
+ entities: Record<string, NormalizedDatabase>;
+ loading?: boolean;
+ loadingError?: unknown;
+}
+
+const mapStateToProps = (state: StateWithReference) => ({
+ entities: getDatabases(state),
+ loading: getLoading(state),
+ loadingError: getError(state),
});
const mapDispatchToProps = {
...metadataActions,
};
-class DatabaseList extends Component {
- static propTypes = {
- entities: PropTypes.object.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- };
-
+class DatabaseList extends Component<DatabaseListProps> {
render() {
const { entities, loadingError, loading } = this.props;
@@ -44,7 +44,9 @@ class DatabaseList extends Component {
})
.sort((a, b) => {
const compared = a.name.localeCompare(b.name);
- return compared !== 0 ? compared : a.engine.localeCompare(b.engine);
+ return compared !== 0
+ ? compared
+ : (a.engine ?? "").localeCompare(b.engine ?? "");
});
return (
diff --git a/frontend/src/metabase/reference/databases/DatabaseListContainer.jsx b/frontend/src/metabase/reference/databases/DatabaseListContainer.tsx
similarity index 55%
rename from frontend/src/metabase/reference/databases/DatabaseListContainer.jsx
rename to frontend/src/metabase/reference/databases/DatabaseListContainer.tsx
index f64870099e0..d026c3ffd37 100644
--- a/frontend/src/metabase/reference/databases/DatabaseListContainer.jsx
+++ b/frontend/src/metabase/reference/databases/DatabaseListContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -11,11 +10,16 @@ import DatabaseList from "metabase/reference/databases/DatabaseList";
import BaseSidebar from "metabase/reference/guide/BaseSidebar";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import { getDatabaseId, getIsEditing } from "../selectors";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -23,23 +27,24 @@ const mapDispatchToProps = {
...actions,
};
-class DatabaseListContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- };
+interface DatabaseListContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ location: Location;
- async fetchContainerData() {
- await actions.wrappedFetchDatabases(this.props);
+ // From mapDispatchToProps (metadataActions spread)
+ fetchRealDatabases: (args: unknown) => Promise<unknown>;
+}
+
+class DatabaseListContainer extends Component<DatabaseListContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabases(this.props);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: DatabaseListContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -53,14 +58,15 @@ class DatabaseListContainer extends Component {
className={cx(CS.flexFull, CS.relative)}
sidebar={<BaseSidebar />}
>
- <DatabaseList {...this.props} />
+ <DatabaseList />
</SidebarLayout>
);
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(DatabaseListContainer);
+)(DatabaseListContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/DatabaseSidebar.tsx b/frontend/src/metabase/reference/databases/DatabaseSidebar.tsx
index ce96dd7e56b..eace40010ab 100644
--- a/frontend/src/metabase/reference/databases/DatabaseSidebar.tsx
+++ b/frontend/src/metabase/reference/databases/DatabaseSidebar.tsx
@@ -6,10 +6,11 @@ import { Breadcrumbs } from "metabase/common/components/Breadcrumbs";
import S from "metabase/common/components/Sidebar.module.css";
import { SidebarItem } from "metabase/common/components/SidebarItem";
import CS from "metabase/css/core/index.css";
-import type { Database } from "metabase-types/api";
+
+import type { StubbedDatabase } from "../types";
interface DatabaseSidebarProps {
- database: Database;
+ database: StubbedDatabase;
}
const DatabaseSidebar = ({ database }: DatabaseSidebarProps) => (
diff --git a/frontend/src/metabase/reference/databases/FieldDetail.jsx b/frontend/src/metabase/reference/databases/FieldDetail.tsx
similarity index 76%
rename from frontend/src/metabase/reference/databases/FieldDetail.jsx
rename to frontend/src/metabase/reference/databases/FieldDetail.tsx
index 538ef6b45f4..24cf6bc4092 100644
--- a/frontend/src/metabase/reference/databases/FieldDetail.jsx
+++ b/frontend/src/metabase/reference/databases/FieldDetail.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { push } from "react-router-redux";
import { t } from "ttag";
@@ -16,7 +14,10 @@ import EditableReferenceHeader from "metabase/reference/components/EditableRefer
import FieldTypeDetail from "metabase/reference/components/FieldTypeDetail";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { FieldId, User } from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getDatabase,
getError,
@@ -27,17 +28,34 @@ import {
getTable,
getUser,
} from "../selectors";
+import type {
+ BaseDetailFormFields,
+ FieldFormFieldsValues,
+ StubbedDatabase,
+ StubbedField,
+ StubbedTable,
+} from "../types";
import { getQuestionUrl } from "../utils";
-const interestingQuestions = (database, table, field, metadata) => {
+interface FieldDetailFormFields
+ extends BaseDetailFormFields, FieldFormFieldsValues {
+ revision_message?: string;
+}
+
+const interestingQuestions = (
+ database: StubbedDatabase,
+ table: StubbedTable,
+ field: StubbedField,
+ metadata: Metadata,
+) => {
return [
{
text: t`Number of ${table.display_name} grouped by ${field.display_name}`,
- icon: "bar",
+ icon: "bar" as const,
link: getQuestionUrl({
dbId: database.id,
tableId: table.id,
- fieldId: field.id,
+ fieldId: field.id as FieldId,
getCount: true,
visualization: "bar",
metadata,
@@ -45,11 +63,11 @@ const interestingQuestions = (database, table, field, metadata) => {
},
{
text: t`Number of ${table.display_name} grouped by ${field.display_name}`,
- icon: "pie",
+ icon: "pie" as const,
link: getQuestionUrl({
dbId: database.id,
tableId: table.id,
- fieldId: field.id,
+ fieldId: field.id as FieldId,
getCount: true,
visualization: "pie",
metadata,
@@ -57,18 +75,21 @@ const interestingQuestions = (database, table, field, metadata) => {
},
{
text: t`All distinct values of ${field.display_name}`,
- icon: "table2",
+ icon: "table2" as const,
link: getQuestionUrl({
dbId: database.id,
tableId: table.id,
- fieldId: field.id,
+ fieldId: field.id as FieldId,
metadata,
}),
},
];
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const entity = getField(state, props) || {};
return {
@@ -76,12 +97,12 @@ const mapStateToProps = (state, props) => {
field: entity,
table: getTable(state, props),
database: getDatabase(state, props),
- loading: getLoading(state, props),
+ loading: getLoading(state),
// naming this 'error' will conflict with redux form
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
- isFormulaExpanded: getIsFormulaExpanded(state, props),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
+ isFormulaExpanded: getIsFormulaExpanded(state),
};
};
@@ -92,27 +113,24 @@ const mapDispatchToProps = {
onChangeLocation: push,
};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entity: PropTypes.object.isRequired,
- field: PropTypes.object.isRequired,
- table: PropTypes.object,
- user: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- metadata: PropTypes.object,
- onSubmit: PropTypes.func.isRequired,
-};
+interface FieldDetailProps {
+ style: React.CSSProperties;
+ entity: StubbedField;
+ field: StubbedField;
+ table: StubbedTable;
+ user: User;
+ database: StubbedDatabase;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ loading?: boolean;
+ loadingError?: unknown;
+ metadata: Metadata;
+
+ onSubmit: (fields: FieldDetailFormFields, props: any) => void;
+}
-const FieldDetail = (props) => {
+const FieldDetail = (props: FieldDetailProps) => {
const {
style,
entity,
@@ -133,13 +151,14 @@ const FieldDetail = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<FieldDetailFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
@@ -151,14 +170,13 @@ const FieldDetail = (props) => {
hasRevisionHistory={false}
onSubmit={handleSubmit}
endEditing={endEditing}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
submitting={isSubmitting}
revisionMessageFormField={getFormField("revision_message")}
/>
)}
<EditableReferenceHeader
entity={entity}
- table={table}
type="field"
headerIcon="field"
name="Details"
@@ -191,7 +209,6 @@ const FieldDetail = (props) => {
<ul>
<li>
<Detail
- id="description"
name={t`Description`}
description={entity.description}
placeholder={t`No description yet`}
@@ -202,7 +219,6 @@ const FieldDetail = (props) => {
{!isEditing && (
<li>
<Detail
- id="name"
name={t`Actual name in database`}
description={entity.name}
subtitleClass={S.tableActualName}
@@ -211,7 +227,6 @@ const FieldDetail = (props) => {
)}
<li>
<Detail
- id="points_of_interest"
name={t`Why this field is interesting`}
description={entity.points_of_interest}
placeholder={t`Nothing interesting yet`}
@@ -221,7 +236,6 @@ const FieldDetail = (props) => {
</li>
<li>
<Detail
- id="caveats"
name={t`Things to be aware of about this field`}
description={entity.caveats}
placeholder={t`Nothing to be aware of yet`}
@@ -233,7 +247,6 @@ const FieldDetail = (props) => {
{!isEditing && (
<li>
<Detail
- id="base_type"
name={t`Data type`}
description={entity.database_type}
/>
@@ -241,12 +254,12 @@ const FieldDetail = (props) => {
)}
<li>
<FieldTypeDetail
- databaseId={table.db_id}
+ databaseId={table.db_id!}
field={entity}
fieldTypeFormField={getFormField("semantic_type")}
foreignKeyFormField={getFormField("fk_target_field_id")}
fieldSettingsFormField={getFormField("settings")}
- isEditing={isEditing}
+ isEditing={Boolean(isEditing)}
/>
</li>
{!isEditing && (
@@ -270,7 +283,8 @@ const FieldDetail = (props) => {
);
};
-FieldDetail.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(FieldDetail);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(FieldDetail as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/FieldDetailContainer.jsx b/frontend/src/metabase/reference/databases/FieldDetailContainer.tsx
similarity index 54%
rename from frontend/src/metabase/reference/databases/FieldDetailContainer.jsx
rename to frontend/src/metabase/reference/databases/FieldDetailContainer.tsx
index 82332c0fa16..bd50cfd1c65 100644
--- a/frontend/src/metabase/reference/databases/FieldDetailContainer.jsx
+++ b/frontend/src/metabase/reference/databases/FieldDetailContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -11,6 +10,12 @@ import FieldDetail from "metabase/reference/databases/FieldDetail";
import * as actions from "metabase/reference/reference";
import { getMetadata } from "metabase/selectors/metadata";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import {
getDatabase,
getDatabaseId,
@@ -18,16 +23,20 @@ import {
getIsEditing,
getTable,
} from "../selectors";
+import type { StubbedDatabase, StubbedField, StubbedTable } from "../types";
import FieldSidebar from "./FieldSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
table: getTable(state, props),
field: getField(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
- metadata: getMetadata(state, props),
+ isEditing: getIsEditing(state),
+ metadata: getMetadata(state),
});
const mapDispatchToProps = {
@@ -35,30 +44,35 @@ const mapDispatchToProps = {
...actions,
};
-class FieldDetailContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- table: PropTypes.object.isRequired,
- field: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- metadata: PropTypes.object,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadata(
- this.props,
- this.props.databaseId,
- );
+interface FieldDetailContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ table: StubbedTable;
+ field: StubbedField;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps (metadataActions spread)
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+}
+
+class FieldDetailContainer extends Component<FieldDetailContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadata(this.props, this.props.databaseId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: FieldDetailContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -83,8 +97,9 @@ class FieldDetailContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(FieldDetailContainer);
+)(FieldDetailContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/FieldList.jsx b/frontend/src/metabase/reference/databases/FieldList.tsx
similarity index 71%
rename from frontend/src/metabase/reference/databases/FieldList.jsx
rename to frontend/src/metabase/reference/databases/FieldList.tsx
index 7806f366da5..51571ab16ce 100644
--- a/frontend/src/metabase/reference/databases/FieldList.jsx
+++ b/frontend/src/metabase/reference/databases/FieldList.tsx
@@ -1,8 +1,5 @@
-/* eslint "react/prop-types": "warn" */
-/* eslint-disable react/no-unknown-property */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { EmptyState } from "metabase/common/components/EmptyState";
@@ -18,7 +15,14 @@ import Field from "metabase/reference/components/Field";
import F from "metabase/reference/components/Field.module.css";
import * as actions from "metabase/reference/reference";
import { getIconForField } from "metabase-lib/v1/metadata/utils/fields";
+import type {
+ FieldId,
+ IconName,
+ NormalizedField,
+ User,
+} from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getFieldsByTable,
@@ -27,23 +31,29 @@ import {
getTable,
getUser,
} from "../selectors";
+import type { FieldFormFieldsValues, StubbedTable } from "../types";
+
+type FieldListFormFields = Record<string, FieldFormFieldsValues>;
const emptyStateData = {
get message() {
return t`Fields in this table will appear here as they're added`;
},
- icon: "fields",
+ icon: "fields" as const,
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const data = getFieldsByTable(state, props);
return {
table: getTable(state, props),
entities: data,
- loading: getLoading(state, props),
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
+ loading: getLoading(state),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
};
};
@@ -53,25 +63,27 @@ const mapDispatchToProps = {
onSubmit: actions.rUpdateFields,
};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entities: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- user: PropTypes.object.isRequired,
- table: PropTypes.object.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- onSubmit: PropTypes.func.isRequired,
- "data-testid": PropTypes.string,
-};
+interface FieldListProps {
+ style: React.CSSProperties;
-const FieldList = (props) => {
+ entities: Record<string, NormalizedField>;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ user: User | null;
+ table: StubbedTable;
+ loading?: boolean;
+ loadingError?: unknown;
+ // The action handler in reference.ts types its own props parameter.
+ onSubmit: (
+ entities: Record<string, NormalizedField>,
+ fields: FieldListFormFields,
+ props: any,
+ ) => void;
+ "data-testid"?: string;
+}
+
+const FieldList = (props: FieldListProps) => {
const {
style,
entities,
@@ -91,18 +103,19 @@ const FieldList = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<FieldListFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(entities, fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(entities, fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
- const getNestedFormField = (id) => ({
+ const getNestedFormField = (id: string | number) => ({
display_name: getFormField(`${id}.display_name`),
description: getFormField(`${id}.description`),
semantic_type: getFormField(`${id}.semantic_type`),
@@ -115,12 +128,12 @@ const FieldList = (props) => {
style={style}
className={CS.full}
onSubmit={handleSubmit}
- testID={props["data-testid"]}
+ {...({ testID: props["data-testid"] } as Record<string, unknown>)}
>
{isEditing && (
<EditHeader
hasRevisionHistory={false}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
endEditing={endEditing}
submitting={isSubmitting}
/>
@@ -171,14 +184,16 @@ const FieldList = (props) => {
entity &&
entity.id &&
entity.name && (
- <li key={entity.id}>
+ <li key={String(entity.id)}>
<Field
- databaseId={table.db_id}
+ databaseId={table.db_id!}
field={entity}
url={`/reference/databases/${table.db_id}/tables/${table.id}/fields/${entity.id}`}
- icon={getIconForField(entity)}
+ icon={getIconForField(entity) as IconName}
isEditing={isEditing}
- formField={getNestedFormField(entity.id)}
+ formField={getNestedFormField(
+ entity.id as FieldId,
+ )}
/>
</li>
),
@@ -197,7 +212,8 @@ const FieldList = (props) => {
);
};
-FieldList.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(FieldList);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(FieldList as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/FieldListContainer.jsx b/frontend/src/metabase/reference/databases/FieldListContainer.tsx
similarity index 51%
rename from frontend/src/metabase/reference/databases/FieldListContainer.jsx
rename to frontend/src/metabase/reference/databases/FieldListContainer.tsx
index ab4ed366851..2f0ac396a0e 100644
--- a/frontend/src/metabase/reference/databases/FieldListContainer.jsx
+++ b/frontend/src/metabase/reference/databases/FieldListContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,20 +9,30 @@ import * as metadataActions from "metabase/redux/metadata";
import FieldList from "metabase/reference/databases/FieldList";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import {
getDatabase,
getDatabaseId,
getIsEditing,
getTable,
} from "../selectors";
+import type { StubbedDatabase, StubbedTable } from "../types";
import TableSidebar from "./TableSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
table: getTable(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -31,28 +40,34 @@ const mapDispatchToProps = {
...actions,
};
-class FieldListContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- table: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadata(
- this.props,
- this.props.databaseId,
- );
+interface FieldListContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ table: StubbedTable;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps (metadataActions spread)
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+}
+
+class FieldListContainer extends Component<FieldListContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadata(this.props, this.props.databaseId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: FieldListContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -75,5 +90,9 @@ class FieldListContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(FieldListContainer);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(FieldListContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/FieldSidebar.tsx b/frontend/src/metabase/reference/databases/FieldSidebar.tsx
index 77eba1a2215..b358e7ff7be 100644
--- a/frontend/src/metabase/reference/databases/FieldSidebar.tsx
+++ b/frontend/src/metabase/reference/databases/FieldSidebar.tsx
@@ -7,14 +7,14 @@ import S from "metabase/common/components/Sidebar.module.css";
import { SidebarItem } from "metabase/common/components/SidebarItem";
import CS from "metabase/css/core/index.css";
import MetabaseSettings from "metabase/utils/settings";
-import type { Database, Field, Table } from "metabase-types/api";
import { trackReferenceXRayClicked } from "../analytics";
+import type { StubbedDatabase, StubbedField, StubbedTable } from "../types";
interface FieldSidebarProps {
- database: Database;
- table: Table;
- field: Field;
+ database: StubbedDatabase;
+ table: StubbedTable;
+ field: StubbedField;
}
const FieldSidebar = ({ database, table, field }: FieldSidebarProps) => (
diff --git a/frontend/src/metabase/reference/databases/TableDetail.jsx b/frontend/src/metabase/reference/databases/TableDetail.tsx
similarity index 74%
rename from frontend/src/metabase/reference/databases/TableDetail.jsx
rename to frontend/src/metabase/reference/databases/TableDetail.tsx
index 4e25924c3b5..7051e5e04f3 100644
--- a/frontend/src/metabase/reference/databases/TableDetail.jsx
+++ b/frontend/src/metabase/reference/databases/TableDetail.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { push } from "react-router-redux";
import { t } from "ttag";
@@ -19,7 +17,10 @@ import {
getShallowFields as getFields,
getMetadata,
} from "metabase/selectors/metadata";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { User } from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getHasSingleSchema,
@@ -29,15 +30,20 @@ import {
getTable,
getUser,
} from "../selectors";
+import type { BaseDetailFormFields, StubbedTable } from "../types";
import { getQuestionUrl } from "../utils";
-const interestingQuestions = (table, metadata) => {
+interface TableDetailFormFields extends BaseDetailFormFields {
+ revision_message?: string;
+}
+
+const interestingQuestions = (table: StubbedTable, metadata: Metadata) => {
return [
{
text: t`Count of ${table.display_name}`,
- icon: "number",
+ icon: "number" as const,
link: getQuestionUrl({
- dbId: table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
getCount: true,
metadata,
@@ -45,31 +51,35 @@ const interestingQuestions = (table, metadata) => {
},
{
text: t`See raw data for ${table.display_name}`,
- icon: "table2",
+ icon: "table2" as const,
link: getQuestionUrl({
- dbId: table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
metadata,
}),
},
];
};
-const mapStateToProps = (state, props) => {
+
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const entity = getTable(state, props) || {};
- const fields = getFields(state, props);
+ const fields = getFields(state);
return {
entity,
table: getTable(state, props),
metadataFields: fields,
metadata: getMetadata(state),
- loading: getLoading(state, props),
+ loading: getLoading(state),
// naming this 'error' will conflict with redux form
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
hasSingleSchema: getHasSingleSchema(state, props),
- isFormulaExpanded: getIsFormulaExpanded(state, props),
+ isFormulaExpanded: getIsFormulaExpanded(state),
};
};
@@ -80,29 +90,23 @@ const mapDispatchToProps = {
onChangeLocation: push,
};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entity: PropTypes.object.isRequired,
- table: PropTypes.object,
- user: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- handleSubmit: PropTypes.func.isRequired,
- resetForm: PropTypes.func.isRequired,
- fields: PropTypes.object.isRequired,
- hasSingleSchema: PropTypes.bool,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- metadata: PropTypes.object.isRequired,
- onSubmit: PropTypes.func.isRequired,
-};
+interface TableDetailProps {
+ style: React.CSSProperties;
+ entity: StubbedTable;
+ table: StubbedTable;
+ user: User;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ hasSingleSchema?: boolean;
+ loading?: boolean;
+ loadingError?: unknown;
+ metadata: Metadata;
-const TableDetail = (props) => {
+ onSubmit: (fields: TableDetailFormFields, props: any) => void;
+}
+
+const TableDetail = (props: TableDetailProps) => {
const {
style,
entity,
@@ -124,13 +128,14 @@ const TableDetail = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<TableDetailFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
@@ -142,18 +147,17 @@ const TableDetail = (props) => {
hasRevisionHistory={false}
onSubmit={handleSubmit}
endEditing={endEditing}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
submitting={isSubmitting}
revisionMessageFormField={getFormField("revision_message")}
/>
)}
<EditableReferenceHeader
entity={entity}
- table={table}
type="table"
headerIcon="table2"
headerLink={getQuestionUrl({
- dbId: entity.db_id,
+ dbId: entity.db_id!,
tableId: entity.id,
metadata,
})}
@@ -187,7 +191,6 @@ const TableDetail = (props) => {
<ul>
<li>
<Detail
- id="description"
name={t`Description`}
description={entity.description}
placeholder={t`No description yet`}
@@ -198,7 +201,6 @@ const TableDetail = (props) => {
{!isEditing && (
<li>
<Detail
- id="name"
name={t`Actual name in database`}
description={entity.name}
subtitleClass={S.tableActualName}
@@ -207,7 +209,6 @@ const TableDetail = (props) => {
)}
<li>
<Detail
- id="points_of_interest"
name={t`Why this table is interesting`}
description={entity.points_of_interest}
placeholder={t`Nothing interesting yet`}
@@ -217,7 +218,6 @@ const TableDetail = (props) => {
</li>
<li>
<Detail
- id="caveats"
name={t`Things to be aware of about this table`}
description={entity.caveats}
placeholder={t`Nothing to be aware of yet`}
@@ -241,7 +241,8 @@ const TableDetail = (props) => {
);
};
-TableDetail.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(TableDetail);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(TableDetail as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableDetailContainer.jsx b/frontend/src/metabase/reference/databases/TableDetailContainer.tsx
similarity index 53%
rename from frontend/src/metabase/reference/databases/TableDetailContainer.jsx
rename to frontend/src/metabase/reference/databases/TableDetailContainer.tsx
index ae0f0dacae0..281738bb108 100644
--- a/frontend/src/metabase/reference/databases/TableDetailContainer.jsx
+++ b/frontend/src/metabase/reference/databases/TableDetailContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,20 +9,30 @@ import * as metadataActions from "metabase/redux/metadata";
import TableDetail from "metabase/reference/databases/TableDetail";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import {
getDatabase,
getDatabaseId,
getIsEditing,
getTable,
} from "../selectors";
+import type { StubbedDatabase, StubbedTable } from "../types";
import TableSidebar from "./TableSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
table: getTable(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -31,28 +40,34 @@ const mapDispatchToProps = {
...actions,
};
-class TableDetailContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- table: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadata(
- this.props,
- this.props.databaseId,
- );
+interface TableDetailContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ table: StubbedTable;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps (metadataActions spread)
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+}
+
+class TableDetailContainer extends Component<TableDetailContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadata(this.props, this.props.databaseId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: TableDetailContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -75,8 +90,9 @@ class TableDetailContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(TableDetailContainer);
+)(TableDetailContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableList.jsx b/frontend/src/metabase/reference/databases/TableList.tsx
similarity index 71%
rename from frontend/src/metabase/reference/databases/TableList.jsx
rename to frontend/src/metabase/reference/databases/TableList.tsx
index e1dffcb46a0..19280c66e4d 100644
--- a/frontend/src/metabase/reference/databases/TableList.jsx
+++ b/frontend/src/metabase/reference/databases/TableList.tsx
@@ -1,6 +1,4 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
import { Component } from "react";
import { t } from "ttag";
import _ from "underscore";
@@ -16,6 +14,7 @@ import * as metadataActions from "metabase/redux/metadata";
import R from "metabase/reference/Reference.module.css";
import ReferenceHeader from "../components/ReferenceHeader";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getDatabase,
getError,
@@ -28,26 +27,39 @@ const emptyStateData = {
get message() {
return t`Tables in this database will appear here as they're added`;
},
- icon: "table2",
+ icon: "table2" as const,
};
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
entities: getTablesByDatabase(state, props),
hasSingleSchema: getHasSingleSchema(state, props),
- loading: getLoading(state, props),
- loadingError: getError(state, props),
+ loading: getLoading(state),
+ loadingError: getError(state),
});
const mapDispatchToProps = {
...metadataActions,
};
-const createListItem = (table) => (
+interface TableLike {
+ id?: number | string;
+ name?: string;
+ display_name?: string;
+ description?: string;
+ initial_sync_status?: string;
+ db_id?: number;
+ schema_name?: string;
+}
+
+const createListItem = (table: TableLike) => (
<ListItem
data-testid="table-list-item"
key={table.id}
- name={table.display_name || table.name}
+ name={table.display_name || table.name || ""}
description={table.description}
disabled={table.initial_sync_status !== "complete"}
url={`/reference/databases/${table.db_id}/tables/${table.id}`}
@@ -55,18 +67,18 @@ const createListItem = (table) => (
/>
);
-const createSchemaSeparator = (table) => (
+const createSchemaSeparator = (table: TableLike) => (
<li className={R.schemaSeparator}>{table.schema_name}</li>
);
-export const separateTablesBySchema = (
- tables,
- createSchemaSeparator,
- createListItem,
-) => {
+export const separateTablesBySchema = <T extends TableLike, S, I>(
+ tables: Record<string, T> | T[],
+ createSchemaSeparator: (table: T) => S,
+ createListItem: (table: T) => I,
+): Array<I | [S, I] | undefined> => {
const sortedTables = _.chain(tables)
- .sortBy((t) => t.name)
- .sortBy((t) => t.schema_name)
+ .sortBy((table) => table.name)
+ .sortBy((table) => table.schema_name)
.value();
return sortedTables.map((table, index, sortedTables) => {
@@ -74,23 +86,22 @@ export const separateTablesBySchema = (
return;
}
// add schema header for first element and if schema is different from previous
- const previousTableId = Object.keys(sortedTables)[index - 1];
return index === 0 ||
- sortedTables[previousTableId].schema_name !== table.schema_name
+ sortedTables[index - 1].schema_name !== table.schema_name
? [createSchemaSeparator(table), createListItem(table)]
: createListItem(table);
});
};
-class TableList extends Component {
- static propTypes = {
- entities: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- hasSingleSchema: PropTypes.bool,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- };
+interface TableListProps {
+ entities: Record<string, TableLike>;
+ database: { name?: string };
+ hasSingleSchema?: boolean;
+ loading?: boolean;
+ loadingError?: unknown;
+}
+class TableList extends Component<TableListProps> {
render() {
const { entities, database, hasSingleSchema, loadingError, loading } =
this.props;
@@ -140,4 +151,7 @@ class TableList extends Component {
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(TableList);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(TableList as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableList.unit.spec.tsx b/frontend/src/metabase/reference/databases/TableList.unit.spec.tsx
index 3d576853b76..7817c53e4fc 100644
--- a/frontend/src/metabase/reference/databases/TableList.unit.spec.tsx
+++ b/frontend/src/metabase/reference/databases/TableList.unit.spec.tsx
@@ -51,7 +51,9 @@ function setup() {
return renderWithProviders(
<Route
path="/"
- component={() => <TableList params={{ databaseId }} style={{}} />}
+ component={() => (
+ <TableList params={{ databaseId: String(databaseId) }} />
+ )}
/>,
{ storeInitialState, withRouter: true },
);
diff --git a/frontend/src/metabase/reference/databases/TableListContainer.jsx b/frontend/src/metabase/reference/databases/TableListContainer.tsx
similarity index 50%
rename from frontend/src/metabase/reference/databases/TableListContainer.jsx
rename to frontend/src/metabase/reference/databases/TableListContainer.tsx
index 709d01dcfd1..02a1a850127 100644
--- a/frontend/src/metabase/reference/databases/TableListContainer.jsx
+++ b/frontend/src/metabase/reference/databases/TableListContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,14 +9,24 @@ import * as metadataActions from "metabase/redux/metadata";
import TableList from "metabase/reference/databases/TableList";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import { getDatabase, getDatabaseId, getIsEditing } from "../selectors";
+import type { StubbedDatabase } from "../types";
import DatabaseSidebar from "./DatabaseSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -25,27 +34,33 @@ const mapDispatchToProps = {
...actions,
};
-class TableListContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadata(
- this.props,
- this.props.databaseId,
- );
+interface TableListContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps (metadataActions spread)
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+}
+
+class TableListContainer extends Component<TableListContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadata(this.props, this.props.databaseId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: TableListContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -68,5 +83,9 @@ class TableListContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(TableListContainer);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(TableListContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableQuestions.jsx b/frontend/src/metabase/reference/databases/TableQuestions.tsx
similarity index 74%
rename from frontend/src/metabase/reference/databases/TableQuestions.jsx
rename to frontend/src/metabase/reference/databases/TableQuestions.tsx
index 24dd111a7c9..9a825f96c77 100644
--- a/frontend/src/metabase/reference/databases/TableQuestions.jsx
+++ b/frontend/src/metabase/reference/databases/TableQuestions.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import dayjs from "dayjs";
-import PropTypes from "prop-types";
import { Component } from "react";
import { t } from "ttag";
@@ -16,34 +14,41 @@ import * as metadataActions from "metabase/redux/metadata";
import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import visualizations from "metabase/visualizations";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Card } from "metabase-types/api";
import ReferenceHeader from "../components/ReferenceHeader";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getLoading,
getTable,
getTableQuestions,
} from "../selectors";
+import type { StubbedTable } from "../types";
import { getQuestionUrl } from "../utils";
-const emptyStateData = (table, metadata) => {
+const emptyStateData = (table: StubbedTable, metadata: Metadata) => {
return {
message: t`Questions about this table will appear here as they're added`,
- icon: "folder",
+ icon: "folder" as const,
action: t`Ask a question`,
link: getQuestionUrl({
- dbId: table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
metadata,
}),
};
};
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
table: getTable(state, props),
entities: getTableQuestions(state, props),
- loading: getLoading(state, props),
- loadingError: getError(state, props),
+ loading: getLoading(state),
+ loadingError: getError(state),
metadata: getMetadata(state),
});
@@ -51,15 +56,15 @@ const mapDispatchToProps = {
...metadataActions,
};
-class TableQuestions extends Component {
- static propTypes = {
- table: PropTypes.object.isRequired,
- metadata: PropTypes.object.isRequired,
- entities: PropTypes.object.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- };
+interface TableQuestionsProps {
+ table: StubbedTable;
+ metadata: Metadata;
+ entities: Card[];
+ loading?: boolean;
+ loadingError?: unknown;
+}
+class TableQuestions extends Component<TableQuestionsProps> {
render() {
const { entities, loadingError, loading, table, metadata } = this.props;
@@ -85,12 +90,12 @@ class TableQuestions extends Component {
entity.name && (
<ListItem
key={entity.id}
- name={entity.display_name || entity.name}
+ name={entity.name}
description={t`Created ${dayjs(
entity.created_at,
- ).fromNow()} by ${entity.creator.common_name}`}
+ ).fromNow()} by ${entity.creator?.common_name ?? ""}`}
url={Urls.card(entity)}
- icon={visualizations.get(entity.display).iconName}
+ icon={visualizations.get(entity.display)?.iconName}
/>
),
)}
@@ -109,4 +114,7 @@ class TableQuestions extends Component {
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(TableQuestions);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(TableQuestions as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableQuestionsContainer.jsx b/frontend/src/metabase/reference/databases/TableQuestionsContainer.tsx
similarity index 56%
rename from frontend/src/metabase/reference/databases/TableQuestionsContainer.jsx
rename to frontend/src/metabase/reference/databases/TableQuestionsContainer.tsx
index 1232afcc581..1cfb1ef457f 100644
--- a/frontend/src/metabase/reference/databases/TableQuestionsContainer.jsx
+++ b/frontend/src/metabase/reference/databases/TableQuestionsContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -11,20 +10,30 @@ import * as metadataActions from "metabase/redux/metadata";
import TableQuestions from "metabase/reference/databases/TableQuestions";
import * as actions from "metabase/reference/reference";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import {
getDatabase,
getDatabaseId,
getIsEditing,
getTable,
} from "../selectors";
+import type { StubbedDatabase, StubbedTable } from "../types";
import TableSidebar from "./TableSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
database: getDatabase(state, props),
table: getTable(state, props),
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -33,18 +42,28 @@ const mapDispatchToProps = {
...actions,
};
-class TableQuestionsContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- database: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- table: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchDatabaseMetadataAndQuestion(
+interface TableQuestionsContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ database: StubbedDatabase;
+ databaseId: number;
+ table: StubbedTable;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+ fetchQuestions: () => Promise<unknown>;
+}
+
+class TableQuestionsContainer extends Component<TableQuestionsContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchDatabaseMetadataAndQuestion(
this.props,
this.props.databaseId,
);
@@ -54,7 +73,7 @@ class TableQuestionsContainer extends Component {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: TableQuestionsContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -77,8 +96,9 @@ class TableQuestionsContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(TableQuestionsContainer);
+)(TableQuestionsContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/databases/TableSidebar.tsx b/frontend/src/metabase/reference/databases/TableSidebar.tsx
index ac2e22b3cd8..23cfc563576 100644
--- a/frontend/src/metabase/reference/databases/TableSidebar.tsx
+++ b/frontend/src/metabase/reference/databases/TableSidebar.tsx
@@ -7,13 +7,13 @@ import S from "metabase/common/components/Sidebar.module.css";
import { SidebarItem } from "metabase/common/components/SidebarItem";
import CS from "metabase/css/core/index.css";
import MetabaseSettings from "metabase/utils/settings";
-import type { Database, Table } from "metabase-types/api";
import { trackReferenceXRayClicked } from "../analytics";
+import type { StubbedDatabase, StubbedTable } from "../types";
interface TableSidebarProps {
- database: Database;
- table: Table;
+ database: StubbedDatabase;
+ table: StubbedTable;
}
const TableSidebar = ({ database, table }: TableSidebarProps) => (
diff --git a/frontend/src/metabase/reference/reference.js b/frontend/src/metabase/reference/reference.js
deleted file mode 100644
index b7f5491c160..00000000000
--- a/frontend/src/metabase/reference/reference.js
+++ /dev/null
@@ -1,231 +0,0 @@
-import { assoc } from "icepick";
-
-import { createAction, handleActions } from "metabase/redux";
-
-import { filterUntouchedFields, isEmptyObject } from "./utils.js";
-
-export const SET_ERROR = "metabase/reference/SET_ERROR";
-export const CLEAR_ERROR = "metabase/reference/CLEAR_ERROR";
-export const START_LOADING = "metabase/reference/START_LOADING";
-export const END_LOADING = "metabase/reference/END_LOADING";
-export const START_EDITING = "metabase/reference/START_EDITING";
-export const END_EDITING = "metabase/reference/END_EDITING";
-export const EXPAND_FORMULA = "metabase/reference/EXPAND_FORMULA";
-export const COLLAPSE_FORMULA = "metabase/reference/COLLAPSE_FORMULA";
-export const SHOW_DASHBOARD_MODAL = "metabase/reference/SHOW_DASHBOARD_MODAL";
-export const HIDE_DASHBOARD_MODAL = "metabase/reference/HIDE_DASHBOARD_MODAL";
-
-export const setError = createAction(SET_ERROR);
-
-export const clearError = createAction(CLEAR_ERROR);
-
-export const startLoading = createAction(START_LOADING);
-
-export const endLoading = createAction(END_LOADING);
-
-export const startEditing = createAction(START_EDITING);
-
-export const endEditing = createAction(END_EDITING);
-
-export const expandFormula = createAction(EXPAND_FORMULA);
-
-export const collapseFormula = createAction(COLLAPSE_FORMULA);
-
-//TODO: consider making an app-wide modal state reducer and related actions
-export const showDashboardModal = createAction(SHOW_DASHBOARD_MODAL);
-
-export const hideDashboardModal = createAction(HIDE_DASHBOARD_MODAL);
-
-// Helper functions. This is meant to be a transitional state to get things out of tryFetchData() and friends
-
-const fetchDataWrapper = (props, fn) => {
- return async (argument) => {
- props.clearError();
- props.startLoading();
- try {
- await fn(argument);
- } catch (error) {
- console.error(error);
- props.setError(error);
- }
-
- props.endLoading();
- };
-};
-
-export const wrappedFetchDatabaseMetadata = (props, databaseID) => {
- fetchDataWrapper(props, props.fetchDatabaseMetadata)(databaseID);
-};
-
-export const wrappedFetchDatabaseMetadataAndQuestion = async (
- props,
- databaseID,
-) => {
- fetchDataWrapper(props, async (dbID) => {
- await Promise.all([
- props.fetchDatabaseMetadata(dbID),
- props.fetchQuestions(),
- ]);
- })(databaseID);
-};
-export const wrappedFetchDatabases = (props) => {
- fetchDataWrapper(props, props.fetchRealDatabases)({});
-};
-export const wrappedFetchSegments = (props) => {
- fetchDataWrapper(props, props.fetchSegments)({});
-};
-
-export const wrappedFetchSegmentDetail = (props, segmentID) => {
- fetchDataWrapper(props, props.fetchSegmentTable)(segmentID);
-};
-
-export const wrappedFetchSegmentQuestions = async (props, segmentID) => {
- fetchDataWrapper(props, async (sID) => {
- await props.fetchSegments(sID);
- await Promise.all([props.fetchSegmentTable(sID), props.fetchQuestions()]);
- })(segmentID);
-};
-export const wrappedFetchSegmentRevisions = async (props, segmentID) => {
- fetchDataWrapper(props, async (sID) => {
- await props.fetchSegments(sID);
- await Promise.all([
- props.fetchSegmentRevisions(sID),
- props.fetchSegmentTable(sID),
- ]);
- })(segmentID);
-};
-export const wrappedFetchSegmentFields = async (props, segmentID) => {
- fetchDataWrapper(props, async (sID) => {
- await props.fetchSegments(sID);
- await Promise.all([
- props.fetchSegmentFields(sID),
- props.fetchSegmentTable(sID),
- ]);
- })(segmentID);
-};
-
-// This is called when a component gets a new set of props.
-// I *think* this is un-necessary in all cases as we're using multiple
-// components where the old code re-used the same component
-export const clearState = (props) => {
- props.endEditing();
- props.endLoading();
- props.clearError();
- props.collapseFormula();
-};
-
-// This is called on the success or failure of a form triggered update
-const resetForm = (props) => {
- props.resetForm();
- props.endLoading();
- props.endEditing();
-};
-
-// Update actions
-// these use the "fetchDataWrapper" for now. It should probably be renamed.
-// Using props to fire off actions, which imo should be refactored to
-// dispatch directly, since there is no actual dependence with the props
-// of that component
-
-const updateDataWrapper = (props, fn) => {
- return async (fields) => {
- props.clearError();
- props.startLoading();
- try {
- const editedFields = filterUntouchedFields(fields, props.entity);
- if (!isEmptyObject(editedFields)) {
- const newEntity = { ...props.entity, ...editedFields };
- await fn(newEntity);
- }
- } catch (error) {
- console.error(error);
- props.setError(error);
- }
- resetForm(props);
- };
-};
-
-export const rUpdateSegmentDetail = (formFields, props) => {
- return () => updateDataWrapper(props, props.updateSegment)(formFields);
-};
-export const rUpdateSegmentFieldDetail = (formFields, props) => {
- return () => updateDataWrapper(props, props.updateField)(formFields);
-};
-export const rUpdateDatabaseDetail = (formFields, props) => {
- return () => updateDataWrapper(props, props.updateDatabase)(formFields);
-};
-export const rUpdateTableDetail = (formFields, props) => {
- return () => updateDataWrapper(props, props.updateTable)(formFields);
-};
-export const rUpdateFieldDetail = (formFields, props) => {
- return () => updateDataWrapper(props, props.updateField)(formFields);
-};
-
-export const rUpdateFields = (fields, formFields, props) => {
- return async () => {
- props.startLoading();
- try {
- const updatedFields = Object.keys(formFields)
- .map((fieldId) => ({
- field: fields[fieldId],
- formField: filterUntouchedFields(
- formFields[fieldId],
- fields[fieldId],
- ),
- }))
- .filter(({ field, formField }) => !isEmptyObject(formField))
- .map(({ field, formField }) => ({ ...field, ...formField }));
-
- await Promise.all(updatedFields.map(props.updateField));
- } catch (error) {
- props.setError(error);
- console.error(error);
- }
-
- resetForm(props);
- };
-};
-
-const initialState = {
- error: null,
- isLoading: false,
- isEditing: false,
- isFormulaExpanded: false,
- isDashboardModalOpen: false,
-};
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default handleActions(
- {
- [SET_ERROR]: {
- throw: (state, { payload }) => assoc(state, "error", payload),
- },
- [CLEAR_ERROR]: {
- next: (state) => assoc(state, "error", null),
- },
- [START_LOADING]: {
- next: (state) => assoc(state, "isLoading", true),
- },
- [END_LOADING]: {
- next: (state) => assoc(state, "isLoading", false),
- },
- [START_EDITING]: {
- next: (state) => assoc(state, "isEditing", true),
- },
- [END_EDITING]: {
- next: (state) => assoc(state, "isEditing", false),
- },
- [EXPAND_FORMULA]: {
- next: (state) => assoc(state, "isFormulaExpanded", true),
- },
- [COLLAPSE_FORMULA]: {
- next: (state) => assoc(state, "isFormulaExpanded", false),
- },
- [SHOW_DASHBOARD_MODAL]: {
- next: (state) => assoc(state, "isDashboardModalOpen", true),
- },
- [HIDE_DASHBOARD_MODAL]: {
- next: (state) => assoc(state, "isDashboardModalOpen", false),
- },
- },
- initialState,
-);
diff --git a/frontend/src/metabase/reference/reference.ts b/frontend/src/metabase/reference/reference.ts
new file mode 100644
index 00000000000..3d143b5f8d6
--- /dev/null
+++ b/frontend/src/metabase/reference/reference.ts
@@ -0,0 +1,344 @@
+import { assoc } from "icepick";
+
+import { createAction, handleActions } from "metabase/redux";
+
+import { filterUntouchedFields, isEmptyObject } from "./utils";
+
+export const SET_ERROR = "metabase/reference/SET_ERROR";
+export const CLEAR_ERROR = "metabase/reference/CLEAR_ERROR";
+export const START_LOADING = "metabase/reference/START_LOADING";
+export const END_LOADING = "metabase/reference/END_LOADING";
+export const START_EDITING = "metabase/reference/START_EDITING";
+export const END_EDITING = "metabase/reference/END_EDITING";
+export const EXPAND_FORMULA = "metabase/reference/EXPAND_FORMULA";
+export const COLLAPSE_FORMULA = "metabase/reference/COLLAPSE_FORMULA";
+export const SHOW_DASHBOARD_MODAL = "metabase/reference/SHOW_DASHBOARD_MODAL";
+export const HIDE_DASHBOARD_MODAL = "metabase/reference/HIDE_DASHBOARD_MODAL";
+
+export const setError = createAction(SET_ERROR);
+
+export const clearError = createAction(CLEAR_ERROR);
+
+export const startLoading = createAction(START_LOADING);
+
+export const endLoading = createAction(END_LOADING);
+
+export const startEditing = createAction(START_EDITING);
+
+export const endEditing = createAction(END_EDITING);
+
+export const expandFormula = createAction(EXPAND_FORMULA);
+
+export const collapseFormula = createAction(COLLAPSE_FORMULA);
+
+//TODO: consider making an app-wide modal state reducer and related actions
+export const showDashboardModal = createAction(SHOW_DASHBOARD_MODAL);
+
+export const hideDashboardModal = createAction(HIDE_DASHBOARD_MODAL);
+
+export interface FetchProps {
+ clearError: () => void;
+ startLoading: () => void;
+ endLoading: () => void;
+ setError: (error: unknown) => void;
+}
+
+interface UpdateProps extends FetchProps {
+ resetForm: () => void;
+ endEditing: () => void;
+ entity: Record<string, unknown>;
+}
+
+interface DatabaseFetchProps extends FetchProps {
+ fetchDatabaseMetadata: (id: number) => Promise<unknown>;
+ fetchQuestions: () => Promise<unknown>;
+ fetchRealDatabases: (args: unknown) => Promise<unknown>;
+}
+
+interface SegmentFetchProps extends FetchProps {
+ fetchSegments: (id?: number) => Promise<unknown>;
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+ fetchSegmentRevisions: (id: number) => Promise<unknown>;
+ fetchSegmentFields: (id: number) => Promise<unknown>;
+ fetchQuestions: () => Promise<unknown>;
+}
+
+export interface ClearStateProps {
+ endEditing: () => void;
+ endLoading: () => void;
+ clearError: () => void;
+ collapseFormula: () => void;
+}
+
+interface UpdateEntityProps extends UpdateProps {
+ updateSegment: (entity: Record<string, unknown>) => Promise<unknown>;
+ updateField: (entity: Record<string, unknown>) => Promise<unknown>;
+ updateDatabase: (entity: Record<string, unknown>) => Promise<unknown>;
+ updateTable: (entity: Record<string, unknown>) => Promise<unknown>;
+}
+
+// Helper functions. This is meant to be a transitional state to get things out of tryFetchData() and friends
+
+const fetchDataWrapper = <T>(
+ props: FetchProps,
+ fn: (argument: T) => Promise<unknown>,
+) => {
+ return async (argument: T) => {
+ props.clearError();
+ props.startLoading();
+ try {
+ await fn(argument);
+ } catch (error) {
+ console.error(error);
+ props.setError(error);
+ }
+
+ props.endLoading();
+ };
+};
+
+export const wrappedFetchDatabaseMetadata = (
+ props: FetchProps & Pick<DatabaseFetchProps, "fetchDatabaseMetadata">,
+ databaseID: number,
+) => {
+ fetchDataWrapper(props, props.fetchDatabaseMetadata)(databaseID);
+};
+
+export const wrappedFetchDatabaseMetadataAndQuestion = async (
+ props: FetchProps &
+ Pick<DatabaseFetchProps, "fetchDatabaseMetadata" | "fetchQuestions">,
+ databaseID: number,
+) => {
+ fetchDataWrapper(props, async (dbID: number) => {
+ await Promise.all([
+ props.fetchDatabaseMetadata(dbID),
+ props.fetchQuestions(),
+ ]);
+ })(databaseID);
+};
+export const wrappedFetchDatabases = (
+ props: FetchProps & Pick<DatabaseFetchProps, "fetchRealDatabases">,
+) => {
+ fetchDataWrapper(props, props.fetchRealDatabases)({});
+};
+export const wrappedFetchSegments = (
+ props: FetchProps & Pick<SegmentFetchProps, "fetchSegments">,
+) => {
+ fetchDataWrapper(props, props.fetchSegments)(undefined);
+};
+
+export const wrappedFetchSegmentDetail = (
+ props: FetchProps & Pick<SegmentFetchProps, "fetchSegmentTable">,
+ segmentID: number,
+) => {
+ fetchDataWrapper(props, props.fetchSegmentTable)(segmentID);
+};
+
+export const wrappedFetchSegmentQuestions = async (
+ props: FetchProps &
+ Pick<
+ SegmentFetchProps,
+ "fetchSegments" | "fetchSegmentTable" | "fetchQuestions"
+ >,
+ segmentID: number,
+) => {
+ fetchDataWrapper(props, async (sID: number) => {
+ await props.fetchSegments(sID);
+ await Promise.all([props.fetchSegmentTable(sID), props.fetchQuestions()]);
+ })(segmentID);
+};
+export const wrappedFetchSegmentRevisions = async (
+ props: FetchProps &
+ Pick<
+ SegmentFetchProps,
+ "fetchSegments" | "fetchSegmentRevisions" | "fetchSegmentTable"
+ >,
+ segmentID: number,
+) => {
+ fetchDataWrapper(props, async (sID: number) => {
+ await props.fetchSegments(sID);
+ await Promise.all([
+ props.fetchSegmentRevisions(sID),
+ props.fetchSegmentTable(sID),
+ ]);
+ })(segmentID);
+};
+export const wrappedFetchSegmentFields = async (
+ props: FetchProps &
+ Pick<
+ SegmentFetchProps,
+ "fetchSegments" | "fetchSegmentFields" | "fetchSegmentTable"
+ >,
+ segmentID: number,
+) => {
+ fetchDataWrapper(props, async (sID: number) => {
+ await props.fetchSegments(sID);
+ await Promise.all([
+ props.fetchSegmentFields(sID),
+ props.fetchSegmentTable(sID),
+ ]);
+ })(segmentID);
+};
+
+// This is called when a component gets a new set of props.
+// I *think* this is un-necessary in all cases as we're using multiple
+// components where the old code re-used the same component
+export const clearState = (props: ClearStateProps) => {
+ props.endEditing();
+ props.endLoading();
+ props.clearError();
+ props.collapseFormula();
+};
+
+// This is called on the success or failure of a form triggered update
+const resetForm = (props: UpdateProps) => {
+ props.resetForm();
+ props.endLoading();
+ props.endEditing();
+};
+
+// Update actions
+// these use the "fetchDataWrapper" for now. It should probably be renamed.
+// Using props to fire off actions, which imo should be refactored to
+// dispatch directly, since there is no actual dependence with the props
+// of that component
+
+const updateDataWrapper = (
+ props: UpdateProps,
+ fn: (entity: Record<string, unknown>) => Promise<unknown>,
+) => {
+ return async (fields: Record<string, unknown>) => {
+ props.clearError();
+ props.startLoading();
+ try {
+ const editedFields = filterUntouchedFields(fields, props.entity);
+ if (!isEmptyObject(editedFields)) {
+ const newEntity = { ...props.entity, ...editedFields };
+ await fn(newEntity);
+ }
+ } catch (error) {
+ console.error(error);
+ props.setError(error);
+ }
+ resetForm(props);
+ };
+};
+
+export const rUpdateSegmentDetail = (
+ formFields: Record<string, unknown>,
+ props: UpdateEntityProps,
+) => {
+ return () => updateDataWrapper(props, props.updateSegment)(formFields);
+};
+export const rUpdateSegmentFieldDetail = (
+ formFields: Record<string, unknown>,
+ props: UpdateEntityProps,
+) => {
+ return () => updateDataWrapper(props, props.updateField)(formFields);
+};
+export const rUpdateDatabaseDetail = (
+ formFields: Record<string, unknown>,
+ props: UpdateEntityProps,
+) => {
+ return () => updateDataWrapper(props, props.updateDatabase)(formFields);
+};
+export const rUpdateTableDetail = (
+ formFields: Record<string, unknown>,
+ props: UpdateEntityProps,
+) => {
+ return () => updateDataWrapper(props, props.updateTable)(formFields);
+};
+export const rUpdateFieldDetail = (
+ formFields: Record<string, unknown>,
+ props: UpdateEntityProps,
+) => {
+ return () => updateDataWrapper(props, props.updateField)(formFields);
+};
+
+interface UpdateFieldsProps extends UpdateProps {
+ updateField: (field: Record<string, unknown>) => Promise<unknown>;
+}
+
+export const rUpdateFields = (
+ fields: Record<string, Record<string, unknown>>,
+ formFields: Record<string, Record<string, unknown>>,
+ props: UpdateFieldsProps,
+) => {
+ return async () => {
+ props.startLoading();
+ try {
+ const updatedFields = Object.keys(formFields)
+ .map((fieldId) => ({
+ field: fields[fieldId],
+ formField: filterUntouchedFields(
+ formFields[fieldId],
+ fields[fieldId],
+ ),
+ }))
+ .filter(({ formField }) => !isEmptyObject(formField))
+ .map(({ field, formField }) => ({ ...field, ...formField }));
+
+ await Promise.all(updatedFields.map(props.updateField));
+ } catch (error) {
+ props.setError(error);
+ console.error(error);
+ }
+
+ resetForm(props);
+ };
+};
+
+interface ReferenceState {
+ error: unknown;
+ isLoading: boolean;
+ isEditing: boolean;
+ isFormulaExpanded: boolean;
+ isDashboardModalOpen: boolean;
+}
+
+const initialState: ReferenceState = {
+ error: null,
+ isLoading: false,
+ isEditing: false,
+ isFormulaExpanded: false,
+ isDashboardModalOpen: false,
+};
+// eslint-disable-next-line import/no-default-export -- deprecated usage
+export default handleActions(
+ {
+ [SET_ERROR]: {
+ throw: (state: ReferenceState, { payload }: { payload: unknown }) =>
+ assoc(state, "error", payload),
+ },
+ [CLEAR_ERROR]: {
+ next: (state: ReferenceState) => assoc(state, "error", null),
+ },
+ [START_LOADING]: {
+ next: (state: ReferenceState) => assoc(state, "isLoading", true),
+ },
+ [END_LOADING]: {
+ next: (state: ReferenceState) => assoc(state, "isLoading", false),
+ },
+ [START_EDITING]: {
+ next: (state: ReferenceState) => assoc(state, "isEditing", true),
+ },
+ [END_EDITING]: {
+ next: (state: ReferenceState) => assoc(state, "isEditing", false),
+ },
+ [EXPAND_FORMULA]: {
+ next: (state: ReferenceState) => assoc(state, "isFormulaExpanded", true),
+ },
+ [COLLAPSE_FORMULA]: {
+ next: (state: ReferenceState) => assoc(state, "isFormulaExpanded", false),
+ },
+ [SHOW_DASHBOARD_MODAL]: {
+ next: (state: ReferenceState) =>
+ assoc(state, "isDashboardModalOpen", true),
+ },
+ [HIDE_DASHBOARD_MODAL]: {
+ next: (state: ReferenceState) =>
+ assoc(state, "isDashboardModalOpen", false),
+ },
+ },
+ initialState,
+);
diff --git a/frontend/src/metabase/reference/segments/SegmentDetail.jsx b/frontend/src/metabase/reference/segments/SegmentDetail.tsx
similarity index 65%
rename from frontend/src/metabase/reference/segments/SegmentDetail.jsx
rename to frontend/src/metabase/reference/segments/SegmentDetail.tsx
index f551cf7af16..3ea7da155e6 100644
--- a/frontend/src/metabase/reference/segments/SegmentDetail.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentDetail.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { Link } from "metabase/common/components/Link";
@@ -21,8 +19,11 @@ import {
getShallowFields as getFields,
getMetadata,
} from "metabase/selectors/metadata";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { User } from "metabase-types/api";
import S from "../components/Detail.module.css";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getIsEditing,
@@ -32,15 +33,28 @@ import {
getTable,
getUser,
} from "../selectors";
+import type {
+ BaseDetailFormFields,
+ StubbedSegment,
+ StubbedTable,
+} from "../types";
import { getQuestionUrl } from "../utils";
-const interestingQuestions = (table, segment, metadata) => {
+interface SegmentDetailFormFields extends BaseDetailFormFields {
+ revision_message?: string;
+}
+
+const interestingQuestions = (
+ table: StubbedTable,
+ segment: StubbedSegment,
+ metadata: Metadata,
+) => {
return [
{
text: t`Number of ${segment.name}`,
- icon: "number",
+ icon: "number" as const,
link: getQuestionUrl({
- dbId: table && table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
segmentId: segment.id,
getCount: true,
@@ -49,9 +63,9 @@ const interestingQuestions = (table, segment, metadata) => {
},
{
text: t`See all ${segment.name}`,
- icon: "table2",
+ icon: "table2" as const,
link: getQuestionUrl({
- dbId: table && table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
segmentId: segment.id,
metadata,
@@ -60,21 +74,24 @@ const interestingQuestions = (table, segment, metadata) => {
];
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const entity = getSegment(state, props) || {};
- const fields = getFields(state, props);
+ const fields = getFields(state);
return {
entity,
table: getTable(state, props),
metadataFields: fields,
metadata: getMetadata(state),
- loading: getLoading(state, props),
+ loading: getLoading(state),
// naming this 'error' will conflict with redux form
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
- isFormulaExpanded: getIsFormulaExpanded(state, props),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
+ isFormulaExpanded: getIsFormulaExpanded(state),
};
};
@@ -84,33 +101,30 @@ const mapDispatchToProps = {
onSubmit: actions.rUpdateSegmentDetail,
};
-const validate = (values) =>
+const validate = (values: SegmentDetailFormFields) =>
!values.revision_message
? { revision_message: t`Please enter a revision message` }
: {};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entity: PropTypes.object.isRequired,
- table: PropTypes.object,
- user: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- expandFormula: PropTypes.func.isRequired,
- collapseFormula: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- isFormulaExpanded: PropTypes.bool,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- metadata: PropTypes.object.isRequired,
- onSubmit: PropTypes.func.isRequired,
-};
+interface SegmentDetailProps {
+ style: React.CSSProperties;
+ entity: StubbedSegment;
+ table: StubbedTable | undefined;
+ user: User;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ expandFormula: () => void;
+ collapseFormula: () => void;
+ isFormulaExpanded?: boolean;
+ loading?: boolean;
+ loadingError?: unknown;
+ metadata: Metadata;
+
+ onSubmit: (fields: SegmentDetailFormFields, props: any) => void;
+}
-const SegmentDetail = (props) => {
+const SegmentDetail = (props: SegmentDetailProps) => {
const {
style,
entity,
@@ -134,15 +148,16 @@ const SegmentDetail = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<SegmentDetailFormFields>({
validate,
initialValues: {},
initialErrors: validate({}),
- onSubmit: (fields) =>
- onSubmit(fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
@@ -154,31 +169,32 @@ const SegmentDetail = (props) => {
hasRevisionHistory={true}
onSubmit={handleSubmit}
endEditing={endEditing}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
submitting={isSubmitting}
revisionMessageFormField={getFormField("revision_message")}
/>
)}
- <EditableReferenceHeader
- entity={entity}
- table={table}
- type="segment"
- headerIcon={modelIconMap.segment}
- headerLink={getQuestionUrl({
- dbId: table && table.db_id,
- tableId: entity.table_id,
- segmentId: entity.id,
- metadata,
- })}
- name={t`Details`}
- user={user}
- isEditing={isEditing}
- hasSingleSchema={false}
- hasDisplayName={false}
- startEditing={startEditing}
- displayNameFormField={getFormField("display_name")}
- nameFormField={getFormField("name")}
- />
+ {entity && table && (
+ <EditableReferenceHeader
+ entity={entity}
+ type="segment"
+ headerIcon={modelIconMap.segment}
+ headerLink={getQuestionUrl({
+ dbId: table.db_id!,
+ tableId: entity.table_id!,
+ segmentId: entity.id,
+ metadata,
+ })}
+ name={t`Details`}
+ user={user}
+ isEditing={isEditing}
+ hasSingleSchema={false}
+ hasDisplayName={false}
+ startEditing={startEditing}
+ displayNameFormField={getFormField("display_name")}
+ nameFormField={getFormField("name")}
+ />
+ )}
<LoadingAndErrorWrapper
loading={!loadingError && loading}
error={loadingError}
@@ -227,7 +243,6 @@ const SegmentDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="description"
name={t`Description`}
description={entity.description}
placeholder={t`No description yet`}
@@ -237,7 +252,6 @@ const SegmentDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="points_of_interest"
name={t`Why this Segment is interesting`}
description={entity.points_of_interest}
placeholder={t`Nothing interesting yet`}
@@ -247,7 +261,6 @@ const SegmentDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="caveats"
name={t`Things to be aware of about this Segment`}
description={entity.caveats}
placeholder={t`Nothing to be aware of yet`}
@@ -255,25 +268,28 @@ const SegmentDetail = (props) => {
field={getFormField("caveats")}
/>
</li>
- {!isEditing && (
+ {!isEditing && table && (
<li className={CS.relative}>
<UsefulQuestions
questions={interestingQuestions(table, entity, metadata)}
/>
</li>
)}
- {table && !isEditing && (
- <li className={cx(CS.relative, CS.mb4)}>
- <Formula
- type="segment"
- entity={entity}
- table={table}
- isExpanded={isFormulaExpanded}
- expandFormula={expandFormula}
- collapseFormula={collapseFormula}
- />
- </li>
- )}
+ {table &&
+ !isEditing &&
+ entity.definition &&
+ entity.table_id != null && (
+ <li className={cx(CS.relative, CS.mb4)}>
+ <Formula
+ type="segment"
+ definition={entity.definition}
+ tableId={entity.table_id}
+ isExpanded={Boolean(isFormulaExpanded)}
+ expandFormula={expandFormula}
+ collapseFormula={collapseFormula}
+ />
+ </li>
+ )}
</List>
</div>
</div>
@@ -283,7 +299,8 @@ const SegmentDetail = (props) => {
);
};
-SegmentDetail.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(SegmentDetail);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(SegmentDetail as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentDetailContainer.jsx b/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
similarity index 50%
rename from frontend/src/metabase/reference/segments/SegmentDetailContainer.jsx
rename to frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
index fba824a62ca..ee6fb9f421d 100644
--- a/frontend/src/metabase/reference/segments/SegmentDetailContainer.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -9,23 +8,27 @@ import { connect } from "metabase/redux";
import * as metadataActions from "metabase/redux/metadata";
import * as actions from "metabase/reference/reference";
import SegmentDetail from "metabase/reference/segments/SegmentDetail";
+import type { User } from "metabase-types/api";
-import {
- getDatabaseId,
- getIsEditing,
- getSegment,
- getSegmentId,
- getUser,
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
} from "../selectors";
+import { getIsEditing, getSegment, getSegmentId, getUser } from "../selectors";
+import type { StubbedSegment } from "../types";
import SegmentSidebar from "./SegmentSidebar";
-const mapStateToProps = (state, props) => ({
- user: getUser(state, props),
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
+ user: getUser(state),
segment: getSegment(state, props),
segmentId: getSegmentId(state, props),
- databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -33,26 +36,34 @@ const mapDispatchToProps = {
...actions,
};
-class SegmentDetailContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- user: PropTypes.object.isRequired,
- segment: PropTypes.object.isRequired,
- segmentId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchSegmentDetail(this.props, this.props.segmentId);
+interface SegmentDetailContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ user: User | null;
+ segment: StubbedSegment;
+ segmentId: number;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+}
+
+class SegmentDetailContainer extends Component<SegmentDetailContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegmentDetail(this.props, this.props.segmentId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: SegmentDetailContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -75,8 +86,9 @@ class SegmentDetailContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentDetailContainer);
+)(SegmentDetailContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx b/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
similarity index 75%
rename from frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx
rename to frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
index 4878e77d8a7..8f9304438a2 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { List } from "metabase/common/components/List";
@@ -17,7 +15,10 @@ import FieldTypeDetail from "metabase/reference/components/FieldTypeDetail";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
import { getMetadata } from "metabase/selectors/metadata";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { FieldId, User } from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getFieldBySegment,
@@ -27,48 +28,66 @@ import {
getTable,
getUser,
} from "../selectors";
+import type {
+ BaseDetailFormFields,
+ FieldFormFieldsValues,
+ StubbedField,
+ StubbedTable,
+} from "../types";
import { getQuestionUrl } from "../utils";
-const interestingQuestions = (table, field, metadata) => {
+interface SegmentFieldDetailFormFields
+ extends BaseDetailFormFields, FieldFormFieldsValues {
+ revision_message?: string;
+}
+
+const interestingQuestions = (
+ table: StubbedTable,
+ field: StubbedField,
+ metadata: Metadata,
+) => {
return [
{
text: t`Number of ${table && table.display_name} grouped by ${
field.display_name
}`,
- icon: "number",
+ icon: "number" as const,
link: getQuestionUrl({
- dbId: table && table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
- fieldId: field.id,
+ fieldId: field.id as FieldId,
getCount: true,
metadata,
}),
},
{
text: t`All distinct values of ${field.display_name}`,
- icon: "table2",
+ icon: "table2" as const,
link: getQuestionUrl({
- dbId: table && table.db_id,
+ dbId: table.db_id!,
tableId: table.id,
- fieldId: field.id,
+ fieldId: field.id as FieldId,
metadata,
}),
},
];
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const entity = getFieldBySegment(state, props) || {};
return {
entity,
table: getTable(state, props),
- loading: getLoading(state, props),
+ loading: getLoading(state),
// naming this 'error' will conflict with redux form
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
- isFormulaExpanded: getIsFormulaExpanded(state, props),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
+ isFormulaExpanded: getIsFormulaExpanded(state),
metadata: getMetadata(state),
};
};
@@ -79,25 +98,22 @@ const mapDispatchToProps = {
onSubmit: actions.rUpdateSegmentFieldDetail,
};
-const propTypes = {
- style: PropTypes.object.isRequired,
- entity: PropTypes.object.isRequired,
- table: PropTypes.object,
- user: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- metadata: PropTypes.object.isRequired,
- onSubmit: PropTypes.func.isRequired,
-};
+interface SegmentFieldDetailProps {
+ style: React.CSSProperties;
+ entity: StubbedField;
+ table: StubbedTable;
+ user: User;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ loading?: boolean;
+ loadingError?: unknown;
+ metadata: Metadata;
+
+ onSubmit: (fields: SegmentFieldDetailFormFields, props: any) => void;
+}
-const SegmentFieldDetail = (props) => {
+const SegmentFieldDetail = (props: SegmentFieldDetailProps) => {
const {
style,
entity,
@@ -118,13 +134,14 @@ const SegmentFieldDetail = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<SegmentFieldDetailFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit(fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
@@ -136,14 +153,13 @@ const SegmentFieldDetail = (props) => {
hasRevisionHistory={false}
onSubmit={handleSubmit}
endEditing={endEditing}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
submitting={isSubmitting}
revisionMessageFormField={getFormField("revision_message")}
/>
)}
<EditableReferenceHeader
entity={entity}
- table={table}
headerIcon="field"
name={t`Details`}
type="field"
@@ -167,7 +183,6 @@ const SegmentFieldDetail = (props) => {
<List>
<li className={CS.relative}>
<Detail
- id="description"
name={t`Description`}
description={entity.description}
placeholder={t`No description yet`}
@@ -178,7 +193,6 @@ const SegmentFieldDetail = (props) => {
{!isEditing && (
<li className={CS.relative}>
<Detail
- id="name"
name={t`Actual name in database`}
description={entity.name}
subtitleClass={S.tableActualName}
@@ -187,7 +201,6 @@ const SegmentFieldDetail = (props) => {
)}
<li className={CS.relative}>
<Detail
- id="points_of_interest"
name={t`Why this field is interesting`}
description={entity.points_of_interest}
placeholder={t`Nothing interesting yet`}
@@ -197,7 +210,6 @@ const SegmentFieldDetail = (props) => {
</li>
<li className={CS.relative}>
<Detail
- id="caveats"
name={t`Things to be aware of about this field`}
description={entity.caveats}
placeholder={t`Nothing to be aware of yet`}
@@ -209,7 +221,6 @@ const SegmentFieldDetail = (props) => {
{!isEditing && (
<li className={CS.relative}>
<Detail
- id="base_type"
name={t`Data type`}
description={entity.database_type}
/>
@@ -217,12 +228,12 @@ const SegmentFieldDetail = (props) => {
)}
<li className={CS.relative}>
<FieldTypeDetail
- databaseId={table.db_id}
+ databaseId={table.db_id!}
field={entity}
fieldTypeFormField={getFormField("semantic_type")}
foreignKeyFormField={getFormField("fk_target_field_id")}
fieldSettingsFormField={getFormField("settings")}
- isEditing={isEditing}
+ isEditing={Boolean(isEditing)}
/>
</li>
{!isEditing && (
@@ -241,7 +252,8 @@ const SegmentFieldDetail = (props) => {
);
};
-SegmentFieldDetail.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(SegmentFieldDetail);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(SegmentFieldDetail as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.jsx b/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
similarity index 51%
rename from frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.jsx
rename to frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
index 975ce61d824..6f6080f3eec 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,15 +9,25 @@ import * as metadataActions from "metabase/redux/metadata";
import * as actions from "metabase/reference/reference";
import SegmentFieldDetail from "metabase/reference/segments/SegmentFieldDetail";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import { getField, getIsEditing, getSegment, getSegmentId } from "../selectors";
+import type { StubbedField, StubbedSegment } from "../types";
import SegmentFieldSidebar from "./SegmentFieldSidebar";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
segment: getSegment(state, props),
segmentId: getSegmentId(state, props),
field: getField(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -26,26 +35,36 @@ const mapDispatchToProps = {
...actions,
};
-class SegmentFieldDetailContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- segment: PropTypes.object.isRequired,
- segmentId: PropTypes.number.isRequired,
- field: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchSegmentFields(this.props, this.props.segmentId);
+interface SegmentFieldDetailContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ segment: StubbedSegment;
+ segmentId: number;
+ field: StubbedField;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegments: (id?: number) => Promise<unknown>;
+ fetchSegmentFields: (id: number) => Promise<unknown>;
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+}
+
+class SegmentFieldDetailContainer extends Component<SegmentFieldDetailContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegmentFields(this.props, this.props.segmentId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: SegmentFieldDetailContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -68,8 +87,9 @@ class SegmentFieldDetailContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentFieldDetailContainer);
+)(SegmentFieldDetailContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldList.jsx b/frontend/src/metabase/reference/segments/SegmentFieldList.tsx
similarity index 70%
rename from frontend/src/metabase/reference/segments/SegmentFieldList.jsx
rename to frontend/src/metabase/reference/segments/SegmentFieldList.tsx
index 46432d0ae5a..e3d15d3cbb5 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldList.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldList.tsx
@@ -1,7 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
import { useFormik } from "formik";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { EmptyState } from "metabase/common/components/EmptyState";
@@ -19,7 +17,14 @@ import Field from "metabase/reference/components/Field";
import F from "metabase/reference/components/Field.module.css";
import * as actions from "metabase/reference/reference";
import { getIconForField } from "metabase-lib/v1/metadata/utils/fields";
+import type {
+ FieldId,
+ IconName,
+ NormalizedField,
+ User,
+} from "metabase-types/api";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getFieldsBySegment,
@@ -28,23 +33,33 @@ import {
getSegment,
getUser,
} from "../selectors";
+import type {
+ FieldFormFieldsValues,
+ StubbedSegment,
+ StubbedTable,
+} from "../types";
+
+type SegmentFieldListFormFields = Record<string, FieldFormFieldsValues>;
const emptyStateData = {
get message() {
return t`Fields in this table will appear here as they're added`;
},
- icon: "fields",
+ icon: "fields" as const,
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
const data = getFieldsBySegment(state, props);
return {
segment: getSegment(state, props),
entities: data,
- loading: getLoading(state, props),
- loadingError: getError(state, props),
- user: getUser(state, props),
- isEditing: getIsEditing(state, props),
+ loading: getLoading(state),
+ loadingError: getError(state),
+ user: getUser(state),
+ isEditing: getIsEditing(state),
};
};
@@ -54,25 +69,26 @@ const mapDispatchToProps = {
onSubmit: actions.rUpdateFields,
};
-const propTypes = {
- segment: PropTypes.object.isRequired,
- style: PropTypes.object.isRequired,
- entities: PropTypes.object.isRequired,
- isEditing: PropTypes.bool,
- startEditing: PropTypes.func.isRequired,
- endEditing: PropTypes.func.isRequired,
- startLoading: PropTypes.func.isRequired,
- endLoading: PropTypes.func.isRequired,
- setError: PropTypes.func.isRequired,
- updateField: PropTypes.func.isRequired,
- user: PropTypes.object.isRequired,
- table: PropTypes.object.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- onSubmit: PropTypes.func,
-};
+interface SegmentFieldListProps {
+ segment: StubbedSegment;
+ style: React.CSSProperties;
+ entities: Record<string, NormalizedField>;
+ isEditing?: boolean;
+ startEditing: () => void;
+ endEditing: () => void;
+ user: User | null;
+ table: StubbedTable;
+ loading?: boolean;
+ loadingError?: unknown;
+ // The action handler in reference.ts types its own props parameter.
+ onSubmit?: (
+ entities: Record<string, NormalizedField>,
+ fields: SegmentFieldListFormFields,
+ props: any,
+ ) => void;
+}
-const SegmentFieldList = (props) => {
+const SegmentFieldList = (props: SegmentFieldListProps) => {
const {
segment,
style,
@@ -93,19 +109,21 @@ const SegmentFieldList = (props) => {
getFieldMeta,
handleSubmit,
handleReset,
- } = useFormik({
+ } = useFormik<SegmentFieldListFormFields>({
initialValues: {},
- onSubmit: (fields) =>
- onSubmit(entities, fields, { ...props, resetForm: handleReset }),
+ onSubmit: (fields): void => {
+ onSubmit?.(entities, fields, { ...props, resetForm: handleReset });
+ },
});
- const getFormField = (name) => ({
+ const getFormField = (name: string) => ({
...getFieldProps(name),
...getFieldMeta(name),
});
- const getNestedFormField = (id) => ({
+ const getNestedFormField = (id: string | number) => ({
display_name: getFormField(`${id}.display_name`),
+ description: getFormField(`${id}.description`),
semantic_type: getFormField(`${id}.semantic_type`),
fk_target_field_id: getFormField(`${id}.fk_target_field_id`),
settings: getFormField(`${id}.settings`),
@@ -116,7 +134,7 @@ const SegmentFieldList = (props) => {
{isEditing && (
<EditHeader
hasRevisionHistory={false}
- reinitializeForm={handleReset}
+ reinitializeForm={() => handleReset(undefined)}
endEditing={endEditing}
submitting={isSubmitting}
/>
@@ -165,14 +183,14 @@ const SegmentFieldList = (props) => {
entity &&
entity.id &&
entity.name && (
- <li className={CS.relative} key={entity.id}>
+ <li className={CS.relative} key={String(entity.id)}>
<Field
- databaseId={table.db_id}
+ databaseId={table.db_id!}
field={entity}
url={`/reference/segments/${segment.id}/fields/${entity.id}`}
- icon={getIconForField(entity)}
+ icon={getIconForField(entity) as IconName}
isEditing={isEditing}
- formField={getNestedFormField(entity.id)}
+ formField={getNestedFormField(entity.id as FieldId)}
/>
</li>
),
@@ -191,7 +209,8 @@ const SegmentFieldList = (props) => {
);
};
-SegmentFieldList.propTypes = propTypes;
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(SegmentFieldList);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(SegmentFieldList as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldListContainer.jsx b/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
similarity index 50%
rename from frontend/src/metabase/reference/segments/SegmentFieldListContainer.jsx
rename to frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
index d2785cc0078..5ce4e34e6f9 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldListContainer.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -9,7 +8,14 @@ import { connect } from "metabase/redux";
import * as metadataActions from "metabase/redux/metadata";
import * as actions from "metabase/reference/reference";
import SegmentFieldList from "metabase/reference/segments/SegmentFieldList";
+import type { User } from "metabase-types/api";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import {
getIsEditing,
getSegment,
@@ -17,15 +23,19 @@ import {
getTable,
getUser,
} from "../selectors";
+import type { StubbedSegment, StubbedTable } from "../types";
import SegmentSidebar from "./SegmentSidebar";
-const mapStateToProps = (state, props) => ({
- user: getUser(state, props),
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
+ user: getUser(state),
segment: getSegment(state, props),
segmentId: getSegmentId(state, props),
table: getTable(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -33,26 +43,37 @@ const mapDispatchToProps = {
...actions,
};
-class SegmentFieldListContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- user: PropTypes.object.isRequired,
- segment: PropTypes.object.isRequired,
- segmentId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchSegmentFields(this.props, this.props.segmentId);
+interface SegmentFieldListContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ user: User | null;
+ segment: StubbedSegment;
+ segmentId: number;
+ table: StubbedTable;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegments: (id?: number) => Promise<unknown>;
+ fetchSegmentFields: (id: number) => Promise<unknown>;
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+}
+
+class SegmentFieldListContainer extends Component<SegmentFieldListContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegmentFields(this.props, this.props.segmentId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: SegmentFieldListContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -75,8 +96,9 @@ class SegmentFieldListContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentFieldListContainer);
+)(SegmentFieldListContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx b/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
index 2927c83603e..a3717e310fc 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
@@ -5,11 +5,12 @@ import { Breadcrumbs } from "metabase/common/components/Breadcrumbs";
import S from "metabase/common/components/Sidebar.module.css";
import { SidebarItem } from "metabase/common/components/SidebarItem";
import CS from "metabase/css/core/index.css";
-import type { Field, Segment } from "metabase-types/api";
+
+import type { StubbedField, StubbedSegment } from "../types";
interface SegmentFieldSidebarProps {
- segment: Segment;
- field: Field;
+ segment: StubbedSegment;
+ field: StubbedField;
}
const SegmentFieldSidebar = ({ segment, field }: SegmentFieldSidebarProps) => (
diff --git a/frontend/src/metabase/reference/segments/SegmentListContainer.jsx b/frontend/src/metabase/reference/segments/SegmentListContainer.tsx
similarity index 55%
rename from frontend/src/metabase/reference/segments/SegmentListContainer.jsx
rename to frontend/src/metabase/reference/segments/SegmentListContainer.tsx
index f0a56a92003..96f0e12be57 100644
--- a/frontend/src/metabase/reference/segments/SegmentListContainer.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentListContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -11,11 +10,20 @@ import BaseSidebar from "metabase/reference/guide/BaseSidebar";
import * as actions from "metabase/reference/reference";
import { SegmentList } from "metabase/reference/segments/SegmentList";
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
import { getDatabaseId, getIsEditing } from "../selectors";
-const mapStateToProps = (state, props) => ({
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -23,23 +31,31 @@ const mapDispatchToProps = {
...actions,
};
-class SegmentListContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
+interface SegmentListContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
- async fetchContainerData() {
- await actions.wrappedFetchSegments(this.props);
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegments: (id?: number) => Promise<unknown>;
+}
+
+class SegmentListContainer extends Component<SegmentListContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegments(this.props);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: SegmentListContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -62,8 +78,9 @@ class SegmentListContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentListContainer);
+)(SegmentListContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentQuestions.jsx b/frontend/src/metabase/reference/segments/SegmentQuestions.tsx
similarity index 70%
rename from frontend/src/metabase/reference/segments/SegmentQuestions.jsx
rename to frontend/src/metabase/reference/segments/SegmentQuestions.tsx
index 302cca6b5e6..0a198c9493b 100644
--- a/frontend/src/metabase/reference/segments/SegmentQuestions.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentQuestions.tsx
@@ -1,6 +1,4 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { AdminAwareEmptyState } from "metabase/common/components/AdminAwareEmptyState";
@@ -16,25 +14,36 @@ import * as metadataActions from "metabase/redux/metadata";
import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import visualizations from "metabase/visualizations";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
import ReferenceHeader from "../components/ReferenceHeader";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import { getSegment, getTableBySegment } from "../selectors";
+import type { StubbedSegment, StubbedTable } from "../types";
import { getDescription, getQuestionUrl } from "../utils";
-const emptyStateData = (table, segment, metadata) => {
+const emptyStateData = (
+ table: StubbedTable,
+ segment: StubbedSegment,
+ metadata: Metadata,
+) => {
return {
message: t`Questions about this segment will appear here as they're added`,
- icon: "folder",
+ icon: "folder" as const,
action: t`Ask a question`,
link: getQuestionUrl({
- dbId: table && table.db_id,
- tableId: segment.table_id,
+ dbId: table.db_id!,
+ tableId: segment.table_id!,
segmentId: segment.id,
metadata,
}),
};
};
-const mapStateToProps = (state, props) => ({
+
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
segment: getSegment(state, props),
table: getTableBySegment(state, props),
metadata: getMetadata(state),
@@ -44,13 +53,25 @@ const mapDispatchToProps = {
...metadataActions,
};
-const SegmentQuestionsInner = ({ style, table, segment, metadata }) => {
+interface SegmentQuestionsInnerProps {
+ style: React.CSSProperties;
+ table: StubbedTable;
+ segment: StubbedSegment;
+ metadata: Metadata;
+}
+
+const SegmentQuestionsInner = ({
+ style,
+ table,
+ segment,
+ metadata,
+}: SegmentQuestionsInnerProps) => {
const {
data = [],
isLoading,
error,
} = useQuestionListQuery({
- query: { f: "using_segment", model_id: segment.id },
+ query: { f: "using_segment" as any, model_id: segment.id },
});
return (
@@ -71,10 +92,10 @@ const SegmentQuestionsInner = ({ style, table, segment, metadata }) => {
question.displayName() && (
<ListItem
key={question.id()}
- name={question.displayName()}
+ name={question.displayName() ?? ""}
description={getDescription(question)}
url={Urls.card(question.card())}
- icon={visualizations.get(question.display()).iconName}
+ icon={visualizations.get(question.display())?.iconName}
/>
),
)}
@@ -82,9 +103,11 @@ const SegmentQuestionsInner = ({ style, table, segment, metadata }) => {
</div>
) : (
<div className={S.empty}>
- <AdminAwareEmptyState
- {...emptyStateData(table, segment, metadata)}
- />
+ {table && segment && metadata && (
+ <AdminAwareEmptyState
+ {...emptyStateData(table, segment, metadata)}
+ />
+ )}
</div>
)
}
@@ -93,14 +116,7 @@ const SegmentQuestionsInner = ({ style, table, segment, metadata }) => {
);
};
-SegmentQuestionsInner.propTypes = {
- table: PropTypes.object,
- segment: PropTypes.object.isRequired,
- style: PropTypes.object.isRequired,
- metadata: PropTypes.object.isRequired,
-};
-
export const SegmentQuestions = connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentQuestionsInner);
+)(SegmentQuestionsInner as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.jsx b/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
similarity index 50%
rename from frontend/src/metabase/reference/segments/SegmentQuestionsContainer.jsx
rename to frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
index 450ad56fc5c..d47bafdb9f7 100644
--- a/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
@@ -1,6 +1,5 @@
-/* eslint "react/prop-types": "warn" */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { Location } from "history";
import { Component } from "react";
import { SidebarLayout } from "metabase/common/components/SidebarLayout";
@@ -10,23 +9,27 @@ import { connect } from "metabase/redux";
import * as metadataActions from "metabase/redux/metadata";
import * as actions from "metabase/reference/reference";
import { SegmentQuestions } from "metabase/reference/segments/SegmentQuestions";
+import type { User } from "metabase-types/api";
-import {
- getDatabaseId,
- getIsEditing,
- getSegment,
- getSegmentId,
- getUser,
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
} from "../selectors";
+import { getIsEditing, getSegment, getSegmentId, getUser } from "../selectors";
+import type { StubbedSegment } from "../types";
import SegmentSidebar from "./SegmentSidebar";
-const mapStateToProps = (state, props) => ({
- user: getUser(state, props),
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
+ user: getUser(state),
segment: getSegment(state, props),
segmentId: getSegmentId(state, props),
- databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
+ isEditing: getIsEditing(state),
});
const mapDispatchToProps = {
@@ -35,29 +38,36 @@ const mapDispatchToProps = {
...actions,
};
-class SegmentQuestionsContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- user: PropTypes.object.isRequired,
- segment: PropTypes.object.isRequired,
- segmentId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchSegmentQuestions(
- this.props,
- this.props.segmentId,
- );
+interface SegmentQuestionsContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ user: User | null;
+ segment: StubbedSegment;
+ segmentId: number;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegments: (id?: number) => Promise<unknown>;
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+ fetchQuestions: () => Promise<unknown>;
+}
+
+class SegmentQuestionsContainer extends Component<SegmentQuestionsContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegmentQuestions(this.props, this.props.segmentId);
}
UNSAFE_componentWillMount() {
this.fetchContainerData();
}
- UNSAFE_componentWillReceiveProps(newProps) {
+ UNSAFE_componentWillReceiveProps(newProps: SegmentQuestionsContainerProps) {
if (this.props.location.pathname === newProps.location.pathname) {
return;
}
@@ -80,8 +90,9 @@ class SegmentQuestionsContainer extends Component {
}
}
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
mapStateToProps,
mapDispatchToProps,
-)(SegmentQuestionsContainer);
+)(SegmentQuestionsContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentRevisions.jsx b/frontend/src/metabase/reference/segments/SegmentRevisions.tsx
similarity index 70%
rename from frontend/src/metabase/reference/segments/SegmentRevisions.jsx
rename to frontend/src/metabase/reference/segments/SegmentRevisions.tsx
index a833126d807..1c527f2f7c3 100644
--- a/frontend/src/metabase/reference/segments/SegmentRevisions.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentRevisions.tsx
@@ -1,6 +1,5 @@
import cx from "classnames";
import { getIn } from "icepick";
-import PropTypes from "prop-types";
import { Component } from "react";
import { t } from "ttag";
@@ -14,8 +13,14 @@ import { connect } from "metabase/redux";
import * as metadataActions from "metabase/redux/metadata";
import { getShallowTables as getTables } from "metabase/selectors/metadata";
import { assignUserColors } from "metabase/ui/colors/formatting-colors";
+import type {
+ NormalizedTable,
+ Revision as RevisionData,
+ User,
+} from "metabase-types/api";
import ReferenceHeader from "../components/ReferenceHeader";
+import type { ReferenceRouteProps, StateWithReference } from "../selectors";
import {
getError,
getLoading,
@@ -23,6 +28,7 @@ import {
getSegmentRevisions,
getUser,
} from "../selectors";
+import type { StubbedSegment } from "../types";
const emptyStateData = {
get message() {
@@ -30,14 +36,17 @@ const emptyStateData = {
},
};
-const mapStateToProps = (state, props) => {
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => {
return {
revisions: getSegmentRevisions(state, props),
segment: getSegment(state, props),
- tables: getTables(state, props),
- user: getUser(state, props),
- loading: getLoading(state, props),
- loadingError: getError(state, props),
+ tables: getTables(state),
+ user: getUser(state),
+ loading: getLoading(state),
+ loadingError: getError(state),
};
};
@@ -45,30 +54,30 @@ const mapDispatchToProps = {
...metadataActions,
};
-class SegmentRevisions extends Component {
- static propTypes = {
- style: PropTypes.object.isRequired,
- revisions: PropTypes.object.isRequired,
- segment: PropTypes.object.isRequired,
- tables: PropTypes.object.isRequired,
- user: PropTypes.object.isRequired,
- loading: PropTypes.bool,
- loadingError: PropTypes.object,
- };
+interface SegmentRevisionsProps {
+ style: React.CSSProperties;
+ revisions: Record<string, RevisionData>;
+ segment: StubbedSegment;
+ tables: Record<string, NormalizedTable>;
+ user: User;
+ loading?: boolean;
+ loadingError?: unknown;
+}
+class SegmentRevisions extends Component<SegmentRevisionsProps> {
render() {
const { style, revisions, segment, tables, user, loading, loadingError } =
this.props;
const entity = segment;
- const userColorAssignments =
+ const userColorAssignments: Record<string | number, string> =
user && Object.keys(revisions).length > 0
? assignUserColors(
Object.values(revisions).map((revision) =>
- getIn(revision, ["user", "id"]),
+ String(getIn(revision, ["user", "id"])),
),
- user.id,
+ String(user.id),
)
: {};
@@ -83,7 +92,9 @@ class SegmentRevisions extends Component {
error={loadingError}
>
{() =>
- Object.keys(revisions).length > 0 && tables[entity.table_id] ? (
+ Object.keys(revisions).length > 0 &&
+ entity.table_id != null &&
+ tables[entity.table_id] ? (
<div className={CS.wrapper}>
<div
className={cx(
@@ -101,12 +112,12 @@ class SegmentRevisions extends Component {
<Revision
key={revision.id}
revision={revision || {}}
- tableId={entity.table_id}
- objectName={entity.name}
+ tableId={entity.table_id!}
+ objectName={entity.name!}
currentUser={user || {}}
userColor={
userColorAssignments[
- getIn(revision, ["user", "id"])
+ getIn(revision, ["user", "id"]) as string
]
}
/>
@@ -129,4 +140,7 @@ class SegmentRevisions extends Component {
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(mapStateToProps, mapDispatchToProps)(SegmentRevisions);
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(SegmentRevisions as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.jsx b/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.jsx
deleted file mode 100644
index 6ab93c1f0f3..00000000000
--- a/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.jsx
+++ /dev/null
@@ -1,85 +0,0 @@
-/* eslint "react/prop-types": "warn" */
-import cx from "classnames";
-import PropTypes from "prop-types";
-import { Component } from "react";
-
-import { SidebarLayout } from "metabase/common/components/SidebarLayout";
-import CS from "metabase/css/core/index.css";
-import { connect } from "metabase/redux";
-import * as metadataActions from "metabase/redux/metadata";
-import * as actions from "metabase/reference/reference";
-import SegmentRevisions from "metabase/reference/segments/SegmentRevisions";
-
-import {
- getDatabaseId,
- getIsEditing,
- getSegment,
- getSegmentId,
- getUser,
-} from "../selectors";
-
-import SegmentSidebar from "./SegmentSidebar";
-
-const mapStateToProps = (state, props) => ({
- user: getUser(state, props),
- segment: getSegment(state, props),
- segmentId: getSegmentId(state, props),
- databaseId: getDatabaseId(state, props),
- isEditing: getIsEditing(state, props),
-});
-
-const mapDispatchToProps = {
- ...metadataActions,
- ...actions,
-};
-
-class SegmentRevisionsContainer extends Component {
- static propTypes = {
- params: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- databaseId: PropTypes.number.isRequired,
- user: PropTypes.object.isRequired,
- segment: PropTypes.object.isRequired,
- segmentId: PropTypes.number.isRequired,
- isEditing: PropTypes.bool,
- };
-
- async fetchContainerData() {
- await actions.wrappedFetchSegmentRevisions(
- this.props,
- this.props.segmentId,
- );
- }
-
- UNSAFE_componentWillMount() {
- this.fetchContainerData();
- }
-
- UNSAFE_componentWillReceiveProps(newProps) {
- if (this.props.location.pathname === newProps.location.pathname) {
- return;
- }
-
- actions.clearState(newProps);
- }
-
- render() {
- const { user, segment, isEditing } = this.props;
-
- return (
- <SidebarLayout
- className={cx(CS.flexFull, CS.relative)}
- style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentSidebar segment={segment} user={user} />}
- >
- <SegmentRevisions {...this.props} />
- </SidebarLayout>
- );
- }
-}
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(
- mapStateToProps,
- mapDispatchToProps,
-)(SegmentRevisionsContainer);
diff --git a/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx b/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx
new file mode 100644
index 00000000000..0bb042d53bd
--- /dev/null
+++ b/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx
@@ -0,0 +1,96 @@
+import cx from "classnames";
+import type { Location } from "history";
+import { Component } from "react";
+
+import { SidebarLayout } from "metabase/common/components/SidebarLayout";
+import CS from "metabase/css/core/index.css";
+import { connect } from "metabase/redux";
+import * as metadataActions from "metabase/redux/metadata";
+import * as actions from "metabase/reference/reference";
+import SegmentRevisions from "metabase/reference/segments/SegmentRevisions";
+import type { User } from "metabase-types/api";
+
+import type { ClearStateProps, FetchProps } from "../reference";
+import type {
+ ReferenceRouteParams,
+ ReferenceRouteProps,
+ StateWithReference,
+} from "../selectors";
+import { getIsEditing, getSegment, getSegmentId, getUser } from "../selectors";
+import type { StubbedSegment } from "../types";
+
+import SegmentSidebar from "./SegmentSidebar";
+
+const mapStateToProps = (
+ state: StateWithReference,
+ props: ReferenceRouteProps,
+) => ({
+ user: getUser(state),
+ segment: getSegment(state, props),
+ segmentId: getSegmentId(state, props),
+ isEditing: getIsEditing(state),
+});
+
+const mapDispatchToProps = {
+ ...metadataActions,
+ ...actions,
+};
+
+interface SegmentRevisionsContainerProps extends FetchProps, ClearStateProps {
+ // From React Router
+ params: ReferenceRouteParams;
+ location: Location;
+
+ // From route definition / parent
+ style: React.CSSProperties;
+
+ // From mapStateToProps
+ user: User | null;
+ segment: StubbedSegment;
+ segmentId: number;
+ isEditing?: boolean;
+
+ // From mapDispatchToProps
+ fetchSegments: (id?: number) => Promise<unknown>;
+ fetchSegmentRevisions: (id: number) => Promise<unknown>;
+ fetchSegmentTable: (id: number) => Promise<unknown>;
+}
+
+class SegmentRevisionsContainer extends Component<SegmentRevisionsContainerProps> {
+ fetchContainerData() {
+ actions.wrappedFetchSegmentRevisions(this.props, this.props.segmentId);
+ }
+
+ UNSAFE_componentWillMount() {
+ this.fetchContainerData();
+ }
+
+ UNSAFE_componentWillReceiveProps(newProps: SegmentRevisionsContainerProps) {
+ if (this.props.location.pathname === newProps.location.pathname) {
+ return;
+ }
+
+ actions.clearState(newProps);
+ }
+
+ render() {
+ const { user, segment, isEditing } = this.props;
+
+ return (
+ <SidebarLayout
+ className={cx(CS.flexFull, CS.relative)}
+ style={isEditing ? { paddingTop: "43px" } : {}}
+ sidebar={<SegmentSidebar segment={segment} user={user} />}
+ >
+ <SegmentRevisions {...this.props} />
+ </SidebarLayout>
+ );
+ }
+}
+
+// connect HOC tangle: action-type constants in `actions` + JS-typed metadata thunks.
+// eslint-disable-next-line import/no-default-export -- deprecated usage
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
+)(SegmentRevisionsContainer as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentSidebar.tsx b/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
index 88dbe6e80dd..d897ed2c101 100644
--- a/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
@@ -7,12 +7,13 @@ import S from "metabase/common/components/Sidebar.module.css";
import { SidebarItem } from "metabase/common/components/SidebarItem";
import CS from "metabase/css/core/index.css";
import MetabaseSettings from "metabase/utils/settings";
-import type { Segment, User } from "metabase-types/api";
+import type { User } from "metabase-types/api";
import { trackReferenceXRayClicked } from "../analytics";
+import type { StubbedSegment } from "../types";
interface SegmentSidebarProps {
- segment: Segment;
+ segment: StubbedSegment;
user?: User | null;
}
diff --git a/frontend/src/metabase/reference/selectors.js b/frontend/src/metabase/reference/selectors.js
deleted file mode 100644
index 91b9dddfb4c..00000000000
--- a/frontend/src/metabase/reference/selectors.js
+++ /dev/null
@@ -1,111 +0,0 @@
-import { createSelector } from "@reduxjs/toolkit";
-import { getIn } from "icepick";
-
-import {
- getShallowDatabases as getDatabases,
- getShallowFields as getFields,
- getShallowSegments as getSegments,
- getShallowTables as getTables,
-} from "metabase/selectors/metadata";
-
-import { idsToObjectMap } from "./utils";
-
-export const getUser = (state, props) => state.currentUser;
-
-export const getSegmentId = (state, props) =>
- Number.parseInt(props.params.segmentId);
-export const getSegment = createSelector(
- [getSegmentId, getSegments],
- (segmentId, segments) => segments[segmentId] || { id: segmentId },
-);
-
-export const getDatabaseId = (state, props) =>
- Number.parseInt(props.params.databaseId);
-
-export const getDatabase = createSelector(
- [getDatabaseId, getDatabases],
- (databaseId, databases) => databases[databaseId] || { id: databaseId },
-);
-
-export const getTableId = (state, props) =>
- Number.parseInt(props.params.tableId);
-// export const getTableId = (state, props) => Number.parseInt(props.params.tableId);
-export const getTablesByDatabase = createSelector(
- [getTables, getDatabase],
- (tables, database) =>
- tables && database && database.tables
- ? idsToObjectMap(database.tables, tables)
- : {},
-);
-export const getTableBySegment = createSelector(
- [getSegment, getTables],
- (segment, tables) =>
- segment && segment.table_id ? tables[segment.table_id] : {},
-);
-export const getTable = createSelector(
- [getTableId, getTables, getSegmentId, getTableBySegment],
- (tableId, tables, segmentId, tableBySegment) =>
- tableId
- ? tables[tableId] || { id: tableId }
- : segmentId
- ? tableBySegment
- : {},
-);
-
-export const getFieldId = (state, props) =>
- Number.parseInt(props.params.fieldId);
-export const getFieldsByTable = createSelector(
- [getTable, getFields],
- (table, fields) =>
- table && table.fields ? idsToObjectMap(table.fields, fields) : {},
-);
-export const getFieldsBySegment = createSelector(
- [getTableBySegment, getFields],
- (table, fields) =>
- table && table.fields ? idsToObjectMap(table.fields, fields) : {},
-);
-export const getField = createSelector(
- [getFieldId, getFields],
- (fieldId, fields) => fields[fieldId] || { id: fieldId },
-);
-export const getFieldBySegment = createSelector(
- [getFieldId, getFieldsBySegment],
- (fieldId, fields) => fields[fieldId] || { id: fieldId },
-);
-
-const getQuestions = (state, props) =>
- getIn(state, ["entities", "questions"]) || {};
-
-const getRevisions = (state, props) => state.revisions;
-
-export const getSegmentRevisions = createSelector(
- [getSegmentId, getRevisions],
- (segmentId, revisions) => getIn(revisions, ["segment", segmentId]) || {},
-);
-
-export const getTableQuestions = createSelector(
- [getTable, getQuestions],
- (table, questions) =>
- Object.values(questions).filter(
- (question) => question.table_id === table.id,
- ),
-);
-
-export const getLoading = (state, props) => state.reference.isLoading;
-
-export const getError = (state, props) => state.reference.error;
-
-export const getHasSingleSchema = createSelector(
- [getTablesByDatabase],
- (tables) =>
- tables && Object.keys(tables).length > 0
- ? Object.values(tables).every(
- (table, index, tables) => table.schema_name === tables[0].schema,
- )
- : true,
-);
-
-export const getIsEditing = (state, props) => state.reference.isEditing;
-
-export const getIsFormulaExpanded = (state, props) =>
- state.reference.isFormulaExpanded;
diff --git a/frontend/src/metabase/reference/selectors.ts b/frontend/src/metabase/reference/selectors.ts
new file mode 100644
index 00000000000..5fe755b6f1a
--- /dev/null
+++ b/frontend/src/metabase/reference/selectors.ts
@@ -0,0 +1,174 @@
+import { createSelector } from "@reduxjs/toolkit";
+import { getIn } from "icepick";
+
+import type { State } from "metabase/redux/store";
+import {
+ getShallowDatabases as getDatabases,
+ getShallowFields as getFields,
+ getShallowSegments as getSegments,
+ getShallowTables as getTables,
+} from "metabase/selectors/metadata";
+import type {
+ Card,
+ NormalizedField,
+ NormalizedTable,
+} from "metabase-types/api";
+
+import type {
+ StubbedDatabase,
+ StubbedField,
+ StubbedSegment,
+ StubbedTable,
+} from "./types";
+import { idsToObjectMap } from "./utils";
+
+export interface ReferenceRouteParams {
+ segmentId?: string;
+ databaseId?: string;
+ tableId?: string;
+ fieldId?: string;
+}
+
+export interface ReferenceRouteProps {
+ params: ReferenceRouteParams;
+}
+
+interface ReferenceSliceState {
+ isLoading: boolean;
+ error: unknown;
+ isEditing: boolean;
+ isFormulaExpanded: boolean;
+}
+
+// The `reference` and `revisions` slices are wired in via `reducers-main.ts`
+// but aren't declared on the global `State` type. Adding them centrally
+// triggers a TS2589 ("excessively deep") cascade in dashboard's reducers,
+// so we widen locally here instead.
+export type StateWithReference = State & {
+ reference: ReferenceSliceState;
+ revisions?: Record<string, Record<string | number, unknown>>;
+};
+
+export const getUser = (state: StateWithReference) => state.currentUser;
+
+export const getSegmentId = (
+ _state: StateWithReference,
+ props: ReferenceRouteProps,
+) => Number.parseInt(props.params.segmentId ?? "");
+export const getSegment = createSelector(
+ [getSegmentId, getSegments],
+ (segmentId, segments): StubbedSegment =>
+ segments?.[segmentId] || { id: segmentId },
+);
+
+export const getDatabaseId = (
+ _state: StateWithReference,
+ props: ReferenceRouteProps,
+) => Number.parseInt(props.params.databaseId ?? "");
+
+export const getDatabase = createSelector(
+ [getDatabaseId, getDatabases],
+ (databaseId, databases): StubbedDatabase =>
+ databases?.[databaseId] || { id: databaseId },
+);
+
+export const getTableId = (
+ _state: StateWithReference,
+ props: ReferenceRouteProps,
+) => Number.parseInt(props.params.tableId ?? "");
+// export const getTableId = (state, props) => Number.parseInt(props.params.tableId);
+export const getTablesByDatabase = createSelector(
+ [getTables, getDatabase],
+ (tables, database) =>
+ tables && database.tables
+ ? idsToObjectMap(database.tables, tables)
+ : ({} as Record<string, NormalizedTable>),
+);
+export const getTableBySegment = createSelector(
+ [getSegment, getTables],
+ (segment, tables): StubbedTable =>
+ segment.table_id && tables?.[segment.table_id]
+ ? tables[segment.table_id]
+ : { id: 0 },
+);
+export const getTable = createSelector(
+ [getTableId, getTables, getSegmentId, getTableBySegment],
+ (tableId, tables, segmentId, tableBySegment): StubbedTable =>
+ tableId
+ ? tables?.[tableId] || { id: tableId }
+ : segmentId
+ ? tableBySegment
+ : { id: 0 },
+);
+
+export const getFieldId = (
+ _state: StateWithReference,
+ props: ReferenceRouteProps,
+) => Number.parseInt(props.params.fieldId ?? "");
+export const getFieldsByTable = createSelector(
+ [getTable, getFields],
+ (table, fields) =>
+ table.fields
+ ? idsToObjectMap(table.fields, fields)
+ : ({} as Record<string, NormalizedField>),
+);
+export const getFieldsBySegment = createSelector(
+ [getTableBySegment, getFields],
+ (table, fields) =>
+ table.fields
+ ? idsToObjectMap(table.fields, fields)
+ : ({} as Record<string, NormalizedField>),
+);
+export const getField = createSelector(
+ [getFieldId, getFields],
+ (fieldId, fields): StubbedField => fields?.[fieldId] || { id: fieldId },
+);
+export const getFieldBySegment = createSelector(
+ [getFieldId, getFieldsBySegment],
+ (fieldId, fields): StubbedField => fields[fieldId] || { id: fieldId },
+);
+
+const getQuestions = (state: StateWithReference) =>
+ getIn(state, ["entities", "questions"]) || {};
+
+const getRevisions = (state: StateWithReference) => state.revisions;
+
+export const getSegmentRevisions = createSelector(
+ [getSegmentId, getRevisions],
+ (segmentId, revisions) => getIn(revisions, ["segment", segmentId]) || {},
+);
+
+export const getTableQuestions = createSelector(
+ [getTable, getQuestions],
+ (table, questions): Card[] => {
+ const tableId = table.id;
+ return Object.values(questions as Record<string, Card>).filter(
+ (question) => question.table_id === tableId,
+ );
+ },
+);
+
+export const getLoading = (state: State) =>
+ (state as StateWithReference).reference.isLoading;
+
+export const getError = (state: State) =>
+ (state as StateWithReference).reference.error;
+
+export const getHasSingleSchema = createSelector(
+ [getTablesByDatabase],
+ (tables) => {
+ const list = Object.values(tables);
+ // NOTE: original compared each row's `schema_name` to the first row's
+ // `schema` (different fields). Behavior preserved verbatim — likely a
+ // pre-existing bug, but out of scope for the TS conversion.
+ return list.length > 0
+ ? list.every((table) => table.schema_name === list[0].schema)
+ : true;
+ },
+);
+
+export const getIsEditing = (state: State) =>
+ (state as StateWithReference).reference.isEditing;
+
+export const getIsFormulaExpanded = (state: StateWithReference) =>
+ state.reference.isFormulaExpanded;
diff --git a/frontend/src/metabase/reference/types.ts b/frontend/src/metabase/reference/types.ts
new file mode 100644
index 00000000000..44b25e44c7c
--- /dev/null
+++ b/frontend/src/metabase/reference/types.ts
@@ -0,0 +1,54 @@
+// Shared types for the legacy reference module.
+// These permissive shapes match the loosely-typed redux state and props
+// flowing through this module's connected components.
+
+import type {
+ DatabaseId,
+ FieldFormattingSettings,
+ FieldId,
+ NormalizedDatabase,
+ NormalizedField,
+ NormalizedSegment,
+ NormalizedTable,
+ SegmentId,
+ TableId,
+} from "metabase-types/api";
+
+// Reference selectors fall back to a `{ id }` stub when an entity hasn't been
+// fetched yet; consumers handle the loading/empty states.
+export type StubbedDatabase = Partial<NormalizedDatabase> & { id: DatabaseId };
+export type StubbedTable = Partial<NormalizedTable> & { id: TableId };
+export type StubbedSegment = Partial<NormalizedSegment> & { id: SegmentId };
+export type StubbedField = Partial<NormalizedField> & {
+ id: NormalizedField["id"];
+};
+
+export interface FormFieldEntry<T = unknown> {
+ name: string;
+ value?: T;
+
+ onChange: (...args: any[]) => void;
+}
+
+// Common editable text fields shared by all entity Detail forms.
+// Index signature allows formik to carry arbitrary extra keys and lets these
+// satisfy `Record<string, unknown>` at action-handler boundaries without casts.
+export interface BaseDetailFormFields {
+ display_name?: string;
+ name?: string;
+ description?: string | null;
+ points_of_interest?: string;
+ caveats?: string;
+ [key: string]: unknown;
+}
+
+// Field-specific editable values used by FieldDetail / SegmentFieldDetail
+// directly and by FieldList / SegmentFieldList nested per-field.
+export interface FieldFormFieldsValues {
+ display_name?: string;
+ description?: string | null;
+ semantic_type?: string | null;
+ fk_target_field_id?: FieldId | null;
+ settings?: FieldFormattingSettings;
+ [key: string]: unknown;
+}
diff --git a/frontend/src/metabase/reference/utils.js b/frontend/src/metabase/reference/utils.ts
similarity index 52%
rename from frontend/src/metabase/reference/utils.js
rename to frontend/src/metabase/reference/utils.ts
index 6fe686c61fd..2154a0d5489 100644
--- a/frontend/src/metabase/reference/utils.js
+++ b/frontend/src/metabase/reference/utils.ts
@@ -5,21 +5,50 @@ import { serializeCardForUrl } from "metabase/common/utils/card";
import * as Urls from "metabase/urls";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
-
-export const idsToObjectMap = (ids, objects) =>
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Card, VisualizationDisplay } from "metabase-types/api";
+import type { DatabaseId } from "metabase-types/api/database";
+import type { FieldId } from "metabase-types/api/field";
+import type { SegmentId } from "metabase-types/api/segment";
+import type { TableId } from "metabase-types/api/table";
+
+export const idsToObjectMap = <T extends { id: unknown }>(
+ ids: ReadonlyArray<string | number>,
+ objects: Record<string, T>,
+): Record<string, T> =>
ids
.map((id) => objects[id])
- .reduce((map, object) => ({ ...map, [object.id]: object }), {});
+ .reduce<Record<string, T>>(
+ (map, object) => ({ ...map, [String(object.id)]: object }),
+ {},
+ );
// recursive freezing done by assoc here is too expensive
// hangs browser for large databases
// .reduce((map, object) => assoc(map, object.id, object), {});
-export const filterUntouchedFields = (fields, entity = {}) =>
+export const filterUntouchedFields = (
+ fields: Record<string, unknown>,
+ entity: Record<string, unknown> = {},
+): Record<string, unknown> =>
Object.keys(fields)
.filter((key) => fields[key] !== undefined && entity[key] !== fields[key])
- .reduce((map, key) => ({ ...map, [key]: fields[key] }), {});
-
-export const isEmptyObject = (object) => Object.keys(object).length === 0;
+ .reduce<Record<string, unknown>>(
+ (map, key) => ({ ...map, [key]: fields[key] }),
+ {},
+ );
+
+export const isEmptyObject = (object: object): boolean =>
+ Object.keys(object).length === 0;
+
+export interface GetQuestionArgs {
+ dbId: DatabaseId;
+ tableId: TableId;
+ fieldId?: FieldId;
+ segmentId?: SegmentId;
+ getCount?: boolean;
+ visualization?: VisualizationDisplay;
+ metadata: Metadata;
+}
export const getQuestion = ({
dbId: databaseId,
@@ -29,7 +58,7 @@ export const getQuestion = ({
getCount,
visualization,
metadata,
-}) => {
+}: GetQuestionArgs): Card | undefined => {
const metadataProvider = Lib.metadataProvider(databaseId, metadata);
const table = Lib.tableOrCardMetadata(metadataProvider, tableId);
if (table == null) {
@@ -57,7 +86,11 @@ export const getQuestion = ({
return question.card();
};
-function breakoutWithDefaultTemporalBucket(query, metadata, fieldId) {
+function breakoutWithDefaultTemporalBucket(
+ query: Lib.Query,
+ metadata: Metadata,
+ fieldId: FieldId,
+): Lib.Query {
const stageIndex = -1;
const field = metadata.field(fieldId);
@@ -65,7 +98,11 @@ function breakoutWithDefaultTemporalBucket(query, metadata, fieldId) {
return query;
}
- const column = Lib.fromLegacyColumn(query, stageIndex, field);
+ const column = Lib.fromLegacyColumn(
+ query,
+ stageIndex,
+ field.getPlainObject(),
+ );
if (!column) {
return query;
@@ -75,7 +112,7 @@ function breakoutWithDefaultTemporalBucket(query, metadata, fieldId) {
return Lib.replaceBreakouts(query, -1, newColumn);
}
-function filterBySegmentId(query, segmentId) {
+function filterBySegmentId(query: Lib.Query, segmentId: SegmentId): Lib.Query {
const stageIndex = -1;
const segmentMetadata = Lib.segmentMetadata(query, segmentId);
@@ -86,16 +123,19 @@ function filterBySegmentId(query, segmentId) {
return Lib.filter(query, stageIndex, segmentMetadata);
}
-export const getQuestionUrl = (getQuestionArgs) =>
- Urls.card(null, {
- hash: serializeCardForUrl(getQuestion(getQuestionArgs)),
+export const getQuestionUrl = (getQuestionArgs: GetQuestionArgs): string => {
+ const card = getQuestion(getQuestionArgs);
+ return Urls.card(null, {
+ hash: card ? serializeCardForUrl(card) : "",
});
+};
// little utility function to determine if we 'has' things, useful
// for handling entity empty states
-export const has = (entity) => entity && entity.length > 0;
+export const has = (entity: unknown): boolean =>
+ Array.isArray(entity) ? entity.length > 0 : Boolean(entity);
-export const getDescription = (question) => {
+export const getDescription = (question: Question): string => {
const timestamp = dayjs(question.getCreatedAt()).fromNow();
const author = question.getCreator().common_name;
return t`Created ${timestamp} by ${author}`;
diff --git a/frontend/src/metabase/reference/utils.unit.spec.js b/frontend/src/metabase/reference/utils.unit.spec.ts
similarity index 93%
rename from frontend/src/metabase/reference/utils.unit.spec.js
rename to frontend/src/metabase/reference/utils.unit.spec.ts
index 52105462534..550ff61469a 100644
--- a/frontend/src/metabase/reference/utils.unit.spec.js
+++ b/frontend/src/metabase/reference/utils.unit.spec.ts
@@ -24,8 +24,9 @@ describe("Reference utils.js", () => {
6: { id: 6, name: "Buffalo", schema_name: "bar" },
};
- const createSchemaSeparator = (table) => table.schema_name;
- const createListItem = (table) => table;
+ const createSchemaSeparator = (table: { schema_name: string }) =>
+ table.schema_name;
+ const createListItem = (table: { schema_name: string }) => table;
const schemaSeparatedTables = separateTablesBySchema(
tables,
@@ -50,7 +51,7 @@ describe("Reference utils.js", () => {
const segment = createMockSegment({ table_id: tableId });
const segmentId = segment.id;
const field = createMockField({ table_id: tableId });
- const fieldId = field.id;
+ const fieldId = field.id as number;
const table = createMockTable({
id: tableId,
db_id: dbId,
@@ -106,7 +107,7 @@ describe("Reference utils.js", () => {
});
const query = new Question(card).query();
- expect(card.display).toBe("bar");
+ expect(card?.display).toBe("bar");
expect(Lib.aggregations(query, stageIndex)).toHaveLength(1);
expect(Lib.breakouts(query, stageIndex)).toHaveLength(1);
});
@@ -122,7 +123,7 @@ describe("Reference utils.js", () => {
});
const query = new Question(card).query();
- expect(card.display).toBe("pie");
+ expect(card?.display).toBe("pie");
expect(Lib.aggregations(query, stageIndex)).toHaveLength(1);
expect(Lib.breakouts(query, stageIndex)).toHaveLength(1);
});