| /** |
| * 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 { ExtraFormData, makeApi } from '@superset-ui/core'; |
| import { Dispatch } from 'redux'; |
| import { |
| Filter, |
| FilterConfiguration, |
| } from 'src/dashboard/components/nativeFilters/types'; |
| import { dashboardInfoChanged } from './dashboardInfo'; |
| import { CurrentFilterState } from '../reducers/types'; |
| import { SelectedValues } from '../components/nativeFilters/FilterConfigModal/types'; |
| |
| export const SET_FILTER_CONFIG_BEGIN = 'SET_FILTER_CONFIG_BEGIN'; |
| export interface SetFilterConfigBegin { |
| type: typeof SET_FILTER_CONFIG_BEGIN; |
| filterConfig: FilterConfiguration; |
| } |
| export const SET_FILTER_CONFIG_COMPLETE = 'SET_FILTER_CONFIG_COMPLETE'; |
| export interface SetFilterConfigComplete { |
| type: typeof SET_FILTER_CONFIG_COMPLETE; |
| filterConfig: FilterConfiguration; |
| } |
| export const SET_FILTER_CONFIG_FAIL = 'SET_FILTER_CONFIG_FAIL'; |
| export interface SetFilterConfigFail { |
| type: typeof SET_FILTER_CONFIG_FAIL; |
| filterConfig: FilterConfiguration; |
| } |
| |
| export const SET_FILTER_STATE = 'SET_FILTER_STATE'; |
| export interface SetFilterState { |
| type: typeof SET_FILTER_STATE; |
| selectedValues: SelectedValues; |
| filter: Filter; |
| filters: FilterConfiguration; |
| } |
| |
| interface DashboardInfo { |
| id: number; |
| json_metadata: string; |
| } |
| |
| export const setFilterConfiguration = ( |
| filterConfig: FilterConfiguration, |
| ) => async (dispatch: Dispatch, getState: () => any) => { |
| dispatch({ |
| type: SET_FILTER_CONFIG_BEGIN, |
| filterConfig, |
| }); |
| const { id, metadata } = getState().dashboardInfo; |
| |
| // TODO extract this out when makeApi supports url parameters |
| const updateDashboard = makeApi< |
| Partial<DashboardInfo>, |
| { result: DashboardInfo } |
| >({ |
| method: 'PUT', |
| endpoint: `/api/v1/dashboard/${id}`, |
| }); |
| |
| try { |
| const response = await updateDashboard({ |
| json_metadata: JSON.stringify({ |
| ...metadata, |
| filter_configuration: filterConfig, |
| }), |
| }); |
| dispatch( |
| dashboardInfoChanged({ |
| metadata: JSON.parse(response.result.json_metadata), |
| }), |
| ); |
| dispatch({ |
| type: SET_FILTER_CONFIG_COMPLETE, |
| filterConfig, |
| }); |
| } catch (err) { |
| dispatch({ type: SET_FILTER_CONFIG_FAIL, filterConfig }); |
| } |
| }; |
| |
| export const SET_EXTRA_FORM_DATA = 'SET_EXTRA_FORM_DATA'; |
| export interface SetExtraFormData { |
| type: typeof SET_EXTRA_FORM_DATA; |
| filterId: string; |
| extraFormData: ExtraFormData; |
| currentState: CurrentFilterState; |
| } |
| |
| export function setFilterState( |
| selectedValues: SelectedValues, |
| filter: Filter, |
| filters: FilterConfiguration, |
| ) { |
| return { |
| type: SET_FILTER_STATE, |
| selectedValues, |
| filter, |
| filters, |
| }; |
| } |
| /** |
| * Sets the selected option(s) for a given filter |
| * @param filterId the id of the native filter |
| * @param extraFormData the selection translated into extra form data |
| * @param currentState |
| */ |
| export function setExtraFormData( |
| filterId: string, |
| extraFormData: ExtraFormData, |
| currentState: CurrentFilterState, |
| ): SetExtraFormData { |
| return { |
| type: SET_EXTRA_FORM_DATA, |
| filterId, |
| extraFormData, |
| currentState, |
| }; |
| } |
| |
| export type AnyFilterAction = |
| | SetFilterConfigBegin |
| | SetFilterConfigComplete |
| | SetFilterConfigFail |
| | SetExtraFormData |
| | SetFilterState; |