@uiengine/util/src/page.js

UIengine utilities.

const { basename, dirname, join, relative, resolve } = require('path')
const R = require('ramda')
const FileUtil = require('./file')
const { crossPlatformPath, titleize } = require('./string')
const { UiengineInputError } = require('./error')

const INDEX_FILE_PATH = '.'
const INDEX_PAGE_PATH = ''
const PAGE_CONFNAME = 'page.config.js'
const PAGE_DOCSNAME = 'README.md'
const INDEX_ID = 'index'

// types
const PAGE_TYPE_TOKENS = 'tokens'
const PAGE_TYPE_TEMPLATE = 'template'
const PAGE_TYPE_DOCUMENTATION = 'documentation'

const isIndexPage = pageId =>
  pageId === INDEX_ID

const isIndexFilePath = pagePath =>
  pagePath === INDEX_FILE_PATH

const isIndexPagePath = pagePath =>
  pagePath === INDEX_PAGE_PATH

const isDocumentationPage = pageType =>
  pageType === PAGE_TYPE_DOCUMENTATION

const isTokensPage = pageType =>
  pageType === PAGE_TYPE_TOKENS

const pageIdToPath = pageId =>
  isIndexPage(pageId) ? INDEX_PAGE_PATH : pageId

const pageIdForComponentId = (parentPageId, componentId) =>
  isIndexPage(parentPageId) ? componentId : `${pageIdToPath(parentPageId)}/${componentId}`

const pagePathForComponentId = (parentPagePath, componentId) =>
  isIndexPagePath(parentPagePath) ? componentId : `${parentPagePath}/${componentId}`

const pageIdToTitle = pageId => {
  if (isIndexPage(pageId)) return 'Home'

  const base = basename(pageId)
  const title = titleize(base)

  return title
}

const pageIdToFilePath = (pagesPath, pageId, fileName = PAGE_CONFNAME) => {
  const relativePath = isIndexPage(pageId) ? INDEX_FILE_PATH : pageId
  const absolutePath = join(pagesPath, relativePath, fileName)

  return absolutePath
}

const pageFilePathToId = (pagesPath, filePath) => {
  const relativePath = relative(pagesPath, filePath)

  // invalid path: this is not a page
  if (relativePath.startsWith('..')) return null

  const dir = dirname(relativePath)
  const file = basename(relativePath)
  const isPageFile = file === PAGE_CONFNAME || file === PAGE_DOCSNAME

  if (isPageFile || FileUtil.exists(resolve(filePath, '..', PAGE_CONFNAME)) || FileUtil.exists(resolve(filePath, '..', PAGE_DOCSNAME))) {
    const pageId = isIndexFilePath(dir) ? INDEX_ID : crossPlatformPath(dir)

    return pageId
  } else {
    const parentPath = resolve(filePath, '..', '..')
    const parentFilePath = join(parentPath, file)

    return pageFilePathToId(pagesPath, parentFilePath)
  }
}

const parentIdForPageId = (pageIds, pageId) => {
  if (isIndexPage(pageId)) return null
  const parentDir = dirname(pageId)
  const parentId = isIndexFilePath(parentDir) ? INDEX_ID : parentDir

  return pageIds.includes(parentId)
    ? parentId
    : parentIdForPageId(pageIds, parentId)
}

const determineType = attributes => {
  if (attributes.tokens) {
    return PAGE_TYPE_TOKENS
  } else if (attributes.template || attributes.fragment) {
    return PAGE_TYPE_TEMPLATE
  } else {
    return PAGE_TYPE_DOCUMENTATION
  }
}

// turns the list of children from the user provided attributes
// into a list of correctly named childIds
const convertUserProvidedChildrenList = (pageId, availableChildIds, attributes) => {
  const { children } = attributes
  if (!(children instanceof Array)) return attributes

  const prefix = pageIdToPath(pageId)
  const childIds = R.map(id => {
    const childId = id.startsWith(prefix) ? id : `${prefix}/${id}`
    if (availableChildIds.includes(childId)) {
      return childId
    } else {
      throw new UiengineInputError([
        `Child page "${id}" does not exist for page "${pageId}".`,
        'Here is a list of available child pages:',
        availableChildIds.map(childId => `- ${childId}`).join('\n')
      ])
    }
  }, children)

  attributes = R.dissoc('children', attributes)
  attributes = R.assoc('childIds', childIds, attributes)

  return attributes
}

// turns the list of components from the user provided attributes
// into a list of correctly named componentIds
const convertUserProvidedComponentsList = (pageId, attributes) => {
  const { components } = attributes
  if (typeof components !== 'object') return attributes

  attributes = R.dissoc('components', attributes)
  attributes = R.assoc('componentIds', components, attributes)

  return attributes
}

module.exports = {
  PAGE_CONFNAME,
  PAGE_DOCSNAME,
  INDEX_ID,
  convertUserProvidedChildrenList,
  convertUserProvidedComponentsList,
  isIndexPage,
  isIndexFilePath,
  isIndexPagePath,
  isDocumentationPage,
  isTokensPage,
  determineType,
  pageIdToPath,
  pageIdForComponentId,
  pagePathForComponentId,
  pageIdToTitle,
  pageIdToFilePath,
  pageFilePathToId,
  parentIdForPageId
}