Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

refactor(PowerSearch): rename preset types to *FilterPreset (#2925)

EJ Hammondaadfdd0b8cf9
diff --git a/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs b/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
index 138a1143d5..7dd4714f04 100644
--- a/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
+++ b/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
@@ -22,7 +22,7 @@ export const docs = {
{ name: 'min', type: 'ISODateString', description: 'Minimum selectable date.' },
{ name: 'max', type: 'ISODateString', description: 'Maximum selectable date.' },
{ name: 'dateConstraints', type: 'Array<(date: Date) => boolean>', description: 'Custom constraint functions to disable specific dates.' },
- { name: 'presets', type: 'Array<XDSDateRangePreset>', description: 'Preset ranges shown as quick-select options beside the calendar.' },
+ { name: 'presets', type: 'Array<DateRangePreset>', description: 'Preset ranges shown as quick-select options beside the calendar.' },
{ name: 'hasClear', type: 'boolean', description: 'Shows a clear button when a range is selected.', default: 'true' },
{ name: 'placeholder', type: 'string', description: 'Placeholder text when no range is selected.', default: "'Select date range'" },
{ name: 'size', type: "'sm' | 'md' | 'lg'", description: 'Size of the trigger.', default: "'md'" },
diff --git a/packages/core/src/DateRangeInput/XDSDateRangeInput.tsx b/packages/core/src/DateRangeInput/XDSDateRangeInput.tsx
index 520c8468dc..e11b7d6b1d 100644
--- a/packages/core/src/DateRangeInput/XDSDateRangeInput.tsx
+++ b/packages/core/src/DateRangeInput/XDSDateRangeInput.tsx
@@ -55,7 +55,7 @@ import {xdsThemeProps} from '../utils/xdsThemeProps';
export type {DateRange} from '../Calendar';
-export interface XDSDateRangePreset {
+export interface DateRangePreset {
label: string;
getRange: () => DateRange;
}
@@ -280,7 +280,7 @@ export interface XDSDateRangeInputProps extends Omit<
/**
* Preset date ranges shown as quick-select options beside the calendar.
*/
- presets?: ReadonlyArray<XDSDateRangePreset>;
+ presets?: ReadonlyArray<DateRangePreset>;
/**
* Whether to show a clear button when a range is selected.
@@ -438,7 +438,7 @@ export function XDSDateRangeInput({
);
const handlePresetClick = useCallback(
- (preset: XDSDateRangePreset) => {
+ (preset: DateRangePreset) => {
fireChange(preset.getRange());
popover.hide();
},
diff --git a/packages/core/src/DateRangeInput/index.ts b/packages/core/src/DateRangeInput/index.ts
index 553d85dd5a..19516d5ba5 100644
--- a/packages/core/src/DateRangeInput/index.ts
+++ b/packages/core/src/DateRangeInput/index.ts
@@ -16,5 +16,5 @@ export type {
XDSDateRangeInputStatus,
XDSDateRangeInputStatusType,
DateRange,
- XDSDateRangePreset,
+ DateRangePreset,
} from './XDSDateRangeInput';
diff --git a/packages/core/src/PowerSearch/index.ts b/packages/core/src/PowerSearch/index.ts
index 3adbfc02df..19d98369c5 100644
--- a/packages/core/src/PowerSearch/index.ts
+++ b/packages/core/src/PowerSearch/index.ts
@@ -72,8 +72,8 @@ export type {
PowerSearchEntity,
DateTimeRange,
DateTimeRangePart,
- DateRangePreset,
- RelativeDatePreset,
+ DateRangeFilterPreset,
+ RelativeDateFilterPreset,
OperatorTokenizationConfig,
PowerSearchChangeType,
XDSPowerSearchHandle,
diff --git a/packages/core/src/PowerSearch/types.ts b/packages/core/src/PowerSearch/types.ts
index 1b8289821f..de62c2cd1e 100644
--- a/packages/core/src/PowerSearch/types.ts
+++ b/packages/core/src/PowerSearch/types.ts
@@ -76,9 +76,9 @@ export interface DateRelativeOperatorValue {
export interface DateRangeOperatorValue {
readonly type: 'date_range';
/** Preset date ranges (e.g. "Last 7 days"). */
- readonly intervalDatePresets?: ReadonlyArray<DateRangePreset>;
+ readonly intervalDatePresets?: ReadonlyArray<DateRangeFilterPreset>;
/** Preset relative dates. */
- readonly relativeDatePresets?: ReadonlyArray<RelativeDatePreset>;
+ readonly relativeDatePresets?: ReadonlyArray<RelativeDateFilterPreset>;
}
export interface EnumItem {
@@ -271,12 +271,12 @@ export interface DateTimeRange {
readonly end: DateTimeRangePart;
}
-export interface DateRangePreset {
+export interface DateRangeFilterPreset {
readonly label: string;
readonly value: DateTimeRange;
}
-export interface RelativeDatePreset {
+export interface RelativeDateFilterPreset {
readonly label: string;
readonly value: string;
}