ooxml-core 0.2.0

package/dist/docx/diagram.d.ts

@@ -0,0 +1,89 @@
+import { type DiagramDrawing, type DiagramIssue, type DiagramLayoutType, type DiagramRelationshipIds } from '../diagram/index.js';
+import type { Relationship } from './package-parts.js';
+import type { XmlElement } from './xml.js';
+/** The `a:graphicData/@uri` of a SmartArt graphic. */
+export declare const DIAGRAM_GRAPHIC_URI = "http://schemas.openxmlformats.org/drawingml/2006/diagram";
+/** A package part a diagram refers to. */
+export interface DocxDiagramPart {
+    /** Relationship id in the part that holds the drawing (`word/document.xml`, a header...). */
+    relId: string;
+    /** Package part name, e.g. `word/diagrams/data1.xml`. */
+    partName: string;
+}
+/** One content node of the diagram's data model. */
+export interface DocxDiagramNode {
+    id: string;
+    text: string;
+    /** Model id of the parent content node, when the data model has one. */
+    parentId?: string;
+}
+/**
+ * How the diagram can be shown.
+ * `cached-drawing`: the shapes the producing application saved (`dsp:drawing`) are available as
+ * `drawing`; they are a snapshot, not a layout computed here.
+ * `placeholder`: no usable cached drawing; only a labelled placeholder (with the node text) can be
+ * shown, because no SmartArt layout is computed.
+ */
+export type DocxDiagramRendering = 'cached-drawing' | 'placeholder';
+/** A SmartArt graphic in a Word document. Part contents are read-only; the XML is preserved on save. */
+export interface DocxDiagram {
+    /** `inline` (`wp:inline`) or `anchor` (`wp:anchor`, floating). */
+    placement: 'inline' | 'anchor';
+    /** `wp:extent` in EMU: the frame the cached drawing's coordinates are relative to. */
+    extentEmu: {
+        width: number;
+        height: number;
+    };
+    /** `wp:docPr/@name` and `@id`. */
+    name?: string;
+    id?: string;
+    /** `dgm:relIds` as written on the graphic. */
+    relationshipIds: DiagramRelationshipIds;
+    /** The diagram parts the relationships resolve to (package part names). */
+    parts: {
+        data?: DocxDiagramPart;
+        layout?: DocxDiagramPart;
+        quickStyle?: DocxDiagramPart;
+        colors?: DocxDiagramPart;
+        /** Cached layout (`dsp:drawing`), once located. */
+        drawing?: DocxDiagramPart;
+    };
+    /**
+     * Relationship id -> package part name for the relationships this diagram needs, in the part
+     * that holds it. Lets the parts be resolved later without the host part's `.rels`.
+     */
+    hostRelationships: Record<string, string>;
+    /** Layout identification, from `dgm:layoutDef`. */
+    layout?: {
+        uniqueId: string;
+        family?: DiagramLayoutType;
+        rootAlgorithm?: string;
+    };
+    /** Colour and quick-style definition ids (`dgm:colorsDef/@uniqueId`, `dgm:styleDef/@uniqueId`). */
+    colorsId?: string;
+    quickStyleId?: string;
+    /** Content nodes of the data model, in document order. */
+    nodes: DocxDiagramNode[];
+    /** The cached shape tree, EMU relative to `extentEmu`. Absent for `placeholder` rendering. */
+    drawing?: DiagramDrawing;
+    /** Whether a renderer can draw shapes (`cached-drawing`) or must show a placeholder. */
+    rendering: DocxDiagramRendering;
+    /** What this model does and does not provide, to show alongside the diagram. */
+    notice: string;
+    /** Problems met reading the parts; empty when everything resolved. */
+    issues: DiagramIssue[];
+}
+/** The notice that goes with a rendering. */
+export declare const diagramNotice: (rendering: DocxDiagramRendering) => string;
+/**
+ * Reads the host side of a SmartArt graphic. Synchronous: resolves the relationships through the
+ * host's `.rels` but reads no part; {@link resolveDiagramParts} fills in the part contents.
+ */
+export declare function parseDiagramGraphic(graphicData: XmlElement, extent: XmlElement | undefined, docPr: XmlElement | undefined, rels: ReadonlyMap<string, Relationship>, isAnchor: boolean): DocxDiagram;
+/**
+ * Reads the diagram's parts from the package and completes the model: node text, layout and style
+ * identification, the cached drawing and the honest rendering status. Never throws; problems go to
+ * `issues`.
+ */
+export declare function resolveDiagramParts(diagram: DocxDiagram, readText: (partName: string) => Promise<string | undefined>): Promise<void>;
+//# sourceMappingURL=diagram.d.ts.map

