@uniformdev/mesh-sdk-react 17.6.1-alpha.60 → 17.7.1-alpha.34

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
 import * as React from 'react';
-import React__default, { SVGProps } from 'react';
+import React__default, { SVGProps, ComponentType, PropsWithChildren } from 'react';
 import { TDate } from 'timeago.js';
 import * as _emotion_react from '@emotion/react';
-import { InputSelectProps } from '@uniformdev/design-system';
-export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, InputKeywordSearch as KeywordSearchInput, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps } from '@uniformdev/design-system';
-import { DataVariableDefinition } from '@uniformdev/canvas';
+import { DataVariableDefinition, DataResourceVariables } from '@uniformdev/canvas';
 import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
-import { MeshLocation, UniformMeshSDK, MeshLocationCore } from '@uniformdev/mesh-sdk';
+import { MeshLocation, SetValueOptions, DataSourceLocationValue, DataTypeLocationValue, UniformMeshSDK, MeshLocationCore } from '@uniformdev/mesh-sdk';
 export * from '@uniformdev/mesh-sdk';
+import { InputSelectProps } from '@uniformdev/design-system';
+export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, InputKeywordSearch as KeywordSearchInput, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps } from '@uniformdev/design-system';
 
 declare const SvgCaution: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
@@ -370,23 +370,80 @@ declare const damSelectedItemMediaContainer: _emotion_react.SerializedStyles;
 declare const damSelectedItemInfoBtn: _emotion_react.SerializedStyles;
 declare const damSelectItemImage: _emotion_react.SerializedStyles;
 
-declare type MeshAppProps = {
-    loadingComponent?: React__default.ComponentType;
-    errorComponent?: React__default.ComponentType<{
-        error: Error;
-    }>;
+/**
+ * Provides convenient access to the current Uniform Mesh location via React hook.
+ * Intended to be used within <MeshApp />.
+ *
+ * There are three primary ways to invoke this hook:
+ * 1. Without any arguments, this hook will return the current location regardless of its type. The result will be a union of all possible locations you can discriminate between i.e. with an if statement on the `type`
+ *    const location = useMeshLocation();
+ *    if (location.type === 'paramType') { // location is now known to be a paramType }
+ * 2. With a string argument, this hook will assert that the current location is the expected one and return the correct typings for that location.
+ *    const location = useMeshLocation('settings');
+ * 3. With an explicit generic to set the expected param type data or param type settings data. This is useful because (2) will return unknown as the value type for param types.
+ *    const location = useMeshLocation<'paramType', MyParamTypeValueType>();
+ *
+ * You can also combine (2) and (3) to get both explicit value typing and assertion of the location.
+ */
+declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLocationValue = unknown, TLocationSetValue = TLocationValue>(expectedLocation?: TLocationType): Omit<Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.DataResourceLocation, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
+    type: TLocationType;
+}> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
+    type: TLocationType;
+}>, "setValue"> & {
+    setValue: SetLocationValueDispatch<(Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataResourceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
+        type: TLocationType;
+    }>)["value"], Parameters<(Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.DataResourceLocation, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
+        type: TLocationType;
+    }> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
+        type: TLocationType;
+    }>)["setValue"]>[0]>;
+};
+declare type SetLocationValueDispatch<TValue, TSetValue = TValue> = (dispatch: SetLocationValueFunction<TValue, TSetValue>) => Promise<void> | void;
+declare type SetLocationValueFunction<TValue, TSetValue> = (previousValue: TValue) => DispatchResult<TSetValue>;
+declare type DispatchResult<TSetValue> = {
+    options?: SetValueOptions;
+    newValue: TSetValue;
 };
