gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-20 15:19:01 +02:00
Code Issues Actions 19 Packages Projects Releases Wiki Activity

refactor(bulk_action): remake types & change method signature

Browse Source
This commit is contained in:
Elian Doran 2025-07-19 12:32:47 +03:00
parent daa4743967
commit e2c8443778
No known key found for this signature in database
3 changed files with 76 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/routes/api/bulk_action.ts
View File

@ -12,7 +12,7 @@ function execute(req: Request) {
const bulkActionNote = becca.getNoteOrThrow("_bulkAction");
bulkActionService.executeActions(bulkActionNote, affectedNoteIds);
bulkActionService.executeActionsFromNote(bulkActionNote, affectedNoteIds);
}
function getAffectedNoteCount(req: Request) {

2
apps/server/src/routes/api/search.ts
View File

@ -40,7 +40,7 @@ function searchAndExecute(req: Request) {
const { searchResultNoteIds } = searchService.searchFromNote(note);
bulkActionService.executeActions(note, searchResultNoteIds);
bulkActionService.executeActionsFromNote(note, searchResultNoteIds);
}
function quickSearch(req: Request) {

112
apps/server/src/services/bulk_actions.ts
View File

@ -6,97 +6,88 @@ import { randomString } from "./utils.js";
import eraseService from "./erase.js";
import type BNote from "../becca/entities/bnote.js";
interface AddLabelAction {
type ActionHandlers = {
addLabel: {
labelName: string;
labelValue?: string;
}
interface AddRelationAction {
},
addRelation: {
relationName: string;
targetNoteId: string;
}
interface DeleteRevisionsAction {}
interface DeleteLabelAction {
},
deleteNote: {},
deleteRevisions: {},
deleteLabel: {
labelName: string;
}
interface DeleteRelationAction {
},
deleteRelation: {
relationName: string;
}
interface RenameNoteAction {
},
renameNote: {
newTitle: string;
}
interface RenameLabelAction {
},
renameLabel: {
oldLabelName: string;
newLabelName: string;
}
interface RenameRelationAction {
},
renameRelation: {
oldRelationName: string;
newRelationName: string;
}
interface UpdateLabelValueAction {
},
updateLabelValue: {
labelName: string;
labelValue: string;
}
interface UpdateRelationTargetAction {
},
updateRelationTarget: {
relationName: string;
targetNoteId: string;
}
interface MoveNoteAction {
},
moveNote: {
targetParentNoteId: string;
}
interface ExecuteScriptAction {
},
executeScript: {
script: string;
}
interface DeleteNoteAction { }
type BulkAction = AddLabelAction | AddRelationAction | DeleteNoteAction | DeleteRevisionsAction | DeleteLabelAction | DeleteRelationAction | RenameNoteAction | RenameLabelAction | RenameRelationAction | UpdateLabelValueAction | UpdateRelationTargetAction | MoveNoteAction | ExecuteScriptAction;
};
type ActionHandler<T> = (action: T, note: BNote) => void;
type ActionHandlerMap = {
[K in keyof BulkAction]: ActionHandler<K>;
}
[K in keyof ActionHandlers]: ActionHandler<ActionHandlers[K] & { name: K }>;
};
export type BulkAction = { name: keyof ActionHandlers } & ActionHandlers[keyof ActionHandlers];
const ACTION_HANDLERS: ActionHandlerMap = {
addLabel: (action: AddLabelAction, note: BNote) => {
addLabel: (action, note) => {
note.addLabel(action.labelName, action.labelValue);
},
addRelation: (action: AddRelationAction, note: BNote) => {
addRelation: (action, note) => {
note.addRelation(action.relationName, action.targetNoteId);
},
deleteNote: (action: DeleteNoteAction, note: BNote) => {
deleteNote: (action, note) => {
const deleteId = `searchbulkaction-${randomString(10)}`;
note.deleteNote(deleteId);
},
deleteRevisions: (action: DeleteRevisionsAction, note: BNote) => {
deleteRevisions: (action, note) => {
const revisionIds = note
.getRevisions()
.map((rev) => rev.revisionId)
.filter((rev) => !!rev) as string[];
eraseService.eraseRevisions(revisionIds);
},
deleteLabel: (action: DeleteLabelAction, note: BNote) => {
deleteLabel: (action, note) => {
for (const label of note.getOwnedLabels(action.labelName)) {
label.markAsDeleted();
}
},
deleteRelation: (action: DeleteRelationAction, note: BNote) => {
deleteRelation: (action, note) => {
for (const relation of note.getOwnedRelations(action.relationName)) {
relation.markAsDeleted();
}
},
renameNote: (action: RenameNoteAction, note: BNote) => {
renameNote: (action, note) => {
// "officially" injected value:
// - note
@ -107,7 +98,7 @@ const ACTION_HANDLERS: ActionHandlerMap = {
note.save();
}
},
renameLabel: (action: RenameLabelAction, note: BNote) => {
renameLabel: (action, note) => {
for (const label of note.getOwnedLabels(action.oldLabelName)) {
// attribute name is immutable, renaming means delete old + create new
const newLabel = label.createClone("label", action.newLabelName, label.value);
@ -116,7 +107,7 @@ const ACTION_HANDLERS: ActionHandlerMap = {
label.markAsDeleted();
}
},
renameRelation: (action: RenameRelationAction, note: BNote) => {
renameRelation: (action, note) => {
for (const relation of note.getOwnedRelations(action.oldRelationName)) {
// attribute name is immutable, renaming means delete old + create new
const newRelation = relation.createClone("relation", action.newRelationName, relation.value);
@ -125,19 +116,19 @@ const ACTION_HANDLERS: ActionHandlerMap = {
relation.markAsDeleted();
}
},
updateLabelValue: (action: UpdateLabelValueAction, note: BNote) => {
updateLabelValue: (action, note) => {
for (const label of note.getOwnedLabels(action.labelName)) {
label.value = action.labelValue;
label.save();
}
},
updateRelationTarget: (action: UpdateRelationTargetAction, note: BNote) => {
updateRelationTarget: (action, note) => {
for (const relation of note.getOwnedRelations(action.relationName)) {
relation.value = action.targetNoteId;
relation.save();
}
},
moveNote: (action: MoveNoteAction, note: BNote) => {
moveNote: (action, note) => {
const targetParentNote = becca.getNote(action.targetParentNoteId);
if (!targetParentNote) {
@ -158,7 +149,7 @@ const ACTION_HANDLERS: ActionHandlerMap = {
log.info(`Moving/cloning note ${note.noteId} to ${action.targetParentNoteId} failed with error ${JSON.stringify(res)}`);
}
},
executeScript: (action: ExecuteScriptAction, note: BNote) => {
executeScript: (action, note) => {
if (!action.script || !action.script.trim()) {
log.info("Ignoring executeScript since the script is empty.");
return;
@ -169,7 +160,7 @@ const ACTION_HANDLERS: ActionHandlerMap = {
note.save();
}
};
} as const;
function getActions(note: BNote) {
return note
@ -189,15 +180,23 @@ function getActions(note: BNote) {
return null;
}
return action;
return action as BulkAction;
})
.filter((a) => !!a);
}
function executeActions(note: BNote, searchResultNoteIds: string[] | Set<string>) {
/**
* Executes the bulk actions defined in the note against the provided search result note IDs.
* @param note the note containing the bulk actions, read from the `action` label.
* @param noteIds the IDs of the notes to apply the actions to.
*/
function executeActionsFromNote(note: BNote, noteIds: string[] | Set<string>) {
const actions = getActions(note);
return executeActions(actions, noteIds);
}
for (const resultNoteId of searchResultNoteIds) {
function executeActions(actions: BulkAction[], noteIds: string[] | Set<string>) {
for (const resultNoteId of noteIds) {
const resultNote = becca.getNote(resultNoteId);
if (!resultNote) {
@ -217,5 +216,6 @@ function executeActions(note: BNote, searchResultNoteIds: string[] | Set<string>
}
export default {
executeActions
executeActions,
executeActionsFromNote
};