awaforge

docxFullBundle

AGPL-3.0-onlyRelease 2L4

Pre-wired bundle: docx-large + every remaining docx-touching extra (every WordprocessingML schema element typed or preserved).

Module docxFullBundle | Source packages/front/office/ooxml/src/bundles/docx-full.js | Deps docxLargeBundle + 7 extras | Worker-safe yes

Use this when you need exhaustive coverage — every WML element, including the long tail and Office 2003 / VML fixtures.

Included

Everything in docx-large, plus:

Resolve

const word = runtime.resolve('docxFullBundle');
// Returns the same enriched `docx` instance `docxLargeBundle` produced,
// with the remaining extras layered on top.

API

docxFullBundle is a pure fw factory descriptor that depends on docxLargeBundle plus every remaining docx-touching extra. The runtime resolves docxLargeBundle first (enriched docx instance), then the factory layers the P2 + misc extras on top via .use(...) and returns the same instance.

Resolve key Returns Dependencies (auto-wired)
'docxFullBundle' enriched docx API docxLargeBundle + wmlVmlLegacy, dmlShapesAdvanced, transitional, legacyVml, wmlMisc, mathMisc, dmlMainMisc

Examples

import { ModuleRuntime } from '@awacloud/fw/core/runtime.js';
import { fw_require, modules, extras } from '@awacloud/ooxml';
import { docxLargeBundle } from '@awacloud/ooxml/bundles/docx-large';
import { docxFullBundle }  from '@awacloud/ooxml/bundles/docx-full';

const runtime = new ModuleRuntime();
runtime.registerAll(fw_require);   // the @awacloud/fw modules the package consumes
runtime.registerAll(modules);
runtime.registerAll(extras);
runtime.register(docxLargeBundle);   // dependency of docxFullBundle
runtime.register(docxFullBundle);

const word = runtime.resolve('docxFullBundle');

// Read a legacy Office 2003 docx with VML drawings.
const bytes  = new Uint8Array(/* … */);
const result = word.read(bytes);

// Write back — `write` takes the DOCUMENT, not the read result.
const out = word.write(result.document, { styles: result.styles });

Notes

  • Bundle size impact: roughly 6× the core parser surface. Use docx-large if VML / part-4 are not needed.
  • transitional is registered with the other extras but declares no hydrate* / dehydrate* hook, so it changes neither read() nor write(): no namespace is rewritten, and the typed extras see the element names of the input (the docx reader matches the w: prefix and ignores the namespace URI; the writers emit the Transitional URIs). To convert a tree between the Transitional and Strict forms, resolve transitional and call toStrict / fromStrict.
  • docxLargeBundle must be registered too — it is a declared dependency of docxFullBundle, and the runtime resolves it before the full bundle's factory runs.

Breaking change

The previous buildDocxFull(docx, { xml, props }) imperative helper has been removed. Replace any call sites with the ModuleRuntime pattern shown above.

See also