@vdhewei/xlsx-template-lib 1.6.7 → 1.6.11

package/README.md

@@ -678,6 +678,8 @@ xlsx-cli render <xlsx-file> [options]
 - `-n, --sheet-name <string>` - Sheet name to render (default: first sheet)
 - `-s, --save <string>` - Save rendered file to specified directory (default: current directory)
 - `-d, --data <string>` - Render data source (JSON string, file path, or URL)
+- `--header <string>` - HTTP headers for remote data fetch (can be specified multiple times, format: `Key:Value`)
+- `--body <string>` - HTTP request body for POST requests
 
 **Examples:**
 
@@ -700,6 +702,15 @@ xlsx-cli render template.xlsx -c -d './data.json'
 # Render specific sheet
 xlsx-cli render template.xlsx -n Sheet1 -d './data.json'
 
+# Render with custom HTTP headers
+xlsx-cli render template.xlsx -d 'https://api.example.com/data.json' --header 'Authorization:Bearer token123' --header 'Content-Type:application/json'
+
+# Render with POST request body
+xlsx-cli render template.xlsx -d 'https://api.example.com/api/query' --body '{"query":"SELECT * FROM users"}' --header 'Content-Type:application/json'
+
+# Render with POST method via header
+xlsx-cli render template.xlsx -d 'https://api.example.com/api/create' --body '{"name":"Test"}' --header 'Content-Type:application/json' --header 'method:POST'
+
 # Full example
 xlsx-cli render template.xlsx -c -n Sheet1 -s ./output/ -d './data.json'
 ```
@@ -709,6 +720,70 @@ xlsx-cli render template.xlsx -c -n Sheet1 -s ./output/ -d './data.json'
 - **Local File**: Path to `.json` file (relative or absolute)
 - **Remote URL**: HTTP/HTTPS URL returning JSON
 
+**HTTP Request Options (for Remote URL):**
+- **Headers**: Use `--header` to add custom HTTP headers (can be specified multiple times)
+  - Format: `--header 'Key:Value'`
+  - Example: `--header 'Authorization:Bearer token123' --header 'Content-Type:application/json'`
+  - Special header: `method:POST` can set the HTTP method to POST
+- **Body**: Use `--body` to send request body (typically for POST requests)
+  - Format: `--body '{"key":"value"}'`
+  - Automatically uses POST method when body is provided
+- **Default Behavior**: GET request with no headers
+
+**HTTP Request Examples:**
+
+```bash
+# GET request with custom headers
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/data.json' \
+  --header 'Authorization:Bearer your-token' \
+  --header 'X-API-Key:api-key-123'
+
+# POST request with JSON body
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/api/query' \
+  --body '{"query":"SELECT * FROM users LIMIT 10"}' \
+  --header 'Content-Type:application/json'
+
+# POST request with method specified in header
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/api/create' \
+  --body '{"name":"New Record","value":100}' \
+  --header 'Content-Type:application/json' \
+  --header 'method:POST'
+
+# Complex example with authentication and query body
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/v1/export' \
+  --header 'Authorization:Bearer eyJhbGc...' \
+  --header 'Content-Type:application/json' \
+  --body '{"format":"xlsx","filter":{"status":"active"}}' \
+  -c -n Sheet1 -s ./output/
+```
+
+**HTTP Request Details:**
+
+1. **Method Determination**:
+   - Default: `GET`
+   - With `--body`: Automatically becomes `POST`
+   - With `method:POST` header: Explicitly set to `POST`
+   - With `method:GET` header: Explicitly set to `GET`
+
+2. **Header Format**:
+   - Headers are parsed as `Key:Value` pairs
+   - Multiple `--header` options can be used
+   - Example: `--header 'Accept:application/json' --header 'User-Agent:MyApp/1.0'`
+
+3. **Error Handling**:
+   - Non-200 status codes return `undefined` and display error message
+   - Network errors are caught and displayed in red
+   - Missing `node-fetch` (Node.js < 18) displays error message
+
+4. **Supported Data Formats**:
+   - JSON objects: `{"key":"value"}`
+   - JSON arrays: `[{"id":1},{"id":2}]`
+   - Nested structures: `{"user":{"name":"John","age":30}}`
+
 **Output:**
 - Rendered Excel file saved as `<filename>_<timestamp>.xlsx`
 - Validation checks for sheet existence

package/README.zh-CN.md

@@ -676,6 +676,8 @@ xlsx-cli render <xlsx-文件> [选项]
 - `-n, --sheet-name <string>` - 要渲染的工作表名称（默认：第一个工作表）
 - `-s, --save <string>` - 将渲染后的文件保存到指定目录（默认：当前目录）
 - `-d, --data <string>` - 渲染数据源（JSON 字符串、文件路径或 URL）
+- `--header <string>` - 远程数据获取的 HTTP 请求头（可指定多次，格式：`Key:Value`）
+- `--body <string>` - POST 请求的 HTTP 请求体
 
 **示例:**
 
@@ -698,6 +700,15 @@ xlsx-cli render template.xlsx -c -d './data.json'
 # 渲染指定工作表
 xlsx-cli render template.xlsx -n Sheet1 -d './data.json'
 
+# 使用自定义 HTTP 请求头渲染
+xlsx-cli render template.xlsx -d 'https://api.example.com/data.json' --header 'Authorization:Bearer token123' --header 'Content-Type:application/json'
+
+# 使用 POST 请求体渲染
+xlsx-cli render template.xlsx -d 'https://api.example.com/api/query' --body '{"query":"SELECT * FROM users"}' --header 'Content-Type:application/json'
+
+# 通过 header 指定 POST 方法
+xlsx-cli render template.xlsx -d 'https://api.example.com/api/create' --body '{"name":"测试"}' --header 'Content-Type:application/json' --header 'method:POST'
+
 # 完整示例
 xlsx-cli render template.xlsx -c -n Sheet1 -s ./output/ -d './data.json'
 ```
@@ -707,6 +718,70 @@ xlsx-cli render template.xlsx -c -n Sheet1 -s ./output/ -d './data.json'
 - **本地文件**: `.json` 文件的路径（相对或绝对）
 - **远程 URL**: 返回 JSON 的 HTTP/HTTPS URL
 
+**HTTP 请求选项（用于远程 URL）:**
+- **请求头**: 使用 `--header` 添加自定义 HTTP 请求头（可指定多次）
+  - 格式：`--header 'Key:Value'`
+  - 示例：`--header 'Authorization:Bearer token123' --header 'Content-Type:application/json'`
+  - 特殊请求头：`method:POST` 可设置 HTTP 方法为 POST
+- **请求体**: 使用 `--body` 发送请求体（通常用于 POST 请求）
+  - 格式：`--body '{"key":"value"}'`
+  - 提供请求体时自动使用 POST 方法
+- **默认行为**: 无请求头的 GET 请求
+
+**HTTP 请求示例:**
+
+```bash
+# 带自定义请求头的 GET 请求
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/data.json' \
+  --header 'Authorization:Bearer your-token' \
+  --header 'X-API-Key:api-key-123'
+
+# 带 JSON 请求体的 POST 请求
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/api/query' \
+  --body '{"query":"SELECT * FROM users LIMIT 10"}' \
+  --header 'Content-Type:application/json'
+
+# 通过 header 指定 POST 方法
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/api/create' \
+  --body '{"name":"新记录","value":100}' \
+  --header 'Content-Type:application/json' \
+  --header 'method:POST'
+
+# 复杂示例：带认证和查询请求体
+xlsx-cli render template.xlsx \
+  -d 'https://api.example.com/v1/export' \
+  --header 'Authorization:Bearer eyJhbGc...' \
+  --header 'Content-Type:application/json' \
+  --body '{"format":"xlsx","filter":{"status":"active"}}' \
+  -c -n Sheet1 -s ./output/
+```
+
+**HTTP 请求详细说明:**
+
+1. **HTTP 方法确定**:
+   - 默认：`GET`
+   - 使用 `--body`：自动变为 `POST`
+   - 使用 `method:POST` 请求头：显式设置为 `POST`
+   - 使用 `method:GET` 请求头：显式设置为 `GET`
+
+2. **请求头格式**:
+   - 请求头按 `Key:Value` 格式解析
+   - 可以使用多个 `--header` 选项
+   - 示例：`--header 'Accept:application/json' --header 'User-Agent:MyApp/1.0'`
+
+3. **错误处理**:
+   - 非 200 状态码返回 `undefined` 并显示错误消息
+   - 网络错误会被捕获并以红色显示
+   - 缺少 `node-fetch`（Node.js < 18）会显示错误消息
+
+4. **支持的数据格式**:
+   - JSON 对象：`{"key":"value"}`
+   - JSON 数组：`[{"id":1},{"id":2}]`
+   - 嵌套结构：`{"user":{"name":"张三","age":30}}`
+
 **输出:**
 - 渲染后的 Excel 文件保存为 `<文件名>_<时间戳>.xlsx`
 - 检查工作表是否存在

