neo-cmp-cli 1.3.10 → 1.5.0-beta.10

package/src/neo/neoService.js

@@ -0,0 +1,525 @@
+const axios = require('axios');
+const FormData = require('form-data');
+const fs = require('fs');
+const path = require('path');
+const _ = require('lodash');
+const updatePublishLog = require('../projectUtils/updatePublishLog');
+
+// 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', // 文件上传接口地址
+  saveAPI: '/rest/metadata/v3.0/ui/customComponents/actions/saveOrUpdateComponent' // 创建或者保存接口地址
+};
+
+/**
+ * Neo 平台服务类
+ * 提供 token 管理、文件上传、组件更新等功能
+ */
+class NeoService {
+  /**
+   * 初始化 Neo 服务
+   * @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 密码
+   */
+  constructor(config = {}) {
+    const { assetsRoot, neoBaseURL, tokenAPI, authConfig } = config;
+    if (!authConfig) {
+      throw new Error('authConfig 不能为空');
+    }
+    if (
+      !authConfig.client_id ||
+      !authConfig.client_secret ||
+      !authConfig.username ||
+      !authConfig.password
+    ) {
+      throw new Error(
+        'authConfig 配置不完整，需要包含 client_id、client_secret、username、password'
+      );
+    }
+
+    this.assetsRoot = assetsRoot;
+    this.neoBaseURL = neoBaseURL || NeoCrmAPI.neoBaseURL;
+    this.tokenAPI = tokenAPI || NeoCrmAPI.tokenAPI;
+    this.authConfig = authConfig;
+
+    // Token 缓存
+    this.tokenCache = {
+      token: null,
+      expiresAt: null
+    };
+  }
+
+  /**
+   * 构建完整的 API URL
+   * @param {string} url 相对或绝对 URL
+   * @returns {string} 完整的 URL
+   */
+  buildFullUrl(url) {
+    if (url.startsWith('http://') || url.startsWith('https://')) {
+      return url;
+    }
+    return `${this.neoBaseURL}${url}`;
+  }
+
+  // 获取文件上传接口地址
+  uploadAPI() {
+    return this.buildFullUrl(NeoCrmAPI.uploadAPI);
+  }
+
+  // 获取组件信息保存接口地址
+  saveAPI() {
+    return this.buildFullUrl(NeoCrmAPI.saveAPI);
+  }
+
+  /**
+   * 检查 token 是否过期
+   * @returns {boolean} true 表示已过期，false 表示未过期
+   */
+  isTokenExpired() {
+    if (!this.tokenCache.token || !this.tokenCache.expiresAt) {
+      return true;
+    }
+    // 提前 60 秒判断为过期，避免边缘情况
+    return Date.now() >= this.tokenCache.expiresAt;
+  }
+
+  /**
+   * 获取 token（含授权信息、租户信息）
+   * @returns {Promise<string>} token
+   */
+  async getToken() {
+    // 检查缓存是否有效
+    if (!this.isTokenExpired()) {
+      console.info('使用缓存的 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);
+
+    const tokenUrl = this.buildFullUrl(this.tokenAPI);
+
+    try {
+      const response = await axios.post(tokenUrl, formData.toString(), {
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded'
+        }
+      });
+
+      const { access_token, expires_in } = response.data || {};
+
+      if (!access_token) {
+        console.error('\n获取 token 失败：响应中未包含 access_token', response.data);
+        process.exit(1);
+      }
+
+      // 缓存 token（提前 60 秒过期，避免边缘情况）
+      const expiresIn = parseInt(expires_in) || 3600; // 默认 1 小时
+      this.tokenCache = {
+        token: access_token,
+        expiresAt: Date.now() + (expiresIn - 60) * 1000
+      };
+      return access_token;
+    } catch (error) {
+      console.error('\n获取 token 失败:', error.message);
+      console.error('\ntoken 授权地址:', tokenUrl);
+      console.error('\ntoken 请求参数:', formData);
+      if (error.response) {
+        console.error('响应数据:', error.response.data);
+      }
+      process.exit(1);
+    }
+  }
+
+  /**
+   * 刷新 token
+   * @returns {Promise<string>} 新的 token
+   */
+  async refreshToken() {
+    // 清除缓存，强制获取新 token
+    this.tokenCache = {
+      token: null,
+      expiresAt: null
+    };
+
+    return await this.getToken();
+  }
+
+  /**
+   * 确保 token 有效，如果过期则自动刷新
+   * @returns {Promise<string>} 有效的 token
+   */
+  async ensureValidToken() {
+    if (!this.tokenCache.token) {
+      return await this.getToken();
+    } else if (this.isTokenExpired()) {
+      console.info('token 已过期，正在刷新...');
+      return await this.refreshToken();
+    }
+    return this.tokenCache.token;
+  }
+
+  /**
+   * 上传文件到 Neo 平台
+   * @param {string} filePath 文件路径
+   * @param {object} options 可选配置
+   * @param {string} options.fieldName 表单字段名，默认为 'customComponentCode'
+   * @param {number} options.maxSize 最大文件大小（字节），默认 50MB
+   * @param {number} options.timeout 超时时间（毫秒），默认 60000
+   * @returns {Promise<string>} CDN 地址或文件 URL
+   */
+  async uploadFile(filePath, options = {}) {
+    // 确保 token 有效
+    const token = await this.ensureValidToken();
+
+    // 验证文件路径
+    if (!filePath || typeof filePath !== 'string') {
+      throw new Error(`文件路径无效: ${filePath}`);
+    }
+
+    // 检查文件是否存在
+    if (!fs.existsSync(filePath)) {
+      throw new Error(`文件不存在: ${filePath}`);
+    }
+
+    // 检查文件状态
+    const fileStat = fs.statSync(filePath);
+    if (!fileStat.isFile()) {
+      throw new Error(`路径不是文件: ${filePath}`);
+    }
+
+    // 检查文件大小
+    const maxSize = options.maxSize || 50 * 1024 * 1024; // 默认 50MB
+    if (fileStat.size > maxSize) {
+      const sizeMB = (fileStat.size / 1024 / 1024).toFixed(2);
+      const maxSizeMB = (maxSize / 1024 / 1024).toFixed(2);
+      throw new Error(`文件大小超过限制: ${sizeMB}MB > ${maxSizeMB}MB`);
+    }
+
+    if (fileStat.size === 0) {
+      throw new Error(`文件为空: ${filePath}`);
+    }
+
+    const fileName = path.basename(filePath);
+    const fileSizeKB = (fileStat.size / 1024).toFixed(2);
+    console.info(`正在上传文件: ${fileName} (${fileSizeKB}KB)...`);
+
+    try {
+      // 创建 FormData
+      const formData = new FormData();
+      const fieldName = options.fieldName || 'customComponentCode';
+      
+      // 使用文件流而不是读取整个文件到内存（对大文件更友好）
+      const fileContent = fs.createReadStream(filePath);
+
+      // 追加文件到 FormData，第三个参数指定文件名
+      formData.append(fieldName, fileContent, fileName);
+
+      // 构建完整的上传 API 地址
+      const fullUploadAPI = this.uploadAPI();
+
+      // 配置请求选项
+      const timeout = options.timeout || 60000; // 默认 60 秒
+      const requestConfig = {
+        headers: {
+          Authorization: `Bearer ${token}`,
+          'xsy-inner-source': 'bff',
+          // 无需手动设置 Content-Type，formData.getHeaders() 会自动设置正确的 multipart/form-data 和 boundary
+          ...formData.getHeaders()
+        },
+        timeout,
+        // 确保 axios 正确处理大文件和流
+        maxContentLength: Infinity, // 不限制响应内容长度
+        maxBodyLength: Infinity // 不限制请求体长度（适用于文件上传）
+      };
+
+      // 发送上传请求
+      const response = await axios.post(fullUploadAPI, formData, requestConfig);
+
+      // 处理响应数据
+      let resultData;
+      const responseData = response.data;
+
+      // 检查响应状态码
+      if (response.status !== 200 && response.status !== 201) {
+        throw new Error(`上传失败: HTTP ${response.status}`);
+      }
+
+      // 处理不同的响应格式
+      if (typeof responseData === 'string') {
+        // 如果响应是字符串，直接使用
+        resultData = responseData.trim();
+      } else if (responseData && typeof responseData === 'object') {
+        // 检查是否有错误码
+        if (responseData.code !== undefined && responseData.code !== 200 && responseData.code !== 0) {
+          const errorMsg = responseData.message || responseData.msg || '未知错误';
+          throw new Error(`上传失败: ${errorMsg} (code: ${responseData.code})`);
+        }
+
+        // 提取数据
+        if (responseData.data !== undefined) {
+          resultData = responseData.data;
+        } else if (responseData.url !== undefined) {
+          resultData = responseData.url;
+        } else if (responseData.fileUrl !== undefined) {
+          resultData = responseData.fileUrl;
+        } else {
+          resultData = responseData;
+        }
+      } else {
+        throw new Error(`响应数据格式不正确: ${typeof responseData}`);
+      }
+
+      // 验证返回的文件地址
+      if (!resultData) {
+        throw new Error(`返回的文件地址为空`);
+      }
+
+      // 格式化文件 URL
+      let fileUrl;
+      if (typeof resultData === 'string') {
+        fileUrl = resultData;
+      } else if (resultData && typeof resultData === 'object' && resultData.url) {
+        fileUrl = resultData.url;
+      }
+      console.info(`\n文件上传成功: ${fileName} -> ${fileUrl}`);
+      return fileUrl;
+    } catch (error) {
+      console.error(`\n上传文件失败: ${error.message}，`);
+      console.error(`文件路径: ${filePath}。\n`);
+      
+      // 输出详细的错误信息
+      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}`
+          );
+        }
+      } else if (error.request) {
+        console.error('请求已发送但未收到响应，请检查网络连接或代理配置。');
+      }
+      
+      throw error;
+    }
+  }
+
+  /**
+   * 将构建产物上传到 NeoCRM 平台端
+   *
+   * @param {object} cmpType 自定义组件名称
+   * @param {array} fileExtensions 需要上传的文件类型，默认 ['.js', '.css']
+   */
+  async publish2oss(cmpType, fileExtensions = ['.js', '.css']) {
+    if (!cmpType) {
+      console.error(`自定义组件名称不能为空: ${cmpType}`);
+      return;
+    }
+    if (!fs.existsSync(this.assetsRoot)) {
+      console.error(`未找到自定义组件资源目录: ${this.assetsRoot}`);
+      return;
+    }
+    // 当前组件信息
+    const curCmpInfo = {
+      cmpType
+    };
+
+    const files = fs.readdirSync(this.assetsRoot); // 读取构建目录下的所有文件
+
+    // 并行上传所有指定类型的文件
+    const uploadPromises = files.map(async (file) => {
+      const filePath = path.join(this.assetsRoot, file);
+      // 获取文件状态
+      const fileStat = fs.statSync(filePath);
+      // 检查文件扩展名
+      // const fileExt = path.extname(file);
+      const fileInfo = path.parse(filePath);
+      if (fileStat.isFile() && fileExtensions.includes(fileInfo.ext)) {
+        let widgetName = _.camelCase(cmpType);
+
+        if (file.indexOf(widgetName) < 0) {
+          return;
+        }
+
+        try {
+          // 上传文件
+          const fileUrl = await this.uploadFile(filePath);
+
+          if (file.indexOf('Model') > -1) {
+            curCmpInfo.modelAsset = fileUrl;
+          } else if (file.endsWith('.css')) {
+            curCmpInfo.cssAsset = fileUrl;
+          } else {
+            curCmpInfo.asset = fileUrl;
+          }
+        } catch (error) {
+          console.error(`文件上传失败（${file}）：\n`);
+          process.exit(1);
+        }
+      }
+    });
+
+    await Promise.all(uploadPromises);
+
+    if (curCmpInfo && curCmpInfo.cmpType) {
+      console.info('上传至 OSS 的文件信息：\n', curCmpInfo);
+      // 更新发布日志
+      updatePublishLog(curCmpInfo);
+    }
+    return curCmpInfo;
+  }
+
+  /**
+   * 更新自定义组件
+   * @param {object} componentData 组件数据
+   * @returns {Promise<object>} 更新结果
+   */
+  async updateCustomComponent(componentData) {
+    // 确保 token 有效
+    const token = await this.ensureValidToken();
+
+    if (!componentData) {
+      throw new Error('componentData 不能为空');
+    }
+
+    console.info('正在更新自定义组件...');
+
+    try {
+      const fullUpdateAPI = this.saveAPI();
+      const response = await axios.post(fullUpdateAPI, componentData, {
+        headers: {
+          Authorization: `Bearer ${token}`,
+          'xsy-inner-source': 'bff',
+          'Content-Type': 'application/json'
+        }
+      });
+      const {code, message} = response.data || {};
+
+      if (code && code !== 200) {
+        throw new Error(`更新组件失败: ${response.data.message || '未知错误'}`);
+      }
+      
+
+      console.info(message ? `组件更新成功: ${message}。` : '组件更新成功。');
+    } catch (error) {
+      if (error.message) {
+        console.error('更新组件失败:', error.message);
+      } else {
+        console.error('响应数据:', error);
+      }
+      process.exit(1);
+    }
+  }
+
+  /**
+   * 通用请求方法（确保 token 有效）
+   * @param {string} method HTTP 方法
+   * @param {string} api API 地址（相对或绝对路径）
+   * @param {object} options 请求选项
+   * @param {object} options.data 请求数据
+   * @param {object} options.headers 额外的请求头
+   * @param {object} options.params 查询参数
+   * @returns {Promise<object>} 响应数据
+   */
+  async request(method, api, options = {}) {
+    // 确保 token 有效
+    const token = await this.ensureValidToken();
+
+    const { data, headers = {}, params } = options;
+    const fullAPI = this.buildFullUrl(api);
+
+    try {
+      const response = await axios({
+        method,
+        url: fullAPI,
+        data,
+        params,
+        headers: {
+          Authorization: `Bearer ${token}`,
+          'xsy-inner-source': 'bff',
+          ...headers
+        }
+      });
+
+      if (response.data && response.data.code && response.data.code !== 200) {
+        throw new Error(`请求失败: ${response.data.message || '未知错误'}`);
+      }
+
+      return response.data;
+    } catch (error) {
+      console.error(`请求失败 [${method} ${api}]:`, error.message);
+      if (error.response) {
+        console.error('响应数据:', error.response.data);
+      }
+      throw error;
+    }
+  }
+
+  /**
+   * GET 请求
+   * @param {string} api API 地址
+   * @param {object} options 请求选项
+   * @returns {Promise<object>} 响应数据
+   */
+  async get(api, options = {}) {
+    return await this.request('GET', api, options);
+  }
+
+  /**
+   * POST 请求
+   * @param {string} api API 地址
+   * @param {object} options 请求选项
+   * @returns {Promise<object>} 响应数据
+   */
+  async post(api, options = {}) {
+    return await this.request('POST', api, options);
+  }
+
+  /**
+   * PUT 请求
+   * @param {string} api API 地址
+   * @param {object} options 请求选项
+   * @returns {Promise<object>} 响应数据
+   */
+  async put(api, options = {}) {
+    return await this.request('PUT', api, options);
+  }
+
+  /**
+   * DELETE 请求
+   * @param {string} api API 地址
+   * @param {object} options 请求选项
+   * @returns {Promise<object>} 响应数据
+   */
+  async delete(api, options = {}) {
+    return await this.request('DELETE', api, options);
+  }
+}
+
+module.exports = NeoService;

package/src/neo/wrapperContent.js

@@ -1,6 +1,7 @@
 /**
  * 注入 neoRequire 函数
  * 备注：用于实现和 Neo 平台共享依赖
+ * 特别说明：这个文件只是用于说明 AddNeoRequirePlugin 中会插入的代码内容，实际内容内置在 AddNeoRequirePlugin 方法中。
  */
 (function(NeoCustomCmpFileFactory) {
   if (!window.neoRequire) {
@@ -12,4 +13,4 @@
    * 这里放自定义组件相关内容代码
    * 备注: 自定义组件代码中的 require 函数 已被替换成 neoRequire 函数（require === neoRequire）。
    */
-});
+});