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

package/src/module/index.js

@@ -2,6 +2,7 @@ const figlet = require('figlet'); // 用于输出图形文字
 const yargs = require('yargs'); // 命令行工具
 const chalk = require('chalk'); // 带样式的log输出
 const inquirer = require('inquirer'); // 问答式交互
+const ora = require('ora');
 
 const neoInit = require('./neoInit.js');
 const neoInitByCopy = require('./neoInitByCopy.js');
@@ -10,6 +11,7 @@ const neoConfigInit = require('../utils/neoConfigInit.js');
 const { validateProjectName } = require('../utils/projectNameValidator.js');
 const mainAction = require('./main.js'); // 入口文件
 const getCmpTypeByDir = require('../cmpUtils/getCmpTypeByDir.js');
+const NeoService = require('../neo/neoService.js');
 
 // neo 的 package 文件
 const neoPackage = require('../../package.json');
@@ -67,6 +69,11 @@ yargs
             value: 'react-ts',
             short: 'react-ts'
           },
+          {
+            name: 'Neo 自定义组件（使用平台实体数据源）',
+            value: 'neo',
+            short: 'neo'
+          },
           {
             name: 'antd 自定义组件',
             value: 'antd',
@@ -77,11 +84,6 @@ yargs
             value: 'echarts',
             short: 'echarts'
           },
