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

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"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;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { ptxastToMdast } from './lib/ptxast-to-mdast.js';
+export { ptxastToMarkdown } from './lib/ptxast-util-to-mdast.js';

package/dist/index.js

@@ -0,0 +1,250 @@
+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
+  "appendix"
+]), b = {
+  chapter: 1,
+  section: 2,
+  subsection: 3,
+  subsubsection: 4,
+  paragraphs: 5,
+  appendix: 1
+}, T = /* @__PURE__ */ new Set([
+  "pretext",
+  "book",
+  "article",
+  "frontmatter",
+  "backmatter",
+  "part"
+]), w = /* @__PURE__ */ new Map([
+  // theorem-like
+  ["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-like
+  ["definition", { name: "definition", category: "definition-like" }],
+  ["notation", { name: "notation", category: "definition-like" }],
+  // remark-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-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-like
+  ["proof", { name: "proof", category: "proof-like" }],
+  ["case", { name: "case", category: "proof-like" }],
+  // solution-like
+  ["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) {
+  return {
+    type: "root",
+    children: f(e.children, 2)
+  };
+}
+function f(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);
+      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")
+  ), 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(...f(s, c)), n;
+}
+function p(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 N(e);
+    case "me":
+    case "men":
+    case "md":
+    case "mdn":
+      return j(e);
+    default: {
+      const t = w.get(e.name);
+      return t ? _(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) => p(t)).filter(m)
+  };
+}
+function y(e, t) {
+  return {
+    type: "list",
+    ordered: t,
+    spread: !1,
+    children: e.children.filter((n) => n.type === "element").map((n) => D(n))
+  };
+}
+function D(e) {
+  return {
+    type: "listItem",
+    spread: !1,
+    children: e.children.filter((t) => t.type === "element").map((t) => p(t)).filter(m)
+  };
+}
+function N(e) {
+  return {
+    type: "code",
+    lang: (e.attributes ?? {}).language ?? null,
+    value: u(e)
+  };
+}
+function j(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(` \\\\
+`) };
+}
+function _(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 (E.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);
+          }
+        else {
+          const a = p(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 = p(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: u(t) };
+    case "m":
+      return { type: "inlineMath", value: u(t) };
+    default:
+      return null;
+  }
+}
+function m(e) {
+  return e !== null;
+}
+function O(e) {
+  const t = P(e);
+  return g(t, {
+    extensions: [k(), v()]
+  });
+}
+export {
+  O as ptxastToMarkdown,
+  P as ptxastToMdast
+};

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

@@ -0,0 +1,4 @@
+import { Root as MdastRoot } from 'mdast';
+import { Root } from '@pretextbook/ptxast';
+/** Convert an xast Root (PreTeXt document) to an mdast Root. */
+export declare function ptxastToMdast(root: Root): MdastRoot;

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

@@ -0,0 +1,7 @@
+import { Root } from '@pretextbook/ptxast';
+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.
+ */
+export declare function ptxastToMarkdown(root: Root): string;

package/index.cjs

@@ -1 +1 @@
-module.exports = require('../../dist/packages/ptxast-util-to-mdast/index.cjs');
+module.exports = require('./dist/index.cjs');

package/index.d.ts

@@ -1 +1 @@
-export * from '../../dist/packages/ptxast-util-to-mdast/index.d.ts';
+export * from "./dist/index.d.ts";

package/index.js

@@ -1 +1 @@
-export * from '../../dist/packages/ptxast-util-to-mdast/index.js';
+export * from './dist/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/ptxast-util-to-mdast",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Convert ptxast to mdast (markdown AST) and markdown strings",
   "author": "Oscar Levin",
   "license": "GPL-3.0-or-later",
@@ -32,14 +32,14 @@
     "*.cjs",
     "*.d.ts",
     "*.d.cts",
-    "lib"
+    "dist"
   ],
   "scripts": {
     "build": "vite build",
     "test": "vitest run"
   },
   "dependencies": {
-    "@pretextbook/ptxast": "^0.0.2",
+    "@pretextbook/ptxast": "^0.0.4",
     "@types/mdast": "^4.0.0",
     "mdast-util-directive": "^3.0.0",
     "mdast-util-math": "^3.0.0",