refactor(backend): Functions

backend/src/services/learning-objects/attachment-service.ts

@@ -3,7 +3,7 @@ import { Attachment } from '../../entities/content/attachment.entity.js';
 import { LearningObjectIdentifier } from '../../interfaces/learning-content.js';
 
 const attachmentService = {
-    getAttachment(learningObjectId: LearningObjectIdentifier, attachmentName: string): Promise<Attachment | null> {
+    async getAttachment(learningObjectId: LearningObjectIdentifier, attachmentName: string): Promise<Attachment | null> {
         const attachmentRepo = getAttachmentRepository();
 
         if (learningObjectId.version) {

backend/src/services/learning-objects/database-learning-object-provider.ts

@@ -41,7 +41,7 @@ function convertLearningObject(learningObject: LearningObject | null): FilteredL
     };
 }
 
-function findLearningObjectEntityById(id: LearningObjectIdentifier): Promise<LearningObject | null> {
+async function findLearningObjectEntityById(id: LearningObjectIdentifier): Promise<LearningObject | null> {
     const learningObjectRepo = getLearningObjectRepository();
 
     return learningObjectRepo.findLatestByHruidAndLanguage(id.hruid, id.language as Language);
@@ -69,7 +69,7 @@ const databaseLearningObjectProvider: LearningObjectProvider = {
         if (!learningObject) {
             return null;
         }
-        return await processingService.render(learningObject, (id) => findLearningObjectEntityById(id));
+        return await processingService.render(learningObject, async (id) => findLearningObjectEntityById(id));
     },
 
     /**
@@ -96,7 +96,7 @@ const databaseLearningObjectProvider: LearningObjectProvider = {
             throw new NotFoundError('The learning path with the given ID could not be found.');
         }
         const learningObjects = await Promise.all(
-            learningPath.nodes.map((it) => {
+            learningPath.nodes.map(async (it) => {
                 const learningObject = learningObjectService.getLearningObjectById({
                     hruid: it.learningObjectHruid,
                     language: it.language,

backend/src/services/learning-objects/learning-object-service.ts

@@ -18,28 +18,28 @@ const learningObjectService = {
     /**
      * Fetches a single learning object by its HRUID
      */
-    getLearningObjectById(id: LearningObjectIdentifier): Promise<FilteredLearningObject | null> {
+    async getLearningObjectById(id: LearningObjectIdentifier): Promise<FilteredLearningObject | null> {
         return getProvider(id).getLearningObjectById(id);
     },
 
     /**
      * Fetch full learning object data (metadata)
      */
-    getLearningObjectsFromPath(id: LearningPathIdentifier): Promise<FilteredLearningObject[]> {
+    async getLearningObjectsFromPath(id: LearningPathIdentifier): Promise<FilteredLearningObject[]> {
         return getProvider(id).getLearningObjectsFromPath(id);
     },
 
     /**
      * Fetch only learning object HRUIDs
      */
-    getLearningObjectIdsFromPath(id: LearningPathIdentifier): Promise<string[]> {
+    async getLearningObjectIdsFromPath(id: LearningPathIdentifier): Promise<string[]> {
         return getProvider(id).getLearningObjectIdsFromPath(id);
     },
 
     /**
      * Obtain a HTML-rendering of the learning object with the given identifier (as a string).
      */
-    getLearningObjectHTML(id: LearningObjectIdentifier): Promise<string | null> {
+    async getLearningObjectHTML(id: LearningObjectIdentifier): Promise<string | null> {
         return getProvider(id).getLearningObjectHTML(id);
     },
 };

backend/src/services/learning-objects/processing/extern/extern-processor.ts

@@ -15,7 +15,7 @@ class ExternProcessor extends StringProcessor {
         super(DwengoContentType.EXTERN);
     }
 
-    override renderFn(externURL: string) {
+    override renderFn(externURL: string): string {
         if (!isValidHttpUrl(externURL)) {
             throw new ProcessingError('The url is not valid: ' + externURL);
         }

backend/src/services/learning-objects/processing/gift/gift-processor.ts

@@ -32,7 +32,7 @@ class GiftProcessor extends StringProcessor {
         super(DwengoContentType.GIFT);
     }
 
-    override renderFn(giftString: string) {
+    override renderFn(giftString: string): string {
         const quizQuestions: GIFTQuestion[] = parse(giftString);
 
         let html = "<div class='learning-object-gift'>\n";

backend/src/services/learning-objects/processing/image/block-image-processor.ts

@@ -10,7 +10,7 @@ class BlockImageProcessor extends InlineImageProcessor {
         super();
     }
 
-    override renderFn(imageUrl: string) {
+    override renderFn(imageUrl: string): string {
         const inlineHtml = super.render(imageUrl);
         return DOMPurify.sanitize(`<div>${inlineHtml}</div>`);
     }

backend/src/services/learning-objects/processing/image/inline-image-processor.ts

@@ -13,7 +13,7 @@ class InlineImageProcessor extends StringProcessor {
         super(contentType);
     }
 
-    override renderFn(imageUrl: string) {
+    override renderFn(imageUrl: string): string {
         if (!isValidHttpUrl(imageUrl)) {
             throw new ProcessingError(`Image URL is invalid: ${imageUrl}`);
         }

backend/src/services/learning-objects/processing/markdown/markdown-processor.ts

@@ -14,7 +14,7 @@ class MarkdownProcessor extends StringProcessor {
         super(DwengoContentType.TEXT_MARKDOWN);
     }
 
-    override renderFn(mdText: string) {
+    override renderFn(mdText: string): string {
         try {
             marked.use({ renderer: dwengoMarkedRenderer });
             const html = marked(mdText, { async: false });
@@ -24,7 +24,7 @@ class MarkdownProcessor extends StringProcessor {
         }
     }
 
-    replaceLinks(html: string) {
+    replaceLinks(html: string): string {
         const proc = new InlineImageProcessor();
         html = html.replace(
             /<img.*?src="(.*?)".*?(alt="(.*?)")?.*?(title="(.*?)")?.*?>/g,

backend/src/services/learning-objects/processing/pdf/pdf-processor.ts

@@ -15,7 +15,7 @@ class PdfProcessor extends StringProcessor {
         super(DwengoContentType.APPLICATION_PDF);
     }
 
-    override renderFn(pdfUrl: string) {
+    override renderFn(pdfUrl: string): string {
         if (!isValidHttpUrl(pdfUrl)) {
             throw new ProcessingError(`PDF URL is invalid: ${pdfUrl}`);
         }

backend/src/services/learning-objects/processing/processor.ts

@@ -9,7 +9,9 @@ import { DwengoContentType } from './content-type.js';
  * Based on https://github.com/dwengovzw/Learning-Object-Repository/blob/main/app/processors/processor.js
  */
 abstract class Processor<T> {
-    protected constructor(public contentType: DwengoContentType) {}
+    protected constructor(public contentType: DwengoContentType) {
+        // Do nothing
+    }
 
     /**
      * Render the given object.

backend/src/services/learning-objects/processing/text/text-processor.ts

@@ -11,7 +11,7 @@ class TextProcessor extends StringProcessor {
         super(DwengoContentType.TEXT_PLAIN);
     }
 
-    override renderFn(text: string) {
+    override renderFn(text: string): string {
         // Sanitize plain text to prevent xss.
         return DOMPurify.sanitize(text);
     }