package/dist/docx/diagram.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagram.d.ts","sourceRoot":"","sources":["../../src/docx/diagram.ts"],"names":[],"mappings":"AAKA,OAAO,EAMN,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,sDAAsD;AACtD,eAAO,MAAM,mBAAmB,6DAA6D,CAAC;AAG9F,0CAA0C;AAC1C,MAAM,WAAW,eAAe;IAC/B,6FAA6F;IAC7F,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAEpE,wGAAwG;AACxG,MAAM,WAAW,WAAW;IAC3B,kEAAkE;IAClE,SAAS,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC/B,sFAAsF;IACtF,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8CAA8C;IAC9C,eAAe,EAAE,sBAAsB,CAAC;IACxC,2EAA2E;IAC3E,KAAK,EAAE;QACN,IAAI,CAAC,EAAE,eAAe,CAAC;QACvB,MAAM,CAAC,EAAE,eAAe,CAAC;QACzB,UAAU,CAAC,EAAE,eAAe,CAAC;QAC7B,MAAM,CAAC,EAAE,eAAe,CAAC;QACzB,mDAAmD;QACnD,OAAO,CAAC,EAAE,eAAe,CAAC;KAC1B,CAAC;IACF;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,mDAAmD;IACnD,MAAM,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClF,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,8FAA8F;IAC9F,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,wFAAwF;IACxF,SAAS,EAAE,oBAAoB,CAAC;IAChC,gFAAgF;IAChF,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,MAAM,EAAE,YAAY,EAAE,CAAC;CACvB;AAiBD,6CAA6C;AAC7C,eAAO,MAAM,aAAa,GAAI,WAAW,oBAAoB,KAAG,MACM,CAAC;AAEvE;;;GAGG;AACH,wBAAgB,mBAAmB,CAClC,WAAW,EAAE,UAAU,EACvB,MAAM,EAAE,UAAU,GAAG,SAAS,EAC9B,KAAK,EAAE,UAAU,GAAG,SAAS,EAC7B,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,EACvC,QAAQ,EAAE,OAAO,GACf,WAAW,CA2Db;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACxC,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,GACzD,OAAO,CAAC,IAAI,CAAC,CAoEf"}

package/dist/docx/docpr-ids.d.ts

@@ -0,0 +1,14 @@
+import type JSZip from 'jszip';
+import type { XmlDocument } from './xml.js';
+export declare class DocPrIdAllocator {
+    private max;
+    reserve(id: number): void;
+    /** Reserves every `wp:docPr` id in an already parsed part. */
+    reserveFromDocument(doc: XmlDocument): void;
+    /** Reserves every `docPr` id found in serialized XML. */
+    reserveFromXml(xml: string): void;
+    /** Reserves the ids of every XML part in a package (document, headers, footers, notes...). */
+    reserveFromPackage(zip: JSZip): Promise<void>;
+    next(): string;
+}
+//# sourceMappingURL=docpr-ids.d.ts.map

package/dist/docx/docpr-ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docpr-ids.d.ts","sourceRoot":"","sources":["../../src/docx/docpr-ids.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAK5C,qBAAa,gBAAgB;IAC5B,OAAO,CAAC,GAAG,CAAK;IAEhB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIzB,8DAA8D;IAC9D,mBAAmB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAK3C,yDAAyD;IACzD,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC,8FAA8F;IACxF,kBAAkB,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnD,IAAI,IAAI,MAAM;CAId"}

