treege 0.11.1 → 0.11.2

package/dist/src/utils/array/index.d.ts

@@ -1 +1,3 @@
-export * from "./isUniqueArrayItem/isUniqueArrayItem";
+import isUniqueArrayItem from "./isUniqueArrayItem/isUniqueArrayItem";
+import isUniqueArrayItemWithNewEntry from "./isUniqueArrayItemWithNewEntry/isUniqueArrayItemWithNewEntry";
+export { isUniqueArrayItem, isUniqueArrayItemWithNewEntry };

package/dist/src/utils/array/isUniqueArrayItem/isUniqueArrayItem.d.ts

@@ -1,2 +1,6 @@
-export declare const isUniqueArrayItem: (array: string[]) => boolean;
-export declare const isUniqueArrayItemWithNewEntry: (array: string[], entry: string, excludeEntry?: string | false | undefined) => boolean;
+/**
+ * Check if array items are unique
+ * @param array
+ */
+declare const isUniqueArrayItem: (array: string[]) => boolean;
+export default isUniqueArrayItem;

package/dist/src/utils/array/isUniqueArrayItemWithNewEntry/isUniqueArrayItemWithNewEntry.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Check if the array item is unique with a new entry
+ * @param array
+ * @param entry
+ * @param excludeEntry
+ */
+declare const isUniqueArrayItemWithNewEntry: (array: string[], entry: string, excludeEntry?: string | false | undefined) => boolean;
+export default isUniqueArrayItemWithNewEntry;

package/dist/src/utils/object/removeObjectProperty/removeObjectProperty.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Removes a property from an object
+ * @param obj
+ * @param propToRemove
+ */
 export declare const removeObjectProperty: (obj: any, propToRemove: string) => Pick<any, string | number | symbol>;
 export default removeObjectProperty;

package/dist/src/utils/tree/appendNode/appendNode.d.ts

@@ -5,6 +5,13 @@ interface AppendChildParams {
     name: string;
     child: TreeNode;
 }
