Skip to content

Build your personal knowledge base with Trilium Notes

3.3 KB
Raw Blame
import { MERMAID_ATTACHMENT_MIME } from "@triliumnext/commons";
import type { ComponentType } from "preact";

import type { ContentEditor } from "./content_renderer";

/** What the component of a {@link SourceEmbedType} receives, wherever its source is stored. */
export interface SourceEmbedProps {
    /** The saved source. It changes when the source is saved elsewhere, or undone. */
    content: string;
    /** Saves the edited source. Without it the content is read-only. */
    editor?: ContentEditor;
    /** The language of a source kept inline, as a CKEditor code block language. */
    language?: string;
}

/**
 * A kind of content that an embed in a text note shows from a source, such as a Mermaid diagram.
 * The source is stored in one of two ways, and its component works the same with both:
 *
 * - inline, as a `<pre><code class="language-…">` code block of the note, of {@link language};
 * - in an attachment of the note, of media type {@link mime}.
 */
export interface SourceEmbedType {
    /** The language of the code block that keeps the source inline. */
    language: string;
    /** The media type of an attachment that keeps the source. */
    mime: string;
    /** The content type that `getRenderedContent()` names the content, for its styles. */
    contentType: string;
    /** Loads the component that shows and edits the source. */
    load(): Promise<ComponentType<SourceEmbedProps>>;
    /** Renders `source` into `container` as a static picture, outside an embed. */
    renderPreview(source: string, container: HTMLElement): Promise<void>;
}

export const SOURCE_EMBED_TYPES: readonly SourceEmbedType[] = [
    {
        language: "mermaid",
        mime: MERMAID_ATTACHMENT_MIME,
        contentType: "mermaidDiagram",
        load: async () => (await import("../widgets/type_widgets/mermaid/MermaidDiagram")).default,
        async renderPreview(source, container) {
            const { renderMermaidSvg } = await import("./mermaid");
            try {
                container.innerHTML = await renderMermaidSvg(source);
            } catch (e) {
                container.textContent = (e as Error)?.message ?? String(e);
            }
        }
    }
];

/** What an embed of a source kept inline shows, by {@link getInlineEmbedType}. */
export type InlineEmbedType = Pick<SourceEmbedType, "contentType" | "load">;

/** An extended code block: code kept inline, shown in the code editor by `InlineCodeEmbed`. */
const EXTENDED_CODE_BLOCK_TYPE: InlineEmbedType = {
    contentType: "extendedCodeBlock",
    load: async () => (await import("../widgets/type_widgets/code/CodeEmbed")).InlineCodeEmbed
};

/**
 * The type of an embed of a source kept inline, of `language`: the source embed type of that
 * language, otherwise an extended code block.
 */
export function getInlineEmbedType(language: string): InlineEmbedType {
    return getSourceEmbedTypeByLanguage(language) ?? EXTENDED_CODE_BLOCK_TYPE;
}

/** The type of the source embeds whose code blocks are of `language`, or `undefined`. */
export function getSourceEmbedTypeByLanguage(language: string) {
    return SOURCE_EMBED_TYPES.find((type) => type.language === language);
}

/** The type of the source embeds whose content type is `contentType`, or `undefined`. */
export function getSourceEmbedTypeByContentType(contentType: string) {
    return SOURCE_EMBED_TYPES.find((type) => type.contentType === contentType);
}