sks-maximo-utils 1.0.4 → 1.0.6

package/CLI.md

@@ -0,0 +1,137 @@
+# CLI 命令使用说明
+
+## 命令概览
+
+| 命令 | 说明 |
+|------|------|
+| `sks-maximo` | 检查配置文件并打开配置目录 |
+| `sks-maximo <env>` | 加载指定环境配置 |
+| `sks-maximo call <scriptName>` | 调用通用脚本接口 |
+
+---
+
+## 1. 打开配置目录
+
+```bash
+sks-maximo
+```
+
+**功能：**
+- 检查 `~/.sks/nodeutils/config.json` 是否存在
+- 不存在则复制 `sample.config.json` 创建
+- 自动打开配置文件所在目录
+
+---
+
+## 2. 加载环境配置
+
+```bash
+sks-maximo local    # 使用本地环境配置
+sks-maximo dev      # 使用开发环境配置  
+sks-maximo hd       # 使用测试环境配置
+```
+
+**功能：**
+- 加载指定环境的配置到全局
+- 后续所有 API 调用使用该环境的 baseUrl、apiKey 等配置
+
+---
+
+## 3. 调用通用脚本接口
+
+```bash
+sks-maximo call <scriptName> [--file <fileName>] [--params <params>] [--logname <logname>]
+```
+
+**参数说明：**
+
+| 参数 | 简写 | 说明 | 必填 |
+|------|------|------|------|
+| `<scriptName>` | - | Maximo 脚本接口名称 | 是 |
+| `--file` | `-f` | 请求体文件路径（JSON/XML等） | 否 |
+| `--params` | `-p` | URL 查询参数（JSON格式） | 否 |
+| `--logname` | `-l` | 日志名称 | 否 |
+
+### 3.1 GET 请求（无请求体）
+
+```bash
+sks-maximo call SHARPTREE.AUTOSCRIPT.LIBRARY --params '{"name":"TEST"}'
+```
+
+### 3.2 POST 请求（带请求体文件）
+
+```bash
+# JSON 请求体
+sks-maximo call SKS_DEPLOY_AUTOKEY --file data/autokey.json
+
+# XML 请求体
+sks-maximo call SHARPTREE.AUTOSCRIPT.SCREENS --file screens/test.xml
+
+# 同时带参数和请求体
+sks-maximo call SKS_IMP_MAXAPPINFO --file appinfo.json --params '{"debug":true}' --logname "导入应用信息"
+```
+
+### 3.3 请求体文件处理
+
+- **`.json` 文件**：自动解析为 JSON 对象作为请求体
+- **其他文件**：读取文件内容作为字符串请求体
+
+---
+
+## 配置文件说明
+
+配置文件位置：`~/.sks/nodeutils/config.json`
+
+```json
+{
+  "logLevel": "INFO",
+  "langcode": "zh",
+  "envs": {
+    "local": {
+      "baseUrl": "http://127.0.0.1:9080/maximo",
+      "apiKey": "your-api-key",
+      "maxauth": "",
+      "authType": "apiKey",
+      "langcode": "zh"
+    },
+    "dev": {
+      "baseUrl": "https://mdev/maximo",
+      "apiKey": "your-api-key",
+      "maxauth": "",
+      "authType": "apiKey"
+    }
+  }
+}
+```
+
+---
+
+## 示例
+
+### 示例 1：查询脚本库
+
+```bash
+sks-maximo call SHARPTREE.AUTOSCRIPT.LIBRARY --params '{"name":"MY_SCRIPT"}'
+```
+
+### 示例 2：部署自动编码
+
+```bash
+sks-maximo call SKS_DEPLOY_AUTOKEY --file autokey/test.json --logname "部署自动编码"
+```
+
+### 示例 3：导入应用信息
+
+```bash
+sks-maximo call SKS_IMP_MAXAPPINFO --file appinfo/APP001.json
+```
+
+---
+
+## 帮助信息
+
+```bash
+sks-maximo --help    # 显示帮助
+sks-maximo -h        # 显示帮助
+sks-maximo -v        # 显示版本号
+```

package/README.md

@@ -11,7 +11,7 @@ npm install -g shoukaiseki-maximo-utils
 
 ### 项目中安装（引用使用）
 ```bash
-npm install shoukaiseki-maximo-utils
+npm install sks-maximo-utils
 ```
 
 ## 使用方式
