@gx-design-vue/create-gx-cli 0.0.4 → 0.0.5

package/template-design-pro/src/utils/request/axiosCancel.ts

@@ -0,0 +1,60 @@
+import type { AxiosRequestConfig, Canceler } from 'axios'
+import axios from 'axios'
+import { isFunction } from '@gx-design-vue/pro-utils'
+
+// Used to store the identification and cancellation function of each request
+let pendingMap = new Map<string, Canceler>()
+
+export const getPendingUrl = (config: AxiosRequestConfig) => [ config.method, config.url ].join('&')
+
+export class AxiosCanceler {
+  /**
+   * Add request
+   * @param {Object} config
+   */
+  addPending(config: AxiosRequestConfig) {
+    this.removePending(config)
+    const url = getPendingUrl(config)
+    config.cancelToken =
+      config.cancelToken ||
+      new axios.CancelToken((cancel) => {
+        if (!pendingMap.has(url)) {
+          // If there is no current request in pending, add it
+          pendingMap.set(url, cancel)
+        }
+      })
+  }
+
+  /**
+   * @description: Clear all pending
+   */
+  removeAllPending() {
+    pendingMap.forEach((cancel) => {
+      cancel && isFunction(cancel) && cancel()
+    })
+    pendingMap.clear()
+  }
+
+  /**
+   * Removal request
+   * @param {Object} config
+   */
+  removePending(config: AxiosRequestConfig) {
+    const url = getPendingUrl(config)
+
+    if (pendingMap.has(url)) {
+      // If there is a current request identifier in pending,
+      // the current request needs to be cancelled and removed
+      const cancel = pendingMap.get(url)
+      cancel && cancel(url)
+      pendingMap.delete(url)
+    }
+  }
+
+  /**
+   * @description: reset
+   */
+  reset(): void {
+    pendingMap = new Map<string, Canceler>()
+  }
+}

package/template-design-pro/src/utils/request/checkStatus.ts

@@ -0,0 +1,26 @@
+import { useStoreUser } from '@/store'
+import { message } from 'ant-design-vue'
+import { router } from '@/router'
+
+/**
+ * @author gx12358 2539306317@qq.com
+ * @description 处理code异常
+ * @param {*} code
+ * @param {*} msg
+ */
+export const handleCode = (code: number, msg: string) => {
+  const user = useStoreUser()
+  switch (code) {
+    case 401:
+      message.error(msg || '登录失效')
+      user.resetPermissions()
+      router.push({ path: '/user/login' })
+      break
+    case 403:
+      router.push({ path: '/exception/403' })
+      break
+    default:
+      message.error(msg || `后端接口${code}异常`)
+      break
+  }
+}

package/template-design-pro/src/utils/request/index.ts