package/dist/docx/document-parts.d.ts

@@ -0,0 +1,18 @@
+import type JSZip from 'jszip';
+import type { Block, Note, SectionProperties } from './model.js';
+import { type XmlElement } from './xml.js';
+import { type StNumberFormat } from './generated/wml-simple-types.js';
+import type { DrawingContext } from './drawing.js';
+export interface DocumentPartsResult {
+    sections: SectionProperties[];
+    footnotes?: Note[];
+    endnotes?: Note[];
+    footnoteNumFmt?: StNumberFormat;
+    endnoteNumFmt?: StNumberFormat;
+    evenAndOddHeaders?: boolean;
+    autoHyphenation?: boolean;
+    warnings: string[];
+}
+/** Resolves sections (with header/footer content) and footnotes/endnotes for a loaded package. */
+export declare function parseDocumentParts(zip: JSZip, body: XmlElement, blocks: Block[], drawings?: DrawingContext): Promise<DocumentPartsResult>;
+//# sourceMappingURL=document-parts.d.ts.map

package/dist/docx/document-parts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-parts.d.ts","sourceRoot":"","sources":["../../src/docx/document-parts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,KAAK,EAAqB,IAAI,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpF,OAAO,EAAyB,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAElE,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAMxF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAgFnD,MAAM,WAAW,mBAAmB;IACnC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;IAClB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,kGAAkG;AAClG,wBAAsB,kBAAkB,CACvC,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,KAAK,EAAE,EACf,QAAQ,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,CA8D9B"}

package/dist/docx/drawing.d.ts

@@ -0,0 +1,13 @@
+import type { InlineImage } from './model.js';
+import { type ContentTypes, type Relationship } from './package-parts.js';
+import { type XmlElement } from './xml.js';
+/** 914400 EMU per inch, 96 CSS px per inch. */
+export { EMU_PER_PIXEL } from './units.js';
+export interface DrawingContext {
+    rels: ReadonlyMap<string, Relationship>;
+    contentTypes: ContentTypes;
+    mediaParts: ReadonlySet<string>;
+}
+/** Parses a `w:drawing` or `w:pict` run child into an inline image model. */
+export declare function parseDrawing(node: XmlElement, context: DrawingContext): InlineImage;
+//# sourceMappingURL=drawing.d.ts.map

package/dist/docx/drawing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawing.d.ts","sourceRoot":"","sources":["../../src/docx/drawing.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAoB,MAAM,YAAY,CAAC;AAChE,OAAO,EAGN,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAW5D,+CAA+C;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACxC,YAAY,EAAE,YAAY,CAAC;IAC3B,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAChC;AAgOD,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,GAAG,WAAW,CAInF"}

package/dist/docx/element-order.d.ts

@@ -0,0 +1,13 @@
+import { type XmlElement } from './xml.js';
+/** `CT_RPr` child order (ECMA-376 §17.3.2.28). */
+export declare const RPR_ORDER: string[];
+/**
+ * Sorts an element's children into `order`. Elements outside the list (extensions) keep their
+ * position relative to the known element before them. Nothing moves when already in order.
+ */
+export declare function orderChildren(parent: XmlElement, order: readonly string[]): void;
+/** `CT_SectPr` child order (ECMA-376 §17.6.17); header/footer references come first. */
+export declare const SECTPR_ORDER: string[];
+/** Sorts `w:sectPr` children into schema order. */
+export declare function orderSectionProperties(sectPr: XmlElement): void;
+//# sourceMappingURL=element-order.d.ts.map

package/dist/docx/element-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-order.d.ts","sourceRoot":"","sources":["../../src/docx/element-order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAE/D,kDAAkD;AAClD,eAAO,MAAM,SAAS,UA6CrB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAWhF;AAED,wFAAwF;AACxF,eAAO,MAAM,YAAY,UAuBxB,CAAC;AAEF,mDAAmD;AACnD,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAE/D"}