adf2markdown 1.1.0 → 1.1.2

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { adf2markdown, type Adf } from "./src/adf2markdown";

package/dist/index.js

@@ -0,0 +1,134 @@
+// src/adf2markdown.ts
+function getChildren(node) {
+  return node?.content ?? [];
+}
+function renderEachChildren(node, context, renderChild) {
+  return getChildren(node).map((child, i, children) => renderChild(child, {
+    ...context,
+    ancestors: [node, ...context.ancestors],
+    siblings: children.slice(0, i)
+  }));
+}
+function renderChildren(node, context, renderChild = renderNode) {
+  return renderEachChildren(node, context, renderChild).join(context.join);
+}
+var markRenders = {
+  strong: (text) => `**${text}**`,
+  em: (text) => `_${text}_`,
+  strike: (text) => `~~${text}~~`,
+  code: (text) => `\`${text}\``,
+  underline: (text) => `<u>${text}</u>`,
+  link: (text, mark) => `[${text}](${mark.attrs?.href ?? ""})`,
+  subsup: (text, mark) => mark.attrs?.type === "sub" ? `<sub>${text}</sub>` : `<sup>${text}</sup>`
+};
+var renders = {
+  text(node) {
+    const identity = (text2) => text2;
+    const marks = node.marks ?? [];
+    const text = node.text ?? "";
+    return marks.reduce((text2, mark) => (markRenders[mark.type] ?? identity)(text2, mark), text);
+  },
+  heading(node, context) {
+    const level = Number(node.attrs?.level ?? 1);
+    const hashes = "#".repeat(level);
+    return `${hashes} ${renderChildren(node, { ...context, join: " " })}`;
+  },
+  orderedList: (node, context) => renderChildren(node, { ...context, join: `
+` }),
+  bulletList: (node, context) => renderChildren(node, { ...context, join: `
+` }),
+  decisionItem(node, context) {
+    return `> ${renderChildren(node, { ...context, join: " " })}`;
+  },
+  listItem(node, context) {
+    const parent = context.ancestors[0];
+    const listTypes = ["bulletList", "orderedList"];
+    const isParentList = parent && listTypes.includes(parent.type);
+    const isParentOrderedList = parent?.type === "orderedList";
+    return renderChildren(node, context, (child) => {
+      const isChildText = child.type === "text" || child.type === "paragraph";
+      if (isParentList && isChildText) {
+        const level = context.ancestors.filter((ancestor) => listTypes.includes(ancestor.type)).length;
+        const indentSymbol = isParentOrderedList ? "   " : "  ";
+        const indent = indentSymbol.repeat(level - 1);
+        const symbol = isParentOrderedList ? `${context.siblings.length + 1}.` : "-";
+        return `${indent}${symbol} ${renderNode(child, { ...context, join: " " })}`;
+      }
+      return renderNode(child, context);
+    });
+  },
+  taskItem(node, context) {
+    const state = node.attrs?.state === "DONE" ? "x" : " ";
+    return `[${state}] ${renderChildren(node, { ...context, join: " " })}`;
+  },
+  blockquote(node, context) {
+    return renderChildren(node, context).split(`
+`).map((line) => `> ${line}`).join(`
+`);
+  },
+  codeBlock(node, context) {
+    const language = node.attrs?.language ?? "";
+    return `\`\`\`${language}
+${renderChildren(node, { ...context, join: `
+` })}
+\`\`\``;
+  },
+  panel(node, context) {
+    const panelType = String(node.attrs?.panelType ?? "info");
+    const title = panelType + ":";
+    const content = renderChildren(node, context);
+    return `> **${title}**
+${content.split(`
+`).map((line) => `> ${line}`).join(`
+`)}`;
+  },
+  table(node, context) {
+    const rows = renderEachChildren(node, context, (row) => {
+      return renderEachChildren(row, { ...context, join: " " }, renderNode);
+    });
+    const columnWidths = [];
+    for (const row of rows) {
+      for (const [i, cell] of row.entries()) {
+        columnWidths[i] = Math.max(columnWidths[i] ?? 0, cell.length);
+      }
+    }
+    const wrap = (text) => `| ${text} |`;
+    const formattedRows = rows.map((row) => wrap(row.map((cell, i) => cell.padEnd(columnWidths[i] ?? 0)).join(" | ")));
+    const hasHeader = getChildren(getChildren(node)[0]).some((cell) => cell.type === "tableHeader");
+    if (hasHeader) {
+      const separatorRow = wrap(columnWidths.map((width) => "-".repeat(width)).join(" | "));
+      formattedRows.splice(1, 0, separatorRow);
+    }
+    return formattedRows.join(`
+`);
+  },
+  paragraph: (node, context) => renderChildren(node, { ...context, join: "" }),
+  rule: () => "---",
+  inlineCard: (node) => `[${node.attrs?.url ?? ""}](${node.attrs?.url ?? ""})`,
+  emoji: (node) => String(node.attrs?.text ?? node.attrs?.shortName ?? ""),
+  date: (node) => new Date(Number(node.attrs?.timestamp ?? 0)).toISOString(),
+  status: (node) => `[${node.attrs?.text ?? ""}]`,
+  mention: (node) => String(node.attrs?.text ?? ""),
+  hardBreak: () => "<br/>",
+  media(node) {
+    const alt = node.attrs?.alt ?? "";
+    const linkMark = node.marks?.find((mark) => mark.type === "link");
+    const url = linkMark?.attrs?.href ?? node.attrs?.url ?? "";
+    return `![${alt}](${url})`;
+  }
+};
+function renderNode(node, context) {
+  return (renders[node.type] ?? renderChildren)(node, context);
+}
+function adf2markdown(adf) {
+  return renderNode(adf, { join: `
+
+`, ancestors: [], siblings: [] }) + `
+`;
+}
+export {
+  adf2markdown
+};
+
+//# debugId=18C31A676A58776064756E2164756E21
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/adf2markdown.ts"],
+  "sourcesContent": [
+    "// https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/\n// https://developer.atlassian.com/platform/forge/ui-kit/components/adf-renderer/\n\ninterface Context {\n  ancestors: Node[];\n  siblings: Node[];\n  join: string;\n}\n\ninterface Mark {\n  type: string;\n  attrs?: Record<string, unknown>;\n}\n\ninterface Node {\n  type: string;\n  text?: string;\n  content?: Node[];\n  marks?: Mark[];\n  attrs?: Record<string, unknown>;\n}\n\nexport interface Adf extends Node {\n  version: number;\n}\n\nfunction getChildren(node?: Node | null): Node[] {\n  return node?.content ?? [];\n}\n\ntype RenderChild<Result> = (child: Node, context: Context) => Result;\n\nfunction renderEachChildren<Result>(node: Node, context: Context, renderChild: RenderChild<Result>): Result[] {\n  return getChildren(node).map((child, i, children) =>\n    renderChild(child, {\n      ...context,\n      ancestors: [node, ...context.ancestors],\n      siblings: children.slice(0, i),\n    }),\n  );\n}\n\nfunction renderChildren(node: Node, context: Context, renderChild = renderNode) {\n  return renderEachChildren(node, context, renderChild).join(context.join);\n}\n\ntype MarkRender = (text: string, mark: Mark) => string;\n\nconst markRenders: Record<string, MarkRender> = {\n  strong: (text) => `**${text}**`,\n  em: (text) => `_${text}_`,\n  strike: (text) => `~~${text}~~`,\n  code: (text) => `\\`${text}\\``,\n  underline: (text) => `<u>${text}</u>`,\n  link: (text, mark) => `[${text}](${mark.attrs?.href ?? \"\"})`,\n  subsup: (text, mark) => (mark.attrs?.type === \"sub\" ? `<sub>${text}</sub>` : `<sup>${text}</sup>`),\n};\n\ntype Render = (node: Node, context: Context) => string;\n\nconst renders: Record<string, Render> = {\n  text(node) {\n    const identity = (text: string) => text;\n    const marks = node.marks ?? [];\n    const text = node.text ?? \"\";\n\n    return marks.reduce((text, mark) => (markRenders[mark.type] ?? identity)(text, mark), text);\n  },\n\n  heading(node, context) {\n    const level = Number(node.attrs?.level ?? 1);\n    const hashes = \"#\".repeat(level);\n    return `${hashes} ${renderChildren(node, { ...context, join: \" \" })}`;\n  },\n\n  orderedList: (node, context) => renderChildren(node, { ...context, join: \"\\n\" }),\n  bulletList: (node, context) => renderChildren(node, { ...context, join: \"\\n\" }),\n\n  decisionItem(node, context) {\n    return `> ${renderChildren(node, { ...context, join: \" \" })}`;\n  },\n\n  listItem(node, context) {\n    const parent = context.ancestors[0];\n    const listTypes = [\"bulletList\", \"orderedList\"];\n    const isParentList = parent && listTypes.includes(parent.type);\n    const isParentOrderedList = parent?.type === \"orderedList\";\n\n    return renderChildren(node, context, (child: Node) => {\n      const isChildText = child.type === \"text\" || child.type === \"paragraph\";\n\n      if (isParentList && isChildText) {\n        const level = context.ancestors.filter((ancestor) => listTypes.includes(ancestor.type)).length;\n        const indentSymbol = isParentOrderedList ? \"   \" : \"  \";\n        const indent = indentSymbol.repeat(level - 1);\n        const symbol = isParentOrderedList ? `${context.siblings.length + 1}.` : \"-\";\n        return `${indent}${symbol} ${renderNode(child, { ...context, join: \" \" })}`;\n      }\n\n      return renderNode(child, context);\n    });\n  },\n\n  taskItem(node, context) {\n    const state = node.attrs?.state === \"DONE\" ? \"x\" : \" \";\n    return `[${state}] ${renderChildren(node, { ...context, join: \" \" })}`;\n  },\n\n  blockquote(node, context) {\n    return renderChildren(node, context)\n      .split(\"\\n\")\n      .map((line) => `> ${line}`)\n      .join(\"\\n\");\n  },\n\n  codeBlock(node, context) {\n    const language = node.attrs?.language ?? \"\";\n    return `\\`\\`\\`${language}\\n${renderChildren(node, { ...context, join: \"\\n\" })}\\n\\`\\`\\``;\n  },\n\n  panel(node, context) {\n    const panelType = String(node.attrs?.panelType ?? \"info\");\n    const title = panelType + \":\";\n    const content = renderChildren(node, context);\n\n    return `> **${title}**\\n${content\n      .split(\"\\n\")\n      .map((line) => `> ${line}`)\n      .join(\"\\n\")}`;\n  },\n\n  table(node, context) {\n    const rows = renderEachChildren(node, context, (row: Node) => {\n      return renderEachChildren(row, { ...context, join: \" \" }, renderNode);\n    });\n\n    const columnWidths: number[] = [];\n    for (const row of rows) {\n      for (const [i, cell] of row.entries()) {\n        columnWidths[i] = Math.max(columnWidths[i] ?? 0, cell.length);\n      }\n    }\n\n    const wrap = (text: string) => `| ${text} |`;\n\n    const formattedRows = rows.map((row) => wrap(row.map((cell, i) => cell.padEnd(columnWidths[i] ?? 0)).join(\" | \")));\n\n    const hasHeader = getChildren(getChildren(node)[0]).some((cell) => cell.type === \"tableHeader\");\n    if (hasHeader) {\n      const separatorRow = wrap(columnWidths.map((width) => \"-\".repeat(width)).join(\" | \"));\n      formattedRows.splice(1, 0, separatorRow);\n    }\n\n    return formattedRows.join(\"\\n\");\n  },\n\n  paragraph: (node, context) => renderChildren(node, { ...context, join: \"\" }),\n  rule: () => \"---\",\n  inlineCard: (node) => `[${node.attrs?.url ?? \"\"}](${node.attrs?.url ?? \"\"})`,\n  emoji: (node) => String(node.attrs?.text ?? node.attrs?.shortName ?? \"\"),\n  date: (node) => new Date(Number(node.attrs?.timestamp ?? 0)).toISOString(),\n  status: (node) => `[${node.attrs?.text ?? \"\"}]`,\n  mention: (node) => String(node.attrs?.text ?? \"\"),\n  hardBreak: () => \"<br/>\",\n  media(node) {\n    const alt = node.attrs?.alt ?? \"\";\n    const linkMark = node.marks?.find((mark) => mark.type === \"link\");\n    const url = linkMark?.attrs?.href ?? node.attrs?.url ?? \"\";\n    return `![${alt}](${url})`;\n  },\n};\n\nfunction renderNode(node: Node, context: Context): string {\n  return (renders[node.type] ?? renderChildren)(node, context);\n}\n\nexport function adf2markdown(adf: Adf): string {\n  return renderNode(adf, { join: \"\\n\\n\", ancestors: [], siblings: [] }) + \"\\n\";\n}\n"
+  ],
+  "mappings": ";AA0BA,SAAS,WAAW,CAAC,MAA4B;AAAA,EAC/C,OAAO,MAAM,WAAW,CAAC;AAAA;AAK3B,SAAS,kBAA0B,CAAC,MAAY,SAAkB,aAA4C;AAAA,EAC5G,OAAO,YAAY,IAAI,EAAE,IAAI,CAAC,OAAO,GAAG,aACtC,YAAY,OAAO;AAAA,OACd;AAAA,IACH,WAAW,CAAC,MAAM,GAAG,QAAQ,SAAS;AAAA,IACtC,UAAU,SAAS,MAAM,GAAG,CAAC;AAAA,EAC/B,CAAC,CACH;AAAA;AAGF,SAAS,cAAc,CAAC,MAAY,SAAkB,cAAc,YAAY;AAAA,EAC9E,OAAO,mBAAmB,MAAM,SAAS,WAAW,EAAE,KAAK,QAAQ,IAAI;AAAA;AAKzE,IAAM,cAA0C;AAAA,EAC9C,QAAQ,CAAC,SAAS,KAAK;AAAA,EACvB,IAAI,CAAC,SAAS,IAAI;AAAA,EAClB,QAAQ,CAAC,SAAS,KAAK;AAAA,EACvB,MAAM,CAAC,SAAS,KAAK;AAAA,EACrB,WAAW,CAAC,SAAS,MAAM;AAAA,EAC3B,MAAM,CAAC,MAAM,SAAS,IAAI,SAAS,KAAK,OAAO,QAAQ;AAAA,EACvD,QAAQ,CAAC,MAAM,SAAU,KAAK,OAAO,SAAS,QAAQ,QAAQ,eAAe,QAAQ;AACvF;AAIA,IAAM,UAAkC;AAAA,EACtC,IAAI,CAAC,MAAM;AAAA,IACT,MAAM,WAAW,CAAC,UAAiB;AAAA,IACnC,MAAM,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC7B,MAAM,OAAO,KAAK,QAAQ;AAAA,IAE1B,OAAO,MAAM,OAAO,CAAC,OAAM,UAAU,YAAY,KAAK,SAAS,UAAU,OAAM,IAAI,GAAG,IAAI;AAAA;AAAA,EAG5F,OAAO,CAAC,MAAM,SAAS;AAAA,IACrB,MAAM,QAAQ,OAAO,KAAK,OAAO,SAAS,CAAC;AAAA,IAC3C,MAAM,SAAS,IAAI,OAAO,KAAK;AAAA,IAC/B,OAAO,GAAG,UAAU,eAAe,MAAM,KAAK,SAAS,MAAM,IAAI,CAAC;AAAA;AAAA,EAGpE,aAAa,CAAC,MAAM,YAAY,eAAe,MAAM,KAAK,SAAS,MAAM;AAAA,EAAK,CAAC;AAAA,EAC/E,YAAY,CAAC,MAAM,YAAY,eAAe,MAAM,KAAK,SAAS,MAAM;AAAA,EAAK,CAAC;AAAA,EAE9E,YAAY,CAAC,MAAM,SAAS;AAAA,IAC1B,OAAO,KAAK,eAAe,MAAM,KAAK,SAAS,MAAM,IAAI,CAAC;AAAA;AAAA,EAG5D,QAAQ,CAAC,MAAM,SAAS;AAAA,IACtB,MAAM,SAAS,QAAQ,UAAU;AAAA,IACjC,MAAM,YAAY,CAAC,cAAc,aAAa;AAAA,IAC9C,MAAM,eAAe,UAAU,UAAU,SAAS,OAAO,IAAI;AAAA,IAC7D,MAAM,sBAAsB,QAAQ,SAAS;AAAA,IAE7C,OAAO,eAAe,MAAM,SAAS,CAAC,UAAgB;AAAA,MACpD,MAAM,cAAc,MAAM,SAAS,UAAU,MAAM,SAAS;AAAA,MAE5D,IAAI,gBAAgB,aAAa;AAAA,QAC/B,MAAM,QAAQ,QAAQ,UAAU,OAAO,CAAC,aAAa,UAAU,SAAS,SAAS,IAAI,CAAC,EAAE;AAAA,QACxF,MAAM,eAAe,sBAAsB,QAAQ;AAAA,QACnD,MAAM,SAAS,aAAa,OAAO,QAAQ,CAAC;AAAA,QAC5C,MAAM,SAAS,sBAAsB,GAAG,QAAQ,SAAS,SAAS,OAAO;AAAA,QACzE,OAAO,GAAG,SAAS,UAAU,WAAW,OAAO,KAAK,SAAS,MAAM,IAAI,CAAC;AAAA,MAC1E;AAAA,MAEA,OAAO,WAAW,OAAO,OAAO;AAAA,KACjC;AAAA;AAAA,EAGH,QAAQ,CAAC,MAAM,SAAS;AAAA,IACtB,MAAM,QAAQ,KAAK,OAAO,UAAU,SAAS,MAAM;AAAA,IACnD,OAAO,IAAI,UAAU,eAAe,MAAM,KAAK,SAAS,MAAM,IAAI,CAAC;AAAA;AAAA,EAGrE,UAAU,CAAC,MAAM,SAAS;AAAA,IACxB,OAAO,eAAe,MAAM,OAAO,EAChC,MAAM;AAAA,CAAI,EACV,IAAI,CAAC,SAAS,KAAK,MAAM,EACzB,KAAK;AAAA,CAAI;AAAA;AAAA,EAGd,SAAS,CAAC,MAAM,SAAS;AAAA,IACvB,MAAM,WAAW,KAAK,OAAO,YAAY;AAAA,IACzC,OAAO,SAAS;AAAA,EAAa,eAAe,MAAM,KAAK,SAAS,MAAM;AAAA,EAAK,CAAC;AAAA;AAAA;AAAA,EAG9E,KAAK,CAAC,MAAM,SAAS;AAAA,IACnB,MAAM,YAAY,OAAO,KAAK,OAAO,aAAa,MAAM;AAAA,IACxD,MAAM,QAAQ,YAAY;AAAA,IAC1B,MAAM,UAAU,eAAe,MAAM,OAAO;AAAA,IAE5C,OAAO,OAAO;AAAA,EAAY,QACvB,MAAM;AAAA,CAAI,EACV,IAAI,CAAC,SAAS,KAAK,MAAM,EACzB,KAAK;AAAA,CAAI;AAAA;AAAA,EAGd,KAAK,CAAC,MAAM,SAAS;AAAA,IACnB,MAAM,OAAO,mBAAmB,MAAM,SAAS,CAAC,QAAc;AAAA,MAC5D,OAAO,mBAAmB,KAAK,KAAK,SAAS,MAAM,IAAI,GAAG,UAAU;AAAA,KACrE;AAAA,IAED,MAAM,eAAyB,CAAC;AAAA,IAChC,WAAW,OAAO,MAAM;AAAA,MACtB,YAAY,GAAG,SAAS,IAAI,QAAQ,GAAG;AAAA,QACrC,aAAa,KAAK,KAAK,IAAI,aAAa,MAAM,GAAG,KAAK,MAAM;AAAA,MAC9D;AAAA,IACF;AAAA,IAEA,MAAM,OAAO,CAAC,SAAiB,KAAK;AAAA,IAEpC,MAAM,gBAAgB,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,MAAM,MAAM,KAAK,OAAO,aAAa,MAAM,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC;AAAA,IAEjH,MAAM,YAAY,YAAY,YAAY,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa;AAAA,IAC9F,IAAI,WAAW;AAAA,MACb,MAAM,eAAe,KAAK,aAAa,IAAI,CAAC,UAAU,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC;AAAA,MACpF,cAAc,OAAO,GAAG,GAAG,YAAY;AAAA,IACzC;AAAA,IAEA,OAAO,cAAc,KAAK;AAAA,CAAI;AAAA;AAAA,EAGhC,WAAW,CAAC,MAAM,YAAY,eAAe,MAAM,KAAK,SAAS,MAAM,GAAG,CAAC;AAAA,EAC3E,MAAM,MAAM;AAAA,EACZ,YAAY,CAAC,SAAS,IAAI,KAAK,OAAO,OAAO,OAAO,KAAK,OAAO,OAAO;AAAA,EACvE,OAAO,CAAC,SAAS,OAAO,KAAK,OAAO,QAAQ,KAAK,OAAO,aAAa,EAAE;AAAA,EACvE,MAAM,CAAC,SAAS,IAAI,KAAK,OAAO,KAAK,OAAO,aAAa,CAAC,CAAC,EAAE,YAAY;AAAA,EACzE,QAAQ,CAAC,SAAS,IAAI,KAAK,OAAO,QAAQ;AAAA,EAC1C,SAAS,CAAC,SAAS,OAAO,KAAK,OAAO,QAAQ,EAAE;AAAA,EAChD,WAAW,MAAM;AAAA,EACjB,KAAK,CAAC,MAAM;AAAA,IACV,MAAM,MAAM,KAAK,OAAO,OAAO;AAAA,IAC/B,MAAM,WAAW,KAAK,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,MAAM;AAAA,IAChE,MAAM,MAAM,UAAU,OAAO,QAAQ,KAAK,OAAO,OAAO;AAAA,IACxD,OAAO,KAAK,QAAQ;AAAA;AAExB;AAEA,SAAS,UAAU,CAAC,MAAY,SAA0B;AAAA,EACxD,QAAQ,QAAQ,KAAK,SAAS,gBAAgB,MAAM,OAAO;AAAA;AAGtD,SAAS,YAAY,CAAC,KAAkB;AAAA,EAC7C,OAAO,WAAW,KAAK,EAAE,MAAM;AAAA;AAAA,GAAQ,WAAW,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI;AAAA;AAAA;",
+  "debugId": "18C31A676A58776064756E2164756E21",
+  "names": []
+}

package/dist/src/adf2markdown.d.ts

@@ -0,0 +1,16 @@
+interface Mark {
+    type: string;
+    attrs?: Record<string, unknown>;
+}
+interface Node {
+    type: string;
+    text?: string;
+    content?: Node[];
+    marks?: Mark[];
+    attrs?: Record<string, unknown>;
+}
+export interface Adf extends Node {
+    version: number;
+}
+export declare function adf2markdown(adf: Adf): string;
+export {};

package/dist/src/adf2markdown.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adf2markdown",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "keywords": [
     "adf",
     "atlassian",
@@ -25,8 +25,7 @@
     "default": "./dist/index.js"
   },
   "scripts": {
-    "build": "bun build index.ts --outdir ./dist --format esm --target node --sourcemap=linked && tsc -p tsconfig.json --declaration --declarationMap --emitDeclarationOnly --outDir dist",
-    "publish": "bun run build && bun publish",
+    "build": "bun build index.ts --outdir ./dist --format esm --target node --sourcemap=linked && tsc --declaration --emitDeclarationOnly --outDir dist --noEmit false",
     "check": "bun audit && bun run format:check && bun run knip && bun run lint && bun run typeCheck && bun test",
     "test": "bun test",
     "lint": "oxlint",