FEAT: simplify color and emoji property definitions in docsfera.json

docsfera.json

@@ -5662,6 +5662,48 @@
           ]
         }
       },
+      "/catalog/custom-properties": {
+        "get": {
+          "operationId": "CatalogController_getCustomPropertyDefinitions",
+          "parameters": [
+            {
+              "name": "dadosfera-lang",
+              "in": "header",
+              "required": false,
+              "schema": {
+                "enum": [
+                  "pt-br",
+                  "en-us"
+                ],
+                "type": "string"
+              }
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object"
+                  }
+                }
+              }
+            }
+          },
+          "tags": [
+            "Catalog"
+          ],
+          "security": [
+            {
+              "access-token": []
+            },
+            {
+              "access-token": []
+            }
+          ]
+        }
+      },
       "/catalog/data-asset/{id}": {
         "get": {
           "operationId": "CatalogController_getDataAsset",
@@ -5922,57 +5964,6 @@
               "access-token": []
             }
           ]
-        },
-        "patch": {
-          "operationId": "CatalogController_updateColumnsMetadata",
-          "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/UpdateColumnsMetadataRequest"
-                }
-              }
-            }
-          },
-          "responses": {
-            "200": {
-              "description": ""
-            }
-          },
-          "tags": [
-            "Catalog"
-          ],
-          "security": [
-            {
-              "access-token": []
-            },
-            {
-              "access-token": []
-            }
-          ]
         }
       },
       "/catalog/data-asset/{id}/preview": {
@@ -11172,35 +11163,6 @@
             "columns_metadata"
           ]
         },
-        "ColumnDescriptionDto": {
-          "type": "object",
-          "properties": {
-            "column_name": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "column_name",
-            "description"
-          ]
-        },
-        "UpdateColumnsMetadataRequest": {
-          "type": "object",
-          "properties": {
-            "columns": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/ColumnDescriptionDto"
-              }
-            }
-          },
-          "required": [
-            "columns"
-          ]
-        },
         "IData": {
           "type": "object",
           "properties": {
@@ -11303,6 +11265,37 @@
             "docs"
           ]
         },
