superset-frontend/src/dataMask/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 { ExtraFormData, DataMaskCurrentState } from '@superset-ui/core';

export enum DataMaskType {
  NativeFilters = 'nativeFilters',
  CrossFilters = 'crossFilters',
  OwnFilters = 'ownFilters',
}

export type Mask = {
  extraFormData?: ExtraFormData;
  currentState: DataMaskCurrentState;
};
export type DataMaskUnit = { [filterId: string]: Mask };
export type DataMaskState = {
  [DataMaskType.NativeFilters]: Mask;
  [DataMaskType.CrossFilters]: Mask;
  [DataMaskType.OwnFilters]: Mask;
};

export type MaskWithId = Mask & { id: string };
export type DataMaskUnitWithId = { [filterId: string]: MaskWithId };
export type DataMaskStateWithId = {
  [DataMaskType.NativeFilters]: DataMaskUnitWithId;
  [DataMaskType.CrossFilters]: DataMaskUnitWithId;
  [DataMaskType.OwnFilters]: DataMaskUnitWithId;
};