feat: allow switching from folder to capsule (#2052)

* feat: allow changing isCapsule of folder extra

* feat: add create capsule and update to capsule endpoints

* feat: add specific endpoints to switch

* refactor: apply some fixes

* docs: add a capsule doc

* refactor: rename switching to converting

* refactor: apply PR requested changes

* refactor: fix tests

* refactor: fix tests

---------

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

Author: pyphilia

package.json

@@ -67,7 +67,7 @@
     "@fastify/type-provider-typebox": "5.1.0",
     "@fastify/websocket": "11.0.2",
     "@graasp/etherpad-api": "2.1.1",
-    "@graasp/sdk": "5.17.0",
+    "@graasp/sdk": "5.18.0",
     "@rapideditor/country-coder": "5.4.0",
     "@sentry/node": "7.119.2",
     "@sentry/tracing": "7.120.3",

src/plugins/swagger.ts

@@ -19,6 +19,7 @@ export default async function (instance: FastifyInstance): Promise<void> {
         { name: 'app-action', description: 'Endpoints related to actions created in apps' },
         { name: 'app-data', description: 'Endpoints related to data created in apps' },
         { name: 'app-setting', description: 'Endpoints related to settings created in apps' },
+        { name: 'capsule', description: 'Endpoints related to capsules' },
         { name: 'chat', description: 'Endpoints related to chats' },
         { name: 'app-chatbot', description: 'Endpoints related to chatbots in apps' },
         { name: 'current', description: 'Endpoints related to current user' },

src/services/item/discrimination.ts

@@ -6,6 +6,8 @@ export type AppItem = ItemWithType<typeof ItemType.APP>;
 export type DocumentItem = ItemWithType<typeof ItemType.DOCUMENT>;
 export type EtherpadItem = ItemWithType<typeof ItemType.ETHERPAD>;
 export type FolderItem = ItemWithType<typeof ItemType.FOLDER>;
+// For now a capsule is a folder with one different setting
+export type CapsuleItem = FolderItem;
 export type PageItem = ItemWithType<typeof ItemType.PAGE>;
 export type H5PItem = ItemWithType<typeof ItemType.H5P>;
 export type EmbeddedLinkItem = ItemWithType<typeof ItemType.LINK>;

src/services/item/index.ts

@@ -11,6 +11,7 @@ import itemController from './item.controller';
 import actionItemPlugin from './plugins/action/itemAction.controller';
 import graaspApps from './plugins/app/app.controller';
 import { plugin as graaspAppItem } from './plugins/app/appItem.controller';
+import { capsulePlugin } from './plugins/capsule/capsule.controller';
 import graaspDocumentItem from './plugins/document/document.controller';
 import { PREFIX_DOCUMENT } from './plugins/document/document.service';
 import graaspEmbeddedLinkItem from './plugins/embeddedLink/link.controller';
@@ -74,6 +75,8 @@ const plugin: FastifyPluginAsync = async (fastify) => {
 
       fastify.register(graaspFolderItem);
 
+      fastify.register(capsulePlugin);
+
       fastify.register(graaspAppItem);
 
       fastify.register(ShortLinkService, {

src/services/item/plugins/capsule/README.md

@@ -0,0 +1,5 @@
+# Capsules
+
+Capsules are identical to regular folders but are marked with a special flag to indicate their capsule status (`isCapsule=true`).
+
+Folders can be converted to capsules by toggling the `isCapsule` property and vice versa. It does not affect contents or structure.