@d-matrix/utils 1.21.1 → 1.23.0

package/dist/algorithm/index.d.ts

@@ -0,0 +1 @@
+export * as tree from './tree';

package/dist/algorithm/index.js

@@ -0,0 +1 @@
+export * as tree from './tree';

package/dist/algorithm/tree.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 计算指定层级的节点数量
+ * @param root tree data 对象
+ * @param depth 需要计算节点数量的层级
+ * @param childrenKey 子节点key
+ * @returns 节点数量
+ */
+export declare const nodeCountAtDepth: <T extends Record<string, any>>(root: T, depth: number, childrenKey?: string) => number;
+/**
+ * 找到符合条件的节点
+ * @param tree tree data 数组
+ * @param predicate 对每个节点执行的函数, 如果返回true, 则返回该节点
+ * @param childrenKey 子节点key
+ * @returns 找到的节点
+ */
+export declare const findNode: <T extends Record<string, any>>(tree: T[], predicate: (node: T) => boolean, childrenKey?: string) => T | null;

package/dist/algorithm/tree.js

@@ -0,0 +1,43 @@
+/**
+ * 计算指定层级的节点数量
+ * @param root tree data 对象
+ * @param depth 需要计算节点数量的层级
+ * @param childrenKey 子节点key
+ * @returns 节点数量
+ */
+export const nodeCountAtDepth = (root, depth, childrenKey = 'children') => {
+    const depths = { 0: 1 };
+    (function recurTree(node, level) {
+        var _a;
+        level++;
+        const children = (_a = node[childrenKey]) !== null && _a !== void 0 ? _a : [];
+        if (depths[level] === undefined) {
+            depths[level] = children.length;
+        }
+        else {
+            depths[level] += children.length;
+        }
+        if (level + 1 > depth)
+            return;
+        for (let i = 0; i < children.length; i++) {
+            recurTree(children[i], level);
+        }
+    })(root, 0);
+    return depths[depth];
+};
+/**
+ * 找到符合条件的节点
+ * @param tree tree data 数组
+ * @param predicate 对每个节点执行的函数, 如果返回true, 则返回该节点
+ * @param childrenKey 子节点key
+ * @returns 找到的节点
+ */
+export const findNode = (tree, predicate, childrenKey = 'children') => {
+    const list = [...tree];
+    for (const node of list) {
+        if (predicate(node))
+            return node;
+        Array.isArray(node[childrenKey]) && list.push(...node[childrenKey]);
+    }
+    return null;
+};

package/dist/array.d.ts

@@ -1,3 +1,4 @@
 export declare function moveMutable<T>(array: T[], fromIndex: number, toIndex: number): void;
 export declare function moveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[];
 export declare function moveToStart<T>(array: T[], predicate: (item: T) => boolean): T[];
+export declare const moveMulti: <T extends unknown>(arr: T[], indexes: number[], start: number) => T[];

package/dist/array.js

@@ -19,3 +19,15 @@ export function moveToStart(array, predicate) {
     moveMutable(newArray, index, 0);
     return newArray;
 }
+const removeSymbol = Symbol('Placeholder for removed element');
+export const moveMulti = (arr, indexes, start) => {
+    const cloned = arr.slice();
+    for (let i = 0; i < cloned.length; i++) {
+        if (indexes.includes(i)) {
+            cloned[i] = removeSymbol;
+        }
+    }
+    const els = arr.filter((__, i) => indexes.includes(i));
+    cloned.splice(start, 0, ...els);
+    return cloned.filter((v) => v !== removeSymbol);
+};

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export * as decimal from './decimal';
 export * as object from './object';
 export * as echarts from './echarts';
 export * as array from './array';
+export * as number from './number';

package/dist/index.js

@@ -12,3 +12,4 @@ export * as decimal from './decimal';
 export * as object from './object';
 export * as echarts from './echarts';
 export * as array from './array';
+export * as number from './number';

package/dist/number.d.ts

