@thegetty/quire-cli 1.0.0-pre-release.1 → 1.0.0-pre-release.2

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/figures/image/processor.js

@@ -1,89 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-const fs = require('fs-extra')
-const path = require('path')
-const Tiler = require('./tiler')
-const Transformer = require('./transformer')
-
-const logger = chalkFactory('Figures:ImageProcessor', 'DEBUG')
-
-/**
- * The Quire Image Processor handles file system changes for IIIF images
- * - Create image transformations
- * - Tiles images OR copies image into output directory so it's not removed by Vite
- * 
- * @return {Object}
- * @property {Array} errors Process error messages
- */
-module.exports = class ImageProcessor {
-  constructor(iiifConfig) {
-    const { imagesDir, inputRoot, outputRoot } = iiifConfig.dirs
-    const tiler = new Tiler(iiifConfig)
-    const transformer = new Transformer(iiifConfig)
-
-    this.inputRoot = path.join(inputRoot, imagesDir)
-    this.outputRoot = outputRoot
-    this.tiler = tiler.tile.bind(tiler)
-    this.transform = transformer.transform.bind(transformer)
-
-    logger.debug(`
-      inputRoot: ${this.inputRoot}
-      outputRoot: ${this.outputRoot}
-    `)
-  }
-
-  /**
-   * @param  {String} imagePath
-   * @param  {String} outputPath
-   * @param  {Object} options
-   * @property  {Boolean} tile To tile or not to tile
-   * @property  {Object} transformations Image transformations to perform
-   */
-  async processImage(imagePath, outputPath, options = {}) {
-    if (!imagePath || imagePath.startsWith('http')) {
-      logger.debug(`processing skipped for '${imagePath}'`)
-      return {}
-    }
-
-    const errors = []
-    const inputPath = path.join(this.inputRoot, imagePath)
-
-    logger.debug(`processing inputPath: ${inputPath}`)
-
-    if (options.transformations) {
-      /**
-       * Transform Image
-       */
-      await Promise.all(
-        options.transformations.map((transformation) => {
-          return this.transform(inputPath, outputPath, transformation, options)
-        })
-      ).catch((error) => {
-        errors.push(`Failed to transform source image ${imagePath} ${error}`)
-      })
-    }
-
-    if (options.tile) {
-      /**
-       * Tile image
-       */
-      try {
-        await this.tiler(inputPath, outputPath)
-      } catch(error) {
-        errors.push(`Failed to generate tiles from source ${imagePath} ${error}`)
-      }
-    } else {
-      /**
-       * Copy file to output directory since vite removes images
-       * not directly referenced by the templates
-       */
-      const { base } = path.parse(imagePath)
-      try {
-        fs.copySync(inputPath, path.join(this.outputRoot, outputPath, base))
-      } catch(error) {
-        errors.push(`Failed to copy source image ${imagePath} ${error}`)
-      }
-    }
-
-    return { errors }
-  }
-} 

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/figures/image/tiler.js

@@ -1,61 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-const fs = require('fs-extra')
-const path = require('path')
-const sharp = require('sharp')
-
-const logger = chalkFactory('Figures:ImageTiler', 'DEBUG')
-
-/**
- * Tiler
- *
- * @class  Tiler
- */
-module.exports = class Tiler {
-  /**
-   * @param  {Object} iiifConfig 
-   */
-  constructor(iiifConfig) {
-    this.baseURI = iiifConfig.baseURI
-    this.formats = iiifConfig.formats
-    this.outputRoot = iiifConfig.dirs.outputRoot
-    this.supportedExtensions = iiifConfig.formats.flatMap(({ input }) => input)
-    this.tilesDir = iiifConfig.tilesDirName
-    this.tileSize = iiifConfig.tileSize
-  }
-
-  /**
-   * Tile an image for IIIF image service using sharp
-   * @param  {String} inputPath   Path to the image file to tile
-   * @param  {String} outputDir   Destination directory for the tiles
-   * @return {Promise}
-   */
-  tile(inputPath, outputDir) {
-    if (!inputPath) return
-
-    const { ext, name } = path.parse(inputPath)
-
-    if (!this.supportedExtensions.includes(ext)) {
-      throw new Error(`Image file of type '${ext}' is not supported. Supported file types are: ${this.supportedExtensions.join(', ')}`)
-    }
-
-    const outputPath = path.join(this.outputRoot, outputDir, name, this.tilesDir)
-
-    if (fs.existsSync(path.join(outputPath, 'info.json'))) {
-      logger.debug(`skipping previously tiled image '${inputPath}'`)
-      return
-    }
-
-    fs.ensureDirSync(outputPath)
-
-    logger.debug(`tiling '${inputPath}'`)
-    const format = this.formats.find(({ input }) => input.includes(ext))
-    return sharp(inputPath)
-      .toFormat(format.output.replace('.', ''))
-      .tile({
-        id: new URL(path.join(outputDir, name), this.baseURI).toString(),
-        layout: 'iiif',
-        size: this.tileSize
-      })
-      .toFile(path.join(outputPath))
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/figures/image/transformer.js

@@ -1,61 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-const fs = require('fs-extra')
-const path = require('path')
-const sharp = require('sharp')
-
-const logger = chalkFactory('Figures:ImageTransformer', 'DEBUG')
-
-/**
- * @param  {Object} iiifConfig Quire IIIF Process config
- */
-module.exports = class Transformer {
-  constructor(iiifConfig) {
-    const { dirs, formats } = iiifConfig
-    this.formats = formats
-    this.outputRoot = dirs.outputRoot
-  }
-
-  /**
-   * Creates a `sharp/transform` that writes the image file to the output directory.
-   * Nota bene: this `transform` is distinct form `11ty/transform`
-   * 
-   * @property {String} inputPath The path to the image file to transform
-   * @property  {Object} transformation A transformation item from `iiif/config.js#transformations`
-   * @param  {Object} options
-   * @property  {Object} resize Resize options for `sharp`
-   * @return {Promise}
-   */
-  async transform(inputPath, outputDir, transformation, options = {}) {
-    if (!inputPath) return {}
-
-    const { region } = options
-    const { resize } = transformation
-    const { ext, name } = path.parse(inputPath)
-    const format = this.formats.find(({ input }) => input.includes(ext))
-    const outputPath = path.join(this.outputRoot, outputDir, name, `${transformation.name}${format.output}`)
-
-    fs.ensureDirSync(path.parse(outputPath).dir)
-
-    if (fs.pathExistsSync(outputPath)) {
-      logger.debug(`skipping previously transformed image '${inputPath}'`)
-      return
-    }
-
-    /**
-     * Declare a `sharp` service with a `crop` method that is callable
-     * without a `region`, which the sharp API `extract` method does not allow
-     */
-    const service = sharp(inputPath)
-    service.crop = function (region) {
-      if (!region) return this
-      const [ top, left, width, height ] = region.split(',').map((item) => parseFloat(item.trim()))
-      service.extract({ top, left, width, height })
-      return this
-    }
-    return service
-      .crop(region)
-      .resize(resize)
-      .withMetadata()
-      .toFile(outputPath)
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/figures/index.js

@@ -1,39 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-const FigureFactory = require('./figure/factory')
-const iiifConfig = require('./iiif/config')
-
-const logger = chalkFactory('Figures', 'DEBUG')
-
-/**
- * Figures Plugin
- * Uses the FigureFactory to create Figure instances
- * for all figures in `figures.yaml` and updates global data
- */
-module.exports = function (eleventyConfig, options = {}) {
-  const figureFactory = new FigureFactory(iiifConfig(eleventyConfig))
-
-  eleventyConfig.on('eleventy.before', async () => {
-    const { figure_list: figureList } = eleventyConfig.globalData.figures
-
-    const figures = await Promise.all(figureList.map((data) => {
-      return figureFactory.create(data)
-    }))
-    const errors = figureList.filter(({ errors }) => errors && !!errors.length)
-
-    if (errors.length) {
-      logger.error('There were errors processing the following images:')
-      console.table(
-        errors.map(({ errors, figure }) => {
-          return { id: figure.id, errors: errors.join(' ') }
-        }),
-        ['id', 'errors']
-      )
-    }
-
-    /**
-     * Update global figures data to only have properties for Quire shortcodes
-     */
-    Object.assign(figureList, figures.map(({ figure }) => figure.adapter()))
-    logger.info('Processing complete')
-  })
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/capitalize.js

@@ -1,3 +0,0 @@
-module.exports = function(string) {
-  return string.charAt(0).toUpperCase() + string.slice(1)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/fancyJoin.js

@@ -1,6 +0,0 @@
-module.exports = function(array, separator=', ', finalSeparator) {
-  finalSeparator = finalSeparator || separator
-  if (array.length <= 1) return array.join(separator)
-  const last = array.pop()
-  return [array.join(separator), last].join(finalSeparator)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/fullname.js

@@ -1,29 +0,0 @@
-/**
- * @param     {Object|Array<Object>} person or array of people
- * @property  {Object} first_name
- * @property  {Object} full_name
- * @property  {Object} last_name
- * @param     {Object} options
- * @property  {Object} reverse - if true, returns "lastname, firstname"
- *
- * @return {String} person display name
- */
-
-const getName = (person, options) => {
-  const { first_name, full_name, last_name } = person
-  const nameParts = [first_name, last_name].filter(item => item)
-  let joinedName
-  if (options.reverse) {
-    joinedName = nameParts.reverse().join(', ')
-  } else {
-    joinedName = nameParts.join(' ')
-  }
-  return full_name ? full_name : joinedName
-}
-
-module.exports = function (data, options = {}) {
-  if (Array.isArray(data)) {
-    return data.map(item => getName(item, options))
-  }
-  return getName(data, options)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/getAnnotation.js

@@ -1,15 +0,0 @@
-/**
- * Looks up an annotation object in figures.yaml by id
- * @param  {Object} eleventyConfig
- * @param  {String} id             annotation id
- * @return {Object}                annotation
- */
-module.exports = function(eleventyConfig, fig, annotationId) {
-  const getFigure = eleventyConfig.getFilter('getFigure')
-  const { figure_list: figureList } = eleventyConfig.globalData.figures
-  const figure = getFigure(fig)
-  if (!figure || !Array.isArray(figure.annotations)) return
-  return figure.annotations
-    .flatMap(({ items }) => items)
-    .find(({ id }) =>  id === annotationId)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/getContributor.js

@@ -1,30 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-
-const { info, error } = chalkFactory('filters:getContributor')
-
-/**
- * Looks up a contributor in publication.yaml[contributor] by id
- * @param  {Object} eleventyConfig
- * @param  {Object} contributor
- * @return {Object}                contributor
- */
-module.exports = function (eleventyConfig, item) {
-  if (!item) return ''
-
-  // If contributor object is defined on the page, return it
-  if (item.full_name || (item.first_name && item.last_name)) {
-    return item
-  }
-
-  // Look up contributor by id in `publication` global data
-  const { publication } = eleventyConfig.globalData
-  const contributor = publication.contributor.find(
-    (contributor) => contributor.id === item.id
-  )
-
-  if (!contributor) {
-    error(`Contributor not found in 'publication.yaml.' Contributor: `, item)
-    return ''
-  }
-  return contributor
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/getFigure.js

@@ -1,10 +0,0 @@
-/**
- * Looks up a figure in figures.yaml by id
- * @param  {Object} eleventyConfig
- * @param  {String} id             figure id
- * @return {Object}                figure
- */
-module.exports = function(eleventyConfig, id) {
-  const { figure_list } = eleventyConfig.globalData.figures
-  return figure_list.find((item) => item.id === id)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/getObject.js

@@ -1,19 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-
-const { warn } = chalkFactory('filters:getObject')
-
-/**
- * Looks up a object in objects.yaml by id
- * @param  {Object} eleventyConfig
- * @param  {String} id             object id
- * @return {Object}                object
- */
-module.exports = function(eleventyConfig, id) {
-  const { objects } = eleventyConfig.globalData
-  const object = objects.object_list.find((item) => item.id === id)
-  if (!object) {
-    warn(`the id '${id}' was not found in 'objects.yaml'`)
-    return ''
-  }
-  return object
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/index.js

@@ -1,42 +0,0 @@
-// Quire data filters
-const fullname = require('./fullname')
-const getAnnotation = require('./getAnnotation')
-const getContributor = require('./getContributor')
-const getFigure = require('./getFigure')
-const getObject = require('./getObject')
-const initials = require('./initials')
-const keywords = require('./keywords')
-const sortContributors = require('./sortContributors')
-const sortReferences = require('./sortReferences')
-
-// string filters
-const capitalize = require('./capitalize')
-const json = require('./json')
-const removeHTML = require('./removeHTML')
-const titleCase = require('./titleCase')
-
-/**
- * Add universal filters for use in templates
- * @see https://www.11ty.dev/docs/filters/#universal-filters
- */
-module.exports = function(eleventyConfig, options) {
-  /**
-   * Quire data filters
-   */
-  eleventyConfig.addFilter('fullname', (person, options) => fullname(person, options))
-  eleventyConfig.addFilter('getAnnotation', (...args) => getAnnotation(eleventyConfig, ...args))
-  eleventyConfig.addFilter('getContributor', (id) => getContributor(eleventyConfig, id))
-  eleventyConfig.addFilter('getFigure', (id) => getFigure(eleventyConfig, id))
-  eleventyConfig.addFilter('getObject', (id) => getObject(eleventyConfig, id))
-  eleventyConfig.addFilter('initials', (person, options) => initials(person, options))
-  eleventyConfig.addFilter('keywords', () => keywords(eleventyConfig))
-  eleventyConfig.addFilter('sortContributors', (contributors) => sortContributors(eleventyConfig, contributors))
-  eleventyConfig.addFilter('sortReferences', (items) => sortReferences(eleventyConfig, items))
-  /**
-   * String manipulation filters
-   */
-  eleventyConfig.addFilter('capitalize', (string) => capitalize(string))
-  eleventyConfig.addFilter('json', (string) => json(string))
-  eleventyConfig.addFilter('removeHTML', (string) => removeHTML(string))
-  eleventyConfig.addFilter('titleCase', (string) => titleCase(string))
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/initials.js

@@ -1,25 +0,0 @@
-/**
- * @param     {Object} person or array of people
- * @property  {Object} first_name
- * @property  {Object} full_name
- * @property  {Object} last_name
- * @param     {Object} options
- *
- * @return {String} First letter of first and last name
- * @example "H.B."
- */
-
-module.exports = (person, options) => {
-  const { 
-    first_name: firstName,
-    full_name: fullName,
-    last_name: lastName
-  } = person
-  const nameParts = []
-  if (firstName && lastName) {
-    nameParts.push(firstName, lastName)
-  } else if (fullName) {
-    nameParts.push(...fullName.split(' '))
-  }
-  return nameParts.map((name) => `${name.charAt(0).toUpperCase()}.`).join('')
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/json.js

@@ -1,8 +0,0 @@
-/**
- * Replaces the default liquidjs json filter with specific arguments
- * @param      {Object}  data    JSON data to pretty print
- * @return     {String}  A formatted JSON string
- */
-module.exports = function(data) {
-  return `<pre><code>${JSON.stringify(data, null, 2)}</code></pre>`
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/keywords.js

@@ -1,19 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-
-const { warn } = chalkFactory('filters:keywords')
-
-/**
- * Gets the array of subject keywords defined in the publication data file
- *
- * @return {Array} An array of keyword strings
- */
-module.exports = function(eleventyConfig, { publication }) {
-  if (!publication.subject) {
-    warn(`the 'subject' key is not defined in the 'publication' data file`)
-    return ''
-  }
-
-  return publication.subject
-    .filter(({ type }) => type === 'keyword')
-    .map(({ name }) => name)
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/removeHTML.js

@@ -1,8 +0,0 @@
-/**
- * Removes html tags from the provided string
- * @param      {String}
- * @return     {String}  String with no HTML
- */
-module.exports = function(string) {
-  return string.replace(/(<([^>]+)>)/gi, '')
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/sortContributors.js

@@ -1,21 +0,0 @@
-/**
- * Nota bene:
- * Separate sort functions for different content types is not ideal,
- * however Quire requires that data could be defined globally, per-page, or per-shortcode.
- * As a result the logic to define the sort key and sort must be performed at the shortcode-level.
- * 
- * @param  {Object} eleventyConfig
- * @param  {Array} contributors
- * @return {Object}                object
- */
-module.exports = function(eleventyConfig, contributors) {
-  const fullname = eleventyConfig.getFilter('fullname')
-  return contributors
-    .map((item) => {
-      item.sort_as ??= fullname(item, { reverse: true })
-      return item
-    })
-    .sort((a, b) => {
-      return a.sort_as && b.sort_as && a.sort_as.localeCompare(b.sort_as)
-    })
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/sortReferences.js

@@ -1,40 +0,0 @@
-/**
- * Nota bene:
- * Separate sort functions for different content types is not ideal,
- * however Quire requires that data could be defined globally, per-page, or per-shortcode.
- * As a result the logic to define the sort key and sort must be performed at the shortcode-level.
- *
- * @param  {Array} items References
- * @return {Array} sorted references
- */
-module.exports = function (eleventyConfig, items) {
-  if (!items || !Array.isArray(items)) return null
-  const { defaultLocale } = eleventyConfig.globalData.config.localization
-  const removeMarkdown = eleventyConfig.getFilter('removeMarkdown')
-
-  /**
-   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#locales
-   */
-  const locales = defaultLocale
-
-  /**
-   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#options
-   */
-  const options = {
-    caseFirst: 'upper',
-    ignorePunctuation: true,
-    localeMatcher: 'best fit',
-    numeric: true,
-    sensitivity: 'variant',
-    usage: 'sort'
-  }
-
-  return items.sort((itemA, itemB) => {
-    const sortById = eleventyConfig.globalData.config.bibliography.displayShort
-    let a = sortById ? itemA.id : itemA.sort_as || itemA.full
-    let b = sortById ? itemB.id : itemB.sort_as || itemB.full
-    a = removeMarkdown(a)
-    b = removeMarkdown(b)
-    return a.localeCompare(b, locales, options)
-  })
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/filters/titleCase.js

@@ -1,12 +0,0 @@
-/**
- * Convert a string to Title Case formatting
- *
- * @param      {String}  A camel case or snake case input string
- * @return     {String}  The input string converted to title case
- */
-module.exports = function(string) {
-  return string
-    .split(/(?=[A-Z])|[_\s]/)
-    .map((word) => word.replace(word[0], word[0].toUpperCase()))
-    .join(' ')
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/frontmatter/README.md

@@ -1,5 +0,0 @@
-## Quire Frontmatter Plugin
-
-Custom frontmatter handling using [grey-matter](https://github.com/jonschlinkert/gray-matter)
-
-@todo transform legacy Quire front-matter

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/frontmatter/index.js

@@ -1,5 +0,0 @@
-module.exports = function(eleventyConfig, options) {
-  eleventyConfig.setFrontMatterParsingOptions({
-
-  })
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/globalData/README.md

@@ -1,3 +0,0 @@
-## Quire Global Data Plugin
-
-The [`globalData` plugin](_plugins/globalData) uses the [configured data extensions](_plugins/dataExtensions) to parse Quire data files and add the data to Eleventy global data, making the Quire data available to the shortcode [components](_includes/components/).

package/src/lib/quire/versions/1.0.0-pre-release.2/_plugins/globalData/index.js

@@ -1,58 +0,0 @@
-const chalkFactory = require('~lib/chalk')
-const fs = require('fs-extra')
-const path = require('path')
-const parser = require('./parser')
-
-const logger = chalkFactory('_plugins:globalData')
-
-/**
- * Throws an error if data contains duplicate ids
- * @param  {Object|Array} data
- */
-const checkForDuplicateIds = function (data, filename) {
-  if (!data) return
-
-  if (Array.isArray(data)) {
-    if (data.every((item) => item.hasOwnProperty('id'))) {
-      const duplicates = data.filter((a, index) => {
-        return index !== data.findIndex((b) => b.id === a.id)
-      })
-      if (duplicates.length) {
-        const ids = duplicates.map(({ id }) => id)
-        throw new Error(`Duplicates ids: ${ids.join(', ')}`)
-      }
-    }
-  }
-
-  if (typeof data === 'object') {
-    Object.keys(data).forEach((key) => {
-      try {
-        checkForDuplicateIds(data[key])
-      } catch (error) {
-        logger.error(`${filename} ${key} contains multiple entries with the same id.\nEach entry in ${key} must have a unique id. ${error.message}`)
-      }
-    })
-  }
-}
-
-/**
- * Programmatically load global data from files
- * Nota bene: data is not loaded from the `eleventyConfig.dir.data` directory
- *
- * @param  {EleventyConfig}  eleventyConfig
- */
-module.exports = function(eleventyConfig) {
-  const dataDir = path.resolve('../11ty/content/_data')
-  const files = fs.readdirSync(dataDir)
-  const parseFile = parser(eleventyConfig)
-
-  for (const file of files) {
-    const { name: key } = path.parse(file)
-    const value = parseFile(path.join(dataDir, file))
-
-    if (key && value) {
-      checkForDuplicateIds(value, file)
-      eleventyConfig.addGlobalData(key, value)
-    }
-  }
-}