tech(api): add api in learning content to expose skills by ids

Author: laura-bergoens

Diff for: api/src/learning-content/application/api/models/SkillDTO.js

@@ -0,0 +1,7 @@
+export class SkillDTO {
+  constructor({ id, difficulty, tubeId }) {
+    this.id = id;
+    this.difficulty = difficulty;
+    this.tubeId = tubeId;
+  }
+}

Diff for: api/src/learning-content/application/api/skills-api.js

@@ -0,0 +1,29 @@
+import * as skillRepository from '../../../shared/infrastructure/repositories/skill-repository.js';
+import { SkillDTO } from './models/SkillDTO.js';
+
+/**
+ * @typedef SkillDTO
+ * @type {object}
+ * @property {string} id
+ * @property {number} difficulty
+ * @property {string} tubeId
+ */
+
+/**
+ * @function
+ * @name findByIds
+ *
+ * @param {Object} params
+ * @param {Array<string>} params.ids
+ * @returns {Promise<Array<SkillDTO>>}
+ */
+export async function findByIds({ ids = [] }) {
+  if (!ids?.length) {
+    return [];
+  }
+  const skills = await skillRepository.findByRecordIds(ids);
+
+  return skills.map(_toApi);
+}
+
+const _toApi = (skill) => new SkillDTO(skill);

Diff for: api/tests/integration/application/learning-content/api/skills-api_test.js

@@ -0,0 +1,51 @@
+import { SkillDTO } from '../../../../../src/learning-content/application/api/models/SkillDTO.js';
+import * as skillsApi from '../../../../../src/learning-content/application/api/skills-api.js';
+import { databaseBuilder, expect } from '../../../../test-helper.js';
+
+describe('Integration | LearningContent | Application | Api | skills', function () {
+  describe('#findByIds', function () {
+    it('should return an empty array when wrong ids collection provided', async function () {
+      // given
+      const emptySkillIds = [];
+      const brokenSkillIds = null;
+
+      // when
+      const resultForEmpty = await skillsApi.findByIds({ ids: emptySkillIds });
+      const resultForBroken = await skillsApi.findByIds({ ids: brokenSkillIds });
+
+      // then
+      expect(resultForEmpty).to.deepEqualArray([]);
+      expect(resultForBroken).to.deepEqualArray([]);
+    });
+
+    it('should return the skillDTOs collection corresponding to provided skill ids', async function () {
+      // given
+      databaseBuilder.factory.learningContent.buildSkill({
+        id: 'skillA',
+        level: 4,
+        tubeId: 'tubeA',
+      });
+      databaseBuilder.factory.learningContent.buildSkill({
+        id: 'skillC',
+        level: 1,
+        tubeId: 'tubeC',
+      });
+      databaseBuilder.factory.learningContent.buildSkill({
+        id: 'skillB',
+        level: 3,
+        tubeId: 'tubeB',
+      });
+      await databaseBuilder.commit();
+      const skillIds = ['skillA', 'skillB'];
+
+      // when
+      const result = await skillsApi.findByIds({ ids: skillIds });
+
+      // then
+      expect(result).to.deepEqualArray([
+        new SkillDTO({ id: 'skillA', difficulty: 4, tubeId: 'tubeA' }),
+        new SkillDTO({ id: 'skillB', difficulty: 3, tubeId: 'tubeB' }),
+      ]);
+    });
+  });
+});