@dereekb/util 0.0.1 → 1.2.0

package/src/lib/tree/tree.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represends a traversable tree with values of type T.
+ */
+export interface TreeNode<T, N extends TreeNode<T, N> = TreeNode<T, any>> {
+    depth: number;
+    value: T;
+    parent?: N;
+    children?: N[];
+}
+/**
+ * A TreeNode with no children values available. Used when building a tree.
+ */
+export declare type TreeNodeWithoutChildren<T, N extends TreeNode<T, N> = TreeNode<T, any>> = Omit<TreeNode<T, N>, 'children'>;

package/src/lib/tree/tree.expand.d.ts

@@ -0,0 +1,40 @@
+import { TreeNode, TreeNodeWithoutChildren } from "./tree";
+import { Maybe } from "../value";
+/**
+ * ExpandTreeFunction configuration.
+ */
+export interface ExpandTree<T> {
+    /**
+     * Returns child values from the value, if they exist.
+     * @param value
+     */
+    getChildren(value: T): Maybe<T[]>;
+}
+/**
+ * Extended ExpandTree configuration with custom node building.
+ */
+export interface ExpandTreeWithNodeBuilder<T, N extends TreeNode<T, N>> extends ExpandTree<T> {
+    /**
+     * Creates a TreeNode of type N, minus the children values that are attached afterwards.
+     */
+    makeNode: (node: TreeNodeWithoutChildren<T, N>) => Omit<N, 'children'>;
+}
+/**
+ * Expands the input value into a TreeNode.
+ */
+export declare type ExpandTreeFunction<T, N extends TreeNode<T, N> = TreeNode<T, any>> = (value: T) => N;
+/**
+ * Creates an ExpandTreeFunction from the input configuration.
+ *
+ * @param config
+ */
+export declare function expandTreeFunction<T>(config: ExpandTree<T>): ExpandTreeFunction<T, TreeNode<T>>;
+export declare function expandTreeFunction<T, N extends TreeNode<T, N>>(config: ExpandTreeWithNodeBuilder<T, N>): ExpandTreeFunction<T, N>;
+/**
+ * Convenience function for expanding multiple values into trees then merging them together into a single array.
+ *
+ * @param values
+ * @param expandFn
+ * @returns
+ */
+export declare function expandTrees<T, N extends TreeNode<T, N>>(values: T[], expandFn: ExpandTreeFunction<T, N>): N[];

package/src/lib/tree/tree.expand.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expandTrees = exports.expandTreeFunction = void 0;
+;
+function expandTreeFunction(config) {
+    var _a;
+    const makeNode = (_a = config.makeNode) !== null && _a !== void 0 ? _a : ((node) => node);
+    const expandFn = (value, parent) => {
+        const depth = (parent) ? parent.depth + 1 : 0;
+        const treeNode = {
+            depth,
+            parent,
+            value
+        };
+        const node = makeNode(treeNode);
+        const childrenValues = config.getChildren(value);
+        node.children = (childrenValues) ? childrenValues.map(x => expandFn(x, node)) : undefined;
+        return node;
+    };
+    return (root) => expandFn(root);
+}
+exports.expandTreeFunction = expandTreeFunction;
+/**
+ * Convenience function for expanding multiple values into trees then merging them together into a single array.
+ *
+ * @param values
+ * @param expandFn
+ * @returns
+ */
+function expandTrees(values, expandFn) {
+    return values.map(expandFn);
+}
+exports.expandTrees = expandTrees;
+//# sourceMappingURL=tree.expand.js.map

package/src/lib/tree/tree.expand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.expand.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/tree/tree.expand.ts"],"names":[],"mappings":";;;AAcC,CAAC;AAwBF,SAAgB,kBAAkB,CAAiD,MAAuD;;IACxI,MAAM,QAAQ,GAA6B,MAAC,MAAc,CAAC,QAAQ,mCAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAS,CAAC,CAAC;IAE7F,MAAM,QAAQ,GAAG,CAAC,KAAQ,EAAE,MAAU,EAAK,EAAE;QAC3C,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAkC;YAC9C,KAAK;YACL,MAAM;YACN,KAAK;SACN,CAAC;QAEF,MAAM,IAAI,GAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,cAAc,GAAe,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,QAAQ,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAlBD,gDAkBC;AAED;;;;;;GAMG;AACF,SAAgB,WAAW,CAA8B,MAAW,EAAE,QAAkC;IACvG,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAFA,kCAEA"}

package/src/lib/tree/tree.flatten.d.ts

