fix: add Buffer data type

Author: m.r

_test_/src/read.ts

@@ -6,36 +6,32 @@ interface ExtractResult {
   [sheetName: string]: ExtractedData;
 }
 function hasTBeforeV(element: string) {
-  // Use regular expression to find 't="s"' before <v>
   const regex = /t="s".*?<v/;
   return regex.test(element);
 }
 function getValueWithinT(element: string) {
-  // Use regular expression to extract the content between <v> and </v>
   const regex = /<t.*?>(.*?)<\/t>/;
   const match = element.match(regex);
   if (match) {
-    return match[1]; // Extracted value
+    return match[1];
   }
-  return null; // Return null if <v> tag is not found
+  return null;
 }
 function getValueWithinV(element: string) {
-  // Use regular expression to extract the content between <v> and </v>
   const regex = /<v.*?>(.*?)<\/v>/;
   const match = element.match(regex);
   if (match) {
-    return match[1]; // Extracted value
+    return match[1];
   }
-  return null; // Return null if <v> tag is not found
+  return null;
 }
 function getRValue(element: string) {
-  // Use regular expression to extract the 'r' attribute value
   const regex = /r="(.*?)"/;
   const match = element.match(regex);
   if (match) {
-    return match[1]; // Extracted 'r' value
+    return match[1];
   }
-  return null; // Return null if 'r' attribute is not found
+  return null;
 }
 export async function readGeneratedFile(
   data: unknown,
@@ -124,8 +120,7 @@ export async function readGeneratedFile(
                 if (prop === "isNameSet") {
                   return target.isNameSet;
                 }
-                // By default, it looks like Reflect.get(target, prop, receiver)
-                // which has a different value of `this`
+
                 return target.counter;
               },
             }

_test_/src/utils.ts

@@ -2,15 +2,8 @@ export function countOccurrences(
   mainString: string,
   subString: string
 ): number {
-  // Escape special characters in the substring for regex
   const escapedSubstring = subString.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-
-  // Construct the regular expression using the escaped substring
   const regex = new RegExp(escapedSubstring, "g");
-
-  // Use match() to find all occurrences of the substring in the main string
   const matches = mainString.match(regex);
-
-  // Return the count of occurrences (or 0 if no matches were found)
   return matches ? matches.length : 0;
 }

dist/excel-table.d.ts

@@ -42,6 +42,23 @@ declare type BorderOption = {
     };
 };
 
+declare class Buffer_2 extends Uint8Array {
+    constructor(str: string, encoding?: string);
+    constructor(size: number);
+    constructor(array: Uint8Array);
+    constructor(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number);
+    static alloc(size: number, fill?: string | Buffer_2 | number, encoding?: string): Buffer_2;
+    static from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer_2;
+    static from(data: number[]): Buffer_2;
+    static from(str: string, encoding?: string): Buffer_2;
+    write(string: string, offset?: number, length?: number, encoding?: string): number;
+    toString(encoding?: string, start?: number, end?: number): string;
+    slice(start?: number, end?: number): Buffer_2;
+    static concat(list: Buffer_2[], totalLength?: number): Buffer_2;
+    length: number;
+    byteOffset: number;
+}
+
 declare interface Checkbox {
     col: number;
     row: number;
@@ -94,7 +111,7 @@ export declare function convertTableToExcel(queryForTable?: string, table?: HTML
     keepStyle?: boolean;
     rowHeightScaleFunction?: RowHeightScaleFunction;
     colWidthScaleFunction?: ColWidthScaleFunction;
-}): Promise<string | number[] | Blob | Buffer | undefined>;
+}): Promise<string | number[] | DataModel.Buffer | Blob | undefined>;
 
 declare interface CustomFormulaSetting {
     isArray?: boolean;
@@ -171,7 +188,8 @@ declare namespace DataModel {
         ThemeOption,
         ExtractedData,
         ExtractResult,
-        ReadResult
+        ReadResult,
+        Buffer_2 as Buffer
     }
 }
 export { DataModel }
