@flowerforce/flower-react 3.1.2-beta.9 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+## 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)
+
+
+### 🚀 Features
+
+- expose start node id from hook useFlower ([77223f7](https://github.com/flowerforce/flower/commit/77223f7))
+
+- remove remote key in devtool ([f89abdc](https://github.com/flowerforce/flower/commit/f89abdc))
+
+- Added the function to reset a form at a specific step or current step ([b17780f](https://github.com/flowerforce/flower/commit/b17780f))
+
+- added custom errors ([c09a23a](https://github.com/flowerforce/flower/commit/c09a23a))
+
+- **devtool:** add sourcemap preview ([7882290](https://github.com/flowerforce/flower/commit/7882290))
+
+- **Form:** add submitted status in form node ([fd2d69f](https://github.com/flowerforce/flower/commit/fd2d69f))
+
+- **Form:** add setDataField to chag ([935d8a5](https://github.com/flowerforce/flower/commit/935d8a5))
+
+
+### 🩹 Fixes
+
+- remove global.window object ([81a10c5](https://github.com/flowerforce/flower/commit/81a10c5))
+
+- restore documentation comments into d.ts ([d5677d9](https://github.com/flowerforce/flower/commit/d5677d9))
+
+
+### 🧱 Updated Dependencies
+
+- Updated flower-core to 3.2.0
+
 ## 3.1.1 (2024-06-11)
 
 

package/LICENSE

@@ -1,15 +1,21 @@
-ISC License
+MIT License
 
 Copyright (c) 2024 FlowerForce
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/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/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.1.2-beta.9",
+  "version": "3.3.0",
   "description": "FlowerJS components, hooks and utils for React.",
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
   "scripts": {
     "tsc:noemit": "tsc -p tsconfig.lib.json --noEmit"
   },
-  "license": "ISC",
+  "license": "MIT",
   "peerDependencies": {
     "react": ">=18"
   },
@@ -34,7 +34,7 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@flowerforce/flower-core": "3.1.2-beta.9",
+    "@flowerforce/flower-core": "3.2.0",
     "@reduxjs/toolkit": "^2.2.4",
     "lodash": "^4.17.21",
     "react-redux": "^9.1.2",