@vdhewei/xlsx-template-lib 1.4.3 → 1.5.0

package/dist/index.d.mts

@@ -470,5 +470,35 @@ declare const compileRuleSheetName = "export_metadata.config";
 declare const mergeMap: (source: Map<string, string>, dest: Map<string, string>) => 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]>;
+declare const compileAll: (buf: Buffer, compileOpts: AutoOptions, renderData?: Object) => Promise<Buffer>;
 
-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, toCellValue, valueDotGet, workSheetSetPlaceholder };
+type CustomChecker = (data: Buffer, options: FullOptions & {
+    [key: string]: any;
+}, values: Object, fileName?: string) => Promise<Buffer>;
+type CustomCheckerOptions = {
+    checker?: CustomChecker;
+    options?: FullOptions;
+    [key: string]: any;
+};
+declare class XlsxRender extends Workbook {
+    constructor(option?: FullOptions);
+    static create(data: Buffer, option?: FullOptions): Promise<XlsxRender>;
+    render(values: Object, sheetName: string): Promise<void>;
+    getSheets(): SheetInfo[];
+}
+declare class ZipXlsxTemplateApp {
+    zipBuffer?: Buffer;
+    private zip;
+    private xlsxEntries;
+    private records;
+    constructor(data?: Buffer);
+    loadZipBuffer(data: Buffer): ZipXlsxTemplateApp;
+    parse(data: Buffer): Map<string, Buffer>;
+    getEntries(): Map<string, Buffer>;
+    static compileAll(files: Map<string, Buffer>, renderData?: Object, compileOpts?: AutoOptions): Promise<Map<string, Buffer>>;
+    substituteAll(renderData: Object, compileOpts?: AutoOptions, renderOpts?: FullOptions): Promise<ZipXlsxTemplateApp>;
+    generate(options?: JsZip.JSZipGeneratorOptions<BufferType.NodeBuffer> & FullOptions): Promise<Buffer>;
+    static compileTo(data: Buffer, opts: CustomCheckerOptions, values?: Record<string, any> | Object): Promise<Buffer>;
+}
+
+export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomChecker, 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, XlsxRender, ZipXlsxTemplateApp, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileAll, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadCompileSheets, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, toCellValue, valueDotGet, workSheetSetPlaceholder };

package/dist/index.d.ts

@@ -470,5 +470,35 @@ declare const compileRuleSheetName = "export_metadata.config";
 declare const mergeMap: (source: Map<string, string>, dest: Map<string, string>) => 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]>;
+declare const compileAll: (buf: Buffer, compileOpts: AutoOptions, renderData?: Object) => Promise<Buffer>;
 
-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, toCellValue, valueDotGet, workSheetSetPlaceholder };
+type CustomChecker = (data: Buffer, options: FullOptions & {
+    [key: string]: any;
+}, values: Object, fileName?: string) => Promise<Buffer>;
+type CustomCheckerOptions = {
+    checker?: CustomChecker;
+    options?: FullOptions;
+    [key: string]: any;
+};
+declare class XlsxRender extends Workbook {
+    constructor(option?: FullOptions);
+    static create(data: Buffer, option?: FullOptions): Promise<XlsxRender>;
+    render(values: Object, sheetName: string): Promise<void>;
+    getSheets(): SheetInfo[];
+}
+declare class ZipXlsxTemplateApp {
+    zipBuffer?: Buffer;
+    private zip;
+    private xlsxEntries;
+    private records;
+    constructor(data?: Buffer);
+    loadZipBuffer(data: Buffer): ZipXlsxTemplateApp;
+    parse(data: Buffer): Map<string, Buffer>;
+    getEntries(): Map<string, Buffer>;
+    static compileAll(files: Map<string, Buffer>, renderData?: Object, compileOpts?: AutoOptions): Promise<Map<string, Buffer>>;
+    substituteAll(renderData: Object, compileOpts?: AutoOptions, renderOpts?: FullOptions): Promise<ZipXlsxTemplateApp>;
+    generate(options?: JsZip.JSZipGeneratorOptions<BufferType.NodeBuffer> & FullOptions): Promise<Buffer>;
+    static compileTo(data: Buffer, opts: CustomCheckerOptions, values?: Record<string, any> | Object): Promise<Buffer>;
+}
+
+export { AddCommand, AddCommandMust, type AfterReplaceHook, type Argument, ArgumentData, ArgumentValue, ArgumentValueLoader, type AutoOptions, type BeforeReplaceHook, BufferType, type CellPosition, type CmdFunction, CompileContext, type CompileResult, type CustomChecker, 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, XlsxRender, ZipXlsxTemplateApp, autoRegisterAlias, columnLetterToNumber, columnNumberToLetter, commandExtendQuery, compileAll, compileRuleSheetName, compileWorkSheet, compileWorkSheetPlaceholder, defaultExtractPlaceholders, defaultFormatters, defaultValueDotGet, generateCommandsXlsxTemplate, generateCommandsXlsxTemplateWithCompile, generateXlsxTemplate, getCommands, getTokenParser, hasGeneratorToken, isRuleToken, isUrl, loadCompileSheets, loadWorkbook, mergeMap, parseWorkSheetRules, registerTokenParser, registerTokenParserMust, resolveArgument, scanCellSetPlaceholder, toArrayBuffer, toCellValue, valueDotGet, workSheetSetPlaceholder };