-          {
-            name: 'Neo 自定义组件',
-            value: 'neo',
-            short: 'neo'
-          },
           /*
           // 暂不提供 react js 模板（react js 模板已废弃）
           {
@@ -227,6 +229,53 @@ yargs
       }
     }
   )
+  .command(
+    'pullCmp [options]',
+    '拉取线上自定义组件',
+    (yargs) => {
+      yargs
+        .reset()
+        .usage(titleTip('Usage') + ': $0 preview [options]')
+        .option('name', {
+          alias: 'n',
+          describe: '自定义组件名称'
+        })
+        .alias('h', 'help');
+    },
+    async (argv) => {
+      if (argv.name) {
+        mainAction.pullCmp(argv.name);
+      } else {
+        // 创建 neoService 实例
+        const neoService = new NeoService(authConfig);
+        const spinner = ora('正在获取自定义组件列表...').start();
+        const cmpList = await neoService.getCustomCmpList();
+        if (cmpList.length === 0) {
+          console.error('当前租户暂无任何自定义组件。');
+          process.exit(1);
+        }
+        spinner.clear();
+        const cmpTypeChoices = cmpList.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
+        questions.push({
+          name: 'cmpType',
+          type: 'list',
+          message: '请选择要拉取的自定义组件:',
+          choices: cmpTypeChoices
+        });
+        inquirer.prompt(questions).then((ans) => {
+          if (!ans.name) {
+            console.error('自定义组件名称不能为空。');
+            process.exit(1);
+          } else {
+            mainAction.pullCmp(ans.name, neoService);
+          }
+        });
+      }
+    }
+  )
   .command(
     'preview [options]',
     '预览指定自定义组件（仅预览组件本身内容）',

package/src/module/main.js

@@ -17,6 +17,7 @@ const { getExternalsByNeoCommonModules } = require('../neo/neoRequire');
 const createCommonModulesCode = require('../cmpUtils/createCommonModulesCode');
 const createCmpByTemplate = require('../cmpUtils/createCmpByTemplate');
 const createCmpProjectByTemplate = require('../projectUtils/createCmpProjectByTemplate');
+const pullCmp = require('../cmpUtils/pullCmp');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
@@ -277,8 +278,9 @@ module.exports = {
   },
   // 发布组件到 NeoCRM 平台
   pushCmp: (cmpType) => {
+    const { neoConfig, pushCmp: _pushCmpConfig } = curConfig;
+    const pushCmpConfig = Object.assign({}, _pushCmpConfig, neoConfig);
     // 将 pushCmp 相关配置设置给 build2lib
-    const pushCmpConfig = curConfig.pushCmp;
     curConfig.build2lib = Object.assign(curConfig.build2lib, pushCmpConfig);
 
     const curEntry = curConfig.build2lib.entry;
@@ -363,5 +365,9 @@ module.exports = {
       pushCmp(pushCmpConfig, cmpType);
     });
   },
+  // 从 NeoCRM 平台拉取组件
+  pullCmp: (cmpType, neoService) => {
+    pullCmp(cmpType, curConfig.neoConfig, neoService);
+  },
   build2esm: (fileName) => akfun.build2esm(fileName, curConfig, consoleTag) // 构建esm输出模块
 };

package/src/neo/NeoUMDContent.js

@@ -1,6 +1,7 @@
 /**
  * 内置 UMD 模块，用于在 Node cli 端加载自定义组件模型
  * 特别说明：这个文件内容会通过 AddNeoRequirePlugin 插入的构建代码中。
+ * 暂未使用，保留备用。
  */
 (function (root, factory) {
   // AMD 环境检测

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 { resolve } = require('akfun');
 const updatePublishLog = require('../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,34 @@ 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
+      !auth.client_id ||
+      !auth.client_secret ||
+      !auth.username ||
+      !auth.password
     ) {
       throw new Error(
-        'authConfig 配置不完整，需要包含 client_id、client_secret、username、password'
+        '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 +125,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 +152,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 +162,7 @@ class NeoService {
         token: access_token,
         expiresAt: Date.now() + (expiresIn - 60) * 1000
       };
+      spinner.succeed('获取 token 成功。');
       return access_token;
     } catch (error) {
       console.error('\n获取 token 失败:', error.message);
@@ -167,8 +197,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 +248,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 +297,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 +332,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;
     }
   }
@@ -410,7 +445,7 @@ class NeoService {
       throw new Error('componentData 不能为空');
     }
 
-    console.info('正在更新自定义组件...');
+    const spinner = ora('正在更新自定义组件...').start();
 
     try {
       const fullUpdateAPI = this.saveAPI();
@@ -421,15 +456,15 @@ 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.succeed(message ? `组件更新成功: ${message}。` : '组件更新成功。');
     } catch (error) {
+      spinner.fail('更新组件失败。');
       if (error.message) {
         console.error('更新组件失败:', error.message);
       } else {
@@ -439,6 +474,79 @@ 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, {}, {
+        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/projectUtils/createCmpProjectZip.js

@@ -13,7 +13,7 @@ const hasNeoProject = require('./hasNeoProject');
 module.exports = function (cmpType, _projectPath, assetsRoot) {
   const projectRoot = _projectPath || process.cwd();
   const finalAssetsRoot = assetsRoot || path.join(projectRoot, 'dist');
-  
+
   if (!hasNeoProject(_projectPath)) {
     console.error(`${consoleTag}当前目录不是自定义组件项目，请在自定义组件项目目录下执行。`);
     process.exit(1);
@@ -25,11 +25,11 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
   }
 
   const zip = new AdmZip();
-  
+
   // 需要排除的目录和文件
   const excludeDirs = ['node_modules', '.neo-cli', 'dist'];
   const excludeFiles = ['.eslintcache', 'auth.config.js'];
-  
+
   /**
    * 判断文件/目录是否应该被排除
    * @param {string} filePath 文件路径
@@ -39,17 +39,17 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
   const shouldExclude = (filePath, relativePath) => {
     const name = path.basename(filePath);
     const stat = fs.statSync(filePath);
-    
+
     // 排除指定的目录
     if (stat.isDirectory() && excludeDirs.includes(name)) {
       return true;
     }
-    
+
     // 排除指定的文件
     if (stat.isFile() && excludeFiles.includes(name)) {
       return true;
     }
-    
+
     // 对于 src/components 目录，只包含 cmpType 子目录
     // 处理逻辑：如果路径是 src/components/xxx，且 xxx 不是 cmpType，则排除
     if (relativePath.startsWith('src/components')) {
@@ -63,10 +63,10 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
         }
       }
     }
-    
+
     return false;
   };
-  
+
   /**
    * 递归遍历目录并添加到 zip
    * @param {string} dirPath 目录路径
@@ -75,18 +75,18 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
   const addDirectoryToZip = (dirPath, relativePath = '') => {
     try {
       const items = fs.readdirSync(dirPath);
-      
+
       items.forEach((item) => {
         const itemPath = path.join(dirPath, item);
         const itemRelativePath = relativePath ? path.join(relativePath, item) : item;
-        
+
         // 检查是否应该排除
         if (shouldExclude(itemPath, itemRelativePath)) {
           return;
         }
-        
+
         const stat = fs.statSync(itemPath);
-        
+
         if (stat.isDirectory()) {
           // 递归处理子目录
           addDirectoryToZip(itemPath, itemRelativePath);
@@ -100,23 +100,23 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
       console.error(`${consoleTag}遍历目录失败 (${dirPath}):`, error.message);
     }
   };
-  
+
   // 开始遍历项目根目录
   addDirectoryToZip(projectRoot);
-  
+
   // 生成 zip 文件名
   const zipFileName = `${_.camelCase(cmpType)}Source.zip`;
   const zipPath = path.join(finalAssetsRoot, zipFileName);
-  
+
   // 如果已存在同名 zip 文件，先删除
   if (fs.existsSync(zipPath)) {
     fs.removeSync(zipPath);
   }
-  
+
   // 写入 zip 文件
   zip.writeZip(zipPath);
-  
+
   console.log(`${consoleTag}已创建自定义组件源码 zip 包: ${zipFileName}`);
-  
+
   return zipPath;
 };

package/src/projectUtils/hasNeoProject.js

@@ -2,8 +2,8 @@ const fs = require('fs-extra');
 const path = require('path');
 
 /**
- * 判断当前是否存在 neo 项目
- * 备注：neo.config.js 和 package.json 必须同时存在才算作 neo 项目
+ * 判断当前是否存在 自定义组件项目
+ * 备注：neo.config.js 和 package.json 必须同时存在才算作 自定义组件项目
  */
 module.exports = function (_projectPath) {
   const projectPath = _projectPath || process.cwd();

package/src/template/antd-custom-cmp-template/neo.config.js

@@ -97,12 +97,12 @@ module.exports = {
     }
     */
   },
-  pushCmp: {
-    // 用于构建并发布至 NeoCRM 的相关配置
+  // NeoCRM 平台配置
+  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 授权配置
-    authConfig: {
+    auth: {
       client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
       client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
       username: 'xx', // 用户在销售易系统中的用户名
@@ -111,7 +111,10 @@ module.exports = {
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
       password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    },
+    }
+  },
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',

package/src/template/antd-custom-cmp-template/package.json

@@ -2,6 +2,7 @@
   "name": "antd-custom-cmp-template",
   "version": "1.1.9",
   "description": "neo自定义组件模板（react&ts技术栈）",
+  "framework": "react-ts",
   "keywords": [
     "自定义组件模板",
     "react&ts技术栈",

package/src/template/echarts-custom-cmp-template/neo.config.js

@@ -98,12 +98,12 @@ module.exports = {
     }
     */
   },
-  pushCmp: {
-    // 用于构建并发布至 NeoCRM 的相关配置
+  // NeoCRM 平台配置
+  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 授权配置
-    authConfig: {
+    auth: {
       client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
       client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
       username: 'xx', // 用户在销售易系统中的用户名
@@ -112,7 +112,10 @@ module.exports = {
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
       password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    },
+    }
+  },
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',

package/src/template/echarts-custom-cmp-template/package.json

@@ -2,6 +2,7 @@
   "name": "echarts-custom-cmp-template",
   "version": "1.1.19",
   "description": "neo自定义组件模板（react&ts技术栈）",
+  "framework": "react-ts",
   "keywords": [
     "自定义组件模板",
     "react&ts技术栈",