@museumwnf/viewer-core 2.7.0 → 2.9.0

package/README.md

@@ -415,13 +415,14 @@ viewer-layout's.
 
 | Export | Meaning |
 | --- | --- |
-| `useRecordSheet(record, { entity, translations, attribution })` | what `useRecordLanguage` returns, plus `text` (the record's translation in the active language, falling back to English), `ready` (the entity and every named related entity loaded, in the active language and in English), `terms` (`[{ id, word, definition, spellings }]` for the record's `glossary_ids`, in the active language), `glossary` (the `[{ id, spelling }]` list the renderers take) and `attribution` — when `attribution: ['author', 'copy_editor']` names fields that are proper names, the first other language of the record that has them supplies them (`{ from, author, … }`), because the importer files some records' credits on one language only. |
+| `useRecordSheet(record, { entity, translations, attribution })` | what `useRecordLanguage` returns, plus `text` (the record's translation in the active language, falling back to English), `ready` (the entity and every named related entity loaded, in the active language and in English), `terms` (`[{ id, word, definition, spellings }]` for the record's `glossary_ids` that have a row in the active language — none through another language), `glossary` (the `[{ id, spelling }]` list the renderers take) and `attribution` — when `attribution: ['author', 'copy_editor']` names fields that are proper names, the first other language of the record that has them supplies them (`{ from, author, … }`), for a site that asks; no platform sheet does, since legacy printed a language's own credits only. |
 | `sheetRows(spec, ctx)` | `[{ key, label, render, value, html }]` from `[{ key, label, value, render, when, join }]`: `value` a function of `ctx` or the name of a field of `ctx.text`; `render` one of `inline`, `block`, `plain` (through the pipeline, with `ctx.glossary`), `link`, `custom` (handed back for a slot); `when(ctx)` gates the row; empty values are dropped. "Materials/techniques" on one site and "Type" on another for the same field are both legacy facts, and both are a spec entry. |
 | `useGlossaryPopup(entries)` | `{ active, onClick, close }` — one delegated click on the sheet's container answers the term rendered as `.gloss-term` |
-| `searchGlossary(input, language)` | the terms whose spelling starts with the input, for a glossary search box |
+| `searchGlossary(input, language)` | the terms with a row in `language` whose spelling starts with the input, for a glossary search box |
 | `glossaryTermsForText(text, language, { entity })` | `glossaryTermsFor`'s counterpart for a text with no `glossary_ids` column — a dynasty history, a theme essay: `[{ id, word, definition, spellings }]` for every glossary term whose spelling occurs in `text`, matched the same word-bounded way `md`/`renderBlock` highlight it. Pass the result through `glossaryEntries` for the `glossary` option the renderers take, the same as `terms`/`glossary` from `useRecordSheet` |
 | `citation({ author, name, project, publisher, year, permalink, inWord })` | the sentence under a sheet, assembled from parts in order rather than written into a text with holes; `permalink` is the page's own address, e.g. from [`sourceUrl()`](#the-declaration-outside-a-component) |
-| `relatedRecords(record, { entity, language })` / `useRelatedRecords` | `{ inPackage: [{ reference, record, justification }], outside: [reference] }` — a reference the package does not hold stays a reference; nothing is dropped and nothing invented |
+| `relatedRecords(record, { entity, language })` / `useRelatedRecords` | `{ inPackage: [{ reference, record, justification }], outside: [reference] }`, the justification in `language` only — a reference the package does not hold stays a reference; nothing is dropped and nothing invented |
+| `pictureCredits(picture, language)` | `{ photographer, copyright }` of an item picture in `language`, from the package's per-language `photographers` / `copyrights` maps, as legacy kept and printed them; the flat `photographer` / `copyright` of a package exported before the maps |
 | `timelineLinkFor(record, { name, keys, country, round })` | the route location of the timeline results for the record's country and dates, or null |
 
 ### Collection trees

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@museumwnf/viewer-core",
-  "version": "2.7.0",
+  "version": "2.9.0",
   "description": "Application engine for MWNF websites: turns a dataset.config.js into a mounted Vue application.",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE.md",

package/src/dxa/exhibition/useExhibitionItemDetail.js

@@ -22,7 +22,7 @@ import { useExhibitionSheet } from './useExhibitionSheet.js'
  * The exhibition's item-page spec, over its data layer's `data` and its
  * timeline layer's `timeline` (`useExhibitionTimeline`).
  *
- * Reads `data.defaultLang`, `data.dynastyById`, `data.isExploreRecord`,
+ * Reads `data.dynastyById`, `data.isExploreRecord`,
  * `data.isHiddenPartner`, `data.labelOf`, `data.partnerById`,
  * `data.partnerRoute`, `data.translations`, what `useExhibitionSheet` reads,
  * and `timeline.countryIdForCode`, `timeline.hasTimeline`,
@@ -30,7 +30,7 @@ import { useExhibitionSheet } from './useExhibitionSheet.js'
  */
 export function useExhibitionItemDetail(data, timeline) {
   const {
-    defaultLang, dynastyById, isExploreRecord, isHiddenPartner, labelOf, partnerById, partnerRoute, translations,
+    dynastyById, isExploreRecord, isHiddenPartner, labelOf, partnerById, partnerRoute, translations,
   } = data
   const { countryIdForCode, hasTimeline, timelineEvents, timelineSpec } = timeline
   const { countries: timelineCountries, findEvents } = timelineEvents
@@ -41,7 +41,7 @@ export function useExhibitionItemDetail(data, timeline) {
   }
 
   function dynastyTr(dynasty, language) {
-    return translations('dynasties', language)[dynasty.id] ?? translations('dynasties', defaultLang)[dynasty.id] ?? {}
+    return translations('dynasties', language)[dynasty.id] ?? {}
   }
 
   // Legacy popped out a dynasty only when it had a history to show.

package/src/dxa/exhibition/useExhibitionPartner.js

@@ -1,3 +1,5 @@
+import { pictureCredits } from '../../record/derivations.js'
+
 // The partner list and profile, as specs. The grouping, the A–Z toggle, the
 // tab strip's mechanics, the language switch and the media gallery are the
 // platform's (`PartnerListView`/`RecordView`); what stays here is an
@@ -11,12 +13,12 @@
 /**
  * The exhibition's partner specs, over its data layer's `data`.
  *
- * Reads `data.defaultLang`, `data.isHiddenPartner`, `data.labelOf`,
+ * Reads `data.isHiddenPartner`, `data.labelOf`,
  * `data.partnerRoute`. `config` carries nothing today.
  */
 export function useExhibitionPartner(data, config = {}) {
   void config
-  const { defaultLang, isHiddenPartner, labelOf, partnerRoute } = data
+  const { isHiddenPartner, labelOf, partnerRoute } = data
 
   // ── The list (Partners.vue) ─────────────────────────────────────────
   //
@@ -52,9 +54,8 @@ export function useExhibitionPartner(data, config = {}) {
         .map((p) => ({
           url: p.url,
           alt: labelOf('partners', record.id),
-          caption: p.captions?.[language] ?? p.captions?.[defaultLang] ?? '',
-          photographer: p.photographer ?? '',
-          copyright: p.copyright ?? '',
+          caption: p.captions?.[language] ?? '',
+          ...pictureCredits(p, language),
         })),
   }
 

package/src/dxa/exhibition/useExhibitionSheet.js

@@ -27,7 +27,7 @@
 // dynasties stand in when it has none, and keep their own popouts
 // (decision D5, inventory-app#2233).
 
-import { artistLine, recordArtist } from '../../record/derivations.js'
+import { artistLine, pictureCredits, recordArtist } from '../../record/derivations.js'
 
 /**
  * The exhibition's item-sheet spec, over its data layer's `data`.
@@ -44,7 +44,7 @@ export function useExhibitionSheet(data, config = {}) {
 
   const dynastyNames = (c) =>
     (c.record.dynasty_ids ?? [])
-      .map((id) => translations('dynasties', c.language)[id]?.name ?? translations('dynasties', defaultLang)[id]?.name ?? '')
+      .map((id) => translations('dynasties', c.language)[id]?.name ?? '')
       .filter(Boolean)
       .join(', ')
 
@@ -87,13 +87,8 @@ export function useExhibitionSheet(data, config = {}) {
   const itemSheet = {
     entity: 'items',
     translations: ['glossary', 'dynasties', 'partners'],
-    // Attribution names are language-independent, but the importer files
-    // `author` / `copy_editor` for EPM records on the Arabic row only (a
-    // known gap, recorded in the exporter's README). Legacy printed them on
-    // every sheet, so the platform reads them off another row when the
-    // active one has neither — the one place a page reads across
-    // languages, and only for proper names.
-    attribution: ['author', 'copy_editor'],
+    // Credits are the sheet language's own: dxa-api read them from that
+    // language's authors_objects rows and printed nothing when it had none.
     fields,
     layout: 'list',
     shortDescription: 'short_description',
@@ -104,9 +99,8 @@ export function useExhibitionSheet(data, config = {}) {
         .map((p) => ({
           url: p.url,
           alt: labelOf('items', record.id),
-          caption: p.captions?.[language] ?? p.captions?.[defaultLang] ?? '',
-          photographer: p.photographer ?? '',
-          copyright: p.copyright ?? '',
+          caption: p.captions?.[language] ?? '',
+          ...pictureCredits(p, language),
         })),
     citation: {
       permalink: false,
@@ -121,11 +115,13 @@ export function useExhibitionSheet(data, config = {}) {
       variant: 'grid',
       heading: 'exhibition.related.objects',
       actionLabel: 'catalogue.results.seeDatabaseEntry',
-      record: ({ record: other, justification }) => ({
+      // In the sheet's language when the related record has it, in the main
+      // language otherwise, as legacy's relatedObjectsMainLanguage did.
+      record: ({ record: other, justification }, { language = defaultLang } = {}) => ({
         id: other.id,
         image: other.images?.[0]?.url ?? '',
         imageAlt: labelOf('items', other.id),
-        name: mdInline(tr('items', other.id, defaultLang).name ?? other.internal_name ?? ''),
+        name: mdInline(translations('items', language)[other.id]?.name ?? tr('items', other.id, defaultLang).name ?? other.internal_name ?? ''),
         meta: [labelOf('countries', other.country_id), justification ? mdStrip(justification) : ''].filter(Boolean),
         to: itemRoute(other),
       }),

package/src/dxa/gallery/useGalleryItemDetail.js

@@ -25,13 +25,13 @@ import { useGallerySheet } from './useGallerySheet.js'
  * The gallery's item-page spec, over its data layer's `data` and its
  * timeline layer's `timeline` (`useGalleryTimeline`).
  *
- * Reads `data.defaultLang`, `data.dynastyById`, `data.labelOf`,
+ * Reads `data.dynastyById`, `data.labelOf`,
  * `data.partnerById`, `data.partnerRoute`, `data.translations`, what
  * `useGallerySheet` reads, and `timeline.countryIdForCode`,
  * `timeline.timelineEvents` (`countries`, `findEvents`).
  */
 export function useGalleryItemDetail(data, timeline) {
-  const { defaultLang, dynastyById, labelOf, partnerById, partnerRoute, translations } = data
+  const { dynastyById, labelOf, partnerById, partnerRoute, translations } = data
   const { countryIdForCode, timelineEvents } = timeline
   const { countries: timelineCountries, findEvents } = timelineEvents
   const { itemSheet: platformSheet } = useGallerySheet(data)
@@ -43,8 +43,9 @@ export function useGalleryItemDetail(data, timeline) {
     return partner ? partnerRoute(partner) : null
   }
 
+  // The sheet language's own: dxa-api returned a dynasty only in it.
   function dynastyTranslation(dynasty, language) {
-    return translations('dynasties', language)[dynasty.id] ?? translations('dynasties', defaultLang)[dynasty.id] ?? {}
+    return translations('dynasties', language)[dynasty.id] ?? {}
   }
 
   // Legacy popped out a dynasty only when it had a history to show.

package/src/dxa/gallery/useGallerySheet.js

@@ -27,7 +27,7 @@
 // dynasties stand in when it has none, and keep their own popouts
 // (decision D5, inventory-app#2233).
 
-import { artistLine, recordArtist } from '../../record/derivations.js'
+import { artistLine, pictureCredits, recordArtist } from '../../record/derivations.js'
 
 /**
  * The gallery's item-sheet spec, over its data layer's `data`.
@@ -44,7 +44,7 @@ export function useGallerySheet(data, config = {}) {
 
   const dynastyNames = (c) =>
     (c.record.dynasty_ids ?? [])
-      .map((id) => translations('dynasties', c.language)[id]?.name ?? translations('dynasties', defaultLang)[id]?.name ?? '')
+      .map((id) => translations('dynasties', c.language)[id]?.name ?? '')
       .filter(Boolean)
       .join(', ')
 
@@ -87,13 +87,8 @@ export function useGallerySheet(data, config = {}) {
   const itemSheet = {
     entity: 'items',
     translations: ['glossary', 'dynasties', 'partners'],
-    // Attribution names are language-independent, but the importer files
-    // `author` / `copy_editor` for EPM records on the Arabic row only (a
-    // known gap, recorded in the exporter's README). Legacy printed them on
-    // every sheet, so the platform reads them off another row when the
-    // active one has neither — the one place a page reads across
-    // languages, and only for proper names.
-    attribution: ['author', 'copy_editor'],
+    // Credits are the sheet language's own: dxa-api read them from that
+    // language's authors_objects rows and printed nothing when it had none.
     fields,
     layout: 'list',
     shortDescription: 'short_description',
@@ -104,20 +99,21 @@ export function useGallerySheet(data, config = {}) {
         .map((p) => ({
           url: p.url,
           alt: labelOf('items', record.id),
-          caption: p.captions?.[language] ?? p.captions?.[defaultLang] ?? '',
-          photographer: p.photographer ?? '',
-          copyright: p.copyright ?? '',
+          caption: p.captions?.[language] ?? '',
+          ...pictureCredits(p, language),
         })),
     citation: { permalink: false, heading: 'record.citation.ofThisPage' },
     related: {
       variant: 'grid',
       heading: 'record.related.items',
       actionLabel: 'catalogue.results.seeDatabaseEntry',
-      record: ({ record: other, justification }) => ({
+      // In the sheet's language when the related record has it, in the main
+      // language otherwise, as legacy's relatedObjectsMainLanguage did.
+      record: ({ record: other, justification }, { language = defaultLang } = {}) => ({
         id: other.id,
         image: other.images?.[0]?.url ?? '',
         imageAlt: labelOf('items', other.id),
-        name: mdInline(tr('items', other.id, defaultLang).name ?? other.internal_name ?? ''),
+        name: mdInline(translations('items', language)[other.id]?.name ?? tr('items', other.id, defaultLang).name ?? other.internal_name ?? ''),
         meta: [labelOf('countries', other.country_id), justification ? mdStrip(justification) : ''].filter(Boolean),
         to: itemRoute(other),
       }),

package/src/index.js

@@ -39,7 +39,7 @@ export {
   glossaryEntries, glossaryTermsFor, glossaryTermsForText, sheetRows, useRecordSheet,
 } from './record/recordSheet.js'
 export {
-  artistLine, citation, recordArtist, relatedRecords, removeEndingPoint, searchGlossary, timelineLinkFor, useGlossaryPopup,
+  artistLine, citation, pictureCredits, recordArtist, relatedRecords, removeEndingPoint, searchGlossary, timelineLinkFor, useGlossaryPopup,
   useRelatedRecords,
 } from './record/derivations.js'
 export { buildCollectionTree, collectionTreeFromThemes, useCollectionTree } from './record/collectionTree.js'

package/src/record/derivations.js

@@ -43,8 +43,9 @@ export function useGlossaryPopup(entries) {
 }
 
 /**
- * The glossary terms whose spelling starts with `input`, in `language`
- * (falling back to English), for a glossary search box: `[{ id, word,
+ * The glossary terms whose spelling starts with `input`, among those that have
+ * a row in `language` (legacy searched that language's glossary only), for a
+ * glossary search box: `[{ id, word,
  * spelling, definition }]`, one per term, sorted by spelling.
  */
 export function searchGlossary(input, language, { entity = 'glossary' } = {}) {
@@ -52,10 +53,10 @@ export function searchGlossary(input, language, { entity = 'glossary' } = {}) {
   if (!needle) return []
   const { translations } = useDataPackage()
   const rows = translations(entity, language)
-  const fallback = translations(entity, BASE_LANGUAGE)
   const out = []
   for (const term of entityRef(entity).value ?? []) {
-    const t = rows[term.id] ?? fallback[term.id] ?? {}
+    const t = rows[term.id]
+    if (!t) continue
     const spellings = t.spellings?.length ? t.spellings : [term.word]
     for (const spelling of spellings) {
       if (String(spelling ?? '').toLowerCase().startsWith(needle)) {
@@ -95,7 +96,7 @@ export function citation({ author, name, project, publisher = 'Museum With No Fr
 /**
  * A record's `related_items`, split by whether the package carries them:
  * `inPackage` is `[{ reference, record, justification }]` with the
- * justification in `language` (falling back to English); `outside` is the
+ * justification in `language` only, as legacy printed it; `outside` is the
  * references the package does not hold, kept as the references they are — a
  * link is never dropped for being unresolvable, and never invented either.
  */
@@ -116,7 +117,7 @@ export function relatedRecords(record, { entity = 'items', language = BASE_LANGU
     inPackage.push({
       reference,
       record: found,
-      justification: justifications[language] ?? justifications[BASE_LANGUAGE] ?? '',
+      justification: justifications[language] ?? '',
     })
   }
   return { inPackage, outside }
@@ -179,16 +180,32 @@ export function removeEndingPoint(text) {
   return body.slice(0, start)
 }
 
+/**
+ * A picture's photographer and copyright in `language`. Legacy kept them per
+ * language, like the caption, and printed only the page language's. A package
+ * exported before the per-language `photographers` and `copyrights` maps
+ * existed has only the flat fields, which it reads instead.
+ */
+export function pictureCredits(picture, language) {
+  if (picture?.photographers || picture?.copyrights) {
+    return { photographer: picture.photographers?.[language] ?? '', copyright: picture.copyrights?.[language] ?? '' }
+  }
+  return { photographer: picture?.photographer ?? '', copyright: picture?.copyright ?? '' }
+}
+
 const lifePart = (value) => (typeof value === 'string' ? value.trim() : '')
 
 /**
- * The artist the sheet names: the translation's own `artist` when it has one,
- * else the record's `artist_names`. A Sharing History record has no artist
- * entity, and legacy wrote its artist per language ("Unknown", "Inconnu"),
- * so the package carries it on each translation (inventory-app#2233, C22).
+ * The artist the sheet names: the translation's own `artist`. Legacy wrote the
+ * artist line per language ("Unknown", "Inconnu", or a sentence in Arabic) and
+ * printed a language's own line, or nothing when that language had none, so
+ * the package carries it on each translation (inventory-app#2233). The
+ * record's `artist_names` come from one language's line and stand for none;
+ * the record stays a parameter so callers need not change.
  */
+// eslint-disable-next-line no-unused-vars
 export function recordArtist(record, text) {
-  return lifePart(text?.artist) || (record?.artist_names ?? []).join(', ')
+  return lifePart(text?.artist)
 }
 
 /**

package/src/record/recordSheet.js

@@ -14,15 +14,15 @@ const BASE_LANGUAGE = 'en'
 // Seven pages wrote that choreography by hand. This is the one place it is
 // written, on top of `useRecordLanguage`, which decides the language.
 
-// A term's row in one language: its spellings and definition from
-// `rows`/`fallback` (English), its headword from `term` (the glossary
-// record itself, language-independent) — `null` when the term has neither,
-// which happens for a headword-only fixture row with no translation file at
-// all. Shared by `glossaryTermsFor` (walks a record's own `glossary_ids`)
+// A term's row in one language: its spellings and definition from `rows`,
+// its headword from `term` (the glossary record itself, language-independent)
+// — `null` when the term has no row in that language. Legacy linked a term
+// only in a language its glossary had it in, never through another. Shared by `glossaryTermsFor` (walks a record's own `glossary_ids`)
 // and `glossaryTermsForText` (walks the whole glossary, filtered by what
 // the text contains), so the two agree on what a term row looks like.
-function termRow(id, term, rows, fallback) {
-  const t = rows[id] ?? fallback[id] ?? {}
+function termRow(id, term, rows) {
+  const t = rows[id]
+  if (!t) return null
   const spellings = (t.spellings ?? []).map((s) => String(s).trim()).filter(Boolean)
   const word = term?.word ?? spellings[0] ?? ''
   if (!word && spellings.length === 0) return null
@@ -31,17 +31,16 @@ function termRow(id, term, rows, fallback) {
 
 /**
  * `{ id, word, definition, spellings }` for each glossary term of `record`
- * (its `glossary_ids`), with the spellings and definition in `language`,
- * falling back to English, then to the term's own headword.
+ * (its `glossary_ids`) that has a row in `language`, with its spellings and
+ * definition in it, its headword standing in for a row without spellings.
  */
 export function glossaryTermsFor(record, language, { entity = 'glossary', translations, byId } = {}) {
   const ids = record?.glossary_ids ?? []
   if (ids.length === 0) return []
   const rows = translations(entity, language)
-  const fallback = translations(entity, BASE_LANGUAGE)
   const out = []
   for (const id of ids) {
-    const row = termRow(id, byId?.get(id), rows, fallback)
+    const row = termRow(id, byId?.get(id), rows)
     if (row) out.push(row)
   }
   return out
@@ -53,7 +52,7 @@ export function glossaryTermsFor(record, language, { entity = 'glossary', transl
  * spelling occurs in `text`, matched the same word-bounded way `md`/
  * `renderBlock` highlight it, so what this returns and what the text is
  * rendered with agree. The candidate list — the whole glossary in
- * `language`, English behind it — is the same for every text asked about
+ * `language` — is the same for every text asked about
  * in that language; `glossaryIdsIn` is what carries the caching (see
  * `markdown.js`), so building it here costs one pass over the glossary,
  * not a rebuilt regex.
@@ -63,11 +62,10 @@ export function glossaryTermsForText(text, language, { entity = 'glossary' } = {
   if (!value) return []
   const { translations } = useDataPackage()
   const rows = translations(entity, language)
-  const fallback = translations(entity, BASE_LANGUAGE)
   const byId = new Map()
   const candidates = []
   for (const term of entityRef(entity).value ?? []) {
-    const row = termRow(term.id, term, rows, fallback)
+    const row = termRow(term.id, term, rows)
     if (!row) continue
     byId.set(term.id, row)
     for (const spelling of row.spellings) candidates.push({ id: term.id, spelling })
@@ -98,9 +96,9 @@ export function glossaryEntries(terms) {
  *
  * `attribution: ['author', 'copy_editor']` names fields that are proper
  * names rather than text: when the active language's row lacks them, the
- * first other language of the record that has them supplies them. This is
- * the one place a page reads across languages, and it exists because the
- * importer files some records' credits on one language only.
+ * first other language of the record that has them supplies them. No
+ * platform sheet asks for it any more: legacy printed a language's own
+ * credits only, and nothing where it had none.
  */
 export function useRecordSheet(record, { entity, translations: related = [], attribution: attributionFields = [], languages } = {}) {
   if (!entity) throw new Error('useRecordSheet: entity is required')
@@ -143,8 +141,9 @@ export function useRecordSheet(record, { entity, translations: related = [], att
       return
     }
     // The record language and English both: `tr` falls back to English for a
-    // record or a term that has no row in the active language, and a fallback
-    // that has not been loaded is a blank, not a fallback.
+    // record that has no row in the active language, as legacy's PHP sheets
+    // did, and a fallback that has not been loaded is a blank, not a fallback.
+    // Glossary terms, dynasties and the rest stay in the active language.
     const languages = lang === BASE_LANGUAGE ? [lang] : [lang, BASE_LANGUAGE]
     await Promise.all(
       [entity, ...related].flatMap((name) => languages.map((code) => pkg.loadTranslations(name, code))),