@vtj/utils 0.0.5

package/src/storage.ts

@@ -0,0 +1,143 @@
+/**
+ * 缓存操作模块，提供sessionStorage和localStorage操作
+ * @module storage
+ * @author 陈华春
+ */
+
+/**
+ * sessionStorage
+ * @const
+ * @type {Storage}
+ */
+const SESSION = window.sessionStorage || {};
+
+/**
+ * localStorage
+ * @type {Storage}
+ */
+const LOCAL = window.localStorage || {};
+
+/**
+ * 内存缓存
+ * @type {{}}
+ */
+let CACHES: Record<string, any> = {};
+
+/**
+ * 存储方式映射
+ */
+const TYPES: Record<string, any> = {
+  local: LOCAL,
+  session: SESSION,
+  cache: CACHES
+};
+
+const defaultOptions = {
+  type: 'cache',
+  expired: 0,
+  prefix: '__NewPearl__'
+};
+
+/**
+ * 保存缓存
+ * @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 function save(key: string, value: any = '', opts = {}) {
+  if (!key) return;
+  const { type, expired, prefix } = { ...defaultOptions, ...opts };
+  const timestamp = Date.now();
+  const realKey = prefix + key;
+  const storage = TYPES[type] || CACHES;
+  const info = {
+    value,
+    timestamp,
+    expired
+  };
+  if (storage === CACHES) {
+    storage[realKey] = info;
+  } else {
+    storage.setItem(realKey, JSON.stringify(info));
+  }
+}
+
+/**
+ * 获取缓存
+ * @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 function get(key: string, opts = {}) {
+  if (!key) return;
+  const { type, prefix } = { ...defaultOptions, ...opts };
+  const realKey = prefix + key;
+  const storage = TYPES[type] || CACHES;
+  let info;
+  if (storage === CACHES) {
+    info = storage[realKey];
+  } else {
+    const content = storage.getItem(realKey);
+    if (content) {
+      info = JSON.parse(content);
+    }
+  }
+  // 不存在缓存
+  if (!info) return null;
+  const { value, timestamp, expired } = info;
+  // 缓存是否过期
+  const isExpired = expired > 0 && timestamp + expired < Date.now();
+  // 过期清空缓存，返回null
+  if (isExpired) {
+    remove(key, opts);
+    return null;
+  }
+  return value;
+}
+
+/**
+ * 删除缓存
+ * @param {string} key 缓存key
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ * @param {string} [opts.prefix=__NewPearl__] key 前缀
+ */
+export function remove(key: string, opts = {}) {
+  if (!key) return;
+  const { type, prefix } = { ...defaultOptions, ...opts };
+  const storage = TYPES[type] || CACHES;
+  const realKey = prefix + key;
+  if (storage === CACHES) {
+    delete storage[realKey];
+  } else {
+    storage.removeItem(realKey);
+  }
+}
+
+/**
+ * 删除全部缓存
+ * @param {object} [opts] 选项
+ * @param {Object} [opts.type=cache] 存储方式 local、 session、cache
+ */
+export function clear(opts = {}) {
+  const { type } = { ...defaultOptions, ...opts };
+  const storage = TYPES[type] || CACHES;
+  if (storage === CACHES) {
+    CACHES = {};
+  } else {
+    storage.clear();
+  }
+}
+
+export default {
+  save,
+  get,
+  remove,
+  clear
+};

package/src/url.ts

@@ -0,0 +1,102 @@
+export const UrlRegex = /^(http|https):\/\/[\w.:\-@]*/;
+
+export function isUrl(txt: string) {
+  return UrlRegex.test(txt);
+}
+
+/**
+ * 获取当前页面的 host
+ * @param {boolean} includePath 带上 pathname
+ * @return {string}
+ */
+export function getCurrentHost(includePath: boolean) {
+  const { protocol, host, pathname } = location;
+  return `${protocol}//${host}${includePath ? pathname : ''}`;
+}
+
+/**
+ * 获取指定url的host
+ * @param {string} url
+ * @return {string} host
+ */
+export function getHost(url: string = '') {
+  const matches = url.match(UrlRegex);
+  if (matches) {
+    return matches[0];
+  }
+  return '';
+}
+
+/**
+ * 键值对转换成查询字符串
+ * @param {object} query 键值对，对象
+ * @returns {string} 查询参数字符串
+ */
+export function stringify(query: Record<string, any>) {
+  const array = [];
+  for (const key in query) {
+    if (Object.prototype.hasOwnProperty.call(query, key)) {
+      array.push([key, encodeURIComponent(query[key])].join('='));
+    }
+  }
+  return array.join('&');
+}
+
+/**
+ * 参数字符串转换成对象形式，如：a=1&b=2 转换成 {a:1, b:2}
+ * @param {String} str 需要转换的字符串
+ * @param {String} [sep=&] 连接符，可选，默认 &
+ * @param {String} [eq==] 键值间隔符，可选，默认 =
+ * @returns {Object}
+ */
+export function parse(str: string, sep?: string, eq?: string) {
+  const obj: Record<string, any> = {};
+  str = (str || location.search).replace(/^[^]*\?/, '');
+  sep = sep || '&';
+  eq = eq || '=';
+  let arr;
+  const reg = new RegExp(
+    '(?:^|\\' +
+      sep +
+      ')([^\\' +
+      eq +
+      '\\' +
+      sep +
+      ']+)(?:\\' +
+      eq +
+      '([^\\' +
+      sep +
+      ']*))?',
+    'g'
+  );
+  while ((arr = reg.exec(str)) !== null) {
+    if (arr[1] !== str) {
+      obj[decodeURIComponent(arr[1])] = decodeURIComponent(arr[2] || '');
+    }
+  }
+  return obj;
+}
+
+/**
+ * 在url追加参数
+ * @param {string} url 原本的url
+ * @param {string|object} query 需要追加的参数，Object|String
+ * @returns {string} 追加参数后的url
+ */
+export function append(url: string, query: string | Record<string, any>) {
+  query = typeof query === 'string' ? parse(query) : query;
+  const path = url.split('?')[0];
+  const originalQuery = parse(url);
+  const joinQuery = Object.assign({}, originalQuery, query);
+  const queryStr = stringify(joinQuery);
+  return queryStr ? [path, queryStr].join('?') : url;
+}
+
+export default {
+  isUrl,
+  getCurrentHost,
+  getHost,
+  stringify,
+  parse,
+  append
+};

