@rkmodules/rules 0.0.161 → 0.0.162

package/dist/lib/Engine/types.d.ts

@@ -30,7 +30,10 @@ export type RecOfTrees = Record<string, Tree<any>>;
 export type PrimitiveFunction = {
     name: string;
     label?: string;
-    nodeType?: string;
+    nodeType?: string | {
+        name: string;
+        props: Record<string, any>;
+    };
     description?: string;
     params?: Record<string, VarDef>;
     inputs?: Record<string, VarDef>;

package/dist/lib/Flow/types.d.ts

@@ -11,6 +11,7 @@ export type FunctionNode = Node<{
     outputDefs: Record<string, VarDef>;
     onChange: (newData: Partial<FunctionNode["data"]>) => void;
     onIOChange?: (callback: (fn: GraphedFunction) => Partial<GraphedFunction>) => void;
+    nodeProps?: Record<string, any>;
 }>;
 export type NodeDropItem = {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rkmodules/rules",
-    "version": "0.0.161",
+    "version": "0.0.162",
     "main": "dist/index.cjs.js",
     "module": "dist/index.esm.mjs",
     "types": "./dist/index.d.ts",
@@ -41,6 +41,7 @@
         "react-dom": ">=17.0.1"
     },
     "dependencies": {
+        "@rkmodules/stringtemplate": "^0.1.3",
         "@rkmodules/use-inner": "^1.0.3",
         "@xyflow/react": "^12.8.3",
         "classnames": "^2.5.1",

package/readme.md

@@ -142,6 +142,110 @@ custom contols can be passed into the `<Flow>` component with the `customControl
 />
 ```
 
+# custom nodes
+
+alternatively, the entire node can be customized. There are the following standard nodes `Default`, `Calc`, and
+
+- `Default`: the default node
+- `Calc`: specialized node for the Calc function that renders the expression and creates input ports based on variables in the expression
+- `DynamicInput`: creates additional input ports, useful for allowing a dynamic number of inputs
+- `DynamicOutput`: creates output ports on the fly based on the function result
+- `NamedInput`: allows adding and renaming input ports by the user
+- `Input` and `Output`: used for rule input and output
+
+# Components / functions reference
+
+## List
+
+- List Input: creates a list of strings or numbers based on textfield input
+- List Item: selects items from a list based on their indices
+- List Length: returns the length of a list
+- Relative Item
+- Relative Items
+- Unique Items: removes duplicates from a list
+
+## Logic
+
+- And: returns true if both inputs are true
+- Or: returns true if one or both of the inputs are true
+- Not: negates all elements in the list
+- Group And: returns true if all elements in the list are true
+- Group Or: returns true if some elements in the list are true
+- Group stats: returns min, max, avg, std, sum and count of a list of numbers
+
+## Math
+
+- Add
+- Subtract
+- Multiply
+- Divide
+- Modulo
+- Pow
+- Sqrt
+- Round
+- Floor
+- Ceil
+- Sin
+- Cos
+- Tan
+- Sum
+- Less Than
+- Greater Than
+
+## String
+
+- Join Strings
+- String Equal To
+- String Template
+- To String
+
+## Date
+
+- Duration
+- Format Date
+- Iso Date
+- Parse Date
+- Today
+
+## Util
+
+- Get Type
+- Get Value
+- Log
+- Value
+
+## Sequence
+
+- Series
+
+## JSON
+
+- Array To List
+- Destructure Object
+- Explode Object
+- List To Array
+- Merge Object
+- Object
+- Entries
+- Set Field
+
+## Group
+
+- Cartesian Groups
+- Filter Tree
+- Group All
+- Merge Group
+- Merge Tree
+- Normalize Tree
+- SimplifyTree
+- Split Group
+- Tree Item
+
+## IO
+
+- Input
+- Output
+
 TODO:
 
 - [ ] filtering of lists
@@ -153,20 +257,6 @@ TODO:
     - running flag
     - intermediate results
 
-Components / functions
-
-List
-
-- [x] listItem
-- [x] listLength
-- [x] graftTree
-- [x] trimTree
-
-Math
-
-- [x] lessThan
-- [x] greaterThan
-
 Text
 
 - formatting