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

package/packages/add-and-take/readme.md

@@ -1,31 +1,32 @@
-<!--仅用于绕过 eslint-loader 校验的错误信息：Parsing error: Invalid character-->
-<!--??以目前现象看，文档首字符不为 "<" 会报错??-->
-## 追加领取（减保领取）（AddAndTake）
-计划书的追加领取模块。减保领取可以认为是追加领取的一种，两者数据结构是相同的，只是险种中对应的字段（accountData、reduceBaofData）不同、校验数据的接口不同。  
-v1.x.x，追加领取、减保领取两者是独立的；v2.x.x，追加领取的账户价值是受减保领取的数据影响的，并且当分红、账户利率变化（余额不足）时，可能两者的数据都要清空。  
-v2.x.x，对模块进行了重构，重新定义了传参、回参，并且尽量保证不同场景的传参是一样的（投保页、结果页、对比）。  
-**内容：** 该模块包含三部分：
-  * 利益表单：包括分利、年末分红利率、账户利率、自定义利率、领取方式等  
-  * 利益表格：展示利益账户价值、追加金额、领取的金额数据等  
-  * 追加领取表单：编辑追加领取数据，包括起止年度、追加金额、领取金额、领取用途等  
-
-**属性：** type、submoduleName、scene、groupKey、productKey、insuranceKey、resultUuid、inputData、accountData、accountInsuranceId、reduceBaofData、reduceBaofData2、reduceBaofInsuranceId、interestData  
-**方法：** goToTable、confirm、updateData  
-**事件：** confirm  
-
-###
+## 追加领取（AddAndTake）
+
+计划书的追加领取 / 减保领取模块。减保领取可视为追加领取的一种，两者数据结构相同，仅险种对应字段（`accountData` / `reduceBaofData`）及校验接口不同。
+
+v2.x.x 起，追加领取的账户价值受减保领取数据影响；当分红、账户利率变化（余额不足）时，两者数据可能同时被清空。同版本对模块进行了重构，重新定义了传参与回参，并尽量保证不同场景（投保页、结果页、对比）的传参一致。
+
+**模块包含三部分**：
+
+1. **利益表单**：分利、年末分红利率、账户利率、自定义利率、领取方式等
+2. **利益表格**：展示利益账户价值、追加金额、领取金额等数据
+3. **追加领取表单**：编辑追加领取数据，包括起止年度、追加金额、领取金额、领取用途等
+
+---
+
 ### 模块引用（import）
+
 ```javascript
-import AddAndTake from 'bxs-tools-ui';
+import { AddAndTake } from 'bxs-tools-ui';
 export default {
   components: {
     AddAndTake
   }
-}
+};
 ```
 
-###
+---
+
 ### 示例（example）
