neo-cmp-cli 1.5.0-beta.3 → 1.5.0-beta.5

package/README.md

@@ -1,14 +1,14 @@
 ## Neo 自定义组件开发工具
-neo-cmp-cli 是 Neo 自定义组件开发工具，基于 [AKFun](https://github.com/wibetter/akfun) 的工程能力，提供 初始化、编译构建、预览调试、热更新、多技术栈支持和一键发布等功能。
+neo-cmp-cli 是 Neo 自定义组件开发工具，基于 [AKFun](https://github.com/wibetter/akfun) 的工程能力，提供 初始化、编译构建、预览调试、热更新、多技术栈支持和发布等功能。
 
 ### 主要特性
 - **零配置**: 内置默认配置，开箱可用；
 - **多技术栈**: 支持 Vue2、React、React+TypeScript 自定义组件的调试、构建与发布；
-- **多构建场景**: 本地预览（含热更新/代理）、外链调试、库构建（UMD/ESM）；
+- **多构建场景**: 本地预览（含热更新/代理）、外链调试、库构建（UMD/ESM）、部署&发布；
 - **灵活可配**: 支持 构建入口、别名、代理、SASS 注入、ESLint/StyleLint、Babel/Loader/Plugin 扩展等配置；
 - **样式与规范**: 内置 Autoprefixer、Sass、PostCSS、ESLint、StyleLint；
-- **参数替换**: 支持基于 [params-replace-loader](https://www.npmjs.com/package/params-replace-loader) 的环境变量批量替换；
-- **一键发布**: 内置发布到 OSS 的能力，并支持自定义对象存储配置。
+- **发布至 CDN**: 内置发布到对象存储（OSS）的能力，支持自定义对象存储配置；
+- **发布至 NeoCRM 平台**: 支持一键发布到NeoCRM 平台的能力，需自行补充授权配置；
 
 ### 内置的自定义组件模板
 创建自定义组件时（执行初始化命令 neo init）可选用。
@@ -40,8 +40,8 @@ neo preview
 # 外链调试（在平台线上预览与调试）
 neo linkDebug
 
-# 构建并发布到 OSS（确保 package.json 的 name 唯一、version 不重复）
-neo publish2oss
+# 构建并发布到 NeoCRM（需自行添加授权配置，并确保 package.json 的 name 唯一、version 不重复）
+neo publish2neo
 ```
 
 ### 方法二：在现有业务项目中使用自定义组件开发工具
@@ -58,7 +58,7 @@ npm i neo-cmp-cli --save-dev
 ```bash
 "preview": "neo preview",
 "linkDebug": "neo linkDebug",
-"publish2oss": "neo publish2oss"
+"publish2neo": "neo publish2neo"
 ```
 ##### 3) 初始化配置文件
 ```bash
@@ -76,6 +76,7 @@ npm run publish2oss
 - **neo preview**: 本地预览自定义组件内容，默认支持热更新与接口代理。
 - **neo linkDebug**: 外链调试模式，在平台端页面设计器中调试自定义组件。
 - **neo publish2oss**: 构建并上传到对象存储（可自定义配置对象存储）。
+- **neo publish2neo**: 构建并发布到NeoCRM平台（需自行添加授权配置）。
 
 ## 开发须知
 #### 1）默认自动识别自定义组件
@@ -128,17 +129,50 @@ neo linkDebug
 ##### 3. 页面设计器开启 debug 模式后，左侧会展示 外部链接 管理面板
 将第 1 步生成的「外链脚本地址」添加进来，即可在此页面设计器 / 组件物料面板中看到对应自定义组件。
 
-#### 6）发布自定义组件
-执行 `neo publish2oss` 即可构建对应自定义组件，并自动将构建后资源上传到对象存储（OSS）中。  
+#### 6）发布自定义组件至 NeoCRM
+执行 `neo publish2neo` 即可构建并发布自定义组件至 NeoCRM 平台，其构建后资源也会上传到 NeoCRM 平台端提供的 CDN 中。  
 
 ##### 发布前请确保
 - **package.json 的 name 唯一**
 - **version 不重复**
-- 已按需配置对象存储参数（支持自定义）
+
+##### 需自行添加授权配置
+```javascript
+module.exports = {
+  publishCmp: {
+    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 授权配置
+    authorization: {
+      /**
+       * 客户端 ID 和 客户端秘钥 需通过 创建连接器 获取，
+       * 详细见：https://doc.xiaoshouyi.com / 创建连接器。
+       */
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      /**
+       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+       * 如何获取 安全令牌请见：https://doc.xiaoshouyi.com / OAuth安全认证 / 密码模式 / 获取令牌。
+       */
+      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
+    },
+  },
+}
+```
 
 ##### 支持发布指定自定义组件
 执行 `neo publish2oss --cmpType=xxCmp`
 
+#### 7）发布自定义组件至CDN
+执行 `neo publish2oss` 即可构建对应自定义组件，并自动将构建后资源上传到对象存储（OSS）中。  
+
+##### 发布前请确保
+- **package.json 的 name 唯一**
+- **version 不重复**
+- 可按需配置对象存储参数（支持自定义），默认使用内置对象存储配置。
+
 ##### 支持自定义对象存储配置
 ```javascript
 module.exports = {
@@ -159,6 +193,9 @@ module.exports = {
 }
 ```
 
+##### 支持发布指定自定义组件
+执行 `neo publish2oss --cmpType=xxCmp`
+
 ## 项目工程配置说明（neo.config.js）
 neo-cmp-cli 默认提供完整配置； 
 如需自定义，使用 `neo config init` 生成 `neo.config.js` 并按需修改。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo-cmp-cli",
-  "version": "1.5.0-beta.3",
+  "version": "1.5.0-beta.5",
   "description": "前端脚手架：自定义组件开发工具，支持react 和 vue2.0技术栈。",
   "keywords": [
     "neo-cli",

package/src/cmpUtils/getCmpTypeByDir.js

@@ -0,0 +1,41 @@
+const fs = require('fs');
+const path = require('path');
+const { resolveToCurrentRoot } = require('../utils/pathUtils');
+/**
+ * 根据当前组件目录，获取所有组件类型
+ * @param {*} componentsBaseDir 自定义组件目录
+ * @returns 组件类型列表
+ */
+const getCmpTypeByDir = (componentsBaseDir = './src/components') => {
+  const componentsDir = resolveToCurrentRoot(componentsBaseDir);
+  if (!fs.existsSync(componentsDir)) {
+    console.error(`未找到自定义组件目录，请检查 ${componentsDir} 目录是否存在。`);
+    // 退出进程
+    process.exit(1);
+  }
+
+  try {
+    // 读取组件目录下的所有子目录
+    const dirs = fs.readdirSync(componentsDir);
+    const cmpTypes = [];
+
+    // 遍历所有目录，过滤出有效的组件类型
+    dirs.forEach((dir) => {
+      const dirPath = path.join(componentsDir, dir);
+      const stat = fs.statSync(dirPath);
+      
+      // 只处理目录，过滤掉隐藏目录和 node_modules
+      if (stat.isDirectory() && !dir.startsWith('.') && dir !== 'node_modules') {
+        cmpTypes.push(dir);
+      }
+    });
+
+    return cmpTypes;
+  } catch (error) {
+    console.error('获取组件类型失败（getCmpTypeByDir）:', error);
+    // 退出进程
+    process.exit(1);
+  }
+};
+
+module.exports = getCmpTypeByDir;

package/src/cmpUtils/publishCmp.js

@@ -99,8 +99,6 @@ const buildComponentData = async (assetsRoot, cmpInfo) => {
   }
   const widgetName = _.camelCase(cmpType);
   const modelFile = path.join(assetsRoot, `${widgetName}Model.js`);
-  
-  let CatchCustomCmpModelClass = null;
 
   // 为 Node.js 环境设置全局 window 对象（模型文件可能需要）
   // 使用 globalThis 以确保在 Node.js 和浏览器环境中都能工作
@@ -109,6 +107,7 @@ const buildComponentData = async (assetsRoot, cmpInfo) => {
     globalThis.window = {
       console: console,
       neoRequire: () => {},
+      postMessage: () => {},
       // 可以添加其他常用的 window 属性
     };
   }
@@ -124,35 +123,38 @@ const buildComponentData = async (assetsRoot, cmpInfo) => {
       console.error(`未找到自定义组件模型文件，请检查以下路径是否存在：`, modelFile);
       return null;
     }
-
-    if (!CatchCustomCmpModelClass || typeof CatchCustomCmpModelClass !== 'function') {
+    if (!window.NEOEditorCustomModels) {
       console.error(`模型文件未导出有效模型方法（CatchCustomCmpModelClass），模型文件地址： ${modelFile} `);
       return null;
     }
 
-    // 先获取对应的模型类
-    const ModelClass = new CatchCustomCmpModelClass(cmpType);
+    const ModelClass = window.NEOEditorCustomModels[cmpType];
+    if (!ModelClass) {
+      console.error(`未找到自定义组件模型类（${cmpType}），模型文件地址： ${modelFile} `);
+      return null;
+    }
     // 实例化模型类
     const modelInstance = new ModelClass();
 
     if (!modelInstance) {
-      console.error(`模型文件未导出有效模型实例（${cmpType}），模型文件地址： ${modelFile} `);
+      console.error(`未找到自定义组件模型信息（${cmpType}），模型文件地址： ${modelFile} `);
       return null;
     }
 
     // 构建组件数据，合并模型实例的信息
     const curCmpInfo = {
       ...cmpInfo,
+      plugin: cmpInfo.modelAsset,
       version: currentPackageJson.version || '1.0.0',
       framework: currentPackageJson.framework ? getFramework(currentPackageJson.framework) : '0', // 0: React, 1: vue2, 2: jQuery, 3: vue3
       // 从模型实例中提取并设置组件信息
       label: modelInstance.label || cmpType,
       description: modelInstance.description || '',
-      componentCategory: modelInstance.tags || [],
+      componentCategory: (modelInstance.tags || []).join(','),
       icon: modelInstance.iconSrc,
-      defaultProps: modelInstance.defaultComProps || {},
-      previewProps: modelInstance.previewComProps || {},
-      propsSchema: modelInstance.propsSchema || [],
+      defaultProps: JSON.stringify(modelInstance.defaultComProps || {}),
+      previewProps: JSON.stringify(modelInstance.previewComProps || {}),
+      propsSchema: JSON.stringify(modelInstance.propsSchema || []),
       events: modelInstance.events || [],
       actions: modelInstance.actions || [],
       // 如果模型实例中有其他属性，也可以添加
@@ -161,7 +163,7 @@ const buildComponentData = async (assetsRoot, cmpInfo) => {
       enableDuplicate: modelInstance.enableDuplicate !== undefined ? modelInstance.enableDuplicate : true
     };
 
-    console.log('自定义组件模型信息（${cmpType}）:', curCmpInfo);
+    console.log(`自定义组件模型信息（${cmpType}）:`, curCmpInfo);
     return curCmpInfo;
   } catch (error) {
     console.error(`自定义组件模型文件解析失败 (${modelFile || '未知路径'}):`, error.message);

package/src/module/index.js

@@ -9,6 +9,7 @@ const inspect = require('./inspect.js'); // 输出当前项目配置文件
 const neoConfigInit = require('../utils/neoConfigInit.js');
 const { validateProjectName } = require('../utils/projectNameValidator.js');
 const mainAction = require('./main.js'); // 入口文件
+const getCmpTypeByDir = require('../cmpUtils/getCmpTypeByDir.js');
 
 // neo 的 package 文件
 const neoPackage = require('../../package.json');
@@ -168,16 +169,26 @@ yargs
       if (argv.cmpType) {
         mainAction.previewCmp(argv.cmpType);
       } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (!cmpTypes.lenth || cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
         const questions = [
           {
             name: 'cmpType',
-            type: 'input',
-            message: '请输入要预览的自定义组件名称:',
+            type: 'list',
+            message: '请选择要预览的自定义组件:',
+            choices: cmpTypeChoices
           }
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            console.error('未选择要预览的自定义组件。');
             process.exit(1);
           }
           mainAction.previewCmp(ans.cmpType);
@@ -251,7 +262,34 @@ yargs
         .alias('h', 'help');
     },
     (argv) => {
-      mainAction.publish2oss(argv.cmpType); // 构建并发布脚本到oss
+      if (argv.cmpType) {
+        mainAction.publish2oss(argv.cmpType); // 构建并发布脚本到oss
+      } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (!cmpTypes.lenth || cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
+        const questions = [
+          {
+            name: 'cmpType',
+            type: 'list',
+            message: '请选择要发布的自定义组件:',
+            choices: cmpTypeChoices
+          }
+        ];
+        inquirer.prompt(questions).then((ans) => {
+          if (!ans.cmpType) {
+            console.error('未选择要发布的自定义组件。');
+            process.exit(1);
+          }
+          mainAction.publish2oss(ans.cmpType);
+        });
+      }
     }
   )
   .command(
@@ -271,16 +309,26 @@ yargs
       if (argv.cmpType) {
         mainAction.publishCmp(argv.cmpType); // 构建并发布组件到 NeoCRM
       } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (!cmpTypes.lenth || cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
         const questions = [
           {
             name: 'cmpType',
-            type: 'input',
-            message: '请输入要发布的自定义组件名称:'
+            type: 'list',
+            message: '请选择要发布的自定义组件:',
+            choices: cmpTypeChoices
           }
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            console.error('未选择要发布的自定义组件。');
             process.exit(1);
           }
           mainAction.publishCmp(ans.cmpType);

package/src/neo/neoService.js

@@ -123,7 +123,7 @@ class NeoService {
       const { access_token, expires_in } = response.data || {};
 
       if (!access_token) {
-        console.error('获取 token 失败：响应中未包含 access_token', response.data);
+        console.error('\n获取 token 失败：响应中未包含 access_token', response.data);
         process.exit(1);
       }
 
@@ -135,7 +135,7 @@ class NeoService {
       };
       return access_token;
     } catch (error) {
-      console.error('获取 token 失败:', error.message);
+      console.error('\n获取 token 失败:', error.message);
       console.error('\ntoken 授权地址:', tokenUrl);
       console.error('\ntoken 请求参数:', formData);
       if (error.response) {
@@ -296,11 +296,11 @@ class NeoService {
       } else if (resultData && typeof resultData === 'object' && resultData.url) {
         fileUrl = resultData.url;
       }
-      console.info(`文件上传成功: ${fileName} -> ${fileUrl}`);
+      console.info(`\n文件上传成功: ${fileName} -> ${fileUrl}`);
       return fileUrl;
     } catch (error) {
-      console.error(`上传文件失败: ${error.message}`);
-      console.error(`文件路径: ${filePath}`);
+      console.error(`\n上传文件失败: ${error.message}，`);
+      console.error(`文件路径: ${filePath}。\n`);
       
       // 输出详细的错误信息
       if (error.response) {
@@ -412,7 +412,6 @@ class NeoService {
 
     try {
       const fullUpdateAPI = this.saveAPI();
-      console.info('更新组件 API 地址:', fullUpdateAPI);
       const response = await axios.post(fullUpdateAPI, componentData, {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -420,17 +419,19 @@ class NeoService {
           'Content-Type': 'application/json'
         }
       });
+      const {code, message} = response.data || {};
 
-      if (response.data && response.data.code && response.data.code !== 200) {
+      if (code && code !== 200) {
         throw new Error(`更新组件失败: ${response.data.message || '未知错误'}`);
       }
+      
 
-      console.info('组件更新成功:', response.data);
-      return response.data;
+      console.info(message ? `组件更新成功: ${message}。` : '组件更新成功。');
     } catch (error) {
-      console.error('更新组件失败:', error.message);
-      if (error.response) {
-        console.error('响应数据:', error.response.data);
+      if (error.message) {
+        console.error('更新组件失败:', error.message);
+      } else {
+        console.error('响应数据:', error);
       }
       process.exit(1);
     }

package/src/plugins/AddNeoRequirePlugin.js

@@ -1,4 +1,6 @@
 const { ConcatSource } = require('webpack-sources');
+const fs = require('fs');
+const path = require('path');
 /**
  * 注入 neoRequire 函数
  * 备注：用于实现和 Neo 平台共享依赖
@@ -162,9 +164,9 @@ class AddNeoRequirePlugin {
 })(function(require) {
                 `;
 
-    const NeoUMDContent = fs.readFileSync(path.join(__dirname, '../neo/NeoUMDContent.js'), 'utf8');
-
-    const Footer = `}); \n${NeoUMDContent}`;
+    // const NeoUMDContent = fs.readFileSync(path.join(__dirname, '../neo/NeoUMDContent.js'), 'utf8');
+    // const Footer = `}); \n${NeoUMDContent}`;
+    const Footer = `});`;
 
     // 创建新的资源
     const newSource = new ConcatSource(Header, content, Footer);

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

@@ -127,7 +127,6 @@ module.exports = {
     */
   },
   publishCmp: {
-    libraryName: 'NeoCustomCmpModel', // 构建第三方功能包时最后导出的引用变量名
     // 用于构建并发布至 NeoCRM 的相关配置
     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）

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

@@ -53,7 +53,7 @@
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
     "@types/axios": "^0.14.0",
-    "neo-cmp-cli": "^1.5.0-beta.2",
+    "neo-cmp-cli": "^1.5.0-beta.3",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/neo-custom-cmp-template/src/components/entity-detail/index.tsx

@@ -278,8 +278,14 @@ export default class EntityDetail extends React.PureComponent<
 
     return (
       <div className="entity-detail-container">
-        <img src="https://custom-widget2.oss-cn-beijing.aliyuncs.com/img.png" alt="logo" />
-        <img src="https://publicfront-1253467224.cos.ap-beijing.myqcloud.com/customComponent/crm-cd/tenant/3392331536784858/1761882606360/img.png" alt="logo" />
+        <img
+          src="https://custom-widget2.oss-cn-beijing.aliyuncs.com/img.png"
+          alt="logo"
+        />
+        <img
+          src="https://publicfront-1253467224.cos.ap-beijing.myqcloud.com/customComponent/crm-cd/tenant/3392331536784858/1761882606360/img.png"
+          alt="logo"
+        />
         {showTitle && (
           <div className="detail-header">
             <div className="header-content">