FEAT: add endpoint and logic to update data asset certification status

feat: add endpoint to retrieve pipeline run jobs

Dockerfile

@@ -1,5 +1,5 @@
 FROM node:20-alpine AS base_image
-RUN npm install -g npm@latest
+RUN npm install -g npm@10.8.2
 
 FROM base_image AS build_base
 WORKDIR /app

docsfera.json

@@ -4574,6 +4574,7 @@
         "get": {
           "operationId": "PlatformApiController_getPipelineRunJobs",
           "summary": "Get pipeline run jobs",
+          "description": "Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.",
           "parameters": [
             {
               "name": "pipelineId",
@@ -4594,11 +4595,22 @@
           ],
           "responses": {
             "200": {
-              "description": "",
+              "description": "DB-backed job runs for the selected pipeline run.",
               "content": {
                 "application/json": {
                   "schema": {
-                    "type": "object"
+                    "type": "object",
+                    "properties": {
+                      "jobs": {
+                        "type": "array",
+                        "items": {
+                          "type": "object"
+                        }
+                      }
+                    },
+                    "required": [
+                      "jobs"
+                    ]
                   }
                 }
               }
@@ -5940,6 +5952,66 @@
           ]
         }
       },
+      "/catalog/data-asset/{id}/certification-status": {
+        "put": {
+          "operationId": "CatalogController_updateDataAssetCertificationStatus",
+          "parameters": [
+            {
+              "name": "dadosfera-lang",
+              "in": "header",
+              "required": false,
+              "schema": {
+                "enum": [
+                  "pt-br",
+                  "en-us"
+                ],
+                "type": "string"
+              }
+            },
+            {
+              "name": "id",
+              "required": true,
+              "in": "path",
+              "schema": {
+                "type": "string"
+              }
+            }
+          ],
+          "requestBody": {
+            "required": true,
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/IUpdateCertificationStatusRequest"
+                }
+              }
+            }
+          },
+          "responses": {
+            "200": {
+              "description": "",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/IUpdateCertificationStatusRequest"
+                  }
+                }
+              }
+            }
+          },
+          "tags": [
+            "Catalog"
+          ],
+          "security": [
+            {
+              "access-token": []
+            },
+            {
+              "access-token": []
+            }
+          ]
+        }
+      },
       "/catalog/data-asset/{id}/manage-permissions": {
         "put": {
           "operationId": "CatalogController_manageDataAssetPermissions",
@@ -11020,6 +11092,23 @@
             "data_asset"
           ]
         },
