@unicom-cloud/utils 0.1.11 → 0.1.13

package/types/tinycolor/src/index.d.ts

@@ -0,0 +1,214 @@
+import { CMYK, HSL, HSLA, HSV, HSVA, Numberify, RGB, RGBA } from './interfaces.js';
+export interface TinyColorOptions {
+    format: string;
+    gradientType: string;
+}
+export type ColorInput = string | number | RGB | RGBA | HSL | HSLA | HSV | HSVA | CMYK | TinyColor | unknown;
+export type ColorFormats = 'rgb' | 'prgb' | 'hex' | 'hex3' | 'hex4' | 'hex6' | 'hex8' | 'name' | 'hsl' | 'hsv' | 'cmyk';
+export declare class TinyColor {
+    /** red */
+    r: number;
+    /** green */
+    g: number;
+    /** blue */
+    b: number;
+    /** alpha */
+    a: number;
+    /** the format used to create the tinycolor instance */
+    format: ColorFormats;
+    /** input passed into the constructer used to create the tinycolor instance */
+    originalInput: ColorInput;
+    /** the color was successfully parsed */
+    isValid: boolean;
+    gradientType?: string;
+    /** rounded alpha */
+    roundA: number;
+    constructor(color?: ColorInput, opts?: Partial<TinyColorOptions>);
+    get ok(): boolean;
+    isDark(): boolean;
+    isLight(): boolean;
+    /**
+     * Returns the perceived brightness of the color, from 0-255.
+     */
+    getBrightness(): number;
+    /**
+     * Returns the perceived luminance of a color, from 0-1.
+     */
+    getLuminance(): number;
+    /**
+     * Returns the alpha value of a color, from 0-1.
+     */
+    getAlpha(): number;
+    /**
+     * Sets the alpha value on the current color.
+     *
+     * @param alpha - The new alpha value. The accepted range is 0-1.
+     */
+    setAlpha(alpha?: string | number): this;
+    /**
+     * Returns whether the color is monochrome.
+     */
+    isMonochrome(): boolean;
+    /**
+     * Returns the object as a HSVA object.
+     */
+    toHsv(): Numberify<HSVA>;
+    toHsv_(): Numberify<HSVA>;
+    /**
+     * Returns the hsva values interpolated into a string with the following format:
+     * "hsva(xxx, xxx, xxx, xx)".
+     */
+    toHsvString(): string;
+    /**
+     * Returns the object as a HSLA object.
+     */
+    toHsl(): Numberify<HSLA>;
+    /**
+     * Returns the hsla values interpolated into a string with the following format:
+     * "hsla(xxx, xxx, xxx, xx)".
+     */
+    toHslString(): string;
+    /**
+     * Returns the hex value of the color.
+     * @param allow3Char will shorten hex value to 3 char if possible
+     */
+    toHex(allow3Char?: boolean): string;
+    /**
+     * Returns the hex value of the color -with a # prefixed.
+     * @param allow3Char will shorten hex value to 3 char if possible
+     */
+    toHexString(allow3Char?: boolean): string;
+    /**
+     * Returns the hex 8 value of the color.
+     * @param allow4Char will shorten hex value to 4 char if possible
+     */
+    toHex8(allow4Char?: boolean): string;
+    /**
+     * Returns the hex 8 value of the color -with a # prefixed.
+     * @param allow4Char will shorten hex value to 4 char if possible
+     */
+    toHex8String(allow4Char?: boolean): string;
+    /**
+     * Returns the shorter hex value of the color depends on its alpha -with a # prefixed.
+     * @param allowShortChar will shorten hex value to 3 or 4 char if possible
+     */
+    toHexShortString(allowShortChar?: boolean): string;
+    /**
+     * Returns the object as a RGBA object.
+     */
+    toRgb(): Numberify<RGBA>;
+    toRgba(): Numberify<RGBA>;
+    toRgbArray(): number[];
+    toRgbArrayString(): string;
+    /**
+     * Returns the RGBA values interpolated into a string with the following format:
+     * "RGBA(xxx, xxx, xxx, xx)".
+     */
+    toRgbString(): string;
+    toRgbaString(): string;
+    /**
+     * Returns the object as a RGBA object.
+     */
+    toPercentageRgb(): RGBA;
+    /**
+     * Returns the RGBA relative values interpolated into a string
+     */
+    toPercentageRgbString(): string;
+    toCmyk(): Numberify<CMYK>;
+    toCmykString(): string;
+    /**
+     * The 'real' name of the color -if there is one.
+     */
+    toName(): string | false;
+    /**
+     * String representation of the color.
+     *
+     * @param format - The format to be used when displaying the string representation.
+     */
+    toString<T extends 'name'>(format: T): boolean | string;
+    toString<T extends ColorFormats>(format?: T): string;
+    toNumber(): number;
+    clone(): TinyColor;
+    /**
+     * Lighten the color a given amount. Providing 100 will always return white.
+     * @param amount - valid between 1-100
+     */
+    lighten(amount?: number): TinyColor;
+    /**
+     * Brighten the color a given amount, from 0 to 100.
+     * @param amount - valid between 1-100
+     */
+    brighten(amount?: number): TinyColor;
+    /**
+     * Darken the color a given amount, from 0 to 100.
+     * Providing 100 will always return black.
+     * @param amount - valid between 1-100
+     */
+    darken(amount?: number): TinyColor;
+    /**
+     * Mix the color with pure white, from 0 to 100.
+     * Providing 0 will do nothing, providing 100 will always return white.
+     * @param amount - valid between 1-100
+     */
+    tint(amount?: number): TinyColor;
+    /**
+     * Mix the color with pure black, from 0 to 100.
+     * Providing 0 will do nothing, providing 100 will always return black.
+     * @param amount - valid between 1-100
+     */
+    shade(amount?: number): TinyColor;
+    /**
+     * Desaturate the color a given amount, from 0 to 100.
+     * Providing 100 will is the same as calling greyscale
+     * @param amount - valid between 1-100
+     */
+    desaturate(amount?: number): TinyColor;
+    /**
+     * Saturate the color a given amount, from 0 to 100.
+     * @param amount - valid between 1-100
+     */
+    saturate(amount?: number): TinyColor;
+    /**
+     * Completely desaturates a color into greyscale.
+     * Same as calling `desaturate(100)`
+     */
+    greyscale(): TinyColor;
+    /**
+     * Spin takes a positive or negative amount within [-360, 360] indicating the change of hue.
+     * Values outside of this range will be wrapped into this range.
+     */
+    spin(amount: number): TinyColor;
+    /**
+     * Mix the current color a given amount with another color, from 0 to 100.
+     * 0 means no mixing (return current color).
+     */
+    mix(color: ColorInput, amount?: number): TinyColor;
+    analogous(results?: number, slices?: number): TinyColor[];
+    /**
+     * taken from https://github.com/infusion/jQuery-xcolor/blob/master/jquery.xcolor.js
+     */
+    complement(): TinyColor;
+    monochromatic(results?: number): TinyColor[];
+    splitcomplement(): TinyColor[];
+    /**
+     * Compute how the color would appear on a background
+     */
+    onBackground(background: ColorInput): TinyColor;
+    /**
+     * Alias for `polyad(3)`
+     */
+    triad(): TinyColor[];
+    /**
+     * Alias for `polyad(4)`
+     */
+    tetrad(): TinyColor[];
+    /**
+     * Get polyad colors, like (for 1, 2, 3, 4, 5, 6, 7, 8, etc...)
+     * monad, dyad, triad, tetrad, pentad, hexad, heptad, octad, etc...
+     */
+    polyad(n: number): TinyColor[];
+    /**
+     * compare color vs current color
+     */
+    equals(color?: ColorInput): boolean;
+}