+
 ```html
 <template>
   <CommonPopup
@@ -63,112 +64,41 @@ export default {
 </template>
 
 <script>
+import { AddAndTake } from 'bxs-tools-ui';
+
 export default {
-  data () {
+  components: { AddAndTake },
+  data() {
     return {
-      takePopupConfig: null
-    }
-  },
-  computed: {
-    inputData() {
-      return _get(this, 'planbookData.initData.inputData');
-    },
-    groupData() {
-      return _get(this, 'inputData.productGroupList[0]');
-    },
-    productData() {
-      return _get(this, 'groupData.prodOrderList[0]');
-    },
-    reduceBaofInsuranceData() {
-      const productData = convertProductData(this.productData);
-      const mulInsOrderList = _get(productData, 'mulInsOrderList') || [];
-      return mulInsOrderList.find(ins => ins.reduceBaof && ins.reduceBaofData);
-    },
-    accountInsuranceData() {
-      const productData = convertProductData(this.productData);
-      const mulInsOrderList = _get(productData, 'mulInsOrderList') || [];
-      return mulInsOrderList.find(ins => ins.account && ins.accountData);
-    }
-  },
-  created () {
-    this.openAddAndTakePopup(this.reduceBaofInsuranceData, 'reduceBaofData')
-    // this.openAddAndTakePopup(this.accountInsuranceData, 'accountData')
-  },
-  methods: {
-    openAddAndTakePopup(ins, name) {
-      const { resultUuid, inputData, params } = this;
-      if (ins[name]) {
-        const { groupKey, productKey } = params;
-        const isReduceBaof = name === 'reduceBaofData';
-        const type = isReduceBaof ? 'reduceBaof' : ins[name].accountPart;
-        const takePopupConfig = {
-          visible: true,
-          title: '弹层标题',
-          type,
-          submoduleName: 'Table',
-          scene: 0,
-          groupKey,
-          productKey,
-          insuranceKey: ins.key,
-          resultUuid,
-          inputData: null,
-          insuredAge: null,
-          periodNum: ins.periodNum,
-          [name]: ins[name],
-          reduceBaofData2: ins.duplicateReduceBaofData,
-          [isReduceBaof ? 'reduceBaofInsuranceId' : 'accountInsuranceId']: ins.key,
-          interestData: {
-            bonus: 'low',
-            rate: null,
-            takeType: 'account',
-            customRate: 0.047,
-            // yearBonusRate: 1.2,
-            // endBonusRate: 1.2,
-          }
-        };
-        // 将投保页数据转换为结果页数据形式
-        const resultData = convertInputDataToResultData(inputData);
-        if (resultData) {
-          takePopupConfig.inputData = {
-            personData: resultData.personData,
-            productGroupList: resultData.productGroupList
-          };
-          takePopupConfig.insuredAge = resultData.personData.personOrderList[0].age;
-          const productGroupList = (resultData.productGroupList || []).filter(g => g.prodOrderList);
-          productGroupList.forEach(g => {
-            const product = g.prodOrderList.find(p => p.key === productKey && p.hadChoice && p.mulInsOrderList);
-            product.mulInsOrderList.forEach(ins => {
-              if (name === 'reduceBaofData') {
-                if (ins.account && ins.accountData) {
-                  takePopupConfig.accountData = ins.accountData;
-                  takePopupConfig.accountInsuranceId = ins.key;
-                }
-              } else {
-                if (ins.reduceBaof && ins.reduceBaofData) {
-                  takePopupConfig.reduceBaofData = ins.reduceBaofData;
-                  takePopupConfig.reduceBaofData2 = ins.duplicateReduceBaofData;
-                  takePopupConfig.reduceBaofInsuranceId = ins.key;
-                }
-              }
-            });
-          });
+      takePopupConfig: {
+        visible: true,
+        title: '弹层标题',
+        type: 'reduceBaof',
+        submoduleName: 'Table',
+        scene: 0,
+        groupKey: 'allMainInsData',
+        productKey: 1800,
+        insuranceKey: 17588,
+        resultUuid: null,
+        inputData: null,
+        insuredAge: 30,
+        accountData: null,
+        accountInsuranceId: null,
+        reduceBaofData: null,
+        reduceBaofData2: null,
+        reduceBaofInsuranceId: 17588,
+        interestData: {
+          bonus: 'low',
+          rate: null,
+          takeType: 'account',
+          customRate: 0.047
         }
-        this.takePopupConfig = takePopupConfig;
       }
-    },
+    };
+  },
+  methods: {
     addAndTakeConfirm(data) {
-      const { productData } = this;
       const { type, accountData, accountInsuranceId, reduceBaofData, reduceBaofData2, reduceBaofInsuranceId, interestData } = data;
-      productData.mulInsOrderList.forEach(ins => {
-        if (ins.key === accountInsuranceId) {
-          ins.accountData = accountData;
-        }
-        if (ins.key === reduceBaofInsuranceId) {
-          ins.reduceBaofData = reduceBaofData;
-          ins.duplicateReduceBaofData = reduceBaofData2;
-        }
-      });
-      this.takePopupConfig = initAddAndTakePopupConfig();
       console.log(data);
     },
     closeAddAndTake() {
@@ -182,36 +112,40 @@ export default {
       }
     }
   }
-}
+};
 </script>
 ```
 
