@flowerforce/flower-react 3.2.0 → 3.3.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 3.3.1 (2024-08-27)
+
+
+### 🩹 Fixes
+
+- rulesOperators example fixed ([f1def97](https://github.com/flowerforce/flower/commit/f1def97))
+
+
+### 🧱 Updated Dependencies
+
+- Updated flower-core to 3.2.1
+
+## 3.3.0 (2024-08-27)
+
+
+### 🚀 Features
+
+- added new utils to retrieve form status ([c1ac7ba](https://github.com/flowerforce/flower/commit/c1ac7ba))
+
+- added dirty default value ([02a5e28](https://github.com/flowerforce/flower/commit/02a5e28))
+
 ## 3.2.0 (2024-07-23)
 
 

package/dist/index.cjs.js

@@ -850,6 +850,7 @@ const component = React.memo(FlowerComponent);
  * - replaceData,
  * - reset,
  * - setCustomErrors
+ * - getFormStatus
  *
  * @param {string} flowName - first optional parameter
  *
@@ -872,13 +873,22 @@ const useFlowerForm = ({ flowName: customFlowName, name } = {}) => {
             ...newpath
         ]);
     }, [store, flowName]);
-    const setDataField = React.useCallback((id, val) => {
+    const getFormStatus = React.useCallback((path) => {
+        const { flowNameFromPath = flowName, path: newpath } = flowerCore.CoreUtils.getPath(path);
+        return _get(store.getState(), [
+            'flower',
+            flowNameFromPath,
+            'form',
+            ...newpath
+        ]);
+    }, [store, flowName]);
+    const setDataField = React.useCallback((id, val, dirty = true) => {
         const { flowNameFromPath = flowName } = flowerCore.CoreUtils.getPath(id);
         dispatch(actions.addDataByPath({
             flowName: flowNameFromPath,
             id,
             value: val,
-            dirty: true
+            dirty
         }));
         return;
     }, [flowName, dispatch]);
@@ -923,7 +933,8 @@ const useFlowerForm = ({ flowName: customFlowName, name } = {}) => {
         unsetData,
         replaceData,
         reset,
-        setCustomErrors
+        setCustomErrors,
+        getFormStatus
     };
 };
 

package/dist/index.esm.js

@@ -848,6 +848,7 @@ const component = memo(FlowerComponent);
  * - replaceData,
  * - reset,
  * - setCustomErrors
+ * - getFormStatus
  *
  * @param {string} flowName - first optional parameter
  *
@@ -870,13 +871,22 @@ const useFlowerForm = ({ flowName: customFlowName, name } = {}) => {
             ...newpath
         ]);
     }, [store, flowName]);
-    const setDataField = useCallback((id, val) => {
+    const getFormStatus = useCallback((path) => {
+        const { flowNameFromPath = flowName, path: newpath } = CoreUtils.getPath(path);
+        return _get(store.getState(), [
+            'flower',
+            flowNameFromPath,
+            'form',
+            ...newpath
+        ]);
+    }, [store, flowName]);
+    const setDataField = useCallback((id, val, dirty = true) => {
         const { flowNameFromPath = flowName } = CoreUtils.getPath(id);
         dispatch(actions.addDataByPath({
             flowName: flowNameFromPath,
             id,
             value: val,
-            dirty: true
+            dirty
         }));
         return;
     }, [flowName, dispatch]);
@@ -921,7 +931,8 @@ const useFlowerForm = ({ flowName: customFlowName, name } = {}) => {
         unsetData,
         replaceData,
         reset,
-        setCustomErrors
+        setCustomErrors,
+        getFormStatus
     };
 };
 

package/dist/src/components/types/FlowerField.d.ts

@@ -85,7 +85,7 @@ export type FlowerFieldProps<T extends Record<string, any> = Record<string, any>
     asyncWaitingError?: string;
     /** An object containing the display rules of that component. When the conditions are not satisfied, the children is hidden.
      *
-     * Example: rules={{ $and: [{ name: { $exist: true } }] }}
+     * Example: rules={{ $and: [{ name: { $exists: true } }] }}
      */
     rules?: RulesObject<T> | FunctionRule;
     /** The name of the flow from which read the data

package/dist/src/components/types/FlowerHooks.d.ts

@@ -15,6 +15,8 @@ export type UseFlowerForm = (options?: UseFlowerProps) => {
     isValid: boolean;
     /** This value is set to true during asynchronous validation.*/
     isValidating: boolean | undefined;
+    /** Use this function to read status from the flow's form. */
+    getFormStatus: (path?: string) => any;
     /** Use this function to read values from the flow's data. */
     getData: (path?: string) => any;
     /** Use this function to set values in the flow's data. */
@@ -22,13 +24,15 @@ export type UseFlowerForm = (options?: UseFlowerProps) => {
     /** The value that you want to set */
     value: any, 
     /** Specify the target path to set the value*/
-    path?: string) => void;
+    id?: string) => void;
     /** Use this function to set value in the flow's field data. */
     setDataField: (
     /** Specify the target path to set the value*/
-    path: string, 
+    id: string, 
     /** The value that you want to set */
-    value: any) => void;
+    value: any, 
+    /** Specify default value for dirty status*/
+    dirty?: boolean) => void;
     /** Use this function to unset values in the flow's data. */
     unsetData: (
     /** Specify the target path to the value tha you want to unset*/

package/dist/src/components/types/FlowerRule.d.ts

@@ -11,7 +11,7 @@ export type FlowerRuleProps = {
     value?: any;
     /** An object or function containing the display rules of that component. When the conditions are not satisfied, the children is hidden.
      *
-     * Example: rules={{ $and: [{ name: { $exist: true } }] }}
+     * Example: rules={{ $and: [{ name: { $exists: true } }] }}
      * Example: rules={(state) => state... === true}
      * if missing it is always visible
      */

package/dist/src/components/types/FlowerValue.d.ts

@@ -11,7 +11,7 @@ export type FlowerValueProps = {
     value?: any;
     /** An object containing the display rules of that component. When the conditions are not satisfied, the children is hidden.
      *
-     * Example: rules={{ $and: [{ name: { $exist: true } }] }}
+     * Example: rules={{ $and: [{ name: { $exists: true } }] }}
      */
     rules?: RulesObject<any> | FunctionRule;
     /** The FlowerValue's children  */

package/dist/src/components/useFlowerForm.d.ts

@@ -15,6 +15,7 @@ import { UseFlowerForm } from './types/FlowerHooks';
  * - replaceData,
  * - reset,
  * - setCustomErrors
+ * - getFormStatus
  *
  * @param {string} flowName - first optional parameter
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowerforce/flower-react",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "FlowerJS components, hooks and utils for React.",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@flowerforce/flower-core": "3.2.0",
+    "@flowerforce/flower-core": "3.2.1",
     "@reduxjs/toolkit": "^2.2.4",
     "lodash": "^4.17.21",
     "react-redux": "^9.1.2",