@carbon/ibm-products 2.43.2-canary.27 → 2.43.2-canary.270

package/es/components/ConditionBuilder/ConditionBlock/ConditionBlock.js

@@ -10,7 +10,6 @@ import React__default, { useContext, useState } from 'react';
 import { Close } from '@carbon/react/icons';
 import { ConditionBuilderItem } from '../ConditionBuilderItem/ConditionBuilderItem.js';
 import PropTypes from '../../../node_modules/prop-types/index.js';
-import { blockClass, translateWithId, statementConfig, operatorConfig } from '../ConditionBuilderContext/DataConfigs.js';
 import cx from 'classnames';
 import ConditionConnector from '../ConditionBuilderConnector/ConditionConnector.js';
 import { ConditionBuilderItemNumber } from '../ConditionBuilderItem/ConditionBuilderItemNumber/ConditionBuilderItemNumber.js';
@@ -18,11 +17,13 @@ import { ConditionBuilderItemText } from '../ConditionBuilderItem/ConditionBuild
 import { ConditionBuilderItemDate } from '../ConditionBuilderItem/ConditionBuilderItemDate/ConditionBuilderItemDate.js';
 import { ConditionBuilderContext } from '../ConditionBuilderContext/ConditionBuilderProvider.js';
 import { ConditionBuilderButton } from '../ConditionBuilderButton/ConditionBuilderButton.js';
-import { focusThisField } from '../utils/util.js';
+import { blockClass, HIERARCHICAL_VARIANT, NON_HIERARCHICAL_VARIANT, checkIsValid, focusThisField } from '../utils/util.js';
 import { ConditionBuilderItemTime } from '../ConditionBuilderItem/ConditionBuilderItemTime/ConditionBuilderItemTime.js';
 import ConditionBuilderAdd from '../ConditionBuilderAdd/ConditionBuilderAdd.js';
 import { ItemOption } from '../ConditionBuilderItem/ConditionBuilderItemOption/ItemOption.js';
 import { ItemOptionForValueField } from '../ConditionBuilderItem/ConditionBuilderItemOption/ItemOptionForValueField.js';
+import { useTranslations } from '../utils/useTranslations.js';
+import { useDataConfigs } from '../utils/useDataConfigs.js';
 
 var _div;
 
