@uniformdev/mesh-sdk-react 17.1.1-alpha.452 → 17.1.1-alpha.498

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
-import { UniformMeshSDK, MeshLocation } from '@uniformdev/mesh-sdk';
+import { MeshLocationCore, UniformMeshSDK, MeshLocation } from '@uniformdev/mesh-sdk';
 export * from '@uniformdev/mesh-sdk';
 import * as React from 'react';
 import React__default, { SVGProps } from 'react';
@@ -10,14 +10,11 @@ export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, Callou
 
 /**
  * Provides convenient access to the current Uniform Mesh location via React hook.
- * Intended to be used within a UniformMeshLocationContextProvider.
+ * Intended to be used within <MeshApp />.
+ *
+ * @deprecated prefer useMeshLocation which has much more accurate type safety
  */
-declare function useUniformMeshLocation<TLocationMethodsValue = unknown, TLocationMethodsMetadata = unknown, TLocationSetValue = TLocationMethodsValue>(): {
-    value: TLocationMethodsValue;
-    setValue: (value: TLocationSetValue, options?: _uniformdev_mesh_sdk.SetValueOptions | undefined) => Promise<void>;
-    metadata: TLocationMethodsMetadata;
-    setValidationResult: (value: _uniformdev_mesh_sdk.ValidationResult) => Promise<void>;
-};
+declare function useUniformMeshLocation<TLocationValue = unknown, TLocationMetadata = never, TLocationSetValue = TLocationValue>(): MeshLocationCore<TLocationValue, TLocationMetadata, TLocationSetValue>;
 
 interface UseUniformMeshSdkOptions {
     autoResizingDisabled?: boolean;
@@ -25,6 +22,8 @@ interface UseUniformMeshSdkOptions {
 /**
  * Provides a React-hook wrapper around Uniform Mesh SDK initialization.
  * NOTE: initialization is an async operation and should be handled as such.
+ *
+ * @deprecated prefer <MeshApp /> to initialize and provide in a single component
  */
 declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUniformMeshSdkOptions) => {
     initializing: boolean;
@@ -34,27 +33,63 @@ declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUnifor
 
 /**
  * Provides convenient access to the current Uniform Mesh SDK instance via React hook.
- * Intended to be used within a UniformMeshSdkContextProvider.
+ * Intended to be used within <MeshApp />.
  */
 declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
 
-interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationMetadata = unknown, TLocationSetValue = TLocationValue> {
-    location: MeshLocation<TLocationValue, TLocationMetadata, TLocationSetValue>;
+/**
+ * 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.DataConnectionLocation, {
+    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;
+}>;
+
+/** @deprecated */
+interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationSetValue = TLocationValue> {
+    location: MeshLocation<TLocationValue, TLocationSetValue>;
 }
-declare const UniformMeshLocationContext: React__default.Context<UniformMeshLocationContextValue<unknown, unknown, unknown> | undefined>;
+/** @deprecated not intended for public usage */
+declare const UniformMeshLocationContext: React__default.Context<UniformMeshLocationContextValue<unknown, unknown> | undefined>;
+/** @deprecated not intended for public usage. Use <MeshApp /> instead. */
 declare const UniformMeshLocationContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
 /**
  * Provides access to the current UniformMeshLocationContext value.
+ * @deprecated Not intended for public use. Use `useUniformMeshLocation` instead.
  */
-declare const useUniformMeshLocationContext: <TLocationValue, TLocationMetadata, TLocationSetValue = TLocationValue>() => UniformMeshLocationContextValue<TLocationValue, TLocationMetadata, TLocationSetValue>;
+declare const useUniformMeshLocationContext: <TLocationValue = unknown, TLocationSetValue = TLocationValue>() => UniformMeshLocationContextValue<TLocationValue, TLocationSetValue>;
 
 interface UniformMeshSdkContextValue {
     sdk: UniformMeshSDK;
 }
+/** @deprecated not intended for public usage */
 declare const UniformMeshSdkContext: React__default.Context<UniformMeshSdkContextValue | undefined>;
+/** @deprecated not intended for public usage; use <MeshApp /> instead */
 declare const UniformMeshSdkContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
 /**
  * Provides access to the current (initialized) Uniform Mesh SDK context value.
+ * @deprecated Not intended for public use. Use `useUniformMeshLocation` or `useUniformMeshSdk` instead.
  */
 declare const useUniformMeshSdkContext: () => UniformMeshSdkContextValue;
 
@@ -374,6 +409,14 @@ interface DamSelectedItemProps<TResult extends DamItem = DamItem> {
 }
 declare function DamSelectedItem({ selectedItem, onDeselect, onEditClosed, logoIcon, itemDetailsRendererComponent, }: DamSelectedItemProps): _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 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;
@@ -418,4 +461,4 @@ declare namespace index {
   };
 }
 
-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, 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, 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, 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 };