package/dist/index.js

@@ -43,10 +43,13 @@ __export(index_exports, {
   RuleToken: () => RuleToken,
   TokenParserManger: () => TokenParserManger,
   Workbook: () => Workbook,
+  XlsxRender: () => XlsxRender,
+  ZipXlsxTemplateApp: () => ZipXlsxTemplateApp,
   autoRegisterAlias: () => autoRegisterAlias,
   columnLetterToNumber: () => columnLetterToNumber,
   columnNumberToLetter: () => columnNumberToLetter,
   commandExtendQuery: () => commandExtendQuery,
+  compileAll: () => compileAll,
   compileRuleSheetName: () => compileRuleSheetName,
   compileWorkSheet: () => compileWorkSheet,
   compileWorkSheetPlaceholder: () => compileWorkSheetPlaceholder,
@@ -4061,6 +4064,170 @@ var generateCommandsXlsxTemplateWithCompile = async function(data, values, compi
   await w.substituteAll(values);
   return w.generate(options);
 };
+var compileAll = async (buf, compileOpts, renderData) => {
+  if (compileOpts === void 0 || compileOpts.sheetName === "") {
+    return buf;
+  }
+  const result = await ExprResolver.compile(buf, compileOpts.sheetName, compileOpts);
+  if (result.errs !== void 0 && result.errs.length > 0) {
+    throw result.errs[0];
+  }
+  if (compileOpts.remove !== void 0 && compileOpts.remove === true) {
+    result.workbook = ExprResolver.removeUnExportSheets(result.workbook, compileOpts);
+  }
+  if (renderData !== void 0) {
+    autoRegisterAlias(renderData, result.configure);
+  }
+  return await ExprResolver.toBuffer(result.workbook);
+};
+
+// src/biz.ts
+var import_node_path = require("path");
+var import_lodash = require("lodash");
+var import_adm_zip = __toESM(require("adm-zip"));
+var XlsxRender = class _XlsxRender extends Workbook {
+  constructor(option) {
+    super(option);
+  }
+  static async create(data, option) {
+    const w = await super.parse(data, option);
+    w.setQueryFunctionHandler(commandExtendQuery);
+    const app = new _XlsxRender(option);
+    Object.assign(app, { ...w });
+    return app;
+  }
+  async render(values, sheetName) {
+    await this.substitute(sheetName, values);
+  }
+  getSheets() {
+    return this.sheets;
+  }
+};
+var ZipXlsxTemplateApp = class _ZipXlsxTemplateApp {
+  constructor(data) {
+    this.records = /* @__PURE__ */ new Map();
+    this.zipBuffer = data;
+    if (data !== void 0) {
+      this.xlsxEntries = this.parse(data);
+    }
+  }
+  loadZipBuffer(data) {
+    this.zipBuffer = data;
+    this.zip = new import_adm_zip.default(data);
+    this.xlsxEntries = this.parse(data);
+    return this;
+  }
+  parse(data) {
+    const zip = new import_adm_zip.default(data);
+    const result = /* @__PURE__ */ new Map();
+    const entries = zip.getEntries();
+    for (let fd of entries) {
+      if (fd.isDirectory) {
+        continue;
+      }
+      let ext = (0, import_node_path.extname)(fd.entryName).substring(1).toLowerCase();
+      if (ext !== "xlsx") {
+        continue;
+      }
+      result.set(fd.entryName, fd.getData());
+    }
+    this.zip = zip;
+    return result;
+  }
+  getEntries() {
+    if (this.xlsxEntries !== void 0 && this.xlsxEntries.size > 0) {
+      return this.xlsxEntries;
+    } else {
+      if (this.zipBuffer !== void 0) {
+        return this.parse(this.zipBuffer);
+      }
+    }
+    return /* @__PURE__ */ new Map();
+  }
+  static async compileAll(files, renderData, compileOpts) {
+    const records = /* @__PURE__ */ new Map();
+    if (compileOpts !== void 0 && (compileOpts.sheetName === void 0 || compileOpts.sheetName === "")) {
+      compileOpts.sheetName = compileRuleSheetName;
+    }
+    let values = (0, import_lodash.clone)(renderData);
+    for (let [key, buf] of files.entries()) {
+      buf = await compileAll(buf, (0, import_lodash.clone)(compileOpts), (0, import_lodash.clone)(values));
+      records.set(key, buf);
+    }
+    return records;
+  }
+  async substituteAll(renderData, compileOpts, renderOpts) {
+    const files = await _ZipXlsxTemplateApp.compileAll(this.xlsxEntries, renderData, compileOpts);
+    for (const [k, buf] of files.entries()) {
+      const xlsx = await XlsxRender.create(buf, renderOpts);
+      await xlsx.substituteAll(renderData);
+      this.records.set(k, xlsx);
+    }
+    return this;
+  }
+  async generate(options) {
+    if (this.records === void 0 || this.records.size <= 0) {
+      return this.zipBuffer;
+    }
+    if (this.zip === void 0) {
+      this.zip = new import_adm_zip.default();
+    }
+    if (options === void 0 || options === null) {
+      options = {
+        type: "nodebuffer" /* NodeBuffer */,
+        compression: "DEFLATE",
+        compressionOptions: {
+          level: 9
+        }
+      };
+    }
+    for (const [key, xlsx] of this.records) {
+      const buf = await xlsx.generate(options);
+      let entry = this.zip.getEntry(key);
+      if (entry !== null) {
+        entry.setData(Buffer.from(buf));
+      } else {
+        this.zip.addFile(key, Buffer.from(buf));
+      }
+    }
+    return this.zip.toBuffer();
+  }
+  static async compileTo(data, opts, values) {
+    const zip = new import_adm_zip.default(data);
+    const entries = zip.getEntries();
+    let files = /* @__PURE__ */ new Map();
+    if (values === void 0) {
+      values = /* @__PURE__ */ new Map();
+    }
+    for (let fd of entries) {
+      if (fd.isDirectory) {
+        continue;
+      }
+      let ext = (0, import_node_path.extname)(fd.entryName).substring(1).toLowerCase();
+      if (ext !== "xlsx") {
+        continue;
+      }
+      let buf = fd.getData();
+      if (opts.checker !== void 0) {
+        await opts.checker(buf, opts.options, values, opts.fileName || void 0);
+      }
+      files.set(fd.entryName, buf);
+    }
+    const compileOpts = new RuleMapOptions();
+    compileOpts.remove = true;
+    if (files.size > 0) {
+      files = await _ZipXlsxTemplateApp.compileAll(files, values, compileOpts);
+    } else {
+      throw new Error(`empty xlsx file zip file`);
+    }
+    if (files.size > 0) {
+      for (const [k, data2] of files.entries()) {
+        zip.getEntry(k).setData(data2);
+      }
+    }
+    return zip.toBuffer();
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddCommand,
@@ -4076,10 +4243,13 @@ var generateCommandsXlsxTemplateWithCompile = async function(data, values, compi
   RuleToken,
   TokenParserManger,
   Workbook,
+  XlsxRender,
+  ZipXlsxTemplateApp,
   autoRegisterAlias,
   columnLetterToNumber,
   columnNumberToLetter,
   commandExtendQuery,
+  compileAll,
   compileRuleSheetName,
   compileWorkSheet,
   compileWorkSheetPlaceholder,