@cowave-cli/utils 2.5.3

package/README.md

@@ -0,0 +1,115 @@
+# cowave-utils 控维工具包
+
+## 更新记录
+
+### 2.5.0
+
+1. 添加组件工具函数 on ，用于中间件透传事件
+
+### 2.4.0
+
+1. 加入Vue工具函数，使用cowave-utils/vue 使用 vue工具函数
+
+### 2.3.0
+
+1. 包优化
+
+### 2.2.0
+
+1. 引入http
+
+### 2.0.0
+
+1. 从tsup升级为rollup，并保留注释，新增了所有函数注释使用方法，可以便捷使用所有函数。
+2. 删除getDate的默认formatter, 默认输出Date格式。
+3. 优化setTime时间同步逻辑。
+
+## JS工具函数
+
+<!-- 表格 -->
+1. 全屏
+   
+    | 函数                                          | 功能     |
+    | --------------------------------------------- | -------- |
+    | <code>isFullscreen()</code>                   | 是否全屏 |
+    | <code>inFullscreen( el : HTMLElement )</code> | 进入全屏 |
+    | <code>exitFullscreen()</code>                 | 退出全屏 |
+    | <code>fullscreen( el : HTMLElement )</code>   | 切换全屏 |
+
+2. 系统
+   
+   | 函数                         | 返回值                                      | 功能           |
+   | ---------------------------- | ------------------------------------------- | -------------- |
+   | <code>browserEngine()</code> | "Gecko" \| "Blink" \| "WebKit" \| "Unknown" | 浏览器引擎判断 |
+
+3. 数字处理
+   
+   | 函数                                                     | 功能       |
+   | -------------------------------------------------------- | ---------- |
+   | <code>Num(num: string \| number, factor?: number)</code> | 转换为数字 |
+
+4. 字符串处理
+   
+   | 函数                                                                              | 功能                           |
+   | --------------------------------------------------------------------------------- | ------------------------------ |
+   | <code>toHump(strings: string \| string[], hyphenType = '-', isGreatHump? )</code> | 将连字符字符串转换为驼峰字符串 |
+   | <code>toHyphen(strings: string \| string[], hyphenType = '-')</code>              | 将驼峰字符串转换为连字符字符串 |
+
+5. 对象处理
+   
+   | 函数                                                                | 功能                                         |
+   | ------------------------------------------------------------------- | -------------------------------------------- |
+   | <code>getObject(objectArr, keyName, keyValue, foundKeyName?)</code> | 从对象列表中，根据指定键值，找到对象(或属性) |
+   | <code>assignObject(dist: T, src: T): T</code>                       | 深合并对象                                   |
+   | <code>expose(option,...refs)</code>                                 | 处理中间件事件向上透传(用于Vue组件封装)    |
+
+6. 时间处理
+   
+   | 函数                                                            | 功能                               |
+   | --------------------------------------------------------------- | ---------------------------------- |
+   | <code>setTime(callback: () => Date \| string  \| number)</code> | 服务器时间同步                     |
+   | <code>getTime()</code>                                          | 获取服务器时间戳                   |
+   | <code>getDate(date?: Date \| string, formatter?: string)</code> | 获取时间(服务器时间)/转换时间格式  |
+   | <code>getDateObject(date: Date \| string \| number)</code>      | 获取时间对象                       |
+   | <code>getSpecialDate(dateType, date?, formatter?)</code>        | 获取特殊时间节点(一个月前、一年前) |
+
+7. AJAX请求
+   
+   ```js
+   import { createHttp } from 'cowave-utils'
+   ```
+
+8. 颜色处理
+    | 函数                     | 功能       | 文档                                  |
+    | ------------------------ | ---------- | ------------------------------------- |
+    | <code>new TinyColor(color)</code> | 颜色处理库 | [地址](./document/tiny-color.md) |
+
+
+## Vue工具函数
+
+1. API
+2. 文件处理
+3. store
+4. 发布订阅
+
+
+## Node工具函数
+
+1. 文件处理
+   
+   | 函数                                                      | 功能                           |
+   | --------------------------------------------------------- | ------------------------------ |
+   | <code>createDir(path: string)</code>                      | 创建文件夹                     |
+   | <code>readDir(path: string)</code>                        | 读取文件夹下的所有文件、文件夹 |
+   | <code>readFile(pathName: string)</code>                   | 读取文件内容                   |
+   | <code>writeFile(pathName: string, content: string)</code> | 写入文件内容                   |
+   | <code>copyFileOrDir(src: string, dest: string)</code>     | 复制文件夹或者文件             |
+   | <code>removeFileOrDir(path: string)</code>                | 删除文件夹或者文件             |
+   
+2. 路径处理
+   
+   | 函数                                                                          | 功能                                       |
+   | ----------------------------------------------------------------------------- | ------------------------------------------ |
+   | <code>relation(fromPath: string, toPath: string, toPathIsFile = false)</code> | 判断从toPath引入fromPath的路径相对关系     |
+   | <code>filter(files, basePath?, includePath?, excludePath?)</code>             | 过滤文件(仅过滤文件路径，不过滤文件夹路径) |
+   | <code>findFiles(srcs, includePath?, excludePath?)</code>                      | 遍历寻找src目录下的所有文件                |

