interface File {
  constructor(fileProps: FileProps): File
  update(fileProps: FileProps): void
  name: string
  // the display name of file, usually the last part on path components

  path: string
  // just like id, file can be identified by it's path

  get id(): string
  // alias to this.path

  isDir: boolean
  // see if it has children

  contentType: string
  content: string
  size: number
  gitStatus: object

  isRoot: boolean
  // see if this file is the root node

  depth: number
  // depth calc from file path, root's depth is 0
  
  parent: File
  children: File[]
  siblings: File[]
  // all files in the same directory, including self

  firstChild: File
  // this.children[0]

  lastChild: File
  // this.children[this.children.length - 1]

  prev: File
  next: File
  // previous/next file in same directory, return undefined if not found
}

interface FileStore {
  get(path: string): File
  // get file by path

  isValid(file: File): boolean
  // test if an object is instance of File

  // @fixme: probably should rename this method
  loadNodeData(filePropsList: FileProps[]): void
  // load file data, identify files by it's path

  fetchProjectRoot(): void
  // api.fetchPath('/').then(loadNodeData)

  updateFile(fileProps: FileProps): void
  // update props of a file node, path is required

  removeNode(file: File): void
  // remove the file node from state.entities
}