@uniformdev/mesh-sdk-react 17.4.1-alpha.37 → 17.5.1-alpha.105

package/dist/index.d.ts

@@ -6,7 +6,9 @@ import React__default, { SVGProps } from 'react';
 import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
 import { TDate } from 'timeago.js';
 import * as _emotion_react from '@emotion/react';
-export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, Heading, HeadingProps, Input, 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 { InputSelectProps } from '@uniformdev/design-system';
+export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, 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';
 
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
@@ -417,6 +419,137 @@ declare type MeshAppProps = {
 };
 declare const MeshApp: React__default.FC<React__default.PropsWithChildren<MeshAppProps>>;
 
+declare type DataVariableDefinitionWithName = {
+    name: string;
+} & DataVariableDefinition;
+declare function variablesToList(variables: Record<string, DataVariableDefinition> | undefined): Array<DataVariableDefinitionWithName>;
+
+declare type VariableEditorProps = {
+    variable: string;
+    onSubmit: (values: DataVariableDefinitionWithName) => void | Promise<void>;
+    onCancel: () => void;
+};
+declare function VariableEditor({ variable, onSubmit, onCancel }: VariableEditorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type VariablesProviderProps = React.PropsWithChildren<{
+    value: Record<string, DataVariableDefinition>;
+    onChange: (newValue: Record<string, DataVariableDefinition>) => void;
+    editVariableComponent?: React.ComponentType<VariableEditorProps>;
+}>;
+declare type VariablesAction = {
+    type: 'edit';
+    variable: string;
+} | {
+    type: 'remove';
+    variable: string;
+} | {
+    type: 'set';
+    variable: DataVariableDefinitionWithName;
+    openEditor?: boolean;
+} | {
+    type: 'reorder';
+    result: Record<string, DataVariableDefinitionWithName>;
+};
+declare type VariablesContext = {
+    dispatch: (event: VariablesAction) => void;
+    variables: Readonly<Record<string, DataVariableDefinition>>;
+};
+declare function VariablesProvider({ value, onChange, editVariableComponent, children, }: VariablesProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare function useVariables(): VariablesContext;
+
+declare function VariablesList(): _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 value of the input */
+    value: string;
+    /** sets the passed down function call */
+    onChange: (newValue: string) => void;
+    disableVariables?: boolean;
+};
+declare function InputVariables({ label, value, disableVariables, onChange }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+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;
+
+declare function RequestParameters({ disableVariables }: Pick<InputVariablesProps, 'disableVariables'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type RequestParameter = {
+    key: string;
+    value: string;
+};
+declare type RequestData = {
+    relativeUrl: string;
+    headers: Array<RequestParameter>;
+    baseUrl?: string;
+    method?: string;
+    body?: string;
+};
+declare type ComputedRequestData = RequestData & {
+    parameters: Array<RequestParameter>;
+};
+declare type RequestProviderProps = React.PropsWithChildren<{
+    value: RequestData;
+    onChange: (newValue: ComputedRequestData) => void;
+}>;
+declare type RequestAction = {
+    type: 'setRelativeUrl';
+    relativeUrl: string;
+} | {
+    type: 'updateHeader';
+    header: RequestParameter;
+    index?: number;
+} | {
+    type: 'removeHeader';
+    index: number;
+} | {
+    type: 'updateParameter';
+    parameter: RequestParameter;
+    index?: number;
+} | {
+    type: 'removeParameter';
+    index: number;
+} | {
+    type: 'setMethod';
+    method: string;
+} | {
+    type: 'setBody';
+    body: string;
+    contentType: string;
+};
+declare type RequestContext = {
+    dispatch: (event: RequestAction) => void;
+    request: Readonly<ComputedRequestData>;
+};
+declare function RequestProvider({ value, onChange, children }: RequestProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare function useRequest(): RequestContext;
+declare function decomposeRelativeUrl(relativeUrl: string): [string, Array<RequestParameter>];
+
+declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type RequestTypeContainerProps = React.HTMLAttributes<HTMLDivElement> & {
+    /**sets the background color of the container
+     * @default 'transparent'
+     */
+    bgColor?: 'transparent' | 'var(--gray-100)';
+    children: React.ReactNode;
+};
+/**
+ * @description a container to layout content in a 2 column grid format = 12ch 1fr
+ * @example <RequestTypeContainer bgColor="var(--gray-100)">
+ * <label>Name <input type="text" /></label>
+ * <label>Name <input type="text" /></label>
+ * </div> */
+declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
 declare const SvgCaution: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
@@ -461,4 +594,4 @@ declare namespace index {
   };
 }
 
-export { Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DefaultSearchRow, DefaultSelectedItem, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, MeshApp, MeshAppProps, NoResultsProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, ResolvableLoadingValue, SelectionField, SelectionFieldValue, UniformMeshLocationContext, UniformMeshLocationContextProvider, UniformMeshLocationContextValue, UniformMeshSdkContext, UniformMeshSdkContextProvider, UniformMeshSdkContextValue, UseUniformMeshSdkOptions, 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, useInitializeUniformMeshSdk, useMeshLocation, useProductQueryContext, useProductSearchContext, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext };
+export { Brand, ComputedRequestData, 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, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, 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, decomposeRelativeUrl, 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, useInitializeUniformMeshSdk, useMeshLocation, useProductQueryContext, useProductSearchContext, useRequest, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };