@vdhewei/xlsx-template-lib 1.2.3 → 1.2.5

package/dist/index.d.mts

@@ -402,6 +402,7 @@ type CompileResult = {
     configure?: RuleResult;
     errs?: Error[];
 };
+declare const loadCompileSheets: (workbook: exceljs.Workbook, ruleSheetName: string | number) => string[];
 declare const compileWorkSheet: <T extends ArrayBuffer | Buffer | string>(data: T, sheetName: string | number, options?: RuleOptions) => Promise<exceljs.Xlsx | Error[]>;
 declare class ExprResolver {
     static toBuffer: (w: exceljs.Workbook) => Promise<Buffer>;
@@ -469,4 +470,4 @@ declare const mergeMap: (source: Map<string, string>, dest: Map<string, string>)
 declare const autoRegisterAlias: (values: Object, configure: RuleResult) => Object;
 declare const generateCommandsXlsxTemplateWithCompile: <T extends JsZip.OutputType>(data: Buffer, values: Object, compileOptions: AutoOptions, options?: JsZip.JSZipGeneratorOptions<T> & FullOptions) => Promise<OutputByType[T]>;
 
-export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomFormatter, type CustomPlaceholderExtractor, type CustomReplacer, DefaultPlaceholderCellValue, type DrawingInfo, ExprResolver, type ExtensionOptions, type ExtractMacroArgs, type FilterMacroResult, type FullOptions, type MacroArgs, type MacroUnitHelper, type OutputByType, type Placeholder, type PlaceholderCellValue, type QueryFunction, type Range, type Ref, type RelsInfo, RuleMapOptions, type RuleOptions, type RuleResult, RuleToken, type SheetInfo, type TableInfo, TokenParserManger, Workbook, type WorkbookOptions, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, valueDotGet, workSheetSetPlaceholder };
+export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomFormatter, type CustomPlaceholderExtractor, type CustomReplacer, DefaultPlaceholderCellValue, type DrawingInfo, ExprResolver, type ExtensionOptions, type ExtractMacroArgs, type FilterMacroResult, type FullOptions, type MacroArgs, type MacroUnitHelper, type OutputByType, type Placeholder, type PlaceholderCellValue, type QueryFunction, type Range, type Ref, type RelsInfo, RuleMapOptions, type RuleOptions, type RuleResult, RuleToken, type SheetInfo, type TableInfo, TokenParserManger, Workbook, type WorkbookOptions, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadCompileSheets, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, valueDotGet, workSheetSetPlaceholder };

package/dist/index.d.ts

@@ -402,6 +402,7 @@ type CompileResult = {
     configure?: RuleResult;
     errs?: Error[];
 };
+declare const loadCompileSheets: (workbook: exceljs.Workbook, ruleSheetName: string | number) => string[];
 declare const compileWorkSheet: <T extends ArrayBuffer | Buffer | string>(data: T, sheetName: string | number, options?: RuleOptions) => Promise<exceljs.Xlsx | Error[]>;
 declare class ExprResolver {
     static toBuffer: (w: exceljs.Workbook) => Promise<Buffer>;
@@ -469,4 +470,4 @@ declare const mergeMap: (source: Map<string, string>, dest: Map<string, string>)
 declare const autoRegisterAlias: (values: Object, configure: RuleResult) => Object;
 declare const generateCommandsXlsxTemplateWithCompile: <T extends JsZip.OutputType>(data: Buffer, values: Object, compileOptions: AutoOptions, options?: JsZip.JSZipGeneratorOptions<T> & FullOptions) => Promise<OutputByType[T]>;
 
-export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomFormatter, type CustomPlaceholderExtractor, type CustomReplacer, DefaultPlaceholderCellValue, type DrawingInfo, ExprResolver, type ExtensionOptions, type ExtractMacroArgs, type FilterMacroResult, type FullOptions, type MacroArgs, type MacroUnitHelper, type OutputByType, type Placeholder, type PlaceholderCellValue, type QueryFunction, type Range, type Ref, type RelsInfo, RuleMapOptions, type RuleOptions, type RuleResult, RuleToken, type SheetInfo, type TableInfo, TokenParserManger, Workbook, type WorkbookOptions, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, valueDotGet, workSheetSetPlaceholder };
+export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomFormatter, type CustomPlaceholderExtractor, type CustomReplacer, DefaultPlaceholderCellValue, type DrawingInfo, ExprResolver, type ExtensionOptions, type ExtractMacroArgs, type FilterMacroResult, type FullOptions, type MacroArgs, type MacroUnitHelper, type OutputByType, type Placeholder, type PlaceholderCellValue, type QueryFunction, type Range, type Ref, type RelsInfo, RuleMapOptions, type RuleOptions, type RuleResult, RuleToken, type SheetInfo, type TableInfo, TokenParserManger, Workbook, type WorkbookOptions, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadCompileSheets, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, valueDotGet, workSheetSetPlaceholder };

package/dist/index.js

@@ -62,6 +62,7 @@ __export(index_exports, {
   hasGeneratorToken: () => hasGeneratorToken,
   isRuleToken: () => isRuleToken,
   isUrl: () => isUrl,
+  loadCompileSheets: () => loadCompileSheets,
   loadWorkbook: () => loadWorkbook,
   mergeMap: () => mergeMap,
   parseWorkSheetRules: () => parseWorkSheetRules,
@@ -2130,16 +2131,16 @@ var RuleMapOptions = class _RuleMapOptions {
   }
   parseDefault(worksheet) {
     this.ruleKeyMap = mergeOption(this.ruleKeyMap, defaultRuleTokenMap);
-    if (this.startLine === void 0) {
+    if (this.startLine === void 0 || isNaN(this.startLine) || this.startLine < 0) {
       this.startLine = 1;
     }
-    if (this.endLine === void 0) {
+    if (this.endLine === void 0 || isNaN(this.endLine) || this.endLine < 0) {
       this.endLine = worksheet.rowCount;
     }
-    if (this.startColumn === void 0) {
+    if (this.startColumn === void 0 || isNaN(this.startColumn) || this.startColumn < 0) {
       this.startColumn = 1;
     }
-    if (this.endColumn === void 0) {
+    if (this.endColumn === void 0 || isNaN(this.endColumn) || this.endColumn < 0) {
       this.endColumn = worksheet.columnCount;
     }
     return this;
@@ -3569,13 +3570,31 @@ var compileWorkSheetPlaceholder = function(ctx, sheet, result) {
   }
   return void 0;
 };
+var loadCompileSheets = (workbook, ruleSheetName) => {
+  let first;
+  let sheets = [];
+  for (const [_, w] of workbook.worksheets.entries()) {
+    if (w.name === ruleSheetName) {
+      continue;
+    }
+    if (first === "") {
+      first = w.name;
+    }
+    if (!w.name.endsWith(".json") && !w.name.endsWith(".config")) {
+      sheets.push(w.name);
+    }
+  }
+  if (sheets.length <= 0 && first !== "") {
+    sheets.push(first);
+  }
+  return sheets;
+};
 var compile = async function(data, ruleSheetName, options) {
   const workbook = await loadWorkbook(data);
   const sheet = workbook.getWorksheet(ruleSheetName);
   if (sheet === void 0) {
     return {
-      workbook,
-      errs: [new Error(`compile error, ${ruleSheetName} not exists!`)]
+      workbook
     };
   }
   if (workbook.worksheets === void 0) {
@@ -3588,6 +3607,10 @@ var compile = async function(data, ruleSheetName, options) {
     const excludes = [ruleSheetName];
     options = RuleMapOptions.withAllSheets(workbook, excludes);
   }
+  options = options.parseDefault(sheet);
+  if (options.compileSheets === void 0 || options.compileSheets.length === 0) {
+    options.compileSheets = loadCompileSheets(workbook, ruleSheetName);
+  }
   const result = parseWorkSheetRules(sheet, options);
   const errs = compileCheck(result, options);
   if (errs !== void 0) {
@@ -3650,6 +3673,9 @@ var fetchAlias = (m) => {
 };
 var removeUnExportSheets = (w, options) => {
   const removes = [];
+  if (typeof options.skipRemoveUnExportSheet === "boolean" && options.skipRemoveUnExportSheet === true) {
+    return w;
+  }
   if (options.compileSheets === void 0 || options.compileSheets.length <= 0) {
     for (const [i, v] of w.worksheets.entries()) {
       const sheetName = v.name;
@@ -3692,6 +3718,7 @@ ExprResolver.resolveCompileMacroGen = resolveCompileMacroGen;
 ExprResolver.resolveCompileMacroExpr = resolveCompileMacroExpr;
 
 // src/extends.ts
+var import_promises = __toESM(require("fs/promises"));
 function hasToString(obj) {
   return obj != null && typeof obj.toString === "function";
 }
@@ -3961,6 +3988,12 @@ var autoRegisterAlias = function(values, configure) {
   values[aliasKey] = alias;
   return values;
 };
+var saveCompile = async (compileOptions, wb) => {
+  if (typeof compileOptions.save === "boolean" && compileOptions.save === true && typeof compileOptions.saveFile === "string" && compileOptions.saveFile !== "") {
+    const path2 = compileOptions.saveFile;
+    await import_promises.default.writeFile(`${path2}compile_${(/* @__PURE__ */ new Date()).valueOf()}.xlsx`, wb);
+  }
+};
 var generateCommandsXlsxTemplateWithCompile = async function(data, values, compileOptions, options) {
   if (compileOptions.sheetName === void 0 || compileOptions.sheetName === "") {
     compileOptions.sheetName = compileRuleSheetName;
@@ -3972,6 +4005,7 @@ var generateCommandsXlsxTemplateWithCompile = async function(data, values, compi
   values = autoRegisterAlias(values, result.configure);
   result.workbook = ExprResolver.removeUnExportSheets(result.workbook, compileOptions);
   const wb = await ExprResolver.toBuffer(result.workbook);
+  await saveCompile(compileOptions, wb);
   const w = await Workbook.parse(wb, options);
   w.setQueryFunctionHandler(commandExtendQuery);
   await w.substituteAll(values);
@@ -4011,6 +4045,7 @@ var generateCommandsXlsxTemplateWithCompile = async function(data, values, compi
   hasGeneratorToken,
   isRuleToken,
   isUrl,
+  loadCompileSheets,
   loadWorkbook,
   mergeMap,
   parseWorkSheetRules,