package/types/tinycolor/src/interfaces.d.ts

@@ -0,0 +1,57 @@
+/**
+ * convert all properties in an interface to a number
+ */
+export type Numberify<T> = {
+    [P in keyof T]: number;
+};
+/**
+ * A representation of additive color mixing.
+ * Projection of primary color lights on a white screen shows secondary
+ * colors where two overlap; the combination of all three of red, green,
+ * and blue in equal intensities makes white.
+ */
+export interface RGB {
+    r: number | string;
+    g: number | string;
+    b: number | string;
+}
+export interface RGBA extends RGB {
+    a: number;
+}
+/**
+ * The HSL model describes colors in terms of hue, saturation,
+ * and lightness (also called luminance).
+ * @link https://en.wikibooks.org/wiki/Color_Models:_RGB,_HSV,_HSL#HSL
+ */
+export interface HSL {
+    h: number | string;
+    s: number | string;
+    l: number | string;
+}
+export interface HSLA extends HSL {
+    a: number;
+}
+/**
+ * The HSV, or HSB, model describes colors in terms of
+ * hue, saturation, and value (brightness).
+ * @link https://en.wikibooks.org/wiki/Color_Models:_RGB,_HSV,_HSL#HSV
+ */
+export interface HSV {
+    h: number | string;
+    s: number | string;
+    v: number | string;
+}
+export interface HSVA extends HSV {
+    a: number;
+}
+/**
+ * The CMYK color model is a subtractive color model used in the printing process.
+ * It described four ink palettes: Cyan, Magenta, Yellow, and Black.
+ * @link https://en.wikipedia.org/wiki/CMYK_color_model
+ */
+export interface CMYK {
+    c: number | string;
+    m: number | string;
+    y: number | string;
+    k: number | string;
+}

