@simplysm/excel 13.0.0-beta.7 → 13.0.1

package/src/xml/excel-xml-style.ts

@@ -0,0 +1,393 @@
+import type {
+  ExcelBorderPosition,
+  ExcelHorizontalAlign,
+  ExcelVerticalAlign,
+  ExcelXml,
+  ExcelXmlStyleData,
+  ExcelXmlStyleDataBorder,
+  ExcelXmlStyleDataFill,
+  ExcelXmlStyleDataXf,
+} from "../types";
+import "@simplysm/core-common";
+import { numParseInt, objClone, objEqual } from "@simplysm/core-common";
+
+export interface ExcelStyle {
+  numFmtId?: string;
+  numFmtCode?: string;
+  border?: ExcelBorderPosition[];
+  background?: string;
+  verticalAlign?: ExcelVerticalAlign;
+  horizontalAlign?: ExcelHorizontalAlign;
+}
+
+/**
+ * xl/styles.xml 파일을 관리하는 클래스.
+ * 숫자 형식, 배경색, 테두리, 정렬 등의 스타일을 처리한다.
+ */
+export class ExcelXmlStyle implements ExcelXml {
+  data: ExcelXmlStyleData;
+
+  constructor(data?: ExcelXmlStyleData) {
+    if (data === undefined) {
+      this.data = {
+        styleSheet: {
+          $: {
+            xmlns: "http://schemas.openxmlformats.org/spreadsheetml/2006/main",
+          },
+          fonts: [
+            {
+              $: { count: "1" },
+              font: [{}],
+            },
+          ],
+          fills: [
+            {
+              $: { count: "2" },
+              fill: [
+                { patternFill: [{ $: { patternType: "none" } }] },
+                { patternFill: [{ $: { patternType: "gray125" } }] },
+              ],
+            },
+          ],
+          borders: [
+            {
+              $: { count: "1" },
+              border: [{}],
+            },
+          ],
+          cellXfs: [
+            {
+              $: { count: "1" },
+              xf: [{ $: { numFmtId: "0" } }],
+            },
+          ],
+        },
+      };
+    } else {
+      this.data = data;
+    }
+  }
+
+  add(style: ExcelStyle): string {
+    const newXf: ExcelXmlStyleDataXf = { $: {} };
+
+    if (style.numFmtId !== undefined) {
+      newXf.$.numFmtId = style.numFmtId;
+    }
+
+    if (style.numFmtCode !== undefined) {
+      newXf.$.numFmtId = this._setNumFmtCode(style.numFmtCode);
+      newXf.$.applyNumberFormat = "1";
+    }
+
+    if (style.background !== undefined) {
+      const newFill: ExcelXmlStyleDataFill = {
+        patternFill: [
+          {
+            $: { patternType: "solid" },
+            fgColor: [{ $: { rgb: style.background.toUpperCase() } }],
+          },
+        ],
+      };
+
+      newXf.$.applyFill = "1";
+      newXf.$.fillId = this._getSameOrCreateFill(newFill);
+    }
+
+    if (style.border !== undefined) {
+      const newBorder = this._createBorderFromPositions(style.border);
+      newXf.$.applyBorder = "1";
+      newXf.$.borderId = this._getSameOrCreateBorder(newBorder);
+    }
+
+    this._applyAlignment(newXf, style);
+
+    return this._getSameOrCreateXf(newXf);
+  }
+
+  addWithClone(id: string, style: ExcelStyle): string {
+    const idNum = numParseInt(id);
+    if (idNum == null) {
+      throw new Error(`잘못된 스타일 ID: ${id}`);
+    }
+    const xfArray = this.data.styleSheet.cellXfs[0].xf;
+    if (idNum < 0 || idNum >= xfArray.length) {
+      throw new Error(`존재하지 않는 스타일 ID: ${id} (범위: 0-${xfArray.length - 1})`);
+    }
+    const prevXf = xfArray[idNum];
+    const cloneXf = objClone(prevXf);
+
+    if (style.numFmtId !== undefined) {
+      cloneXf.$.numFmtId = style.numFmtId;
+    }
+
+    if (style.numFmtCode !== undefined) {
+      cloneXf.$.numFmtId = this._setNumFmtCode(style.numFmtCode);
+      cloneXf.$.applyNumberFormat = "1";
+    }
+
+    if (style.background !== undefined) {
+      const fillIdNum = cloneXf.$.fillId !== undefined ? numParseInt(cloneXf.$.fillId) : undefined;
+      const prevFill = fillIdNum !== undefined ? this.data.styleSheet.fills[0].fill[fillIdNum] : undefined;
+
+      if (prevFill != null) {
+        const cloneFill = objClone(prevFill);
+        cloneFill.patternFill[0].$.patternType = "solid";
+
+        if (cloneFill.patternFill[0].fgColor == null) {
+          cloneFill.patternFill[0].fgColor = [{ $: { rgb: style.background } }];
+        } else {
+          cloneFill.patternFill[0].fgColor[0].$.rgb = style.background;
+        }
+
+        cloneXf.$.applyFill = "1";
+        cloneXf.$.fillId = this._getSameOrCreateFill(cloneFill);
+      } else {
+        const newFill: ExcelXmlStyleDataFill = {
+          patternFill: [
+            {
+              $: { patternType: "solid" },
+              fgColor: [{ $: { rgb: style.background.toUpperCase() } }],
+            },
+          ],
+        };
+        cloneXf.$.applyFill = "1";
+        cloneXf.$.fillId = this._getSameOrCreateFill(newFill);
+      }
+    }
+
+    if (style.border !== undefined) {
+      const borderIdNum = cloneXf.$.borderId !== undefined ? numParseInt(cloneXf.$.borderId) : undefined;
+      const prevBorder = borderIdNum !== undefined ? this.data.styleSheet.borders[0].border[borderIdNum] : undefined;
+
+      if (prevBorder != null) {
+        const cloneBorder = objClone(prevBorder);
+        this._applyBorderPosition(cloneBorder, "left", style.border.includes("left"));
+        this._applyBorderPosition(cloneBorder, "right", style.border.includes("right"));
+        this._applyBorderPosition(cloneBorder, "top", style.border.includes("top"));
+        this._applyBorderPosition(cloneBorder, "bottom", style.border.includes("bottom"));
+
+        cloneXf.$.applyBorder = "1";
+        cloneXf.$.borderId = this._getSameOrCreateBorder(cloneBorder);
+      } else {
+        const newBorder = this._createBorderFromPositions(style.border);
+        cloneXf.$.applyBorder = "1";
+        cloneXf.$.borderId = this._getSameOrCreateBorder(newBorder);
+      }
+    }
+
+    this._applyAlignment(cloneXf, style);
+
+    return this._getSameOrCreateXf(cloneXf);
+  }
+
+  get(id: string): ExcelStyle {
+    const idNum = numParseInt(id);
+    if (idNum == null) {
+      throw new Error(`잘못된 스타일 ID: ${id}`);
+    }
+    const xf = this.data.styleSheet.cellXfs[0].xf[idNum] as ExcelXmlStyleDataXf | undefined;
+
+    const result: ExcelStyle = {};
+
+    if (xf !== undefined) {
+      result.numFmtId = xf.$.numFmtId;
+
+      if (xf.$.fillId !== undefined) {
+        const fillIdNum = numParseInt(xf.$.fillId);
+        if (fillIdNum != null) {
+          const fill = this.data.styleSheet.fills[0].fill[fillIdNum] as ExcelXmlStyleDataFill | undefined;
+          if (fill == null) {
+            throw new Error(
+              `존재하지 않는 fill ID: ${xf.$.fillId} (범위: 0-${this.data.styleSheet.fills[0].fill.length - 1})`,
+            );
+          }
+          result.background = fill.patternFill[0].fgColor?.[0].$.rgb;
+        }
+      }
+
+      if (xf.$.borderId !== undefined) {
+        const borderIdNum = numParseInt(xf.$.borderId);
+        if (borderIdNum == null) {
+          throw new Error(`잘못된 border ID: ${xf.$.borderId}`);
+        }
+        const border = this.data.styleSheet.borders[0].border[borderIdNum] as ExcelXmlStyleDataBorder | undefined;
+        if (border == null) {
+          throw new Error(
+            `존재하지 않는 border ID: ${xf.$.borderId} (범위: 0-${this.data.styleSheet.borders[0].border.length - 1})`,
+          );
+        }
+        if (border.top != null || border.left != null || border.right != null || border.bottom != null) {
+          result.border = [];
+          if (border.left != null) {
+            result.border.push("left");
+          }
+          if (border.right != null) {
+            result.border.push("right");
+          }
+          if (border.top != null) {
+            result.border.push("top");
+          }
+          if (border.bottom != null) {
+            result.border.push("bottom");
+          }
+        }
+      }
+
+      result.verticalAlign = xf.alignment?.[0].$.vertical;
+      result.horizontalAlign = xf.alignment?.[0].$.horizontal;
+    }
+
+    return result;
+  }
+
+  getNumFmtCode(numFmtId: string): string | undefined {
+    return (this.data.styleSheet.numFmts?.[0].numFmt ?? []).single((item) => item.$.numFmtId === numFmtId)?.$
+      .formatCode;
+  }
+
+  cleanup(): void {
+    const result = {} as ExcelXmlStyleData["styleSheet"];
+
+    // 순서 정렬 (numFmts 맨위로)
+
+    if (this.data.styleSheet.numFmts != null) {
+      result.numFmts = this.data.styleSheet.numFmts;
+    }
+
+    const styleSheetRec = this.data.styleSheet as Record<string, unknown>;
+    const resultRec = result as Record<string, unknown>;
+    for (const key of Object.keys(styleSheetRec)) {
+      if (key === "numFmts") continue;
+
+      resultRec[key] = styleSheetRec[key];
+    }
+
+    this.data.styleSheet = result;
+  }
+
+  //#region Private Methods
+
+  private _setNumFmtCode(numFmtCode: string): string {
+    // 이미 해당 code가 있으면 넘기기
+    const existsNumFmtId = (this.data.styleSheet.numFmts?.[0].numFmt ?? []).single(
+      (item) => item.$.formatCode === numFmtCode,
+    )?.$.numFmtId;
+    if (existsNumFmtId != null) {
+      return existsNumFmtId;
+    }
+
+    this.data.styleSheet.numFmts = this.data.styleSheet.numFmts ?? [
+      {
+        $: { count: "0" },
+        numFmt: [],
+      },
+    ];
+
+    this.data.styleSheet.numFmts[0].numFmt = this.data.styleSheet.numFmts[0].numFmt ?? [];
+
+    // Excel 사용자 정의 숫자 형식은 ID 180 이상부터 시작한다 (0-163: 내장 형식, 164-179: 예약됨)
+    const numFmts = this.data.styleSheet.numFmts[0].numFmt;
+    const maxItem =
+      numFmts.length > 0 ? numFmts.orderByDesc((item) => numParseInt(item.$.numFmtId) ?? 180).first() : undefined;
+    const maxId = maxItem ? (numParseInt(maxItem.$.numFmtId) ?? 180) : 180;
+    const nextNumFmtId = (maxId + 1).toString();
+    this.data.styleSheet.numFmts[0].numFmt.push({
+      $: {
+        numFmtId: nextNumFmtId,
+        formatCode: numFmtCode,
+      },
+    });
+    this.data.styleSheet.numFmts[0].$.count = (
+      (numParseInt(this.data.styleSheet.numFmts[0].$.count) ?? 0) + 1
+    ).toString();
+
+    return nextNumFmtId;
+  }
+
+  private _applyAlignment(xf: ExcelXmlStyleDataXf, style: ExcelStyle): void {
+    if (style.verticalAlign !== undefined) {
+      xf.$.applyAlignment = "1";
+      if (xf.alignment == null) {
+        xf.alignment = [{ $: { vertical: style.verticalAlign } }];
+      } else {
+        xf.alignment[0].$.vertical = style.verticalAlign;
+      }
+    }
+
+    if (style.horizontalAlign !== undefined) {
+      xf.$.applyAlignment = "1";
+      if (xf.alignment == null) {
+        xf.alignment = [{ $: { horizontal: style.horizontalAlign } }];
+      } else {
+        xf.alignment[0].$.horizontal = style.horizontalAlign;
+      }
+    }
+  }
+
+  private _createBorderFromPositions(positions: ExcelBorderPosition[]): ExcelXmlStyleDataBorder {
+    return {
+      ...(positions.includes("left") ? { left: [{ $: { style: "thin" }, color: [{ $: { rgb: "00000000" } }] }] } : {}),
+      ...(positions.includes("right")
+        ? { right: [{ $: { style: "thin" }, color: [{ $: { rgb: "00000000" } }] }] }
+        : {}),
+      ...(positions.includes("top") ? { top: [{ $: { style: "thin" }, color: [{ $: { rgb: "00000000" } }] }] } : {}),
+      ...(positions.includes("bottom")
+        ? { bottom: [{ $: { style: "thin" }, color: [{ $: { rgb: "00000000" } }] }] }
+        : {}),
+    };
+  }
+
+  private _applyBorderPosition(border: ExcelXmlStyleDataBorder, position: ExcelBorderPosition, enabled: boolean): void {
+    if (enabled) {
+      const existing = border[position];
+      if (existing == null) {
+        border[position] = [{ $: { style: "thin" }, color: [{ $: { rgb: "00000000" } }] }];
+      } else if (existing[0].color == null) {
+        existing[0].color = [{ $: { rgb: "00000000" } }];
+      } else {
+        existing[0].color[0].$.rgb = "00000000";
+      }
+    } else {
+      delete border[position];
+    }
+  }
+
+  private _getSameOrCreateXf(xfItem: ExcelXmlStyleDataXf): string {
+    const prevSameXf = this.data.styleSheet.cellXfs[0].xf.single((item) => objEqual(item, xfItem));
+
+    if (prevSameXf != null) {
+      return this.data.styleSheet.cellXfs[0].xf.indexOf(prevSameXf).toString();
+    } else {
+      this.data.styleSheet.cellXfs[0].xf.push(xfItem);
+      this.data.styleSheet.cellXfs[0].$.count = this.data.styleSheet.cellXfs[0].xf.length.toString();
+      return (this.data.styleSheet.cellXfs[0].xf.length - 1).toString();
+    }
+  }
+
+  private _getSameOrCreateFill(fillItem: ExcelXmlStyleDataFill): string {
+    const prevSameFill = this.data.styleSheet.fills[0].fill.single((item) => objEqual(item, fillItem));
+
+    if (prevSameFill != null) {
+      return this.data.styleSheet.fills[0].fill.indexOf(prevSameFill).toString();
+    } else {
+      this.data.styleSheet.fills[0].fill.push(fillItem);
+      this.data.styleSheet.fills[0].$.count = this.data.styleSheet.fills[0].fill.length.toString();
+      return (this.data.styleSheet.fills[0].fill.length - 1).toString();
+    }
+  }
+
+  private _getSameOrCreateBorder(borderItem: ExcelXmlStyleDataBorder): string {
+    const prevSameBorder = this.data.styleSheet.borders[0].border.single((item) => objEqual(item, borderItem));
+
+    if (prevSameBorder != null) {
+      return this.data.styleSheet.borders[0].border.indexOf(prevSameBorder).toString();
+    } else {
+      this.data.styleSheet.borders[0].border.push(borderItem);
+      this.data.styleSheet.borders[0].$.count = this.data.styleSheet.borders[0].border.length.toString();
+      return (this.data.styleSheet.borders[0].border.length - 1).toString();
+    }
+  }
+
+  //#endregion
+}

