@uniformdev/mesh-sdk-react 16.1.0 → 16.1.1-alpha.169

package/dist/index.d.ts

@@ -6,7 +6,7 @@ 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 { 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';
+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';
 
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
@@ -107,6 +107,10 @@ declare type EntrySearchProps<TResult extends EntrySearchResult = EntrySearchRes
     onSort?: (items: TResult[]) => void;
     typeSelectorLabel?: string;
     typeSelectorAllTypesOptionText?: string;
+    /** Specifies how long (in milliseconds) to wait before showing the loading indicator when `resultsLoading` is true.
+     * @default 1000
+     */
+    loadingIndicatorDelay?: number;
 };
 interface EntrySearchResult {
     id: string;
@@ -124,7 +128,7 @@ interface NoResultsProps {
     searchText: string | undefined;
     selectedContentType: string | undefined;
 }
-declare const EntrySearch: <TResult extends EntrySearchResult>({ search, results, contentTypes, selectedItems, logoIcon, select, multiSelect, multiSelectId, rowComponent, selectedItemComponent, totalResults, resultsLoading, requireContentType, onAddNew, onEditClosed, onCancel, noResultsComponent, helpComponent, onSort, typeSelectorLabel, typeSelectorAllTypesOptionText, }: EntrySearchProps<TResult>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const EntrySearch: <TResult extends EntrySearchResult>({ search, results, contentTypes, selectedItems, logoIcon, select, multiSelect, multiSelectId, rowComponent, selectedItemComponent, totalResults, resultsLoading, requireContentType, onAddNew, onEditClosed, onCancel, noResultsComponent, helpComponent, onSort, typeSelectorLabel, typeSelectorAllTypesOptionText, loadingIndicatorDelay, }: EntrySearchProps<TResult>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare const searchRowContainer: _emotion_react.SerializedStyles;
 declare const searchRowContainerWithPopover: _emotion_react.SerializedStyles;
@@ -181,8 +185,10 @@ declare type ProductSearchResult = EntrySearchResult & {
         id: string;
         name: string;
     }>;
+    /** @deprecated Use `editLink` instead. */
     url?: string;
-    name: string;
+    /** @deprecated Use `title` instead. */
+    name?: string;
 };
 interface ProductSearchResults {
     total: number;
@@ -207,7 +213,7 @@ interface ProductDynamicSelectorValue {
     sortOrder?: string;
 }
 interface ProductQueryProps<TValue extends ProductDynamicSelectorValue = ProductDynamicSelectorValue> {
-    value: TValue;
+    value: TValue | undefined;
     setValue: (value: TValue) => Promise<void>;
     brands: Brand[] | undefined;
     categories: ProductQueryCategory[] | undefined;
@@ -314,6 +320,52 @@ declare const SelectionField: ({ id, label, loading, selectedValues, values, onA
     onRemove: (id: string) => void;
 }) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+declare const damSelectedItemContainer: _emotion_react.SerializedStyles;
+declare const damSelectedItemInner: _emotion_react.SerializedStyles;
+declare const damSelectedItemDetails: _emotion_react.SerializedStyles;
+declare const damSelectedItemCopy: _emotion_react.SerializedStyles;
+declare const damSelectedItemTitle: _emotion_react.SerializedStyles;
+declare const damSelectedItemIcon: _emotion_react.SerializedStyles;
+declare const damSelectedItemCloseIcon: _emotion_react.SerializedStyles;
+declare const damSelectedItemPopover: _emotion_react.SerializedStyles;
+declare const damSelectedItemSmallText: _emotion_react.SerializedStyles;
+declare const damSelectedItemPopoverLabel: _emotion_react.SerializedStyles;
+declare const damSelectedItemLinkContainer: _emotion_react.SerializedStyles;
+declare const damSelectedItemLinkBtn: _emotion_react.SerializedStyles;
+declare const damSelectedItemMediaContainer: _emotion_react.SerializedStyles;
+
+interface DamItem {
+    id: string;
+    title: string | JSX.Element;
+    createdDate?: Date | string | number;
+    editLink?: string | JSX.Element;
+    metadata?: Record<string, string | JSX.Element>;
+    popoverData?: Record<string, string | JSX.Element>;
+    previewUrl?: string | JSX.Element;
+    type: 'image' | 'video' | 'file' | 'other';
+}
+
+interface DamSelectedItemProps<TResult extends DamItem = DamItem> {
+    /** The item used for rendering this component. */
+    selectedItem: TResult;
+    /** Logo icon is used for the `editLink` if `editLink` is a string value, otherwise the icon is not used. */
+    logoIcon?: string | React__default.ComponentType<{
+        className?: string;
+    }>;
+    /** Callback that is invoked when the "Unlink" (deselect) button is clicked. */
+    onDeselect: (item: TResult) => void;
+    /** If `editLink` is a string value, an `<a>` element will be rendered for the `editLink` and
+     * the `onEditClosed` callback will be invoked when the tab opened by clicking the `<a>` element is closed. */
+    onEditClosed?: (item: TResult) => void;
+    /** Allows for customizing how item details, e.g. item preview, item metadata, are rendered. If not defined,
+     * item details will be rendered using the default (built-in) renderer.
+     */
+    itemDetailsRendererComponent?: React__default.ComponentType<{
+        item: TResult;
+    }>;
+}
+declare function DamSelectedItem({ selectedItem, onDeselect, onEditClosed, logoIcon, itemDetailsRendererComponent, }: DamSelectedItemProps): _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;
@@ -358,4 +410,4 @@ declare namespace index {
   };
 }
 
-export { Brand, DefaultSearchRow, DefaultSelectedItem, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, 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, draggableContainer, draggableIcon, draggableIconOffset, draggableIconWrapper, entrySearchBtn, entrySearchConfig, entrySearchConfigHidden, entrySearchLoadMoreBtn, entrySearchResultList, entrySearchSelectIcon, entrySearchSelectImg, entrySearchSelectInput, entrySearchSelectOption, entrySearchWrapper, productSearchRowActiveIcon, productSearchRowCategory, productSearchRowContainer, productSearchRowContent, productSearchRowContentActive, productSearchRowDetails, productSearchRowTitle, productSelectedItemContainer, productSelectedItemContent, productSelectedItemDetails, productSelectedItemImage, searchRowBtn, searchRowContainer, searchRowContainerActive, searchRowContainerWithPopover, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemCloseIcon, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, useInitializeUniformMeshSdk, useProductQueryContext, useProductSearchContext, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext };
+export { Brand, DamItem, DamSelectedItem, DamSelectedItemProps, DefaultSearchRow, DefaultSelectedItem, EntrySearch, EntrySearchContentType, EntrySearchProps, EntrySearchQueryOptions, EntrySearchResult, EntrySearchRowProps, EntrySearchSelectedItemProps, GetProductOptions, GetProductsOptions, index as Icons, 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, damSelectedItemCloseIcon, damSelectedItemContainer, damSelectedItemCopy, damSelectedItemDetails, damSelectedItemIcon, 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, productSelectedItemImage, searchRowBtn, searchRowContainer, searchRowContainerActive, searchRowContainerWithPopover, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemCloseIcon, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, useInitializeUniformMeshSdk, useProductQueryContext, useProductSearchContext, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext };