@uniformdev/mesh-sdk-react 17.5.1-alpha.7 → 17.6.1-alpha.60
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +200 -186
- package/dist/index.esm.js +217 -189
- package/dist/index.js +216 -188
- package/dist/index.mjs +217 -189
- package/package.json +7 -18
package/dist/index.d.ts
CHANGED
|
@@ -1,99 +1,58 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import { MeshLocationCore, UniformMeshSDK, MeshLocation } from '@uniformdev/mesh-sdk';
|
|
3
|
-
export * from '@uniformdev/mesh-sdk';
|
|
1
|
+
import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
|
|
4
2
|
import * as React from 'react';
|
|
5
3
|
import React__default, { SVGProps } from 'react';
|
|
6
|
-
import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
|
|
7
4
|
import { TDate } from 'timeago.js';
|
|
8
5
|
import * as _emotion_react from '@emotion/react';
|
|
9
|
-
import { DataVariableDefinition } from '@uniformdev/canvas';
|
|
10
6
|
import { InputSelectProps } from '@uniformdev/design-system';
|
|
11
|
-
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';
|
|
7
|
+
export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, 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';
|
|
8
|
+
import { DataVariableDefinition } from '@uniformdev/canvas';
|
|
9
|
+
import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
|
|
10
|
+
import { MeshLocation, UniformMeshSDK, MeshLocationCore } from '@uniformdev/mesh-sdk';
|
|
11
|
+
export * from '@uniformdev/mesh-sdk';
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
* Provides convenient access to the current Uniform Mesh location via React hook.
|
|
15
|
-
* Intended to be used within <MeshApp />.
|
|
16
|
-
*
|
|
17
|
-
* @deprecated prefer useMeshLocation which has much more accurate type safety
|
|
18
|
-
*/
|
|
19
|
-
declare function useUniformMeshLocation<TLocationValue = unknown, TLocationMetadata = never, TLocationSetValue = TLocationValue>(): MeshLocationCore<TLocationValue, TLocationMetadata, TLocationSetValue>;
|
|
13
|
+
declare const SvgCaution: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
20
14
|
|
|
21
|
-
|
|
22
|
-
autoResizingDisabled?: boolean;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Provides a React-hook wrapper around Uniform Mesh SDK initialization.
|
|
26
|
-
* NOTE: initialization is an async operation and should be handled as such.
|
|
27
|
-
*
|
|
28
|
-
* @deprecated prefer <MeshApp /> to initialize and provide in a single component
|
|
29
|
-
*/
|
|
30
|
-
declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUniformMeshSdkOptions) => {
|
|
31
|
-
initializing: boolean;
|
|
32
|
-
error: Error | undefined;
|
|
33
|
-
sdk: UniformMeshSDK | undefined;
|
|
34
|
-
};
|
|
15
|
+
declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
35
16
|
|
|
36
|
-
|
|
37
|
-
* Provides convenient access to the current Uniform Mesh SDK instance via React hook.
|
|
38
|
-
* Intended to be used within <MeshApp />.
|
|
39
|
-
*/
|
|
40
|
-
declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
|
|
17
|
+
declare const SvgChevronDown: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
41
18
|
|
|
42
|
-
|
|
43
|
-
* Provides convenient access to the current Uniform Mesh location via React hook.
|
|
44
|
-
* Intended to be used within <MeshApp />.
|
|
45
|
-
*
|
|
46
|
-
* There are three primary ways to invoke this hook:
|
|
47
|
-
* 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`
|
|
48
|
-
* const location = useMeshLocation();
|
|
49
|
-
* if (location.type === 'paramType') { // location is now known to be a paramType }
|
|
50
|
-
* 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.
|
|
51
|
-
* const location = useMeshLocation('settings');
|
|
52
|
-
* 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.
|
|
53
|
-
* const location = useMeshLocation<'paramType', MyParamTypeValueType>();
|
|
54
|
-
*
|
|
55
|
-
* You can also combine (2) and (3) to get both explicit value typing and assertion of the location.
|
|
56
|
-
*/
|
|
57
|
-
declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLocationValue = unknown, TLocationSetValue = TLocationValue>(expectedLocation?: TLocationType): Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
|
|
58
|
-
type: TLocationType;
|
|
59
|
-
}> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
|
|
60
|
-
type: TLocationType;
|
|
61
|
-
}> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
|
|
62
|
-
type: TLocationType;
|
|
63
|
-
}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
|
|
64
|
-
type: TLocationType;
|
|
65
|
-
}> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
|
|
66
|
-
type: TLocationType;
|
|
67
|
-
}> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
|
|
68
|
-
type: TLocationType;
|
|
69
|
-
}>;
|
|
19
|
+
declare const SvgClose: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
70
20
|
|
|
71
|
-
|
|
72
|
-
interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationSetValue = TLocationValue> {
|
|
73
|
-
location: MeshLocation<TLocationValue, TLocationSetValue>;
|
|
74
|
-
}
|
|
75
|
-
/** @deprecated not intended for public usage */
|
|
76
|
-
declare const UniformMeshLocationContext: React__default.Context<UniformMeshLocationContextValue<unknown, unknown> | undefined>;
|
|
77
|
-
/** @deprecated not intended for public usage. Use <MeshApp /> instead. */
|
|
78
|
-
declare const UniformMeshLocationContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
|
|
79
|
-
/**
|
|
80
|
-
* Provides access to the current UniformMeshLocationContext value.
|
|
81
|
-
* @deprecated Not intended for public use. Use `useUniformMeshLocation` instead.
|
|
82
|
-
*/
|
|
83
|
-
declare const useUniformMeshLocationContext: <TLocationValue = unknown, TLocationSetValue = TLocationValue>() => UniformMeshLocationContextValue<TLocationValue, TLocationSetValue>;
|
|
21
|
+
declare const SvgDanger: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
84
22
|
|
|
85
|
-
|
|
86
|
-
|
|
23
|
+
declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
24
|
+
|
|
25
|
+
declare const SvgInfo: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
26
|
+
|
|
27
|
+
declare const SvgLightbulb: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
28
|
+
|
|
29
|
+
declare const SvgMagnifyingGlass: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
30
|
+
|
|
31
|
+
declare const SvgMaximizeAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
32
|
+
|
|
33
|
+
declare const SvgMinus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
34
|
+
|
|
35
|
+
declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
36
|
+
|
|
37
|
+
declare const SvgPlus: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
38
|
+
|
|
39
|
+
declare namespace index {
|
|
40
|
+
export {
|
|
41
|
+
SvgCaution as Caution,
|
|
42
|
+
SvgCheckmark as Checkmark,
|
|
43
|
+
SvgChevronDown as ChevronDown,
|
|
44
|
+
SvgClose as Close,
|
|
45
|
+
SvgDanger as Danger,
|
|
46
|
+
SvgExclamationPoint as ExclamationPoint,
|
|
47
|
+
SvgInfo as Info,
|
|
48
|
+
SvgLightbulb as Lightbulb,
|
|
49
|
+
SvgMagnifyingGlass as MagnifyingGlass,
|
|
50
|
+
SvgMaximizeAlt as MaximizeAlt,
|
|
51
|
+
SvgMinus as Minus,
|
|
52
|
+
SvgMoreVerticalAlt as MoreVerticalAlt,
|
|
53
|
+
SvgPlus as Plus,
|
|
54
|
+
};
|
|
87
55
|
}
|
|
88
|
-
/** @deprecated not intended for public usage */
|
|
89
|
-
declare const UniformMeshSdkContext: React__default.Context<UniformMeshSdkContextValue | undefined>;
|
|
90
|
-
/** @deprecated not intended for public usage; use <MeshApp /> instead */
|
|
91
|
-
declare const UniformMeshSdkContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
|
|
92
|
-
/**
|
|
93
|
-
* Provides access to the current (initialized) Uniform Mesh SDK context value.
|
|
94
|
-
* @deprecated Not intended for public use. Use `useUniformMeshLocation` or `useUniformMeshSdk` instead.
|
|
95
|
-
*/
|
|
96
|
-
declare const useUniformMeshSdkContext: () => UniformMeshSdkContextValue;
|
|
97
56
|
|
|
98
57
|
interface EntrySearchSelectedItemProps<TResult extends EntrySearchResult = EntrySearchResult> {
|
|
99
58
|
selectedItem: TResult;
|
|
@@ -105,13 +64,6 @@ interface EntrySearchSelectedItemProps<TResult extends EntrySearchResult = Entry
|
|
|
105
64
|
}
|
|
106
65
|
declare const DefaultSelectedItem: React__default.FC<EntrySearchSelectedItemProps>;
|
|
107
66
|
|
|
108
|
-
interface EntrySearchRowProps<TResult extends EntrySearchResult = EntrySearchResult> {
|
|
109
|
-
result: TResult;
|
|
110
|
-
isSelected: boolean;
|
|
111
|
-
triggerSelection: () => void;
|
|
112
|
-
}
|
|
113
|
-
declare const DefaultSearchRow: React__default.FC<EntrySearchRowProps>;
|
|
114
|
-
|
|
115
67
|
declare type EntrySearchQueryOptions = {
|
|
116
68
|
count: number;
|
|
117
69
|
offset: number;
|
|
@@ -169,6 +121,13 @@ interface NoResultsProps {
|
|
|
169
121
|
}
|
|
170
122
|
declare const EntrySearch: <TResult extends EntrySearchResult>({ search, results, contentTypes, selectedItems, logoIcon, select, multiSelect, multiSelectId, rowComponent, selectedItemComponent, totalResults, cursor, resultsLoading, requireContentType, onAddNew, onEditClosed, onCancel, noResultsComponent, helpComponent, onSort, typeSelectorLabel, typeSelectorAllTypesOptionText, loadingIndicatorDelay, }: EntrySearchProps<TResult>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
171
123
|
|
|
124
|
+
interface EntrySearchRowProps<TResult extends EntrySearchResult = EntrySearchResult> {
|
|
125
|
+
result: TResult;
|
|
126
|
+
isSelected: boolean;
|
|
127
|
+
triggerSelection: () => void;
|
|
128
|
+
}
|
|
129
|
+
declare const DefaultSearchRow: React__default.FC<EntrySearchRowProps>;
|
|
130
|
+
|
|
172
131
|
declare const searchRowContainer: _emotion_react.SerializedStyles;
|
|
173
132
|
declare const searchRowContainerWithPopover: _emotion_react.SerializedStyles;
|
|
174
133
|
declare const searchRowContainerActive: _emotion_react.SerializedStyles;
|
|
@@ -323,25 +282,8 @@ interface ProductSearchContextValue {
|
|
|
323
282
|
declare const ProductSearchContext: React__default.Context<ProductSearchContextValue | undefined>;
|
|
324
283
|
declare const useProductSearchContext: () => ProductSearchContextValue;
|
|
325
284
|
|
|
326
|
-
declare const productSearchRowContainer: _emotion_react.SerializedStyles;
|
|
327
|
-
declare const productSearchRowContent: _emotion_react.SerializedStyles;
|
|
328
|
-
declare const productSearchRowContentActive: _emotion_react.SerializedStyles;
|
|
329
|
-
declare const productSearchRowTitle: _emotion_react.SerializedStyles;
|
|
330
|
-
declare const productSearchRowCategory: _emotion_react.SerializedStyles;
|
|
331
|
-
declare const productSearchRowDetails: _emotion_react.SerializedStyles;
|
|
332
|
-
declare const productSearchRowActiveIcon: _emotion_react.SerializedStyles;
|
|
333
|
-
|
|
334
285
|
declare function ProductSearchRow({ result, isSelected, triggerSelection, }: EntrySearchRowProps<ProductSearchResult>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
335
286
|
|
|
336
|
-
declare const productSelectedItemContainer: _emotion_react.SerializedStyles;
|
|
337
|
-
declare const productSelectedItemDetails: _emotion_react.SerializedStyles;
|
|
338
|
-
declare const productSelectedItemContent: _emotion_react.SerializedStyles;
|
|
339
|
-
declare const productSelectedItemImage: _emotion_react.SerializedStyles;
|
|
340
|
-
declare const productedSelectedItemLinkBtn: _emotion_react.SerializedStyles;
|
|
341
|
-
declare const productedSelectedItemSmallText: _emotion_react.SerializedStyles;
|
|
342
|
-
declare const productSelectedItemIcon: _emotion_react.SerializedStyles;
|
|
343
|
-
declare const productSelectedItemLinkContainer: _emotion_react.SerializedStyles;
|
|
344
|
-
|
|
345
287
|
declare function ProductSelectedItem({ selectedItem, onDeselect, }: EntrySearchSelectedItemProps<ProductSearchResult>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
346
288
|
|
|
347
289
|
declare const ResolvableLoadingValue: ({ value, text, loading, }: {
|
|
@@ -364,20 +306,22 @@ declare const SelectionField: ({ id, label, loading, selectedValues, values, onA
|
|
|
364
306
|
onRemove: (id: string) => void;
|
|
365
307
|
}) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
366
308
|
|
|
367
|
-
declare const
|
|
368
|
-
declare const
|
|
369
|
-
declare const
|
|
370
|
-
declare const
|
|
371
|
-
declare const
|
|
372
|
-
declare const
|
|
373
|
-
declare const
|
|
374
|
-
|
|
375
|
-
declare const
|
|
376
|
-
declare const
|
|
377
|
-
declare const
|
|
378
|
-
declare const
|
|
379
|
-
declare const
|
|
380
|
-
declare const
|
|
309
|
+
declare const productSearchRowContainer: _emotion_react.SerializedStyles;
|
|
310
|
+
declare const productSearchRowContent: _emotion_react.SerializedStyles;
|
|
311
|
+
declare const productSearchRowContentActive: _emotion_react.SerializedStyles;
|
|
312
|
+
declare const productSearchRowTitle: _emotion_react.SerializedStyles;
|
|
313
|
+
declare const productSearchRowCategory: _emotion_react.SerializedStyles;
|
|
314
|
+
declare const productSearchRowDetails: _emotion_react.SerializedStyles;
|
|
315
|
+
declare const productSearchRowActiveIcon: _emotion_react.SerializedStyles;
|
|
316
|
+
|
|
317
|
+
declare const productSelectedItemContainer: _emotion_react.SerializedStyles;
|
|
318
|
+
declare const productSelectedItemDetails: _emotion_react.SerializedStyles;
|
|
319
|
+
declare const productSelectedItemContent: _emotion_react.SerializedStyles;
|
|
320
|
+
declare const productSelectedItemImage: _emotion_react.SerializedStyles;
|
|
321
|
+
declare const productedSelectedItemLinkBtn: _emotion_react.SerializedStyles;
|
|
322
|
+
declare const productedSelectedItemSmallText: _emotion_react.SerializedStyles;
|
|
323
|
+
declare const productSelectedItemIcon: _emotion_react.SerializedStyles;
|
|
324
|
+
declare const productSelectedItemLinkContainer: _emotion_react.SerializedStyles;
|
|
381
325
|
|
|
382
326
|
interface DamItem {
|
|
383
327
|
id: string;
|
|
@@ -411,6 +355,21 @@ interface DamSelectedItemProps<TResult extends DamItem = DamItem> {
|
|
|
411
355
|
}
|
|
412
356
|
declare function DamSelectedItem({ selectedItem, onDeselect, onEditClosed, logoIcon, itemDetailsRendererComponent, }: DamSelectedItemProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
413
357
|
|
|
358
|
+
declare const damSelectedItemContainer: _emotion_react.SerializedStyles;
|
|
359
|
+
declare const damSelectedItemInner: _emotion_react.SerializedStyles;
|
|
360
|
+
declare const damSelectedItemDetails: _emotion_react.SerializedStyles;
|
|
361
|
+
declare const damSelectedItemCopy: _emotion_react.SerializedStyles;
|
|
362
|
+
declare const damSelectedItemTitle: _emotion_react.SerializedStyles;
|
|
363
|
+
declare const damSelectedItemIcon: _emotion_react.SerializedStyles;
|
|
364
|
+
declare const damSelectedItemPopover: _emotion_react.SerializedStyles;
|
|
365
|
+
declare const damSelectedItemSmallText: _emotion_react.SerializedStyles;
|
|
366
|
+
declare const damSelectedItemPopoverLabel: _emotion_react.SerializedStyles;
|
|
367
|
+
declare const damSelectedItemLinkContainer: _emotion_react.SerializedStyles;
|
|
368
|
+
declare const damSelectedItemLinkBtn: _emotion_react.SerializedStyles;
|
|
369
|
+
declare const damSelectedItemMediaContainer: _emotion_react.SerializedStyles;
|
|
370
|
+
declare const damSelectedItemInfoBtn: _emotion_react.SerializedStyles;
|
|
371
|
+
declare const damSelectItemImage: _emotion_react.SerializedStyles;
|
|
372
|
+
|
|
414
373
|
declare type MeshAppProps = {
|
|
415
374
|
loadingComponent?: React__default.ComponentType;
|
|
416
375
|
errorComponent?: React__default.ComponentType<{
|
|
@@ -419,6 +378,25 @@ declare type MeshAppProps = {
|
|
|
419
378
|
};
|
|
420
379
|
declare const MeshApp: React__default.FC<React__default.PropsWithChildren<MeshAppProps>>;
|
|
421
380
|
|
|
381
|
+
declare function RequestBody(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
382
|
+
|
|
383
|
+
declare type InputToken = {
|
|
384
|
+
name: string;
|
|
385
|
+
value: string;
|
|
386
|
+
};
|
|
387
|
+
declare type InputVariablesProps = {
|
|
388
|
+
/** sets the input label value */
|
|
389
|
+
label: string;
|
|
390
|
+
/** sets the value of the input */
|
|
391
|
+
value: string;
|
|
392
|
+
/** sets the passed down function call */
|
|
393
|
+
onChange: (newValue: string) => void;
|
|
394
|
+
/** called when the field is pasted into */
|
|
395
|
+
onPaste?: (newValue: string) => void;
|
|
396
|
+
disableVariables?: boolean;
|
|
397
|
+
};
|
|
398
|
+
declare function InputVariables({ label, value, disableVariables, onChange, onPaste }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
399
|
+
|
|
422
400
|
declare type DataVariableDefinitionWithName = {
|
|
423
401
|
name: string;
|
|
424
402
|
} & DataVariableDefinition;
|
|
@@ -431,6 +409,8 @@ declare type VariableEditorProps = {
|
|
|
431
409
|
};
|
|
432
410
|
declare function VariableEditor({ variable, onSubmit, onCancel }: VariableEditorProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
433
411
|
|
|
412
|
+
declare function VariablesList(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
413
|
+
|
|
434
414
|
declare type VariablesProviderProps = React.PropsWithChildren<{
|
|
435
415
|
value: Record<string, DataVariableDefinition>;
|
|
436
416
|
onChange: (newValue: Record<string, DataVariableDefinition>) => void;
|
|
@@ -446,6 +426,9 @@ declare type VariablesAction = {
|
|
|
446
426
|
type: 'set';
|
|
447
427
|
variable: DataVariableDefinitionWithName;
|
|
448
428
|
openEditor?: boolean;
|
|
429
|
+
} | {
|
|
430
|
+
type: 'reorder';
|
|
431
|
+
result: Record<string, DataVariableDefinitionWithName>;
|
|
449
432
|
};
|
|
450
433
|
declare type VariablesContext = {
|
|
451
434
|
dispatch: (event: VariablesAction) => void;
|
|
@@ -454,48 +437,33 @@ declare type VariablesContext = {
|
|
|
454
437
|
declare function VariablesProvider({ value, onChange, editVariableComponent, children, }: VariablesProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
455
438
|
declare function useVariables(): VariablesContext;
|
|
456
439
|
|
|
457
|
-
declare function VariablesList(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
458
|
-
|
|
459
|
-
declare type InputToken = {
|
|
460
|
-
name: string;
|
|
461
|
-
value: string;
|
|
462
|
-
};
|
|
463
|
-
declare type InputVariablesProps = {
|
|
464
|
-
/** sets the input label value */
|
|
465
|
-
label: string;
|
|
466
|
-
/** sets the value of the input */
|
|
467
|
-
value: string;
|
|
468
|
-
/** sets the passed down function call */
|
|
469
|
-
onChange: (newValue: string) => void;
|
|
470
|
-
disableVariables?: boolean;
|
|
471
|
-
};
|
|
472
|
-
declare function InputVariables({ label, value, disableVariables, onChange }: InputVariablesProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
473
|
-
|
|
474
|
-
declare function RequestBody(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
475
|
-
|
|
476
440
|
declare function RequestHeaders({ disableVariables }: Pick<InputVariablesProps, 'disableVariables'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
477
441
|
|
|
478
442
|
declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
479
443
|
|
|
444
|
+
declare type RequestParametersProps = Pick<InputVariablesProps, 'disableVariables'>;
|
|
480
445
|
declare function RequestParameters({ disableVariables }: Pick<InputVariablesProps, 'disableVariables'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
481
446
|
|
|
482
447
|
declare type RequestParameter = {
|
|
483
448
|
key: string;
|
|
484
449
|
value: string;
|
|
485
450
|
};
|
|
451
|
+
declare type BaseRequestData = {
|
|
452
|
+
baseUrl: string;
|
|
453
|
+
headers?: Array<RequestParameter>;
|
|
454
|
+
parameters?: Array<RequestParameter>;
|
|
455
|
+
};
|
|
486
456
|
declare type RequestData = {
|
|
487
457
|
relativeUrl: string;
|
|
488
458
|
headers: Array<RequestParameter>;
|
|
489
|
-
|
|
459
|
+
parameters: Array<RequestParameter>;
|
|
460
|
+
baseRequest?: BaseRequestData;
|
|
490
461
|
method?: string;
|
|
491
462
|
body?: string;
|
|
492
463
|
};
|
|
493
|
-
declare type ComputedRequestData = RequestData & {
|
|
494
|
-
parameters: Array<RequestParameter>;
|
|
495
|
-
};
|
|
496
464
|
declare type RequestProviderProps = React.PropsWithChildren<{
|
|
497
465
|
value: RequestData;
|
|
498
|
-
onChange: (
|
|
466
|
+
onChange: (delegate: (oldValue: RequestData) => RequestData) => void;
|
|
499
467
|
}>;
|
|
500
468
|
declare type RequestAction = {
|
|
501
469
|
type: 'setRelativeUrl';
|
|
@@ -520,16 +488,14 @@ declare type RequestAction = {
|
|
|
520
488
|
} | {
|
|
521
489
|
type: 'setBody';
|
|
522
490
|
body: string;
|
|
491
|
+
contentType: string;
|
|
523
492
|
};
|
|
524
493
|
declare type RequestContext = {
|
|
525
494
|
dispatch: (event: RequestAction) => void;
|
|
526
|
-
request: Readonly<
|
|
495
|
+
request: Readonly<RequestData>;
|
|
527
496
|
};
|
|
528
497
|
declare function RequestProvider({ value, onChange, children }: RequestProviderProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
529
498
|
declare function useRequest(): RequestContext;
|
|
530
|
-
declare function decomposeRelativeUrl(relativeUrl: string): [string, Array<RequestParameter>];
|
|
531
|
-
|
|
532
|
-
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
533
499
|
|
|
534
500
|
declare type RequestTypeContainerProps = React.HTMLAttributes<HTMLDivElement> & {
|
|
535
501
|
/**sets the background color of the container
|
|
@@ -546,48 +512,96 @@ declare type RequestTypeContainerProps = React.HTMLAttributes<HTMLDivElement> &
|
|
|
546
512
|
* </div> */
|
|
547
513
|
declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
548
514
|
|
|
549
|
-
declare
|
|
550
|
-
|
|
551
|
-
declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
552
|
-
|
|
553
|
-
declare const SvgChevronDown: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
554
|
-
|
|
555
|
-
declare const SvgClose: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
515
|
+
declare function RequestUrl(): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
556
516
|
|
|
557
|
-
declare
|
|
558
|
-
|
|
559
|
-
declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
517
|
+
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
560
518
|
|
|
561
|
-
declare
|
|
519
|
+
declare function urlEncodeRequestUrl(url: string, varValues?: Record<string, DataVariableDefinition>): string;
|
|
520
|
+
declare function urlEncodeRequestParameter(parameter: RequestParameter, varValues?: Record<string, DataVariableDefinition>): RequestParameter;
|
|
562
521
|
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
522
|
+
/** @deprecated */
|
|
523
|
+
interface UniformMeshLocationContextValue<TLocationValue = unknown, TLocationSetValue = TLocationValue> {
|
|
524
|
+
location: MeshLocation<TLocationValue, TLocationSetValue>;
|
|
525
|
+
}
|
|
526
|
+
/** @deprecated not intended for public usage */
|
|
527
|
+
declare const UniformMeshLocationContext: React__default.Context<UniformMeshLocationContextValue<unknown, unknown> | undefined>;
|
|
528
|
+
/** @deprecated not intended for public usage. Use <MeshApp /> instead. */
|
|
529
|
+
declare const UniformMeshLocationContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
|
|
530
|
+
/**
|
|
531
|
+
* Provides access to the current UniformMeshLocationContext value.
|
|
532
|
+
* @deprecated Not intended for public use. Use `useUniformMeshLocation` instead.
|
|
533
|
+
*/
|
|
534
|
+
declare const useUniformMeshLocationContext: <TLocationValue = unknown, TLocationSetValue = TLocationValue>() => UniformMeshLocationContextValue<TLocationValue, TLocationSetValue>;
|
|
566
535
|
|
|
567
|
-
|
|
536
|
+
interface UniformMeshSdkContextValue {
|
|
537
|
+
sdk: UniformMeshSDK;
|
|
538
|
+
}
|
|
539
|
+
/** @deprecated not intended for public usage */
|
|
540
|
+
declare const UniformMeshSdkContext: React__default.Context<UniformMeshSdkContextValue | undefined>;
|
|
541
|
+
/** @deprecated not intended for public usage; use <MeshApp /> instead */
|
|
542
|
+
declare const UniformMeshSdkContextProvider: React__default.FC<React__default.PropsWithChildren<unknown>>;
|
|
543
|
+
/**
|
|
544
|
+
* Provides access to the current (initialized) Uniform Mesh SDK context value.
|
|
545
|
+
* @deprecated Not intended for public use. Use `useUniformMeshLocation` or `useUniformMeshSdk` instead.
|
|
546
|
+
*/
|
|
547
|
+
declare const useUniformMeshSdkContext: () => UniformMeshSdkContextValue;
|
|
568
548
|
|
|
569
|
-
|
|
549
|
+
interface UseUniformMeshSdkOptions {
|
|
550
|
+
autoResizingDisabled?: boolean;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Provides a React-hook wrapper around Uniform Mesh SDK initialization.
|
|
554
|
+
* NOTE: initialization is an async operation and should be handled as such.
|
|
555
|
+
*
|
|
556
|
+
* @deprecated prefer <MeshApp /> to initialize and provide in a single component
|
|
557
|
+
*/
|
|
558
|
+
declare const useInitializeUniformMeshSdk: ({ autoResizingDisabled }?: UseUniformMeshSdkOptions) => {
|
|
559
|
+
initializing: boolean;
|
|
560
|
+
error: Error | undefined;
|
|
561
|
+
sdk: UniformMeshSDK | undefined;
|
|
562
|
+
};
|
|
570
563
|
|
|
571
|
-
|
|
564
|
+
/**
|
|
565
|
+
* Provides convenient access to the current Uniform Mesh location via React hook.
|
|
566
|
+
* Intended to be used within <MeshApp />.
|
|
567
|
+
*
|
|
568
|
+
* There are three primary ways to invoke this hook:
|
|
569
|
+
* 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`
|
|
570
|
+
* const location = useMeshLocation();
|
|
571
|
+
* if (location.type === 'paramType') { // location is now known to be a paramType }
|
|
572
|
+
* 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.
|
|
573
|
+
* const location = useMeshLocation('settings');
|
|
574
|
+
* 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.
|
|
575
|
+
* const location = useMeshLocation<'paramType', MyParamTypeValueType>();
|
|
576
|
+
*
|
|
577
|
+
* You can also combine (2) and (3) to get both explicit value typing and assertion of the location.
|
|
578
|
+
*/
|
|
579
|
+
declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLocationValue = unknown, TLocationSetValue = TLocationValue>(expectedLocation?: TLocationType): Extract<_uniformdev_mesh_sdk.DataSourceLocation, {
|
|
580
|
+
type: TLocationType;
|
|
581
|
+
}> | Extract<_uniformdev_mesh_sdk.DataTypeLocation, {
|
|
582
|
+
type: TLocationType;
|
|
583
|
+
}> | Extract<_uniformdev_mesh_sdk.DataTypeInstanceLocation, {
|
|
584
|
+
type: TLocationType;
|
|
585
|
+
}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
|
|
586
|
+
type: TLocationType;
|
|
587
|
+
}> | Extract<_uniformdev_mesh_sdk.ParamTypeConfigLocation<TLocationValue, unknown>, {
|
|
588
|
+
type: TLocationType;
|
|
589
|
+
}> | Extract<_uniformdev_mesh_sdk.SettingsLocation<TLocationValue>, {
|
|
590
|
+
type: TLocationType;
|
|
591
|
+
}>;
|
|
572
592
|
|
|
573
|
-
|
|
593
|
+
/**
|
|
594
|
+
* Provides convenient access to the current Uniform Mesh location via React hook.
|
|
595
|
+
* Intended to be used within <MeshApp />.
|
|
596
|
+
*
|
|
597
|
+
* @deprecated prefer useMeshLocation which has much more accurate type safety
|
|
598
|
+
*/
|
|
599
|
+
declare function useUniformMeshLocation<TLocationValue = unknown, TLocationMetadata = never, TLocationSetValue = TLocationValue>(): MeshLocationCore<TLocationValue, TLocationMetadata, TLocationSetValue>;
|
|
574
600
|
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
SvgClose as Close,
|
|
581
|
-
SvgDanger as Danger,
|
|
582
|
-
SvgExclamationPoint as ExclamationPoint,
|
|
583
|
-
SvgInfo as Info,
|
|
584
|
-
SvgLightbulb as Lightbulb,
|
|
585
|
-
SvgMagnifyingGlass as MagnifyingGlass,
|
|
586
|
-
SvgMaximizeAlt as MaximizeAlt,
|
|
587
|
-
SvgMinus as Minus,
|
|
588
|
-
SvgMoreVerticalAlt as MoreVerticalAlt,
|
|
589
|
-
SvgPlus as Plus,
|
|
590
|
-
};
|
|
591
|
-
}
|
|
601
|
+
/**
|
|
602
|
+
* Provides convenient access to the current Uniform Mesh SDK instance via React hook.
|
|
603
|
+
* Intended to be used within <MeshApp />.
|
|
604
|
+
*/
|
|
605
|
+
declare function useUniformMeshSdk(): _uniformdev_mesh_sdk.UniformMeshSDK;
|
|
592
606
|
|
|
593
|
-
export {
|
|
607
|
+
export { BaseRequestData, Brand, 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, RequestParametersProps, RequestProvider, RequestProviderProps, RequestTypeContainer, RequestTypeContainerProps, RequestUrl, 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, 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, useUniformMeshLocation, useUniformMeshLocationContext, useUniformMeshSdk, useUniformMeshSdkContext, useVariables, variablesToList };
|