@markup-carve/pandoc-carve 0.1.0

package/dist/row-groups.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The optional `table.rowGroups` partition of PART 12 §15.
+ *
+ * The object holds COUNTS, never rows, so a grouping cannot contradict the
+ * table's flat `rows` - it partitions them, head first, then each body group
+ * (its own intermediate header rows, then its body rows), then the foot.
+ *
+ * §15 states as a MUST that those counts account for every row exactly once.
+ * JSON Schema cannot express a cross-field sum, so `resources/ast-schema.json`
+ * deliberately does not check it and an upstream test pins that a non-summing
+ * partition still validates. A document that validates is therefore not a
+ * document whose partition is coherent, and this bridge has to decide for
+ * itself: a partition that does not add up is refused here rather than turned
+ * into a table whose sections silently disagree with its rows.
+ */
+/** A body group: its intermediate header rows, its body rows, and its extras. */
+export interface RowGroupBody {
+    headRows: number;
+    bodyRows: number;
+    rowHeadColumns?: number;
+    attrs?: unknown;
+}
+/** The whole partition: leading head rows, the body groups, trailing foot rows. */
+export interface RowGroups {
+    headRows: number;
+    bodies: RowGroupBody[];
+    footRows: number;
+}
+/** The outcome of reading the field: at most one of `groups` and `error` is set. */
+export interface RowGroupsRead {
+    groups: RowGroups | null;
+    error: string | null;
+}
+/** The number of rows a partition consumes. */
+export declare function rowGroupsTotal(groups: RowGroups): number;
+/**
+ * Read `table.rowGroups` for a table of `rowCount` rows.
+ *
+ * Absent is not an error: it means the implicit structure every renderer
+ * already derives. Present but unusable IS one, and it is reported rather
+ * than repaired, because guessing which of the counts was meant would produce
+ * a table nobody wrote.
+ */
+export declare function readRowGroups(value: unknown, rowCount: number): RowGroupsRead;

package/dist/row-groups.js

@@ -0,0 +1,86 @@
+/**
+ * The optional `table.rowGroups` partition of PART 12 §15.
+ *
+ * The object holds COUNTS, never rows, so a grouping cannot contradict the
+ * table's flat `rows` - it partitions them, head first, then each body group
+ * (its own intermediate header rows, then its body rows), then the foot.
+ *
+ * §15 states as a MUST that those counts account for every row exactly once.
+ * JSON Schema cannot express a cross-field sum, so `resources/ast-schema.json`
+ * deliberately does not check it and an upstream test pins that a non-summing
+ * partition still validates. A document that validates is therefore not a
+ * document whose partition is coherent, and this bridge has to decide for
+ * itself: a partition that does not add up is refused here rather than turned
+ * into a table whose sections silently disagree with its rows.
+ */
+function isObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+/** A required count: a non-negative integer, nothing else. */
+function count(value) {
+    return typeof value === 'number' && Number.isInteger(value) && value >= 0 ? value : null;
+}
+/** The number of rows a partition consumes. */
+export function rowGroupsTotal(groups) {
+    return (groups.headRows +
+        groups.bodies.reduce((sum, b) => sum + b.headRows + b.bodyRows, 0) +
+        groups.footRows);
+}
+/**
+ * Read `table.rowGroups` for a table of `rowCount` rows.
+ *
+ * Absent is not an error: it means the implicit structure every renderer
+ * already derives. Present but unusable IS one, and it is reported rather
+ * than repaired, because guessing which of the counts was meant would produce
+ * a table nobody wrote.
+ */
+export function readRowGroups(value, rowCount) {
+    if (value === undefined || value === null)
+        return { groups: null, error: null };
+    if (!isObject(value))
+        return { groups: null, error: 'rowGroups is not an object' };
+    const headRows = count(value['headRows']);
+    const footRows = count(value['footRows']);
+    if (headRows === null || footRows === null) {
+        return { groups: null, error: 'rowGroups needs integer headRows and footRows of at least 0' };
+    }
+    if (!Array.isArray(value['bodies'])) {
+        return { groups: null, error: 'rowGroups needs a bodies array (an empty one is a head-only table)' };
+    }
+    const bodies = [];
+    for (const [i, raw] of value['bodies'].entries()) {
+        if (!isObject(raw))
+            return { groups: null, error: `rowGroups body ${i + 1} is not an object` };
+        const bodyHead = count(raw['headRows']);
+        const bodyRows = count(raw['bodyRows']);
+        if (bodyHead === null || bodyRows === null) {
+            return {
+                groups: null,
+                error: `rowGroups body ${i + 1} needs integer headRows and bodyRows of at least 0`,
+            };
+        }
+        const body = { headRows: bodyHead, bodyRows };
+        if (raw['rowHeadColumns'] !== undefined) {
+            const rowHead = count(raw['rowHeadColumns']);
+            if (rowHead === null) {
+                return { groups: null, error: `rowGroups body ${i + 1} has a rowHeadColumns that is not a count` };
+            }
+            if (rowHead > 0)
+                body.rowHeadColumns = rowHead;
+        }
+        if (raw['attrs'] !== undefined)
+            body.attrs = raw['attrs'];
+        bodies.push(body);
+    }
+    const groups = { headRows, bodies, footRows };
+    const total = rowGroupsTotal(groups);
+    if (total !== rowCount) {
+        return {
+            groups: null,
+            error: `rowGroups partitions ${total} row(s) but the table has ${rowCount} ` +
+                `(head ${headRows}, ${bodies.map((b) => `body ${b.headRows}+${b.bodyRows}`).join(', ') || 'no bodies'}, foot ${footRows}). ` +
+                'PART 12 §15 requires the counts to account for every row exactly once, and no schema can check that',
+        };
+    }
+    return { groups, error: null };
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@markup-carve/pandoc-carve",
+  "version": "0.1.0",
+  "description": "Carve to Pandoc bridge: convert Carve markup to Pandoc's JSON AST and reach every pandoc output format (LaTeX, Typst, DOCX, PDF, ...)",
+  "keywords": [
+    "carve",
+    "pandoc",
+    "markup",
+    "converter",
+    "latex",
+    "typst",
+    "ast"
+  ],
+  "license": "MIT",
+  "author": "Mark Scherer",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "pandoc-carve": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc",
+    "examples:build": "npm run build && node scripts/build-examples.mjs",
+    "test": "npm run build && node --test test/*.test.mjs",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/markup-carve/pandoc-carve.git"
+  },
+  "support": {
+    "issues": "https://github.com/markup-carve/pandoc-carve/issues",
+    "source": "https://github.com/markup-carve/pandoc-carve"
+  },
+  "dependencies": {
+    "@markup-carve/carve": "git+https://github.com/markup-carve/carve-js.git#db224f30d10a3c2d7a192b0e60de66563404b7e5"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "ajv": "^8.20.0",
+    "typescript": "^5.8.0"
+  }
+}