@4399ywkf/editor 0.5.0 → 0.7.0

package/dist/xlsx.d.ts

@@ -1,179 +1,5 @@
-/**
- * Univer 快照的结构化镜像。
- *
- * 为什么不直接 `import type { IWorkbookData } from "@univerjs/core"`：
- * 那是**可选 peer**。没装 `@univerjs/presets` 的项目一解析不到这个模块，
- * 整个包的 typecheck 就红了 —— 而「拿快照出 xlsx」恰恰是最不该逼人装 871KB
- * 渲染引擎的场景（服务端定时导出、Node 里跑批都只有 JSON）。
- *
- * 所以这里只声明导出真正读到的字段，字段名与取值语义和 `@univerjs/core`
- * 逐一对齐。Univer 加字段不会影响这里；改字段含义会 —— 那种时候本文件是
- * 唯一需要改的地方。
- */
-type CellValue = string | number | boolean;
-interface ColorStyle {
-    /** `#RRGGBB` / `rgb(r,g,b)` / `rgba(r,g,b,a)` */
-    rgb?: string | null;
-    /** 主题色 token。xlsx 侧解析不了，直接忽略 */
-    th?: number;
-}
-/** 下划线 / 删除线 / 上划线 */
-interface TextDecorationData {
-    /** 0 关 1 开 */
-    s?: number;
-    cl?: ColorStyle | null;
-    t?: number;
-}
-interface BorderStyleData {
-    /** 对齐 `BorderStyleTypes` */
-    s?: number;
-    cl?: ColorStyle | null;
-}
-interface BorderData {
-    t?: BorderStyleData | null;
-    r?: BorderStyleData | null;
-    b?: BorderStyleData | null;
-    l?: BorderStyleData | null;
-}
-interface TextRotation {
-    /** 角度，-90 ~ 90，正数逆时针 */
-    a?: number;
-    /** 1 = 竖排 */
-    v?: number;
-}
-interface StyleData {
-    /** fontFamily */
-    ff?: string | null;
-    /** fontSize，pt */
-    fs?: number;
-    /** italic */
-    it?: number;
-    /** bold */
-    bl?: number;
-    /** underline */
-    ul?: TextDecorationData | null;
-    /** strikethrough */
-    st?: TextDecorationData | null;
-    /** overline —— xlsx 没有对应表达 */
-    ol?: TextDecorationData | null;
-    /** background */
-    bg?: ColorStyle | null;
-    /** border */
-    bd?: BorderData | null;
-    /** font color */
-    cl?: ColorStyle | null;
-    /** 上下标 */
-    va?: number | null;
-    /** 数字格式 */
-    n?: {
-        pattern?: string;
-    } | null;
-    /** textRotation */
-    tr?: TextRotation | null;
-    /** horizontalAlign */
-    ht?: number | null;
-    /** verticalAlign */
-    vt?: number | null;
-    /** wrapStrategy */
-    tb?: number | null;
-}
-/** 富文本单元格。导出只取纯文本 —— xlsx 的富文本要拆成 `<si><r>` 段，收益不抵复杂度 */
-interface RichTextData {
-    body?: {
-        dataStream?: string;
-    } | null;
-}
-interface CellData {
-    v?: CellValue | null;
-    /** 对齐 `CellValueType` */
-    t?: number | null;
-    /** 原始公式，含前导 `=` */
-    f?: string | null;
-    /** 共享公式组 id。同组里只有一个单元格带 `f` */
-    si?: string | null;
-    /** 数组公式的引用范围 */
-    ref?: string | null;
-    /** 样式 id 或内联样式 */
-    s?: StyleData | string | null;
-    /** 富文本 */
-    p?: RichTextData | null;
-}
-interface RowData {
-    /** 高度 px */
-    h?: number;
-    /** 自适应高度 px，`ia` 为 1 时用它 */
-    ah?: number;
-    /** 是否自适应 */
-    ia?: number;
-    /** 隐藏 */
-    hd?: number;
-    s?: StyleData | string | null;
-}
-interface ColumnData {
-    /** 宽度 px */
-    w?: number;
-    hd?: number;
-    s?: StyleData | string | null;
-}
-interface CellRange {
-    startRow: number;
-    startColumn: number;
-    endRow: number;
-    endColumn: number;
-}
-interface FreezeData {
-    /** 冻结列数 */
-    xSplit: number;
-    /** 冻结行数 */
-    ySplit: number;
-    startRow: number;
-    startColumn: number;
-}
-/** `IObjectMatrixPrimitiveType<T>`：行号 → 列号 → 值，两层都是稀疏对象 */
-type Matrix<T> = Record<number, Record<number, T> | undefined>;
-interface WorksheetData {
-    id?: string;
-    name?: string;
-    /** `#RRGGBB` */
-    tabColor?: string;
-    /** 1 = 隐藏 */
-    hidden?: number;
-    freeze?: FreezeData;
-    rowCount?: number;
-    columnCount?: number;
-    /** px */
-    defaultColumnWidth?: number;
-    /** px */
-    defaultRowHeight?: number;
-    mergeData?: CellRange[];
-    cellData?: Matrix<CellData>;
-    rowData?: Record<number, RowData | undefined>;
-    columnData?: Record<number, ColumnData | undefined>;
-    /** 0 = 不显示网格线 */
-    showGridlines?: number;
-    /** 1 = 从右向左 */
-    rightToLeft?: number;
-    defaultStyle?: StyleData | string | null;
-}
-interface WorkbookData {
-    id?: string;
-    name?: string;
-    /** 工作表顺序。缺省时按 `sheets` 的键序 */
-    sheetOrder?: string[];
-    sheets?: Record<string, WorksheetData | undefined>;
-    /** 样式表：`CellData.s` 为字符串时查这里 */
-    styles?: Record<string, StyleData | null | undefined>;
-    defaultStyle?: StyleData | string | null;
-    /**
-     * 各插件自己序列化的数据（图片、条件格式、数据校验、筛选……）。
-     * 导出读不了它们的私有结构，但**能据此如实报告丢了什么** —— 见 `warnings`。
-     */
-    resources?: Array<{
-        id?: string;
-        name: string;
-        data: string;
-    }>;
-}
+import { W as WorkbookData, a as CsvParseOptions } from './csv-parse-D0zTBvDB.js';
+export { C as CellData, e as CellRange, f as CellValue, g as ColumnData, b as CsvToSnapshotResult, R as RowData, S as StyleData, c as WorksheetData, d as csvToSnapshot, p as parseCsv } from './csv-parse-D0zTBvDB.js';
 
 /**
  * Univer 快照 → xlsx 的各个 XML 部件。
@@ -218,10 +44,121 @@ interface SerializeXlsxResult {
 declare function serializeXlsx(workbook: WorkbookData, options?: SerializeXlsxOptions): SerializeXlsxResult;
 
 /**
- * `@4399ywkf/editor/xlsx` —— 表格导出。
+ * 解析 OOXML 用的 DOM 小工具。
+ *
+ * 只用 DOM Level 2 的接口（firstChild / nextSibling / getAttribute），
+ * 浏览器原生 DOMParser 和 @xmldom/xmldom 的产物都吃 —— 不用 querySelector
+ * 是因为 xmldom 没有它，且命名空间前缀会让选择器在两边行为不一致。
+ */
+/** 注入式 DOMParser 的最小面：浏览器传原生的，Node 传 @xmldom/xmldom 的 */
+interface DomParserLike {
+    new (): {
+        parseFromString(source: string, mimeType: string): Document;
+    };
+}
+
+/**
+ * xlsx / csv 导入的入口 —— 把「拿到手的东西」变成 Univer 快照。
  *
- * 和 `./docx` 同一套思路：**在本地生成，文档不出内网**，不依赖任何转换服务，
- * 也不引 SheetJS —— 打包只多出 fflate（本来就有）和这几百行 OOXML 拼装。
+ * 分层和导出侧对称：`parse.ts` / `csv-parse.ts` 是纯函数（解压、XML 解析
+ * 都注入），本文件负责脏活 —— 解 zip（fflate）、缺省 DOMParser（浏览器原生）、
+ * 解码文本（UTF-8 优先，失败退 GBK）、从 URL 拉字节、按扩展名和魔数嗅探格式。
+ *
+ * ```ts
+ * import { importSheetSource } from "@4399ywkf/editor/xlsx"
+ *
+ * const { workbook, warnings } = await importSheetSource(file)
+ * univerAPI.createWorkbook(workbook)
+ * if (warnings.length) toast(warnings.join("\n"))   // ← 如实报告丢了什么
+ * ```
+ *
+ * Node 侧没有全局 DOMParser，`importXlsx` 显式传 `@xmldom/xmldom` 的即可。
+ */
+
+interface ImportSheetResult {
+    workbook: WorkbookData;
+    /** 导入时丢掉/降级了什么。**要展示给用户**，别吞 */
+    warnings: string[];
+    stats: Record<string, number>;
+}
+interface ImportXlsxOptions {
+    /** 不传则用浏览器原生 DOMParser；Node 里传 @xmldom/xmldom 的 */
+    DOMParser?: DomParserLike;
+    /** 快照里的工作簿名。不传则用 File 名或文档属性里的标题 */
+    name?: string;
+}
+type BinarySource = File | Blob | ArrayBuffer | Uint8Array;
+/** .xlsx 字节 → Univer 快照。纯本地解析，文档不出内网 */
+declare function importXlsx(source: BinarySource, options?: ImportXlsxOptions): Promise<ImportSheetResult>;
+interface ImportCsvOptions extends CsvParseOptions {
+}
+/** csv/tsv 文本或字节 → Univer 快照 */
+declare function importCsv(source: BinarySource | string, options?: ImportCsvOptions): Promise<ImportSheetResult>;
+interface ImportSheetSourceResult extends ImportSheetResult {
+    /** 实际按哪种格式解析的 */
+    format: "xlsx" | "csv" | "tsv";
+}
+/**
+ * `DocumentView` 的 `source` → Univer 快照：URL / File / Blob 都收。
+ *
+ * 判定顺序：扩展名（.csv/.tsv 显式声明就信）→ zip 魔数（xlsx 本质是 zip）
+ * → 都不是则按 csv 试 —— 文本表格没有魔数，这是唯一诚实的兜底。
+ */
+declare function importSheetSource(source: string | Blob | File, options?: ImportXlsxOptions & ImportCsvOptions): Promise<ImportSheetSourceResult>;
+
+/**
+ * xlsx 的各个 XML 部件 → Univer 快照。`serialize.ts`（导出侧）的逆。
+ *
+ * 同构：解压和 XML 解析都由调用方注入（见 `import.ts`），浏览器
+ * （fflate + 原生 DOMParser）和 Node（任意 zip 库 + @xmldom/xmldom）
+ * 共用这一份实现，不存在两份真相 —— 和 `docx/parse.ts` 同一套约定。
+ *
+ * **能保住的**：多工作表（含顺序与隐藏）、值与类型、公式（普通/共享/数组）、
+ * 数字格式、字体/颜色/填充/边框/对齐/换行/旋转、合并单元格、行高列宽、
+ * 隐藏行列、冻结窗格、网格线开关、标签颜色、quotePrefix（强制文本）。
+ *
+ * **保不住的**：图片、图表、透视表、条件格式、数据校验、筛选、批注、
+ * 超链接、主题色。它们要么住在独立部件里（drawing / pivot / comments），
+ * 要么需要把 Excel 的主题模型抄一遍（theme + tint）。这里不假装支持，
+ * 而是逐个探测、**如实报告丢了什么**（见 `warnings`）—— 让宿主能把话
+ * 原样告诉用户，而不是打开表格才发现少了东西。
+ */
+
+interface XlsxEntries {
+    /** 读取包内某个条目；不存在返回 null */
+    read(entryPath: string): Uint8Array | null;
+    /** 包内全部条目路径。用于探测图片/批注等「导入保不住」的部件 */
+    list(): string[];
+}
+interface ParseXlsxOptions {
+    /** 浏览器传原生 DOMParser，Node 传 @xmldom/xmldom 的 */
+    DOMParser: DomParserLike;
+    /** 快照里的工作簿名。不传则用 docProps 里的标题，再没有就空着 */
+    name?: string;
+}
+interface ParseXlsxResult {
+    workbook: WorkbookData;
+    /** 导入时丢掉/降级了什么。**要展示给用户**，别吞 */
+    warnings: string[];
+    /** 计数，用于量化保真度 */
+    stats: Record<string, number>;
+}
+declare function parseXlsx(entries: XlsxEntries, options: ParseXlsxOptions): ParseXlsxResult;
+
+/** 从 Univer 实例取快照。xlsx 与 csv 两条导出路径共用。 */
+
+/**
+ * 参数类型是 `unknown` 而不是 `FUniver`：`@univerjs/presets` 是可选 peer，
+ * 写成具体类型会让没装它的项目 typecheck 直接红。运行时按 facade 的两个
+ * 方法名依次试探（`getSnapshot` 是新名字，`save` 是旧的）。
+ */
+declare function snapshotFromUniver(univerAPI: unknown): WorkbookData;
+
+/**
+ * `@4399ywkf/editor/xlsx` —— 表格导入导出。
+ *
+ * 和 `./docx` 同一套思路：**在本地转换，文档不出内网**，不依赖任何转换服务，
+ * 也不引 SheetJS —— 打包只多出 fflate（本来就有）和这千把行 OOXML 拼装/解析。
  *
  * ```ts
  * import { downloadXlsx } from "@4399ywkf/editor/xlsx"
@@ -231,6 +168,14 @@ declare function serializeXlsx(workbook: WorkbookData, options?: SerializeXlsxOp
  * downloadXlsx(ref.current, "年度报表.xlsx")
  * ```
  *
+ * 导入是反方向 —— File / Blob / URL 都收，`SheetView` 的 `source` 走的就是它：
+ *
+ * ```ts
+ * import { importSheetSource } from "@4399ywkf/editor/xlsx"
+ * const { workbook, warnings } = await importSheetSource(file)
+ * univerAPI.createWorkbook(workbook)
+ * ```
+ *
  * 服务端 / 定时任务只有 JSON 也能用 —— 整条链路不碰 DOM：
  *
  * ```ts
@@ -239,7 +184,8 @@ declare function serializeXlsx(workbook: WorkbookData, options?: SerializeXlsxOp
  * ```
  *
  * `warnings` 一定要透给用户。Univer 把图片、条件格式、数据校验这些存在插件数据里，
- * 不在单元格模型内，导出必然丢 —— 打开文件才发现远比导出时被告知糟糕。
+ * 不在单元格模型内，导出必然丢；导入侧同理（drawing / pivot / comments 是独立部件）——
+ * 打开文件才发现远比转换时被告知糟糕。
  */
 
 declare const XLSX_MIME = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
@@ -251,14 +197,6 @@ interface XlsxResult {
 }
 /** 纯函数：Univer 快照 → .xlsx 字节。不依赖 DOM 与引擎，服务端 / 测试直接可用。 */
 declare function xlsxFromSnapshot(workbook: WorkbookData, options?: SerializeXlsxOptions): XlsxResult;
-/**
- * 从 Univer 实例取快照。
- *
- * 参数类型是 `unknown` 而不是 `FUniver`：`@univerjs/presets` 是可选 peer，
- * 写成具体类型会让没装它的项目 typecheck 直接红。运行时按 facade 的两个
- * 方法名依次试探（`getSnapshot` 是新名字，`save` 是旧的）。
- */
-declare function snapshotFromUniver(univerAPI: unknown): WorkbookData;
 /** Univer 实例或快照 → .xlsx 字节 */
 declare function exportXlsx(source: WorkbookData | unknown, options?: SerializeXlsxOptions): XlsxResult;
 /** Univer 实例或快照 → Blob，便于交给上传接口 */
@@ -270,4 +208,4 @@ declare function xlsxBlob(source: WorkbookData | unknown, options?: SerializeXls
  */
 declare function downloadXlsx(source: WorkbookData | unknown, filename?: string, options?: SerializeXlsxOptions): XlsxResult;
 
-export { type CellData, type CellRange, type CellValue, type ColumnData, type RowData, type SerializeXlsxOptions, type SerializeXlsxResult, type StyleData, type WorkbookData, type WorksheetData, XLSX_MIME, type XlsxResult, downloadXlsx, exportXlsx, serializeXlsx, snapshotFromUniver, xlsxBlob, xlsxFromSnapshot };
+export { CsvParseOptions, type ImportCsvOptions, type ImportSheetResult, type ImportSheetSourceResult, type ImportXlsxOptions, type ParseXlsxOptions, type ParseXlsxResult, type SerializeXlsxOptions, type SerializeXlsxResult, WorkbookData, XLSX_MIME, type XlsxEntries, type XlsxResult, downloadXlsx, exportXlsx, importCsv, importSheetSource, importXlsx, parseXlsx, serializeXlsx, snapshotFromUniver, xlsxBlob, xlsxFromSnapshot };

package/dist/xlsx.js

@@ -1,83 +1,12 @@
+export { importCsv, importSheetSource, importXlsx, parseXlsx } from './chunk-DGUNVCOM.js';
+import { pxToPoints, cellRef, escapeXml, pxToColumnWidth, columnName, toArgb, XML_DECL, escapeAttr } from './chunk-SBTKDJAL.js';
+import { toSnapshot } from './chunk-WF7PIIFR.js';
+export { snapshotFromUniver } from './chunk-WF7PIIFR.js';
+import { H_ALIGN, V_ALIGN, CELL_TYPE, WRAP } from './chunk-KRP5V7VF.js';
+export { csvToSnapshot, parseCsv } from './chunk-KRP5V7VF.js';
+import { numericKeys, richTextToPlain } from './chunk-5HMKRNIH.js';
 import { zipSync } from 'fflate';
 
-// src/xlsx/index.ts
-
-// src/xlsx/types.ts
-var CELL_TYPE = {
-  /** 强制文本：用户输入 `'0123` 这类本该被当数字的内容 */
-  FORCE_STRING: 4
-};
-var H_ALIGN = {
-  LEFT: 1,
-  CENTER: 2,
-  RIGHT: 3,
-  JUSTIFIED: 4,
-  BOTH: 5,
-  DISTRIBUTED: 6
-};
-var V_ALIGN = { TOP: 1, MIDDLE: 2, BOTTOM: 3 };
-var WRAP = { WRAP: 3 };
-
-// src/xlsx/xml.ts
-var CONTROL = /[\u0000-\u0008\u000B\u000C\u000E-\u001F\uFFFE\uFFFF]/g;
-var LONE_SURROGATE = /[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/g;
-function escapeXml(value) {
-  return value.replace(CONTROL, "").replace(LONE_SURROGATE, "").replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
-}
-function escapeAttr(value) {
-  return escapeXml(value).replace(/'/g, "&apos;").replace(/\r/g, "&#13;").replace(/\n/g, "&#10;");
-}
-function columnName(index) {
-  let n = index;
-  let out = "";
-  do {
-    out = String.fromCharCode(65 + n % 26) + out;
-    n = Math.floor(n / 26) - 1;
-  } while (n >= 0);
-  return out;
-}
-function cellRef(row, column) {
-  return `${columnName(column)}${row + 1}`;
-}
-function hex2(n) {
-  return Math.max(0, Math.min(255, Math.round(n))).toString(16).toUpperCase().padStart(2, "0");
-}
-function toArgb(color) {
-  const raw = typeof color === "string" ? color : color?.rgb;
-  if (!raw) return void 0;
-  const s = raw.trim();
-  if (s.startsWith("#")) {
-    const h = s.slice(1);
-    if (!/^[0-9a-fA-F]+$/.test(h)) return void 0;
-    const dup = (c) => c + c;
-    if (h.length === 3 || h.length === 4) {
-      const [r, g, b, a] = h.split("");
-      return `${a ? dup(a) : "FF"}${dup(r)}${dup(g)}${dup(b)}`.toUpperCase();
-    }
-    if (h.length === 6) return `FF${h.toUpperCase()}`;
-    if (h.length === 8) return `${h.slice(6, 8)}${h.slice(0, 6)}`.toUpperCase();
-    return void 0;
-  }
-  const m = /^rgba?\(([^)]+)\)$/i.exec(s);
-  if (m) {
-    const parts = m[1].split(/[,/\s]+/).filter(Boolean);
-    if (parts.length < 3) return void 0;
-    const [r, g, b, a] = parts;
-    const alpha = a === void 0 ? 1 : Number.parseFloat(a) / (a.includes("%") ? 100 : 1);
-    const chan = (v) => v.includes("%") ? Number.parseFloat(v) / 100 * 255 : Number.parseFloat(v);
-    if (!Number.isFinite(alpha)) return void 0;
-    return `${hex2(alpha * 255)}${hex2(chan(r))}${hex2(chan(g))}${hex2(chan(b))}`;
-  }
-  return void 0;
-}
-function pxToColumnWidth(px) {
-  return Math.round((px - 5) / 7 * 100) / 100;
-}
-function pxToPoints(px) {
-  return Math.round(px * 0.75 * 100) / 100;
-}
-var XML_DECL = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n';
-
 // src/xlsx/styles.ts
 var BORDER_STYLE = [
   "none",
@@ -277,15 +206,6 @@ var BAD_SHEET_NAME = /[\\/?*[\]:]/g;
 var RELS_NS = 'xmlns="http://schemas.openxmlformats.org/package/2006/relationships"';
 var MAIN_NS = "http://schemas.openxmlformats.org/spreadsheetml/2006/main";
 var DOC_REL = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";
-function numericKeys(o) {
-  if (!o) return [];
-  return Object.keys(o).map(Number).filter((n) => Number.isInteger(n) && n >= 0).sort((a, b) => a - b);
-}
-function richTextToPlain(cell) {
-  const stream = cell.p?.body?.dataStream;
-  if (typeof stream !== "string") return void 0;
-  return stream.replace(/\r\n$/, "").replace(/\r/g, "\n");
-}
 function serializeXlsx(workbook, options = {}) {
   const { cachedFormulaValues = true, creator = "@4399ywkf/editor", created = /* @__PURE__ */ new Date() } = options;
   const warnings = [];
@@ -570,22 +490,6 @@ function xlsxFromSnapshot(workbook, options = {}) {
   const { files, warnings, stats } = serializeXlsx(workbook, options);
   return { bytes: zipSync(files, { level: 6 }), warnings, stats };
 }
-function snapshotFromUniver(univerAPI) {
-  const api = univerAPI;
-  const book = api?.getActiveWorkbook?.();
-  if (!book) throw new Error("拿不到当前工作簿：univerAPI 无效，或表格尚未就绪");
-  const snapshot = book.getSnapshot?.() ?? book.save?.();
-  if (!snapshot || typeof snapshot !== "object") {
-    throw new Error("当前 Univer 版本没有 getSnapshot() / save()，无法取快照");
-  }
-  return snapshot;
-}
-function toSnapshot(source) {
-  const maybe = source;
-  if (maybe && typeof maybe === "object" && ("sheets" in maybe || "sheetOrder" in maybe))
-    return maybe;
-  return snapshotFromUniver(source);
-}
 function exportXlsx(source, options) {
   return xlsxFromSnapshot(toSnapshot(source), options);
 }
@@ -608,6 +512,6 @@ function downloadXlsx(source, filename = "工作簿.xlsx", options) {
   return result;
 }
 
-export { XLSX_MIME, downloadXlsx, exportXlsx, serializeXlsx, snapshotFromUniver, xlsxBlob, xlsxFromSnapshot };
+export { XLSX_MIME, downloadXlsx, exportXlsx, serializeXlsx, xlsxBlob, xlsxFromSnapshot };
 //# sourceMappingURL=xlsx.js.map
 //# sourceMappingURL=xlsx.js.map