refactor(common): Learning content

backend/src/controllers/learning-objects.ts

@@ -1,12 +1,12 @@
 import { Request, Response } from 'express';
 import { FALLBACK_LANG } from '../config.js';
-import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from '../interfaces/learning-content.js';
 import learningObjectService from '../services/learning-objects/learning-object-service.js';
 import { EnvVars, getEnvVar } from '../util/envvars.js';
 import { Language } from '../entities/content/language.js';
 import attachmentService from '../services/learning-objects/attachment-service.js';
 import { NotFoundError } from '@mikro-orm/core';
 import { BadRequestException } from '../exceptions/bad-request-exception.js';
+import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 function getLearningObjectIdentifierFromRequest(req: Request): LearningObjectIdentifier {
     if (!req.params.hruid) {

backend/src/interfaces/learning-content.ts

@@ -1,112 +0,0 @@
-import { Language } from '../entities/content/language';
-
-export interface Transition {
-    default: boolean;
-    _id: string;
-    next: {
-        _id: string;
-        hruid: string;
-        version: number;
-        language: string;
-    };
-}
-
-export interface LearningObjectIdentifier {
-    hruid: string;
-    language: Language;
-    version?: number;
-}
-
-export interface LearningObjectNode {
-    _id: string;
-    learningobject_hruid: string;
-    version: number;
-    language: Language;
-    start_node?: boolean;
-    transitions: Transition[];
-    created_at: string;
-    updatedAt: string;
-    done?: boolean; // True if a submission exists for this node by the user for whom the learning path is customized.
-}
-
-export interface LearningPath {
-    _id: string;
-    language: string;
-    hruid: string;
-    title: string;
-    description: string;
-    image?: string; // Image might be missing, so it's optional
-    num_nodes: number;
-    num_nodes_left: number;
-    nodes: LearningObjectNode[];
-    keywords: string;
-    target_ages: number[];
-    min_age: number;
-    max_age: number;
-    __order: number;
-}
-
-export interface LearningPathIdentifier {
-    hruid: string;
-    language: Language;
-}
-
-export interface EducationalGoal {
-    source: string;
-    id: string;
-}
-
-export interface ReturnValue {
-    callback_url: string;
-    callback_schema: Record<string, any>;
-}
-
-export interface LearningObjectMetadata {
-    _id: string;
-    uuid: string;
-    hruid: string;
-    version: number;
-    language: Language;
-    title: string;
-    description: string;
-    difficulty: number;
-    estimated_time: number;
-    available: boolean;
-    teacher_exclusive: boolean;
-    educational_goals: EducationalGoal[];
-    keywords: string[];
-    target_ages: number[];
-    content_type: string; // Markdown, image, etc.
-    content_location?: string;
-    skos_concepts?: string[];
-    return_value?: ReturnValue;
-}
-
-export interface FilteredLearningObject {
-    key: string;
-    _id: string;
-    uuid: string;
-    version: number;
-    title: string;
-    htmlUrl: string;
-    language: Language;
-    difficulty: number;
-    estimatedTime?: number;
-    available: boolean;
-    teacherExclusive: boolean;
-    educationalGoals: EducationalGoal[];
-    keywords: string[];
-    description: string;
-    targetAges: number[];
-    contentType: string;
-    contentLocation?: string;
-    skosConcepts?: string[];
-    returnValue?: ReturnValue;
-}
-
-export interface LearningPathResponse {
-    success: boolean;
-    source: string;
-    data: LearningPath[] | null;
-    message?: string;
-}

backend/src/services/learning-objects.ts

@@ -1,6 +1,12 @@
 import { DWENGO_API_BASE } from '../config.js';
 import { fetchWithLogging } from '../util/api-helper.js';
-import { FilteredLearningObject, LearningObjectMetadata, LearningObjectNode, LearningPathResponse } from '../interfaces/learning-content.js';
+
+import {
+    FilteredLearningObject,
+    LearningObjectMetadata,
+    LearningObjectNode,
+    LearningPathResponse,
+} from 'dwengo-1-common/src/interfaces/learning-content';
 
 function filterData(data: LearningObjectMetadata, htmlUrl: string): FilteredLearningObject {
     return {

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

@@ -1,6 +1,7 @@
 import { getAttachmentRepository } from '../../data/repositories.js';
 import { Attachment } from '../../entities/content/attachment.entity.js';
-import { LearningObjectIdentifier } from '../../interfaces/learning-content.js';
+
+import { LearningObjectIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const attachmentService = {
     getAttachment(learningObjectId: LearningObjectIdentifier, attachmentName: string): Promise<Attachment | null> {

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

@@ -1,5 +1,4 @@
 import { LearningObjectProvider } from './learning-object-provider.js';
-import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from '../../interfaces/learning-content.js';
 import { getLearningObjectRepository, getLearningPathRepository } from '../../data/repositories.js';
 import { Language } from '../../entities/content/language.js';
 import { LearningObject } from '../../entities/content/learning-object.entity.js';
@@ -8,6 +7,7 @@ import processingService from './processing/processing-service.js';
 import { NotFoundError } from '@mikro-orm/core';
 import learningObjectService from './learning-object-service.js';
 import { getLogger, Logger } from '../../logging/initalize.js';
+import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const logger: Logger = getLogger();
 

backend/src/services/learning-objects/dwengo-api-learning-object-provider.ts

@@ -1,5 +1,8 @@
 import { DWENGO_API_BASE } from '../../config.js';
 import { fetchWithLogging } from '../../util/api-helper.js';
+import dwengoApiLearningPathProvider from '../learning-paths/dwengo-api-learning-path-provider.js';
+import { LearningObjectProvider } from './learning-object-provider.js';
+import { getLogger, Logger } from '../../logging/initalize.js';
 import {
     FilteredLearningObject,
     LearningObjectIdentifier,
@@ -7,10 +10,7 @@ import {
     LearningObjectNode,
     LearningPathIdentifier,
     LearningPathResponse,
-} from '../../interfaces/learning-content.js';
-import dwengoApiLearningPathProvider from '../learning-paths/dwengo-api-learning-path-provider.js';
-import { LearningObjectProvider } from './learning-object-provider.js';
-import { getLogger, Logger } from '../../logging/initalize.js';
+} from 'dwengo-1-common/src/interfaces/learning-content';
 
 const logger: Logger = getLogger();
 

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

@@ -1,4 +1,4 @@
-import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from '../../interfaces/learning-content.js';
+import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 export interface LearningObjectProvider {
     /**

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

@@ -1,8 +1,8 @@
-import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from '../../interfaces/learning-content.js';
 import dwengoApiLearningObjectProvider from './dwengo-api-learning-object-provider.js';
 import { LearningObjectProvider } from './learning-object-provider.js';
 import { EnvVars, getEnvVar } from '../../util/envvars.js';
 import databaseLearningObjectProvider from './database-learning-object-provider.js';
+import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 function getProvider(id: LearningObjectIdentifier): LearningObjectProvider {
     if (id.hruid.startsWith(getEnvVar(EnvVars.UserContentPrefix))) {

backend/src/services/learning-objects/processing/markdown/dwengo-marked-renderer.ts

@@ -8,13 +8,13 @@ import InlineImageProcessor from '../image/inline-image-processor.js';
 import * as marked from 'marked';
 import { getUrlStringForLearningObjectHTML, isValidHttpUrl } from '../../../../util/links.js';
 import { ProcessingError } from '../processing-error.js';
-import { LearningObjectIdentifier } from '../../../../interfaces/learning-content.js';
 import { Language } from '../../../../entities/content/language.js';
 
 import Image = marked.Tokens.Image;
 import Heading = marked.Tokens.Heading;
 import Link = marked.Tokens.Link;
 import RendererObject = marked.RendererObject;
+import { LearningObjectIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const prefixes = {
     learningObject: '@learning-object',

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

@@ -13,9 +13,9 @@ import GiftProcessor from './gift/gift-processor.js';
 import { LearningObject } from '../../../entities/content/learning-object.entity.js';
 import Processor from './processor.js';
 import { DwengoContentType } from './content-type.js';
-import { LearningObjectIdentifier } from '../../../interfaces/learning-content.js';
 import { Language } from '../../../entities/content/language.js';
 import { replaceAsync } from '../../../util/async.js';
+import { LearningObjectIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const EMBEDDED_LEARNING_OBJECT_PLACEHOLDER = /<learning-object hruid="([^"]+)" language="([^"]+)" version="([^"]+)"\/>/g;
 const LEARNING_OBJECT_DOES_NOT_EXIST = "<div class='non-existing-learning-object' />";

backend/src/services/learning-paths/database-learning-path-provider.ts

@@ -1,5 +1,4 @@
 import { LearningPathProvider } from './learning-path-provider.js';
-import { FilteredLearningObject, LearningObjectNode, LearningPath, LearningPathResponse, Transition } from '../../interfaces/learning-content.js';
 import { LearningPath as LearningPathEntity } from '../../entities/content/learning-path.entity.js';
 import { getLearningPathRepository } from '../../data/repositories.js';
 import { Language } from '../../entities/content/language.js';
@@ -7,6 +6,13 @@ import learningObjectService from '../learning-objects/learning-object-service.j
 import { LearningPathNode } from '../../entities/content/learning-path-node.entity.js';
 import { LearningPathTransition } from '../../entities/content/learning-path-transition.entity.js';
 import { getLastSubmissionForCustomizationTarget, isTransitionPossible, PersonalizationTarget } from './learning-path-personalization-util.js';
+import {
+    FilteredLearningObject,
+    LearningObjectNode,
+    LearningPath,
+    LearningPathResponse,
+    Transition,
+} from 'dwengo-1-common/src/interfaces/learning-content';
 
 /**
  * Fetches the corresponding learning object for each of the nodes and creates a map that maps each node to its

backend/src/services/learning-paths/dwengo-api-learning-path-provider.ts

@@ -1,8 +1,8 @@
 import { fetchWithLogging } from '../../util/api-helper.js';
 import { DWENGO_API_BASE } from '../../config.js';
-import { LearningPath, LearningPathResponse } from '../../interfaces/learning-content.js';
 import { LearningPathProvider } from './learning-path-provider.js';
 import { getLogger, Logger } from '../../logging/initalize.js';
+import { LearningPath, LearningPathResponse } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const logger: Logger = getLogger();
 

backend/src/services/learning-paths/learning-path-provider.ts

@@ -1,6 +1,6 @@
-import { LearningPath, LearningPathResponse } from '../../interfaces/learning-content.js';
 import { Language } from '../../entities/content/language.js';
 import { PersonalizationTarget } from './learning-path-personalization-util.js';
+import { LearningPath, LearningPathResponse } from 'dwengo-1-common/src/interfaces/learning-content';
 
 /**
  * Generic interface for a service which provides access to learning paths from a data source.

backend/src/services/learning-paths/learning-path-service.ts

@@ -1,9 +1,9 @@
-import { LearningPath, LearningPathResponse } from '../../interfaces/learning-content.js';
 import dwengoApiLearningPathProvider from './dwengo-api-learning-path-provider.js';
 import databaseLearningPathProvider from './database-learning-path-provider.js';
 import { EnvVars, getEnvVar } from '../../util/envvars.js';
 import { Language } from '../../entities/content/language.js';
 import { PersonalizationTarget } from './learning-path-personalization-util.js';
+import { LearningPath, LearningPathResponse } from 'dwengo-1-common/src/interfaces/learning-content';
 
 const userContentPrefix = getEnvVar(EnvVars.UserContentPrefix);
 const allProviders = [dwengoApiLearningPathProvider, databaseLearningPathProvider];

backend/src/util/links.ts

@@ -1,4 +1,4 @@
-import { LearningObjectIdentifier } from '../interfaces/learning-content';
+import { LearningObjectIdentifier } from 'dwengo-1-common/src/interfaces/learning-content';
 
 export function isValidHttpUrl(url: string): boolean {
     try {

backend/tests/services/learning-objects/database-learning-object-provider.test.ts

@@ -5,11 +5,11 @@ import example from '../../test-assets/learning-objects/pn-werkingnotebooks/pn-w
 import { LearningObject } from '../../../src/entities/content/learning-object.entity';
 import databaseLearningObjectProvider from '../../../src/services/learning-objects/database-learning-object-provider';
 import { expectToBeCorrectFilteredLearningObject } from '../../test-utils/expectations';
-import { FilteredLearningObject } from '../../../src/interfaces/learning-content';
 import { Language } from '../../../src/entities/content/language';
 import learningObjectExample from '../../test-assets/learning-objects/pn-werkingnotebooks/pn-werkingnotebooks-example';
 import learningPathExample from '../../test-assets/learning-paths/pn-werking-example';
 import { LearningPath } from '../../../src/entities/content/learning-path.entity';
+import {FilteredLearningObject} from "dwengo-1-common/src/interfaces/learning-content";
 
 async function initExampleData(): Promise<{ learningObject: LearningObject; learningPath: LearningPath }> {
     const learningObjectRepo = getLearningObjectRepository();

backend/tests/services/learning-objects/learning-object-service.test.ts

@@ -4,11 +4,11 @@ import { LearningObject } from '../../../src/entities/content/learning-object.en
 import { getLearningObjectRepository, getLearningPathRepository } from '../../../src/data/repositories';
 import learningObjectExample from '../../test-assets/learning-objects/pn-werkingnotebooks/pn-werkingnotebooks-example';
 import learningObjectService from '../../../src/services/learning-objects/learning-object-service';
-import { LearningObjectIdentifier, LearningPathIdentifier } from '../../../src/interfaces/learning-content';
 import { Language } from '../../../src/entities/content/language';
 import { EnvVars, getEnvVar } from '../../../src/util/envvars';
 import { LearningPath } from '../../../src/entities/content/learning-path.entity';
 import learningPathExample from '../../test-assets/learning-paths/pn-werking-example';
+import {LearningObjectIdentifier, LearningPathIdentifier} from "dwengo-1-common/src/interfaces/learning-content";
 
 const EXPECTED_DWENGO_LEARNING_OBJECT_TITLE = 'Werken met notebooks';
 const DWENGO_TEST_LEARNING_OBJECT_ID: LearningObjectIdentifier = {

backend/tests/services/learning-path/database-learning-path-provider.test.ts

@@ -19,7 +19,8 @@ import {
     createConditionTestLearningPathAndLearningObjects,
 } from '../../test-assets/learning-paths/test-conditions-example.js';
 import { Student } from '../../../src/entities/users/student.entity.js';
-import { LearningObjectNode, LearningPathResponse } from '../../../src/interfaces/learning-content.js';
+
+import {LearningObjectNode, LearningPathResponse} from "dwengo-1-common/src/interfaces/learning-content";
 
 async function initExampleData(): Promise<{ learningObject: LearningObject; learningPath: LearningPath }> {
     const learningObjectRepo = getLearningObjectRepository();

backend/tests/test-utils/expectations.ts

@@ -1,8 +1,8 @@
 import { AssertionError } from 'node:assert';
 import { LearningObject } from '../../src/entities/content/learning-object.entity';
-import { FilteredLearningObject, LearningPath } from '../../src/interfaces/learning-content';
 import { LearningPath as LearningPathEntity } from '../../src/entities/content/learning-path.entity';
 import { expect } from 'vitest';
+import {FilteredLearningObject, LearningPath} from "dwengo-1-common/src/interfaces/learning-content";
 
 // Ignored properties because they belang for example to the class, not to the entity itself.
 const IGNORE_PROPERTIES = ['parent'];