package/dist/error.d.ts

@@ -0,0 +1 @@
+export declare const noDisk: (fromPath1: any, toPath1: any) => never;

package/dist/js/fullscreen.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 是否全屏
+ *
+ * @returns boolean
+ */
+export declare function isFullscreen(): boolean;
+/**
+ * 进入全屏
+ *
+ * @param { HTMLElement } el  需要进入全屏的元素
+ *
+ */
+export declare function inFullscreen(el?: any): void;
+/**
+ * 退出全屏
+ *
+ */
+export declare function exitFullscreen(): void;
+/**
+ * 切换全屏显示
+ *
+ * @param { HTMLElement } el 需要进入全屏的元素
+ */
+export declare function fullscreen(el?: HTMLElement): void;

package/dist/js/http.d.ts

@@ -0,0 +1,26 @@
+import type { AxiosRequestConfig, AxiosResponse, CreateAxiosDefaults, InternalAxiosRequestConfig } from 'axios';
+export type Config = CreateAxiosDefaults<any>;
+export type Request = InternalAxiosRequestConfig<any>;
+export type Response = AxiosResponse<any, any>;
+/**
+ *
+ * @param config 配置 （如配置 baseUrl、timeout 等 ）
+ * @param request 请求拦截
+ * @param response 响应成功拦截
+ * @param reject 响应错误拦截 (正常情况用不到)
+ * @returns
+ */
+export declare const createHttp: ({ config, request, response, reject, }: {
+    config?: Config;
+    request?: (config: Request) => Request;
+    response?: (data: any, res: Response) => any;
+    reject?: (error: any) => any;
+}) => {
+    (config: AxiosRequestConfig<any>): Promise<any>;
+    get: (url: string, params?: any, config?: AxiosRequestConfig<any>) => any;
+    delete: (url: string, params?: any, config?: AxiosRequestConfig<any>) => any;
+    head: (url: string, params?: any, config?: AxiosRequestConfig<any>) => any;
+    post: (url: string, data?: any, config?: AxiosRequestConfig<any>) => any;
+    put: (url: string, data?: any, config?: AxiosRequestConfig<any>) => any;
+    patch: (url: string, data?: any, config?: AxiosRequestConfig<any>) => any;
+};

package/dist/js/logic.d.ts

@@ -0,0 +1 @@
+export declare const setValue: (condition: any, value: any, def?: any) => any;

package/dist/js/navigator.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 浏览器引擎判断
+ *
+ * Gecke 火狐（Firefox）
+ * Blink (谷歌, 欧朋)
+ * WebKit （苹果，老版谷歌）
+ * Unknown （其他）
+ */
+export declare function browserEngine(): "Gecko" | "Blink" | "WebKit" | "Unknown";

