@antora/ui-loader/lib/ui-catalog.js

Downloads a UI bundle, if necessary, and loads the files into a UI catalog for use in an Antora documentation pipeline.

'use strict'

const $files = Symbol('files')

class UiCatalog {
  constructor () {
    this[$files] = new Map()
  }

  getFiles () {
    const accum = []
    for (const filesForType of this[$files].values()) {
      for (const file of filesForType.values()) accum.push(file)
    }
    return accum
  }

  addFile (file) {
    let filesForType = this[$files].get(file.type)
    if (!filesForType) this[$files].set(file.type, (filesForType = new Map()))
    const key = file.path
    if (filesForType.has(key)) {
      throw new Error('Duplicate UI file: ' + key)
    }
    filesForType.set(key, file)
    return file
  }

  removeFile (file) {
    const filesForType = this[$files].get(file.type)
    return filesForType ? filesForType.delete(file.path) : false
  }

  findByType (type) {
    const filesForType = this[$files].get(type)
    return filesForType ? [...filesForType.values()] : []
  }
}

/**
 * @deprecated superceded by getFiles(); scheduled to be removed in Antora 4
 */
UiCatalog.prototype.getAll = UiCatalog.prototype.getFiles

module.exports = UiCatalog