@uniformdev/mesh-sdk-react 13.0.0-beta.0 → 13.0.1-alpha.271

package/dist/index.d.ts

@@ -1,15 +1,20 @@
 import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
 import { UniformMeshSDK, MeshLocation } from '@uniformdev/mesh-sdk';
 export * from '@uniformdev/mesh-sdk';
-import React from 'react';
+import * as React from 'react';
+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, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Theme, ThemeProps } from '@uniformdev/design-system';
 
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
  * Intended to be used within a UniformMeshLocationContextProvider.
  */
-declare function useUniformMeshLocation<TLocationMethodsValue = unknown, TLocationMethodsMetadata = unknown>(): {
+declare function useUniformMeshLocation<TLocationMethodsValue = unknown, TLocationMethodsMetadata = unknown, TLocationSetValue = TLocationMethodsValue>(): {
     value: TLocationMethodsValue;
-    setValue: (value: TLocationMethodsValue) => Promise<void>;
+    setValue: (value: TLocationSetValue) => Promise<void>;
     metadata: TLocationMethodsMetadata;
 };
 
@@ -32,24 +37,316 @@ declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUnifor
  */
 declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
 
+interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationMetadata = unknown, TLocationSetValue = TLocationValue> {
+    location: MeshLocation<TLocationValue, TLocationMetadata, TLocationSetValue>;
+}
+declare const UniformMeshLocationContext: React__default.Context<UniformMeshLocationContextValue<unknown, unknown, unknown> | undefined>;
+declare const UniformMeshLocationContextProvider: React__default.FC;
+/**
+ * Provides access to the current UniformMeshLocationContext value.
+ */
+declare const useUniformMeshLocationContext: <TLocationValue, TLocationMetadata, TLocationSetValue = TLocationValue>() => UniformMeshLocationContextValue<TLocationValue, TLocationMetadata, TLocationSetValue>;
+
 interface UniformMeshSdkContextValue {
     sdk: UniformMeshSDK;
 }
-declare const UniformMeshSdkContext: React.Context<UniformMeshSdkContextValue | undefined>;
-declare const UniformMeshSdkContextProvider: React.FC;
+declare const UniformMeshSdkContext: React__default.Context<UniformMeshSdkContextValue | undefined>;
+declare const UniformMeshSdkContextProvider: React__default.FC;
 /**
  * Provides access to the current (initialized) Uniform Mesh SDK context value.
  */
 declare const useUniformMeshSdkContext: () => UniformMeshSdkContextValue;
 
-interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationMetadata = unknown> {
-    location: MeshLocation<TLocationValue, TLocationMetadata>;
+interface EntrySearchSelectedItemProps<TResult extends EntrySearchResult = EntrySearchResult> {
+    selectedItem: TResult;
+    logoIcon: string | React__default.ComponentType<{
+        className?: string;
+    }>;
+    onDeselect: (item: TResult) => void;
+    onEditClosed?: (item: TResult) => void;
+}
+declare const DefaultSelectedItem: React__default.FC<EntrySearchSelectedItemProps>;
+
+interface EntrySearchRowProps<TResult extends EntrySearchResult = EntrySearchResult> {
+    result: TResult;
+    isSelected: boolean;
+    triggerSelection: () => void;
+}
+declare const DefaultSearchRow: React__default.FC<EntrySearchRowProps>;
+
+declare type EntrySearchQueryOptions = {
+    count: number;
+    offset: number;
+    contentType?: string;
+};
+declare type EntrySearchProps<TResult extends EntrySearchResult = EntrySearchResult> = {
+    search: (text: string, options: EntrySearchQueryOptions) => void;
+    results: TResult[] | undefined;
+    totalResults?: number | undefined;
+    contentTypes?: EntrySearchContentType[];
+    selectedItems: TResult[] | undefined;
+    logoIcon: string | React.ComponentType<{
+        className?: string;
+    }>;
+    select: (id: string[], contentType?: string) => void;
+    requireContentType?: boolean;
+    multiSelectId?: string;
+    multiSelect?: boolean;
+    rowComponent?: React.FC<EntrySearchRowProps<TResult>>;
+    selectedItemComponent?: React.FC<EntrySearchSelectedItemProps<TResult>>;
+    onAddNew?: (type: EntrySearchContentType) => void;
+    onEditClosed?: (item: EntrySearchResult) => void;
+    onCancel?: () => void;
+    resultsLoading?: boolean;
+    noResultsComponent?: React.FC<{
+        searchText?: string;
+        selectedContentType?: string;
+    }>;
+    helpComponent?: JSX.Element;
+    onSort?: (ids: string[]) => void;
+};
+interface EntrySearchResult {
+    id: string;
+    title: string | JSX.Element;
+    createdDate?: TDate;
+    editLink?: string;
+    metadata?: Record<string, string | JSX.Element>;
+    popoverData?: Record<string, string | JSX.Element>;
+}
+interface EntrySearchContentType {
+    id: string;
+    name: string;
+}
+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, }: EntrySearchProps<TResult>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const searchRowContainer: _emotion_react.SerializedStyles;
+declare const searchRowContainerActive: _emotion_react.SerializedStyles;
+declare const searchRowTextSmall: _emotion_react.SerializedStyles;
+declare const searchRowText: _emotion_react.SerializedStyles;
+declare const searchRowPopover: _emotion_react.SerializedStyles;
+declare const searchRowBtn: _emotion_react.SerializedStyles;
+
+declare const selectedItemContainer: _emotion_react.SerializedStyles;
+declare const selectedItemInner: _emotion_react.SerializedStyles;
+declare const selectedItemDetails: _emotion_react.SerializedStyles;
+declare const selectedItemCopy: _emotion_react.SerializedStyles;
+declare const selectedItemTitle: _emotion_react.SerializedStyles;
+declare const selectedItemIcon: _emotion_react.SerializedStyles;
+declare const selectedItemCloseIcon: _emotion_react.SerializedStyles;
+declare const selectItemPopover: _emotion_react.SerializedStyles;
+declare const selectItemSmallText: _emotion_react.SerializedStyles;
+declare const selectItemPopoverLabel: _emotion_react.SerializedStyles;
+declare const selectItemLinkContainer: _emotion_react.SerializedStyles;
+declare const selectItemLinkBtn: _emotion_react.SerializedStyles;
+
+declare const entrySearchWrapper: _emotion_react.SerializedStyles;
+declare const entrySearchBtn: _emotion_react.SerializedStyles;
+declare const entrySearchLoadMoreBtn: _emotion_react.SerializedStyles;
+declare const entrySearchConfig: _emotion_react.SerializedStyles;
+declare const entrySearchConfigHidden: _emotion_react.SerializedStyles;
+declare const entrySearchResultList: _emotion_react.SerializedStyles;
+declare const entrySearchSelectInput: _emotion_react.SerializedStyles;
+declare const entrySearchSelectIcon: _emotion_react.SerializedStyles;
+declare const entrySearchSelectImg: _emotion_react.SerializedStyles;
+declare const entrySearchSelectOption: _emotion_react.SerializedStyles;
+declare const draggableContainer: _emotion_react.SerializedStyles;
+declare const draggableIconWrapper: _emotion_react.SerializedStyles;
+declare const draggableIcon: _emotion_react.SerializedStyles;
+declare const draggableIconOffset: _emotion_react.SerializedStyles;
+declare const badgeIcon: _emotion_react.SerializedStyles;
+
+declare type GetProductsOptions = {
+    keyword?: string;
+    count?: number;
+    categories?: string[];
+    brand?: string;
+    sort?: string;
+    sortOrder?: string;
+    ids?: string[];
+    offset?: number;
+};
+declare type ProductSearchResult = EntrySearchResult & {
+    price: number;
+    sku?: string;
+    thumbnailUrl?: string;
+    categories?: Array<{
+        id: string;
+        name: string;
+    }>;
+    url?: string;
+    name: string;
+};
+interface ProductSearchResults {
+    total: number;
+    products: ProductSearchResult[];
+}
+interface ProductCategory {
+    id: string;
+    name: string;
+    children?: ProductCategory[];
+}
+
+declare const ProductPreviewList: ({ products, }: {
+    products: ProductSearchResults['products'] | undefined;
+}) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+interface ProductDynamicSelectorValue {
+    count: number;
+    categories?: string[];
+    brand?: string;
+    keyword?: string;
+    sort?: string;
+    sortOrder?: string;
+}
+interface ProductQueryProps<TValue extends ProductDynamicSelectorValue = ProductDynamicSelectorValue> {
+    value: TValue;
+    setValue: (value: TValue) => Promise<void>;
+    brands: Brand[] | undefined;
+    categories: ProductQueryCategory[] | undefined;
+    loading?: boolean;
+    categoriesLoading?: boolean;
+    brandsLoading?: boolean;
+    logoIcon?: string | React__default.ComponentType<{
+        className?: string;
+    }>;
+    onGetProducts: (options?: GetProductsOptions) => Promise<ProductSearchResults>;
+    sortOptions?: Array<{
+        name: string;
+        sortKey: string;
+    }>;
+    sortOrderOptions?: Array<{
+        name: string;
+        sortOrderKey: string;
+    }>;
+}
+interface ProductQueryCategory {
+    id: string;
+    name: string;
+    children?: ProductQueryCategory[];
+}
+interface Brand {
+    id: string;
+    name: string;
+}
+declare const ProductQuery: ({ value, setValue, brands, categories, loading, categoriesLoading, brandsLoading, logoIcon, onGetProducts, sortOptions, sortOrderOptions, }: ProductQueryProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+interface ProductQueryContextValue {
+    categories: ProductQueryProps['categories'];
+    logoIcon: ProductQueryProps['logoIcon'];
+}
+declare const ProductQueryContext: React__default.Context<ProductQueryContextValue | undefined>;
+declare const useProductQueryContext: () => ProductQueryContextValue;
+
+declare type ProductSearchProps<TResult extends ProductSearchResult = ProductSearchResult> = Pick<EntrySearchProps<TResult>, 'multiSelect' | 'multiSelectId' | 'logoIcon' | 'rowComponent' | 'selectedItemComponent'> & {
+    value: string[] | undefined;
+    setValue: (ids: string[] | undefined) => Promise<void>;
+    onGetSelectedProducts: (args: {
+        ids: string[];
+        options?: GetProductOptions;
+    }) => Promise<TResult[]>;
+    onGetCategories: () => Promise<ProductCategory[]>;
+    onSearchProducts: (args: {
+        text: string;
+        options?: GetProductOptions;
+    }) => Promise<{
+        total: number;
+        products: TResult[];
+    }>;
+};
+interface GetProductOptions {
+    limit?: number;
+    offset?: number;
+    categoryId?: string;
+}
+declare function ProductSearch({ value, setValue, onGetSelectedProducts, onGetCategories, onSearchProducts, logoIcon, multiSelect, multiSelectId, selectedItemComponent, rowComponent, }: ProductSearchProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+interface ProductSearchContextValue {
+    logoIcon: ProductSearchProps['logoIcon'];
+    categories: ProductCategory[] | undefined;
+}
+declare const ProductSearchContext: React__default.Context<ProductSearchContextValue | undefined>;
+declare const useProductSearchContext: () => ProductSearchContextValue;
+
+declare const productSearchRowContainer: _emotion_react.SerializedStyles;
+declare const productSearchRowContent: _emotion_react.SerializedStyles;
+declare const productSearchRowContentActive: _emotion_react.SerializedStyles;
+declare const productSearchRowTitle: _emotion_react.SerializedStyles;
+declare const productSearchRowCategory: _emotion_react.SerializedStyles;
+declare const productSearchRowDetails: _emotion_react.SerializedStyles;
+declare const productSearchRowActiveIcon: _emotion_react.SerializedStyles;
+
+declare function ProductSearchRow({ result, isSelected, triggerSelection, }: EntrySearchRowProps<ProductSearchResult>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const productSelectedItemContainer: _emotion_react.SerializedStyles;
+declare const productSelectedItemDetails: _emotion_react.SerializedStyles;
+declare const productSelectedItemContent: _emotion_react.SerializedStyles;
+declare const productSelectedItemImage: _emotion_react.SerializedStyles;
+
+declare function ProductSelectedItem({ selectedItem, onDeselect, }: EntrySearchSelectedItemProps<ProductSearchResult>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const ResolvableLoadingValue: ({ value, text, loading, }: {
+    value: string;
+    text: string | undefined;
+    loading: boolean;
+}) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type SelectionFieldValue = {
+    id: string;
+    name: string;
+};
+declare const SelectionField: ({ name, loading, selectedValues, values, onAdd, onRemove, }: {
+    name: string;
+    loading: boolean;
+    selectedValues: string[] | undefined;
+    values: SelectionFieldValue[];
+    onAdd: (id: string) => void;
+    onRemove: (id: string) => void;
+}) => _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;
+
+declare const SvgChevronDown: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgClose: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgDanger: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgInfo: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgLightbulb: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgMagnifyingGlass: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgMaximizeAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgMinus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const SvgPlus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare namespace index {
+  export {
+    SvgCaution as Caution,
+    SvgCheckmark as Checkmark,
+    SvgChevronDown as ChevronDown,
+    SvgClose as Close,
+    SvgDanger as Danger,
+    SvgExclamationPoint as ExclamationPoint,
+    SvgInfo as Info,
+    SvgLightbulb as Lightbulb,
+    SvgMagnifyingGlass as MagnifyingGlass,
+    SvgMaximizeAlt as MaximizeAlt,
+    SvgMinus as Minus,
+    SvgMoreVerticalAlt as MoreVerticalAlt,
+    SvgPlus as Plus,
+  };
 }
-declare const UniformMeshLocationContext: React.Context<UniformMeshLocationContextValue<unknown, unknown> | undefined>;
-declare const UniformMeshLocationContextProvider: React.FC;
-/**
- * Provides access to the current UniformMeshLocationContext value.
- */
-declare const useUniformMeshLocationContext: <TLocationValue, TLocationMetadata>() => UniformMeshLocationContextValue<TLocationValue, TLocationMetadata>;
 
-export { UniformMeshLocationContext, UniformMeshLocationContextProvider, UniformMeshLocationContextValue, UniformMeshSdkContext, UniformMeshSdkContextProvider, UniformMeshSdkContextValue, UseUniformMeshSdkOptions, useInitializeUniformMeshSdk, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext };
+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, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemCloseIcon, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, useInitializeUniformMeshSdk, useProductQueryContext, useProductSearchContext, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext };