Skip to content

Build your personal knowledge base with Trilium Notes

4.6 KB
Raw Blame
import server from "./server.js";
import ws from "./ws.js";
import MoveNoteBulkAction from "../widgets/bulk_actions/note/move_note.js";
import DeleteNoteBulkAction from "../widgets/bulk_actions/note/delete_note.js";
import SaveRevisionBulkAction from "../widgets/bulk_actions/note/save_revision.js";
import DeleteRevisionsBulkAction from "../widgets/bulk_actions/note/delete_revisions.js";
import DeleteLabelBulkAction from "../widgets/bulk_actions/label/delete_label.js";
import DeleteRelationBulkAction from "../widgets/bulk_actions/relation/delete_relation.js";
import RenameLabelBulkAction from "../widgets/bulk_actions/label/rename_label.js";
import RenameRelationBulkAction from "../widgets/bulk_actions/relation/rename_relation.js";
import UpdateLabelValueBulkAction from "../widgets/bulk_actions/label/update_label_value.js";
import UpdateRelationTargetBulkAction from "../widgets/bulk_actions/relation/update_relation_target.js";
import ExecuteScriptBulkAction from "../widgets/bulk_actions/execute_script.js";
import AddLabelBulkAction from "../widgets/bulk_actions/label/add_label.js";
import AddRelationBulkAction from "../widgets/bulk_actions/relation/add_relation.js";
import RenameNoteBulkAction from "../widgets/bulk_actions/note/rename_note.js";
import ConvertNoteBulkAction from "../widgets/bulk_actions/note/convert_note.js";
import { t } from "./i18n.js";
import type FNote from "../entities/fnote.js";
import toast from "./toast.js";
import { BulkAction } from "@triliumnext/commons";

export const ACTION_GROUPS = [
    {
        title: t("bulk_actions.labels"),
        icon: "bx bx-hash",
        actions: [AddLabelBulkAction, UpdateLabelValueBulkAction, RenameLabelBulkAction, DeleteLabelBulkAction]
    },
    {
        title: t("bulk_actions.relations"),
        icon: "bx bx-transfer",
        actions: [AddRelationBulkAction, UpdateRelationTargetBulkAction, RenameRelationBulkAction, DeleteRelationBulkAction]
    },
    {
        title: t("bulk_actions.notes"),
        icon: "bx bx-note",
        actions: [RenameNoteBulkAction, MoveNoteBulkAction, ConvertNoteBulkAction, DeleteNoteBulkAction, SaveRevisionBulkAction, DeleteRevisionsBulkAction]
    },
    {
        title: t("bulk_actions.other"),
        icon: "bx bx-dots-horizontal-rounded",
        actions: [ExecuteScriptBulkAction]
    }
];

const ACTION_CLASSES = [
    RenameNoteBulkAction,
    MoveNoteBulkAction,
    DeleteNoteBulkAction,
    SaveRevisionBulkAction,
    DeleteRevisionsBulkAction,
    DeleteLabelBulkAction,
    DeleteRelationBulkAction,
    RenameLabelBulkAction,
    RenameRelationBulkAction,
    AddLabelBulkAction,
    AddRelationBulkAction,
    UpdateLabelValueBulkAction,
    UpdateRelationTargetBulkAction,
    ExecuteScriptBulkAction,
    ConvertNoteBulkAction
];

async function addAction(noteId: string, actionName: string) {
    await server.post(`notes/${noteId}/attributes`, {
        type: "label",
        name: "action",
        value: JSON.stringify({
            name: actionName
        })
    });

    await ws.waitForMaxKnownEntityChangeId();
}

function parseActions(note: FNote) {
    const actionLabels = note.getLabels("action");

    return actionLabels
        .map((actionAttr) => {
            let actionDef;

            try {
                actionDef = JSON.parse(actionAttr.value);
            } catch (e: any) {
                logError(`Parsing of attribute: '${actionAttr.value}' failed with error: ${e.message}`);
                return null;
            }

            const ActionClass = ACTION_CLASSES.find((actionClass) => actionClass.actionName === actionDef.name);

            if (!ActionClass) {
                logError(`No action class for '${actionDef.name}' found.`);
                return null;
            }

            return new ActionClass(actionAttr, actionDef);
        })
        .filter((action) => !!action);
}

export interface BulkActionOptions {
    /** Whether to apply the actions to every descendant of the given notes as well. */
    includeDescendants?: boolean;
    /**
     * Whether to skip the "bulk actions executed" toast, for a caller whose own UI already
     * shows the result of the change.
     */
    silent?: boolean;
}

export async function executeBulkActions(
    targetNoteIds: string[],
    actions: BulkAction[],
    { includeDescendants = false, silent = false }: BulkActionOptions = {}
) {
    await server.post("bulk-action/execute", {
        noteIds: targetNoteIds,
        includeDescendants,
        actions
    });

    await ws.waitForMaxKnownEntityChangeId();

    if (!silent) {
        toast.showMessage(t("bulk_actions.bulk_actions_executed"), 3000);
    }
}

export default {
    addAction,
    parseActions,
    ACTION_CLASSES,
    ACTION_GROUPS
};