@carbon/ibm-products 2.43.2-canary.22 → 2.43.2-canary.226

package/es/components/ConditionBuilder/ConditionBuilderContext/ConditionBuilderProvider.js

@@ -14,7 +14,7 @@ var emptyState = {
   operator: 'or',
   groups: [{
     groupOperator: 'and',
-    statement: 'if',
+    statement: 'ifAll',
     id: uuidv4(),
     conditions: [{
       property: undefined,
@@ -25,23 +25,11 @@ var emptyState = {
     }]
   }]
 };
-var ConditionBuilderContext = /*#__PURE__*/createContext();
-
-// const rootReducer=(state,action)=>{
-//   switch(action.type){
-//   case 'update':
-//      ;
-//     return {
-//       ...state,
-//       ...action.payload
-//     }
-//     break;
-//     default:
-//       return state;
-//   }
-
-// }
-
+var ConditionBuilderContext = /*#__PURE__*/createContext({
+  rootState: {
+    groups: []
+  }
+});
 var ConditionBuilderProvider = function ConditionBuilderProvider(props) {
   var _useState = useState({
       groups: []
@@ -53,17 +41,20 @@ var ConditionBuilderProvider = function ConditionBuilderProvider(props) {
     _useState4 = _slicedToArray(_useState3, 2),
     actionState = _useState4[0],
     setActionState = _useState4[1];
+  var contextValue = {
+    rootState: rootState,
+    setRootState: setRootState,
+    actionState: actionState,
+    setActionState: setActionState,
+    inputConfig: props.inputConfig,
+    popOverSearchThreshold: props.popOverSearchThreshold,
+    getOptions: props.getOptions,
+    variant: props.variant,
+    translateWithId: props.translateWithId,
+    conditionBuilderRef: props.conditionBuilderRef
+  };
   return /*#__PURE__*/React__default.createElement(ConditionBuilderContext.Provider, {
-    value: {
-      rootState: rootState,
-      setRootState: setRootState,
-      actionState: actionState,
-      setActionState: setActionState,
-      inputConfig: props.inputConfig,
-      popOverSearchThreshold: props.popOverSearchThreshold,
-      getOptions: props.getOptions,
-      variant: props.variant
-    }
+    value: contextValue
   },
   // eslint-disable-next-line react/prop-types
   props.children);
@@ -73,6 +64,11 @@ ConditionBuilderProvider.propTypes = {
    * Provide the contents of the ConditionBuilder.
    */
   children: PropTypes.node.isRequired,
+  /**
+   * ref of condition builder
+   */
+  /**@ts-ignore */
+  conditionBuilderRef: PropTypes.object,
   /**
    * This is an optional callback function that will be triggered when options array is not passed in the inputConfig against a property. 
    * This can be a asynchronous function that need  to  return a promise, so it will allow to fetch options from API call.
@@ -87,19 +83,25 @@ ConditionBuilderProvider.propTypes = {
    * 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,
-      label: PropTypes.string,
+      id: PropTypes.string.isRequired,
+      label: PropTypes.string.isRequired,
       icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
-      type: PropTypes.oneOf(['text', 'number', 'date', 'option', 'time', 'custom']),
+      type: PropTypes.oneOf(['text', 'textarea', 'number', 'date', 'option', 'time', 'custom']).isRequired,
       config: PropTypes.shape({
         options: PropTypes.arrayOf(PropTypes.shape({
-          id: PropTypes.string,
-          label: PropTypes.string,
+          id: PropTypes.string.isRequired,
+          label: PropTypes.string.isRequired,
           icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
         })),
-        includeSearch: PropTypes.bool
+        component: PropTypes.func,
+        operators: PropTypes.arrayOf(PropTypes.shape({
+          id: PropTypes.string.isRequired,
+          label: PropTypes.string.isRequired
+        })),
+        long: PropTypes.bool
       })
     }))
   }).isRequired,
@@ -108,7 +110,14 @@ ConditionBuilderProvider.propTypes = {
    */
   popOverSearchThreshold: PropTypes.number.isRequired,
   /**
-   * Provide the condition builder variant: sentence/ tree
+   * Optional prop if you want to pass translation to the texts used . Otherwise this will the defined defaults.
+   * This callback function will receive the message id and you need to return the corresponding text for that id.
+   * The message key will be one of [   "ifText",   "addConditionText",   "addConditionGroupText",   "addSubgroupText",   "conditionText",   "propertyText",   "operatorText",   "valueText",   "connectorText",   "conditionRowText",   "removeConditionText",   "addConditionRowText",   "startText",   "endText",   "clearSearchText",   "actionsText",   "then",   "removeActionText",   "addActionText",   "invalidText",   "invalidNumberWarnText"
+  ]
+   */
+  translateWithId: PropTypes.func,
+  /**
+   * Provide the condition builder variant: Non-Hierarchical/ Hierarchical
    */
   variant: PropTypes.string.isRequired
 };

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

@@ -1,41 +1,51 @@
 export namespace translationsObject {
-    namespace en {
-        let _if: string;
-        export { _if as if };
-        export let excl_if: string;
-        export let and: string;
-        export let or: string;
-        export let is: string;
-        export let greater: string;
-        export let greater_equal: string;
-        export let lower: string;
-        export let lower_equal: string;
-        export let starts_with: string;
-        export let ends_with: string;
-        export let contains: string;
-        export let one_of: string;
-        export let before: string;
-        export let after: string;
-        export let between: string;
-        export let add_condition: string;
-        export let add_condition_group: string;
-        export let add_subgroup: string;
-        export let condition: string;
-        export let property: string;
-        export let operator: string;
-        export let value: string;
-        export let connector: string;
-        export let condition_row: string;
-        export let remove_condition: string;
-        export let add_condition_row: string;
-        export let start: string;
-        export let end: string;
-        export let clear_search: string;
-        export let actions: string;
-        export let then: string;
-        export let remove_action: string;
-        export let add_action: string;
-        export let invalid_text: string;
-        export let text_invalid_number: string;
-    }
+    let ifText: string;
+    let unlessText: string;
+    let excl_if: string;
+    let and: string;
+    let or: string;
+    let is: string;
+    let ifAll: string;
+    let ifAny: string;
+    let unlessAll: string;
+    let unlessAny: string;
+    let greater: string;
+    let greaterEqual: string;
+    let lower: string;
+    let lowerEqual: string;
+    let startsWith: string;
+    let endsWith: string;
+    let contains: string;
+    let oneOf: string;
+    let before: string;
+    let after: string;
+    let between: string;
+    let addConditionText: string;
+    let addConditionGroupText: string;
+    let addSubgroupText: string;
+    let conditionText: string;
+    let propertyText: string;
+    let operatorText: string;
+    let valueText: string;
+    let connectorText: string;
+    let conditionRowText: string;
+    let conditionRowGroupText: string;
+    let removeConditionText: string;
+    let addConditionRowText: string;
+    let startText: string;
+    let endText: string;
+    let clearSearchText: string;
+    let actionsText: string;
+    let then: string;
+    let removeActionText: string;
+    let addActionText: string;
+    let invalidText: string;
+    let invalidNumberWarnText: string;
+    let conditionBuilderText: string;
+    let actionSectionText: string;
+    let conditionHeadingText: string;
+    let addPropertyText: string;
+    let addOperatorText: string;
+    let addValueText: string;
+    let conditionBuilderHierarchicalText: string;
 }

package/es/components/ConditionBuilder/ConditionBuilderContext/translationObject.js

@@ -6,44 +6,55 @@
  */
 
 var translationsObject = {
-  en: {
-    if: 'if',
-    excl_if: 'excl.if',
-    and: 'and',
-    or: 'or',
-    is: 'is',
-    greater: 'is greater than',
-    greater_equal: 'is greater than or equal to',
-    lower: 'is lower than',
-    lower_equal: 'is lower than or equal to',
-    starts_with: 'starts with',
-    ends_with: 'ends with',
-    contains: 'contains',
-    one_of: 'is one of',
-    before: 'is before',
-    after: 'is after',
-    between: 'is between',
-    add_condition: 'Add condition',
-    add_condition_group: 'Add condition group',
-    add_subgroup: 'Add subgroup',
-    condition: 'Condition',
-    property: 'Property',
-    operator: 'Operator',
-    value: 'Value',
-    connector: 'Connector',
-    condition_row: 'Condition row',
-    remove_condition: 'Remove condition',
-    add_condition_row: 'Add condition row',
-    start: 'Start',
-    end: 'End',
-    clear_search: 'Clear search input',
-    actions: 'Actions',
-    then: 'then',
-    remove_action: 'Remove Action',
-    add_action: 'Add action',
-    invalid_text: 'Incomplete',
-    text_invalid_number: 'Invalid number, must be 0 or greater'
-  }
+  ifText: 'if',
+  unlessText: 'unless',
+  excl_if: 'excl.if',
+  and: 'and',
+  or: 'or',
+  is: 'is',
+  ifAll: 'if all',
+  ifAny: 'if any',
+  unlessAll: 'unless all',
+  unlessAny: 'unless any',
+  greater: 'is greater than',
+  greaterEqual: 'is greater than or equal to',
+  lower: 'is lower than',
+  lowerEqual: 'is lower than or equal to',
+  startsWith: 'starts with',
+  endsWith: 'ends with',
+  contains: 'contains',
+  oneOf: 'is one of',
+  before: 'is before',
+  after: 'is after',
+  between: 'is between',
+  addConditionText: 'Add condition',
+  addConditionGroupText: 'Add condition group',
+  addSubgroupText: 'Add subgroup',
+  conditionText: 'Condition',
+  propertyText: 'Property',
+  operatorText: 'Operator',
+  valueText: 'Value',
+  connectorText: 'Connector',
+  conditionRowText: 'Condition row',
+  conditionRowGroupText: 'Condition row group',
+  removeConditionText: 'Delete condition',
+  addConditionRowText: 'Add condition row',
+  startText: 'Start',
+  endText: 'End',
+  clearSearchText: 'Clear search input',
+  actionsText: 'Actions',
+  then: 'then',
+  removeActionText: 'Remove Action',
+  addActionText: 'Add action',
+  invalidText: 'Incomplete',
+  invalidNumberWarnText: 'Invalid number, must be 0 or greater',
+  conditionBuilderText: 'Condition Builder',
+  actionSectionText: 'Action Section',
+  conditionHeadingText: 'Condition',
+  addPropertyText: 'Add property',
+  addOperatorText: 'Add operator',
+  addValueText: 'Add value',
+  conditionBuilderHierarchicalText: 'Condition Builder Hierarchical'
 };
 
 export { translationsObject };

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

@@ -1,28 +1,82 @@
-export function ConditionBuilderItem({ children, className, label, renderIcon, title, type, showToolTip, condition, popOverClassName, config, ...rest }: {
-    [x: string]: any;
-    children: any;
-    className: any;
-    label: any;
-    renderIcon: any;
-    title: any;
-    type: any;
-    showToolTip: any;
-    condition: any;
-    popOverClassName: any;
-    config: any;
-}): import("react/jsx-runtime").JSX.Element;
-export namespace ConditionBuilderItem {
-    namespace propTypes {
-        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        let className: PropTypes.Requireable<string>;
-        let condition: PropTypes.Requireable<object>;
-        let config: PropTypes.Requireable<object>;
-        let label: PropTypes.Requireable<NonNullable<string | object | null | undefined>>;
-        let popOverClassName: PropTypes.Requireable<string>;
-        let renderIcon: PropTypes.Requireable<object>;
-        let showToolTip: PropTypes.Requireable<boolean>;
-        let title: PropTypes.Requireable<string>;
-        let type: PropTypes.Requireable<string>;
-    }
-}
+/**
+ * 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 React, { PropsWithChildren, ReactNode, RefObject } from 'react';
 import PropTypes from 'prop-types';
+import { CarbonIconType } from '@carbon/react/icons';
+import { Condition, PropertyConfig, Action, Option } from '../ConditionBuilder.types';
+interface ConditionBuilderItemProps extends PropsWithChildren {
+    className?: string;
+    label?: string | Option | Option[];
+    renderIcon?: CarbonIconType;
+    title?: string;
+    showToolTip?: boolean;
+    popOverClassName?: string;
+    type?: string;
+    condition?: Action & Condition;
+    config?: PropertyConfig;
+    renderChildren?: (ref: RefObject<HTMLDivElement>) => ReactNode;
+    onChange?: (val: string) => void;
+    tabIndex?: number;
+    onMouseEnter?: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    onMouseLeave?: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    onFocus?: React.FocusEventHandler<HTMLButtonElement>;
+    onBlur?: React.FocusEventHandler<HTMLButtonElement>;
+}
+export declare const ConditionBuilderItem: {
+    ({ children, className, label, renderIcon, title, type, showToolTip, condition, popOverClassName, config, renderChildren, onChange, ...rest }: ConditionBuilderItemProps): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        /**
+         * provide the contents of the popover
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Provide an optional class to be applied to the containing node.
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * current condition state object
+         */
+        condition: PropTypes.Requireable<object>;
+        /**
+         * this is the config object again the current property from inputConfig
+         */
+        config: PropTypes.Requireable<object>;
+        /**
+         * text to be displayed in the field
+         */
+        label: PropTypes.Requireable<NonNullable<string | object | null | undefined>>;
+        /**
+         * callback to update the current condition of the state tree
+         */
+        onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * class name for popover
+         */
+        popOverClassName: PropTypes.Requireable<string>;
+        /**
+         * callback prop that returns the jsx for children
+         */
+        renderChildren: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * Optional prop to allow overriding the icon rendering.
+         */
+        renderIcon: PropTypes.Requireable<object>;
+        /**
+         * show tool tip
+         */
+        showToolTip: PropTypes.Requireable<boolean>;
+        /**
+         * title of the popover
+         */
+        title: PropTypes.Requireable<string>;
+        /**
+         * input type
+         */
+        type: PropTypes.Requireable<string>;
+    };
+};
+export {};

package/es/components/ConditionBuilder/ConditionBuilderItem/ConditionBuilderItem.js

@@ -6,14 +6,17 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default, { useRef, useState, useEffect } from 'react';
+import React__default, { useRef, useState, useContext, useEffect } from 'react';
 import { Popover, PopoverContent, Layer } from '@carbon/react';
 import PropTypes from '../../../node_modules/prop-types/index.js';
 import { Add } from '@carbon/react/icons';
-import { translateWithId, blockClass, valueRenderers } from '../ConditionBuilderContext/DataConfigs.js';
 import { ConditionBuilderButton } from '../ConditionBuilderButton/ConditionBuilderButton.js';
+import { useTranslations } from '../utils/useTranslations.js';
+import { ConditionBuilderContext } from '../ConditionBuilderContext/ConditionBuilderProvider.js';
+import { handleKeyDownForPopover } from '../utils/handleKeyboardEvents.js';
+import { blockClass, getValue } from '../utils/util.js';
 
-var _excluded = ["children", "className", "label", "renderIcon", "title", "type", "showToolTip", "condition", "popOverClassName", "config"];
+var _excluded = ["children", "className", "label", "renderIcon", "title", "type", "showToolTip", "condition", "popOverClassName", "config", "renderChildren", "onChange"];
 var ConditionBuilderItem = function ConditionBuilderItem(_ref) {
   var children = _ref.children,
     className = _ref.className,
@@ -25,23 +28,44 @@ var ConditionBuilderItem = function ConditionBuilderItem(_ref) {
     condition = _ref.condition,
     popOverClassName = _ref.popOverClassName,
     config = _ref.config,
+    renderChildren = _ref.renderChildren,
+    onChange = _ref.onChange,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var contentRef = useRef(null);
+  var popoverRef = useRef(null);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     open = _useState2[0],
     setOpen = _useState2[1];
+  var statementIdMap = {
+    ifAll: 'if',
+    ifAny: 'if',
+    unlessAll: 'unless',
+    unlessAny: 'unless'
+  };
+  var _useTranslations = useTranslations(['invalidText', 'addConditionText', 'addPropertyText', 'addOperatorText', 'addValueText', label], statementIdMap),
+    _useTranslations2 = _slicedToArray(_useTranslations, 6),
+    invalidText = _useTranslations2[0],
+    addConditionText = _useTranslations2[1],
+    addPropertyText = _useTranslations2[2],
+    addOperatorText = _useTranslations2[3],
+    addValueText = _useTranslations2[4],
+    labelText = _useTranslations2[5];
+  var _useContext = useContext(ConditionBuilderContext),
+    conditionBuilderRef = _useContext.conditionBuilderRef;
   var getPropertyDetails = function getPropertyDetails() {
-    if (label === 'INVALID') {
+    var _ref2 = condition || {},
+      property = _ref2.property,
+      operator = _ref2.operator;
+    if (label === 'INVALID' || rest['data-name'] === 'propertyField' && property === 'INVALID' || rest['data-name'] === 'operatorField' && operator === 'INVALID') {
       return {
-        propertyLabel: translateWithId('invalid_text'),
+        propertyLabel: invalidText,
         isInvalid: true
       };
     }
-    var propertyId = rest['data-name'] == 'valueField' && type ? valueRenderers[type](label, config) : label;
+    var propertyId = rest['data-name'] == 'valueField' && type ? getValue[type](label, config) : labelText;
     return {
       isInvalid: false,
-      propertyLabel: translateWithId(propertyId)
+      propertyLabel: propertyId
     };
   };
   var _getPropertyDetails = getPropertyDetails(),
@@ -57,60 +81,100 @@ var ConditionBuilderItem = function ConditionBuilderItem(_ref) {
       //if any condition is changed, state prop is triggered
       if (condition.popoverToOpen && currentField !== condition.popoverToOpen) {
         // close the previous popover
-        setOpen(false);
-      } else if (currentField == 'valueField' && type == 'option' && condition.operator !== 'one_of') {
+        closePopover();
+      } else if (currentField == 'valueField' && type == 'option' && (condition === null || condition === void 0 ? void 0 : condition.operator) !== 'oneOf') {
         //close the current popover if the field is valueField and  is a single select dropdown. For all other inputs ,popover need to be open on value changes.
-        setOpen(false);
+        closePopover();
       }
       if (condition.popoverToOpen == currentField) {
         //current popover need to be opened
-        setOpen(true);
+        openPopOver();
       }
     } else {
       // when we change any statement(if/ excl.if) which is not part of condition state, label change is triggered.
       //close popOver when statement is changed.
-      setOpen(false);
+      closePopover();
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [condition, label]);
   useEffect(function () {
     //this will focus the first input field in the popover
-    if (open && contentRef.current) {
-      var firstFocusableElement = contentRef.current.querySelector('input');
+    if (open && popoverRef.current) {
+      var _popoverRef$current;
+      var firstFocusableElement = popoverRef === null || popoverRef === void 0 || (_popoverRef$current = popoverRef.current) === null || _popoverRef$current === void 0 ? void 0 : _popoverRef$current.querySelector('input,textarea');
       if (firstFocusableElement) {
-        firstFocusableElement.focus();
+        setTimeout(function () {
+          return firstFocusableElement.focus();
+        }, 0);
       }
     }
-  }, [contentRef, open]);
+  }, [popoverRef, open]);
+  var manageInvalidSelection = function manageInvalidSelection() {
+    //when the user didn't select any value , we need to show as incomplete
+    if (rest['data-name'] === 'propertyField' && !(condition !== null && condition !== void 0 && condition.property) || rest['data-name'] === 'operatorField' && !(condition !== null && condition !== void 0 && condition.operator) || rest['data-name'] === 'valueField' && !(condition !== null && condition !== void 0 && condition.value)) {
+      onChange === null || onChange === void 0 || onChange('INVALID');
+    }
+  };
+  var closePopover = function closePopover() {
+    if (open) {
+      manageInvalidSelection();
+    }
+    setOpen(false);
+  };
+  var openPopOver = function openPopOver() {
+    return setOpen(true);
+  };
+  var togglePopover = function togglePopover() {
+    if (children || renderChildren) {
+      setOpen(!open);
+    }
+  };
+  var handleKeyDownHandler = function handleKeyDownHandler(evt) {
+    handleKeyDownForPopover(evt, conditionBuilderRef, popoverRef);
+    if (evt.key === 'Escape') {
+      manageInvalidSelection();
+    }
+  };
+  var getLabel = function getLabel() {
+    if (propertyLabel) {
+      return propertyLabel;
+    } else if (rest['data-name'] === 'propertyField') {
+      return addPropertyText;
+    } else if (rest['data-name'] === 'operatorField') {
+      return addOperatorText;
+    } else if (rest['data-name'] === 'valueField') {
+      return addValueText;
+    } else {
+      return addConditionText;
+    }
+  };
   return /*#__PURE__*/React__default.createElement(Popover, {
     open: open,
     isTabTip: true,
     role: "gridcell",
-    className: popOverClassName,
-    onRequestClose: function onRequestClose() {
-      setOpen(false);
-    }
+    className: "".concat(popOverClassName, " ").concat(blockClass, "__popover"),
+    ref: popoverRef,
+    onRequestClose: closePopover
   }, /*#__PURE__*/React__default.createElement(ConditionBuilderButton, _extends({
-    label: propertyLabel !== null && propertyLabel !== void 0 ? propertyLabel : translateWithId('add_condition'),
+    label: getLabel(),
     hideLabel: !label ? true : false,
-    onClick: function onClick() {
-      children ? setOpen(!open) : null;
-    },
+    onClick: togglePopover,
     className: className,
     "aria-haspopup": true,
     "aria-expanded": open,
-    renderIcon: renderIcon ? renderIcon : label == undefined ? Add : null,
+    renderIcon: renderIcon ? renderIcon : label == undefined ? Add : undefined,
     showToolTip: showToolTip,
     isInvalid: isInvalid
-  }, rest)), /*#__PURE__*/React__default.createElement(PopoverContent, {
-    className: "".concat(blockClass, "__item__content"),
+  }, rest)), open && /*#__PURE__*/React__default.createElement(PopoverContent, {
+    className: "".concat(blockClass, "__popover-content-wrapper"),
     role: "dialog",
-    "aria-label": "".concat(title)
+    "aria-label": title,
+    onKeyDown: handleKeyDownHandler
   }, /*#__PURE__*/React__default.createElement(Layer, null, /*#__PURE__*/React__default.createElement("h1", {
     className: "".concat(blockClass, "__item__title")
   }, title), /*#__PURE__*/React__default.createElement("div", {
-    ref: contentRef
-  }, open && children))));
+    className: "".concat(blockClass, "__popover-content")
+  }, renderChildren ? renderChildren(popoverRef) : children))));
 };
 ConditionBuilderItem.propTypes = {
   /**
@@ -134,10 +198,18 @@ ConditionBuilderItem.propTypes = {
    * text to be displayed in the field
    */
   label: PropTypes.oneOfType([PropTypes.string, PropTypes.array, PropTypes.object]),
+  /**
+   * callback to update the current condition of the state tree
+   */
+  onChange: PropTypes.func,
   /**
    * class name for popover
    */
   popOverClassName: PropTypes.string,
+  /**
+   * callback prop that returns the jsx for children
+   */
+  renderChildren: PropTypes.func,
   /**
    * Optional prop to allow overriding the icon rendering.
    */