@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/_includes/components/figure/image/print.js

@@ -1,41 +0,0 @@
-const { html } = require('~lib/common-tags')
-const path = require('path')
-
-/**
- * Renders an image with a caption in print output
- *
- * @param      {Object}  eleventyConfig  eleventy configuration
- * @param      {Object}  figure          Figure data
- *
- * @return     {String}  HTML containing an <img> element and a caption
- */
-module.exports = function(eleventyConfig) {
-  const figureCaption = eleventyConfig.getFilter('figureCaption')
-  const figureLabel = eleventyConfig.getFilter('figureLabel')
-
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function(figure) {
-    const { alt, caption, credit, id, label, src='' } = figure
-
-    const labelElement = figureLabel({ caption, id, label })
-
-    let imageSrc
-
-    switch (true) {
-      case figure.isCanvas || figure.isImageService:
-        imageSrc = figure.printImage
-        break
-      default:
-        imageSrc = src.startsWith('http')
-          ? src
-          : path.join(imageDir, src)
-        break
-    }
-
-    return html`
-      <img alt="${alt}" class="q-figure__image" src="${imageSrc}"/>
-      ${figureCaption({ caption, content: labelElement, credit })}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/label.js

@@ -1,26 +0,0 @@
-const { oneLine } = require('~lib/common-tags')
-
-/**
- * A figure label element
- * @param  {Object} eleventyConfig  eleventy configuration
- * @return
- */
-module.exports = function(eleventyConfig) {
-  const icon = eleventyConfig.getFilter('icon')
-  const markdownify = eleventyConfig.getFilter('markdownify')
-  const modalLink = eleventyConfig.getFilter('figureModalLink')
-
-  return function({ id, label }) {
-    if (!label) return ''
-
-    let content = `<span class="q-figure__label-icon">${icon({ type: 'fullscreen', description: 'Expand' })}</span>`
-    content += `<span class="q-figure__label-text">${markdownify(label || '')}</span>`
-    content = modalLink({ content, id })
-
-    const labelElement = `<span class="q-figure__label q-figure__label--below">
-      ${content}
-    </span>`
-
-    return oneLine`${labelElement}`
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/modal-link.js

@@ -1,9 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-module.exports = function (eleventyConfig) {
-  const { enableModal } = eleventyConfig.globalData.config.figures
-
-  return ({ content, id }) => enableModal
-    ? html`<a class="q-figure__modal-link" href="#${id}">${content}</a>`
-    : content
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/placeholder.js

@@ -1,39 +0,0 @@
-const path = require('path')
-const { html } = require('~lib/common-tags')
-
-module.exports = function(eleventyConfig) {
-  const figureLabel = eleventyConfig.getFilter('figureLabel')
-
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function({ alt, caption, id, label, mediaType, src }) {
-    let imageElement
-
-    if (src) {
-      const imagePath = path.join(imageDir, src)
-      imageElement = `
-        <img
-          id="${id}"
-          class="q-figure__image"
-          src="${imagePath}"
-          alt="${alt}"
-        />
-      `
-    } else {
-      const imagePath = path.join(imageDir, 'icons', `${mediaType}.png`)
-      imageElement = `
-        <img src="${imagePath}" class="q-figure__media-fallback" />
-      `
-    }
-
-    const labelElement = figureLabel({ caption, id, label })
-
-    const captionElement = `
-      <figcaption class="quire-figure__caption">
-        <a href="${src}" target="_blank">${src}</a>
-      </figcaption>
-    `
-
-    return html`${imageElement}${labelElement}${captionElement}`
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/table/element.js

@@ -1,27 +0,0 @@
-const path = require('path')
-
-/**
- * Shortcode component to render referenced template file content
- * @see https://www.11ty.dev/docs/plugins/render/#renderfile
- *
- * @param  {EleventyConfig}  eleventyConfig  Eleventy configuration
- */
-module.exports = function (eleventyConfig) {
-  const renderFile = eleventyConfig.getFilter('renderFile')
-  const { assetDir } = eleventyConfig.globalData.config.figures
-
-  /**
-   * Render template file content referenced by a `figure.src` property
-   *
-   * @param  {Object}  figure  Figure entry data from `figures.yaml`
-   * @param  {String}  figure.src  File path relative to the project root
-   * @param  {Object}  data  Additional data passed to the template file
-   * @param  {String}  extension  Override the target file syntax
-   *
-   * @return  {String}  Text content of the referenced template file
-   */
-  return async function ({ src }) {
-    const filePath = path.join(eleventyConfig.dir.input, assetDir, src)
-    return await renderFile(filePath)
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/table/index.js

@@ -1,36 +0,0 @@
-const { html } = require('~lib/common-tags')
-const path = require('path')
-
-/**
- * Renders a table into the document with a captionn
- *
- * @param      {Object}  eleventyConfig  eleventy configuration
- * @param      {Object}  figure          The figure object
- *
- * @return     {String}  Content of referenced table file and a caption
- */
-module.exports = function(eleventyConfig) {
-  const figureCaption = eleventyConfig.getFilter('figureCaption')
-  const figureLabel = eleventyConfig.getFilter('figureLabel')
-  const tableElement = eleventyConfig.getFilter('figureTableElement')
-  const markdownify = eleventyConfig.getFilter('markdownify')
-
-  return async function({ caption, credit, id, label, src }) {
-    const table = await tableElement({ src })
-    const title = markdownify(caption)
-
-    const labelElement = figureLabel({ caption, id, label })
-    const captionElement = figureCaption({ caption, content: labelElement, credit })
-
-    return html`
-      <a
-        class="q-figure__modal-link"
-        href="#${id}"
-        title="${title}"
-      >
-        ${table}
-      </a>
-      ${captionElement}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/video/element.js

@@ -1,99 +0,0 @@
-const { html } = require('~lib/common-tags')
-const chalkFactory = require('~lib/chalk')
-const path = require('path')
-
-const { warn, error } = chalkFactory('Figure Video')
-
-const videoElements = {
-  video({ id, poster='', src }) {
-    if (!src) {
-      error(`Cannot render Video without 'src'. Check that figures data for id: ${id} has a valid 'src'`)
-      return ''
-    }
-
-    if (!poster) {
-      warn(`Figure '${id}' does not have a 'poster' property. A poster image for id: ${id} will not be rendered`)
-    }
-
-    const unsupported = 'Sorry, your browser does not support embedded videos.'
-    return html`
-      <video
-        class="q-figure-video-element"
-        controls
-        poster="${poster}"
-      >
-        <source src="${src}" type="video/mp4"/>
-        ${unsupported}
-      </video>
-    `
-  },
-  vimeo({ id, mediaId }) {
-    if (!mediaId) {
-      error(`Cannot render Vimeo embed without 'media_id'. Check that figures data for id: ${id} has a valid 'media_id'`)
-      return ''
-    }
-
-    // Sample Vimeo id: 672853278/b3f8d29d53
-    const embedId = mediaId.replace('/', '?h=')
-    return html`
-      <iframe
-        allow="fullscreen; picture-in-picture"
-        allowfullscreen
-        class="q-figure-video-element q-figure-video-element--embed"
-        frameborder="0"
-        src="https://player.vimeo.com/video/${embedId}"
-      ></iframe>
-    `
-  },
-  youtube({ id, mediaId }) {
-    if (!mediaId) {
-      error(`Cannot render Youtube component without 'media_id'. Check that figures data for id: ${id} has a valid 'media_id'`)
-      return ''
-    }
-
-    return html`
-      <iframe
-        allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
-        allowfullscreen
-        class="q-figure-video-element q-figure-video-element--embed"
-        frameborder="0"
-        src="https://www.youtube-nocookie.com/embed/${mediaId}"
-      ></iframe>
-    `
-  }
-}
-
-/**
- * Renders a native or embedded video player
- *
- * @param      {Object}  eleventyConfig  eleventy configuration
- *
- * @param      {Object}  figure          The figure object
- * @param      {String}  id              The id of the figure
- * @param      {String}  mediaId        An id for a youtube or vimeo embed
- * @param      {String}  mediaType      The type of tag video ('video', 'vimeo' or 'youtube')
- * @param      {String}  poster          Poster image url for a static video file
- * @param      {String}  src             Source url for a static video file
- *
- * @return     {String}  An HTML <video> element
- */
-module.exports = function (eleventyConfig) {
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function ({
-    id,
-    mediaId,
-    mediaType,
-    poster,
-    src
-  }) {
-    if (poster) {
-      poster = path.join(imageDir, poster)
-    }
-    if (src) {
-      src = src.startsWith('http') ? src : path.join(imageDir, src)
-    }
-
-    return videoElements[mediaType]({ id, mediaId, poster, src })
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/video/html.js

@@ -1,38 +0,0 @@
-const { html } = require('~lib/common-tags')
-/**
- * Renders a native or embedded video player with a caption
- *
- * @param      {Object}  eleventyConfig  eleventy configuration
- * @param      {Object}  figure          The figure object
- *
- * @return     {String}  HTML containing a video player and a caption
- */
-module.exports = function(eleventyConfig) {
-  const figureCaption = eleventyConfig.getFilter('figureCaption')
-  const figureLabel = eleventyConfig.getFilter('figureLabel')
-  const figureVideoElement = eleventyConfig.getFilter('figureVideoElement')
-
-  return function({
-    aspect_ratio: aspectRatio,
-    caption,
-    credit,
-    id,
-    label,
-    mediaId,
-    mediaType,
-    poster,
-    src
-  }) {
-    const isEmbed = mediaType === 'vimeo' || mediaType === 'youtube'
-    const videoElement = figureVideoElement({ id, mediaId, mediaType, src, poster })
-    const labelElement = figureLabel({ caption, id, label })
-    const captionElement = figureCaption({ caption, content: labelElement, credit })
-
-    return html`
-      <div class="q-figure__media-wrapper ${isEmbed && 'q-figure__media-wrapper--' + (aspectRatio || 'widescreen')}">
-        ${videoElement}
-      </div>
-      ${captionElement}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/video/index.js

@@ -1,6 +0,0 @@
-module.exports = function(eleventyConfig) {
-  const renderOutputs = eleventyConfig.getFilter('renderOutputs')
-  return function(params) {
-    return renderOutputs(__dirname, params)
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/figure/video/print.js

@@ -1,39 +0,0 @@
-const { html } = require('~lib/common-tags')
-const chalkFactory = require('~lib/chalk')
-const path = require('path')
-
-const { warn } = chalkFactory('Figure Video')
-
-/**
- * Renders an image fallback for a video player in print output
- *
- * @param      {Object}  eleventyConfig  eleventy configuration
- * @param      {Object}  figure          The figure object
- *
- * @return     {String}  HTML containing a fallback image and a caption
- */
-module.exports = function(eleventyConfig) {
-  const figureCaption = eleventyConfig.getFilter('figureCaption')
-  const figureLabel = eleventyConfig.getFilter('figureLabel')
-
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function({ aspect_ratio: aspectRatio, caption, credit, id, label, mediaType, poster=''}) {
-    if (!poster) {
-      warn(`Figure '${id}' does not have a 'poster' property. Print media will not render a fallback image for id: ${id}`)
-    }
-
-    const posterSrc = poster.startsWith('http')
-      ? poster
-      : path.join(imageDir, poster)
-    const labelElement = figureLabel({ caption, id, label })
-    const captionElement = figureCaption({ caption, content: labelElement,  credit })
-
-    return html`
-      <div class="q-figure__media-wrapper--${ aspectRatio || 'widescreen' }">
-        <img src="${posterSrc}" />
-      </div>
-      ${captionElement}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/head-tags/dublin-core.js

@@ -1,87 +0,0 @@
-const path = require('path')
-
-/**
- * Renders <head> meta and link tags
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  data
- * 
- * @return     {String}  HTML meta and link elements
- */
-module.exports = function(eleventyConfig) {
-  const { publication } = eleventyConfig.globalData
-
-  return function (params) {
-    const links = [
-      { rel: 'schema.dcterms', href: 'https://purl.org/dc/terms/' }
-    ]
-
-    const meta = [
-      {
-        name: 'dcterms.title',
-        content: publication.title },
-      {
-        name: 'dcterms.date',
-        content: publication.pub_date
-      },
-      {
-        name: 'dcterms.description',
-        content: publication.description.one_line || publication.description.full
-      },
-      {
-        name: 'dcterms.identifier',
-        content: publication.identifier.isbn && publication.identifier.isbn.replace(/-/g, '')
-      },
-      {
-        name: 'dcterms.language',
-        content: publication.language
-      },
-      {
-        name: 'dcterms.rights',
-        content: publication.copyright
-      }
-    ]
-
-    publication.contributor.forEach((contributor) => {
-      const { type, full_name, first_name, last_name } = contributor
-      const name = full_name || `${first_name} ${last_name}`
-      switch (type) {
-        case 'primary':
-          meta.push({ name: 'dcterms.creator', content: name })
-          break
-        case 'secondary':
-          meta.push({ name: 'dcterms.contributor', content: name })
-          break
-        default:
-          break
-      }
-    })
-
-    publication.publisher.forEach(({ name, location }) => {
-      meta.push({
-        name: 'dcterms.publisher',
-        content: `${name}, ${location}`
-      })
-    })
-
-    publication.subject.forEach(({ name }) => {
-      meta.push({
-        name: 'dcterms.subject',
-        content: name
-      })
-    })
-
-    const linkTags = links.map(({ rel, href }) => (
-      `<link rel="${rel}" href="${href}">`
-    ))
-
-    const metaTags = meta.map(({ name, content }) => (
-      `<meta name="${name}" content="${content}">`
-    ))
-
-    return `
-    ${linkTags.join('\n')}
-    ${metaTags.join('\n')}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/head-tags/jsonld.js

@@ -1,136 +0,0 @@
-const path = require('path')
-
-/**
- * Renders a JSON-LD representation of the page
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  data
- * 
- * @return     {String}  An HTML script element with JSON-LD
- */
-module.exports = function(eleventyConfig) {
-  const { config, publication } = eleventyConfig.globalData
-  const { imageDir } = config.figures
-
-  return function ({ canonicalURL, page }) {
-    const { abstract, contributor, cover, title } = page
-    const pageContributors = contributor ? contributor
-      .map((contributor, { id }) => {
-        contributor = id ? publication.contributor[id] : contributor
-        if (!contributor) return
-        const { full_name, first_name, last_name } = contributor
-        return {
-          type: 'Person',
-          name: full_name || `${first_name} ${last_name}`
-        }
-      }) : []
-
-    const publicationContributors = publication.contributor
-      .filter((contributor) => contributor.type === 'primary')
-      .map((contributor) => {
-        const { full_name, first_name, last_name } = contributor
-        return {
-          type: 'Person',
-          name: full_name || `${first_name} ${last_name}`,
-          jobTitle: contributor.title,
-          affiliation: contributor.affiliation,
-          identifier: contributor.url
-        }
-      })
-
-    const isbn = publication.identifier.isbn
-    const publicationDescription = publication.description.full || ''
-
-    const Book = {
-      type: 'Book',
-      name: publication.title,
-      description: publicationDescription.replace(/\n/g,' '),
-      isbn: isbn && isbn.replace(/-/g, '')
-    }
-
-    const Periodical = {
-      type: 'PublicationIssue',
-      name:  publication.title,
-      description: publicationDescription.replace(/\n/g,' '),
-      issueNumber: publication.series_issue_number,
-      isPartOf: {
-        type: 'Periodical',
-        name: publication.title,
-        issn: publication.identifier.issn
-      }
-    }
-
-    // publication.pub_type === null
-    const WebSite = {
-      type: 'WebSite',
-      name: publication.title,
-    }
-
-    const partOf = (type) => {
-      switch (true) {
-        case type === 'book':
-          return Book
-        case type === 'journal-periodical':
-          return Periodical
-        default:
-          return WebSite
-      }
-    }
-
-    const about = publication.subject
-      .filter(({ type }) => type === 'getty')
-      .map(({ identifier, name }) => {
-        const vocab = {
-          '/aat/': 'Thing',
-          '/tgn/': 'Place',
-          '/ulan/': 'Person'
-        }
-        return {
-          type: vocab[identifier] || 'Thing',
-          name,
-          identifier
-        }
-      })
-
-    const publisher = {
-      type: 'Organization',
-      name: publication.publisher.name,
-      location: {
-        type: 'PostalAddress',
-        addressLocality: publication.publisher.location
-      },
-      identifier: publication.publisher.url
-    }
-
-    const Article = {
-      '@type': 'Article',
-      author: [...pageContributors],
-      description: abstract && abstract.replace(/\n/g,' '),
-      headline: title,
-      image: cover && path.join(imageDir, cover),
-      partOf: {
-        ...partOf(publication.pub_type),
-        about,
-        author: [...publicationContributors],
-        datePublished: publication.pub_date,
-        dateModified: publication.revision_history.date,
-        image: publication.promo_image && path.join(imageDir, publication.promo_image),
-        license: publication.license.url,
-        keywords: publication.subject
-          .filter(({ type }) => type === 'keyword')
-          .map((name) => name)
-          .toString(),
-        publisher: [publisher],
-        url: publication.url
-      },
-      url: canonicalURL
-    }
-
-    return JSON.stringify(
-      {
-        '@context': 'http://schema.org/',
-        ...Article
-      }
-    )
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/head-tags/opengraph.js

@@ -1,74 +0,0 @@
-/**
- * Renders <head> <meta> data tags for Open Graph protocol data
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  data
- * 
- * @return     {String}  HTML meta and link elements
- */
-module.exports = function(eleventyConfig) {
-  const { config, publication } = eleventyConfig.globalData
-
-  return function ({ page }) {
-    const { description, identifier, promo_image, pub_date, pub_type, url } = publication
-    const pageType = page && page.type
-
-    const meta = [
-      {
-        property: 'og:title',
-        content: pageType != 'essay' ? publication.title : page.title
-      },
-      {
-        property: 'og:url',
-        content: new URL(page.url, url).toString()
-      },
-      {
-        property: 'og:image',
-        content: pageType != 'essay'
-          ? promo_image
-          : page.cover || promo_image
-      },
-      {
-        property: 'og:description',
-        content: pageType != 'essay'
-          ? description.one_line || description.full
-          : page.abstract || description.one_line || description.full
-      }
-    ]
-
-    if (pageType != 'essay' && pub_type === 'book') {
-      meta.push({ property: 'og:type', content: 'book' })
-      meta.push({
-        property: 'og:book:isbn', content: identifier.isbn && identifier.isbn.replace(/-/g, '')
-      })
-      meta.push({ property: 'og:book:release_date', content: pub_date })
-    } else {
-      meta.push({ property: 'og:type', content: 'article' })
-      meta.push({ property: 'og:site_name', content: publication.title })
-      meta.push({ property: 'og:article:published_time', content: pub_date })
-    }
-
-    /**
-     * Builds an array of page or publication contributor objects
-     */
-    publication.contributor.forEach((contributor, { id }) => {
-      if (!id) return
-      // resolve a page contributor id to a publication contributor
-      contributor = publication.contributor[id] && contributor
-
-      const { type, full_name, first_name, last_name } = contributor
-      const name = full_name || `${first_name} ${last_name}`
-
-      if (pageType === 'essay') {
-        meta.push({ name: 'og:article:author', content: name })
-      } else if (pub_type === 'book' && type === 'primary') {
-        meta.push({ name: 'og:book:author', content: name })
-      }
-    })
-
-    const metaTags = meta.map(({ property, content }) => (
-      `<meta property="${property}" content="${content}">`
-    ))
-    return `${metaTags.join('\n')}`
-  }
-}