trilium/apps/server/src/test/becca_easy_mocking.ts

import { NoteType } from "@triliumnext/commons";

import BAttachment from "../becca/entities/battachment.js";
import BAttribute from "../becca/entities/battribute.js";
import BBranch from "../becca/entities/bbranch.js";
import BNote from "../becca/entities/bnote.js";
import utils, { randomString } from "../services/utils.js";

type AttributeDefinitions = { [key in `#${string}`]: string; };
type RelationDefinitions = { [key in `~${string}`]: string; };

interface NoteDefinition extends AttributeDefinitions, RelationDefinitions {
    id?: string | undefined;
    title?: string;
    content?: string;
    type?: NoteType;
    mime?: string;
    children?: NoteDefinition[];
    attachments?: {
        title: string;
        role: string;
        mime: string;
    }[];
}

/**
 * Creates the given notes with the given title and optionally one or more attributes.
 *
 * For a label to be created, simply pass on a key prefixed with `#` and any desired value.
 *
 * The notes and attributes will be injected in the froca.
 *
 * @param notes
 * @returns an array containing the IDs of the created notes.
 * @example
 * buildNotes([
 *  { title: "A", "#startDate": "2025-05-05" },
 *  { title: "B", "#startDate": "2025-05-07" }
 * ]);
 */
export function buildNotes(notes: NoteDefinition[]) {
    const ids: string[] = [];

    for (const noteDef of notes) {
        ids.push(buildNote(noteDef).noteId);
    }

    return ids;
}

export function buildNote(noteDef: NoteDefinition) {
    const note = new BNote({
        noteId: noteDef.id ?? utils.randomString(12),
        title: noteDef.title ?? "New note",
        type: noteDef.type ?? "text",
        mime: noteDef.mime ?? "text/html",
        isProtected: false,
        blobId: ""
    });

    // Handle content.
    if (noteDef.content !== undefined) {
        note.getContent = () => noteDef.content!;
    }

    // Handle children
    if (noteDef.children) {
        for (const childDef of noteDef.children) {
            const childNote = buildNote(childDef);
            new BBranch({
                noteId: childNote.noteId,
                parentNoteId: note.noteId,
                branchId: `${note.noteId}_${childNote.noteId}`
            });
        }
    }

    // Handle labels and relations.
    let position = 0;
    for (const [ key, value ] of Object.entries(noteDef)) {
        const attributeId = utils.randomString(12);
        const name = key.substring(1);

        let attribute: BAttribute | null = null;
        if (key.startsWith("#")) {
            attribute = new BAttribute({
                noteId: note.noteId,
                attributeId,
                type: "label",
                name,
                value,
                position,
                isInheritable: false
            });
        }

        if (key.startsWith("~")) {
            attribute = new BAttribute({
                noteId: note.noteId,
                attributeId,
                type: "relation",
                name,
                value,
                position,
                isInheritable: false
            });
        }

        if (!attribute) {
            continue;
        }

        position++;
    }

    // Handle attachments.
    if (noteDef.attachments) {
        const allAttachments: BAttachment[] = [];
        for (const { title, role, mime } of noteDef.attachments) {
            const attachment = new BAttachment({
                attachmentId: randomString(10),
                ownerId: note.noteId,
                title,
                role,
                mime
            });
            allAttachments.push(attachment);
        }

        note.getAttachmentsByRole = (role) => allAttachments.filter(a => a.role === role);
    }

    return note;
}