@vtj/utils 0.0.1

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vtj/utils",
+  "private": false,
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "setup": "npm install --registry=https://registry.npmmirror.com",
+    "dev": "cross-env ENV_TYPE=dev vite",
+    "build": "vue-tsc && vite build && npm run build:cdn",
+    "build:cdn": "vue-tsc && cross-env CDN=true vite build",
+    "test:unit": "vitest"
+  },
+  "devDependencies": {
+    "@vtj/cli": "^0.0.2",
+    "@vtj/deps": "^0.0.1"
+  },
+  "files": [
+    "lib",
+    "types",
+    "cdn"
+  ],
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./lib/index.js"
+    }
+  },
+  "gitHead": "30f61dda4b0669f479d467845a57ce267fcdafb3",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/axios.d.ts

@@ -0,0 +1,4 @@
+import type { AxiosInstance } from 'axios';
+export * from 'axios';
+declare const instance: AxiosInstance;
+export default instance;

package/types/cookie.d.ts

@@ -0,0 +1,10 @@
+export interface ICookieOptions {
+    expires?: number;
+    path?: string;
+    domain?: string;
+    secure?: boolean;
+    sameSite?: string;
+}
+export declare function set(name: string, value: string, opts?: ICookieOptions): void;
+export declare function get(name: string): string | undefined;
+export declare function remove(name: string, opts?: ICookieOptions): void;

package/types/crypto.d.ts

@@ -0,0 +1 @@
+export declare function md5(content: string): string;

package/types/dayjs.d.ts

@@ -0,0 +1,2 @@
+import * as dayjs from 'dayjs';
+export { dayjs };

package/types/file.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @desc axios下载文件
+ * @author TangYong
+ * @param url 下载路径
+ * @param fileName 下载的文件名称及其后缀，后缀要和后台保持的一致
+ */
+export declare function downloadFile({ url, fileName }: {
+    url: string;
+    fileName: string;
+}): void;

package/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from './util';
+export * from './axios';
+export * from './request';
+export * from './raf';
+export * as cookie from './cookie';
+export * as storage from './storage';
+export * as crypto from './crypto';
+export * as url from './url';
+export * as file from './file';
+export { dayjs } from './dayjs';
+export { jsonp } from './jsonp';

package/types/jsonp.d.ts

@@ -0,0 +1,9 @@
+export interface JSONPOptions {
+    cache?: boolean;
+    timeout?: number;
+    prefix?: string;
+    param?: string;
+    name?: string;
+    script?: boolean;
+}
+export declare function jsonp<T>(url: string, params?: Record<string, any>, options?: JSONPOptions): Promise<T>;

package/types/raf.d.ts

@@ -0,0 +1,2 @@
+export declare const rAF: (fn: () => void) => number;
+export declare const cAF: (handle: number) => void;

package/types/request.d.ts

@@ -0,0 +1,47 @@
+import type { AxiosRequestConfig, AxiosResponse } from './axios';
+import { AxiosError } from './axios';
+import instance from './axios';
+declare const LOCAL_REQUEST_ID = "Local-Request-Id";
+export interface ApiResponse<T = any> {
+    code: number;
+    data: T | null;
+    msg: string;
+    success: boolean;
+    promise?: Promise<any>;
+}
+export interface ApiSettings<OriginResponse, ValidSuccess> {
+    loading?: boolean;
+    showLoading?: () => void;
+    hideLoading?: () => void;
+    loadingTime?: number;
+    type?: 'form' | 'json' | 'data';
+    originResponse?: OriginResponse;
+    validSuccess?: ValidSuccess;
+    validate?: (res: AxiosResponse) => boolean;
+    failMessage?: boolean;
+    showError?: (msg: string, e: AxiosError | AxiosResponse<ApiResponse>) => void;
+    injectHeaders?: (config: ApiRequestConfig) => Record<string, string>;
+    defaults?: Record<string, any>;
+    trim?: boolean;
+    picked?: boolean;
+    pickFilter?: (v: any) => boolean;
+    skipWarnResponseCode?: number;
+    skipWarnExecutor?: () => void;
+    skipWarnCallback?: () => void;
+    skipWarnFinally?: () => void;
+    skipWarn?: boolean;
+}
+export declare type ApiRequestConfig<RequestData = any, OriginResponse = boolean, ValidSuccess = boolean> = AxiosRequestConfig<RequestData> & {
+    settings?: ApiSettings<OriginResponse, ValidSuccess>;
+};
+declare const __settings__: ApiSettings<boolean, boolean>;
+export declare function setRequestSettings(settings: ApiSettings<boolean, boolean>): void;
+declare function request<Req = any, Res = any>(options: ApiRequestConfig<Req, false, true>, currentSettings?: ApiSettings<boolean, boolean>): Promise<Res>;
+declare function request<Req = any, Res = any>(options: ApiRequestConfig<Req, false, false>, currentSettings?: ApiSettings<boolean, boolean>): Promise<ApiResponse<Res>>;
+declare function request<Req = any, Res = any>(options: ApiRequestConfig<Req, true, boolean>, currentSettings?: ApiSettings<boolean, boolean>): Promise<AxiosResponse<ApiResponse<Res>>>;
+export declare function setRequest(success: any, fail?: any): any;
+export declare function setResponse(success: any, fail?: any): any;
+declare function createApi<Req = any, Res = any>(options: string | ApiRequestConfig<Req, false, true>): (data?: Req, currentSettings?: ApiSettings<boolean, boolean>) => Promise<Res>;
+declare function createApi<Req = any, Res = any>(options: string | ApiRequestConfig<Req, false, false>): (data?: Req, currentSettings?: ApiSettings<boolean, boolean>) => Promise<ApiResponse<Res>>;
+declare function createApi<Req = any, Res = any>(options: string | ApiRequestConfig<Req, true, boolean>): (data?: Req, currentSettings?: ApiSettings<boolean, boolean>) => Promise<AxiosResponse<ApiResponse<Res>>>;
+export { request, createApi, instance as axiosInstance, __settings__ as requestSettings, LOCAL_REQUEST_ID };

package/types/storage.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 缓存操作模块，提供sessionStorage和localStorage操作
+ * @module storage
+ * @author 陈华春
+ */
+/**
+ * 保存缓存
+ * @param {string} key 缓存key
+ * @param {String|Object|Array} value 缓存值，对象、数组类型自动JSON.stringify成字符串
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ * @param {number} [opts.expired=0] 过期时间，单位毫秒
+ * @param {string} [opts.prefix=__NewPearl__] key 前缀
+ */
+export declare function save(key: string, value?: any, opts?: {}): void;
+/**
+ * 获取缓存
+ * @param {string} key 缓存key
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ * @param {number} [opts.expired=0] 过期时间，单位毫秒
+ * @param {string} [opts.prefix=__NewPearl__] key 前缀
+ * @returns {String|Object|Array}
+ */
+export declare function get(key: string, opts?: {}): any;
+/**
+ * 删除缓存
+ * @param {string} key 缓存key
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ * @param {string} [opts.prefix=__NewPearl__] key 前缀
+ */
+export declare function remove(key: string, opts?: {}): void;
+/**
+ * 删除全部缓存
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ */
+export declare function clear(opts?: {}): void;
+declare const _default: {
+    save: typeof save;
+    get: typeof get;
+    remove: typeof remove;
+    clear: typeof clear;
+};
+export default _default;

package/types/url.d.ts

@@ -0,0 +1,44 @@
+export declare const UrlRegex: RegExp;
+export declare function isUrl(txt: string): boolean;
+/**
+ * 获取当前页面的 host
+ * @param {boolean} includePath 带上 pathname
+ * @return {string}
+ */
+export declare function getCurrentHost(includePath: boolean): string;
+/**
+ * 获取指定url的host
+ * @param {string} url
+ * @return {string} host
+ */
+export declare function getHost(url?: string): string;
+/**
+ * 键值对转换成查询字符串
+ * @param {object} query 键值对，对象
+ * @returns {string} 查询参数字符串
+ */
+export declare function stringify(query: Record<string, any>): string;
+/**
+ * 参数字符串转换成对象形式，如：a=1&b=2 转换成 {a:1, b:2}
+ * @param {String} str 需要转换的字符串
+ * @param {String} [sep=&] 连接符，可选，默认 &
+ * @param {String} [eq==] 键值间隔符，可选，默认 =
+ * @returns {Object}
+ */
+export declare function parse(str: string, sep?: string, eq?: string): Record<string, any>;
+/**
+ * 在url追加参数
+ * @param {string} url 原本的url
+ * @param {string|object} query 需要追加的参数，Object|String
+ * @returns {string} 追加参数后的url
+ */
+export declare function append(url: string, query: string | Record<string, any>): string;
+declare const _default: {
+    isUrl: typeof isUrl;
+    getCurrentHost: typeof getCurrentHost;
+    getHost: typeof getHost;
+    stringify: typeof stringify;
+    parse: typeof parse;
+    append: typeof append;
+};
+export default _default;

package/types/util.d.ts

