@canopy-iiif/app 1.8.14 → 1.9.0

package/lib/build/iiif.js

@@ -16,7 +16,14 @@ const {
   readSiteMetadata,
   readPrimaryNavigation,
   withBase,
+  resolveLocaleFromHref,
+  getLocaleRouteEntries,
+  getDefaultRoute,
+  buildRouteRelativePath,
+  getLocaleRouteConfig,
+  getDefaultLocaleCode,
 } = require("../common");
+const {readCanopyLocalesWithMessages} = require("../locales");
 const {resolveCanopyConfigPath} = require("../config-path");
 const mdx = require("./mdx");
 const {log, logLine, logResponse} = require("./log");
@@ -174,9 +181,9 @@ function normalizeSlugBase(value, fallback) {
   return clampSlugLength(safeFallback, MAX_ENTRY_SLUG_LENGTH) || safeFallback;
 }
 
-function manifestHrefFromSlug(slug) {
+function manifestHrefFromSlug(slug, routePath) {
   if (!slug) return "";
-  const rel = `works/${String(slug).trim()}.html`;
+  const rel = buildRouteRelativePath(routePath || getDefaultRoute("works"), `${String(slug).trim()}.html`);
   return rootRelativeHref(rel);
 }
 
@@ -203,10 +210,10 @@ function extractHomepageId(resource) {
   return "";
 }
 
-function resolveManifestCanonical(manifest, slug) {
+function resolveManifestCanonical(manifest, slug, routePath) {
   const homepageId = extractHomepageId(manifest);
   if (homepageId) return homepageId;
-  return manifestHrefFromSlug(slug);
+  return manifestHrefFromSlug(slug, routePath);
 }
 
 function resolveCollectionCanonical(collection) {
@@ -223,9 +230,9 @@ function assignEntryCanonical(entry, canonical) {
   return value;
 }
 
-function applyManifestEntryCanonical(entry, manifest, slug) {
+function applyManifestEntryCanonical(entry, manifest, slug, routePath) {
   if (!entry || entry.type !== "Manifest") return "";
-  const canonical = resolveManifestCanonical(manifest, slug);
+  const canonical = resolveManifestCanonical(manifest, slug, routePath);
   return assignEntryCanonical(entry, canonical);
 }
 
@@ -1127,7 +1134,7 @@ async function loadCachedManifestById(id) {
               slug,
               parent: "",
             };
-            applyManifestEntryCanonical(entry, null, slug);
+            applyManifestEntryCanonical(entry, null, slug, getDefaultRoute("works"));
             if (existingEntryIdx >= 0) index.byId[existingEntryIdx] = entry;
             else index.byId.push(entry);
             await saveManifestIndex(index);
@@ -1160,6 +1167,7 @@ async function loadCachedManifestById(id) {
           entry,
           normalized,
           slug,
+          getDefaultRoute("works"),
         );
         if (nextCanonical !== prevCanonical) {
           await saveManifestIndex(index);
@@ -1202,7 +1210,7 @@ async function saveCachedManifest(manifest, id, parentId) {
       slug,
       parent: parentId ? String(parentId) : "",
     };
-    applyManifestEntryCanonical(entry, normalizedManifest, slug);
+    applyManifestEntryCanonical(entry, normalizedManifest, slug, getDefaultRoute("works"));
     if (existingEntryIdx >= 0) index.byId[existingEntryIdx] = entry;
     else index.byId.push(entry);
     await saveManifestIndex(index);
@@ -1860,6 +1868,16 @@ async function buildIiifCollectionPages(CONFIG) {
   const iiifRecords = [];
   const navPlaceRecords = [];
   const {size: thumbSize, unsafe: unsafeThumbs} = resolveThumbnailPreferences();
+  let workRouteEntries = getLocaleRouteEntries("works");
+  if (!workRouteEntries.length) {
+    workRouteEntries = [
+      {
+        locale: getDefaultLocaleCode(),
+        route: getDefaultRoute("works"),
+        isDefault: true,
+      },
+    ];
+  }
 
   // Compile the works layout component once per run
   const worksLayoutPath = path.join(CONTENT_DIR, "works", "_layout.mdx");
@@ -2028,10 +2046,20 @@ async function buildIiifCollectionPages(CONFIG) {
         if (normalizedManifestId) renderedManifestIds.add(normalizedManifestId);
         logDebug(`Resolved slug ${slug} for ${manifestLabel}`);
         const references = referenced.getReferencesForManifest(manifestId);
-        const href = path.join("works", slug + ".html");
-        const outPath = path.join(OUT_DIR, href);
-        ensureDirSync(path.dirname(outPath));
-        try {
+        for (const routeEntry of workRouteEntries) {
+          const routeBase =
+            routeEntry && routeEntry.route
+              ? routeEntry.route
+              : getDefaultRoute("works");
+          const isDefaultRoute = routeEntry && routeEntry.isDefault === true;
+          const localeFromRoute =
+            routeEntry && routeEntry.locale
+              ? routeEntry.locale
+              : getDefaultLocaleCode();
+          const href = buildRouteRelativePath(routeBase, `${slug}.html`);
+          const outPath = path.join(OUT_DIR, href);
+          ensureDirSync(path.dirname(outPath));
+          try {
           let components = {};
           try {
             components = await mdx.loadUiComponents();
@@ -2062,8 +2090,9 @@ async function buildIiifCollectionPages(CONFIG) {
           }
           const normalizedHref = href.split(path.sep).join("/");
           const pageHref = rootRelativeHref(normalizedHref);
+          const pageLocale = localeFromRoute || resolveLocaleFromHref(pageHref);
           const pageDescription = summaryForMeta || title;
-          const canonical = resolveManifestCanonical(manifest, slug);
+          const canonical = resolveManifestCanonical(manifest, slug, routeBase);
           const pageDetails = {
             title,
             href: pageHref,
@@ -2074,12 +2103,14 @@ async function buildIiifCollectionPages(CONFIG) {
             manifestId,
             referencedBy: references,
             canonical,
+            locale: pageLocale,
             meta: {
               title,
               description: pageDescription,
               type: "work",
               url: pageHref,
               canonical,
+              locale: pageLocale,
             },
           };
           const ogImageForPage =
@@ -2095,11 +2126,33 @@ async function buildIiifCollectionPages(CONFIG) {
             navigationRoots && Object.keys(navigationRoots).length
               ? {allRoots: navigationRoots}
               : null;
-          const primaryNav = readPrimaryNavigation();
+          const primaryNav = readPrimaryNavigation(pageLocale);
+          const siteMeta = readSiteMetadata ? {...readSiteMetadata()} : null;
+          const siteLanguageToggle = (() => {
+            try {
+              const data = readCanopyLocalesWithMessages();
+              if (data && Array.isArray(data.locales) && data.locales.length) {
+                return {locales: data.locales, messages: data.messages || {}};
+              }
+            } catch (_) {}
+            return null;
+          })();
+          const siteContext = siteMeta ? {...siteMeta} : {};
+          if (siteLanguageToggle) {
+            siteContext.languageToggle = siteLanguageToggle;
+          }
+          try {
+            const localeRoutes = getLocaleRouteConfig(pageLocale);
+            if (localeRoutes) siteContext.routes = localeRoutes;
+          } catch (_) {}
+          try {
+            const defaultRoutes = getLocaleRouteConfig(getDefaultLocaleCode());
+            if (defaultRoutes) siteContext.routesDefault = defaultRoutes;
+          } catch (_) {}
           const pageContextValue = {
             navigation: navigationContext,
             page: pageDetails,
-            site: readSiteMetadata ? {...readSiteMetadata()} : null,
+            site: siteContext && Object.keys(siteContext).length ? siteContext : null,
             primaryNavigation: Array.isArray(primaryNav) ? primaryNav : [],
           };
           if (
@@ -2329,6 +2382,7 @@ async function buildIiifCollectionPages(CONFIG) {
             scriptHref: jsRel,
             headExtra,
             bodyClass,
+            lang: pageLocale,
           });
           try {
             html = require("../common").applyBaseToHtml(html);
@@ -2501,104 +2555,124 @@ async function buildIiifCollectionPages(CONFIG) {
               }
             }
           } catch (_) {}
-          let metadataValues = [];
-          let summaryValue = "";
-          let annotationValue = "";
-          try {
-            const metadataEntries = extractMetadataEntries(manifest, {
-              includeAll: metadataCollectAllLabels,
-              labelsSet: metadataLabelSet,
-            });
-            if (metadataEntries && metadataEntries.length) {
-              for (const entry of metadataEntries) recordMetadataIndexEntry(entry);
-            }
-          } catch (_) {}
-          if (metadataOptions && metadataOptions.enabled) {
+          if (isDefaultRoute) {
+            let metadataValues = [];
+            let summaryValue = "";
+            let annotationValue = "";
             try {
-              metadataValues = extractMetadataValues(manifest, metadataOptions);
-            } catch (_) {
-              metadataValues = [];
+              const metadataEntries = extractMetadataEntries(manifest, {
+                includeAll: metadataCollectAllLabels,
+                labelsSet: metadataLabelSet,
+              });
+              if (metadataEntries && metadataEntries.length) {
+                for (const entry of metadataEntries) recordMetadataIndexEntry(entry);
+              }
+            } catch (_) {}
+            if (metadataOptions && metadataOptions.enabled) {
+              try {
+                metadataValues = extractMetadataValues(manifest, metadataOptions);
+              } catch (_) {
+                metadataValues = [];
+              }
             }
-          }
-          if (summaryOptions && summaryOptions.enabled) {
-            summaryValue = summaryRaw || "";
-          }
-          if (annotationsOptions && annotationsOptions.enabled) {
-            try {
-              annotationValue = await extractAnnotationText(
-                manifest,
-                annotationsOptions,
+            if (summaryOptions && summaryOptions.enabled) {
+              summaryValue = summaryRaw || "";
+            }
+            if (annotationsOptions && annotationsOptions.enabled) {
+              try {
+                annotationValue = await extractAnnotationText(
+                  manifest,
+                  annotationsOptions,
+                );
+              } catch (_) {
+                annotationValue = "";
+              }
+            }
+            const fallbackThumbnail =
+              (heroMedia && heroMedia.heroThumbnail) || "";
+            const fallbackThumbWidth =
+              heroMedia && typeof heroMedia.heroThumbnailWidth === "number"
+                ? heroMedia.heroThumbnailWidth
+                : undefined;
+            const fallbackThumbHeight =
+              heroMedia && typeof heroMedia.heroThumbnailHeight === "number"
+                ? heroMedia.heroThumbnailHeight
+                : undefined;
+            const navThumbnail = thumbUrl || fallbackThumbnail;
+            const navThumbWidth =
+              typeof thumbWidth === "number" ? thumbWidth : fallbackThumbWidth;
+            const navThumbHeight =
+              typeof thumbHeight === "number" ? thumbHeight : fallbackThumbHeight;
+            const navRecord = navPlace.buildManifestNavPlaceRecord({
+              manifest,
+              slug,
+              href: pageHref,
+              title,
+              summary: summaryRaw,
+              thumbnail: navThumbnail,
+              thumbnailWidth: navThumbWidth,
+              thumbnailHeight: navThumbHeight,
+            });
+            if (navRecord) navPlaceRecords.push(navRecord);
+
+            const recordThumbnail = navThumbnail;
+            const recordThumbWidth = navThumbWidth;
+            const recordThumbHeight = navThumbHeight;
+            const localeHrefMap = {};
+            for (const entry of workRouteEntries) {
+              const targetBase =
+                entry && entry.route ? entry.route : getDefaultRoute("works");
+              const targetLocale =
+                entry && entry.locale ? entry.locale : getDefaultLocaleCode();
+              const relHref = buildRouteRelativePath(
+                targetBase,
+                `${slug}.html`,
+              );
+              localeHrefMap[targetLocale] = rootRelativeHref(
+                relHref.split(path.sep).join("/"),
               );
-            } catch (_) {
-              annotationValue = "";
             }
+            iiifRecords.push({
+              id: String(manifest.id || id),
+              title,
+              href: pageHref,
+              type: "work",
+               slug,
+               locale: pageLocale,
+              thumbnail: recordThumbnail || undefined,
+              thumbnailWidth:
+                typeof recordThumbWidth === "number"
+                  ? recordThumbWidth
+                  : undefined,
+              thumbnailHeight:
+                typeof recordThumbHeight === "number"
+                  ? recordThumbHeight
+                  : undefined,
+              searchMetadataValues:
+                metadataValues && metadataValues.length
+                  ? metadataValues
+                  : undefined,
+              searchSummary:
+                summaryValue && summaryValue.length ? summaryValue : undefined,
+              searchAnnotation:
+                annotationValue && annotationValue.length
+                  ? annotationValue
+                  : undefined,
+              routes: localeHrefMap,
+            });
+            logDebug(
+              `Search record queued for ${manifestLabel}: ${pageHref} (metadata values ${
+                metadataValues ? metadataValues.length : 0
+              })`,
+            );
           }
-          const fallbackThumbnail =
-            (heroMedia && heroMedia.heroThumbnail) || "";
-          const fallbackThumbWidth =
-            heroMedia && typeof heroMedia.heroThumbnailWidth === "number"
-              ? heroMedia.heroThumbnailWidth
-              : undefined;
-          const fallbackThumbHeight =
-            heroMedia && typeof heroMedia.heroThumbnailHeight === "number"
-              ? heroMedia.heroThumbnailHeight
-              : undefined;
-          const navThumbnail = thumbUrl || fallbackThumbnail;
-          const navThumbWidth =
-            typeof thumbWidth === "number" ? thumbWidth : fallbackThumbWidth;
-          const navThumbHeight =
-            typeof thumbHeight === "number" ? thumbHeight : fallbackThumbHeight;
-          const navRecord = navPlace.buildManifestNavPlaceRecord({
-            manifest,
-            slug,
-            href: pageHref,
-            title,
-            summary: summaryRaw,
-            thumbnail: navThumbnail,
-            thumbnailWidth: navThumbWidth,
-            thumbnailHeight: navThumbHeight,
-          });
-          if (navRecord) navPlaceRecords.push(navRecord);
-
-          const recordThumbnail = navThumbnail;
-          const recordThumbWidth = navThumbWidth;
-          const recordThumbHeight = navThumbHeight;
-          iiifRecords.push({
-            id: String(manifest.id || id),
-            title,
-            href: pageHref,
-            type: "work",
-            thumbnail: recordThumbnail || undefined,
-            thumbnailWidth:
-              typeof recordThumbWidth === "number"
-                ? recordThumbWidth
-                : undefined,
-            thumbnailHeight:
-              typeof recordThumbHeight === "number"
-                ? recordThumbHeight
-                : undefined,
-            searchMetadataValues:
-              metadataValues && metadataValues.length
-                ? metadataValues
-                : undefined,
-            searchSummary:
-              summaryValue && summaryValue.length ? summaryValue : undefined,
-            searchAnnotation:
-              annotationValue && annotationValue.length
-                ? annotationValue
-                : undefined,
-          });
-          logDebug(
-            `Search record queued for ${manifestLabel}: ${pageHref} (metadata values ${
-              metadataValues ? metadataValues.length : 0
-            })`,
-          );
         } catch (e) {
           lns.push([
             `IIIF: failed to render for ${id || "<unknown>"} — ${e.message}`,
             "red",
           ]);
         }
+        }
         logs[idx] = lns;
         tryFlush();
       }

package/lib/build/mdx.js

@@ -13,12 +13,31 @@ const {
   withBase,
   readSiteMetadata,
   readPrimaryNavigation,
+  getLocaleRouteConfig,
+  getDefaultLocaleCode,
 } = require("../common");
-
 const globalRoot = typeof globalThis !== "undefined" ? globalThis : global;
 if (globalRoot && typeof globalRoot.__canopyRequire !== "function") {
   globalRoot.__canopyRequire = typeof require === "function" ? require : null;
 }
+const {readCanopyLocalesWithMessages} = require("../locales");
+
+function getSiteLanguageToggle() {
+  try {
+    const data = readCanopyLocalesWithMessages();
+    if (
+      data &&
+      Array.isArray(data.locales) &&
+      data.locales.length
+    ) {
+      return {
+        locales: data.locales,
+        messages: data.messages || {},
+      };
+    }
+  } catch (_) {}
+  return null;
+}
 let remarkGfm = null;
 try {
   const mod = require("remark-gfm");
@@ -1069,12 +1088,29 @@ async function compileMdxFile(filePath, outPath, Layout, extraProps = {}) {
   const withApp = React.createElement(app.App, null, withLayout);
   const PageContext = getPageContext();
   const siteMeta = readSiteMetadata();
-  const primaryNav = readPrimaryNavigation();
+  const pageLocale =
+    extraProps && extraProps.page && typeof extraProps.page.locale === "string"
+      ? extraProps.page.locale
+      : undefined;
+  const primaryNav = readPrimaryNavigation(pageLocale);
+  const siteLanguageToggle = getSiteLanguageToggle();
+  const siteContext = siteMeta ? {...siteMeta} : {};
+  if (siteLanguageToggle) {
+    siteContext.languageToggle = siteLanguageToggle;
+  }
+  try {
+    const localeRoutes = getLocaleRouteConfig(pageLocale);
+    if (localeRoutes) siteContext.routes = localeRoutes;
+  } catch (_) {}
+  try {
+    const defaultRoutes = getLocaleRouteConfig(getDefaultLocaleCode());
+    if (defaultRoutes) siteContext.routesDefault = defaultRoutes;
+  } catch (_) {}
   const contextValue = {
     navigation:
       extraProps && extraProps.navigation ? extraProps.navigation : null,
     page: extraProps && extraProps.page ? extraProps.page : null,
-    site: siteMeta ? {...siteMeta} : null,
+    site: siteContext && Object.keys(siteContext).length ? siteContext : null,
     primaryNavigation: Array.isArray(primaryNav) ? primaryNav : [],
   };
   const withContext = PageContext

package/lib/build/pages.js

@@ -8,6 +8,9 @@ const {
   htmlShell,
   canopyBodyClassForType,
   rootRelativeHref,
+  resolveLocaleFromContentPath,
+  canonicalizeLocaleCode,
+  getDefaultLocaleCode,
 } = require('../common');
 const { log } = require('./log');
 const mdx = require('./mdx');
@@ -109,12 +112,20 @@ async function renderContentMdxToHtml(filePath, outPath, extraProps = {}, source
       ? mdx.parseFrontmatter(source)
       : { data: null, content: source };
   const frontmatterData = frontmatter && isPlainObject(frontmatter.data) ? frontmatter.data : null;
+  const frontmatterLocaleRaw = readFrontmatterString(frontmatterData, 'locale');
+  const frontmatterLocale = canonicalizeLocaleCode(frontmatterLocaleRaw);
+  const pageLocale =
+    frontmatterLocale ||
+    resolveLocaleFromContentPath(relContentPath) ||
+    getDefaultLocaleCode();
   const referencedManifestIdsRaw = frontmatterData ? frontmatterData.referencedManifests : null;
   const referencedManifestIds = referenced.normalizeReferencedManifestList(
     referencedManifestIdsRaw
   );
   const referencedItems = referencedManifestIds.length
-    ? referenced.buildReferencedItems(referencedManifestIds)
+    ? referenced.buildReferencedItems(referencedManifestIds, {
+        locale: pageLocale,
+      })
     : [];
   let layoutMeta = null;
   try {
@@ -141,6 +152,7 @@ async function renderContentMdxToHtml(filePath, outPath, extraProps = {}, source
   const frontmatterMeta = frontmatterData && isPlainObject(frontmatterData.meta) ? frontmatterData.meta : null;
   const headings = mdx.extractHeadings(source);
   const basePage = pageInfo ? { ...pageInfo } : {};
+  if (pageLocale) basePage.locale = pageLocale;
   if (title) basePage.title = title;
   if (resolvedType) basePage.type = resolvedType;
   if (resolvedDescription) basePage.description = resolvedDescription;
@@ -171,6 +183,7 @@ async function renderContentMdxToHtml(filePath, outPath, extraProps = {}, source
     pageMeta.image = resolvedImage;
     if (!pageMeta.ogImage) pageMeta.ogImage = resolvedImage;
   }
+  if (pageLocale) pageMeta.locale = pageLocale;
   if (frontmatterMeta) Object.assign(pageMeta, frontmatterMeta);
   if (Object.keys(pageMeta).length) basePage.meta = pageMeta;
   if (referencedManifestIds.length) {
@@ -357,6 +370,7 @@ async function renderContentMdxToHtml(filePath, outPath, extraProps = {}, source
     scriptHref: jsRel,
     headExtra,
     bodyClass,
+    lang: pageLocale,
   });
   const { applyBaseToHtml } = require('../common');
   return applyBaseToHtml(html);

package/lib/build/search-index.js

@@ -1,6 +1,6 @@
 
 const { logLine } = require('./log');
-const { rootRelativeHref } = require('../common');
+const { rootRelativeHref, buildRouteRelativePath, getDefaultRoute } = require('../common');
 
 function pagesToRecords(pageRecords) {
   const list = Array.isArray(pageRecords) ? pageRecords : [];
@@ -29,7 +29,8 @@ function maybeMockRecords() {
   const svg = encodeURIComponent('<svg xmlns="http://www.w3.org/2000/svg" width="400" height="300"><rect width="400" height="300" fill="#dbeafe"/><text x="50%" y="50%" dominant-baseline="middle" text-anchor="middle" font-family="Arial" font-size="24" fill="#1d4ed8">Mock</text></svg>');
   const thumb = `data:image/svg+xml;charset=utf-8,${svg}`;
   for (let i = 1; i <= 120; i++) {
-    mock.push({ title: `Mock Work #${i}`, href: rootRelativeHref(`works/mock-${i}.html`), type: 'work', thumbnail: thumb });
+    const rel = buildRouteRelativePath(getDefaultRoute('works'), `mock-${i}.html`);
+    mock.push({ title: `Mock Work #${i}`, href: rootRelativeHref(rel), type: 'work', thumbnail: thumb });
   }
   mock.push({ title: 'Mock Doc A', href: rootRelativeHref('getting-started/index.html'), type: 'docs' });
   mock.push({ title: 'Mock Doc B', href: rootRelativeHref('getting-started/example.html'), type: 'docs' });

package/lib/build/search-workflow.js

@@ -1,4 +1,11 @@
-const { fs, path, OUT_DIR } = require('../common');
+const {
+  fs,
+  path,
+  OUT_DIR,
+  getLocaleRouteEntries,
+  getDefaultRoute,
+  getDefaultLocaleCode,
+} = require('../common');
 const search = require('../search/search');
 const runtimes = require('./runtimes');
 const { generateFacets } = require('./facets');
@@ -10,7 +17,12 @@ const { logLine } = require('./log');
  * and build the page so subsequent steps can update artifacts incrementally.
  */
 async function ensureSearchInitialized() {
-  const searchPath = path.join(OUT_DIR, 'search.html');
+  const entries = getLocaleRouteEntries('search');
+  const defaultEntry = entries.length
+    ? entries[0]
+    : { locale: getDefaultLocaleCode(), route: getDefaultRoute('search') };
+  const rel = search.resolveSearchOutputRelative(defaultEntry.route || '');
+  const searchPath = path.join(OUT_DIR, rel);
   const needCreatePage = !fs.existsSync(searchPath);
   if (!needCreatePage) return;
   try { logLine('• Preparing search (initial)...', 'blue', { bright: true }); } catch (_) {}
@@ -20,7 +32,7 @@ async function ensureSearchInitialized() {
   await search.writeSearchIndex([]);
   try { logLine('  - Writing runtime...', 'blue'); } catch (_) {}
   await runtimes.prepareSearchRuntime(process.env.CANOPY_BUNDLE_TIMEOUT || 10000, 'initial');
-  try { logLine('  - Building search.html...', 'blue'); } catch (_) {}
+  try { logLine('  - Building search page...', 'blue'); } catch (_) {}
   await search.buildSearchPage();
   try { logLine('✓ Created search page', 'cyan'); } catch (_) {}
 }
@@ -38,7 +50,7 @@ async function finalizeSearch(combinedRecords) {
   try { logLine('• Writing search runtime (final)...', 'blue', { bright: true }); } catch (_) {}
   await runtimes.prepareSearchRuntime(process.env.CANOPY_BUNDLE_TIMEOUT || 10000, 'final');
   try { await search.ensureResultTemplate(); } catch (_) {}
-  try { logLine('• Updating search.html...', 'blue'); } catch (_) {}
+  try { logLine('• Updating search page...', 'blue'); } catch (_) {}
   await search.buildSearchPage();
   try { logLine('✓ Search page updated', 'cyan'); } catch (_) {}
 
@@ -58,4 +70,3 @@ async function finalizeSearch(combinedRecords) {
 }
 
 module.exports = { ensureSearchInitialized, finalizeSearch };
-