Class OpenXmlPackage

Base class for all Open XML document packages.

Remarks

An Open XML package is a ZIP archive (or equivalent Flat OPC / Base64 representation) containing parts (XML documents, images, and other binary data) linked by relationships.

OpenXmlPackage provides format-agnostic opening and saving, part management, and relationship navigation. For format-specific convenience methods, use the subclasses WmlPackage, SmlPackage, or PmlPackage.

The static open() method auto-detects the input format: binary Blob, Base64 string, or Flat OPC XML string.

Example

import { OpenXmlPackage } from "openxmlsdkts";
import fs from "fs";

const buffer = fs.readFileSync("document.docx");
const pkg = await OpenXmlPackage.open(new Blob([buffer]));
const parts = pkg.getParts();
console.log(`Package contains ${parts.length} parts`);

const blob = await pkg.saveToBlobAsync();

Hierarchy (View Summary)

OpenXmlPackage

Constructors

constructor

new OpenXmlPackage(): OpenXmlPackage
Returns OpenXmlPackage

Methods

`Static`open

open(document: string | Blob): Promise<OpenXmlPackage>
Opens an Open XML document from any supported format.
Parameters
- document: string | Blob
  The document to open.
Returns Promise<OpenXmlPackage>
A promise resolving to an OpenXmlPackage instance.
Remarks
Auto-detects the input format: binary Blob, Base64 string, or Flat OPC XML string. For format-specific packages, use WmlPackage.open, SmlPackage.open, or PmlPackage.open instead.
Example
```
// Open from binary Blob
const buffer = fs.readFileSync("document.docx");
const pkg = await OpenXmlPackage.open(new Blob([buffer]));

// Open from Base64 string
const base64 = fs.readFileSync("document.txt", "utf-8");
const pkg2 = await OpenXmlPackage.open(base64);

// Open from Flat OPC XML string
const flatOpc = fs.readFileSync("document.xml", "utf-8");
const pkg3 = await OpenXmlPackage.open(flatOpc);
```
- Defined in src/OpenXmlPackage.ts:641

getParts

getParts(): OpenXmlPart[]
Returns all content parts in the package, excluding the content-types part and relationship parts.

Returns OpenXmlPart[]
An array of all content OpenXmlPart instances in the package.
- Defined in src/OpenXmlPackage.ts:83

addPart

addPart(
    uri: string,
    contentType: string,
    partType: PartType,
    data: unknown,
): OpenXmlPart
Adds a new part to the package.
Parameters
- uri: string
  The part URI (e.g., "/word/comments.xml").
- contentType: string
  The MIME content type. Use ContentType constants.
- partType: PartType
  The part data type: "xml", "binary", or "base64".
- data: unknown
  The part content (an XDocument for XML parts, or a string/Blob for binary).
Returns OpenXmlPart
The newly created OpenXmlPart.
Throws
Error if a part with the given URI already exists.
Example
```
import { ContentType, XDocument, XElement, W } from "openxmlsdkts";

const xDoc = new XDocument(new XElement(W.comments));
pkg.addPart("/word/comments.xml", ContentType.wordprocessingComments, "xml", xDoc);
```
- Defined in src/OpenXmlPackage.ts:105

deletePart

deletePart(part: OpenXmlPart): Promise<void>
Removes a part from the package and cleans up any relationships that reference it.
Parameters
- part: OpenXmlPart
  The part to delete.
Returns Promise<void>
- Defined in src/OpenXmlPackage.ts:121

getPartByUri

getPartByUri(uri: string): OpenXmlPart | undefined
Looks up a part by its URI.
Parameters
- uri: string
  The full part URI (e.g., "/word/document.xml").
Returns OpenXmlPart | undefined
The matching OpenXmlPart, or undefined if not found.
- Defined in src/OpenXmlPackage.ts:160

getContentType

getContentType(uri: string): string
Returns the content type for a part identified by its URI.
Parameters
- uri: string
  The full part URI.
Returns string
The MIME content type string.

Throws
Error if the content type cannot be determined.
- Defined in src/OpenXmlPackage.ts:171

getRelationships

getRelationships(): Promise<OpenXmlRelationship[]>
Returns all package-level relationships (from /_rels/.rels).

Returns Promise<OpenXmlRelationship[]>
An array of OpenXmlRelationship objects.
Example
```
const rels = await pkg.getRelationships();
for (const rel of rels) {
  console.log(`${rel.getId()} -> ${rel.getTargetFullName()}`);
}
```
- Defined in src/OpenXmlPackage.ts:188

getRelationshipsByRelationshipType

getRelationshipsByRelationshipType(
relationshipType: string,
): Promise<OpenXmlRelationship[]>
Returns package-level relationships filtered by relationship type.
Parameters
- relationshipType: string
  The relationship type URI. Use RelationshipType constants.