package/dist/js/number.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 取近似值，取整
+ *
+ * @param num 数字
+ * @param factor 近似因子
+ * @returns 数字
+ *
+ * @ep
+ *
+ * Num(13,5)  // 15
+ *
+ * Num(1.264,0.01)  //1.26
+ *
+ */
+export declare const Num: (num: string | number, factor?: number) => number;

package/dist/js/object.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 从对象数组中获取匹配特定键值对的对象。
+ * @param objectArr 对象数组，每个对象至少包含一个键值对。
+ * @param keyName 需要匹配的键的名称。
+ * @param keyValue 需要匹配的键对应的值。可以是具体值或函数，如果为函数，则会将函数应用于数组中每个对象的键值进行匹配。
+ * @param foundKeyName 如果找到匹配的对象，从该对象中返回的键的名称。如果未指定，则返回整个对象。
+ * @returns 如果找到匹配的对象且指定了`foundKeyName`，则返回该键的值；如果未指定`foundKeyName`，则返回整个匹配的对象。如果没有找到匹配的对象，则返回一个空对象。
+ */
+export declare const getObject: (objectArr: Record<string, any>[], keyName: string, keyValue: any, foundKeyName?: string) => any;
+type DeepWritable<T> = {
+    -readonly [P in keyof T]: T[P] extends object ? DeepWritable<T[P]> : T[P];
+};
+/**
+ * 将源对象[src]的属性分配到目标对象[dist]，并递归地合并它们的属性。
+ * 如果源对象的属性是一个对象（且不是数组），则会递归地将其属性分配到目标对象的相应属性中。
+ * 如果源对象的属性是数组或其他类型，则直接覆盖目标对象的相应属性。
+ *
+ * @param dist 目标对象，其属性将被源对象的属性覆盖或合并。
+ * @param src 源对象，其属性将覆盖或合并到目标对象中。
+ * @returns 返回合并后的目标对象。
+ * @template T 目标对象和源对象的类型，该类型必须是可深度写入的对象类型。
+ */
+export declare const assignObject: <T extends DeepWritable<Record<string, any>>>(dist: T, src: T) => T;
+/**
+ * 此函数用来处理中间件向上透传方法 (仅用于Vue组件封装)
+ *
+ * @example
+ *
+ * com.vue
+ * !暴露form表单的所有方法，table表格的所有方法，以及onClick
+ * defineExpose( { onClick: () => { console.log('click') } }, formRef,tableRef)
+ * !父组件调用
+ * com.value.change() //调用表单change方法
+ * com.value.onClick() //调用onClick方法
+ *
+ * @param callback 回调函数，传onMounted
+ * @param option 默认暴露对象
+ * @param refs 要暴露的组件
+ * @returns 暴露对象
+ */
+export declare const expose: (option: any, ...refs: {
+    value: any;
+}[]) => any;
+/**
+ * 此函数用来处理中间件向上透传事件 (仅用于Vue组件封装)
+ *
+ * @param emit emit
+ * @param emitStrs
+ * @returns
+ */
+export declare const on: (emit: any, emitStrs: string[] | Object) => {};
+export {};

package/dist/js/string.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @deprecated 这个函数已弃用，请使用 toHump() 代替
+ */
+export declare const pathToHump: (path: any, isGreatHump?: boolean) => any;
+/**
+ * 将连接符字符串转换为驼峰字符串
+ *
+ * @param strings 字符串(列表)
+ * @param hyphenType 连接符
+ * @param isGreatHump 是否为大驼峰
+ * @returns humpString
+ */
+export declare const toHump: (strings: string | string[], hyphenType?: null | string, isGreatHump?: boolean) => string | string[];
+/**
+ * 将驼峰字符串转换为连接符字符串
+ *
+ * @param strings 字符串(列表)
+ * @param hyphenType 连接符
+ * @returns hyphenString
+ */
+export declare const toHyphen: (strings: string | string[], hyphenType?: string) => void | void[];
+/**
+ * 将object转换成query参数
+ *
+ * @param keyValue 对象
+ * @returns query参数
+ */
+export declare const query: (keyValue: object | null) => string;
+/**
+ *
+ * 将url 传参转成data格式
+ *
+ * @param url (?********)
+ * @returns
+ */
+export declare const urlToData: (url: string) => any[];
+/**
+ *
+ *  判断url格式
+ *
+ * @param url
+ * @returns
+ */
+export declare const isUrl: (path: string) => boolean;

