@flowerforce/flower-react 3.1.1-beta.1 → 3.1.2-beta.0

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

@@ -1,11 +1,34 @@
 import { FunctionRule, RulesObject } from '@flowerforce/flower-core';
 export type FlowerRuleProps = {
+    /** The path to the value you want to read from the flow's data
+     *
+     * Example: id="loginForm.name"
+     *
+     * The FlowerRule component reads the value of the key "name" of the loginForm object in the flow's data
+     */
     id?: string;
+    /** */
     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={(state) => state... === true}
+     * if missing it is always visible
+     */
     rules?: RulesObject<any> | FunctionRule;
+    /** The name of the flow from which read the data
+     *
+     * - note: the default value is the name of the flow where the component is used
+     */
     flowName?: string;
+    /** When set to true, the children is shown even if the rules are not satisfied
+     *
+     * The FlowerRule returns the boolean variable "hidden" to notify you if the conditions are satisfied or not
+     */
     alwaysDisplay?: boolean;
+    /** The function executed when the value found at the path passed to the "id" prop changes */
     onUpdate?: (hidden: boolean) => void;
+    /** The children of the FlowerRule*/
     children?: React.ReactNode | ((props: {
         hidden?: boolean;
     }) => React.ReactNode | React.ReactElement | undefined);

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

@@ -1,7 +1,9 @@
 import { FlowerNodeProps } from './FlowerNode';
 export type FlowerServerProps = {
     action?: {
+        /** The type of the action */
         type: string;
+        /** The parameters passed to the action */
         props?: Record<string, any>;
     };
 } & FlowerNodeProps;

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

@@ -1,11 +1,33 @@
 import { FunctionRule, RulesObject } from '@flowerforce/flower-core';
 export type FlowerValueProps = {
+    /** The path to the value you want to read from the flow's data
+     *
+     * Example: id="loginForm.name"
+     *
+     * The FlowerValue component reads the value of the key "name" of the loginForm object in the flow's data
+     * If missing, I return all values, which is equivalent to setting id='*'
+     */
     id?: string;
     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 } }] }}
+     */
     rules?: RulesObject<any> | FunctionRule;
+    /** The FlowerValue's children  */
     children: React.ReactNode | ((props: Record<string, any>) => React.ReactNode | React.ReactElement | undefined);
+    /** Set this value to true to spread the value into separate values in case it is an object. */
     spreadValue?: boolean;
+    /** The name of the flow from which read the data
+     *
+     * - note: the default value is the name of the flow where the component is used
+     */
     flowName?: string;
+    /** When set to true, the children is shown even if the rules are not satisfied
+     *
+     * The FlowerValue returns the boolean variable "hidden" to notify you if the conditions are satisfied or not
+     */
     alwaysDisplay?: boolean;
+    /** The function executed when the value found at the path passed to the "id" prop changes */
     onUpdate?: (value: any) => void;
 };

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

@@ -1,3 +1,21 @@
 import { UseFlower } from './types/FlowerHooks';
+/** This hook allows you to read flow informations, such as the flowName and ID of the current node.
+ *
+ * It also exposes all the functions to navigate within the flow:
+ *
+ * - next
+ *
+ * - back
+ *
+ * - jump
+ *
+ * - reset
+ *
+ * - restart
+ *
+ * @param {string} flowName - first optional parameter
+ *
+ * @param {string} name - optional parameter, if flowName exist, name is not used
+ */
 declare const useFlower: UseFlower;
 export default useFlower;

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

@@ -1,3 +1,20 @@
 import { UseFlowerForm } from './types/FlowerHooks';
+/**  This hook allows you to manage and retrieve information about Forms.
+ *
+ * It exposes details regarding the form's state and a set of methods for reading and writing within it:
+ *
+ * - getData
+ *
+ * - setData
+ *
+ * - unSetData
+ *
+ * - replaceData
+ *
+ * @param {string} flowName - first optional parameter
+ *
+ * @param {string} name - optional parameter, if flowName exist, name is not used
+ *
+ */
 declare const useFlowerForm: UseFlowerForm;
 export default useFlowerForm;

package/dist/src/provider.d.ts

@@ -1,4 +1,4 @@
-import React, { PropsWithChildren, Component } from 'react';
+import React, { PropsWithChildren, PureComponent } from 'react';
 import { Action } from '@reduxjs/toolkit';
 import { FlowerProviderProps } from './components/types/FlowerProvider';
 export declare const useDispatch: import("react-redux").UseDispatch<import("redux").Dispatch<Action>>;
@@ -13,11 +13,13 @@ export declare const store: ({ enableDevtool }: {
         flower: Record<string, import("packages/flower-core/dist/src").Flower<Record<string, any>>>;
     }, undefined, import("redux").UnknownAction>;
 }>, import("redux").StoreEnhancer]>>;
-declare class FlowerProvider extends Component<PropsWithChildren, FlowerProviderProps> {
+declare class FlowerProvider extends PureComponent<PropsWithChildren<{
+    enableReduxDevtool?: boolean;
+}>, FlowerProviderProps> {
     private store;
-    constructor(props: PropsWithChildren & {
-        enableDevtool?: boolean;
-    });
+    constructor(props: PropsWithChildren<{
+        enableReduxDevtool?: boolean;
+    }>);
     render(): React.JSX.Element;
 }
 export default FlowerProvider;

package/package.json

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