feat: add --syllabus flag to collect.js, document

ref #115

Author: phette23

collection-export/collect.js

@@ -8,7 +8,8 @@ import rc from 'rc'
 import xpath from 'xpath'
 import { DOMParser as xmldom } from '@xmldom/xmldom'
 
-import { toStrictMODS } from './strict-mods.js'
+import {toStrictMODS} from './strict-mods.js'
+import {convertSyllabusXMLtoMODS} from './syllabus.js'
 
 const defaults = {
     // obviously need attachment & metadata info
@@ -17,6 +18,7 @@ const defaults = {
     info: 'attachment,basic,detail,metadata',
     limit: Infinity,
     mods: true,
+    syllabus: false,
 }
 const options = rc('app', defaults)
 const UUIDRegex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/
@@ -29,6 +31,7 @@ if (options.help || options.h || (options._.length && options._[0].match(/^help$
     console.log('  --item <UUID>        UUID of single item to export')
     console.log('  --name               Use item name for export folders instead of UUID')
     console.log('  --no-mods            Do not write strict MODS XML for each item')
+    console.log('  --syllabus           Convert courseInfo syllabus metadata to MODS')
     console.log('  --verbose            Print debug info')
     console.log('\nYou can also specify any valid EQUELLA search parameters such as "--status DRAFT,ARCHIVE" or "--modifiedBefore 2020-01-01".\nSee https://vault.cca.edu/apidocs.do#operations-tag-Searching')
     process.exit(0)
@@ -188,8 +191,19 @@ function getAttachments(item, itemDir) {
 function writeXML(item, dir) {
     debug(`Writing XML metadata for item ${item.links.view}`)
     fs.writeFile(path.join(dir, 'metadata', 'metadata.xml'), item.metadata, handleErr)
+    if (options.syllabus) {
+        const syllabusMods = convertSyllabusXMLtoMODS(item.metadata) // returns Document not string
+        if (!syllabusMods) {
+            return console.error(`Error: unable to convert courseInfo syllabus metadata to MODS for item ${item.links.view}`)
+        }
+        // do not write other MODS if --syllabus is specified, since it's a strict MODS document
+        return fs.writeFile(path.join(dir, 'metadata', 'metadata.mods.xml'), syllabusMods.toString(), handleErr)
+    }
     if (options.mods) {
         const strictMods = toStrictMODS(item.metadata)
+        if (!strictMods) {
+            return console.error(`Error: unable to convert metadata to strict MODS for item ${item.links.view}`)
+        }
         fs.writeFile(path.join(dir, 'metadata', 'metadata.mods.xml'), strictMods, handleErr)
     }
 }

collection-export/readme.md

@@ -23,6 +23,7 @@ Options:
   --item <UUID>        UUID of single item to export
   --name               Use item name for export folders instead of UUID
   --no-mods            Do not write strict MODS XML for each item
+  --syllabus           Convert courseInfo syllabus metadata to MODS
   --verbose            Print debug info
 
 You can also specify any valid EQUELLA search parameters such as "--status DRAFT,ARCHIVE" or "--modifiedBefore 2020-01-01".
@@ -36,6 +37,8 @@ node collect --collection $UUID --status DRAFT,ARCHIVE --modifiedBefore 2020-01-
 node collect  --collection $UUID --name
 # sub-collection of Libraries, note --where needs fully-specified /xml/... path
 node collect --collection 6b755832-4070-73d2-77b3-3febcc1f5fad --where "/xml/mods/relatedItem/title = 'Robert Sommer Mudflats Collection'"
+# download syllabi & convert their metadata to MODS
+node collect --collection (eq coll --name "Syllabus Collection" | jq -r .uuid) --syllabus
 ```
 
 By default item folders are named after UUID and then version. The `--name` flag makes the folder's the item's title, but titles can be duplicative or absent. An integer is append to the folder name if it would collide with an existing folder.
@@ -100,11 +103,11 @@ node test-collection-samples.js data/mudflats.json 10
 
 The `test-collection-samples.js` script tests random samples of XML metadata from exported EQUELLA JSON files against the strict-mods library to verify conversions work correctly. We can also download item XML to run the strict MODS conversion on our own.
 
-## Syllabus Conversion
+## Syllabus Metadata Conversion
 
-The syllabus.js file converts XML metadata from CCA's "courseInfo" schema to standards-compliant MODS. It can be used as a library or passed a single XML file on the command line; it will print the converted MODS to stdout.
+The syllabus.js file converts XML metadata from CCA's "courseInfo" schema to standards-compliant MODS. It can be used as a library or passed a single XML file on the command line; it will print the converted MODS to stdout. `npm run sylxmltest` runs the test suite.
 
-TODO: add `--syllabus` flag to collect.js to convert syllabus XML to MODS.
+Running `node collect` with the `--syllabus` flag will automatically convert syllabus XML to MODS for any items in the collection that have a syllabus attachment.
 
 ### Converting & Validating MODS Files