@uniformdev/context-ui 19.35.2 → 19.36.0

package/dist/index.d.mts

@@ -0,0 +1,156 @@
+import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
+import { DimensionMatch, EnrichmentData, VariantMatchCriteria } from '@uniformdev/context';
+import { InputComboBoxProps, InputComboBoxOption } from '@uniformdev/design-system';
+export * from '@uniformdev/design-system';
+import { DimensionDefinition, ManifestGetResponse } from '@uniformdev/context/api';
+import React, { ComponentType, ReactElement } from 'react';
+import * as _emotion_react from '@emotion/react';
+import * as yup from 'yup';
+
+type CriteriaOperatorMenuProps = {
+    value: DimensionMatch['op'];
+    onChange: (newValue: DimensionMatch['op']) => void;
+} & Omit<InputComboBoxProps<InputComboBoxOption, false>, 'value' | 'options' | 'onChange'>;
+declare const contextCriteriaMenuOperators: Array<{
+    name: string;
+    description?: string;
+    value: DimensionMatch['op'];
+}>;
+declare function CriteriaOperatorMenu({ onChange, value, ...props }: CriteriaOperatorMenuProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+interface ContextConfig {
+    projectId?: string;
+    apiHost: string;
+    apiKey: string;
+}
+type DimensionsData = {
+    dimensions: ResolvedDimensionDefinition[];
+    dimIndex: Record<string, ResolvedDimensionDefinition | undefined>;
+};
+type ResolvedDimensionDefinition = DimensionDefinition & {
+    displayName: string;
+};
+
+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;
+
+interface DataContextErrorProps {
+    contextConfig: ContextConfig;
+    result: UseContextDataResult | UseDimensionsResult;
+}
+interface ContextDataProps {
+    loadingComponent?: ComponentType;
+    errorComponent?: ComponentType<DataContextErrorProps>;
+    noIntentsComponent?: ComponentType<DataContextErrorProps>;
+    contextConfig: ContextConfig;
+}
+declare const ContextData: React.FC<React.PropsWithChildren<ContextDataProps>>;
+declare function useContextConfig(): ContextConfig;
+declare function useManifest(): ManifestGetResponse;
+declare function useDimensionsDataContext(): DimensionsData;
+
+type CriteriaMatchMenuProps = {
+    criteriaMatch: DimensionMatch;
+    dimensions: DimensionsData;
+    errorMessage?: string;
+    onChange: (newCriteria: DimensionMatch) => void;
+} & Omit<InputComboBoxProps<InputComboBoxOption, false>, 'value' | 'options' | 'onChange' | 'inputValue' | 'value' | 'onInputChange'>;
+declare function CriteriaMatchMenu({ onChange, criteriaMatch, dimensions, errorMessage, ...props }: CriteriaMatchMenuProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type DimensionMenuProps = {
+    value?: ResolvedDimensionDefinition;
+    dimensions: ResolvedDimensionDefinition[];
+    errorMessage?: string;
+    onChange: (newValue: ResolvedDimensionDefinition) => void;
+} & Omit<InputComboBoxProps<InputComboBoxOption, false>, 'value' | 'options' | 'onChange'>;
+declare function DimensionMenu({ onChange, value, dimensions, errorMessage, ...props }: DimensionMenuProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type DimensionValueProps = {
+    displayName: string;
+};
+declare function DimensionValue({ displayName }: DimensionValueProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EditLinkProps = {
+    linkTo: string;
+    name?: string;
+    linkText?: string;
+};
+declare const EditLink: ({ linkTo, name, linkText }: EditLinkProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const addEnrichmentLink: _emotion_react.SerializedStyles;
+interface EnrichmentTagProps {
+    value: EnrichmentData[] | null | undefined;
+    setValue: (value: EnrichmentData[] | null) => void;
+    contextConfig: ContextConfig;
+    displayTitle?: boolean;
+}
+declare const EnrichmentTag: React.FC<EnrichmentTagProps>;
+
+interface PersonalizationCriteriaStaticProps {
+    value: VariantMatchCriteria | null | undefined;
+    setValue: (value: VariantMatchCriteria | null) => void;
+    dimensions: DimensionsData;
+    displayTitle?: boolean;
+    onMenuOpen?: () => void;
+    onMenuClose?: () => void;
+    onAddCriteria?: (value: VariantMatchCriteria) => void;
+    onRemoveCriteria?: (value: VariantMatchCriteria | null) => void;
+    components?: {
+        NoDimensionsDefined?: React.ComponentType;
+        Title?: React.ComponentType;
+        CustomVariantName?: React.ComponentType;
+    };
+    errors?: {
+        lhs?: Array<string | undefined>;
+        rhs?: Array<string | undefined>;
+    };
+}
+declare const PersonalizationCriteriaStatic: React.FC<PersonalizationCriteriaStaticProps>;
+
+type ParameterValidationError<TValue> = TValue extends string | number | boolean ? string : {
+    [key in keyof TValue]: ParameterValidationError<TValue[key]> | undefined;
+};
+declare function convertErrorsToObj(errors: yup.ValidationError[]): ParameterValidationError<VariantMatchCriteria>;
+type PersonalizationCriteriaProps = {
+    contextConfig: ContextConfig;
+} & Omit<PersonalizationCriteriaStaticProps, 'dimensions'>;
+declare const PersonalizationCriteria: React.FC<PersonalizationCriteriaProps>;
+
+type UIVersionProps = {
+    versionMap: Record<number, React.ComponentType>;
+    children?: React.ReactNode;
+    contextConfig: ContextConfig;
+};
+declare function ProjectUIVersion({ children, versionMap, contextConfig }: UIVersionProps): ReactElement;
+
+interface UseValidateContextConfigResult {
+    validating: boolean;
+    error?: Error;
+    result?: ManifestGetResponse;
+}
+declare const useValidateContextConfig: (contextConfig?: ContextConfig) => UseValidateContextConfigResult;
+
+declare function isEnrichmentTagData(obj: any): obj is EnrichmentData[];
+declare function isPersonalizationCriteriaData(obj: any): obj is VariantMatchCriteria;
+declare function opHasRhs(op: string): boolean;
+
+declare const validateContextConfig: (contextConfig?: ContextConfig) => Promise<{
+    valid: boolean;
+    error?: Error;
+    result?: ManifestGetResponse;
+}>;
+
+export { ContextConfig, ContextData, ContextDataProps, CriteriaMatchMenu, CriteriaMatchMenuProps, CriteriaOperatorMenu, CriteriaOperatorMenuProps, DataContextErrorProps, DimensionMenu, DimensionMenuProps, DimensionValue, DimensionValueProps, DimensionsData, EditLink, EditLinkProps, EnrichmentTag, EnrichmentTagProps, PersonalizationCriteria, PersonalizationCriteriaProps, PersonalizationCriteriaStatic, PersonalizationCriteriaStaticProps, ProjectUIVersion, ResolvedDimensionDefinition, UseContextDataResult, UseDimensionsResult, UseValidateContextConfigResult, addEnrichmentLink, contextCriteriaMenuOperators, convertErrorsToObj, isEnrichmentTagData, isPersonalizationCriteriaData, opHasRhs, useContextConfig, useContextData, useDimensions, useDimensionsDataContext, useManifest, useValidateContextConfig, validateContextConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context-ui",
-  "version": "19.35.2",
+  "version": "19.36.0",
   "description": "React-based functionality and components for Uniform Context",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -32,8 +32,8 @@
   },
   "dependencies": {
     "@emotion/react": "11.11.1",
-    "@uniformdev/context": "19.35.2",
-    "@uniformdev/design-system": "19.35.2",
+    "@uniformdev/context": "19.36.0",
+    "@uniformdev/design-system": "19.36.0",
     "immer": "9.0.21",
     "react-beautiful-dnd": "13.1.1",
     "react-icons": "^4.7.1",
@@ -75,5 +75,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "3ae246a7f0f39adeaf04ecba4c7e48c478c019ad"
 }