Collections management (#2872)

Signed-off-by: Sameh16 <sameh_mohamed16@hotmail.com>
Co-authored-by: Mikhail Savelyev <msavelyev@contractor.linuxfoundation.org>

Author: Sameh16

backend/src/api/collections/collectionsCreate.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+/**
+ * POST /collections
+ * @summary Create a collection
+ * @tag Collections
+ * @security Bearer
+ * @description Create a new collection
+ * @bodyContent {CollectionCreateInput} application/json
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  const payload = await service.createCollection(req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/collectionsDestroy.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+/**
+ * DELETE /collections/{id}
+ * @summary Delete a collection
+ * @tag Collections
+ * @security Bearer
+ * @description Delete a collection by ID
+ * @pathParam {string} id - The ID of the collection
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  await service.destroy(req.params.id)
+
+  await req.responseHandler.success(req, res, true)
+}

backend/src/api/collections/collectionsGet.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+/**
+ * GET /collections/{id}
+ * @summary Get a collection
+ * @tag Collections
+ * @security Bearer
+ * @description Get a collection by ID
+ * @pathParam {string} id - The ID of the collection
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionRead)
+
+  const service = new CollectionService(req)
+  const payload = await service.findById(req.params.id)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/collectionsQuery.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+/**
+ * POST /collections/query
+ * @summary Query collections
+ * @tag Collections
+ * @security Bearer
+ * @description Query collections with filters and pagination
+ * @bodyContent {CollectionsQuery} application/json
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionRead)
+
+  const service = new CollectionService(req)
+  const payload = await service.query(req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/collectionsUpdate.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+/**
+ * POST /collection/:id
+ * @summary Update a collection
+ * @tag Collections
+ * @security Bearer
+ * @description Update a collection
+ * @bodyContent {CollectionUpdateInput} application/json
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  const payload = await service.updateCollection(req.params.id, req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/index.ts

@@ -0,0 +1,34 @@
+import { safeWrap } from '../../middlewares/errorMiddleware'
+
+export default (app) => {
+  // Insights projects routes
+  app.post(
+    '/collections/insights-projects/query',
+    safeWrap(require('./insightsProjects/insightsProjectsQuery').default),
+  )
+  app.post(
+    '/collections/insights-projects',
+    safeWrap(require('./insightsProjects/insightsProjectsCreate').default),
+  )
+  app.delete(
+    '/collections/insights-projects/:id',
+    safeWrap(require('./insightsProjects/insightsProjectsDestroy').default),
+  )
+  app.post(
+    '/collections/insights-projects/:id',
+    safeWrap(require('./insightsProjects/insightsProjectsUpdate').default),
+  )
+  app.get(
+    '/collections/insights-projects/:id',
+    safeWrap(require('./insightsProjects/insightsProjectsGet').default),
+  )
+
+  // Collections routes
+  app.post('/collections/query', safeWrap(require('./collectionsQuery').default))
+  app.post('/collections', safeWrap(require('./collectionsCreate').default))
+  app.get('/collections/:id', safeWrap(require('./collectionsGet').default))
+  app.post('/collections/:id', safeWrap(require('./collectionsUpdate').default))
+  app.delete('/collections/:id', safeWrap(require('./collectionsDestroy').default))
+
+  app.get('/segments/:id/repositories', safeWrap(require('./segmentsRepositoriesGet').default))
+}

backend/src/api/collections/insightsProjects/insightsProjectsCreate.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../../security/permissions'
+import PermissionChecker from '../../../services/user/permissionChecker'
+
+/**
+ * POST /collections/insights-projects
+ * @summary Create an insights project
+ * @tag Collections
+ * @security Bearer
+ * @description Create a new insights project
+ * @bodyContent {InsightsProjectCreateInput} application/json
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  const payload = await service.createInsightsProject(req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/insightsProjects/insightsProjectsDestroy.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../../security/permissions'
+import PermissionChecker from '../../../services/user/permissionChecker'
+
+/**
+ * DELETE /collections/insights-projects/{id}
+ * @summary Delete an insights project
+ * @tag Collections
+ * @security Bearer
+ * @description Delete an insights project by ID
+ * @pathParam {string} id - The ID of the insights project
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  await service.destroyInsightsProject(req.params.id)
+
+  await req.responseHandler.success(req, res, true)
+}

backend/src/api/collections/insightsProjects/insightsProjectsGet.ts

@@ -0,0 +1,24 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../../security/permissions'
+import PermissionChecker from '../../../services/user/permissionChecker'
+
+/**
+ * GET /collections/insights-projects/:id
+ * @summary Get an insights project
+ * @tag Collections
+ * @security Bearer
+ * @description Get an insights project by ID
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionEdit)
+
+  const service = new CollectionService(req)
+  const payload = await service.findInsightsProjectById(req.params.id)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/collections/insightsProjects/insightsProjectsQuery.ts

@@ -0,0 +1,25 @@
+import { CollectionService } from '@/services/collectionService'
+
+import Permissions from '../../../security/permissions'
+import PermissionChecker from '../../../services/user/permissionChecker'
+
+/**
+ * POST /collections/insights-projects/query
+ * @summary Query insights projects
+ * @tag Collections
+ * @security Bearer
+ * @description Query insights projects with filters and pagination
+ * @bodyContent {InsightsProjectsQuery} application/json
+ * @response 200 - Ok
+ * @response 401 - Unauthorized
+ * @response 404 - Not found
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.collectionRead)
+
+  const service = new CollectionService(req)
+  const payload = await service.queryInsightsProjects(req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}