-###  
-### 属性（Attributes）
-| 参数| 说明 | 类型 | 默认值 | 备注 | 版本 |  
-| --- | --- | --- |  --- |  --- |  --- |  
-| type | 可选，追加领取的类型。 | String | addAndTake | addAndTake-追加领取 <br/>add-追加 <br/>take-领取 <br/>reduceBaof-减保领取 | 2.0.0 |  
-| scene | 可选，所在场景。 | Number | 0 | 0-投保页 <br/>1-结果页 <br/>2-计划书对比 <br/>3-利益对比 <br/>4-保司投保页 | 2.0.0 |  
-| submoduleName | 可选，当前展示的模块。 | String | Table | Table-利益表格 <br/>Form-追加领取表单 | 2.0.0 |  
-| groupKey | 必传，产品组的 key。 | String | - | - | 2.0.0 |  
-| productKey | 必传，产品的 key。 | Number | - | - | 2.0.0 |  
-| insuranceKey | 必传，险种的 key。 | Number | - | - | 2.0.0 |  
-| resultUuid | 可选，计划书结果页的 uuid。 | String | - | - | 2.0.0 |  
-| inputData | 可选，需要符合计划书投保页的数据结构。主要有两种场景：不传 resultUuid，inputData 是必传，用于利益初始化接口、利益详情接口的请求传参；传 resultUuid，不需要传 inputData | Object | - | 见 InputData 对象 | 2.0.0 |  
-| insuredAge | 必传，被保人年龄。 | Number | - |  | 2.0.0 |  
-| periodNum | 可选，险种交费期间。 | Number | 0 |  | 2.0.0 |  
-| accountData | 可选，追加领取的数据。 | Object | - | 见 AccountData 对象 | 2.0.0 |  
-| accountInsuranceId | 可选，追加领取险种的 key。 | Number | - | - | 2.0.0 |  
-| reduceBaofData | 可选，减保领取的数据。 | Object | - | 见 ReduceBaofData 对象 | 2.0.0 |  
-| reduceBaofData2 | 可选，减保领取的数据。 | Object | - | 见 ReduceBaofData 对象 | 2.0.0 |  
-| reduceBaofInsuranceId | 可选，减保领取险种的 key。 | Number | - | - | 2.0.0 |  
-| interestData | 可选，利益数据。 | Object | - | 见 InterestData 对象 | 2.0.0 |  
-| footer | 可选，表示是否显示底部按钮。 | Boolean | true | - | 2.0.0 |  
-  
-accountData、accountInsuranceId，是追加领取的数据和对应的险种id；reduceBaofData、reduceBaofInsuranceId 是减保领取的数据和对应的险种id。当一个产品下，即有追加领取，又有减保领取，两者都要传；正常传其中一个即可。
-
-####  
-#### - InputData 对象
+---
+
+### Attributes
+
+#### 根级 props
+
+| 参数 | 说明 | 类型 | 默认值 | 备注 |
+| --- | --- | --- | --- | --- |
+| `type` | 可选，追加领取的类型 | String | `addAndTake` | `addAndTake` 追加领取 / `add` 追加 / `take` 领取 / `reduceBaof` 减保领取 |
+| `groupKey` | 必传，产品组的 key | Number / String | — | — |
+| `productKey` | 必传，产品的 key | Number / String | — | — |
+| `insuredAge` | 必传，被保人年龄 | Number | — | — |
+| `scene` | 可选，所在场景 | Number | `0` | `0` 投保页 / `1` 结果页 / `2` 计划书对比 / `3` 利益对比 / `4` 保司投保页 / `5` 险种对比（利益对比2024） |
+| `submoduleName` | 可选，当前展示的子模块（`.sync`） | String | `Table` | `Table` 利益表格 / `Form` 追加领取表单 |
+| `resultUuid` | 可选，计划书结果页的 uuid | String | — | 传入后可不传 `inputData` |
+| `inputData` | 可选，计划书投保页数据结构 | Object | — | 不传 `resultUuid` 时需传入；见 InputData 对象 |
+| `periodNum` | 可选，险种交费期间 | Number | `0` | — |
+| `accountData` | 可选，追加领取的数据 | Object | — | 见 AccountData 对象 |
+| `accountInsuranceId` | 可选，追加领取险种的 key | Number | — | — |
+| `reduceBaofData` | 可选，减保领取的数据 | Object | — | 见 ReduceBaofData 对象 |
+| `reduceBaofData2` | 可选，双减保领取的数据 | Object | — | 见 ReduceBaofData 对象 |
+| `reduceBaofInsuranceId` | 可选，减保领取险种的 key | Number | — | — |
+| `interestData` | 可选，利益数据 | Object | — | 见 InterestData 对象 |
+| `footer` | 可选，是否显示底部按钮 | Boolean | `true` | — |
+
+> `accountData` / `accountInsuranceId` 对应追加领取，`reduceBaofData` / `reduceBaofInsuranceId` 对应减保领取。产品下同时存在两者时，需全部传入。
+
+
+#### InputData 对象
+
 ```json
 {
   "personData": {
@@ -221,7 +155,7 @@ accountData、accountInsuranceId，是追加领取的数据和对应的险种id
         "title": true,
         "sex": 1,
         "age": 30,
-        "birthday": "",
+        "birthday": ""
       }
     ]
   },
@@ -230,136 +164,108 @@ accountData、accountInsuranceId，是追加领取的数据和对应的险种id
       "key": "allMainInsData",
       "prodOrderList": [
         {
+          "key": 1800,
           "mulInsOrderList": [
             {
-              "code": "862",
-              "calculatorType": "",
-              "allowSamePerson": false,
-              "scale": 2,
-              "durationType": 0,
+              "key": 17588,
+              "name": "智悦人生年金保险（万能型，Ⅱ）",
+              "account": true,
               "accountData": {
                 "accountName": "",
                 "addAndTakeData": [],
                 "accountPart": "addAndTake"
-              },
-              "required": true,
-              "roundingMode": "HALF_UP",
-              "trade": false,
-              "huomian": "",
-              "name": "智悦人生年金保险（万能型，Ⅱ）",
-              "key": 17588,
-              "account": true
+              }
             }
-          ],
-          "companyId": 2,
-          "hide": false,
-          "titleName": "平安智悦人生年金保险（万能型，Ⅱ）",
-          "trade": false,
-          "companyName": "中国平安",
-          "autoImport": true,
-          "liabilityShowType": 0,
-          "key": 1800,
-          "required": true,
-          "tradeId": -1
-        },
-      ],
+          ]
+        }
+      ]
     }
   ]
 }
 ```
 
