myst-cli/dist/build/utils/projectManifest.js

Command line tools for MyST

import { castSession } from '../../session/cache.js';
import { selectors } from '../../store/index.js';
import { fileTitle } from '../../utils/fileInfo.js';
export async function manifestPagesFromProject(session, projectPath) {
    const state = session.store.getState();
    const proj = selectors.selectLocalProject(state, projectPath);
    if (!proj)
        return [];
    const cache = castSession(session);
    const pages = await Promise.all(proj.pages.map(async (tocEntry) => {
        if ('hidden' in tocEntry && tocEntry.hidden)
            return null; // skip hidden pages
        if ('file' in tocEntry) {
            // fileInfo has metadata about the file taken from the toc and file frontmatter
            const fileInfo = selectors.selectFileInfo(state, tocEntry.file);
            // Choose title and short_title based on hierarchy of metadata
            const title = fileInfo.title ?? fileTitle(tocEntry.file);
            const short_title = tocEntry.title ?? fileInfo.short_title ?? undefined;
            // Everything else we pull from fileInfo
            const description = fileInfo.description ?? '';
            const thumbnail = fileInfo.thumbnail ?? '';
            const thumbnailOptimized = fileInfo.thumbnailOptimized ?? '';
            const banner = fileInfo.banner ?? '';
            const bannerOptimized = fileInfo.bannerOptimized ?? '';
            const date = fileInfo.date ?? '';
            const tags = fileInfo.tags ?? [];
            const { slug, level, file } = tocEntry;
            const { frontmatter } = cache.$getMdast(file)?.post ?? {};
            const projectPage = {
                slug,
                title,
                short_title,
                description,
                date,
                thumbnail,
                thumbnailOptimized,
                banner,
                bannerOptimized,
                tags,
                level,
                enumerator: frontmatter?.enumerator,
            };
            return projectPage;
        }
        if ('url' in tocEntry) {
            const { title, url, open_in_same_tab, level } = tocEntry;
            const externalURL = {
                title,
                url,
                open_in_same_tab,
                level,
            };
            return externalURL;
        }
        // Not a file or URL, probably a sub-entry; try and bubble down
        return { ...tocEntry };
    }));
    return pages?.filter((p) => p !== null);
}
export function manifestTitleFromProject(session, projectPath) {
    const state = session.store.getState();
    const projConfig = selectors.selectLocalProjectConfig(state, projectPath);
    if (projConfig?.title)
        return projConfig.title;
    const proj = selectors.selectLocalProject(state, projectPath);
    if (!proj)
        return 'Untitled';
    const projectFileInfo = selectors.selectFileInfo(session.store.getState(), proj.file);
    return projectFileInfo.title || proj.index || 'Untitled';
}
export function indexFrontmatterFromProject(session, projectPath) {
    const state = session.store.getState();
    const cache = castSession(session);
    const proj = selectors.selectLocalProject(state, projectPath);
    if (!proj)
        return {};
    const { file } = proj;
    const { frontmatter } = cache.$getMdast(file)?.post ?? {};
    return frontmatter ?? {};
}