awaforge

oconvXlsxToIr

AGPL-3.0-onlyRelease 2L3

.xlsx (@awacloud/ooxml's xlsx.read() result) → oconv-ir/v1, tier 2 — one heading + one table per sheet.

Module oconvXlsxToIr (oconvXlsxToIr) | Source packages/front/office/oconv/src/read/xlsx-to-ir.js | Deps oconvIr, xlsx | Worker-safe yes

Pure transformation over an already-parsed xlsx.read(bytes) structure. Composes only xlsx's public API, never an @awacloud/ooxml internal.

Resolve

import { ModuleRuntime } from '@awacloud/fw/core/runtime.js';
import { fw_require, modules } from '@awacloud/oconv';

const runtime = new ModuleRuntime();
runtime.registerAll(fw_require);
runtime.registerAll(modules);
const xlsx = runtime.resolve('xlsx');
const { xlsxToIr } = runtime.resolve('oconvXlsxToIr');

API

Member Signature Returns Throws
xlsxToIr (readResult: object, opts?: object) => {ir, losses} ir — an oconv-ir/v1 document; losses — {code, detail}[] —

Examples

Convert an .xlsx read result to IR

const { ir, losses } = xlsxToIr(xlsx.read(bytes));
ir.kind;   // 'document'
losses;    // [] on a plain grid with no formulas/styles/merges/charts

Notes

  • One IR heading{level:1} + one IR table per workbook sheet, in workbook order — the heading is always level 1 (sheets carry no nesting signal to derive a deeper level from).
  • The sheet's row grid is padded to its widest row, then trailing all-empty rows/columns are trimmed (normalizeGrid, mirrored from read/sheet-grid.js); a sheet whose trimmed grid has zero rows emits its heading only.
  • No row.header is ever set — xlsx carries no first-class header-row concept (contrast oconvOdsToIr, whose table:table-header-rows is a real signal).
  • Loss codes this module emits: sheet/formula-as-value (a formula cell reduced to its cached value), sheet/format-dropped (once per sheet, first styled cell), sheet/merge-dropped (once per sheet, when any merge exists), sheet/chart-dropped (once per sheet, first drawing carrying a chart).
  • Pivot tables are a matrix-level, permanently out-of-scope drop — this reader's frozen dependency list never wires the opt-in pivot-table extension, so a pivot table is structurally invisible on the readResult it receives; never reported per node.

See also