superset-frontend/src/filters/components/Select/types.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
import {
  QueryFormData,
  DataRecord,
  SetDataMaskHook,
  Behavior,
} from '@superset-ui/core';
import { RefObject } from 'react';
import { PluginFilterStylesProps } from '../types';

interface PluginFilterSelectCustomizeProps {
  defaultValue?: (string | number)[] | null;
  currentValue?: (string | number)[] | null;
  enableEmptyFilter: boolean;
  fetchPredicate?: string;
  inverseSelection: boolean;
  multiSelect: boolean;
  inputRef?: RefObject<HTMLInputElement>;
}

export type PluginFilterSelectQueryFormData = QueryFormData &
  PluginFilterStylesProps &
  PluginFilterSelectCustomizeProps;

export type PluginFilterSelectProps = PluginFilterStylesProps & {
  data: DataRecord[];
  setDataMask: SetDataMaskHook;
  behaviors: Behavior[];
  formData: PluginFilterSelectQueryFormData;
};

export const DEFAULT_FORM_DATA: PluginFilterSelectCustomizeProps = {
  defaultValue: null,
  currentValue: null,
  enableEmptyFilter: false,
  fetchPredicate: '',
  inverseSelection: false,
  multiSelect: false,
};