package/dist/js/style.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @param px 像素或者数字
+ * @returns
+ */
+export declare function addPx(px?: number | string): string;

package/dist/js/time.d.ts

@@ -0,0 +1,77 @@
+import type { DateType } from '../type';
+/**
+ * @param callback 获取服务器时间的回调函数，需要返回服务器时间
+ *
+ * @example
+ *
+ * setTime(async () => {
+ *  return await getServerTime()
+ * })
+ *
+ */
+declare const setTime: (callback: () => Date | string | number) => Promise<void>;
+/**
+ * 获取服务器时间戳
+ *
+ * @returns 服务器时间戳
+ */
+declare const getTime: () => number;
+/** 时间格式化 （参考dayjs）
+ *
+ * @param date 时间
+ * @param formatStr 格式如下
+ * @returns 格式化后的时间
+ *
+ * @formatStr
+ *
+ * |格式	|输出|	描述|
+ * |----|----|----|
+ * |YY|	18	|两位数年份|
+ * |YYYY|	2018	|四位数年份|
+ * |M|	1-12	|月份，从 1 开始|
+ * |MM	|01-12	|月份，2 位数字|
+ * |D	|1-31	|该月的哪一天|
+ * |DD|	01-31|	月份中的日期，2 位数字|
+ * |h|	0-23|	小时|
+ * |hh	|00-23	|小时，2 位数字|
+ * |m|	0-59|	分钟|
+ * |mm	|00-59	|分钟，2 位数字|
+ * |s	|0-59|	秒钟|
+ * |ss	|00-59	|秒钟，2 位数字|
+ */
+declare const getDate: (date: Date | string | number | null | undefined, formatStr?: string) => string | Date;
+/** 获取特殊时间节点
+ *
+ * @param {'weekstart' | 'weekend' | 'monthstart' | 'monthend' | 'yearstart' | 'yearend' | 'weekbefore' |'weekafter'| 'monthbefore' | 'yearbefore' | 'yearafter'} dateType  获取特殊时间
+ * @param  {string } formatter 格式字符串或预设方案数字
+ *
+ * dateType:
+ *
+ *  - weekstart  —— 本周起始日期
+ *
+ *  - weekend    —— 本周结束日期
+ *
+ *  - weekbefore —— 一周前日期
+ *
+ *  - weekafter —— 一周后日期
+ *
+ *  - monthstart —— 本月起始日期
+ *
+ *  - monthend   —— 本月结束日期
+ *
+ *  - monthbefore—— 一个月前日期
+ *
+ *  - yearstart  —— 今年1月1日
+ *
+ *  - yearend    —— 今年12月31日
+ *
+ *  - yearbefore —— 一年前日期
+ *
+ *  - yearafter —— 一年后日期
+ *
+ * formatter: 参考 getDate
+ *
+ * @returns {Date | string}
+ */
+declare const getSpecialDate: (dateType: DateType, date?: Date | number | string | null, formatter?: any) => string | Date;
+export { setTime, getTime, getDate, getSpecialDate };

package/dist/js/tiny-color.d.ts