@@ -0,0 +1,2 @@
+/** 返回[min, max]之间的随机整数 */
+export declare function randomInt(min: number, max: number): number;

package/dist/number.js

@@ -0,0 +1,4 @@
+/** 返回[min, max]之间的随机整数 */
+export function randomInt(min, max) {
+    return Math.floor(Math.random() * (max - min + 1) + min);
+}

package/dist/object.d.ts

@@ -4,3 +4,10 @@ export declare const ZeroValues: ({} | null | undefined)[];
  * 默认的零值是：undefined、null、空字符串, NaN, [], {}
  */
 export declare const removeZeroValueKeys: <T extends Record<string, any>>(obj: T, zeroValues?: ({} | null | undefined)[]) => T;
+/**
+ * 返回tuple，而不是string[]
+ * const obj = { a: 1, b: '2' };
+ * Object.keys(obj) => string[]
+ * typedKeys({ a: 1, b: '2' }) => ('a' | 'b')[]
+ */
+export declare const typedKeys: <T extends object>(obj: T) => (keyof T)[];

package/dist/object.js

@@ -19,3 +19,10 @@ export const removeZeroValueKeys = (obj, zeroValues = ZeroValues) => {
     }
     return r;
 };
+/**
+ * 返回tuple，而不是string[]
+ * const obj = { a: 1, b: '2' };
+ * Object.keys(obj) => string[]
+ * typedKeys({ a: 1, b: '2' }) => ('a' | 'b')[]
+ */
+export const typedKeys = Object.keys;

package/dist/react/types.d.ts

@@ -1,3 +1,9 @@
 import type { ForwardRefExoticComponent, NamedExoticComponent, ComponentPropsWithoutRef, ComponentPropsWithRef, RefAttributes, ElementType } from 'react';
 export declare type ComponentRef<T extends ElementType> = T extends NamedExoticComponent<ComponentPropsWithoutRef<T> & RefAttributes<infer Method>> ? Method : ComponentPropsWithRef<T> extends RefAttributes<infer Method> ? Method : never;
 export declare type InferRef<T> = T extends ForwardRefExoticComponent<infer Ref> ? Ref extends React.RefAttributes<infer RefElement> ? RefElement : never : never;
+declare type ReactRefComponent<Props extends {
+    ref?: React.Ref<any> | string;
+}> = (props: Props) => React.ReactNode;
+declare type ExtractRefAttributesRef<T> = T extends React.RefAttributes<infer P> ? P : never;
+export declare type GetRef<T extends ReactRefComponent<any> | React.Component<any>> = T extends React.Component<any> ? T : T extends React.ComponentType<infer P> ? ExtractRefAttributesRef<P> : never;
+export {};

package/dist/types.d.ts

@@ -15,3 +15,7 @@ export declare type NonFunctionPropertyNames<T> = {
 }[keyof T];
 /** 获取对象中key的值，返回由这些值组成的union type */
 export declare type ValueOf<T> = T[keyof T];
+/** 指定属性变为必选 */
+export declare type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@d-matrix/utils",
   "sideEffects": false,
-  "version": "1.21.1",
+  "version": "1.23.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {

package/readme.md

