@yelon/util 19.2.0 → 20.0.0-beta.0

package/mtypes/index.d.ts

@@ -1,9 +1,197 @@
-export * from './authority.type';
-export * from './menu.type';
-export * from './user.types';
-export * from './role.type';
-export * from './project-info.types';
-export * from './header-menu.type';
-export * from './nav.types';
-export * from './page';
-export * from './response';
+interface YunzaiAuthority {
+    authority: string;
+}
+
+interface YunzaiMenu {
+    [key: string]: any;
+    appCode: string;
+    appIconUrl: string;
+    appType: string;
+    appUrl: string;
+    attribute: string;
+    badge: number;
+    badge_dot: boolean;
+    badge_status: string;
+    children: YunzaiMenu[];
+    createdDate: string;
+    displayIndex: number;
+    externalLink: string;
+    group: boolean;
+    helpUrl: string;
+    hide: boolean;
+    hideChildren: boolean;
+    hideInBreadcrumb: boolean;
+    i18n: string;
+    icon: string;
+    id: string;
+    intro: string;
+    label: string;
+    link: string;
+    menuAuths: string[];
+    reuse: boolean;
+    shortcut: boolean;
+    shortcut_root: boolean;
+    systemCode: string;
+    target: string;
+    text: string;
+    version: number;
+}
+interface YunzaiMenuAttribute {
+    defaultRoute: any;
+    dataPlatform: any;
+    targetUser: any;
+    starConfig: any;
+}
+
+interface YunzaiRole {
+    id: string;
+    onlyDeptOne: boolean;
+    onlyOne: boolean;
+    roleDesc: string;
+    roleName: string;
+    roleValue: string;
+    status: number;
+    thisDepartment: boolean;
+}
+
+interface YunzaiUser {
+    email: string;
+    accountNonExpired: boolean;
+    accountNonLocked: boolean;
+    authorities: YunzaiAuthority[];
+    avatarId: string;
+    credentialsNonExpired: boolean;
+    deptId: string;
+    deptName: string;
+    enabled: boolean;
+    id: string;
+    menu: YunzaiMenu[];
+    realname: string;
+    roles: YunzaiRole[];
+    userCode: string;
+    userId: string;
+    userType: number;
+    username: string;
+}
+
+interface YunzaiHeaderStyle {
+    label: string;
+    value: string;
+}
+interface YunzaiProfile {
+    name: string;
+    url: string;
+}
+interface YunzaiProjectInfo {
+    colorfulLogoUrl: string;
+    copyright: string;
+    faviconUrl: string;
+    gateway: string;
+    headerStyle: YunzaiHeaderStyle[];
+    maxLogoUrl: string;
+    miniLogoUrl: string;
+    profileList: YunzaiProfile[];
+    projectName: string;
+    showAllMenu: boolean;
+    tucaoUrl: string;
+    pageTitlePattern: string;
+}
+
+interface YunzaiNavTopic {
+    attribute: any;
+    icon: any;
+    children: YunzaiNavTopic[];
+    intro: string;
+    key: string;
+    name: string;
+    target: string;
+    auth: boolean;
+    url: string;
+    version: string;
+}
+
+declare enum NavType {
+    APPLICATION = "application",// 应用与服务
+    GROUP = "group",// 分组
+    TILE = "tiled",// 平铺
+    BLANK = "blank",// 空
+    TABS = "tabs"
+}
+interface LayoutBasicAside {
+    name: string;
+    intro: string;
+    icon: string;
+}
+interface LayoutBasicDisplay {
+    nav: boolean;
+    reusetab: boolean;
+    aside: boolean;
+}
+interface LayoutNavApplicationState {
+    active: boolean;
+    type: 'all' | 'mine' | 'other';
+    topic?: YunzaiNavTopic;
+    topics: YunzaiNavTopic[];
+    list: YunzaiNavTopic[];
+    search: string | null;
+}
+interface LayoutNavGroupState {
+    topics: YunzaiNavTopic[];
+}
+
+interface YunzaiPageParam<T> {
+    pageNum?: number;
+    pageSize?: number;
+    pageParam?: T;
+}
+interface Pageable {
+    offset: number;
+    pageNumber: number;
+    pageSize: number;
+    paged: boolean;
+    sort: PageableSort;
+    unpaged: boolean;
+}
+interface PageableSort {
+    empty: boolean;
+    sorted: boolean;
+    unsorted: boolean;
+}
+interface YunzaiPageResult<T> {
+    content: T[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: Pageable;
+    size: number;
+    sort: PageableSort;
+    totalElements: number;
+    totalPages: number;
+}
+declare class YunzaiPageBuilder<T extends any | unknown> {
+    private page;
+    pageNum(pageNum: number): this;
+    pageSize(pageSize: number): this;
+    pageParam(param: T): this;
+    default(): this;
+    build(): YunzaiPageParam<T>;
+}
+declare class Page<T> {
+    pageNum: number;
+    pageSize: number;
+    param?: Partial<T>;
+    private constructor();
+    static create<T>(): Page<T>;
+}
+
+interface YunzaiResponse<T> {
+    data: T;
+    errorMessage: string;
+    message: string;
+}
+type YunzaiPageResponse<T> = YunzaiResponse<YunzaiPageResult<T>>;
+
+export { NavType, Page, YunzaiPageBuilder };
+export type { LayoutBasicAside, LayoutBasicDisplay, LayoutNavApplicationState, LayoutNavGroupState, Pageable, PageableSort, YunzaiAuthority, YunzaiHeaderStyle, YunzaiMenu, YunzaiMenuAttribute, YunzaiNavTopic, YunzaiPageParam, YunzaiPageResponse, YunzaiPageResult, YunzaiProfile, YunzaiProjectInfo, YunzaiResponse, YunzaiRole, YunzaiUser };

package/other/index.d.ts

@@ -1,7 +1,154 @@
-export * from './deep';
-export * from './logger';
-export * from './lazy.service';
-export * from './assert';
-export * from './path-to-regexp.service';
-export * from './resize';
-export * from './favicon';
+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: any, path: string | string[] | null | undefined, defaultValue?: unknown): any;
+/**
+ * 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, any> = any>(obj: T | null | undefined): T;
+/**
+ * Deep merge object.
+ *
+ * 深度合并对象
+ *
+ * @param original 原始对象
+ * @param arrayProcessMethod 数组处理方式
+ *  - `true` 表示替换新值，不管新值为哪种类型
+ *  - `false` 表示会合并整个数组（将旧数据与新数据合并成新数组）
+ * @param objects 要合并的对象
+ */
+declare function deepMergeKey(original: unknown, arrayProcessMethod: boolean, ...objects: any[]): any;
+/**
+ * Deep merge object.
+ *
+ * 深度合并对象
+ */
+declare function deepMerge(original: unknown, ...objects: unknown[]): any;
+
+declare const PREFIX = "[@YELON]:";
+declare const warn: (...args: any[]) => void;
+declare const warnDeprecation: (...args: any[]) => any;
+declare const log: (...args: any[]) => void;
+
+interface LazyResult {
+    path: string;
+    status: 'ok' | 'error' | 'loading';
+    error?: any;
+}
+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;
+
+declare class PathToRegexpService {
+    constructor();
+    DEFAULT_DELIMITER: string;
+    PATH_REGEXP: RegExp;
+    parse(str: any, options: any): (string | {
+        name: string | number;
+        prefix: string;
+        delimiter: any;
+        optional: boolean;
+        repeat: boolean;
+        pattern: any;
+    })[];
+    compile(str: any, options: any): (data: any, options: any) => string;
+    tokensToFunction(tokens: any, options: any): (data: any, options: any) => string;
+    escapeString(str: any): any;
+    escapeGroup(group: any): any;
+    flags(options: any): "" | "i";
+    regexpToRegexp(path: any, keys: any): any;
+    arrayToRegexp(path: any, keys: any, options: any): RegExp;
+    stringToRegexp(path: any, keys: any, options: any): RegExp;
+    tokensToRegExp(tokens: any, keys: any, options: any): RegExp;
+    pathToRegexp(path: any, keys: any, options: any): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PathToRegexpService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PathToRegexpService>;
+}
+
+declare const resizeWindow: () => void;
+
+declare function setFavicon(path: string): void;
+declare function hasFavicon(url: string): Promise<boolean>;
+
+export { LazyService, PREFIX, PathToRegexpService, assert, assertArray, assertEmpty, assertNumber, assertObservable, assertString, deepCopy, deepGet, deepMerge, deepMergeKey, hasFavicon, log, resizeWindow, setFavicon, warn, warnDeprecation };
+export type { LazyLoadItem, LazyLoadOptions, LazyResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yelon/util",
-  "version": "19.2.0",
+  "version": "20.0.0-beta.0",
   "author": "yunzai-bot<yunzai-bot@outlook.com>",
   "license": "MIT",
   "repository": {
@@ -37,30 +37,30 @@
       "types": "./array/index.d.ts",
       "default": "./fesm2022/array.mjs"
     },
-    "./browser": {
-      "types": "./browser/index.d.ts",
-      "default": "./fesm2022/browser.mjs"
-    },
     "./config": {
       "types": "./config/index.d.ts",
       "default": "./fesm2022/config.mjs"
     },
-    "./date-time": {
-      "types": "./date-time/index.d.ts",
-      "default": "./fesm2022/date-time.mjs"
-    },
     "./decorator": {
       "types": "./decorator/index.d.ts",
       "default": "./fesm2022/decorator.mjs"
     },
-    "./format": {
-      "types": "./format/index.d.ts",
-      "default": "./fesm2022/format.mjs"
+    "./browser": {
+      "types": "./browser/index.d.ts",
+      "default": "./fesm2022/browser.mjs"
+    },
+    "./date-time": {
+      "types": "./date-time/index.d.ts",
+      "default": "./fesm2022/date-time.mjs"
     },
     "./form": {
       "types": "./form/index.d.ts",
       "default": "./fesm2022/form.mjs"
     },
+    "./format": {
+      "types": "./format/index.d.ts",
+      "default": "./fesm2022/format.mjs"
+    },
     "./math": {
       "types": "./math/index.d.ts",
       "default": "./fesm2022/math.mjs"

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 '@yelon/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,21 @@
-export * from './filter.pipe';
-export * from './module';
+import * as i0 from '@angular/core';
+import { PipeTransform } from '@angular/core';
+
+/**
+ * Filter array
+ *
+ * 过滤数组
+ */
+declare class FilterPipe implements PipeTransform {
+    transform<T>(array: readonly T[], matcher: (item: T, ...args: any[]) => boolean, ...args: any[]): 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 '@yelon/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;
-}