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

package/src/template/react-ts-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: 自定义组件的内容文件；
+- src/components/xxCmp/model: 自定义组件的模型文件，用于对接页面设计器；
 - 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)

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

@@ -110,8 +110,8 @@ module.exports = {
        * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
-      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    }
+      password: 'xx xx', // 用户账户密码 + 8 位安全令牌
+    },
   },
   pushCmp: {
     // 用于构建并发布至 NeoCRM 的相关配置

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

@@ -2,8 +2,8 @@
 - src: 自定义组件源码；
 - src/assets: 存放组件静态资源，比如 css、img等；
 - src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
-- src/components/info-card/index.vue: 自定义组件的内容文件；
-- src/components/info-card/model.js: 自定义组件的模型文件，用于对接页面设计器；
+- src/components/xxCmp/index: 自定义组件的内容文件；
+- src/components/xxCmp/model: 自定义组件的模型文件，用于对接页面设计器；
 - 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)

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

@@ -118,8 +118,8 @@ module.exports = {
        * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
-      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    }
+      password: 'xx xx', // 用户账户密码 + 8 位安全令牌
+    },
   },
   pushCmp: {
     // 用于构建并发布至 NeoCRM 的相关配置

package/src/{cmpUtils → utils/cmpUtils}/createCmpByTemplate.js

@@ -1,8 +1,8 @@
 const fs = require('fs-extra');
 const path = require('path');
 const _ = require('lodash');
-const { consoleTag } = require('../utils/neoParams'); // 输出标记
-const replaceInFilesByMap = require('../utils/replaceInFilesByMap');
+const { consoleTag } = require('../neoParams'); // 输出标记
+const replaceInFilesByMap = require('../replaceInFilesByMap');
 const hasCmpTypeByDir = require('./hasCmpTypeByDir');
 const hasNeoProject = require('../projectUtils/hasNeoProject');
 
@@ -14,7 +14,7 @@ const curCmpTemplate = {
     modelName: 'CmpModel',
     cmpClassName: 'custom-cmp-container',
     cmpType: 'xx-custom-cmp',
-    cmpLabel: 'xx组件',
+    cmpLabel: 'xx组件'
   },
   dir: path.resolve(__dirname, '../template/empty-cmp')
 };
@@ -29,7 +29,9 @@ module.exports = function (cmpName, componentBaseDir = './src/components') {
   const finalCmpPath = path.resolve(process.cwd(), componentBaseDir, finalCmpName);
 
   if (!hasNeoProject()) {
-    console.error(`${consoleTag}当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo createProject）。`);
+    console.error(
+      `${consoleTag}当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo createProject）。`
+    );
     process.exit(1);
   }
 
@@ -49,7 +51,7 @@ module.exports = function (cmpName, componentBaseDir = './src/components') {
         [curCmpTemplate.widgetInfo.cmpName]: curCmpName,
         [curCmpTemplate.widgetInfo.cmpClassName]: `${cmpType}-container`,
         [curCmpTemplate.widgetInfo.cmpType]: cmpType,
-        [curCmpTemplate.widgetInfo.cmpLabel]: `${cmpType}组件`,
+        [curCmpTemplate.widgetInfo.cmpLabel]: `${cmpType}组件`
       });
 
       console.log(`${consoleTag}已创建自定义组件（${finalCmpName}）!`);

package/src/{cmpUtils → utils/cmpUtils}/createCmpByZip.js

@@ -3,7 +3,7 @@ const path = require('path');
 const axios = require('axios');
 const ora = require('ora');
 const AdmZip = require('adm-zip');
-const { consoleTag } = require('../utils/neoParams'); // 输出标记
+const { consoleTag } = require('../neoParams'); // 输出标记
 const hasCmpTypeByDir = require('./hasCmpTypeByDir');
 const hasNeoProject = require('../projectUtils/hasNeoProject');
 
