bxs-tools-ui 3.2.0-1 → 3.2.0-2

package/packages/adjust-baoe/readme.md

@@ -1,110 +1,145 @@
-<!--仅用于绕过 eslint-loader 校验的错误信息：Parsing error: Invalid character-->
-<!--??以目前现象看，文档首字符不为 "<" 会报错??-->
 ## 调整保额（AdjustBaoe）
-**说明：** 计划书的调整保额模块，该模块跟随产品。显示该模块的必要条件是，产品下的至少有一个险种有 `adjustBaoe: true` 值。  
-**内容：** 该模块包含两个子模块，一个展示数据的 Table 模块，一个用于编辑数据的 Form 模块，模块内部实现子模块的切换逻辑。  
-**属性：** inputData、params、footer、submoduleName  
-**方法：** goToTable、confirm    
-**事件：** confirm  
 
-###
+计划书的调整保额模块，随产品展示。显示该模块的必要条件为：产品下至少有一个险种包含 `adjustBaoe: true` 字段。
+
+**模块包含两个子模块**，内部自动处理子模块切换：
+
+1. **Table 模块**：以表格形式展示各险种保额数据
+2. **Form 模块**：编辑各险种保额数据
+
+---
+
 ### 模块引用（import）
+
 ```javascript
-import AdjustBaoe from 'bxs-tools-ui';
+import { AdjustBaoe } from 'bxs-tools-ui';
 export default {
   components: {
     AdjustBaoe
   }
-}
+};
 ```
 
-###   
-### 数据示例
-```json
-{
-  "adjustBaoeData": [
-    {
-      "baoe_856": 1,
-      "baoe_855": 2,
-      "baoe_552": 33,
-      "baoe_530": 4,
-      "age": 32
-    }
-  ]
-}
+---
+
+### 示例（example）
+
+**弹层模式：**
+
+```html
+<template>
+  <CommonPopup
+    v-model="isShowAdjustBaoe"
+    title="调整保额"
+    height="90%"
+    closeable
+    position="bottom"
+    get-container="body"
+    :showFooter="false"
+    :z-index="100"
+  >
+    <AdjustBaoe
+      v-if="isShowAdjustBaoe"
+      ref="AdjustBaoe"
+      :submoduleName.sync="submoduleName"
+      :input-data="inputData"
+      :params="{
+        planbookId: URL_PARAM.planbookId,
+        groupKey: groupData.key,
+        productKey: productData.key
+      }"
+      @confirm="onConfirm"
+    />
+  </CommonPopup>
+</template>
 ```
-###  
-### 示例
-两种使用模式的 DEMO：
-  
-###
-**弹层模式示例：**
+
+**普通（内嵌）模式：**
+
 ```html
-<CommonPopup
-  v-model="isShowAdjustBaoe"
-  title="调整保额"
-  height="90%"
-  closeable
-  position="bottom"
-  get-container="body"
-  :showFooter="false"
-  :z-index="100"
->
+<template>
   <AdjustBaoe
-    v-if="isShowAdjustBaoe"
     ref="AdjustBaoe"
-    :submoduleName.sync="submoduleName1"
+    :submoduleName.sync="submoduleName"
     :input-data="inputData"
     :params="{
       planbookId: URL_PARAM.planbookId,
       groupKey: groupData.key,
       productKey: productData.key
     }"
-    @confirm="onClickPopupConfirm"
+    :footer="false"
+    @confirm="onConfirm"
   />
-</CommonPopup>
+</template>
+
+<script>
+import { AdjustBaoe } from 'bxs-tools-ui';
+
+export default {
+  components: { AdjustBaoe },
+  data() {
+    return {
+      submoduleName: 'Table'
+    };
+  },
+  methods: {
+    onConfirm(adjustBaoeData, inst) {
+      console.log(adjustBaoeData);
+    }
+  }
+};
+</script>
 ```
-  
-###  
-**普通模式示例：**
-```html
-<AdjustBaoe
-  ref="AdjustBaoe2"
-  :submoduleName.sync="submoduleName2"
-  :input-data="inputData"
-  :params="{
-    planbookId: URL_PARAM.planbookId,
-    groupKey: groupData.key,
-    productKey: productData.key
-  }"
-  :footer="false"
-  @confirm="onClickPopupConfirm"
-/>
+
+`confirm` 回调中 `adjustBaoeData` 是直接的数组（非对象包装）：
+
+```json
+[
+  {
+    "baoe_856": 1,
+    "baoe_855": 2,
+    "baoe_552": 33,
+    "baoe_530": 4,
+    "age": 32
+  }
+]
 ```
 
-###  
+---
+
 ### Attributes
-| 参数| 说明 | 类型 | 默认值 | 备注 |
-| --- | --- | --- |  --- |  --- |
-| inputData | 必传。计划书数据，需要符合计划书的数据结构 | Object | {} | - |  
-| params | 必传。其他参数，参考下方 Params 对象 | Object | {} | - |  
-| submoduleName | 可不传，只读属性。仅用于需要获取子模块名称的场景 | String | Table | 可选值：Table、Form |  
-| footer | 可不传，有默认值。表示是否显示底部按钮 | Boolean | true | - |  
-###  
-### Params 对象
-| 参数| 说明 | 类型 | 备注 |
-| --- | --- | --- | --- |    
-| planbookId | 计划书的 ID | Number | - |  
-| groupKey | 组合产品的 Key | String、Number | - |  
-| productKey | 产品的 Key | Number | - |  
-###  
+
+| 参数 | 说明 | 类型 | 默认值 | 备注 |
+| --- | --- | --- | --- | --- |
+| `inputData` | 必传，计划书数据，需符合计划书数据结构 | Object | `{}` | — |
+| `params` | 必传，需有 `groupKey` / `productKey` 才能正常定位产品 | Object | `{}` | 见 Params 对象 |
+| `submoduleName` | 可选，当前子模块名称，支持 `.sync` 双向绑定 | String | `Table` | `Table` / `Form` |
+| `footer` | 可选，是否显示底部按钮 | Boolean | `true` | — |
+
+
+#### Params 对象
+
+| 参数 | 说明 | 类型 |
+| --- | --- | --- |
+| `planbookId` | 计划书 ID | Number |
+| `groupKey` | 产品组的 key | String / Number |
+| `productKey` | 产品的 key | Number |
+| `publicPbUuid` | 公开计划书的 uuid；传入时调用 public 接口进行保额校验 | String |
+
+---
+
 ### Methods
-| 方法名 | 说明 | 参数 | 备注 |
-| --- | --- | --- |  --- |
-| goToTable | 用于从 Form 子模块，返回 Table 子模块 | - | - |
-| confirm | 自动调用 Table、Form 的确定事件。如果当前是 Table 模块，返回调整保额的数据 | - | - |
-###  
+
+| 方法名 | 说明 | 参数 |
+| --- | --- | --- |
+| `goToTable` | 从 Form 子模块返回 Table 子模块 | — |
+| `confirm` | 自动触发 Table / Form 的确定事件；当前为 Table 时返回调整保额数据 | — |
+
+---
+
 ### Events
-| 方法名 | 说明 | 参数 | 备注 |
-| --- | --- | --- | --- |
-| confirm | 确定事件。仅用于 footer 属性为 true 时，Table 子模块底部确定按钮的回调 | (调整保额数据, 模块实例) | - |
+
+| 事件名 | 说明 | 回调参数 |
+| --- | --- | --- |
+| `confirm` | 确定事件；`footer` 为 `true` 时，Table 子模块底部确定按钮的回调（Form 子模块的确定不触发此事件，仅切回 Table） | `Function(adjustBaoeData, 模块实例)` |
+| `update:submoduleName` | 子模块切换时触发，配合 `:submoduleName.sync` 使用 | 当前子模块名称（`'Table'` / `'Form'`） |