-#### - AccountData 对象
-```json
-{
-  "accountData": {
-    "accountPart": "addAndTake", // addAndTake-追加领取 add-追加 take-领取 reduceBaof-减额领取
-    "accountName": "",
-    "addAndTakeData": [
-      {
-        "key": "add",   // accountPart 为 addAndTake、add 时必要
-        "adjustData": [
-          [1, 6, 1] // [年度、年度、追加]
-        ]
-      },
-      {
-        "key": "take", // accountPart 为 addAndTake、take 时必要
-        "adjustData": [
-          [3, 3, 2, ""] // [年度、年度、领取、用途]
-        ]
-      }
-    ]
-  }  
-}
-```
 
-#### - ReduceBaofData 对象
+#### AccountData 对象
+
 ```json
 {
-  "reduceBaofData": {
-    "accountPart": "take", // 固定值: take-领取
-    "addAndTakeData": [
-      {
-        "key": "take",
-        "adjustData": [
-          [3, 3, 2, ""] // [年度、年度、领取、用途]
-        ]
-      }
-    ]
-  }
+  "accountPart": "addAndTake",
+  "accountName": "",
+  "addAndTakeData": [
+    {
+      "key": "add",
+      "adjustData": [
+        [1, 6, 1]
+      ]
+    },
+    {
+      "key": "take",
+      "adjustData": [
+        [3, 3, 2, ""]
+      ]
+    }
+  ]
 }
 ```
 
-#### - InterestData 对象
-| 参数| 说明 | 类型 | 备注 | 版本 |  
-| --- | --- | --- | --- | --- |    
-| takeType | 可选，领取方式式 | String | - | 2.0.0 |  
-| bonus | 可选，分红值 | String | - | 2.0.0 |  
-| rate | 可选，账户利率值 | Number | - | 2.0.0 |  
-| customRate | 可选，自定义利率 | Number | - | 2.0.0 |  
-| yearBonusRate | 可选，现金分红实现率 | Number | 仅在 scene 为 3, 即利益对比时有效  | 2.0.0 |  
-| endBonusRate | 可选，终了分红实现率 | Number | 仅在 scene 为 3, 即利益对比时有效 | 2.0.0 |  
+> `accountPart`：`addAndTake` 追加领取 / `add` 追加 / `take` 领取 / `reduceBaof` 减额领取
+> `adjustData` 行格式：`[开始年度, 结束年度, 金额]`（追加）；`[开始年度, 结束年度, 金额, 用途]`（领取）
+
+
+#### ReduceBaofData 对象
+
 ```json
 {
-  "bonus": 'low',
-  "rate": 0.06,
-  "takeType": 'account',
-  "customRate": 0.047,
-  // year"BonusRate: 1.2,
-  // "endBonusRate": 1.2,
+  "accountPart": "take",
+  "addAndTakeData": [
+    {
+      "key": "take",
+      "adjustData": [
+        [3, 3, 2, ""]
+      ]
+    }
+  ]
 }
 ```
 
