@hzab/utils 1.0.11 → 1.0.13

package/changelog.md

@@ -1,3 +1,11 @@
+# @hzab/utils@1.0.13
+
+feat: upload axios ts
+
+# @hzab/utils@1.0.12
+
+feat: 去除省市区行政校验
+
 # @hzab/utils@1.0.11
 
 feat: 身份证校验合法性

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "@hzab/utils",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "utils",
   "main": "src",
   "scripts": {
     "dev": "webpack serve -c ./config/webpack.config.js --env local",
     "build": "webpack -c ./config/webpack.config.js --env production",
-    "publish-beta": "npm publish --beta",
-    "publish-patch": "npm version patch && npm publish --access public",
-    "publish-minor": "npm version minor && npm publish --access public",
-    "publish-major": "npm version major && npm publish --access public",
+    "version:alpha": "npm version prerelease --preid=alpha",
+    "publish:alpha": "npm publish --tag alpha",
+    "version:beta": "npm version prerelease --preid=beta",
+    "publish:beta": "npm publish --tag beta",
+    "version:patch": "npm version patch",
+    "version:minior": "npm version minor",
+    "version:major": "npm version major",
+    "publish:stable": "npm publish --access public",
     "prepare": "husky install",
     "mac-chmod": "chmod +x .husky && chmod +x .husky/pre-commit",
     "docs": "typedoc"

package/src/idCardVerify.ts

@@ -32,7 +32,7 @@ export function isValidIdCard(idCard, opt?) {
   }
 
   // 校验地址码（省级+市级）
-  if (!isValidAddressCode(id18)) return false;
+  // if (!isValidAddressCode(id18)) return false;
 
   // 校验出生日期是否在合理范围内（1900年-当前年份）
   if (opt?.validBirthDate && !isValidBirthDate(id18)) return false;
@@ -45,20 +45,20 @@ export function isValidIdCard(idCard, opt?) {
  * 校验地址码（前6位）
  * 规则校验：省级代码合法 + 市级代码格式合法
  */
-export function isValidAddressCode(id18) {
-  const addrCode = id18.substring(0, 6);
+// export function isValidAddressCode(id18) {
+//   const addrCode = id18.substring(0, 6);
 
-  const provinceCode = addrCode.substring(0, 2);
-  const cityCode = addrCode.substring(2, 4);
+//   const provinceCode = addrCode.substring(0, 2);
+//   const cityCode = addrCode.substring(2, 4);
 
-  // 1. 校验省级代码（第1-2位）
-  if (!isValidProvinceCode(provinceCode)) return false;
+//   // 1. 校验省级代码（第1-2位）
+//   if (!isValidProvinceCode(provinceCode)) return false;
 
-  // 2. 校验市级代码（第3-4位）
-  if (!isValidCityCode(cityCode)) return false;
+//   // 2. 校验市级代码（第3-4位）
+//   if (!isValidCityCode(cityCode)) return false;
 
-  return true;
-}
+//   return true;
+// }
 
 /**
  * 校验省级代码（第1-2位）

package/src/upload/OfflineUpload.ts

@@ -1,4 +1,5 @@
 import dayjs from "dayjs";
+import { Axios, AxiosRequestConfig } from "axios";
 
 import { axios } from "@hzab/data-model";
 
@@ -15,11 +16,11 @@ export interface IGetSignatureOpt {
   /**
    * axios 实例
    */
-  axios?: Object;
+  axios?: Axios;
   /**
    * axios 配置
    */
-  axiosConf?: Object;
+  axiosConf?: AxiosRequestConfig;
   /**
    * 请求入参
    */
@@ -32,11 +33,11 @@ export interface IOfflineUploadProps {
   /**
    * axios 实例
    */
-  axios?: Object;
+  axios?: Axios;
   /**
    * axios 配置
    */
-  axiosConf?: Object;
+  axiosConf?: AxiosRequestConfig;
   /**
    * 配置接口地址
    */
@@ -84,11 +85,11 @@ export interface IUploadOpt {
   /**
    * axios 实例
    */
-  axios?: Object;
+  axios?: Axios;
   /**
    * axios 配置
    */
-  axiosConf?: Object;
+  axiosConf?: AxiosRequestConfig;
 }
 
 /**
@@ -141,8 +142,8 @@ export function getSignature(opt: IGetSignatureOpt = {}) {
 export interface IGetPreviewUrlsOpt {
   previewUrl?: string;
   params?: Object;
-  axios?: Object;
-  axiosConf?: Object;
+  axios?: Axios;
+  axiosConf?: AxiosRequestConfig;
 }
 
 /**

package/src/upload/OssUploadUtil.ts

@@ -1,206 +1,214 @@
-import dayjs from "dayjs";
-
-import { axios } from "@hzab/data-model";
-import { formatDirStr } from "./uploadUtils";
-import { getGlobalServeConfig } from "../globalConfig"
-const isPublicMap = {
-  0: "&",
-  1: "?"
-}
-/**
- * getSignature 配置
- */
-export interface IGetSignatureOpt {
-  /** 获取配置的接口地址 */
-  serverUrl?: string;
-  /** axios 实例 */
-  axios?: typeof axios;
-  /** axios 配置参数 */
-  axiosConf?: Object;
-  /** 获取配置的接口自定义入参 */
-  params?: {
-    /** 文件路径 */
-    dir?: string;
-    /** 是否是公开库 */
-    isPublic?: number;
-  };
-}
-
-/**
- * OssUpload props 参数
- */
-export interface IOssUploadProps {
-  /** axios 实例 */
-  axios?: typeof axios;
-  /** axios 配置参数 */
-  axiosConf?: Object;
-  /** 获取配置的接口地址 */
-  serverUrl?: string;
-  /** 获取配置的接口自定义入参 */
-  signatureParams?: {
-    /** 文件路径 */
-    dir?: string;
-    /** 是否是公开库 */
-    isPublic?: number;
-  };
-}
-
-export interface IUploadOpt {
-  fileName?: string;
-  /** axios 实例 */
-  axios?: typeof axios;
-  /** axios 配置参数 */
-  axiosConf?: Object;
-  /** 获取配置的接口地址 */
-  serverUrl?: string;
-  /** 获取配置的接口自定义入参 */
-  params?: {
-    /** 文件路径 */
-    dir?: string;
-    /** 是否是公开库 */
-    isPublic?: number;
-  };
-  /**
-   * 获取配置接口请求入参
-   */
-  signatureParams?: {
-    /** 公开还是私有 */
-    isPublic?: number;
-  };
-  /** 文件上传的接口自定义入参 */
-  ossParams?: {};
-  /** 是否使用 hash 文件名 */
-  useHashName?: boolean;
-  /**缩略图参数 */
-  thumbnailParams?: string;
-}
-
-export function getSignature(opt: IGetSignatureOpt = {}) {
-  const { serverUrl = getGlobalServeConfig()?.serverUrl || "/api/v1/user/oss/getWebOssConfig" } = opt;
-  // 减 10 秒，避免发起请求时 刚好过期的情况
-  if (
-    window._$ossSignatureRes &&
-    serverUrl === window._$ossSignatureRes.serverUrl &&
-    dayjs().valueOf() - window._$ossSignatureRes.__saveTime < window._$ossSignatureRes.expireTimeMilles - 10000
-  ) {
-    return Promise.resolve(window._$ossSignatureRes);
-  }
-  const { axios: _ax = axios, params = {}, axiosConf } = opt;
-  // 处理 dir 格式，必须为非 / 开头， /  结尾。如： test/
-  params.dir = formatDirStr(params.dir);
-
-  return _ax
-    .get(serverUrl, {
-      ...axiosConf,
-      params: {
-        isPublic: 1,
-        ...params,
-      },
-    })
-    .then((res) => {
-      window._$ossSignatureRes = res?.data?.data ?? res?.data ?? res;
-      if (window._$ossSignatureRes) {
-        window._$ossSignatureRes.__saveTime = dayjs().valueOf();
-        window._$ossSignatureRes.serverUrl = serverUrl;
-      }
-      return window._$ossSignatureRes;
-    });
-}
-
-/**
- * oss 上传工具类
- */
-class OssUploadUtil {
-  /** axios 实例 */
-  axios: typeof axios;
-  /** axios 配置参数 */
-  axiosConf: Object;
-  /** 获取配置的接口地址 */
-  serverUrl: string;
-  /** 获取配置的接口自定义入参 */
-  signatureParams?: {
-    /** 文件路径 */
-    dir?: string;
-    /** 是否是公开库 */
-    isPublic?: number;
-  };
-
-  constructor(props: IOssUploadProps = {}) {
-    this.axios = props.axios || axios;
-    this.axiosConf = props.axiosConf || {};
-    this.serverUrl = props.serverUrl || getGlobalServeConfig()?.serverUrl || "/api/v1/user/oss/getWebOssConfig";
-    this.signatureParams = props.signatureParams || {};
-  }
-
-  getSignature(serverUrl = this.serverUrl, opt) {
-    return this._getSignature(serverUrl, opt);
-  }
-
-  upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
-    return this._upload(file, { ...opt });
-  }
-
-  _getSignature(serverUrl = this.serverUrl, opt) {
-    return getSignature({
-      ...opt,
-      serverUrl,
-      axios: opt?.axios || this.axios,
-      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
-    });
-  }
-
-  _upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
-    return new Promise(async (resolve, reject) => {
-      const ossParams = await this._getSignature(opt.serverUrl || this.serverUrl, {
-        ...opt,
-        params: { ...this.signatureParams, ...opt.params },
-      });
-
-      const { ossParams: propOssParams, fileName } = opt || {};
-      const formData = new FormData();
-      // key 表示上传到 Bucket 内的 Object 的完整路径，例如 exampledir/exampleobject.txtObject，完整路径中不能包含 Bucket 名称。
-      // filename 表示待上传的本地文件名称。
-      const filename = fileName || file.name;
-      const key = `${ossParams?.dir}${filename}`;
-      formData.set("key", key);
-      formData.set("OSSAccessKeyId", ossParams.accessid);
-      formData.set("policy", ossParams.policy);
-      formData.set("Signature", ossParams.signature);
-      if (ossParams.callback) {
-        formData.set("callback", ossParams.callback);
-      }
-      // @ts-ignore
-      formData.set("success_action_status", 200);
-      formData.set("file", file);
-
-      if (propOssParams) {
-        for (const key in propOssParams) {
-          if (Object.hasOwnProperty.call(propOssParams, key)) {
-            formData.set(key, propOssParams[key]);
-          }
-        }
-      }
-
-      const _axios = opt?.axios || this.axios;
-
-      return _axios
-        .post(ossParams.host, formData, { ...this.axiosConf, ...opt?.axiosConf })
-        .then((res) => {
-          if (getGlobalServeConfig()?.showThumbnail) {
-            res.data.data.thumbnailUrl = `${res?.data?.data?.fileUrl}${opt?.thumbnailParams ? isPublicMap[opt?.signatureParams?.isPublic] + opt?.thumbnailParams : ""}`;
-          }
-          resolve(res);
-          return res;
-        })
-        .catch((err) => {
-          console.error("oss upload err", err);
-          reject(err);
-          return Promise.reject(err);
-        });
-    });
-  }
-}
-
-export { axios };
-
-export default OssUploadUtil;
+import dayjs from "dayjs";
+import { Axios, AxiosResponse, AxiosRequestConfig } from "axios";
+
+import { axios } from "@hzab/data-model";
+import { formatDirStr } from "./uploadUtils";
+import { getGlobalServeConfig } from "../globalConfig";
+const isPublicMap = {
+  0: "&",
+  1: "?",
+};
+/**
+ * getSignature 配置
+ */
+export interface IGetSignatureOpt {
+  /** 获取配置的接口地址 */
+  serverUrl?: string;
+  /** axios 实例 */
+  axios?: Axios;
+  /** axios 配置参数 */
+  axiosConf?: AxiosRequestConfig;
+  /** 获取配置的接口自定义入参 */
+  params?: {
+    /** 文件路径 */
+    dir?: string;
+    /** 是否是公开库 */
+    isPublic?: number;
+  };
+}
+
+/**
+ * OssUpload props 参数
+ */
+export interface IOssUploadProps {
+  /** axios 实例 */
+  axios?: Axios;
+  /** axios 配置参数 */
+  axiosConf?: AxiosRequestConfig;
+  /** 获取配置的接口地址 */
+  serverUrl?: string;
+  /** 获取配置的接口自定义入参 */
+  signatureParams?: {
+    /** 文件路径 */
+    dir?: string;
+    /** 是否是公开库 */
+    isPublic?: number;
+  };
+}
+
+export interface IUploadOpt {
+  fileName?: string;
+  /** axios 实例 */
+  axios?: Axios;
+  /** axios 配置参数 */
+  axiosConf?: AxiosRequestConfig;
+  /** 获取配置的接口地址 */
+  serverUrl?: string;
+  /** 获取配置的接口自定义入参 */
+  params?: {
+    /** 文件路径 */
+    dir?: string;
+    /** 是否是公开库 */
+    isPublic?: number;
+  };
+  /**
+   * 获取配置接口请求入参
+   */
+  signatureParams?: {
+    /** 公开还是私有 */
+    isPublic?: number;
+  };
+  /** 文件上传的接口自定义入参 */
+  ossParams?: {};
+  /** 是否使用 hash 文件名 */
+  useHashName?: boolean;
+  /**缩略图参数 */
+  thumbnailParams?: string;
+}
+
+export interface ResponseData extends AxiosResponse {
+  fileUrl: string;
+  thumbnailUrl?: string;
+}
+
+export function getSignature(opt: IGetSignatureOpt = {}) {
+  const { serverUrl = getGlobalServeConfig()?.serverUrl || "/api/v1/user/oss/getWebOssConfig" } = opt;
+  // 减 10 秒，避免发起请求时 刚好过期的情况
+  if (
+    window._$ossSignatureRes &&
+    serverUrl === window._$ossSignatureRes.serverUrl &&
+    dayjs().valueOf() - window._$ossSignatureRes.__saveTime < window._$ossSignatureRes.expireTimeMilles - 10000
+  ) {
+    return Promise.resolve(window._$ossSignatureRes);
+  }
+  const { axios: _ax = axios, params = {}, axiosConf } = opt;
+  // 处理 dir 格式，必须为非 / 开头， /  结尾。如： test/
+  params.dir = formatDirStr(params.dir);
+
+  return _ax
+    .get(serverUrl, {
+      ...axiosConf,
+      params: {
+        isPublic: 1,
+        ...params,
+      },
+    })
+    .then((res) => {
+      window._$ossSignatureRes = res?.data?.data ?? res?.data ?? res;
+      if (window._$ossSignatureRes) {
+        window._$ossSignatureRes.__saveTime = dayjs().valueOf();
+        window._$ossSignatureRes.serverUrl = serverUrl;
+      }
+      return window._$ossSignatureRes;
+    });
+}
+
+/**
+ * oss 上传工具类
+ */
+class OssUploadUtil {
+  /** axios 实例 */
+  axios: Axios;
+  /** axios 配置参数 */
+  axiosConf: AxiosRequestConfig;
+  /** 获取配置的接口地址 */
+  serverUrl: string;
+  /** 获取配置的接口自定义入参 */
+  signatureParams?: {
+    /** 文件路径 */
+    dir?: string;
+    /** 是否是公开库 */
+    isPublic?: number;
+  };
+
+  constructor(props: IOssUploadProps = {}) {
+    this.axios = props.axios || axios;
+    this.axiosConf = props.axiosConf || {};
+    this.serverUrl = props.serverUrl || getGlobalServeConfig()?.serverUrl || "/api/v1/user/oss/getWebOssConfig";
+    this.signatureParams = props.signatureParams || {};
+  }
+
+  getSignature(serverUrl = this.serverUrl, opt) {
+    return this._getSignature(serverUrl, opt);
+  }
+
+  upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
+    return this._upload(file, { ...opt });
+  }
+
+  _getSignature(serverUrl = this.serverUrl, opt) {
+    return getSignature({
+      ...opt,
+      serverUrl,
+      axios: opt?.axios || this.axios,
+      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
+    });
+  }
+
+  _upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
+    return new Promise(async (resolve, reject) => {
+      const ossParams = await this._getSignature(opt.serverUrl || this.serverUrl, {
+        ...opt,
+        params: { ...this.signatureParams, ...opt.params },
+      });
+
+      const { ossParams: propOssParams, fileName } = opt || {};
+      const formData = new FormData();
+      // key 表示上传到 Bucket 内的 Object 的完整路径，例如 exampledir/exampleobject.txtObject，完整路径中不能包含 Bucket 名称。
+      // filename 表示待上传的本地文件名称。
+      const filename = fileName || file.name;
+      const key = `${ossParams?.dir}${filename}`;
+      formData.set("key", key);
+      formData.set("OSSAccessKeyId", ossParams.accessid);
+      formData.set("policy", ossParams.policy);
+      formData.set("Signature", ossParams.signature);
+      if (ossParams.callback) {
+        formData.set("callback", ossParams.callback);
+      }
+      // @ts-ignore
+      formData.set("success_action_status", 200);
+      formData.set("file", file);
+
+      if (propOssParams) {
+        for (const key in propOssParams) {
+          if (Object.hasOwnProperty.call(propOssParams, key)) {
+            formData.set(key, propOssParams[key]);
+          }
+        }
+      }
+
+      const _axios = opt?.axios || this.axios;
+
+      return _axios
+        .post(ossParams.host, formData, { ...this.axiosConf, ...opt?.axiosConf })
+        .then((res: ResponseData) => {
+          if (getGlobalServeConfig()?.showThumbnail) {
+            res.data.data.thumbnailUrl = `${res?.data?.data?.fileUrl}${
+              opt?.thumbnailParams ? isPublicMap[opt?.signatureParams?.isPublic] + opt?.thumbnailParams : ""
+            }`;
+          }
+          resolve(res);
+          return res;
+        })
+        .catch((err) => {
+          console.error("oss upload err", err);
+          reject(err);
+          return Promise.reject(err);
+        });
+    });
+  }
+}
+
+export { axios };
+
+export default OssUploadUtil;