@delon/util 19.2.0 → 20.0.0-beta.0

package/math/index.d.ts

@@ -1,2 +1,50 @@
-export * from './in-range';
-export * from './round';
+/**
+ * Checks if `value` is between `start` and `end` to, but not including `end`. If `end` is not specified, it's set to start with `start` then set to `0`. If `start` is greater than `end` the params are swapped to support negative ranges.
+ *
+ * 检查 `value` 是否在 `start` 与 `end` 之间，但不包括 `end`。 如果 `end` 没有指定，那么 `start` 设置为 `0`。 如果 `start` 大于 `end`，那么参数会交换以便支持负范围。
+ * ```ts
+ * inRange(3, 2, 4); // true
+ * inRange(4, 8); // true
+ * inRange(4, 2); // false
+ * inRange(2, 2); // false
+ * inRange(1.2, 2); // true
+ * inRange(-3, -2, -6); // true
+ * ```
+ */
+declare function inRange(value: number, start: number, end?: number): boolean;
+
+/**
+ * Computes `number` rounded up to `precision`.
+ *
+ * 根据 `precision`（精度） 向上舍入 `number`。
+ * ```ts
+ * ceil(4.006); // 5
+ * ceil(6.004, 2); // 6.01
+ * ceil(6040, -2); // 6100
+ * ```
+ */
+declare function ceil(number: number, precision?: number): number;
+/**
+ * Computes `number` rounded down to `precision`.
+ *
+ * 根据 `precision`（精度） 向下舍入 `number`。
+ * ```ts
+ * floor(4.006); // 4
+ * floor(0.046, 2); // 0.04
+ * floor(4060, -2); // 4000
+ * ```
+ */
+declare function floor(number: number, precision?: number): number;
+/**
+ * Computes `number` rounded to `precision`.
+ *
+ * 根据 `precision`（精度） 四舍五入 `number`。
+ * ```ts
+ * round(4.006); // 4
+ * round(4.006, 2); // 4.01
+ * round(4060, -2); // 4100
+ * ```
+ */
+declare function round(number: number, precision?: number): number;
+
+export { ceil, floor, inRange, round };

package/other/index.d.ts

