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

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技术栈",
@@ -47,7 +48,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/template/empty-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/empty-custom-cmp-template/package.json

@@ -2,6 +2,7 @@
   "name": "empty-custom-cmp-template",
   "version": "1.0.0",
   "description": "neo 自定义组件",
+  "framework": "react-ts",
   "keywords": [
     "react&ts 技术栈",
     "neo 自定义组件"
@@ -45,7 +46,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

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

@@ -7,10 +7,10 @@ function resolve(dir) {
   return path.resolve(__dirname, dir);
 }
 
-let authConfig = {}; // NeoCRM 授权配置
+let auth = {}; // NeoCRM 授权配置
 if (fs.existsSync('./auth.config.js')) {
   // 加载 NeoCRM 授权配置
-  authConfig = require('./auth.config');
+  auth = require('./auth.config');
 }
 
 // 包括生产和开发的环境配置信息
@@ -105,21 +105,24 @@ 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: {
-      client_id: authConfig.client_id || 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
-      client_secret: authConfig.client_secret || 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
-      username: authConfig.username || 'xx', // 用户在销售易系统中的用户名
+    auth: {
+      client_id: auth.client_id || 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: auth.client_secret || 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: auth.username || 'xx', // 用户在销售易系统中的用户名
       /**
        * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
-      password: authConfig.password || 'xx xx' // 用户账户密码 + 8 位安全令牌
+      password: auth.password || 'xx xx' // 用户账户密码 + 8 位安全令牌
     },
+  },
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',

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

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

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

@@ -0,0 +1,166 @@
+const fs = require('fs');
+const path = require('path');
+const _ = require('lodash');
+const { catchCurPackageJson } = require('../utils/pathUtils');
+const getConfigObj = require('../utils/getConfigObj');
+const ora = require('ora');
+const NeoService = require('../neo/neoService');
+const { getFramework } = require('../utils/common');
+const createCmpProjectZip = require('../projectUtils/createCmpProjectZip');
+
+// 获取当前项目的package文件
+const currentPackageJsonDir = catchCurPackageJson();
+const currentPackageJson = getConfigObj(currentPackageJsonDir);
+
+/**
+ * 构建组件数据映射
+ * @param {string} assetsRoot 构建产物的目录
+ * @param {object} cmpInfo 自定义组件信息
+ * @returns {Promise<object|null>} 自定义组件数据（含自定义组件模型信息）
+ */
+const buildComponentData = async (assetsRoot, cmpInfo) => {
+  if (!cmpInfo || !cmpInfo.cmpType) {
+    console.error('自定义组件信息或组件名称不能为空');
+    return null;
+  }
+
+  const { cmpType } = cmpInfo;
+
+  if (!assetsRoot || !fs.existsSync(assetsRoot)) {
+    console.error(`未找到自定义组件目录: ${assetsRoot}`);
+    return null;
+  }
+  const widgetName = _.camelCase(cmpType);
+  const modelFile = path.join(assetsRoot, `${widgetName}Model.js`);
+
+  // 为 Node.js 环境设置全局 window 对象（模型文件可能需要）
+  // 使用 globalThis 以确保在 Node.js 和浏览器环境中都能工作
+  const originalWindow = globalThis.window;
+  if (!globalThis.window) {
+    globalThis.window = {
+      console: console,
+      neoRequire: () => {},
+      postMessage: () => {}
+      // 可以添加其他常用的 window 属性
+    };
+  }
+
+  try {
+    // 加载自定义组件模型资源文件
+    if (fs.existsSync(modelFile)) {
+      // 加载自定义组件模型资源文件
+      let modelModule = require(modelFile);
+      // 获取导出的模型类（可能是 default 导出或命名导出）
+      // const CatchCustomCmpModelClass = modelModule.default || modelModule;
+    } else {
+      console.error(`未找到自定义组件模型文件，请检查以下路径是否存在：`, modelFile);
+      return null;
+    }
+    if (!window.NEOEditorCustomModels) {
+      console.error(
+        `模型文件未导出有效模型方法（CatchCustomCmpModelClass），模型文件地址： ${modelFile} `
+      );
+      return null;
+    }
+
+    const ModelClass = window.NEOEditorCustomModels[cmpType];
+    if (!ModelClass) {
+      console.error(`未找到自定义组件模型类（${cmpType}），模型文件地址： ${modelFile} `);
+      return null;
+    }
+    // 实例化模型类
+    const modelInstance = new ModelClass();
+
+    if (!modelInstance) {
+      console.error(`未找到自定义组件模型信息（${cmpType}），模型文件地址： ${modelFile} `);
+      return null;
+    }
+
+    // 构建组件数据，合并模型实例的信息
+    const curCmpInfo = {
+      ...cmpInfo,
+      plugin: cmpInfo.modelAsset,
+      version: currentPackageJson.version || '1.0.0',
+      // 技术栈标识: 从 package.json / framework 字段获取，没有则默认 为 react ts 技术栈
+      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 || []).join(','),
+      icon: modelInstance.iconSrc,
+      defaultProps: JSON.stringify(modelInstance.defaultComProps || {}),
+      previewProps: JSON.stringify(modelInstance.previewComProps || {}),
+      propsSchema: JSON.stringify(modelInstance.propsSchema || []),
+      events: modelInstance.events || [],
+      actions: modelInstance.actions || [],
+      // 如果模型实例中有其他属性，也可以添加
+      exposedToDesigner:
+        modelInstance.exposedToDesigner !== undefined ? modelInstance.exposedToDesigner : true,
+      namespace: modelInstance.namespace || 'neo-cmp-cli',
+      enableDuplicate:
+        modelInstance.enableDuplicate !== undefined ? modelInstance.enableDuplicate : true
+    };
+
+    console.log(`自定义组件模型信息（${cmpType}）:`, curCmpInfo);
+    return curCmpInfo;
+  } catch (error) {
+    console.error(`自定义组件模型文件解析失败 (${modelFile || '未知路径'}):`, error.message);
+    console.error(error.stack);
+    return null;
+  } finally {
+    // 恢复原始的 window 对象（如果之前存在）
+    if (originalWindow === undefined) {
+      delete globalThis.window;
+    } else {
+      globalThis.window = originalWindow;
+    }
+  }
+};
+
+/**
+ * 发布组件到 NeoCRM
+ * @param {object} config 配置信息
+ * @param {string} assetsRoot 构建产物的目录
+ */
+const pushCmp = async (config, cmpType) => {
+  const { auth: credentials } = config;
+
+  if (!credentials) {
+    console.error('未找到 NeoCRM 平台授权配置（neo.config.js / neoConfig');
+    return;
+  }
+
+  const spinner = ora('正在发布组件...').start();
+
+  try {
+    // 步骤 1: 初始化 NeoService
+    spinner.text = '发布自定义组件：初始化 NeoService...';
+    const neoService = new NeoService(config);
+
+    // 步骤 2: 打包源码文件（打包单个自定义组件源码）
+    spinner.text = '发布自定义组件：打包源码文件（含单个自定义组件源码）...';
+    createCmpProjectZip(cmpType, process.cwd(), config.assetsRoot);
+
+    // 步骤 3: 上传构建后资源文件
+    spinner.text = '发布自定义组件：上传自定义组件构建产物到 OSS...';
+    const cmpInfo = await neoService.publish2oss(cmpType);
+
+    // 步骤 5: 构建组件数据
+    spinner.text = '发布自定义组件：构建组件数据...';
+    const componentInfo = await buildComponentData(config.assetsRoot, cmpInfo);
+    if (!componentInfo) {
+      throw new Error(`构建组件数据失败，未获取到自定义组件模型信息。（${cmpType}）`);
+    }
+
+    // 步骤 6: 保存组件信息
+    spinner.text = '发布自定义组件：保存组件信息...';
+    await neoService.updateCustomComponent(componentInfo);
+
+    spinner.succeed('自定义组件发布成功！\n', componentInfo);
+  } catch (error) {
+    spinner.fail(`自定义组件发布失败: ${error.message}`);
+    throw error;
+  }
+};
+
+module.exports = pushCmp;

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

@@ -96,12 +96,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', // 用户在销售易系统中的用户名
@@ -110,7 +110,10 @@ module.exports = {
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
       password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    },
+    }
+  },
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',

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