@@ -0,0 +1,27 @@
+import { TreeNode } from "./tree";
+/**
+ * Flattens the tree by pushing the values into the input array, or a new array and returns the value.
+ */
+export declare type FlattenTreeFunction<N extends TreeNode<any>, V> = (tree: N, array?: V[]) => V[];
+/**
+ * Traverses the tree and flattens it into all tree nodes.
+ */
+export declare function flattenTree<N extends TreeNode<any> = TreeNode<any>>(tree: N): N[];
+/**
+ * Traverses the tree and pushes the nodes into the input array.
+ *
+ * @param tree
+ * @param array
+ * @returns
+ */
+export declare function flattenTreeToArray<N extends TreeNode<any> = TreeNode<any>>(tree: N, array: N[]): N[];
+export declare function flattenTreeToArrayFunction<N extends TreeNode<any>>(): FlattenTreeFunction<N, N>;
+export declare function flattenTreeToArrayFunction<N extends TreeNode<any, N>, V>(mapNodeFn?: ((node: N) => V)): FlattenTreeFunction<N, V>;
+/**
+ * Convenience function for flattening multiple trees with a flatten function.
+ *
+ * @param trees
+ * @param flattenFn
+ * @returns
+ */
+export declare function flattenTrees<N extends TreeNode<any, N>, V>(trees: N[], flattenFn: FlattenTreeFunction<N, V>): V[];

package/src/lib/tree/tree.flatten.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flattenTrees = exports.flattenTreeToArrayFunction = exports.flattenTreeToArray = exports.flattenTree = void 0;
+/**
+ * Traverses the tree and flattens it into all tree nodes.
+ */
+function flattenTree(tree) {
+    return flattenTreeToArray(tree, []);
+}
+exports.flattenTree = flattenTree;
+/**
+ * Traverses the tree and pushes the nodes into the input array.
+ *
+ * @param tree
+ * @param array
+ * @returns
+ */
+function flattenTreeToArray(tree, array) {
+    return flattenTreeToArrayFunction()(tree, array);
+}
+exports.flattenTreeToArray = flattenTreeToArray;
+function flattenTreeToArrayFunction(mapNodeFn) {
+    const mapNode = mapNodeFn !== null && mapNodeFn !== void 0 ? mapNodeFn : ((x) => x);
+    const flattenFn = (tree, array = []) => {
+        array.push(mapNode(tree));
+        if (tree.children) {
+            tree.children.forEach((x) => flattenFn(x, array));
+        }
+        return array;
+    };
+    return flattenFn;
+}
+exports.flattenTreeToArrayFunction = flattenTreeToArrayFunction;
+/**
+ * Convenience function for flattening multiple trees with a flatten function.
+ *
+ * @param trees
+ * @param flattenFn
+ * @returns
+ */
+function flattenTrees(trees, flattenFn) {
+    const array = [];
+    trees.forEach((x) => flattenFn(x, array));
+    return array;
+}
+exports.flattenTrees = flattenTrees;
+//# sourceMappingURL=tree.flatten.js.map

package/src/lib/tree/tree.flatten.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.flatten.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/tree/tree.flatten.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACH,SAAgB,WAAW,CAA0C,IAAO;IAC1E,OAAO,kBAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAFD,kCAEC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAA0C,IAAO,EAAE,KAAU;IAC7F,OAAO,0BAA0B,EAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtD,CAAC;AAFD,gDAEC;AAID,SAAgB,0BAA0B,CAAgC,SAA4B;IACpG,MAAM,OAAO,GAAmB,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAQ,CAAC,CAAC;IAE/D,MAAM,SAAS,GAAG,CAAC,IAAO,EAAE,QAAa,EAAE,EAAE,EAAE;QAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;SACnD;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAdD,gEAcC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAgC,KAAU,EAAE,SAAoC;IAC1G,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC;AAJD,oCAIC"}

package/src/lib/tree/tree.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tree.js.map

package/src/lib/tree/tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/tree/tree.ts"],"names":[],"mappings":""}

package/src/lib/type.d.ts

@@ -7,3 +7,4 @@ export declare type ClassType<T> = {
 export declare type KeyValueTransformMap<T, V, K extends keyof T = keyof T> = {
     [k in K]: V;
 };
+export declare type BooleanKeyValueTransformMap<T> = KeyValueTransformMap<T, boolean>;

package/src/lib/value.js.map

@@ -1 +1 @@
-{"version":3,"file":"value.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/value.ts"],"names":[],"mappings":";;;AAuBA,SAAgB,eAAe,CAAI,KAAe;IAChD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAFD,0CAEC;AAmBD,SAAgB,kBAAkB,CAAC,KAAU;IAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;KACzB;SAAM;QACL,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;KACtC;AACH,CAAC;AAND,gDAMC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAI,CAAW,EAAE,CAAW;IAC5D,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;AAChC,CAAC;AAFD,gDAEC"}
+{"version":3,"file":"value.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/value.ts"],"names":[],"mappings":";;;AAsBA,SAAgB,eAAe,CAAI,KAAe;IAChD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAFD,0CAEC;AAmBD,SAAgB,kBAAkB,CAAC,KAAU;IAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;KACzB;SAAM;QACL,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;KACtC;AACH,CAAC;AAND,gDAMC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAI,CAAW,EAAE,CAAW;IAC5D,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;AAChC,CAAC;AAFD,gDAEC"}