@carbon/ibm-products 2.43.2-canary.233 → 2.43.2-canary.234

package/es/components/ConditionBuilder/ConditionBuilder.js

@@ -47,7 +47,8 @@ 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,
@@ -146,27 +147,32 @@ 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,
-      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
+    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.
@@ -199,7 +205,7 @@ 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.

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

@@ -122,17 +122,21 @@ export type Action = {
 export type variantsType = 'Non-Hierarchical' | 'Hierarchical';
 export type ConditionBuilderProps = {
     inputConfig: inputConfig;
-    initialState?: ConditionBuilderState;
+    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;
+    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;

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

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import PropTypes from 'prop-types';
-import { Action, ConditionBuilderState } from '../ConditionBuilder.types';
+import { Action, ConditionBuilderState, InitialState } from '../ConditionBuilder.types';
 interface ConditionBuilderContentProps {
     startConditionLabel: string;
     getConditionState: (state: ConditionBuilderState) => void;
     getActionsState?: (state: Action[]) => void;
-    initialState?: ConditionBuilderState;
+    initialState?: InitialState;
     actions?: Action[];
 }
 declare const ConditionBuilderContent: {
@@ -35,12 +35,15 @@ declare const ConditionBuilderContent: {
          * Optional prop if the condition building need to start from a predefined initial state
          */
         initialState: PropTypes.Requireable<PropTypes.InferProps<{
-            groups: PropTypes.Requireable<(PropTypes.InferProps<{
-                groupOperator: PropTypes.Requireable<string>;
-                statement: PropTypes.Requireable<string>;
-                conditions: PropTypes.Requireable<(object | null | undefined)[]>;
-            }> | null | undefined)[]>;
-            operator: PropTypes.Requireable<string>;
+            state: PropTypes.Requireable<PropTypes.InferProps<{
+                groups: PropTypes.Requireable<(PropTypes.InferProps<{
+                    groupOperator: PropTypes.Requireable<string>;
+                    statement: PropTypes.Requireable<string>;
+                    conditions: PropTypes.Requireable<(object | null | undefined)[]>;
+                }> | null | undefined)[]>;
+                operator: PropTypes.Requireable<string>;
+            }>>;
+            enabledDefault: PropTypes.Requireable<boolean>;
         }>>;
         startConditionLabel: PropTypes.Validator<string>;
     };

package/es/components/ConditionBuilder/ConditionBuilderContent/ConditionBuilderContent.js

@@ -6,7 +6,7 @@
  */
 
 import { slicedToArray as _slicedToArray, objectSpread2 as _objectSpread2, toConsumableArray as _toConsumableArray } from '../../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default, { useContext, useState, useEffect, useCallback } from 'react';
+import React__default, { useContext, useRef, useState, useEffect, useCallback } from 'react';
 import PropTypes from '../../../node_modules/prop-types/index.js';
 import { Button, Section, Heading } from '@carbon/react';
 import { Add, TextNewLine } from '@carbon/react/icons';
@@ -33,6 +33,7 @@ var ConditionBuilderContent = function ConditionBuilderContent(_ref) {
     setRootState = _useContext.setRootState,
     variant = _useContext.variant,
     actionState = _useContext.actionState;
+  var initialConditionState = useRef(initialState !== null && initialState !== void 0 && initialState.state ? JSON.parse(JSON.stringify(initialState === null || initialState === void 0 ? void 0 : initialState.state)) : null);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     isConditionBuilderActive = _useState2[0],
@@ -69,10 +70,24 @@ var ConditionBuilderContent = function ConditionBuilderContent(_ref) {
     getActionsState === null || getActionsState === void 0 || getActionsState(actionState !== null && actionState !== void 0 ? actionState : []);
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [actionState]);
+  useEffect(function () {
+    if (initialState !== null && initialState !== void 0 && initialState.enabledDefault) {
+      setRootState === null || setRootState === void 0 || setRootState(initialConditionState.current);
+      initialConditionState.current = null;
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [initialState]);
   var onStartConditionBuilder = function onStartConditionBuilder() {
+    var _initialConditionStat;
     //when add condition button is clicked.
     setIsConditionBuilderActive(true);
-    setRootState === null || setRootState === void 0 || setRootState(initialState !== null && initialState !== void 0 ? initialState : emptyState); //here we can set an empty skeleton object for an empty condition builder,
+    if (initialConditionState !== null && initialConditionState !== void 0 && (_initialConditionStat = initialConditionState.current) !== null && _initialConditionStat !== void 0 && (_initialConditionStat = _initialConditionStat.groups) !== null && _initialConditionStat !== void 0 && _initialConditionStat.length) {
+      setRootState === null || setRootState === void 0 || setRootState(initialConditionState.current);
+      initialConditionState.current = null;
+    } else {
+      setRootState === null || setRootState === void 0 || setRootState(emptyState); //here we can set an empty skeleton object for an empty condition builder,
+    }
+
     //or we can even pre-populate some existing builder and continue editing
   };
   var _onRemove = useCallback(function (groupId) {
@@ -208,22 +223,25 @@ ConditionBuilderContent.propTypes = {
    * Optional prop if the condition building need to start from a predefined initial state
    */
   initialState: 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
+    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
   }),
   /* Provide a label to the button that starts condition builder
    */

package/lib/components/ConditionBuilder/ConditionBuilder.js

@@ -56,7 +56,8 @@ var componentName = 'ConditionBuilder';
 exports.ConditionBuilder = /*#__PURE__*/React__default["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,
@@ -155,27 +156,32 @@ exports.ConditionBuilder.propTypes = {
    */
   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
    */
   /**@ts-ignore */
   initialState: 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
+    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.
@@ -208,7 +214,7 @@ exports.ConditionBuilder.propTypes = {
   /**
    * 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.

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

@@ -122,17 +122,21 @@ export type Action = {
 export type variantsType = 'Non-Hierarchical' | 'Hierarchical';
 export type ConditionBuilderProps = {
     inputConfig: inputConfig;
-    initialState?: ConditionBuilderState;
+    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;
+    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;

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

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import PropTypes from 'prop-types';
-import { Action, ConditionBuilderState } from '../ConditionBuilder.types';
+import { Action, ConditionBuilderState, InitialState } from '../ConditionBuilder.types';
 interface ConditionBuilderContentProps {
     startConditionLabel: string;
     getConditionState: (state: ConditionBuilderState) => void;
     getActionsState?: (state: Action[]) => void;
-    initialState?: ConditionBuilderState;
+    initialState?: InitialState;
     actions?: Action[];
 }
 declare const ConditionBuilderContent: {
@@ -35,12 +35,15 @@ declare const ConditionBuilderContent: {
          * Optional prop if the condition building need to start from a predefined initial state
          */
         initialState: PropTypes.Requireable<PropTypes.InferProps<{
-            groups: PropTypes.Requireable<(PropTypes.InferProps<{
-                groupOperator: PropTypes.Requireable<string>;
-                statement: PropTypes.Requireable<string>;
-                conditions: PropTypes.Requireable<(object | null | undefined)[]>;
-            }> | null | undefined)[]>;
-            operator: PropTypes.Requireable<string>;
+            state: PropTypes.Requireable<PropTypes.InferProps<{
+                groups: PropTypes.Requireable<(PropTypes.InferProps<{
+                    groupOperator: PropTypes.Requireable<string>;
+                    statement: PropTypes.Requireable<string>;
+                    conditions: PropTypes.Requireable<(object | null | undefined)[]>;
+                }> | null | undefined)[]>;
+                operator: PropTypes.Requireable<string>;
+            }>>;
+            enabledDefault: PropTypes.Requireable<boolean>;
         }>>;
         startConditionLabel: PropTypes.Validator<string>;
     };

package/lib/components/ConditionBuilder/ConditionBuilderContent/ConditionBuilderContent.js

@@ -41,6 +41,7 @@ var ConditionBuilderContent = function ConditionBuilderContent(_ref) {
     setRootState = _useContext.setRootState,
     variant = _useContext.variant,
     actionState = _useContext.actionState;
+  var initialConditionState = React.useRef(initialState !== null && initialState !== void 0 && initialState.state ? JSON.parse(JSON.stringify(initialState === null || initialState === void 0 ? void 0 : initialState.state)) : null);
   var _useState = React.useState(false),
     _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
     isConditionBuilderActive = _useState2[0],
@@ -77,10 +78,24 @@ var ConditionBuilderContent = function ConditionBuilderContent(_ref) {
     getActionsState === null || getActionsState === void 0 || getActionsState(actionState !== null && actionState !== void 0 ? actionState : []);
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [actionState]);
+  React.useEffect(function () {
+    if (initialState !== null && initialState !== void 0 && initialState.enabledDefault) {
+      setRootState === null || setRootState === void 0 || setRootState(initialConditionState.current);
+      initialConditionState.current = null;
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [initialState]);
   var onStartConditionBuilder = function onStartConditionBuilder() {
+    var _initialConditionStat;
     //when add condition button is clicked.
     setIsConditionBuilderActive(true);
-    setRootState === null || setRootState === void 0 || setRootState(initialState !== null && initialState !== void 0 ? initialState : ConditionBuilderProvider.emptyState); //here we can set an empty skeleton object for an empty condition builder,
+    if (initialConditionState !== null && initialConditionState !== void 0 && (_initialConditionStat = initialConditionState.current) !== null && _initialConditionStat !== void 0 && (_initialConditionStat = _initialConditionStat.groups) !== null && _initialConditionStat !== void 0 && _initialConditionStat.length) {
+      setRootState === null || setRootState === void 0 || setRootState(initialConditionState.current);
+      initialConditionState.current = null;
+    } else {
+      setRootState === null || setRootState === void 0 || setRootState(ConditionBuilderProvider.emptyState); //here we can set an empty skeleton object for an empty condition builder,
+    }
+
     //or we can even pre-populate some existing builder and continue editing
   };
   var _onRemove = React.useCallback(function (groupId) {
@@ -216,22 +231,25 @@ ConditionBuilderContent.propTypes = {
    * Optional prop if the condition building need to start from a predefined initial state
    */
   initialState: 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
+    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
   }),
   /* Provide a label to the button that starts condition builder
    */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/ibm-products",
   "description": "Carbon for IBM Products",
-  "version": "2.43.2-canary.233+11c1554ba",
+  "version": "2.43.2-canary.234+3b2b91c63",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -120,5 +120,5 @@
     "react": "^16.8.6 || ^17.0.1 || ^18.2.0",
     "react-dom": "^16.8.6 || ^17.0.1 || ^18.2.0"
   },
-  "gitHead": "11c1554ba92037f559862ad9c83cfdf048074659"
+  "gitHead": "3b2b91c63157d748425c1fa85ed70411e2c7e018"
 }