fix: fix packed h5p schema to include integrationUrl (#2077)

* fix: fix packed h5p schema to include integrationUrl

* refactor: add extended item

---------

Co-authored-by: kim <kim.phanhoang@epfl.ch>

Author: pyphilia

src/services/item/item.controller.read.test.ts

@@ -11,6 +11,7 @@ import { db } from '../../drizzle/db';
 import { assertIsDefined } from '../../utils/assertions';
 import { ItemNotFound, MemberCannotAccess } from '../../utils/errors';
 import { assertIsMemberForTest } from '../authentication';
+import { H5PItem } from './item';
 import { type PackedItem, PackedItemDTO } from './packedItem.dto';
 import { expectManyPackedItems, expectPackedItem, expectThumbnails } from './test/fixtures/items';
 import { Ordering, SortBy } from './types';
@@ -336,7 +337,6 @@ describe('Item routes tests', () => {
               ],
             },
             // schema check
-
             {
               name: 'app with settings',
               type: 'app',
@@ -947,6 +947,46 @@ describe('Item routes tests', () => {
         data.forEach((i) => expectThumbnails(i, MOCK_SIGNED_URL, false));
       });
 
+      it('Returns a child h5p successfully', async () => {
+        const {
+          actor,
+          items: [parentItem],
+        } = await seedFromJson({
+          items: [
+            {
+              memberships: [{ account: 'actor', permission: 'admin' }],
+              children: [
+                {
+                  type: 'h5p',
+                  extra: {
+                    h5p: {
+                      contentId: 'content-id',
+                      h5pFilePath: 'file-path',
+                      contentFilePath: 'content-file-path',
+                    },
+                  },
+                },
+              ],
+            },
+          ],
+        });
+        assertIsDefined(actor);
+        assertIsMemberForTest(actor);
+        mockAuthenticate(actor);
+
+        const response = await app.inject({
+          method: HttpMethod.Get,
+          url: `/api/items/${parentItem.id}/children`,
+        });
+
+        const data = response.json<PackedItem[]>();
+        expect(response.statusCode).toBe(StatusCodes.OK);
+
+        expect(data).toHaveLength(1);
+        // expect additionnal packed property
+        expect((data[0] as H5PItem).extra.h5p.contentFilePath).toBeDefined();
+      });
+
       it('Returns successfully with thumbnails', async () => {
         const {
           actor,

src/services/item/item.schemas.packed.ts

@@ -14,7 +14,7 @@ import { embeddedLinkItemSchemaRef } from './plugins/embeddedLink/link.schemas';
 import { etherpadItemSchemaRef } from './plugins/etherpad/etherpad.schemas';
 import { fileItemSchemaRef } from './plugins/file/itemFile.schema';
 import { folderItemSchemaRef } from './plugins/folder/folder.schemas';
-import { h5pItemSchemaRef } from './plugins/html/h5p/h5p.schemas';
+import { h5pExtendedItemSchema, h5pItemSchemaRef } from './plugins/html/h5p/h5p.schemas';
 import { itemVisibilitySchemaRef } from './plugins/itemVisibility/itemVisibility.schemas';
 import { pageItemSchemaRef } from './plugins/page/page.schemas';
 import { shortcutItemSchemaRef } from './plugins/shortcut/shortcut.schemas';
@@ -69,7 +69,32 @@ export const packedItemSchemaRef = registerSchemaAsRef(
     ],
     {
       discriminator: 'type',
-      description: 'Item with additional information',
+      description: 'Item with additional information for simple display',
+    },
+  ),
+);
+
+export const extendedItemSchemaRef = registerSchemaAsRef(
+  'extendedItem',
+  'Extended Item',
+  Type.Intersect(
+    [
+      Type.Union([
+        appItemSchemaRef,
+        documentItemSchemaRef,
+        embeddedLinkItemSchemaRef,
+        etherpadItemSchemaRef,
+        fileItemSchemaRef,
+        folderItemSchemaRef,
+        h5pExtendedItemSchema,
+        pageItemSchemaRef,
+        shortcutItemSchemaRef,
+      ]),
+      packedSchema,
+    ],
+    {
+      discriminator: 'type',
+      description: 'Item with extended information useful for complete display',
     },
   ),
 );
@@ -83,7 +108,7 @@ export const getOne = {
   params: customType.StrictObject({
     id: customType.UUID(),
   }),
-  response: { [StatusCodes.OK]: packedItemSchemaRef, '4xx': errorSchemaRef },
+  response: { [StatusCodes.OK]: extendedItemSchemaRef, '4xx': errorSchemaRef },
 } as const satisfies FastifySchema;
 
 export const getAccessible = {
@@ -139,7 +164,7 @@ export const getChildren = {
     }),
   ),
   response: {
-    [StatusCodes.OK]: Type.Array(packedItemSchemaRef),
+    [StatusCodes.OK]: Type.Array(extendedItemSchemaRef),
     '4xx': errorSchemaRef,
   },
 } as const satisfies FastifySchema;

src/services/item/plugins/html/h5p/h5p.schemas.ts

@@ -29,6 +29,27 @@ const h5pItemSchema = Type.Composite([
   ),
 ]);
 
+export const h5pExtendedItemSchema = Type.Composite([
+  itemCommonSchema,
+  customType.StrictObject(
+    {
+      type: Type.Literal('h5p'),
+      extra: customType.StrictObject({
+        h5p: customType.StrictObject({
+          contentId: Type.String(),
+          h5pFilePath: Type.String(),
+          contentFilePath: Type.String(),
+          integrationUrl: Type.String({ description: 'url of the h5p integration' }),
+        }),
+      }),
+    },
+    {
+      title: 'H5P Extended Item',
+      description: 'Extended item of type H5P.',
+    },
+  ),
+]);
+
 export const h5pItemSchemaRef = registerSchemaAsRef('h5pItem', 'H5P Item', h5pItemSchema);
 
 export const h5pImport = {