@shadow-garden/bapbong-docx 0.1.0

package/dist/lib/docx.d.ts

@@ -0,0 +1,63 @@
+import JSZip from 'jszip';
+import { Node as PMNode, Schema } from 'prosemirror-model';
+export type DocxInput = ArrayBuffer | Uint8Array | Blob;
+/**
+ * Result of importing a .docx: the ProseMirror document plus the raw
+ * `word/document.xml` we parsed it from. The raw string is kept so a later
+ * export step can round-trip parts of the document we don't model yet.
+ */
+/** Page geometry in CSS px (structurally a bapbong-contracts PageConfig). */
+export interface PageConfig {
+    width: number;
+    height: number;
+    margin: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+}
+/** A document comment (structurally a bapbong-contracts CommentData). */
+export interface CommentData {
+    id: number;
+    author: string;
+    date: string;
+    text: string;
+}
+export interface DocxImport {
+    doc: PMNode;
+    rawDocumentXml: string;
+    /** Header stories keyed by w:type ("default" | "first" | "even"). */
+    headers: Record<string, PMNode>;
+    /** Footer stories keyed by w:type. */
+    footers: Record<string, PMNode>;
+    /** Footnote body stories keyed by display number (w:footnoteReference). Laid
+     *  out at the bottom of the page their reference falls on. Endnotes are NOT
+     *  here — they're appended to `doc`. */
+    footnotes: Record<number, PMNode>;
+    /** w:titlePg — page 1 uses the "first" header/footer (headers/footers['first']). */
+    titlePg: boolean;
+    /** w:evenAndOddHeaders — even pages use the "even" header/footer. */
+    evenAndOdd: boolean;
+    /** Comments referenced by the body (w:commentRange), in appearance order. */
+    comments: CommentData[];
+    /** Page size + margins from w:sectPr (A4 @96dpi when unspecified). */
+    page: PageConfig;
+    /** The loaded source package — pass to `exportDocx(doc, { carry })` so the
+     *  parts bapbong doesn't model yet (styles, numbering, headers/footers, …)
+     *  survive the round-trip instead of being dropped. */
+    raw: JSZip;
+}
+/**
+ * Parse the bytes of a .docx file into a bapbong ProseMirror document.
+ *
+ * Scope so far: paragraphs, tables (col/row spans), text runs with the
+ * run-property cascade resolved to bold/italic/underline/strike/color/size/font
+ * marks, flat list paragraphs with multilevel numbering, hyperlinks (link mark),
+ * and inline images (data-URL). Headers/footers, theme colors, and export are
+ * later milestones; unmodeled XML is preserved on `rawDocumentXml`.
+ */
+export declare function importDocx(input: DocxInput, opts?: {
+    schema?: Schema;
+}): Promise<DocxImport>;
+//# sourceMappingURL=docx.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docx.d.ts","sourceRoot":"","sources":["../../src/lib/docx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,IAAI,MAAM,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAC;AA4BjE,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC;AAExD;;;;GAIG;AACH,6EAA6E;AAC7E,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACtE;AAED,yEAAyE;AACzE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAqBD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,MAAM,CAAC;IACvB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC;;4CAEwC;IACxC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,oFAAoF;IACpF,OAAO,EAAE,OAAO,CAAC;IACjB,qEAAqE;IACrE,UAAU,EAAE,OAAO,CAAC;IACpB,6EAA6E;IAC7E,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,sEAAsE;IACtE,IAAI,EAAE,UAAU,CAAC;IACjB;;2DAEuD;IACvD,GAAG,EAAE,KAAK,CAAC;CACZ;AA2xCD;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAC9B,KAAK,EAAE,SAAS,EAChB,IAAI,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACzB,OAAO,CAAC,UAAU,CAAC,CAkGrB"}

package/dist/lib/export.d.ts

@@ -0,0 +1,15 @@
+import JSZip from 'jszip';
+import type { Node as PMNode } from 'prosemirror-model';
+/**
+ * Serialise a bapbong document back to `.docx` bytes.
+ *
+ * With `opts.carry` (the source package from `importDocx().raw`) the original
+ * parts bapbong doesn't model yet — styles, numbering, headers/footers,
+ * footnotes, settings, theme, media — are preserved; only document.xml and the
+ * comment parts are regenerated. Without it, a minimal package is built from
+ * scratch (E1–E3 content only).
+ */
+export declare function exportDocx(doc: PMNode, opts?: {
+    carry?: JSZip;
+}): Promise<Uint8Array>;
+//# sourceMappingURL=export.d.ts.map

package/dist/lib/export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/lib/export.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAQ,IAAI,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAsf9D;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAkE3F"}

