Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-03 11:56:01 +01:00
Code Issues Packages Projects Releases Activity

refactor: add typesafety to TaskContext

Browse Source
This commit is contained in:
Elian Doran
2025-09-13 13:44:23 +03:00
parent 777d5ab3b7
commit 9c8b0611ea
21 changed files with 111 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
packages/commons/src/lib/ws_api.ts
View File

@@ -26,37 +26,64 @@ export interface EntityChangeRecord {
entity?: EntityRow;
}
type TaskStatus<TypeT, DataT, ResultT> = {
type TaskDataDefinitions = {
empty: null,
deleteNotes: null,
undeleteNotes: null,
export: null,
protectNotes: {
protect: boolean;
}
importNotes: {
textImportedAsText?: boolean;
codeImportedAsCode?: boolean;
replaceUnderscoresWithSpaces?: boolean;
shrinkImages?: boolean;
safeImport?: boolean;
} | null,
importAttachments: null
}
type TaskResultDefinitions = {
empty: null,
deleteNotes: null,
undeleteNotes: null,
export: null,
protectNotes: null,
importNotes: {
parentNoteId?: string;
importedNoteId?: string
};
importAttachments: {
parentNoteId?: string;
importedNoteId?: string
};
}
export type TaskType = keyof TaskDataDefinitions | keyof TaskResultDefinitions;
export type TaskData<T extends TaskType> = TaskDataDefinitions[T];
export type TaskResult<T extends TaskType> = TaskResultDefinitions[T];
type TaskDefinition<T extends TaskType> = {
type: "taskProgressCount",
taskId: string;
taskType: TypeT;
data: DataT,
taskType: T;
data: TaskData<T>,
progressCount: number
} | {
type: "taskError",
taskId: string;
taskType: TypeT;
data: DataT;
taskType: T;
data: TaskData<T>,
message: string;
} | {
type: "taskSucceeded",
taskId: string;
taskType: TypeT;
data: DataT;
result: ResultT;
taskType: T;
data: TaskData<T>,
result: TaskResult<T>;
}
type TaskDefinitions =
TaskStatus<"protectNotes", { protect: boolean; }, null>
| TaskStatus<"importNotes", null, { importedNoteId: string }>
| TaskStatus<"importAttachments", null, { parentNoteId?: string; importedNoteId: string }>
| TaskStatus<"deleteNotes", null, null>
| TaskStatus<"undeleteNotes", null, null>
| TaskStatus<"export", null, null>
;
export type TaskType = TaskDefinitions["taskType"];
export interface OpenedFileUpdateStatus {
entityType: string;
entityId: string;
@@ -64,7 +91,16 @@ export interface OpenedFileUpdateStatus {
filePath: string;
}
export type WebSocketMessage = TaskDefinitions | {
type AllTaskDefinitions =
| TaskDefinition<"empty">
| TaskDefinition<"deleteNotes">
| TaskDefinition<"undeleteNotes">
| TaskDefinition<"export">
| TaskDefinition<"protectNotes">
| TaskDefinition<"importNotes">
| TaskDefinition<"importAttachments">;
export type WebSocketMessage = AllTaskDefinitions | {
type: "ping"
} | {
type: "frontend-update",