@pretextbook/ptxast-util-to-mdast 0.0.4 → 0.0.5

package/README.md

@@ -28,7 +28,19 @@ Converts a `PtxRoot` tree to an mdast `Root` tree with directive nodes for PreTe
 
 ### `ptxastToMarkdown(root: PtxRoot): string`
 
-Converts a `PtxRoot` tree to a Markdown string. Theorem-like environments render as `:::theorem` directive fences; divisions render as ATX headings (`##`).
+Converts a `PtxRoot` tree to a Markdown string. Theorem-like environments render as `:::theorem` directive fences; divisions render as ATX headings, relative to the document's actual outermost division (a depth-1 heading is whatever that division is — `chapter`, `section`, `part`, ...).
+
+When the outermost division isn't `chapter` (the default a depth-1 heading is assumed to mean by [`@pretextbook/remark-pretext`](../remark-pretext)), a `division:` frontmatter block is prepended so the markdown can be converted back to PreTeXt unambiguously:
+
+```
+---
+division: section
+---
+
+# Top-level section
+
+## A subsection
+```
 
 ## License
 

package/dist/index.cjs

@@ -1,2 +1,6 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("@pretextbook/ptxast"),k=require("mdast-util-to-markdown"),x=require("mdast-util-directive"),v=require("mdast-util-math"),b=new Set(["chapter","section","subsection","subsubsection","paragraphs","appendix"]),T={chapter:1,section:2,subsection:3,subsubsection:4,paragraphs:5,appendix:1},w=new Set(["pretext","book","article","frontmatter","backmatter","part"]),P=new Map([["theorem",{name:"theorem",category:"theorem-like"}],["lemma",{name:"lemma",category:"theorem-like"}],["corollary",{name:"corollary",category:"theorem-like"}],["proposition",{name:"proposition",category:"theorem-like"}],["claim",{name:"claim",category:"theorem-like"}],["fact",{name:"fact",category:"theorem-like"}],["conjecture",{name:"conjecture",category:"theorem-like"}],["axiom",{name:"axiom",category:"theorem-like"}],["principle",{name:"principle",category:"theorem-like"}],["hypothesis",{name:"hypothesis",category:"theorem-like"}],["algorithm",{name:"algorithm",category:"theorem-like"}],["definition",{name:"definition",category:"definition-like"}],["notation",{name:"notation",category:"definition-like"}],["remark",{name:"remark",category:"remark-like"}],["note",{name:"note",category:"remark-like"}],["observation",{name:"observation",category:"remark-like"}],["warning",{name:"warning",category:"remark-like"}],["insight",{name:"insight",category:"remark-like"}],["assemblage",{name:"assemblage",category:"remark-like"}],["example",{name:"example",category:"example-like"}],["question",{name:"question",category:"example-like"}],["problem",{name:"problem",category:"example-like"}],["exercise",{name:"exercise",category:"example-like"}],["activity",{name:"activity",category:"example-like"}],["exploration",{name:"exploration",category:"example-like"}],["investigation",{name:"investigation",category:"example-like"}],["project",{name:"project",category:"example-like"}],["proof",{name:"proof",category:"proof-like"}],["case",{name:"case",category:"proof-like"}],["solution",{name:"solution",category:"solution-like"}],["hint",{name:"hint",category:"solution-like"}],["answer",{name:"answer",category:"solution-like"}]]),M=new Set(["theorem-like","definition-like"]);function g(e){return{type:"root",children:d(e.children,2)}}function d(e,t){const n=[];for(const r of e){if(r.type!=="element")continue;const o=r;if(w.has(o.name))n.push(...d(o.children,t));else if(b.has(o.name)){const l=T[o.name]??t;n.push(...E(o,l))}else{const l=u(o);l!==null&&n.push(l)}}return n}function E(e,t){const n=[],r=e.attributes??{},o=e.children,l=o.find(a=>a.type==="element"&&a.name==="title"),s=o.filter(a=>!(a.type==="element"&&a.name==="title")),i={type:"heading",depth:t,children:l?l.children.map(h).filter(m):[],...r["xml:id"]?{data:{id:r["xml:id"],hProperties:{id:r["xml:id"]}}}:{}};n.push(i);const c=Math.min(t+1,6);return n.push(...d(s,c)),n}function u(e){switch(e.name){case"p":return S(e);case"blockquote":return C(e);case"ol":return y(e,!0);case"ul":return y(e,!1);case"program":return D(e);case"me":case"men":case"md":case"mdn":return I(e);default:{const t=P.get(e.name);return t?j(e,t):null}}}function S(e){return{type:"paragraph",children:e.children.map(h).filter(m)}}function C(e){return{type:"blockquote",children:e.children.filter(t=>t.type==="element").map(t=>u(t)).filter(m)}}function y(e,t){return{type:"list",ordered:t,spread:!1,children:e.children.filter(n=>n.type==="element").map(n=>q(n))}}function q(e){return{type:"listItem",spread:!1,children:e.children.filter(t=>t.type==="element").map(t=>u(t)).filter(m)}}function D(e){return{type:"code",lang:(e.attributes??{}).language??null,value:p.getPtxTextContent(e)}}function I(e){const t=e.children;return t.length>0&&t[0].type==="text"?{type:"math",value:p.getPtxTextContent(e)}:{type:"math",value:t.filter(r=>r.type==="element"&&r.name==="mrow").map(r=>p.getPtxTextContent(r)).join(` \\\\
-`)}}function j(e,t){const n=e.attributes??{},r=e.children,o={};n["xml:id"]&&(o.id=n["xml:id"]);for(const[i,c]of Object.entries(n))i==="xml:id"||c==null||(o[i]=c);const l=r.find(i=>i.type==="element"&&i.name==="title"),s=[];if(l){const i={type:"paragraph",data:{directiveLabel:!0},children:l.children.map(h).filter(m)};s.push(i)}if(M.has(t.category))for(const i of r){if(i.type!=="element")continue;const c=i;if(c.name!=="title")if(c.name==="statement")for(const a of c.children){if(a.type!=="element")continue;const f=u(a);f&&s.push(f)}else{const a=u(c);a&&s.push(a)}}else for(const i of r){if(i.type!=="element")continue;const c=i;if(c.name==="title")continue;const a=u(c);a&&s.push(a)}return{type:"containerDirective",name:t.name,attributes:Object.keys(o).length>0?o:void 0,children:s}}function h(e){if(e.type==="text")return{type:"text",value:e.value??""};if(e.type!=="element")return null;const t=e;switch(t.name){case"em":return{type:"emphasis",children:t.children.map(h).filter(m)};case"alert":return{type:"strong",children:t.children.map(h).filter(m)};case"c":return{type:"inlineCode",value:p.getPtxTextContent(t)};case"m":return{type:"inlineMath",value:p.getPtxTextContent(t)};default:return null}}function m(e){return e!==null}function N(e){const t=g(e);return k.toMarkdown(t,{extensions:[x.directiveToMarkdown(),v.mathToMarkdown()]})}exports.ptxastToMarkdown=N;exports.ptxastToMdast=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("@pretextbook/ptxast"),T=require("mdast-util-to-markdown"),b=require("mdast-util-directive"),w=require("mdast-util-math"),g=new Set([...p.DIVISION_HIERARCHY,"appendix"]),k=new Set(["pretext","book","article","frontmatter","backmatter"]),M=new Map([["theorem",{name:"theorem",category:"theorem-like"}],["lemma",{name:"lemma",category:"theorem-like"}],["corollary",{name:"corollary",category:"theorem-like"}],["proposition",{name:"proposition",category:"theorem-like"}],["claim",{name:"claim",category:"theorem-like"}],["fact",{name:"fact",category:"theorem-like"}],["conjecture",{name:"conjecture",category:"theorem-like"}],["axiom",{name:"axiom",category:"theorem-like"}],["principle",{name:"principle",category:"theorem-like"}],["hypothesis",{name:"hypothesis",category:"theorem-like"}],["algorithm",{name:"algorithm",category:"theorem-like"}],["definition",{name:"definition",category:"definition-like"}],["notation",{name:"notation",category:"definition-like"}],["remark",{name:"remark",category:"remark-like"}],["note",{name:"note",category:"remark-like"}],["observation",{name:"observation",category:"remark-like"}],["warning",{name:"warning",category:"remark-like"}],["insight",{name:"insight",category:"remark-like"}],["assemblage",{name:"assemblage",category:"remark-like"}],["example",{name:"example",category:"example-like"}],["question",{name:"question",category:"example-like"}],["problem",{name:"problem",category:"example-like"}],["exercise",{name:"exercise",category:"example-like"}],["activity",{name:"activity",category:"example-like"}],["exploration",{name:"exploration",category:"example-like"}],["investigation",{name:"investigation",category:"example-like"}],["project",{name:"project",category:"example-like"}],["proof",{name:"proof",category:"proof-like"}],["case",{name:"case",category:"proof-like"}],["solution",{name:"solution",category:"solution-like"}],["hint",{name:"hint",category:"solution-like"}],["answer",{name:"answer",category:"solution-like"}]]),P=new Set(["theorem-like","definition-like"]);function x(e){return{type:"root",children:d(e.children,1)}}function v(e){for(const t of e){if(t.type!=="element")continue;const n=t;if(g.has(n.name))return n.name;if(k.has(n.name)){const i=v(n.children);if(i)return i}}}function d(e,t){const n=[];for(const i of e){if(i.type!=="element")continue;const a=i;if(k.has(a.name))n.push(...d(a.children,t));else if(g.has(a.name))n.push(...E(a,Math.min(t,6)));else{const l=u(a);l!==null&&n.push(l)}}return n}function E(e,t){const n=[],i=e.attributes??{},a=e.children,l=a.find(o=>o.type==="element"&&o.name==="title"),s=a.filter(o=>!(o.type==="element"&&o.name==="title")),r={type:"heading",depth:t,children:l?l.children.map(h).filter(m):[],...i["xml:id"]?{data:{id:i["xml:id"],hProperties:{id:i["xml:id"]}}}:{}};n.push(r);const c=Math.min(t+1,6);return n.push(...d(s,c)),n}function u(e){switch(e.name){case"p":return I(e);case"blockquote":return S(e);case"ol":return y(e,!0);case"ul":return y(e,!1);case"program":return D(e);case"me":case"men":case"md":case"mdn":return N(e);default:{const t=M.get(e.name);return t?q(e,t):null}}}function I(e){return{type:"paragraph",children:e.children.map(h).filter(m)}}function S(e){return{type:"blockquote",children:e.children.filter(t=>t.type==="element").map(t=>u(t)).filter(m)}}function y(e,t){return{type:"list",ordered:t,spread:!1,children:e.children.filter(n=>n.type==="element").map(n=>C(n))}}function C(e){return{type:"listItem",spread:!1,children:e.children.filter(t=>t.type==="element").map(t=>u(t)).filter(m)}}function D(e){return{type:"code",lang:(e.attributes??{}).language??null,value:p.getPtxTextContent(e)}}function N(e){const t=e.children;return t.length>0&&t[0].type==="text"?{type:"math",value:p.getPtxTextContent(e)}:{type:"math",value:t.filter(i=>i.type==="element"&&i.name==="mrow").map(i=>p.getPtxTextContent(i)).join(` \\\\
+`)}}function q(e,t){const n=e.attributes??{},i=e.children,a={};n["xml:id"]&&(a.id=n["xml:id"]);for(const[r,c]of Object.entries(n))r==="xml:id"||c==null||(a[r]=c);const l=i.find(r=>r.type==="element"&&r.name==="title"),s=[];if(l){const r={type:"paragraph",data:{directiveLabel:!0},children:l.children.map(h).filter(m)};s.push(r)}if(P.has(t.category))for(const r of i){if(r.type!=="element")continue;const c=r;if(c.name!=="title")if(c.name==="statement")for(const o of c.children){if(o.type!=="element")continue;const f=u(o);f&&s.push(f)}else{const o=u(c);o&&s.push(o)}}else for(const r of i){if(r.type!=="element")continue;const c=r;if(c.name==="title")continue;const o=u(c);o&&s.push(o)}return{type:"containerDirective",name:t.name,attributes:Object.keys(a).length>0?a:void 0,children:s}}function h(e){if(e.type==="text")return{type:"text",value:e.value??""};if(e.type!=="element")return null;const t=e;switch(t.name){case"em":return{type:"emphasis",children:t.children.map(h).filter(m)};case"alert":return{type:"strong",children:t.children.map(h).filter(m)};case"c":return{type:"inlineCode",value:p.getPtxTextContent(t)};case"m":return{type:"inlineMath",value:p.getPtxTextContent(t)};default:return null}}function m(e){return e!==null}function j(e){const t=x(e),n=T.toMarkdown(t,{extensions:[b.directiveToMarkdown(),w.mathToMarkdown()]}),i=v(e.children);return!i||i==="chapter"?n:`---
+division: ${i}
+---
+
+${n}`}exports.ptxastToMarkdown=j;exports.ptxastToMdast=x;

package/dist/index.js

@@ -1,30 +1,17 @@
-import { getPtxTextContent as u } from "@pretextbook/ptxast";
-import { toMarkdown as g } from "mdast-util-to-markdown";
-import { directiveToMarkdown as k } from "mdast-util-directive";
-import { mathToMarkdown as v } from "mdast-util-math";
-const x = /* @__PURE__ */ new Set([
-  "chapter",
-  "section",
-  "subsection",
-  "subsubsection",
-  "paragraphs",
-  // appendix is division-like at the same level as chapter
+import { DIVISION_HIERARCHY as x, getPtxTextContent as p } from "@pretextbook/ptxast";
+import { toMarkdown as b } from "mdast-util-to-markdown";
+import { directiveToMarkdown as T } from "mdast-util-directive";
+import { mathToMarkdown as w } from "mdast-util-math";
+const g = /* @__PURE__ */ new Set([
+  ...x,
   "appendix"
-]), b = {
-  chapter: 1,
-  section: 2,
-  subsection: 3,
-  subsubsection: 4,
-  paragraphs: 5,
-  appendix: 1
-}, T = /* @__PURE__ */ new Set([
+]), k = /* @__PURE__ */ new Set([
   "pretext",
   "book",
   "article",
   "frontmatter",
-  "backmatter",
-  "part"
-]), w = /* @__PURE__ */ new Map([
+  "backmatter"
+]), E = /* @__PURE__ */ new Map([
   // theorem-like
   ["theorem", { name: "theorem", category: "theorem-like" }],
   ["lemma", { name: "lemma", category: "theorem-like" }],
@@ -63,78 +50,88 @@ const x = /* @__PURE__ */ new Set([
   ["solution", { name: "solution", category: "solution-like" }],
   ["hint", { name: "hint", category: "solution-like" }],
   ["answer", { name: "answer", category: "solution-like" }]
-]), E = /* @__PURE__ */ new Set(["theorem-like", "definition-like"]);
-function P(e) {
+]), I = /* @__PURE__ */ new Set(["theorem-like", "definition-like"]);
+function M(e) {
   return {
     type: "root",
-    children: f(e.children, 2)
+    children: h(e.children, 1)
   };
 }
-function f(e, t) {
+function v(e) {
+  for (const t of e) {
+    if (t.type !== "element") continue;
+    const n = t;
+    if (g.has(n.name)) return n.name;
+    if (k.has(n.name)) {
+      const r = v(n.children);
+      if (r) return r;
+    }
+  }
+}
+function h(e, t) {
   const n = [];
   for (const r of e) {
     if (r.type !== "element") continue;
-    const o = r;
-    if (T.has(o.name))
-      n.push(...f(o.children, t));
-    else if (x.has(o.name)) {
-      const l = b[o.name] ?? t;
-      n.push(...M(o, l));
-    } else {
-      const l = p(o);
+    const a = r;
+    if (k.has(a.name))
+      n.push(...h(a.children, t));
+    else if (g.has(a.name))
+      n.push(...P(a, Math.min(t, 6)));
+    else {
+      const l = u(a);
       l !== null && n.push(l);
     }
   }
   return n;
 }
-function M(e, t) {
-  const n = [], r = e.attributes ?? {}, o = e.children, l = o.find(
-    (a) => a.type === "element" && a.name === "title"
-  ), s = o.filter(
-    (a) => !(a.type === "element" && a.name === "title")
+function P(e, t) {
+  const n = [], r = e.attributes ?? {}, a = e.children, l = a.find(
+    (o) => o.type === "element" && o.name === "title"
+  ), m = a.filter(
+    (o) => !(o.type === "element" && o.name === "title")
   ), i = {
     type: "heading",
     depth: t,
-    children: l ? l.children.map(h).filter(m) : [],
+    children: l ? l.children.map(f).filter(s) : [],
     ...r["xml:id"] ? { data: { id: r["xml:id"], hProperties: { id: r["xml:id"] } } } : {}
   };
   n.push(i);
   const c = Math.min(t + 1, 6);
-  return n.push(...f(s, c)), n;
+  return n.push(...h(m, c)), n;
 }
-function p(e) {
+function u(e) {
   switch (e.name) {
     case "p":
-      return I(e);
+      return D(e);
     case "blockquote":
-      return S(e);
+      return N(e);
     case "ol":
       return y(e, !0);
     case "ul":
       return y(e, !1);
     case "program":
-      return N(e);
+      return A(e);
     case "me":
     case "men":
     case "md":
     case "mdn":
-      return j(e);
+      return _(e);
     default: {
-      const t = w.get(e.name);
-      return t ? _(e, t) : null;
+      const t = E.get(e.name);
+      return t ? j(e, t) : null;
     }
   }
 }
-function I(e) {
+function D(e) {
   return {
     type: "paragraph",
-    children: e.children.map(h).filter(m)
+    children: e.children.map(f).filter(s)
   };
 }
-function S(e) {
+function N(e) {
   return {
     type: "blockquote",
-    children: e.children.filter((t) => t.type === "element").map((t) => p(t)).filter(m)
+    children: e.children.filter((t) => t.type === "element").map((t) => u(t)).filter(s)
   };
 }
 function y(e, t) {
@@ -142,58 +139,58 @@ function y(e, t) {
     type: "list",
     ordered: t,
     spread: !1,
-    children: e.children.filter((n) => n.type === "element").map((n) => D(n))
+    children: e.children.filter((n) => n.type === "element").map((n) => S(n))
   };
 }
-function D(e) {
+function S(e) {
   return {
     type: "listItem",
     spread: !1,
-    children: e.children.filter((t) => t.type === "element").map((t) => p(t)).filter(m)
+    children: e.children.filter((t) => t.type === "element").map((t) => u(t)).filter(s)
   };
 }
-function N(e) {
+function A(e) {
   return {
     type: "code",
     lang: (e.attributes ?? {}).language ?? null,
-    value: u(e)
+    value: p(e)
   };
 }
-function j(e) {
+function _(e) {
   const t = e.children;
-  return t.length > 0 && t[0].type === "text" ? { type: "math", value: u(e) } : { type: "math", value: t.filter((r) => r.type === "element" && r.name === "mrow").map((r) => u(r)).join(` \\\\
+  return t.length > 0 && t[0].type === "text" ? { type: "math", value: p(e) } : { type: "math", value: t.filter((r) => r.type === "element" && r.name === "mrow").map((r) => p(r)).join(` \\\\
 `) };
 }
-function _(e, t) {
-  const n = e.attributes ?? {}, r = e.children, o = {};
-  n["xml:id"] && (o.id = n["xml:id"]);
+function j(e, t) {
+  const n = e.attributes ?? {}, r = e.children, a = {};
+  n["xml:id"] && (a.id = n["xml:id"]);
   for (const [i, c] of Object.entries(n))
-    i === "xml:id" || c == null || (o[i] = c);
+    i === "xml:id" || c == null || (a[i] = c);
   const l = r.find(
     (i) => i.type === "element" && i.name === "title"
-  ), s = [];
+  ), m = [];
   if (l) {
     const i = {
       type: "paragraph",
       data: { directiveLabel: !0 },
-      children: l.children.map(h).filter(m)
+      children: l.children.map(f).filter(s)
     };
-    s.push(i);
+    m.push(i);
   }
-  if (E.has(t.category))
+  if (I.has(t.category))
     for (const i of r) {
       if (i.type !== "element") continue;
       const c = i;
       if (c.name !== "title")
         if (c.name === "statement")
-          for (const a of c.children) {
-            if (a.type !== "element") continue;
-            const d = p(a);
-            d && s.push(d);
+          for (const o of c.children) {
+            if (o.type !== "element") continue;
+            const d = u(o);
+            d && m.push(d);
           }
         else {
-          const a = p(c);
-          a && s.push(a);
+          const o = u(c);
+          o && m.push(o);
         }
     }
   else
@@ -201,17 +198,17 @@ function _(e, t) {
       if (i.type !== "element") continue;
       const c = i;
       if (c.name === "title") continue;
-      const a = p(c);
-      a && s.push(a);
+      const o = u(c);
+      o && m.push(o);
     }
   return {
     type: "containerDirective",
     name: t.name,
-    attributes: Object.keys(o).length > 0 ? o : void 0,
-    children: s
+    attributes: Object.keys(a).length > 0 ? a : void 0,
+    children: m
   };
 }
-function h(e) {
+function f(e) {
   if (e.type === "text")
     return { type: "text", value: e.value ?? "" };
   if (e.type !== "element") return null;
@@ -220,31 +217,35 @@ function h(e) {
     case "em":
       return {
         type: "emphasis",
-        children: t.children.map(h).filter(m)
+        children: t.children.map(f).filter(s)
       };
     case "alert":
       return {
         type: "strong",
-        children: t.children.map(h).filter(m)
+        children: t.children.map(f).filter(s)
       };
     case "c":
-      return { type: "inlineCode", value: u(t) };
+      return { type: "inlineCode", value: p(t) };
     case "m":
-      return { type: "inlineMath", value: u(t) };
+      return { type: "inlineMath", value: p(t) };
     default:
       return null;
   }
 }
-function m(e) {
+function s(e) {
   return e !== null;
 }
 function O(e) {
-  const t = P(e);
-  return g(t, {
-    extensions: [k(), v()]
-  });
+  const t = M(e), n = b(t, {
+    extensions: [T(), w()]
+  }), r = v(e.children);
+  return !r || r === "chapter" ? n : `---
+division: ${r}
+---
+
+${n}`;
 }
 export {
   O as ptxastToMarkdown,
-  P as ptxastToMdast
+  M as ptxastToMdast
 };

package/dist/lib/ptxast-to-mdast.d.ts

@@ -1,4 +1,18 @@
 import { Root as MdastRoot } from 'mdast';
-import { Root } from '@pretextbook/ptxast';
+import { Root, ElementContent } from '@pretextbook/ptxast';
+export declare const DIVISION_TYPE_NAMES: Set<string>;
+/**
+ * Structural container types whose content should be recursed into
+ * without emitting a heading, and without changing the current depth.
+ * This handles full ptxast trees that include a `pretext > book > chapter`
+ * hierarchy.
+ */
+export declare const TRANSPARENT_TYPES: Set<string>;
 /** Convert an xast Root (PreTeXt document) to an mdast Root. */
 export declare function ptxastToMdast(root: Root): MdastRoot;
+/**
+ * Find the name of the outermost division in a ptxast tree (skipping
+ * transparent structural wrappers), i.e. the division a depth-1 heading
+ * would represent if this tree were flattened to markdown.
+ */
+export declare function findTopLevelDivision(nodes: ElementContent[]): string | undefined;

package/dist/lib/ptxast-util-to-mdast.d.ts

@@ -3,5 +3,9 @@ export { ptxastToMdast } from './ptxast-to-mdast.js';
 /**
  * Convert an xast Root (PreTeXt document) to a markdown string using the directive
  * syntax for PreTeXt block environments.
+ *
+ * When the document's outermost division isn't `chapter` (the default a
+ * depth-1 heading is assumed to mean), a `division:` frontmatter block is
+ * prepended so the markdown can be converted back to PreTeXt unambiguously.
  */
 export declare function ptxastToMarkdown(root: Root): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/ptxast-util-to-mdast",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Convert ptxast to mdast (markdown AST) and markdown strings",
   "author": "Oscar Levin",
   "license": "GPL-3.0-or-later",
@@ -39,7 +39,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@pretextbook/ptxast": "^0.0.4",
+    "@pretextbook/ptxast": "^0.0.5",
     "@types/mdast": "^4.0.0",
     "mdast-util-directive": "^3.0.0",
     "mdast-util-math": "^3.0.0",