+        "IUpdateCertificationStatusRequest": {
+          "type": "object",
+          "properties": {
+            "certification_status": {
+              "type": "string",
+              "enum": [
+                "draft",
+                "in_review",
+                "approved",
+                "deprecated"
+              ]
+            }
+          },
+          "required": [
+            "certification_status"
+          ]
+        },
         "ICreateDataAsset": {
           "type": "object",
           "properties": {

package-lock.json

@@ -16,7 +16,7 @@
         "@aws-sdk/lib-dynamodb": "^3.414.0",
         "@aws-sdk/signature-v4": "^3.370.0",
         "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-        "@dadosfera/protospack-v2": "3.40.0-beta.10",
+        "@dadosfera/protospack-v2": "^3.40.0-beta.10",
         "@grpc/grpc-js": "^1.9.3",
         "@grpc/proto-loader": "^0.7.9",
         "@nestjs/cli": "^9.5.0",
@@ -1738,7 +1738,6 @@
       "version": "3.40.0-beta.10",
       "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.40.0-beta.10.tgz",
       "integrity": "sha512-F45dSEIKG+gwwDMYHayA242bFwhFTJbZm26KesQbGhf4I45ur6hYZD8dK0voNuVQInLMQhtm6+7th6/jJ8xpTQ==",
-      "license": "ISC",
       "dependencies": {
         "@grpc/grpc-js": "^1.9.3",
         "rxjs": "^7.5.5"

package.json

@@ -34,7 +34,7 @@
     "@aws-sdk/lib-dynamodb": "^3.414.0",
     "@aws-sdk/signature-v4": "^3.370.0",
     "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-    "@dadosfera/protospack-v2": "3.40.0-beta.10",
+    "@dadosfera/protospack-v2": "^3.40.0-beta.10",
     "@grpc/grpc-js": "^1.9.3",
     "@grpc/proto-loader": "^0.7.9",
     "@nestjs/cli": "^9.5.0",

src/authentication/permissions.enum.ts

@@ -357,6 +357,16 @@ export const PERMISSIONS_GROUPS = {
           'es-es': 'Crear y editar atributos en el catálogo',
         },
       },
+      CERTIFY: {
+        seqid: 53,
+        claim: 'catalog:certify',
+        usage: PermissionUsages.PUBLIC,
+        name: {
+          'pt-br': 'Alterar o status de certificação dos Ativos',
+          'en-us': "Change Assets' certification status",
+          'es-es': 'Cambiar el estado de certificación de los Activos',
+        },
+      },
       DELETE: {
         seqid: 1,
         claim: 'catalog:delete',

src/modules/catalog/catalog.controller.ts

@@ -17,6 +17,7 @@ import {
   HttpStatus,
   Res,
 } from '@nestjs/common';
+import { ValidationPipe } from '../../pipes/object-validation.pipe';
 import {
   ApiCreatedResponse,
   ApiHeaders,
@@ -46,6 +47,7 @@ import {
   IMakeAComment,
   IOneDataAsset,
   IPreviewResponse,
+  IUpdateCertificationStatusRequest,
   IUpdateDataRequest,
   TriggerCatalogReq,
   TriggerCatalogRes,
@@ -493,6 +495,8 @@ export class CatalogController {
       language,
     });
 
+    delete (body as any).certification_status;
+
     const result = await this.catalogService.updateOneDataAsset({
       body,
       data_asset_id,
@@ -506,6 +510,33 @@ export class CatalogController {
     return result;
   }
 
+  @Put('data-asset/:id/certification-status')
+  @RequireSomePermission(
+    PERMISSIONS_GROUPS.CATALOG.permissions.CERTIFY,
+    PERMISSIONS_GROUPS.CATALOG.permissions.DATA_MANAGER,
+  )
+  async updateDataAssetCertificationStatus(
+    @User() user: RequestUser,
+    @Language() language: LanguageEnum,
+    @Param('id') data_asset_id: string,
+    @Body(new ValidationPipe()) body: IUpdateCertificationStatusRequest,
+  ): Promise<IUpdateCertificationStatusRequest> {
+    const { customer_id, customer_name, user_id, username } = user;
+    const metadata = PackTheMetadata({
+      customer_id,
+      customer_name,
+      user_id,
+      username,
+      language,
+    });
+
+    return this.catalogService.updateCertificationStatus({
+      body,
+      data_asset_id,
+      metadata,
+    });
+  }
+
   @Post('data-asset/:id/docs')
   @RequireSomePermission(
     PERMISSIONS_GROUPS.CATALOG.permissions.UPDATE,

src/modules/catalog/catalog.service.ts

@@ -29,6 +29,7 @@ import {
   AssetReporter,
   BatchRemoveRlsRulesRequest,
   CreateDataDocsDTO,
+  IUpdateCertificationStatusRequest,
   IUpdateDataRequest,
   TriggerCatalogReq,
 } from './dtos';
@@ -384,6 +385,28 @@ class CatalogService implements OnModuleInit {
     return { data_asset: asset[0] };
   }
 
+  async updateCertificationStatus(data: {
+    data_asset_id: string;
+    body: IUpdateCertificationStatusRequest;
+    metadata: Metadata;
+  }) {
+    const { body, data_asset_id, metadata } = data;
+
+    await lastValueFrom(
+      this.catalogWriteService.UpdateDataAsset(
+        {
+          id: data_asset_id,
+          changes: JSON.stringify({
+            certification_status: body.certification_status,
+          }),
+        },
+        metadata,
+      ),
+    );
+
+    return { certification_status: body.certification_status };
+  }
+
   async updateOneDataAsset(data: {
     data_asset_id: string;
     customer_id: string;

src/modules/catalog/dtos/index.ts

@@ -1,4 +1,5 @@
 import { ApiProperty, ApiPropertyOptional, PickType } from '@nestjs/swagger';
+import { IsEnum } from 'class-validator';
 import { CreateDataAssetRequest } from '@dadosfera/protospack-v2/dist/lib/Catalog/interfaces/messages';
 
 export enum DataAssetShareType {
@@ -6,6 +7,12 @@ export enum DataAssetShareType {
   public = 'public',
   private = 'private',
 }
+export enum CertificationStatus {
+  draft = 'draft',
+  in_review = 'in_review',
+  approved = 'approved',
+  deprecated = 'deprecated',
+}
 export enum OrderEnum {
   asc = 'asc',
   desc = 'desc',
@@ -205,6 +212,13 @@ export class IUpdateDataRequest {
   @ApiPropertyOptional()
   docs?: string;
 }
+
+export class IUpdateCertificationStatusRequest {
+  @ApiProperty({ enum: CertificationStatus })
+  @IsEnum(CertificationStatus)
+  certification_status: CertificationStatus;
+}
+
 export class ICreateDataAsset implements CreateDataAssetRequest {
   @ApiProperty()
   display_name: string;

src/modules/pipelinesV2/pipelines.controller.ts

@@ -15,6 +15,7 @@ import {
   HttpException,
   BadRequestException,
   UseGuards,
+  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,

src/modules/platform-api/platform-api.controller.ts

@@ -14,7 +14,7 @@ import {
   NotFoundException,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags, ApiOperation } from '@nestjs/swagger';
+import { ApiTags, ApiOperation, ApiOkResponse } from '@nestjs/swagger';
 import { DadosferaLogger } from '@dadosfera/dadosfera-logs';
 
 import {
@@ -72,6 +72,10 @@ export class PlatformApiController {
     return id?.replace(/-/g, '_') || '';
   }
 
+  private decodePathParam(value: string): string {
+    return value ? decodeURIComponent(value) : '';
+  }
+
   /**
    * Denormalize ID back to UUID format (replace _ with -).
    * Used when we receive a normalized ID but need the original UUID.
@@ -833,7 +837,23 @@ export class PlatformApiController {
   }
 
   @Get('pipelines/:pipelineId/pipeline_run/:runId/jobs')
-  @ApiOperation({ summary: 'Get pipeline run jobs' })
+  @ApiOperation({
+    summary: 'Get pipeline run jobs',
+    description: 'Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.',
+  })
+  @ApiOkResponse({
+    description: 'DB-backed job runs for the selected pipeline run.',
+    schema: {
+      type: 'object',
+      properties: {
+        jobs: {
+          type: 'array',
+          items: { type: 'object' },
+        },
+      },
+      required: ['jobs'],
+    },
+  })
   @RequireAllPermissions(PERMISSIONS_GROUPS.PIPELINE.permissions.GET)
   async getPipelineRunJobs(
     @Param('pipelineId') pipelineId: string,
@@ -841,11 +861,11 @@ export class PlatformApiController {
     @User() user: RequestUser,
   ) {
     const normalizedPipelineId = this.normalizePipelineId(pipelineId);
-    const normalizedRunId = this.normalizePipelineId(runId);
+    const decodedRunId = this.decodePathParam(runId);
 
     return this.platformApiService.proxy(
       'GET',
-      `/pipeline/${normalizedPipelineId}/pipeline_run/${normalizedRunId}/jobs`,
+      `/pipeline/${normalizedPipelineId}/pipeline_run/${decodedRunId}/jobs`,
       user,
     );
   }