@zcrkey/js-utils 0.0.11 → 0.0.15

package/dist/types/file.d.ts

@@ -0,0 +1,481 @@
+/**
+ * 文件类型
+ * - `UNKNOWN` 未知
+ * - `IMAGE` 图片
+ * - `VIDEO` 视频
+ * - `AUDIO` 音频
+ * - `DOCUMENT` 文档
+ * - `CAD` CAD / 工程图
+ * - `MODEL_3D` 3D 模型
+ * - `DIAGRAM`  流程图 / 思维导图
+ * - `ARCHIVE` 压缩包
+ */
+export declare enum FileTypeEnum {
+    /** 未知类型 */
+    UNKNOWN = "unknown",
+    /** 图片，如 jpg、png、svg */
+    IMAGE = "image",
+    /** 视频，如 mp4、webm、avi */
+    VIDEO = "video",
+    /** 音频，如 mp3、wav、flac */
+    AUDIO = "audio",
+    /** 文档，如 Office、PDF、代码、配置、电子书 */
+    DOCUMENT = "document",
+    /** 压缩包，如 zip、rar、7z */
+    ARCHIVE = "archive",
+    /** CAD / 工程图，如 dwg、dxf */
+    CAD = "cad",
+    /** 3D 模型，如 glb、obj、stl */
+    MODEL_3D = "model_3d",
+    /** 流程图 / 思维导图，如 vsdx、drawio、xmind */
+    DIAGRAM = "diagram"
+}
+/**
+ * 图片细分类型。
+ */
+export declare enum ImageTypeEnum {
+    JPG = "jpg",
+    JPEG = "jpeg",
+    PNG = "png",
+    WEBP = "webp",
+    GIF = "gif",
+    SVG = "svg",
+    BMP = "bmp",
+    PSD = "psd",
+    TIF = "tif",
+    TIFF = "tiff",
+    TGA = "tga",
+    EMF = "emf",
+    WMF = "wmf",
+    ICO = "ico",
+    HEIC = "heic",
+    AVIF = "avif",
+    UNKNOWN = "unknown"
+}
+/**
+ * 视频细分类型。
+ */
+export declare enum VideoTypeEnum {
+    MP4 = "mp4",
+    WEBM = "webm",
+    AVI = "avi",
+    M4V = "m4v",
+    MPG = "mpg",
+    MPEG = "mpeg",
+    M2V = "m2v",
+    M4P = "m4p",
+    OGV = "ogv",
+    WMV = "wmv",
+    MKV = "mkv",
+    MOV = "mov",
+    FLV = "flv",
+    UNKNOWN = "unknown"
+}
+/**
+ * 音频细分类型。
+ */
+export declare enum AudioTypeEnum {
+    MP3 = "mp3",
+    M4A = "m4a",
+    WAV = "wav",
+    AAC = "aac",
+    OGG = "ogg",
+    FLAC = "flac",
+    AC3 = "ac3",
+    AU = "au",
+    WMA = "wma",
+    AIF = "aif",
+    AIFC = "aifc",
+    AIFF = "aiff",
+    UNKNOWN = "unknown"
+}
+/**
+ * 文档细分类型。
+ */
+export declare enum DocumentTypeEnum {
+    PDF = "pdf",
+    OFD = "ofd",
+    DOC = "doc",
+    DOCX = "docx",
+    DOT = "dot",
+    DOTX = "dotx",
+    DOTM = "dotm",
+    DOCM = "docm",
+    WPS = "wps",
+    WPT = "wpt",
+    RTF = "rtf",
+    XLS = "xls",
+    XLSX = "xlsx",
+    XLSM = "xlsm",
+    XLT = "xlt",
+    XLTX = "xltx",
+    XLTM = "xltm",
+    ODS = "ods",
+    OTS = "ots",
+    FODS = "fods",
+    XLA = "xla",
+    XLAM = "xlam",
+    ET = "et",
+    ETT = "ett",
+    CSV = "csv",
+    PPT = "ppt",
+    PPTX = "pptx",
+    DPS = "dps",
+    DPT = "dpt",
+    PPTM = "pptm",
+    POT = "pot",
+    POTX = "potx",
+    POTM = "potm",
+    ODP = "odp",
+    OTP = "otp",
+    FODP = "fodp",
+    TXT = "txt",
+    MD = "md",
+    MARKDOWN = "markdown",
+    MDOWN = "mdown",
+    MKD = "mkd",
+    MKDN = "mkdn",
+    MDWN = "mdwn",
+    MDTXT = "mdtxt",
+    MDX = "mdx",
+    HTML = "html",
+    HTM = "htm",
+    XML = "xml",
+    XSD = "xsd",
+    XSL = "xsl",
+    XSLT = "xslt",
+    TEX = "tex",
+    LTX = "ltx",
+    BIB = "bib",
+    CLS = "cls",
+    STY = "sty",
+    INS = "ins",
+    DTX = "dtx",
+    RST = "rst",
+    LOG = "log",
+    CONF = "conf",
+    JS = "js",
+    JSX = "jsx",
+    MJS = "mjs",
+    CJS = "cjs",
+    TS = "ts",
+    TSX = "tsx",
+    VUE = "vue",
+    SVELTE = "svelte",
+    CSS = "css",
+    SCSS = "scss",
+    SASS = "sass",
+    LESS = "less",
+    JAVA = "java",
+    JSP = "jsp",
+    JSPX = "jspx",
+    JHTML = "jhtml",
+    TAG = "tag",
+    GROOVY = "groovy",
+    GVY = "gvy",
+    GSH = "gsh",
+    GRVY = "grvy",
+    SCALA = "scala",
+    SC = "sc",
+    KT = "kt",
+    KTS = "kts",
+    C = "c",
+    CPP = "cpp",
+    CC = "cc",
+    CXX = "cxx",
+    H = "h",
+    HPP = "hpp",
+    HXX = "hxx",
+    HH = "hh",
+    CS = "cs",
+    CSHTML = "cshtml",
+    RAZOR = "razor",
+    PY = "py",
+    PYW = "pyw",
+    PYT = "pyt",
+    PYX = "pyx",
+    PYO = "pyo",
+    RPY = "rpy",
+    GO = "go",
+    GOMOD = "gomod",
+    GOHTML = "gohtml",
+    PHP = "php",
+    PHP3 = "php3",
+    PHP4 = "php4",
+    PHP5 = "php5",
+    PHTML = "phtml",
+    PHPT = "phpt",
+    RB = "rb",
+    RAKE = "rake",
+    THOR = "thor",
+    RU = "ru",
+    LUA = "lua",
+    R = "r",
+    RMD = "rmd",
+    RNW = "rnw",
+    RS = "rs",
+    SWIFT = "swift",
+    DART = "dart",
+    PL = "pl",
+    PM = "pm",
+    T = "t",
+    POD = "pod",
+    ERL = "erl",
+    HRL = "hrl",
+    EX = "ex",
+    EXS = "exs",
+    HS = "hs",
+    LHS = "lhs",
+    SH = "sh",
+    BASH = "bash",
+    ZSH = "zsh",
+    FISH = "fish",
+    KSH = "ksh",
+    CSH = "csh",
+    TCSH = "tcsh",
+    BASHRC = "bashrc",
+    BASH_PROFILE = "bash_profile",
+    CMD = "cmd",
+    ASM = "asm",
+    S = "s",
+    M = "m",
+    MM = "mm",
+    OBJC = "objc",
+    OBJCPP = "objcpp",
+    JSON = "json",
+    GEOJSON = "geojson",
+    LDJSON = "ldjson",
+    JSON5 = "json5",
+    YAML = "yaml",
+    YML = "yml",
+    SQL = "sql",
+    PGSQL = "pgsql",
+    SQLITE = "sqlite",
+    DB = "db",
+    DB3 = "db3",
+    DSQL = "dsql",
+    GRADLE = "gradle",
+    CMAKE = "cmake",
+    GYP = "gyp",
+    TF = "tf",
+    TFVARS = "tfvars",
+    HCL = "hcl",
+    DOCKERFILE = "dockerfile",
+    GITIGNORE = "gitignore",
+    NGINX = "nginx",
+    EJS = "ejs",
+    JADE = "jade",
+    PUG = "pug",
+    VBHTML = "vbhtml",
+    SCHEMA = "schema",
+    HTTP = "http",
+    REST = "rest",
+    EPUB = "epub",
+    UNKNOWN = "unknown"
+}
+/**
+ * 压缩包细分类型。
+ */
+export declare enum ArchiveTypeEnum {
+    ZIP = "zip",
+    JAR = "jar",
+    RAR = "rar",
+    SEVEN_Z = "7z",
+    TAR = "tar",
+    TAR_GZ = "tar.gz",
+    TGZ = "tgz",
+    GZ = "gz",
+    UNKNOWN = "unknown"
+}
+/**
+ * CAD / 工程图细分类型。
+ */
+export declare enum CadTypeEnum {
+    DWG = "dwg",
+    DXF = "dxf",
+    UNKNOWN = "unknown"
+}
+/**
+ * 3D 模型细分类型。
+ */
+export declare enum Model3DTypeEnum {
+    GLTF = "gltf",
+    GLB = "glb",
+    OBJ = "obj",
+    STL = "stl",
+    FBX = "fbx",
+    PLY = "ply",
+    DAE = "dae",
+    WRL = "wrl",
+    THREE_DS = "3ds",
+    THREE_MF = "3mf",
+    THREE_DM = "3dm",
+    UNKNOWN = "unknown"
+}
+/**
+ * 流程图 / 思维导图细分类型。
+ */
+export declare enum DiagramTypeEnum {
+    VSD = "vsd",
+    VSDM = "vsdm",
+    VSDX = "vsdx",
+    VSSM = "vssm",
+    VSSX = "vssx",
+    VSTM = "vstm",
+    VSTX = "vstx",
+    BPMN = "bpmn",
+    DRAWIO = "drawio",
+    XMIND = "xmind",
+    UNKNOWN = "unknown"
+}
+/**
+ * 所有文件细分类型的统一联合类型。
+ */
+export type CrFileSubType = ImageTypeEnum | VideoTypeEnum | AudioTypeEnum | DocumentTypeEnum | ArchiveTypeEnum | CadTypeEnum | Model3DTypeEnum | DiagramTypeEnum;
+/**
+ * 文件元信息。
+ */
+export interface CrFileMeta {
+    /** 归一化后的扩展名，不包含点；复合后缀保留为 tar.gz */
+    ext: string;
+    /** 文件大类 */
+    type: FileTypeEnum;
+    /** 图片细分类，仅 IMAGE 类型有效 */
+    imageType?: ImageTypeEnum;
+    /** 视频细分类，仅 VIDEO 类型有效 */
+    videoType?: VideoTypeEnum;
+    /** 音频细分类，仅 AUDIO 类型有效 */
+    audioType?: AudioTypeEnum;
+    /** 文档细分类，仅 DOCUMENT 类型有效 */
+    documentType?: DocumentTypeEnum;
+    /** 压缩包细分类，仅 ARCHIVE 类型有效 */
+    archiveType?: ArchiveTypeEnum;
+    /** CAD 细分类，仅 CAD 类型有效 */
+    cadType?: CadTypeEnum;
+    /** 3D 模型细分类，仅 MODEL_3D 类型有效 */
+    model3DType?: Model3DTypeEnum;
+    /** 流程图 / 思维导图细分类，仅 DIAGRAM 类型有效 */
+    diagramType?: DiagramTypeEnum;
+    /** 统一细分类入口，等于当前大类对应的 xxxType 字段 */
+    subType?: CrFileSubType;
+}
+export declare class CrFileUtil {
+    /**
+     * 提取文件扩展名，不包含点。
+     *
+     * 未知或空文件名返回空字符串；复合后缀 tar.gz 会完整保留。
+     */
+    static getExt(filename?: string): string;
+    /**
+     * 获取文件完整元信息。
+     *
+     * 未识别扩展名会返回 UNKNOWN 大类，并保留原始扩展名。
+     */
+    static getMeta(filename: string): CrFileMeta;
+    /**
+     * 获取文件大类。
+     */
+    static getType(filename: string): FileTypeEnum;
+    /**
+     * 获取统一细分类型。
+     *
+     * 未知格式返回 undefined。
+     */
+    static getSubType(filename: string): CrFileSubType | undefined;
+    /**
+     * 获取文档细分类型。
+     *
+     * 非文档或未知格式返回 DocumentTypeEnum.UNKNOWN。
+     */
+    static getDocumentType(filename: string): DocumentTypeEnum;
+    /**
+     * 获取图片细分类型。
+     *
+     * 非图片或未知格式返回 ImageTypeEnum.UNKNOWN。
+     */
+    static getImageType(filename: string): ImageTypeEnum;
+    /**
+     * 获取视频细分类型。
+     *
+     * 非视频或未知格式返回 VideoTypeEnum.UNKNOWN。
+     */
+    static getVideoType(filename: string): VideoTypeEnum;
+    /**
+     * 获取音频细分类型。
+     *
+     * 非音频或未知格式返回 AudioTypeEnum.UNKNOWN。
+     */
+    static getAudioType(filename: string): AudioTypeEnum;
+    /**
+     * 获取压缩包细分类型。
+     *
+     * 非压缩包或未知格式返回 ArchiveTypeEnum.UNKNOWN。
+     */
+    static getArchiveType(filename: string): ArchiveTypeEnum;
+    /**
+     * 获取 CAD 细分类型。
+     *
+     * 非 CAD 或未知格式返回 CadTypeEnum.UNKNOWN。
+     */
+    static getCadType(filename: string): CadTypeEnum;
+    /**
+     * 获取 3D 模型细分类型。
+     *
+     * 非 3D 模型或未知格式返回 Model3DTypeEnum.UNKNOWN。
+     */
+    static getModel3DType(filename: string): Model3DTypeEnum;
+    /**
+     * 获取流程图 / 思维导图细分类型。
+     *
+     * 非流程图或未知格式返回 DiagramTypeEnum.UNKNOWN。
+     */
+    static getDiagramType(filename: string): DiagramTypeEnum;
+    /**
+     * 格式化文件大小。
+     *
+     * @param bytes 文件字节数
+     * @param fixed 小数位数
+     *
+     * @example
+     * 0 => 0 B
+     * 123 => 123.00B
+     * 1024 => 1.00KB
+     * 1500 => 1.46KB
+     * 1024 * 1024 => 1.00MB
+     * 1024 * 1024 * 3.5 => 3.50MB
+     * 1024 * 1024 * 1024 => 1.00GB
+     */
+    static formatFileSize(bytes: number, fixed?: number): string;
+    /**
+     * 判断是否为图片。
+     */
+    static isImage(filename: string): boolean;
+    /**
+     * 判断是否为视频。
+     */
+    static isVideo(filename: string): boolean;
+    /**
+     * 判断是否为音频。
+     */
+    static isAudio(filename: string): boolean;
+    /**
+     * 判断是否为文档。
+     */
+    static isDocument(filename: string): boolean;
+    /**
+     * 判断是否为压缩包。
+     */
+    static isArchive(filename: string): boolean;
+    /**
+     * 判断是否为 CAD / 工程图。
+     */
+    static isCad(filename: string): boolean;
+    /**
+     * 判断是否为 3D 模型。
+     */
+    static is3DModel(filename: string): boolean;
+    /**
+     * 判断是否为流程图 / 思维导图。
+     */
+    static isDiagram(filename: string): boolean;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './color';
+export * from './eventCenter';
+export * from './file';
+export * from './obj';
+export * from './storage';
+export * from './tree';
+export * from './util';

package/dist/types/obj.d.ts

@@ -0,0 +1,20 @@
+import { PropertyPath } from 'lodash';
+export type { PropertyPath };
+export declare class CrObjUtil {
+    /**
+     * 根据字段路径获取对象值
+     * @param obj { 'a': [{ 'b': { 'c': 3 } }] }
+     * @param path 'a[0].b.c' | ['a', '0', 'b', 'c']
+     * @param defaultValue 找不到时返回的默认值
+     * @returns
+     */
+    static getValueByPath(obj: Record<string | number | symbol, any>, propertyPath: PropertyPath, defaultValue?: any): any;
+    /**
+     * 根据字段路径设置对象值（可变更新，直接修改原对象）
+     * @param obj 要修改的原对象 { 'a': [{ 'b': { 'c': 3 } }] }
+     * @param propertyPath 路径 'a[0].b.c' | ['a', '0', 'b', 'c']
+     * @param value 要设置的值
+     * @returns 修改后的原对象（和入参obj是同一个引用）
+     */
+    static setValueByPath(obj: Record<string | number | symbol, any>, propertyPath: PropertyPath, value: any): Record<string | number | symbol, any>;
+}

package/dist/{esm → types}/storage.d.ts

@@ -1,4 +1,4 @@
-export default class CrStorage {
+export declare class CrStorage {
     /**
      * 设置本地存储
      * @param key

package/dist/{esm → types}/tree.d.ts

@@ -1,4 +1,4 @@
-export default class CrTreeUtil {
+export declare class CrTreeUtil {
     /**
      * 列表数据转树形数据
      * @param list

package/dist/{cjs → types}/util.d.ts

@@ -1,4 +1,4 @@
-export default class CrUtil {
+export declare class CrUtil {
     /**
      * 判断是否为数组
      * @param value
@@ -17,6 +17,12 @@ export default class CrUtil {
      * @returns boolean
      */
     static isEmptyObject(value: object): value is Record<string | number, never>;
+    /**
+     * 判断是否为空
+     * @param value
+     * @returns boolean
+     */
+    static isEmptyVal(value: unknown): boolean;
     /**
      * 判断是否对象的属性是否全部为空
      * @param value
@@ -59,6 +65,18 @@ export default class CrUtil {
      * @returns boolean
      */
     static isFunction(value: unknown): value is (...args: any[]) => any;
+    /**
+     * 是否为 URL
+     * @param path
+     * @returns boolean
+     */
+    static isUrl(path: string): boolean;
+    /**
+     * 是否为十六进制颜色值
+     * @param color 十六进制颜色值(#fff000、#f00)
+     * @returns boolean
+     */
+    static isHexColor(color: string): boolean;
     /**
      * 去掉字符串前后所有空格
      * @param str
@@ -74,14 +92,14 @@ export default class CrUtil {
     /**
      * 深拷贝
      * @param value
-     * @returns
+     * @returns T
      */
     static cloneDeep<T>(value: T): T;
     /**
      * 深拷贝
      * @param target
      * @deprecated 即将移除，使用 {@link CrUtil.cloneDeep} 替代
-     * @returns
+     * @returns T
      */
     static deepCopy<T = any>(target: T): T;
     /**
@@ -176,7 +194,9 @@ export default class CrUtil {
      * 根据 ids 获取相对应的数据名称
      * @param data
      * @param ids
-     * @param settings
+     * @param settings.sep
+     * @param settings.nameField
+     * @param settings.idField
      * @returns string
      */
     static getDataNameByIds<T extends Record<string, any>>(data: T[], ids: (string | number)[], settings?: {
@@ -197,7 +217,7 @@ export default class CrUtil {
      * 比较数据差异
      * @param data1
      * @param data2
-     * @returns
+     * @returns Record<string, "added" | "removed" | "modified">
      */
     static compareDataDiff(data1: any, data2: any): Record<string, "added" | "removed" | "modified">;
     /**
@@ -209,13 +229,13 @@ export default class CrUtil {
     /**
      * 格式化为千分位格式
      * @param value
-     * @returns
+     * @returns 12345.6789 => 12,345.6789
      */
     static formatThousands(value?: string | number): string;
     /**
      * 解析千分位格式
      * @param value
-     * @returns
+     * @returns 12,345.6789 => 12345.6789
      */
     static parseThousands(value?: string | number): string;
 }

package/package.json

@@ -1,35 +1,30 @@
 {
   "name": "@zcrkey/js-utils",
-  "version": "0.0.11",
+  "version": "0.0.15",
+  "private": false,
   "description": "一个 javascript 实用函数库",
   "keywords": [
     "js"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://cnb.cool/cnbkey/zcrkey/js-utils.git"
-  },
-  "license": "MIT",
   "exports": {
     ".": {
-      "require": "./dist/cjs/index.js",
-      "import": "./dist/esm/index.js"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js"
     }
   },
-  "main": "dist/cjs/index.js",
-  "unpkg": "dist/umd/index.umd.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/esm/index.d.ts",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "unpkg": "dist/index.umd.js",
+  "types": "dist/types/index.d.ts",
+  "source": "src/index.ts",
   "files": [
-    "dist",
-    "README.html"
+    "README.html",
+    "dist"
   ],
   "dependencies": {
-    "lodash": "^4.17.21",
-    "qs": "^6.11.2"
-  },
-  "publishConfig": {
-    "access": "public"
+    "lodash": "^4.18.1",
+    "qs": "^6.15.1"
   },
   "authors": [
     "zcr[774508556@qq.com]"