@rkmodules/rules 0.0.1 → 0.0.3

package/dist/lib/Flow/Nodes/Calc.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { NodeProps } from "@xyflow/react";
 import { FunctionNode } from "../types";
-import "katex/dist/katex.min.css";
+import "../style/katex.min.css";
 type MathProps = {
     expr: string;
     displayMode?: boolean;

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

@@ -3,7 +3,7 @@ import { GraphedFunction } from "../Engine/types";
 import React from "react";
 import { Engine } from "../Engine";
 import { FunctionNode } from "./types";
-import "@xyflow/react/dist/style.css";
+import "./style/xyflow.css";
 export * from "./types";
 export type PositionData = Record<string, {
     x: number;

package/package.json

@@ -1,10 +1,14 @@
 {
     "name": "@rkmodules/rules",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "main": "dist/index.js",
     "types": "./dist/index.d.ts",
     "files": [
-        "dist"
+        "dist/index.js",
+        "dist/index.js.map",
+        "dist/index.d.ts",
+        "dist/index.css",
+        "dist/lib"
     ],
     "exports": {
         ".": "./dist/index.js",

package/readme.md

@@ -1,3 +1,52 @@
+# Usage
+
+`npm install @rkmodules/rules`
+
+## Engine
+
+An engine creates a namespace for functions, so create an engine to start with:
+
+`const engine = new Engine()`
+
+## Specifying a function
+
+A function definition is just a json object. It can be assembled together via code or just hardcoded. It is of type `GraphedFunction` and at least has to have a `name` and `body` field. The latter defines a graph with calls to primitives or other graphed functions:
+
+```ts
+const testFunction: GraphedFunction = {
+    name: "test",
+    body: {
+        myVal: {
+            name: "value",
+            params: {
+                type: "string"
+            },
+        }
+        myLog: {
+            name: "log",
+            inputs: {
+                data: "<myVal.value>"
+            }
+        }
+    }
+};
+```
+
+We get back to function definitions later
+
+## Running the function
+
+-   build all the custom functions
+-   run the one you need
+
+## use in react
+
+`useFunction`
+
+## editor
+
+`<Flow>`
+
 TODO:
 
 -   [ ] filtering of lists

package/dist/app/editor/calcTestFunction.d.ts

@@ -1,2 +0,0 @@
-import { GraphedFunction } from "../../lib/Engine";
-export declare const calcTest: GraphedFunction;

package/dist/app/editor/page.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export default function Index(): React.JSX.Element;

package/dist/app/finance/entriesTestFunction.d.ts

@@ -1,2 +0,0 @@
-import { GraphedFunction } from "../../lib/Engine";
-export declare const entriesTest: GraphedFunction;

package/dist/app/finance/page.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export default function Index(): React.JSX.Element;

package/dist/app/finance/testEntries.d.ts

@@ -1,40 +0,0 @@
-export declare const EntryA: {
-    name: string;
-    description: string;
-    lines: {
-        db: string;
-        cr: string;
-        amt: number;
-    }[];
-    toString: () => string;
-};
-export declare const EntryB: {
-    name: string;
-    description: string;
-    lines: {
-        db: string;
-        cr: string;
-        amt: number;
-    }[];
-    toString: () => string;
-};
-export declare const EntryC: {
-    name: string;
-    description: string;
-    lines: {
-        db: string;
-        cr: string;
-        amt: number;
-    }[];
-    toString: () => string;
-};
-export declare const entries: {
-    name: string;
-    description: string;
-    lines: {
-        db: string;
-        cr: string;
-        amt: number;
-    }[];
-    toString: () => string;
-}[];

package/dist/app/layout.d.ts

@@ -1,9 +0,0 @@
-import React from "react";
-import "./global.css";
-export declare const metadata: {
-    title: string;
-    description: string;
-};
-export default function RootLayout({ children, }: {
-    children: React.ReactNode;
-}): React.JSX.Element;

package/dist/app/page.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export default function Index(): React.JSX.Element;

package/dist/app/supalipu/page.d.ts

@@ -1,13 +0,0 @@
-import React from "react";
-import { GraphedFunction } from "../../lib/Engine";
-interface PropObject<P = any> {
-    _id: string;
-    type: string;
-    props: P;
-    onChange?: string;
-}
-type Function = PropObject<GraphedFunction>;
-/** propobject for the change handler */
-export declare const handleChange: Function;
-export default function Index(): React.JSX.Element;
-export {};