Returns Promise<OpenXmlRelationship[]>
An array of matching OpenXmlRelationship objects.
- Defined in src/OpenXmlPackage.ts:202

getPartsByRelationshipType

getPartsByRelationshipType(relationshipType: string): Promise<OpenXmlPart[]>
Returns parts that are targets of package-level relationships of the given type.
Parameters
- relationshipType: string
  The relationship type URI. Use RelationshipType constants.
Returns Promise<OpenXmlPart[]>
An array of matching OpenXmlPart instances.
Example
```
import { RelationshipType } from "openxmlsdkts";

const themeParts = await pkg.getPartsByRelationshipType(RelationshipType.theme);
```
- Defined in src/OpenXmlPackage.ts:220

getRelationshipById

getRelationshipById(rId: string): Promise<OpenXmlRelationship | undefined>
Finds a package-level relationship by its ID.
Parameters
- rId: string
  The relationship ID (e.g., "rId1").
Returns Promise<OpenXmlRelationship | undefined>
The matching OpenXmlRelationship, or undefined.
- Defined in src/OpenXmlPackage.ts:231

getPartById

getPartById(rId: string): Promise<OpenXmlPart | undefined>
Finds a part by following a package-level relationship ID.
Parameters
- rId: string
  The relationship ID (e.g., "rId1").
Returns Promise<OpenXmlPart | undefined>
The target OpenXmlPart, or undefined.
- Defined in src/OpenXmlPackage.ts:242

getRelationshipsByContentType

getRelationshipsByContentType(
contentType: string,
): Promise<OpenXmlRelationship[]>
Returns package-level relationships whose target parts have the given content type.
Parameters
- contentType: string
  The MIME content type. Use ContentType constants.
Returns Promise<OpenXmlRelationship[]>
An array of matching OpenXmlRelationship objects.
- Defined in src/OpenXmlPackage.ts:253

getPartsByContentType

getPartsByContentType(contentType: string): Promise<OpenXmlPart[]>
Returns parts whose content type matches the given value.
Parameters
- contentType: string
  The MIME content type. Use ContentType constants.
Returns Promise<OpenXmlPart[]>
An array of matching OpenXmlPart instances.
Example
```
import { ContentType } from "openxmlsdkts";

const themeParts = await pkg.getPartsByContentType(ContentType.theme);
```
- Defined in src/OpenXmlPackage.ts:271

getPartByRelationshipType

getPartByRelationshipType(
relationshipType: string,
): Promise<OpenXmlPart | undefined>
Returns the first part targeted by a package-level relationship of the given type.
Parameters
- relationshipType: string
  The relationship type URI. Use RelationshipType constants.
Returns Promise<OpenXmlPart | undefined>
The first matching OpenXmlPart, or undefined.
- Defined in src/OpenXmlPackage.ts:282

coreFilePropertiesPart

coreFilePropertiesPart(): Promise<OpenXmlPart | undefined>
Returns the core file properties part (title, author, dates, etc.).

Returns Promise<OpenXmlPart | undefined>
The core properties OpenXmlPart, or undefined if not present.
- Defined in src/OpenXmlPackage.ts:292

extendedFilePropertiesPart

extendedFilePropertiesPart(): Promise<OpenXmlPart | undefined>
Returns the extended file properties part (application name, company, etc.).

Returns Promise<OpenXmlPart | undefined>
The extended properties OpenXmlPart, or undefined if not present.
- Defined in src/OpenXmlPackage.ts:301

customFilePropertiesPart

customFilePropertiesPart(): Promise<OpenXmlPart | undefined>
Returns the custom file properties part.

Returns Promise<OpenXmlPart | undefined>
The custom properties OpenXmlPart, or undefined if not present.
- Defined in src/OpenXmlPackage.ts:310

getRelationshipsForPart

getRelationshipsForPart(part: OpenXmlPart): Promise<OpenXmlRelationship[]>
Returns all relationships defined for a specific part.
Parameters
- part: OpenXmlPart
  The part whose relationships to retrieve.
Returns Promise<OpenXmlRelationship[]>
An array of OpenXmlRelationship objects.
- Defined in src/OpenXmlPackage.ts:320

addRelationship

addRelationship(
    id: string,
    type: string,
    target: string,
    targetMode?: string,
): Promise<OpenXmlRelationship>
Adds a package-level relationship.
Parameters
- id: string
  The relationship ID (e.g., "rId10").
- type: string
  The relationship type URI. Use RelationshipType constants.
- target: string
  The target URI.
- targetMode: string = "Internal"
  "Internal" (default) or "External".