package/dist/lib/numbering.d.ts

@@ -0,0 +1,13 @@
+import type { NumberingDefs } from '@shadow-garden/bapbong-model';
+import { OoxmlNode } from './ooxml.js';
+/** Parsed view of `word/numbering.xml`. Markers are NOT computed at import —
+ *  the defs ride the document (doc attr) and the layout engine recounts them
+ *  every pass, so edits renumber live. */
+export interface NumberingResolver {
+    /** Plain-data definitions for the doc node's `numbering` attr. */
+    defs: NumberingDefs | null;
+    /** The lvl's paragraph properties (indent layer in the pPr cascade). */
+    levelPPr(numId: string, level: number): OoxmlNode | undefined;
+}
+export declare function buildNumbering(numberingRoot: OoxmlNode | undefined): NumberingResolver;
+//# sourceMappingURL=numbering.d.ts.map

package/dist/lib/numbering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numbering.d.ts","sourceRoot":"","sources":["../../src/lib/numbering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAA2B,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhE;;0CAE0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,kEAAkE;IAClE,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC3B,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;CAC/D;AAED,wBAAgB,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,SAAS,GAAG,iBAAiB,CAkDtF"}

package/dist/lib/ooxml.d.ts

@@ -0,0 +1,43 @@
+/**
+ * A normalized OOXML element. We parse with `preserveOrder: true` (so the
+ * document's block order — paragraphs vs tables — is faithful) and flatten the
+ * verbose fast-xml-parser shape into this simple tree: ordered `children`,
+ * attribute map (without the `@_` prefix), and concatenated `text`.
+ */
+export interface OoxmlNode {
+    name: string;
+    attrs: Record<string, string>;
+    children: OoxmlNode[];
+    text: string;
+}
+/** Parse an OOXML part into a synthetic `#root` node holding the top-level elements. */
+export declare function parseXml(xml: string): OoxmlNode;
+/** First child element with the given tag name. */
+export declare function child(node: OoxmlNode | undefined, name: string): OoxmlNode | undefined;
+/** All child elements with the given tag name (in document order). */
+export declare function children(node: OoxmlNode | undefined, name: string): OoxmlNode[];
+/** An attribute value (name without the `@_`/`w:` mangling, e.g. "w:val"). */
+export declare function attrOf(node: OoxmlNode | undefined, name: string): string | undefined;
+/** Depth-first search for the first descendant with the given tag name. */
+export declare function findDescendant(node: OoxmlNode | undefined, name: string): OoxmlNode | undefined;
+/** Normalized run (character) properties, independent of the OOXML shape. */
+export interface RunProps {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strike?: boolean;
+    color?: string;
+    sizePt?: number;
+    fontFamily?: string;
+    highlight?: string;
+    vertAlign?: 'super' | 'sub';
+}
+/** Normalize an OOXML hex color ("FF0000" or "#ff0000") to "#FF0000". */
+export declare function normalizeHex(v: string | undefined): string | undefined;
+/** Resolve a `w:themeColor` (+ optional tint/shade) to "#RRGGBB". */
+export type ThemeColorResolver = (themeColor: string, tint?: string, shade?: string) => string | undefined;
+/** Parse a `w:rPr` element into normalized run properties (only present keys). */
+export declare function parseRunProps(rPr: OoxmlNode | undefined, resolveTheme?: ThemeColorResolver): RunProps;
+/** Merge run properties; defined keys in `over` win over `base`. */
+export declare function mergeRunProps(base: RunProps, over: RunProps): RunProps;
+//# sourceMappingURL=ooxml.d.ts.map

package/dist/lib/ooxml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ooxml.d.ts","sourceRoot":"","sources":["../../src/lib/ooxml.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd;AAuCD,wFAAwF;AACxF,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAS/C;AAED,mDAAmD;AACnD,wBAAgB,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAEtF;AAED,sEAAsE;AACtE,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,CAE/E;AAED,8EAA8E;AAC9E,wBAAgB,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEpF;AAED,2EAA2E;AAC3E,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAQ/F;AAmBD,6EAA6E;AAC7E,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CAC7B;AAWD,yEAAyE;AACzE,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAGtE;AAED,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG,CAC/B,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,KACX,MAAM,GAAG,SAAS,CAAC;AAExB,kFAAkF;AAClF,wBAAgB,aAAa,CAC3B,GAAG,EAAE,SAAS,GAAG,SAAS,EAC1B,YAAY,CAAC,EAAE,kBAAkB,GAChC,QAAQ,CAqDV;AAED,oEAAoE;AACpE,wBAAgB,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAEtE"}

package/dist/lib/rels.d.ts

@@ -0,0 +1,8 @@
+import { OoxmlNode } from './ooxml.js';
+export interface Relationship {
+    target: string;
+    external: boolean;
+}
+/** Parse a `_rels/*.rels` part into a map of relationship id → target. */
+export declare function buildRels(root: OoxmlNode | undefined): Map<string, Relationship>;
+//# sourceMappingURL=rels.d.ts.map

package/dist/lib/rels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rels.d.ts","sourceRoot":"","sources":["../../src/lib/rels.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhE,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,0EAA0E;AAC1E,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAUhF"}

package/dist/lib/styles.d.ts

@@ -0,0 +1,18 @@
+import { OoxmlNode, RunProps, ThemeColorResolver } from './ooxml.js';
+/** Resolved view of `word/styles.xml`: document defaults plus named styles,
+ *  with `w:basedOn` inheritance flattened on demand. */
+export interface StyleRegistry {
+    /** docDefaults → rPrDefault, the lowest layer of the run cascade. */
+    docDefaults: RunProps;
+    /** docDefaults → pPrDefault, the lowest layer of the paragraph cascade. */
+    docDefaultsPPr: OoxmlNode | undefined;
+    /** Effective run properties contributed by a styleId (incl. basedOn chain). */
+    resolveStyle(styleId: string | undefined): RunProps;
+    /** The styleId's w:pPr nodes, base-most first (basedOn ancestors → style).
+     *  Callers append the inline pPr and resolve "later wins" per property. */
+    resolveStylePPr(styleId: string | undefined): OoxmlNode[];
+    /** The most-derived w:tblBorders a table style (chain) contributes, if any. */
+    resolveTableBorders(styleId: string | undefined): OoxmlNode | undefined;
+}
+export declare function buildStyleRegistry(stylesRoot: OoxmlNode | undefined, resolveTheme?: ThemeColorResolver): StyleRegistry;
+//# sourceMappingURL=styles.d.ts.map

package/dist/lib/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/lib/styles.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,SAAS,EAET,QAAQ,EACR,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAUpB;wDACwD;AACxD,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,WAAW,EAAE,QAAQ,CAAC;IACtB,2EAA2E;IAC3E,cAAc,EAAE,SAAS,GAAG,SAAS,CAAC;IACtC,+EAA+E;IAC/E,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;IACpD;+EAC2E;IAC3E,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;IAC1D,+EAA+E;IAC/E,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CACzE;AAID,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,SAAS,GAAG,SAAS,EACjC,YAAY,CAAC,EAAE,kBAAkB,GAChC,aAAa,CAoDf"}

package/dist/lib/theme.d.ts

@@ -0,0 +1,5 @@
+import { OoxmlNode } from './ooxml.js';
+/** Resolve an OOXML `w:themeColor` (+ optional tint/shade hex) to "#RRGGBB". */
+export type ThemeResolver = (themeColor: string, tint?: string, shade?: string) => string | undefined;
+export declare function buildThemeResolver(themeRoot: OoxmlNode | undefined): ThemeResolver;
+//# sourceMappingURL=theme.d.ts.map

package/dist/lib/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/lib/theme.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,SAAS,EAAE,MAAM,YAAY,CAAC;AAEtE,gFAAgF;AAChF,MAAM,MAAM,aAAa,GAAG,CAC1B,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,KACX,MAAM,GAAG,SAAS,CAAC;AAmDxB,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,aAAa,CAgBlF"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@shadow-garden/bapbong-docx",
+  "version": "0.1.0",
+  "description": "bapbong — DOCX (OOXML) import / export",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shadowgarden-app/bapbong.git",
+    "directory": "packages/docx"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@shadow-garden/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "tags": [
+      "scope:io"
+    ],
+    "targets": {
+      "build": {
+        "executor": "@nx/esbuild:esbuild",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "packages/docx/dist",
+          "main": "packages/docx/src/index.ts",
+          "tsConfig": "packages/docx/tsconfig.lib.json",
+          "format": [
+            "esm",
+            "cjs"
+          ],
+          "declarationRootDir": "packages/docx/src",
+          "generatePackageJson": false,
+          "external": [
+            "@shadow-garden/bapbong-model"
+          ]
+        }
+      }
+    }
+  },
+  "dependencies": {
+    "fast-xml-parser": "^5.8.0",
+    "jszip": "^3.10.1",
+    "prosemirror-model": "^1.25.7",
+    "@shadow-garden/bapbong-model": "^0.1.0",
+    "@shadow-garden/bapbong-contracts": "^0.1.0"
+  }
+}