@uniformdev/mesh-sdk-react 20.7.1-alpha.12 → 20.7.1-alpha.120

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/LICENSE.txt CHANGED
@@ -1,2 +1,2 @@
1
- © 2024 Uniform Systems, Inc. All Rights Reserved.
1
+ © 2025 Uniform Systems, Inc. All Rights Reserved.
2
2
  See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula
package/dist/index.d.mts CHANGED
@@ -8,7 +8,7 @@ import { DataVariableDefinition, DataResourceVariables, DataType, DataSourceVari
8
8
  import { Emitter } from 'mitt';
9
9
  import { TDate } from 'timeago.js';
10
10
  import * as lexical from 'lexical';
11
- import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
11
+ import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, DOMConversionMap, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
12
12
  import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
13
13
  import { InputSelectProps, IconType } from '@uniformdev/design-system';
14
14
  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';
@@ -96,6 +96,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
96
96
  type: TLocationType;
97
97
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
98
98
  type: TLocationType;
99
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
100
+ type: TLocationType;
101
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
102
+ type: TLocationType;
103
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
104
+ type: TLocationType;
99
105
  }>, "setValue"> & {
100
106
  setValue: SetLocationValueDispatch<(Extract<_uniformdev_mesh_sdk.AssetLibraryLocation, {
101
107
  type: TLocationType;
@@ -121,6 +127,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
121
127
  type: TLocationType;
122
128
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
123
129
  type: TLocationType;
130
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
131
+ type: TLocationType;
132
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
133
+ type: TLocationType;
134
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
135
+ type: TLocationType;
124
136
  }>)["value"], Parameters<(Extract<_uniformdev_mesh_sdk.AssetLibraryLocation, {
125
137
  type: TLocationType;
126
138
  }> | Extract<_uniformdev_mesh_sdk.AssetParameterLocation, {
@@ -145,6 +157,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
145
157
  type: TLocationType;
146
158
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
147
159
  type: TLocationType;
160
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
161
+ type: TLocationType;
162
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
163
+ type: TLocationType;
164
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
165
+ type: TLocationType;
148
166
  }>)["setValue"]>[0]>;
149
167
  };
150
168
  type SetLocationValueDispatch<TValue, TSetValue = TValue> = (dispatch: SetLocationValueFunction<TValue, TSetValue>) => Promise<void> | void;
@@ -230,6 +248,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
230
248
  /** Creates the DOM wrapper that hosts the node */
231
249
  createDOM(): HTMLSpanElement;
232
250
  updateDOM(): boolean;
251
+ static importDOM(): DOMConversionMap | null;
233
252
  /**
234
253
  * Render the variable node using React.
235
254
  * NOTE: this is effectively an island of React, and you may not call hooks,
@@ -397,6 +416,11 @@ type VariablesPluginProps<TEditorContext = unknown> = {
397
416
  filterVariable?: SelectVariableMenuProps<TEditorContext>['filterVariable'];
398
417
  /** If true, the whole value of the editor is replaced when a variable is inserted */
399
418
  replaceValueOnVariableInsert: boolean;
419
+ /**
420
+ * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
421
+ * Use this to render dynamic tokens as paths instead of bound values.
422
+ */
423
+ disableVariableDisplayNames?: boolean;
400
424
  };
401
425
  type UseVariablesMenuInput<TEditorContext> = Pick<VariablesPluginProps<TEditorContext>, 'showAddVariableMenuOption' | 'enableEditingVariables' | 'filterVariable' | 'getEditorContext'>;
