@ivujs/i-utils 1.1.18 → 2.0.0

package/README.md

@@ -3,11 +3,10 @@
 [![npm version](https://img.shields.io/npm/v/xe-utils.svg?style=flat-square)](https://github.com/qq575792372/i-utils)
 [![npm license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
 
-🔥 **i-utils** 🔥是一款功能强大、高效的一站式前端模块化 **JavaScript** 工具库，支持`Typescript`导入，
+🔥 **i-utils** 🔥是一款功能强大、高效的一站式前端模块化 **JavaScript** 工具库，支持 `Typescript` 导入，
 其集成了众多日常开发中用到的方法，覆盖`字符串`，`数组`，`数学`，`文件`，`数学`，`文件`，`加解密算法`，`脱敏`,`分页`，
 `浏览器 Cookie`，`浏览器 Clipboard`，`浏览器 Dom`，`微信小程序工具`等多个模块，同时支持`es模块化`、`umd浏览器环境`、
-`require服务端环境`
-，满足不同场景的开发需求，大幅提升开发效率。
+`require服务端环境`，满足不同场景的开发需求，大幅提升开发效率。
 
 ### 📦 安装
 
@@ -24,48 +23,116 @@ yarn add @ivu-plus/i-utils --save
 
 ### 🎨 使用
 
-#### es 模块
+#### es 模块环境
 
 ```javascript
 // 按需引入
-import { loadedTestUtils } from "@ivu-plus/i-utils";
+import { testLoaded } from "@ivu-plus/i-utils";
 
-loadedTestUtils();
+testLoaded();
 
-// 全部引入
+// 全量引入
 import * as iUtils from "@ivu-plus/i-utils";
 
-iUtils.loadedTestUtils();
+iUtils.testLoaded();
 ```
 
-#### require 服务端环境
+#### commonjs 服务端环境
 
 ```javascript
-// 全部引入
+// 全量引入
 const iUtils = require("@ivu-plus/i-utils");
-iUtils.loadedTestUtils();
+iUtils.testLoaded();
 
 // 按需引入
-const { loadedTestUtils } = require("@ivu-plus/i-utils");
-loadedTestUtils();
+const { testLoaded } = require("@ivu-plus/i-utils");
+testLoaded();
 ```
 
 #### umd 浏览器环境
 
-```javascript
-<!-- 将工具库下面 dist/lib/index.full.umd.js 文件拷贝出来引入 -->
-<script src="dist/lib/index.full.umd.js"></script>;
-<!-- 这里使用的实际是全局的 window.iUtils 对象 -->
+直接使用打包好的 `umd` 的包，提供常规包和 `min` 压缩包
+
+```html
+<!-- <script src="dist/lib/index.full.umd.js"></script> -->
+<script src="dist/lib/index.full.umd.min.js"></script>
+
+<!-- 这里使用的实际是绑定到全局的 window.iUtils 对象 -->
 <script>
-  iUtils.loadedTestUtils();
-</script>;
+  iUtils.testLoaded();
+</script>
+```
+
+还有一种是浏览器中使用 `ESM` 模块引入方式
+
+```html
+<script type="module" src="dist/es/index.mjs">
+  iUtils.testLoaded();
+</script>
 ```
 
 #### 自动导入
-工具库采用unplugin-auto-import开发解析器支持自动导入，
+
+需要使用额外的插件来实现自动导入，`IUtilsResolver`解析器支持 `Vite` 和 `Webpack` 工具。
+
+首先需要安装自动导入插件
+
+```bash
+pnpm install unplugin-auto-import -D
+
+```
+
+在 `vite.config.ts` 中使用
+
+```javascript
+import { defineConfig } from "vite";
+import AutoImport from "unplugin-auto-import/vite";
+import { IUtilsResolver } from "@ivu-plus/i-utils/resolver";
+
+export default defineConfig({
+  plugins: [
+    AutoImport({
+      resolvers: [IUtilsResolver()],
+    }),
+  ],
+});
+```
+
+在 `webpack.config.js` 中使用
+
+```javascript
+const AutoImport = require("unplugin-auto-import/webpack");
+const { ElementPlusResolver } = require("@ivu-plus/i-utils/resolver");
+
+module.exports = {
+  plugins: [
+    AutoImport({
+      resolvers: [ElementPlusResolver()],
+    }),
+  ],
+};
+```
+
+解析器提供 3 种场景
+
+```javascript
+// 场景1：默认加载所有方法
+IUtilsResolver();
+
+// 场景2：追加指定方法名
+IUtilsResolver(["getDate"]);
+
+// 场景3：精细化控制（排除/只包含/追加）
+IUtilsResolver({
+  include: ["getUUID", "getGUID"],
+  exclude: ["testLoaded"],
+  append: ["formatDate"],
+});
+```
+
 ### 🔨 构建
 
-工具库源码架构使用 `pnpm` 做为包管理工具，打包后生成`esm`、`umd`、`cjs`包。
+工具库源码架构使用 `pnpm` 做为包管理工具，支持 `Typescript` 类型导入，打包后生成`es`、`cjs`、`umd`包。
 
 ```bash
 # 构建包
@@ -75,7 +142,7 @@ pnpm build
 ### ✅ 发布
 
 ```bash
-pnpm publish
+npm publish
 ```
 
 ### 📝API 文档
@@ -83,11 +150,11 @@ pnpm publish
 [常量集合 Constant](https://github.com/qq575792372/i-utils/blob/main/doc/constants.md)
 
 [字符串](https://github.com/qq575792372/i-utils/blob/main/doc/string.md)  
-[数字](https://github.com/qq575792372/i-utils/blob/main/doc/number.md)     
-[数组](https://github.com/qq575792372/i-utils/blob/main/doc/array.md)    
-[对象](https://github.com/qq575792372/i-utils/blob/main/doc/object.md)    
-[函数](https://github.com/qq575792372/i-utils/blob/main/doc/function.md)    
-[日期](https://github.com/qq575792372/i-utils/blob/main/doc/date.md)   
+[数字](https://github.com/qq575792372/i-utils/blob/main/doc/number.md)  
+[数组](https://github.com/qq575792372/i-utils/blob/main/doc/array.md)  
+[对象](https://github.com/qq575792372/i-utils/blob/main/doc/object.md)  
+[函数](https://github.com/qq575792372/i-utils/blob/main/doc/function.md)  
+[日期](https://github.com/qq575792372/i-utils/blob/main/doc/date.md)  
 [数学](https://github.com/qq575792372/i-utils/blob/main/doc/math.md)  
 [正则](https://github.com/qq575792372/i-utils/blob/main/doc/regexp.md)  
 [随机数](https://github.com/qq575792372/i-utils/blob/main/doc/random.md)
@@ -104,8 +171,8 @@ pnpm publish
 [分页](https://github.com/qq575792372/i-utils/blob/main/pagination/net.md)
 
 [浏览器 Url](https://github.com/qq575792372/i-utils/blob/main/doc/browser-url.md)  
-[浏览器 Cookie](https://github.com/qq575792372/i-utils/blob/main/doc/browser-storage.md)    
-[浏览器 Storage](https://github.com/qq575792372/i-utils/blob/main/doc/browser-cookie.md)   
+[浏览器 Cookie](https://github.com/qq575792372/i-utils/blob/main/doc/browser-storage.md)  
+[浏览器 Storage](https://github.com/qq575792372/i-utils/blob/main/doc/browser-cookie.md)  
 [浏览器 Dom](https://github.com/qq575792372/i-utils/blob/main/doc/browser-dom.md)  
 [浏览器 Device](https://github.com/qq575792372/i-utils/blob/main/doc/browser-device.md)  
 [浏览器 Clipboard](https://github.com/qq575792372/i-utils/blob/main/doc/browser-clipboard.md)
@@ -146,4 +213,3 @@ git commit -m 'fix: 修复了xxx问题'
 git commit -m 'fix(string): 修复了string工具类的xxx问题'
 git commit -m 'docs: 更新了字符串模块文档'
 ```
-

package/dist/cjs/ID-card/index.cjs

@@ -0,0 +1,87 @@
+'use strict';
+
+var index = require('../validate/index.cjs');
+var index$1 = require('../date/index.cjs');
+var idCard = require('../constants/id-card.cjs');
+
+/**
+ * 根据身份证号码获取信息
+ * @description 能获取到 籍贯，出生日期，年龄，性别
+ * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {Object} 返回身份证信息对象
+ */
+function getInfoByIDCard(idCard) {
+    if (index.isNull(idCard))
+        return;
+    return {
+        // 省份
+        province: getProvinceByIDCard(idCard),
+        // 生日
+        birthday: getBirthdayByIDCard(idCard),
+        // 年龄
+        age: getAgeByIDCard(idCard),
+        // 性别
+        sex: getSexByIDCard(idCard),
+    };
+}
+/**
+ * 根据身份证号码获得生日
+ * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {String} 返回生日
+ */
+function getBirthdayByIDCard(idCard) {
+    if (index.isNull(idCard))
+        return;
+    // 15位身份证
+    if (idCard.length === 15) {
+        return "19" + idCard.substring(6, 8) + "-" + idCard.substring(8, 10) + "-" + idCard.substring(10, 12);
+    }
+    // 18位身份证
+    if (idCard.length === 18) {
+        return idCard.substring(6, 10) + "-" + idCard.substring(10, 12) + "-" + idCard.substring(12, 14);
+    }
+}
+/**
+ * 根据身份证号码获得年龄
+ * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {Number} 返回年龄
+ */
+function getAgeByIDCard(idCard) {
+    if (index.isNull(idCard))
+        return;
+    let birthday = getBirthdayByIDCard(idCard);
+    return index$1.getAge(index$1.parseDate(birthday));
+}
+/**
+ * 根据身份证号码获得性别
+ * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {String} 返回性别
+ */
+function getSexByIDCard(idCard$1) {
+    if (index.isNull(idCard$1))
+        return;
+    // 15位身份证
+    if (idCard$1.length === 15) {
+        return Number(idCard$1.substring(14)) % 2 === 0 ? idCard.ID_CARD.SEX.WOMAN : idCard.ID_CARD.SEX.MAN;
+    }
+    // 18位身份证
+    if (idCard$1.length === 18) {
+        return Number(idCard$1.substring(16, 17)) % 2 === 0 ? idCard.ID_CARD.SEX.WOMAN : idCard.ID_CARD.SEX.MAN;
+    }
+}
+/**
+ * 根据身份证号码获得省份
+ * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {String} 返回省份
+ */
+function getProvinceByIDCard(idCard$1) {
+    if (index.isNull(idCard$1))
+        return;
+    return idCard.ID_CARD.PROVINCE[idCard$1.substring(0, 2)];
+}
+
+exports.getAgeByIDCard = getAgeByIDCard;
+exports.getBirthdayByIDCard = getBirthdayByIDCard;
+exports.getInfoByIDCard = getInfoByIDCard;
+exports.getProvinceByIDCard = getProvinceByIDCard;
+exports.getSexByIDCard = getSexByIDCard;