@@ -1,4 +1,124 @@
-export * from './deep';
-export * from './logger';
-export * from './lazy.service';
-export * from './assert';
+import { NzSafeAny } from 'ng-zorro-antd/core/types';
+import { Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+
+/**
+ * Gets the value at `path` of `object`, like `_.get` in lodash.
+ *
+ * 类似 `_.get`，根据 `path` 获取安全值
+ */
+declare function deepGet(obj: NzSafeAny, path: string | string[] | null | undefined, defaultValue?: unknown): NzSafeAny;
+/**
+ * Base on [extend](https://github.com/justmoon/node-extend) deep copy.
+ *
+ * 基于 [extend](https://github.com/justmoon/node-extend) 的深度拷贝
+ *
+ * NOTE: Don't a lot of recursion, maybe performance issues
+ */
+declare function deepCopy<T extends Record<string, NzSafeAny> = NzSafeAny>(obj: T | null | undefined): T;
+/**
+ * Deep merge object.
+ *
+ * 深度合并对象
+ *
+ * @param original 原始对象
+ * @param arrayProcessMethod 数组处理方式
+ *  - `true` 表示替换新值，不管新值为哪种类型
+ *  - `false` 表示会合并整个数组（将旧数据与新数据合并成新数组）
+ * @param objects 要合并的对象
+ */
+declare function deepMergeKey(original: unknown, arrayProcessMethod: boolean, ...objects: NzSafeAny[]): NzSafeAny;
+/**
+ * Deep merge object.
+ *
+ * 深度合并对象
+ */
+declare function deepMerge(original: unknown, ...objects: unknown[]): NzSafeAny;
+
+declare const PREFIX = "[@DELON]:";
+declare const warn: (...args: NzSafeAny[]) => void;
+declare const warnDeprecation: (...args: NzSafeAny[]) => NzSafeAny;
+declare const log: (...args: NzSafeAny[]) => void;
+
+interface LazyResult {
+    path: string;
+    status: 'ok' | 'error' | 'loading';
+    error?: NzSafeAny;
+}
+interface LazyLoadItem {
+    path: string;
+    options?: LazyLoadOptions;
+}
+interface LazyLoadOptions {
+    innerContent?: string;
+    attributes?: Record<string, string>;
+    rel?: string;
+}
+/**
+ * `LazyService` delay loading JS or CSS files.
+ *
+ * 延迟加载资源（js 或 css）服务
+ */
+declare class LazyService {
+    private readonly doc;
+    private list;
+    private cached;
+    private _notify;
+    get change(): Observable<LazyResult[]>;
+    clear(): void;
+    private attachAttributes;
+    /**
+     * Load script or style files
+     */
+    load(paths: string | LazyLoadItem | Array<string | LazyLoadItem>): Promise<LazyResult[]>;
+    /**
+     * Load a script file
+     */
+    loadScript(path: string, options?: LazyLoadOptions): Promise<LazyResult>;
+    /**
+     * Load a style file
+     */
+    loadStyle(path: string, options?: LazyLoadOptions): Promise<LazyResult>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LazyService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LazyService>;
+}
+
+/**
+ * Assert whether the expression and throw an error into console in dev mode
+ *
+ * 断言表达式是否符合预期，并在开发模式下会在控制台抛出一个错误
+ */
+declare function assert(expression: boolean, msg?: string): void;
+/**
+ * Assert whether empty (`null` or `undefined`)
+ *
+ * 断言是否空值（`null` 或 `undefined`）
+ */
+declare function assertEmpty(actual: unknown, msg?: string): void;
+/**
+ * Assert whether `number` type
+ *
+ * 断言是否 `number` 类型
+ */
+declare function assertNumber(actual: unknown, msg?: string): void;
+/**
+ * Assert whether `string` type
+ *
+ * 断言是否 `string` 类型
+ */
+declare function assertString(actual: unknown, msg?: string): void;
+/**
+ * Assert whether `array` type
+ *
+ * 断言是否 `array` 类型
+ */
+declare function assertArray(actual: unknown, msg?: string): void;
+/**
+ * Assert whether `Observable` type
+ *
+ * 断言是否 `Observable` 类型
+ */
+declare function assertObservable(obj: unknown, msg?: string): void;
+
+export { LazyService, PREFIX, assert, assertArray, assertEmpty, assertNumber, assertObservable, assertString, deepCopy, deepGet, deepMerge, deepMergeKey, log, warn, warnDeprecation };
+export type { LazyLoadItem, LazyLoadOptions, LazyResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@delon/util",
-  "version": "19.2.0",
+  "version": "20.0.0-beta.0",
   "author": "cipchk<cipchk@qq.com>",
   "license": "MIT",
   "repository": {

package/pipes/currency/index.d.ts

@@ -1,4 +1,52 @@
-export * from './mega.pipe';
-export * from './price.pipe';
-export * from './module';
-export * from './cny.pipe';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+import { CurrencyMegaOptions, CurrencyFormatOptions, CurrencyCNYOptions } from '@delon/util/format';
+
+/**
+ * Large number format filter
+ *
+ * 大数据格式化
+ */
+declare class CurrencyMegaPipe implements PipeTransform {
+    private readonly srv;
+    private isCN;
+    transform(value: number | string, options?: CurrencyMegaOptions): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyMegaPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<CurrencyMegaPipe, "mega", true>;
+}
+
+/**
+ * Format a number with commas as thousands separators
+ *
+ * 格式化货币，用逗号将数字格式化为千位分隔符
+ * ```ts
+ * 10000 => `10,000`
+ * 10000.567 => `10,000.57`
+ * ```
+ */
+declare class CurrencyPricePipe implements PipeTransform {
+    private readonly srv;
+    transform(value: number | string, options?: CurrencyFormatOptions): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyPricePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<CurrencyPricePipe, "price", true>;
+}
+
+/**
+ * Converted into RMB notation.
+ *
+ * 转化成人民币表示法
+ */
+declare class CurrencyCNYPipe implements PipeTransform {
+    private readonly srv;
+    transform(value: number | string, options?: CurrencyCNYOptions): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyCNYPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<CurrencyCNYPipe, "cny", true>;
+}
+
+declare class CurrencyPipeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CurrencyPipeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CurrencyPipeModule, never, [typeof CurrencyMegaPipe, typeof CurrencyPricePipe, typeof CurrencyCNYPipe], [typeof CurrencyMegaPipe, typeof CurrencyPricePipe, typeof CurrencyCNYPipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<CurrencyPipeModule>;
+}
+
+export { CurrencyCNYPipe, CurrencyMegaPipe, CurrencyPipeModule, CurrencyPricePipe };

package/pipes/filter/index.d.ts

@@ -1,2 +1,22 @@
-export * from './filter.pipe';
-export * from './module';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+import { NzSafeAny } from 'ng-zorro-antd/core/types';
+
+/**
+ * Filter array
+ *
+ * 过滤数组
+ */
+declare class FilterPipe implements PipeTransform {
+    transform<T>(array: readonly T[], matcher: (item: T, ...args: NzSafeAny[]) => boolean, ...args: NzSafeAny[]): T[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<FilterPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<FilterPipe, "filter", true>;
+}
+
+declare class FilterPipeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FilterPipeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FilterPipeModule, never, [typeof FilterPipe], [typeof FilterPipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FilterPipeModule>;
+}
+
+export { FilterPipe, FilterPipeModule };

package/pipes/format/index.d.ts

@@ -1,2 +1,36 @@
-export * from './mask.pipe';
-export * from './module';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+import { FormatMaskOption } from '@delon/util/format';
+
+/**
+ * Format mask
+ *
+ * 格式化掩码
+ *
+ * | 字符 | 描述 |
+ * | --- | --- |
+ * | `0` | 任意数字，若该位置字符不符合，则默认为 `0` 填充 |
+ * | `9` | 任意数字 |
+ * | `#` | 任意字符 |
+ * | `U` | 转换大写 |
+ * | `L` | 转换小写 |
+ * | `*` | 转换为 `*` 字符 |
+ *
+ * ```ts
+ * formatMask('123', '(###)') => (123)
+ * formatMask('15900000000', '999****9999') => 159****0000
+ * ```
+ */
+declare class FormatMaskPipe implements PipeTransform {
+    transform(value: string, mask: string | FormatMaskOption): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormatMaskPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<FormatMaskPipe, "mask", true>;
+}
+
+declare class FormatPipeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormatPipeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FormatPipeModule, never, [typeof FormatMaskPipe], [typeof FormatMaskPipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FormatPipeModule>;
+}
+
+export { FormatMaskPipe, FormatPipeModule };

package/token/index.d.ts

@@ -1,2 +1,18 @@
-export * from './window';
-export * from './page-visibility';
+import { InjectionToken } from '@angular/core';
+import { Observable } from 'rxjs';
+
+/**
+ * Access to global `window` object
+ *
+ * 访问全局 `window` 对象
+ */
+declare const WINDOW: InjectionToken<Window>;
+
+/**
+ * Use the `visibilitychange` event to monitor whether the browser tab is visible, which is generally used when the user leaves the browser tab to temp interrupt the backend to continue sending requests
+ *
+ * 通过 `visibilitychange` 事件来监听浏览器选项卡是否可见，一般用于当用户离开应用时暂时中断后端持续发送请求时
+ */
+declare const PAGE_VISIBILITY: InjectionToken<Observable<boolean>>;
+
+export { PAGE_VISIBILITY, WINDOW };

package/array/array-type.service.d.ts

@@ -1,68 +0,0 @@
-import type { NzTreeNode } from 'ng-zorro-antd/core/tree';
-export interface ArrayServiceTreeToArrOptions<T extends object = any> {
-    /** 深度项名，默认：`'deep'` */
-    deepMapName?: string;
-    /** 扁平后数组的父数据项名，默认：`'parent'` */
-    parentMapName?: string;
-    /** 源数据子项名，默认：`'children'` */
-    childrenMapName?: string;
-    /** 是否移除 `children` 节点，默认：`true` */
-    clearChildren?: boolean;
-    /** 转换成数组结构时回调 */
-    cb?: (item: T, parent: T | null, deep: number) => void;
-}
-export interface ArrayServiceArrToTreeOptions<T extends object = any> {
-    /** 编号项名，默认：`'id'` */
-    idMapName?: string;
-    /** 父编号项名，默认：`'parent_id'` */
-    parentIdMapName?: string;
-    /**
-     * 根父编号值，默认会自动计算得到最合适的根父编号值，例如：
-     *
-     * @example
-     * ```ts
-     * const res = srv.arrToTree([
-     *    { id: 2, parent_id: 'a', title: 'c1' },
-     *    { id: 4, parent_id: 2, title: 't1' },
-     *  ],
-     *  { rootParentValue: 'a' });
-     * ```
-     */
-    rootParentIdValue?: any;
-    /** 子项名，默认：`'children'` */
-    childrenMapName?: string;
-    /** 转换成树数据时回调 */
-    cb?: (item: T) => void;
-}
-export interface ArrayServiceArrToTreeNodeOptions<T extends object = any> {
-    /** 编号项名，默认：`'id'` */
-    idMapName?: string;
-    /** 父编号项名，默认：`'parent_id'` */
-    parentIdMapName?: string;
-    /** 标题项名，默认：`'title'` */
-    titleMapName?: string;
-    /** 设置为叶子节点项名，若数据源不存在时自动根据 `children` 值决定是否为叶子节点，默认：`'isLeaf'` */
-    isLeafMapName?: string;
-    /** 节点 Checkbox 是否选中项名，默认：`'checked'` */
-    checkedMapname?: string;
-    /** 节点本身是否选中项名，默认：`'selected'` */
-    selectedMapname?: string;
-    /** 节点是否展开(叶子节点无效)项名，默认：`'expanded'` */
-    expandedMapname?: string;
-    /** 设置是否禁用节点(不可进行任何操作)项名，默认：`'disabled'` */
-    disabledMapname?: string;
-    /** 转换成树数据后，执行的递归回调 */
-    cb?: (item: T, parent: T | null, deep: number) => void;
-}
-export interface ArrayServiceGetKeysByTreeNodeOptions {
-    /** 是否包含半选状态的值，默认：`true` */
-    includeHalfChecked?: boolean;
-    /** 是否重新指定 `key` 键名，若不指定表示使用 `NzTreeNode.key` 值 */
-    keyMapName?: string;
-    /** 回调，返回一个值 `key` 值，优先级高于其他 */
-    cb?: (item: NzTreeNode, parent: NzTreeNode | null, deep: number) => any;
-}
-export interface ArrayServiceGroupByResult {
-    [key: string]: any;
-    [key: number]: any;
-}

package/array/array.service.d.ts

@@ -1,78 +0,0 @@
-import { AlainConfigService } from '@delon/util/config';
-import { NzTreeNode } from 'ng-zorro-antd/core/tree';
-import { ArrayServiceArrToTreeNodeOptions, ArrayServiceArrToTreeOptions, ArrayServiceGetKeysByTreeNodeOptions, ArrayServiceGroupByResult, ArrayServiceTreeToArrOptions } from './array-type.service';
-import * as i0 from "@angular/core";
-export declare class ArrayService {
-    private c;
-    constructor(cog: AlainConfigService);
-    /**
-     * Convert tree structure to array structure
-     *
-     * 将树结构转换成数组结构
-     */
-    treeToArr<T extends object = any>(tree: readonly T[], options?: ArrayServiceTreeToArrOptions<T>): T[];
-    /**
-     * Convert array structure to tree structure
-     *
-     * 数组转换成树数据
-     */
-    arrToTree<T extends object = any>(arr: readonly T[], options?: ArrayServiceArrToTreeOptions<T>): T[];
-    /**
-     * 数组转换成 `nz-tree` 数据源，通过 `options` 转化项名，也可以使用 `options.cb` 更高级决定数据项
-     */
-    arrToTreeNode<T extends object = any>(arr: readonly T[], options?: ArrayServiceArrToTreeNodeOptions): NzTreeNode[];
-    /**
-     * 递归访问整个树
-     */
-    visitTree<T extends object = any>(tree: readonly T[], cb: (item: T, parent: T | null, deep: number) => void, options?: {
-        /** 子项名，默认：`'children'` */
-        childrenMapName?: string;
-    }): void;
-    /**
-     * Return the value of the first tree value in the tree where predicate is true, and `undefined` otherwise
-     *
-     * 根据条件返回树的第一个值，否则返回 `undefined`
-     */
-    findTree<T extends object = any>(tree: readonly T[], predicate: (item: T) => boolean, options?: {
-        /** 子项名，默认：`'children'` */
-        childrenMapName?: string;
-    }): T | undefined;
-    /**
-     * 获取所有已经选中的 `key` 值
-     */
-    getKeysByTreeNode(tree: NzTreeNode[], options?: ArrayServiceGetKeysByTreeNodeOptions): any[];
-    private baseFlat;
-    /**
-     * Recursively flattens array
-     *
-     * 递归扁平数组
-     * ```ts
-     * srv.flat([1, [2, 3, [4, 5, [6]]]]) => [1,2,3,4,5,6]
-     * srv.flat([1, [2, 3, [4, 5, [6]]]], 1) => [1,2,3,[4, 5, [6]]]
-     * ```
-     */
-    flat<T>(array: readonly T[], depth?: number): T[];
-    /**
-     * Group the array
-     *
-     * 对数组进行分组
-     * ```ts
-     * srv.groupBy([6.1, 4.2, 6.3], Math.floor) => {"4":[4.2],"6":[6.1,6.3]}
-     * srv.groupBy(['one', 'two', 'three'], v => v.length) => {"3":["one","two"],"5":["three"]}
-     * ```
-     */
-    groupBy<T>(array: readonly T[], iteratee: (value: T) => string | number): ArrayServiceGroupByResult;
-    /**
-     * Creates a duplicate-free version of an array
-     *
-     * 创建去重后的数组
-     * ```ts
-     * uniq([1, 2, 2, 3, 1]) => [1,2,3]
-     * uniq([{ a: 1 }, { a: 1 }, { a: 2 }], 'a') => [{"a":1},{"a":2}]
-     * uniq([{ a: 1 }, { a: 1 }, { a: 2 }], i => (i.a === 1 ? 'a' : 'b')) => [{"a":1},{"a":2}]
-     * ```
-     */
-    uniq<T>(array: readonly T[], predicate?: string | ((value: T) => string | number | boolean)): T[];
-    static ɵfac: i0.ɵɵFactoryDeclaration<ArrayService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ArrayService>;
-}

package/browser/cookie.service.d.ts

@@ -1,62 +0,0 @@
-import * as i0 from "@angular/core";
-export interface CookieOptions {
-    path?: string;
-    domain?: string;
-    /**
-     * Expiration time, `number` is seconds
-     *
-     * 过期时间，`number` 类型表示秒数
-     */
-    expires?: number | Date | string;
-    secure?: boolean;
-    HttpOnly?: boolean;
-    SameSite?: boolean | 'lax' | 'strict' | 'none';
-}
-/**
- * A set of simple Cookie manipulation classes.
- *
- * 一组简单的 Cookie 操作类。
- */
-export declare class CookieService {
-    private readonly _doc;
-    private readonly platform;
-    private get doc();
-    /**
-     * Original cookie value
-     *
-     * 原始Cookie值
-     */
-    get cookie(): string;
-    /**
-     * Get all cookie key-value pairs
-     *
-     * 获取所有Cookie键值对
-     */
-    getAll(): Record<string, string>;
-    /**
-     * Get the value of given cookie `key`
-     *
-     * 获取指定 `key` 的值
-     */
-    get(key: string): string | undefined;
-    /**
-     * Sets a value for given cookie key
-     *
-     * 设置指定 Cookie 键的值
-     */
-    put(key: string, value: string, options?: CookieOptions): void;
-    /**
-     * Remove given cookie
-     *
-     * 移除指定 Cookie
-     */
-    remove(key: string, options?: CookieOptions): void;
-    /**
-     * Remove all cookies
-     *
-     * 移除所有 Cookies
-     */
-    removeAll(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CookieService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CookieService>;
-}

package/browser/copy.d.ts

@@ -1,6 +0,0 @@
-/**
- * Copy text to clipboard
- *
- * 复制字符串文档至剪贴板
- */
-export declare function copy(value: string): Promise<string>;

package/browser/is-empty.d.ts

@@ -1,6 +0,0 @@
-/**
- * Used to verify `<ng-content />` is empty, useful for custom components.
- *
- * 用于校验 `<ng-content />` 是否为空，自定义组件时蛮有用。
- */
-export declare function isEmpty(element: HTMLElement): boolean;

package/browser/scroll.service.d.ts

@@ -1,34 +0,0 @@
-import * as i0 from "@angular/core";
-export declare class ScrollService {
-    private readonly _doc;
-    private readonly platform;
-    private _getDoc;
-    private _getWin;
-    /**
-     * 获取滚动条位置
-     *
-     * @param element 指定元素，默认 `window`
-     */
-    getScrollPosition(element?: Element | Window | null): [number, number];
-    /**
-     * 设置滚动条位置
-     *
-     * @param element 指定元素
-     */
-    scrollToPosition(element: Element | Window | null | undefined, position: [number, number]): void;
-    /**
-     * 设置滚动条至指定元素
-     *
-     * @param element 指定元素，默认 `document.body`
-     * @param topOffset 偏移值，默认 `0`
-     */
-    scrollToElement(element?: Element | null, topOffset?: number): void;
-    /**
-     * 滚动至顶部
-     *
-     * @param topOffset 偏移值，默认 `0`
-     */
-    scrollToTop(topOffset?: number): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScrollService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScrollService>;
-}

package/browser/style.d.ts

@@ -1,19 +0,0 @@
-import { Renderer2 } from '@angular/core';
-/**
- * Update host component style `class`
- *
- * 更新宿主组件样式 `class`
- *
- * ```ts
- * updateHostClass(
- *  this.el.nativeElement,
- *  this.renderer,
- *  {
- *    [ 'classname' ]: true,
- *    [ 'classname' ]: this.type === '1',
- *    [ this.cls ]: true,
- *    [ `a-${this.cls}` ]: true
- *  })
- * ```
- */
-export declare function updateHostClass(el: HTMLElement, renderer: Renderer2, classMap: Record<string, unknown>, preClean?: boolean): void;