XeNote/lib/utils.js

import { Node } from "./node"
import { Transformer } from "./transformer";
import { unified } from "unified";
import markdown from "remark-parse";
import { toString } from 'mdast-util-to-string'
import path from "path";
import fs from "fs";

const dirTree = require("directory-tree");


export function getContent(slug) {
  let currentFilePath = toFilePath(slug)
  if (currentFilePath === undefined || currentFilePath == null) return null
  return Node.readFileSync(currentFilePath)
}

export function getShortSummary(slug) {
  const content = getContent(slug)
  if (content === undefined || content === null) {
    return
  }

  const tree = unified().use(markdown)
    .parse(content)
  let plainText = toString(tree)
  return plainText.split(" ").splice(0, 40).join(" ")
}


export function getAllMarkdownFiles() {
  return Node.getFiles(Node.getMarkdownFolder())
}

export function getSinglePost(slug) {

  const t = new Transformer()

  // List of filenames that will provide existing links to wikilink
  let currentFilePath = toFilePath(slug)
  //console.log("currentFilePath: ", currentFilePath)

  var fileContent = Node.readFileSync(currentFilePath)

  //const currentFileFrontMatter = t.getFrontMatterData(fileContent)
  // console.log("===============\n\nFile is scanning: ", slug)
  const [htmlContent] = t.getHtmlContent(fileContent)
  // console.log("==================================")
  //console.log("hrmlcontents and backlinks")
  return {
    id: slug,
    // ...currentFileFrontMatter,
    data: htmlContent,
  }

}

const cachedSlugMap = getSlugHashMap()

export function toFilePath(slug) {
  return cachedSlugMap[slug]
}

export function getSlugHashMap() {
  // This is to solve problem of converting between slug and filepath,
  // where previously if I convert a slug to a file path sometime
  // it does not always resolve to correct filepath, converting function is not bi-directional
  // and not conflict-free, other solution was considered (hash file name into a hash, but this
  // is not SEO-friendly and make url look ugly ==> I chose this

  const slugMap = new Map()
  getAllMarkdownFiles().map(aFile => {
    const aSlug = toSlug(aFile);
    // if (slugMap.has(aSlug)) {
    //     slugMap[aSlug].push(aFile)
    // } else {
    //     slugMap[aSlug] = [aFile]
    // }
    // Note: [Future improvement] Resolve conflict
    slugMap[aSlug] = aFile
  })

  const indexFile = "/🌎 Home.md"
  slugMap['index'] = Node.getMarkdownFolder() + indexFile
  slugMap['/'] = Node.getMarkdownFolder() + indexFile

  return slugMap
}


export function toSlug(filePath) {
  const markdownFolder = Node.getMarkdownFolder()
  const isFile = Node.isFile(filePath)
  const isMarkdownFolder = filePath.includes(markdownFolder)

  if (isFile && isMarkdownFolder) {
    return filePath.replace(markdownFolder, '')
      .replaceAll('/', '_')
      .replaceAll(' ', '+')
      .replaceAll('&', '-')
      .replace('.md', '')
  } else {
    //TODO handle this properly
    return '/'
  }

}



export function constructGraphData() {
  const t = new Transformer()
  const filepath = path.join(process.cwd(), "graph-data.json");
  if (Node.isFile(filepath)) {
    const data = fs.readFileSync(filepath);
    return JSON.parse(String(data))
  } else {
    const filePaths = getAllMarkdownFiles();
    const edges = []
    const nodes = []
    filePaths
      .forEach(aFilePath => {
        // const {currentFilePath} = getFileNames(filename)
        const aNode = {
          title: t.parseFileNameFromPath(aFilePath),
          slug: toSlug(aFilePath),
          shortSummary: getShortSummary(toSlug(aFilePath))
        }
        nodes.push(aNode)

        // console.log("Constructing graph for node: " + aFilePath )
        const internalLinks = t.getInternalLinks(aFilePath)
        internalLinks.forEach(aLink => {

          if (aLink.slug === null || aLink.slug.length === 0) return

          const anEdge = {
            source: toSlug(aFilePath),
            target: aLink.slug,
          }
          edges.push(anEdge)
          // console.log("Source: " + anEdge.source)
          // console.log("Target: " + anEdge.target)
        })
        // console.log("==============Constructing graph" )
      }
      )
    const data = { nodes, edges };
    fs.writeFileSync(filepath, JSON.stringify(data), "utf-8");
    return data;
  }
}


export function getLocalGraphData(currentNodeId) {
  const t = new Transformer()
  const { nodes, edges } = constructGraphData()

  const newNodes = nodes.map(aNode => (
    {
      data: {
        id: aNode.slug.toString(),
        label: t.parseFileNameFromPath(toFilePath(aNode.slug)),
      }
    }
  ))

  const newEdges = edges.map(anEdge => ({
    data: {
      source: anEdge.source,
      target: anEdge.target,
    }
  }))


  const existingNodeIDs = newNodes.map(aNode => aNode.data.id)
  currentNodeId = currentNodeId === 'index' ? '__index' : currentNodeId
  if (currentNodeId != null && existingNodeIDs.includes(currentNodeId)) {
    const outGoingNodeIds = newEdges
      .filter(anEdge => anEdge.data.source === currentNodeId)
      .map(anEdge => anEdge.data.target)

    const incomingNodeIds = newEdges
      .filter(anEdge => anEdge.data.target === currentNodeId)
      .map(anEdge => anEdge.data.source)

    outGoingNodeIds.push(currentNodeId)

    const localNodeIds = incomingNodeIds.concat(outGoingNodeIds.filter(item => incomingNodeIds.indexOf(item) < 0))
    if (localNodeIds.indexOf(currentNodeId) < 0) {
      localNodeIds.push(currentNodeId)
    }

    const localNodes = newNodes.filter(aNode => localNodeIds.includes(aNode.data.id))
    let localEdges = newEdges.filter(edge => localNodeIds.includes(edge.data.source)).filter(edge => localNodeIds.includes(edge.data.target));

    // Filter self-reference edges
    localEdges = localEdges.filter(edge => edge.data.source !== edge.data.target)

    // TODO: Find out why target ==='/' in some case
    localEdges = localEdges.filter(edge => edge.data.target !== '/')
    return {
      nodes: localNodes,
      edges: localEdges
    }
  } else {
    const filteredEdges = newEdges
      .filter(edge => existingNodeIDs.includes(edge.data.source))
      .filter(edge => existingNodeIDs.includes(edge.data.target))

    return {
      nodes: newNodes,
      edges: filteredEdges
    }
  }


}

export function getAllSlugs() {
  //console.log("\n\nAll Posts are scanning")
  // Get file names under /posts
  const markdownFolder = Node.getMarkdownFolder()
  const markdownFiles = Node.getFiles(markdownFolder)
  const filePaths = markdownFiles.filter(file => !(file.endsWith("index") || file.endsWith("sidebar")))
  return filePaths.map(f => toSlug(f))
}

export function getDirectoryData() {
  const filteredDirectory = dirTree(Node.getMarkdownFolder(), { extensions: /\.md/, exclude: [/\.git/, /\.obsidian/] });
  return convertObject(filteredDirectory)
}

let _counter = 0;

export function convertObject(thisObject) {
  const t = new Transformer()
  const children = []

  let routerPath = getAllSlugs().find(slug => {
    const fileName = t.parseFileNameFromPath(toFilePath(slug))
    return t.normalizeFileName(fileName) === t.normalizeFileName(thisObject.name)
  }) || null
  routerPath = routerPath ? '/note/' + routerPath : null
  const newObject = {
    name: thisObject.name,
    children: children,
    id: (_counter++).toString(),
    routePath: routerPath || null
  };

  if (thisObject.children != null && thisObject.children.length > 0) {
    thisObject.children.forEach(aChild => {
      const newChild = convertObject(aChild)
      children.push(newChild)
    })
    return newObject;
  } else {
    return newObject
  }
}

function flat(array) {
  var result = [];
  array.forEach(function(a) {
    result.push(a);
    if (Array.isArray(a.children)) {
      result = result.concat(flat(a.children));
    }
  });
  return result;
}

export function getFlattenArray(thisObject) {
  return flat(thisObject.children)
}