package/packages/business-card/readme.md

@@ -1,54 +1,117 @@
-<!--仅用于绕过 eslint-loader 校验的错误信息：Parsing error: Invalid character-->
-<!--??以目前现象看，文档首字符不为 "<" 会报错??-->
 ## 名片（BusinessCard）
-说明：前端工具组，名片模块。  
-内容：头像、姓名、手机号、按钮  
-属性：名片信息(头像、姓名、手机号)、位置(bottom) 、按钮文案、按钮背景色  
-方法：单击头像、单击按钮  
 
+展示个人名片信息的业务组件，适用于代理人名片场景。
+
+**自上而下展示顺序**：
+
+1. 头像（可点击）
+2. 姓名 + 职级图标（可点击，与头像同事件）
+3. 职级文案（可选）
+4. 手机号（可选，点击触发系统拨号）
+5. 操作按钮（可选，可自定义文案与颜色）
+
+---
 
-###
 ### 模块引用（import）
+
 ```javascript
-import BusinessCard from 'bxs-tools-ui';
+import { BusinessCard } from 'bxs-tools-ui';
 export default {
   components: {
     BusinessCard
   }
-}
+};
 ```
 
-### 示例
-``` html
+---
+
+### 示例（example）
+
+```html
 <template>
   <BusinessCard
     :card-data="cardData"
     :button-data="buttonData"
     @click="avatarHandler"
     @clickBtn="buttonHandler"
-  ></BusinessCard>
+  />
 </template>
 
