@vtj/utils 0.5.2 → 0.6.0

package/package.json

@@ -1,36 +1,45 @@
 {
   "name": "@vtj/utils",
   "private": false,
-  "version": "0.5.2",
+  "version": "0.6.0",
   "type": "module",
+  "sideEffects": false,
   "scripts": {
     "setup": "pnpm install --registry=https://registry.npmmirror.com",
-    "dev": "cross-env ENV_TYPE=dev vite",
     "build": "vue-tsc && vite build && pnpm run build:cdn",
-    "build:cdn": "vue-tsc && cross-env CDN=true vite build",
-    "test:unit": "vitest --environment jsdom",
-    "coverage": "vitest run --coverage --environment jsdom"
+    "build:cdn": "vue-tsc && cross-env CDN=true vite build"
   },
   "devDependencies": {
-    "@vtj/cli": "^0.5.2",
-    "@vtj/deps": "^0.5.2"
+    "@types/crypto-js": "~4.1.1",
+    "@types/js-cookie": "~3.0.3",
+    "@types/lodash-es": "~4.17.8",
+    "@types/numeral": "~2.0.2",
+    "@vtj/cli": "^0.6.0",
+    "@vueuse/core": "~10.4.1",
+    "axios": "~1.4.0",
+    "crypto-js": "~4.1.1",
+    "dayjs": "~1.11.9",
+    "js-cookie": "~3.0.5",
+    "jsencrypt": "~3.3.2",
+    "lodash-es": "~4.17.21",
+    "numeral": "~2.0.6"
   },
   "files": [
     "lib",
     "types",
     "cdn"
   ],
-  "main": "lib/index.js",
-  "module": "lib/index.js",
-  "types": "types/index.d.ts",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "types": "./types/index.d.ts",
   "exports": {
     ".": {
       "types": "./types/index.d.ts",
-      "import": "./lib/index.js",
-      "require": "./lib/index.js"
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs"
     }
   },
-  "gitHead": "c87d950274aeda770c2e38b485a4bcd23f39c5f7",
+  "gitHead": "a565aefeb62ea6b2c0df0312fc26788bc180388a",
   "publishConfig": {
     "access": "public"
   }

package/types/Request.d.ts

@@ -0,0 +1,115 @@
+import { AxiosInstance, CreateAxiosDefaults, AxiosResponse, AxiosRequestConfig, RawAxiosRequestHeaders, InternalAxiosRequestConfig, CancelTokenSource } from 'axios';
+declare const LOCAL_REQUEST_ID = "Local-Request-Id";
+export interface IRequestSkipWarn {
+    executor: (resolve: (value: unknown) => void, reject: (reason?: any) => void) => void;
+    code: string | number;
+    name?: string;
+    callback?: (res: AxiosResponse) => void;
+    complete?: () => void;
+}
+export interface IRequestSkipWarnResponse extends AxiosResponse {
+    promise: any;
+}
+export interface IResultWrapper<T = any> {
+    code: number;
+    data: T;
+    msg: string;
+    success: boolean;
+}
+export type RequestOriginResponse<R = any, D = any> = AxiosResponse<IResultWrapper<R>, D>;
+export interface IRequestSettings {
+    /**
+     * 发送数据类型
+     */
+    type?: 'form' | 'json' | 'data';
+    /**
+     * 请求头
+     */
+    headers?: RawAxiosRequestHeaders | ((config: AxiosRequestConfig) => RawAxiosRequestHeaders);
+    /**
+     * 是否显示 loading
+     */
+    loading?: boolean;
+    /**
+     * 显示 loading
+     */
+    showLoading?: () => void;
+    /**
+     * 关闭 loading
+     */
+    hideLoading?: () => void;
+    /**
+     * 显示失败提示
+     */
+    failMessage?: boolean;
+    /**
+     * 自定义失败提示
+     */
+    showError?: (msg: string, e: any) => void;
+    /**
+     *  返回原始 axios 响应对象
+     */
+    originResponse?: boolean;
+    /**
+     * 校验响应成功
+     */
+    validSuccess?: boolean;
+    /**
+     * 自定义校验方法
+     */
+    validate?: (res: AxiosResponse) => boolean;
+    /**
+     * 请求响应警告执行程序插件
+     */
+    skipWarn?: IRequestSkipWarn;
+}
+export interface IRequestOptions extends CreateAxiosDefaults {
+    settings?: IRequestSettings;
+}
+export interface IRequestConfig<D = any> extends AxiosRequestConfig<D> {
+    settings?: IRequestSettings;
+    query?: Record<string, any>;
+}
+export interface IRequestRecord {
+    settings: IRequestSettings;
+    config: AxiosRequestConfig;
+    source: CancelTokenSource;
+}
+export declare class Request {
+    axios: AxiosInstance;
+    settings: IRequestSettings;
+    records: Record<string, IRequestRecord>;
+    private isLoading;
+    private stopSkipWarn?;
+    private showLoading;
+    private showError;
+    constructor(options?: IRequestOptions);
+    setConfig(options?: IRequestOptions): void;
+    cancel(id?: string, message?: string): void;
+    private createHeaders;
+    private isJsonType;
+    private toFormData;
+    private createSendData;
+    private createUrl;
+    private openLoading;
+    private closeLoading;
+    private _showError;
+    private validResponse;
+    private isSkipWarnResponse;
+    send<R = any, D = any>(options?: IRequestConfig<D>, isSkipWarn?: boolean): Promise<R>;
+    useResponse(onFulfilled?: ((value: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>) | null, onRejected?: ((error: any) => any) | null): () => void;
+    useRequest(onFulfilled?: ((value: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>) | null, onRejected?: ((error: any) => any) | null): () => void;
+    private setupSkipWarn;
+}
+export interface IStaticRequest extends Request {
+    (options: IRequestConfig): Promise<AxiosResponse>;
+    instance: Request;
+}
+export declare function createRequest(options?: IRequestOptions): IStaticRequest;
+export declare const request: IStaticRequest;
+export declare function createApi<R = any, D = any>(config: string | IRequestConfig): (data?: D, opts?: IRequestConfig) => Promise<R>;
+export interface IApiMap {
+    [name: string]: string | IRequestConfig;
+}
+export declare function createApis(map: IApiMap): Record<string, (data?: unknown, opts?: IRequestConfig<any> | undefined) => Promise<unknown>>;
+export { LOCAL_REQUEST_ID };

package/types/Storage.d.ts

@@ -0,0 +1,31 @@
+export interface StorageOptions {
+    /**
+     * 存储类型
+     */
+    type: 'cache' | 'local' | 'session';
+    /**
+     * 在多少毫秒后失效, 0为永不过期
+     */
+    expired: number;
+    /**
+     * key前缀
+     */
+    prefix: string;
+}
+export interface StorageTypes {
+    local: any;
+    session: any;
+    cache: any;
+}
+export declare class Storage {
+    options: StorageOptions;
+    private caches;
+    private types;
+    constructor(options?: Partial<StorageOptions>);
+    config(options?: Partial<StorageOptions>): void;
+    save(key: string, value: any, opts?: Partial<StorageOptions>): void;
+    get(key: string, opts?: Partial<StorageOptions>): any;
+    remove(key: string, opts?: Partial<StorageOptions>): void;
+    clear(opts?: Partial<StorageOptions>): void;
+}
+export declare const storage: Storage;

package/types/crypto.d.ts

@@ -1 +1,2 @@
 export declare function md5(content: string): string;
+export declare function RSA(key: string, content: string): string | false;

package/types/dayjs.d.ts

@@ -1,2 +1,3 @@
-import * as dayjs from 'dayjs';
+import dayjs from 'dayjs';
+export declare function dateFormat(date: string | number | Date, format?: string): string;
 export { dayjs };

package/types/index.d.ts

@@ -1,10 +1,12 @@
+export * from './version';
 export * from './util';
-export * from './axios';
-export * from './request';
+export * from './Request';
 export * from './raf';
+export * from './dayjs';
+export * from './numeral';
+export * from './Storage';
+export * from './regex';
 export * as cookie from './cookie';
-export * as storage from './storage';
 export * as crypto from './crypto';
 export * as url from './url';
-export { dayjs } from './dayjs';
 export { jsonp } from './jsonp';

package/types/jsonp.d.ts

@@ -1,5 +1,5 @@
 export interface JSONPOptions {
-    cache?: boolean;
+    cache?: boolean | string;
     timeout?: number;
     prefix?: string;
     param?: string;

package/types/numeral.d.ts

@@ -0,0 +1,3 @@
+import numeral from 'numeral';
+export declare function numberFormat(value: number, format: string): string;
+export { numeral };

package/types/regex.d.ts

@@ -0,0 +1,11 @@
+export declare const URL_REGEX: RegExp;
+export declare const EMAIL_REGEX: RegExp;
+export declare const ID_NUMBER_REGEX: RegExp;
+export declare const MOBILE_PHONE_REGEX: RegExp;
+export declare const CAR_NUMBER_NEW_REGEX: RegExp;
+export declare const CAR_NUMBER_REGEX: RegExp;
+export declare function isUrl(str: string): boolean;
+export declare function isEmail(str: string): boolean;
+export declare function isIdNumber(str: string): boolean;
+export declare function isMobilePhone(str: string): boolean;
+export declare function isCarNo(str: string): boolean;

package/types/url.d.ts

@@ -2,43 +2,21 @@ 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;
+export declare function getCurrentHost(includePath: boolean): string | null;
 /**
  * 获取指定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

@@ -1,17 +1,54 @@
 import { upperFirst, camelCase } from 'lodash-es';
 export { get, set, isPlainObject, cloneDeep, merge, debounce, throttle, isEqual, template, lowerFirst, kebabCase } from 'lodash-es';
 export { upperFirst, camelCase };
+/**
+ * 是否浏览器环境
+ */
+export declare const isClient: boolean;
+/**
+ * 已定义
+ * @param val
+ * @returns
+ */
+export declare const isDef: (val: unknown) => boolean;
+/**
+ * 当前时间
+ * @returns
+ */
+export declare const now: () => number;
+/**
+ * 时间戳
+ * @returns
+ */
+export declare const timestamp: () => number;
+/**
+ * 随机数
+ * @param min
+ * @param max
+ * @returns
+ */
+export declare const rand: (min: number, max: number) => number;
 export declare function uid(): string;
 export declare function uuid(split?: boolean): string;
-export declare function isFunction(val: any): boolean;
+export declare function isFunction(val: any): val is (...args: any[]) => any;
+export declare function isObject(value: any): value is Record<string, unknown>;
+export declare function isString(value: any): value is string;
+export declare function isUndefined(value: any): boolean;
 export declare function upperFirstCamelCase(name: string): string;
 /**
- * 提取对象属性
- * @param object
- * @param filter
+ * 对象排除属性
+ * @param target 需要处理的对象
+ * @param keys 需要排除的属性名称
+ * @returns
+ */
+export declare function omit<T extends Record<string, any>, K extends Record<string, any>>(target: T, keys: string[] | ((k: string, v: any) => boolean)): K;
+/**
+ * 对象提取属性
+ * @param target
+ * @param keys
  * @returns
  */
-export declare function pick(object: Record<string, any>, filter?: (v: any) => boolean): Record<string, any>;
+export declare function pick<T extends Record<string, any>, K extends Record<string, any>>(target: T, keys: string[] | ((k: string, v: any) => boolean)): K;
 /**
  * 递归对象或数组清除文本类型值的两边空格
  * @param {Object|Array} obj
@@ -23,3 +60,6 @@ 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>;
+export declare function arrayToMap<T>(data: T[], prop: keyof T): Map<any, T>;
+export declare function mapToObject<V = any>(map: Map<any, V>): Record<any, V>;
+export declare function dedupArray<T>(array: any[], prop?: keyof T): any[];

package/types/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "0.6.0";