package/types/tinycolor/src/public_api.d.ts

@@ -0,0 +1,10 @@
+export * from './conversion.js';
+export * from './css-color-names.js';
+export * from './format-input.js';
+export * from './from-ratio.js';
+export * from './index.js';
+export * from './interfaces.js';
+export * from './random.js';
+export * from './readability.js';
+export * from './to-ms-filter.js';
+export * from './util.js';

package/types/tinycolor/src/random.d.ts

@@ -0,0 +1,24 @@
+import { TinyColor } from './index.js';
+export interface RandomOptions {
+    seed?: number;
+    hue?: number | string | 'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'monochrome';
+    luminosity?: 'random' | 'bright' | 'dark' | 'light';
+    alpha?: number;
+}
+export interface RandomCountOptions extends RandomOptions {
+    count?: number | null;
+}
+export declare function random(options?: RandomOptions): TinyColor;
+export declare function random(options?: RandomCountOptions): TinyColor[];
+/**
+ * @hidden
+ */
+export interface ColorBound {
+    name: string;
+    hueRange: [number, number] | null;
+    lowerBounds: Array<[number, number]>;
+}
+/**
+ * @hidden
+ */
+export declare const bounds: ColorBound[];

package/types/tinycolor/src/readability.d.ts

@@ -0,0 +1,46 @@
+import { ColorInput, TinyColor } from './index.js';
+/**
+ * AKA `contrast`
+ *
+ * Analyze the 2 colors and returns the color contrast defined by (WCAG Version 2)
+ */
+export declare function readability(color1: ColorInput, color2: ColorInput): number;
+export interface WCAG2Parms {
+    level?: 'AA' | 'AAA';
+    size?: 'large' | 'small';
+}
+/**
+ * Ensure that foreground and background color combinations meet WCAG2 guidelines.
+ * The third argument is an object.
+ *      the 'level' property states 'AA' or 'AAA' - if missing or invalid, it defaults to 'AA';
+ *      the 'size' property states 'large' or 'small' - if missing or invalid, it defaults to 'small'.
+ * If the entire object is absent, isReadable defaults to {level:"AA",size:"small"}.
+ *
+ * Example
+ * ```ts
+ * new TinyColor().isReadable('#000', '#111') => false
+ * new TinyColor().isReadable('#000', '#111', { level: 'AA', size: 'large' }) => false
+ * ```
+ */
+export declare function isReadable(color1: ColorInput, color2: ColorInput, wcag2?: WCAG2Parms): boolean;
+export interface WCAG2FallbackParms extends WCAG2Parms {
+    includeFallbackColors?: boolean;
+}
+/**
+ * Given a base color and a list of possible foreground or background
+ * colors for that base, returns the most readable color.
+ * Optionally returns Black or White if the most readable color is unreadable.
+ *
+ * @param baseColor - the base color.
+ * @param colorList - array of colors to pick the most readable one from.
+ * @param args - and object with extra arguments
+ *
+ * Example
+ * ```ts
+ * new TinyColor().mostReadable('#123', ['#124", "#125'], { includeFallbackColors: false }).toHexString(); // "#112255"
+ * new TinyColor().mostReadable('#123', ['#124", "#125'],{ includeFallbackColors: true }).toHexString();  // "#ffffff"
+ * new TinyColor().mostReadable('#a8015a', ["#faf3f3"], { includeFallbackColors:true, level: 'AAA', size: 'large' }).toHexString(); // "#faf3f3"
+ * new TinyColor().mostReadable('#a8015a', ["#faf3f3"], { includeFallbackColors:true, level: 'AAA', size: 'small' }).toHexString(); // "#ffffff"
+ * ```
+ */
+export declare function mostReadable(baseColor: ColorInput, colorList: ColorInput[], args?: WCAG2FallbackParms): TinyColor | null;

package/types/tinycolor/src/to-ms-filter.d.ts

@@ -0,0 +1,5 @@
+import { ColorInput } from './index.js';
+/**
+ * Returns the color represented as a Microsoft filter for use in old versions of IE.
+ */
+export declare function toMsFilter(firstColor: ColorInput, secondColor?: ColorInput): string;

package/types/tinycolor/src/umd_api.d.ts

@@ -0,0 +1,22 @@
+import { names } from './css-color-names.js';
+import { inputToRGB, isValidCSSUnit, stringInputToObject } from './format-input.js';
+import { fromRatio, legacyRandom } from './from-ratio.js';
+import { TinyColor } from './index.js';
+import { random } from './random.js';
+import { mostReadable, readability } from './readability.js';
+import { toMsFilter } from './to-ms-filter.js';
+export interface TinyColorUMD {
+    TinyColor: typeof TinyColor;
+    readability: typeof readability;
+    random: typeof random;
+    names: typeof names;
+    fromRatio: typeof fromRatio;
+    legacyRandom: typeof legacyRandom;
+    toMsFilter: typeof toMsFilter;
+    inputToRGB: typeof inputToRGB;
+    stringInputToObject: typeof stringInputToObject;
+    isValidCSSUnit: typeof isValidCSSUnit;
+    mostReadable: typeof mostReadable;
+}
+declare const tinycolorumd: TinyColorUMD;
+export default tinycolorumd;

package/types/tinycolor/src/util.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Take input from [0, n] and return it as [0, 1]
+ * @hidden
+ */
+export declare function bound01(n: any, max: number): number;
+/**
+ * Force a number between 0 and 1
+ * @hidden
+ */
+export declare function clamp01(val: number): number;
+/**
+ * Need to handle 1.0 as 100%, since once it is a number, there is no difference between it and 1
+ * <http://stackoverflow.com/questions/7422072/javascript-how-to-detect-number-as-a-decimal-including-1-0>
+ * @hidden
+ */
+export declare function isOnePointZero(n: string | number): boolean;
+/**
+ * Check to see if string passed in is a percentage
+ * @hidden
+ */
+export declare function isPercentage(n: string | number): boolean;
+/**
+ * Return a valid alpha value [0,1] with all invalid values being set to 1
+ * @hidden
+ */
+export declare function boundAlpha(a?: number | string): number;
+/**
+ * Replace a decimal with it's percentage value
+ * @hidden
+ */
+export declare function convertToPercentage(n: number | string): number | string;
+/**
+ * Force a hex value to have 2 characters
+ * @hidden
+ */
+export declare function pad2(c: string): string;

package/types/tree/index.d.ts

@@ -6,3 +6,4 @@ export function getLabelFromDictionaryByValue(a: any, value: any, 保底?: boole
 export function getChildWithParentBy(root: any, key: any, value: any, childrenKey?: string): null | undefined;
 export function getItemBy2(root: any, key: any, value: any, childrenKey?: string): any;
 export default getItemBy;
+export { default as searchTree } from "./search";

package/types/tree/search/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 基础原始类型定义（string/number/boolean/symbol/null/undefined）
+ */
+type Primitive = string | number | boolean | symbol | null | undefined;
+/**
+ * 条件值类型，可以是：
+ * 1. 原始值（Primitive）
+ * 2. 判断函数（接收节点值返回boolean）
+ * 3. 正则表达式
+ * @template T 节点值的泛型类型
+ */
+type ConditionValue<T = unknown> = Primitive | ((value: T) => boolean) | RegExp;
+/**
+ * 树搜索配置选项接口
+ */
+interface SearchOptions {
+    /**
+     * 遍历策略：广度优先(BFS)或深度优先(DFS)
+     * @default 'BFS'
+     */
+    strategy?: 'BFS' | 'DFS';
+    /**
+     * 子节点字段名
+     * @default 'children'
+     */
+    childrenKey?: string;
+    /**
+     * 是否启用严格模式比较（===）
+     * @default false
+     */
+    strict?: boolean;
+    /**
+     * 是否启用字符串模糊匹配
+     * @default false
+     */
+    fuzzyMatch?: boolean;
+    /**
+     * 是否返回所有匹配结果（否则返回第一个匹配）
+     * @default false
+     */
+    returnAllMatches?: boolean;
+    /**
+     * 字符串匹配是否区分大小写
+     * @default false
+     */
+    caseSensitive?: boolean;
+    /**
+     * 多条件匹配模式：AND（所有条件需满足）或OR（任一条件满足）
+     * @default 'AND'
+     */
+    matchMode?: 'AND' | 'OR';
+    /**
+     * 字符串匹配是否允许空字符
+     * @default false
+     */
+    allowEmptyString?: boolean;
+}
+/**
+ * 树节点接口定义
+ */
+interface TreeNode {
+    /**
+     * 动态属性（任意键值对）
+     */
+    [key: string]: unknown;
+    /**
+     * 子节点数组（可选）
+     */
+    children?: TreeNode[];
+}
+/**
+ * 高级树搜索函数
+ * @param treeData 要搜索的树数据（必须是数组）
+ * @param searchCondition 搜索条件对象（键值对）
+ * @param options 搜索配置选项
+ * @returns 返回匹配的节点或节点数组（根据returnAllMatches决定）
+ * @throws 当参数不符合要求时抛出TypeError或Error
+ */
+declare function searchTree(treeData: TreeNode[], searchCondition: Record<string, ConditionValue>, options?: SearchOptions): TreeNode | TreeNode[] | null;
+export default searchTree;

package/types/ui-color/compareColorByRange.d.ts

@@ -0,0 +1,2 @@
+export default compareColorByRange;
+declare function compareColorByRange(range?: number[]): (percentage?: number) => string;