@docx4j/core-ts 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,12 @@
+@docx4j/core-ts
+Copyright 2026 Plutext Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This package is a TypeScript counterpart of docx4j's docx4j-core module
+(https://github.com/plutext/docx4j, Apache License 2.0): the Open Packaging Conventions layer
+(packages, parts, relationships, content types), the typed parts, and the style, numbering and font
+resolution utilities follow docx4j's design and names. It depends on @docx4j/generated-objects-ts
+(https://github.com/plutext/docx4j-generated-objects-ts) for the Office Open XML object model and on
+@docx4j/jsonix (https://github.com/plutext/jsonix) for XML binding; see their NOTICE files for the
+material they derive from (ECMA-376, Microsoft Open Specifications, Jsonix).

package/README.md

@@ -0,0 +1,126 @@
+# @docx4j/core-ts
+
+docx4j-core for TypeScript: Open Packaging (docx, pptx and xlsx as zip, and the flat OPC packages
+that Office JS `getOoxml()` returns), typed parts and relationships, and docx4j's style, numbering
+and font resolution, over the Office Open XML object model of
+[`@docx4j/generated-objects-ts`](https://github.com/plutext/docx4j-generated-objects-ts). Node,
+browsers and Word add-ins.
+
+Status: the Open Packaging layer, the typed parts and the packages (Phase A of
+[CR-001](docs/change-requests/CR-001-engine.md)) are implemented; the resolution utilities
+(`PropertyResolver`, list numbering, fonts: Phase B) are next.
+
+```
+npm install @docx4j/core-ts
+```
+
+```ts
+import { WordprocessingMLPackage, ImagePart, ContentTypes } from '@docx4j/core-ts';
+
+// a zip (Uint8Array), a flat OPC string from Office JS getOoxml(), or a PartStore
+const pkg = await WordprocessingMLPackage.load(bytes);
+const body = await pkg.getBody();                   // Office JS Word.Body, over the typed tree
+body.insertParagraph('Hello World', 'End');
+for (const range of body.search('draft', { matchWholeWord: true })) range.insertText('final', 'Replace');
+body.paragraphs[0].font.bold = true;
+
+const main = pkg.getMainDocumentPart();
+const document = main.contents;                     // org_docx4j_wml.Document: the tree behind the views
+const styles = await main.styleDefinitionsPart.getContents();
+
+const image = new ImagePart('/word/media/image1.png', ContentTypes.IMAGE_PNG);
+image.setBytes(pngBytes);
+const rel = main.addTargetPart(image);              // rel.id is the r:embed to use in the document
+
+const docx = await pkg.save();                      // zip: only the parts you unmarshalled are re-marshalled
+const ooxml = await pkg.saveFlatOpc();              // pkg:package, for insertOoxml()
+```
+
+A part that is never touched is written back byte for byte; `getContents()` (or a view over
+it) marks a part for re-marshalling. `mc:AlternateContent` is resolved when a part is
+unmarshalled, as Word does on open (`{ mcePreprocess: false }` to keep it). Subpaths
+`@docx4j/core-ts/opc`, `/parts`, `/packages` and `/model` give the layers separately.
+
+### The content API
+
+`Body`, `Paragraph`, `Range` and `Font` follow Office JS's `Word.*` shapes (a compile-time
+check keeps them assignable to a subset of those types), so add-in code runs against a
+package with its `load` and `sync` lines removed. Hello World, from nothing to a `.docx`:
+
+```ts
+import { writeFile } from 'node:fs/promises';
+import { WordprocessingMLPackage } from '@docx4j/core-ts';
+
+const pkg = await WordprocessingMLPackage.createPackage({ pageSize: 'A4' });
+pkg.body.insertParagraph('Hello World', 'End');
+await writeFile('hello.docx', await pkg.save());
+```
+
+Editing what is there:
+
+```ts
+const body = await pkg.getBody();
+const title = body.insertParagraph('Report', 'Start');
+title.styleBuiltIn = 'Heading 1';
+title.alignment = 'Centered';
+const [hit] = body.search('quick brown fox');          // across runs
+hit.font.italic = true;                                // runs split at the boundaries
+hit.insertText('slow red fox', 'Replace');             // keeps the first replaced character's formatting
+body.paragraphs.at(-1)?.insertParagraph('The end.', 'After');
+body.text;                                             // a paragraph per line
+```
+
+For agents, every paragraph has an address (`body/3`, or the `w14:paraId` Word wrote), and
+`outline()` lists them all:
+
+```ts
+const outline = await pkg.outline();   // { paragraphs: [{ address: 'body/0', paraId, style, text }, ...], tables, headers, footers }
+const p = await pkg.paragraphAt('body/3');
+p?.insertParagraph('Inserted after the fourth block', 'After');
+(await pkg.paragraphAt({ contains: 'Chapter 2' }))?.delete();
+```
+
+Docx4j's names are there as aliases (`addParagraphOfText`, `addStyledParagraphOfText`,
+`addObject`, `getContent`), and the tree stays reachable: `paragraph.p` is the `P`,
+`body.content` the live array.
+
+### XML in
+
+A whole `word/document.xml` becomes the main document part's contents with `setXml`, and a
+fragment (one or more `w:p`, `w:tbl`, ... as written inside `document.xml`, standard prefixes
+declared for you) goes in through `insertXml`:
+
+```ts
+main.setXml(`<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:body><w:p><w:r><w:t>Hello World</w:t></w:r></w:p><w:sectPr/></w:body>
+</w:document>`);
+const body = await main.getBody();
+await body.insertXml('<w:p><w:pPr><w:pStyle w:val="Heading1"/></w:pPr><w:r><w:t>From XML</w:t></w:r></w:p>', 'Start');
+```
+
+Typed content is built with the objects package's generated factories and appended with
+`addObject` (docx4j) or `insertElement`, which links parent pointers and rejects what a body
+cannot hold:
+
+```ts
+import * as el from '@docx4j/generated-objects-ts/el/org_docx4j_wml';
+body.addObject(el.p({ content: [el.r({ content: [el.t({ value: 'Hello World' })] })] }));
+```
+
+Tables, pictures, `insertOoxml` from a `pkg:package`, custom XML parts, XML mapping and typed
+content controls are the next phases of
+[CR-002](docs/change-requests/CR-002-content-api.md); effective formatting (styles resolved,
+as Office JS reports it) comes with [CR-001](docs/change-requests/CR-001-engine.md) Phase B.
+
+## Development
+
+```
+npm ci                              # the locked dependencies from npm
+npm run typecheck && npm test       # test = build, then node --test test/*.test.mjs
+```
+
+Releases are published to npm from GitHub Actions; see `RELEASING.md`.
+
+## Licence
+
+Apache-2.0, as docx4j. See NOTICE.

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+export * from '@docx4j/generated-objects-ts';
+export type { Part as FlatOpcPart } from '@docx4j/generated-objects-ts';
+export { Part } from './parts/Part.mjs';
+export * from './opc/index.mjs';
+export * from './parts/index.mjs';
+export * from './packages/index.mjs';
+export * from './model/index.mjs';

package/dist/index.mjs

@@ -0,0 +1,10 @@
+// @docx4j/core-ts: the counterpart of docx4j-core. The Open Packaging layer, the typed parts and
+// the packages are specified in docs/change-requests/CR-001-engine.md. The object model's facade
+// (docx4j's XmlUtils names) is re-exported so that code written against
+// @docx4j/generated-objects-ts reads the same here.
+export * from '@docx4j/generated-objects-ts';
+export { Part } from './parts/Part.mjs';
+export * from './opc/index.mjs';
+export * from './parts/index.mjs';
+export * from './packages/index.mjs';
+export * from './model/index.mjs';

package/dist/model/content/Body.d.mts

@@ -0,0 +1,107 @@
+import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
+import type { XmlPart } from '../../parts/XmlPart.mjs';
+import type { OpcPackage } from '../../packages/OpcPackage.mjs';
+import { type Element } from './tree.mjs';
+import { Paragraph } from './Paragraph.mjs';
+import { Range } from './Range.mjs';
+import type { SearchOptions } from './search.mjs';
+/** Where a paragraph or table is, for agents and across tool calls (CR-002 section 3.3). */
+export type Address = string | {
+    contains: string;
+} | {
+    paraId: string;
+};
+/** A view over a block-level element that is not a paragraph (a table, a content control), for insert targets and outlines. */
+export interface BlockElement {
+    element: Element;
+    container: Element[];
+}
+export interface OutlineParagraph {
+    address: string;
+    paraId?: string;
+    style: string;
+    text: string;
+}
+export interface OutlineTable {
+    address: string;
+    rows: number;
+    cols: number;
+}
+export interface Outline {
+    paragraphs: OutlineParagraph[];
+    tables: OutlineTable[];
+}
+/**
+ * A subset of Office JS `Word.Body` over any container with block-level content: the main
+ * document's body, a header, a footer, a footnote, a cell or a content control. A view: the
+ * tree is the state; `content` is the live array.
+ */
+export declare class Body {
+    /** The part whose tree this is; marks it for re-marshalling by being unmarshalled. */
+    readonly part: XmlPart<unknown> | undefined;
+    /** The container value: a Body, Hdr, Ftr, Tc, SdtContentBlock, ... */
+    readonly container: {
+        content?: Element[];
+    };
+    /** The address prefix: 'body', 'header:rId3', 'footer:rId4', 'footnote:2'. */
+    readonly prefix: string;
+    readonly package_?: OpcPackage | undefined;
+    constructor(
+    /** The part whose tree this is; marks it for re-marshalling by being unmarshalled. */
+    part: XmlPart<unknown> | undefined, 
+    /** The container value: a Body, Hdr, Ftr, Tc, SdtContentBlock, ... */
+    container: {
+        content?: Element[];
+    }, 
+    /** The address prefix: 'body', 'header:rId3', 'footer:rId4', 'footnote:2'. */
+    prefix?: string, package_?: OpcPackage | undefined);
+    /** The live content array (docx4j getContent()); block-level elements only, sectPr excluded. */
+    get content(): Element[];
+    /** Every paragraph in document order, descending into tables and content controls. */
+    get paragraphs(): Paragraph[];
+    /** The tables directly in this body (as elements; `Table` views are CR-002 Phase C). */
+    get tables(): BlockElement[];
+    /** The text, a paragraph per line. */
+    get text(): string;
+    insertParagraph(text: string, location: 'Start' | 'End'): Paragraph;
+    /** Text at the start of the first paragraph, the end of the last, or replacing everything with one paragraph. */
+    insertText(text: string, location: 'Start' | 'End' | 'Replace'): Range;
+    insertBreak(type: 'Page' | 'Line', location: 'Start' | 'End'): void;
+    /**
+     * Inserts block-level elements (docx4j addObject): at the start or end of this body, or
+     * before or after a target paragraph, element or address. Links PARENT. Rejects anything the
+     * body cannot hold, naming what was passed. Returns the view of the first inserted element.
+     */
+    insertElement(element: Element | Element[], location: 'Start' | 'End' | 'Before' | 'After', target?: Paragraph | BlockElement | Address): Paragraph | BlockElement;
+    /** Inserts a WML fragment (one or more w:p / w:tbl / ... as inside document.xml); the standard prefixes are declared for it. */
+    insertXml(xml: string, location: 'Start' | 'End' | 'Before' | 'After', target?: Paragraph | BlockElement | Address): Promise<(Paragraph | BlockElement)[]>;
+    /** Matches over every paragraph, in document order. */
+    search(text: string, options?: SearchOptions): Range[];
+    /** Removes everything (section properties stay). */
+    clear(): void;
+    /** The part's XML (extension; Office JS getOoxml wraps it in a package). */
+    getXml(): Promise<string>;
+    /** The element at an address: 'body/3' (fourth block), 'body/3/1/0/2' (table row 1, cell 0, block 2), a paraId, or a text match. */
+    elementAt(address: Address): BlockElement | undefined;
+    paragraphAt(address: Address): Paragraph | undefined;
+    /** The ordinal address of a paragraph or element in this body, from PARENT links; undefined when it is not here. */
+    addressOf(target: Paragraph | BlockElement): string | undefined;
+    /** What an agent asks for first: every paragraph and table with its address, style and text. */
+    outline(): Outline;
+    /** docx4j MainDocumentPart.addParagraphOfText. */
+    addParagraphOfText(text: string): wml.P;
+    /** docx4j MainDocumentPart.addStyledParagraphOfText. */
+    addStyledParagraphOfText(styleId: string, text: string): wml.P;
+    /** docx4j addObject: appends a block-level element. */
+    addObject(element: Element): void;
+    /** docx4j getContent(). */
+    getContent(): Element[];
+    private resolveTarget;
+    /** The typed object whose content array this is, for PARENT links. */
+    private ownerOf;
+    private containerOf;
+    private pathOf;
+    /** Gives a new paragraph a w14:paraId when the document already uses them. */
+    private assignParaId;
+    private usesParaIds;
+}