@@ -0,0 +1,288 @@
+interface TinyColorOptions {
+    format: string;
+    gradientType: string;
+}
+type Numberify<T> = {
+    [P in keyof T]: number;
+};
+type NumberOrString<T> = {
+    [P in keyof T]: number | string;
+};
+interface RGB {
+    r: number | string;
+    g: number | string;
+    b: number | string;
+}
+interface RGBA extends RGB {
+    a: number;
+}
+interface HSL {
+    h: number | string;
+    s: number | string;
+    l: number | string;
+}
+interface HSLA extends HSL {
+    a: number;
+}
+interface HSV {
+    h: number | string;
+    s: number | string;
+    v: number | string;
+}
+interface HSVA extends HSV {
+    a: number;
+}
+type ColorInput = string | number | RGB | RGBA | HSL | HSLA | HSV | HSVA | TinyColor;
+export declare class TinyColor {
+    private matchers;
+    private names;
+    private _originalInput;
+    private _r;
+    private _g;
+    private _b;
+    private _a;
+    private _roundA;
+    private _format;
+    private _gradientType;
+    private _ok;
+    isDark: boolean;
+    isLight: boolean;
+    isValid: boolean;
+    constructor(color?: ColorInput, opts?: Partial<TinyColorOptions>);
+    init(color?: ColorInput, opts?: Partial<TinyColorOptions>): void;
+    initAttr(): void;
+    private static initNames;
+    private initMatchers;
+    getBrightness(): number;
+    toRgb(): Numberify<RGBA>;
+    static getNames(): {
+        aliceblue: string;
+        antiquewhite: string;
+        aqua: string;
+        aquamarine: string;
+        azure: string;
+        beige: string;
+        bisque: string;
+        black: string;
+        blanchedalmond: string;
+        blue: string;
+        blueviolet: string;
+        brown: string;
+        burlywood: string;
+        burntsienna: string;
+        cadetblue: string;
+        chartreuse: string;
+        chocolate: string;
+        coral: string;
+        cornflowerblue: string;
+        cornsilk: string;
+        crimson: string;
+        cyan: string;
+        darkblue: string;
+        darkcyan: string;
+        darkgoldenrod: string;
+        darkgray: string;
+        darkgreen: string;
+        darkgrey: string;
+        darkkhaki: string;
+        darkmagenta: string;
+        darkolivegreen: string;
+        darkorange: string;
+        darkorchid: string;
+        darkred: string;
+        darksalmon: string;
+        darkseagreen: string;
+        darkslateblue: string;
+        darkslategray: string;
+        darkslategrey: string;
+        darkturquoise: string;
+        darkviolet: string;
+        deeppink: string;
+        deepskyblue: string;
+        dimgray: string;
+        dimgrey: string;
+        dodgerblue: string;
+        firebrick: string;
+        floralwhite: string;
+        forestgreen: string;
+        fuchsia: string;
+        gainsboro: string;
+        ghostwhite: string;
+        gold: string;
+        goldenrod: string;
+        gray: string;
+        green: string;
+        greenyellow: string;
+        grey: string;
+        honeydew: string;
+        hotpink: string;
+        indianred: string;
+        indigo: string;
+        ivory: string;
+        khaki: string;
+        lavender: string;
+        lavenderblush: string;
+        lawngreen: string;
+        lemonchiffon: string;
+        lightblue: string;
+        lightcoral: string;
+        lightcyan: string;
+        lightgoldenrodyellow: string;
+        lightgray: string;
+        lightgreen: string;
+        lightgrey: string;
+        lightpink: string;
+        lightsalmon: string;
+        lightseagreen: string;
+        lightskyblue: string;
+        lightslategray: string;
+        lightslategrey: string;
+        lightsteelblue: string;
+        lightyellow: string;
+        lime: string;
+        limegreen: string;
+        linen: string;
+        magenta: string;
+        maroon: string;
+        mediumaquamarine: string;
+        mediumblue: string;
+        mediumorchid: string;
+        mediumpurple: string;
+        mediumseagreen: string;
+        mediumslateblue: string;
+        mediumspringgreen: string;
+        mediumturquoise: string;
+        mediumvioletred: string;
+        midnightblue: string;
+        mintcream: string;
+        mistyrose: string;
+        moccasin: string;
+        navajowhite: string;
+        navy: string;
+        oldlace: string;
+        olive: string;
+        olivedrab: string;
+        orange: string;
+        orangered: string;
+        orchid: string;
+        palegoldenrod: string;
+        palegreen: string;
+        paleturquoise: string;
+        palevioletred: string;
+        papayawhip: string;
+        peachpuff: string;
+        peru: string;
+        pink: string;
+        plum: string;
+        powderblue: string;
+        purple: string;
+        rebeccapurple: string;
+        red: string;
+        rosybrown: string;
+        royalblue: string;
+        saddlebrown: string;
+        salmon: string;
+        sandybrown: string;
+        seagreen: string;
+        seashell: string;
+        sienna: string;
+        silver: string;
+        skyblue: string;
+        slateblue: string;
+        slategray: string;
+        slategrey: string;
+        snow: string;
+        springgreen: string;
+        steelblue: string;
+        tan: string;
+        teal: string;
+        thistle: string;
+        tomato: string;
+        turquoise: string;
+        violet: string;
+        wheat: string;
+        white: string;
+        whitesmoke: string;
+        yellow: string;
+        yellowgreen: string;
+    };
+    getOriginalInput(): ColorInput;
+    getFormat(): string;
+    getAlpha(): number;
+    getLuminance(): number;
+    setAlpha(value?: any): this;
+    toHsv(): Numberify<HSVA>;
+    toHsvString(): string;
+    toHsl(): Numberify<HSLA>;
+    toHslString(): string;
+    toHex(allow3Char?: boolean): string;
+    toHexString(allow3Char?: boolean): string;
+    toHex8(allow4Char?: boolean): string;
+    toHex8String(allow4Char?: boolean): string;
+    toRgbString(): string;
+    toPercentageRgb(): NumberOrString<RGBA>;
+    toPercentageRgbString(): string;
+    toName(): string | boolean;
+    toFilter(secondColor?: ColorInput): string;
+    toString(format?: string): any;
+    clone(): TinyColor;
+    private _applyModification;
+    private _lighten;
+    lighten(...args: any): TinyColor;
+    private _brighten;
+    brighten(...args: any): TinyColor;
+    private _darken;
+    darken(...args: any): TinyColor;
+    private _desaturate;
+    desaturate(...args: any): TinyColor;
+    private _saturate;
+    saturate(...args: any): TinyColor;
+    private _greyscale;
+    greyscale(...args: any): TinyColor;
+    private _spin;
+    spin(...args: any): TinyColor;
+    private _applyCombination;
+    private _analogous;
+    analogous(...args: any): TinyColor;
+    private _complement;
+    complement(...args: any): TinyColor;
+    private _monochromatic;
+    monochromatic(...args: any): TinyColor;
+    private _splitcomplement;
+    splitcomplement(...args: any): TinyColor;
+    private _triad;
+    triad(...args: any): TinyColor;
+    private _tetrad;
+    tetrad(...args: any): TinyColor;
+    static fromRatio(color: ColorInput, opts?: Partial<TinyColorOptions>): TinyColor;
+    static equals(color1: ColorInput, color2: ColorInput): boolean;
+    static random(): TinyColor;
+    static mix(color1: ColorInput, color2: ColorInput, amount?: number): TinyColor;
+    static readability(color1: ColorInput, color2: ColorInput): number;
+    static isReadable(color1: ColorInput, color2: ColorInput, wcag2?: any): boolean;
+    static mostReadable(baseColor: ColorInput, colorList: any[], args?: any): any;
+    private clamp01;
+    private _flip;
+    private isValidCSSUnit;
+    private isOnePointZero;
+    private isPercentage;
+    private pad2;
+    private bound01;
+    private convertDecimalToHex;
+    private rgbToRgb;
+    private hsvToRgb;
+    private hslToRgb;
+    private rgbToHsl;
+    private rgbToHsv;
+    private rgbToHex;
+    private rgbaToHex;
+    private rgbaToArgbHex;
+    private static convertToPercentage;
+    private boundAlpha;
+    private inputToRGB;
+    private parseIntFromHex;
+    private convertHexToDecimal;
+    private stringInputToObject;
+    private static validateWCAG2Parms;
+}
+export {};