@unfoldingword/door43-preview-renderers 1.5.0

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@unfoldingword/door43-preview-renderers",
+  "version": "1.5.0",
+  "type": "module",
+  "description": "JavaScript library for gathering content from various repositories and rendering HTML snippets for web previews and PDFs",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "bin": {
+    "door43-renderers": "./src/cli.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/index.js",
+    "dist/index.esm.js",
+    "src/cli.js"
+  ],
+  "scripts": {
+    "fetch-logos": "node scripts/fetch-logos.mjs",
+    "prebuild": "node -e \"const f='src/assets/logos.generated.js';require('fs').existsSync(f)||require('child_process').execSync('node scripts/fetch-logos.mjs',{stdio:'inherit'})\"",
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js",
+    "test:watch": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --watch",
+    "test:coverage": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --coverage",
+    "cli": "node src/cli.js",
+    "lint": "eslint src --ext .js,.jsx",
+    "format": "prettier --write \"src/**/*.{js,jsx,json,md}\"",
+    "styleguide": "styleguidist server --config styleguide.config.cjs",
+    "styleguide:dev": "styleguidist server --config styleguide.config.cjs",
+    "styleguide:build": "pnpm run build && styleguidist build --config styleguide.config.cjs",
+    "prepare": "pnpm run build"
+  },
+  "keywords": [
+    "door43",
+    "preview",
+    "renderer",
+    "html",
+    "pdf",
+    "bible",
+    "translation"
+  ],
+  "author": "unfoldingWord",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unfoldingWord/door43-preview-renderers.git"
+  },
+  "bugs": {
+    "url": "https://github.com/unfoldingWord/door43-preview-renderers/issues"
+  },
+  "homepage": "https://github.com/unfoldingWord/door43-preview-renderers#readme",
+  "devDependencies": {
+    "@babel/core": "^7.23.0",
+    "@babel/preset-env": "^7.23.0",
+    "@babel/preset-react": "^7.23.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "babel-loader": "^9.1.3",
+    "css-loader": "^6.8.1",
+    "eslint": "^8.51.0",
+    "jest": "^29.7.0",
+    "netlify-cli": "^23.11.1",
+    "prettier": "^3.0.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-styleguidist": "^13.1.2",
+    "rollup": "^4.1.4",
+    "style-loader": "^3.3.3",
+    "webpack": "^5.89.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "js-yaml": "^4.1.1",
+    "jszip": "^3.10.1",
+    "markdown-it": "^14.1.1",
+    "proskomma-core": "^0.10.17",
+    "proskomma-json-tools": "0.8.12",
+    "tsv-quote-converters": "^1.1.18",
+    "usfm-alignment-remover": "^0.1.6",
+    "usfm-js": "^3.4.3"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "pnpm": ">=8.0.0"
+  }
+}

package/src/cli.js

@@ -0,0 +1,300 @@
+#!/usr/bin/env node
+
+/**
+ * CLI tool for door43-preview-renderers
+ *
+ * Usage:
+ *   cli.js getAllCatalogEntries --owner unfoldingWord --repo en_tn --ref v80 --book gen [--output file.json] [--dcs-api-url URL]
+ *   cli.js getResourceData --owner unfoldingWord --repo en_tn --ref v80 --book gen [--output file.json] [--dcs-api-url URL]
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { getAllCatalogEntries } from './getAllCatalogEntries.js';
+import { getResourceData } from './getResourceData.js';
+import { renderHtmlData } from './renderHtmlData.js';
+import { renderHTML } from './renderHTML.js';
+import { renderPdf } from './pdf/renderPdf.js';
+
+// Map the CLI's short page-size keys to PAGE_SIZES keys understood by renderHTML/renderPdf.
+function resolveCliPageSize(shortKey) {
+  const map = {
+    A4: 'A4_PORTRAIT',
+    A5: 'A5_PORTRAIT',
+    USL: 'US_LETTER_PORTRAIT',
+    TRADE: 'TRADE',
+    CQ: 'CROWN_QUARTO',
+  };
+  return map[(shortKey || 'A4').toUpperCase()] || 'A4_PORTRAIT';
+}
+
+// Parse command line arguments
+function parseArgs(args) {
+  const parsed = {
+    command: args[0],
+    params: {},
+    quiet: false,
+  };
+
+  for (let i = 1; i < args.length; i++) {
+    const arg = args[i];
+
+    // Handle flags without values
+    if (arg === '--quiet' || arg === '-q') {
+      parsed.quiet = true;
+      continue;
+    }
+
+    // Handle key-value pairs
+    if (arg.startsWith('--')) {
+      const key = arg.replace(/^--/, '').replace(/-/g, '_');
+      const value = args[i + 1];
+
+      if (key === 'book') {
+        parsed.params.bookId = value;
+      } else if (key === 'dcs_api_url') {
+        parsed.params.dcsApiUrl = value;
+      } else if (key === 'output') {
+        parsed.output = value;
+      } else if (key === 'page_size') {
+        parsed.params.pageSize = value;
+      } else if (key === 'columns') {
+        parsed.params.columns = parseInt(value, 10) || 1;
+      } else {
+        parsed.params[key] = value;
+      }
+      i++; // Skip the value in next iteration
+    }
+  }
+
+  return parsed;
+}
+
+// Display help message
+function showHelp() {
+  process.stdout.write(`
+door43-preview-renderers CLI
+
+Usage:
+  cli.js <command> [options]
+
+Commands:
+  getAllCatalogEntries    Get all catalog entries for rendering
+  getResourceData        Get resource data for a specific book
+  renderHtml             Fetch resource data and render to HTML sections (JSON)
+  assemblePrint          Fetch, render, and assemble a print-ready HTML document
+  generatePdf            Fetch, render, assemble, and render a PDF via WeasyPrint (requires the weasyprint binary)
+
+Options:
+  --owner <owner>         Repository owner (required)
+  --repo <repo>           Repository name (required)
+  --ref <ref>             Git reference (branch/tag/commit)
+  --book <bookId>         Book ID (e.g., gen, exo, mat, 1ti)
+  --dcs-api-url <url>     Custom DCS API URL (optional)
+  --output <file>         Output file path (optional, defaults to stdout)
+  --quiet, -q             Suppress logging output (no API URLs or progress messages)
+  --page-size <size>      Page size for assemblePrint (A4, A5, USL, TRADE, CQ; default A4)
+  --columns <n>           Number of columns for assemblePrint (default 1)
+  --pdf-service-url <url> generatePdf: use a hosted weasyprint-pdf service instead of the local binary
+
+Examples:
+  # Get catalog entries and output to stdout
+  node src/cli.js getAllCatalogEntries --owner unfoldingWord --repo en_tn --ref v80 --book gen
+
+  # Get catalog entries with quiet mode (no logging, just JSON)
+  node src/cli.js getAllCatalogEntries --owner unfoldingWord --repo en_tn --ref v80 --book gen --quiet
+
+  # Get catalog entries and save to file
+  node src/cli.js getAllCatalogEntries --owner unfoldingWord --repo en_tn --ref v80 --book gen --output result.json
+
+  # Quiet mode for piping to jq
+  node src/cli.js getAllCatalogEntries --owner BSOJ --repo ar_twl --ref v5 --book 1jn --quiet | jq '.catalogEntries[] | {owner, repo: .name, subject}'
+
+  # Get resource data
+  node src/cli.js getResourceData --owner unfoldingWord --repo en_tn --ref v80 --book gen
+
+  # Render HTML sections (JSON output with body, toc, css, etc.)
+  node src/cli.js renderHtml --owner unfoldingWord --repo en_tn --ref v88 --book tit --quiet
+
+  # Assemble print-ready HTML document (outputs complete HTML)
+  node src/cli.js assemblePrint --owner unfoldingWord --repo en_tn --ref v88 --book tit --output tit_tn.html
+
+  # Assemble with page size options
+  node src/cli.js assemblePrint --owner unfoldingWord --repo en_obs --ref v9 --page-size TRADE --output obs.html
+
+  # Generate a PDF directly (no browser; requires weasyprint installed)
+  node src/cli.js generatePdf --owner unfoldingWord --repo en_tn --ref v88 --book tit --output tit_tn.pdf
+
+  # Use custom DCS API URL
+  node src/cli.js getAllCatalogEntries --owner BSOJ --repo ar_twl --ref v5 --book 1jn --dcs-api-url https://git.door43.org/api/v1
+
+Test Cases:
+  # Valid case
+  node src/cli.js getAllCatalogEntries --owner unfoldingWord --repo en_tn --ref v80 --book gen
+
+  # Invalid book ID (should fail)
+  node src/cli.js getAllCatalogEntries --owner fr_gl --repo fr_tn --ref v2 --book 1th
+
+  # Valid case
+  node src/cli.js getAllCatalogEntries --owner fr_gl --repo gr_tn --ref v2 --book 1ti
+
+  # Aligned Bible case (currently fails, needs fix)
+  node src/cli.js getAllCatalogEntries --owner BSOJ --repo ar_twl --ref v5 --book 1jn
+`);
+}
+
+// Main function
+async function main() {
+  const args = process.argv.slice(2);
+
+  if (args.length === 0 || args[0] === '--help' || args[0] === '-h') {
+    showHelp();
+    process.exit(0);
+  }
+
+  const { command, params, output, quiet } = parseArgs(args);
+
+  // Validate required parameters
+  if (!params.owner || !params.repo) {
+    console.error('Error: --owner and --repo are required');
+    console.error('Use --help for usage information');
+    process.exit(1);
+  }
+
+  try {
+    let result;
+
+    switch (command) {
+      case 'getAllCatalogEntries': {
+        if (!quiet) {
+          console.error(`Fetching catalog entries for ${params.owner}/${params.repo}...`);
+        }
+        const books = params.bookId ? [params.bookId] : [];
+        result = await getAllCatalogEntries(
+          { owner: params.owner, repo: params.repo, ref: params.ref, books },
+          { dcs_api_url: params.dcsApiUrl || 'https://git.door43.org/api/v1', quiet }
+        );
+        break;
+      }
+
+      case 'getResourceData': {
+        if (!quiet) {
+          console.error(`Fetching resource data for ${params.owner}/${params.repo}...`);
+        }
+        const resourceBooks = params.bookId ? [params.bookId] : [];
+        result = await getResourceData(
+          { owner: params.owner, repo: params.repo, ref: params.ref, books: resourceBooks },
+          { dcs_api_url: params.dcsApiUrl || 'https://git.door43.org/api/v1', quiet }
+        );
+        break;
+      }
+
+      case 'renderHtml': {
+        if (!quiet) {
+          console.error(`Rendering HTML for ${params.owner}/${params.repo}...`);
+        }
+        const renderBooks = params.bookId ? [params.bookId] : [];
+        const resourceData = await getResourceData(
+          { owner: params.owner, repo: params.repo, ref: params.ref, books: renderBooks },
+          { dcs_api_url: params.dcsApiUrl || 'https://git.door43.org/api/v1', quiet }
+        );
+        // HtmlData package (identity + sections); the body can be large.
+        result = renderHtmlData(resourceData, { books: renderBooks });
+        break;
+      }
+
+      case 'assemblePrint': {
+        if (!quiet) {
+          console.error(`Assembling print document for ${params.owner}/${params.repo}...`);
+        }
+        const printBooks = params.bookId ? [params.bookId] : [];
+        const resourceData = await getResourceData(
+          { owner: params.owner, repo: params.repo, ref: params.ref, books: printBooks },
+          { dcs_api_url: params.dcsApiUrl || 'https://git.door43.org/api/v1', quiet }
+        );
+        const htmlData = renderHtmlData(resourceData, { books: printBooks });
+        const html = renderHTML(htmlData, {
+          media: 'print',
+          columns: params.columns || 1,
+          print: { pageSize: resolveCliPageSize(params.pageSize) },
+        });
+
+        // For assemblePrint, output the raw HTML, not JSON
+        if (output) {
+          const outputPath = path.resolve(output);
+          fs.writeFileSync(outputPath, html);
+          console.error(`✓ Print-ready HTML written to ${outputPath}`);
+          process.exit(0);
+        } else {
+          process.stdout.write(html + '\n', () => {
+            process.exit(0);
+          });
+        }
+        return; // Skip JSON formatting below
+      }
+
+      case 'generatePdf': {
+        if (!output) {
+          console.error('Error: generatePdf requires --output <file.pdf>');
+          process.exit(1);
+        }
+        if (!quiet) {
+          console.error(`Generating PDF for ${params.owner}/${params.repo}...`);
+        }
+        const pdfBooks = params.bookId ? [params.bookId] : [];
+        const resourceData = await getResourceData(
+          { owner: params.owner, repo: params.repo, ref: params.ref, books: pdfBooks },
+          { dcs_api_url: params.dcsApiUrl || 'https://git.door43.org/api/v1', quiet }
+        );
+        const htmlData = renderHtmlData(resourceData, { books: pdfBooks });
+        const pdfOutputPath = path.resolve(output);
+        await renderPdf(htmlData, {
+          pageSize: resolveCliPageSize(params.pageSize),
+          columns: params.columns || 1,
+          outputPath: pdfOutputPath,
+          // Offload to a hosted weasyprint-pdf service instead of the local binary.
+          pdfServiceUrl: params.pdf_service_url,
+          quiet,
+        });
+        console.error(`✓ PDF written to ${pdfOutputPath}`);
+        process.exit(0);
+        return;
+      }
+
+      default:
+        console.error(`Error: Unknown command "${command}"`);
+        console.error(
+          'Valid commands: getAllCatalogEntries, getResourceData, renderHtml, assemblePrint, generatePdf'
+        );
+        process.exit(1);
+    }
+
+    // Format output
+    const jsonOutput = JSON.stringify(result, null, 2);
+
+    // Write to file or stdout
+    if (output) {
+      const outputPath = path.resolve(output);
+      fs.writeFileSync(outputPath, jsonOutput);
+      console.error(`✓ Output written to ${outputPath}`);
+      process.exit(0);
+    } else {
+      // Write to stdout and wait for it to flush before exiting
+      process.stdout.write(jsonOutput + '\n', () => {
+        process.exit(0);
+      });
+    }
+  } catch (error) {
+    console.error('Error:', error.message);
+    if (error.response) {
+      console.error('API Response:', error.response.status, error.response.statusText);
+      if (error.response.data) {
+        console.error('Details:', error.response.data);
+      }
+    }
+    process.exit(1);
+  }
+}
+
+// Run main function
+main();