package/src/util.ts

@@ -0,0 +1,74 @@
+export {
+  get,
+  set,
+  isPlainObject,
+  cloneDeep,
+  merge,
+  debounce,
+  throttle,
+  isEqual
+} from 'lodash-es';
+
+export function uid() {
+  return Number(Math.random().toString().substring(2, 5) + Date.now()).toString(
+    36
+  );
+}
+
+export function isFunction(val: any): boolean {
+  return typeof val === 'function';
+}
+
+/**
+ * 提取对象属性
+ * @param object
+ * @param filter
+ * @returns
+ */
+export function pick(
+  object: Record<string, any>,
+  filter?: (v: any) => boolean
+) {
+  const obj: Record<string, any> = Object.create(null);
+  const match = filter || ((v) => v !== null && v !== undefined);
+  Object.entries(object).forEach(([n, v]) => {
+    if (match(v)) {
+      obj[n] = v;
+    }
+  });
+  return obj;
+}
+
+/**
+ * 递归对象或数组清除文本类型值的两边空格
+ * @param {Object|Array} obj
+ * @return {Object|Array}
+ */
+export function trim(obj: any): any {
+  const type = typeof obj;
+  if (type === 'string') {
+    return obj.trim();
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((n: any) => trim(n));
+  }
+  if (obj && type === 'object') {
+    Object.entries(obj).forEach(([k, v]) => {
+      obj[k] = trim(v);
+    });
+    return obj;
+  }
+  return obj;
+}
+
+/**
+ * 截取几位小数
+ * @param {number} value 浮点数
+ * @param {number} [number=2] 保留几位小数
+ * @param {boolean} [round] 是否四舍五入
+ * @returns {number}
+ */
+export function toFixed(value: number, number = 2, round: boolean) {
+  const method = round ? Math.round : Math.floor;
+  return method(Math.pow(10, number) * value) / Math.pow(10, number);
+}

package/types/dev/vite-env.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="vite/client" />
+
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue';
+  const component: DefineComponent<{}, {}, any>;
+  export default component;
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+declare module '@vtj/utils' {
+  //@ts-ignore
+  export * from '@vtj/utils/types/src/index';
+}

package/types/src/axios.d.ts

@@ -0,0 +1,2 @@
+import axios from 'axios';
+export { axios };

package/types/src/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/src/crypto.d.ts

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

package/types/src/dayjs.d.ts

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

package/types/src/index.d.ts

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

package/types/src/request.d.ts

@@ -0,0 +1,41 @@
+declare const instance: import("axios").AxiosInstance;
+export interface ISettings {
+    loading?: boolean;
+    showLoading?: () => void;
+    hideLoading?: () => void;
+    loadingTime?: 200;
+    type?: 'form' | 'json' | 'data';
+    originResponse?: boolean;
+    validSuccess?: boolean;
+    validate?: (res: any) => boolean;
+    failMessage?: boolean;
+    showError?: (msg: any) => void;
+    injectHeaders?: (options: IOptions) => 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;
+}
+declare const __settings__: ISettings;
+export declare function setConfig(config: ISettings): void;
+export interface IOptions {
+    url: string;
+    method?: 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
+    baseURL?: string;
+    headers?: Record<string, string>;
+    params?: any;
+    data?: any;
+    timeout?: number;
+    settings?: ISettings;
+}
+export declare type IApiOptions = string | IOptions;
+declare function request(options: IOptions, currentSettings?: ISettings): Promise<unknown>;
+export declare function createApi(options: IApiOptions): (data: any, currentOptions?: {}) => Promise<unknown>;
+export declare function setRequest(success: any, fail?: any): any;
+export declare function setResponse(success: any, fail?: any): any;
+export { request, instance as axiosInstance, __settings__ as RequestSettings };

package/types/src/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/src/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/src/util.d.ts

@@ -0,0 +1,24 @@
+export { get, set, isPlainObject, cloneDeep, merge, debounce, throttle, isEqual } from 'lodash-es';
+export declare function uid(): string;
+export declare function isFunction(val: 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;
+/**
+ * 截取几位小数
+ * @param {number} value 浮点数
+ * @param {number} [number=2] 保留几位小数
+ * @param {boolean} [round] 是否四舍五入
+ * @returns {number}
+ */
+export declare function toFixed(value: number, number: number | undefined, round: boolean): number;

package/types/src/utils.d.ts

@@ -0,0 +1,3 @@
+export { get, set, isPlainObject, cloneDeep, merge, debounce, throttle, isEqual } from 'lodash-es';
+export declare function uid(): string;
+export declare function isFunction(val: any): boolean;