@uniformdev/mesh-sdk-react 19.135.0 → 19.135.1-alpha.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -9,8 +9,8 @@ import { DynamicInputs, MeshLocation, SetValueOptions, EditConnectedDataResponse
9
9
  export * from '@uniformdev/mesh-sdk';
10
10
  import { DataVariableDefinition, DataResourceVariables, DataType } from '@uniformdev/canvas';
11
11
  import { Emitter } from 'mitt';
12
- import { BadgeThemeProps, InputSelectProps } from '@uniformdev/design-system';
13
- export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, DrawerContent, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, useParameterShell } from '@uniformdev/design-system';
12
+ import { BadgeThemeProps, InputSelectProps, IconType } from '@uniformdev/design-system';
13
+ export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, DrawerContent, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, useParameterShell, utilityColors } from '@uniformdev/design-system';
14
14
  import * as lexical from 'lexical';
15
15
  import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState } from 'lexical';
16
16
  import { MenuOption } from '@lexical/react/LexicalTypeaheadMenuPlugin';
@@ -391,6 +391,8 @@ type DataResourceDynamicInputProviderProps = {
391
391
  /** Child components of the provider. Variables-using components, such as InputVariables, can be used here. */
392
392
  children: ReactNode;
393
393
  };
394
+ declare const DataResourceInputContext: React$1.Context<DynamicInputs | undefined>;
395
+ declare const useDataResourceDynamicInputs: () => DynamicInputs | undefined;
394
396
  /**
395
397
  * Wrapper for data resource locations. Provides read-only access to dynamic inputs as if they were variables,
396
398
  * using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
@@ -512,7 +514,7 @@ type VariableNodeState = {
512
514
  * Note that this is ignored if `isFresh` is true, which is set for the result of edits or insertions
513
515
  * made after the editor has mounted (which we know are good and don't validate to prevent flicker or false errors)
514
516
  */
515
- referenceIsValid: boolean | 'info';
517
+ referenceIsValid: boolean | 'info' | 'warning';
516
518
  /**
517
519
  * Whether the variable node has been inserted or edited during this editing session
518
520
  * Fresh nodes are always considered "valid" because they are the result of a user action
@@ -602,6 +604,7 @@ type MeshDataVariableDefinition = Omit<DataVariableDefinition, 'default'> & {
602
604
  type KnownUndefinedVariableInfo = {
603
605
  error?: string;
604
606
  info?: string;
607
+ warning?: string;
605
608
  displayName?: string;
606
609
  };
607
610
  type DataVariableDefinitionWithName = {
@@ -613,9 +616,25 @@ type DataVariableDefinitionWithName = {
613
616
  */
614
617
  declare function variablesToList(variables: Record<string, MeshDataVariableDefinition> | undefined): Array<DataVariableDefinitionWithName>;
615
618
 
619
+ type KnownUndefinedVariableInfoWithName = KnownUndefinedVariableInfo & {
620
+ name: string;
621
+ resultType: 'undefined';
622
+ };
623
+ type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = {
624
+ variable: string;
625
+ onSubmit: (values: DataVariableDefinitionWithName | KnownUndefinedVariableInfoWithName, context: TEditVariableCompletedContext) => void | Promise<void>;
626
+ /** Disables the tip about Mesh integrations. Intended for use when this is placed on a custom Mesh integration to edit variables. */
627
+ disableMeshTip?: boolean;
628
+ onCancel: (context: TEditVariableCancelledContext) => void;
629
+ context: TEditorContext | undefined;
630
+ disableAutoFocusOnMount?: boolean;
631
+ showDisplayName?: boolean;
632
+ };
633
+ declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
634
+
616
635
  type SelectVariableMenuProps<TEditorContext = undefined> = {
617
636
  /** sets the onClick menu item event. Also called if the menu adds a variable with the newly added variable. */
618
- onSelectVariable: (selectedVariable: DataVariableDefinitionWithName) => void;
637
+ onSelectVariable: (selectedVariable: DataVariableDefinitionWithName | KnownUndefinedVariableInfoWithName) => void;
619
638
  /** Controls whether one can add variables from the menu */
620
639
  showAddVariableMenuOption?: boolean | string;
621
640
  /** Emotion styles to apply to the menu trigger icon button */
@@ -784,10 +803,23 @@ type InputVariablesProps<TEditorContext = unknown> = {
784
803
  * @deprecated this is ignored if passed, computation is now automatic
785
804
  */
786
805
  disableReset?: boolean;
806
+ /**
807
+ * By default when keyDown happens in the variables input, any active variable editor is dismissed automatically.
808
+ * This makes sense, until you want to put a variables input _into_ a variables editor component. In that case,
809
+ * disable it with this prop.
810
+ */
811
+ disableDismissEditorOnChange?: boolean;
787
812
  /** Enables mutliple lines in the input (\n in the value) */
788
813
  multiLine?: boolean;
789
814
  /** Disables the inline variable selection menu when rendering a variables input */
790
815
  disableInlineMenu?: boolean | 'by-label' | 'by-input';
816
+ /**
817
+ * Defines single place to render "Insert variable" menu buttons.
818
+ * Be aware that it will override "disableInlineMenu" if set.
819
+ *
820
+ * @deprecated beta
821
+ */
822
+ showMenuPosition?: 'label' | 'input' | 'inline-right';
791
823
  /**
792
824
  * Enables clicking a variable reference to edit the variable
793
825
  * Note: automatically disabled if `disabled` or `disableVariables` is set
@@ -842,12 +874,16 @@ type ParameterConnectionIndicatorProps = {
842
874
  menuOptions: ReactNode;
843
875
  /** Sets the tooltip shown on hover over the insert-variable menu */
844
876
  menuTooltip?: string;
877
+ /**
878
+ * @deprecated beta used internally
879
+ * Sets margin bottom styles for the menu button, we use margin to allow for negative values */
880
+ overrideMenuButtonParentMargin?: number | string;
845
881
  };
846
882
  /**
847
883
  * An input box that enables insertion of 'variables', provided by VariablesProvider,
848
884
  * into its value. Designed specifically for use in the Canvas Parameter Editor.
849
885
  */
850
- declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, }: ParameterConnectionIndicatorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
886
+ declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, overrideMenuButtonParentMargin, }: ParameterConnectionIndicatorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
851
887
 
852
888
  type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
853
889
  disabled?: boolean;
