neo-cmp-cli 1.5.6 → 1.6.0-beta.10

package/src/neo/neoService.js

@@ -2,17 +2,44 @@ const axios = require('axios');
 const FormData = require('form-data');
 const fs = require('fs');
 const path = require('path');
+const ora = require('ora');
 const _ = require('lodash');
-const updatePublishLog = require('../projectUtils/updatePublishLog');
+const { resolve } = require('akfun');
+const updatePublishLog = require('../utils/projectUtils/updatePublishLog');
+const { getFramework } = require('../utils/common');
 
 // NeoCRM 平台默认 API 配置
 const NeoCrmAPI = {
   neoBaseURL: 'https://crm.xiaoshouyi.com', // 平台根地址
   tokenAPI: 'https://login.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
   uploadAPI: '/rest/metadata/v3.0/ui/customComponents/actions/upload', // 文件上传接口地址
+  delete: '/rest/metadata/v3.0/ui/customComponents',
+  query: '/rest/metadata/v3.0/ui/customComponents/actions/queryCustomComponents', // 带分页
+  queryAll: '/rest/metadata/v3.0/ui/customComponents/actions/queryAllCustomComponents', // 不带分页
   saveAPI: '/rest/metadata/v3.0/ui/customComponents/actions/saveOrUpdateComponent' // 创建或者保存接口地址
 };
 
+const cmpFields = [
+  'cmpType',
+  'label',
+  'componentCategory',
+  'description',
+  'framework',
+  'icon',
+  'orderNo',
+  'version',
+  'propsSchema',
+  'defaultProps',
+  'previewProps',
+  'events',
+  'actions',
+  'asset',
+  'plugin',
+  'modelAsset',
+  'cssAsset',
+  'codeLib'
+];
+
 /**
  * Neo 平台服务类
  * 提供 token 管理、文件上传、组件更新等功能
@@ -23,32 +50,29 @@ class NeoService {
    * @param {object} config 配置信息
    * @param {string} config.neoBaseURL Neo 平台根地址
    * @param {string} config.tokenAPI Token 获取接口地址
-   * @param {object} config.authConfig 授权信息
-   * @param {string} config.authConfig.client_id 客户端 ID
-   * @param {string} config.authConfig.client_secret 客户端密钥
-   * @param {string} config.authConfig.username 用户名
-   * @param {string} config.authConfig.password 密码
+   * @param {object} config.auth 授权信息
+   * @param {string} config.auth.client_id 客户端 ID
+   * @param {string} config.auth.client_secret 客户端密钥
+   * @param {string} config.auth.username 用户名
+   * @param {string} config.auth.password 密码
    */
   constructor(config = {}) {
-    const { assetsRoot, neoBaseURL, tokenAPI, authConfig } = config;
-    if (!authConfig) {
-      throw new Error('authConfig 不能为空');
+    const { assetsRoot, neoBaseURL, tokenAPI, auth } = config || {};
+    if (!auth) {
+      throw new Error('auth 不能为空');
     }
-    if (
-      !authConfig.client_id ||
-      !authConfig.client_secret ||
-      !authConfig.username ||
-      !authConfig.password
-    ) {
+    if (!auth.client_id || !auth.client_secret || !auth.username || !auth.password) {
       throw new Error(
-        'authConfig 配置不完整，需要包含 client_id、client_secret、username、password'
+        'neoConfig / auth 配置不完整，需要包含 client_id、client_secret、username、password'
       );
     }
 
-    this.assetsRoot = assetsRoot;
+    this.assetsRoot = assetsRoot || resolve('dist');
     this.neoBaseURL = neoBaseURL || NeoCrmAPI.neoBaseURL;
     this.tokenAPI = tokenAPI || NeoCrmAPI.tokenAPI;
-    this.authConfig = authConfig;
+    this.auth = auth;
+    this.cmpList = [];
+    this.cmpInfoMap = {};
 
     // Token 缓存
     this.tokenCache = {
@@ -96,20 +120,20 @@ class NeoService {
    * @returns {Promise<string>} token
    */
   async getToken() {
+    const spinner = ora('获取 token...').start();
     // 检查缓存是否有效
     if (!this.isTokenExpired()) {
-      console.info('使用缓存的 token');
+      spinner.succeed('使用缓存的 token。');
       return this.tokenCache.token;
     }
-    console.info('获取 token...');
 
     // 构建表单数据格式的请求参数
     const formData = new URLSearchParams();
     formData.append('grant_type', 'password');
-    formData.append('client_id', this.authConfig.client_id);
-    formData.append('client_secret', this.authConfig.client_secret);
-    formData.append('username', this.authConfig.username);
-    formData.append('password', this.authConfig.password);
+    formData.append('client_id', this.auth.client_id);
+    formData.append('client_secret', this.auth.client_secret);
+    formData.append('username', this.auth.username);
+    formData.append('password', this.auth.password);
 
     const tokenUrl = this.buildFullUrl(this.tokenAPI);
 
@@ -123,7 +147,7 @@ class NeoService {
       const { access_token, expires_in } = response.data || {};
 
       if (!access_token) {
-        console.error('\n获取 token 失败（授权配置错误）：响应中未包含 access_token', response.data);
+        spinner.fail('获取 token 失败（授权配置错误）：响应中未包含 access_token，', response.data);
         process.exit(1);
       }
 
@@ -133,6 +157,8 @@ class NeoService {
         token: access_token,
         expiresAt: Date.now() + (expiresIn - 60) * 1000
       };
+      spinner.clear();
+      spinner.stop();
       return access_token;
     } catch (error) {
       console.error('\n获取 token 失败:', error.message);
@@ -167,8 +193,10 @@ class NeoService {
     if (!this.tokenCache.token) {
       return await this.getToken();
     } else if (this.isTokenExpired()) {
-      console.info('token 已过期，正在刷新...');
-      return await this.refreshToken();
+      const spinner = ora('token 已过期，正在刷新...').start();
+      const token = await this.refreshToken();
+      spinner.succeed('token 刷新成功。');
+      return token;
     }
     return this.tokenCache.token;
   }
@@ -216,13 +244,13 @@ class NeoService {
 
     const fileName = path.basename(filePath);
     const fileSizeKB = (fileStat.size / 1024).toFixed(2);
-    console.info(`正在上传文件: ${fileName} (${fileSizeKB}KB)...`);
+    const spinner = ora(`正在上传文件: ${fileName} (${fileSizeKB}KB)...`).start();
 
     try {
       // 创建 FormData
       const formData = new FormData();
       const fieldName = options.fieldName || 'customComponentCode';
-      
+
       // 使用文件流而不是读取整个文件到内存（对大文件更友好）
       const fileContent = fs.createReadStream(filePath);
 
@@ -265,7 +293,11 @@ class NeoService {
         resultData = responseData.trim();
       } else if (responseData && typeof responseData === 'object') {
         // 检查是否有错误码
-        if (responseData.code !== undefined && responseData.code !== 200 && responseData.code !== 0) {
+        if (
+          responseData.code !== undefined &&
+          responseData.code !== 200 &&
+          responseData.code !== 0
+        ) {
           const errorMsg = responseData.message || responseData.msg || '未知错误';
           throw new Error(`上传失败: ${errorMsg} (code: ${responseData.code})`);
         }
@@ -296,36 +328,35 @@ class NeoService {
       } else if (resultData && typeof resultData === 'object' && resultData.url) {
         fileUrl = resultData.url;
       }
-      console.info(`\n文件上传成功: ${fileName} -> ${fileUrl}`);
+      spinner.succeed(`文件上传成功: ${fileName} -> ${fileUrl}`);
       return fileUrl;
     } catch (error) {
-      console.error(`\n上传文件失败: ${error.message}，`);
-      console.error(`文件路径: ${filePath}。\n`);
-      
+      spinner.fail(`上传文件失败: ${error.message}, 文件路径: ${filePath}`);
+
       // 输出详细的错误信息
       if (error.response) {
         const status = error.response.status;
         const statusText = error.response.statusText;
         const responseData = error.response.data;
         const requestUrl = error.config?.url || this.uploadAPI();
-        
+
         console.error(`\n========== 上传请求详情 ==========`);
         console.error(`请求 URL: ${requestUrl}`);
         console.error(`HTTP 状态码: ${status} ${statusText}`);
         console.error(`响应数据:`, responseData);
         console.error(`==================================\n`);
-        
+
         if (status === 404) {
           throw new Error(
             `上传 API 不存在 (404): ${requestUrl}\n` +
-            `请检查 neo.config.js 中的 neoBaseURL 配置是否正确，或者 API 路径是否存在。\n` +
-            `当前配置的 API 路径: ${NeoCrmAPI.uploadAPI}`
+              `请检查 neo.config.js 中的 neoBaseURL 配置是否正确，或者 API 路径是否存在。\n` +
+              `当前配置的 API 路径: ${NeoCrmAPI.uploadAPI}`
           );
         }
       } else if (error.request) {
         console.error('请求已发送但未收到响应，请检查网络连接或代理配置。');
       }
-      
+
       throw error;
     }
   }
@@ -345,6 +376,7 @@ class NeoService {
       console.error(`未找到自定义组件资源目录: ${this.assetsRoot}`);
       return;
     }
+
     // 当前组件信息
     const curCmpInfo = {
       cmpType
@@ -410,7 +442,7 @@ class NeoService {
       throw new Error('componentData 不能为空');
     }
 
-    console.info('正在更新自定义组件...');
+    const spinner = ora('正在更新自定义组件...').start();
 
     try {
       const fullUpdateAPI = this.saveAPI();
@@ -421,15 +453,16 @@ class NeoService {
           'Content-Type': 'application/json'
         }
       });
-      const {code, message} = response.data || {};
+      const { code, message } = response.data || {};
 
       if (code && code !== 200) {
         throw new Error(`更新组件失败: ${response.data.message || '未知错误'}`);
       }
-      
 
-      console.info(message ? `组件更新成功: ${message}。` : '组件更新成功。');
+      spinner.clear();
+      spinner.stop();
     } catch (error) {
+      spinner.fail('更新组件失败。');
       if (error.message) {
         console.error('更新组件失败:', error.message);
       } else {
@@ -439,6 +472,84 @@ class NeoService {
     }
   }
 
+  /**
+   * 获取线上自定义组件列表
+   * @returns {Promise<array>} 自定义组件列表
+   */
+  async getCustomCmpList() {
+    // 确保 token 有效
+    const token = await this.ensureValidToken();
+
+    /*
+    // 如果自定义组件列表已存在，则直接返回
+    if (this.cmpList && this.cmpList.length > 0) {
+      return this.cmpList;
+    }
+    */
+
+    try {
+      let queryAllAPI = this.buildFullUrl(NeoCrmAPI.queryAll);
+      queryAllAPI += `?fields=${cmpFields.join(',')}`;
+      const response = await axios.post(
+        queryAllAPI,
+        {
+          data: {}
+        },
+        {
+          headers: {
+            Authorization: `Bearer ${token}`,
+            'xsy-inner-source': 'bff',
+            'Content-Type': 'application/json'
+          }
+        }
+      );
+      const { code, message } = response.data || {};
+
+      if (code && code !== 200) {
+        throw new Error(`获取自定义组件列表失败: ${message || '未知错误'}`);
+      }
+
+      this.updateCustomCmpList(response.data.data || []);
+    } catch (error) {
+      if (error.message) {
+        console.error('获取自定义组件列表失败:', error.message);
+      } else {
+        console.error('响应数据:', error);
+      }
+      process.exit(1);
+    }
+
+    return this.cmpList || [];
+  }
+
+  // 获取指定框架的自定义组件列表
+  getCmpListByFramework(framework) {
+    if (!framework) {
+      return this.cmpList;
+    }
+    const curFramework = getFramework(framework);
+    return this.cmpList.filter((cmp) => cmp.framework === curFramework);
+  }
+
+  // 获取自定义组件信息
+  getCmpInfoByCmpType(cmpType) {
+    if (!cmpType) {
+      return null;
+    }
+    return this.cmpInfoMap[cmpType] || null;
+  }
+
+  // 更新自定义组件 Map
+  updateCustomCmpList(cmpList) {
+    if (!cmpList || !Array.isArray(cmpList)) {
+      return;
+    }
+    this.cmpList = cmpList;
+    cmpList.forEach((cmp) => {
+      this.cmpInfoMap[cmp.cmpType] = cmp;
+    });
+  }
+
   /**
    * 通用请求方法（确保 token 有效）
    * @param {string} method HTTP 方法

package/src/oss/publish2oss.js

@@ -2,9 +2,10 @@ const { aliBOS, baiduBOS } = require('akfun');
 const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
+const ora = require('ora');
 const { catchCurPackageJson } = require('../utils/pathUtils');
 const getConfigObj = require('../utils/getConfigObj');
-const updatePublishLog = require('../projectUtils/updatePublishLog');
+const updatePublishLog = require('../utils/projectUtils/updatePublishLog');
 
 // 获取当前项目的package文件
 const currentPackageJsonDir = catchCurPackageJson();
@@ -40,7 +41,11 @@ const getFilePath = (ossType, bucket, objectKey) => {
     baidu: 'bj.bcebos.com',
     ali: 'oss-cn-beijing.aliyuncs.com'
   };
-  return `https://${bucket}.${regions[ossType]}/${objectKey}`;
+  const region = regions[ossType];
+  if (!region) {
+    throw new Error(`不支持的oss类型: ${ossType}`);
+  }
+  return `https://${bucket}.${region}/${objectKey}`;
 };
 
 // 获取上传成功和失败的文件信息
@@ -92,12 +97,12 @@ const getResultFilesByWidgetName = (files) => {
     }
     let widgetName = file.widgetName;
     const curCmpInfo = {
-      'cmpType': _.kebabCase(widgetName),
-    }
+      cmpType: _.kebabCase(widgetName)
+    };
 
     if (widgetName.includes('Model')) {
       widgetName = widgetName.replace('Model', '');
-      curCmpInfo.cmpType = _.kebabCase(widgetName),
+      curCmpInfo.cmpType = _.kebabCase(widgetName);
       curCmpInfo.modelAsset = !file.success ? `${file.error}[${file.ossPath}]` : file.ossPath;
     } else if (file.fileName.endsWith('.css')) {
       curCmpInfo.cssAsset = !file.success ? `${file.error}[${file.ossPath}]` : file.ossPath;
@@ -146,6 +151,75 @@ function addVersionToFilename(
   return `${projectName}/${baseName}-${version}${extension}`;
 }
 
+/**
+ * 上传单个文件到 OSS
+ * @param {object} bosClient OSS 客户端实例
+ * @param {string} filePath 文件路径
+ * @param {string} objectKey OSS 对象键
+ * @param {string} ossType OSS 类型
+ * @param {object} ossConfig OSS 配置
+ * @param {object} fileInfo 文件信息
+ * @returns {Promise<object>} 上传结果
+ */
+async function uploadSingleFile(bosClient, filePath, objectKey, ossType, ossConfig, fileInfo) {
+  const fileName = path.basename(filePath);
+  const fileSizeKB = (fs.statSync(filePath).size / 1024).toFixed(2);
+  const spinner = ora(`正在上传文件: ${fileName} (${fileSizeKB}KB)...`).start();
+
+  try {
+    // 判断线上是否存在重名文件，避免被覆盖
+    const historyResult = await bosClient.get(objectKey);
+    if (historyResult && historyResult.url) {
+      spinner.warn(`文件已存在，跳过上传: ${fileName}`);
+      return {
+        success: false,
+        status: '文件上传失败',
+        widgetName: fileInfo.name,
+        fileName: fileName,
+        filepath: filePath,
+        ossPath: historyResult.url,
+        error: '线上存在重名文件。'
+      };
+    }
+
+    // 上传文件
+    const result = await bosClient.upload(objectKey, filePath);
+    const ossPath = getFilePath(ossType, ossConfig.bucket, objectKey);
+    spinner.succeed(`文件上传成功: ${fileName} -> ${ossPath}`);
+
+    return {
+      success: true,
+      status: '文件上传成功',
+      fileName: fileName,
+      widgetName: fileInfo.name,
+      filepath: filePath,
+      ossPath: ossPath,
+      resultMsg: result
+    };
+  } catch (error) {
+    spinner.fail(`文件上传失败: ${fileName}`);
+
+    // 输出详细的错误信息
+    console.error(`\n========== 上传文件详情 ==========`);
+    console.error(`文件路径: ${filePath}`);
+    console.error(`OSS 对象键: ${objectKey}`);
+    console.error(`错误信息: ${error.message}`);
+    if (error.stack) {
+      console.error(`错误堆栈:`, error.stack);
+    }
+    console.error(`==================================\n`);
+
+    return {
+      success: false,
+      status: '文件上传失败',
+      widgetName: fileInfo.name,
+      fileName: fileName,
+      filepath: filePath,
+      error: error.message
+    };
+  }
+}
+
 /**
  * 将构建产物上传到指定 oss 存储桶
  *
@@ -154,91 +228,120 @@ function addVersionToFilename(
  * @param {string} assetsRoot 构建产物的目录
  * @param {array} fileExtensions 需要上传的文件类型，默认 ['.js', '.css']
  */
-const publish2oss = (ossType, ossConfig, assetsRoot, fileExtensions = ['.js', '.css']) => {
+const publish2oss = async (ossType, ossConfig, assetsRoot, fileExtensions = ['.js', '.css']) => {
+  // 参数验证
   if (ossType !== 'baidu' && ossType !== 'ali') {
     console.error(`不支持的oss类型: ${ossType}`);
     return;
   }
-  const bosClient = getBosClient(ossType, ossConfig);
+
+  if (!ossConfig) {
+    console.error('ossConfig 不能为空');
+    return;
+  }
+
   if (!assetsRoot) {
     console.error('assetsRoot 不能为空');
     return;
   }
+
+  // 检查目录是否存在
   if (!fs.existsSync(assetsRoot)) {
     console.error(`assetsRoot 不存在: ${assetsRoot}`);
     return;
   }
-  const files = fs.readdirSync(assetsRoot); // 读取构建目录下的所有文件
-
-  // 并行上传所有指定类型的文件
-  const uploadPromises = files.map(async (file) => {
-    const filePath = path.join(assetsRoot, file);
-    // 获取文件状态
-    const fileStat = fs.statSync(filePath);
-    // 检查文件扩展名
-    // const fileExt = path.extname(file);
-    const fileInfo = path.parse(filePath);
-    if (fileStat.isFile() && fileExtensions.includes(fileInfo.ext)) {
-      const objectKey = addVersionToFilename(file);
+
+  // 检查目录是否为目录
+  const assetsRootStat = fs.statSync(assetsRoot);
+  if (!assetsRootStat.isDirectory()) {
+    console.error(`assetsRoot 不是目录: ${assetsRoot}`);
+    return;
+  }
+
+  // 创建 OSS 客户端
+  const bosClient = getBosClient(ossType, ossConfig);
+  if (!bosClient) {
+    console.error(`无法创建 OSS 客户端，请检查 ossType 和 ossConfig 配置`);
+    return;
+  }
+
+  // 读取构建目录下的所有文件
+  const files = fs.readdirSync(assetsRoot);
+  if (files.length === 0) {
+    console.warn(`构建目录为空: ${assetsRoot}`);
+    return;
+  }
+
+  const spinner = ora('正在准备上传文件...').start();
+
+  try {
+    // 过滤出需要上传的文件
+    const filesToUpload = files.filter((file) => {
+      const filePath = path.join(assetsRoot, file);
       try {
-        // 判断线上是否存在重名文件，避免被覆盖
-        const historyResult = await bosClient.get(objectKey);
-        if (historyResult && historyResult.url) {
-          return {
-            success: false,
-            status: '文件上传失败',
-            widgetName: fileInfo.name,
-            fileName: file,
-            filepath: filePath,
-            ossPath: historyResult.url,
-            error: '线上存在重名文件。'
-          };
+        const fileStat = fs.statSync(filePath);
+        if (!fileStat.isFile()) {
+          return false;
         }
-        // 上传文件
-        const result = await bosClient.upload(objectKey, filePath);
-        return {
-          success: true,
-          status: '文件上传成功',
-          fileName: file,
-          widgetName: fileInfo.name,
-          filepath: filePath,
-          ossPath: getFilePath(ossType, ossConfig.bucket, objectKey),
-          resultMsg: result
-        };
+        const fileInfo = path.parse(filePath);
+        return fileExtensions.includes(fileInfo.ext);
       } catch (error) {
-        return {
-          success: false,
-          status: '文件上传失败',
-          widgetName: fileInfo.name,
-          fileName: file,
-          filepath: filePath,
-          error: error.message
-        };
+        console.warn(`无法读取文件状态: ${filePath}`, error.message);
+        return false;
       }
+    });
+
+    if (filesToUpload.length === 0) {
+      spinner.warn('未找到需要上传的文件');
+      return;
     }
-  });
 
-  Promise.all(uploadPromises)
-    .then((results) => {
-      /*
-      const { succeedFiles, errorFiles } = getResultFiles(results);
-      if (succeedFiles.length > 0) {
-        console.info('已成功上传如下文件：\n', succeedFiles);
-      }
-      if (errorFiles.length > 0) {
-        console.info('上传失败的文件有：\n', errorFiles);
-      }
-      */
-      const widgetFilesMap = getResultFilesByWidgetName(results);
-      if (widgetFilesMap) {
-        console.info('上传至 OSS 的文件信息：\n', widgetFilesMap);
-        // 更新发布日志
-        updatePublishLog(widgetFilesMap);
-      }
-    })
-    .catch((error) => {
-      console.error('批量上传文件异常：\n', error);
+    spinner.succeed(`找到 ${filesToUpload.length} 个文件需要上传`);
+
+    // 并行上传所有指定类型的文件
+    const uploadPromises = filesToUpload.map(async (file) => {
+      const filePath = path.join(assetsRoot, file);
+      const fileInfo = path.parse(filePath);
+      const objectKey = addVersionToFilename(file);
+
+      return await uploadSingleFile(bosClient, filePath, objectKey, ossType, ossConfig, fileInfo);
     });
+
+    // 等待所有文件上传完成
+    const results = await Promise.all(uploadPromises);
+
+    // 过滤掉 undefined 结果（不符合条件的文件）
+    const validResults = results.filter((result) => result !== undefined);
+
+    // 处理上传结果
+    const widgetFilesMap = getResultFilesByWidgetName(validResults);
+    if (widgetFilesMap && Object.keys(widgetFilesMap).length > 0) {
+      console.info('\n上传至 OSS 的文件信息：\n', widgetFilesMap);
+      // 更新发布日志
+      updatePublishLog(widgetFilesMap);
+    } else {
+      console.warn('未生成有效的文件上传结果');
+    }
+
+    // 统计上传结果
+    const succeedCount = validResults.filter((r) => r && r.success).length;
+    const failCount = validResults.filter((r) => r && !r.success).length;
+
+    if (failCount > 0) {
+      console.warn(`\n上传完成：成功 ${succeedCount} 个，失败 ${failCount} 个`);
+    } else {
+      console.info(`\n✅ 所有文件上传成功！共 ${succeedCount} 个文件`);
+    }
+  } catch (error) {
+    spinner.fail('批量上传文件异常');
+    console.error('\n========== 批量上传异常 ==========');
+    console.error('错误信息:', error.message);
+    if (error.stack) {
+      console.error('错误堆栈:', error.stack);
+    }
+    console.error('==================================\n');
+    throw error;
+  }
 };
 
 module.exports = publish2oss;

package/src/template/antd-custom-cmp-template/README.md

@@ -2,8 +2,8 @@
 - src: 自定义组件源码；
 - src/assets: 存放组件静态资源，比如 css、img等；
 - src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
-- src/components/info-card/index.tsx: 自定义组件的内容文件；
-- src/components/info-card/model.ts: 自定义组件的模型文件，用于对接页面设计器；
+- src/components/xxCmp/index.tsx: 自定义组件的内容文件；
+- src/components/xxCmp/model.ts: 自定义组件的模型文件，用于对接页面设计器；
 - neo.config.js: neo-cmp-cli 配置文件。
 
 ### 组件开发规范
@@ -43,5 +43,29 @@ $ npm run linkDebug
 $ npm run pushCmp
 ```
 
+##### 需自行添加 NeoCRM 授权配置
+```javascript
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+    // NeoCRM 授权配置
+    auth: {
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      /**
+       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+       */
+      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
+    },
+  },
+}
+```
+1、客户端 ID 和 客户端秘钥 需通过 创建连接器 获取，获取方式见：[https://doc.xiaoshouyi.com](https://doc.xiaoshouyi.com) / 创建连接器；
+2、如何获取 安全令牌 见：[https://doc.xiaoshouyi.com](https://doc.xiaoshouyi.com) / OAuth安全认证 / 密码模式 / 获取令牌；
+3、发布成功后即可在 NeoCRM 对应租户环境的页面设计器和表单设计器中使用此自定义组件。
+
 ### 配置项说明（neo-cmp-cli）
 [请查看neo-cmp-cli](https://github.com/wibetter/neo-cmp-cli)