+        "CustomPropertyDto": {
+          "type": "object",
+          "properties": {
+            "key": {
+              "type": "string"
+            },
+            "value": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "text",
+                "number",
+                "date",
+                "boolean"
+              ]
+            },
+            "color": {
+              "type": "string"
+            },
+            "emoji": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "key",
+            "value",
+            "type"
+          ]
+        },
         "IUpdateDataRequest": {
           "type": "object",
           "properties": {
@@ -11331,6 +11324,12 @@
             },
             "docs": {
               "type": "string"
+            },
+            "custom_properties": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/CustomPropertyDto"
+              }
             }
           },
           "required": [

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.14",
         "@grpc/grpc-js": "^1.9.3",
         "@grpc/proto-loader": "^0.7.9",
         "@nestjs/cli": "^9.5.0",
@@ -1735,9 +1735,9 @@
       }
     },
     "node_modules/@dadosfera/protospack-v2": {
-      "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==",
+      "version": "3.40.0-beta.14",
+      "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.40.0-beta.14.tgz",
+      "integrity": "sha512-pv3pxq0x1XcBgf3ajD6QOFRLOduh8iEozKFA3AKlIW4gid+gT4iL0GcU2M+O7h0QFeO4JIzRZe/nEMN82nqk7A==",
       "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.14",
     "@grpc/grpc-js": "^1.9.3",
     "@grpc/proto-loader": "^0.7.9",
     "@nestjs/cli": "^9.5.0",

src/modules/catalog/catalog.controller.ts

@@ -9,7 +9,6 @@ import {
   Inject,
   NotFoundException,
   Param,
-  Patch,
   Post,
   Put,
   Query,
@@ -52,7 +51,6 @@ import {
   IUpdateDataRequest,
   TriggerCatalogReq,
   TriggerCatalogRes,
-  UpdateColumnsMetadataRequest,
 } from './dtos';
 import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter';
 import { Language } from 'src/decorators/language.decorator';
@@ -285,6 +283,23 @@ export class CatalogController {
 
   }
 
+  @Get('custom-properties')
+  @RequireSomePermission(
+    PERMISSIONS_GROUPS.CATALOG.permissions.GET,
+    PERMISSIONS_GROUPS.CATALOG.permissions.DATA_MANAGER,
+  )
+  async getCustomPropertyDefinitions(@User() user: RequestUser) {
+    const { customer_id, customer_name, user_id, username } = user;
+    const metadata = PackTheMetadata({
+      customer_id,
+      customer_name,
+      user_id,
+      username,
+    });
+
+    return this.catalogService.getCustomPropertyDefinitions(metadata);
+  }
+
   @Get('data-asset/:id')
   @RequireSomePermission(
     PERMISSIONS_GROUPS.CATALOG.permissions.GET,
@@ -433,42 +448,6 @@ export class CatalogController {
     return { columns_metadata };
   }
 
-  @Patch('data-asset/:id/columns-metadata')
-  @RequireSomePermission(
-    PERMISSIONS_GROUPS.CATALOG.permissions.UPDATE,
-    PERMISSIONS_GROUPS.CATALOG.permissions.DATA_MANAGER,
-  )
-  async updateColumnsMetadata(
-    @User() user: RequestUser,
-    @Language() language: LanguageEnum,
-    @Param('id') id: string,
-    @Body(new ValidationPipe()) body: UpdateColumnsMetadataRequest,
-  ): Promise<{ success: boolean }> {
-    const { customer_name, customer_id, user_id, username } = user;
-
-    this.logger.info(`/catalog - update columns metadata`, {
-      user_id,
-      customer_name,
-      columns_count: body.columns.length,
-    });
-
-    const metadata = PackTheMetadata({
-      customer_name,
-      customer_id,
-      user_id,
-      username,
-      language,
-    });
-
-    await this.catalogService.updateColumnsDescriptions(
-      id,
-      body.columns,
-      metadata,
-    );
-
-    return { success: true };
-  }
-
   @Get('data-asset/:id/preview')
   @RequireSomePermission(
     PERMISSIONS_GROUPS.CATALOG.permissions.GET,
@@ -1094,4 +1073,4 @@ export class CatalogController {
       this.logger.error(error.message);
     }
   }
-}
+}

src/modules/catalog/catalog.service.ts

@@ -120,6 +120,10 @@ class CatalogService implements OnModuleInit {
     }
   }
 
+  async getCustomPropertyDefinitions(metadata: Metadata) {
+    return lastValueFrom(this.catalogReadService.GetCustomPropertyDefinitions({}, metadata));
+  }
+
   async createDataAsset(data: Messages.CreateDataAssetRequest, metadata) {
     this.logger.info('CatalogService - Manage Data assets permissions');
     if (!data.embed) data.embed = undefined;
@@ -463,24 +467,6 @@ class CatalogService implements OnModuleInit {
     return result;
   }
 
-  async updateColumnsDescriptions(
-    id: string,
-    columns: { column_name: string; description: string }[],
-    metadata: Metadata,
-  ) {
-    await lastValueFrom(
-      this.catalogWriteService.UpdateDataAsset(
-        {
-          id,
-          changes: JSON.stringify({
-            column_descriptions: columns,
-          }),
-        },
-        metadata,
-      ),
-    );
-  }
-
   async createDataDocs(body: CreateDataDocsDTO, metadata: Metadata) {
     if (body.asset_type === 'table' || body.asset_type === 'view') {
       return this.createDataDocsViaNimbus(body);

src/modules/catalog/dtos/index.ts

@@ -1,13 +1,10 @@
 import { ApiProperty, ApiPropertyOptional, PickType } from '@nestjs/swagger';
 import {
-  ArrayNotEmpty,
-  IsArray,
   IsEnum,
   IsNotEmpty,
+  IsOptional,
   IsString,
-  ValidateNested,
 } from 'class-validator';
-import { Type } from 'class-transformer';
 import { CreateDataAssetRequest } from '@dadosfera/protospack-v2/dist/lib/Catalog/interfaces/messages';
 
 export enum DataAssetShareType {
@@ -206,6 +203,27 @@ export class IData {
   day_opening: number;
 }
 
+
+export enum CustomPropertyType {
+  TEXT = 'text',
+  NUMBER = 'number',
+  DATE = 'date',
+  BOOLEAN = 'boolean',
+}
+
+export class CustomPropertyDto {
+  @ApiProperty()
+  key: string;
+  @ApiProperty()
+  value: string;
+  @ApiProperty({ enum: CustomPropertyType })
+  type: CustomPropertyType;
+  @ApiPropertyOptional()
+  color?: string;
+  @ApiPropertyOptional()
+  emoji?: string;
+}
+
 export class IUpdateDataRequest {
   @ApiProperty()
   name: string;
@@ -219,6 +237,8 @@ export class IUpdateDataRequest {
   share_type?: DataAssetShareType;
   @ApiPropertyOptional()
   docs?: string;
+  @ApiPropertyOptional({ type: [CustomPropertyDto] })
+  custom_properties?: CustomPropertyDto[];
 }
 
 export class IUpdateCertificationStatusRequest {
@@ -227,26 +247,6 @@ export class IUpdateCertificationStatusRequest {
   certification_status: CertificationStatus;
 }
 
-export class ColumnDescriptionDto {
-  @ApiProperty()
-  @IsString()
-  @IsNotEmpty()
-  column_name: string;
-
-  @ApiProperty()
-  @IsString()
-  description: string;
-}
-
-export class UpdateColumnsMetadataRequest {
-  @ApiProperty({ type: [ColumnDescriptionDto] })
-  @IsArray()
-  @ArrayNotEmpty()
-  @ValidateNested({ each: true })
-  @Type(() => ColumnDescriptionDto)
-  columns: ColumnDescriptionDto[];
-}
-
 export class ICreateDataAsset implements CreateDataAssetRequest {
   @ApiProperty()
   display_name: string;
@@ -400,4 +400,4 @@ export type CreateDataDocsDTO = {
   docs: string;
   asset_type: string;
 
-}
+}

src/utils/ErrorBuilder.ts

@@ -315,14 +315,6 @@ export function EnrichErrorCode(code: string) {
           'Tente realizar a ação novamente. Caso o erro persista, entre em contato com o suporte',
         code,
       };
-    case ErrorCodes.CATALOG.COLUMN_NOT_FOUND:
-      return {
-        statusCode: HttpStatus.NOT_FOUND,
-        error: 'Coluna não encontrada',
-        message:
-          'Uma ou mais colunas informadas não existem neste ativo. Verifique os nomes e tente novamente.',
-        code,
-      };
     case ErrorCodes.CATALOG.PREVIEW_TOO_BIG:
       return {
         statusCode: HttpStatus.INTERNAL_SERVER_ERROR,

src/utils/errorCodes.ts

@@ -74,7 +74,6 @@ const CATALOG = {
   DATA_ASSET_NOT_FOUND: 'CATALOG.DATA_ASSET_NOT_FOUND',
   PREVIEW_TOO_BIG: 'CATALOG.PREVIEW_TOO_BIG',
   METADATA_TOO_BIG: 'CATALOG.METADATA_TOO_BIG',
-  COLUMN_NOT_FOUND: 'CATALOG.COLUMN_NOT_FOUND',
 };
 const IDENTITY_PROVIDER = {
   INVALID_RESPONSE: 'IDENTITY_PROVIDER.INVALID_RESPONSE',