@uniformdev/context-ui 14.2.1-alpha.177

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import * as React from 'react';
+import React__default, { ReactNode, SVGProps } from 'react';
+import { DimensionDefinition, ManifestGetResponse } from '@uniformdev/context/api';
+import { EnrichmentData, VariantMatchCriteria } from '@uniformdev/context';
+import { ButtonProps as ButtonProps$1, InputProps as InputProps$1 } from 'reakit';
+import { GroupBase } from 'react-select';
+import { StateManagerProps } from 'react-select/dist/declarations/src/useStateManager';
+import InternalSelect from 'react-select/dist/declarations/src/Select';
+
+declare type CalloutType = 'caution' | 'danger' | 'info' | 'note' | 'success' | 'tip' | 'error';
+interface CalloutProps {
+    type: CalloutType;
+    title?: ReactNode;
+    children: ReactNode;
+    className?: string;
+}
+declare const Callout: React__default.FC<CalloutProps>;
+
+declare const LoadingIndicator: () => JSX.Element;
+
+declare type EditLinkProps = {
+    linkTo: string;
+    name?: string;
+    linkText?: string;
+};
+declare const EditLink: ({ linkTo, name, linkText }: EditLinkProps) => JSX.Element;
+
+interface ContextConfig {
+    projectId?: string;
+    apiHost: string;
+    apiKey: string;
+}
+declare type DimensionsData = {
+    dimensions: ResolvedDimensionDefinition[];
+    dimIndex: Record<string, ResolvedDimensionDefinition>;
+};
+declare type ResolvedDimensionDefinition = DimensionDefinition & {
+    displayName: string;
+};
+
+interface EnrichmentTagProps {
+    value: EnrichmentData[] | null | undefined;
+    setValue: (value: EnrichmentData[] | null) => void;
+    contextConfig: ContextConfig;
+}
+declare const EnrichmentTag: React__default.FC<EnrichmentTagProps>;
+
+interface PersonalizationCriteriaProps {
+    value: VariantMatchCriteria | null | undefined;
+    setValue: (value: VariantMatchCriteria | null) => void;
+    contextConfig: ContextConfig;
+}
+declare const PersonalizationCriteria: React__default.FC<PersonalizationCriteriaProps>;
+
+interface ButtonProps extends ButtonProps$1 {
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    buttonType?: 'primary' | 'secondary' | 'tertiary' | 'quaternary' | 'unimportant';
+    disablePadding?: boolean;
+    rounded?: boolean;
+}
+declare const Button: React__default.FC<ButtonProps>;
+
+declare type InputProps = InputProps$1 & {
+    label?: string;
+    classNameContainer?: string;
+    classNameControl?: string;
+    classNameLabel?: string;
+    icon?: React__default.ReactElement;
+    capture?: boolean | 'user' | 'environment';
+};
+declare const Input: React__default.FC<InputProps>;
+
+declare type SelectInputProps = React.SelectHTMLAttributes<HTMLSelectElement> & {
+    defaultOption?: string;
+    options: Array<React.OptionHTMLAttributes<HTMLOptionElement> & {
+        label: string;
+    }>;
+    caption?: string;
+    label: string;
+    showLabel?: boolean;
+    classNameContainer?: string;
+    classNameControl?: string;
+    classNameLabel?: string;
+};
+declare const SelectInput: ({ label, defaultOption, options, caption, classNameContainer, classNameControl, classNameLabel, showLabel, ...props }: SelectInputProps) => JSX.Element;
+
+declare type ComboBoxOption = {
+    label: string;
+    value: string;
+    isDisabled?: boolean;
+};
+declare type ComboBoxProps<TOption, IsMulti extends boolean, TGroup extends GroupBase<TOption> = GroupBase<TOption>> = StateManagerProps<TOption, IsMulti, TGroup> & React.RefAttributes<InternalSelect<TOption, IsMulti, TGroup>>;
+declare type ComboBoxGroupBase<TOption> = GroupBase<TOption>;
+declare function ComboBox<TOption = ComboBoxOption, IsMulti extends boolean = false, TGroup extends ComboBoxGroupBase<TOption> = ComboBoxGroupBase<TOption>>(props: ComboBoxProps<TOption, IsMulti, TGroup>): JSX.Element;
+
+declare type InlineSelectInputOption = {
+    label: string;
+    value: string;
+};
+declare type InlineSelectInputProps = Omit<React.HTMLAttributes<HTMLButtonElement>, 'onChange'> & {
+    disabled?: boolean;
+    value: string;
+    options: Array<InlineSelectInputOption>;
+    onChange: (option: InlineSelectInputOption) => void;
+    classNameContainer?: string;
+};
+declare const InlineSelectInput: ({ classNameContainer, disabled, options, value, onChange, ...props }: InlineSelectInputProps) => JSX.Element;
+
+interface LoadingOverlayProps {
+    isActive: boolean;
+    statusMessage?: string | JSX.Element;
+}
+declare const LoadingOverlay: React__default.FC<LoadingOverlayProps>;
+interface LoadingIconProps {
+    width?: number;
+    height?: number;
+}
+declare const LoadingIcon: React__default.FC<LoadingIconProps>;
+
+declare type ComponentIconNames = 'add-r' | 'add' | 'airplane' | 'alarm' | 'album' | 'align-bottom' | 'align-center' | 'align-left' | 'align-middle' | 'align-right' | 'align-top' | 'anchor' | 'apple-watch' | 'arrange-back' | 'arrange-front' | 'arrow-align-h' | 'arrow-align-v' | 'arrow-bottom-left-o' | 'arrow-bottom-left-r' | 'arrow-bottom-left' | 'arrow-bottom-right-o' | 'arrow-bottom-right-r' | 'arrow-bottom-right' | 'arrow-down-o' | 'arrow-down-r' | 'arrow-down' | 'arrow-left-o' | 'arrow-left-r' | 'arrow-left' | 'arrow-long-down-c' | 'arrow-long-down-e' | 'arrow-long-down-l' | 'arrow-long-down-r' | 'arrow-long-down' | 'arrow-long-left-c' | 'arrow-long-left-e' | 'arrow-long-left-l' | 'arrow-long-left-r' | 'arrow-long-left' | 'arrow-long-right-c' | 'arrow-long-right-e' | 'arrow-long-right-l' | 'arrow-long-right-r' | 'arrow-long-right' | 'arrow-long-up-c' | 'arrow-long-up-e' | 'arrow-long-up-l' | 'arrow-long-up-r' | 'arrow-long-up' | 'arrow-right-o' | 'arrow-right-r' | 'arrow-right' | 'arrow-top-left-o' | 'arrow-top-left-r' | 'arrow-top-left' | 'arrow-top-right-o' | 'arrow-top-right-r' | 'arrow-top-right' | 'arrow-up-o' | 'arrow-up-r' | 'arrow-up' | 'arrows-breake-h' | 'arrows-breake-v' | 'arrows-exchange-alt-v' | 'arrows-exchange-alt' | 'arrows-exchange-v' | 'arrows-exchange' | 'arrows-expand-down-left' | 'arrows-expand-down-right' | 'arrows-expand-left-alt' | 'arrows-expand-left' | 'arrows-expand-right-alt' | 'arrows-expand-right' | 'arrows-expand-up-left' | 'arrows-expand-up-right' | 'arrows-h-alt' | 'arrows-h' | 'arrows-merge-alt-h' | 'arrows-merge-alt-v' | 'arrows-scroll-h' | 'arrows-scroll-v' | 'arrows-shrink-h' | 'arrows-shrink-v' | 'arrows-v-alt' | 'arrows-v' | 'assign' | 'asterisk' | 'attachment' | 'attribution' | 'awards' | 'backspace' | 'band-aid' | 'battery-empty' | 'battery-full' | 'battery' | 'bee' | 'bell' | 'bitbucket' | 'block' | 'board' | 'bolt' | 'bookmark' | 'border-all' | 'border-bottom' | 'border-left' | 'border-right' | 'border-style-dashed' | 'border-style-dotted' | 'border-style-solid' | 'border-top' | 'bot' | 'bowl' | 'box' | 'boy' | 'briefcase' | 'browse' | 'browser' | 'brush' | 'bulb' | 'c-plus-plus' | 'calculator' | 'calendar-dates' | 'calendar-due' | 'calendar-next' | 'calendar-today' | 'calendar-two' | 'calendar' | 'calibrate' | 'camera' | 'cap' | 'captions' | 'card-clubs' | 'card-diamonds' | 'card-hearts' | 'card-spades' | 'carousel' | 'cast' | 'chart' | 'check-o' | 'check-r' | 'check' | 'chevron-double-down-o' | 'chevron-double-down-r' | 'chevron-double-down' | 'chevron-double-left-o' | 'chevron-double-left-r' | 'chevron-double-left' | 'chevron-double-right-o' | 'chevron-double-right-r' | 'chevron-double-right' | 'chevron-double-up-o' | 'chevron-double-up-r' | 'chevron-double-up' | 'chevron-down-o' | 'chevron-down-r' | 'chevron-down' | 'chevron-left-o' | 'chevron-left-r' | 'chevron-left' | 'chevron-right-o' | 'chevron-right-r' | 'chevron-right' | 'chevron-up-o' | 'chevron-up-r' | 'chevron-up' | 'clapper-board' | 'clipboard' | 'close-o' | 'close-r' | 'close' | 'cloud' | 'code-slash' | 'code' | 'coffee' | 'collage' | 'color-bucket' | 'color-picker' | 'comment' | 'community' | 'components' | 'compress-left' | 'compress-right' | 'compress-v' | 'compress' | 'controller' | 'copy' | 'copyright' | 'corner-double-down-left' | 'corner-double-down-right' | 'corner-double-left-down' | 'corner-double-left-up' | 'corner-double-right-down' | 'corner-double-right-up' | 'corner-double-up-left' | 'corner-double-up-right' | 'corner-down-left' | 'corner-down-right' | 'corner-left-down' | 'corner-left-up' | 'corner-right-down' | 'corner-right-up' | 'corner-up-left' | 'corner-up-right' | 'credit-card' | 'crop' | 'cross' | 'crown' | 'danger' | 'dark-mode' | 'data' | 'database' | 'debug' | 'desktop' | 'details-less' | 'details-more' | 'dialpad' | 'dice-1' | 'dice-2' | 'dice-3' | 'dice-4' | 'dice-5' | 'dice-6' | 'disc' | 'display-flex' | 'display-fullwidth' | 'display-grid' | 'display-spacing' | 'distribute-horizontal' | 'distribute-vertical' | 'dock-bottom' | 'dock-left' | 'dock-right' | 'dock-window' | 'dollar' | 'drive' | 'drop-invert' | 'drop-opacity' | 'drop' | 'duplicate' | 'edit-black-point' | 'edit-contrast' | 'edit-exposure' | 'edit-fade' | 'edit-flip-h' | 'edit-flip-v' | 'edit-highlight' | 'edit-markup' | 'edit-mask' | 'edit-noise' | 'edit-shadows' | 'edit-straight' | 'edit-unmask' | 'eject' | 'enter' | 'erase' | 'ereader' | 'ericsson' | 'ethernet' | 'euro' | 'expand' | 'export' | 'extension-add' | 'extension-alt' | 'extension-remove' | 'extension' | 'external' | 'eye-alt' | 'eye' | 'feed' | 'file-add' | 'file-document' | 'file-remove' | 'file' | 'film' | 'filters' | 'flag-alt' | 'flag' | 'folder-add' | 'folder-remove' | 'folder' | 'font-height' | 'font-spacing' | 'format-bold' | 'format-center' | 'format-color' | 'format-heading' | 'format-indent-decrease' | 'format-indent-increase' | 'format-italic' | 'format-justify' | 'format-left' | 'format-line-height' | 'format-right' | 'format-separator' | 'format-slash' | 'format-strike' | 'format-text' | 'format-underline' | 'format-uppercase' | 'games' | 'gender-female' | 'gender-male' | 'ghost-character' | 'gift' | 'girl' | 'git-branch' | 'git-commit' | 'git-fork' | 'git-pull' | 'glass-alt' | 'glass' | 'globe-alt' | 'globe' | 'gym' | 'hashtag' | 'headset' | 'heart' | 'home-alt' | 'home-screen' | 'home' | 'icecream' | 'image' | 'import' | 'inbox' | 'infinity' | 'info' | 'inpicture' | 'insert-after-o' | 'insert-after-r' | 'insert-after' | 'insert-before-o' | 'insert-before-r' | 'insert-before' | 'insights' | 'internal' | 'key' | 'keyboard' | 'keyhole' | 'laptop' | 'layout-grid-small' | 'layout-grid' | 'layout-list' | 'layout-pin' | 'link' | 'list-tree' | 'list' | 'live-photo' | 'loadbar-alt' | 'loadbar-doc' | 'loadbar-sound' | 'loadbar' | 'lock-unlock' | 'lock' | 'log-in' | 'log-off' | 'log-out' | 'loupe' | 'magnet' | 'mail-forward' | 'mail-open' | 'mail-reply' | 'mail' | 'math-divide' | 'math-equal' | 'math-minus' | 'math-percent' | 'math-plus' | 'maximize-alt' | 'maximize' | 'media-live' | 'media-podcast' | 'menu-boxed' | 'menu-cake' | 'menu-cheese' | 'menu-grid-o' | 'menu-grid-r' | 'menu-hotdog' | 'menu-left-alt' | 'menu-left' | 'menu-motion' | 'menu-oreos' | 'menu-right-alt' | 'menu-right' | 'menu-round' | 'menu' | 'merge-horizontal' | 'merge-vertical' | 'mic' | 'mini-player' | 'minimize-alt' | 'minimize' | 'modem' | 'moon' | 'more-alt' | 'more-o' | 'more-r' | 'more-vertical-alt' | 'more-vertical-o' | 'more-vertical-r' | 'more-vertical' | 'more' | 'mouse' | 'move-down' | 'move-left' | 'move-right' | 'move-task' | 'move-up' | 'music-note' | 'music-speaker' | 'music' | 'nametag' | 'notes' | 'notifications' | 'options' | 'organisation' | 'password' | 'path-back' | 'path-crop' | 'path-divide' | 'path-exclude' | 'path-front' | 'path-intersect' | 'path-outline' | 'path-trim' | 'path-unite' | 'pen' | 'pentagon-bottom-left' | 'pentagon-bottom-right' | 'pentagon-down' | 'pentagon-left' | 'pentagon-right' | 'pentagon-top-left' | 'pentagon-top-right' | 'pentagon-up' | 'performance' | 'phone' | 'photoscan' | 'piano' | 'pill' | 'pin-alt' | 'pin-bottom' | 'pin-top' | 'pin' | 'play-backwards' | 'play-button-o' | 'play-button-r' | 'play-button' | 'play-forwards' | 'play-list-add' | 'play-list-check' | 'play-list-remove' | 'play-list-search' | 'play-list' | 'play-pause-o' | 'play-pause-r' | 'play-pause' | 'play-stop-o' | 'play-stop-r' | 'play-stop' | 'play-track-next-o' | 'play-track-next-r' | 'play-track-next' | 'play-track-prev-o' | 'play-track-prev-r' | 'play-track-prev' | 'plug' | 'polaroid' | 'poll' | 'presentation' | 'printer' | 'profile' | 'pull-clear' | 'push-chevron-down-o' | 'push-chevron-down-r' | 'push-chevron-down' | 'push-chevron-left-o' | 'push-chevron-left-r' | 'push-chevron-left' | 'push-chevron-right-o' | 'push-chevron-right-r' | 'push-chevron-right' | 'push-chevron-up-o' | 'push-chevron-up-r' | 'push-chevron-up' | 'push-down' | 'push-left' | 'push-right' | 'push-up' | 'qr' | 'quote-o' | 'quote' | 'radio-check' | 'radio-checked' | 'ratio' | 'read' | 'readme' | 'record' | 'redo' | 'remote' | 'remove-r' | 'remove' | 'rename' | 'reorder' | 'repeat' | 'ring' | 'row-first' | 'row-last' | 'ruler' | 'sand-clock' | 'scan' | 'screen-mirror' | 'screen-shot' | 'screen-wide' | 'screen' | 'scroll-h' | 'scroll-v' | 'search-found' | 'search-loading' | 'search' | 'select-o' | 'select-r' | 'select' | 'server' | 'shape-circle' | 'shape-half-circle' | 'shape-hexagon' | 'shape-rhombus' | 'shape-square' | 'shape-triangle' | 'shape-zigzag' | 'share' | 'shield' | 'shopping-bag' | 'shopping-cart' | 'shortcut' | 'sidebar-open' | 'sidebar-right' | 'sidebar' | 'signal' | 'size' | 'sleep' | 'smart-home-boiler' | 'smart-home-cooker' | 'smart-home-heat' | 'smart-home-light' | 'smart-home-refrigerator' | 'smart-home-wash-machine' | 'smartphone-chip' | 'smartphone-ram' | 'smartphone-shake' | 'smartphone' | 'smile-mouth-open' | 'smile-neutral' | 'smile-no-mouth' | 'smile-none' | 'smile-sad' | 'smile-upside' | 'smile' | 'software-download' | 'software-upload' | 'sort-az' | 'sort-za' | 'space-between-v' | 'space-between' | 'spinner-alt' | 'spinner-two-alt' | 'spinner-two' | 'spinner' | 'stack' | 'stopwatch' | 'stories' | 'style' | 'sun' | 'support' | 'swap-vertical' | 'swap' | 'sweden' | 'swiss' | 'sync' | 'tab' | 'tag' | 'tap-double' | 'tap-single' | 'template' | 'tennis' | 'terminal' | 'terrain' | 'thermometer' | 'thermostat' | 'tikcode' | 'time' | 'timelapse' | 'timer' | 'today' | 'toggle-off' | 'toggle-on' | 'toggle-square-off' | 'toggle-square' | 'toolbar-bottom' | 'toolbar-left' | 'toolbar-right' | 'toolbar-top' | 'toolbox' | 'touchpad' | 'track' | 'transcript' | 'trash-empty' | 'trash' | 'tree' | 'trees' | 'trending-down' | 'trending' | 'trophy' | 'tv' | 'ui-kit' | 'umbrella' | 'unavailable' | 'unblock' | 'undo' | 'unsplash' | 'usb-c' | 'usb' | 'user-add' | 'user-list' | 'user-remove' | 'user' | 'view-cols' | 'view-comfortable' | 'view-day' | 'view-grid' | 'view-list' | 'view-month' | 'view-split' | 'vinyl' | 'voicemail-o' | 'voicemail-r' | 'voicemail' | 'volume' | 'webcam' | 'website' | 'work-alt' | 'yinyang' | 'zoom-in' | 'zoom-out' | 'settings';
+interface IconProps {
+    iconType: ComponentIconNames | null | undefined;
+    iconColorClass?: string;
+    onIconSelect?: (iconType: string) => void;
+}
+declare const Icon: React__default.NamedExoticComponent<IconProps>;
+
+declare function useIconContext(): {
+    loading: boolean | null;
+};
+declare function IconsProvider({ children }: {
+    children: ReactNode;
+}): JSX.Element;
+
+declare const SvgCaution: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgDanger: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgInfo: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgLightbulb: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare const SvgUniformBadge: (props: SVGProps<SVGSVGElement>) => JSX.Element;
+
+declare namespace index {
+  export {
+    SvgCaution as Caution,
+    SvgCheckmark as Checkmark,
+    SvgDanger as Danger,
+    SvgExclamationPoint as ExclamationPoint,
+    SvgInfo as Info,
+    SvgLightbulb as Lightbulb,
+    SvgUniformBadge as UniformBadge,
+  };
+}
+
+declare const validateContextConfig: (ContextConfig?: ContextConfig | undefined) => Promise<{
+    valid: boolean;
+    error?: Error;
+}>;
+
+interface UseValidateContextConfigResult {
+    validating: boolean;
+    error?: Error;
+}
+declare const useValidateContextConfig: (ContextConfig?: ContextConfig | undefined) => UseValidateContextConfigResult;
+
+interface UseContextDataResult {
+    result: ManifestGetResponse | null;
+    error: string | null;
+    loading: boolean;
+    notConfigured: boolean;
+}
+declare function useContextData({ apiHost, apiKey, projectId }: ContextConfig): UseContextDataResult;
+
+interface UseDimensionsResult {
+    result: DimensionsData | null;
+    error: string | null;
+    loading: boolean;
+    notConfigured: boolean;
+}
+declare function useDimensions({ apiHost, apiKey, projectId }: ContextConfig): UseDimensionsResult;
+
+export { Button, ButtonProps, Callout, CalloutProps, CalloutType, ComboBox, ComboBoxGroupBase, ComboBoxOption, ComboBoxProps, ComponentIconNames, ContextConfig, DimensionsData, EditLink, EditLinkProps, EnrichmentTag, EnrichmentTagProps, Icon, IconProps, index as Icons, IconsProvider, InlineSelectInput, InlineSelectInputOption, InlineSelectInputProps, Input, InputProps, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, PersonalizationCriteria, PersonalizationCriteriaProps, ResolvedDimensionDefinition, SelectInput, SelectInputProps, UseContextDataResult, UseDimensionsResult, UseValidateContextConfigResult, useContextData, useDimensions, useIconContext, useValidateContextConfig, validateContextConfig };