@@ -148,7 +148,7 @@ npm install
 npm link
 
 # 在其他项目中链接测试
-npm link shoukaiseki-maximo-utils
+npm link sks-maximo-utils
 ```
 
 ## License

package/cli.js

@@ -1,38 +1,115 @@
 #!/usr/bin/env node
 import { exec } from 'child_process';
+import { readFileSync } from 'fs';
+import { fileURLToPath, URL } from 'url';
 import { checkAndCreateConfig, getConfigDir, loadConfig } from './nodeutils/config.js';
+import { callMaxScript } from './nodeutils/maximoTools.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = new URL('.', import.meta.url).pathname;
+const packageJson = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf-8'));
 
 const args = process.argv.slice(2);
+const cmd = args[0];
 const env = args[0];
 
-if (!env) {
-  // 不带参数：检查配置并打开目录
-  const configPath = checkAndCreateConfig();
-  const configDir = getConfigDir();
+if (!cmd || ['-h', '--help', '-?', '--version', '-v'].includes(cmd)) {
+  console.log(`sks-maximo v${packageJson.version}`);
+  console.log('');
+  console.log('用法:');
+  console.log('  sks-maximo              # 检查配置文件并打开配置目录');
+  console.log('  sks-maximo <env>        # 加载指定环境配置');
+  console.log('  sks-maximo call <scriptName> [--file <fileName>] [--params <params>]  # 调用脚本接口');
+  console.log('');
+  console.log('环境:');
+  console.log('  local                   # 使用本地环境配置');
+  console.log('  dev                     # 使用开发环境配置');
+  console.log('  hd                      # 使用测试环境配置');
+  console.log('');
+  console.log('命令:');
+  console.log('  call                    # 调用通用脚本接口');
+  console.log('');
+  console.log('选项:');
+  console.log('  -h, --help              # 显示帮助信息');
+  console.log('  -v, --version           # 显示版本信息');
+  console.log('  --file <fileName>       # 请求体文件路径（JSON）');
+  console.log('  --params <params>       # URL参数（JSON格式）');
+  console.log('');
+  console.log('配置文件位置: ~/.sks/nodeutils/config.json');
   
-  console.log(`配置文件位置: ${configPath}`);
-  console.log(`正在打开配置目录...`);
+  if (!cmd) {
+    const configPath = checkAndCreateConfig();
+    const configDir = getConfigDir();
+    
+    console.log(`\n配置文件位置: ${configPath}`);
+    console.log(`正在打开配置目录...`);
+    
+    const platform = process.platform;
+    let command;
+    
+    if (platform === 'win32') {
+      command = `explorer "${configDir}"`;
+    } else if (platform === 'darwin') {
+      command = `open "${configDir}"`;
+    } else {
+      command = `xdg-open "${configDir}"`;
+    }
+    
+    exec(command, (error) => {
+      if (error) {
+        console.error(`打开目录失败: ${error.message}`);
+        console.log(`请手动打开: ${configDir}`);
+      }
+    });
+  }
+} else if (cmd === 'call') {
+  const scriptName = args[1];
   
-  // 根据操作系统打开目录
-  const platform = process.platform;
-  let command;
+  if (!scriptName) {
+    console.error('错误: 请指定脚本名称');
+    console.log('用法: sks-maximo call <scriptName> [--file <fileName>] [--params <params>]');
+    process.exit(1);
+  }
   
-  if (platform === 'win32') {
-    command = `explorer "${configDir}"`;
-  } else if (platform === 'darwin') {
-    command = `open "${configDir}"`;
-  } else {
-    command = `xdg-open "${configDir}"`;
+  let fileName = null;
+  let params = {};
+  let logname = null;
+  
+  for (let i = 2; i < args.length; i++) {
+    if (args[i] === '--file' || args[i] === '-f') {
+      fileName = args[i + 1];
+      i++;
+    } else if (args[i] === '--params' || args[i] === '-p') {
+      try {
+        params = JSON.parse(args[i + 1]);
+      } catch (e) {
+        console.error(`参数解析失败: ${e.message}`);
+        process.exit(1);
+      }
+      i++;
+    } else if (args[i] === '--logname' || args[i] === '-l') {
+      logname = args[i + 1];
+      i++;
+    }
   }
   
-  exec(command, (error) => {
-    if (error) {
-      console.error(`打开目录失败: ${error.message}`);
-      console.log(`请手动打开: ${configDir}`);
+  loadConfig('local');
+  
+  (async () => {
+    try {
+      const response = await callMaxScript({ apiScriptName: scriptName, fileName, params, logname });
+      if (response) {
+        console.log('响应:', JSON.stringify(response, null, 2));
+      } else {
+        console.error('调用失败');
+        process.exit(1);
+      }
+    } catch (error) {
+      console.error('调用出错:', error.message);
+      process.exit(1);
     }
-  });
+  })();
 } else {
-  // 带参数：加载配置
   loadConfig(env);
 }
 

package/index.js

@@ -3,5 +3,5 @@ export { loadConfig, getConfig, getWorkDir } from './nodeutils/config.js';
 export { default as logger } from './nodeutils/logger.js';
 export { default as request } from './nodeutils/requestHttp.js';
 export { readFileContent, readJsonFile, readXmlFile, fileExists } from './nodeutils/fileUtils.js';
-export { importMaxObject, importMaxPresentation, importMaxDomain, importMaxAutoKey, importMaxScript, saveScriptHistory, importMaxAppInfo } from './nodeutils/maximoTools.js';
+export { importMaxObject, importMaxPresentation, importMaxDomain, importMaxAutoKey, importMaxScript, saveScriptHistory, importMaxAppInfo, callMaxScript } from './nodeutils/maximoTools.js';
 export { sendMockData, sendMockDataBatch, sendPOMockData, sendPOMockDataBatch, sendRlImportMockDataBatch } from './nodeutils/mockdataTools.js';

package/nodeutils/maximoTools.js

@@ -44,7 +44,7 @@ export async function importMaxObject({fileName, logname}) {
         
         logger.info(`[${logname}]收到响应`);
         logger.info(`[${logname}]响应类型:`, typeof response);
-        logger.info(`[${logname}]响应内容:`, response);
+        logger.debug(`[${logname}]响应内容:`, response);
         
         // 检查响应 - requestHttp的响应拦截器已返回res.data
         if (response !== null && response !== undefined) {
@@ -113,7 +113,7 @@ export async function importMaxPresentation({fileName, logname}) {
         
         logger.info(`[${logname}]收到响应`);
         logger.info(`[${logname}]响应类型:`, typeof response);
-        logger.info(`[${logname}]响应内容:`, response);
+        logger.debug(`[${logname}]响应内容:`, response);
         
         if (response !== null && response !== undefined) {
             logger.warn(`[${logname}]导入成功`)
@@ -175,9 +175,9 @@ export async function importMaxDomain({fileName, logname}) {
             data: fileContent  // 将文件内容作为请求体发送
         })
         
-        logger.info(`[${logname}]收到响应`);
-        logger.info(`[${logname}]响应类型:`, typeof response);
-        logger.info(`[${logname}]响应内容:`, response);
+        logger.warn(`[${logname}]收到响应`);
+        logger.warn(`[${logname}]响应类型:`, typeof response);
+        logger.warn(`[${logname}]响应内容:`, response);
         
         // 检查响应 - requestHttp的响应拦截器已返回res.data
         if (response !== null && response !== undefined) {
@@ -237,7 +237,7 @@ export async function saveScriptHistory({autoscript, source, version = '', alias
             }
         });
         
-        logger.info(`[${autoscript}]脚本历史记录保存成功`);
+        logger.warn(`[${autoscript}]脚本历史记录保存成功`);
         return response !== null && response !== undefined;
     } catch (error) {
         logger.error(`[${autoscript}]保存脚本历史记录失败:`, error.message);
@@ -276,8 +276,8 @@ export async function importMaxScript({fileName, logname}) {
         
         const actualLogname = logname || autoscript;
         logger.info(`[${actualLogname}]成功读取配置文件: ${fileName}`);
-        logger.info(`[${actualLogname}]脚本名称: ${autoscript}`);
-        logger.info(`[${actualLogname}]脚本语言: ${scriptLanguage}`);
+        logger.warn(`[${actualLogname}]脚本名称: ${autoscript}`);
+        logger.warn(`[${actualLogname}]脚本语言: ${scriptLanguage}`);
         
         const dirname = fileName.substring(0, fileName.lastIndexOf('/')) || fileName.substring(0, fileName.lastIndexOf('\\')) || '';
         const scriptFileName = dirname ? `${dirname}/${autoscript}${scriptExt}` : `${autoscript}${scriptExt}`;
@@ -525,7 +525,7 @@ export async function importMaxAutoKey({fileName, logname}) {
         
         logger.info(`[${logname}]收到响应`);
         logger.info(`[${logname}]响应类型:`, typeof response);
-        logger.info(`[${logname}]响应内容:`, response);
+        logger.debug(`[${logname}]响应内容:`, response);
         
         if (response !== null && response !== undefined) {
             logger.warn(`[${logname}]导入成功`)
@@ -607,4 +607,73 @@ export async function importMaxAppInfo({fileName, logname}) {
         }
         return false
     }
-}
+}
+export async function callMaxScript({ apiScriptName, fileName, params = {}, logname }) {
+    if (!apiScriptName) {
+        logger.error('[callMaxScript]脚本名称不能为空')
+        return false
+    }
+    
+    const actualLogname = logname || apiScriptName
+    
+    try {
+        logger.info(`[${actualLogname}]开始调用脚本: ${apiScriptName}`)
+        
+        let data = null
+        if (fileName) {
+            const fileContent = readFileContent(fileName)
+            if (!fileContent) {
+                logger.error(`[${actualLogname}]文件读取失败: ${fileName}`)
+                return false
+            }
+            logger.info(`[${actualLogname}]已读取请求体文件: ${fileName}`)
+            
+            if (fileName.endsWith('.json')) {
+                try {
+                    data = JSON.parse(fileContent)
+                } catch (e) {
+                    logger.error(`[${actualLogname}]JSON解析失败: ${e.message}`)
+                    return false
+                }
+            } else {
+                data = fileContent
+            }
+        }
+        
+        const requestConfig = {
+            url: `/api/script/${apiScriptName}`,
+            method: data ? 'POST' : 'GET',
+            params: {
+                ...params,
+                _langcode: getConfig().langcode,
+            }
+        }
+        
+        if (data !== null) {
+            requestConfig.data = data
+        }
+        
+        const response = await request(requestConfig)
+        
+        logger.info(`[${actualLogname}]收到响应`)
+        logger.debug(`[${actualLogname}]响应内容:`, response)
+        
+        if (response !== null && response !== undefined) {
+            logger.info(`[${actualLogname}]调用成功`)
+            return response
+        } else {
+            logger.error(`[${actualLogname}]调用失败，响应为空或null`)
+            return null
+        }
+    } catch (error) {
+        logger.error(`[${actualLogname}]请求出错:`, error.message)
+        if (error.response) {
+            logger.error(`[${actualLogname}]服务器返回错误:`, error.response.data)
+        } else if (error.request) {
+            logger.error(`[${actualLogname}]请求已发出但无响应`)
+        } else {
+            logger.error(`[${actualLogname}]错误详情:`, error)
+        }
+        return null
+    }
+}

package/nodeutils/requestHttp.js

@@ -27,6 +27,10 @@ function limitLogOutput(data, maxLength = 200) {
   }
 }
 
+function joinUrl(base, path) {
+  return `${base.replace(/\/$/, '')}/${path.replace(/^\//, '')}`;
+}
+
 function getLogDir() {
   return path.join(os.homedir(), '.sks', 'nodeutils', 'logs');
 }
@@ -39,7 +43,7 @@ function saveRequestLog(config, globalConfig) {
     }
 
     const method = config.method?.toUpperCase() || 'GET';
-    let url = `${config.url}`;
+    let url = joinUrl(globalConfig.baseUrl, config.url);
     
     if (config.params && Object.keys(config.params).length > 0) {
       const paramsStr = Object.entries(config.params)
@@ -79,6 +83,44 @@ function saveRequestLog(config, globalConfig) {
   }
 }
 
+function saveErrorLog(error) {
+  try {
+    const logDir = getLogDir();
+    if (!fs.existsSync(logDir)) {
+      fs.mkdirSync(logDir, { recursive: true });
+    }
+
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+    const method = error.config?.method?.toUpperCase() || 'GET';
+    const fullUrl = error.config ? joinUrl(getConfig().baseUrl, error.config.url) : 'unknown';
+    
+    const errorLog = {
+      timestamp: timestamp,
+      method: method,
+      url: fullUrl,
+      message: error.message,
+      status: error.response?.status,
+      statusText: error.response?.statusText,
+      headers: error.response?.headers,
+      data: error.response?.data || error.data,
+      config: {
+        url: error.config?.url,
+        method: error.config?.method,
+        params: error.config?.params,
+        data: error.config?.data
+      }
+    };
+
+    const fileName = `response-error-${method}-${timestamp}.json`;
+    const filePath = path.join(logDir, fileName);
+
+    fs.writeFileSync(filePath, JSON.stringify(errorLog, null, 2), 'utf-8');
+
+    logger.warn(`[HTTP Log] 错误日志已保存: ${filePath}`);
+  } catch (e) {
+    logger.error('[HTTP Log] 保存错误日志失败:', e.message);
+  }
+}
 function saveResponseLog(response) {
   try {
     const logDir = getLogDir();
@@ -88,12 +130,24 @@ function saveResponseLog(response) {
 
     const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
     const method = response.config.method?.toUpperCase() || 'GET';
+    const fullUrl = joinUrl(getConfig().baseUrl, response.config.url);
+    
+    const responseLog = {
+      timestamp: timestamp,
+      method: method,
+      url: fullUrl,
+      status: response.status,
+      statusText: response.statusText,
+      headers: response.headers,
+      data: response.data
+    };
+
     const fileName = `response-${method}-${timestamp}.json`;
     const filePath = path.join(logDir, fileName);
 
-    fs.writeFileSync(filePath, JSON.stringify(response.data, null, 2), 'utf-8');
+    fs.writeFileSync(filePath, JSON.stringify(responseLog, null, 2), 'utf-8');
 
-    logger.error(`[HTTP Log] 响应日志已保存: ${filePath}`);
+    logger.warn(`[HTTP Log] 响应日志已保存: ${filePath}`);
   } catch (error) {
     logger.error('[HTTP Log] 保存响应日志失败:', error.message);
   }
@@ -140,7 +194,7 @@ function createService() {
     if (!config.params['_langcode']) {
       config.params['_langcode'] = globalConfig.langcode || 'zh';
     }
-    var url = `${config.method} ${globalConfig.baseUrl}${config.url}`;
+    var url = `${config.method} ${joinUrl(globalConfig.baseUrl, config.url)}`;
     if (config.params && Object.keys(config.params).length > 0) {
       if (url.indexOf('?') > -1) {
         url += `&`;
@@ -200,18 +254,29 @@ function createService() {
       return Promise.reject(new Error('未知错误'));
     }
   }, error => {
-    logger.error('[Response Error] 请求错误:', error.message);
     try{
       if(error){
+        logger.error('[Response Error] 请求错误:', error.message);
+        saveErrorLog(error);
         logger.debug('[Response Error] 错误对象:', error);
         if (error.data) {
           logger.info('[Response Error] 错误error.data:', error.data);
         }
         if (error.response&&error.response.data) {
           logger.info('[Response Error] 错误error.response.data:', error.response.data);
-          if(error.response.data['oslc:Error']&&error.response.data['oslc:Error']['oslc:extendedError']&&error.response.data['oslc:Error']['oslc:extendedError']['oslc:moreInfo']){
-            logger.info('[Response Error] 错误error.response.data:', error.response.data['oslc:Error']['oslc:extendedError']['oslc:moreInfo']);
+          if (error.response.data['oslc:Error']) {
+            if (error.response.data['oslc:Error']['oslc:extendedError']) {
+              if (error.response.data['oslc:Error']['oslc:extendedError']['oslc:moreInfo']) {
+                logger.error('[Response Error] 错误error.response.data:', error.response.data['oslc:Error']['oslc:extendedError']['oslc:moreInfo']);
 
+              }
+            } else {
+              if(error.response.data['oslc:Error']['oslc:message']){
+                logger.error('[Response Error] 错误error.response.data.oslc:Error.oslc:message:', error.response.data['oslc:Error']['oslc:message']);
+              }else{
+                logger.error('[Response Error] 错误error.response.data.oslc:Error.oslc:message:', error.response.data['oslc:Error']);
+              }
+            }
           }
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sks-maximo-utils",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Maximo helper tools for updating table structures and data",
   "type": "module",
   "main": "index.js",
@@ -10,7 +10,10 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": ["maximo", "sks"],
+  "keywords": [
+    "maximo",
+    "sks"
+  ],
   "author": "shoukaiseki",
   "license": "ISC",
   "dependencies": {