@@ -0,0 +1,162 @@
+export { get, set, isPlainObject, cloneDeep, merge, debounce, throttle, isEqual, camelCase, upperFirst, template } from 'lodash-es';
+export declare function uid(): string;
+export declare function uuid(split?: boolean): string;
+export declare function isFunction(val: any): boolean;
+/**
+ * 判断传入的参数是否为null，undefined或者空字符串
+ * @param arg
+ * @return {boolean}
+ */
+export declare function isEmpty(arg: any): boolean;
+/**
+ * 判断字符串是否为空
+ * @param str
+ */
+export declare function isTrimEmpty(str: string): boolean;
+/**
+ * 判断传入的参数不为为null，undefined或者空字符串
+ * @param arg
+ * @return {boolean}
+ */
+export declare function isNotEmpty(arg: string | null | undefined): boolean;
+/**
+ * @desc 判断value是不是一个对象
+ * @param value
+ * @return boolean
+ */
+export declare function isObject(value: any): boolean;
+/**
+ * 提取对象属性
+ * @param object
+ * @param filter
+ * @returns
+ */
+export declare function pick(object: Record<string, any>, filter?: (v: any) => boolean): Record<string, any>;
+/**
+ * 递归对象或数组清除文本类型值的两边空格
+ * @param {Object|Array} obj
+ * @return {Object|Array}
+ */
+export declare function trim(obj: any): any;
+/**
+ * 截取几位小数
+ */
+export declare function toFixed(value: number, number: number | undefined, round: boolean): number;
+export declare function delay(val?: number): Promise<unknown>;
+/**
+ * @desc 判断value是不是一个布尔值
+ * @param value
+ * @return {boolean}
+ */
+export declare function isBoolean(value: any): boolean;
+/**
+ * 树拷贝
+ * @param source
+ * @param childrenProperty
+ * @param validate 校验元素是否需要拷贝的函数
+ * @param copyMethod 自定义复制方法，如果传入了copyMethod，propertyArray就变为无效
+ * @param propertyArray 需要拷贝的属性
+ * @return {array}
+ */
+export declare function copyTree({ source, childrenProperty, validate, copyMethod, propertyArray }: {
+    source: Array<any>;
+    childrenProperty: string;
+    validate?: Function;
+    copyMethod: Function;
+    propertyArray: Array<string>;
+}): any[];
+/**
+ * 对比两棵树是否一样
+ * @param reference
+ * @param target
+ * @param childrenProperty
+ * @param validate
+ * @return {boolean}
+ */
+export declare function compareTree({ reference, target, childrenProperty, validate }: {
+    reference: any;
+    target: any;
+    childrenProperty: string;
+    validate: Function;
+}): boolean;
+/**
+ * 获取所有的叶子节点
+ * @param tree
+ * @param childrenProperty
+ * @return {array}
+ */
+export declare function getLeafList({ tree, childrenProperty }: {
+    tree: Array<any>;
+    childrenProperty: string;
+}): any[];
+/**
+ * 阿里云oss图片路劲转换
+ * @return {string|*}
+ */
+export declare function ossTransferSrc({ src, width, height }: {
+    src: string;
+    width: number;
+    height: number;
+}): string;
+/**
+ * 将树转成二维数组
+ * @param tree
+ * @param childrenProperty
+ * @param validate 是否转换的校验函数，返回true/false
+ * @return {array}
+ */
+export declare function treeToMultiDimensionArray({ tree, childrenProperty, validate }: {
+    tree: Array<any>;
+    childrenProperty: string;
+    validate: Function;
+}): any[];
+/**
+ * @desc 获取树的深度
+ * @param tree 数组
+ * @param childrenProperty 子节点的属性名，默认是children
+ * @return {number} 返回深度值，如[]空数组是0， [{}]有一个元素是1, [{children[]}]也是1，[{children[{}]}]也是2
+ */
+export declare function getTreeDeep({ tree, childrenProperty }: {
+    tree: Array<any>;
+    childrenProperty: string;
+}): number;
+/**
+ * 将数组转成逗号分隔字符串
+ * @param source
+ * @param rowKey
+ * @return {string|*}
+ */
+export declare function fromArrayToCommaDivideString({ source, rowKey }: {
+    source: Array<any>;
+    rowKey: string;
+}): string;
+/**
+ * 将逗号分隔字符串转成数组
+ * @param source
+ * @param rowKey
+ * @return {*[]|any}
+ */
+export declare function fromCommaDivideStringToArray({ source, rowKey }: {
+    source: Array<any> | string;
+    rowKey: string;
+}): any[];
+/**
+ * 将数组转成json字符串
+ * @param source
+ * @param rowKey
+ * @return {string|*}
+ */
+export declare function fromArrayToJsonString({ source, rowKey }: {
+    source: Array<any>;
+    rowKey: string;
+}): string;
+/**
+ * 将json字符串转成数组
+ * @param source
+ * @param rowKey
+ * @return {*[]|any}
+ */
+export declare function fromJsonStringToArray({ source, rowKey }: {
+    source: Array<any> | string;
+    rowKey: string;
+}): any[];