@@ -78,7 +78,10 @@ module.exports = async function (cmpZipUrl, cmpName, componentBaseDir = './src/c
 
     return true;
   } catch (error) {
-    spinner.stopAndFail(`${consoleTag}从 zip 包创建自定义组件失败（${finalCmpName}）：`, error.message);
+    spinner.stopAndFail(
+      `${consoleTag}从 zip 包创建自定义组件失败（${finalCmpName}）：`,
+      error.message
+    );
     // 清理临时目录
     await fs.remove(tempDir);
 

package/src/{cmpUtils → utils/cmpUtils}/createCommonModulesCode.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 const { isPlainObject } = require('lodash');
 
 /**
@@ -9,7 +9,7 @@ const { isPlainObject } = require('lodash');
  * @returns 组件预览代码
  */
 const createCommonModulesCode = (neoCommonModule, cmpTypes) => {
-  const {neoExports, remoteDeps} = neoCommonModule;
+  const { neoExports, remoteDeps } = neoCommonModule;
 
   if (!neoExports && !remoteDeps) {
     return '';

package/src/{cmpUtils → utils/cmpUtils}/getCmpModelRegisterCode.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 
 /**
  * 获取组件注册文件内容

package/src/{cmpUtils → utils/cmpUtils}/getCmpPreviewCode.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 
 /**
  * 获取组件预览代码

package/src/{cmpUtils → utils/cmpUtils}/getCmpRegisterCode.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 
 /**
  * 获取组件注册文件内容

package/src/{cmpUtils → utils/cmpUtils}/getCmpTypeByDir.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const path = require('path');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 /**
  * 根据当前组件目录，获取所有组件类型
  * @param {*} componentsBaseDir 自定义组件目录
@@ -23,7 +23,7 @@ const getCmpTypeByDir = (componentsBaseDir = './src/components') => {
     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);

package/src/{cmpUtils → utils/cmpUtils}/hasCmpTypeByDir.js

@@ -8,4 +8,4 @@ const getCmpTypeByDir = require('./getCmpTypeByDir');
 module.exports = (cmpType) => {
   const cmpTypes = getCmpTypeByDir();
   return cmpTypes.includes(cmpType);
-};;
+};

package/src/{cmpUtils → utils/cmpUtils}/previewCmp.js

@@ -1,8 +1,8 @@
 const fs = require('fs');
 const akfun = require('akfun');
-const { consoleTag } = require('../utils/neoParams'); // 输出标记
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
-const getCmpPreviewCode = require('../cmpUtils/getCmpPreviewCode'); // 获取自定义组件预览代码
+const { consoleTag } = require('../neoParams'); // 输出标记
+const { resolveToCurrentRoot } = require('../pathUtils');
+const getCmpPreviewCode = require('./getCmpPreviewCode'); // 获取自定义组件预览代码
 
 /**
  * 用于预览指定自定义组件的脚本

package/src/{cmpUtils → utils/cmpUtils}/pullCmp.js

@@ -1,11 +1,11 @@
 const _ = require('lodash');
-const { catchCurPackageJson } = require('../utils/pathUtils');
-const getConfigObj = require('../utils/getConfigObj');
+const { catchCurPackageJson } = require('../pathUtils');
+const getConfigObj = require('../getConfigObj');
 const ora = require('ora');
 const NeoService = require('../neo/neoService');
-const { getFramework } = require('../utils/common');
-const getCmpTypeByDir = require('../cmpUtils/getCmpTypeByDir.js');
-const createCmpByZip = require('../cmpUtils/createCmpByZip.js');
+const { getFramework } = require('../common');
+const getCmpTypeByDir = require('../getCmpTypeByDir.js');
+const createCmpByZip = require('../createCmpByZip.js');
 
 // 获取当前项目的package文件
 const currentPackageJsonDir = catchCurPackageJson();
@@ -18,7 +18,6 @@ const framework = getFramework(currentPackageJson.framework);
  * @param {object} authConfig 授权配置
  */
 const pullCmp = async (cmpType, authConfig, _neoService) => {
-
   if (!authConfig) {
     console.error('未找到 NeoCRM 平台授权配置（neo.config.js / authConfig）。');
     return;
@@ -34,7 +33,8 @@ const pullCmp = async (cmpType, authConfig, _neoService) => {
 
   try {
     let neoService = _neoService;
-    let cmpList = [], cmpInfoMap = {};
+    let cmpList = [],
+      cmpInfoMap = {};
     let cmpInfo = null;
 
     if (_neoService) {
@@ -44,7 +44,7 @@ const pullCmp = async (cmpType, authConfig, _neoService) => {
     } else {
       // 创建新的 neoService 实例
       neoService = new NeoService(authConfig);
-      
+
       // 获取自定义组件列表
       spinner.text('正在获取自定义组件列表...');
       cmpList = await neoService.getCustomCmpList();
@@ -78,7 +78,7 @@ const pullCmp = async (cmpType, authConfig, _neoService) => {
 
     // 下载源码文件并解析到 src/components 目录下
     const codeLib = cmpInfo.codeLib; // 源码文件地址（zip包地址）
-    
+
     // 将zip 包里面的自定义组件源码解析到 src/components 目录下
     const cmpResult = await createCmpByZip(codeLib, cmpType, './src/components');
     if (!cmpResult) {

package/src/{cmpUtils → utils/cmpUtils}/pushCmp.js

@@ -1,11 +1,11 @@
 const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
-const { catchCurPackageJson } = require('../utils/pathUtils');
-const getConfigObj = require('../utils/getConfigObj');
+const { catchCurPackageJson } = require('../pathUtils');
+const getConfigObj = require('../getConfigObj');
 const ora = require('ora');
 const NeoService = require('../neo/neoService');
-const { getFramework } = require('../utils/common');
+const { getFramework } = require('../common');
 const createCmpProjectZip = require('../projectUtils/createCmpProjectZip');
 
 // 获取当前项目的package文件
@@ -56,14 +56,14 @@ const buildComponentData = async (assetsRoot, cmpInfo) => {
       console.error(`未找到自定义组件模型文件，请检查以下路径是否存在：`, modelFile);
       return null;
     }
-    if (!window.NEOEditorCustomModels) {
+    if (!globalThis.window || !globalThis.window.NEOEditorCustomModels) {
       console.error(
         `模型文件未导出有效模型方法（CatchCustomCmpModelClass），模型文件地址： ${modelFile} `
       );
       return null;
     }
 
-    const ModelClass = window.NEOEditorCustomModels[cmpType];
+    const ModelClass = globalThis.window.NEOEditorCustomModels[cmpType];
     if (!ModelClass) {
       console.error(`未找到自定义组件模型类（${cmpType}），模型文件地址： ${modelFile} `);
       return null;
@@ -135,6 +135,8 @@ const pushCmp = async (config, cmpType) => {
   try {
     // 步骤 1: 初始化 NeoService
     let neoService = new NeoService(config);
+    // 获取 token
+    await neoService.ensureValidToken();
 
     // 步骤 2: 打包源码文件（打包单个自定义组件源码）
     spinner.start(`[1/4] 打包源码文件（含单个自定义组件源码）...`);

package/src/utils/generateEntries.js

@@ -0,0 +1,73 @@
+const getEntries = require('./projectUtils/getEntries');
+const getEntriesWithAutoRegister = require('./projectUtils/getEntriesWithAutoRegister');
+
+/**
+ * 生成 entry 配置
+ * @param {object} options 配置选项
+ * @param {object} options.configEntry 当前配置中的 entry（如果已存在则直接返回）
+ * @param {boolean} options.disableAutoRegister 是否禁用自动注册
+ * @param {string} options.componentsDir 组件目录路径
+ * @param {string} options.entryType entry 类型：'widget' | 'linkDebug'，默认为 'widget'
+ * @param {string} [options.cmpType] 可选的组件类型，如果指定则只生成该组件的 entry
+ * @param {boolean} [options.forceGetCmpTypes] 即使 entry 已存在，也强制获取 cmpTypes，默认为 false
+ * @returns {object} { entries: object, cmpTypes: array } 如果 configEntry 已存在且 forceGetCmpTypes 为 false，则返回 { entries: configEntry, cmpTypes: [] }
+ */
+function generateEntries({
+  configEntry,
+  disableAutoRegister,
+  componentsDir,
+  entryType = 'widget',
+  cmpType,
+  forceGetCmpTypes = false
+}) {
+  // 如果已配置 entry 且不需要强制获取 cmpTypes，直接返回
+  if (configEntry && Object.keys(configEntry).length > 0 && !forceGetCmpTypes) {
+    return {
+      entries: configEntry,
+      cmpTypes: []
+    };
+  }
+
+  // 根据 disableAutoRegister 选择不同的生成方法
+  let entriesResult;
+  if (disableAutoRegister) {
+    // disableAutoRegister 为 true 时，仅自动生成入口文件（不自动注册）
+    entriesResult = getEntries(componentsDir, cmpType);
+  } else {
+    // 自动生成入口文件（并自动创建对应的注册文件）
+    entriesResult = getEntriesWithAutoRegister(componentsDir, cmpType);
+  }
+
+  // 根据 entryType 选择对应的 entries
+  let entries;
+  if (entryType === 'linkDebug') {
+    entries = entriesResult.linkDebugEntries || {};
+  } else {
+    entries = entriesResult.widgetEntries || {};
+  }
+
+  const cmpTypes = entriesResult.cmpTypes || [];
+
+  // 如果 entry 已存在但需要获取 cmpTypes，使用已存在的 entry
+  if (configEntry && Object.keys(configEntry).length > 0 && forceGetCmpTypes) {
+    entries = configEntry;
+  }
+
+  // 验证 entries 是否有效（仅在需要生成新 entry 时验证）
+  if (
+    (!configEntry || Object.keys(configEntry).length === 0) &&
+    (!entries || Object.keys(entries).length === 0)
+  ) {
+    const defaultComponentsDir = componentsDir || './src/components';
+    throw new Error(
+      `未识别到自定义组件，请检查 ${defaultComponentsDir} 目录下是否存在自定义组件。`
+    );
+  }
+
+  return {
+    entries: entries || configEntry || {},
+    cmpTypes
+  };
+}
+
+module.exports = generateEntries;

package/src/{projectUtils → utils/projectUtils}/createCmpProjectByTemplate.js

@@ -1,9 +1,9 @@
 const fs = require('fs-extra');
 const path = require('path');
-const { consoleTag } = require('../utils/neoParams'); // 输出标记
-const { replaceInPackage } = require('../utils/replaceInPackage');
-const { resetPackageVersion } = require('../utils/resetPackageVersion');
-const autoEntryRootDir = require('../utils/autoEntryRootDir');
+const { consoleTag } = require('../neoParams'); // 输出标记
+const { replaceInPackage } = require('../replaceInPackage');
+const { resetPackageVersion } = require('../resetPackageVersion');
+const autoEntryRootDir = require('../autoEntryRootDir');
 const hasNeoProject = require('./hasNeoProject');
 
 const cmpTemplateList = {
@@ -22,12 +22,16 @@ module.exports = function (projectName, type = 'react-ts') {
   const finalProjectPath = path.resolve(process.cwd(), projectName);
 
   if (hasNeoProject()) {
-    console.error(`${consoleTag}创建自定义组件项目失败，当前目录（${process.cwd()}）已经是一个自定义组件项目，请勿重复创建。`);
+    console.error(
+      `${consoleTag}创建自定义组件项目失败，当前目录（${process.cwd()}）已经是一个自定义组件项目，请勿重复创建。`
+    );
     process.exit(1);
   }
 
   if (fs.existsSync(finalProjectPath)) {
-    console.error(`${consoleTag}创建自定义组件项目失败，当前已存在（${projectName}）项目，请勿创建重名项目。`);
+    console.error(
+      `${consoleTag}创建自定义组件项目失败，当前已存在（${projectName}）项目，请勿创建重名项目。`
+    );
     process.exit(1);
   }
 

package/src/{projectUtils → utils/projectUtils}/createCmpProjectZip.js

@@ -2,7 +2,7 @@ const fs = require('fs-extra');
 const path = require('path');
 const AdmZip = require('adm-zip');
 const _ = require('lodash');
-const { consoleTag } = require('../utils/neoParams'); // 输出标记
+const { consoleTag } = require('../neoParams'); // 输出标记
 const hasNeoProject = require('./hasNeoProject');
 
 /**
@@ -116,7 +116,5 @@ module.exports = function (cmpType, _projectPath, assetsRoot) {
   // 写入 zip 文件
   zip.writeZip(zipPath);
 
-  console.log(`${consoleTag}已创建自定义组件源码 zip 包: ${zipFileName}`);
-
   return zipPath;
 };

package/src/{projectUtils → utils/projectUtils}/getEntries.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 
 /**
  * 从指定目录获取组件入口文件
@@ -70,6 +70,6 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
   return {
     widgetEntries,
     linkDebugEntries,
-    cmpTypes,
+    cmpTypes
   };
 };

package/src/{projectUtils → utils/projectUtils}/getEntriesWithAutoRegister.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 const getCmpRegisterCode = require('../cmpUtils/getCmpRegisterCode');
 const getCmpModelRegisterCode = require('../cmpUtils/getCmpModelRegisterCode');
 /**
@@ -100,6 +100,6 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
   return {
     widgetEntries,
     linkDebugEntries,
-    cmpTypes,
+    cmpTypes
   };
 };

package/src/{projectUtils → utils/projectUtils}/updatePublishLog.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const _ = require('lodash');
-const { resolveToCurrentRoot } = require('../utils/pathUtils');
+const { resolveToCurrentRoot } = require('../pathUtils');
 /**
  * 更新发布日志
  */