-declare const MeshApp: React__default.FC<React__default.PropsWithChildren<MeshAppProps>>;
-
-declare function RequestBody(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare type InputToken = {
     name: string;
     value: string;
 };
 declare type InputVariablesProps = {
-    /** sets the input label value */
-    label: string;
+    /** sets the input aria-label value. */
+    'aria-label'?: string;
     /** sets the value of the input */
     value: string;
     /** sets the passed down function call */
@@ -395,7 +452,7 @@ declare type InputVariablesProps = {
     onPaste?: (newValue: string) => void;
     disableVariables?: boolean;
 };
-declare function InputVariables({ label, value, disableVariables, onChange, onPaste }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare function InputVariables({ 'aria-label': ariaLabel, value, disableVariables, onChange, onPaste, }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare type DataVariableDefinitionWithName = {
     name: string;
@@ -437,6 +494,74 @@ declare type VariablesContext = {
 declare function VariablesProvider({ value, onChange, editVariableComponent, children, }: VariablesProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 declare function useVariables(): VariablesContext;
 
+declare type DataResourceVariablesListProps = {
+    /**
+     * Overrides rendering of a variable based on the `type` property it has set on it.
+     * If this is not passed, all variables are rendered using TextVariableRenderer.
+     */
+    typeRenderers?: Record<string, ComponentType<DataResourceVariableRendererProps> | undefined>;
+    /**
+     * Callback when the state changes in the data resource variables.
+     * Can be sent directly to `useMeshLocation`'s `setValue` or intercepted for validation
+     * by `createLocationValidator`.
+     */
+    setVariables: SetLocationValueDispatch<DataResourceVariables>;
+    /**
+     * Component that is rendered if no variables are set on the data resource.
+     * Defaults to a callout stating that no settings are required.
+     */
+    noVariables?: ComponentType;
+};
+declare function DataResourceVariablesList({ setVariables, noVariables: NoVariablesComponent, typeRenderers, }: DataResourceVariablesListProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare type DataResourceVariableRendererProps = {
+    /** Current value of the variable on the data resource */
+    value: string | undefined;
+    /** Updates the value of the variable on the data resource */
+    setValue: (newValue: string | undefined) => void;
+    /** The definition of the data variable */
+    definition: DataVariableDefinitionWithName;
+};
+/** Default data resource variable renderer, uses a text input */
+declare function TextVariableRenderer({ definition, value, setValue }: DataResourceVariableRendererProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type DataSourceEditorProps = PropsWithChildren<{
+    /**
+     * Callback when the state changes in the request or variables contexts.
+     * Can be sent directly to `useMeshLocation`'s `setValue` or intercepted for validation
+     * by `createLocationValidator`.
+     */
+    onChange: SetLocationValueDispatch<DataSourceLocationValue>;
+}>;
+/**
+ * Wrapper for editing a data source using Uniform Mesh SDK components that rely on `useRequest()`
+ * or `useVariables()`, or custom components that use the same hooks.
+ */
+declare function DataSourceEditor({ onChange, children }: DataSourceEditorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type DataTypeEditorProps = PropsWithChildren<{
+    /**
+     * Callback when the state changes in the request or variables contexts.
+     * Can be sent directly to `useMeshLocation`'s `setValue` or intercepted for validation
+     * by `createLocationValidator`.
+     */
+    onChange: SetLocationValueDispatch<DataTypeLocationValue>;
+}>;
+/**
+ * Wrapper for editing a data type using Uniform Mesh SDK components that rely on `useRequest()`
+ * or `useVariables()`, or custom components that use the same hooks.
+ */
+declare function DataTypeEditor({ onChange, children }: DataTypeEditorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type MeshAppProps = {
+    loadingComponent?: React__default.ComponentType;
+    errorComponent?: React__default.ComponentType<{
+        error: Error;
+    }>;
+};
+declare const MeshApp: React__default.FC<React__default.PropsWithChildren<MeshAppProps>>;
+
+declare function RequestBody(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
 declare function RequestHeaders({ disableVariables }: Pick<InputVariablesProps, 'disableVariables'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
@@ -561,35 +686,6 @@ declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUnifor
     sdk: UniformMeshSDK | undefined;
 };
 
-/**
- * Provides convenient access to the current Uniform Mesh location via React hook.
- * Intended to be used within <MeshApp />.
- *
- * There are three primary ways to invoke this hook:
- * 1. Without any arguments, this hook will return the current location regardless of its type. The result will be a union of all possible locations you can discriminate between i.e. with an if statement on the `type`
- *    const location = useMeshLocation();
- *    if (location.type === 'paramType') { // location is now known to be a paramType }
- * 2. With a string argument, this hook will assert that the current location is the expected one and return the correct typings for that location.
- *    const location = useMeshLocation('settings');
- * 3. With an explicit generic to set the expected param type data or param type settings data. This is useful because (2) will return unknown as the value type for param types.
- *    const location = useMeshLocation<'paramType', MyParamTypeValueType>();
- *
- * You can also combine (2) and (3) to get both explicit value typing and assertion of the location.
- */
-declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLocationValue = unknown, TLocationSetValue = TLocationValue>(expectedLocation?: TLocationType): Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
-    type: TLocationType;
-}> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
-    type: TLocationType;
-}> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
-    type: TLocationType;
-}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
-    type: TLocationType;
-}> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
-    type: TLocationType;
-}> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
-    type: TLocationType;
-}>;
-
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
  * Intended to be used within <MeshApp />.
@@ -604,4 +700,13 @@ declare function useUniformMeshLocation<TLocationValue = unknown, TLocationMetad
  */
 declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
 
-export { BaseRequestData, Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, InputToken, InputVariables, InputVariablesProps, MeshApp, MeshAppProps, NoResultsProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, RequestAction, RequestBody, RequestContext, RequestData, RequestHeaders, RequestMethodSelect, RequestParameter, RequestParameters, RequestParametersProps, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SelectionField, SelectionFieldValue, UniformMeshLocationContext, UniformMeshLocationContextProvider, UniformMeshLocationContextValue, UniformMeshSdkContext, UniformMeshSdkContextProvider, UniformMeshSdkContextValue, UseUniformMeshSdkOptions, VariableEditor, VariableEditorProps, VariablesAction, VariablesContext, VariablesList, VariablesProvider, VariablesProviderProps, badgeIcon, 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, useInitializeUniformMeshSdk, useMeshLocation, useProductQueryContext, useProductSearchContext, useRequest, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };
+/**
+ * Creates a validation interceptor between useMeshLocation's setValue function and your code.
+ * You can use this utility to write cleaner validation logic for your Mesh Location UIs.
+ * @param setValue The location's raw setValue function
+ * @param validate A function to validate the new location's value.
+ * @returns An equivalent to the setValue function that intercepts sets, performs validation, and emits the result with the new value.
+ */
+declare function createLocationValidator<TSetValue>(setValue: SetLocationValueDispatch<TSetValue>, validate: (newValue: TSetValue, currentResult: SetValueOptions | undefined) => SetValueOptions): SetLocationValueDispatch<TSetValue>;
+
+export { BaseRequestData, Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DispatchResult, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, InputToken, InputVariables, InputVariablesProps, MeshApp, MeshAppProps, NoResultsProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, RequestAction, RequestBody, RequestContext, RequestData, RequestHeaders, RequestMethodSelect, RequestParameter, RequestParameters, RequestParametersProps, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SelectionField, SelectionFieldValue, SetLocationValueDispatch, SetLocationValueFunction, TextVariableRenderer, UniformMeshLocationContext, UniformMeshLocationContextProvider, UniformMeshLocationContextValue, UniformMeshSdkContext, UniformMeshSdkContextProvider, UniformMeshSdkContextValue, UseUniformMeshSdkOptions, VariableEditor, VariableEditorProps, VariablesAction, VariablesContext, 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, useInitializeUniformMeshSdk, useMeshLocation, useProductQueryContext, useProductSearchContext, useRequest, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };