@carbon/ibm-products 2.43.2-canary.32 → 2.43.2-canary.321

package/lib/components/ConditionBuilder/ConditionBuilder.js

@@ -7,26 +7,19 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
 var React = require('react');
 var react = require('@carbon/react');
-var index = require('../../node_modules/prop-types/index.js');
+var index = require('../../_virtual/index.js');
 var cx = require('classnames');
 var devtools = require('../../global/js/utils/devtools.js');
 var ConditionBuilderContent = require('./ConditionBuilderContent/ConditionBuilderContent.js');
 var ConditionBuilderProvider = require('./ConditionBuilderContext/ConditionBuilderProvider.js');
 var settings = require('../../settings.js');
-var DataConfigs = require('./ConditionBuilderContext/DataConfigs.js');
 var handleKeyboardEvents = require('./utils/handleKeyboardEvents.js');
+var util = require('./utils/util.js');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
-
-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. */
@@ -53,30 +46,35 @@ var componentName = 'ConditionBuilder';
  * TODO: A description of the component.
  */
 
-exports.ConditionBuilder = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+exports.ConditionBuilder = /*#__PURE__*/React.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 ? util.NON_HIERARCHICAL_VARIANT : _ref$variant,
     actions = _ref.actions,
+    translateWithId = _ref.translateWithId,
     rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
-  var localRef = React.useRef();
+  var localRef = React.useRef(null);
   var conditionBuilderRef = ref || localRef;
   var handleKeyDownHandler = function handleKeyDownHandler(evt) {
-    handleKeyboardEvents.handleKeyDown(evt, conditionBuilderRef);
+    handleKeyboardEvents.handleKeyDown(evt, conditionBuilderRef, variant);
   };
-  return /*#__PURE__*/React__default["default"].createElement(ConditionBuilderProvider.ConditionBuilderProvider, {
+  return /*#__PURE__*/React.createElement(ConditionBuilderProvider.ConditionBuilderProvider, {
     inputConfig: inputConfig,
     popOverSearchThreshold: popOverSearchThreshold,
     getOptions: getOptions,
-    variant: variant
-  }, /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
-    className: cx__default["default"](DataConfigs.blockClass,
+    variant: variant,
+    translateWithId: translateWithId,
+    conditionBuilderRef: conditionBuilderRef
+  }, /*#__PURE__*/React.createElement("div", _rollupPluginBabelHelpers.extends({}, rest, {
+    className: cx(util.blockClass,
     // Apply the block class to the main HTML element
     className,
     // Apply any supplied class names to the main HTML element.
@@ -85,14 +83,12 @@ exports.ConditionBuilder = /*#__PURE__*/React__default["default"].forwardRef(fun
       // switched classes dependant on props or state
       // example: [`${blockClass}__here-if-small`]: size === 'sm',
     }),
-    role: "main",
     ref: conditionBuilderRef
-  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement(react.VStack, {
-    className: "".concat(DataConfigs.blockClass, "__").concat(variant),
+  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(react.VStack, {
+    className: "".concat(util.blockClass, "__").concat(variant),
     onKeyDown: handleKeyDownHandler
-  }, /*#__PURE__*/React__default["default"].createElement(ConditionBuilderContent["default"], {
+  }, /*#__PURE__*/React.createElement(ConditionBuilderContent.default, {
     startConditionLabel: startConditionLabel,
-    conditionBuilderRef: conditionBuilderRef,
     getConditionState: getConditionState,
     getActionsState: getActionsState,
     initialState: initialState,
@@ -114,22 +110,23 @@ exports.ConditionBuilder.propTypes = {
   /**
    * optional array of actions
    */
-  actions: index["default"].arrayOf(index["default"].shape({
-    id: index["default"].oneOfType([index["default"].string | index["default"].number]).isRequired,
-    label: index["default"].string.isRequired
+  /**@ts-ignore */
+  actions: index.default.arrayOf(index.default.shape({
+    id: index.default.oneOfType([index.default.string, index.default.number]).isRequired,
+    label: index.default.string.isRequired
   })),
   /**
    * Provide an optional class to be applied to the containing node.
    */
-  className: index["default"].string,
+  className: index.default.string,
   /**
    * This is a callback that gives back the updated action state
    */
-  getActionsState: index["default"].func,
+  getActionsState: index.default.func,
   /**
    * This is a callback that gives back updated condition state
    */
-  getConditionState: index["default"].func.isRequired,
+  getConditionState: index.default.func.isRequired,
   /**
    * This is a callback that get triggered when  you want to dynamically fetch options.
    *  Component call this when the option array is not passed against a property with type as option in the input config.
@@ -150,49 +147,55 @@ exports.ConditionBuilder.propTypes = {
   }
   };
    */
-  getOptions: index["default"].func,
+  getOptions: index.default.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
    */
-  initialState: index["default"].shape({
-    groups: index["default"].arrayOf(index["default"].shape({
-      groupOperator: index["default"].string.isRequired,
-      statement: index["default"].string.isRequired,
-      conditions: index["default"].arrayOf(index["default"].oneOfType([index["default"].shape({
-        property: index["default"].string.isRequired,
-        operator: index["default"].string.isRequired,
-        value: index["default"].oneOfType([index["default"].string, index["default"].arrayOf(index["default"].shape({
-          id: index["default"].string,
-          label: index["default"].string
-        })), index["default"].shape({
-          id: index["default"].string,
-          label: index["default"].string
-        })])
-      }), index["default"].object]))
-    })),
-    operator: index["default"].string
+  /**@ts-ignore */
+  initialState: index.default.shape({
+    state: index.default.shape({
+      groups: index.default.arrayOf(index.default.shape({
+        groupOperator: index.default.string,
+        statement: index.default.string,
+        conditions: index.default.arrayOf(index.default.oneOfType([index.default.shape({
+          property: index.default.string,
+          operator: index.default.string,
+          value: index.default.oneOfType([index.default.string, index.default.arrayOf(index.default.shape({
+            id: index.default.string,
+            label: index.default.string
+          })), index.default.shape({
+            id: index.default.string,
+            label: index.default.string
+          })])
+        }), index.default.object]))
+      })),
+      operator: index.default.string
+    }),
+    enabledDefault: index.default.bool
   }),
   /**
    * This is a mandatory prop that defines the input to the condition builder.
-   
-   */
-  inputConfig: index["default"].shape({
-    properties: index["default"].arrayOf(index["default"].shape({
-      id: index["default"].string.isRequired,
-      label: index["default"].string.isRequired,
-      icon: index["default"].oneOfType([index["default"].func, index["default"].object]),
-      type: index["default"].oneOf(['text', 'number', 'date', 'option', 'time', 'custom']).isRequired,
-      config: index["default"].shape({
-        options: index["default"].arrayOf(index["default"].shape({
-          id: index["default"].string.isRequired,
-          label: index["default"].string.isRequired,
-          icon: index["default"].oneOfType([index["default"].func, index["default"].object])
+    */
+  /**@ts-ignore */
+  inputConfig: index.default.shape({
+    properties: index.default.arrayOf(index.default.shape({
+      id: index.default.string.isRequired,
+      label: index.default.string.isRequired,
+      icon: index.default.oneOfType([index.default.func, index.default.object]),
+      type: index.default.oneOf(['text', 'textarea', 'number', 'date', 'option', 'time', 'custom']).isRequired,
+      config: index.default.shape({
+        options: index.default.arrayOf(index.default.shape({
+          id: index.default.string.isRequired,
+          label: index.default.string.isRequired,
+          icon: index.default.oneOfType([index.default.func, index.default.object])
         })),
-        component: index["default"].func,
-        operators: index["default"].arrayOf(index["default"].shape({
-          id: index["default"].string.isRequired,
-          label: index["default"].string.isRequired
+        component: index.default.func,
+        operators: index.default.arrayOf(index.default.shape({
+          id: index.default.string.isRequired,
+          label: index.default.string.isRequired
         }))
       })
     }))
@@ -200,14 +203,22 @@ exports.ConditionBuilder.propTypes = {
   /**
    * Provide an mandatory numeric value that will be used to enable search option in the popovers with list.
    */
-  popOverSearchThreshold: index["default"].number.isRequired,
+  popOverSearchThreshold: index.default.number.isRequired,
   /**
    * Provide a label to the button that starts condition builder
    */
-  startConditionLabel: index["default"].string.isRequired,
+  startConditionLabel: index.default.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: index.default.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: index["default"].string.isRequired
+  variant: index.default.oneOf(['Non-Hierarchical', 'Hierarchical'])
 };

package/lib/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 {};

package/lib/components/ConditionBuilder/ConditionBuilderActions/ConditionBuilderActions.d.ts

@@ -1,15 +1,30 @@
-export default ConditionBuilderActions;
-declare function ConditionBuilderActions({ actions, className }: {
-    actions: any;
-    className: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace ConditionBuilderActions {
-    namespace propTypes {
-        let actions: PropTypes.Requireable<(PropTypes.InferProps<{
-            id: PropTypes.Requireable<number>;
-            label: PropTypes.Requireable<string>;
-        }> | null | undefined)[]>;
-        let className: 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 from 'react';
 import PropTypes from 'prop-types';
+import { Action, Option } from '../ConditionBuilder.types';
+interface ConditionBuilderActionsProps {
+    actions: Action[] | Option[];
+    className?: string;
+}
+declare const ConditionBuilderActions: {
+    ({ actions, className, }: ConditionBuilderActionsProps): React.JSX.Element;
+    propTypes: {
+        /**
+         * optional array of object that give the list of actions.
+         */
+        actions: PropTypes.Requireable<(PropTypes.InferProps<{
+            id: PropTypes.Validator<NonNullable<NonNullable<string | number | null | undefined>>>;
+            label: PropTypes.Validator<string>;
+        }> | null | undefined)[]>;
+        /**
+         * Provide an optional class to be applied to the containing node.
+         */
+        className: PropTypes.Requireable<string>;
+    };
+};
+export default ConditionBuilderActions;