package/dist/bin.js

@@ -4309,35 +4309,77 @@ async function resolveFilePath(filePath) {
   }
   throw new Error(`File not found: ${filePath}`);
 }
-async function parseRenderData(dataOption) {
+function isValidJSON(str) {
+  const trimmed = str.trim();
+  if (!trimmed) return false;
+  const firstChar = trimmed[0];
+  const lastChar = trimmed.charAt(trimmed.length - 1);
+  const validStartEndPairs = [
+    ["{", "}"],
+    ["[", "]"],
+    ['"', '"']
+  ];
+  const hasValidFormat = validStartEndPairs.some(
+    ([start, end]) => firstChar === start && lastChar === end
+  );
+  if (!hasValidFormat && !["true", "false", "null"].includes(trimmed) && !/^-?\d+(\.\d+)?([eE][+-]?\d+)?$/.test(trimmed)) {
+    return false;
+  }
+  try {
+    JSON.parse(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function parseRenderData(dataOption, httpHeaders, body) {
   if (!dataOption) {
     return {};
   }
   try {
-    return JSON.parse(dataOption);
-  } catch (e) {
-    try {
-      const filePath = await resolveFilePath(dataOption);
-      const fileContent = await fs3.readFile(filePath, "utf-8");
-      return JSON.parse(fileContent);
-    } catch (e2) {
-      if (dataOption.startsWith("http://") || dataOption.startsWith("https://")) {
-        let fetch;
+    if (isValidJSON(dataOption)) {
+      return JSON.parse(dataOption);
+    }
+    if (dataOption.startsWith("http://") || dataOption.startsWith("https://")) {
+      let fetch;
+      try {
+        fetch = globalThis.fetch;
+      } catch (e3) {
         try {
-          fetch = globalThis.fetch;
-        } catch (e3) {
-          try {
-            const nodeFetch = await import("node-fetch");
-            fetch = nodeFetch.default;
-          } catch (e4) {
-            throw new Error("Remote URLs require Node.js 18+ or node-fetch package");
-          }
+          const nodeFetch = await import("node-fetch");
+          fetch = nodeFetch.default;
+        } catch (e4) {
+          console.error(import_chalk.default.red("Remote URLs require Node.js 18+ or node-fetch package"));
+          return void 0;
         }
-        const response = await fetch(dataOption);
-        return response.json();
       }
-      throw new Error(`Failed to parse render data from: ${dataOption}`);
+      const headers = new Headers();
+      httpHeaders?.forEach((header) => {
+        const [key, value] = header.split(":");
+        headers.append(key, value);
+      });
+      const reqOpts = {
+        headers,
+        method: headers.get(`method`) ? headers.get(`method`).toUpperCase() : "GET"
+      };
+      if (body !== void 0 && body !== "") {
+        reqOpts.body = body;
+      }
+      console.log(import_chalk.default.gray(`Fetching data from: ${dataOption}`));
+      console.log(import_chalk.default.gray(`request.init: ${JSON.stringify(reqOpts)}`));
+      const response = await fetch(dataOption, reqOpts);
+      if (response.status !== 200) {
+        console.error(import_chalk.default.red(`Failed to fetch data from: ${dataOption}, status: ${response.status},${response.text()}`));
+        return void 0;
+      }
+      return response.json();
     }
+    const filePath = await resolveFilePath(dataOption);
+    const fileContent = await fs3.readFile(filePath, "utf-8");
+    return JSON.parse(fileContent);
+  } catch (e) {
+    console.error(import_chalk.default.red(`Failed to parse render data from: ${dataOption}`));
+    return void 0;
   }
 }
 function checkSheetAndPlaceholders(xlsx, sheetName) {
@@ -4505,20 +4547,28 @@ async function addMultipleRulesToSheet(xlsxBuffer, rules) {
 
 // src/bin.ts
 async function main() {
-  let version = "1.0.0";
+  let version;
   try {
-    const possiblePaths = [
-      path3.join(process.cwd(), "package.json"),
-      path3.join(process.cwd(), "..", "package.json")
-    ];
-    for (const packagePath of possiblePaths) {
-      if ((0, import_node_fs2.existsSync)(packagePath)) {
-        const packageJson = JSON.parse(await fs4.readFile(packagePath, "utf-8"));
-        version = packageJson.version;
-        break;
-      }
+    version = __VERSION__;
+    if (version.startsWith('"') && version.endsWith('"')) {
+      version = version.slice(1, -1);
     }
   } catch (e) {
+    version = "1.0.0";
+    try {
+      const possiblePaths = [
+        path3.join(process.cwd(), "package.json"),
+        path3.join(process.cwd(), "..", "package.json")
+      ];
+      for (const packagePath of possiblePaths) {
+        if ((0, import_node_fs2.existsSync)(packagePath)) {
+          const packageJson = JSON.parse(await fs4.readFile(packagePath, "utf-8"));
+          version = packageJson.version;
+          break;
+        }
+      }
+    } catch (e2) {
+    }
   }
   const envPath = path3.join(process.cwd(), ".env");
   if ((0, import_node_fs2.existsSync)(envPath)) {
@@ -4558,7 +4608,7 @@ async function main() {
       process.exit(1);
     }
   });
-  program.command("render").argument("<string>", "xlsx file path").option("-c,--compile", "auto compile flag", false).option("-n,--sheet-name <string>", "render xlsx sheet name when xlsx has multiple sheets").option("-s,--save <string>", "save render xlsx file to user dir").option("-d,--data <string>", "render xlsx file data from").action(async (xlsxFile, options) => {
+  program.command("render").argument("<string>", "xlsx file path").option("-c,--compile", "auto compile flag", false).option("-n,--sheet-name <string>", "render xlsx sheet name when xlsx has multiple sheets").option("-s,--save <string>", "save render xlsx file to user dir").option("-d,--data <string>", "render xlsx file data from").option("--header <string>", "call remote http json data with header", []).option("--body <string>", "call remote http json request with body").option("-r,--remove", "remove configure rules sheet", false).action(async (xlsxFile, options) => {
     try {
       console.log(import_chalk2.default.green("\u{1F4C4} Rendering Excel template..."));
       const filePath = await resolveFilePath(xlsxFile);
@@ -4570,7 +4620,10 @@ async function main() {
       console.log(import_chalk2.default.gray(`Target sheet: ${sheetName}`));
       checkSheetAndPlaceholders(xlsx, sheetName);
       console.log(import_chalk2.default.gray("Sheet validation passed"));
-      const renderData = await parseRenderData(options.data);
+      const renderData = await parseRenderData(options.data, options.header, options.body);
+      if (renderData === void 0) {
+        process.exit(1);
+      }
       if (Object.keys(renderData).length > 0) {
         console.log(import_chalk2.default.gray(`Render data loaded with ${Object.keys(renderData).length} keys`));
       }
@@ -4579,7 +4632,7 @@ async function main() {
         const ruleSheetName = options.sheetName || compileRuleSheetName;
         const opts = new RuleMapOptions();
         opts.sheetName = ruleSheetName;
-        opts.remove = false;
+        opts.remove = options.remove || false;
         const compiledResult = await compileAll(buffer, opts);
         buffer = Buffer.from(compiledResult);
         xlsx = await XlsxRender.create(buffer);