@@ -0,0 +1,145 @@
+import { message } from 'ant-design-vue'
+import config from '/config/config'
+import { useStoreUser } from '@/store'
+import { isDev } from '@/utils/env'
+import { tansParams } from '@/utils/util'
+import { checkURL } from '@/utils/validate'
+import { isBoolean } from '@gx-design-vue/pro-utils'
+import { GAxios } from './XHR'
+import type { XhtInstance } from './typings'
+import { RequestEnum } from './typings'
+import type { GAxiosOptions } from './typings'
+import { handleCode } from './checkStatus'
+
+const { tokenName, requestPrefix } = config.defaultSettings
+
+const { contentType, requestTimeout, successCode } = config.network
+
+const xhtInstance: XhtInstance = {
+  /**
+   * @description: 处理响应数据。如果数据不是预期格式，可直接抛出错误
+   */
+  transformResponseHook: (res, options) => {
+    const { customize, isReturnNativeResponse } = options
+    // 是否返回原生响应头 比如：需要获取响应头时使用该属性
+    if (isReturnNativeResponse) {
+      return res
+    }
+    // 不进行任何处理，直接返回
+    // 用于页面代码可能需要直接获取code，data，message这些信息时开启
+    if (customize) {
+      return res.data
+    }
+    // 错误的时候返回
+
+    const { data }: { data: ResponseResult } = res
+    if (!data) {
+      throw new Error('请求出错，请稍候重试')
+    }
+    //  这里 code，result，message为 后台统一的字段，需要在 types.ts内修改为项目自己的接口返回格式
+    const { code, msg = '', message = '' } = data
+
+    const codeVerificationArray = successCode
+
+    // 这里逻辑可以根据项目进行修改
+    const hasSuccess = codeVerificationArray.includes(code)
+    if (hasSuccess) {
+      return data
+    }
+
+    // 在此处根据自己项目的实际情况对不同的code执行不同的操作
+    // 如果不希望中断当前请求，请return数据，否则直接抛出异常即可
+    handleCode(code, message || msg)
+
+    return Promise.resolve(false)
+  },
+
+  // 请求之前处理config
+  beforeRequestHook: (config) => {
+    // get请求映射params参数
+    if (config.method?.toUpperCase() === RequestEnum.GET && config.params) {
+      let url = config.url + '?' + tansParams(config.params)
+      url = url.slice(0, -1)
+      config.params = {}
+      config.url = url
+    }
+
+    if (!checkURL(config.url)) {
+      if (config.isMock) {
+        config.url = `/mock-server${config.url}`
+      } else {
+        config.url = `${import.meta.env.VITE_BASE_URL}${isDev ? requestPrefix || '' : ''}${config.url}`
+      }
+    }
+
+    return config
+  },
+
+  /**
+   * @description: 请求拦截器处理
+   */
+  requestInterceptors: (config) => {
+    const user = useStoreUser()
+    const carryToken = isBoolean(config.carryToken) ? config.carryToken : true
+    if (user.accessToken && carryToken)
+      config.headers[tokenName] = user.accessToken
+    return config
+  },
+
+  /**
+   * @description: 响应拦截器处理
+   */
+  responseInterceptors: (res) => {
+    return res
+  },
+
+  /**
+   * @description: 响应错误处理
+   */
+  responseInterceptorsCatch: (error: any) => {
+    const { response } = error
+    let errorMessage = error.message || ''
+    if (error.response && error.response.data) {
+      const { status } = response
+      handleCode(status, errorMessage)
+      return Promise.resolve(false)
+    } else {
+      if (errorMessage === 'Network Error') {
+        errorMessage = '后端接口连接异常'
+      }
+      if (errorMessage.includes('timeout')) {
+        errorMessage = '后端接口请求超时'
+      }
+      if (errorMessage.includes('Request failed with status code')) {
+        const code = errorMessage.substr(errorMessage.length - 3)
+        errorMessage = '后端接口' + code || '' + '异常'
+      }
+      message.error(errorMessage || `后端接口未知异常`)
+      return Promise.resolve(false)
+    }
+  },
+  /**
+   * @description: 处理响应错误数据
+   */
+  requestCatchHook: () => false
+}
+
+function createXhr(opt ?: Partial<GAxiosOptions>) {
+  return new GAxios({
+    method: 'get',
+    timeout: requestTimeout,
+    headers: {
+      'Content-Type': contentType
+    },
+    // 忽略重复请求
+    ignoreCancelToken: true,
+    // 是否携带token
+    carryToken: true,
+    ...xhtInstance,
+    ...opt
+  })
+}
+
+const request: (opt?: GAxiosOptions) => Promise<ResponseResult> = (opt) => createXhr().request(opt)
+
+export default request

package/template-design-pro/src/utils/request/typings.ts