@@ -261,7 +279,7 @@ declare function generalValidationCheck(value: never, validateProperty: Validati
 
 export declare function generateCSV(excelTable: ExcelTable, asZip?: boolean): Promise<string[] | "done" | undefined>;
 
-export declare function generateExcel(data: ExcelTable, styleKey?: string): Promise<string | number[] | Blob | Buffer | undefined>;
+export declare function generateExcel(data: ExcelTable, styleKey?: string): Promise<string | number[] | Blob | Buffer_2 | undefined>;
 
 export declare function generateText(excelTable: ExcelTable, asZip?: boolean): Promise<string[] | "done" | undefined>;
 
@@ -450,7 +468,7 @@ declare interface SideBySide {
     headerIndex?: number;
 }
 
-export declare function sideBySideLineByLine(data: SideBySide[][]): Promise<string | number[] | Blob | Buffer | undefined>;
+export declare function sideBySideLineByLine(data: SideBySide[][]): Promise<string | number[] | DataModel.Buffer | Blob | undefined>;
 
 declare interface SingleRefFormulaSetting {
     type: SingleRefFormulaType;
@@ -522,7 +540,7 @@ declare interface Styles {
 
 declare type StyleType = "conditionalFormatting" | "CF" | "headerFooter" | "HF";
 
-export declare function themeBaseGenerate(data: ExcelTable | Data[] | Data[][], option?: ThemeOption): Promise<string | number[] | Blob | Buffer | undefined>;
+export declare function themeBaseGenerate(data: ExcelTable | Data[] | Data[][], option?: ThemeOption): Promise<string | number[] | DataModel.Buffer | Blob | undefined>;
 
 declare interface ThemeOption {
     negativeColor?: boolean;

src/data-model/excel-table.ts

@@ -510,3 +510,35 @@ export interface ReadResult {
   sheetName: IterableIterator<[string, string]>;
   maxLengthOfColumn: Record<string, number>;
 }
+export declare class Buffer extends Uint8Array {
+  constructor(str: string, encoding?: string);
+  constructor(size: number);
+  constructor(array: Uint8Array);
+  constructor(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number);
+
+  static alloc(
+    size: number,
+    fill?: string | Buffer | number,
+    encoding?: string
+  ): Buffer;
+  static from(
+    arrayBuffer: ArrayBuffer,
+    byteOffset?: number,
+    length?: number
+  ): Buffer;
+  static from(data: number[]): Buffer;
+  static from(str: string, encoding?: string): Buffer;
+
+  write(
+    string: string,
+    offset?: number,
+    length?: number,
+    encoding?: string
+  ): number;
+  toString(encoding?: string, start?: number, end?: number): string;
+  slice(start?: number, end?: number): Buffer;
+  static concat(list: Buffer[], totalLength?: number): Buffer;
+
+  length: number;
+  byteOffset: number;
+}

src/functions/generate-excel.ts

@@ -9,9 +9,9 @@ import {
   type ProtectionOptionKey,
   type RowMap,
   type StyleMapper,
+  type Buffer,
 } from "../data-model/excel-table";
 import { generateColumnName } from "../utils/generate-column-name";
-
 import { styleGenerator } from "../utils/content-generator/styles";
 import { contentTypeGenerator } from "../utils/content-generator/content-types";
 import { appGenerator } from "../utils/content-generator/app";
@@ -32,7 +32,10 @@ import { getColRowBaseOnRefString } from "../utils/excel-util";
 import { specialCharacterConverter } from "../utils/special-character";
 import { applyConfig } from "../utils/store";
 import type JSZip from "jszip";
-export async function generateExcel(data: ExcelTable, styleKey: string = "") {
+export async function generateExcel(
+  data: ExcelTable,
+  styleKey: string = ""
+): Promise<string | number[] | Blob | Buffer | undefined> {
   if (typeof styleKey == "string" && styleKey.length > 0) {
     data = applyConfig(styleKey, data);
   }
@@ -71,8 +74,8 @@ export async function generateExcel(data: ExcelTable, styleKey: string = "") {
     cols = generateColumnName(cols, data.numberOfColumn);
   }
   const module = await import("jszip");
-  const JSZip = module.default;
-  let zip = new JSZip();
+  const JSZip1 = module.default;
+  let zip = new JSZip1();
   const sheetLength = data.sheet.length;
   // xl
   let xlFolder = zip.folder("xl");
@@ -2645,7 +2648,7 @@ export async function generateExcel(data: ExcelTable, styleKey: string = "") {
         type: data.generateType ? data.generateType : "nodebuffer",
       })
       .then((content) => {
-        return content;
+        return content as string | number[] | Buffer;
       });
   } else {
     if (data.notSave) {