@amermathsoc/texml-to-html 16.1.1 → 17.0.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [17.0.0](https://github.com/AmerMathSoc/texml-to-html/compare/v16.1.1...v17.0.0) (2024-06-07)
+
+
+### ⚠ BREAKING CHANGES
+
+* Expects role instead author-comment
+
+### Features
+
+* adjust to texml renaming author-comment to role ([c46822b](https://github.com/AmerMathSoc/texml-to-html/commit/c46822b9e6cbd96de1893c8e138f3f14df48492c)), closes [#449](https://github.com/AmerMathSoc/texml-to-html/issues/449)
+
 ### [16.1.1](https://github.com/AmerMathSoc/texml-to-html/compare/v16.1.0...v16.1.1) (2024-06-03)
 
 

package/lib/helpers/extractContribGroups.js

@@ -75,14 +75,14 @@ export function extractContribGroups(articleMetaNode) {
         contributor.orcid = contrib.querySelector('contrib-id[contrib-id-type="orcid"]')?.textContent;
 
         contributor.uri = contrib.querySelector('uri')?.textContent;
-        // author-comment (NOTE: child of contrib-group but it's easier if we copy it to each contributor)
-        const authorComment = contrib.parentNode.querySelector('author-comment')?.textContent;
-        if (index === 0 && authorComment) contributor.byline = authorComment;
+        // role (NOTE: child of contrib-group but it's easier if we copy it to each contributor)
+        const role = contrib.parentNode.querySelector('role')?.textContent;
+        if (index === 0 && role) contributor.byline = role;
         contributorsArray.push(contributor);
     }
 
     const extractContribGroup = function (contributors, contribGroup) {
-        contributors[contribGroup.getAttribute('content-type')] ??= []; // NOTE: jams410 has 2 contrib-groups with content-type=contributors (but different author-comments); cf. #408
+        contributors[contribGroup.getAttribute('content-type')] ??= []; // NOTE: jams410 has 2 contrib-groups with content-type=contributors (but different roles); cf. #408
         contribGroup.querySelectorAll('contrib').forEach(extractContrib.bind(this, contributors[contribGroup.getAttribute('content-type')]));
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amermathsoc/texml-to-html",
-  "version": "16.1.1",
+  "version": "17.0.0",
   "type": "module",
   "description": "A NodeJS library for converting AMS-style JATS XML to HTML",
   "scripts": {

package/test/article--alttitle.xml

@@ -18,7 +18,7 @@
             <bio>Some biographical info with <email>email</email></bio>
           </contrib>
           <aff id="aff">aff</aff>
-          <author-comment>comment</author-comment>
+          <role>comment</role>
        </contrib-group>
        <contrib-group content-type="contribBs">
           <contrib contrib-type="contribB">
@@ -36,7 +36,7 @@
           </contrib>
           <aff id="aff1" specific-use="current">Aff1</aff>
           <aff id="aff2">Aff2</aff>
-          <author-comment>comment</author-comment>
+          <role>comment</role>
        </contrib-group>
       <funding-group>
           <funding-statement/>
@@ -118,7 +118,7 @@
           </contrib>
         </contrib-group>
         <contrib-group content-type="contributors">
-          <author-comment>with</author-comment>
+          <role>with</role>
           <contrib contrib-type="contributor">
             <string-name>Author 2</string-name>
             <bio>Author 2 Bio</bio>

package/test/article.xml

@@ -47,7 +47,7 @@
                     <uri>uri</uri>
                 </contrib>
                 <aff id="aff">aff</aff>
-                <author-comment>comment</author-comment>
+                <role>comment</role>
             </contrib-group>
             <contrib-group content-type="contribBs">
                 <contrib contrib-type="contribB">
@@ -66,7 +66,7 @@
                 </contrib>
                 <aff id="aff1" specific-use="current">Aff1</aff>
                 <aff id="aff2">Aff2</aff>
-                <author-comment>comment</author-comment>
+                <role>comment</role>
             </contrib-group>
             <funding-group>
                 <funding-statement>Funding 1</funding-statement>

package/test/book.xml

@@ -51,7 +51,7 @@
                 <uri>uri</uri>
             </contrib>
             <aff id="aff1">aff</aff>
-            <author-comment>comment</author-comment>
+            <role>comment</role>
         </contrib-group>
         <contrib-group content-type="contrib-group-type2">
             <contrib contrib-type="contrib-type2">
@@ -62,7 +62,7 @@
             </contrib>
         </contrib-group>
         <contrib-group content-type="contrib-group-type3">
-            <author-comment>comment</author-comment>
+            <role>comment</role>
             <contrib contrib-type="contrib-type3">
                 <name name-style="given-only">
                     <given-names>should be ignored</given-names>
@@ -218,9 +218,9 @@
                     <sec-meta>
                         <contrib-group>
                         <!-- NOTE: this contrib-group example is for MCL 1, 14 only; intentionally broken via #254 -->
-                        <author-comment>
+                        <role>
                             comment 
-                        </author-comment>
+                        </role>
                         </contrib-group>
                         <abstract>
                             <title>Abstract</title>

package/test/element-sec-meta.js

@@ -17,7 +17,7 @@
 import { article, articleAlttitle, book } from './helper.js';
 import tape from 'tape';
 
-tape('Template: sec-meta => contrib-group, author-comment, abstract/title', async function (t) {
+tape('Template: sec-meta => contrib-group, role, abstract/title', async function (t) {
   t.plan(10);
 
   const document = book;