The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import {
doesOperatorExist,
getOperatorByTypeAndName,
} from "metabase-lib/v1/operators/utils";
import { PARAMETER_OPERATOR_TYPES } from "metabase-lib/v1/parameters/constants";
import {
getParameterSubType,
getParameterType,
} from "metabase-lib/v1/parameters/utils/parameter-type";
import { NUMBER, PRIMARY_KEY, STRING } from "metabase-lib/v1/types/constants";
import type { Parameter, ParameterMappingOptions } from "metabase-types/api";
import { getIsMultiSelect } from "./parameter-values";
type OperatorType = "date" | "number" | "string" | "id";
export type ParameterSectionId =
| "date"
| "temporal-unit"
| "location"
| "string"
| "number"
| "boolean"
| "id";
export function getOperatorDisplayName(
option: { type: string; name: string; operator: string },
operatorType: OperatorType,
sectionName?: string,
) {
if (
operatorType === "date" ||
operatorType === "number" ||
operatorType === "id"
) {
return option.name;
} else if (operatorType === "string" && option.operator === "=") {
return sectionName;
} else {
return `${sectionName} ${option.name.toLowerCase()}`;
}
}
export function getParameterOperatorName(maybeOperatorName?: string) {
return doesOperatorExist(maybeOperatorName) ? maybeOperatorName : "=";
}
export function deriveFieldOperatorFromParameter(parameter: Parameter) {
const type = getParameterType(parameter);
const subtype = getParameterSubType(parameter);
const operatorType = getParameterOperatorType(type);
const operatorName = getParameterOperatorName(subtype);
const operator = getOperatorByTypeAndName(operatorType, operatorName);
return (
operator && {
...operator,
multi: operator.multi && getIsMultiSelect(parameter),
}
);
}
function getParameterOperatorType(parameterType?: string) {
switch (parameterType) {
case "number":
return NUMBER;
case "string":
case "category":
case "location":
return STRING;
case "id":
// id can technically be a FK but doesn't matter as both use default filter operators
return PRIMARY_KEY;
default:
return undefined;
}
}
export function buildTypedOperatorOptions(
operatorType: OperatorType,
sectionId: ParameterSectionId,
sectionName: string,
): ParameterMappingOptions[] {
return PARAMETER_OPERATOR_TYPES[operatorType].map((operatorOption) => {
return {
...operatorOption,
sectionId,
combinedName: getOperatorDisplayName(
operatorOption,
operatorType,
sectionName,
),
};
});
}
export function getNumberParameterArity(parameter: Parameter) {
switch (parameter.type) {
case "number/=":
case "number/!=":
if (!getIsMultiSelect(parameter)) {
return 1;
}
return "n";
case "number/between":
return 2;
default:
return 1;
}
}