@@ -31,13 +32,10 @@ var _div;
  */
 
 var ConditionBlock = function ConditionBlock(props) {
-  var _props$condition = props.condition,
-    property = _props$condition.property,
-    value = _props$condition.value,
-    operator = _props$condition.operator;
   var onRemove = props.onRemove,
     onChange = props.onChange,
-    condition = props.condition,
+    _props$condition = props.condition,
+    condition = _props$condition === void 0 ? {} : _props$condition,
     conjunction = props.conjunction,
     onConnectorOperatorChange = props.onConnectorOperatorChange,
     isStatement = props.isStatement,
@@ -52,26 +50,44 @@ var ConditionBlock = function ConditionBlock(props) {
     hideConditionPreviewHandler = props.hideConditionPreviewHandler,
     showConditionPreviewHandler = props.showConditionPreviewHandler,
     isLastCondition = props.isLastCondition;
+  var property = condition.property,
+    value = condition.value,
+    operator = condition.operator;
   var _useContext = useContext(ConditionBuilderContext),
     inputConfig = _useContext.inputConfig,
-    variant = _useContext.variant;
+    variant = _useContext.variant,
+    conditionBuilderRef = _useContext.conditionBuilderRef;
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     showDeletionPreview = _useState2[0],
     setShowDeletionPreview = _useState2[1];
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    showAllActions = _useState4[0],
+    setShowAllActions = _useState4[1];
+  var _useTranslations = useTranslations(['conditionRowText', 'conditionText', 'propertyText', 'operatorText', 'removeConditionText']),
+    _useTranslations2 = _slicedToArray(_useTranslations, 5),
+    conditionRowText = _useTranslations2[0],
+    conditionText = _useTranslations2[1],
+    propertyText = _useTranslations2[2],
+    operatorText = _useTranslations2[3],
+    removeConditionText = _useTranslations2[4];
+  var _useDataConfigs = useDataConfigs(),
+    statementConfig = _useDataConfigs.statementConfig,
+    operatorConfig = _useDataConfigs.operatorConfig;
 
   //filtering the current property to access its properties and config options
   var getCurrentConfig = function getCurrentConfig(property) {
     var _inputConfig$properti, _inputConfig$properti2;
-    return (_inputConfig$properti = (_inputConfig$properti2 = inputConfig.properties) === null || _inputConfig$properti2 === void 0 ? void 0 : _inputConfig$properti2.filter(function (eachProperty) {
+    return (_inputConfig$properti = inputConfig === null || inputConfig === void 0 || (_inputConfig$properti2 = inputConfig.properties) === null || _inputConfig$properti2 === void 0 ? void 0 : _inputConfig$properti2.find(function (eachProperty) {
       return eachProperty.id == property;
-    })[0]) !== null && _inputConfig$properti !== void 0 ? _inputConfig$properti : {};
+    })) !== null && _inputConfig$properti !== void 0 ? _inputConfig$properti : {};
   };
-  var _getCurrentConfig = getCurrentConfig(property),
-    icon = _getCurrentConfig.icon,
-    type = _getCurrentConfig.type,
-    config = _getCurrentConfig.config,
-    label = _getCurrentConfig.label;
+  var _ref = getCurrentConfig(property),
+    icon = _ref.icon,
+    type = _ref.type,
+    config = _ref.config,
+    label = _ref.label;
 
   //Below possible input types expected for value field.
   var itemComponents = {
@@ -80,26 +96,33 @@ var ConditionBlock = function ConditionBlock(props) {
     date: ConditionBuilderItemDate,
     time: ConditionBuilderItemTime,
     option: ItemOptionForValueField,
-    custom: config === null || config === void 0 ? void 0 : config.component
+    custom: config === null || config === void 0 ? void 0 : config.component,
+    textarea: ConditionBuilderItemText
+  };
+  var ItemComponent = itemComponents[type];
+  var showAllActionsHandler = function showAllActionsHandler() {
+    setShowAllActions(true);
+  };
+  var hideAllActionsHandler = function hideAllActionsHandler() {
+    setShowAllActions(false);
   };
-  var ItemComponent = property ? itemComponents[type] : null;
   var onStatementChangeHandler = function onStatementChangeHandler(v, evt) {
-    focusThisField(evt);
-    onStatementChange(v);
+    focusThisField(evt, conditionBuilderRef);
+    onStatementChange === null || onStatementChange === void 0 || onStatementChange(v);
   };
   var onPropertyChangeHandler = function onPropertyChangeHandler(newProperty) {
     onChange(_objectSpread2(_objectSpread2({}, condition), {}, {
       property: newProperty,
       operator: undefined,
       value: '',
-      popoverToOpen: 'operatorField'
+      popoverToOpen: checkIsValid(newProperty) ? 'operatorField' : ''
     }));
   };
   var onOperatorChangeHandler = function onOperatorChangeHandler(newOperator) {
     onChange(_objectSpread2(_objectSpread2({}, condition), {}, {
       operator: newOperator,
       value: undefined,
-      popoverToOpen: 'valueField'
+      popoverToOpen: checkIsValid(newOperator) ? 'valueField' : ''
     }));
   };
   var onValueChangeHandler = function onValueChangeHandler(newValue) {
@@ -115,6 +138,12 @@ var ConditionBlock = function ConditionBlock(props) {
   var handleHideDeletionPreview = function handleHideDeletionPreview() {
     setShowDeletionPreview(false);
   };
+  var manageActionButtons = function manageActionButtons(conditionIndex, conditions) {
+    if (variant === HIERARCHICAL_VARIANT) {
+      return true;
+    }
+    return isLastCondition(conditionIndex, conditions);
+  };
   var getOperators = function getOperators() {
     if (config !== null && config !== void 0 && config.operators) {
       return config.operators;
@@ -124,95 +153,110 @@ var ConditionBlock = function ConditionBlock(props) {
     });
   };
   var getAriaAttributes = function getAriaAttributes() {
-    return variant == 'tree' ? {
+    return variant == HIERARCHICAL_VARIANT ? {
       'aria-level': aria.level,
       'aria-posinset': aria.posinset,
       'aria-setsize': aria.setsize
     } : {};
   };
+  var renderChildren = function renderChildren(popoverRef) {
+    return /*#__PURE__*/React__default.createElement(ItemComponent, {
+      conditionState: {
+        property: property,
+        operator: operator,
+        value: value
+      },
+      onChange: onValueChangeHandler,
+      config: config,
+      "data-name": "valueField",
+      parentRef: popoverRef,
+      type: type
+    });
+  };
   return /*#__PURE__*/React__default.createElement("div", _extends({
-    className: cx("".concat(blockClass, "__condition-block"), _defineProperty({}, "".concat(blockClass, "__condition__deletion-preview"), showDeletionPreview), _defineProperty({}, "".concat(blockClass, "__gap-bottom"), variant == 'tree' && !(conditionIndex + 1 >= group.conditions.length)), _defineProperty({}, "".concat(blockClass, "__gap ").concat(blockClass, "__gap-bottom"), variant == 'sentence')),
+    className: cx("".concat(blockClass, "__condition-block"), _defineProperty({}, "".concat(blockClass, "__condition__deletion-preview"), showDeletionPreview), _defineProperty({}, "".concat(blockClass, "__gap-bottom"), variant == HIERARCHICAL_VARIANT), _defineProperty({}, "".concat(blockClass, "__gap ").concat(blockClass, "__gap-bottom"), variant == NON_HIERARCHICAL_VARIANT), _defineProperty({}, "".concat(blockClass, "__condition--interacting"), showAllActions)),
     role: "row",
-    "aria-label": translateWithId('condition_row'),
-    tabIndex: -1
-  }, getAriaAttributes()), conjunction ? /*#__PURE__*/React__default.createElement(ConditionConnector, {
+    "aria-label": conditionRowText
+  }, getAriaAttributes(), {
+    tabIndex: -1,
+    onMouseEnter: showAllActionsHandler,
+    onMouseLeave: hideAllActionsHandler,
+    onBlur: hideAllActionsHandler
+  }), conjunction ? /*#__PURE__*/React__default.createElement(ConditionConnector, {
     className: "".concat(blockClass, "__gap"),
     operator: conjunction,
     onChange: function onChange(op) {
-      return onConnectorOperatorChange(op);
+      return onConnectorOperatorChange === null || onConnectorOperatorChange === void 0 ? void 0 : onConnectorOperatorChange(op);
     }
   }) : _div || (_div = /*#__PURE__*/React__default.createElement("div", {
     role: "gridcell"
   })), isStatement && /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
     label: group.statement,
-    title: translateWithId('condition'),
+    title: conditionText,
     "data-name": "connectorField",
     popOverClassName: "".concat(blockClass, "__gap"),
-    className: "".concat(blockClass, "__statement-button")
+    className: "".concat(blockClass, "__statement-button"),
+    tabIndex: 0
   }, /*#__PURE__*/React__default.createElement(ItemOption, {
     conditionState: {
       value: group.statement,
-      label: translateWithId('condition')
+      label: conditionText
     },
     onChange: onStatementChangeHandler,
     config: {
-      options: statementConfig
+      options: statementConfig,
+      isStatement: true
     }
   })), /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
-    label: label,
-    title: translateWithId('property'),
-    renderIcon: icon !== null && icon !== void 0 ? icon : null,
+    label: label !== null && label !== void 0 ? label : condition === null || condition === void 0 ? void 0 : condition.property,
+    title: propertyText,
+    renderIcon: icon !== null && icon !== void 0 ? icon : undefined,
     className: "".concat(blockClass, "__property-field"),
     "data-name": "propertyField",
     condition: condition,
-    type: type
+    type: type,
+    onChange: onPropertyChangeHandler
   }, /*#__PURE__*/React__default.createElement(ItemOption, {
     conditionState: {
       value: property,
-      label: translateWithId('property')
+      label: propertyText
     },
     onChange: onPropertyChangeHandler,
     config: {
-      options: inputConfig.properties
+      options: inputConfig === null || inputConfig === void 0 ? void 0 : inputConfig.properties
     }
-  })), property && /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
+  })), checkIsValid(property) && /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
     label: operator,
