@shadow-garden/bapbong-model 0.4.0 → 0.6.0

package/dist/index.cjs

@@ -43,7 +43,8 @@ function pastedParagraphAttrs(el, heading) {
   return {
     heading,
     align: m ? m[1].toLowerCase() : null,
-    borders: dataJson(el, "data-borders")
+    borders: dataJson(el, "data-borders"),
+    carry: dataJson(el, "data-carry")
   };
 }
 function pastedImageAttrs(el) {
@@ -80,7 +81,8 @@ function pastedCellAttrs(el) {
     background: bg ? bg[1].trim() : null,
     vAlign: e.getAttribute("data-valign"),
     borders: dataJson(el, "data-borders"),
-    padding: dataJson(el, "data-padding")
+    padding: dataJson(el, "data-padding"),
+    carry: dataJson(el, "data-carry")
   };
 }
 var schema = new import_prosemirror_model.Schema({
@@ -94,6 +96,10 @@ var schema = new import_prosemirror_model.Schema({
         // SectionConfig[] (contracts) — per-section column flow, delimited by
         // w:sectPr breaks. null/absent → one implicit single-column section.
         sections: { default: null },
+        // PageConfig (contracts) — page size + margins in CSS px, from the
+        // body w:sectPr. Edited via setDocAttribute (page-setup commands) so
+        // orientation/paper-size changes undo cleanly. null → A4 default.
+        page: { default: null },
         // CommentNode[] (contracts) — comment threads keyed to `comment` marks.
         // Edited via setDocAttribute so add/reply/resolve/delete undo cleanly.
         comments: { default: null }
@@ -132,7 +138,13 @@ var schema = new import_prosemirror_model.Schema({
         pageBreakBefore: { default: false },
         // w:pBdr — { top?, bottom?, left?, right? } of BorderSide, or null.
         // Importer-set; painted as a box around the paragraph's lines.
-        borders: { default: null }
+        borders: { default: null },
+        // Carry-through fidelity (docx round-trip): OOXML paragraph
+        // properties the model does NOT represent, preserved verbatim so a
+        // customer's save never drops them. { pPr?: string, markRPr?: string }
+        // — raw XML fragments (pPr extras / the paragraph-mark w:rPr), or
+        // null. Importer-set; the exporter splices them back into w:pPr.
+        carry: { default: null }
       },
       // HTML paste path: recover heading level from h1–h6 and alignment from
       // inline style. Other attrs (list/indent/tabs/spacing) stay importer-only
@@ -152,6 +164,8 @@ var schema = new import_prosemirror_model.Schema({
         if (attrs.styleId) dom["data-style"] = attrs.styleId;
         if (node.attrs["borders"])
           dom["data-borders"] = JSON.stringify(node.attrs["borders"]);
+        if (node.attrs["carry"])
+          dom["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return [tag, dom, 0];
       }
     },
@@ -233,7 +247,12 @@ var schema = new import_prosemirror_model.Schema({
         // insideV }, or null — OOXML tables are borderless unless declared.
         borders: { default: null },
         // w:tblPr/w:jc — 'center' | 'right' table alignment, or null (left).
-        align: { default: null }
+        align: { default: null },
+        // Carry-through fidelity: unmodelled w:tblPr children (tblStyle,
+        // tblLayout, tblLook, tblInd, floating tblpPr, …) as one raw XML
+        // string ({ tblPr: string }), or null. Importer-set; the exporter
+        // splices it back so a save never drops them.
+        carry: { default: null }
       },
       // Complex attrs round-trip as data-* JSON — ProseMirror's clipboard is
       // a toDOM → parseDOM pass, so without this an internal copy/paste
@@ -244,7 +263,8 @@ var schema = new import_prosemirror_model.Schema({
           getAttrs: (el) => ({
             borders: dataJson(el, "data-borders"),
             cellPadding: dataJson(el, "data-cell-padding"),
-            align: el.getAttribute("data-align")
+            align: el.getAttribute("data-align"),
+            carry: dataJson(el, "data-carry")
           })
         }
       ],
@@ -255,6 +275,7 @@ var schema = new import_prosemirror_model.Schema({
         if (a["cellPadding"])
           dom["data-cell-padding"] = JSON.stringify(a["cellPadding"]);
         if (a["align"]) dom["data-align"] = String(a["align"]);
+        if (a["carry"]) dom["data-carry"] = JSON.stringify(a["carry"]);
         return ["table", dom, ["tbody", 0]];
       }
     },
@@ -267,7 +288,10 @@ var schema = new import_prosemirror_model.Schema({
         // (Word's default) means the paginator may split the row mid-content.
         cantSplit: { default: false },
         // w:trHeight — { value: px, exact: boolean } or null (auto).
-        height: { default: null }
+        height: { default: null },
+        // Carry-through fidelity: unmodelled w:trPr children ({ trPr: string
+        // } — gridBefore/wBefore, cnfStyle, …), or null. Importer-set.
+        carry: { default: null }
       },
       parseDOM: [
         {
@@ -275,7 +299,8 @@ var schema = new import_prosemirror_model.Schema({
           getAttrs: (el) => ({
             header: el.getAttribute("data-header") === "true",
             cantSplit: el.getAttribute("data-cant-split") === "true",
-            height: dataJson(el, "data-height")
+            height: dataJson(el, "data-height"),
+            carry: dataJson(el, "data-carry")
           })
         }
       ],
@@ -285,6 +310,8 @@ var schema = new import_prosemirror_model.Schema({
         if (node.attrs["cantSplit"]) dom["data-cant-split"] = "true";
         if (node.attrs["height"])
           dom["data-height"] = JSON.stringify(node.attrs["height"]);
+        if (node.attrs["carry"])
+          dom["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return ["tr", dom, 0];
       }
     },
@@ -302,8 +329,11 @@ var schema = new import_prosemirror_model.Schema({
         // w:vAlign — 'center' | 'bottom' (top default)
         borders: { default: null },
         // w:tcBorders per-side visibility override
-        padding: { default: null }
+        padding: { default: null },
         // w:tcMar per-side margin override (px)
+        // Carry-through fidelity: unmodelled w:tcPr children ({ tcPr: string
+        // } — textDirection, noWrap, tcFitText, …), or null. Importer-set.
+        carry: { default: null }
       },
       parseDOM: [
         { tag: "td", getAttrs: pastedCellAttrs },
@@ -325,6 +355,8 @@ var schema = new import_prosemirror_model.Schema({
           attrs["data-borders"] = JSON.stringify(node.attrs["borders"]);
         if (node.attrs["padding"])
           attrs["data-padding"] = JSON.stringify(node.attrs["padding"]);
+        if (node.attrs["carry"])
+          attrs["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return ["td", attrs, 0];
       }
     }
@@ -471,6 +503,28 @@ var schema = new import_prosemirror_model.Schema({
           0
         ];
       }
+    },
+    // Carry-through fidelity (docx round-trip): run properties the model does
+    // NOT represent (w:rtl, w:kern, w:szCs, …), preserved verbatim as one raw
+    // XML fragment so saving a customer's file never drops them. Invisible —
+    // no rendering; the docx exporter splices `xml` back into the run's rPr.
+    // Typing inside/at the edge of a carried run extends the mark (inclusive
+    // default), which is the faithful behavior for properties like w:rtl.
+    carryRPr: {
+      attrs: { xml: {} },
+      toDOM(mark) {
+        return ["span", { "data-carry-rpr": String(mark.attrs["xml"]) }, 0];
+      },
+      parseDOM: [
+        {
+          tag: "span[data-carry-rpr]",
+          getAttrs: (el) => ({
+            xml: el.getAttribute(
+              "data-carry-rpr"
+            ) ?? ""
+          })
+        }
+      ]
     }
     // The `comment` mark (w:commentRangeStart/End) is contributed by the comment
     // plugin (@shadow-garden/bapbong-comments) via the editor's schema

package/dist/index.js

@@ -15,7 +15,8 @@ function pastedParagraphAttrs(el, heading) {
   return {
     heading,
     align: m ? m[1].toLowerCase() : null,
-    borders: dataJson(el, "data-borders")
+    borders: dataJson(el, "data-borders"),
+    carry: dataJson(el, "data-carry")
   };
 }
 function pastedImageAttrs(el) {
@@ -52,7 +53,8 @@ function pastedCellAttrs(el) {
     background: bg ? bg[1].trim() : null,
     vAlign: e.getAttribute("data-valign"),
     borders: dataJson(el, "data-borders"),
-    padding: dataJson(el, "data-padding")
+    padding: dataJson(el, "data-padding"),
+    carry: dataJson(el, "data-carry")
   };
 }
 var schema = new Schema({
@@ -66,6 +68,10 @@ var schema = new Schema({
         // SectionConfig[] (contracts) — per-section column flow, delimited by
         // w:sectPr breaks. null/absent → one implicit single-column section.
         sections: { default: null },
+        // PageConfig (contracts) — page size + margins in CSS px, from the
+        // body w:sectPr. Edited via setDocAttribute (page-setup commands) so
+        // orientation/paper-size changes undo cleanly. null → A4 default.
+        page: { default: null },
         // CommentNode[] (contracts) — comment threads keyed to `comment` marks.
         // Edited via setDocAttribute so add/reply/resolve/delete undo cleanly.
         comments: { default: null }
@@ -104,7 +110,13 @@ var schema = new Schema({
         pageBreakBefore: { default: false },
         // w:pBdr — { top?, bottom?, left?, right? } of BorderSide, or null.
         // Importer-set; painted as a box around the paragraph's lines.
-        borders: { default: null }
+        borders: { default: null },
+        // Carry-through fidelity (docx round-trip): OOXML paragraph
+        // properties the model does NOT represent, preserved verbatim so a
+        // customer's save never drops them. { pPr?: string, markRPr?: string }
+        // — raw XML fragments (pPr extras / the paragraph-mark w:rPr), or
+        // null. Importer-set; the exporter splices them back into w:pPr.
+        carry: { default: null }
       },
       // HTML paste path: recover heading level from h1–h6 and alignment from
       // inline style. Other attrs (list/indent/tabs/spacing) stay importer-only
@@ -124,6 +136,8 @@ var schema = new Schema({
         if (attrs.styleId) dom["data-style"] = attrs.styleId;
         if (node.attrs["borders"])
           dom["data-borders"] = JSON.stringify(node.attrs["borders"]);
+        if (node.attrs["carry"])
+          dom["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return [tag, dom, 0];
       }
     },
@@ -205,7 +219,12 @@ var schema = new Schema({
         // insideV }, or null — OOXML tables are borderless unless declared.
         borders: { default: null },
         // w:tblPr/w:jc — 'center' | 'right' table alignment, or null (left).
-        align: { default: null }
+        align: { default: null },
+        // Carry-through fidelity: unmodelled w:tblPr children (tblStyle,
+        // tblLayout, tblLook, tblInd, floating tblpPr, …) as one raw XML
+        // string ({ tblPr: string }), or null. Importer-set; the exporter
+        // splices it back so a save never drops them.
+        carry: { default: null }
       },
       // Complex attrs round-trip as data-* JSON — ProseMirror's clipboard is
       // a toDOM → parseDOM pass, so without this an internal copy/paste
@@ -216,7 +235,8 @@ var schema = new Schema({
           getAttrs: (el) => ({
             borders: dataJson(el, "data-borders"),
             cellPadding: dataJson(el, "data-cell-padding"),
-            align: el.getAttribute("data-align")
+            align: el.getAttribute("data-align"),
+            carry: dataJson(el, "data-carry")
           })
         }
       ],
@@ -227,6 +247,7 @@ var schema = new Schema({
         if (a["cellPadding"])
           dom["data-cell-padding"] = JSON.stringify(a["cellPadding"]);
         if (a["align"]) dom["data-align"] = String(a["align"]);
+        if (a["carry"]) dom["data-carry"] = JSON.stringify(a["carry"]);
         return ["table", dom, ["tbody", 0]];
       }
     },
@@ -239,7 +260,10 @@ var schema = new Schema({
         // (Word's default) means the paginator may split the row mid-content.
         cantSplit: { default: false },
         // w:trHeight — { value: px, exact: boolean } or null (auto).
-        height: { default: null }
+        height: { default: null },
+        // Carry-through fidelity: unmodelled w:trPr children ({ trPr: string
+        // } — gridBefore/wBefore, cnfStyle, …), or null. Importer-set.
+        carry: { default: null }
       },
       parseDOM: [
         {
@@ -247,7 +271,8 @@ var schema = new Schema({
           getAttrs: (el) => ({
             header: el.getAttribute("data-header") === "true",
             cantSplit: el.getAttribute("data-cant-split") === "true",
-            height: dataJson(el, "data-height")
+            height: dataJson(el, "data-height"),
+            carry: dataJson(el, "data-carry")
           })
         }
       ],
@@ -257,6 +282,8 @@ var schema = new Schema({
         if (node.attrs["cantSplit"]) dom["data-cant-split"] = "true";
         if (node.attrs["height"])
           dom["data-height"] = JSON.stringify(node.attrs["height"]);
+        if (node.attrs["carry"])
+          dom["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return ["tr", dom, 0];
       }
     },
@@ -274,8 +301,11 @@ var schema = new Schema({
         // w:vAlign — 'center' | 'bottom' (top default)
         borders: { default: null },
         // w:tcBorders per-side visibility override
-        padding: { default: null }
+        padding: { default: null },
         // w:tcMar per-side margin override (px)
+        // Carry-through fidelity: unmodelled w:tcPr children ({ tcPr: string
+        // } — textDirection, noWrap, tcFitText, …), or null. Importer-set.
+        carry: { default: null }
       },
       parseDOM: [
         { tag: "td", getAttrs: pastedCellAttrs },
@@ -297,6 +327,8 @@ var schema = new Schema({
           attrs["data-borders"] = JSON.stringify(node.attrs["borders"]);
         if (node.attrs["padding"])
           attrs["data-padding"] = JSON.stringify(node.attrs["padding"]);
+        if (node.attrs["carry"])
+          attrs["data-carry"] = JSON.stringify(node.attrs["carry"]);
         return ["td", attrs, 0];
       }
     }
@@ -443,6 +475,28 @@ var schema = new Schema({
           0
         ];
       }
+    },
+    // Carry-through fidelity (docx round-trip): run properties the model does
+    // NOT represent (w:rtl, w:kern, w:szCs, …), preserved verbatim as one raw
+    // XML fragment so saving a customer's file never drops them. Invisible —
+    // no rendering; the docx exporter splices `xml` back into the run's rPr.
+    // Typing inside/at the edge of a carried run extends the mark (inclusive
+    // default), which is the faithful behavior for properties like w:rtl.
+    carryRPr: {
+      attrs: { xml: {} },
+      toDOM(mark) {
+        return ["span", { "data-carry-rpr": String(mark.attrs["xml"]) }, 0];
+      },
+      parseDOM: [
+        {
+          tag: "span[data-carry-rpr]",
+          getAttrs: (el) => ({
+            xml: el.getAttribute(
+              "data-carry-rpr"
+            ) ?? ""
+          })
+        }
+      ]
     }
     // The `comment` mark (w:commentRangeStart/End) is contributed by the comment
     // plugin (@shadow-garden/bapbong-comments) via the editor's schema

package/dist/lib/model.d.ts

@@ -8,7 +8,7 @@ import { Schema } from 'prosemirror-model';
  * extend THIS schema so the importer, layout engine, and (canvas) painter all
  * agree on one document model.
  */
-export declare const schema: Schema<"doc" | "paragraph" | "text" | "hard_break" | "image" | "page_field" | "table" | "table_row" | "table_cell", "strong" | "em" | "underline" | "strike" | "textColor" | "fontSize" | "vertAlign" | "highlight" | "fontFamily" | "link" | "footnote">;
+export declare const schema: Schema<"doc" | "paragraph" | "text" | "hard_break" | "image" | "page_field" | "table" | "table_row" | "table_cell", "strong" | "em" | "underline" | "strike" | "textColor" | "fontSize" | "vertAlign" | "highlight" | "fontFamily" | "link" | "footnote" | "carryRPr">;
 /** Concrete schema type, handy for typing Node/Mark across packages. */
 export type BapbongSchema = typeof schema;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/lib/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAgF3C;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,2PA6YjB,CAAC;AAEH,wEAAwE;AACxE,MAAM,MAAM,aAAa,GAAG,OAAO,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,eAAO,MAAM,aAAa,yDA0CxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD,qDAAqD;AACrD,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE5D;+EAC+E;AAC/E,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,2EAA2E;AAC3E,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AA0BD;;;4EAG4E;AAC5E,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/lib/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAkF3C;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,wQAscjB,CAAC;AAEH,wEAAwE;AACxE,MAAM,MAAM,aAAa,GAAG,OAAO,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,eAAO,MAAM,aAAa,yDA0CxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD,qDAAqD;AACrD,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE5D;+EAC+E;AAC/E,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,2EAA2E;AAC3E,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AA0BD;;;4EAG4E;AAC5E,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shadow-garden/bapbong-model",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "bapbong — ProseMirror document model / schema",
   "license": "MIT",
   "repository": {