Returns Promise<OpenXmlRelationship>
The newly created OpenXmlRelationship.
- Defined in src/OpenXmlPackage.ts:337

addRelationshipForPart

addRelationshipForPart(
    part: OpenXmlPart,
    id: string,
    type: string,
    target: string,
    targetMode?: string,
): Promise<OpenXmlRelationship>
Adds a relationship to a specific part.
Parameters
- part: OpenXmlPart
  The source part.
- id: string
  The relationship ID.
- type: string
  The relationship type URI. Use RelationshipType constants.
- target: string
  The target URI (relative to the source part).
- targetMode: string = "Internal"
  "Internal" (default) or "External".
Returns Promise<OpenXmlRelationship>
The newly created OpenXmlRelationship.
- Defined in src/OpenXmlPackage.ts:352

deleteRelationship

deleteRelationship(id: string): Promise<boolean>
Deletes a package-level relationship by ID.
Parameters
- id: string
  The relationship ID to delete.
Returns Promise<boolean>
true if the relationship was deleted.

Throws
Error if the relationship is not found.
- Defined in src/OpenXmlPackage.ts:365

deleteRelationshipForPart

deleteRelationshipForPart(part: OpenXmlPart, id: string): Promise<boolean>
Deletes a relationship from a specific part.
Parameters
- part: OpenXmlPart
  The source part.
- id: string
  The relationship ID to delete.
Returns Promise<boolean>
true if the relationship was deleted.

Throws
Error if the relationship is not found.
- Defined in src/OpenXmlPackage.ts:381

saveToFlatOpcAsync

saveToFlatOpcAsync(): Promise<string>
Saves the package as a Flat OPC XML string.

Returns Promise<string>
A promise resolving to the Flat OPC XML string.
Remarks
Flat OPC XML is the required format when working with Office JavaScript/TypeScript Add-ins. It is also useful for storing documents in XML databases, applying XSLT transformations, and debugging document structure.
Example
```
const flatOpc = await pkg.saveToFlatOpcAsync();
fs.writeFileSync("document.xml", flatOpc);
```
- Defined in src/OpenXmlPackage.ts:405

saveToBase64Async

saveToBase64Async(): Promise<string>
Saves the package as a Base64-encoded string.

Returns Promise<string>
A promise resolving to the Base64 string.
Remarks
Useful for embedding documents in JSON payloads, data URIs, or text-based storage.
Example
```
const base64 = await pkg.saveToBase64Async();
```
- Defined in src/OpenXmlPackage.ts:467

saveToBlobAsync

saveToBlobAsync(): Promise<Blob>

Saves the package as a binary Blob (ZIP).

Returns Promise<Blob>

A promise resolving to a Blob containing the document bytes.

Example

const blob = await pkg.saveToBlobAsync();
// In Node.js, convert to Buffer for file I/O:
const buffer = Buffer.from(await blob.arrayBuffer());
fs.writeFileSync("output.docx", buffer);

Class OpenXmlPackage

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns OpenXmlPackage

Methods

Staticopen

Parameters

Returns Promise<OpenXmlPackage>

Remarks

Example

getParts

Returns OpenXmlPart[]

addPart

Parameters

Returns OpenXmlPart

Throws

Example

deletePart

Parameters

Returns Promise<void>

getPartByUri

Parameters

Returns OpenXmlPart | undefined

getContentType

Parameters

Returns string

Throws

getRelationships

Returns Promise<OpenXmlRelationship[]>

Example

getRelationshipsByRelationshipType

Parameters

Returns Promise<OpenXmlRelationship[]>

getPartsByRelationshipType

Parameters

Returns Promise<OpenXmlPart[]>

Example

getRelationshipById

Parameters

Returns Promise<OpenXmlRelationship | undefined>

getPartById

Parameters

Returns Promise<OpenXmlPart | undefined>

getRelationshipsByContentType

Parameters

Returns Promise<OpenXmlRelationship[]>

getPartsByContentType

Parameters

Returns Promise<OpenXmlPart[]>

Example

getPartByRelationshipType

Parameters

Returns Promise<OpenXmlPart | undefined>

coreFilePropertiesPart

Returns Promise<OpenXmlPart | undefined>

extendedFilePropertiesPart

Returns Promise<OpenXmlPart | undefined>

customFilePropertiesPart

Returns Promise<OpenXmlPart | undefined>

getRelationshipsForPart

Parameters

Returns Promise<OpenXmlRelationship[]>

addRelationship

Parameters

Returns Promise<OpenXmlRelationship>

addRelationshipForPart

Parameters

Returns Promise<OpenXmlRelationship>

deleteRelationship

Parameters

Returns Promise<boolean>

Throws

deleteRelationshipForPart

Parameters

`Static`open