awaforge

API — extra/ (opt-in modules)

AGPL-3.0-onlyRelease 2L4

Opt-in modules implementing the coverage guide. Each one wraps the core OOXML parsers with extra typed fields without modifying core. Loaded individually or via a bundle.

See the getting-started guide for the .use() pattern.

Naming rule. Sub-path imports use the kebab-case FILE name (@awacloud/ooxml/extra/wml-run-formatting); the module's export, its ModuleRuntime resolve key and the names in the tables below use the camelCase EXPORT name (wmlRunFormatting):

import { wmlRunFormatting } from '@awacloud/ooxml/extra/wml-run-formatting';
// runtime.resolve('wmlRunFormatting')

WordprocessingML extras

Module Phase Source Role
wmlRunFormatting 1 src/extra/wml-run-formatting.js Typed <w:rPr> (caps, kern, lang, shd, …)
wmlParagraphFormatting 2 src/extra/wml-paragraph-formatting.js Typed <w:pPr> (tabs, framePr, kinsoku, …)
wmlTableProperties 3 src/extra/wml-table-properties.js Typed tblPr / trPr / tcPr
wmlNumberingDetails 4 src/extra/wml-numbering-details.js numbering.xml advanced
wmlSettings 5 src/extra/wml-settings.js settings.xml advanced
wmlFields 6 src/extra/wml-fields.js Field instruction tokenizer
wmlTrackedChanges 7 src/extra/wml-tracked-changes.js moveFrom / rPrChange / cellIns / …
wmlVmlLegacy 8 src/extra/wml-vml-legacy.js <w:pict> / <w:object> / <w:control>
wmlMisc misc src/extra/wml-misc.js Long-tail sweeper

SpreadsheetML extras

Module Phase Source Role
smlPivotTables 9 src/extra/sml-pivot-tables.js pivot tables + cache
smlCalculation 10 src/extra/sml-calculation.js calcChain.xml + calcPr
smlSheetConfig 11 src/extra/sml-sheet-config.js per-sheet config
smlWorkbookConfig 12 src/extra/sml-workbook-config.js workbook-level config
smlFormControls 13 src/extra/sml-form-controls.js ActiveX form controls
smlMisc misc src/extra/sml-misc.js Long-tail sweeper

PresentationML extras

Module Phase Source Role
pmlAnimations 14 src/extra/pml-animations.js Slide timing graph
pmlTransitions 15 src/extra/pml-transitions.js Slide transitions
pmlNotes 16 src/extra/pml-notes.js Notes / handout master
pmlLayoutsTyped 17 src/extra/pml-layouts-typed.js Typed layout descriptors
pmlMisc misc src/extra/pml-misc.js Long-tail sweeper

DrawingML chart extras

Module Phase Source Role
dmlChartDataLabels 18 src/extra/dml-chart-data-labels.js dLbls / dLbl
dmlChartTrendlines 19 src/extra/dml-chart-trendlines.js Trendlines / errBars
dmlChartAxesAdvanced 20 src/extra/dml-chart-axes-advanced.js Full axis config
dmlChart3d 21 src/extra/dml-chart-3d.js 3D scenes
dmlChartOtherTypes 22 src/extra/dml-chart-other-types.js bubble / radar / stock / ofPie
dmlChartMisc misc src/extra/dml-chart-misc.js Long-tail chart sweeper

DrawingML shared / shapes / wp / xdr

Module Phase Source Role
dmlEffects 24 src/extra/dml-effects.js effectLst / effectDag / 3D scene
dmlFillsAdvanced 25 src/extra/dml-fills-advanced.js gradFill / blipFill / pattFill
dmlShapesAdvanced 26 src/extra/dml-shapes-advanced.js Custom geometry
dmlWpPositioning 27 src/extra/dml-wp-positioning.js wp:anchor + wrap
dmlXdrAdvanced 28 src/extra/dml-xdr-advanced.js Connectors + groups
dmlMainMisc misc src/extra/dml-main-misc.js Long-tail dml sweeper

Math extras

Module Phase Source Role
mathAdvanced 23 src/extra/math-advanced.js eqArr / groupChr / mathPr / phant
mathMisc misc src/extra/math-misc.js Long-tail OMML

Cross-cutting

Module Phase Source Role
transitional 29 src/extra/transitional.js Part 4 namespace mapping
legacyVml 30 src/extra/legacy-vml.js Standalone VML mapper

Common pattern

import { xml as xmlMod } from '@awacloud/fw/io/codec/xml.js';
import { docxProperties } from '@awacloud/ooxml';
import { docx } from '@awacloud/ooxml/docx';
import { wmlRunFormatting } from '@awacloud/ooxml/extra/wml-run-formatting';

const xml   = xmlMod.factory();
const props = docxProperties.factory(xml);
const word  = docx.factory(/* … */);
word.use(wmlRunFormatting.factory(xml, props));
// → docx.read(...) now exposes typed run-properties.

See also