-    title: translateWithId('operator'),
+    title: operatorText,
     "data-name": "operatorField",
     condition: condition,
-    type: type
+    type: type,
+    onChange: onOperatorChangeHandler
   }, /*#__PURE__*/React__default.createElement(ItemOption, {
     config: {
       options: getOperators()
     },
     conditionState: {
       value: operator,
-      label: translateWithId('operator')
+      label: operatorText
     },
     onChange: onOperatorChangeHandler
-  })), property && operator && /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
+  })), checkIsValid(property) && checkIsValid(operator) && /*#__PURE__*/React__default.createElement(ConditionBuilderItem, {
     label: value,
     type: type,
     title: label,
     showToolTip: true,
     "data-name": "valueField",
     condition: condition,
-    config: config
-  }, /*#__PURE__*/React__default.createElement(ItemComponent, {
-    conditionState: {
-      property: property,
-      operator: operator,
-      value: value
-    },
-    onChange: onValueChangeHandler,
     config: config,
-    "data-name": "valueField"
-  })), /*#__PURE__*/React__default.createElement("span", {
+    onChange: onValueChangeHandler,
+    renderChildren: renderChildren
+  }), /*#__PURE__*/React__default.createElement("span", {
     role: "gridcell",
-    "aria-label": translateWithId('remove_condition')
+    "aria-label": removeConditionText
   }, /*#__PURE__*/React__default.createElement(ConditionBuilderButton, {
     hideLabel: true,
-    label: translateWithId('remove_condition'),
+    label: removeConditionText,
     onClick: onRemove,
     onMouseEnter: handleShowDeletionPreview,
     onMouseLeave: handleHideDeletionPreview,
@@ -221,22 +265,21 @@ var ConditionBlock = function ConditionBlock(props) {
     renderIcon: Close,
     className: "".concat(blockClass, "__close-condition"),
     "data-name": "closeCondition"
-  })), isLastCondition(conditionIndex, group.conditions) && /*#__PURE__*/React__default.createElement(ConditionBuilderAdd, {
+  })), manageActionButtons(conditionIndex, group.conditions) && /*#__PURE__*/React__default.createElement(ConditionBuilderAdd, {
     onClick: function onClick() {
-      addConditionHandler(conditionIndex);
+      addConditionHandler === null || addConditionHandler === void 0 || addConditionHandler(conditionIndex);
     },
     addConditionSubGroupHandler: function addConditionSubGroupHandler() {
-      _addConditionSubGroupHandler(conditionIndex);
+      _addConditionSubGroupHandler === null || _addConditionSubGroupHandler === void 0 || _addConditionSubGroupHandler(conditionIndex);
     },
     showConditionSubGroupPreviewHandler: showConditionSubGroupPreviewHandler,
     hideConditionSubGroupPreviewHandler: hideConditionSubGroupPreviewHandler,
-    enableSubGroup: variant == 'tree',
+    enableSubGroup: variant == HIERARCHICAL_VARIANT,
     showConditionPreviewHandler: showConditionPreviewHandler,
     hideConditionPreviewHandler: hideConditionPreviewHandler,
     className: "".concat(blockClass, "__gap ").concat(blockClass, "__gap-left")
   }));
 };
