@rkmodules/rules 0.0.78 → 0.0.80

package/dist/lib/DataTree/index.d.ts

@@ -45,7 +45,7 @@ export declare function getPaths<T>(tree: Tree<T>): string[];
  * @param fn
  * @returns
  */
-export declare function mapTree<T, U>(tree: Tree<T>, fn: (item: T, path: string, index: number) => U | U[]): Tree<U>;
+export declare function mapTree<T, U>(tree: Tree<T>, fn: (item: T, path: string, index: number) => U | U[] | typeof DISCARD): Tree<U>;
 export declare function mapTreeBranch<T, U>(tree: Tree<T>, fn: (branch: T[], path: string) => U[] | typeof DISCARD): Tree<U>;
 /**
  * n-ary operation on a tree, branch by branch
@@ -71,7 +71,7 @@ export declare function nAryOnTreeBranch<V>(trees: Tree<any>[], fn: (branches: (
  * @param fn
  * @returns
  */
-export declare function nAryOnTree<R>(trees: Tree<any>[], fn: (items: any[], paths: string[], index: number) => R | R[], fill?: boolean): Tree<R>;
+export declare function nAryOnTree<R>(trees: Tree<any>[], fn: (items: any[], paths: string[], index: number) => R | R[] | typeof DISCARD, fill?: boolean): Tree<R>;
 /**
  * binary operation on a tree, branch by branch
  * - branches are matched by index,
@@ -97,7 +97,7 @@ export declare function binaryOnTreeBranch<T, U, V>(treeA: Tree<T>, treeB: Tree<
  * @param fn
  * @returns
  */
-export declare function binaryOnTree<T, U, V>(treeA: Tree<T>, treeB: Tree<U>, fn: (itemA: T | undefined, itemB: U | undefined, pathA: string, pathB: string, index: number) => V | V[], fill?: boolean): Tree<V>;
+export declare function binaryOnTree<T, U, V>(treeA: Tree<T>, treeB: Tree<U>, fn: (itemA: T | undefined, itemB: U | undefined, pathA: string, pathB: string, index: number) => V | V[] | typeof DISCARD, fill?: boolean): Tree<V>;
 export declare function treeSize<T>(tree: Tree<T>): number;
 export declare function sameShape(a: Tree<any>, b: Tree<any>): boolean;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rkmodules/rules",
-    "version": "0.0.78",
+    "version": "0.0.80",
     "main": "dist/index.cjs.js",
     "module": "dist/index.esm.js",
     "types": "./dist/index.d.ts",

package/readme.md

@@ -45,7 +45,32 @@ We get back to function definitions later
 
 ## editor
 
-`<Flow>`
+-   Create an instance of the rules engine
+-   create a function to work with
+-   use the `<Flow>` component to create the editor
+
+```tsx
+const engine = new Engine({
+    // map of custom rules
+});
+
+const emptyFunction: GraphedFunction = {
+    name: "test",
+    body: {},
+    outputs: {
+        documents: "",
+    },
+};
+
+export default function MyComponent() {
+    const [fn, setFn] = React.useState(emptyFunction);
+    return (
+        <div>
+            <Flow function={fn} engine={engine} onChange={setFn} />
+        <div>
+    );
+}
+```
 
 TODO: