Skip to content

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

Convert DefaultParametersSection to TypeScript (#69075)

Fraserf0c90980ff4d
diff --git a/frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.jsx b/frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.tsx
similarity index 72%
rename from frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.jsx
rename to frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.tsx
index 789a2f627fe..7d1f9850ed3 100644
--- a/frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.jsx
+++ b/frontend/src/metabase/notifications/AddEditSidebar/DefaultParametersSection.tsx
@@ -1,15 +1,25 @@
import cx from "classnames";
-import PropTypes from "prop-types";
import { t } from "ttag";
import { Badge } from "metabase/common/components/Badge";
import CS from "metabase/css/core/index.css";
import { conjunct } from "metabase/lib/formatting";
+import { isNotNull } from "metabase/lib/types";
import { formatDateValue } from "metabase/parameters/utils/date-formatting";
import { Icon, Title } from "metabase/ui";
+import type { Parameter, ParameterValueOrArray } from "metabase-types/api";
+
+interface FormattedParam {
+ name: string;
+ value: string;
+}
+
+function toStringArray(value: ParameterValueOrArray): string[] {
+ return (Array.isArray(value) ? value : [value]).map(String);
+}
// TODO: will need improved formatting for operator parameter filters
-function formatDefaultParamValues(parameters) {
+function formatDefaultParamValues(parameters: Parameter[]): FormattedParam[] {
return parameters
.map((parameter) => {
const { name, type, default: defaultValue } = parameter;
@@ -20,16 +30,15 @@ function formatDefaultParamValues(parameters) {
let formattedValue;
if (type.startsWith("date/")) {
- const values = [].concat(defaultValue);
- const formattedValues = values
+ const formattedValues = toStringArray(defaultValue)
.map((val) => formatDateValue(parameter, val))
- .filter(Boolean);
+ .filter(isNotNull);
if (formattedValues.length > 0) {
formattedValue = conjunct(formattedValues, t`and`);
}
} else {
- formattedValue = conjunct([].concat(defaultValue), t`and`);
+ formattedValue = conjunct(toStringArray(defaultValue), t`and`);
}
if (formattedValue) {
@@ -37,10 +46,18 @@ function formatDefaultParamValues(parameters) {
}
return null;
})
- .filter(Boolean);
+ .filter(isNotNull);
}
-function DefaultParametersSection({ className, parameters }) {
+interface DefaultParametersSectionProps {
+ className?: string;
+ parameters: Parameter[];
+}
+
+function DefaultParametersSection({
+ className,
+ parameters,
+}: DefaultParametersSectionProps) {
const formattedParameterValues = formatDefaultParamValues(parameters);
return (
@@ -73,10 +90,5 @@ function DefaultParametersSection({ className, parameters }) {
);
}
-DefaultParametersSection.propTypes = {
- className: PropTypes.string,
- parameters: PropTypes.array.isRequired,
-};
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default DefaultParametersSection;