-var ConditionBlock$1 = ConditionBlock;
 ConditionBlock.propTypes = {
   /**
    * callback to add a new condition
@@ -303,4 +346,4 @@ ConditionBlock.propTypes = {
   state: PropTypes.object
 };
 
-export { ConditionBlock$1 as default };
+export { ConditionBlock as default };

package/es/components/ConditionBuilder/ConditionBuilder.d.ts

@@ -1,5 +1,12 @@
 /**
- * TODO: A description of the component.
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
  */
-export let ConditionBuilder: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';
+import { ConditionBuilderProps } from './ConditionBuilder.types';
+/**
+ * TODO: A description of the component.
+ */
+export declare let ConditionBuilder: React.ForwardRefExoticComponent<ConditionBuilderProps & React.RefAttributes<HTMLDivElement>>;

package/es/components/ConditionBuilder/ConditionBuilder.js

@@ -14,10 +14,10 @@ import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import ConditionBuilderContent from './ConditionBuilderContent/ConditionBuilderContent.js';
 import { ConditionBuilderProvider } from './ConditionBuilderContext/ConditionBuilderProvider.js';
 import { pkg } from '../../settings.js';
-import { blockClass } from './ConditionBuilderContext/DataConfigs.js';
 import { handleKeyDown } from './utils/handleKeyboardEvents.js';
+import { blockClass, NON_HIERARCHICAL_VARIANT } from './utils/util.js';
 
-var _excluded = ["className", "inputConfig", "startConditionLabel", "popOverSearchThreshold", "getOptions", "initialState", "getConditionState", "getActionsState", "variant", "actions"];
+var _excluded = ["className", "inputConfig", "startConditionLabel", "popOverSearchThreshold", "getOptions", "initialState", "getConditionState", "getActionsState", "variant", "actions", "translateWithId"];
 
 // Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
@@ -47,25 +47,30 @@ var componentName = 'ConditionBuilder';
 var ConditionBuilder = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     inputConfig = _ref.inputConfig,
-    startConditionLabel = _ref.startConditionLabel,
+    _ref$startConditionLa = _ref.startConditionLabel,
+    startConditionLabel = _ref$startConditionLa === void 0 ? 'Add Condition' : _ref$startConditionLa,
     popOverSearchThreshold = _ref.popOverSearchThreshold,
     getOptions = _ref.getOptions,
     initialState = _ref.initialState,
     getConditionState = _ref.getConditionState,
     getActionsState = _ref.getActionsState,
-    variant = _ref.variant,
+    _ref$variant = _ref.variant,
+    variant = _ref$variant === void 0 ? NON_HIERARCHICAL_VARIANT : _ref$variant,
     actions = _ref.actions,
+    translateWithId = _ref.translateWithId,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var localRef = useRef();
+  var localRef = useRef(null);
   var conditionBuilderRef = ref || localRef;
   var handleKeyDownHandler = function handleKeyDownHandler(evt) {
-    handleKeyDown(evt, conditionBuilderRef);
+    handleKeyDown(evt, conditionBuilderRef, variant);
   };
   return /*#__PURE__*/React__default.createElement(ConditionBuilderProvider, {
     inputConfig: inputConfig,
     popOverSearchThreshold: popOverSearchThreshold,
     getOptions: getOptions,
-    variant: variant
+    variant: variant,
+    translateWithId: translateWithId,
+    conditionBuilderRef: conditionBuilderRef
   }, /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
     className: cx(blockClass,
     // Apply the block class to the main HTML element
@@ -76,14 +81,12 @@ var ConditionBuilder = /*#__PURE__*/React__default.forwardRef(function (_ref, re
       // switched classes dependant on props or state
       // example: [`${blockClass}__here-if-small`]: size === 'sm',
     }),
-    role: "main",
     ref: conditionBuilderRef
   }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(VStack, {
     className: "".concat(blockClass, "__").concat(variant),
     onKeyDown: handleKeyDownHandler
   }, /*#__PURE__*/React__default.createElement(ConditionBuilderContent, {
     startConditionLabel: startConditionLabel,
-    conditionBuilderRef: conditionBuilderRef,
     getConditionState: getConditionState,
     getActionsState: getActionsState,
     initialState: initialState,
@@ -105,8 +108,9 @@ ConditionBuilder.propTypes = {
   /**
    * optional array of actions
    */
+  /**@ts-ignore */
   actions: PropTypes.arrayOf(PropTypes.shape({
-    id: PropTypes.oneOfType([PropTypes.string | PropTypes.number]).isRequired,
+    id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
     label: PropTypes.string.isRequired
   })),
   /**
@@ -143,37 +147,43 @@ ConditionBuilder.propTypes = {
    */
   getOptions: PropTypes.func,
   /**
-   * Optional prop if you want to pass a saved condition state.
-   *  This object should respect the structure of condition state that is available in getConditionState callback
+   * Optional prop if you want to pass a saved condition state, pass as "initialState.state".
+   * "initialState.enabledDefault" will populate the builder with the provided initial state before clicking Add Condition button.
+   *
+   *  This state should respect the structure of condition state that is available in getConditionState callback
    */
+  /**@ts-ignore */
   initialState: PropTypes.shape({
-    groups: PropTypes.arrayOf(PropTypes.shape({
-      groupOperator: PropTypes.string.isRequired,
-      statement: PropTypes.string.isRequired,
-      conditions: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.shape({
-        property: PropTypes.string.isRequired,
-        operator: PropTypes.string.isRequired,
-        value: PropTypes.oneOfType([PropTypes.string, PropTypes.arrayOf(PropTypes.shape({
-          id: PropTypes.string,
-          label: PropTypes.string
-        })), PropTypes.shape({
-          id: PropTypes.string,
-          label: PropTypes.string
-        })])
-      }), PropTypes.object]))
-    })),
-    operator: PropTypes.string
+    state: PropTypes.shape({
+      groups: PropTypes.arrayOf(PropTypes.shape({
+        groupOperator: PropTypes.string,
+        statement: PropTypes.string,
+        conditions: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.shape({
+          property: PropTypes.string,
+          operator: PropTypes.string,
+          value: PropTypes.oneOfType([PropTypes.string, PropTypes.arrayOf(PropTypes.shape({
+            id: PropTypes.string,
+            label: PropTypes.string
+          })), PropTypes.shape({
+            id: PropTypes.string,
+            label: PropTypes.string
+          })])
+        }), PropTypes.object]))
+      })),
+      operator: PropTypes.string
+    }),
+    enabledDefault: PropTypes.bool
   }),
   /**
    * This is a mandatory prop that defines the input to the condition builder.
-   
-   */
+    */
+  /**@ts-ignore */
   inputConfig: PropTypes.shape({
     properties: PropTypes.arrayOf(PropTypes.shape({
       id: PropTypes.string.isRequired,
       label: PropTypes.string.isRequired,
       icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
-      type: PropTypes.oneOf(['text', 'number', 'date', 'option', 'time', 'custom']).isRequired,
+      type: PropTypes.oneOf(['text', 'textarea', 'number', 'date', 'option', 'time', 'custom']).isRequired,
       config: PropTypes.shape({
         options: PropTypes.arrayOf(PropTypes.shape({
           id: PropTypes.string.isRequired,
@@ -195,12 +205,20 @@ ConditionBuilder.propTypes = {
   /**
    * Provide a label to the button that starts condition builder
    */
-  startConditionLabel: PropTypes.string.isRequired,
+  startConditionLabel: PropTypes.string,
+  /**
+   * Optional prop, if you need to pass translations to the texts on the component instead of the defined defaults.
+   * This callback function will receive the message id and you need to return the corresponding text for that id.
+   * The message id will be one of [   "ifText","addConditionText",   "addConditionGroupText",   "addSubgroupText",   "conditionText",   "propertyText",   "operatorText",   "valueText",   "connectorText",   "conditionRowText","conditionRowGroupText","conditionBuilderText","actionSectionText",   "removeConditionText",   "addConditionRowText",   "startText",   "endText",   "clearSearchText",   "actionsText",   "then",   "removeActionText",   "addActionText",   "invalidText",  "invalidNumberWarnText"]
+  ]
+   */
+  /**@ts-ignore */
+  translateWithId: PropTypes.func,
   /* TODO: add types and DocGen for all props. */
   /**
-   * Provide the condition builder variant: sentence/ tree
+   * Provide the condition builder variant: Non-Hierarchical/ Hierarchical
    */
-  variant: PropTypes.string.isRequired
+  variant: PropTypes.oneOf(['Non-Hierarchical', 'Hierarchical'])
 };
 
 export { ConditionBuilder };

package/es/components/ConditionBuilder/ConditionBuilder.types.d.ts

@@ -0,0 +1,155 @@
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { TextAreaProps, TextInputProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/react/icons';
+import { NumberInputProps } from '@carbon/react/lib/components/NumberInput/NumberInput';
+import { Dispatch, ForwardedRef, PropsWithChildren, ReactNode, SetStateAction } from 'react';
+export type LogicalOperator = 'and' | 'or';
+export type StatementOperator = 'ifAll' | 'ifAny' | 'unlessAll' | 'unlessAny';
+type CoreOperator = 'is';
+type NumberOperator = 'greater' | 'greaterEqual' | 'lower' | 'lowerEqual';
+type StringOperator = 'startsWith' | 'endsWith';
+type ArrayOperator = 'contains';
+type OptionOperator = 'oneOf';
+type DateOperator = 'before' | 'after';
+export type Operator = LogicalOperator | StatementOperator | CoreOperator | NumberOperator | StringOperator | ArrayOperator | OptionOperator | DateOperator;
+export type OperatorGroups = 'logical' | 'statement' | 'core' | 'number' | 'string' | 'array' | 'option' | 'date';
+export type Operators = {
+    logical: LogicalOperator;
+    statement: StatementOperator;
+    core: CoreOperator;
+    number: NumberOperator;
+    string: StringOperator;
+    array: ArrayOperator;
+    option: OptionOperator;
+    date: DateOperator;
+};
+export type PropertyConfigOption = {
+    type: 'option';
+    config?: {
+        options?: {
+            id: string;
+            label: string;
+            icon?: CarbonIconType;
+        }[];
+    };
+};
+export interface PropertyConfigText {
+    type: 'text';
+    config: TextInputProps;
+}
+export interface PropertyConfigTextArea {
+    type: 'textarea';
+    config: TextAreaProps;
+}
+export interface PropertyConfigNumber {
+    type: 'number';
+    config: {
+        min?: number;
+        max?: number;
+        step?: number;
+        unit?: string;
+    } & NumberInputProps;
+}
+export type PropertyConfigDate = {
+    type: 'date';
+    config: object;
+};
+export type PropertyConfigTime = {
+    type: 'time';
+    config: {
+        timeZones: string[];
+    };
+};
+export type PropertyConfigCustom = {
+    type: 'custom';
+    config: {
+        component: React.ComponentType<any>;
+        operators: {
+            label: string;
+            id: string;
+        }[];
+    };
+};
+export type PropertyConfig = {
+    option: PropertyConfigOption;
+    text: PropertyConfigText;
+    textarea: PropertyConfigTextArea;
+    number: PropertyConfigNumber;
+    date: PropertyConfigDate;
+    time: PropertyConfigTime;
+    custom: PropertyConfigCustom;
+};
+export type Property = {
+    id: string;
+    label: string;
+    icon?: CarbonIconType;
+} & (PropertyConfig['option'] | PropertyConfig['text'] | PropertyConfig['number'] | PropertyConfig['date'] | PropertyConfig['textarea'] | PropertyConfig['time'] | PropertyConfig['custom']);
+export type inputConfig = {
+    properties: Property[];
+};
+export type Option = {
+    id: string;
+    label: string;
+    icon?: CarbonIconType;
+};
+export type Condition = {
+    property?: string;
+    operator?: Operator | '' | 'INVALID';
+    value?: string | Option[] | Option;
+    id?: string | number;
+    popoverToOpen?: string;
+};
+export type ConditionGroup = {
+    conditions?: (ConditionGroup | Condition)[];
+    groupOperator?: LogicalOperator;
+    statement?: StatementOperator;
+    id: string;
+};
+export type ConditionBuilderState = {
+    groups?: ConditionGroup[];
+    operator?: LogicalOperator;
+};
+export type Action = {
+    id?: string | number;
+    label?: string;
+};
+export type variantsType = 'Non-Hierarchical' | 'Hierarchical';
+export type ConditionBuilderProps = {
+    inputConfig: inputConfig;
+    initialState?: InitialState;
+    getActionsState?: (state: Action[] | undefined) => void;
+    getConditionState: (state: ConditionBuilderState | undefined) => void;
+    getOptions?: (state: ConditionBuilderState, condition: Condition) => Promise<Option[]>;
+    actions?: Action[];
+    className?: string;
+    popOverSearchThreshold: number;
+    startConditionLabel?: string;
+    variant?: 'Non-Hierarchical' | 'Hierarchical';
+    translateWithId: (id: string) => string;
+};
+export type InitialState = {
+    state: ConditionBuilderState;
+    enabledDefault?: boolean;
+};
+export interface ConditionBuilderContextInputProps extends PropsWithChildren {
+    children?: ReactNode;
+    inputConfig?: inputConfig;
+    popOverSearchThreshold?: number;
+    getOptions?: (state: ConditionBuilderState, condition: Condition) => Promise<Option[]>;
+    variant?: string;
+    translateWithId?: (id: string) => string;
+    conditionBuilderRef?: ForwardedRef<HTMLDivElement>;
+}
+export type ConditionBuilderContextProps = {
+    rootState?: ConditionBuilderState;
+    setRootState?: Dispatch<SetStateAction<ConditionBuilderState>>;
+    actionState?: Action[];
+    setActionState?: Dispatch<SetStateAction<Action[]>>;
+} & ConditionBuilderContextInputProps;
+export {};