Overleaf/services/web/frontend/js/shared/context/project-context.js

import { createContext, useContext } from 'react'
import PropTypes from 'prop-types'
import useScopeValue from '../hooks/use-scope-value'

const ProjectContext = createContext()

const fileTreeDataPropType = PropTypes.shape({
  _id: PropTypes.string.isRequired,
  name: PropTypes.string.isRequired,
  docs: PropTypes.array.isRequired,
  fileRefs: PropTypes.array.isRequired,
  folders: PropTypes.array.isRequired,
})

ProjectContext.Provider.propTypes = {
  value: PropTypes.shape({
    _id: PropTypes.string.isRequired,
    name: PropTypes.string.isRequired,
    rootDoc_id: PropTypes.string,
    members: PropTypes.arrayOf(
      PropTypes.shape({
        _id: PropTypes.string.isRequired,
      })
    ),
    invites: PropTypes.arrayOf(
      PropTypes.shape({
        _id: PropTypes.string.isRequired,
      })
    ),
    features: PropTypes.shape({
      collaborators: PropTypes.number,
      compileGroup: PropTypes.oneOf(['alpha', 'standard', 'priority']),
      trackChangesVisible: PropTypes.bool,
      references: PropTypes.bool,
      mendeley: PropTypes.bool,
      zotero: PropTypes.bool,
    }),
    publicAccesLevel: PropTypes.string,
    tokens: PropTypes.shape({
      readOnly: PropTypes.string,
      readAndWrite: PropTypes.string,
    }),
    owner: PropTypes.shape({
      _id: PropTypes.string.isRequired,
      email: PropTypes.string.isRequired,
    }),
    rootFolder: PropTypes.arrayOf(fileTreeDataPropType),
  }),
}

export function useProjectContext(propTypes) {
  const context = useContext(ProjectContext)

  if (!context) {
    throw new Error(
      'useProjectContext is only available inside ProjectProvider'
    )
  }

  PropTypes.checkPropTypes(
    propTypes,
    context,
    'data',
    'ProjectContext.Provider'
  )

  return context
}

export function ProjectProvider({ children }) {
  const [project] = useScopeValue('project', true)

  // when the provider is created the project is still not added to the Angular scope.
  // Name is also populated to prevent errors in existing React components
  const value = project || { _id: window.project_id, name: '', features: {} }

  return (
    <ProjectContext.Provider value={value}>{children}</ProjectContext.Provider>
  )
}

ProjectProvider.propTypes = {
  children: PropTypes.any,
}