motionlink-cli/lib/services/post_processing_service.d.ts

Making it easy to use Notion as a Content Management system for personal websites, portfolios, blogs, business homepages, and other kinds of static websites.

/**
 * Buffers a file write and only writes it to the file system once all the links
 * it has to other pages have been resolved.
 *
 * Notion allows users to mention other pages in their pages. When the
 * Markdown for a page with such links is generated, we want to maintain these
 * links. However, by the time the page is generated, some of the pages
 * it mentions might not be generated yet, which means we will not know
 * their paths in the output directory. To fix this we allow the markdown
 * transfomers, and config files, to use path placeholders when linking to a
 * a page that is yet to be generated.
 *
 * A path placeholder has the form `:::pathTo:::page_id:::`, where page_id is the id
 * of the page being linked to. When the text content of a page is submitted, the
 * `PostProcessingService` looks for all the other buffered pages that link
 * to the page and overwrites the path placelders with the actual path to the page,
 * such that a page is only flushed to the file system once all the path placeholders
 * it has have been resolved.
 *
 * The {@link flush} method can be used to force all buffered pages to be written to the
 * file system. This should be called when there are no more pages expected to be
 * generated.
 *
 * Using post processing to solve the page linking problem only works if the pages
 * being linked to are going to be generated. If not, the links will be broken.
 */
export default class PostProcessingService {
    private readonly pagePaths;
    private readonly pagesWithLinks;
    submit(content: string, pgPath: string, pgId: string): void;
    flush(): void;
    private getRelativeLink;
    private static _instance;
    static get instance(): PostProcessingService;
    static setMockedInstance(instance: PostProcessingService): void;
}