refactor(server): add some type safety to bulk actions

This commit is contained in:
Elian Doran 2025-07-19 12:15:33 +03:00
parent 56553078ef
commit daa4743967
No known key found for this signature in database

View File

@ -6,53 +6,97 @@ import { randomString } from "./utils.js";
import eraseService from "./erase.js"; import eraseService from "./erase.js";
import type BNote from "../becca/entities/bnote.js"; import type BNote from "../becca/entities/bnote.js";
interface Action { interface AddLabelAction {
labelName: string; labelName: string;
labelValue: string; labelValue?: string;
}
interface AddRelationAction {
relationName: string;
targetNoteId: string;
}
interface DeleteRevisionsAction {}
interface DeleteLabelAction {
labelName: string;
}
interface DeleteRelationAction {
relationName: string;
}
interface RenameNoteAction {
newTitle: string;
}
interface RenameLabelAction {
oldLabelName: string; oldLabelName: string;
newLabelName: string; newLabelName: string;
}
relationName: string; interface RenameRelationAction {
oldRelationName: string; oldRelationName: string;
newRelationName: string; newRelationName: string;
}
interface UpdateLabelValueAction {
labelName: string;
labelValue: string;
}
interface UpdateRelationTargetAction {
relationName: string;
targetNoteId: string; targetNoteId: string;
}
interface MoveNoteAction {
targetParentNoteId: string; targetParentNoteId: string;
newTitle: string; }
interface ExecuteScriptAction {
script: string; script: string;
} }
type ActionHandler = (action: Action, note: BNote) => void;
const ACTION_HANDLERS: Record<string, ActionHandler> = { interface DeleteNoteAction { }
addLabel: (action, note) => {
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>;
}
const ACTION_HANDLERS: ActionHandlerMap = {
addLabel: (action: AddLabelAction, note: BNote) => {
note.addLabel(action.labelName, action.labelValue); note.addLabel(action.labelName, action.labelValue);
}, },
addRelation: (action, note) => { addRelation: (action: AddRelationAction, note: BNote) => {
note.addRelation(action.relationName, action.targetNoteId); note.addRelation(action.relationName, action.targetNoteId);
}, },
deleteNote: (action, note) => { deleteNote: (action: DeleteNoteAction, note: BNote) => {
const deleteId = `searchbulkaction-${randomString(10)}`; const deleteId = `searchbulkaction-${randomString(10)}`;
note.deleteNote(deleteId); note.deleteNote(deleteId);
}, },
deleteRevisions: (action, note) => { deleteRevisions: (action: DeleteRevisionsAction, note: BNote) => {
const revisionIds = note const revisionIds = note
.getRevisions() .getRevisions()
.map((rev) => rev.revisionId) .map((rev) => rev.revisionId)
.filter((rev) => !!rev) as string[]; .filter((rev) => !!rev) as string[];
eraseService.eraseRevisions(revisionIds); eraseService.eraseRevisions(revisionIds);
}, },
deleteLabel: (action, note) => { deleteLabel: (action: DeleteLabelAction, note: BNote) => {
for (const label of note.getOwnedLabels(action.labelName)) { for (const label of note.getOwnedLabels(action.labelName)) {
label.markAsDeleted(); label.markAsDeleted();
} }
}, },
deleteRelation: (action, note) => { deleteRelation: (action: DeleteRelationAction, note: BNote) => {
for (const relation of note.getOwnedRelations(action.relationName)) { for (const relation of note.getOwnedRelations(action.relationName)) {
relation.markAsDeleted(); relation.markAsDeleted();
} }
}, },
renameNote: (action, note) => { renameNote: (action: RenameNoteAction, note: BNote) => {
// "officially" injected value: // "officially" injected value:
// - note // - note
@ -63,7 +107,7 @@ const ACTION_HANDLERS: Record<string, ActionHandler> = {
note.save(); note.save();
} }
}, },
renameLabel: (action, note) => { renameLabel: (action: RenameLabelAction, note: BNote) => {
for (const label of note.getOwnedLabels(action.oldLabelName)) { for (const label of note.getOwnedLabels(action.oldLabelName)) {
// attribute name is immutable, renaming means delete old + create new // attribute name is immutable, renaming means delete old + create new
const newLabel = label.createClone("label", action.newLabelName, label.value); const newLabel = label.createClone("label", action.newLabelName, label.value);
@ -72,7 +116,7 @@ const ACTION_HANDLERS: Record<string, ActionHandler> = {
label.markAsDeleted(); label.markAsDeleted();
} }
}, },
renameRelation: (action, note) => { renameRelation: (action: RenameRelationAction, note: BNote) => {
for (const relation of note.getOwnedRelations(action.oldRelationName)) { for (const relation of note.getOwnedRelations(action.oldRelationName)) {
// attribute name is immutable, renaming means delete old + create new // attribute name is immutable, renaming means delete old + create new
const newRelation = relation.createClone("relation", action.newRelationName, relation.value); const newRelation = relation.createClone("relation", action.newRelationName, relation.value);
@ -81,19 +125,19 @@ const ACTION_HANDLERS: Record<string, ActionHandler> = {
relation.markAsDeleted(); relation.markAsDeleted();
} }
}, },
updateLabelValue: (action, note) => { updateLabelValue: (action: UpdateLabelValueAction, note: BNote) => {
for (const label of note.getOwnedLabels(action.labelName)) { for (const label of note.getOwnedLabels(action.labelName)) {
label.value = action.labelValue; label.value = action.labelValue;
label.save(); label.save();
} }
}, },
updateRelationTarget: (action, note) => { updateRelationTarget: (action: UpdateRelationTargetAction, note: BNote) => {
for (const relation of note.getOwnedRelations(action.relationName)) { for (const relation of note.getOwnedRelations(action.relationName)) {
relation.value = action.targetNoteId; relation.value = action.targetNoteId;
relation.save(); relation.save();
} }
}, },
moveNote: (action, note) => { moveNote: (action: MoveNoteAction, note: BNote) => {
const targetParentNote = becca.getNote(action.targetParentNoteId); const targetParentNote = becca.getNote(action.targetParentNoteId);
if (!targetParentNote) { if (!targetParentNote) {
@ -114,7 +158,7 @@ const ACTION_HANDLERS: Record<string, ActionHandler> = {
log.info(`Moving/cloning note ${note.noteId} to ${action.targetParentNoteId} failed with error ${JSON.stringify(res)}`); log.info(`Moving/cloning note ${note.noteId} to ${action.targetParentNoteId} failed with error ${JSON.stringify(res)}`);
} }
}, },
executeScript: (action, note) => { executeScript: (action: ExecuteScriptAction, note: BNote) => {
if (!action.script || !action.script.trim()) { if (!action.script || !action.script.trim()) {
log.info("Ignoring executeScript since the script is empty."); log.info("Ignoring executeScript since the script is empty.");
return; return;