@uniformdev/mesh-sdk-react 19.24.0 → 19.25.0

package/dist/index.d.ts

@@ -441,6 +441,14 @@ type DispatchResult<TSetValue> = {
     newValue: TSetValue;
 };
 
+type PasteTransformerPluginProps = {
+    /**
+     * Transforms pasted contents before inserting them.
+     * Return undefined to execute default paste behaviour, or a string to set the paste's contents.
+     */
+    transformPaste?: (pastedText: string) => string | undefined;
+};
+
 type InputToken = {
     name: string;
     value: string;
@@ -456,19 +464,24 @@ type InputVariablesProps = {
     value: string;
     /** sets the passed down function call */
     onChange: (newValue: string) => void;
-    /**
-     * Called when the field is pasted into
-     * Note that this will auto-cancel onChange after the paste when defined.
-     */
-    onPaste?: (newValue: string) => void;
     /** Disables using variables in the input */
     disableVariables?: boolean;
-    /** Turns off the 'Reset' menu option that is added by default when variables are bound to */
+    /**
+     * Turns off the 'Reset' menu option that is added when:
+     * - inputWhenNoVariables is passed in
+     * - variables are, or have have been bound to
+     *
+     * The reset button returns the editor to the inputWithNoVariables state
+     *
+     * @deprecated not usually necessary to set this, it's automatic
+     */
     disableReset?: boolean;
     /** Enables adding variables from the menu */
     showAddVariableMenuOption?: boolean;
     /** Disables the inline variable selection menu when rendering a variables input */
     disableInlineMenu?: boolean;
+    /** Enables clicking a variable reference to edit the variable */
+    enableEditingVariables?: boolean;
     /**
      * When no variables are referenced in the value, and this prop is provided,
      * the variables-injection input will be replaced with this component.
@@ -482,20 +495,23 @@ type InputVariablesProps = {
     infoMessage?: string;
     /** (optional) sets caption text value */
     caption?: string;
-};
-declare function InputVariables({ id, 'aria-label': ariaLabel, label, value, disableVariables, disableReset, disableInlineMenu, onChange, onPaste, showAddVariableMenuOption, inputWhenNoVariables, caption, errorMessage, warningMessage, infoMessage, ...inputProps }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+    /** Sets the test ID of the input */
+    'data-test-id'?: string;
+} & PasteTransformerPluginProps;
+declare function InputVariables({ id, 'aria-label': ariaLabel, label, value, disableVariables, disableReset, enableEditingVariables, disableInlineMenu, onChange, transformPaste, showAddVariableMenuOption, inputWhenNoVariables, caption, errorMessage, warningMessage, infoMessage, 'data-test-id': dataTestId, }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
-/**
- * A regular expression that matches Uniform variable expressions
- * in the form of ${variableName}.
- */
-declare const variableExpression: RegExp;
+/** Expected prefix for variable expressions */
 declare const variablePrefix = "${";
+/** Expected suffix for variable expressions */
 declare const variableSuffix = "}";
 
 type DataVariableDefinitionWithName = {
     name: string;
 } & DataVariableDefinition;
+/**
+ * Converts variable definitions stored in a map into a flat list,
+ * respecting their `order` property if set, and sorting by display name otherwise.
+ */
 declare function variablesToList(variables: Record<string, DataVariableDefinition> | undefined): Array<DataVariableDefinitionWithName>;
 
 type VariableEditorProps = {
@@ -510,8 +526,21 @@ declare function VariableEditor({ variable, onSubmit, onCancel, disableMeshTip }
 declare function VariablesList(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type VariablesProviderProps = React$1.PropsWithChildren<{
+    /**
+     * Signals that components in this variables context are not intended to allow mutation
+     * of the variable values (i.e. editing, adding, or deleting variable definitions).
+     *
+     * Dispatching updates is still accepted, but will be ignored.
+     */
+    readOnly?: boolean;
+    /** Variable values to load into the context */
     value: Record<string, DataVariableDefinition>;
-    onChange: (newValue: Record<string, DataVariableDefinition>) => void;
+    /** Function to handle mutations to the variable values (optional when readOnly is true) */
+    onChange?: (newValue: Record<string, DataVariableDefinition>) => void;
+    /**
+     * Provide a component to handle editing a variable definition (e.g. a modal wrapper)
+     * If not passed, the editor will be rendered inline, with potentially strange results.
+     */
     editVariableComponent?: React$1.ComponentType<VariableEditorProps>;
 }>;
 type VariablesAction = {
@@ -532,6 +561,13 @@ type VariablesEvents = {
     update: string;
 };
 type VariablesContext = {
+    /**
+     * Signals that components in this variables context are not intended to allow mutation
+     * of the variable values (i.e. editing, adding, or deleting variable definitions).
+     *
+     * Dispatching updates is still accepted, but will be ignored.
+     */
+    readOnly?: boolean;
     /** Dispatch update events to the variables */
     dispatch: (event: VariablesAction) => void;
     /** The current variables value */
@@ -548,7 +584,7 @@ type VariablesContext = {
      */
     flatVariables: Readonly<Record<string, string>>;
 };
-declare function VariablesProvider({ value, onChange, editVariableComponent, children, }: VariablesProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare function VariablesProvider({ value, onChange, editVariableComponent, readOnly, children, }: VariablesProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 declare function useVariables(returnEmptyWithoutProvider?: boolean): VariablesContext;
 
 type DataResourceVariablesListProps = {
@@ -1120,4 +1156,4 @@ declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
  */
 declare function createLocationValidator<TSetValue>(setValue: SetLocationValueDispatch<TSetValue>, validate: (newValue: TSetValue, currentResult: SetValueOptions | undefined) => SetValueOptions): SetLocationValueDispatch<TSetValue>;
 
-export { BaseRequestData, Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DataRefreshButton, DataRefreshButtonProps, DataResourceDynamicInputProvider, DataResourceDynamicInputProviderProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DispatchResult, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, InputToken, InputVariables, InputVariablesProps, ItemListProps, LinkButton, MeshApp, MeshAppProps, MinimalDynamicInput, MinimalDynamicInputs, NoResultsProps, ObjectSearchContainer, ObjectSearchContainerProps, ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, ObjectSearchFilterContainerProps, ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, ObjectSearchListItemProps, ObjectSearchProvider, ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, ObjectSearchResultItemButtonProps, ObjectSearchResultItemProps, ObjectSearchResultList, ObjectSearchResultListProps, 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, SetLocationValueDispatch, SetLocationValueFunction, TextVariableRenderer, VariableEditor, VariableEditorProps, VariablesAction, VariablesContext, VariablesEvents, VariablesList, VariablesProvider, VariablesProviderProps, badgeIcon, 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, 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, urlEncodeRequestParameter, urlEncodeRequestUrl, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariables, variableExpression, variablePrefix, variableSuffix, variablesToList };
+export { BaseRequestData, Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DataRefreshButton, DataRefreshButtonProps, DataResourceDynamicInputProvider, DataResourceDynamicInputProviderProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DispatchResult, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, InputToken, InputVariables, InputVariablesProps, ItemListProps, LinkButton, MeshApp, MeshAppProps, MinimalDynamicInput, MinimalDynamicInputs, NoResultsProps, ObjectSearchContainer, ObjectSearchContainerProps, ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, ObjectSearchFilterContainerProps, ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, ObjectSearchListItemProps, ObjectSearchProvider, ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, ObjectSearchResultItemButtonProps, ObjectSearchResultItemProps, ObjectSearchResultList, ObjectSearchResultListProps, 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, SetLocationValueDispatch, SetLocationValueFunction, TextVariableRenderer, VariableEditor, VariableEditorProps, VariablesAction, VariablesContext, VariablesEvents, VariablesList, VariablesProvider, VariablesProviderProps, badgeIcon, 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, 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, urlEncodeRequestParameter, urlEncodeRequestUrl, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariables, variablePrefix, variableSuffix, variablesToList };