package/src/xml/excel-xml-unknown.ts

@@ -0,0 +1,11 @@
+import type { ExcelXml } from "../types";
+
+/**
+ * 알 수 없는 형식의 Excel XML 데이터를 보존하는 클래스.
+ * 원본 데이터를 손실 없이 유지한다.
+ */
+export class ExcelXmlUnknown implements ExcelXml {
+  constructor(public readonly data: Record<string, unknown>) {}
+
+  cleanup(): void {}
+}

package/src/xml/excel-xml-workbook.ts

@@ -0,0 +1,112 @@
+import "@simplysm/core-common";
+import { numParseInt } from "@simplysm/core-common";
+import type { ExcelXml, ExcelXmlWorkbookData } from "../types";
+
+/**
+ * xl/workbook.xml 파일을 관리하는 클래스.
+ * 워크시트 목록과 관계 ID를 처리한다.
+ */
+export class ExcelXmlWorkbook implements ExcelXml {
+  data: ExcelXmlWorkbookData;
+
+  constructor(data?: ExcelXmlWorkbookData) {
+    if (data === undefined) {
+      this.data = {
+        workbook: {
+          $: {
+            "xmlns": "http://schemas.openxmlformats.org/spreadsheetml/2006/main",
+            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+          },
+        },
+      };
+    } else {
+      this.data = data;
+    }
+  }
+
+  get lastWsRelId(): number | undefined {
+    const sheets = this.data.workbook.sheets?.[0].sheet;
+    if (!sheets || sheets.length === 0) return undefined;
+    const maxSheet = sheets.orderByDesc((sheet) => numParseInt(sheet.$["r:id"])!).first();
+    return maxSheet ? numParseInt(maxSheet.$["r:id"]) : undefined;
+  }
+
+  get sheetNames(): string[] {
+    return this.data.workbook.sheets?.[0].sheet.map((item) => item.$.name) ?? [];
+  }
+
+  addWorksheet(name: string): this {
+    const replacedName = this._getReplacedName(name);
+
+    const newWsRelId = (this.lastWsRelId ?? 0) + 1;
+
+    this.data.workbook.sheets = this.data.workbook.sheets ?? [{ sheet: [] }];
+    this.data.workbook.sheets[0].sheet.push({
+      $: {
+        "name": replacedName,
+        "sheetId": newWsRelId.toString(),
+        "r:id": `rId${newWsRelId}`,
+      },
+    });
+
+    return this;
+  }
+
+  cleanup(): void {
+    const result = {} as ExcelXmlWorkbookData["workbook"];
+
+    // 순서 정렬 ("sheets"기준 앞뒤로, 나머지는 원래위치대로)
+
+    const workbookRec = this.data.workbook as Record<string, unknown>;
+    const resultRec = result as Record<string, unknown>;
+
+    for (const key of Object.keys(this.data.workbook)) {
+      if (key === "bookViews") continue;
+
+      if (key === "sheets") {
+        if (this.data.workbook.bookViews != null) {
+          result.bookViews = this.data.workbook.bookViews;
+        }
+        result.sheets = this.data.workbook.sheets;
+      } else {
+        resultRec[key] = workbookRec[key];
+      }
+    }
+
+    this.data.workbook = result;
+  }
+
+  initializeView(): void {
+    this.data.workbook.bookViews = this.data.workbook.bookViews ?? [{ workbookView: [{}] }];
+  }
+
+  getWsRelIdByName(name: string): number | undefined {
+    return numParseInt((this.data.workbook.sheets?.[0].sheet ?? []).single((item) => item.$.name === name)?.$["r:id"]);
+  }
+
+  getWsRelIdByIndex(index: number): number | undefined {
+    return numParseInt(this.data.workbook.sheets?.[0].sheet[index]?.$["r:id"]);
+  }
+
+  getWorksheetNameById(id: number): string | undefined {
+    return this._getSheetDataById(id)?.$.name;
+  }
+
+  setWorksheetNameById(id: number, newName: string): void {
+    const sheetData = this._getSheetDataById(id);
+    if (sheetData == null) {
+      throw new Error(`워크시트 ID ${id}를 찾을 수 없습니다`);
+    }
+    const replacedName = this._getReplacedName(newName);
+    sheetData.$.name = replacedName;
+  }
+
+  private _getSheetDataById(id: number) {
+    return (this.data.workbook.sheets?.[0].sheet ?? []).single((item) => numParseInt(item.$["r:id"]) === id);
+  }
+
+  private _getReplacedName(name: string): string {
+    //-- 시트명칭 사용불가 텍스트를 "_"로 변환
+    return name.replace(/[:\\/?*\[\]']/g, "_");
+  }
+}