402
426
  type OnVariableSelectInput = {
@@ -417,7 +441,7 @@ declare function useVariablesMenu<TEditorContext>({ showAddVariableMenuOption, e
417
441
  * Enables variables auto-complete and reference management to a Lexical editor.
418
442
  * Must also activate the VariableNode node to make this work.
419
443
  */
420
- declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
444
+ declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, disableVariableDisplayNames, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
421
445
 
422
446
  type PasteTransformerPluginProps = {
423
447
  /**
@@ -534,6 +558,11 @@ type InputVariablesProps<TEditorContext = unknown> = {
534
558
  * any existing value on insert a new dynamic token.
535
559
  */
536
560
  singleTokenMode?: boolean;
561
+ /**
562
+ * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
563
+ * Use this to render dynamic tokens as paths instead of bound values.
564
+ */
565
+ disableVariableDisplayNames?: boolean;
537
566
  } & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
538
567
  /**
539
568
  * An input box that enables insertion of 'variables', provided by VariablesProvider,
@@ -881,7 +910,9 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
881
910
  };
882
911
  /**
883
912
  * @description The data refresh button is a UI component to indicate to users a request for data is taking place
884
- * @example <DataRefreshButton buttonText="my button" isLoading /> */
913
+ * @example <DataRefreshButton buttonText="my button" isLoading />
914
+ * @deprecated this component is not recommended for use in new projects
915
+ */
885
916
  declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
886
917
 
887
918
  type ObjectSearchContainerProps = {
@@ -908,7 +939,9 @@ type ObjectSearchContainerProps = {
908
939
  };
909
940
  /**
910
941
  * @description Object search container is an opinionated layout for search parameters and retrieved results
911
- * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
942
+ * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
943
+ * @deprecated this component is not recommended for use in new projects
944
+ */
912
945
  declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
913
946
 
914
947
  type ObjectSearchFilterProps = {
@@ -939,7 +972,9 @@ type ObjectSearchFilterProps = {
939
972
  /**
940
973
  * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
941
974
  * that can be extended with custom functions
942
- * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
975
+ * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
976
+ * @deprecated this component is not recommended for use in new projects
977
+ */
943
978
  declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
944
979
 
945
980
  type ObjectSearchFilterContainerProps = {
@@ -949,6 +984,7 @@ type ObjectSearchFilterContainerProps = {
949
984
  /**
950
985
  * @description an opinionated layout for search filters
951
986
  * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
987
+ * @deprecated this component is not recommended for use in new projects
952
988
  */
953
989
  declare const ObjectSearchFilterContainer: ({ children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
954
990
 
@@ -966,12 +1002,14 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
966
1002
  * @default false
967
1003
  */
968
1004
  disableDnD?: boolean;
1005
+ onClick?: () => void;
969
1006
  };
970
1007
  /**
971
1008
  * @description An opinionated result item, best used for selected results
972
1009
  * @example <ObjectSearchResultItem id="my-result" title="title" />
1010
+ * @deprecated this component is not recommended for use in new projects
973
1011
  */
974
- declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
1012
+ declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, onClick, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
975
1013
 
976
1014
  type SearchQueryProps<TExtraFilters = unknown> = {
977
1015
  /** sets the content type in the search context */
@@ -1049,7 +1087,13 @@ type ObjectSearchProviderProps = {
1049
1087
  isMulti?: boolean;
1050
1088
  defaultQuery?: SearchQueryProps;
1051
1089
  };
1090
+ /**
1091
+ * @deprecated this component is not recommended for use in new projects
1092
+ */
1052
1093
  declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1094
+ /**
1095
+ * @deprecated this component is not recommended for use in new projects
1096
+ */
1053
1097
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1054
1098
 
1055
1099
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1071,7 +1115,9 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1071
1115
  } & React$1.HTMLAttributes<HTMLDivElement>;
1072
1116
  /**
1073
1117
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1074
- * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1118
+ * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
1119
+ * @deprecated this component is not recommended for use in new projects
1120
+ */
1075
1121
  declare const ObjectSearchListItem: ({ id, title, contentType, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
1076
1122
  /**
1077
1123
  * An opinionated loading skeleton component best used with ObjectSearchListItem
@@ -1090,12 +1136,14 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
1090
1136
  /**
1091
1137
  * @description An opinionated button component best used within the ObjectSearchResultItem component
1092
1138
  * @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
1139
+ * @deprecated this component is not recommended for use in new projects
1093
1140
  */
1094
1141
  declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
1095
1142
  /**
1096
1143
  * @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
1097
1144
  * that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
1098
1145
  * @example <LinkButton text="link text" icon="/my-image.png" />
1146
+ * @deprecated this component is not recommended for use in new projects
1099
1147
  */
1100
1148
  declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
1101
1149
 
@@ -1140,6 +1188,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1140
1188
  * The result item component defaults to <ObjectSearchResultItem {...props} />, however this can be overridden with any other UI component and still
1141
1189
  * maintain drag and drop functionality
1142
1190
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1191
+ * @deprecated this component is not recommended for use in new projects
1143
1192
  */
1144
1193
  declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_jsx_runtime.JSX.Element;
1145
1194
 
@@ -1209,6 +1258,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
1209
1258
  /**
1210
1259
  * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
1211
1260
  * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
1261
+ * @deprecated this component is not recommended for use in new projects
1212
1262
  */
1213
1263
  declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1214
1264
 
@@ -1681,6 +1731,8 @@ type SearchAndFilterProviderProps = {
1681
1731
  resetFilterValues?: Filter[];
1682
1732
  /** sets the list of filter options for each filter row */
1683
1733
  filterOptions: FilterOptionGroup[];
1734
+ /** optional function that is used instead of the default reset filter functionality */
1735
+ onResetFilterValues?: () => void;
1684
1736
  /** the total number of results */
1685
1737
  totalResults?: number;
1686
1738
  /** the filter mapper function */
@@ -1725,7 +1777,7 @@ declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProp
1725
1777
  * Search and filter provider
1726
1778
  * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
1727
1779
  * */
1728
- declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1780
+ declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, onResetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1729
1781
  /** Search and filter hook
1730
1782
  * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
1731
1783
  */
@@ -1778,7 +1830,7 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
1778
1830
  /** sets the reset filter values */
1779
1831
  resetFilterValues?: Filter[];
1780
1832
  /** The filter mapper function */
1781
- filterMapper?: Record<FilterEditor, React$1.ComponentType<any> | null>;
1833
+ filterMapper?: FilterMapper;
1782
1834
  /** Component to render inside filters container right below main Filters widget
1783
1835
  * that should contain additional controls like filters
1784
1836
  * which do not fit main structure or sorting */
@@ -1788,7 +1840,7 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
1788
1840
  * Search and filter component
1789
1841
  * @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
1790
1842
  * */
1791
- declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1843
+ declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, onResetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1792
1844
 
1793
1845
  type FilterItemsProps = {
1794
1846
  /** The text for the add button */
package/dist/index.d.ts CHANGED
@@ -8,7 +8,7 @@ import { DataVariableDefinition, DataResourceVariables, DataType, DataSourceVari
8
8
  import { Emitter } from 'mitt';
9
9
  import { TDate } from 'timeago.js';
10
10
  import * as lexical from 'lexical';
11
- import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
11
+ import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, DOMConversionMap, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
12
12
  import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
13
13
  import { InputSelectProps, IconType } from '@uniformdev/design-system';
14
14
  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';
@@ -96,6 +96,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
96
96
  type: TLocationType;
97
97
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
98
98
  type: TLocationType;
99
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
100
+ type: TLocationType;
101
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
102
+ type: TLocationType;
103
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
104
+ type: TLocationType;
99
105
  }>, "setValue"> & {
100
106
  setValue: SetLocationValueDispatch<(Extract<_uniformdev_mesh_sdk.AssetLibraryLocation, {
101
107
  type: TLocationType;
@@ -121,6 +127,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
121
127
  type: TLocationType;
122
128
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
123
129
  type: TLocationType;
130
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
131
+ type: TLocationType;
132
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
133
+ type: TLocationType;
134
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
135
+ type: TLocationType;
124
136
  }>)["value"], Parameters<(Extract<_uniformdev_mesh_sdk.AssetLibraryLocation, {
125
137
  type: TLocationType;
126
138
  }> | Extract<_uniformdev_mesh_sdk.AssetParameterLocation, {
@@ -145,6 +157,12 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
145
157
  type: TLocationType;
146
158
  }> | Extract<_uniformdev_mesh_sdk.AIGenerateLocation<TLocationValue>, {
147
159
  type: TLocationType;
160
+ }> | Extract<_uniformdev_mesh_sdk.PersonalizationCriteriaLocation<TLocationValue, unknown>, {
161
+ type: TLocationType;
162
+ }> | Extract<_uniformdev_mesh_sdk.DashboardToolLocation<TLocationValue, unknown>, {
163
+ type: TLocationType;
164
+ }> | Extract<_uniformdev_mesh_sdk.ProjectToolLocation<TLocationValue, unknown>, {
165
+ type: TLocationType;
148
166
  }>)["setValue"]>[0]>;
149
167
  };
150
168
  type SetLocationValueDispatch<TValue, TSetValue = TValue> = (dispatch: SetLocationValueFunction<TValue, TSetValue>) => Promise<void> | void;
@@ -230,6 +248,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
230
248
  /** Creates the DOM wrapper that hosts the node */
231
249
  createDOM(): HTMLSpanElement;
232
250
  updateDOM(): boolean;
251
+ static importDOM(): DOMConversionMap | null;
233
252
  /**
234
253
  * Render the variable node using React.
235
254
  * NOTE: this is effectively an island of React, and you may not call hooks,
@@ -397,6 +416,11 @@ type VariablesPluginProps<TEditorContext = unknown> = {
397
416
  filterVariable?: SelectVariableMenuProps<TEditorContext>['filterVariable'];
398
417
  /** If true, the whole value of the editor is replaced when a variable is inserted */
399
418
  replaceValueOnVariableInsert: boolean;
419
+ /**
420
+ * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
421
+ * Use this to render dynamic tokens as paths instead of bound values.
422
+ */
423
+ disableVariableDisplayNames?: boolean;
400
424
  };
401
425
  type UseVariablesMenuInput<TEditorContext> = Pick<VariablesPluginProps<TEditorContext>, 'showAddVariableMenuOption' | 'enableEditingVariables' | 'filterVariable' | 'getEditorContext'>;
402
426
  type OnVariableSelectInput = {
@@ -417,7 +441,7 @@ declare function useVariablesMenu<TEditorContext>({ showAddVariableMenuOption, e
417
441
  * Enables variables auto-complete and reference management to a Lexical editor.
418
442
  * Must also activate the VariableNode node to make this work.
419
443
  */
420
- declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
444
+ declare function VariablesPlugin<TEditorContext = unknown>({ disableVariables, showAddVariableMenuOption, enableEditingVariables, getEditorContext, replaceValueOnVariableInsert, filterVariable, disableVariableDisplayNames, }: VariablesPluginProps<TEditorContext>): JSX.Element | null;
421
445
 
422
446
  type PasteTransformerPluginProps = {
423
447
  /**
@@ -534,6 +558,11 @@ type InputVariablesProps<TEditorContext = unknown> = {
534
558
  * any existing value on insert a new dynamic token.
535
559
  */
536
560
  singleTokenMode?: boolean;
561
+ /**
562
+ * Disables display names for variables; the variable's (prettified) name is used instead even if a DN exists
563
+ * Use this to render dynamic tokens as paths instead of bound values.
564
+ */
565
+ disableVariableDisplayNames?: boolean;
537
566
  } & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
538
567
  /**
539
568
  * An input box that enables insertion of 'variables', provided by VariablesProvider,
@@ -881,7 +910,9 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
881
910
  };
882
911
  /**
883
912
  * @description The data refresh button is a UI component to indicate to users a request for data is taking place
884
- * @example <DataRefreshButton buttonText="my button" isLoading /> */
913
+ * @example <DataRefreshButton buttonText="my button" isLoading />
914
+ * @deprecated this component is not recommended for use in new projects
915
+ */
885
916
  declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
886
917
 
887
918
  type ObjectSearchContainerProps = {
@@ -908,7 +939,9 @@ type ObjectSearchContainerProps = {
908
939
  };
909
940
  /**
910
941
  * @description Object search container is an opinionated layout for search parameters and retrieved results
911
- * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
942
+ * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
943
+ * @deprecated this component is not recommended for use in new projects
944
+ */
912
945
  declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
913
946
 
914
947
  type ObjectSearchFilterProps = {
@@ -939,7 +972,9 @@ type ObjectSearchFilterProps = {
939
972
  /**
940
973
  * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
941
974
  * that can be extended with custom functions
942
- * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
975
+ * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
976
+ * @deprecated this component is not recommended for use in new projects
977
+ */
943
978
  declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
944
979
 
945
980
  type ObjectSearchFilterContainerProps = {
@@ -949,6 +984,7 @@ type ObjectSearchFilterContainerProps = {
949
984
  /**
950
985
  * @description an opinionated layout for search filters
951
986
  * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
987
+ * @deprecated this component is not recommended for use in new projects
952
988
  */
953
989
  declare const ObjectSearchFilterContainer: ({ children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
954
990
 
@@ -966,12 +1002,14 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
966
1002
  * @default false
967
1003
  */
968
1004
  disableDnD?: boolean;
1005
+ onClick?: () => void;
969
1006
  };
970
1007
  /**
971
1008
  * @description An opinionated result item, best used for selected results
972
1009
  * @example <ObjectSearchResultItem id="my-result" title="title" />
1010
+ * @deprecated this component is not recommended for use in new projects
973
1011
  */
974
- declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
1012
+ declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, onClick, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
975
1013
 
976
1014
  type SearchQueryProps<TExtraFilters = unknown> = {
977
1015
  /** sets the content type in the search context */
@@ -1049,7 +1087,13 @@ type ObjectSearchProviderProps = {
1049
1087
  isMulti?: boolean;
1050
1088
  defaultQuery?: SearchQueryProps;
1051
1089
  };
1090
+ /**
1091
+ * @deprecated this component is not recommended for use in new projects
1092
+ */
1052
1093
  declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1094
+ /**
1095
+ * @deprecated this component is not recommended for use in new projects
1096
+ */
1053
1097
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1054
1098
 
1055
1099
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1071,7 +1115,9 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1071
1115
  } & React$1.HTMLAttributes<HTMLDivElement>;
1072
1116
  /**
1073
1117
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1074
- * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1118
+ * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
1119
+ * @deprecated this component is not recommended for use in new projects
1120
+ */
1075
1121
  declare const ObjectSearchListItem: ({ id, title, contentType, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
1076
1122
  /**
1077
1123
  * An opinionated loading skeleton component best used with ObjectSearchListItem
@@ -1090,12 +1136,14 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
1090
1136
  /**
1091
1137
  * @description An opinionated button component best used within the ObjectSearchResultItem component
1092
1138
  * @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
1139
+ * @deprecated this component is not recommended for use in new projects
1093
1140
  */
1094
1141
  declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
1095
1142
  /**
1096
1143
  * @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
1097
1144
  * that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
1098
1145
  * @example <LinkButton text="link text" icon="/my-image.png" />
1146
+ * @deprecated this component is not recommended for use in new projects
1099
1147
  */
1100
1148
  declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
1101
1149
 
@@ -1140,6 +1188,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1140
1188
  * The result item component defaults to <ObjectSearchResultItem {...props} />, however this can be overridden with any other UI component and still
1141
1189
  * maintain drag and drop functionality
1142
1190
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1191
+ * @deprecated this component is not recommended for use in new projects
1143
1192
  */
1144
1193
  declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_jsx_runtime.JSX.Element;
1145
1194
 
@@ -1209,6 +1258,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
1209
1258
  /**
1210
1259
  * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
1211
1260
  * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
1261
+ * @deprecated this component is not recommended for use in new projects
1212
1262
  */
1213
1263
  declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1214
1264
 
@@ -1681,6 +1731,8 @@ type SearchAndFilterProviderProps = {
1681
1731
  resetFilterValues?: Filter[];
1682
1732
  /** sets the list of filter options for each filter row */
1683
1733
  filterOptions: FilterOptionGroup[];
1734
+ /** optional function that is used instead of the default reset filter functionality */
1735
+ onResetFilterValues?: () => void;
1684
1736
  /** the total number of results */
1685
1737
  totalResults?: number;
1686
1738
  /** the filter mapper function */
@@ -1725,7 +1777,7 @@ declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProp
1725
1777
  * Search and filter provider
1726
1778
  * @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
1727
1779
  * */
1728
- declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1780
+ declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, onResetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1729
1781
  /** Search and filter hook
1730
1782
  * @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
1731
1783
  */
@@ -1778,7 +1830,7 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
1778
1830
  /** sets the reset filter values */
1779
1831
  resetFilterValues?: Filter[];
1780
1832
  /** The filter mapper function */
1781
- filterMapper?: Record<FilterEditor, React$1.ComponentType<any> | null>;
1833
+ filterMapper?: FilterMapper;
1782
1834
  /** Component to render inside filters container right below main Filters widget
1783
1835
  * that should contain additional controls like filters
1784
1836
  * which do not fit main structure or sorting */
@@ -1788,7 +1840,7 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
1788
1840
  * Search and filter component
1789
1841
  * @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
1790
1842
  * */
1791
- declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1843
+ declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, onResetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1792
1844
 
1793
1845
  type FilterItemsProps = {
1794
1846
  /** The text for the add button */