@rkmodules/rules 0.0.79 → 0.0.81

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

@@ -34,7 +34,8 @@ export declare class Engine {
     private listeners;
     private cache;
     private cacheMiss;
-    constructor(morePrimitives?: Record<string, PrimitiveFunction>);
+    env: Record<string, any>;
+    constructor(morePrimitives?: Record<string, PrimitiveFunction>, env?: Record<string, any>);
     private checkCache;
     private runGraph;
     /**

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

@@ -1,3 +1,4 @@
+import { Engine } from ".";
 import { Tree } from "../DataTree";
 /**
  * type definition of rule inputs and outputs
@@ -32,7 +33,7 @@ export type PrimitiveFunction = {
     params?: Record<string, VarDef>;
     inputs?: Record<string, VarDef>;
     outputs?: Record<string, VarDef>;
-    impl: (inputs: RecOfTrees, params: Record<string, any>) => Promise<RecOfTrees>;
+    impl: (inputs: RecOfTrees, params: Record<string, any>, engine: Engine) => Promise<RecOfTrees>;
     mount?: (trigger: () => void) => (() => void) | void;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rkmodules/rules",
-    "version": "0.0.79",
+    "version": "0.0.81",
     "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: