@canopy-iiif/app 0.6.28 → 0.7.0

package/lib/build/assets.js

@@ -0,0 +1,30 @@
+const { fs, fsp, path, ASSETS_DIR, OUT_DIR, ensureDirSync } = require('../common');
+const { logLine } = require('./log');
+
+async function copyAssets() {
+  try {
+    if (!fs.existsSync(ASSETS_DIR)) return;
+  } catch (_) {
+    return;
+  }
+  async function walk(dir) {
+    const entries = await fsp.readdir(dir, { withFileTypes: true });
+    for (const e of entries) {
+      const src = path.join(dir, e.name);
+      const rel = path.relative(ASSETS_DIR, src);
+      const dest = path.join(OUT_DIR, rel);
+      if (e.isDirectory()) { ensureDirSync(dest); await walk(src); }
+      else if (e.isFile()) {
+        ensureDirSync(path.dirname(dest));
+        await fsp.copyFile(src, dest);
+        try { logLine(`• Asset ${path.relative(process.cwd(), dest)}`, 'cyan', { dim: true }); } catch (_) {}
+      }
+    }
+  }
+  try { logLine('• Copying assets...', 'blue', { bright: true }); } catch (_) {}
+  await walk(ASSETS_DIR);
+  try { logLine('✓ Assets copied', 'green'); } catch (_) {}
+}
+
+module.exports = { copyAssets };
+

package/lib/build/build.js

@@ -0,0 +1,184 @@
+const {
+  fs,
+  path,
+  CONTENT_DIR,
+  OUT_DIR,
+  ensureDirSync,
+  cleanDir,
+} = require("../common");
+const mdx = require("./mdx");
+const iiif = require("./iiif");
+const pages = require("./pages");
+const search = require("../search/search");
+const searchBuild = require("./search");
+const { buildSearchIndex } = require("./search-index");
+const { generateFacets } = require("./facets");
+const runtimes = require("./runtimes");
+const { ensureStyles } = require("./styles");
+const { copyAssets } = require("./assets");
+const { logLine } = require("./log");
+
+// hold records between builds if skipping IIIF
+let iiifRecordsCache = [];
+let pageRecords = [];
+
+async function build(options = {}) {
+  const skipIiif = !!options?.skipIiif;
+  if (!fs.existsSync(CONTENT_DIR)) {
+    console.error("No content directory found at", CONTENT_DIR);
+    process.exit(1);
+  }
+
+  /**
+   * Clean and prepare output directory
+   */
+  logLine("\n[1/6] Clean and prepare directories", "magenta", {
+    bright: true,
+  });
+  mdx?.resetMdxCaches();
+  if (!skipIiif) {
+    await cleanDir(OUT_DIR);
+    logLine("✓ Cleaned output directory\n", "cyan");
+  } else {
+    logLine("• Incremental rebuild\n", "blue");
+  }
+
+  /**
+   * Build IIIF Collection content from configured source(s).
+   * This includes building IIIF manifests for works and collections,
+   * as well as collecting search records for works.
+   */
+  logLine("\n[2/6] Build IIIF Collection content", "magenta", {
+    bright: true,
+  });
+  let searchRecords = [];
+  if (!skipIiif) {
+    const CONFIG = await iiif.loadConfig();
+    const res = await iiif.buildIiifCollectionPages(CONFIG);
+    searchRecords = Array.isArray(res && res.searchRecords)
+      ? res.searchRecords
+      : [];
+    iiifRecordsCache = searchRecords;
+  } else {
+    searchRecords = Array.isArray(iiifRecordsCache) ? iiifRecordsCache : [];
+  }
+
+  /**
+   * Build contextual MDX content from the content directory.
+   * This includes collecting page metadata for sitemap and search index,
+   * as well as building all MDX pages to HTML.
+   */
+  logLine("\n[3/6] Build contextual content from Markdown pages", "magenta", {
+    bright: true,
+  });
+  // Collect pages metadata for sitemap injection
+  pageRecords = await searchBuild.collectMdxPageRecords();
+  // Build all MDX and assets
+  logLine("\n• Building MDX pages...", "blue", { bright: true });
+  await pages.buildContentTree(CONTENT_DIR, pageRecords);
+  logLine("✓ MDX pages built\n", "green");
+
+  /**
+   * Build search index from IIIF and MDX records, then build or update
+   * the search.html page and search runtime bundle.
+   * This is done after all content is built so that the index is comprehensive.
+   */
+  logLine("\n[4/6] Create search indices", "magenta", { bright: true });
+  try {
+    const searchPath = path.join(OUT_DIR, "search.html");
+    const needCreatePage = !fs.existsSync(searchPath);
+    if (needCreatePage) {
+      try {
+        logLine("• Preparing search (initial)...", "blue", { bright: true });
+      } catch (_) {}
+      // Build result item template (if present) up-front so it can be inlined
+      try {
+        await search.ensureResultTemplate();
+      } catch (_) {}
+      try {
+        logLine("  - Writing empty index...", "blue");
+      } catch (_) {}
+      await search.writeSearchIndex([]);
+      try {
+        logLine("  - Writing runtime...", "blue");
+      } catch (_) {}
+      const timeoutMs = Number(process.env.CANOPY_BUNDLE_TIMEOUT || 10000);
+      let timedOut = false;
+      await runtimes.prepareSearchRuntime(
+        process.env.CANOPY_BUNDLE_TIMEOUT || 10000,
+        "initial"
+      );
+      try {
+        logLine("  - Building search.html...", "blue");
+      } catch (_) {}
+      await search.buildSearchPage();
+      logLine("✓ Created search page", "cyan");
+    }
+    // Always (re)write the search index combining IIIF and MDX pages
+    const combined = await buildSearchIndex(searchRecords, pageRecords);
+    // Build facets for IIIF works based on configured metadata labels
+    await generateFacets(combined);
+    try {
+      logLine("• Writing search runtime (final)...", "blue", { bright: true });
+    } catch (_) {}
+    await runtimes.prepareSearchRuntime(
+      process.env.CANOPY_BUNDLE_TIMEOUT || 10000,
+      "final"
+    );
+    // Rebuild result item template after content processing to capture latest
+    try {
+      await search.ensureResultTemplate();
+    } catch (_) {}
+    // Rebuild search.html to inline the latest result template
+    try {
+      logLine("• Updating search.html...", "blue");
+    } catch (_) {}
+    await search.buildSearchPage();
+    try {
+      logLine("✓ Search page updated", "cyan");
+    } catch (_) {}
+    // Itemize counts by type for a clearer summary
+    const counts = new Map();
+    for (const r of combined) {
+      const t = String((r && r.type) || "page").toLowerCase();
+      counts.set(t, (counts.get(t) || 0) + 1);
+    }
+    const parts = Array.from(counts.entries())
+      .sort((a, b) => b[1] - a[1] || a[0].localeCompare(b[0]))
+      .map(([t, n]) => `${t}: ${n}`);
+    const breakdown = parts.length ? `: ${parts.join(", ")}` : "";
+    logLine(
+      `✓ Search index: ${combined.length} total records${breakdown}`,
+      "cyan"
+    );
+  } catch (_) {}
+
+  /**
+   * Prepare client runtimes (e.g. search) by bundling with esbuild.
+   * This is done early so that MDX content can reference runtime assets if needed.
+   */
+  logLine("\n[5/6] Prepare client runtimes and stylesheets", "magenta", {
+    bright: true,
+  });
+  await runtimes.prepareAllRuntimes();
+  ensureDirSync(path.join(OUT_DIR, "styles"));
+  if (!process.env.CANOPY_SKIP_STYLES) {
+    await ensureStyles();
+    logLine("✓ Wrote styles.css\n", "cyan");
+  }
+
+  /**
+   * Copy static assets from the assets directory to the output directory.
+   */
+  logLine("\n[6/6] Copy static assets", "magenta", { bright: true });
+  await copyAssets();
+}
+
+module.exports = { build };
+
+if (require.main === module) {
+  build().catch((e) => {
+    console.error(e);
+    process.exit(1);
+  });
+}

package/lib/{dev.js → build/dev.js}

@@ -2,11 +2,11 @@ const fs = require('fs');
 const fsp = fs.promises;
 const path = require('path');
 const { spawn } = require('child_process');
-const { build } = require('./build');
+const { build } = require('../build/build');
 const http = require('http');
 const url = require('url');
-const { CONTENT_DIR, OUT_DIR, ASSETS_DIR, ensureDirSync } = require('./common');
-const twHelper = (() => { try { return require('../helpers/build-tailwind'); } catch (_) { return null; } })();
+const { CONTENT_DIR, OUT_DIR, ASSETS_DIR, ensureDirSync } = require('../common');
+const twHelper = (() => { try { return require('../../helpers/build-tailwind'); } catch (_) { return null; } })();
 function resolveTailwindCli() {
   try {
     const cliJs = require.resolve('tailwindcss/lib/cli.js');
@@ -23,7 +23,7 @@ let onBuildSuccess = () => {};
 let onBuildStart = () => {};
 let onCssChange = () => {};
 let nextBuildSkipIiif = false; // hint set by watchers
-const UI_DIST_DIR = path.resolve(path.join(__dirname, '../ui/dist'));
+const UI_DIST_DIR = path.resolve(path.join(__dirname, '../../ui/dist'));
 
 function prettyPath(p) {
   try {
@@ -495,7 +495,7 @@ async function dev() {
         const genDir = path.join(CACHE_DIR, 'tailwind');
         ensureDirSync(genDir);
         const genCfg = path.join(genDir, 'tailwind.config.js');
-        const cfg = `module.exports = {\n  presets: [require('@canopy-iiif/app/ui/canopy-iiif-preset')],\n  content: [\n    './content/**/*.{mdx,html}',\n    './site/**/*.html',\n    './site/**/*.js',\n    './packages/app/ui/**/*.{js,jsx,ts,tsx}',\n    './packages/app/lib/components/**/*.{js,jsx}',\n  ],\n  theme: { extend: {} },\n  plugins: [require('@canopy-iiif/app/ui/canopy-iiif-plugin')],\n};\n`;
+        const cfg = `module.exports = {\n  presets: [require('@canopy-iiif/app/ui/canopy-iiif-preset')],\n  content: [\n    './content/**/*.{mdx,html}',\n    './site/**/*.html',\n    './site/**/*.js',\n    './packages/app/ui/**/*.{js,jsx,ts,tsx}',\n    './packages/app/lib/iiif/components/**/*.{js,jsx}',\n  ],\n  theme: { extend: {} },\n  plugins: [require('@canopy-iiif/app/ui/canopy-iiif-plugin')],\n};\n`;
         fs.writeFileSync(genCfg, cfg, 'utf8');
         configPath = genCfg;
       } catch (_) { configPath = null; }

package/lib/build/facets.js

@@ -0,0 +1,19 @@
+
+const { logLine } = require('./log');
+
+async function generateFacets(combined) {
+  try {
+    const { loadConfig } = require('./iiif');
+    const searchBuild = require('./search');
+    const cfg = await loadConfig();
+    const labels = Array.isArray(cfg && cfg.metadata) ? cfg.metadata : [];
+    await searchBuild.buildFacetsForWorks(combined, labels);
+    await searchBuild.writeFacetCollections(labels, combined);
+    await searchBuild.writeFacetsSearchApi();
+    try { logLine('✓ Facets generated', 'cyan'); } catch (_) {}
+  } catch (e) {
+    try { logLine('! Facets generation skipped', 'yellow'); } catch (_) {}
+  }
+}
+
+module.exports = { generateFacets };