feat: byo catalog support (#919)

* feat: getall and create catalog

* feat: catalog endpoints

* fix: create and filemap for catalogs

* fix: workload catalog

* feat: get charts from byo catalog

* feat: refactor getting catalog charts

* fix: tests

* feat: added tests for helper functions

* feat: removed v1 object and additional properties

* fix: remove commented code and definition appcatalog

---------

Co-authored-by: Dennis van Kekem <38350840+dennisvankekem@users.noreply.github.com>
Co-authored-by: svcAPLBot <174728082+svcAPLBot@users.noreply.github.com>

Author: 3 people

package-lock.json

@@ -0,0 +1,25 @@
+import Debug from 'debug'
+import { Response } from 'express'
+import { AplCatalogRequest, OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:catalogs')
+
+/**
+ * GET /v2/catalogs
+ * Get all catalogs
+ */
+export const getAllAplCatalogs = (req: OpenApiRequestExt, res: Response): void => {
+  debug('getAllCatalogs')
+  const v = req.otomi.getAllAplCatalogs()
+  res.json(v)
+}
+
+/**
+ * POST /v2/catalogs
+ * Create a catalog
+ */
+export const createAplCatalog = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  debug('createCatalog')
+  const data = await req.otomi.createAplCatalog(req.body as AplCatalogRequest)
+  res.json(data)
+}

src/api/v2/catalogs.ts

@@ -0,0 +1,49 @@
+import Debug from 'debug'
+import { Response } from 'express'
+import { AplCatalogRequest, OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:catalogs')
+
+/**
+ * GET /v2/catalogs/{catalogId}
+ * Get a specific catalog
+ */
+export const getAplCatalog = (req: OpenApiRequestExt, res: Response): void => {
+  const { catalogId } = req.params
+  debug(`getAplCatalog(${catalogId})`)
+  const data = req.otomi.getAplCatalog(decodeURIComponent(catalogId))
+  res.json(data)
+}
+
+/**
+ * PUT /v2/catalogs/{catalogId}
+ * Edit a catalog
+ */
+export const editAplCatalog = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  const { catalogId } = req.params
+  debug(`editAplCatalog(${catalogId})`)
+  const data = await req.otomi.editAplCatalog(decodeURIComponent(catalogId), req.body as AplCatalogRequest)
+  res.json(data)
+}
+
+/**
+ * PATCH /v2/catalogs/{catalogId}
+ * Partially update a catalog
+ */
+export const patchAplCatalog = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  const { catalogId } = req.params
+  debug(`patchAplCatalog(${catalogId})`)
+  const data = await req.otomi.editAplCatalog(decodeURIComponent(catalogId), req.body as AplCatalogRequest, true)
+  res.json(data)
+}
+
+/**
+ * DELETE /v2/catalogs/{catalogId}
+ * Delete a catalog
+ */
+export const deleteAplCatalog = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  const { catalogId } = req.params
+  debug(`deleteAplCatalog(${catalogId})`)
+  await req.otomi.deleteAplCatalog(decodeURIComponent(catalogId))
+  res.json({})
+}

src/api/v2/catalogs/{catalogId}.ts

@@ -0,0 +1,16 @@
+import Debug from 'debug'
+import { Response } from 'express'
+import { OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:catalogs:charts')
+
+/**
+ * GET /v2/catalogs/{catalogId}/charts
+ * Get charts for a specific catalog
+ */
+export const getAplCatalogsCharts = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  const { catalogId } = req.params
+  debug(`getAplCatalog(${catalogId})`)
+  const data = await req.otomi.getAplCatalogCharts(decodeURIComponent(catalogId))
+  res.json(data)
+}

src/api/v2/catalogs/{catalogId}/charts.ts

@@ -91,6 +91,14 @@ export function getFileMaps(envDir: string): Map<AplKind, FileMap> {
     name: 'otomi',
   })
 
+  maps.set('AplCatalog', {
+    kind: 'AplCatalog',
+    envDir,
+    pathGlob: `${envDir}/env/catalogs/*.{yaml,yaml.dec}`,
+    pathTemplate: 'env/catalogs/{name}.yaml',
+    name: 'catalogs',
+  })
+
   maps.set('AplBackupCollection', {
     kind: 'AplBackupCollection',
     envDir,

src/fileStore/file-map.ts

@@ -167,14 +167,25 @@ export class FileStore {
     return filePath
   }
 
+  deleteTeamResource(kind: AplKind, teamId: string, name: string): string {
+    const filePath = getResourceFilePath(kind, name, teamId)
+    this.store.delete(filePath)
+    return filePath
+  }
+
+  getPlatformResource(kind: AplKind, name: string): AplObject | undefined {
+    const filePath = getResourceFilePath(kind, name)
+    return this.store.get(filePath)
+  }
+
   setPlatformResource(aplPlatformObject: AplPlatformObject): string {
     const filePath = getResourceFilePath(aplPlatformObject.kind, aplPlatformObject.metadata.name)
     this.store.set(filePath, aplPlatformObject)
     return filePath
   }
 
-  deleteTeamResource(kind: AplKind, teamId: string, name: string): string {
-    const filePath = getResourceFilePath(kind, name, teamId)
+  deletePlatformResource(kind: AplKind, name: string): string {
+    const filePath = getResourceFilePath(kind, name)
     this.store.delete(filePath)
     return filePath
   }