@@ -0,0 +1,114 @@
+import type { AxiosRequestConfig, AxiosResponse, Axios, AxiosPromise } from 'axios'
+
+export type XhtInstance = {
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/1/6
+   * @lastTime    2023/1/6
+   * @description 请求之前处理config
+   */
+  beforeRequestHook?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @description: 处理响应数据
+   */
+  transformResponseHook?: (res: AxiosResponse, options: GAxiosOptions) => any;
+
+  /**
+   * @description: 请求失败处理
+   */
+  requestCatchHook?: (e: Error) => boolean;
+
+  /**
+   * @description: 请求之前的拦截器
+   */
+  requestInterceptors?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @description: 请求之后的拦截器
+   */
+  responseInterceptors?: (res: AxiosResponse) => AxiosResponse;
+
+  /**
+   * @description: 请求之前的拦截器错误处理
+   */
+  requestInterceptorsCatch?: (error: Error) => void;
+
+  /**
+   * @description: 请求之后的拦截器错误处理
+   */
+  responseInterceptorsCatch?: (axiosInstance: GAxiosInstance, error: Error) => void;
+}
+
+export interface GAxiosOptions extends AxiosRequestConfig {
+  headers?: Recordable;
+  isMock?: boolean; // 是否是mock
+  isReturnNativeResponse?: boolean; // 直接返回response，不作任何处理（包含响应值等基本信息）
+  customize?: boolean; // 直接返回response.data（接口返回值），错误不做统一提示
+  carryToken?: boolean; // 是否携带token
+  ignoreCancelToken?: boolean; // 忽略重复请求
+  /**
+   * @Author      gx12358
+   * @DateTime    2023/1/6
+   * @lastTime    2023/1/6
+   * @description 请求之前处理config
+   */
+  beforeRequestHook?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @description: 处理响应数据
+   */
+  transformResponseHook?: (res: AxiosResponse, options: GAxiosOptions) => any;
+
+  /**
+   * @description: 请求失败处理
+   */
+  requestCatchHook?: (e: Error) => boolean;
+
+  /**
+   * @description: 请求之前的拦截器
+   */
+  requestInterceptors?: (config: GAxiosOptions) => GAxiosOptions;
+
+  /**
+   * @description: 请求之后的拦截器
+   */
+  responseInterceptors?: (res: AxiosResponse) => AxiosResponse;
+
+  /**
+   * @description: 请求之前的拦截器错误处理
+   */
+  requestInterceptorsCatch?: (error: Error) => void;
+
+  /**
+   * @description: 请求之后的拦截器错误处理
+   */
+  responseInterceptorsCatch?: (axiosInstance: GAxiosInstance, error: Error) => void;
+}
+
+export interface GAxiosInstance extends Axios {
+  (config: GAxiosOptions): AxiosPromise<ResponseResult>;
+
+  (url: string, config?: GAxiosOptions): AxiosPromise<ResponseResult>;
+}
+
+/**
+ * @description: request method
+ */
+export enum RequestEnum {
+  GET = 'GET',
+  POST = 'POST',
+  PUT = 'PUT',
+  DELETE = 'DELETE',
+}
+
+/**
+ * @description:  contentType
+ */
+export enum ContentTypeEnum {
+  // json
+  JSON = 'application/json;charset=UTF-8',
+  // form-data qs
+  FORM_URLENCODED = 'application/x-www-form-urlencoded;charset=UTF-8',
+}
+

package/template-design-pro/src/utils/storage.ts

