Skip to content

Simplify filter types with a value map and capability union #2655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rajarsheechatterjee merged 1 commit into from
Oct 10, 2026
+23 −54
Merged

Simplify filter types with a value map and capability union #2655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 23 additions & 54 deletions src/types/filters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,63 +17,43 @@ export enum FilterTypes {
ExcludableCheckboxGroup = 'XCheckbox',
}

type SwitchFilter = {
type: FilterTypes.Switch;
/** Default value */
value: boolean;
};

type TextFilter = {
type: FilterTypes.TextInput;
/** Default value */
value: string;
};

type CheckboxFilter = {
type: FilterTypes.CheckboxGroup;
options: readonly FilterOption[];
/** Default value */
value: string[];
};
type PickerFilter = {
type: FilterTypes.Picker;
options: readonly FilterOption[];
/** Default value */
value: string;
};

type ExcludableCheckboxFilter = {
type: FilterTypes.ExcludableCheckboxGroup;
options: readonly FilterOption[];
/** Default value */
value: {
type FilterValueMap = {
[FilterTypes.TextInput]: string;
[FilterTypes.Picker]: string;
[FilterTypes.Switch]: boolean;
[FilterTypes.CheckboxGroup]: string[];
[FilterTypes.ExcludableCheckboxGroup]: {
/** Checkboxes marked as included */
include?: string[];
/** Checkboxes marked as excluded */
exclude?: string[];
};
};

type WithOptions =
| FilterTypes.Picker
| FilterTypes.CheckboxGroup
| FilterTypes.ExcludableCheckboxGroup;

type OptionsOf<T extends FilterTypes> = T extends WithOptions
? { options: readonly FilterOption[] }
: object;

/**
* key - filter pairs
*/
export type Filters = Record<string, Filter<FilterTypes>>;

/** Mapping of each FilterType to a Filter */
type FilterFromType = {
[FilterTypes.CheckboxGroup]: CheckboxFilter;
[FilterTypes.ExcludableCheckboxGroup]: ExcludableCheckboxFilter;
[FilterTypes.Picker]: PickerFilter;
[FilterTypes.Switch]: SwitchFilter;
[FilterTypes.TextInput]: TextFilter;
};

/**
* Get type of a single filter type from the {@link FilterType}
*/
export type Filter<Type extends FilterTypes> = {
label: string;
} & FilterFromType[Type];
export type Filter<T extends FilterTypes = FilterTypes> = T extends FilterTypes
? {
label: string;
type: T;
value: FilterValueMap[T];
} & OptionsOf<T>
: never;

/**
* Strip {@link FilterObject} object from 'label' and 'options' to get key - filter_value pairs
Expand All @@ -94,18 +74,7 @@ export type FilterToValues<
* Get value type for a {@link Filter} given it's FilterType
* @see {@link FilterTypes}
*/
export type ValueOfFilter<T extends FilterTypes> =
T extends FilterTypes.CheckboxGroup
? CheckboxFilter['value']
: T extends FilterTypes.Picker
? PickerFilter['value']
: T extends FilterTypes.Switch
? SwitchFilter['value']
: T extends FilterTypes.TextInput
? TextFilter['value']
: T extends FilterTypes.ExcludableCheckboxGroup
? ExcludableCheckboxFilter['value']
: never;
export type ValueOfFilter<T extends FilterTypes> = FilterValueMap[T];

/** Get {@link Filter}'s type */
export type FilterType<T extends { type: unknown }> = T extends {
Expand Down