-###  
-###  
-### 方法（Methods）
-| 方法名 | 说明 | 参数 | 备注 |
-| --- | --- | --- |  --- |
-| goToTable | 从 Form 子模块，返回 Table 子模块 | - | - |
-| confirm | 自动调用 Table、Form 的确定事件。如果当前是 Table 模块，返回追加领取的数据 | - | - |
-| updateData | 修改指定年度的追加领取数据 | Function(values)，见 Values 对象 | - |
-###  
-#### - Values 对象
-| 参数| 说明 | 类型 | 备注 |
-| --- | --- | --- | --- |  
-| type | 必传。追加领取的数据类型 | String | 可选值：add、take |  
-| beginYear | 必传。开始年度 | Number | - |  
-| endYear | 必传。结束年度 | Number | - |  
-| baof | 可不传。修改的金额，为 `falsity` 表示删除  | Number | - |  
-| purpose | 可不传。用途 | String | - |  
-| customPurpose | 可不传。自定义用途，优先级高于 purpose | String | - |  
-###  
-### 事件（Events）
-| 方法名 | 说明 | 回调参数 | 备注 |
+
+#### InterestData 对象
+
+| 参数 | 说明 | 类型 | 备注 |
+| --- | --- | --- | --- |
+| `takeType` | 领取方式 | String | — |
+| `bonus` | 分红值 | String | — |
+| `rate` | 账户利率值 | Number | — |
+| `customRate` | 自定义利率 | Number | — |
+| `yearBonusRate` | 现金分红实现率 | Number | 仅 `scene` 为 `3`（利益对比）时有效 |
+| `endBonusRate` | 终了分红实现率 | Number | 仅 `scene` 为 `3`（利益对比）时有效 |
+
+---
+
+### Methods
+
+| 方法名 | 说明 | 参数 |
+| --- | --- | --- |
+| `goToTable` | 从 Form 子模块返回 Table 子模块 | — |
+| `confirm` | 自动触发 Table / Form 的确定事件；当前为 Table 时返回追加领取数据（Promise） | — |
+
+---
+
+### Events
+
+| 事件名 | 说明 | 回调参数 |
+| --- | --- | --- |
+| `confirm` | 确定事件；`footer` 为 `true` 时，Table 子模块底部确定按钮的回调 | `Function(data, 模块实例)`，data 见 Response 对象 |
+
+
+#### Response 对象
+
+| 参数 | 说明 | 类型 | 备注 |
 | --- | --- | --- | --- |
-| confirm | 确定事件。footer 属性为 true 时，Table 子模块底部确定按钮的回调 | Function(data, 模块实例)，data 见 Response 对象 | - |
-###  
-#### - Response 对象
-| 参数| 说明 | 类型 | 备注 |
-| --- | --- | --- | --- |  
-| type | 追加领取的数据类型 | String | addAndTake-追加领取 <br/>add-追加 <br/>take-领取 <br/>reduceBaof-减保领取 |  
-| accountData | 追加领取的数据 | Object | 见上方 AccountData 对象 |  
-| accountInsuranceId | 追加领取险种的 key | Number | - |  
-| reduceBaofData | 减保领取的数据 | Object | 见上方 ReduceBaofData 对象 |  
-| reduceBaofData2 | 双减保领取的数据 | Object | 见上方 ReduceBaofData 对象 |  
-| reduceBaofInsuranceId | 减保领取险种的 key | Number | - |  
-| interestData | 利益数据 | Object | 见上方 InterestData 对象 |  
+| `type` | 追加领取的数据类型 | String | `addAndTake` / `add` / `take` / `reduceBaof` |
+| `accountData` | 追加领取的数据 | Object | 见 AccountData 对象 |
+| `accountInsuranceId` | 追加领取险种的 key | Number | — |
+| `reduceBaofData` | 减保领取的数据 | Object | 见 ReduceBaofData 对象 |
+| `reduceBaofData2` | 双减保领取的数据 | Object | 见 ReduceBaofData 对象 |
+| `reduceBaofInsuranceId` | 减保领取险种的 key | Number | — |
+| `interestData` | 利益数据 | Object | 见 InterestData 对象 |