@museumwnf/viewer-core 2.8.0 → 2.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@museumwnf/viewer-core",
-  "version": "2.8.0",
+  "version": "2.10.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/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, pictureCredits, recordArtist } from '../../record/derivations.js'
+import { artistLine, pictureCredits, picturesInLanguage, recordArtist } from '../../record/derivations.js'
 
 /**
  * The exhibition's item-sheet spec, over its data layer's `data`.
@@ -88,13 +88,17 @@ export function useExhibitionSheet(data, config = {}) {
     entity: 'items',
     translations: ['glossary', 'dynasties', 'partners'],
     // 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.
+    // language's authors_objects rows (else the record's own credit column)
+    // and printed nothing when it had neither. Each person is printed as its
+    // SQL did, "Firstname LASTNAME" (`credit_names`, `creditLine`).
+    creditNames: true,
     fields,
     layout: 'list',
     shortDescription: 'short_description',
     shortDescriptionAfter: 'description',
+    // Only the pictures with a row in the sheet's language, as dxa-api listed them.
     media: (record, { language }) =>
-      [...(record.images ?? [])]
+      [...picturesInLanguage(record.images, language)]
         .sort((a, b) => (a.display_order ?? 0) - (b.display_order ?? 0))
         .map((p) => ({
           url: p.url,

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, pictureCredits, recordArtist } from '../../record/derivations.js'
+import { artistLine, pictureCredits, picturesInLanguage, recordArtist } from '../../record/derivations.js'
 
 /**
  * The gallery's item-sheet spec, over its data layer's `data`.
@@ -88,13 +88,17 @@ export function useGallerySheet(data, config = {}) {
     entity: 'items',
     translations: ['glossary', 'dynasties', 'partners'],
     // 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.
+    // language's authors_objects rows (else the record's own credit column)
+    // and printed nothing when it had neither. Each person is printed as its
+    // SQL did, "Firstname LASTNAME" (`credit_names`, `creditLine`).
+    creditNames: true,
     fields,
     layout: 'list',
     shortDescription: 'short_description',
     shortDescriptionAfter: 'description',
+    // Only the pictures with a row in the sheet's language, as dxa-api listed them.
     media: (record, { language }) =>
-      [...(record.images ?? [])]
+      [...picturesInLanguage(record.images, language)]
         .sort((a, b) => (a.display_order ?? 0) - (b.display_order ?? 0))
         .map((p) => ({
           url: p.url,

package/src/i18n/markdown.js

@@ -30,6 +30,27 @@ const escaping = {
   },
 }
 
+// No text on these websites is code. Legacy wrote the backtick as a letter
+// (the ʿayn of "Fu`ad", "`Abbas"), and a text pasted from a word processor can
+// hold one anywhere; read as Markdown, two of them turned the words between
+// into a code span, printed in a code font with any markup inside as
+// characters. An indented line was a code block the same way. Without these
+// three tokenizers a backtick is the character it is, and an indented line a
+// line of its paragraph.
+const noCode = {
+  tokenizer: {
+    codespan() {
+      return undefined
+    },
+    code() {
+      return undefined
+    },
+    fences() {
+      return undefined
+    },
+  },
+}
+
 // `breaks` is the one difference, and it is a difference in the source rather
 // than in policy. A text in the dictionary is written as prose and wraps freely,
 // so a single newline means nothing. A record's field arrives from a database
@@ -37,8 +58,8 @@ const escaping = {
 // together.
 const prose = new Marked({ async: false, gfm: true, breaks: false })
 const record = new Marked({ async: false, gfm: true, breaks: true })
-prose.use(escaping)
-record.use(escaping)
+prose.use(escaping, noCode)
+record.use(escaping, noCode)
 
 const pipeline = (breaks) => (breaks ? record : prose)
 
@@ -123,8 +144,8 @@ function withGlossary(breaks, glossary) {
     } else {
       const withProse = new Marked({ async: false, gfm: true, breaks: false })
       const withRecord = new Marked({ async: false, gfm: true, breaks: true })
-      withProse.use(escaping, { extensions: [extension] })
-      withRecord.use(escaping, { extensions: [extension] })
+      withProse.use(escaping, noCode, { extensions: [extension] })
+      withRecord.use(escaping, noCode, { extensions: [extension] })
       entry = { prose: withProse, record: withRecord }
     }
     glossaryPipelines.set(key, entry)

package/src/index.js

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

package/src/record/derivations.js

@@ -193,16 +193,46 @@ export function pictureCredits(picture, language) {
   return { photographer: picture?.photographer ?? '', copyright: picture?.copyright ?? '' }
 }
 
+/**
+ * The pictures a page in `language` shows. Legacy listed a picture on a page
+ * only where it had a row in that language, empty or not; a package carries
+ * those languages per picture (`languages`). A package exported before them
+ * has no such list, and every picture shows, as before.
+ */
+export function picturesInLanguage(pictures, language) {
+  return (pictures ?? []).filter((picture) => !Array.isArray(picture?.languages) || picture.languages.includes(language))
+}
+
+/**
+ * A credit line from its people (`credit_names[role]` in a package): each one
+ * as the galleries' sheet printed them, "Firstname LASTNAME" (dxa-api's SQL
+ * capitalised the surname; the data keeps it as written), or as written when
+ * the entry is a spelling of its own (`{ name }`: the original script on an
+ * Arabic page, or the record's own credit column). Joined with ", ".
+ */
+export function creditLine(names) {
+  return (names ?? [])
+    .map((entry) => {
+      if (typeof entry?.name === 'string') return entry.name.trim()
+      return [entry?.firstname?.trim(), entry?.lastname?.trim()?.toLocaleUpperCase()].filter(Boolean).join(' ')
+    })
+    .filter(Boolean)
+    .join(', ')
+}
+
 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)
 }
 
 /**