-<scripte>
+<script>
+import { BusinessCard } from 'bxs-tools-ui';
+
 export default {
-  data () {
+  components: { BusinessCard },
+  data() {
     return {
       cardData: {
-        avatar:
-            '//media.winbaoxian.com/autoUpload/activity/2b3511574077482e0893c816eb56c8019b142d42f3639-CUzkUL_fw658_478c0884c573f5a.jpeg',
-        name: 'lizhao11',
+        avatar: '//media.winbaoxian.com/autoUpload/activity/xxx.jpeg',
+        name: '张三',
         rank: '三联钻代理人',
-        rankIcon:
-            '//media.winbaoxian.com/autoUpload/activity/diamond_362dcf9f4453ded.png',
-        mobile: '13023690000'
-        };
-        buttonData = {
-        tx: '编辑名片11'
-        // bg: '#0dd',
-        // color: '#d0d'
-      };      
+        rankIcon: '//media.winbaoxian.com/autoUpload/activity/diamond_xxx.png',
+        mobile: '13800138000'
+      },
+      buttonData: {
+        tx: '编辑名片',
+        bg: '#ED9E14',
+        color: '#fff'
+      }
+    };
+  },
+  methods: {
+    avatarHandler() {
+      console.log('点击头像或姓名');
+    },
+    buttonHandler() {
+      console.log('点击操作按钮');
     }
   }
-}
-</scripte>
+};
+</script>
 ```
+
+---
+
+### Attributes
+
+#### 根级 props
+
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| `cardData` | 必传，名片信息 | Object | 见 CardData 对象 |
+| `buttonData` | 可选，按钮配置 | Object | 见 ButtonData 对象 |
+
+
+#### CardData 对象
+
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| `avatar` | 头像图片地址 | String | `''` |
+| `name` | 姓名 | String | `''` |
+| `rank` | 职级文案 | String | `''` |
+| `rankIcon` | 职级图标地址 | String | `''` |
+| `mobile` | 手机号（点击触发系统拨号） | String | `''` |
+
+
+#### ButtonData 对象
+
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| `tx` | 按钮文案；为空时不渲染按钮 | String | `'编辑名片'` |
+| `bg` | 按钮背景色 | String | `'#ED9E14'` |
+| `color` | 按钮文字颜色 | String | `'#fff'` |
+
+---
+
+### Methods
+
+-
+
+---
+
+### Events
+
+| 事件名 | 说明 | 参数 |
+| --- | --- | --- |
+| `click` | 点击头像或姓名区域时触发 | — |
+| `clickBtn` | 点击操作按钮时触发 | — |

package/packages/bxs-utils/planbook/common.ts

@@ -111,7 +111,7 @@ export function getHuomianPeriodValue(val = '', pMinus = 0, age = 0) : string {
  * **将交费期间或者保险期间的值，转换成数值**
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2022-04-25
- * @param {string} value 必传。需要转换的值
+ * @param {string|number} value 必传。需要转换的值
  * @param {number} age 0 可不传。被保人年龄
  * @returns {number} 数值
  * @example
@@ -142,7 +142,7 @@ export function getNumberFromYear(value : string | number, age = 0) : number {
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2022-04-25
  * @param {number} value 必传
- * @returns {string} 单位为万的字符串
+ * @returns {number|string} 满足条件时返回单位为万的字符串，否则返回原数值
  * @example
  * converUnit10000(1000)
  * // returns 1000
@@ -201,7 +201,7 @@ export function deepCopy(obj : any, hash = new WeakMap()) : any {
  * **根据生日算年龄**
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2022-04-25
- * @param {Date|timestamp|dateStr} birth 必传。时间字符串或时间翟
+ * @param {Date|timestamp|dateStr} birth 必传。时间字符串或时间戳
  * @param {Date|timestamp|dateStr} cDate 可不传。指定时间，不传默认为当前时间
  * @returns {number} 年龄
  * @example
@@ -228,11 +228,20 @@ export function getAgeFromBirth(birth : Date | number | string, cDate? : Date |
 }
 
 /**
- * 将数值转换为千分位
+ * **将数值转换为千分位格式的字符串**
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2024-09-10
- * @param {*} n 数值
- * @returns 千分位字符串
+ * @param {number|string} n 必传。需要转换的数值
+ * @returns {string} 千分位字符串；空值返回空字符串；非数值返回原值
+ * @example
+ * formatNumberToThousand(1234567)
+ * // returns '1,234,567'
+ *
+ * formatNumberToThousand(0)
+ * // returns '0'
+ *
+ * formatNumberToThousand(null)
+ * // returns ''
  */
 export function formatNumberToThousand(n) {
   if (n !== 0 && !n) {
@@ -246,10 +255,21 @@ export function formatNumberToThousand(n) {
 }
 
 /**
- * 截取指定字数字符串
- * @param str 
- * @param n 
- * @returns 
+ * **截取字符串到指定字数**
+ * - 中文字符（及非 `[0-9a-z.()]` 的字符）计为 1 个字符
+ * - 数字、小写字母及 `.()` 计为 0.5 个字符
+ * - 超出长度时，截取前 n-2 个字符并追加 `...`
+ * @author Lizhao <lz@winbaoxian.com>
+ * @date 2024-09-10
+ * @param {string} str 必传。需要截取的字符串
+ * @param {number} n 必传。最大字符数（需大于 2）
+ * @returns {string} 截取后的字符串
+ * @example
+ * textOverflowEllipsis('你好world', 4)
+ * // returns 你好...
+ *
+ * textOverflowEllipsis('hello world', 4)
+ * // returns hello world
  */
 export function textOverflowEllipsis (str, n) {
   let text = String(str)
@@ -355,11 +375,12 @@ export function executeElementRule (personData : IPbPersons, product : IPbProduc
     }
     if (['cmCommonSelect', 'cmCommonRadioBtn', 'cmCommonRadio', 'cmCommonCheckbox'].includes(ele.componentName!)) {
       if (ele.defaultValueExp) {
-        if (ele.value !== 0 && !ele.value && paramMap.t.elementKey !== ele.key) {
-          const exp = ele.defaultValueExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')
-          newEleMap.value = eval(exp)
-          consoleLogWhenEnable(`${ele.key}: defaultValueExp`, exp, newEleMap.value)
+        const exp = ele.defaultValueExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')
+        const expValue = eval(exp)
+        if (!['', null, undefined].includes(expValue)) {
+          newEleMap.value = expValue
         }
+        consoleLogWhenEnable(`${ele.key}: defaultValueExp`, exp, newEleMap.value)
       }
       if (ele.underwriteExp) {
         const exp = ele.underwriteExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')
@@ -381,11 +402,12 @@ export function executeElementRule (personData : IPbPersons, product : IPbProduc
     }
     if (['cmCommonInput'].includes(ele.componentName!)) {
       if (ele.defaultValueExp) {
-        if (ele.value !== 0 && !ele.value && paramMap.t.elementKey !== ele.key) {
-          const exp = ele.defaultValueExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')
-          newEleMap.value = eval(exp)
-          consoleLogWhenEnable(`${ele.key}: defaultValueExp`, exp, newEleMap.value)
+        const exp = ele.defaultValueExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')
+        const expValue = eval(exp)
+        if (!['', null, undefined].includes(expValue)) {
+          newEleMap.value = expValue
         }
+        consoleLogWhenEnable(`${ele.key}: defaultValueExp`, exp, newEleMap.value)
       }
       if (ele.minExp) {
         const exp = ele.minExp.replace(/(%)(\d+)(\.*\w*)(%)/g, 'paramMap.i$2$3').replace(/(%)(\w*\.*\w*)(%)/g, 'paramMap.$2')

package/packages/bxs-utils/planbook/person.ts

@@ -355,7 +355,7 @@ export function setPersonAgeOptions(personData : IPbPerson) : IPbPerson {
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2022-04-26
  * @param {IPbPersons} allPersonsData 必传。所有人员数据
- * @param {null|string} type 可不传。
+ * @param {null|string|string[]} type 可不传。
  * 不传，人员数据按原结构返回；
  * 字符串，返回指定的人员数据；
  * 数组，以数组形式，返回多个人员数据。

package/packages/bxs-utils/planbook/product.ts

@@ -50,10 +50,10 @@ export function initProductData(prodData : IPbProduct) : IPbProduct {
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2022-04-26
  * @param {IPbProduct} prodData 必传。产品数据（单个）
- * @param {object} productVerifyData 必传。产品校验条件（单个）
+ * @param {object} prodVerifyData 必传。产品校验条件（单个）
  * @param {IPbPersons} personData 必传。人员信息，包括被保人、投保人、投保人配偶
- * @param {object} parmas 补充参数，目前只有 planbookId
- * @returns {IPbProduct} 产品数据（单个）
+ * @param {object} [parmas] 可不传。补充参数，目前只有 planbookId
+ * @returns {Promise<IPbProduct>} 产品数据（单个）
  */
 export async function productDataHandler(prodData : IPbProduct, prodVerifyData : any, personData : IPbPersons, parmas?: any) : Promise<IPbProduct> {
   if (!prodData) {
@@ -295,6 +295,7 @@ export async function productDataHandler(prodData : IPbProduct, prodVerifyData :
 
 /**
  * **处理多被保人**
+ * @ignore
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2024-02-28
  * @param {IPbPersons} personData 必传。人员信息，包括被保人、投保人、投保人配偶
@@ -327,6 +328,7 @@ function multipleInsuredHandler (personData : IPbPersons) {
 
 /**
  * 请求返回当前产品、当前条件的费率数据
+ * @ignore
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2024-02-28
  * @param {IPbProduct} prodData 必传。产品数据（单个）
@@ -384,6 +386,7 @@ function getSingleInsurancesVerifyData (prodData : IPbProduct, personData : IPbP
 
 /**
  * **多被保人，获取并缓存多个险种信息的费率信息**
+ * @ignore
  * @author Lizhao <lz@winbaoxian.com>
  * @date 2023-12-28
  * @param { any } params 必传。接口请求信息