@@ -2,6 +2,7 @@
   "name": "react-custom-cmp-template",
   "version": "1.1.0",
   "description": "neo自定义组件模板（react技术栈）",
+  "framework": "react-js",
   "keywords": [
     "自定义组件模板",
     "react技术栈",
@@ -44,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-ts-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/react-ts-custom-cmp-template/package.json

@@ -2,6 +2,7 @@
   "name": "react-ts-custom-cmp-template",
   "version": "1.1.1",
   "description": "neo自定义组件模板（react&ts技术栈）",
+  "framework": "react-ts",
   "keywords": [
     "自定义组件模板",
     "react&ts技术栈",
@@ -46,7 +47,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

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

@@ -105,12 +105,12 @@ module.exports = {
     cssSourceMap: true
     */
   },
-  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', // 用户在销售易系统中的用户名
@@ -119,7 +119,10 @@ module.exports = {
        * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
        */
       password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    },
+    }
+  },
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',

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

@@ -2,6 +2,7 @@
   "name": "vue2-custom-cmp-template",
   "version": "1.0.1",
   "description": "neo自定义组件模板（vue2.0技术栈）",
+  "framework": "vue2.0",
   "keywords": [
     "自定义组件模板",
     "vue2.0技术栈",
@@ -44,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/utils/common.js

@@ -0,0 +1,48 @@
+const { consoleTag } = require('./neoParams');
+/**
+ * 获取技术栈标识
+ * 目的：兼容用户非标准写法
+ * 0: React, 1: vue2, 2: jQuery, 3: vue3
+ */
+function getFramework(_framework) {
+  let defaultFramework = '0'; // 默认 React 技术栈
+  if (!_framework) {
+    return defaultFramework;
+  }
+  let curFramework = _framework.toLowerCase().trim();
+  switch (curFramework) {
+    case 'jquery':
+    case 'jq':
+      curFramework = '2';
+      break;
+    case 'vue2':
+    case 'vue 2':
+    case 'vue2.0':
+    case 'vue 2.0':
+      curFramework = '1';
+      break;
+    case 'vue':
+    case 'vue3':
+    case 'vue 3':
+    case 'vue3.0':
+    case 'vue 3.0':
+      curFramework = '3';
+      console.error(`${consoleTag} 暂不支持 vue3.0 技术栈。`);
+      break;
+    case 'react-js':
+      console.error(`${consoleTag} 暂不支持 react-js 技术栈。`);
+      curFramework = '0';
+      break;
+    case 'react':
+    case 'react-ts':
+      curFramework = '0';
+      break;
+    default:
+      curFramework = '0';
+  }
+  return curFramework;
+}
+
+module.exports = {
+  getFramework
+};