@@ -899,18 +935,6 @@ type ParameterVariablesProps<TEditorContext = unknown> = {
899
935
  */
900
936
  declare function ParameterVariables<TEditorContext = unknown>(props: ParameterVariablesProps<TEditorContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
901
937
 
902
- type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = {
903
- variable: string;
904
- onSubmit: (values: DataVariableDefinitionWithName, context: TEditVariableCompletedContext) => void | Promise<void>;
905
- /** Disables the tip about Mesh integrations. Intended for use when this is placed on a custom Mesh integration to edit variables. */
906
- disableMeshTip?: boolean;
907
- onCancel: (context: TEditVariableCancelledContext) => void;
908
- context: TEditorContext | undefined;
909
- disableAutoFocusOnMount?: boolean;
910
- showDisplayName?: boolean;
911
- };
912
- declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
913
-
914
938
  type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = React.PropsWithChildren<{
915
939
  /**
916
940
  * Signals that components in this variables context are not intended to allow mutation
@@ -930,6 +954,14 @@ type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableComplet
930
954
  knownUndefinedValues?: Record<string, KnownUndefinedVariableInfo>;
931
955
  /** Function to handle mutations to the variable values (optional when readOnly is true) */
932
956
  onChange?: (newValue: Record<string, MeshDataVariableDefinition>) => void;
957
+ /**
958
+ * Called when a custom editVariableComponent signals that it wants to add a known undefined value to the variable context
959
+ * instead of a valid variable. This is useful when the variable editor component may be allowed to select invalid values that should produce
960
+ * warning or info messages when referenced, rather than being treated as an error.
961
+ *
962
+ * The caller must wire up the logic to pass back new `knownUndefinedValues` after they are modified.
963
+ */
964
+ onChangeKnownUndefinedValue?: (name: string, value: KnownUndefinedVariableInfo) => void;
933
965
  /**
934
966
  * Provide a component to handle editing a variable definition (e.g. a modal wrapper)
935
967
  * If not passed, the editor will be rendered inline, with potentially strange results.
@@ -966,7 +998,7 @@ type VariablesAction<TEditVariableContext> = {
966
998
  type VariableEditorCompleteEvent<TEditVariableCompletedContext, TEditVariableCancelledContext> = {
967
999
  canceled: false;
968
1000
  /** Selected variable */
969
- selectedVariable: DataVariableDefinitionWithName;
1001
+ selectedVariable: DataVariableDefinitionWithName | KnownUndefinedVariableInfoWithName;
970
1002
  /**
971
1003
  * Arbitrary object that was returned by the variables editor component's onSubmit
972
1004
  * Can be used to convey context data about the submit from custom editor components
@@ -1028,7 +1060,7 @@ type VariablesContext<TEditVariableContext, TEditVariableCompletedContext, TEdit
1028
1060
  */
1029
1061
  isLoading: boolean;
1030
1062
  };
1031
- declare function VariablesProvider<TEditComponentContext = never, TEditVariableCompletedContext = never, TEditVariableCancelledContext = never>({ value, onChange, editVariableComponent, readOnly, isLoading, children, knownUndefinedValues, }: VariablesProviderProps<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1063
+ declare function VariablesProvider<TEditComponentContext = never, TEditVariableCompletedContext = never, TEditVariableCancelledContext = never>({ value, onChange, editVariableComponent, readOnly, isLoading, children, knownUndefinedValues, onChangeKnownUndefinedValue, }: VariablesProviderProps<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1032
1064
  declare function useVariables<TEditComponentContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(returnEmptyWithoutProvider?: boolean): VariablesContext<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>;
1033
1065
 
1034
1066
  declare function useVariableEditor<TEditorContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(): {
@@ -1197,56 +1229,10 @@ type ObjectSearchContainerProps = {
1197
1229
  };
1198
1230
  /**
1199
1231
  * @description Object search container is an opinionated layout for search parameters and retrieved results
1200
- * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
1201
- declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1202
-
1203
- type ObjectSearchFilterProps = {
1204
- /** shows or hides the required content type select option */
1205
- requireContentType?: boolean;
1206
- /** sets the text for the required content type select option
1207
- * @default 'All content types'
1208
- */
1209
- typeSelectorAllTypesOptionText?: string;
1210
- /** sets the select input value label text
1211
- * @default 'Content Type Select'
1212
- */
1213
- selectLabel?: string;
1214
- /** sets the select input options, if empty - only keyword search field will be rendered */
1215
- selectOptions?: Array<{
1216
- id?: string;
1217
- name?: string;
1218
- label: string;
1219
- value?: string;
1220
- }>;
1221
- /** sets the search input name value
1222
- * @default 'searchText'
1223
- */
1224
- searchInputName?: string;
1225
- /** sets the search input placeholder text
1226
- * @default 'Enter keyword to narrow your results'
1227
- */
1228
- searchInputPlaceholderText?: string;
1229
- };
1230
- /**
1231
- * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
1232
- * that can be extended with custom functions
1233
- * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
1234
- declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1235
-
1236
- type ObjectSearchFilterContainerProps = {
1237
- /**
1238
- * sets the title for the container
1239
- * @deprecated we recommend setting the label on ObjectSearchContainer instead
1240
- */
1241
- label?: string;
1242
- /** sets child components in an opinionated layout */
1243
- children?: React.ReactNode;
1244
- };
1245
- /**
1246
- * @description an opinionated layout for search filters
1247
- * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
1232
+ * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
1233
+ * @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
1248
1234
  */
1249
- declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1235
+ declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1250
1236
 
1251
1237
  type SearchQueryProps<TExtraFilters = unknown> = {
1252
1238
  /** sets the content type in the search context */
@@ -1255,6 +1241,7 @@ type SearchQueryProps<TExtraFilters = unknown> = {
1255
1241
  keyword?: string;
1256
1242
  /** sets the locale in the search context */
1257
1243
  locale?: string;
1244
+ dynamicEntryId?: string;
1258
1245
  } & TExtraFilters;
1259
1246
  type SelectedItemProps<TExtraProps = unknown> = {
1260
1247
  /** sets the id value */
@@ -1324,18 +1311,97 @@ type ObjectSearchContextProps<TExtraFilters = unknown, TExtraItemProps = unknown
1324
1311
  /** current list of results in state */
1325
1312
  list: ItemListProps<TExtraItemProps>;
1326
1313
  /** function that sets the list of items to state */
1327
- onSetList: (value: ItemListProps) => void;
1314
+ onSetList?: (value: ItemListProps) => void;
1328
1315
  /** is multi items selection allowed or not */
1329
1316
  isMulti: boolean;
1317
+ localeOptions?: {
1318
+ label: string;
1319
+ value: string;
1320
+ }[];
1321
+ enableFilterByLocale?: boolean;
1322
+ isListLoading?: boolean;
1323
+ isSelectedItemsListLoading?: boolean;
1324
+ dynamicEntryId?: string;
1330
1325
  };
1326
+ declare const ObjectSearchContext: React$1.Context<ObjectSearchContextProps<unknown, unknown>>;
1331
1327
  type ObjectSearchProviderProps = {
1332
1328
  children: ReactNode;
1333
1329
  currentlySelectedItems?: Array<SelectedItemProps>;
1330
+ searchResultList?: Array<SelectedItemProps>;
1334
1331
  isMulti?: boolean;
1335
1332
  defaultQuery?: SearchQueryProps;
1336
1333
  };
1334
+ /**
1335
+ * @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
1336
+ */
1337
1337
  declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1338
1338
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1339
+ declare function bindQuery(query: SearchQueryProps, inputs: Record<string, unknown>): {
1340
+ /** sets the content type in the search context */
1341
+ contentType?: string | undefined;
1342
+ /** sets the keyword search in the search context */
1343
+ keyword?: string | undefined;
1344
+ /** sets the locale in the search context */
1345
+ locale?: string | undefined;
1346
+ dynamicEntryId?: string | undefined;
1347
+ };
1348
+
1349
+ type ObjectSearchFilterProps = {
1350
+ /** shows or hides the required content type select option */
1351
+ requireContentType?: boolean;
1352
+ /** sets the text for the required content type select option
1353
+ * @default 'All content types'
1354
+ */
1355
+ typeSelectorAllTypesOptionText?: string;
1356
+ /** sets the select input value label text
1357
+ * @default 'Content Type Select'
1358
+ */
1359
+ selectLabel?: string;
1360
+ /** sets the select input options, if empty - only keyword search field will be rendered */
1361
+ selectOptions?: Array<{
1362
+ id?: string;
1363
+ name?: string;
1364
+ label: string;
1365
+ value?: string;
1366
+ }>;
1367
+ /** sets the search input name value
1368
+ * @default 'searchText'
1369
+ */
1370
+ searchInputName?: string;
1371
+ /** sets the search input placeholder text
1372
+ * @default 'Enter keyword to narrow your results'
1373
+ */
1374
+ searchInputPlaceholderText?: string;
1375
+ /** sets the label for the locale selectbox filter */
1376
+ localeFilterLabel?: string;
1377
+ /** sets the locale options for the locale selectbox filter */
1378
+ localeOptions?: ObjectSearchContextProps['localeOptions'];
1379
+ /** enables or disables the locale filter */
1380
+ enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
1381
+ };
1382
+ /**
1383
+ * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
1384
+ * that can be extended with custom functions
1385
+ * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
1386
+ * @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
1387
+ */
1388
+ declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, localeFilterLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1389
+
1390
+ type ObjectSearchFilterContainerProps = {
1391
+ /**
1392
+ * sets the title for the container
1393
+ * @deprecated we recommend setting the label on ObjectSearchContainer instead
1394
+ */
1395
+ label?: string;
1396
+ /** sets child components in an opinionated layout */
1397
+ children?: React.ReactNode;
1398
+ };
1399
+ /**
1400
+ * @description an opinionated layout for search filters
1401
+ * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
1402
+ * @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
1403
+ */
1404
+ declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1339
1405
 
1340
1406
  type ObjectSearchListItemProps = SelectedItemProps & {
1341
1407
  /** sets the content type value, this is normally used for subtitles e.g. Kitchens */
@@ -1540,9 +1606,40 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
1540
1606
  /**
1541
1607
  * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
1542
1608
  * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
1609
+ * @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
1543
1610
  */
1544
1611
  declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1545
1612
 
1613
+ declare function ObjectSearchListOfSearchResults(): _emotion_react_types_jsx_namespace.EmotionJSX.Element | _emotion_react_types_jsx_namespace.EmotionJSX.Element[] | undefined;
1614
+
1615
+ type ControlledObjectSearchProviderProps = {
1616
+ children: ReactNode;
1617
+ /**
1618
+ * List of selected items controlled by parent component.
1619
+ * "undefined" value together with "selectedItemsLoading" prop indicate that list is initially loading or it is reloading on select action.
1620
+ * In case of reloading on select action, this component will render selected item right away to avoid waiting for backend response to smooth user experience.
1621
+ */
1622
+ selectedItems: Array<SelectedItemProps> | undefined;
1623
+ searchResultItems: Array<SelectedItemProps> | undefined;
1624
+ /** Indicates that selected items are loading. only used during initial render and on user interaction does not effect anything */
1625
+ selectedItemsLoading?: boolean;
1626
+ searchResultListLoading?: boolean;
1627
+ /** @deprecated Please use <SearchAndFilter> component instead */
1628
+ onQueryChange?: (value: SearchQueryProps) => void;
1629
+ onSelectItemsChange: (selectedItems: Array<SelectedItemProps>) => void;
1630
+ isMulti?: boolean;
1631
+ /** @deprecated Please use <SearchAndFilter> component instead */
1632
+ query?: SearchQueryProps;
1633
+ localeOptions?: ObjectSearchContextProps['localeOptions'];
1634
+ /** @deprecated Please use <SearchAndFilter> component instead */
1635
+ enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
1636
+ /** @deprecated Please use <SearchAndFilter> component instead. It also recommended to have separate archetype for data types to load content by single bindable values */
1637
+ dynamicEntryId?: ObjectSearchContextProps['dynamicEntryId'];
1638
+ /** Used for archetypes where you expect user to select items manually, comparing to automatic selection based on query */
1639
+ isManualSelection?: boolean;
1640
+ };
1641
+ declare const ControlledObjectSearchProvider: ({ selectedItems, searchResultItems, selectedItemsLoading, searchResultListLoading, onQueryChange, onSelectItemsChange, isMulti, children, query, enableFilterByLocale, localeOptions, dynamicEntryId, isManualSelection, }: ControlledObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1642
+
1546
1643
  type ParamTypeDynamicDataProviderProps = {
1547
1644
  /** Child components of the provider. Variables-using components, such as ParameterVariables, can be used here. */
1548
1645
  children: ReactNode;
@@ -1683,6 +1780,497 @@ declare function useRequestParameter(paramName: string): {
1683
1780
  update: (value: string) => void;
1684
1781
  };
1685
1782
 
1783
+ /** @deprecated beta - Filter editor component names */
1784
+ type FilterEditor = 'singleChoice' | 'multiChoice' | 'dateRange' | 'date' | 'text' | 'empty' | 'number' | 'numberRange' | 'statusMultiChoice' | 'statusSingleChoice';
1785
+ /** @deprecated beta - Input option props */
1786
+ type InputOption = {
1787
+ /** The label for the option */
1788
+ label: string;
1789
+ /** The value for the option */
1790
+ value?: string | undefined;
1791
+ /** The options for the option */
1792
+ options?: Array<FilterOption>;
1793
+ /** Set a disabled state on the input */
1794
+ isDisabled?: boolean;
1795
+ /** Set a readonly state on the input */
1796
+ readOnly?: boolean;
1797
+ };
1798
+ /** @deprecated beta - Operator option props */
1799
+ type Operator = {
1800
+ /** The label for the operator */
1801
+ label: string;
1802
+ /** The symbol for the operator */
1803
+ value?: string;
1804
+ /** The symbol for the operator */
1805
+ symbol?: string;
1806
+ /** The editor type for the operator */
1807
+ options?: Array<InputOption>;
1808
+ /** The editor type for the operator */
1809
+ editorType?: FilterEditor;
1810
+ };
1811
+ /** @deprecated beta - Filter option props */
1812
+ type FilterOption = {
1813
+ /** The label for the option */
1814
+ label: string;
1815
+ /** The value for the option */
1816
+ value: string;
1817
+ /** The options for the option */
1818
+ options?: FilterOption[];
1819
+ /** The operator options for the option */
1820
+ operatorOptions?: Operator[];
1821
+ /** The value options for the option */
1822
+ valueOptions?: InputOption[];
1823
+ /** Set a readonly state on the input */
1824
+ readOnly?: boolean;
1825
+ /** Set a disabled state on the input */
1826
+ disabled?: boolean;
1827
+ /** If filter operator allows it allow bind dynamic value to this filter */
1828
+ bindable?: boolean;
1829
+ };
1830
+ /** @deprecated beta - Filter selected and query value props */
1831
+ type Filter = {
1832
+ /** The field value selected */
1833
+ field: string;
1834
+ /** The operator value selected */
1835
+ operator: string;
1836
+ /** The value selected */
1837
+ value: string | string[];
1838
+ };
1839
+
1840
+ /** @deprecated beta - a list of possible operator values that sync with uniform search api */
1841
+ type OperatorValue = 'eq' | 'sys-date-eq' | 'neq' | 'sys-date-neq' | 'gt' | 'sys-date-gt' | 'gte' | 'sys-date-gte' | 'lt' | 'sys-date-lt' | 'lte' | 'sys-date-lte' | 'in' | 'nin' | 'between' | 'sys-date-between' | 'ndef' | 'def' | 'match' | 'starts';
1842
+ type OperatorValueType = {
1843
+ value: OperatorValue;
1844
+ };
1845
+ /** @deprecated beta - a list of possible operator types */
1846
+ type OperatorType = Array<Omit<Operator, 'value'> & OperatorValueType>;
1847
+ /** @deprecated beta - uniform number operators */
1848
+ declare const NUMBER_OPERATORS: OperatorType;
1849
+ /** @deprecated beta - uniform date operators */
1850
+ declare const DATE_OPERATORS: OperatorType;
1851
+ /** @deprecated beta - uniform textbox operators */
1852
+ declare const TEXTBOX_OPERATORS: OperatorType;
1853
+ /** @deprecated beta - uniform user operators */
1854
+ declare const USER_OPERATORS: OperatorType;
1855
+ /** @deprecated beta - uniform system date operators */
1856
+ declare const SYSTEM_DATE_OPERATORS: OperatorType;
1857
+ /** @deprecated beta - uniform rich text operators */
1858
+ declare const RICHTEXT_OPERATORS: OperatorType;
1859
+ /** @deprecated beta - uniform checkbox operators */
1860
+ declare const CHECKBOX_OPERATORS: OperatorType;
1861
+ /** @deprecated beta - uniform system field operators */
1862
+ declare const SYSTEM_FIELD_OPERATORS: OperatorType;
1863
+ /** @deprecated beta - uniform publish status field operators */
1864
+ declare const PUBLISH_STATUS_FIELD_OPERATORS: OperatorType;
1865
+ /** @deprecated beta - uniform select field operators */
1866
+ declare const SELECT_OPERATORS: OperatorType;
1867
+
1868
+ /** @description beta - filter button type */
1869
+ type FilterButtonProps = {
1870
+ /** text to display on the button
1871
+ * @default "Filters"
1872
+ */
1873
+ text?: string;
1874
+ /** icon to display on the button
1875
+ * @default "filter-add"
1876
+ */
1877
+ icon?: IconType;
1878
+ /** number of filters to display on the button and sets the styles on the button */
1879
+ filterCount?: number;
1880
+ /** sets the selected styles on the button */
1881
+ hasSelectedValue?: boolean;
1882
+ /** sets the data-testid attribute on the button */
1883
+ dataTestId?: string;
1884
+ } & HTMLAttributes<HTMLButtonElement>;
1885
+ /**
1886
+ * @deprecated beta - A filter button component used to display filter menu options
1887
+ * @example <FilterButton text="Filters" filterCount={3} />
1888
+ */
1889
+ declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, ...props }: FilterButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1890
+
1891
+ /**
1892
+ * @deprecated beta - Default filter controls for search and filter
1893
+ * @example <FilterControls />
1894
+ */
1895
+ declare const FilterControls: ({ children, hideSearchInput, }: {
1896
+ /** optional param to allow you to add your own controls */
1897
+ children?: ReactNode;
1898
+ /** optional param to hide the search input */
1899
+ hideSearchInput?: boolean | undefined;
1900
+ }) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1901
+
1902
+ type FilterEditorProps = Record<FilterEditor, ComponentType<{
1903
+ label?: string;
1904
+ value?: string;
1905
+ options: any;
1906
+ onChange: (value: any) => void;
1907
+ }> | (() => ReactNode) | null>;
1908
+ type ComboboxOption = {
1909
+ label: string;
1910
+ value: string;
1911
+ };
1912
+ type SingleValueComboboxProps = Omit<FilterEditorCommonInputProps, 'value'> & {
1913
+ value?: string;
1914
+ options: ComboboxOption[];
1915
+ onChange: (e: string) => void;
1916
+ };
1917
+ type MultiValueComboboxProps = Omit<FilterEditorCommonInputProps, 'value'> & {
1918
+ value?: string[];
1919
+ options: ComboboxOption[];
1920
+ onChange: (e: string[]) => void;
1921
+ };
1922
+ type FilterEditorCommonInputProps = {
1923
+ ariaLabel: string;
1924
+ onChange: (e: string | string[]) => void;
1925
+ disabled?: boolean;
1926
+ value?: string | string[];
1927
+ readOnly?: boolean;
1928
+ valueTestId?: string;
1929
+ bindable?: boolean;
1930
+ };
1931
+ /**
1932
+ * @deprecated beta - Multie select filter component
1933
+ * @example <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
1934
+ */
1935
+ declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: MultiValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1936
+ /**
1937
+ * @deprecated beta - Single select filter component
1938
+ * @example <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
1939
+ */
1940
+ declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: SingleValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1941
+ /**
1942
+ * @deprecated beta - Status multi select filter component that renders a custom dropdown menu
1943
+ * @example <StatusMultiEditor options={options} value={value} onChange={onChange} />
1944
+ */
1945
+ declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: MultiValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1946
+ /**
1947
+ * @deprecated beta - Status single select filter component that renders a custom dropdown menu
1948
+ * @example <StatusSingleEditor options={options} value={value} onChange={onChange} />
1949
+ */
1950
+ declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: SingleValueComboboxProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1951
+ /**
1952
+ * @deprecated beta - Renders a text input field for filtering
1953
+ * @example <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
1954
+ */
1955
+ declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1956
+ /**
1957
+ * @deprecated beta - Renders a number range input field for filtering
1958
+ * @example <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
1959
+ */
1960
+ declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1961
+ /**
1962
+ * @deprecated beta - Renders a number input field for filtering
1963
+ * @example <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
1964
+ */
1965
+ declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1966
+ /**
1967
+ * @deprecated beta - Renders a date input field for filtering
1968
+ * @example <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
1969
+ */
1970
+ declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1971
+ /**
1972
+ * @deprecated beta - Renders a date range input field for filtering
1973
+ * @example <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
1974
+ */
1975
+ declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorCommonInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1976
+ type FilterEditorRendererProps = Pick<FilterOption, 'readOnly' | 'disabled' | 'bindable'> & {
1977
+ /** The type of filter editor to render */
1978
+ editorType: FilterEditor;
1979
+ /** The options for the filter editor */
1980
+ options?: Array<Operator>;
1981
+ /** The value for the filter editor */
1982
+ value?: string | string[] | InputOption[] | InputOption;
1983
+ /** The onChange event for the filter editor */
1984
+ onChange: (e: string) => void;
1985
+ /** Sets the data-testid value */
1986
+ valueTestId?: string;
1987
+ };
1988
+ /**
1989
+ * @deprecated beta - Renders a filter editor component
1990
+ * @example <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
1991
+ */
1992
+ declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
1993
+ /** @deprecated beta - A mapper for filter editor components */
1994
+ declare const filterMapper: Record<FilterEditor, ComponentType<any> | null>;
1995
+ declare const bindableFiltersMapper: {
1996
+ multiChoice: React__default.FC<MultiValueComboboxProps>;
1997
+ singleChoice: React__default.FC<SingleValueComboboxProps>;
1998
+ date: React__default.FC<FilterEditorCommonInputProps & {
1999
+ value?: string | undefined;
2000
+ options?: {
2001
+ label: string;
2002
+ value: string;
2003
+ }[] | undefined;
2004
+ }>;
2005
+ text: React__default.FC<FilterEditorCommonInputProps & {
2006
+ value?: string | undefined;
2007
+ options?: {
2008
+ label: string;
2009
+ value: string;
2010
+ }[] | undefined;
2011
+ }>;
2012
+ number: React__default.FC<FilterEditorCommonInputProps & {
2013
+ value?: string | undefined;
2014
+ options?: {
2015
+ label: string;
2016
+ value: string;
2017
+ }[] | undefined;
2018
+ }>;
2019
+ dateRange: React__default.ComponentType<any> | null;
2020
+ empty: React__default.ComponentType<any> | null;
2021
+ numberRange: React__default.ComponentType<any> | null;
2022
+ statusMultiChoice: React__default.ComponentType<any> | null;
2023
+ statusSingleChoice: React__default.ComponentType<any> | null;
2024
+ };
2025
+
2026
+ type FilterMapper = Record<string, ComponentType<any> | null>;
2027
+ type SearchAndFilterProviderProps = {
2028
+ /** sets the filter values */
2029
+ filters: Filter[];
2030
+ /** sets the filter visibility */
2031
+ filterVisible?: boolean;
2032
+ /** function to trigger search change event */
2033
+ onSearchChange?: (term: string) => void;
2034
+ /** function to trigger filter change events */
2035
+ onChange: (filters: Filter[]) => void;
2036
+ /** Sets default value for full text search input, useful for bindable search */
2037
+ defaultSearchTerm?: string;
2038
+ /** sets the reset filter values
2039
+ * @default "[{ field: '', operator: '', value: '' }]"
2040
+ */
2041
+ resetFilterValues?: Filter[];
2042
+ /** sets the list of filter options for each filter row */
2043
+ filterOptions: FilterOption[];
2044
+ /** the total number of results */
2045
+ totalResults?: number;
2046
+ /** the filter mapper function */
2047
+ filterMapper?: FilterMapper;
2048
+ /** sets child components giving access to useSearchAndFilter context */
2049
+ children: ReactNode;
2050
+ /** Allow to bind dynamic inputs to the search term */
2051
+ allowBindingSearchTerm?: boolean;
2052
+ };
2053
+ type SearchAndFilterContextProps = {
2054
+ /** the search term value */
2055
+ searchTerm: string;
2056
+ /** sets the search term value */
2057
+ setSearchTerm: (term: string) => void;
2058
+ /** current filter visibility */
2059
+ filterVisibility?: boolean;
2060
+ /** sets the filter visibility */
2061
+ setFilterVisibility: (visible: boolean) => void;
2062
+ /** sets the initial filters */
2063
+ filters: Filter[];
2064
+ /** function to update the current filters */
2065
+ setFilters: (updatedFilters: Filter[]) => void;
2066
+ /** function that adds a blank set of filter options */
2067
+ handleAddFilter: () => void;
2068
+ /** function to reset all filter values and search term */
2069
+ handleResetFilters: () => void;
2070
+ /** function that deletes a row and it's values visually and from state */
2071
+ handleDeleteFilter: (index: number) => void;
2072
+ /** sets the initial list of filter options */
2073
+ filterOptions: FilterOption[];
2074
+ /** a valid list of valid filter options */
2075
+ validFilterQuery: Filter[] | undefined;
2076
+ /** a component list to map filter options */
2077
+ filterMapper?: FilterMapper;
2078
+ /** the total number of results */
2079
+ totalResults?: number;
2080
+ /** Allow to bind dynamic inputs to the search term */
2081
+ allowBindingSearchTerm?: boolean;
2082
+ };
2083
+ declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProps>;
2084
+ /**
2085
+ * @deprecated beta - Search and filter provider
2086
+ * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
2087
+ * */
2088
+ declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2089
+ /** @deprecated beta - Search and filter hook
2090
+ * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
2091
+ */
2092
+ declare const useSearchAndFilter: () => {
2093
+ /** the search term value */
2094
+ searchTerm: string;
2095
+ /** sets the search term value */
2096
+ setSearchTerm: (term: string) => void;
2097
+ /** current filter visibility */
2098
+ filterVisibility?: boolean | undefined;
2099
+ /** sets the filter visibility */
2100
+ setFilterVisibility: (visible: boolean) => void;
2101
+ /** sets the initial filters */
2102
+ filters: Filter[];
2103
+ /** function to update the current filters */
2104
+ setFilters: (updatedFilters: Filter[]) => void;
2105
+ /** function that adds a blank set of filter options */
2106
+ handleAddFilter: () => void;
2107
+ /** function to reset all filter values and search term */
2108
+ handleResetFilters: () => void;
2109
+ /** function that deletes a row and it's values visually and from state */
2110
+ handleDeleteFilter: (index: number) => void;
2111
+ /** sets the initial list of filter options */
2112
+ filterOptions: FilterOption[];
2113
+ /** a valid list of valid filter options */
2114
+ validFilterQuery: Filter[] | undefined;
2115
+ /** a component list to map filter options */
2116
+ filterMapper?: FilterMapper | undefined;
2117
+ /** the total number of results */
2118
+ totalResults?: number | undefined;
2119
+ /** Allow to bind dynamic inputs to the search term */
2120
+ allowBindingSearchTerm?: boolean | undefined;
2121
+ };
2122
+
2123
+ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
2124
+ /** The filter controls to be displayed
2125
+ * @default '<FilterControls />'
2126
+ */
2127
+ filterControls?: React$1.ReactNode;
2128
+ /** sets the filter mode */
2129
+ filterVisible?: boolean;
2130
+ /** The view switch controls to be displayed */
2131
+ viewSwitchControls?: React$1.ReactNode;
2132
+ /** The number of total results */
2133
+ totalResults?: number;
2134
+ /** The results container view
2135
+ * @default '<SearchAndFilterResultContainer />'
2136
+ */
2137
+ resultsContainerView?: React$1.ReactNode;
2138
+ /** sets the reset filter values */
2139
+ resetFilterValues?: Filter[];
2140
+ /** The filter mapper function */
2141
+ filterMapper?: Record<FilterEditor, React$1.ComponentType<any> | null>;
2142
+ /** Component to render inside filters container right below main Filters widget
2143
+ * that should contain additional controls like filters
2144
+ * which do not fit main structure or sorting */
2145
+ additionalFiltersContainer?: React$1.ReactNode;
2146
+ };
2147
+ /**
2148
+ * @deprecated beta - Search and filter component
2149
+ * @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
2150
+ * */
2151
+ declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2152
+
2153
+ type FilterRowProps = {
2154
+ /** the index of the filter row */
2155
+ index: number;
2156
+ /** the list of filter options for each filter row */
2157
+ paramOptions: FilterOption[];
2158
+ /** function to trigger filter change events */
2159
+ onParamChange: (e: string) => void;
2160
+ /** the list of operator options for each filter row */
2161
+ operatorOptions: Operator[];
2162
+ /** function to trigger operator change events */
2163
+ onOperatorChange: (e: string) => void;
2164
+ /** function to trigger value change events */
2165
+ onValueChange: (e: string) => void;
2166
+ /** the list of value options for each filter row */
2167
+ valueOptions: InputOption[];
2168
+ };
2169
+ /** @deprecated beta - A filter item component used to display filter options */
2170
+ declare const FilterItem: ({ index, paramOptions, operatorOptions, valueOptions, onParamChange, onOperatorChange, onValueChange, }: FilterRowProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2171
+ type FilterItemsProps = {
2172
+ /** The text for the add button */
2173
+ addButtonText?: string;
2174
+ additionalFiltersContainer: SearchAndFilterProps['additionalFiltersContainer'];
2175
+ };
2176
+ /** @deprecated beta - A filter items component used to display filter options */
2177
+ declare const FilterItems: ({ addButtonText, additionalFiltersContainer, }: FilterItemsProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2178
+
2179
+ type SearchAndFilterOptionsContainerProps = {
2180
+ /** The button row to be displayed at the bottom of the container */
2181
+ buttonRow?: React__default.ReactNode;
2182
+ /** The children of the container */
2183
+ children: React__default.ReactNode;
2184
+ additionalFiltersContainer?: SearchAndFilterProps['additionalFiltersContainer'];
2185
+ };
2186
+ /**
2187
+ * @deprecated beta - A container component for search and filter options
2188
+ * @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
2189
+ * */
2190
+ declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2191
+ type FiltersProps = {
2192
+ /** The id of the filter menu */
2193
+ id: string;
2194
+ /** The text for the filter title */
2195
+ filterTitle?: string;
2196
+ /** The controls to be displayed at the bottom of the filter menu */
2197
+ menuControls?: React__default.ReactNode;
2198
+ /** The children of the filter menu */
2199
+ children: React__default.ReactNode;
2200
+ /** Sets the data-test-id attribute for the filter menu */
2201
+ dataTestId?: string;
2202
+ /** The text for the reset button
2203
+ * @default 'reset'
2204
+ */
2205
+ resetButtonText?: string;
2206
+ additionalFiltersContainer?: SearchAndFilterProps['additionalFiltersContainer'];
2207
+ };
2208
+ /**
2209
+ * @deprecated beta - A filter menu component used to display filter options
2210
+ * @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
2211
+ * */
2212
+ declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2213
+
2214
+ type SearchAndFilterResultContainerProps = {
2215
+ /** The label for the clear button
2216
+ * @default 'Clear'
2217
+ */
2218
+ clearButtonLabel?: string;
2219
+ /** The text for the button */
2220
+ buttonText?: string;
2221
+ /** The title for the callout */
2222
+ calloutTitle?: string;
2223
+ /** The text for the callout */
2224
+ calloutText?: string;
2225
+ /** The function to handle the clear button */
2226
+ onHandleClear?: () => void;
2227
+ /** Sets whether to show or hide both clear search buttons */
2228
+ hideClearButton?: boolean;
2229
+ };
2230
+ /** @deprecated beta - Search and filter results container */
2231
+ declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
2232
+
2233
+ declare const SearchOnlyContext: React$1.Context<Pick<SearchAndFilterContextProps, "searchTerm" | "setSearchTerm">>;
2234
+ type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChange'> & {
2235
+ /** sets the max width of input wrapper
2236
+ * @default '712px'
2237
+ */
2238
+ maxWidth?: string;
2239
+ };
2240
+ declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2241
+
2242
+ type SortItemsProps = {
2243
+ /** The label for the sort by field
2244
+ * @default 'Sort by'
2245
+ */
2246
+ sortByLabel?: string;
2247
+ /** The label for the locale returned field
2248
+ * @default 'Enabled locale'
2249
+ */
2250
+ localeLabel?: string;
2251
+ /** sets the list of sort options */
2252
+ sortOptions: FilterOption[];
2253
+ /** the default sort by value */
2254
+ sortByValue?: string;
2255
+ /** function to trigger sort change events */
2256
+ onSortChange: (sort: string) => void;
2257
+ /** sets the list of locale options */
2258
+ localeOptions?: InputOption[];
2259
+ /** function to trigger locale change events */
2260
+ onLocaleChange?: (locale: string) => void;
2261
+ /** sets the default locale option value */
2262
+ localeValue?: string;
2263
+ /**
2264
+ * Optionally disable the binding for sorting inputs.
2265
+ * Mostly used to disable binding for Single/Multiple data resources
2266
+ */
2267
+ disableSortBinding?: boolean;
2268
+ };
2269
+ /**
2270
+ Copy of Design System <SortItems > component with ability to bind variables to inputs.
2271
+ */
2272
+ declare const SortItems: ({ sortByLabel, localeLabel, sortOptions, sortByValue, onSortChange, localeValue, localeOptions, onLocaleChange, disableSortBinding, }: SortItemsProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
2273
+
1686
2274
  /** Converts connected data map into VariablesProvider-format variables */
1687
2275
  declare function useConnectedDataAsVariables(connectedData: Record<string, unknown> | undefined): Record<string, MeshDataVariableDefinition>;
1688
2276
 
@@ -1734,4 +2322,4 @@ type ContentDataResourceLocaleInfoProps = {
1734
2322
  };
1735
2323
  declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
1736
2324
 
1737
- export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledValuePlugin, DISCONNECT_VARIABLE_COMMAND, type DamItem, DamSelectedItem, type DamSelectedItemProps, DataRefreshButton, type DataRefreshButtonProps, DataResourceDynamicInputProvider, type DataResourceDynamicInputProviderProps, type DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, type DataResourceVariablesListProps, DataSourceEditor, type DataSourceEditorProps, DataTypeEditor, type DataTypeEditorProps, type DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, type DisconnectVariableCommandArguments, type DispatchResult, EDIT_VARIABLE_COMMAND, type EditVariableCommandArguments, EntrySearch, type EntrySearchContentType, type EntrySearchProps, type EntrySearchQueryOptions, type EntrySearchResult, type EntrySearchRowProps, type EntrySearchSelectedItemProps, type GetProductOptions, type GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, InputVariables, type InputVariablesProps, type InsertVariableCommandArguments, type ItemListProps, type KnownUndefinedVariableInfo, LinkButton, MeshApp, type MeshAppProps, type MeshDataVariableDefinition, type NoResultsProps, OPEN_INSERT_VARIABLE_COMMAND, ObjectSearchContainer, type ObjectSearchContainerProps, type ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, type ObjectSearchFilterContainerProps, type ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, type ObjectSearchListItemProps, ObjectSearchProvider, type ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, type ObjectSearchResultItemButtonProps, type ObjectSearchResultItemProps, ObjectSearchResultList, type ObjectSearchResultListProps, ParamTypeDynamicDataProvider, type ParamTypeDynamicDataProviderProps, type ParameterConnectOptions, ParameterConnectionIndicator, type ParameterConnectionIndicatorProps, ParameterOrSingleVariable, type ParameterOrSingleVariableProps, ParameterVariables, type ParameterVariablesProps, type ProductCategory, type ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, type ProductQueryCategory, ProductQueryContext, type ProductQueryContextValue, type ProductQueryProps, ProductSearch, ProductSearchContext, type ProductSearchContextValue, type ProductSearchProps, type ProductSearchResult, type ProductSearchResults, ProductSearchRow, ProductSelectedItem, QueryFilter, type QueryFilterProps, type QueryFilterSearchProps, type RequestAction, RequestBody, type RequestContext, type RequestData, RequestHeaders, RequestMethodSelect, type RequestParameter, RequestParameters, type RequestParametersProps, RequestProvider, type RequestProviderProps, RequestTypeContainer, type RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, type SearchQueryProps, type SelectedItemProps, SelectionField, type SelectionFieldValue, type SerializedVariableNode, type SetLocationValueDispatch, type SetLocationValueFunction, TextVariableRenderer, type UseVariablesMenu, type UseVariablesMenuInput, VariableEditor, type VariableEditorCompleteEvent, type VariableEditorProps, VariableNode, type VariableNodeState, type VariableSourceGroup, type VariablesAction, type VariablesContext, type VariablesEvents, VariablesList, VariablesPlugin, type VariablesPluginProps, VariablesProvider, type VariablesProviderProps, badgeIcon, convertConnectedDataToVariable, createLocationValidator, damSelectItemImage, damSelectedItemContainer, damSelectedItemCopy, damSelectedItemDetails, damSelectedItemIcon, damSelectedItemInfoBtn, damSelectedItemInner, damSelectedItemLinkBtn, damSelectedItemLinkContainer, damSelectedItemMediaContainer, damSelectedItemPopover, damSelectedItemPopoverLabel, damSelectedItemSmallText, damSelectedItemTitle, draggableContainer, draggableIcon, draggableIconOffset, draggableIconWrapper, entrySearchBtn, entrySearchConfig, entrySearchConfigHidden, entrySearchLoadMoreBtn, entrySearchResultList, entrySearchSelectIcon, entrySearchSelectImg, entrySearchSelectInput, entrySearchSelectOption, entrySearchWrapper, hasReferencedVariables, prettifyBindExpression, productSearchRowActiveIcon, productSearchRowCategory, productSearchRowContainer, productSearchRowContent, productSearchRowContentActive, productSearchRowDetails, productSearchRowTitle, productSelectedItemContainer, productSelectedItemContent, productSelectedItemDetails, productSelectedItemIcon, productSelectedItemImage, productSelectedItemLinkContainer, productedSelectedItemLinkBtn, productedSelectedItemSmallText, searchRowBtn, searchRowContainer, searchRowContainerActive, searchRowContainerWithPopover, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, serializeVariablesEditorState, setVariablesEditorValue, urlEncodeRequestParameter, urlEncodeRequestUrl, useConnectedDataAsVariables, useContentDataResourceLocaleInfo, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
2325
+ export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, CHECKBOX_OPERATORS, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledObjectSearchProvider, type ControlledObjectSearchProviderProps, ControlledValuePlugin, DATE_OPERATORS, DISCONNECT_VARIABLE_COMMAND, type DamItem, DamSelectedItem, type DamSelectedItemProps, DataRefreshButton, type DataRefreshButtonProps, DataResourceDynamicInputProvider, type DataResourceDynamicInputProviderProps, DataResourceInputContext, type DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, type DataResourceVariablesListProps, DataSourceEditor, type DataSourceEditorProps, DataTypeEditor, type DataTypeEditorProps, type DataVariableDefinitionWithName, DateEditor, DateRangeEditor, DefaultSearchRow, DefaultSelectedItem, type DisconnectVariableCommandArguments, type DispatchResult, EDIT_VARIABLE_COMMAND, type EditVariableCommandArguments, EntrySearch, type EntrySearchContentType, type EntrySearchProps, type EntrySearchQueryOptions, type EntrySearchResult, type EntrySearchRowProps, type EntrySearchSelectedItemProps, type Filter, FilterButton, type FilterButtonProps, FilterControls, type FilterEditor, type FilterEditorCommonInputProps, type FilterEditorProps, FilterEditorRenderer, type FilterEditorRendererProps, FilterItem, FilterItems, type FilterItemsProps, type FilterMapper, FilterMenu, FilterMultiChoiceEditor, type FilterOption, type FilterRowProps, FilterSingleChoiceEditor, type FiltersProps, type GetProductOptions, type GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, type InputOption, InputVariables, type InputVariablesProps, type InsertVariableCommandArguments, type ItemListProps, type KnownUndefinedVariableInfo, type KnownUndefinedVariableInfoWithName, LinkButton, MeshApp, type MeshAppProps, type MeshDataVariableDefinition, NUMBER_OPERATORS, type NoResultsProps, NumberEditor, NumberRangeEditor, OPEN_INSERT_VARIABLE_COMMAND, ObjectSearchContainer, type ObjectSearchContainerProps, ObjectSearchContext, type ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, type ObjectSearchFilterContainerProps, type ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, type ObjectSearchListItemProps, ObjectSearchListOfSearchResults, ObjectSearchProvider, type ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, type ObjectSearchResultItemButtonProps, type ObjectSearchResultItemProps, ObjectSearchResultList, type ObjectSearchResultListProps, type Operator, type OperatorType, type OperatorValue, type OperatorValueType, PUBLISH_STATUS_FIELD_OPERATORS, ParamTypeDynamicDataProvider, type ParamTypeDynamicDataProviderProps, type ParameterConnectOptions, ParameterConnectionIndicator, type ParameterConnectionIndicatorProps, ParameterOrSingleVariable, type ParameterOrSingleVariableProps, ParameterVariables, type ParameterVariablesProps, type ProductCategory, type ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, type ProductQueryCategory, ProductQueryContext, type ProductQueryContextValue, type ProductQueryProps, ProductSearch, ProductSearchContext, type ProductSearchContextValue, type ProductSearchProps, type ProductSearchResult, type ProductSearchResults, ProductSearchRow, ProductSelectedItem, QueryFilter, type QueryFilterProps, type QueryFilterSearchProps, RICHTEXT_OPERATORS, type RequestAction, RequestBody, type RequestContext, type RequestData, RequestHeaders, RequestMethodSelect, type RequestParameter, RequestParameters, type RequestParametersProps, RequestProvider, type RequestProviderProps, RequestTypeContainer, type RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SELECT_OPERATORS, SYSTEM_DATE_OPERATORS, SYSTEM_FIELD_OPERATORS, SearchAndFilter, SearchAndFilterContext, type SearchAndFilterContextProps, SearchAndFilterOptionsContainer, type SearchAndFilterOptionsContainerProps, type SearchAndFilterProps, SearchAndFilterProvider, type SearchAndFilterProviderProps, SearchAndFilterResultContainer, type SearchAndFilterResultContainerProps, SearchOnlyContext, SearchOnlyFilter, type SearchOnlyProviderProps, type SearchQueryProps, type SelectedItemProps, SelectionField, type SelectionFieldValue, type SerializedVariableNode, type SetLocationValueDispatch, type SetLocationValueFunction, SortItems, type SortItemsProps, StatusMultiEditor, StatusSingleEditor, TEXTBOX_OPERATORS, TextEditor, TextVariableRenderer, USER_OPERATORS, type UseVariablesMenu, type UseVariablesMenuInput, VariableEditor, type VariableEditorCompleteEvent, type VariableEditorProps, VariableNode, type VariableNodeState, type VariableSourceGroup, type VariablesAction, type VariablesContext, type VariablesEvents, VariablesList, VariablesPlugin, type VariablesPluginProps, VariablesProvider, type VariablesProviderProps, badgeIcon, bindQuery, bindableFiltersMapper, convertConnectedDataToVariable, createLocationValidator, damSelectItemImage, damSelectedItemContainer, damSelectedItemCopy, damSelectedItemDetails, damSelectedItemIcon, damSelectedItemInfoBtn, damSelectedItemInner, damSelectedItemLinkBtn, damSelectedItemLinkContainer, damSelectedItemMediaContainer, damSelectedItemPopover, damSelectedItemPopoverLabel, damSelectedItemSmallText, damSelectedItemTitle, draggableContainer, draggableIcon, draggableIconOffset, draggableIconWrapper, entrySearchBtn, entrySearchConfig, entrySearchConfigHidden, entrySearchLoadMoreBtn, entrySearchResultList, entrySearchSelectIcon, entrySearchSelectImg, entrySearchSelectInput, entrySearchSelectOption, entrySearchWrapper, filterMapper, hasReferencedVariables, prettifyBindExpression, productSearchRowActiveIcon, productSearchRowCategory, productSearchRowContainer, productSearchRowContent, productSearchRowContentActive, productSearchRowDetails, productSearchRowTitle, productSelectedItemContainer, productSelectedItemContent, productSelectedItemDetails, productSelectedItemIcon, productSelectedItemImage, productSelectedItemLinkContainer, productedSelectedItemLinkBtn, productedSelectedItemSmallText, searchRowBtn, searchRowContainer, searchRowContainerActive, searchRowContainerWithPopover, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, serializeVariablesEditorState, setVariablesEditorValue, urlEncodeRequestParameter, urlEncodeRequestUrl, useConnectedDataAsVariables, useContentDataResourceLocaleInfo, useDataResourceDynamicInputs, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useSearchAndFilter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };