Cite/get.js

  1. import {validateOutputOptions as validate} from './static'
  2. import {format as formatData} from '../get/registrar'
  3. import {csl as parseCsl} from '../parse/'
  5. /**
  6.  * Get a list of the data entry IDs, in the order of that list
  7.  *
  8.  * @memberof Cite#
  9.  *
  10.  * @return {Array<String>} List of IDs
  11.  */
  12. const getIds = function () {
  13.   return this.data.map(entry => entry.id)
  14. }
  16. /**
  17.  * Get formatted data from your object.
  18.  *
  19.  * @memberof Cite#
  20.  *
  21.  * @param {String} format - format module name
  22.  * @param {...*} options - module options (see relevant documentation)
  23.  *
  24.  * @return {String|Arrat<Object>} formatted data
  25.  */
  26. const format = function (format, ...options) {
  27.   return formatData(format, parseCsl(this.data), ...options)
  28. }
  30. /**
  31.  * Get formatted data from your object.
  32.  *
  33.  * @tutorial output
  34.  * @memberof Cite#
  35.  * @deprecated use {@link Cite#format}
  36.  *
  37.  * @param {Cite~OutputOptions} [options={}] - Output options
  38.  *
  39.  * @return {String|Array<Object>} The formatted data
  40.  */
  41. const get = function (options = {}) {
  42.   try {
  43.     validate(options)
  44.   } catch ({message}) {
  45.     logger.error('[get]', message)
  46.   }
  48.   const parsedOptions = Object.assign({}, this.defaultOptions, this._options.output, options)
  50.   const {type, style} = parsedOptions
  51.   const [styleType, styleFormat] = style.split('-')
  52.   const newStyle = styleType === 'citation' ? 'bibliography' : styleType === 'csl' ? 'data' : styleType
  53.   const newType = type === 'string' ? 'text' : type === 'json' ? 'object' : type
  55.   let formatOptions
  57.   switch (newStyle) {
  58.     case 'bibliography':
  59.       const {lang, append, prepend} = parsedOptions
  60.       formatOptions = {template: styleFormat, lang, format: newType, append, prepend}
  61.       break
  63.     case 'data':
  64.     case 'bibtex':
  65.     case 'bibtxt':
  66.       formatOptions = {type: newType}
  67.       break
  69.     default:
  70.       logger.error('[get]', 'Invalid options')
  71.       break
  72.   }
  74.   const result = this.format(newStyle, formatOptions)
  76.   const {format} = parsedOptions
  77.   if (format === 'real' && newType === 'html' && typeof document !== 'undefined' && typeof document.createElement === 'function') {
  78.     const tmp = document.createElement('div')
  79.     tmp.innerHTML = result
  80.     return tmp.firstChild
  81.   } else if (format === 'string' && typeof result === 'object') {
  82.     return JSON.stringify(result)
  83.   } else {
  84.     return result
  85.   }
  86. }
  88. export {format, getIds, get}