book-list: handle datePublished being freeform text

We need to move this from a ISO date string to a freeform text string
as the backend not always has data that can be converted losslessly.

In case it is an iso date, handle as before and show the year, but
in case it isn't show it as is.

For sorting we now need to handle random strings, so to keep things
working as before extract the earliest year-like number from the string.
This also has to handle uncertain year formats like "[20]14", see the
unit tests.

Author: lazka

src/dbp-sublibrary-book-list.js

@@ -13,6 +13,7 @@ import select2CSSPath from 'select2/dist/css/select2.min.css';
 import $ from 'jquery';
 import {classMap} from 'lit/directives/class-map.js';
 import {LibrarySelect} from './library-select.js';
+import {extractEarliestPossibleYearFromPublicationDate} from './utils.js';
 
 class LibraryBookList extends ScopedElementsMixin(LibraryElement) {
     constructor() {
@@ -224,7 +225,8 @@ class LibraryBookList extends ScopedElementsMixin(LibraryElement) {
                 const columns = [
                     {title: this._i18n.t('book-list.book-title')},
                     {title: this._i18n.t('book-list.book-author')},
-                    {title: this._i18n.t('book-list.book-publication-year')},
+                    {title: this._i18n.t('book-list.book-publication-date')},
+                    null,
                     {title: this._i18n.t('book-list.book-publisher')},
                     {title: this._i18n.t('book-list.book-availability-date')},
                     null,
@@ -235,8 +237,10 @@ class LibraryBookList extends ScopedElementsMixin(LibraryElement) {
 
                 // sorting will be done by hidden columns
                 const columnDefs = [
-                    {targets: [4], orderData: [5]},
-                    {targets: [5], visible: false},
+                    {targets: [2], orderData: [3]},
+                    {targets: [3], visible: false},
+                    {targets: [5], orderData: [6]},
+                    {targets: [6], visible: false},
                 ];
 
                 const tbl = [];
@@ -252,14 +256,24 @@ class LibraryBookList extends ScopedElementsMixin(LibraryElement) {
                             that.locationIdentifier === bookOffer.locationIdentifier) &&
                         (that.inventoryYear === '' || that.inventoryYear === inventoryYear)
                     ) {
-                        const datePublished = new Date(bookOffer.book.datePublished);
+                        // We used to return an ISO date string here, but now it returns a freeform date
+                        // string with usually the year only and some other characters like brackets
+                        // or copyrigth symbols. So support both during the transition.
+                        let datePublishedString = bookOffer.book.datePublished ?? '';
+
+                        // FIXME: remove this after the transition is done.
+                        const datePublished = new Date(datePublishedString);
+                        if (!isNaN(datePublished.valueOf())) {
+                            datePublishedString = datePublished.getFullYear().toString();
+                        }
+
+                        let datePublishedSortValue = extractEarliestPossibleYearFromPublicationDate(datePublishedString);
 
                         const row = [
                             bookOffer.book.title,
                             bookOffer.book.author,
-                            bookOffer.book.datePublished !== null
-                                ? datePublished.getFullYear()
-                                : '',
+                            datePublishedString,
+                            datePublishedSortValue,
                             bookOffer.book.publisher,
                             bookOffer.availabilityStarts !== null
                                 ? availabilityStarts.toLocaleDateString('de-AT')

src/i18n/de/translation.json

@@ -7,7 +7,7 @@
         "book-inventory-year": "Inventarisierungsjahr",
         "book-isbn": "ISBN/ISSN",
         "book-location-identifier": "Aufstellung",
-        "book-publication-year": "Erscheinungsjahr",
+        "book-publication-date": "Erscheinungsdatum",
         "book-publisher": "Verlag",
         "book-title": "Titel",
         "books": "Bücher",

src/i18n/en/translation.json

@@ -7,7 +7,7 @@
         "book-inventory-year": "Availability year",
         "book-isbn": "ISBN/ISSN",
         "book-location-identifier": "Location",
-        "book-publication-year": "Publication year",
+        "book-publication-date": "Publication date",
         "book-publisher": "Publisher",
         "book-title": "Title",
         "books": "Books",

src/utils.js

@@ -42,3 +42,28 @@ export function escapeHtml(str) {
         }
       });
 }
+
+/**
+ * Extracts the earliest possible year from a publication date string.
+ * Some example values: "2021", "[2021]", "2021-", "1959-[2020]", "[19]71-2022", "May 2021", "©2005"
+ *
+ * @param {string} publicationDate - The publication date string, which may contain multiple years.
+ * @returns {number|null} The earliest year found in the publication date string, or null if no valid year is found.
+ */
+export function extractEarliestPossibleYearFromPublicationDate(publicationDate) {
+  const matches = publicationDate.replace(/[()[\]]/g, '').match(/\d+/g);
+  if (!matches) {
+    return null;
+  }
+
+  let earliestYear = null;
+  for (const match of matches) {
+    const year = Number(match);
+    // Ignore anything below the year 1000, since that could reference editions and not years.
+    if (year >= 1000 && (earliestYear === null || year < earliestYear)) {
+      earliestYear = year;
+    }
+  }
+
+  return earliestYear;
+}

test/unit.js

@@ -1,7 +1,8 @@
-import {assert} from 'chai';
+import {assert, expect} from 'chai';
 
 import '../src/dbp-sublibrary-shelving';
 import '../src/dbp-sublibrary.js';
+import {extractEarliestPossibleYearFromPublicationDate} from '../src/utils.js';
 
 suite('dbp-sublibrary-shelving basics', () => {
     let node;
@@ -38,3 +39,28 @@ suite('dbp-sublibrary-app basics', () => {
         assert(node.shadowRoot !== undefined);
     });
 });
+
+suite('extractEarliestPossibleYearFromPublicationDate', () => {
+    test('test various things', () => {
+        expect(extractEarliestPossibleYearFromPublicationDate('(1980)')).to.equal(1980);
+        expect(extractEarliestPossibleYearFromPublicationDate('© 2015 [erschienen 2014]')).to.equal(2014);
+        expect(extractEarliestPossibleYearFromPublicationDate('1988 [erschienen] 1989')).to.equal(1988);
+        expect(extractEarliestPossibleYearFromPublicationDate('1999')).to.equal(1999);
+        expect(extractEarliestPossibleYearFromPublicationDate('1997-')).to.equal(1997);
+        expect(extractEarliestPossibleYearFromPublicationDate('[ 2020]')).to.equal(2020);
+        expect(extractEarliestPossibleYearFromPublicationDate('[2004]')).to.equal(2004);
+        expect(extractEarliestPossibleYearFromPublicationDate('[2004]-')).to.equal(2004);
+        expect(extractEarliestPossibleYearFromPublicationDate('1971-2022')).to.equal(1971);
+        expect(extractEarliestPossibleYearFromPublicationDate('[1971]-2022')).to.equal(1971);
+        expect(extractEarliestPossibleYearFromPublicationDate('1971-[2022]')).to.equal(1971);
+        expect(extractEarliestPossibleYearFromPublicationDate('May 2021')).to.equal(2021);
+        expect(extractEarliestPossibleYearFromPublicationDate('©2005')).to.equal(2005);
+        expect(extractEarliestPossibleYearFromPublicationDate('[20]07')).to.equal(2007);
+        expect(extractEarliestPossibleYearFromPublicationDate('[20]07-[20]09')).to.equal(2007);
+        expect(extractEarliestPossibleYearFromPublicationDate('[1905-1907]')).to.equal(1905);
+        expect(extractEarliestPossibleYearFromPublicationDate('[2nd ed., 1901]')).to.equal(1901);
+        expect(extractEarliestPossibleYearFromPublicationDate('[n.d.]')).to.be.null;
+        expect(extractEarliestPossibleYearFromPublicationDate('anfangs')).to.be.null;
+        expect(extractEarliestPossibleYearFromPublicationDate('')).to.be.null;
+    });
+});