@@ -0,0 +1,194 @@
+import dayjs from 'dayjs'
+import config from '/config/config'
+import { isPro } from '@/utils/env'
+import { Decrypt, Encrypt } from '@/utils/crypto'
+import { isJSONStr } from '@/utils/validate'
+import { isObject } from '@gx-design-vue/pro-utils'
+
+const { shortName } = config.defaultSettings
+
+function isEncryption(status: boolean) {
+  return isPro() ? status : false
+}
+
+function handleStorageValue(value: string) {
+  if (isJSONStr(value)) return JSON.parse(value)
+  return value
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 设置Local-key的规则
+ */
+export function getStorageKey(key: string, originKey?: boolean) {
+  const { pkg } = __APP_INFO__
+  const { VITE_USE_MODE, VITE_APP_ENV } = import.meta.env
+  return originKey ? key : `${shortName}_${pkg.version}_${VITE_APP_ENV === 'dev'
+    ? 'development'
+    : VITE_USE_MODE}_${key}`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 获取Storage
+ */
+export function getStorage({
+  key,
+  encryption = true,
+  type = 'local',
+  originKey
+}: { key: string, encryption?: boolean, type?: string, originKey?: boolean }) {
+  const storageValue = type === 'local' ?
+    localStorage.getItem(getStorageKey(key, originKey))
+    : sessionStorage.getItem(getStorageKey(key, originKey))
+  const result: string | LocalResult = storageValue ?
+    isEncryption(encryption) ? Decrypt(storageValue) : handleStorageValue(storageValue)
+    : ''
+  if (result && isObject(result)) {
+    if (result.expired) {
+      const expiredStatus = dayjs().diff(dayjs(result.time)) >= result.expired
+      if (expiredStatus) {
+        removeStorage(key, type)
+        return ''
+      }
+    }
+  }
+  return result?.['value'] || result || ''
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 设置Storage
+ */
+export function setStorage({
+  key,
+  value,
+  expired,
+  originKey,
+  encryption = true,
+  type = 'local'
+}: {
+  key: string;
+  value: any;
+  originKey?: boolean;
+  expired?: number;
+  encryption?: boolean;
+  type?: string;
+}) {
+  const result: LocalResult = originKey ? value : {
+    value,
+    time: dayjs().format('YYYY-MM-DD HH:mm:ss'),
+    expired: expired || 0
+  }
+  const storageValue = isEncryption(encryption) ? Encrypt(JSON.stringify(result)) : JSON.stringify(result)
+  if (type === 'local') localStorage.setItem(getStorageKey(key, originKey), storageValue)
+  sessionStorage.setItem(getStorageKey(key, originKey), storageValue)
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019/12/3
+ * @lastTime    2019/12/3
+ * @description 删除Storage
+ */
+export function removeStorage(key: string, type = 'local', originKey?: boolean) {
+  if (type === 'local') localStorage.removeItem(getStorageKey(key, originKey))
+  sessionStorage.removeItem(getStorageKey(key, originKey))
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookie-name
+ */
+function getCookies(cname: string) {
+  const name = `${cname}=`
+  const decodedCookie = decodeURIComponent(document.cookie)
+  const ca = decodedCookie.split(';')
+  for (let i = 0; i < ca.length; i += 1) {
+    let c = ca[i]
+    while (c.charAt(0) === ' ') {
+      c = c.substring(1)
+    }
+    if (c.indexOf(name) === 0) {
+      return decodeURIComponent(c.substring(name.length, c.length))
+    }
+  }
+  return ''
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookiedomin
+ */
+function GetCookieDomain() {
+  let host = location.hostname
+  const ip = /^(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])$/
+  if (ip.test(host) === true || host === 'localhost') return host
+  const regex = /([^]*).*/
+  const match = host.match(regex)
+  if (typeof match !== 'undefined' && match !== null) {
+    const someIndex = 1
+    host = match[someIndex]
+  }
+  if (typeof host !== 'undefined' && host !== null) {
+    const strAry = host.split('.')
+    if (strAry.length > 1) {
+      host = `${strAry[strAry.length - 2]}.${strAry[strAry.length - 1]}`
+    }
+  }
+  return `.${host}`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 设置Cookie
+ */
+export function setCookie(cname: string, cvalue: string, exdays?: number) {
+  const d = new Date()
+  d.setTime(d.getTime() + (exdays || 365) * 24 * 60 * 60 * 1000)
+  const expires = `=${d.toUTCString()}`
+  document.cookie = `${cname}=${encodeURIComponent(
+    cvalue
+  )}; expires=${expires}; domain=${GetCookieDomain()}; path=/`
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 获取Cookie
+ */
+export function getCookie(cname: string) {
+  const result = getCookies(cname)
+  if (result === '') {
+    return ''
+  }
+  return decodeURIComponent(result)
+}
+
+/**
+ * @Author      gx12358
+ * @DateTime    2019-09-24
+ * @lastTime    2019-09-24
+ * @description 删除Cookie
+ */
+export function delCookie(name: string) {
+  const exp = new Date()
+  exp.setTime(exp.getTime() - 1)
+  const cval = getCookies(name)
+  if (cval !== null) {
+    document.cookie = `${name}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; domain=${GetCookieDomain()}; path=/`
+  }
+}

package/template-design-pro/src/utils/uploadFile.ts

@@ -0,0 +1,26 @@
+import dayjs from 'dayjs'
+import { getRandomNumber } from '@gx-design-vue/pro-utils'
+
+/**
+ * @Author      gx12358
+ * @DateTime    2022/4/22
+ * @lastTime    2022/4/22
+ * @description 修改文件名
+ */
+export const createFileName = ({
+  file,
+  name,
+}: {
+  file: File | string;
+  name?: string;
+}) => {
+  if (name !== 'image' && name !== 'vod') return name
+  const names = file instanceof File ? file.name.split('.') : file.split('.')
+  const time1 = dayjs().format('YYYYMMDDHH')
+  const uuid = `${name || 'vod'}/creator/${time1}/${getRandomNumber().uuid(32).toLowerCase()}`
+  if (names.length > 1) {
+    return uuid + '.' + names[names.length - 1]
+  } else {
+    return uuid
+  }
+}