@@ -20,6 +20,7 @@ A dozen of utils for Front-End Development
 - [decimal](#decimal)
 - [object](#object)
 - [array](#array)
+- [number](#number)
 - [echarts](#echarts)
 
 ### clipboard
@@ -339,11 +340,55 @@ const map = {
 type T0 = ValueOf<typeof map>; // '0m' | '1m' | '2m' | '3m' | '4m' | '5m' | '6m'
 ```
 
+- `WithRequired<T, K extends keyof T>`
+
+指定属性变为必选
+
+```ts
+type Input = {
+  a: number;
+  b?: string;
+};
+type Output = WithRequired<Input, 'b'> // { a: number; b: string }
+```
+
 ### algorithm
 
-- `moveMulti<T extends unknown>(arr: T[], indexes: number[], start: number): T[]`
+- `function nodeCountAtDepth(root: Record<string, any>, depth: number, childrenKey: string = 'children'): number;`
 
-移动多个元素到数组中指定的位置,用法,见[测试用例](tests/algorithm.cy.ts)
+计算指定层级的节点数量
+
+```ts
+const root = {
+  id: 1,
+  children: [
+    { id: 2, children: [{ id: 21 }, { id: 22 }, { id: 23 }] },
+    { id: 3, children: [{ id: 31 }, { id: 32 }, { id: 33 }] },
+  ],
+};
+expect(tree.nodeCountAtDepth(root, 0)).to.be.equal(1);
+expect(tree.nodeCountAtDepth(root, 1)).to.be.equal(2);
+expect(tree.nodeCountAtDepth(root, 2)).to.be.equal(6);
+```
+
+- `const findNode = <T extends Record<string, any>>(tree: T[], predicate: (node: T) => boolean, childrenKey = 'children'): T | null`
+
+找到符合条件的节点
+
+```ts
+const root = {
+  id: 1,
+  children: [
+    { id: 2, children: [{ id: 21 }, { id: 22 }, { id: 23 }] },
+    { id: 3, children: [{ id: 31 }, { id: 32 }, { id: 33 }] },
+  ],
+};
+const actual = tree.findNode([root], (node) => node.id === 3);
+expect(actual).to.be.deep.equal(root.children[1]);
+
+const actual2 = tree.findNode([root], (node) => node.id === 33);
+expect(actual2).to.be.deep.equal(root.children[1].children[2]);
+```
 
 ### file
 
@@ -485,6 +530,16 @@ removeZeroValueKeys({ a: '', b: 'abc', c: undefined, d: null, e: NaN, f: -1, g:
 // { b: 'abc', f: -1 }
 ```
 
+- `typedKeys(obj: T): Array<keyof T>`
+
+返回`tuple`，而不是`string[]`
+
+```ts
+const obj = { a: 1, b: '2' };
+Object.keys(obj) //  string[]
+object.typedKeys({ a: 1, b: '2' }) // ('a' | 'b')[]
+```
+
 ## array
 
 - `moveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[]`
@@ -522,6 +577,16 @@ const newList = array.moveToStart(list, (item) => item.id === 4);
 // [{ id: 4 }, { id: 1 }, { id: 2 }, { id: 3 }, { id: 5 }]
 ```
 
+- `moveMulti<T extends unknown>(arr: T[], indexes: number[], start: number): T[]`
+
+移动多个元素到数组中指定的位置,用法,见[测试用例](tests/algorithm.cy.ts)
+
+## number
+
+- `randomInt(min: number, max: number): number`
+
+返回`min`, `max`之间的随机整数
+
 ## echarts
 
 - `mergeOption(defaults: EChartsOption, overrides: EChartsOption, option?: deepmerge.Options): EChartsOption`
@@ -543,13 +608,13 @@ deep merge Echarts配置，用法见[测试用例](./tests//echarts/echarts.cy.t
 运行全部组件测试
 
 ```bash
-npm run cy:run -- --component
+npm run cy:component:all
 ```
 
 运行单个组件测试
 
 ```bash
-npm run cy:run -- --component --spec tests/date.cy.ts
+npm run cy:component -- tests/date.cy.ts
 ```
 
 运行E2E测试

package/dist/algorithm.d.ts

@@ -1 +0,0 @@
-export declare const moveMulti: <T extends unknown>(arr: T[], indexes: number[], start: number) => T[];

package/dist/algorithm.js

@@ -1,12 +0,0 @@
-const removeSymbol = Symbol('Placeholder for removed element');
-export const moveMulti = (arr, indexes, start) => {
-    const cloned = arr.slice();
-    for (let i = 0; i < cloned.length; i++) {
-        if (indexes.includes(i)) {
-            cloned[i] = removeSymbol;
-        }
-    }
-    const els = arr.filter((__, i) => indexes.includes(i));
-    cloned.splice(start, 0, ...els);
-    return cloned.filter((v) => v !== removeSymbol);
-};