+/**
+ * Append child to tree
+ * @param tree
+ * @param path
+ * @param name
+ * @param child
+ */
 declare const appendNode: ({ tree, path, name, child }: AppendChildParams) => TreeNode | {
     attributes: {
         isLeaf: boolean;
@@ -44,7 +51,13 @@ declare const appendNode: ({ tree, path, name, child }: AppendChildParams) => Tr
         tree?: undefined;
         treePath?: undefined;
         repeatable?: undefined;
-        hiddenValue?: undefined;
+        hiddenValue?: undefined; /**
+         * Append child to tree
+         * @param tree
+         * @param path
+         * @param name
+         * @param child
+         */
     };
     name: string;
     children: TreeNode[];

package/dist/src/utils/tree/findNodeByNameInTree/findNodeByNameInTree.d.ts

@@ -0,0 +1,8 @@
+import type { TreeNode } from '../../../features/Treege/type/TreeNode';
+/**
+ * Get node by name in current tree
+ * @param node
+ * @param name
+ */
+declare const findNodeByNameInTree: (node: TreeNode | null, name: string) => TreeNode | null;
+export default findNodeByNameInTree;

package/dist/src/utils/tree/findParentNodeByNameInTree/findParentNodeByNameInTree.d.ts

@@ -0,0 +1,9 @@
+import type { TreeNode } from '../../../features/Treege/type/TreeNode';
+/**
+ * Get parent node by name in current tree
+ * @param node
+ * @param name
+ * @param parentNode
+ */
+declare const findParentNodeByNameInTree: (node: TreeNode | null, name: string, parentNode?: TreeNode | null) => TreeNode | null;
+export default findParentNodeByNameInTree;

package/dist/src/utils/tree/getNode/getNode.d.ts

@@ -1,3 +1,9 @@
 import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-declare const getNode: (tree: TreeNode, path: string | null, name: string) => TreeNode | null;
+/**
+ * Get node
+ * @param node
+ * @param path
+ * @param name
+ */
+declare const getNode: (node: TreeNode, path: string | null, name: string) => TreeNode | null;
 export default getNode;

package/dist/src/utils/tree/getNodeNames/getNodeNames.d.ts

@@ -1,3 +1,7 @@
 import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-declare const getNodeNames: (tree: TreeNode | null, attributeAccumulator?: string[]) => string[];
+/**
+ * Get node names from tree
+ * @param tree
+ */
+declare const getNodeNames: (tree: TreeNode | null) => string[];
 export default getNodeNames;

package/dist/src/utils/tree/getTree/getTree.d.ts

@@ -1,3 +1,8 @@
 import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-declare const getTree: (element: TreeNode | undefined, searchPath?: string | null) => TreeNode | null;
+/**
+ * Get a tree node by search path within the hierarchy
+ * @param node The starting element
+ * @param searchPath The path to search for
+ */
+declare const getTree: (node: TreeNode | undefined, searchPath?: string | null) => TreeNode | null;
 export default getTree;

package/dist/src/utils/tree/index.d.ts

@@ -1,9 +1,9 @@
 import appendNode from "./appendNode/appendNode";
 import getNode from "./getNode/getNode";
-import getNodeByNameInCurrentTree from "./getNodeByNameInCurrentTree/getNodeByNameInCurrentTree";
 import getNodeNames from "./getNodeNames/getNodeNames";
-import getParentNodeByNameInCurrentTree from "./getParentNodeByNameInCurrentTree/getParentNodeByNameInCurrentTree";
 import getTree from "./getTree/getTree";
 import removeNode from "./removeNode/removeNode";
-import updatedNode from "./updatedNode/updatedNode";
-export { getTree, updatedNode, appendNode, removeNode, getParentNodeByNameInCurrentTree, getNodeByNameInCurrentTree, getNodeNames, getNode, };
+import findNodeByNameInTree from '../../utils/tree/findNodeByNameInTree/findNodeByNameInTree';
+import findParentNodeByNameInTree from '../../utils/tree/findParentNodeByNameInTree/findParentNodeByNameInTree';
+import updateNodeInTree from '../../utils/tree/updateNodeInTree/updateNodeInTree';
+export { getTree, updateNodeInTree, appendNode, removeNode, findParentNodeByNameInTree, findNodeByNameInTree, getNodeNames, getNode };

package/dist/src/utils/tree/removeNode/removeNode.d.ts

@@ -4,5 +4,11 @@ interface RemoveNodeParams {
     path: string;
     name: string;
 }
+/**
+ * Remove node from tree
+ * @param tree
+ * @param path
+ * @param name
+ */
 declare const removeNode: ({ tree, path, name }: RemoveNodeParams) => TreeNode;
 export default removeNode;

package/dist/src/utils/tree/updateNodeInTree/test/updateNodeInTree.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/utils/tree/updateNodeInTree/updateNodeInTree.d.ts

@@ -0,0 +1,16 @@
+import type { TreeNode } from '../../../features/Treege/type/TreeNode';
+interface UpdatedNodeParams {
+    tree: TreeNode;
+    path: string;
+    name: string;
+    child: TreeNode;
+}
+/**
+ * Update node in tree
+ * @param tree
+ * @param path
+ * @param name
+ * @param child
+ */
+declare const updateNodeInTree: ({ tree, path, name, child }: UpdatedNodeParams) => TreeNode;
+export default updateNodeInTree;

package/package.json

@@ -2,7 +2,7 @@
   "name": "treege",
   "description": "Form decision tree generator",
   "license": "ISC",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "type": "module",
   "types": "./dist/main.d.ts",
   "main": "./dist/main.umd.cjs",

package/dist/src/utils/tree/getNodeByNameInCurrentTree/getNodeByNameInCurrentTree.d.ts

@@ -1,3 +0,0 @@
-import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-declare const getNodeByNameInCurrentTree: (tree: TreeNode | null, name: string) => TreeNode | null;
-export default getNodeByNameInCurrentTree;

package/dist/src/utils/tree/getParentNodeByNameInCurrentTree/getParentNodeByNameInCurrentTree.d.ts

@@ -1,3 +0,0 @@
-import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-declare const getParentNodeByNameInCurrentTree: (tree: TreeNode | null, name: string, parentNode?: TreeNode | null) => TreeNode | null;
-export default getParentNodeByNameInCurrentTree;

package/dist/src/utils/tree/updatedNode/updatedNode.d.ts

@@ -1,9 +0,0 @@
-import type { TreeNode } from '../../../features/Treege/type/TreeNode';
-interface UpdatedNodeParams {
-    tree: TreeNode;
-    path: string;
-    name: string;
-    child: TreeNode;
-}
-declare const updatedNode: ({ tree, path, name, child }: UpdatedNodeParams) => TreeNode;
-export default updatedNode;