@uniformdev/mesh-sdk-react 19.79.1-alpha.11 → 19.79.1-alpha.18

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
- © 2023 Uniform Systems, Inc. All Rights Reserved.
1
+ © 2024 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
@@ -5,7 +5,7 @@ import { TDate } from 'timeago.js';
5
5
  import * as _emotion_react from '@emotion/react';
6
6
  import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
7
7
  import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
8
- import { DynamicInput, MeshLocation, SetValueOptions, EditConnectedDataResponseCancellationContext, DynamicInputs, DataSourceLocationValue, DataTypeLocationValue, BindableTypes } from '@uniformdev/mesh-sdk';
8
+ import { DynamicInputs, MeshLocation, SetValueOptions, EditConnectedDataResponseCancellationContext, DataSourceLocationValue, DataTypeLocationValue, BindableTypes } from '@uniformdev/mesh-sdk';
9
9
  export * from '@uniformdev/mesh-sdk';
10
10
  import { DataVariableDefinition, DataResourceVariables, DataType } from '@uniformdev/canvas';
11
11
  import { Emitter } from 'mitt';
@@ -42,21 +42,7 @@ declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) => _emotion_r
42
42
  declare const SvgPlus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
43
43
 
44
44
  declare namespace index {
45
- export {
46
- SvgCaution as Caution,
47
- SvgCheckmark as Checkmark,
48
- SvgChevronDown as ChevronDown,
49
- SvgClose as Close,
50
- SvgDanger as Danger,
51
- SvgExclamationPoint as ExclamationPoint,
52
- SvgInfo as Info,
53
- SvgLightbulb as Lightbulb,
54
- SvgMagnifyingGlass as MagnifyingGlass,
55
- SvgMaximizeAlt as MaximizeAlt,
56
- SvgMinus as Minus,
57
- SvgMoreVerticalAlt as MoreVerticalAlt,
58
- SvgPlus as Plus,
59
- };
45
+ export { SvgCaution as Caution, SvgCheckmark as Checkmark, SvgChevronDown as ChevronDown, SvgClose as Close, SvgDanger as Danger, SvgExclamationPoint as ExclamationPoint, SvgInfo as Info, SvgLightbulb as Lightbulb, SvgMagnifyingGlass as MagnifyingGlass, SvgMaximizeAlt as MaximizeAlt, SvgMinus as Minus, SvgMoreVerticalAlt as MoreVerticalAlt, SvgPlus as Plus };
60
46
  }
61
47
 
62
48
  /** @deprecated please use ObjectSearchListItem - https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-list-item */
@@ -399,11 +385,9 @@ declare const damSelectedItemMediaContainer: _emotion_react.SerializedStyles;
399
385
  declare const damSelectedItemInfoBtn: _emotion_react.SerializedStyles;
400
386
  declare const damSelectItemImage: _emotion_react.SerializedStyles;
401
387
 
402
- type MinimalDynamicInput = Omit<DynamicInput, 'source'>;
403
- type MinimalDynamicInputs = Record<string, MinimalDynamicInput>;
404
388
  type DataResourceDynamicInputProviderProps = {
405
389
  /** Explicitly provide dynamic input values. If not set, Mesh location will be used */
406
- dynamicInputs?: MinimalDynamicInputs;
390
+ dynamicInputs?: DynamicInputs;
407
391
  /** Child components of the provider. Variables-using components, such as InputVariables, can be used here. */
408
392
  children: ReactNode;
409
393
  };
@@ -813,7 +797,7 @@ type InputVariablesProps<TEditorContext = unknown> = {
813
797
  addOmitIfEmpty?: boolean;
814
798
  /** (optional) sets and shows the the error message value */
815
799
  errorMessage?: string;
816
- /** (optional) sets and shows the the warning message value */
800
+ /** (optional) sets and shows the warning message value */
817
801
  warningMessage?: string;
818
802
  /** (optional) sets and shows the the info message value */
819
803
  infoMessage?: string;
@@ -919,8 +903,9 @@ type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext
919
903
  onCancel: (context: TEditVariableCancelledContext) => void;
920
904
  context: TEditorContext | undefined;
921
905
  disableAutoFocusOnMount?: boolean;
906
+ showDisplayName?: boolean;
922
907
  };
923
- declare function VariableEditor({ variable, onSubmit, onCancel, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
908
+ declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
924
909
 
925
910
  type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = React.PropsWithChildren<{
926
911
  /**
@@ -1191,7 +1176,10 @@ type ObjectSearchContainerProps = {
1191
1176
  enableDynamicInputToResultId?: boolean;
1192
1177
  /** a child node that places components within the search location */
1193
1178
  searchFilters: ReactNode;
1194
- /** a child node that places components within a scrollable list location */
1179
+ /**
1180
+ * a child node that places components within a scrollable list location
1181
+ * set to `null` expl
1182
+ */
1195
1183
  resultList?: ReactNode;
1196
1184
  /** allows any child element */
1197
1185
  children?: ReactNode;
@@ -1214,9 +1202,10 @@ type ObjectSearchFilterProps = {
1214
1202
  selectLabel?: string;
1215
1203
  /** sets the select input options, if empty - only keyword search field will be rendered */
1216
1204
  selectOptions?: Array<{
1217
- id: string;
1205
+ id?: string;
1218
1206
  name?: string;
1219
1207
  label: string;
1208
+ value?: string;
1220
1209
  }>;
1221
1210
  /** sets the search input name value
1222
1211
  * @default 'searchText'
@@ -1253,6 +1242,8 @@ type SearchQueryProps<TExtraFilters = unknown> = {
1253
1242
  contentType?: string;
1254
1243
  /** sets the keyword search in the search context */
1255
1244
  keyword?: string;
1245
+ /** sets the locale in the search context */
1246
+ locale?: string;
1256
1247
  } & TExtraFilters;
1257
1248
  type SelectedItemProps<TExtraProps = unknown> = {
1258
1249
  /** sets the id value */
@@ -1323,12 +1314,16 @@ type ObjectSearchContextProps<TExtraFilters = unknown, TExtraItemProps = unknown
1323
1314
  list: ItemListProps<TExtraItemProps>;
1324
1315
  /** function that sets the list of items to state */
1325
1316
  onSetList: (value: ItemListProps) => void;
1317
+ /** is multi items selection allowed or not */
1318
+ isMulti: boolean;
1326
1319
  };
1327
1320
  type ObjectSearchProviderProps = {
1328
1321
  children: ReactNode;
1329
1322
  currentlySelectedItems?: Array<SelectedItemProps>;
1323
+ isMulti?: boolean;
1324
+ defaultQuery?: SearchQueryProps;
1330
1325
  };
1331
- declare const ObjectSearchProvider: ({ currentlySelectedItems, children }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1326
+ declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1332
1327
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1333
1328
 
1334
1329
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1337,7 +1332,7 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1337
1332
  /** sets image parameters
1338
1333
  * @deprecated Please use imageUrl to make it compatible with */
1339
1334
  image?: {
1340
- /** sets the src valuue */
1335
+ /** sets the src value */
1341
1336
  src: string;
1342
1337
  /** sets the alt text value */
1343
1338
  alt: string;
@@ -1359,15 +1354,16 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1359
1354
  children?: React$1.ReactNode;
1360
1355
  /** sets whether multiple entries can be added to the results list context
1361
1356
  * @default false
1357
+ * @deprecated Please use isMulti property in <ObjectSearchProvider />
1362
1358
  */
1363
1359
  isMulti?: boolean;
1364
1360
  /** sets disabled state to the interactive element */
1365
1361
  disabled?: boolean;
1366
- };
1362
+ } & React$1.HTMLAttributes<HTMLDivElement>;
1367
1363
  /**
1368
1364
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1369
1365
  * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1370
- declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, }: ObjectSearchListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1366
+ declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1371
1367
  /**
1372
1368
  * An opinionated loading skeleton component best used with ObjectSearchListItem
1373
1369
  * @example <ObjectSearchListItemLoadingSkeleton />
@@ -1419,6 +1415,8 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1419
1415
  * @default 'Selected'
1420
1416
  */
1421
1417
  resultLabelText?: string;
1418
+ /** sets and override react node replacing the whole HTML block for the result label and counter */
1419
+ resultLabelOverride?: ReactNode;
1422
1420
  /** sets the on remove button click action */
1423
1421
  onRemoveAllSelected?: () => void;
1424
1422
  /** sets the remove button text
@@ -1430,9 +1428,9 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1430
1428
  */
1431
1429
  hideRemoveButton?: boolean;
1432
1430
  /** allows additional buttons to be added to the result title group */
1433
- additionalButtons?: React.ReactNode;
1431
+ additionalButtons?: React__default.ReactNode;
1434
1432
  /** allows placing child components within the result list area */
1435
- renderResultComponent?: (value: TRenderComponent) => React.ReactNode;
1433
+ renderResultComponent?: (value: TRenderComponent) => React__default.ReactNode;
1436
1434
  /** disable or enable drag and drop functionality
1437
1435
  * @default false
1438
1436
  */
@@ -1440,7 +1438,13 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1440
1438
  /** sets the draggable id value */
1441
1439
  multiSelectId?: string;
1442
1440
  /** Rendered when nothing is selected */
1443
- whenNothingSelected?: React.ReactNode;
1441
+ whenNothingSelected?: React__default.ReactNode;
1442
+ /**
1443
+ * Special case for re-parenting the drag and drop container in case of issues with "position: fixed" and "transform:
1444
+ * You can read more about this here https://github.com/atlassian/react-beautiful-dnd/blob/master/docs/guides/reparenting.md
1445
+ * Providing this getter assumes you have that HTML element in the document, and it will enable re-parenting.
1446
+ */
1447
+ getContainerForDnDReparenting?: () => HTMLElement;
1444
1448
  };
1445
1449
  /**
1446
1450
  * @description An opinionated result list UI component that has built in drag and drop functionality and removal of all selected items from context.
@@ -1448,7 +1452,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1448
1452
  * maintain drag and drop functionality
1449
1453
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1450
1454
  */
1451
- declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, additionalButtons, renderResultComponent, multiSelectId, disableDnD, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1455
+ declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1452
1456
 
1453
1457
  type QueryFilterSearchProps = {
1454
1458
  /** sets the count value */
@@ -1458,12 +1462,18 @@ type QueryFilterSearchProps = {
1458
1462
  /** sets the sortOrder filter value */
1459
1463
  sortOrder: string;
1460
1464
  };
1461
- type QuertFilterSelectionOptionProps = Array<{
1462
- id: string;
1463
- name: string;
1465
+ type QueryFilterSelectionOptionProps = Array<{
1466
+ /** @deprecated please use value instead */
1467
+ id?: string;
1468
+ /** @deprecated please use value or label instead */
1469
+ name?: string;
1470
+ /** contains id or machine values. will be used as value attribute in <option> */
1471
+ value?: string;
1472
+ /** Contains human-readable display name for select options.
1473
+ * Used as value in case value is not present <option> */
1464
1474
  label: string;
1465
1475
  }>;
1466
- type QueryFilterProps<TSelectOptions extends QuertFilterSelectionOptionProps = QuertFilterSelectionOptionProps> = {
1476
+ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = QueryFilterSelectionOptionProps> = {
1467
1477
  /** sets the query filter title
1468
1478
  * @default 'Configure Query'
1469
1479
  */
@@ -1484,10 +1494,11 @@ type QueryFilterProps<TSelectOptions extends QuertFilterSelectionOptionProps = Q
1484
1494
  * @default 'Count'
1485
1495
  */
1486
1496
  countLabel?: string;
1487
- /** sets the count value or items to show
1497
+ /** sets the count value or items to show. As a string you can pass dynamic variables ${countFromQuery} for example
1488
1498
  * @default 5
1499
+ * @deprecated please use ObjectSearchProviderProps['defaultQuery'] to pass initial count value
1489
1500
  */
1490
- countValue?: number;
1501
+ countValue?: number | string;
1491
1502
  /** sets the sort label text
1492
1503
  * @default 'Sort'
1493
1504
  */
@@ -1665,7 +1676,7 @@ declare function useRequestParameter(paramName: string): {
1665
1676
  declare function useConnectedDataAsVariables(connectedData: Record<string, unknown> | undefined): Record<string, MeshDataVariableDefinition>;
1666
1677
 
1667
1678
  /** Converts dynamic inputs into VariablesProvider-format variables */
1668
- declare function useDynamicInputsAsVariables(dynamicInputs: MinimalDynamicInputs): Record<string, MeshDataVariableDefinition>;
1679
+ declare function useDynamicInputsAsVariables(dynamicInputs: DynamicInputs): Record<string, MeshDataVariableDefinition>;
1669
1680
 
1670
1681
  /**
1671
1682
  * Provides convenient access to the current Uniform Mesh SDK instance via React hook.
@@ -1682,4 +1693,34 @@ declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
1682
1693
  */
1683
1694
  declare function createLocationValidator<TSetValue>(setValue: SetLocationValueDispatch<TSetValue>, validate: (newValue: TSetValue, currentResult: SetValueOptions | undefined) => SetValueOptions): SetLocationValueDispatch<TSetValue>;
1684
1695
 
1685
- export { $createVariableNode, $isVariableNode, BaseRequestData, Brand, ControlledValuePlugin, DISCONNECT_VARIABLE_COMMAND, DamItem, DamSelectedItem, DamSelectedItemProps, DataRefreshButton, DataRefreshButtonProps, DataResourceDynamicInputProvider, DataResourceDynamicInputProviderProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DisconnectVariableCommandArguments, DispatchResult, EDIT_VARIABLE_COMMAND, EditVariableCommandArguments, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, InputVariables, InputVariablesProps, InsertVariableCommandArguments, ItemListProps, KnownUndefinedVariableInfo, LinkButton, MeshApp, MeshAppProps, MeshDataVariableDefinition, MinimalDynamicInput, MinimalDynamicInputs, NoResultsProps, OPEN_INSERT_VARIABLE_COMMAND, ObjectSearchContainer, ObjectSearchContainerProps, ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, ObjectSearchFilterContainerProps, ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, ObjectSearchListItemProps, ObjectSearchProvider, ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, ObjectSearchResultItemButtonProps, ObjectSearchResultItemProps, ObjectSearchResultList, ObjectSearchResultListProps, ParamTypeDynamicDataProvider, ParamTypeDynamicDataProviderProps, ParameterConnectOptions, ParameterConnectionIndicator, ParameterConnectionIndicatorProps, ParameterOrSingleVariable, ParameterOrSingleVariableProps, ParameterVariables, ParameterVariablesProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, QueryFilter, QueryFilterProps, QueryFilterSearchProps, RequestAction, RequestBody, RequestContext, RequestData, RequestHeaders, RequestMethodSelect, RequestParameter, RequestParameters, RequestParametersProps, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SearchQueryProps, SelectedItemProps, SelectionField, SelectionFieldValue, SerializedVariableNode, SetLocationValueDispatch, SetLocationValueFunction, TextVariableRenderer, UseVariablesMenu, UseVariablesMenuInput, VariableEditor, VariableEditorCompleteEvent, VariableEditorProps, VariableNode, VariableNodeState, VariableSourceGroup, VariablesAction, VariablesContext, VariablesEvents, VariablesList, VariablesPlugin, VariablesPluginProps, VariablesProvider, 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, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
1696
+ type ContentDataResourceLocaleInfoResult = {
1697
+ /**
1698
+ * Effective locale for data resource. It can be one of two types:
1699
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1700
+ * - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
1701
+ */
1702
+ effectiveLocale: string;
1703
+ /** Bound locale value. It can be one of two types:
1704
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1705
+ * - empty string - if locale was not set
1706
+ */
1707
+ boundLocale: string | undefined;
1708
+ };
1709
+ type ContentDataResourceLocaleInfoProps = {
1710
+ /** Current stored locale in mesh data type/resource.
1711
+ * It can be one of tree types:
1712
+ * - undefined - no locale stored in mesh data type/resource yet or it is not localized
1713
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1714
+ * - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
1715
+ *
1716
+ * If locale is empty, fallback to dynamic locale value if it is available.
1717
+ */
1718
+ locale: string | undefined;
1719
+ /** Map of dynamic inputs for current composition. Should be passed down from DataResource metadata */
1720
+ dynamicInputs: DynamicInputs;
1721
+ /** In case of empty locale value, this method is called to bind dynamic locale (sets locale to '${locale}') */
1722
+ setLocale?: (locale: string) => void;
1723
+ };
1724
+ declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
1725
+
1726
+ 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 };
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import { TDate } from 'timeago.js';
5
5
  import * as _emotion_react from '@emotion/react';
6
6
  import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
7
7
  import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
8
- import { DynamicInput, MeshLocation, SetValueOptions, EditConnectedDataResponseCancellationContext, DynamicInputs, DataSourceLocationValue, DataTypeLocationValue, BindableTypes } from '@uniformdev/mesh-sdk';
8
+ import { DynamicInputs, MeshLocation, SetValueOptions, EditConnectedDataResponseCancellationContext, DataSourceLocationValue, DataTypeLocationValue, BindableTypes } from '@uniformdev/mesh-sdk';
9
9
  export * from '@uniformdev/mesh-sdk';
10
10
  import { DataVariableDefinition, DataResourceVariables, DataType } from '@uniformdev/canvas';
11
11
  import { Emitter } from 'mitt';
@@ -42,21 +42,7 @@ declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) => _emotion_r
42
42
  declare const SvgPlus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
43
43
 
44
44
  declare namespace index {
45
- export {
46
- SvgCaution as Caution,
47
- SvgCheckmark as Checkmark,
48
- SvgChevronDown as ChevronDown,
49
- SvgClose as Close,
50
- SvgDanger as Danger,
51
- SvgExclamationPoint as ExclamationPoint,
52
- SvgInfo as Info,
53
- SvgLightbulb as Lightbulb,
54
- SvgMagnifyingGlass as MagnifyingGlass,
55
- SvgMaximizeAlt as MaximizeAlt,
56
- SvgMinus as Minus,
57
- SvgMoreVerticalAlt as MoreVerticalAlt,
58
- SvgPlus as Plus,
59
- };
45
+ export { SvgCaution as Caution, SvgCheckmark as Checkmark, SvgChevronDown as ChevronDown, SvgClose as Close, SvgDanger as Danger, SvgExclamationPoint as ExclamationPoint, SvgInfo as Info, SvgLightbulb as Lightbulb, SvgMagnifyingGlass as MagnifyingGlass, SvgMaximizeAlt as MaximizeAlt, SvgMinus as Minus, SvgMoreVerticalAlt as MoreVerticalAlt, SvgPlus as Plus };
60
46
  }
61
47
 
62
48
  /** @deprecated please use ObjectSearchListItem - https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-list-item */
@@ -399,11 +385,9 @@ declare const damSelectedItemMediaContainer: _emotion_react.SerializedStyles;
399
385
  declare const damSelectedItemInfoBtn: _emotion_react.SerializedStyles;
400
386
  declare const damSelectItemImage: _emotion_react.SerializedStyles;
401
387
 
402
- type MinimalDynamicInput = Omit<DynamicInput, 'source'>;
403
- type MinimalDynamicInputs = Record<string, MinimalDynamicInput>;
404
388
  type DataResourceDynamicInputProviderProps = {
405
389
  /** Explicitly provide dynamic input values. If not set, Mesh location will be used */
406
- dynamicInputs?: MinimalDynamicInputs;
390
+ dynamicInputs?: DynamicInputs;
407
391
  /** Child components of the provider. Variables-using components, such as InputVariables, can be used here. */
408
392
  children: ReactNode;
409
393
  };
@@ -813,7 +797,7 @@ type InputVariablesProps<TEditorContext = unknown> = {
813
797
  addOmitIfEmpty?: boolean;
814
798
  /** (optional) sets and shows the the error message value */
815
799
  errorMessage?: string;
816
- /** (optional) sets and shows the the warning message value */
800
+ /** (optional) sets and shows the warning message value */
817
801
  warningMessage?: string;
818
802
  /** (optional) sets and shows the the info message value */
819
803
  infoMessage?: string;
@@ -919,8 +903,9 @@ type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext
919
903
  onCancel: (context: TEditVariableCancelledContext) => void;
920
904
  context: TEditorContext | undefined;
921
905
  disableAutoFocusOnMount?: boolean;
906
+ showDisplayName?: boolean;
922
907
  };
923
- declare function VariableEditor({ variable, onSubmit, onCancel, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
908
+ declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
924
909
 
925
910
  type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = React.PropsWithChildren<{
926
911
  /**
@@ -1191,7 +1176,10 @@ type ObjectSearchContainerProps = {
1191
1176
  enableDynamicInputToResultId?: boolean;
1192
1177
  /** a child node that places components within the search location */
1193
1178
  searchFilters: ReactNode;
1194
- /** a child node that places components within a scrollable list location */
1179
+ /**
1180
+ * a child node that places components within a scrollable list location
1181
+ * set to `null` expl
1182
+ */
1195
1183
  resultList?: ReactNode;
1196
1184
  /** allows any child element */
1197
1185
  children?: ReactNode;
@@ -1214,9 +1202,10 @@ type ObjectSearchFilterProps = {
1214
1202
  selectLabel?: string;
1215
1203
  /** sets the select input options, if empty - only keyword search field will be rendered */
1216
1204
  selectOptions?: Array<{
1217
- id: string;
1205
+ id?: string;
1218
1206
  name?: string;
1219
1207
  label: string;
1208
+ value?: string;
1220
1209
  }>;
1221
1210
  /** sets the search input name value
1222
1211
  * @default 'searchText'
@@ -1253,6 +1242,8 @@ type SearchQueryProps<TExtraFilters = unknown> = {
1253
1242
  contentType?: string;
1254
1243
  /** sets the keyword search in the search context */
1255
1244
  keyword?: string;
1245
+ /** sets the locale in the search context */
1246
+ locale?: string;
1256
1247
  } & TExtraFilters;
1257
1248
  type SelectedItemProps<TExtraProps = unknown> = {
1258
1249
  /** sets the id value */
@@ -1323,12 +1314,16 @@ type ObjectSearchContextProps<TExtraFilters = unknown, TExtraItemProps = unknown
1323
1314
  list: ItemListProps<TExtraItemProps>;
1324
1315
  /** function that sets the list of items to state */
1325
1316
  onSetList: (value: ItemListProps) => void;
1317
+ /** is multi items selection allowed or not */
1318
+ isMulti: boolean;
1326
1319
  };
1327
1320
  type ObjectSearchProviderProps = {
1328
1321
  children: ReactNode;
1329
1322
  currentlySelectedItems?: Array<SelectedItemProps>;
1323
+ isMulti?: boolean;
1324
+ defaultQuery?: SearchQueryProps;
1330
1325
  };
1331
- declare const ObjectSearchProvider: ({ currentlySelectedItems, children }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1326
+ declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1332
1327
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1333
1328
 
1334
1329
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1337,7 +1332,7 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1337
1332
  /** sets image parameters
1338
1333
  * @deprecated Please use imageUrl to make it compatible with */
1339
1334
  image?: {
1340
- /** sets the src valuue */
1335
+ /** sets the src value */
1341
1336
  src: string;
1342
1337
  /** sets the alt text value */
1343
1338
  alt: string;
@@ -1359,15 +1354,16 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1359
1354
  children?: React$1.ReactNode;
1360
1355
  /** sets whether multiple entries can be added to the results list context
1361
1356
  * @default false
1357
+ * @deprecated Please use isMulti property in <ObjectSearchProvider />
1362
1358
  */
1363
1359
  isMulti?: boolean;
1364
1360
  /** sets disabled state to the interactive element */
1365
1361
  disabled?: boolean;
1366
- };
1362
+ } & React$1.HTMLAttributes<HTMLDivElement>;
1367
1363
  /**
1368
1364
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1369
1365
  * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1370
- declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, }: ObjectSearchListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1366
+ declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1371
1367
  /**
1372
1368
  * An opinionated loading skeleton component best used with ObjectSearchListItem
1373
1369
  * @example <ObjectSearchListItemLoadingSkeleton />
@@ -1419,6 +1415,8 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1419
1415
  * @default 'Selected'
1420
1416
  */
1421
1417
  resultLabelText?: string;
1418
+ /** sets and override react node replacing the whole HTML block for the result label and counter */
1419
+ resultLabelOverride?: ReactNode;
1422
1420
  /** sets the on remove button click action */
1423
1421
  onRemoveAllSelected?: () => void;
1424
1422
  /** sets the remove button text
@@ -1430,9 +1428,9 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1430
1428
  */
1431
1429
  hideRemoveButton?: boolean;
1432
1430
  /** allows additional buttons to be added to the result title group */
1433
- additionalButtons?: React.ReactNode;
1431
+ additionalButtons?: React__default.ReactNode;
1434
1432
  /** allows placing child components within the result list area */
1435
- renderResultComponent?: (value: TRenderComponent) => React.ReactNode;
1433
+ renderResultComponent?: (value: TRenderComponent) => React__default.ReactNode;
1436
1434
  /** disable or enable drag and drop functionality
1437
1435
  * @default false
1438
1436
  */
@@ -1440,7 +1438,13 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1440
1438
  /** sets the draggable id value */
1441
1439
  multiSelectId?: string;
1442
1440
  /** Rendered when nothing is selected */
1443
- whenNothingSelected?: React.ReactNode;
1441
+ whenNothingSelected?: React__default.ReactNode;
1442
+ /**
1443
+ * Special case for re-parenting the drag and drop container in case of issues with "position: fixed" and "transform:
1444
+ * You can read more about this here https://github.com/atlassian/react-beautiful-dnd/blob/master/docs/guides/reparenting.md
1445
+ * Providing this getter assumes you have that HTML element in the document, and it will enable re-parenting.
1446
+ */
1447
+ getContainerForDnDReparenting?: () => HTMLElement;
1444
1448
  };
1445
1449
  /**
1446
1450
  * @description An opinionated result list UI component that has built in drag and drop functionality and removal of all selected items from context.
@@ -1448,7 +1452,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1448
1452
  * maintain drag and drop functionality
1449
1453
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1450
1454
  */
1451
- declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, additionalButtons, renderResultComponent, multiSelectId, disableDnD, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1455
+ declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
1452
1456
 
1453
1457
  type QueryFilterSearchProps = {
1454
1458
  /** sets the count value */
@@ -1458,12 +1462,18 @@ type QueryFilterSearchProps = {
1458
1462
  /** sets the sortOrder filter value */
1459
1463
  sortOrder: string;
1460
1464
  };
1461
- type QuertFilterSelectionOptionProps = Array<{
1462
- id: string;
1463
- name: string;
1465
+ type QueryFilterSelectionOptionProps = Array<{
1466
+ /** @deprecated please use value instead */
1467
+ id?: string;
1468
+ /** @deprecated please use value or label instead */
1469
+ name?: string;
1470
+ /** contains id or machine values. will be used as value attribute in <option> */
1471
+ value?: string;
1472
+ /** Contains human-readable display name for select options.
1473
+ * Used as value in case value is not present <option> */
1464
1474
  label: string;
1465
1475
  }>;
1466
- type QueryFilterProps<TSelectOptions extends QuertFilterSelectionOptionProps = QuertFilterSelectionOptionProps> = {
1476
+ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = QueryFilterSelectionOptionProps> = {
1467
1477
  /** sets the query filter title
1468
1478
  * @default 'Configure Query'
1469
1479
  */
@@ -1484,10 +1494,11 @@ type QueryFilterProps<TSelectOptions extends QuertFilterSelectionOptionProps = Q
1484
1494
  * @default 'Count'
1485
1495
  */
1486
1496
  countLabel?: string;
1487
- /** sets the count value or items to show
1497
+ /** sets the count value or items to show. As a string you can pass dynamic variables ${countFromQuery} for example
1488
1498
  * @default 5
1499
+ * @deprecated please use ObjectSearchProviderProps['defaultQuery'] to pass initial count value
1489
1500
  */
1490
- countValue?: number;
1501
+ countValue?: number | string;
1491
1502
  /** sets the sort label text
1492
1503
  * @default 'Sort'
1493
1504
  */
@@ -1665,7 +1676,7 @@ declare function useRequestParameter(paramName: string): {
1665
1676
  declare function useConnectedDataAsVariables(connectedData: Record<string, unknown> | undefined): Record<string, MeshDataVariableDefinition>;
1666
1677
 
1667
1678
  /** Converts dynamic inputs into VariablesProvider-format variables */
1668
- declare function useDynamicInputsAsVariables(dynamicInputs: MinimalDynamicInputs): Record<string, MeshDataVariableDefinition>;
1679
+ declare function useDynamicInputsAsVariables(dynamicInputs: DynamicInputs): Record<string, MeshDataVariableDefinition>;
1669
1680
 
1670
1681
  /**
1671
1682
  * Provides convenient access to the current Uniform Mesh SDK instance via React hook.
@@ -1682,4 +1693,34 @@ declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
1682
1693
  */
1683
1694
  declare function createLocationValidator<TSetValue>(setValue: SetLocationValueDispatch<TSetValue>, validate: (newValue: TSetValue, currentResult: SetValueOptions | undefined) => SetValueOptions): SetLocationValueDispatch<TSetValue>;
1684
1695
 
1685
- export { $createVariableNode, $isVariableNode, BaseRequestData, Brand, ControlledValuePlugin, DISCONNECT_VARIABLE_COMMAND, DamItem, DamSelectedItem, DamSelectedItemProps, DataRefreshButton, DataRefreshButtonProps, DataResourceDynamicInputProvider, DataResourceDynamicInputProviderProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DisconnectVariableCommandArguments, DispatchResult, EDIT_VARIABLE_COMMAND, EditVariableCommandArguments, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, InputVariables, InputVariablesProps, InsertVariableCommandArguments, ItemListProps, KnownUndefinedVariableInfo, LinkButton, MeshApp, MeshAppProps, MeshDataVariableDefinition, MinimalDynamicInput, MinimalDynamicInputs, NoResultsProps, OPEN_INSERT_VARIABLE_COMMAND, ObjectSearchContainer, ObjectSearchContainerProps, ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, ObjectSearchFilterContainerProps, ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, ObjectSearchListItemProps, ObjectSearchProvider, ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, ObjectSearchResultItemButtonProps, ObjectSearchResultItemProps, ObjectSearchResultList, ObjectSearchResultListProps, ParamTypeDynamicDataProvider, ParamTypeDynamicDataProviderProps, ParameterConnectOptions, ParameterConnectionIndicator, ParameterConnectionIndicatorProps, ParameterOrSingleVariable, ParameterOrSingleVariableProps, ParameterVariables, ParameterVariablesProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, QueryFilter, QueryFilterProps, QueryFilterSearchProps, RequestAction, RequestBody, RequestContext, RequestData, RequestHeaders, RequestMethodSelect, RequestParameter, RequestParameters, RequestParametersProps, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SearchQueryProps, SelectedItemProps, SelectionField, SelectionFieldValue, SerializedVariableNode, SetLocationValueDispatch, SetLocationValueFunction, TextVariableRenderer, UseVariablesMenu, UseVariablesMenuInput, VariableEditor, VariableEditorCompleteEvent, VariableEditorProps, VariableNode, VariableNodeState, VariableSourceGroup, VariablesAction, VariablesContext, VariablesEvents, VariablesList, VariablesPlugin, VariablesPluginProps, VariablesProvider, 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, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
1696
+ type ContentDataResourceLocaleInfoResult = {
1697
+ /**
1698
+ * Effective locale for data resource. It can be one of two types:
1699
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1700
+ * - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
1701
+ */
1702
+ effectiveLocale: string;
1703
+ /** Bound locale value. It can be one of two types:
1704
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1705
+ * - empty string - if locale was not set
1706
+ */
1707
+ boundLocale: string | undefined;
1708
+ };
1709
+ type ContentDataResourceLocaleInfoProps = {
1710
+ /** Current stored locale in mesh data type/resource.
1711
+ * It can be one of tree types:
1712
+ * - undefined - no locale stored in mesh data type/resource yet or it is not localized
1713
+ * - raw locale string - locale stored in mesh data type/resource (e.g. 'en-US')
1714
+ * - variable reference - locale stored in mesh data type/resource as a variable reference (e.g. '${locale}')
1715
+ *
1716
+ * If locale is empty, fallback to dynamic locale value if it is available.
1717
+ */
1718
+ locale: string | undefined;
1719
+ /** Map of dynamic inputs for current composition. Should be passed down from DataResource metadata */
1720
+ dynamicInputs: DynamicInputs;
1721
+ /** In case of empty locale value, this method is called to bind dynamic locale (sets locale to '${locale}') */
1722
+ setLocale?: (locale: string) => void;
1723
+ };
1724
+ declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
1725
+
1726
+ 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 };