@uniformdev/mesh-sdk-react 18.27.1-alpha.12 → 18.27.1-alpha.23

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
-import * as React from 'react';
-import React__default, { SVGProps, ComponentType, PropsWithChildren } from 'react';
+import * as React$1 from 'react';
+import React__default, { SVGProps, ComponentType, PropsWithChildren, HTMLAttributes, ReactNode, AnchorHTMLAttributes } from 'react';
 import { TDate } from 'timeago.js';
 import * as _emotion_react from '@emotion/react';
 import { DataVariableDefinition, DataResourceVariables } from '@uniformdev/canvas';
@@ -77,20 +77,20 @@ type EntrySearchProps<TResult extends EntrySearchResult = EntrySearchResult> = {
     cursor?: string;
     contentTypes?: EntrySearchContentType[];
     selectedItems: TResult[] | undefined;
-    logoIcon: string | React.ComponentType<{
+    logoIcon: string | React$1.ComponentType<{
         className?: string;
     }>;
     select: (items: TResult[], selectedContentType?: string) => void;
     requireContentType?: boolean;
     multiSelectId?: string;
     multiSelect?: boolean;
-    rowComponent?: React.FC<EntrySearchRowProps<TResult>>;
-    selectedItemComponent?: React.FC<EntrySearchSelectedItemProps<TResult>>;
+    rowComponent?: React$1.FC<EntrySearchRowProps<TResult>>;
+    selectedItemComponent?: React$1.FC<EntrySearchSelectedItemProps<TResult>>;
     onAddNew?: (type: EntrySearchContentType) => void;
     onEditClosed?: (item: EntrySearchResult) => void;
     onCancel?: () => void;
     resultsLoading?: boolean;
-    noResultsComponent?: React.FC<{
+    noResultsComponent?: React$1.FC<{
         searchText?: string;
         selectedContentType?: string;
     }>;
@@ -470,10 +470,10 @@ declare function VariableEditor({ variable, onSubmit, onCancel }: VariableEditor
 
 declare function VariablesList(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
-type VariablesProviderProps = React.PropsWithChildren<{
+type VariablesProviderProps = React$1.PropsWithChildren<{
     value: Record<string, DataVariableDefinition>;
     onChange: (newValue: Record<string, DataVariableDefinition>) => void;
-    editVariableComponent?: React.ComponentType<VariableEditorProps>;
+    editVariableComponent?: React$1.ComponentType<VariableEditorProps>;
 }>;
 type VariablesAction = {
     type: 'edit';
@@ -554,6 +554,218 @@ type DataTypeEditorProps = PropsWithChildren<{
  */
 declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
+    /** sets the button text */
+    buttonText: string;
+    /** shows or hides the loading indicator when retrieving data */
+    isLoading: boolean;
+};
+/** @example <DataRefreshButton buttonText="my button" isLoading /> */
+declare const DataRefreshButton: ({ buttonText, isLoading, ...props }: DataRefreshButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchContainerProps = {
+    /** a child node that places components within the search location */
+    searchFilters: ReactNode;
+    /** a child node that places components within a scrollable list location */
+    resultList: ReactNode;
+    /** allows any child element */
+    children?: ReactNode;
+    /** function for the save action */
+    onSave?: () => void;
+    /** function fort he cancel action */
+    onCancel?: () => void;
+};
+/** @example  <EntrySearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
+declare const EntrySearchContainer: ({ searchFilters, resultList, onSave, onCancel, children, }: EntrySearchContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchFilterProps = {
+    /** shows or hides the required content type select option */
+    requireContentType?: boolean;
+    /** sets the text for the required content type select option
+     * @default 'All content types'
+     */
+    typeSelectorAllTypesOptionText?: string;
+    /** sets the select input value label text
+     * @default 'Content Type Select'
+     */
+    selectLabel?: string;
+    /** sets the select input options */
+    selectOptions: Array<{
+        id: string;
+        name: string;
+    }>;
+    /** sets the search input name value
+     * @default 'searchText'
+     */
+    searchInputName?: string;
+    /** sets the search input placeholder text
+     * @default 'Enter keyword to narrow your results'
+     */
+    searchInputPlaceholderText?: string;
+};
+/** @example  <EntrySearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
+declare const EntrySearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: EntrySearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchFilterContainerProps = {
+    label: string;
+    children?: React.ReactNode;
+};
+declare const EntrySearchFilterContainer: ({ label, children }: EntrySearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchListItemProps = {
+    id: string;
+    title: string;
+    subTitle?: string | string[];
+    image?: {
+        src: string;
+        alt: string;
+        width?: number;
+        height?: number;
+    };
+    onSelect?: (data?: Record<string, unknown>) => void;
+    popoverInfo?: React$1.ReactNode;
+    children?: React$1.ReactNode;
+};
+declare const EntrySearchListItem: ({ id, title, subTitle, image, popoverInfo, onSelect, children, ...props }: EntrySearchListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const EntrySearchListItemLoadingSkeleton: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type StatusTypes = 'published' | 'modified' | 'draft' | 'unpublished';
+type PublishStatusProps = {
+    status: StatusTypes;
+};
+declare const PublishStatus: ({ status }: PublishStatusProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchResultItemProps = {
+    /** sets the id which is used for removal functionality */
+    id: string;
+    /** sets the title value */
+    title: string;
+    /** sets the subtitle value */
+    subtitle?: string;
+    /** sets user defined child nodes inside the popover box */
+    popoverInfo?: ReactNode;
+    /** sets the publish status */
+    publishStatus?: StatusTypes;
+    /** sets the created date */
+    createdAt?: TDate;
+    /** sets additional remove functionality onto of default removal */
+    onRemove?: () => void;
+    /** sets whether to show or hide the remove button
+     * @default false
+     */
+    hideRemoveButton?: boolean;
+    /** sets user defined child nodes that are uncontrolled by Uniform */
+    children?: ReactNode;
+};
+declare const EntrySearchResultItem: ({ id, title, subtitle, popoverInfo, publishStatus, onRemove, createdAt, hideRemoveButton, children, }: EntrySearchResultItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchResultItemButtonProps = HTMLAttributes<HTMLButtonElement> & {
+    text: string;
+    icon?: string;
+};
+declare const EntrySearchResultItemButton: ({ text, icon, ...props }: EntrySearchResultItemButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+type LinkButtonProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    text: string;
+    icon?: string;
+};
+declare const LinkButton: ({ text, icon, ...props }: LinkButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EntrySearchResultListProps = {
+    /** sets the result label value
+     * @default 'Selected'
+     */
+    resultLabelText?: string;
+    /** sets the on remove button click action */
+    onRemoveAllSelected?: () => void;
+    /** sets the remove button text
+     * @default 'Remove all'
+     */
+    removeButtonText?: string;
+    /** sets whether to show or hide the remove button
+     * @default false
+     */
+    hideRemoveButton?: boolean;
+    /** allows additional buttons to be added to the result title group */
+    additionalButtons?: React.ReactNode;
+    /** allows placing child components within the result list area */
+    children?: React.ReactNode;
+};
+declare const EntrySearchResultList: ({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, additionalButtons, children, }: EntrySearchResultListProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type QueryFilterSearchProps = {
+    count: number;
+    sortBy: string;
+    sortOrder: string;
+};
+type QueryFilterProps = {
+    queryFilterTitle?: string;
+    requireContentType?: boolean;
+    typeSelectorAllTypesOptionText?: string;
+    contentTypeLabel?: string;
+    contentTypeOptions: Array<{
+        id: string;
+        name: string;
+    }>;
+    countLabel?: string;
+    countValue?: number;
+    sortLabel?: string;
+    sortOptions: Array<{
+        id: string;
+        name: string;
+    }>;
+    sortOrderLabel?: string;
+    sortOrderOptions: Array<{
+        id: string;
+        name: string;
+    }>;
+    children?: ReactNode;
+};
+declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type SearchQueryProps = {
+    /** sets the content type in the search context */
+    contentType: string | undefined;
+    /** sets the keyword search in the search context */
+    keywordSearch?: string;
+    [key: string]: unknown;
+};
+interface SelectedItemProps {
+    id: string;
+    title: string;
+    contentType?: string;
+    createdAt?: TDate;
+    editLink?: string;
+    metadata?: Record<string, string>;
+    popoverData?: ReactNode;
+}
+type ItemsProp = {
+    items?: Array<SelectedItemProps & Record<string, unknown>>;
+};
+type EntrySearchFilterContextProps = {
+    onSetQuery: (value: SearchQueryProps) => void;
+    query: SearchQueryProps;
+    onSelectItem: (selectedResult: any) => void;
+    onRemoveAllSelectedItems: () => void;
+    selectedListItems: Array<SelectedItemProps>;
+    list: ItemsProp;
+    onSetList: (value: ItemsProp) => void;
+};
+declare const EntrySearchContext: React$1.Context<EntrySearchFilterContextProps>;
+type EntrySearchProviderProps = {
+    children: ReactNode;
+    currentlySelectedItems?: Array<SelectedItemProps>;
+};
+declare const EntrySearchProvider: ({ currentlySelectedItems, children }: EntrySearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const useEntrySearchContext: () => {
+    onSetQuery: (value: SearchQueryProps) => void;
+    query: SearchQueryProps;
+    onSelectItem: (selectedResult: any) => void;
+    onRemoveAllSelectedItems: () => void;
+    selectedListItems: Array<SelectedItemProps>;
+    list: ItemsProp;
+    onSetList: (value: ItemsProp) => void;
+};
+
 type MeshAppProps = {
     loadingComponent?: React__default.ComponentType;
     errorComponent?: React__default.ComponentType<{
@@ -592,7 +804,7 @@ type RequestData = {
     method?: string;
     body?: string;
 };
-type RequestProviderProps = React.PropsWithChildren<{
+type RequestProviderProps = React$1.PropsWithChildren<{
     value: RequestData;
     onChange: (delegate: (oldValue: RequestData) => RequestData) => void;
 }>;
@@ -629,12 +841,12 @@ type RequestContext = {
 declare function RequestProvider({ value, onChange, children }: RequestProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 declare function useRequest(): RequestContext;
 
-type RequestTypeContainerProps = React.HTMLAttributes<HTMLDivElement> & {
+type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
     /**sets the background color of the container
      * @default 'transparent'
      */
     bgColor?: 'transparent' | 'var(--gray-100)';
-    children: React.ReactNode;
+    children: React$1.ReactNode;
 };
 /**
  * @description a container to layout content in a 2 column grid format = 12ch 1fr
@@ -747,4 +959,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, 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, useRequestHeader, useRequestParameter, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };
+export { BaseRequestData, Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DataRefreshButton, DataRefreshButtonProps, DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListProps, DataSourceEditor, DataSourceEditorProps, DataTypeEditor, DataTypeEditorProps, DataVariableDefinitionWithName, DefaultSearchRow, DefaultSelectedItem, DispatchResult, EntrySearch, EntrySearchContainer, EntrySearchContainerProps, EntrySearchContentType, EntrySearchContext, EntrySearchFilter, EntrySearchFilterContainer, EntrySearchFilterContainerProps, EntrySearchFilterContextProps, EntrySearchFilterProps, EntrySearchListItem, EntrySearchListItemLoadingSkeleton, EntrySearchListItemProps, EntrySearchProps, EntrySearchProvider, EntrySearchProviderProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchResultItem, EntrySearchResultItemButton, EntrySearchResultItemButtonProps, EntrySearchResultItemProps, EntrySearchResultList, EntrySearchResultListProps, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, InputToken, InputVariables, InputVariablesProps, LinkButton, LinkButtonProps, MeshApp, MeshAppProps, NoResultsProps, ProductCategory, ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, ProductQueryCategory, ProductQueryContext, ProductQueryContextValue, ProductQueryProps, ProductSearch, ProductSearchContext, ProductSearchContextValue, ProductSearchProps, ProductSearchResult, ProductSearchResults, ProductSearchRow, ProductSelectedItem, PublishStatus, PublishStatusProps, 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, StatusTypes, 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, useEntrySearchContext, useInitializeUniformMeshSdk, useMeshLocation, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };