Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import type { ResourceDownloadProgress, ResourcesStatusResponse } from "@triliumnext/commons";
import { ValidationError } from "@triliumnext/core";
import type { Request } from "express";
import resources from "../../services/resources.js";
/**
* `GET /api/resources?ids=a,b`: whether each resource is installed, and the download that runs.
* Without `ids`, reports every registered resource.
*/
function getStatus(req: Request): Promise<ResourcesStatusResponse> {
return resources.getStatus(req.query.ids === undefined ? undefined : parseIds(req.query.ids));
}
/** `POST /api/resources/download` with `{ ids }`: starts downloading the resources not installed. */
function startDownload(req: Request): ResourceDownloadProgress {
return resources.startDownload(parseIds(req.body?.ids));
}
/** `POST /api/resources/download/:downloadId/cancel`. */
function cancelDownload(req: Request<{ downloadId: string }>) {
resources.cancelDownload(req.params.downloadId);
}
/** `DELETE /api/resources/:id`: deletes the files of the resource. */
async function deleteResource(req: Request<{ id: string }>) {
await resources.delete(req.params.id);
}
/** `DELETE /api/resources/foreign/:name`: deletes an entry of the resources directory that is no resource. */
async function deleteForeign(req: Request<{ name: string }>) {
await resources.deleteForeign(req.params.name);
}
function parseIds(ids: unknown) {
const list = typeof ids === "string" ? ids.split(",") : ids;
if (!Array.isArray(list) || !list.length || !list.every((id) => typeof id === "string")) {
throw new ValidationError("Expected a list of resource IDs.");
}
return list as string[];
}
export default {
getStatus,
startDownload,
cancelDownload,
deleteResource,
deleteForeign
};